d839df80b370f8bc7e003376f0efd11ec14a3da7
[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 "options" "macro &-- extracting"
3164 If invoked by an admin user, then &%macro%&, &%macro_list%& and &%macros%&
3165 are available, similarly to the drivers.  Because macros are sometimes used
3166 for storing passwords, this option is restricted.
3167 The output format is one item per line.
3168
3169 .vitem &%-bp%&
3170 .oindex "&%-bp%&"
3171 .cindex "queue" "listing messages on"
3172 .cindex "listing" "messages on the queue"
3173 This option requests a listing of the contents of the mail queue on the
3174 standard output. If the &%-bp%& option is followed by a list of message ids,
3175 just those messages are listed. By default, this option can be used only by an
3176 admin user. However, the &%queue_list_requires_admin%& option can be set false
3177 to allow any user to see the queue.
3178
3179 Each message on the queue is displayed as in the following example:
3180 .code
3181 25m  2.9K 0t5C6f-0000c8-00 <alice@wonderland.fict.example>
3182           red.king@looking-glass.fict.example
3183           <other addresses>
3184 .endd
3185 .cindex "message" "size in queue listing"
3186 .cindex "size" "of message"
3187 The first line contains the length of time the message has been on the queue
3188 (in this case 25 minutes), the size of the message (2.9K), the unique local
3189 identifier for the message, and the message sender, as contained in the
3190 envelope. For bounce messages, the sender address is empty, and appears as
3191 &"<>"&. If the message was submitted locally by an untrusted user who overrode
3192 the default sender address, the user's login name is shown in parentheses
3193 before the sender address.
3194
3195 .cindex "frozen messages" "in queue listing"
3196 If the message is frozen (attempts to deliver it are suspended) then the text
3197 &"*** frozen ***"& is displayed at the end of this line.
3198
3199 The recipients of the message (taken from the envelope, not the headers) are
3200 displayed on subsequent lines. Those addresses to which the message has already
3201 been delivered are marked with the letter D. If an original address gets
3202 expanded into several addresses via an alias or forward file, the original is
3203 displayed with a D only when deliveries for all of its child addresses are
3204 complete.
3205
3206
3207 .vitem &%-bpa%&
3208 .oindex "&%-bpa%&"
3209 This option operates like &%-bp%&, but in addition it shows delivered addresses
3210 that were generated from the original top level address(es) in each message by
3211 alias or forwarding operations. These addresses are flagged with &"+D"& instead
3212 of just &"D"&.
3213
3214
3215 .vitem &%-bpc%&
3216 .oindex "&%-bpc%&"
3217 .cindex "queue" "count of messages on"
3218 This option counts the number of messages on the queue, and writes the total
3219 to the standard output. It is restricted to admin users, unless
3220 &%queue_list_requires_admin%& is set false.
3221
3222
3223 .vitem &%-bpr%&
3224 .oindex "&%-bpr%&"
3225 This option operates like &%-bp%&, but the output is not sorted into
3226 chronological order of message arrival. This can speed it up when there are
3227 lots of messages on the queue, and is particularly useful if the output is
3228 going to be post-processed in a way that doesn't need the sorting.
3229
3230 .vitem &%-bpra%&
3231 .oindex "&%-bpra%&"
3232 This option is a combination of &%-bpr%& and &%-bpa%&.
3233
3234 .vitem &%-bpru%&
3235 .oindex "&%-bpru%&"
3236 This option is a combination of &%-bpr%& and &%-bpu%&.
3237
3238
3239 .vitem &%-bpu%&
3240 .oindex "&%-bpu%&"
3241 This option operates like &%-bp%& but shows only undelivered top-level
3242 addresses for each message displayed. Addresses generated by aliasing or
3243 forwarding are not shown, unless the message was deferred after processing by a
3244 router with the &%one_time%& option set.
3245
3246
3247 .vitem &%-brt%&
3248 .oindex "&%-brt%&"
3249 .cindex "testing" "retry configuration"
3250 .cindex "retry" "configuration testing"
3251 This option is for testing retry rules, and it must be followed by up to three
3252 arguments. It causes Exim to look for a retry rule that matches the values
3253 and to write it to the standard output. For example:
3254 .code
3255 exim -brt bach.comp.mus.example
3256 Retry rule: *.comp.mus.example  F,2h,15m; F,4d,30m;
3257 .endd
3258 See chapter &<<CHAPretry>>& for a description of Exim's retry rules. The first
3259 argument, which is required, can be a complete address in the form
3260 &'local_part@domain'&, or it can be just a domain name. If the second argument
3261 contains a dot, it is interpreted as an optional second domain name; if no
3262 retry rule is found for the first argument, the second is tried. This ties in
3263 with Exim's behaviour when looking for retry rules for remote hosts &-- if no
3264 rule is found that matches the host, one that matches the mail domain is
3265 sought. Finally, an argument that is the name of a specific delivery error, as
3266 used in setting up retry rules, can be given. For example:
3267 .code
3268 exim -brt haydn.comp.mus.example quota_3d
3269 Retry rule: *@haydn.comp.mus.example quota_3d  F,1h,15m
3270 .endd
3271
3272 .vitem &%-brw%&
3273 .oindex "&%-brw%&"
3274 .cindex "testing" "rewriting"
3275 .cindex "rewriting" "testing"
3276 This option is for testing address rewriting rules, and it must be followed by
3277 a single argument, consisting of either a local part without a domain, or a
3278 complete address with a fully qualified domain. Exim outputs how this address
3279 would be rewritten for each possible place it might appear. See chapter
3280 &<<CHAPrewrite>>& for further details.
3281
3282 .vitem &%-bS%&
3283 .oindex "&%-bS%&"
3284 .cindex "SMTP" "batched incoming"
3285 .cindex "batched SMTP input"
3286 This option is used for batched SMTP input, which is an alternative interface
3287 for non-interactive local message submission. A number of messages can be
3288 submitted in a single run. However, despite its name, this is not really SMTP
3289 input. Exim reads each message's envelope from SMTP commands on the standard
3290 input, but generates no responses. If the caller is trusted, or
3291 &%untrusted_set_sender%& is set, the senders in the SMTP MAIL commands are
3292 believed; otherwise the sender is always the caller of Exim.
3293
3294 The message itself is read from the standard input, in SMTP format (leading
3295 dots doubled), terminated by a line containing just a single dot. An error is
3296 provoked if the terminating dot is missing. A further message may then follow.
3297
3298 As for other local message submissions, the contents of incoming batch SMTP
3299 messages can be checked using the non-SMTP ACL (see chapter &<<CHAPACL>>&).
3300 Unqualified addresses are automatically qualified using &%qualify_domain%& and
3301 &%qualify_recipient%&, as appropriate, unless the &%-bnq%& option is used.
3302
3303 Some other SMTP commands are recognized in the input. HELO and EHLO act
3304 as RSET; VRFY, EXPN, ETRN, and HELP act as NOOP;
3305 QUIT quits, ignoring the rest of the standard input.
3306
3307 .cindex "return code" "for &%-bS%&"
3308 If any error is encountered, reports are written to the standard output and
3309 error streams, and Exim gives up immediately. The return code is 0 if no error
3310 was detected; it is 1 if one or more messages were accepted before the error
3311 was detected; otherwise it is 2.
3312
3313 More details of input using batched SMTP are given in section
3314 &<<SECTincomingbatchedSMTP>>&.
3315
3316 .vitem &%-bs%&
3317 .oindex "&%-bs%&"
3318 .cindex "SMTP" "local input"
3319 .cindex "local SMTP input"
3320 This option causes Exim to accept one or more messages by reading SMTP commands
3321 on the standard input, and producing SMTP replies on the standard output. SMTP
3322 policy controls, as defined in ACLs (see chapter &<<CHAPACL>>&) are applied.
3323 Some user agents use this interface as a way of passing locally-generated
3324 messages to the MTA.
3325
3326 In
3327 .cindex "sender" "source of"
3328 this usage, if the caller of Exim is trusted, or &%untrusted_set_sender%& is
3329 set, the senders of messages are taken from the SMTP MAIL commands.
3330 Otherwise the content of these commands is ignored and the sender is set up as
3331 the calling user. Unqualified addresses are automatically qualified using
3332 &%qualify_domain%& and &%qualify_recipient%&, as appropriate, unless the
3333 &%-bnq%& option is used.
3334
3335 .cindex "inetd"
3336 The
3337 &%-bs%& option is also used to run Exim from &'inetd'&, as an alternative to
3338 using a listening daemon. Exim can distinguish the two cases by checking
3339 whether the standard input is a TCP/IP socket. When Exim is called from
3340 &'inetd'&, the source of the mail is assumed to be remote, and the comments
3341 above concerning senders and qualification do not apply. In this situation,
3342 Exim behaves in exactly the same way as it does when receiving a message via
3343 the listening daemon.
3344
3345 .vitem &%-bt%&
3346 .oindex "&%-bt%&"
3347 .cindex "testing" "addresses"
3348 .cindex "address" "testing"
3349 This option runs Exim in address testing mode, in which each argument is taken
3350 as a recipient address to be tested for deliverability. The results are
3351 written to the standard output. If a test fails, and the caller is not an admin
3352 user, no details of the failure are output, because these might contain
3353 sensitive information such as usernames and passwords for database lookups.
3354
3355 If no arguments are given, Exim runs in an interactive manner, prompting with a
3356 right angle bracket for addresses to be tested.
3357
3358 Unlike the &%-be%& test option, you cannot arrange for Exim to use the
3359 &[readline()]& function, because it is running as &'root'& and there are
3360 security issues.
3361
3362 Each address is handled as if it were the recipient address of a message
3363 (compare the &%-bv%& option). It is passed to the routers and the result is
3364 written to the standard output. However, any router that has
3365 &%no_address_test%& set is bypassed. This can make &%-bt%& easier to use for
3366 genuine routing tests if your first router passes everything to a scanner
3367 program.
3368
3369 .cindex "return code" "for &%-bt%&"
3370 The return code is 2 if any address failed outright; it is 1 if no address
3371 failed outright but at least one could not be resolved for some reason. Return
3372 code 0 is given only when all addresses succeed.
3373
3374 .cindex "duplicate addresses"
3375 &*Note*&: When actually delivering a message, Exim removes duplicate recipient
3376 addresses after routing is complete, so that only one delivery takes place.
3377 This does not happen when testing with &%-bt%&; the full results of routing are
3378 always shown.
3379
3380 &*Warning*&: &%-bt%& can only do relatively simple testing. If any of the
3381 routers in the configuration makes any tests on the sender address of a
3382 message,
3383 .oindex "&%-f%&" "for address testing"
3384 you can use the &%-f%& option to set an appropriate sender when running
3385 &%-bt%& tests. Without it, the sender is assumed to be the calling user at the
3386 default qualifying domain. However, if you have set up (for example) routers
3387 whose behaviour depends on the contents of an incoming message, you cannot test
3388 those conditions using &%-bt%&. The &%-N%& option provides a possible way of
3389 doing such tests.
3390
3391 .vitem &%-bV%&
3392 .oindex "&%-bV%&"
3393 .cindex "version number of Exim"
3394 This option causes Exim to write the current version number, compilation
3395 number, and compilation date of the &'exim'& binary to the standard output.
3396 It also lists the DBM library that is being used, the optional modules (such as
3397 specific lookup types), the drivers that are included in the binary, and the
3398 name of the run time configuration file that is in use.
3399
3400 As part of its operation, &%-bV%& causes Exim to read and syntax check its
3401 configuration file. However, this is a static check only. It cannot check
3402 values that are to be expanded. For example, although a misspelt ACL verb is
3403 detected, an error in the verb's arguments is not. You cannot rely on &%-bV%&
3404 alone to discover (for example) all the typos in the configuration; some
3405 realistic testing is needed. The &%-bh%& and &%-N%& options provide more
3406 dynamic testing facilities.
3407
3408 .vitem &%-bv%&
3409 .oindex "&%-bv%&"
3410 .cindex "verifying address" "using &%-bv%&"
3411 .cindex "address" "verification"
3412 This option runs Exim in address verification mode, in which each argument is
3413 taken as a recipient address to be verified by the routers. (This does
3414 not involve any verification callouts). During normal operation, verification
3415 happens mostly as a consequence processing a &%verify%& condition in an ACL
3416 (see chapter &<<CHAPACL>>&). If you want to test an entire ACL, possibly
3417 including callouts, see the &%-bh%& and &%-bhc%& options.
3418
3419 If verification fails, and the caller is not an admin user, no details of the
3420 failure are output, because these might contain sensitive information such as
3421 usernames and passwords for database lookups.
3422
3423 If no arguments are given, Exim runs in an interactive manner, prompting with a
3424 right angle bracket for addresses to be verified.
3425
3426 Unlike the &%-be%& test option, you cannot arrange for Exim to use the
3427 &[readline()]& function, because it is running as &'exim'& and there are
3428 security issues.
3429
3430 Verification differs from address testing (the &%-bt%& option) in that routers
3431 that have &%no_verify%& set are skipped, and if the address is accepted by a
3432 router that has &%fail_verify%& set, verification fails. The address is
3433 verified as a recipient if &%-bv%& is used; to test verification for a sender
3434 address, &%-bvs%& should be used.
3435
3436 If the &%-v%& option is not set, the output consists of a single line for each
3437 address, stating whether it was verified or not, and giving a reason in the
3438 latter case. Without &%-v%&, generating more than one address by redirection
3439 causes verification to end successfully, without considering the generated
3440 addresses. However, if just one address is generated, processing continues,
3441 and the generated address must verify successfully for the overall verification
3442 to succeed.
3443
3444 When &%-v%& is set, more details are given of how the address has been handled,
3445 and in the case of address redirection, all the generated addresses are also
3446 considered. Verification may succeed for some and fail for others.
3447
3448 The
3449 .cindex "return code" "for &%-bv%&"
3450 return code is 2 if any address failed outright; it is 1 if no address
3451 failed outright but at least one could not be resolved for some reason. Return
3452 code 0 is given only when all addresses succeed.
3453
3454 If any of the routers in the configuration makes any tests on the sender
3455 address of a message, you should use the &%-f%& option to set an appropriate
3456 sender when running &%-bv%& tests. Without it, the sender is assumed to be the
3457 calling user at the default qualifying domain.
3458
3459 .vitem &%-bvs%&
3460 .oindex "&%-bvs%&"
3461 This option acts like &%-bv%&, but verifies the address as a sender rather
3462 than a recipient address. This affects any rewriting and qualification that
3463 might happen.
3464
3465 .vitem &%-bw%&
3466 .oindex "&%-bw%&"
3467 .cindex "daemon"
3468 .cindex "inetd"
3469 .cindex "inetd" "wait mode"
3470 This option runs Exim as a daemon, awaiting incoming SMTP connections,
3471 similarly to the &%-bd%& option.  All port specifications on the command-line
3472 and in the configuration file are ignored.  Queue-running may not be specified.
3473
3474 In this mode, Exim expects to be passed a socket as fd 0 (stdin) which is
3475 listening for connections.  This permits the system to start up and have
3476 inetd (or equivalent) listen on the SMTP ports, starting an Exim daemon for
3477 each port only when the first connection is received.
3478
3479 If the option is given as &%-bw%&<&'time'&> then the time is a timeout, after
3480 which the daemon will exit, which should cause inetd to listen once more.
3481
3482 .vitem &%-C%&&~<&'filelist'&>
3483 .oindex "&%-C%&"
3484 .cindex "configuration file" "alternate"
3485 .cindex "CONFIGURE_FILE"
3486 .cindex "alternate configuration file"
3487 This option causes Exim to find the run time configuration file from the given
3488 list instead of from the list specified by the CONFIGURE_FILE
3489 compile-time setting. Usually, the list will consist of just a single file
3490 name, but it can be a colon-separated list of names. In this case, the first
3491 file that exists is used. Failure to open an existing file stops Exim from
3492 proceeding any further along the list, and an error is generated.
3493
3494 When this option is used by a caller other than root, and the list is different
3495 from the compiled-in list, Exim gives up its root privilege immediately, and
3496 runs with the real and effective uid and gid set to those of the caller.
3497 However, if a TRUSTED_CONFIG_LIST file is defined in &_Local/Makefile_&, that
3498 file contains a list of full pathnames, one per line, for configuration files
3499 which are trusted. Root privilege is retained for any configuration file so
3500 listed, as long as the caller is the Exim user (or the user specified in the
3501 CONFIGURE_OWNER option, if any), and as long as the configuration file is
3502 not writeable by inappropriate users or groups.
3503
3504 Leaving TRUSTED_CONFIG_LIST unset precludes the possibility of testing a
3505 configuration using &%-C%& right through message reception and delivery,
3506 even if the caller is root. The reception works, but by that time, Exim is
3507 running as the Exim user, so when it re-executes to regain privilege for the
3508 delivery, the use of &%-C%& causes privilege to be lost. However, root can
3509 test reception and delivery using two separate commands (one to put a message
3510 on the queue, using &%-odq%&, and another to do the delivery, using &%-M%&).
3511
3512 If ALT_CONFIG_PREFIX is defined &_in Local/Makefile_&, it specifies a
3513 prefix string with which any file named in a &%-C%& command line option
3514 must start. In addition, the file name must not contain the sequence &`/../`&.
3515 However, if the value of the &%-C%& option is identical to the value of
3516 CONFIGURE_FILE in &_Local/Makefile_&, Exim ignores &%-C%& and proceeds as
3517 usual. There is no default setting for ALT_CONFIG_PREFIX; when it is
3518 unset, any file name can be used with &%-C%&.
3519
3520 ALT_CONFIG_PREFIX can be used to confine alternative configuration files
3521 to a directory to which only root has access. This prevents someone who has
3522 broken into the Exim account from running a privileged Exim with an arbitrary
3523 configuration file.
3524
3525 The &%-C%& facility is useful for ensuring that configuration files are
3526 syntactically correct, but cannot be used for test deliveries, unless the
3527 caller is privileged, or unless it is an exotic configuration that does not
3528 require privilege. No check is made on the owner or group of the files
3529 specified by this option.
3530
3531
3532 .vitem &%-D%&<&'macro'&>=<&'value'&>
3533 .oindex "&%-D%&"
3534 .cindex "macro" "setting on command line"
3535 This option can be used to override macro definitions in the configuration file
3536 (see section &<<SECTmacrodefs>>&). However, like &%-C%&, if it is used by an
3537 unprivileged caller, it causes Exim to give up its root privilege.
3538 If DISABLE_D_OPTION is defined in &_Local/Makefile_&, the use of &%-D%& is
3539 completely disabled, and its use causes an immediate error exit.
3540
3541 If WHITELIST_D_MACROS is defined in &_Local/Makefile_& then it should be a
3542 colon-separated list of macros which are considered safe and, if &%-D%& only
3543 supplies macros from this list, and the values are acceptable, then Exim will
3544 not give up root privilege if the caller is root, the Exim run-time user, or
3545 the CONFIGURE_OWNER, if set.  This is a transition mechanism and is expected
3546 to be removed in the future.  Acceptable values for the macros satisfy the
3547 regexp: &`^[A-Za-z0-9_/.-]*$`&
3548
3549 The entire option (including equals sign if present) must all be within one
3550 command line item. &%-D%& can be used to set the value of a macro to the empty
3551 string, in which case the equals sign is optional. These two commands are
3552 synonymous:
3553 .code
3554 exim -DABC  ...
3555 exim -DABC= ...
3556 .endd
3557 To include spaces in a macro definition item, quotes must be used. If you use
3558 quotes, spaces are permitted around the macro name and the equals sign. For
3559 example:
3560 .code
3561 exim '-D ABC = something' ...
3562 .endd
3563 &%-D%& may be repeated up to 10 times on a command line.
3564
3565
3566 .vitem &%-d%&<&'debug&~options'&>
3567 .oindex "&%-d%&"
3568 .cindex "debugging" "list of selectors"
3569 .cindex "debugging" "&%-d%& option"
3570 This option causes debugging information to be written to the standard
3571 error stream. It is restricted to admin users because debugging output may show
3572 database queries that contain password information. Also, the details of users'
3573 filter files should be protected. If a non-admin user uses &%-d%&, Exim
3574 writes an error message to the standard error stream and exits with a non-zero
3575 return code.
3576
3577 When &%-d%& is used, &%-v%& is assumed. If &%-d%& is given on its own, a lot of
3578 standard debugging data is output. This can be reduced, or increased to include
3579 some more rarely needed information, by directly following &%-d%& with a string
3580 made up of names preceded by plus or minus characters. These add or remove sets
3581 of debugging data, respectively. For example, &%-d+filter%& adds filter
3582 debugging, whereas &%-d-all+filter%& selects only filter debugging. Note that
3583 no spaces are allowed in the debug setting. The available debugging categories
3584 are:
3585 .display
3586 &`acl            `& ACL interpretation
3587 &`auth           `& authenticators
3588 &`deliver        `& general delivery logic
3589 &`dns            `& DNS lookups (see also resolver)
3590 &`dnsbl          `& DNS black list (aka RBL) code
3591 &`exec           `& arguments for &[execv()]& calls
3592 &`expand         `& detailed debugging for string expansions
3593 &`filter         `& filter handling
3594 &`hints_lookup   `& hints data lookups
3595 &`host_lookup    `& all types of name-to-IP address handling
3596 &`ident          `& ident lookup
3597 &`interface      `& lists of local interfaces
3598 &`lists          `& matching things in lists
3599 &`load           `& system load checks
3600 &`local_scan     `& can be used by &[local_scan()]& (see chapter &&&
3601                     &<<CHAPlocalscan>>&)
3602 &`lookup         `& general lookup code and all lookups
3603 &`memory         `& memory handling
3604 &`pid            `& add pid to debug output lines
3605 &`process_info   `& setting info for the process log
3606 &`queue_run      `& queue runs
3607 &`receive        `& general message reception logic
3608 &`resolver       `& turn on the DNS resolver's debugging output
3609 &`retry          `& retry handling
3610 &`rewrite        `& address rewriting
3611 &`route          `& address routing
3612 &`timestamp      `& add timestamp to debug output lines
3613 &`tls            `& TLS logic
3614 &`transport      `& transports
3615 &`uid            `& changes of uid/gid and looking up uid/gid
3616 &`verify         `& address verification logic
3617 &`all            `& almost all of the above (see below), and also &%-v%&
3618 .endd
3619 The &`all`& option excludes &`memory`& when used as &`+all`&, but includes it
3620 for &`-all`&. The reason for this is that &`+all`& is something that people
3621 tend to use when generating debug output for Exim maintainers. If &`+memory`&
3622 is included, an awful lot of output that is very rarely of interest is
3623 generated, so it now has to be explicitly requested. However, &`-all`& does
3624 turn everything off.
3625
3626 .cindex "resolver, debugging output"
3627 .cindex "DNS resolver, debugging output"
3628 The &`resolver`& option produces output only if the DNS resolver was compiled
3629 with DEBUG enabled. This is not the case in some operating systems. Also,
3630 unfortunately, debugging output from the DNS resolver is written to stdout
3631 rather than stderr.
3632
3633 The default (&%-d%& with no argument) omits &`expand`&, &`filter`&,
3634 &`interface`&, &`load`&, &`memory`&, &`pid`&, &`resolver`&, and &`timestamp`&.
3635 However, the &`pid`& selector is forced when debugging is turned on for a
3636 daemon, which then passes it on to any re-executed Exims. Exim also
3637 automatically adds the pid to debug lines when several remote deliveries are
3638 run in parallel.
3639
3640 The &`timestamp`& selector causes the current time to be inserted at the start
3641 of all debug output lines. This can be useful when trying to track down delays
3642 in processing.
3643
3644 If the &%debug_print%& option is set in any driver, it produces output whenever
3645 any debugging is selected, or if &%-v%& is used.
3646
3647 .vitem &%-dd%&<&'debug&~options'&>
3648 .oindex "&%-dd%&"
3649 This option behaves exactly like &%-d%& except when used on a command that
3650 starts a daemon process. In that case, debugging is turned off for the
3651 subprocesses that the daemon creates. Thus, it is useful for monitoring the
3652 behaviour of the daemon without creating as much output as full debugging does.
3653
3654 .vitem &%-dropcr%&
3655 .oindex "&%-dropcr%&"
3656 This is an obsolete option that is now a no-op. It used to affect the way Exim
3657 handled CR and LF characters in incoming messages. What happens now is
3658 described in section &<<SECTlineendings>>&.
3659
3660 .vitem &%-E%&
3661 .oindex "&%-E%&"
3662 .cindex "bounce message" "generating"
3663 This option specifies that an incoming message is a locally-generated delivery
3664 failure report. It is used internally by Exim when handling delivery failures
3665 and is not intended for external use. Its only effect is to stop Exim
3666 generating certain messages to the postmaster, as otherwise message cascades
3667 could occur in some situations. As part of the same option, a message id may
3668 follow the characters &%-E%&. If it does, the log entry for the receipt of the
3669 new message contains the id, following &"R="&, as a cross-reference.
3670
3671 .vitem &%-e%&&'x'&
3672 .oindex "&%-e%&&'x'&"
3673 There are a number of Sendmail options starting with &%-oe%& which seem to be
3674 called by various programs without the leading &%o%& in the option. For
3675 example, the &%vacation%& program uses &%-eq%&. Exim treats all options of the
3676 form &%-e%&&'x'& as synonymous with the corresponding &%-oe%&&'x'& options.
3677
3678 .vitem &%-F%&&~<&'string'&>
3679 .oindex "&%-F%&"
3680 .cindex "sender" "name"
3681 .cindex "name" "of sender"
3682 This option sets the sender's full name for use when a locally-generated
3683 message is being accepted. In the absence of this option, the user's &'gecos'&
3684 entry from the password data is used. As users are generally permitted to alter
3685 their &'gecos'& entries, no security considerations are involved. White space
3686 between &%-F%& and the <&'string'&> is optional.
3687
3688 .vitem &%-f%&&~<&'address'&>
3689 .oindex "&%-f%&"
3690 .cindex "sender" "address"
3691 .cindex "address" "sender"
3692 .cindex "trusted users"
3693 .cindex "envelope sender"
3694 .cindex "user" "trusted"
3695 This option sets the address of the envelope sender of a locally-generated
3696 message (also known as the return path). The option can normally be used only
3697 by a trusted user, but &%untrusted_set_sender%& can be set to allow untrusted
3698 users to use it.
3699
3700 Processes running as root or the Exim user are always trusted. Other
3701 trusted users are defined by the &%trusted_users%& or &%trusted_groups%&
3702 options. In the absence of &%-f%&, or if the caller is not trusted, the sender
3703 of a local message is set to the caller's login name at the default qualify
3704 domain.
3705
3706 There is one exception to the restriction on the use of &%-f%&: an empty sender
3707 can be specified by any user, trusted or not, to create a message that can
3708 never provoke a bounce. An empty sender can be specified either as an empty
3709 string, or as a pair of angle brackets with nothing between them, as in these
3710 examples of shell commands:
3711 .code
3712 exim -f '<>' user@domain
3713 exim -f "" user@domain
3714 .endd
3715 In addition, the use of &%-f%& is not restricted when testing a filter file
3716 with &%-bf%& or when testing or verifying addresses using the &%-bt%& or
3717 &%-bv%& options.
3718
3719 Allowing untrusted users to change the sender address does not of itself make
3720 it possible to send anonymous mail. Exim still checks that the &'From:'& header
3721 refers to the local user, and if it does not, it adds a &'Sender:'& header,
3722 though this can be overridden by setting &%no_local_from_check%&.
3723
3724 White
3725 .cindex "&""From""& line"
3726 space between &%-f%& and the <&'address'&> is optional (that is, they can be
3727 given as two arguments or one combined argument). The sender of a
3728 locally-generated message can also be set (when permitted) by an initial
3729 &"From&~"& line in the message &-- see the description of &%-bm%& above &-- but
3730 if &%-f%& is also present, it overrides &"From&~"&.
3731
3732 .vitem &%-G%&
3733 .oindex "&%-G%&"
3734 .cindex "submission fixups, suppressing (command-line)"
3735 .new
3736 This option is equivalent to an ACL applying:
3737 .code
3738 control = suppress_local_fixups
3739 .endd
3740 for every message received.  Note that Sendmail will complain about such
3741 bad formatting, where Exim silently just does not fix it up.  This may change
3742 in future.
3743
3744 As this affects audit information, the caller must be a trusted user to use
3745 this option.
3746 .wen
3747
3748 .vitem &%-h%&&~<&'number'&>
3749 .oindex "&%-h%&"
3750 .cindex "Sendmail compatibility" "&%-h%& option ignored"
3751 This option is accepted for compatibility with Sendmail, but has no effect. (In
3752 Sendmail it overrides the &"hop count"& obtained by counting &'Received:'&
3753 headers.)
3754
3755 .vitem &%-i%&
3756 .oindex "&%-i%&"
3757 .cindex "Solaris" "&'mail'& command"
3758 .cindex "dot" "in incoming non-SMTP message"
3759 This option, which has the same effect as &%-oi%&, specifies that a dot on a
3760 line by itself should not terminate an incoming, non-SMTP message. I can find
3761 no documentation for this option in Solaris 2.4 Sendmail, but the &'mailx'&
3762 command in Solaris 2.4 uses it. See also &%-ti%&.
3763
3764 .new
3765 .vitem &%-L%&&~<&'tag'&>
3766 .oindex "&%-L%&"
3767 .cindex "syslog" "process name; set with flag"
3768 This option is equivalent to setting &%syslog_processname%& in the config
3769 file and setting &%log_file_path%& to &`syslog`&.
3770 Its use is restricted to administrators.  The configuration file has to be
3771 read and parsed, to determine access rights, before this is set and takes
3772 effect, so early configuration file errors will not honour this flag.
3773
3774 The tag should not be longer than 32 characters.
3775 .wen
3776
3777 .vitem &%-M%&&~<&'message&~id'&>&~<&'message&~id'&>&~...
3778 .oindex "&%-M%&"
3779 .cindex "forcing delivery"
3780 .cindex "delivery" "forcing attempt"
3781 .cindex "frozen messages" "forcing delivery"
3782 This option requests Exim to run a delivery attempt on each message in turn. If
3783 any of the messages are frozen, they are automatically thawed before the
3784 delivery attempt. The settings of &%queue_domains%&, &%queue_smtp_domains%&,
3785 and &%hold_domains%& are ignored.
3786
3787 Retry
3788 .cindex "hints database" "overriding retry hints"
3789 hints for any of the addresses are overridden &-- Exim tries to deliver even if
3790 the normal retry time has not yet been reached. This option requires the caller
3791 to be an admin user. However, there is an option called &%prod_requires_admin%&
3792 which can be set false to relax this restriction (and also the same requirement
3793 for the &%-q%&, &%-R%&, and &%-S%& options).
3794
3795 The deliveries happen synchronously, that is, the original Exim process does
3796 not terminate until all the delivery attempts have finished. No output is
3797 produced unless there is a serious error. If you want to see what is happening,
3798 use the &%-v%& option as well, or inspect Exim's main log.
3799
3800 .vitem &%-Mar%&&~<&'message&~id'&>&~<&'address'&>&~<&'address'&>&~...
3801 .oindex "&%-Mar%&"
3802 .cindex "message" "adding recipients"
3803 .cindex "recipient" "adding"
3804 This option requests Exim to add the addresses to the list of recipients of the
3805 message (&"ar"& for &"add recipients"&). The first argument must be a message
3806 id, and the remaining ones must be email addresses. However, if the message is
3807 active (in the middle of a delivery attempt), it is not altered. This option
3808 can be used only by an admin user.
3809
3810 .vitem "&%-MC%&&~<&'transport'&>&~<&'hostname'&>&~<&'sequence&~number'&>&&&
3811         &~<&'message&~id'&>"
3812 .oindex "&%-MC%&"
3813 .cindex "SMTP" "passed connection"
3814 .cindex "SMTP" "multiple deliveries"
3815 .cindex "multiple SMTP deliveries"
3816 This option is not intended for use by external callers. It is used internally
3817 by Exim to invoke another instance of itself to deliver a waiting message using
3818 an existing SMTP connection, which is passed as the standard input. Details are
3819 given in chapter &<<CHAPSMTP>>&. This must be the final option, and the caller
3820 must be root or the Exim user in order to use it.
3821
3822 .vitem &%-MCA%&
3823 .oindex "&%-MCA%&"
3824 This option is not intended for use by external callers. It is used internally
3825 by Exim in conjunction with the &%-MC%& option. It signifies that the
3826 connection to the remote host has been authenticated.
3827
3828 .vitem &%-MCP%&
3829 .oindex "&%-MCP%&"
3830 This option is not intended for use by external callers. It is used internally
3831 by Exim in conjunction with the &%-MC%& option. It signifies that the server to
3832 which Exim is connected supports pipelining.
3833
3834 .vitem &%-MCQ%&&~<&'process&~id'&>&~<&'pipe&~fd'&>
3835 .oindex "&%-MCQ%&"
3836 This option is not intended for use by external callers. It is used internally
3837 by Exim in conjunction with the &%-MC%& option when the original delivery was
3838 started by a queue runner. It passes on the process id of the queue runner,
3839 together with the file descriptor number of an open pipe. Closure of the pipe
3840 signals the final completion of the sequence of processes that are passing
3841 messages through the same SMTP connection.
3842
3843 .vitem &%-MCS%&
3844 .oindex "&%-MCS%&"
3845 This option is not intended for use by external callers. It is used internally
3846 by Exim in conjunction with the &%-MC%& option, and passes on the fact that the
3847 SMTP SIZE option should be used on messages delivered down the existing
3848 connection.
3849
3850 .vitem &%-MCT%&
3851 .oindex "&%-MCT%&"
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 host to which Exim is connected supports TLS encryption.
3855
3856 .vitem &%-Mc%&&~<&'message&~id'&>&~<&'message&~id'&>&~...
3857 .oindex "&%-Mc%&"
3858 .cindex "hints database" "not overridden by &%-Mc%&"
3859 .cindex "delivery" "manually started &-- not forced"
3860 This option requests Exim to run a delivery attempt on each message in turn,
3861 but unlike the &%-M%& option, it does check for retry hints, and respects any
3862 that are found. This option is not very useful to external callers. It is
3863 provided mainly for internal use by Exim when it needs to re-invoke itself in
3864 order to regain root privilege for a delivery (see chapter &<<CHAPsecurity>>&).
3865 However, &%-Mc%& can be useful when testing, in order to run a delivery that
3866 respects retry times and other options such as &%hold_domains%& that are
3867 overridden when &%-M%& is used. Such a delivery does not count as a queue run.
3868 If you want to run a specific delivery as if in a queue run, you should use
3869 &%-q%& with a message id argument. A distinction between queue run deliveries
3870 and other deliveries is made in one or two places.
3871
3872 .vitem &%-Mes%&&~<&'message&~id'&>&~<&'address'&>
3873 .oindex "&%-Mes%&"
3874 .cindex "message" "changing sender"
3875 .cindex "sender" "changing"
3876 This option requests Exim to change the sender address in the message to the
3877 given address, which must be a fully qualified address or &"<>"& (&"es"& for
3878 &"edit sender"&). There must be exactly two arguments. The first argument must
3879 be a message id, and the second one an email address. However, if the message
3880 is active (in the middle of a delivery attempt), its status is not altered.
3881 This option can be used only by an admin user.
3882
3883 .vitem &%-Mf%&&~<&'message&~id'&>&~<&'message&~id'&>&~...
3884 .oindex "&%-Mf%&"
3885 .cindex "freezing messages"
3886 .cindex "message" "manually freezing"
3887 This option requests Exim to mark each listed message as &"frozen"&. This
3888 prevents any delivery attempts taking place until the message is &"thawed"&,
3889 either manually or as a result of the &%auto_thaw%& configuration option.
3890 However, if any of the messages are active (in the middle of a delivery
3891 attempt), their status is not altered. This option can be used only by an admin
3892 user.
3893
3894 .vitem &%-Mg%&&~<&'message&~id'&>&~<&'message&~id'&>&~...
3895 .oindex "&%-Mg%&"
3896 .cindex "giving up on messages"
3897 .cindex "message" "abandoning delivery attempts"
3898 .cindex "delivery" "abandoning further attempts"
3899 This option requests Exim to give up trying to deliver the listed messages,
3900 including any that are frozen. However, if any of the messages are active,
3901 their status is not altered. For non-bounce messages, a delivery error message
3902 is sent to the sender, containing the text &"cancelled by administrator"&.
3903 Bounce messages are just discarded. This option can be used only by an admin
3904 user.
3905
3906 .vitem &%-Mmad%&&~<&'message&~id'&>&~<&'message&~id'&>&~...
3907 .oindex "&%-Mmad%&"
3908 .cindex "delivery" "cancelling all"
3909 This option requests Exim to mark all the recipient addresses in the messages
3910 as already delivered (&"mad"& for &"mark all delivered"&). However, if any
3911 message is active (in the middle of a delivery attempt), its status is not
3912 altered. This option can be used only by an admin user.
3913
3914 .vitem &%-Mmd%&&~<&'message&~id'&>&~<&'address'&>&~<&'address'&>&~...
3915 .oindex "&%-Mmd%&"
3916 .cindex "delivery" "cancelling by address"
3917 .cindex "recipient" "removing"
3918 .cindex "removing recipients"
3919 This option requests Exim to mark the given addresses as already delivered
3920 (&"md"& for &"mark delivered"&). The first argument must be a message id, and
3921 the remaining ones must be email addresses. These are matched to recipient
3922 addresses in the message in a case-sensitive manner. If the message is active
3923 (in the middle of a delivery attempt), its status is not altered. This option
3924 can be used only by an admin user.
3925
3926 .vitem &%-Mrm%&&~<&'message&~id'&>&~<&'message&~id'&>&~...
3927 .oindex "&%-Mrm%&"
3928 .cindex "removing messages"
3929 .cindex "abandoning mail"
3930 .cindex "message" "manually discarding"
3931 This option requests Exim to remove the given messages from the queue. No
3932 bounce messages are sent; each message is simply forgotten. However, if any of
3933 the messages are active, their status is not altered. This option can be used
3934 only by an admin user or by the user who originally caused the message to be
3935 placed on the queue.
3936
3937 .vitem &%-Mset%&&~<&'message&~id'&>
3938 .oindex "&%-Mset%&
3939 .cindex "testing" "string expansion"
3940 .cindex "expansion" "testing"
3941 This option is useful only in conjunction with &%-be%& (that is, when testing
3942 string expansions). Exim loads the given message from its spool before doing
3943 the test expansions, thus setting message-specific variables such as
3944 &$message_size$& and the header variables. The &$recipients$& variable is made
3945 available. This feature is provided to make it easier to test expansions that
3946 make use of these variables. However, this option can be used only by an admin
3947 user. See also &%-bem%&.
3948
3949 .vitem &%-Mt%&&~<&'message&~id'&>&~<&'message&~id'&>&~...
3950 .oindex "&%-Mt%&"
3951 .cindex "thawing messages"
3952 .cindex "unfreezing messages"
3953 .cindex "frozen messages" "thawing"
3954 .cindex "message" "thawing frozen"
3955 This option requests Exim to &"thaw"& any of the listed messages that are
3956 &"frozen"&, so that delivery attempts can resume. However, if any of the
3957 messages are active, their status is not altered. This option can be used only
3958 by an admin user.
3959
3960 .vitem &%-Mvb%&&~<&'message&~id'&>
3961 .oindex "&%-Mvb%&"
3962 .cindex "listing" "message body"
3963 .cindex "message" "listing body of"
3964 This option causes the contents of the message body (-D) spool file to be
3965 written to the standard output. This option can be used only by an admin user.
3966
3967 .vitem &%-Mvc%&&~<&'message&~id'&>
3968 .oindex "&%-Mvc%&"
3969 .cindex "message" "listing in RFC 2822 format"
3970 .cindex "listing" "message in RFC 2822 format"
3971 This option causes a copy of the complete message (header lines plus body) to
3972 be written to the standard output in RFC 2822 format. This option can be used
3973 only by an admin user.
3974
3975 .vitem &%-Mvh%&&~<&'message&~id'&>
3976 .oindex "&%-Mvh%&"
3977 .cindex "listing" "message headers"
3978 .cindex "header lines" "listing"
3979 .cindex "message" "listing header lines"
3980 This option causes the contents of the message headers (-H) spool file to be
3981 written to the standard output. This option can be used only by an admin user.
3982
3983 .vitem &%-Mvl%&&~<&'message&~id'&>
3984 .oindex "&%-Mvl%&"
3985 .cindex "listing" "message log"
3986 .cindex "message" "listing message log"
3987 This option causes the contents of the message log spool file to be written to
3988 the standard output. This option can be used only by an admin user.
3989
3990 .vitem &%-m%&
3991 .oindex "&%-m%&"
3992 This is apparently a synonym for &%-om%& that is accepted by Sendmail, so Exim
3993 treats it that way too.
3994
3995 .vitem &%-N%&
3996 .oindex "&%-N%&"
3997 .cindex "debugging" "&%-N%& option"
3998 .cindex "debugging" "suppressing delivery"
3999 This is a debugging option that inhibits delivery of a message at the transport
4000 level. It implies &%-v%&. Exim goes through many of the motions of delivery &--
4001 it just doesn't actually transport the message, but instead behaves as if it
4002 had successfully done so. However, it does not make any updates to the retry
4003 database, and the log entries for deliveries are flagged with &"*>"& rather
4004 than &"=>"&.
4005
4006 Because &%-N%& discards any message to which it applies, only root or the Exim
4007 user are allowed to use it with &%-bd%&, &%-q%&, &%-R%& or &%-M%&. In other
4008 words, an ordinary user can use it only when supplying an incoming message to
4009 which it will apply. Although transportation never fails when &%-N%& is set, an
4010 address may be deferred because of a configuration problem on a transport, or a
4011 routing problem. Once &%-N%& has been used for a delivery attempt, it sticks to
4012 the message, and applies to any subsequent delivery attempts that may happen
4013 for that message.
4014
4015 .new
4016 .vitem &%-n%&
4017 .oindex "&%-n%&"
4018 This option is interpreted by Sendmail to mean &"no aliasing"&.
4019 For normal modes of operation, it is ignored by Exim.
4020 When combined with &%-bP%& it suppresses the name of an option from being output.
4021 .wen
4022
4023 .vitem &%-O%&&~<&'data'&>
4024 .oindex "&%-O%&"
4025 This option is interpreted by Sendmail to mean &`set option`&. It is ignored by
4026 Exim.
4027
4028 .vitem &%-oA%&&~<&'file&~name'&>
4029 .oindex "&%-oA%&"
4030 .cindex "Sendmail compatibility" "&%-oA%& option"
4031 This option is used by Sendmail in conjunction with &%-bi%& to specify an
4032 alternative alias file name. Exim handles &%-bi%& differently; see the
4033 description above.
4034
4035 .vitem &%-oB%&&~<&'n'&>
4036 .oindex "&%-oB%&"
4037 .cindex "SMTP" "passed connection"
4038 .cindex "SMTP" "multiple deliveries"
4039 .cindex "multiple SMTP deliveries"
4040 This is a debugging option which limits the maximum number of messages that can
4041 be delivered down one SMTP connection, overriding the value set in any &(smtp)&
4042 transport. If <&'n'&> is omitted, the limit is set to 1.
4043
4044 .vitem &%-odb%&
4045 .oindex "&%-odb%&"
4046 .cindex "background delivery"
4047 .cindex "delivery" "in the background"
4048 This option applies to all modes in which Exim accepts incoming messages,
4049 including the listening daemon. It requests &"background"& delivery of such
4050 messages, which means that the accepting process automatically starts a
4051 delivery process for each message received, but does not wait for the delivery
4052 processes to finish.
4053
4054 When all the messages have been received, the reception process exits,
4055 leaving the delivery processes to finish in their own time. The standard output
4056 and error streams are closed at the start of each delivery process.
4057 This is the default action if none of the &%-od%& options are present.
4058
4059 If one of the queueing options in the configuration file
4060 (&%queue_only%& or &%queue_only_file%&, for example) is in effect, &%-odb%&
4061 overrides it if &%queue_only_override%& is set true, which is the default
4062 setting. If &%queue_only_override%& is set false, &%-odb%& has no effect.
4063
4064 .vitem &%-odf%&
4065 .oindex "&%-odf%&"
4066 .cindex "foreground delivery"
4067 .cindex "delivery" "in the foreground"
4068 This option requests &"foreground"& (synchronous) delivery when Exim has
4069 accepted a locally-generated message. (For the daemon it is exactly the same as
4070 &%-odb%&.) A delivery process is automatically started to deliver the message,
4071 and Exim waits for it to complete before proceeding.
4072
4073 The original Exim reception process does not finish until the delivery
4074 process for the final message has ended. The standard error stream is left open
4075 during deliveries.
4076
4077 However, like &%-odb%&, this option has no effect if &%queue_only_override%& is
4078 false and one of the queueing options in the configuration file is in effect.
4079
4080 If there is a temporary delivery error during foreground delivery, the
4081 message is left on the queue for later delivery, and the original reception
4082 process exits. See chapter &<<CHAPnonqueueing>>& for a way of setting up a
4083 restricted configuration that never queues messages.
4084
4085
4086 .vitem &%-odi%&
4087 .oindex "&%-odi%&"
4088 This option is synonymous with &%-odf%&. It is provided for compatibility with
4089 Sendmail.
4090
4091 .vitem &%-odq%&
4092 .oindex "&%-odq%&"
4093 .cindex "non-immediate delivery"
4094 .cindex "delivery" "suppressing immediate"
4095 .cindex "queueing incoming messages"
4096 This option applies to all modes in which Exim accepts incoming messages,
4097 including the listening daemon. It specifies that the accepting process should
4098 not automatically start a delivery process for each message received. Messages
4099 are placed on the queue, and remain there until a subsequent queue runner
4100 process encounters them. There are several configuration options (such as
4101 &%queue_only%&) that can be used to queue incoming messages under certain
4102 conditions. This option overrides all of them and also &%-odqs%&. It always
4103 forces queueing.
4104
4105 .vitem &%-odqs%&
4106 .oindex "&%-odqs%&"
4107 .cindex "SMTP" "delaying delivery"
4108 This option is a hybrid between &%-odb%&/&%-odi%& and &%-odq%&.
4109 However, like &%-odb%& and &%-odi%&, this option has no effect if
4110 &%queue_only_override%& is false and one of the queueing options in the
4111 configuration file is in effect.
4112
4113 When &%-odqs%& does operate, a delivery process is started for each incoming
4114 message, in the background by default, but in the foreground if &%-odi%& is
4115 also present. The recipient addresses are routed, and local deliveries are done
4116 in the normal way. However, if any SMTP deliveries are required, they are not
4117 done at this time, so the message remains on the queue until a subsequent queue
4118 runner process encounters it. Because routing was done, Exim knows which
4119 messages are waiting for which hosts, and so a number of messages for the same
4120 host can be sent in a single SMTP connection. The &%queue_smtp_domains%&
4121 configuration option has the same effect for specific domains. See also the
4122 &%-qq%& option.
4123
4124 .vitem &%-oee%&
4125 .oindex "&%-oee%&"
4126 .cindex "error" "reporting"
4127 If an error is detected while a non-SMTP message is being received (for
4128 example, a malformed address), the error is reported to the sender in a mail
4129 message.
4130
4131 .cindex "return code" "for &%-oee%&"
4132 Provided
4133 this error message is successfully sent, the Exim receiving process
4134 exits with a return code of zero. If not, the return code is 2 if the problem
4135 is that the original message has no recipients, or 1 for any other error.
4136 This is the default &%-oe%&&'x'& option if Exim is called as &'rmail'&.
4137
4138 .vitem &%-oem%&
4139 .oindex "&%-oem%&"
4140 .cindex "error" "reporting"
4141 .cindex "return code" "for &%-oem%&"
4142 This is the same as &%-oee%&, except that Exim always exits with a non-zero
4143 return code, whether or not the error message was successfully sent.
4144 This is the default &%-oe%&&'x'& option, unless Exim is called as &'rmail'&.
4145
4146 .vitem &%-oep%&
4147 .oindex "&%-oep%&"
4148 .cindex "error" "reporting"
4149 If an error is detected while a non-SMTP message is being received, the
4150 error is reported by writing a message to the standard error file (stderr).
4151 .cindex "return code" "for &%-oep%&"
4152 The return code is 1 for all errors.
4153
4154 .vitem &%-oeq%&
4155 .oindex "&%-oeq%&"
4156 .cindex "error" "reporting"
4157 This option is supported for compatibility with Sendmail, but has the same
4158 effect as &%-oep%&.
4159
4160 .vitem &%-oew%&
4161 .oindex "&%-oew%&"
4162 .cindex "error" "reporting"
4163 This option is supported for compatibility with Sendmail, but has the same
4164 effect as &%-oem%&.
4165
4166 .vitem &%-oi%&
4167 .oindex "&%-oi%&"
4168 .cindex "dot" "in incoming non-SMTP message"
4169 This option, which has the same effect as &%-i%&, specifies that a dot on a
4170 line by itself should not terminate an incoming, non-SMTP message. Otherwise, a
4171 single dot does terminate, though Exim does no special processing for other
4172 lines that start with a dot. This option is set by default if Exim is called as
4173 &'rmail'&. See also &%-ti%&.
4174
4175 .vitem &%-oitrue%&
4176 .oindex "&%-oitrue%&"
4177 This option is treated as synonymous with &%-oi%&.
4178
4179 .vitem &%-oMa%&&~<&'host&~address'&>
4180 .oindex "&%-oMa%&"
4181 .cindex "sender" "host address, specifying for local message"
4182 A number of options starting with &%-oM%& can be used to set values associated
4183 with remote hosts on locally-submitted messages (that is, messages not received
4184 over TCP/IP). These options can be used by any caller in conjunction with the
4185 &%-bh%&, &%-be%&, &%-bf%&, &%-bF%&, &%-bt%&, or &%-bv%& testing options. In
4186 other circumstances, they are ignored unless the caller is trusted.
4187
4188 The &%-oMa%& option sets the sender host address. This may include a port
4189 number at the end, after a full stop (period). For example:
4190 .code
4191 exim -bs -oMa 10.9.8.7.1234
4192 .endd
4193 An alternative syntax is to enclose the IP address in square brackets,
4194 followed by a colon and the port number:
4195 .code
4196 exim -bs -oMa [10.9.8.7]:1234
4197 .endd
4198 The IP address is placed in the &$sender_host_address$& variable, and the
4199 port, if present, in &$sender_host_port$&. If both &%-oMa%& and &%-bh%&
4200 are present on the command line, the sender host IP address is taken from
4201 whichever one is last.
4202
4203 .vitem &%-oMaa%&&~<&'name'&>
4204 .oindex "&%-oMaa%&"
4205 .cindex "authentication" "name, specifying for local message"
4206 See &%-oMa%& above for general remarks about the &%-oM%& options. The &%-oMaa%&
4207 option sets the value of &$sender_host_authenticated$& (the authenticator
4208 name). See chapter &<<CHAPSMTPAUTH>>& for a discussion of SMTP authentication.
4209 This option can be used with &%-bh%& and &%-bs%& to set up an
4210 authenticated SMTP session without actually using the SMTP AUTH command.
4211
4212 .vitem &%-oMai%&&~<&'string'&>
4213 .oindex "&%-oMai%&"
4214 .cindex "authentication" "id, specifying for local message"
4215 See &%-oMa%& above for general remarks about the &%-oM%& options. The &%-oMai%&
4216 option sets the value of &$authenticated_id$& (the id that was authenticated).
4217 This overrides the default value (the caller's login id, except with &%-bh%&,
4218 where there is no default) for messages from local sources. See chapter
4219 &<<CHAPSMTPAUTH>>& for a discussion of authenticated ids.
4220
4221 .vitem &%-oMas%&&~<&'address'&>
4222 .oindex "&%-oMas%&"
4223 .cindex "authentication" "sender, specifying for local message"
4224 See &%-oMa%& above for general remarks about the &%-oM%& options. The &%-oMas%&
4225 option sets the authenticated sender value in &$authenticated_sender$&. It
4226 overrides the sender address that is created from the caller's login id for
4227 messages from local sources, except when &%-bh%& is used, when there is no
4228 default. For both &%-bh%& and &%-bs%&, an authenticated sender that is
4229 specified on a MAIL command overrides this value. See chapter
4230 &<<CHAPSMTPAUTH>>& for a discussion of authenticated senders.
4231
4232 .vitem &%-oMi%&&~<&'interface&~address'&>
4233 .oindex "&%-oMi%&"
4234 .cindex "interface" "address, specifying for local message"
4235 See &%-oMa%& above for general remarks about the &%-oM%& options. The &%-oMi%&
4236 option sets the IP interface address value. A port number may be included,
4237 using the same syntax as for &%-oMa%&. The interface address is placed in
4238 &$received_ip_address$& and the port number, if present, in &$received_port$&.
4239
4240 .vitem &%-oMr%&&~<&'protocol&~name'&>
4241 .oindex "&%-oMr%&"
4242 .cindex "protocol, specifying for local message"
4243 .vindex "&$received_protocol$&"
4244 See &%-oMa%& above for general remarks about the &%-oM%& options. The &%-oMr%&
4245 option sets the received protocol value that is stored in
4246 &$received_protocol$&. However, it does not apply (and is ignored) when &%-bh%&
4247 or &%-bs%& is used. For &%-bh%&, the protocol is forced to one of the standard
4248 SMTP protocol names (see the description of &$received_protocol$& in section
4249 &<<SECTexpvar>>&). For &%-bs%&, the protocol is always &"local-"& followed by
4250 one of those same names. For &%-bS%& (batched SMTP) however, the protocol can
4251 be set by &%-oMr%&.
4252
4253 .vitem &%-oMs%&&~<&'host&~name'&>
4254 .oindex "&%-oMs%&"
4255 .cindex "sender" "host name, specifying for local message"
4256 See &%-oMa%& above for general remarks about the &%-oM%& options. The &%-oMs%&
4257 option sets the sender host name in &$sender_host_name$&. When this option is
4258 present, Exim does not attempt to look up a host name from an IP address; it
4259 uses the name it is given.
4260
4261 .vitem &%-oMt%&&~<&'ident&~string'&>
4262 .oindex "&%-oMt%&"
4263 .cindex "sender" "ident string, specifying for local message"
4264 See &%-oMa%& above for general remarks about the &%-oM%& options. The &%-oMt%&
4265 option sets the sender ident value in &$sender_ident$&. The default setting for
4266 local callers is the login id of the calling process, except when &%-bh%& is
4267 used, when there is no default.
4268
4269 .vitem &%-om%&
4270 .oindex "&%-om%&"
4271 .cindex "Sendmail compatibility" "&%-om%& option ignored"
4272 In Sendmail, this option means &"me too"&, indicating that the sender of a
4273 message should receive a copy of the message if the sender appears in an alias
4274 expansion. Exim always does this, so the option does nothing.
4275
4276 .vitem &%-oo%&
4277 .oindex "&%-oo%&"
4278 .cindex "Sendmail compatibility" "&%-oo%& option ignored"
4279 This option is ignored. In Sendmail it specifies &"old style headers"&,
4280 whatever that means.
4281
4282 .vitem &%-oP%&&~<&'path'&>
4283 .oindex "&%-oP%&"
4284 .cindex "pid (process id)" "of daemon"
4285 .cindex "daemon" "process id (pid)"
4286 This option is useful only in conjunction with &%-bd%& or &%-q%& with a time
4287 value. The option specifies the file to which the process id of the daemon is
4288 written. When &%-oX%& is used with &%-bd%&, or when &%-q%& with a time is used
4289 without &%-bd%&, this is the only way of causing Exim to write a pid file,
4290 because in those cases, the normal pid file is not used.
4291
4292 .vitem &%-or%&&~<&'time'&>
4293 .oindex "&%-or%&"
4294 .cindex "timeout" "for non-SMTP input"
4295 This option sets a timeout value for incoming non-SMTP messages. If it is not
4296 set, Exim will wait forever for the standard input. The value can also be set
4297 by the &%receive_timeout%& option. The format used for specifying times is
4298 described in section &<<SECTtimeformat>>&.
4299
4300 .vitem &%-os%&&~<&'time'&>
4301 .oindex "&%-os%&"
4302 .cindex "timeout" "for SMTP input"
4303 .cindex "SMTP" "input timeout"
4304 This option sets a timeout value for incoming SMTP messages. The timeout
4305 applies to each SMTP command and block of data. The value can also be set by
4306 the &%smtp_receive_timeout%& option; it defaults to 5 minutes. The format used
4307 for specifying times is described in section &<<SECTtimeformat>>&.
4308
4309 .vitem &%-ov%&
4310 .oindex "&%-ov%&"
4311 This option has exactly the same effect as &%-v%&.
4312
4313 .vitem &%-oX%&&~<&'number&~or&~string'&>
4314 .oindex "&%-oX%&"
4315 .cindex "TCP/IP" "setting listening ports"
4316 .cindex "TCP/IP" "setting listening interfaces"
4317 .cindex "port" "receiving TCP/IP"
4318 This option is relevant only when the &%-bd%& (start listening daemon) option
4319 is also given. It controls which ports and interfaces the daemon uses. Details
4320 of the syntax, and how it interacts with configuration file options, are given
4321 in chapter &<<CHAPinterfaces>>&. When &%-oX%& is used to start a daemon, no pid
4322 file is written unless &%-oP%& is also present to specify a pid file name.
4323
4324 .vitem &%-pd%&
4325 .oindex "&%-pd%&"
4326 .cindex "Perl" "starting the interpreter"
4327 This option applies when an embedded Perl interpreter is linked with Exim (see
4328 chapter &<<CHAPperl>>&). It overrides the setting of the &%perl_at_start%&
4329 option, forcing the starting of the interpreter to be delayed until it is
4330 needed.
4331
4332 .vitem &%-ps%&
4333 .oindex "&%-ps%&"
4334 .cindex "Perl" "starting the interpreter"
4335 This option applies when an embedded Perl interpreter is linked with Exim (see
4336 chapter &<<CHAPperl>>&). It overrides the setting of the &%perl_at_start%&
4337 option, forcing the starting of the interpreter to occur as soon as Exim is
4338 started.
4339
4340 .vitem &%-p%&<&'rval'&>:<&'sval'&>
4341 .oindex "&%-p%&"
4342 For compatibility with Sendmail, this option is equivalent to
4343 .display
4344 &`-oMr`& <&'rval'&> &`-oMs`& <&'sval'&>
4345 .endd
4346 It sets the incoming protocol and host name (for trusted callers). The
4347 host name and its colon can be omitted when only the protocol is to be set.
4348 Note the Exim already has two private options, &%-pd%& and &%-ps%&, that refer
4349 to embedded Perl. It is therefore impossible to set a protocol value of &`d`&
4350 or &`s`& using this option (but that does not seem a real limitation).
4351
4352 .vitem &%-q%&
4353 .oindex "&%-q%&"
4354 .cindex "queue runner" "starting manually"
4355 This option is normally restricted to admin users. However, there is a
4356 configuration option called &%prod_requires_admin%& which can be set false to
4357 relax this restriction (and also the same requirement for the &%-M%&, &%-R%&,
4358 and &%-S%& options).
4359
4360 .cindex "queue runner" "description of operation"
4361 The &%-q%& option starts one queue runner process. This scans the queue of
4362 waiting messages, and runs a delivery process for each one in turn. It waits
4363 for each delivery process to finish before starting the next one. A delivery
4364 process may not actually do any deliveries if the retry times for the addresses
4365 have not been reached. Use &%-qf%& (see below) if you want to override this.
4366
4367 If
4368 .cindex "SMTP" "passed connection"
4369 .cindex "SMTP" "multiple deliveries"
4370 .cindex "multiple SMTP deliveries"
4371 the delivery process spawns other processes to deliver other messages down
4372 passed SMTP connections, the queue runner waits for these to finish before
4373 proceeding.
4374
4375 When all the queued messages have been considered, the original queue runner
4376 process terminates. In other words, a single pass is made over the waiting
4377 mail, one message at a time. Use &%-q%& with a time (see below) if you want
4378 this to be repeated periodically.
4379
4380 Exim processes the waiting messages in an unpredictable order. It isn't very
4381 random, but it is likely to be different each time, which is all that matters.
4382 If one particular message screws up a remote MTA, other messages to the same
4383 MTA have a chance of getting through if they get tried first.
4384
4385 It is possible to cause the messages to be processed in lexical message id
4386 order, which is essentially the order in which they arrived, by setting the
4387 &%queue_run_in_order%& option, but this is not recommended for normal use.
4388
4389 .vitem &%-q%&<&'qflags'&>
4390 The &%-q%& option may be followed by one or more flag letters that change its
4391 behaviour. They are all optional, but if more than one is present, they must
4392 appear in the correct order. Each flag is described in a separate item below.
4393
4394 .vitem &%-qq...%&
4395 .oindex "&%-qq%&"
4396 .cindex "queue" "double scanning"
4397 .cindex "queue" "routing"
4398 .cindex "routing" "whole queue before delivery"
4399 An option starting with &%-qq%& requests a two-stage queue run. In the first
4400 stage, the queue is scanned as if the &%queue_smtp_domains%& option matched
4401 every domain. Addresses are routed, local deliveries happen, but no remote
4402 transports are run.
4403
4404 .cindex "hints database" "remembering routing"
4405 The hints database that remembers which messages are waiting for specific hosts
4406 is updated, as if delivery to those hosts had been deferred. After this is
4407 complete, a second, normal queue scan happens, with routing and delivery taking
4408 place as normal. Messages that are routed to the same host should mostly be
4409 delivered down a single SMTP
4410 .cindex "SMTP" "passed connection"
4411 .cindex "SMTP" "multiple deliveries"
4412 .cindex "multiple SMTP deliveries"
4413 connection because of the hints that were set up during the first queue scan.
4414 This option may be useful for hosts that are connected to the Internet
4415 intermittently.
4416
4417 .vitem &%-q[q]i...%&
4418 .oindex "&%-qi%&"
4419 .cindex "queue" "initial delivery"
4420 If the &'i'& flag is present, the queue runner runs delivery processes only for
4421 those messages that haven't previously been tried. (&'i'& stands for &"initial
4422 delivery"&.) This can be helpful if you are putting messages on the queue using
4423 &%-odq%& and want a queue runner just to process the new messages.
4424
4425 .vitem &%-q[q][i]f...%&
4426 .oindex "&%-qf%&"
4427 .cindex "queue" "forcing delivery"
4428 .cindex "delivery" "forcing in queue run"
4429 If one &'f'& flag is present, a delivery attempt is forced for each non-frozen
4430 message, whereas without &'f'& only those non-frozen addresses that have passed
4431 their retry times are tried.
4432
4433 .vitem &%-q[q][i]ff...%&
4434 .oindex "&%-qff%&"
4435 .cindex "frozen messages" "forcing delivery"
4436 If &'ff'& is present, a delivery attempt is forced for every message, whether
4437 frozen or not.
4438
4439 .vitem &%-q[q][i][f[f]]l%&
4440 .oindex "&%-ql%&"
4441 .cindex "queue" "local deliveries only"
4442 The &'l'& (the letter &"ell"&) flag specifies that only local deliveries are to
4443 be done. If a message requires any remote deliveries, it remains on the queue
4444 for later delivery.
4445
4446 .vitem &%-q%&<&'qflags'&>&~<&'start&~id'&>&~<&'end&~id'&>
4447 .cindex "queue" "delivering specific messages"
4448 When scanning the queue, Exim can be made to skip over messages whose ids are
4449 lexically less than a given value by following the &%-q%& option with a
4450 starting message id. For example:
4451 .code
4452 exim -q 0t5C6f-0000c8-00
4453 .endd
4454 Messages that arrived earlier than &`0t5C6f-0000c8-00`& are not inspected. If a
4455 second message id is given, messages whose ids are lexically greater than it
4456 are also skipped. If the same id is given twice, for example,
4457 .code
4458 exim -q 0t5C6f-0000c8-00 0t5C6f-0000c8-00
4459 .endd
4460 just one delivery process is started, for that message. This differs from
4461 &%-M%& in that retry data is respected, and it also differs from &%-Mc%& in
4462 that it counts as a delivery from a queue run. Note that the selection
4463 mechanism does not affect the order in which the messages are scanned. There
4464 are also other ways of selecting specific sets of messages for delivery in a
4465 queue run &-- see &%-R%& and &%-S%&.
4466
4467 .vitem &%-q%&<&'qflags'&><&'time'&>
4468 .cindex "queue runner" "starting periodically"
4469 .cindex "periodic queue running"
4470 When a time value is present, the &%-q%& option causes Exim to run as a daemon,
4471 starting a queue runner process at intervals specified by the given time value
4472 (whose format is described in section &<<SECTtimeformat>>&). This form of the
4473 &%-q%& option is commonly combined with the &%-bd%& option, in which case a
4474 single daemon process handles both functions. A common way of starting up a
4475 combined daemon at system boot time is to use a command such as
4476 .code
4477 /usr/exim/bin/exim -bd -q30m
4478 .endd
4479 Such a daemon listens for incoming SMTP calls, and also starts a queue runner
4480 process every 30 minutes.
4481
4482 When a daemon is started by &%-q%& with a time value, but without &%-bd%&, no
4483 pid file is written unless one is explicitly requested by the &%-oP%& option.
4484
4485 .vitem &%-qR%&<&'rsflags'&>&~<&'string'&>
4486 .oindex "&%-qR%&"
4487 This option is synonymous with &%-R%&. It is provided for Sendmail
4488 compatibility.
4489
4490 .vitem &%-qS%&<&'rsflags'&>&~<&'string'&>
4491 .oindex "&%-qS%&"
4492 This option is synonymous with &%-S%&.
4493
4494 .vitem &%-R%&<&'rsflags'&>&~<&'string'&>
4495 .oindex "&%-R%&"
4496 .cindex "queue runner" "for specific recipients"
4497 .cindex "delivery" "to given domain"
4498 .cindex "domain" "delivery to"
4499 The <&'rsflags'&> may be empty, in which case the white space before the string
4500 is optional, unless the string is &'f'&, &'ff'&, &'r'&, &'rf'&, or &'rff'&,
4501 which are the possible values for <&'rsflags'&>. White space is required if
4502 <&'rsflags'&> is not empty.
4503
4504 This option is similar to &%-q%& with no time value, that is, it causes Exim to
4505 perform a single queue run, except that, when scanning the messages on the
4506 queue, Exim processes only those that have at least one undelivered recipient
4507 address containing the given string, which is checked in a case-independent
4508 way. If the <&'rsflags'&> start with &'r'&, <&'string'&> is interpreted as a
4509 regular expression; otherwise it is a literal string.
4510
4511 If you want to do periodic queue runs for messages with specific recipients,
4512 you can combine &%-R%& with &%-q%& and a time value. For example:
4513 .code
4514 exim -q25m -R @special.domain.example
4515 .endd
4516 This example does a queue run for messages with recipients in the given domain
4517 every 25 minutes. Any additional flags that are specified with &%-q%& are
4518 applied to each queue run.
4519
4520 Once a message is selected for delivery by this mechanism, all its addresses
4521 are processed. For the first selected message, Exim overrides any retry
4522 information and forces a delivery attempt for each undelivered address. This
4523 means that if delivery of any address in the first message is successful, any
4524 existing retry information is deleted, and so delivery attempts for that
4525 address in subsequently selected messages (which are processed without forcing)
4526 will run. However, if delivery of any address does not succeed, the retry
4527 information is updated, and in subsequently selected messages, the failing
4528 address will be skipped.
4529
4530 .cindex "frozen messages" "forcing delivery"
4531 If the <&'rsflags'&> contain &'f'& or &'ff'&, the delivery forcing applies to
4532 all selected messages, not just the first; frozen messages are included when
4533 &'ff'& is present.
4534
4535 The &%-R%& option makes it straightforward to initiate delivery of all messages
4536 to a given domain after a host has been down for some time. When the SMTP
4537 command ETRN is accepted by its ACL (see chapter &<<CHAPACL>>&), its default
4538 effect is to run Exim with the &%-R%& option, but it can be configured to run
4539 an arbitrary command instead.
4540
4541 .vitem &%-r%&
4542 .oindex "&%-r%&"
4543 This is a documented (for Sendmail) obsolete alternative name for &%-f%&.
4544
4545 .vitem &%-S%&<&'rsflags'&>&~<&'string'&>
4546 .oindex "&%-S%&"
4547 .cindex "delivery" "from given sender"
4548 .cindex "queue runner" "for specific senders"
4549 This option acts like &%-R%& except that it checks the string against each
4550 message's sender instead of against the recipients. If &%-R%& is also set, both
4551 conditions must be met for a message to be selected. If either of the options
4552 has &'f'& or &'ff'& in its flags, the associated action is taken.
4553
4554 .vitem &%-Tqt%&&~<&'times'&>
4555 .oindex "&%-Tqt%&"
4556 This is an option that is exclusively for use by the Exim testing suite. It is not
4557 recognized when Exim is run normally. It allows for the setting up of explicit
4558 &"queue times"& so that various warning/retry features can be tested.
4559
4560 .vitem &%-t%&
4561 .oindex "&%-t%&"
4562 .cindex "recipient" "extracting from header lines"
4563 .cindex "&'Bcc:'& header line"
4564 .cindex "&'Cc:'& header line"
4565 .cindex "&'To:'& header line"
4566 When Exim is receiving a locally-generated, non-SMTP message on its standard
4567 input, the &%-t%& option causes the recipients of the message to be obtained
4568 from the &'To:'&, &'Cc:'&, and &'Bcc:'& header lines in the message instead of
4569 from the command arguments. The addresses are extracted before any rewriting
4570 takes place and the &'Bcc:'& header line, if present, is then removed.
4571
4572 .cindex "Sendmail compatibility" "&%-t%& option"
4573 If the command has any arguments, they specify addresses to which the message
4574 is &'not'& to be delivered. That is, the argument addresses are removed from
4575 the recipients list obtained from the headers. This is compatible with Smail 3
4576 and in accordance with the documented behaviour of several versions of
4577 Sendmail, as described in man pages on a number of operating systems (e.g.
4578 Solaris 8, IRIX 6.5, HP-UX 11). However, some versions of Sendmail &'add'&
4579 argument addresses to those obtained from the headers, and the O'Reilly
4580 Sendmail book documents it that way. Exim can be made to add argument addresses
4581 instead of subtracting them by setting the option
4582 &%extract_addresses_remove_arguments%& false.
4583
4584 .cindex "&%Resent-%& header lines" "with &%-t%&"
4585 If there are any &%Resent-%& header lines in the message, Exim extracts
4586 recipients from all &'Resent-To:'&, &'Resent-Cc:'&, and &'Resent-Bcc:'& header
4587 lines instead of from &'To:'&, &'Cc:'&, and &'Bcc:'&. This is for compatibility
4588 with Sendmail and other MTAs. (Prior to release 4.20, Exim gave an error if
4589 &%-t%& was used in conjunction with &%Resent-%& header lines.)
4590
4591 RFC 2822 talks about different sets of &%Resent-%& header lines (for when a
4592 message is resent several times). The RFC also specifies that they should be
4593 added at the front of the message, and separated by &'Received:'& lines. It is
4594 not at all clear how &%-t%& should operate in the present of multiple sets,
4595 nor indeed exactly what constitutes a &"set"&.
4596 In practice, it seems that MUAs do not follow the RFC. The &%Resent-%& lines
4597 are often added at the end of the header, and if a message is resent more than
4598 once, it is common for the original set of &%Resent-%& headers to be renamed as
4599 &%X-Resent-%& when a new set is added. This removes any possible ambiguity.
4600
4601 .vitem &%-ti%&
4602 .oindex "&%-ti%&"
4603 This option is exactly equivalent to &%-t%& &%-i%&. It is provided for
4604 compatibility with Sendmail.
4605
4606 .vitem &%-tls-on-connect%&
4607 .oindex "&%-tls-on-connect%&"
4608 .cindex "TLS" "use without STARTTLS"
4609 .cindex "TLS" "automatic start"
4610 This option is available when Exim is compiled with TLS support. It forces all
4611 incoming SMTP connections to behave as if the incoming port is listed in the
4612 &%tls_on_connect_ports%& option. See section &<<SECTsupobssmt>>& and chapter
4613 &<<CHAPTLS>>& for further details.
4614
4615
4616 .vitem &%-U%&
4617 .oindex "&%-U%&"
4618 .cindex "Sendmail compatibility" "&%-U%& option ignored"
4619 Sendmail uses this option for &"initial message submission"&, and its
4620 documentation states that in future releases, it may complain about
4621 syntactically invalid messages rather than fixing them when this flag is not
4622 set. Exim ignores this option.
4623
4624 .vitem &%-v%&
4625 .oindex "&%-v%&"
4626 This option causes Exim to write information to the standard error stream,
4627 describing what it is doing. In particular, it shows the log lines for
4628 receiving and delivering a message, and if an SMTP connection is made, the SMTP
4629 dialogue is shown. Some of the log lines shown may not actually be written to
4630 the log if the setting of &%log_selector%& discards them. Any relevant
4631 selectors are shown with each log line. If none are shown, the logging is
4632 unconditional.
4633
4634 .vitem &%-x%&
4635 .oindex "&%-x%&"
4636 AIX uses &%-x%& for a private purpose (&"mail from a local mail program has
4637 National Language Support extended characters in the body of the mail item"&).
4638 It sets &%-x%& when calling the MTA from its &%mail%& command. Exim ignores
4639 this option.
4640
4641 .new
4642 .vitem &%-X%&&~<&'logfile'&>
4643 .oindex "&%-X%&"
4644 This option is interpreted by Sendmail to cause debug information to be sent
4645 to the named file.  It is ignored by Exim.
4646 .wen
4647 .endlist
4648
4649 .ecindex IIDclo1
4650 .ecindex IIDclo2
4651
4652
4653 . ////////////////////////////////////////////////////////////////////////////
4654 . Insert a stylized DocBook comment here, to identify the end of the command
4655 . line options. This is for the benefit of the Perl script that automatically
4656 . creates a man page for the options.
4657 . ////////////////////////////////////////////////////////////////////////////
4658
4659 .literal xml
4660 <!-- === End of command line options === -->
4661 .literal off
4662
4663
4664
4665
4666
4667 . ////////////////////////////////////////////////////////////////////////////
4668 . ////////////////////////////////////////////////////////////////////////////
4669
4670
4671 .chapter "The Exim run time configuration file" "CHAPconf" &&&
4672          "The runtime configuration file"
4673
4674 .cindex "run time configuration"
4675 .cindex "configuration file" "general description"
4676 .cindex "CONFIGURE_FILE"
4677 .cindex "configuration file" "errors in"
4678 .cindex "error" "in configuration file"
4679 .cindex "return code" "for bad configuration"
4680 Exim uses a single run time configuration file that is read whenever an Exim
4681 binary is executed. Note that in normal operation, this happens frequently,
4682 because Exim is designed to operate in a distributed manner, without central
4683 control.
4684
4685 If a syntax error is detected while reading the configuration file, Exim
4686 writes a message on the standard error, and exits with a non-zero return code.
4687 The message is also written to the panic log. &*Note*&: Only simple syntax
4688 errors can be detected at this time. The values of any expanded options are
4689 not checked until the expansion happens, even when the expansion does not
4690 actually alter the string.
4691
4692 The name of the configuration file is compiled into the binary for security
4693 reasons, and is specified by the CONFIGURE_FILE compilation option. In
4694 most configurations, this specifies a single file. However, it is permitted to
4695 give a colon-separated list of file names, in which case Exim uses the first
4696 existing file in the list.
4697
4698 .cindex "EXIM_USER"
4699 .cindex "EXIM_GROUP"
4700 .cindex "CONFIGURE_OWNER"
4701 .cindex "CONFIGURE_GROUP"
4702 .cindex "configuration file" "ownership"
4703 .cindex "ownership" "configuration file"
4704 The run time configuration file must be owned by root or by the user that is
4705 specified at compile time by the CONFIGURE_OWNER option (if set). The
4706 configuration file must not be world-writeable, or group-writeable unless its
4707 group is the root group or the one specified at compile time by the
4708 CONFIGURE_GROUP option.
4709
4710 &*Warning*&: In a conventional configuration, where the Exim binary is setuid
4711 to root, anybody who is able to edit the run time configuration file has an
4712 easy way to run commands as root. If you specify a user or group in the
4713 CONFIGURE_OWNER or CONFIGURE_GROUP options, then that user and/or any users
4714 who are members of that group will trivially be able to obtain root privileges.
4715
4716 Up to Exim version 4.72, the run time configuration file was also permitted to
4717 be writeable by the Exim user and/or group. That has been changed in Exim 4.73
4718 since it offered a simple privilege escalation for any attacker who managed to
4719 compromise the Exim user account.
4720
4721 A default configuration file, which will work correctly in simple situations,
4722 is provided in the file &_src/configure.default_&. If CONFIGURE_FILE
4723 defines just one file name, the installation process copies the default
4724 configuration to a new file of that name if it did not previously exist. If
4725 CONFIGURE_FILE is a list, no default is automatically installed. Chapter
4726 &<<CHAPdefconfil>>& is a &"walk-through"& discussion of the default
4727 configuration.
4728
4729
4730
4731 .section "Using a different configuration file" "SECID40"
4732 .cindex "configuration file" "alternate"
4733 A one-off alternate configuration can be specified by the &%-C%& command line
4734 option, which may specify a single file or a list of files. However, when
4735 &%-C%& is used, Exim gives up its root privilege, unless called by root (or
4736 unless the argument for &%-C%& is identical to the built-in value from
4737 CONFIGURE_FILE), or is listed in the TRUSTED_CONFIG_LIST file and the caller
4738 is the Exim user or the user specified in the CONFIGURE_OWNER setting. &%-C%&
4739 is useful mainly for checking the syntax of configuration files before
4740 installing them. No owner or group checks are done on a configuration file
4741 specified by &%-C%&, if root privilege has been dropped.
4742
4743 Even the Exim user is not trusted to specify an arbitrary configuration file
4744 with the &%-C%& option to be used with root privileges, unless that file is
4745 listed in the TRUSTED_CONFIG_LIST file. This locks out the possibility of
4746 testing a configuration using &%-C%& right through message reception and
4747 delivery, even if the caller is root. The reception works, but by that time,
4748 Exim is running as the Exim user, so when it re-execs to regain privilege for
4749 the delivery, the use of &%-C%& causes privilege to be lost. However, root
4750 can test reception and delivery using two separate commands (one to put a
4751 message on the queue, using &%-odq%&, and another to do the delivery, using
4752 &%-M%&).
4753
4754 If ALT_CONFIG_PREFIX is defined &_in Local/Makefile_&, it specifies a
4755 prefix string with which any file named in a &%-C%& command line option must
4756 start. In addition, the file name must not contain the sequence &"&`/../`&"&.
4757 There is no default setting for ALT_CONFIG_PREFIX; when it is unset, any file
4758 name can be used with &%-C%&.
4759
4760 One-off changes to a configuration can be specified by the &%-D%& command line
4761 option, which defines and overrides values for macros used inside the
4762 configuration file. However, like &%-C%&, the use of this option by a
4763 non-privileged user causes Exim to discard its root privilege.
4764 If DISABLE_D_OPTION is defined in &_Local/Makefile_&, the use of &%-D%& is
4765 completely disabled, and its use causes an immediate error exit.
4766
4767 The WHITELIST_D_MACROS option in &_Local/Makefile_& permits the binary builder
4768 to declare certain macro names trusted, such that root privilege will not
4769 necessarily be discarded.
4770 WHITELIST_D_MACROS defines a colon-separated list of macros which are
4771 considered safe and, if &%-D%& only supplies macros from this list, and the
4772 values are acceptable, then Exim will not give up root privilege if the caller
4773 is root, the Exim run-time user, or the CONFIGURE_OWNER, if set.  This is a
4774 transition mechanism and is expected to be removed in the future.  Acceptable
4775 values for the macros satisfy the regexp: &`^[A-Za-z0-9_/.-]*$`&
4776
4777 Some sites may wish to use the same Exim binary on different machines that
4778 share a file system, but to use different configuration files on each machine.
4779 If CONFIGURE_FILE_USE_NODE is defined in &_Local/Makefile_&, Exim first
4780 looks for a file whose name is the configuration file name followed by a dot
4781 and the machine's node name, as obtained from the &[uname()]& function. If this
4782 file does not exist, the standard name is tried. This processing occurs for
4783 each file name in the list given by CONFIGURE_FILE or &%-C%&.
4784
4785 In some esoteric situations different versions of Exim may be run under
4786 different effective uids and the CONFIGURE_FILE_USE_EUID is defined to
4787 help with this. See the comments in &_src/EDITME_& for details.
4788
4789
4790
4791 .section "Configuration file format" "SECTconffilfor"
4792 .cindex "configuration file" "format of"
4793 .cindex "format" "configuration file"
4794 Exim's configuration file is divided into a number of different parts. General
4795 option settings must always appear at the start of the file. The other parts
4796 are all optional, and may appear in any order. Each part other than the first
4797 is introduced by the word &"begin"& followed by the name of the part. The
4798 optional parts are:
4799
4800 .ilist
4801 &'ACL'&: Access control lists for controlling incoming SMTP mail (see chapter
4802 &<<CHAPACL>>&).
4803 .next
4804 .cindex "AUTH" "configuration"
4805 &'authenticators'&: Configuration settings for the authenticator drivers. These
4806 are concerned with the SMTP AUTH command (see chapter &<<CHAPSMTPAUTH>>&).
4807 .next
4808 &'routers'&: Configuration settings for the router drivers. Routers process
4809 addresses and determine how the message is to be delivered (see chapters
4810 &<<CHAProutergeneric>>&&--&<<CHAPredirect>>&).
4811 .next
4812 &'transports'&: Configuration settings for the transport drivers. Transports
4813 define mechanisms for copying messages to destinations (see chapters
4814 &<<CHAPtransportgeneric>>&&--&<<CHAPsmtptrans>>&).
4815 .next
4816 &'retry'&: Retry rules, for use when a message cannot be delivered immediately.
4817 If there is no retry section, or if it is empty (that is, no retry rules are
4818 defined), Exim will not retry deliveries. In this situation, temporary errors
4819 are treated the same as permanent errors. Retry rules are discussed in chapter
4820 &<<CHAPretry>>&.
4821 .next
4822 &'rewrite'&: Global address rewriting rules, for use when a message arrives and
4823 when new addresses are generated during delivery. Rewriting is discussed in
4824 chapter &<<CHAPrewrite>>&.
4825 .next
4826 &'local_scan'&: Private options for the &[local_scan()]& function. If you
4827 want to use this feature, you must set
4828 .code
4829 LOCAL_SCAN_HAS_OPTIONS=yes
4830 .endd
4831 in &_Local/Makefile_& before building Exim. Details of the &[local_scan()]&
4832 facility are given in chapter &<<CHAPlocalscan>>&.
4833 .endlist
4834
4835 .cindex "configuration file" "leading white space in"
4836 .cindex "configuration file" "trailing white space in"
4837 .cindex "white space" "in configuration file"
4838 Leading and trailing white space in configuration lines is always ignored.
4839
4840 Blank lines in the file, and lines starting with a # character (ignoring
4841 leading white space) are treated as comments and are ignored. &*Note*&: A
4842 # character other than at the beginning of a line is not treated specially,
4843 and does not introduce a comment.
4844
4845 Any non-comment line can be continued by ending it with a backslash. Note that
4846 the general rule for white space means that trailing white space after the
4847 backslash and leading white space at the start of continuation
4848 lines is ignored. Comment lines beginning with # (but not empty lines) may
4849 appear in the middle of a sequence of continuation lines.
4850
4851 A convenient way to create a configuration file is to start from the
4852 default, which is supplied in &_src/configure.default_&, and add, delete, or
4853 change settings as required.
4854
4855 The ACLs, retry rules, and rewriting rules have their own syntax which is
4856 described in chapters &<<CHAPACL>>&, &<<CHAPretry>>&, and &<<CHAPrewrite>>&,
4857 respectively. The other parts of the configuration file have some syntactic
4858 items in common, and these are described below, from section &<<SECTcos>>&
4859 onwards. Before that, the inclusion, macro, and conditional facilities are
4860 described.
4861
4862
4863
4864 .section "File inclusions in the configuration file" "SECID41"
4865 .cindex "inclusions in configuration file"
4866 .cindex "configuration file" "including other files"
4867 .cindex "&`.include`& in configuration file"
4868 .cindex "&`.include_if_exists`& in configuration file"
4869 You can include other files inside Exim's run time configuration file by
4870 using this syntax:
4871 .display
4872 &`.include`& <&'file name'&>
4873 &`.include_if_exists`& <&'file name'&>
4874 .endd
4875 on a line by itself. Double quotes round the file name are optional. If you use
4876 the first form, a configuration error occurs if the file does not exist; the
4877 second form does nothing for non-existent files. In all cases, an absolute file
4878 name is required.
4879
4880 Includes may be nested to any depth, but remember that Exim reads its
4881 configuration file often, so it is a good idea to keep them to a minimum.
4882 If you change the contents of an included file, you must HUP the daemon,
4883 because an included file is read only when the configuration itself is read.
4884
4885 The processing of inclusions happens early, at a physical line level, so, like
4886 comment lines, an inclusion can be used in the middle of an option setting,
4887 for example:
4888 .code
4889 hosts_lookup = a.b.c \
4890                .include /some/file
4891 .endd
4892 Include processing happens after macro processing (see below). Its effect is to
4893 process the lines of the included file as if they occurred inline where the
4894 inclusion appears.
4895
4896
4897
4898 .section "Macros in the configuration file" "SECTmacrodefs"
4899 .cindex "macro" "description of"
4900 .cindex "configuration file" "macros"
4901 If a line in the main part of the configuration (that is, before the first
4902 &"begin"& line) begins with an upper case letter, it is taken as a macro
4903 definition, and must be of the form
4904 .display
4905 <&'name'&> = <&'rest of line'&>
4906 .endd
4907 The name must consist of letters, digits, and underscores, and need not all be
4908 in upper case, though that is recommended. The rest of the line, including any
4909 continuations, is the replacement text, and has leading and trailing white
4910 space removed. Quotes are not removed. The replacement text can never end with
4911 a backslash character, but this doesn't seem to be a serious limitation.
4912
4913 Macros may also be defined between router, transport, authenticator, or ACL
4914 definitions. They may not, however, be defined within an individual driver or
4915 ACL, or in the &%local_scan%&, retry, or rewrite sections of the configuration.
4916
4917 .section "Macro substitution" "SECID42"
4918 Once a macro is defined, all subsequent lines in the file (and any included
4919 files) are scanned for the macro name; if there are several macros, the line is
4920 scanned for each in turn, in the order in which the macros are defined. The
4921 replacement text is not re-scanned for the current macro, though it is scanned
4922 for subsequently defined macros. For this reason, a macro name may not contain
4923 the name of a previously defined macro as a substring. You could, for example,
4924 define
4925 .display
4926 &`ABCD_XYZ = `&<&'something'&>
4927 &`ABCD = `&<&'something else'&>
4928 .endd
4929 but putting the definitions in the opposite order would provoke a configuration
4930 error. Macro expansion is applied to individual physical lines from the file,
4931 before checking for line continuation or file inclusion (see above). If a line
4932 consists solely of a macro name, and the expansion of the macro is empty, the
4933 line is ignored. A macro at the start of a line may turn the line into a
4934 comment line or a &`.include`& line.
4935
4936
4937 .section "Redefining macros" "SECID43"
4938 Once defined, the value of a macro can be redefined later in the configuration
4939 (or in an included file). Redefinition is specified by using &'=='& instead of
4940 &'='&. For example:
4941 .code
4942 MAC =  initial value
4943 ...
4944 MAC == updated value
4945 .endd
4946 Redefinition does not alter the order in which the macros are applied to the
4947 subsequent lines of the configuration file. It is still the same order in which
4948 the macros were originally defined. All that changes is the macro's value.
4949 Redefinition makes it possible to accumulate values. For example:
4950 .code
4951 MAC =  initial value
4952 ...
4953 MAC == MAC and something added
4954 .endd
4955 This can be helpful in situations where the configuration file is built
4956 from a number of other files.
4957
4958 .section "Overriding macro values" "SECID44"
4959 The values set for macros in the configuration file can be overridden by the
4960 &%-D%& command line option, but Exim gives up its root privilege when &%-D%& is
4961 used, unless called by root or the Exim user. A definition on the command line
4962 using the &%-D%& option causes all definitions and redefinitions within the
4963 file to be ignored.
4964
4965
4966
4967 .section "Example of macro usage" "SECID45"
4968 As an example of macro usage, consider a configuration where aliases are looked
4969 up in a MySQL database. It helps to keep the file less cluttered if long
4970 strings such as SQL statements are defined separately as macros, for example:
4971 .code
4972 ALIAS_QUERY = select mailbox from user where \
4973               login='${quote_mysql:$local_part}';
4974 .endd
4975 This can then be used in a &(redirect)& router setting like this:
4976 .code
4977 data = ${lookup mysql{ALIAS_QUERY}}
4978 .endd
4979 In earlier versions of Exim macros were sometimes used for domain, host, or
4980 address lists. In Exim 4 these are handled better by named lists &-- see
4981 section &<<SECTnamedlists>>&.
4982
4983
4984 .section "Conditional skips in the configuration file" "SECID46"
4985 .cindex "configuration file" "conditional skips"
4986 .cindex "&`.ifdef`&"
4987 You can use the directives &`.ifdef`&, &`.ifndef`&, &`.elifdef`&,
4988 &`.elifndef`&, &`.else`&, and &`.endif`& to dynamically include or exclude
4989 portions of the configuration file. The processing happens whenever the file is
4990 read (that is, when an Exim binary starts to run).
4991
4992 The implementation is very simple. Instances of the first four directives must
4993 be followed by text that includes the names of one or macros. The condition
4994 that is tested is whether or not any macro substitution has taken place in the
4995 line. Thus:
4996 .code
4997 .ifdef AAA
4998 message_size_limit = 50M
4999 .else
5000 message_size_limit = 100M
5001 .endif
5002 .endd
5003 sets a message size limit of 50M if the macro &`AAA`& is defined, and 100M
5004 otherwise. If there is more than one macro named on the line, the condition
5005 is true if any of them are defined. That is, it is an &"or"& condition. To
5006 obtain an &"and"& condition, you need to use nested &`.ifdef`&s.
5007
5008 Although you can use a macro expansion to generate one of these directives,
5009 it is not very useful, because the condition &"there was a macro substitution
5010 in this line"& will always be true.
5011
5012 Text following &`.else`& and &`.endif`& is ignored, and can be used as comment
5013 to clarify complicated nestings.
5014
5015
5016
5017 .section "Common option syntax" "SECTcos"
5018 .cindex "common option syntax"
5019 .cindex "syntax of common options"
5020 .cindex "configuration file" "common option syntax"
5021 For the main set of options, driver options, and &[local_scan()]& options,
5022 each setting is on a line by itself, and starts with a name consisting of
5023 lower-case letters and underscores. Many options require a data value, and in
5024 these cases the name must be followed by an equals sign (with optional white
5025 space) and then the value. For example:
5026 .code
5027 qualify_domain = mydomain.example.com
5028 .endd
5029 .cindex "hiding configuration option values"
5030 .cindex "configuration options" "hiding value of"
5031 .cindex "options" "hiding value of"
5032 Some option settings may contain sensitive data, for example, passwords for
5033 accessing databases. To stop non-admin users from using the &%-bP%& command
5034 line option to read these values, you can precede the option settings with the
5035 word &"hide"&. For example:
5036 .code
5037 hide mysql_servers = localhost/users/admin/secret-password
5038 .endd
5039 For non-admin users, such options are displayed like this:
5040 .code
5041 mysql_servers = <value not displayable>
5042 .endd
5043 If &"hide"& is used on a driver option, it hides the value of that option on
5044 all instances of the same driver.
5045
5046 The following sections describe the syntax used for the different data types
5047 that are found in option settings.
5048
5049
5050 .section "Boolean options" "SECID47"
5051 .cindex "format" "boolean"
5052 .cindex "boolean configuration values"
5053 .oindex "&%no_%&&'xxx'&"
5054 .oindex "&%not_%&&'xxx'&"
5055 Options whose type is given as boolean are on/off switches. There are two
5056 different ways of specifying such options: with and without a data value. If
5057 the option name is specified on its own without data, the switch is turned on;
5058 if it is preceded by &"no_"& or &"not_"& the switch is turned off. However,
5059 boolean options may be followed by an equals sign and one of the words
5060 &"true"&, &"false"&, &"yes"&, or &"no"&, as an alternative syntax. For example,
5061 the following two settings have exactly the same effect:
5062 .code
5063 queue_only
5064 queue_only = true
5065 .endd
5066 The following two lines also have the same (opposite) effect:
5067 .code
5068 no_queue_only
5069 queue_only = false
5070 .endd
5071 You can use whichever syntax you prefer.
5072
5073
5074
5075
5076 .section "Integer values" "SECID48"
5077 .cindex "integer configuration values"
5078 .cindex "format" "integer"
5079 If an option's type is given as &"integer"&, the value can be given in decimal,
5080 hexadecimal, or octal. If it starts with a digit greater than zero, a decimal
5081 number is assumed. Otherwise, it is treated as an octal number unless it starts
5082 with the characters &"0x"&, in which case the remainder is interpreted as a
5083 hexadecimal number.
5084
5085 If an integer value is followed by the letter K, it is multiplied by 1024; if
5086 it is followed by the letter M, it is multiplied by 1024x1024. When the values
5087 of integer option settings are output, values which are an exact multiple of
5088 1024 or 1024x1024 are sometimes, but not always, printed using the letters K
5089 and M. The printing style is independent of the actual input format that was
5090 used.
5091
5092
5093 .section "Octal integer values" "SECID49"
5094 .cindex "integer format"
5095 .cindex "format" "octal integer"
5096 If an option's type is given as &"octal integer"&, its value is always
5097 interpreted as an octal number, whether or not it starts with the digit zero.
5098 Such options are always output in octal.
5099
5100
5101 .section "Fixed point numbers" "SECID50"
5102 .cindex "fixed point configuration values"
5103 .cindex "format" "fixed point"
5104 If an option's type is given as &"fixed-point"&, its value must be a decimal
5105 integer, optionally followed by a decimal point and up to three further digits.
5106
5107
5108
5109 .section "Time intervals" "SECTtimeformat"
5110 .cindex "time interval" "specifying in configuration"
5111 .cindex "format" "time interval"
5112 A time interval is specified as a sequence of numbers, each followed by one of
5113 the following letters, with no intervening white space:
5114
5115 .table2 30pt
5116 .irow &%s%& seconds
5117 .irow &%m%& minutes
5118 .irow &%h%& hours
5119 .irow &%d%& days
5120 .irow &%w%& weeks
5121 .endtable
5122
5123 For example, &"3h50m"& specifies 3 hours and 50 minutes. The values of time
5124 intervals are output in the same format. Exim does not restrict the values; it
5125 is perfectly acceptable, for example, to specify &"90m"& instead of &"1h30m"&.
5126
5127
5128
5129 .section "String values" "SECTstrings"
5130 .cindex "string" "format of configuration values"
5131 .cindex "format" "string"
5132 If an option's type is specified as &"string"&, the value can be specified with
5133 or without double-quotes. If it does not start with a double-quote, the value
5134 consists of the remainder of the line plus any continuation lines, starting at
5135 the first character after any leading white space, with trailing white space
5136 removed, and with no interpretation of the characters in the string. Because
5137 Exim removes comment lines (those beginning with #) at an early stage, they can
5138 appear in the middle of a multi-line string. The following two settings are
5139 therefore equivalent:
5140 .code
5141 trusted_users = uucp:mail
5142 trusted_users = uucp:\
5143                 # This comment line is ignored
5144                 mail
5145 .endd
5146 .cindex "string" "quoted"
5147 .cindex "escape characters in quoted strings"
5148 If a string does start with a double-quote, it must end with a closing
5149 double-quote, and any backslash characters other than those used for line
5150 continuation are interpreted as escape characters, as follows:
5151
5152 .table2 100pt
5153 .irow &`\\`&                     "single backslash"
5154 .irow &`\n`&                     "newline"
5155 .irow &`\r`&                     "carriage return"
5156 .irow &`\t`&                     "tab"
5157 .irow "&`\`&<&'octal digits'&>"  "up to 3 octal digits specify one character"
5158 .irow "&`\x`&<&'hex digits'&>"   "up to 2 hexadecimal digits specify one &&&
5159                                    character"
5160 .endtable
5161
5162 If a backslash is followed by some other character, including a double-quote
5163 character, that character replaces the pair.
5164
5165 Quoting is necessary only if you want to make use of the backslash escapes to
5166 insert special characters, or if you need to specify a value with leading or
5167 trailing spaces. These cases are rare, so quoting is almost never needed in
5168 current versions of Exim. In versions of Exim before 3.14, quoting was required
5169 in order to continue lines, so you may come across older configuration files
5170 and examples that apparently quote unnecessarily.
5171
5172
5173 .section "Expanded strings" "SECID51"
5174 .cindex "expansion" "definition of"
5175 Some strings in the configuration file are subjected to &'string expansion'&,
5176 by which means various parts of the string may be changed according to the
5177 circumstances (see chapter &<<CHAPexpand>>&). The input syntax for such strings
5178 is as just described; in particular, the handling of backslashes in quoted
5179 strings is done as part of the input process, before expansion takes place.
5180 However, backslash is also an escape character for the expander, so any
5181 backslashes that are required for that reason must be doubled if they are
5182 within a quoted configuration string.
5183
5184
5185 .section "User and group names" "SECID52"
5186 .cindex "user name" "format of"
5187 .cindex "format" "user name"
5188 .cindex "groups" "name format"
5189 .cindex "format" "group name"
5190 User and group names are specified as strings, using the syntax described
5191 above, but the strings are interpreted specially. A user or group name must
5192 either consist entirely of digits, or be a name that can be looked up using the
5193 &[getpwnam()]& or &[getgrnam()]& function, as appropriate.
5194
5195
5196 .section "List construction" "SECTlistconstruct"
5197 .cindex "list" "syntax of in configuration"
5198 .cindex "format" "list item in configuration"
5199 .cindex "string" "list, definition of"
5200 The data for some configuration options is a list of items, with colon as the
5201 default separator. Many of these options are shown with type &"string list"& in
5202 the descriptions later in this document. Others are listed as &"domain list"&,
5203 &"host list"&, &"address list"&, or &"local part list"&. Syntactically, they
5204 are all the same; however, those other than &"string list"& are subject to
5205 particular kinds of interpretation, as described in chapter
5206 &<<CHAPdomhosaddlists>>&.
5207
5208 In all these cases, the entire list is treated as a single string as far as the
5209 input syntax is concerned. The &%trusted_users%& setting in section
5210 &<<SECTstrings>>& above is an example. If a colon is actually needed in an item
5211 in a list, it must be entered as two colons. Leading and trailing white space
5212 on each item in a list is ignored. This makes it possible to include items that
5213 start with a colon, and in particular, certain forms of IPv6 address. For
5214 example, the list
5215 .code
5216 local_interfaces = 127.0.0.1 : ::::1
5217 .endd
5218 contains two IP addresses, the IPv4 address 127.0.0.1 and the IPv6 address ::1.
5219
5220 &*Note*&: Although leading and trailing white space is ignored in individual
5221 list items, it is not ignored when parsing the list. The space after the first
5222 colon in the example above is necessary. If it were not there, the list would
5223 be interpreted as the two items 127.0.0.1:: and 1.
5224
5225 .section "Changing list separators" "SECID53"
5226 .cindex "list separator" "changing"
5227 .cindex "IPv6" "addresses in lists"
5228 Doubling colons in IPv6 addresses is an unwelcome chore, so a mechanism was
5229 introduced to allow the separator character to be changed. If a list begins
5230 with a left angle bracket, followed by any punctuation character, that
5231 character is used instead of colon as the list separator. For example, the list
5232 above can be rewritten to use a semicolon separator like this:
5233 .code
5234 local_interfaces = <; 127.0.0.1 ; ::1
5235 .endd
5236 This facility applies to all lists, with the exception of the list in
5237 &%log_file_path%&. It is recommended that the use of non-colon separators be
5238 confined to circumstances where they really are needed.
5239
5240 .cindex "list separator" "newline as"
5241 .cindex "newline" "as list separator"
5242 It is also possible to use newline and other control characters (those with
5243 code values less than 32, plus DEL) as separators in lists. Such separators
5244 must be provided literally at the time the list is processed. For options that
5245 are string-expanded, you can write the separator using a normal escape
5246 sequence. This will be processed by the expander before the string is
5247 interpreted as a list. For example, if a newline-separated list of domains is
5248 generated by a lookup, you can process it directly by a line such as this:
5249 .code
5250 domains = <\n ${lookup mysql{.....}}
5251 .endd
5252 This avoids having to change the list separator in such data. You are unlikely
5253 to want to use a control character as a separator in an option that is not
5254 expanded, because the value is literal text. However, it can be done by giving
5255 the value in quotes. For example:
5256 .code
5257 local_interfaces = "<\n 127.0.0.1 \n ::1"
5258 .endd
5259 Unlike printing character separators, which can be included in list items by
5260 doubling, it is not possible to include a control character as data when it is
5261 set as the separator. Two such characters in succession are interpreted as
5262 enclosing an empty list item.
5263
5264
5265
5266 .section "Empty items in lists" "SECTempitelis"
5267 .cindex "list" "empty item in"
5268 An empty item at the end of a list is always ignored. In other words, trailing
5269 separator characters are ignored. Thus, the list in
5270 .code
5271 senders = user@domain :
5272 .endd
5273 contains only a single item. If you want to include an empty string as one item
5274 in a list, it must not be the last item. For example, this list contains three
5275 items, the second of which is empty:
5276 .code
5277 senders = user1@domain : : user2@domain
5278 .endd
5279 &*Note*&: There must be white space between the two colons, as otherwise they
5280 are interpreted as representing a single colon data character (and the list
5281 would then contain just one item). If you want to specify a list that contains
5282 just one, empty item, you can do it as in this example:
5283 .code
5284 senders = :
5285 .endd
5286 In this case, the first item is empty, and the second is discarded because it
5287 is at the end of the list.
5288
5289
5290
5291
5292 .section "Format of driver configurations" "SECTfordricon"
5293 .cindex "drivers" "configuration format"
5294 There are separate parts in the configuration for defining routers, transports,
5295 and authenticators. In each part, you are defining a number of driver
5296 instances, each with its own set of options. Each driver instance is defined by
5297 a sequence of lines like this:
5298 .display
5299 <&'instance name'&>:
5300   <&'option'&>
5301   ...
5302   <&'option'&>
5303 .endd
5304 In the following example, the instance name is &(localuser)&, and it is
5305 followed by three options settings:
5306 .code
5307 localuser:
5308   driver = accept
5309   check_local_user
5310   transport = local_delivery
5311 .endd
5312 For each driver instance, you specify which Exim code module it uses &-- by the
5313 setting of the &%driver%& option &-- and (optionally) some configuration
5314 settings. For example, in the case of transports, if you want a transport to
5315 deliver with SMTP you would use the &(smtp)& driver; if you want to deliver to
5316 a local file you would use the &(appendfile)& driver. Each of the drivers is
5317 described in detail in its own separate chapter later in this manual.
5318
5319 You can have several routers, transports, or authenticators that are based on
5320 the same underlying driver (each must have a different instance name).
5321
5322 The order in which routers are defined is important, because addresses are
5323 passed to individual routers one by one, in order. The order in which
5324 transports are defined does not matter at all. The order in which
5325 authenticators are defined is used only when Exim, as a client, is searching
5326 them to find one that matches an authentication mechanism offered by the
5327 server.
5328
5329 .cindex "generic options"
5330 .cindex "options" "generic &-- definition of"
5331 Within a driver instance definition, there are two kinds of option: &'generic'&
5332 and &'private'&. The generic options are those that apply to all drivers of the
5333 same type (that is, all routers, all transports or all authenticators). The
5334 &%driver%& option is a generic option that must appear in every definition.
5335 .cindex "private options"
5336 The private options are special for each driver, and none need appear, because
5337 they all have default values.
5338
5339 The options may appear in any order, except that the &%driver%& option must
5340 precede any private options, since these depend on the particular driver. For
5341 this reason, it is recommended that &%driver%& always be the first option.
5342
5343 Driver instance names, which are used for reference in log entries and
5344 elsewhere, can be any sequence of letters, digits, and underscores (starting
5345 with a letter) and must be unique among drivers of the same type. A router and
5346 a transport (for example) can each have the same name, but no two router
5347 instances can have the same name. The name of a driver instance should not be
5348 confused with the name of the underlying driver module. For example, the
5349 configuration lines:
5350 .code
5351 remote_smtp:
5352   driver = smtp
5353 .endd
5354 create an instance of the &(smtp)& transport driver whose name is
5355 &(remote_smtp)&. The same driver code can be used more than once, with
5356 different instance names and different option settings each time. A second
5357 instance of the &(smtp)& transport, with different options, might be defined
5358 thus:
5359 .code
5360 special_smtp:
5361   driver = smtp
5362   port = 1234
5363   command_timeout = 10s
5364 .endd
5365 The names &(remote_smtp)& and &(special_smtp)& would be used to reference
5366 these transport instances from routers, and these names would appear in log
5367 lines.
5368
5369 Comment lines may be present in the middle of driver specifications. The full
5370 list of option settings for any particular driver instance, including all the
5371 defaulted values, can be extracted by making use of the &%-bP%& command line
5372 option.
5373
5374
5375
5376
5377
5378
5379 . ////////////////////////////////////////////////////////////////////////////
5380 . ////////////////////////////////////////////////////////////////////////////
5381
5382 .chapter "The default configuration file" "CHAPdefconfil"
5383 .scindex IIDconfiwal "configuration file" "default &""walk through""&"
5384 .cindex "default" "configuration file &""walk through""&"
5385 The default configuration file supplied with Exim as &_src/configure.default_&
5386 is sufficient for a host with simple mail requirements. As an introduction to
5387 the way Exim is configured, this chapter &"walks through"& the default
5388 configuration, giving brief explanations of the settings. Detailed descriptions
5389 of the options are given in subsequent chapters. The default configuration file
5390 itself contains extensive comments about ways you might want to modify the
5391 initial settings. However, note that there are many options that are not
5392 mentioned at all in the default configuration.
5393
5394
5395
5396 .section "Main configuration settings" "SECTdefconfmain"
5397 The main (global) configuration option settings must always come first in the
5398 file. The first thing you'll see in the file, after some initial comments, is
5399 the line
5400 .code
5401 # primary_hostname =
5402 .endd
5403 This is a commented-out setting of the &%primary_hostname%& option. Exim needs
5404 to know the official, fully qualified name of your host, and this is where you
5405 can specify it. However, in most cases you do not need to set this option. When
5406 it is unset, Exim uses the &[uname()]& system function to obtain the host name.
5407
5408 The first three non-comment configuration lines are as follows:
5409 .code
5410 domainlist local_domains    = @
5411 domainlist relay_to_domains =
5412 hostlist   relay_from_hosts = 127.0.0.1
5413 .endd
5414 These are not, in fact, option settings. They are definitions of two named
5415 domain lists and one named host list. Exim allows you to give names to lists of
5416 domains, hosts, and email addresses, in order to make it easier to manage the
5417 configuration file (see section &<<SECTnamedlists>>&).
5418
5419 The first line defines a domain list called &'local_domains'&; this is used
5420 later in the configuration to identify domains that are to be delivered
5421 on the local host.
5422
5423 .cindex "@ in a domain list"
5424 There is just one item in this list, the string &"@"&. This is a special form
5425 of entry which means &"the name of the local host"&. Thus, if the local host is
5426 called &'a.host.example'&, mail to &'any.user@a.host.example'& is expected to
5427 be delivered locally. Because the local host's name is referenced indirectly,
5428 the same configuration file can be used on different hosts.
5429
5430 The second line defines a domain list called &'relay_to_domains'&, but the
5431 list itself is empty. Later in the configuration we will come to the part that
5432 controls mail relaying through the local host; it allows relaying to any
5433 domains in this list. By default, therefore, no relaying on the basis of a mail
5434 domain is permitted.
5435
5436 The third line defines a host list called &'relay_from_hosts'&. This list is
5437 used later in the configuration to permit relaying from any host or IP address
5438 that matches the list. The default contains just the IP address of the IPv4
5439 loopback interface, which means that processes on the local host are able to
5440 submit mail for relaying by sending it over TCP/IP to that interface. No other
5441 hosts are permitted to submit messages for relaying.
5442
5443 Just to be sure there's no misunderstanding: at this point in the configuration
5444 we aren't actually setting up any controls. We are just defining some domains
5445 and hosts that will be used in the controls that are specified later.
5446
5447 The next two configuration lines are genuine option settings:
5448 .code
5449 acl_smtp_rcpt = acl_check_rcpt
5450 acl_smtp_data = acl_check_data
5451 .endd
5452 These options specify &'Access Control Lists'& (ACLs) that are to be used
5453 during an incoming SMTP session for every recipient of a message (every RCPT
5454 command), and after the contents of the message have been received,
5455 respectively. The names of the lists are &'acl_check_rcpt'& and
5456 &'acl_check_data'&, and we will come to their definitions below, in the ACL
5457 section of the configuration. The RCPT ACL controls which recipients are
5458 accepted for an incoming message &-- if a configuration does not provide an ACL
5459 to check recipients, no SMTP mail can be accepted. The DATA ACL allows the
5460 contents of a message to be checked.
5461
5462 Two commented-out option settings are next:
5463 .code
5464 # av_scanner = clamd:/tmp/clamd
5465 # spamd_address = 127.0.0.1 783
5466 .endd
5467 These are example settings that can be used when Exim is compiled with the
5468 content-scanning extension. The first specifies the interface to the virus
5469 scanner, and the second specifies the interface to SpamAssassin. Further
5470 details are given in chapter &<<CHAPexiscan>>&.
5471
5472 Three more commented-out option settings follow:
5473 .code
5474 # tls_advertise_hosts = *
5475 # tls_certificate = /etc/ssl/exim.crt
5476 # tls_privatekey = /etc/ssl/exim.pem
5477 .endd
5478 These are example settings that can be used when Exim is compiled with
5479 support for TLS (aka SSL) as described in section &<<SECTinctlsssl>>&. The
5480 first one specifies the list of clients that are allowed to use TLS when
5481 connecting to this server; in this case the wildcard means all clients. The
5482 other options specify where Exim should find its TLS certificate and private
5483 key, which together prove the server's identity to any clients that connect.
5484 More details are given in chapter &<<CHAPTLS>>&.
5485
5486 Another two commented-out option settings follow:
5487 .code
5488 # daemon_smtp_ports = 25 : 465 : 587
5489 # tls_on_connect_ports = 465
5490 .endd
5491 .cindex "port" "465 and 587"
5492 .cindex "port" "for message submission"
5493 .cindex "message" "submission, ports for"
5494 .cindex "ssmtp protocol"
5495 .cindex "smtps protocol"
5496 .cindex "SMTP" "ssmtp protocol"
5497 .cindex "SMTP" "smtps protocol"
5498 These options provide better support for roaming users who wish to use this
5499 server for message submission. They are not much use unless you have turned on
5500 TLS (as described in the previous paragraph) and authentication (about which
5501 more in section &<<SECTdefconfauth>>&). The usual SMTP port 25 is often blocked
5502 on end-user networks, so RFC 4409 specifies that message submission should use
5503 port 587 instead. However some software (notably Microsoft Outlook) cannot be
5504 configured to use port 587 correctly, so these settings also enable the
5505 non-standard &"smtps"& (aka &"ssmtp"&) port 465 (see section
5506 &<<SECTsupobssmt>>&).
5507
5508 Two more commented-out options settings follow:
5509 .code
5510 # qualify_domain =
5511 # qualify_recipient =
5512 .endd
5513 The first of these specifies a domain that Exim uses when it constructs a
5514 complete email address from a local login name. This is often needed when Exim
5515 receives a message from a local process. If you do not set &%qualify_domain%&,
5516 the value of &%primary_hostname%& is used. If you set both of these options,
5517 you can have different qualification domains for sender and recipient
5518 addresses. If you set only the first one, its value is used in both cases.
5519
5520 .cindex "domain literal" "recognizing format"
5521 The following line must be uncommented if you want Exim to recognize
5522 addresses of the form &'user@[10.11.12.13]'& that is, with a &"domain literal"&
5523 (an IP address within square brackets) instead of a named domain.
5524 .code
5525 # allow_domain_literals
5526 .endd
5527 The RFCs still require this form, but many people think that in the modern
5528 Internet it makes little sense to permit mail to be sent to specific hosts by
5529 quoting their IP addresses. This ancient format has been used by people who
5530 try to abuse hosts by using them for unwanted relaying. However, some
5531 people believe there are circumstances (for example, messages addressed to
5532 &'postmaster'&) where domain literals are still useful.
5533
5534 The next configuration line is a kind of trigger guard:
5535 .code
5536 never_users = root
5537 .endd
5538 It specifies that no delivery must ever be run as the root user. The normal
5539 convention is to set up &'root'& as an alias for the system administrator. This
5540 setting is a guard against slips in the configuration.
5541 The list of users specified by &%never_users%& is not, however, the complete
5542 list; the build-time configuration in &_Local/Makefile_& has an option called
5543 FIXED_NEVER_USERS specifying a list that cannot be overridden. The
5544 contents of &%never_users%& are added to this list. By default
5545 FIXED_NEVER_USERS also specifies root.
5546
5547 When a remote host connects to Exim in order to send mail, the only information
5548 Exim has about the host's identity is its IP address. The next configuration
5549 line,
5550 .code
5551 host_lookup = *
5552 .endd
5553 specifies that Exim should do a reverse DNS lookup on all incoming connections,
5554 in order to get a host name. This improves the quality of the logging
5555 information, but if you feel it is too expensive, you can remove it entirely,
5556 or restrict the lookup to hosts on &"nearby"& networks.
5557 Note that it is not always possible to find a host name from an IP address,
5558 because not all DNS reverse zones are maintained, and sometimes DNS servers are
5559 unreachable.
5560
5561 The next two lines are concerned with &'ident'& callbacks, as defined by RFC
5562 1413 (hence their names):
5563 .code
5564 rfc1413_hosts = *
5565 rfc1413_query_timeout = 5s
5566 .endd
5567 These settings cause Exim to make ident callbacks for all incoming SMTP calls.
5568 You can limit the hosts to which these calls are made, or change the timeout
5569 that is used. If you set the timeout to zero, all ident calls are disabled.
5570 Although they are cheap and can provide useful information for tracing problem
5571 messages, some hosts and firewalls have problems with ident calls. This can
5572 result in a timeout instead of an immediate refused connection, leading to
5573 delays on starting up an incoming SMTP session.
5574
5575 When Exim receives messages over SMTP connections, it expects all addresses to
5576 be fully qualified with a domain, as required by the SMTP definition. However,
5577 if you are running a server to which simple clients submit messages, you may
5578 find that they send unqualified addresses. The two commented-out options:
5579 .code
5580 # sender_unqualified_hosts =
5581 # recipient_unqualified_hosts =
5582 .endd
5583 show how you can specify hosts that are permitted to send unqualified sender
5584 and recipient addresses, respectively.
5585
5586 The &%percent_hack_domains%& option is also commented out:
5587 .code
5588 # percent_hack_domains =
5589 .endd
5590 It provides a list of domains for which the &"percent hack"& is to operate.
5591 This is an almost obsolete form of explicit email routing. If you do not know
5592 anything about it, you can safely ignore this topic.
5593
5594 The last two settings in the main part of the default configuration are
5595 concerned with messages that have been &"frozen"& on Exim's queue. When a
5596 message is frozen, Exim no longer continues to try to deliver it. Freezing
5597 occurs when a bounce message encounters a permanent failure because the sender
5598 address of the original message that caused the bounce is invalid, so the
5599 bounce cannot be delivered. This is probably the most common case, but there
5600 are also other conditions that cause freezing, and frozen messages are not
5601 always bounce messages.
5602 .code
5603 ignore_bounce_errors_after = 2d
5604 timeout_frozen_after = 7d
5605 .endd
5606 The first of these options specifies that failing bounce messages are to be
5607 discarded after 2 days on the queue. The second specifies that any frozen
5608 message (whether a bounce message or not) is to be timed out (and discarded)
5609 after a week. In this configuration, the first setting ensures that no failing
5610 bounce message ever lasts a week.
5611
5612
5613
5614 .section "ACL configuration" "SECID54"
5615 .cindex "default" "ACLs"
5616 .cindex "&ACL;" "default configuration"
5617 In the default configuration, the ACL section follows the main configuration.
5618 It starts with the line
5619 .code
5620 begin acl
5621 .endd
5622 and it contains the definitions of two ACLs, called &'acl_check_rcpt'& and
5623 &'acl_check_data'&, that were referenced in the settings of &%acl_smtp_rcpt%&
5624 and &%acl_smtp_data%& above.
5625
5626 .cindex "RCPT" "ACL for"
5627 The first ACL is used for every RCPT command in an incoming SMTP message. Each
5628 RCPT command specifies one of the message's recipients. The ACL statements
5629 are considered in order, until the recipient address is either accepted or
5630 rejected. The RCPT command is then accepted or rejected, according to the
5631 result of the ACL processing.
5632 .code
5633 acl_check_rcpt:
5634 .endd
5635 This line, consisting of a name terminated by a colon, marks the start of the
5636 ACL, and names it.
5637 .code
5638 accept  hosts = :
5639 .endd
5640 This ACL statement accepts the recipient if the sending host matches the list.
5641 But what does that strange list mean? It doesn't actually contain any host
5642 names or IP addresses. The presence of the colon puts an empty item in the
5643 list; Exim matches this only if the incoming message did not come from a remote
5644 host, because in that case, the remote hostname is empty. The colon is
5645 important. Without it, the list itself is empty, and can never match anything.
5646
5647 What this statement is doing is to accept unconditionally all recipients in
5648 messages that are submitted by SMTP from local processes using the standard
5649 input and output (that is, not using TCP/IP). A number of MUAs operate in this
5650 manner.
5651 .code
5652 deny    message       = Restricted characters in address
5653         domains       = +local_domains
5654         local_parts   = ^[.] : ^.*[@%!/|]
5655
5656 deny    message       = Restricted characters in address
5657         domains       = !+local_domains
5658         local_parts   = ^[./|] : ^.*[@%!] : ^.*/\\.\\./
5659 .endd
5660 These statements are concerned with local parts that contain any of the
5661 characters &"@"&, &"%"&, &"!"&, &"/"&, &"|"&, or dots in unusual places.
5662 Although these characters are entirely legal in local parts (in the case of
5663 &"@"& and leading dots, only if correctly quoted), they do not commonly occur
5664 in Internet mail addresses.
5665
5666 The first three have in the past been associated with explicitly routed
5667 addresses (percent is still sometimes used &-- see the &%percent_hack_domains%&
5668 option). Addresses containing these characters are regularly tried by spammers
5669 in an attempt to bypass relaying restrictions, and also by open relay testing
5670 programs. Unless you really need them it is safest to reject these characters
5671 at this early stage. This configuration is heavy-handed in rejecting these
5672 characters for all messages it accepts from remote hosts. This is a deliberate
5673 policy of being as safe as possible.
5674
5675 The first rule above is stricter, and is applied to messages that are addressed
5676 to one of the local domains handled by this host. This is implemented by the
5677 first condition, which restricts it to domains that are listed in the
5678 &'local_domains'& domain list. The &"+"& character is used to indicate a
5679 reference to a named list. In this configuration, there is just one domain in
5680 &'local_domains'&, but in general there may be many.
5681
5682 The second condition on the first statement uses two regular expressions to
5683 block local parts that begin with a dot or contain &"@"&, &"%"&, &"!"&, &"/"&,
5684 or &"|"&. If you have local accounts that include these characters, you will
5685 have to modify this rule.
5686
5687 Empty components (two dots in a row) are not valid in RFC 2822, but Exim
5688 allows them because they have been encountered in practice. (Consider the
5689 common convention of local parts constructed as
5690 &"&'first-initial.second-initial.family-name'&"& when applied to someone like
5691 the author of Exim, who has no second initial.) However, a local part starting
5692 with a dot or containing &"/../"& can cause trouble if it is used as part of a
5693 file name (for example, for a mailing list). This is also true for local parts
5694 that contain slashes. A pipe symbol can also be troublesome if the local part
5695 is incorporated unthinkingly into a shell command line.
5696
5697 The second rule above applies to all other domains, and is less strict. This
5698 allows your own users to send outgoing messages to sites that use slashes
5699 and vertical bars in their local parts. It blocks local parts that begin
5700 with a dot, slash, or vertical bar, but allows these characters within the
5701 local part. However, the sequence &"/../"& is barred. The use of &"@"&, &"%"&,
5702 and &"!"& is blocked, as before. The motivation here is to prevent your users
5703 (or your users' viruses) from mounting certain kinds of attack on remote sites.
5704 .code
5705 accept  local_parts   = postmaster
5706         domains       = +local_domains
5707 .endd
5708 This statement, which has two conditions, accepts an incoming address if the
5709 local part is &'postmaster'& and the domain is one of those listed in the
5710 &'local_domains'& domain list. The &"+"& character is used to indicate a
5711 reference to a named list. In this configuration, there is just one domain in
5712 &'local_domains'&, but in general there may be many.
5713
5714 The presence of this statement means that mail to postmaster is never blocked
5715 by any of the subsequent tests. This can be helpful while sorting out problems
5716 in cases where the subsequent tests are incorrectly denying access.
5717 .code
5718 require verify        = sender
5719 .endd
5720 This statement requires the sender address to be verified before any subsequent
5721 ACL statement can be used. If verification fails, the incoming recipient
5722 address is refused. Verification consists of trying to route the address, to
5723 see if a bounce message could be delivered to it. In the case of remote
5724 addresses, basic verification checks only the domain, but &'callouts'& can be
5725 used for more verification if required. Section &<<SECTaddressverification>>&
5726 discusses the details of address verification.
5727 .code
5728 accept  hosts         = +relay_from_hosts
5729         control       = submission
5730 .endd
5731 This statement accepts the address if the message is coming from one of the
5732 hosts that are defined as being allowed to relay through this host. Recipient
5733 verification is omitted here, because in many cases the clients are dumb MUAs
5734 that do not cope well with SMTP error responses. For the same reason, the
5735 second line specifies &"submission mode"& for messages that are accepted. This
5736 is described in detail in section &<<SECTsubmodnon>>&; it causes Exim to fix
5737 messages that are deficient in some way, for example, because they lack a
5738 &'Date:'& header line. If you are actually relaying out from MTAs, you should
5739 probably add recipient verification here, and disable submission mode.
5740 .code
5741 accept  authenticated = *
5742         control       = submission
5743 .endd
5744 This statement accepts the address if the client host has authenticated itself.
5745 Submission mode is again specified, on the grounds that such messages are most
5746 likely to come from MUAs. The default configuration does not define any
5747 authenticators, though it does include some nearly complete commented-out
5748 examples described in &<<SECTdefconfauth>>&. This means that no client can in
5749 fact authenticate until you complete the authenticator definitions.
5750 .code
5751 require message = relay not permitted
5752         domains = +local_domains : +relay_to_domains
5753 .endd
5754 This statement rejects the address if its domain is neither a local domain nor
5755 one of the domains for which this host is a relay.
5756 .code
5757 require verify = recipient
5758 .endd
5759 This statement requires the recipient address to be verified; if verification
5760 fails, the address is rejected.
5761 .code
5762 # deny    message     = rejected because $sender_host_address \
5763 #                       is in a black list at $dnslist_domain\n\
5764 #                       $dnslist_text
5765 #         dnslists    = black.list.example
5766 #
5767 # warn    dnslists    = black.list.example
5768 #         add_header  = X-Warning: $sender_host_address is in \
5769 #                       a black list at $dnslist_domain
5770 #         log_message = found in $dnslist_domain
5771 .endd
5772 These commented-out lines are examples of how you could configure Exim to check
5773 sending hosts against a DNS black list. The first statement rejects messages
5774 from blacklisted hosts, whereas the second just inserts a warning header
5775 line.
5776 .code
5777 # require verify = csa
5778 .endd
5779 This commented-out line is an example of how you could turn on client SMTP
5780 authorization (CSA) checking. Such checks do DNS lookups for special SRV
5781 records.
5782 .code
5783 accept
5784 .endd
5785 The final statement in the first ACL unconditionally accepts any recipient
5786 address that has successfully passed all the previous tests.
5787 .code
5788 acl_check_data:
5789 .endd
5790 This line marks the start of the second ACL, and names it. Most of the contents
5791 of this ACL are commented out:
5792 .code
5793 # deny    malware   = *
5794 #         message   = This message contains a virus \
5795 #                     ($malware_name).
5796 .endd
5797 These lines are examples of how to arrange for messages to be scanned for
5798 viruses when Exim has been compiled with the content-scanning extension, and a
5799 suitable virus scanner is installed. If the message is found to contain a
5800 virus, it is rejected with the given custom error message.
5801 .code
5802 # warn    spam      = nobody
5803 #         message   = X-Spam_score: $spam_score\n\
5804 #                     X-Spam_score_int: $spam_score_int\n\
5805 #                     X-Spam_bar: $spam_bar\n\
5806 #                     X-Spam_report: $spam_report
5807 .endd
5808 These lines are an example of how to arrange for messages to be scanned by
5809 SpamAssassin when Exim has been compiled with the content-scanning extension,
5810 and SpamAssassin has been installed. The SpamAssassin check is run with
5811 &`nobody`& as its user parameter, and the results are added to the message as a
5812 series of extra header line. In this case, the message is not rejected,
5813 whatever the spam score.
5814 .code
5815 accept
5816 .endd
5817 This final line in the DATA ACL accepts the message unconditionally.
5818
5819
5820 .section "Router configuration" "SECID55"
5821 .cindex "default" "routers"
5822 .cindex "routers" "default"
5823 The router configuration comes next in the default configuration, introduced
5824 by the line
5825 .code
5826 begin routers
5827 .endd
5828 Routers are the modules in Exim that make decisions about where to send
5829 messages. An address is passed to each router in turn, until it is either
5830 accepted, or failed. This means that the order in which you define the routers
5831 matters. Each router is fully described in its own chapter later in this
5832 manual. Here we give only brief overviews.
5833 .code
5834 # domain_literal:
5835 #   driver = ipliteral
5836 #   domains = !+local_domains
5837 #   transport = remote_smtp
5838 .endd
5839 .cindex "domain literal" "default router"
5840 This router is commented out because the majority of sites do not want to
5841 support domain literal addresses (those of the form &'user@[10.9.8.7]'&). If
5842 you uncomment this router, you also need to uncomment the setting of
5843 &%allow_domain_literals%& in the main part of the configuration.
5844 .code
5845 dnslookup:
5846   driver = dnslookup
5847   domains = ! +local_domains
5848   transport = remote_smtp
5849   ignore_target_hosts = 0.0.0.0 : 127.0.0.0/8
5850   no_more
5851 .endd
5852 The first uncommented router handles addresses that do not involve any local
5853 domains. This is specified by the line
5854 .code
5855 domains = ! +local_domains
5856 .endd
5857 The &%domains%& option lists the domains to which this router applies, but the
5858 exclamation mark is a negation sign, so the router is used only for domains
5859 that are not in the domain list called &'local_domains'& (which was defined at
5860 the start of the configuration). The plus sign before &'local_domains'&
5861 indicates that it is referring to a named list. Addresses in other domains are
5862 passed on to the following routers.
5863
5864 The name of the router driver is &(dnslookup)&,
5865 and is specified by the &%driver%& option. Do not be confused by the fact that
5866 the name of this router instance is the same as the name of the driver. The
5867 instance name is arbitrary, but the name set in the &%driver%& option must be
5868 one of the driver modules that is in the Exim binary.
5869
5870 The &(dnslookup)& router routes addresses by looking up their domains in the
5871 DNS in order to obtain a list of hosts to which the address is routed. If the
5872 router succeeds, the address is queued for the &(remote_smtp)& transport, as
5873 specified by the &%transport%& option. If the router does not find the domain
5874 in the DNS, no further routers are tried because of the &%no_more%& setting, so
5875 the address fails and is bounced.
5876
5877 The &%ignore_target_hosts%& option specifies a list of IP addresses that are to
5878 be entirely ignored. This option is present because a number of cases have been
5879 encountered where MX records in the DNS point to host names
5880 whose IP addresses are 0.0.0.0 or are in the 127 subnet (typically 127.0.0.1).
5881 Completely ignoring these IP addresses causes Exim to fail to route the
5882 email address, so it bounces. Otherwise, Exim would log a routing problem, and
5883 continue to try to deliver the message periodically until the address timed
5884 out.
5885 .code
5886 system_aliases:
5887   driver = redirect
5888   allow_fail
5889   allow_defer
5890   data = ${lookup{$local_part}lsearch{/etc/aliases}}
5891 # user = exim
5892   file_transport = address_file
5893   pipe_transport = address_pipe
5894 .endd
5895 Control reaches this and subsequent routers only for addresses in the local
5896 domains. This router checks to see whether the local part is defined as an
5897 alias in the &_/etc/aliases_& file, and if so, redirects it according to the
5898 data that it looks up from that file. If no data is found for the local part,
5899 the value of the &%data%& option is empty, causing the address to be passed to
5900 the next router.
5901
5902 &_/etc/aliases_& is a conventional name for the system aliases file that is
5903 often used. That is why it is referenced by from the default configuration
5904 file. However, you can change this by setting SYSTEM_ALIASES_FILE in
5905 &_Local/Makefile_& before building Exim.
5906 .code
5907 userforward:
5908   driver = redirect
5909   check_local_user
5910 # local_part_suffix = +* : -*
5911 # local_part_suffix_optional
5912   file = $home/.forward
5913 # allow_filter
5914   no_verify
5915   no_expn
5916   check_ancestor
5917   file_transport = address_file
5918   pipe_transport = address_pipe
5919   reply_transport = address_reply
5920 .endd
5921 This is the most complicated router in the default configuration. It is another
5922 redirection router, but this time it is looking for forwarding data set up by
5923 individual users. The &%check_local_user%& setting specifies a check that the
5924 local part of the address is the login name of a local user. If it is not, the
5925 router is skipped. The two commented options that follow &%check_local_user%&,
5926 namely:
5927 .code
5928 # local_part_suffix = +* : -*
5929 # local_part_suffix_optional
5930 .endd
5931 .vindex "&$local_part_suffix$&"
5932 show how you can specify the recognition of local part suffixes. If the first
5933 is uncommented, a suffix beginning with either a plus or a minus sign, followed
5934 by any sequence of characters, is removed from the local part and placed in the
5935 variable &$local_part_suffix$&. The second suffix option specifies that the
5936 presence of a suffix in the local part is optional. When a suffix is present,
5937 the check for a local login uses the local part with the suffix removed.
5938
5939 When a local user account is found, the file called &_.forward_& in the user's
5940 home directory is consulted. If it does not exist, or is empty, the router
5941 declines. Otherwise, the contents of &_.forward_& are interpreted as
5942 redirection data (see chapter &<<CHAPredirect>>& for more details).
5943
5944 .cindex "Sieve filter" "enabling in default router"
5945 Traditional &_.forward_& files contain just a list of addresses, pipes, or
5946 files. Exim supports this by default. However, if &%allow_filter%& is set (it
5947 is commented out by default), the contents of the file are interpreted as a set
5948 of Exim or Sieve filtering instructions, provided the file begins with &"#Exim
5949 filter"& or &"#Sieve filter"&, respectively. User filtering is discussed in the
5950 separate document entitled &'Exim's interfaces to mail filtering'&.
5951
5952 The &%no_verify%& and &%no_expn%& options mean that this router is skipped when
5953 verifying addresses, or when running as a consequence of an SMTP EXPN command.
5954 There are two reasons for doing this:
5955
5956 .olist
5957 Whether or not a local user has a &_.forward_& file is not really relevant when
5958 checking an address for validity; it makes sense not to waste resources doing
5959 unnecessary work.
5960 .next
5961 More importantly, when Exim is verifying addresses or handling an EXPN
5962 command during an SMTP session, it is running as the Exim user, not as root.
5963 The group is the Exim group, and no additional groups are set up.
5964 It may therefore not be possible for Exim to read users' &_.forward_& files at
5965 this time.
5966 .endlist
5967
5968 The setting of &%check_ancestor%& prevents the router from generating a new
5969 address that is the same as any previous address that was redirected. (This
5970 works round a problem concerning a bad interaction between aliasing and
5971 forwarding &-- see section &<<SECTredlocmai>>&).
5972
5973 The final three option settings specify the transports that are to be used when
5974 forwarding generates a direct delivery to a file, or to a pipe, or sets up an
5975 auto-reply, respectively. For example, if a &_.forward_& file contains
5976 .code
5977 a.nother@elsewhere.example, /home/spqr/archive
5978 .endd
5979 the delivery to &_/home/spqr/archive_& is done by running the &%address_file%&
5980 transport.
5981 .code
5982 localuser:
5983   driver = accept
5984   check_local_user
5985 # local_part_suffix = +* : -*
5986 # local_part_suffix_optional
5987   transport = local_delivery
5988 .endd
5989 The final router sets up delivery into local mailboxes, provided that the local
5990 part is the name of a local login, by accepting the address and assigning it to
5991 the &(local_delivery)& transport. Otherwise, we have reached the end of the
5992 routers, so the address is bounced. The commented suffix settings fulfil the
5993 same purpose as they do for the &(userforward)& router.
5994
5995
5996 .section "Transport configuration" "SECID56"
5997 .cindex "default" "transports"
5998 .cindex "transports" "default"
5999 Transports define mechanisms for actually delivering messages. They operate
6000 only when referenced from routers, so the order in which they are defined does
6001 not matter. The transports section of the configuration starts with
6002 .code
6003 begin transports
6004 .endd
6005 One remote transport and four local transports are defined.
6006 .code
6007 remote_smtp:
6008   driver = smtp
6009 .endd
6010 This transport is used for delivering messages over SMTP connections. All its
6011 options are defaulted. The list of remote hosts comes from the router.
6012 .code
6013 local_delivery:
6014   driver = appendfile
6015   file = /var/mail/$local_part
6016   delivery_date_add
6017   envelope_to_add
6018   return_path_add
6019 # group = mail
6020 # mode = 0660
6021 .endd
6022 This &(appendfile)& transport is used for local delivery to user mailboxes in
6023 traditional BSD mailbox format. By default it runs under the uid and gid of the
6024 local user, which requires the sticky bit to be set on the &_/var/mail_&
6025 directory. Some systems use the alternative approach of running mail deliveries
6026 under a particular group instead of using the sticky bit. The commented options
6027 show how this can be done.
6028
6029 Exim adds three headers to the message as it delivers it: &'Delivery-date:'&,
6030 &'Envelope-to:'& and &'Return-path:'&. This action is requested by the three
6031 similarly-named options above.
6032 .code
6033 address_pipe:
6034   driver = pipe
6035   return_output
6036 .endd
6037 This transport is used for handling deliveries to pipes that are generated by
6038 redirection (aliasing or users' &_.forward_& files). The &%return_output%&
6039 option specifies that any output generated by the pipe is to be returned to the
6040 sender.
6041 .code
6042 address_file:
6043   driver = appendfile
6044   delivery_date_add
6045   envelope_to_add
6046   return_path_add
6047 .endd
6048 This transport is used for handling deliveries to files that are generated by
6049 redirection. The name of the file is not specified in this instance of
6050 &(appendfile)&, because it comes from the &(redirect)& router.
6051 .code
6052 address_reply:
6053   driver = autoreply
6054 .endd
6055 This transport is used for handling automatic replies generated by users'
6056 filter files.
6057
6058
6059
6060 .section "Default retry rule" "SECID57"
6061 .cindex "retry" "default rule"
6062 .cindex "default" "retry rule"
6063 The retry section of the configuration file contains rules which affect the way
6064 Exim retries deliveries that cannot be completed at the first attempt. It is
6065 introduced by the line
6066 .code
6067 begin retry
6068 .endd
6069 In the default configuration, there is just one rule, which applies to all
6070 errors:
6071 .code
6072 *   *   F,2h,15m; G,16h,1h,1.5; F,4d,6h
6073 .endd
6074 This causes any temporarily failing address to be retried every 15 minutes for
6075 2 hours, then at intervals starting at one hour and increasing by a factor of
6076 1.5 until 16 hours have passed, then every 6 hours up to 4 days. If an address
6077 is not delivered after 4 days of temporary failure, it is bounced.
6078
6079 If the retry section is removed from the configuration, or is empty (that is,
6080 if no retry rules are defined), Exim will not retry deliveries. This turns
6081 temporary errors into permanent errors.
6082
6083
6084 .section "Rewriting configuration" "SECID58"
6085 The rewriting section of the configuration, introduced by
6086 .code
6087 begin rewrite
6088 .endd
6089 contains rules for rewriting addresses in messages as they arrive. There are no
6090 rewriting rules in the default configuration file.
6091
6092
6093
6094 .section "Authenticators configuration" "SECTdefconfauth"
6095 .cindex "AUTH" "configuration"
6096 The authenticators section of the configuration, introduced by
6097 .code
6098 begin authenticators
6099 .endd
6100 defines mechanisms for the use of the SMTP AUTH command. The default
6101 configuration file contains two commented-out example authenticators
6102 which support plaintext username/password authentication using the
6103 standard PLAIN mechanism and the traditional but non-standard LOGIN
6104 mechanism, with Exim acting as the server. PLAIN and LOGIN are enough
6105 to support most MUA software.
6106
6107 The example PLAIN authenticator looks like this:
6108 .code
6109 #PLAIN:
6110 #  driver                  = plaintext
6111 #  server_set_id           = $auth2
6112 #  server_prompts          = :
6113 #  server_condition        = Authentication is not yet configured
6114 #  server_advertise_condition = ${if def:tls_in_cipher }
6115 .endd
6116 And the example LOGIN authenticator looks like this:
6117 .code
6118 #LOGIN:
6119 #  driver                  = plaintext
6120 #  server_set_id           = $auth1
6121 #  server_prompts          = <| Username: | Password:
6122 #  server_condition        = Authentication is not yet configured
6123 #  server_advertise_condition = ${if def:tls_in_cipher }
6124 .endd
6125
6126 The &%server_set_id%& option makes Exim remember the authenticated username
6127 in &$authenticated_id$&, which can be used later in ACLs or routers. The
6128 &%server_prompts%& option configures the &(plaintext)& authenticator so
6129 that it implements the details of the specific authentication mechanism,
6130 i.e. PLAIN or LOGIN. The &%server_advertise_condition%& setting controls
6131 when Exim offers authentication to clients; in the examples, this is only
6132 when TLS or SSL has been started, so to enable the authenticators you also
6133 need to add support for TLS as described in section &<<SECTdefconfmain>>&.
6134
6135 The &%server_condition%& setting defines how to verify that the username and
6136 password are correct. In the examples it just produces an error message.
6137 To make the authenticators work, you can use a string expansion
6138 expression like one of the examples in chapter &<<CHAPplaintext>>&.
6139
6140 Beware that the sequence of the parameters to PLAIN and LOGIN differ; the
6141 usercode and password are in different positions.
6142 Chapter &<<CHAPplaintext>>& covers both.
6143
6144 .ecindex IIDconfiwal
6145
6146
6147
6148 . ////////////////////////////////////////////////////////////////////////////
6149 . ////////////////////////////////////////////////////////////////////////////
6150
6151 .chapter "Regular expressions" "CHAPregexp"
6152
6153 .cindex "regular expressions" "library"
6154 .cindex "PCRE"
6155 Exim supports the use of regular expressions in many of its options. It
6156 uses the PCRE regular expression library; this provides regular expression
6157 matching that is compatible with Perl 5. The syntax and semantics of
6158 regular expressions is discussed in many Perl reference books, and also in
6159 Jeffrey Friedl's &'Mastering Regular Expressions'&, which is published by
6160 O'Reilly (see &url(http://www.oreilly.com/catalog/regex2/)).
6161
6162 The documentation for the syntax and semantics of the regular expressions that
6163 are supported by PCRE is included in the PCRE distribution, and no further
6164 description is included here. The PCRE functions are called from Exim using
6165 the default option settings (that is, with no PCRE options set), except that
6166 the PCRE_CASELESS option is set when the matching is required to be
6167 case-insensitive.
6168
6169 In most cases, when a regular expression is required in an Exim configuration,
6170 it has to start with a circumflex, in order to distinguish it from plain text
6171 or an &"ends with"& wildcard. In this example of a configuration setting, the
6172 second item in the colon-separated list is a regular expression.
6173 .code
6174 domains = a.b.c : ^\\d{3} : *.y.z : ...
6175 .endd
6176 The doubling of the backslash is required because of string expansion that
6177 precedes interpretation &-- see section &<<SECTlittext>>& for more discussion
6178 of this issue, and a way of avoiding the need for doubling backslashes. The
6179 regular expression that is eventually used in this example contains just one
6180 backslash. The circumflex is included in the regular expression, and has the
6181 normal effect of &"anchoring"& it to the start of the string that is being
6182 matched.
6183
6184 There are, however, two cases where a circumflex is not required for the
6185 recognition of a regular expression: these are the &%match%& condition in a
6186 string expansion, and the &%matches%& condition in an Exim filter file. In
6187 these cases, the relevant string is always treated as a regular expression; if
6188 it does not start with a circumflex, the expression is not anchored, and can
6189 match anywhere in the subject string.
6190
6191 In all cases, if you want a regular expression to match at the end of a string,
6192 you must code the $ metacharacter to indicate this. For example:
6193 .code
6194 domains = ^\\d{3}\\.example
6195 .endd
6196 matches the domain &'123.example'&, but it also matches &'123.example.com'&.
6197 You need to use:
6198 .code
6199 domains = ^\\d{3}\\.example\$
6200 .endd
6201 if you want &'example'& to be the top-level domain. The backslash before the
6202 $ is needed because string expansion also interprets dollar characters.
6203
6204
6205
6206 . ////////////////////////////////////////////////////////////////////////////
6207 . ////////////////////////////////////////////////////////////////////////////
6208
6209 .chapter "File and database lookups" "CHAPfdlookup"
6210 .scindex IIDfidalo1 "file" "lookups"
6211 .scindex IIDfidalo2 "database" "lookups"
6212 .cindex "lookup" "description of"
6213 Exim can be configured to look up data in files or databases as it processes
6214 messages. Two different kinds of syntax are used:
6215
6216 .olist
6217 A string that is to be expanded may contain explicit lookup requests. These
6218 cause parts of the string to be replaced by data that is obtained from the
6219 lookup. Lookups of this type are conditional expansion items. Different results
6220 can be defined for the cases of lookup success and failure. See chapter
6221 &<<CHAPexpand>>&, where string expansions are described in detail.
6222 .next
6223 Lists of domains, hosts, and email addresses can contain lookup requests as a
6224 way of avoiding excessively long linear lists. In this case, the data that is
6225 returned by the lookup is often (but not always) discarded; whether the lookup
6226 succeeds or fails is what really counts. These kinds of list are described in
6227 chapter &<<CHAPdomhosaddlists>>&.
6228 .endlist
6229
6230 String expansions, lists, and lookups interact with each other in such a way
6231 that there is no order in which to describe any one of them that does not
6232 involve references to the others. Each of these three chapters makes more sense
6233 if you have read the other two first. If you are reading this for the first
6234 time, be aware that some of it will make a lot more sense after you have read
6235 chapters &<<CHAPdomhosaddlists>>& and &<<CHAPexpand>>&.
6236
6237 .section "Examples of different lookup syntax" "SECID60"
6238 It is easy to confuse the two different kinds of lookup, especially as the
6239 lists that may contain the second kind are always expanded before being
6240 processed as lists. Therefore, they may also contain lookups of the first kind.
6241 Be careful to distinguish between the following two examples:
6242 .code
6243 domains = ${lookup{$sender_host_address}lsearch{/some/file}}
6244 domains = lsearch;/some/file
6245 .endd
6246 The first uses a string expansion, the result of which must be a domain list.
6247 No strings have been specified for a successful or a failing lookup; the
6248 defaults in this case are the looked-up data and an empty string, respectively.
6249 The expansion takes place before the string is processed as a list, and the
6250 file that is searched could contain lines like this:
6251 .code
6252 192.168.3.4: domain1:domain2:...
6253 192.168.1.9: domain3:domain4:...
6254 .endd
6255 When the lookup succeeds, the result of the expansion is a list of domains (and
6256 possibly other types of item that are allowed in domain lists).
6257
6258 In the second example, the lookup is a single item in a domain list. It causes
6259 Exim to use a lookup to see if the domain that is being processed can be found
6260 in the file. The file could contains lines like this:
6261 .code
6262 domain1:
6263 domain2:
6264 .endd
6265 Any data that follows the keys is not relevant when checking that the domain
6266 matches the list item.
6267
6268 It is possible, though no doubt confusing, to use both kinds of lookup at once.
6269 Consider a file containing lines like this:
6270 .code
6271 192.168.5.6: lsearch;/another/file
6272 .endd
6273 If the value of &$sender_host_address$& is 192.168.5.6, expansion of the
6274 first &%domains%& setting above generates the second setting, which therefore
6275 causes a second lookup to occur.
6276
6277 The rest of this chapter describes the different lookup types that are
6278 available. Any of them can be used in any part of the configuration where a
6279 lookup is permitted.
6280
6281
6282 .section "Lookup types" "SECID61"
6283 .cindex "lookup" "types of"
6284 .cindex "single-key lookup" "definition of"
6285 Two different types of data lookup are implemented:
6286
6287 .ilist
6288 The &'single-key'& type requires the specification of a file in which to look,
6289 and a single key to search for. The key must be a non-empty string for the
6290 lookup to succeed. The lookup type determines how the file is searched.
6291 .next
6292 .cindex "query-style lookup" "definition of"
6293 The &'query-style'& type accepts a generalized database query. No particular
6294 key value is assumed by Exim for query-style lookups. You can use whichever
6295 Exim variables you need to construct the database query.
6296 .endlist
6297
6298 The code for each lookup type is in a separate source file that is included in
6299 the binary of Exim only if the corresponding compile-time option is set. The
6300 default settings in &_src/EDITME_& are:
6301 .code
6302 LOOKUP_DBM=yes
6303 LOOKUP_LSEARCH=yes
6304 .endd
6305 which means that only linear searching and DBM lookups are included by default.
6306 For some types of lookup (e.g. SQL databases), you need to install appropriate
6307 libraries and header files before building Exim.
6308
6309
6310
6311
6312 .section "Single-key lookup types" "SECTsinglekeylookups"
6313 .cindex "lookup" "single-key types"
6314 .cindex "single-key lookup" "list of types"
6315 The following single-key lookup types are implemented:
6316
6317 .ilist
6318 .cindex "cdb" "description of"
6319 .cindex "lookup" "cdb"
6320 .cindex "binary zero" "in lookup key"
6321 &(cdb)&: The given file is searched as a Constant DataBase file, using the key
6322 string without a terminating binary zero. The cdb format is designed for
6323 indexed files that are read frequently and never updated, except by total
6324 re-creation. As such, it is particularly suitable for large files containing
6325 aliases or other indexed data referenced by an MTA. Information about cdb can
6326 be found in several places:
6327 .display
6328 &url(http://www.pobox.com/~djb/cdb.html)
6329 &url(ftp://ftp.corpit.ru/pub/tinycdb/)
6330 &url(http://packages.debian.org/stable/utils/freecdb.html)
6331 .endd
6332 A cdb distribution is not needed in order to build Exim with cdb support,
6333 because the code for reading cdb files is included directly in Exim itself.
6334 However, no means of building or testing cdb files is provided with Exim, so
6335 you need to obtain a cdb distribution in order to do this.
6336 .next
6337 .cindex "DBM" "lookup type"
6338 .cindex "lookup" "dbm"
6339 .cindex "binary zero" "in lookup key"
6340 &(dbm)&: Calls to DBM library functions are used to extract data from the given
6341 DBM file by looking up the record with the given key. A terminating binary
6342 zero is included in the key that is passed to the DBM library. See section
6343 &<<SECTdb>>& for a discussion of DBM libraries.
6344
6345 .cindex "Berkeley DB library" "file format"
6346 For all versions of Berkeley DB, Exim uses the DB_HASH style of database
6347 when building DBM files using the &%exim_dbmbuild%& utility. However, when
6348 using Berkeley DB versions 3 or 4, it opens existing databases for reading with
6349 the DB_UNKNOWN option. This enables it to handle any of the types of database
6350 that the library supports, and can be useful for accessing DBM files created by
6351 other applications. (For earlier DB versions, DB_HASH is always used.)
6352 .next
6353 .cindex "lookup" "dbmjz"
6354 .cindex "lookup" "dbm &-- embedded NULs"
6355 .cindex "sasldb2"
6356 .cindex "dbmjz lookup type"
6357 &(dbmjz)&: This is the same as &(dbm)&, except that the lookup key is
6358 interpreted as an Exim list; the elements of the list are joined together with
6359 ASCII NUL characters to form the lookup key.  An example usage would be to
6360 authenticate incoming SMTP calls using the passwords from Cyrus SASL's
6361 &_/etc/sasldb2_& file with the &(gsasl)& authenticator or Exim's own
6362 &(cram_md5)& authenticator.
6363 .next
6364 .cindex "lookup" "dbmnz"
6365 .cindex "lookup" "dbm &-- terminating zero"
6366 .cindex "binary zero" "in lookup key"
6367 .cindex "Courier"
6368 .cindex "&_/etc/userdbshadow.dat_&"
6369 .cindex "dbmnz lookup type"
6370 &(dbmnz)&: This is the same as &(dbm)&, except that a terminating binary zero
6371 is not included in the key that is passed to the DBM library. You may need this
6372 if you want to look up data in files that are created by or shared with some
6373 other application that does not use terminating zeros. For example, you need to
6374 use &(dbmnz)& rather than &(dbm)& if you want to authenticate incoming SMTP
6375 calls using the passwords from Courier's &_/etc/userdbshadow.dat_& file. Exim's
6376 utility program for creating DBM files (&'exim_dbmbuild'&) includes the zeros
6377 by default, but has an option to omit them (see section &<<SECTdbmbuild>>&).
6378 .next
6379 .cindex "lookup" "dsearch"
6380 .cindex "dsearch lookup type"
6381 &(dsearch)&: The given file must be a directory; this is searched for an entry
6382 whose name is the key by calling the &[lstat()]& function. The key may not
6383 contain any forward slash characters. If &[lstat()]& succeeds, the result of
6384 the lookup is the name of the entry, which may be a file, directory,
6385 symbolic link, or any other kind of directory entry. An example of how this
6386 lookup can be used to support virtual domains is given in section
6387 &<<SECTvirtualdomains>>&.
6388 .next
6389 .cindex "lookup" "iplsearch"
6390 .cindex "iplsearch lookup type"
6391 &(iplsearch)&: The given file is a text file containing keys and data. A key is
6392 terminated by a colon or white space or the end of the line. The keys in the
6393 file must be IP addresses, or IP addresses with CIDR masks. Keys that involve
6394 IPv6 addresses must be enclosed in quotes to prevent the first internal colon
6395 being interpreted as a key terminator. For example:
6396 .code
6397 1.2.3.4:           data for 1.2.3.4
6398 192.168.0.0/16:    data for 192.168.0.0/16
6399 "abcd::cdab":      data for abcd::cdab
6400 "abcd:abcd::/32"   data for abcd:abcd::/32
6401 .endd
6402 The key for an &(iplsearch)& lookup must be an IP address (without a mask). The
6403 file is searched linearly, using the CIDR masks where present, until a matching
6404 key is found. The first key that matches is used; there is no attempt to find a
6405 &"best"& match. Apart from the way the keys are matched, the processing for
6406 &(iplsearch)& is the same as for &(lsearch)&.
6407
6408 &*Warning 1*&: Unlike most other single-key lookup types, a file of data for
6409 &(iplsearch)& can &'not'& be turned into a DBM or cdb file, because those
6410 lookup types support only literal keys.
6411
6412 &*Warning 2*&: In a host list, you must always use &(net-iplsearch)& so that
6413 the implicit key is the host's IP address rather than its name (see section
6414 &<<SECThoslispatsikey>>&).
6415 .next
6416 .cindex "linear search"
6417 .cindex "lookup" "lsearch"
6418 .cindex "lsearch lookup type"
6419 .cindex "case sensitivity" "in lsearch lookup"
6420 &(lsearch)&: The given file is a text file that is searched linearly for a
6421 line beginning with the search key, terminated by a colon or white space or the
6422 end of the line. The search is case-insensitive; that is, upper and lower case
6423 letters are treated as the same. The first occurrence of the key that is found
6424 in the file is used.
6425
6426 White space between the key and the colon is permitted. The remainder of the
6427 line, with leading and trailing white space removed, is the data. This can be
6428 continued onto subsequent lines by starting them with any amount of white
6429 space, but only a single space character is included in the data at such a
6430 junction. If the data begins with a colon, the key must be terminated by a
6431 colon, for example:
6432 .code
6433 baduser:  :fail:
6434 .endd
6435 Empty lines and lines beginning with # are ignored, even if they occur in the
6436 middle of an item. This is the traditional textual format of alias files. Note
6437 that the keys in an &(lsearch)& file are literal strings. There is no
6438 wildcarding of any kind.
6439
6440 .cindex "lookup" "lsearch &-- colons in keys"
6441 .cindex "white space" "in lsearch key"
6442 In most &(lsearch)& files, keys are not required to contain colons or #
6443 characters, or white space. However, if you need this feature, it is available.
6444 If a key begins with a doublequote character, it is terminated only by a
6445 matching quote (or end of line), and the normal escaping rules apply to its
6446 contents (see section &<<SECTstrings>>&). An optional colon is permitted after
6447 quoted keys (exactly as for unquoted keys). There is no special handling of
6448 quotes for the data part of an &(lsearch)& line.
6449
6450 .next
6451 .cindex "NIS lookup type"
6452 .cindex "lookup" "NIS"
6453 .cindex "binary zero" "in lookup key"
6454 &(nis)&: The given file is the name of a NIS map, and a NIS lookup is done with
6455 the given key, without a terminating binary zero. There is a variant called
6456 &(nis0)& which does include the terminating binary zero in the key. This is
6457 reportedly needed for Sun-style alias files. Exim does not recognize NIS
6458 aliases; the full map names must be used.
6459
6460 .next
6461 .cindex "wildlsearch lookup type"
6462 .cindex "lookup" "wildlsearch"
6463 .cindex "nwildlsearch lookup type"
6464 .cindex "lookup" "nwildlsearch"
6465 &(wildlsearch)& or &(nwildlsearch)&: These search a file linearly, like
6466 &(lsearch)&, but instead of being interpreted as a literal string, each key in
6467 the file may be wildcarded. The difference between these two lookup types is
6468 that for &(wildlsearch)&, each key in the file is string-expanded before being
6469 used, whereas for &(nwildlsearch)&, no expansion takes place.
6470
6471 .cindex "case sensitivity" "in (n)wildlsearch lookup"
6472 Like &(lsearch)&, the testing is done case-insensitively. However, keys in the
6473 file that are regular expressions can be made case-sensitive by the use of
6474 &`(-i)`& within the pattern. The following forms of wildcard are recognized:
6475
6476 . ==== As this is a nested list, any displays it contains must be indented
6477 . ==== as otherwise they are too far to the left.
6478
6479 .olist
6480 The string may begin with an asterisk to mean &"ends with"&. For example:
6481 .code
6482     *.a.b.c       data for anything.a.b.c
6483     *fish         data for anythingfish
6484 .endd
6485 .next
6486 The string may begin with a circumflex to indicate a regular expression. For
6487 example, for &(wildlsearch)&:
6488 .code
6489     ^\N\d+\.a\.b\N    data for <digits>.a.b
6490 .endd
6491 Note the use of &`\N`& to disable expansion of the contents of the regular
6492 expression. If you are using &(nwildlsearch)&, where the keys are not
6493 string-expanded, the equivalent entry is:
6494 .code
6495     ^\d+\.a\.b        data for <digits>.a.b
6496 .endd
6497 The case-insensitive flag is set at the start of compiling the regular
6498 expression, but it can be turned off by using &`(-i)`& at an appropriate point.
6499 For example, to make the entire pattern case-sensitive:
6500 .code
6501     ^(?-i)\d+\.a\.b        data for <digits>.a.b
6502 .endd
6503
6504 If the regular expression contains white space or colon characters, you must
6505 either quote it (see &(lsearch)& above), or represent these characters in other
6506 ways. For example, &`\s`& can be used for white space and &`\x3A`& for a
6507 colon. This may be easier than quoting, because if you quote, you have to
6508 escape all the backslashes inside the quotes.
6509
6510 &*Note*&: It is not possible to capture substrings in a regular expression
6511 match for later use, because the results of all lookups are cached. If a lookup
6512 is repeated, the result is taken from the cache, and no actual pattern matching
6513 takes place. The values of all the numeric variables are unset after a
6514 &((n)wildlsearch)& match.
6515
6516 .next
6517 Although I cannot see it being of much use, the general matching function that
6518 is used to implement &((n)wildlsearch)& means that the string may begin with a
6519 lookup name terminated by a semicolon, and followed by lookup data. For
6520 example:
6521 .code
6522     cdb;/some/file  data for keys that match the file
6523 .endd
6524 The data that is obtained from the nested lookup is discarded.
6525 .endlist olist
6526
6527 Keys that do not match any of these patterns are interpreted literally. The
6528 continuation rules for the data are the same as for &(lsearch)&, and keys may
6529 be followed by optional colons.
6530
6531 &*Warning*&: Unlike most other single-key lookup types, a file of data for
6532 &((n)wildlsearch)& can &'not'& be turned into a DBM or cdb file, because those
6533 lookup types support only literal keys.
6534 .endlist ilist
6535
6536
6537 .section "Query-style lookup types" "SECID62"
6538 .cindex "lookup" "query-style types"
6539 .cindex "query-style lookup" "list of types"
6540 The supported query-style lookup types are listed below. Further details about
6541 many of them are given in later sections.
6542
6543 .ilist
6544 .cindex "DNS" "as a lookup type"
6545 .cindex "lookup" "DNS"
6546 &(dnsdb)&: This does a DNS search for one or more records whose domain names
6547 are given in the supplied query. The resulting data is the contents of the
6548 records. See section &<<SECTdnsdb>>&.
6549 .next
6550 .cindex "InterBase lookup type"
6551 .cindex "lookup" "InterBase"
6552 &(ibase)&: This does a lookup in an InterBase database.
6553 .next
6554 .cindex "LDAP" "lookup type"
6555 .cindex "lookup" "LDAP"
6556 &(ldap)&: This does an LDAP lookup using a query in the form of a URL, and
6557 returns attributes from a single entry. There is a variant called &(ldapm)&
6558 that permits values from multiple entries to be returned. A third variant
6559 called &(ldapdn)& returns the Distinguished Name of a single entry instead of
6560 any attribute values. See section &<<SECTldap>>&.
6561 .next
6562 .cindex "MySQL" "lookup type"
6563 .cindex "lookup" "MySQL"
6564 &(mysql)&: The format of the query is an SQL statement that is passed to a
6565 MySQL database. See section &<<SECTsql>>&.
6566 .next
6567 .cindex "NIS+ lookup type"
6568 .cindex "lookup" "NIS+"
6569 &(nisplus)&: This does a NIS+ lookup using a query that can specify the name of
6570 the field to be returned. See section &<<SECTnisplus>>&.
6571 .next
6572 .cindex "Oracle" "lookup type"
6573 .cindex "lookup" "Oracle"
6574 &(oracle)&: The format of the query is an SQL statement that is passed to an
6575 Oracle database. See section &<<SECTsql>>&.
6576 .next
6577 .cindex "lookup" "passwd"
6578 .cindex "passwd lookup type"
6579 .cindex "&_/etc/passwd_&"
6580 &(passwd)& is a query-style lookup with queries that are just user names. The
6581 lookup calls &[getpwnam()]& to interrogate the system password data, and on
6582 success, the result string is the same as you would get from an &(lsearch)&
6583 lookup on a traditional &_/etc/passwd file_&, though with &`*`& for the
6584 password value. For example:
6585 .code
6586 *:42:42:King Rat:/home/kr:/bin/bash
6587 .endd
6588 .next
6589 .cindex "PostgreSQL lookup type"
6590 .cindex "lookup" "PostgreSQL"
6591 &(pgsql)&: The format of the query is an SQL statement that is passed to a
6592 PostgreSQL database. See section &<<SECTsql>>&.
6593
6594 .next
6595 .cindex "sqlite lookup type"
6596 .cindex "lookup" "sqlite"
6597 &(sqlite)&: The format of the query is a file name followed by an SQL statement
6598 that is passed to an SQLite database. See section &<<SECTsqlite>>&.
6599
6600 .next
6601 &(testdb)&: This is a lookup type that is used for testing Exim. It is
6602 not likely to be useful in normal operation.
6603 .next
6604 .cindex "whoson lookup type"
6605 .cindex "lookup" "whoson"
6606 &(whoson)&: &'Whoson'& (&url(http://whoson.sourceforge.net)) is a protocol that
6607 allows a server to check whether a particular (dynamically allocated) IP
6608 address is currently allocated to a known (trusted) user and, optionally, to
6609 obtain the identity of the said user. For SMTP servers, &'Whoson'& was popular
6610 at one time for &"POP before SMTP"& authentication, but that approach has been
6611 superseded by SMTP authentication. In Exim, &'Whoson'& can be used to implement
6612 &"POP before SMTP"& checking using ACL statements such as
6613 .code
6614 require condition = \
6615   ${lookup whoson {$sender_host_address}{yes}{no}}
6616 .endd
6617 The query consists of a single IP address. The value returned is the name of
6618 the authenticated user, which is stored in the variable &$value$&. However, in
6619 this example, the data in &$value$& is not used; the result of the lookup is
6620 one of the fixed strings &"yes"& or &"no"&.
6621 .endlist
6622
6623
6624
6625 .section "Temporary errors in lookups" "SECID63"
6626 .cindex "lookup" "temporary error in"
6627 Lookup functions can return temporary error codes if the lookup cannot be
6628 completed. For example, an SQL or LDAP database might be unavailable. For this
6629 reason, it is not advisable to use a lookup that might do this for critical
6630 options such as a list of local domains.
6631
6632 When a lookup cannot be completed in a router or transport, delivery
6633 of the message (to the relevant address) is deferred, as for any other
6634 temporary error. In other circumstances Exim may assume the lookup has failed,
6635 or may give up altogether.
6636
6637
6638
6639 .section "Default values in single-key lookups" "SECTdefaultvaluelookups"
6640 .cindex "wildcard lookups"
6641 .cindex "lookup" "default values"
6642 .cindex "lookup" "wildcard"
6643 .cindex "lookup" "* added to type"
6644 .cindex "default" "in single-key lookups"
6645 In this context, a &"default value"& is a value specified by the administrator
6646 that is to be used if a lookup fails.
6647
6648 &*Note:*& This section applies only to single-key lookups. For query-style
6649 lookups, the facilities of the query language must be used. An attempt to
6650 specify a default for a query-style lookup provokes an error.
6651
6652 If &"*"& is added to a single-key lookup type (for example, &%lsearch*%&)
6653 and the initial lookup fails, the key &"*"& is looked up in the file to
6654 provide a default value. See also the section on partial matching below.
6655
6656 .cindex "*@ with single-key lookup"
6657 .cindex "lookup" "*@ added to type"
6658 .cindex "alias file" "per-domain default"
6659 Alternatively, if &"*@"& is added to a single-key lookup type (for example
6660 &%dbm*@%&) then, if the initial lookup fails and the key contains an @
6661 character, a second lookup is done with everything before the last @ replaced
6662 by *. This makes it possible to provide per-domain defaults in alias files
6663 that include the domains in the keys. If the second lookup fails (or doesn't
6664 take place because there is no @ in the key), &"*"& is looked up.
6665 For example, a &(redirect)& router might contain:
6666 .code
6667 data = ${lookup{$local_part@$domain}lsearch*@{/etc/mix-aliases}}
6668 .endd
6669 Suppose the address that is being processed is &'jane@eyre.example'&. Exim
6670 looks up these keys, in this order:
6671 .code
6672 jane@eyre.example
6673 *@eyre.example
6674 *
6675 .endd
6676 The data is taken from whichever key it finds first. &*Note*&: In an
6677 &(lsearch)& file, this does not mean the first of these keys in the file. A
6678 complete scan is done for each key, and only if it is not found at all does
6679 Exim move on to try the next key.
6680
6681
6682
6683 .section "Partial matching in single-key lookups" "SECTpartiallookup"
6684 .cindex "partial matching"
6685 .cindex "wildcard lookups"
6686 .cindex "lookup" "partial matching"
6687 .cindex "lookup" "wildcard"
6688 .cindex "asterisk" "in search type"
6689 The normal operation of a single-key lookup is to search the file for an exact
6690 match with the given key. However, in a number of situations where domains are
6691 being looked up, it is useful to be able to do partial matching. In this case,
6692 information in the file that has a key starting with &"*."& is matched by any
6693 domain that ends with the components that follow the full stop. For example, if
6694 a key in a DBM file is
6695 .code
6696 *.dates.fict.example
6697 .endd
6698 then when partial matching is enabled this is matched by (amongst others)
6699 &'2001.dates.fict.example'& and &'1984.dates.fict.example'&. It is also matched
6700 by &'dates.fict.example'&, if that does not appear as a separate key in the
6701 file.
6702
6703 &*Note*&: Partial matching is not available for query-style lookups. It is
6704 also not available for any lookup items in address lists (see section
6705 &<<SECTaddresslist>>&).
6706
6707 Partial matching is implemented by doing a series of separate lookups using
6708 keys constructed by modifying the original subject key. This means that it can
6709 be used with any of the single-key lookup types, provided that
6710 partial matching keys
6711 beginning with a special prefix (default &"*."&) are included in the data file.
6712 Keys in the file that do not begin with the prefix are matched only by
6713 unmodified subject keys when partial matching is in use.
6714
6715 Partial matching is requested by adding the string &"partial-"& to the front of
6716 the name of a single-key lookup type, for example, &%partial-dbm%&. When this
6717 is done, the subject key is first looked up unmodified; if that fails, &"*."&
6718 is added at the start of the subject key, and it is looked up again. If that
6719 fails, further lookups are tried with dot-separated components removed from the
6720 start of the subject key, one-by-one, and &"*."& added on the front of what
6721 remains.
6722
6723 A minimum number of two non-* components are required. This can be adjusted
6724 by including a number before the hyphen in the search type. For example,
6725 &%partial3-lsearch%& specifies a minimum of three non-* components in the
6726 modified keys. Omitting the number is equivalent to &"partial2-"&. If the
6727 subject key is &'2250.dates.fict.example'& then the following keys are looked
6728 up when the minimum number of non-* components is two:
6729 .code
6730 2250.dates.fict.example
6731 *.2250.dates.fict.example
6732 *.dates.fict.example
6733 *.fict.example
6734 .endd
6735 As soon as one key in the sequence is successfully looked up, the lookup
6736 finishes.
6737
6738 .cindex "lookup" "partial matching &-- changing prefix"
6739 .cindex "prefix" "for partial matching"
6740 The use of &"*."& as the partial matching prefix is a default that can be
6741 changed. The motivation for this feature is to allow Exim to operate with file
6742 formats that are used by other MTAs. A different prefix can be supplied in
6743 parentheses instead of the hyphen after &"partial"&. For example:
6744 .code
6745 domains = partial(.)lsearch;/some/file
6746 .endd
6747 In this example, if the domain is &'a.b.c'&, the sequence of lookups is
6748 &`a.b.c`&, &`.a.b.c`&, and &`.b.c`& (the default minimum of 2 non-wild
6749 components is unchanged). The prefix may consist of any punctuation characters
6750 other than a closing parenthesis. It may be empty, for example:
6751 .code
6752 domains = partial1()cdb;/some/file
6753 .endd
6754 For this example, if the domain is &'a.b.c'&, the sequence of lookups is
6755 &`a.b.c`&, &`b.c`&, and &`c`&.
6756
6757 If &"partial0"& is specified, what happens at the end (when the lookup with
6758 just one non-wild component has failed, and the original key is shortened right
6759 down to the null string) depends on the prefix:
6760
6761 .ilist
6762 If the prefix has zero length, the whole lookup fails.
6763 .next
6764 If the prefix has length 1, a lookup for just the prefix is done. For
6765 example, the final lookup for &"partial0(.)"& is for &`.`& alone.
6766 .next
6767 Otherwise, if the prefix ends in a dot, the dot is removed, and the
6768 remainder is looked up. With the default prefix, therefore, the final lookup is
6769 for &"*"& on its own.
6770 .next
6771 Otherwise, the whole prefix is looked up.
6772 .endlist
6773
6774
6775 If the search type ends in &"*"& or &"*@"& (see section
6776 &<<SECTdefaultvaluelookups>>& above), the search for an ultimate default that
6777 this implies happens after all partial lookups have failed. If &"partial0"& is
6778 specified, adding &"*"& to the search type has no effect with the default
6779 prefix, because the &"*"& key is already included in the sequence of partial
6780 lookups. However, there might be a use for lookup types such as
6781 &"partial0(.)lsearch*"&.
6782
6783 The use of &"*"& in lookup partial matching differs from its use as a wildcard
6784 in domain lists and the like. Partial matching works only in terms of
6785 dot-separated components; a key such as &`*fict.example`&
6786 in a database file is useless, because the asterisk in a partial matching
6787 subject key is always followed by a dot.
6788
6789
6790
6791
6792 .section "Lookup caching" "SECID64"
6793 .cindex "lookup" "caching"
6794 .cindex "caching" "lookup data"
6795 Exim caches all lookup results in order to avoid needless repetition of
6796 lookups. However, because (apart from the daemon) Exim operates as a collection
6797 of independent, short-lived processes, this caching applies only within a
6798 single Exim process. There is no inter-process lookup caching facility.
6799
6800 For single-key lookups, Exim keeps the relevant files open in case there is
6801 another lookup that needs them. In some types of configuration this can lead to
6802 many files being kept open for messages with many recipients. To avoid hitting
6803 the operating system limit on the number of simultaneously open files, Exim
6804 closes the least recently used file when it needs to open more files than its
6805 own internal limit, which can be changed via the &%lookup_open_max%& option.
6806
6807 The single-key lookup files are closed and the lookup caches are flushed at
6808 strategic points during delivery &-- for example, after all routing is
6809 complete.
6810
6811
6812
6813
6814 .section "Quoting lookup data" "SECID65"
6815 .cindex "lookup" "quoting"
6816 .cindex "quoting" "in lookups"
6817 When data from an incoming message is included in a query-style lookup, there
6818 is the possibility of special characters in the data messing up the syntax of
6819 the query. For example, a NIS+ query that contains
6820 .code
6821 [name=$local_part]
6822 .endd
6823 will be broken if the local part happens to contain a closing square bracket.
6824 For NIS+, data can be enclosed in double quotes like this:
6825 .code
6826 [name="$local_part"]
6827 .endd
6828 but this still leaves the problem of a double quote in the data. The rule for
6829 NIS+ is that double quotes must be doubled. Other lookup types have different
6830 rules, and to cope with the differing requirements, an expansion operator
6831 of the following form is provided:
6832 .code
6833 ${quote_<lookup-type>:<string>}
6834 .endd
6835 For example, the safest way to write the NIS+ query is
6836 .code
6837 [name="${quote_nisplus:$local_part}"]
6838 .endd
6839 See chapter &<<CHAPexpand>>& for full coverage of string expansions. The quote
6840 operator can be used for all lookup types, but has no effect for single-key
6841 lookups, since no quoting is ever needed in their key strings.
6842
6843
6844
6845
6846 .section "More about dnsdb" "SECTdnsdb"
6847 .cindex "dnsdb lookup"
6848 .cindex "lookup" "dnsdb"
6849 .cindex "DNS" "as a lookup type"
6850 The &(dnsdb)& lookup type uses the DNS as its database. A simple query consists
6851 of a record type and a domain name, separated by an equals sign. For example,
6852 an expansion string could contain:
6853 .code
6854 ${lookup dnsdb{mx=a.b.example}{$value}fail}
6855 .endd
6856 If the lookup succeeds, the result is placed in &$value$&, which in this case
6857 is used on its own as the result. If the lookup does not succeed, the
6858 &`fail`& keyword causes a &'forced expansion failure'& &-- see section
6859 &<<SECTforexpfai>>& for an explanation of what this means.
6860
6861 The supported DNS record types are A, CNAME, MX, NS, PTR, SPF, SRV, and TXT,
6862 and, when Exim is compiled with IPv6 support, AAAA (and A6 if that is also
6863 configured). If no type is given, TXT is assumed. When the type is PTR,
6864 the data can be an IP address, written as normal; inversion and the addition of
6865 &%in-addr.arpa%& or &%ip6.arpa%& happens automatically. For example:
6866 .code
6867 ${lookup dnsdb{ptr=192.168.4.5}{$value}fail}
6868 .endd
6869 If the data for a PTR record is not a syntactically valid IP address, it is not
6870 altered and nothing is added.
6871
6872 .cindex "MX record" "in &(dnsdb)& lookup"
6873 .cindex "SRV record" "in &(dnsdb)& lookup"
6874 For an MX lookup, both the preference value and the host name are returned for
6875 each record, separated by a space. For an SRV lookup, the priority, weight,
6876 port, and host name are returned for each record, separated by spaces.
6877
6878 For any record type, if multiple records are found (or, for A6 lookups, if a
6879 single record leads to multiple addresses), the data is returned as a
6880 concatenation, with newline as the default separator. The order, of course,
6881 depends on the DNS resolver. You can specify a different separator character
6882 between multiple records by putting a right angle-bracket followed immediately
6883 by the new separator at the start of the query. For example:
6884 .code
6885 ${lookup dnsdb{>: a=host1.example}}
6886 .endd
6887 It is permitted to specify a space as the separator character. Further
6888 white space is ignored.
6889
6890 .cindex "TXT record" "in &(dnsdb)& lookup"
6891 .cindex "SPF record" "in &(dnsdb)& lookup"
6892 For TXT records with multiple items of data, only the first item is returned,
6893 unless a separator for them is specified using a comma after the separator
6894 character followed immediately by the TXT record item separator. To concatenate
6895 items without a separator, use a semicolon instead. For SPF records the
6896 default behaviour is to concatenate multiple items without using a separator.
6897 .code
6898 ${lookup dnsdb{>\n,: txt=a.b.example}}
6899 ${lookup dnsdb{>\n; txt=a.b.example}}
6900 ${lookup dnsdb{spf=example.org}}
6901 .endd
6902 It is permitted to specify a space as the separator character. Further
6903 white space is ignored.
6904
6905 .section "Pseudo dnsdb record types" "SECID66"
6906 .cindex "MX record" "in &(dnsdb)& lookup"
6907 By default, both the preference value and the host name are returned for
6908 each MX record, separated by a space. If you want only host names, you can use
6909 the pseudo-type MXH:
6910 .code
6911 ${lookup dnsdb{mxh=a.b.example}}
6912 .endd
6913 In this case, the preference values are omitted, and just the host names are
6914 returned.
6915
6916 .cindex "name server for enclosing domain"
6917 Another pseudo-type is ZNS (for &"zone NS"&). It performs a lookup for NS
6918 records on the given domain, but if none are found, it removes the first
6919 component of the domain name, and tries again. This process continues until NS
6920 records are found or there are no more components left (or there is a DNS
6921 error). In other words, it may return the name servers for a top-level domain,
6922 but it never returns the root name servers. If there are no NS records for the
6923 top-level domain, the lookup fails. Consider these examples:
6924 .code
6925 ${lookup dnsdb{zns=xxx.quercite.com}}
6926 ${lookup dnsdb{zns=xxx.edu}}
6927 .endd
6928 Assuming that in each case there are no NS records for the full domain name,
6929 the first returns the name servers for &%quercite.com%&, and the second returns
6930 the name servers for &%edu%&.
6931
6932 You should be careful about how you use this lookup because, unless the
6933 top-level domain does not exist, the lookup always returns some host names. The
6934 sort of use to which this might be put is for seeing if the name servers for a
6935 given domain are on a blacklist. You can probably assume that the name servers
6936 for the high-level domains such as &%com%& or &%co.uk%& are not going to be on
6937 such a list.
6938
6939 .cindex "CSA" "in &(dnsdb)& lookup"
6940 A third pseudo-type is CSA (Client SMTP Authorization). This looks up SRV
6941 records according to the CSA rules, which are described in section
6942 &<<SECTverifyCSA>>&. Although &(dnsdb)& supports SRV lookups directly, this is
6943 not sufficient because of the extra parent domain search behaviour of CSA. The
6944 result of a successful lookup such as:
6945 .code
6946 ${lookup dnsdb {csa=$sender_helo_name}}
6947 .endd
6948 has two space-separated fields: an authorization code and a target host name.
6949 The authorization code can be &"Y"& for yes, &"N"& for no, &"X"& for explicit
6950 authorization required but absent, or &"?"& for unknown.
6951
6952 .new
6953 .cindex "A+" "in &(dnsdb)& lookup"
6954 The pseudo-type A+ performs an A6 lookup (if configured) followed by an AAAA
6955 and then an A lookup.  All results are returned; defer processing
6956 (see below) is handled separately for each lookup.  Example:
6957 .code
6958 ${lookup dnsdb {>; a+=$sender_helo_name}}
6959 .endd
6960 .wen
6961
6962
6963 .section "Multiple dnsdb lookups" "SECID67"
6964 In the previous sections, &(dnsdb)& lookups for a single domain are described.
6965 However, you can specify a list of domains or IP addresses in a single
6966 &(dnsdb)& lookup. The list is specified in the normal Exim way, with colon as
6967 the default separator, but with the ability to change this. For example:
6968 .code
6969 ${lookup dnsdb{one.domain.com:two.domain.com}}
6970 ${lookup dnsdb{a=one.host.com:two.host.com}}
6971 ${lookup dnsdb{ptr = <; 1.2.3.4 ; 4.5.6.8}}
6972 .endd
6973 In order to retain backwards compatibility, there is one special case: if
6974 the lookup type is PTR and no change of separator is specified, Exim looks
6975 to see if the rest of the string is precisely one IPv6 address. In this
6976 case, it does not treat it as a list.
6977
6978 The data from each lookup is concatenated, with newline separators by default,
6979 in the same way that multiple DNS records for a single item are handled. A
6980 different separator can be specified, as described above.
6981
6982 The &(dnsdb)& lookup fails only if all the DNS lookups fail. If there is a
6983 temporary DNS error for any of them, the behaviour is controlled by
6984 an optional keyword followed by a comma that may appear before the record
6985 type. The possible keywords are &"defer_strict"&, &"defer_never"&, and
6986 &"defer_lax"&. With &"strict"& behaviour, any temporary DNS error causes the
6987 whole lookup to defer. With &"never"& behaviour, a temporary DNS error is
6988 ignored, and the behaviour is as if the DNS lookup failed to find anything.
6989 With &"lax"& behaviour, all the queries are attempted, but a temporary DNS
6990 error causes the whole lookup to defer only if none of the other lookups
6991 succeed. The default is &"lax"&, so the following lookups are equivalent:
6992 .code
6993 ${lookup dnsdb{defer_lax,a=one.host.com:two.host.com}}
6994 ${lookup dnsdb{a=one.host.com:two.host.com}}
6995 .endd
6996 Thus, in the default case, as long as at least one of the DNS lookups
6997 yields some data, the lookup succeeds.
6998
6999
7000
7001
7002 .section "More about LDAP" "SECTldap"
7003 .cindex "LDAP" "lookup, more about"
7004 .cindex "lookup" "LDAP"
7005 .cindex "Solaris" "LDAP"
7006 The original LDAP implementation came from the University of Michigan; this has
7007 become &"Open LDAP"&, and there are now two different releases. Another
7008 implementation comes from Netscape, and Solaris 7 and subsequent releases
7009 contain inbuilt LDAP support. Unfortunately, though these are all compatible at
7010 the lookup function level, their error handling is different. For this reason
7011 it is necessary to set a compile-time variable when building Exim with LDAP, to
7012 indicate which LDAP library is in use. One of the following should appear in
7013 your &_Local/Makefile_&:
7014 .code
7015 LDAP_LIB_TYPE=UMICHIGAN
7016 LDAP_LIB_TYPE=OPENLDAP1
7017 LDAP_LIB_TYPE=OPENLDAP2
7018 LDAP_LIB_TYPE=NETSCAPE
7019 LDAP_LIB_TYPE=SOLARIS
7020 .endd
7021 If LDAP_LIB_TYPE is not set, Exim assumes &`OPENLDAP1`&, which has the
7022 same interface as the University of Michigan version.
7023
7024 There are three LDAP lookup types in Exim. These behave slightly differently in
7025 the way they handle the results of a query:
7026
7027 .ilist
7028 &(ldap)& requires the result to contain just one entry; if there are more, it
7029 gives an error.
7030 .next
7031 &(ldapdn)& also requires the result to contain just one entry, but it is the
7032 Distinguished Name that is returned rather than any attribute values.
7033 .next
7034 &(ldapm)& permits the result to contain more than one entry; the attributes
7035 from all of them are returned.
7036 .endlist
7037
7038
7039 For &(ldap)& and &(ldapm)&, if a query finds only entries with no attributes,
7040 Exim behaves as if the entry did not exist, and the lookup fails. The format of
7041 the data returned by a successful lookup is described in the next section.
7042 First we explain how LDAP queries are coded.
7043
7044
7045 .section "Format of LDAP queries" "SECTforldaque"
7046 .cindex "LDAP" "query format"
7047 An LDAP query takes the form of a URL as defined in RFC 2255. For example, in
7048 the configuration of a &(redirect)& router one might have this setting:
7049 .code
7050 data = ${lookup ldap \
7051   {ldap:///cn=$local_part,o=University%20of%20Cambridge,\
7052   c=UK?mailbox?base?}}
7053 .endd
7054 .cindex "LDAP" "with TLS"
7055 The URL may begin with &`ldap`& or &`ldaps`& if your LDAP library supports
7056 secure (encrypted) LDAP connections. The second of these ensures that an
7057 encrypted TLS connection is used.
7058
7059 With sufficiently modern LDAP libraries, Exim supports forcing TLS over regular
7060 LDAP connections, rather than the SSL-on-connect &`ldaps`&.
7061 See the &%ldap_start_tls%& option.
7062
7063
7064 .section "LDAP quoting" "SECID68"
7065 .cindex "LDAP" "quoting"
7066 Two levels of quoting are required in LDAP queries, the first for LDAP itself
7067 and the second because the LDAP query is represented as a URL. Furthermore,
7068 within an LDAP query, two different kinds of quoting are required. For this
7069 reason, there are two different LDAP-specific quoting operators.
7070
7071 The &%quote_ldap%& operator is designed for use on strings that are part of
7072 filter specifications. Conceptually, it first does the following conversions on
7073 the string:
7074 .code
7075 *   =>   \2A
7076 (   =>   \28
7077 )   =>   \29
7078 \   =>   \5C
7079 .endd
7080 in accordance with RFC 2254. The resulting string is then quoted according
7081 to the rules for URLs, that is, all non-alphanumeric characters except
7082 .code
7083 ! $ ' - . _ ( ) * +
7084 .endd
7085 are converted to their hex values, preceded by a percent sign. For example:
7086 .code
7087 ${quote_ldap: a(bc)*, a<yz>; }
7088 .endd
7089 yields
7090 .code
7091 %20a%5C28bc%5C29%5C2A%2C%20a%3Cyz%3E%3B%20
7092 .endd
7093 Removing the URL quoting, this is (with a leading and a trailing space):
7094 .code
7095 a\28bc\29\2A, a<yz>;
7096 .endd
7097 The &%quote_ldap_dn%& operator is designed for use on strings that are part of
7098 base DN specifications in queries. Conceptually, it first converts the string
7099 by inserting a backslash in front of any of the following characters:
7100 .code
7101 , + " \ < > ;
7102 .endd
7103 It also inserts a backslash before any leading spaces or # characters, and
7104 before any trailing spaces. (These rules are in RFC 2253.) The resulting string
7105 is then quoted according to the rules for URLs. For example:
7106 .code
7107 ${quote_ldap_dn: a(bc)*, a<yz>; }
7108 .endd
7109 yields
7110 .code
7111 %5C%20a(bc)*%5C%2C%20a%5C%3Cyz%5C%3E%5C%3B%5C%20
7112 .endd
7113 Removing the URL quoting, this is (with a trailing space):
7114 .code
7115 \ a(bc)*\, a\<yz\>\;\
7116 .endd
7117 There are some further comments about quoting in the section on LDAP
7118 authentication below.
7119
7120
7121 .section "LDAP connections" "SECID69"
7122 .cindex "LDAP" "connections"
7123 The connection to an LDAP server may either be over TCP/IP, or, when OpenLDAP
7124 is in use, via a Unix domain socket. The example given above does not specify
7125 an LDAP server. A server that is reached by TCP/IP can be specified in a query
7126 by starting it with
7127 .code
7128 ldap://<hostname>:<port>/...
7129 .endd
7130 If the port (and preceding colon) are omitted, the standard LDAP port (389) is
7131 used. When no server is specified in a query, a list of default servers is
7132 taken from the &%ldap_default_servers%& configuration option. This supplies a
7133 colon-separated list of servers which are tried in turn until one successfully
7134 handles a query, or there is a serious error. Successful handling either
7135 returns the requested data, or indicates that it does not exist. Serious errors
7136 are syntactical, or multiple values when only a single value is expected.
7137 Errors which cause the next server to be tried are connection failures, bind
7138 failures, and timeouts.
7139
7140 For each server name in the list, a port number can be given. The standard way
7141 of specifying a host and port is to use a colon separator (RFC 1738). Because
7142 &%ldap_default_servers%& is a colon-separated list, such colons have to be
7143 doubled. For example
7144 .code
7145 ldap_default_servers = ldap1.example.com::145:ldap2.example.com
7146 .endd
7147 If &%ldap_default_servers%& is unset, a URL with no server name is passed
7148 to the LDAP library with no server name, and the library's default (normally
7149 the local host) is used.
7150
7151 If you are using the OpenLDAP library, you can connect to an LDAP server using
7152 a Unix domain socket instead of a TCP/IP connection. This is specified by using
7153 &`ldapi`& instead of &`ldap`& in LDAP queries. What follows here applies only
7154 to OpenLDAP. If Exim is compiled with a different LDAP library, this feature is
7155 not available.
7156
7157 For this type of connection, instead of a host name for the server, a pathname
7158 for the socket is required, and the port number is not relevant. The pathname
7159 can be specified either as an item in &%ldap_default_servers%&, or inline in
7160 the query. In the former case, you can have settings such as
7161 .code
7162 ldap_default_servers = /tmp/ldap.sock : backup.ldap.your.domain
7163 .endd
7164 When the pathname is given in the query, you have to escape the slashes as
7165 &`%2F`& to fit in with the LDAP URL syntax. For example:
7166 .code
7167 ${lookup ldap {ldapi://%2Ftmp%2Fldap.sock/o=...
7168 .endd
7169 When Exim processes an LDAP lookup and finds that the &"hostname"& is really
7170 a pathname, it uses the Unix domain socket code, even if the query actually
7171 specifies &`ldap`& or &`ldaps`&. In particular, no encryption is used for a
7172 socket connection. This behaviour means that you can use a setting of
7173 &%ldap_default_servers%& such as in the example above with traditional &`ldap`&
7174 or &`ldaps`& queries, and it will work. First, Exim tries a connection via
7175 the Unix domain socket; if that fails, it tries a TCP/IP connection to the
7176 backup host.
7177
7178 If an explicit &`ldapi`& type is given in a query when a host name is
7179 specified, an error is diagnosed. However, if there are more items in
7180 &%ldap_default_servers%&, they are tried. In other words:
7181
7182 .ilist
7183 Using a pathname with &`ldap`& or &`ldaps`& forces the use of the Unix domain
7184 interface.
7185 .next
7186 Using &`ldapi`& with a host name causes an error.
7187 .endlist
7188
7189
7190 Using &`ldapi`& with no host or path in the query, and no setting of
7191 &%ldap_default_servers%&, does whatever the library does by default.
7192
7193
7194
7195 .section "LDAP authentication and control information" "SECID70"
7196 .cindex "LDAP" "authentication"
7197 The LDAP URL syntax provides no way of passing authentication and other control
7198 information to the server. To make this possible, the URL in an LDAP query may
7199 be preceded by any number of <&'name'&>=<&'value'&> settings, separated by
7200 spaces. If a value contains spaces it must be enclosed in double quotes, and
7201 when double quotes are used, backslash is interpreted in the usual way inside
7202 them. The following names are recognized:
7203 .display
7204 &`DEREFERENCE`&  set the dereferencing parameter
7205 &`NETTIME    `&  set a timeout for a network operation
7206 &`USER       `&  set the DN, for authenticating the LDAP bind
7207 &`PASS       `&  set the password, likewise
7208 &`REFERRALS  `&  set the referrals parameter
7209 &`SIZE       `&  set the limit for the number of entries returned
7210 &`TIME       `&  set the maximum waiting time for a query
7211 .endd
7212 The value of the DEREFERENCE parameter must be one of the words &"never"&,
7213 &"searching"&, &"finding"&, or &"always"&. The value of the REFERRALS parameter
7214 must be &"follow"& (the default) or &"nofollow"&. The latter stops the LDAP
7215 library from trying to follow referrals issued by the LDAP server.
7216
7217 The name CONNECT is an obsolete name for NETTIME, retained for
7218 backwards compatibility. This timeout (specified as a number of seconds) is
7219 enforced from the client end for operations that can be carried out over a
7220 network. Specifically, it applies to network connections and calls to the
7221 &'ldap_result()'& function. If the value is greater than zero, it is used if
7222 LDAP_OPT_NETWORK_TIMEOUT is defined in the LDAP headers (OpenLDAP), or
7223 if LDAP_X_OPT_CONNECT_TIMEOUT is defined in the LDAP headers (Netscape
7224 SDK 4.1). A value of zero forces an explicit setting of &"no timeout"& for
7225 Netscape SDK; for OpenLDAP no action is taken.
7226
7227 The TIME parameter (also a number of seconds) is passed to the server to
7228 set a server-side limit on the time taken to complete a search.
7229
7230
7231 Here is an example of an LDAP query in an Exim lookup that uses some of these
7232 values. This is a single line, folded to fit on the page:
7233 .code
7234 ${lookup ldap
7235   {user="cn=manager,o=University of Cambridge,c=UK" pass=secret
7236   ldap:///o=University%20of%20Cambridge,c=UK?sn?sub?(cn=foo)}
7237   {$value}fail}
7238 .endd
7239 The encoding of spaces as &`%20`& is a URL thing which should not be done for
7240 any of the auxiliary data. Exim configuration settings that include lookups
7241 which contain password information should be preceded by &"hide"& to prevent
7242 non-admin users from using the &%-bP%& option to see their values.
7243
7244 The auxiliary data items may be given in any order. The default is no
7245 connection timeout (the system timeout is used), no user or password, no limit
7246 on the number of entries returned, and no time limit on queries.
7247
7248 When a DN is quoted in the USER= setting for LDAP authentication, Exim
7249 removes any URL quoting that it may contain before passing it LDAP. Apparently
7250 some libraries do this for themselves, but some do not. Removing the URL
7251 quoting has two advantages:
7252
7253 .ilist
7254 It makes it possible to use the same &%quote_ldap_dn%& expansion for USER=
7255 DNs as with DNs inside actual queries.
7256 .next
7257 It permits spaces inside USER= DNs.
7258 .endlist
7259
7260 For example, a setting such as
7261 .code
7262 USER=cn=${quote_ldap_dn:$1}
7263 .endd
7264 should work even if &$1$& contains spaces.
7265
7266 Expanded data for the PASS= value should be quoted using the &%quote%&
7267 expansion operator, rather than the LDAP quote operators. The only reason this
7268 field needs quoting is to ensure that it conforms to the Exim syntax, which
7269 does not allow unquoted spaces. For example:
7270 .code
7271 PASS=${quote:$3}
7272 .endd
7273 The LDAP authentication mechanism can be used to check passwords as part of
7274 SMTP authentication. See the &%ldapauth%& expansion string condition in chapter
7275 &<<CHAPexpand>>&.
7276
7277
7278
7279 .section "Format of data returned by LDAP" "SECID71"
7280 .cindex "LDAP" "returned data formats"
7281 The &(ldapdn)& lookup type returns the Distinguished Name from a single entry
7282 as a sequence of values, for example
7283 .code
7284 cn=manager, o=University of Cambridge, c=UK
7285 .endd
7286 The &(ldap)& lookup type generates an error if more than one entry matches the
7287 search filter, whereas &(ldapm)& permits this case, and inserts a newline in
7288 the result between the data from different entries. It is possible for multiple
7289 values to be returned for both &(ldap)& and &(ldapm)&, but in the former case
7290 you know that whatever values are returned all came from a single entry in the
7291 directory.
7292
7293 In the common case where you specify a single attribute in your LDAP query, the
7294 result is not quoted, and does not contain the attribute name. If the attribute
7295 has multiple values, they are separated by commas.
7296
7297 If you specify multiple attributes, the result contains space-separated, quoted
7298 strings, each preceded by the attribute name and an equals sign. Within the
7299 quotes, the quote character, backslash, and newline are escaped with
7300 backslashes, and commas are used to separate multiple values for the attribute.
7301 Apart from the escaping, the string within quotes takes the same form as the
7302 output when a single attribute is requested. Specifying no attributes is the
7303 same as specifying all of an entry's attributes.
7304
7305 Here are some examples of the output format. The first line of each pair is an
7306 LDAP query, and the second is the data that is returned. The attribute called
7307 &%attr1%& has two values, whereas &%attr2%& has only one value:
7308 .code
7309 ldap:///o=base?attr1?sub?(uid=fred)
7310 value1.1, value1.2
7311
7312 ldap:///o=base?attr2?sub?(uid=fred)
7313 value two
7314
7315 ldap:///o=base?attr1,attr2?sub?(uid=fred)
7316 attr1="value1.1, value1.2" attr2="value two"
7317
7318 ldap:///o=base??sub?(uid=fred)
7319 objectClass="top" attr1="value1.1, value1.2" attr2="value two"
7320 .endd
7321 The &%extract%& operator in string expansions can be used to pick out
7322 individual fields from data that consists of &'key'&=&'value'& pairs. You can
7323 make use of Exim's &%-be%& option to run expansion tests and thereby check the
7324 results of LDAP lookups.
7325
7326
7327
7328
7329 .section "More about NIS+" "SECTnisplus"
7330 .cindex "NIS+ lookup type"
7331 .cindex "lookup" "NIS+"
7332 NIS+ queries consist of a NIS+ &'indexed name'& followed by an optional colon
7333 and field name. If this is given, the result of a successful query is the
7334 contents of the named field; otherwise the result consists of a concatenation
7335 of &'field-name=field-value'& pairs, separated by spaces. Empty values and
7336 values containing spaces are quoted. For example, the query
7337 .code
7338 [name=mg1456],passwd.org_dir
7339 .endd
7340 might return the string
7341 .code
7342 name=mg1456 passwd="" uid=999 gid=999 gcos="Martin Guerre"
7343 home=/home/mg1456 shell=/bin/bash shadow=""
7344 .endd
7345 (split over two lines here to fit on the page), whereas
7346 .code
7347 [name=mg1456],passwd.org_dir:gcos
7348 .endd
7349 would just return
7350 .code
7351 Martin Guerre
7352 .endd
7353 with no quotes. A NIS+ lookup fails if NIS+ returns more than one table entry
7354 for the given indexed key. The effect of the &%quote_nisplus%& expansion
7355 operator is to double any quote characters within the text.
7356
7357
7358
7359 .section "SQL lookups" "SECTsql"
7360 .cindex "SQL lookup types"
7361 .cindex "MySQL" "lookup type"
7362 .cindex "PostgreSQL lookup type"
7363 .cindex "lookup" "MySQL"
7364 .cindex "lookup" "PostgreSQL"
7365 .cindex "Oracle" "lookup type"
7366 .cindex "lookup" "Oracle"
7367 .cindex "InterBase lookup type"
7368 .cindex "lookup" "InterBase"
7369 Exim can support lookups in InterBase, MySQL, Oracle, PostgreSQL, and SQLite
7370 databases. Queries for these databases contain SQL statements, so an example
7371 might be
7372 .code
7373 ${lookup mysql{select mailbox from users where id='userx'}\
7374   {$value}fail}
7375 .endd
7376 If the result of the query contains more than one field, the data for each
7377 field in the row is returned, preceded by its name, so the result of
7378 .code
7379 ${lookup pgsql{select home,name from users where id='userx'}\
7380   {$value}}
7381 .endd
7382 might be
7383 .code
7384 home=/home/userx name="Mister X"
7385 .endd
7386 Empty values and values containing spaces are double quoted, with embedded
7387 quotes escaped by a backslash. If the result of the query contains just one
7388 field, the value is passed back verbatim, without a field name, for example:
7389 .code
7390 Mister X
7391 .endd
7392 If the result of the query yields more than one row, it is all concatenated,
7393 with a newline between the data for each row.
7394
7395
7396 .section "More about MySQL, PostgreSQL, Oracle, and InterBase" "SECID72"
7397 .cindex "MySQL" "lookup type"
7398 .cindex "PostgreSQL lookup type"
7399 .cindex "lookup" "MySQL"
7400 .cindex "lookup" "PostgreSQL"
7401 .cindex "Oracle" "lookup type"
7402 .cindex "lookup" "Oracle"
7403 .cindex "InterBase lookup type"
7404 .cindex "lookup" "InterBase"
7405 If any MySQL, PostgreSQL, Oracle, or InterBase lookups are used, the
7406 &%mysql_servers%&, &%pgsql_servers%&, &%oracle_servers%&, or &%ibase_servers%&
7407 option (as appropriate) must be set to a colon-separated list of server
7408 information.
7409 (For MySQL and PostgreSQL only, the global option need not be set if all
7410 queries contain their own server information &-- see section
7411 &<<SECTspeserque>>&.) Each item in the list is a slash-separated list of four
7412 items: host name, database name, user name, and password. In the case of
7413 Oracle, the host name field is used for the &"service name"&, and the database
7414 name field is not used and should be empty. For example:
7415 .code
7416 hide oracle_servers = oracle.plc.example//userx/abcdwxyz
7417 .endd
7418 Because password data is sensitive, you should always precede the setting with
7419 &"hide"&, to prevent non-admin users from obtaining the setting via the &%-bP%&
7420 option. Here is an example where two MySQL servers are listed:
7421 .code
7422 hide mysql_servers = localhost/users/root/secret:\
7423                      otherhost/users/root/othersecret
7424 .endd
7425 For MySQL and PostgreSQL, a host may be specified as <&'name'&>:<&'port'&> but
7426 because this is a colon-separated list, the colon has to be doubled. For each
7427 query, these parameter groups are tried in order until a connection is made and
7428 a query is successfully processed. The result of a query may be that no data is
7429 found, but that is still a successful query. In other words, the list of
7430 servers provides a backup facility, not a list of different places to look.
7431
7432 The &%quote_mysql%&, &%quote_pgsql%&, and &%quote_oracle%& expansion operators
7433 convert newline, tab, carriage return, and backspace to \n, \t, \r, and \b
7434 respectively, and the characters single-quote, double-quote, and backslash
7435 itself are escaped with backslashes. The &%quote_pgsql%& expansion operator, in
7436 addition, escapes the percent and underscore characters. This cannot be done
7437 for MySQL because these escapes are not recognized in contexts where these
7438 characters are not special.
7439
7440 .section "Specifying the server in the query" "SECTspeserque"
7441 For MySQL and PostgreSQL lookups (but not currently for Oracle and InterBase),
7442 it is possible to specify a list of servers with an individual query. This is
7443 done by starting the query with
7444 .display
7445 &`servers=`&&'server1:server2:server3:...'&&`;`&
7446 .endd
7447 Each item in the list may take one of two forms:
7448 .olist
7449 If it contains no slashes it is assumed to be just a host name. The appropriate
7450 global option (&%mysql_servers%& or &%pgsql_servers%&) is searched for a host
7451 of the same name, and the remaining parameters (database, user, password) are
7452 taken from there.
7453 .next
7454 If it contains any slashes, it is taken as a complete parameter set.
7455 .endlist
7456 The list of servers is used in exactly the same way as the global list.
7457 Once a connection to a server has happened and a query has been
7458 successfully executed, processing of the lookup ceases.
7459
7460 This feature is intended for use in master/slave situations where updates
7461 are occurring and you want to update the master rather than a slave. If the
7462 master is in the list as a backup for reading, you might have a global setting
7463 like this:
7464 .code
7465 mysql_servers = slave1/db/name/pw:\
7466                 slave2/db/name/pw:\
7467                 master/db/name/pw
7468 .endd
7469 In an updating lookup, you could then write:
7470 .code
7471 ${lookup mysql{servers=master; UPDATE ...} }
7472 .endd
7473 That query would then be sent only to the master server. If, on the other hand,
7474 the master is not to be used for reading, and so is not present in the global
7475 option, you can still update it by a query of this form:
7476 .code
7477 ${lookup pgsql{servers=master/db/name/pw; UPDATE ...} }
7478 .endd
7479
7480
7481 .section "Special MySQL features" "SECID73"
7482 For MySQL, an empty host name or the use of &"localhost"& in &%mysql_servers%&
7483 causes a connection to the server on the local host by means of a Unix domain
7484 socket. An alternate socket can be specified in parentheses. The full syntax of
7485 each item in &%mysql_servers%& is:
7486 .display
7487 <&'hostname'&>::<&'port'&>(<&'socket name'&>)/<&'database'&>/&&&
7488   <&'user'&>/<&'password'&>
7489 .endd
7490 Any of the three sub-parts of the first field can be omitted. For normal use on
7491 the local host it can be left blank or set to just &"localhost"&.
7492
7493 No database need be supplied &-- but if it is absent here, it must be given in
7494 the queries.
7495
7496 If a MySQL query is issued that does not request any data (an insert, update,
7497 or delete command), the result of the lookup is the number of rows affected.
7498
7499 &*Warning*&: This can be misleading. If an update does not actually change
7500 anything (for example, setting a field to the value it already has), the result
7501 is zero because no rows are affected.
7502
7503
7504 .section "Special PostgreSQL features" "SECID74"
7505 PostgreSQL lookups can also use Unix domain socket connections to the database.
7506 This is usually faster and costs less CPU time than a TCP/IP connection.
7507 However it can be used only if the mail server runs on the same machine as the
7508 database server. A configuration line for PostgreSQL via Unix domain sockets
7509 looks like this:
7510 .code
7511 hide pgsql_servers = (/tmp/.s.PGSQL.5432)/db/user/password : ...
7512 .endd
7513 In other words, instead of supplying a host name, a path to the socket is
7514 given. The path name is enclosed in parentheses so that its slashes aren't
7515 visually confused with the delimiters for the other server parameters.
7516
7517 If a PostgreSQL query is issued that does not request any data (an insert,
7518 update, or delete command), the result of the lookup is the number of rows
7519 affected.
7520
7521 .section "More about SQLite" "SECTsqlite"
7522 .cindex "lookup" "SQLite"
7523 .cindex "sqlite lookup type"
7524 SQLite is different to the other SQL lookups because a file name is required in
7525 addition to the SQL query. An SQLite database is a single file, and there is no
7526 daemon as in the other SQL databases. The interface to Exim requires the name
7527 of the file, as an absolute path, to be given at the start of the query. It is
7528 separated from the query by white space. This means that the path name cannot
7529 contain white space. Here is a lookup expansion example:
7530 .code
7531 ${lookup sqlite {/some/thing/sqlitedb \
7532   select name from aliases where id='userx';}}
7533 .endd
7534 In a list, the syntax is similar. For example:
7535 .code
7536 domainlist relay_to_domains = sqlite;/some/thing/sqlitedb \
7537    select * from relays where ip='$sender_host_address';
7538 .endd
7539 The only character affected by the &%quote_sqlite%& operator is a single
7540 quote, which it doubles.
7541
7542 The SQLite library handles multiple simultaneous accesses to the database
7543 internally. Multiple readers are permitted, but only one process can
7544 update at once. Attempts to access the database while it is being updated
7545 are rejected after a timeout period, during which the SQLite library
7546 waits for the lock to be released. In Exim, the default timeout is set
7547 to 5 seconds, but it can be changed by means of the &%sqlite_lock_timeout%&
7548 option.
7549 .ecindex IIDfidalo1
7550 .ecindex IIDfidalo2
7551
7552
7553 . ////////////////////////////////////////////////////////////////////////////
7554 . ////////////////////////////////////////////////////////////////////////////
7555
7556 .chapter "Domain, host, address, and local part lists" &&&
7557          "CHAPdomhosaddlists" &&&
7558          "Domain, host, and address lists"
7559 .scindex IIDdohoadli "lists of domains; hosts; etc."
7560 A number of Exim configuration options contain lists of domains, hosts,
7561 email addresses, or local parts. For example, the &%hold_domains%& option
7562 contains a list of domains whose delivery is currently suspended. These lists
7563 are also used as data in ACL statements (see chapter &<<CHAPACL>>&), and as
7564 arguments to expansion conditions such as &%match_domain%&.
7565
7566 Each item in one of these lists is a pattern to be matched against a domain,
7567 host, email address, or local part, respectively. In the sections below, the
7568 different types of pattern for each case are described, but first we cover some
7569 general facilities that apply to all four kinds of list.
7570
7571
7572
7573 .section "Expansion of lists" "SECID75"
7574 .cindex "expansion" "of lists"
7575 Each list is expanded as a single string before it is used. The result of
7576 expansion must be a list, possibly containing empty items, which is split up
7577 into separate items for matching. By default, colon is the separator character,
7578 but this can be varied if necessary. See sections &<<SECTlistconstruct>>& and
7579 &<<SECTempitelis>>& for details of the list syntax; the second of these
7580 discusses the way to specify empty list items.
7581
7582
7583 If the string expansion is forced to fail, Exim behaves as if the item it is
7584 testing (domain, host, address, or local part) is not in the list. Other
7585 expansion failures cause temporary errors.
7586
7587 If an item in a list is a regular expression, backslashes, dollars and possibly
7588 other special characters in the expression must be protected against
7589 misinterpretation by the string expander. The easiest way to do this is to use
7590 the &`\N`& expansion feature to indicate that the contents of the regular
7591 expression should not be expanded. For example, in an ACL you might have:
7592 .code
7593 deny senders = \N^\d{8}\w@.*\.baddomain\.example$\N : \
7594                ${lookup{$domain}lsearch{/badsenders/bydomain}}
7595 .endd
7596 The first item is a regular expression that is protected from expansion by
7597 &`\N`&, whereas the second uses the expansion to obtain a list of unwanted
7598 senders based on the receiving domain.
7599
7600
7601
7602
7603 .section "Negated items in lists" "SECID76"
7604 .cindex "list" "negation"
7605 .cindex "negation" "in lists"
7606 Items in a list may be positive or negative. Negative items are indicated by a
7607 leading exclamation mark, which may be followed by optional white space. A list
7608 defines a set of items (domains, etc). When Exim processes one of these lists,
7609 it is trying to find out whether a domain, host, address, or local part
7610 (respectively) is in the set that is defined by the list. It works like this:
7611
7612 The list is scanned from left to right. If a positive item is matched, the
7613 subject that is being checked is in the set; if a negative item is matched, the
7614 subject is not in the set. If the end of the list is reached without the
7615 subject having matched any of the patterns, it is in the set if the last item
7616 was a negative one, but not if it was a positive one. For example, the list in
7617 .code
7618 domainlist relay_to_domains = !a.b.c : *.b.c
7619 .endd
7620 matches any domain ending in &'.b.c'& except for &'a.b.c'&. Domains that match
7621 neither &'a.b.c'& nor &'*.b.c'& do not match, because the last item in the
7622 list is positive. However, if the setting were
7623 .code
7624 domainlist relay_to_domains = !a.b.c
7625 .endd
7626 then all domains other than &'a.b.c'& would match because the last item in the
7627 list is negative. In other words, a list that ends with a negative item behaves
7628 as if it had an extra item &`:*`& on the end.
7629
7630 Another way of thinking about positive and negative items in lists is to read
7631 the connector as &"or"& after a positive item and as &"and"& after a negative
7632 item.
7633
7634
7635
7636 .section "File names in lists" "SECTfilnamlis"
7637 .cindex "list" "file name in"
7638 If an item in a domain, host, address, or local part list is an absolute file
7639 name (beginning with a slash character), each line of the file is read and
7640 processed as if it were an independent item in the list, except that further
7641 file names are not allowed,
7642 and no expansion of the data from the file takes place.
7643 Empty lines in the file are ignored, and the file may also contain comment
7644 lines:
7645
7646 .ilist
7647 For domain and host lists, if a # character appears anywhere in a line of the
7648 file, it and all following characters are ignored.
7649 .next
7650 Because local parts may legitimately contain # characters, a comment in an
7651 address list or local part list file is recognized only if # is preceded by
7652 white space or the start of the line. For example:
7653 .code
7654 not#comment@x.y.z   # but this is a comment
7655 .endd
7656 .endlist
7657
7658 Putting a file name in a list has the same effect as inserting each line of the
7659 file as an item in the list (blank lines and comments excepted). However, there
7660 is one important difference: the file is read each time the list is processed,
7661 so if its contents vary over time, Exim's behaviour changes.
7662
7663 If a file name is preceded by an exclamation mark, the sense of any match
7664 within the file is inverted. For example, if
7665 .code
7666 hold_domains = !/etc/nohold-domains
7667 .endd
7668 and the file contains the lines
7669 .code
7670 !a.b.c
7671 *.b.c
7672 .endd
7673 then &'a.b.c'& is in the set of domains defined by &%hold_domains%&, whereas
7674 any domain matching &`*.b.c`& is not.
7675
7676
7677
7678 .section "An lsearch file is not an out-of-line list" "SECID77"
7679 As will be described in the sections that follow, lookups can be used in lists
7680 to provide indexed methods of checking list membership. There has been some
7681 confusion about the way &(lsearch)& lookups work in lists. Because
7682 an &(lsearch)& file contains plain text and is scanned sequentially, it is
7683 sometimes thought that it is allowed to contain wild cards and other kinds of
7684 non-constant pattern. This is not the case. The keys in an &(lsearch)& file are
7685 always fixed strings, just as for any other single-key lookup type.
7686
7687 If you want to use a file to contain wild-card patterns that form part of a
7688 list, just give the file name on its own, without a search type, as described
7689 in the previous section. You could also use the &(wildlsearch)& or
7690 &(nwildlsearch)&, but there is no advantage in doing this.
7691
7692
7693
7694
7695 .section "Named lists" "SECTnamedlists"
7696 .cindex "named lists"
7697 .cindex "list" "named"
7698 A list of domains, hosts, email addresses, or local parts can be given a name
7699 which is then used to refer to the list elsewhere in the configuration. This is
7700 particularly convenient if the same list is required in several different
7701 places. It also allows lists to be given meaningful names, which can improve
7702 the readability of the configuration. For example, it is conventional to define
7703 a domain list called &'local_domains'& for all the domains that are handled
7704 locally on a host, using a configuration line such as
7705 .code
7706 domainlist local_domains = localhost:my.dom.example
7707 .endd
7708 Named lists are referenced by giving their name preceded by a plus sign, so,
7709 for example, a router that is intended to handle local domains would be
7710 configured with the line
7711 .code
7712 domains = +local_domains
7713 .endd
7714 The first router in a configuration is often one that handles all domains
7715 except the local ones, using a configuration with a negated item like this:
7716 .code
7717 dnslookup:
7718   driver = dnslookup
7719   domains = ! +local_domains
7720   transport = remote_smtp
7721   no_more
7722 .endd
7723 The four kinds of named list are created by configuration lines starting with
7724 the words &%domainlist%&, &%hostlist%&, &%addresslist%&, or &%localpartlist%&,
7725 respectively. Then there follows the name that you are defining, followed by an
7726 equals sign and the list itself. For example:
7727 .code
7728 hostlist    relay_from_hosts = 192.168.23.0/24 : my.friend.example
7729 addresslist bad_senders = cdb;/etc/badsenders
7730 .endd
7731 A named list may refer to other named lists:
7732 .code
7733 domainlist  dom1 = first.example : second.example
7734 domainlist  dom2 = +dom1 : third.example
7735 domainlist  dom3 = fourth.example : +dom2 : fifth.example
7736 .endd
7737 &*Warning*&: If the last item in a referenced list is a negative one, the
7738 effect may not be what you intended, because the negation does not propagate
7739 out to the higher level. For example, consider:
7740 .code
7741 domainlist  dom1 = !a.b
7742 domainlist  dom2 = +dom1 : *.b
7743 .endd
7744 The second list specifies &"either in the &%dom1%& list or &'*.b'&"&. The first
7745 list specifies just &"not &'a.b'&"&, so the domain &'x.y'& matches it. That
7746 means it matches the second list as well. The effect is not the same as
7747 .code
7748 domainlist  dom2 = !a.b : *.b
7749 .endd
7750 where &'x.y'& does not match. It's best to avoid negation altogether in
7751 referenced lists if you can.
7752
7753 Named lists may have a performance advantage. When Exim is routing an
7754 address or checking an incoming message, it caches the result of tests on named
7755 lists. So, if you have a setting such as
7756 .code
7757 domains = +local_domains
7758 .endd
7759 on several of your routers
7760 or in several ACL statements,
7761 the actual test is done only for the first one. However, the caching works only
7762 if there are no expansions within the list itself or any sublists that it
7763 references. In other words, caching happens only for lists that are known to be
7764 the same each time they are referenced.
7765
7766 By default, there may be up to 16 named lists of each type. This limit can be
7767 extended by changing a compile-time variable. The use of domain and host lists
7768 is recommended for concepts such as local domains, relay domains, and relay
7769 hosts. The default configuration is set up like this.
7770
7771
7772
7773 .section "Named lists compared with macros" "SECID78"
7774 .cindex "list" "named compared with macro"
7775 .cindex "macro" "compared with named list"
7776 At first sight, named lists might seem to be no different from macros in the
7777 configuration file. However, macros are just textual substitutions. If you
7778 write
7779 .code
7780 ALIST = host1 : host2
7781 auth_advertise_hosts = !ALIST
7782 .endd
7783 it probably won't do what you want, because that is exactly the same as
7784 .code
7785 auth_advertise_hosts = !host1 : host2
7786 .endd
7787 Notice that the second host name is not negated. However, if you use a host
7788 list, and write
7789 .code
7790 hostlist alist = host1 : host2
7791 auth_advertise_hosts = ! +alist
7792 .endd
7793 the negation applies to the whole list, and so that is equivalent to
7794 .code
7795 auth_advertise_hosts = !host1 : !host2
7796 .endd
7797
7798
7799 .section "Named list caching" "SECID79"
7800 .cindex "list" "caching of named"
7801 .cindex "caching" "named lists"
7802 While processing a message, Exim caches the result of checking a named list if
7803 it is sure that the list is the same each time. In practice, this means that
7804 the cache operates only if the list contains no $ characters, which guarantees
7805 that it will not change when it is expanded. Sometimes, however, you may have
7806 an expanded list that you know will be the same each time within a given
7807 message. For example:
7808 .code
7809 domainlist special_domains = \
7810            ${lookup{$sender_host_address}cdb{/some/file}}
7811 .endd
7812 This provides a list of domains that depends only on the sending host's IP
7813 address. If this domain list is referenced a number of times (for example,
7814 in several ACL lines, or in several routers) the result of the check is not
7815 cached by default, because Exim does not know that it is going to be the
7816 same list each time.
7817
7818 By appending &`_cache`& to &`domainlist`& you can tell Exim to go ahead and
7819 cache the result anyway. For example:
7820 .code
7821 domainlist_cache special_domains = ${lookup{...
7822 .endd
7823 If you do this, you should be absolutely sure that caching is going to do
7824 the right thing in all cases. When in doubt, leave it out.
7825
7826
7827
7828 .section "Domain lists" "SECTdomainlist"
7829 .cindex "domain list" "patterns for"
7830 .cindex "list" "domain list"
7831 Domain lists contain patterns that are to be matched against a mail domain.
7832 The following types of item may appear in domain lists:
7833
7834 .ilist
7835 .cindex "primary host name"
7836 .cindex "host name" "matched in domain list"
7837 .oindex "&%primary_hostname%&"
7838 .cindex "domain list" "matching primary host name"
7839 .cindex "@ in a domain list"
7840 If a pattern consists of a single @ character, it matches the local host name,
7841 as set by the &%primary_hostname%& option (or defaulted). This makes it
7842 possible to use the same configuration file on several different hosts that
7843 differ only in their names.
7844 .next
7845 .cindex "@[] in a domain list"
7846 .cindex "domain list" "matching local IP interfaces"
7847 .cindex "domain literal"
7848 If a pattern consists of the string &`@[]`& it matches an IP address enclosed
7849 in square brackets (as in an email address that contains a domain literal), but
7850 only if that IP address is recognized as local for email routing purposes. The
7851 &%local_interfaces%& and &%extra_local_interfaces%& options can be used to
7852 control which of a host's several IP addresses are treated as local.
7853 In today's Internet, the use of domain literals is controversial.
7854 .next
7855 .cindex "@mx_any"
7856 .cindex "@mx_primary"
7857 .cindex "@mx_secondary"
7858 .cindex "domain list" "matching MX pointers to local host"
7859 If a pattern consists of the string &`@mx_any`& it matches any domain that
7860 has an MX record pointing to the local host or to any host that is listed in
7861 .oindex "&%hosts_treat_as_local%&"
7862 &%hosts_treat_as_local%&. The items &`@mx_primary`& and &`@mx_secondary`&
7863 are similar, except that the first matches only when a primary MX target is the
7864 local host, and the second only when no primary MX target is the local host,
7865 but a secondary MX target is. &"Primary"& means an MX record with the lowest
7866 preference value &-- there may of course be more than one of them.
7867
7868 The MX lookup that takes place when matching a pattern of this type is
7869 performed with the resolver options for widening names turned off. Thus, for
7870 example, a single-component domain will &'not'& be expanded by adding the
7871 resolver's default domain. See the &%qualify_single%& and &%search_parents%&
7872 options of the &(dnslookup)& router for a discussion of domain widening.
7873
7874 Sometimes you may want to ignore certain IP addresses when using one of these
7875 patterns. You can specify this by following the pattern with &`/ignore=`&<&'ip
7876 list'&>, where <&'ip list'&> is a list of IP addresses. These addresses are
7877 ignored when processing the pattern (compare the &%ignore_target_hosts%& option
7878 on a router). For example:
7879 .code
7880 domains = @mx_any/ignore=127.0.0.1
7881 .endd
7882 This example matches any domain that has an MX record pointing to one of
7883 the local host's IP addresses other than 127.0.0.1.
7884
7885 The list of IP addresses is in fact processed by the same code that processes
7886 host lists, so it may contain CIDR-coded network specifications and it may also
7887 contain negative items.
7888
7889 Because the list of IP addresses is a sublist within a domain list, you have to
7890 be careful about delimiters if there is more than one address. Like any other
7891 list, the default delimiter can be changed. Thus, you might have:
7892 .code
7893 domains = @mx_any/ignore=<;127.0.0.1;0.0.0.0 : \
7894           an.other.domain : ...
7895 .endd
7896 so that the sublist uses semicolons for delimiters. When IPv6 addresses are
7897 involved, it is easiest to change the delimiter for the main list as well:
7898 .code
7899 domains = <? @mx_any/ignore=<;127.0.0.1;::1 ? \
7900           an.other.domain ? ...
7901 .endd
7902 .next
7903 .cindex "asterisk" "in domain list"
7904 .cindex "domain list" "asterisk in"
7905 .cindex "domain list" "matching &""ends with""&"
7906 If a pattern starts with an asterisk, the remaining characters of the pattern
7907 are compared with the terminating characters of the domain. The use of &"*"& in
7908 domain lists differs from its use in partial matching lookups. In a domain
7909 list, the character following the asterisk need not be a dot, whereas partial
7910 matching works only in terms of dot-separated components. For example, a domain
7911 list item such as &`*key.ex`& matches &'donkey.ex'& as well as
7912 &'cipher.key.ex'&.
7913
7914 .next
7915 .cindex "regular expressions" "in domain list"
7916 .cindex "domain list" "matching regular expression"
7917 If a pattern starts with a circumflex character, it is treated as a regular
7918 expression, and matched against the domain using a regular expression matching
7919 function. The circumflex is treated as part of the regular expression.
7920 Email domains are case-independent, so this regular expression match is by
7921 default case-independent, but you can make it case-dependent by starting it
7922 with &`(?-i)`&. References to descriptions of the syntax of regular expressions
7923 are given in chapter &<<CHAPregexp>>&.
7924
7925 &*Warning*&: Because domain lists are expanded before being processed, you
7926 must escape any backslash and dollar characters in the regular expression, or
7927 use the special &`\N`& sequence (see chapter &<<CHAPexpand>>&) to specify that
7928 it is not to be expanded (unless you really do want to build a regular
7929 expression by expansion, of course).
7930 .next
7931 .cindex "lookup" "in domain list"
7932 .cindex "domain list" "matching by lookup"
7933 If a pattern starts with the name of a single-key lookup type followed by a
7934 semicolon (for example, &"dbm;"& or &"lsearch;"&), the remainder of the pattern
7935 must be a file name in a suitable format for the lookup type. For example, for
7936 &"cdb;"& it must be an absolute path:
7937 .code
7938 domains = cdb;/etc/mail/local_domains.cdb
7939 .endd
7940 The appropriate type of lookup is done on the file using the domain name as the
7941 key. In most cases, the data that is looked up is not used; Exim is interested
7942 only in whether or not the key is present in the file. However, when a lookup
7943 is used for the &%domains%& option on a router
7944 or a &%domains%& condition in an ACL statement, the data is preserved in the
7945 &$domain_data$& variable and can be referred to in other router options or
7946 other statements in the same ACL.
7947
7948 .next
7949 Any of the single-key lookup type names may be preceded by
7950 &`partial`&<&'n'&>&`-`&, where the <&'n'&> is optional, for example,
7951 .code
7952 domains = partial-dbm;/partial/domains
7953 .endd
7954 This causes partial matching logic to be invoked; a description of how this
7955 works is given in section &<<SECTpartiallookup>>&.
7956
7957 .next
7958 .cindex "asterisk" "in lookup type"
7959 Any of the single-key lookup types may be followed by an asterisk. This causes
7960 a default lookup for a key consisting of a single asterisk to be done if the
7961 original lookup fails. This is not a useful feature when using a domain list to
7962 select particular domains (because any domain would match), but it might have
7963 value if the result of the lookup is being used via the &$domain_data$&
7964 expansion variable.
7965 .next
7966 If the pattern starts with the name of a query-style lookup type followed by a
7967 semicolon (for example, &"nisplus;"& or &"ldap;"&), the remainder of the
7968 pattern must be an appropriate query for the lookup type, as described in
7969 chapter &<<CHAPfdlookup>>&. For example:
7970 .code
7971 hold_domains = mysql;select domain from holdlist \
7972   where domain = '${quote_mysql:$domain}';
7973 .endd
7974 In most cases, the data that is looked up is not used (so for an SQL query, for
7975 example, it doesn't matter what field you select). Exim is interested only in
7976 whether or not the query succeeds. However, when a lookup is used for the
7977 &%domains%& option on a router, the data is preserved in the &$domain_data$&
7978 variable and can be referred to in other options.
7979 .next
7980 .cindex "domain list" "matching literal domain name"
7981 If none of the above cases apply, a caseless textual comparison is made
7982 between the pattern and the domain.
7983 .endlist
7984
7985 Here is an example that uses several different kinds of pattern:
7986 .code
7987 domainlist funny_domains = \
7988   @ : \
7989   lib.unseen.edu : \
7990   *.foundation.fict.example : \
7991   \N^[1-2]\d{3}\.fict\.example$\N : \
7992   partial-dbm;/opt/data/penguin/book : \
7993   nis;domains.byname : \
7994   nisplus;[name=$domain,status=local],domains.org_dir
7995 .endd
7996 There are obvious processing trade-offs among the various matching modes. Using
7997 an asterisk is faster than a regular expression, and listing a few names
7998 explicitly probably is too. The use of a file or database lookup is expensive,
7999 but may be the only option if hundreds of names are required. Because the
8000 patterns are tested in order, it makes sense to put the most commonly matched
8001 patterns earlier.
8002
8003
8004
8005 .section "Host lists" "SECThostlist"
8006 .cindex "host list" "patterns in"
8007 .cindex "list" "host list"
8008 Host lists are used to control what remote hosts are allowed to do. For
8009 example, some hosts may be allowed to use the local host as a relay, and some
8010 may be permitted to use the SMTP ETRN command. Hosts can be identified in
8011 two different ways, by name or by IP address. In a host list, some types of
8012 pattern are matched to a host name, and some are matched to an IP address.
8013 You need to be particularly careful with this when single-key lookups are
8014 involved, to ensure that the right value is being used as the key.
8015
8016
8017 .section "Special host list patterns" "SECID80"
8018 .cindex "empty item in hosts list"
8019 .cindex "host list" "empty string in"
8020 If a host list item is the empty string, it matches only when no remote host is
8021 involved. This is the case when a message is being received from a local
8022 process using SMTP on the standard input, that is, when a TCP/IP connection is
8023 not used.
8024
8025 .cindex "asterisk" "in host list"
8026 The special pattern &"*"& in a host list matches any host or no host. Neither
8027 the IP address nor the name is actually inspected.
8028
8029
8030
8031 .section "Host list patterns that match by IP address" "SECThoslispatip"
8032 .cindex "host list" "matching IP addresses"
8033 If an IPv4 host calls an IPv6 host and the call is accepted on an IPv6 socket,
8034 the incoming address actually appears in the IPv6 host as
8035 &`::ffff:`&<&'v4address'&>. When such an address is tested against a host
8036 list, it is converted into a traditional IPv4 address first. (Not all operating
8037 systems accept IPv4 calls on IPv6 sockets, as there have been some security
8038 concerns.)
8039
8040 The following types of pattern in a host list check the remote host by
8041 inspecting its IP address:
8042
8043 .ilist
8044 If the pattern is a plain domain name (not a regular expression, not starting
8045 with *, not a lookup of any kind), Exim calls the operating system function
8046 to find the associated IP address(es). Exim uses the newer
8047 &[getipnodebyname()]& function when available, otherwise &[gethostbyname()]&.
8048 This typically causes a forward DNS lookup of the name. The result is compared
8049 with the IP address of the subject host.
8050
8051 If there is a temporary problem (such as a DNS timeout) with the host name
8052 lookup, a temporary error occurs. For example, if the list is being used in an
8053 ACL condition, the ACL gives a &"defer"& response, usually leading to a
8054 temporary SMTP error code. If no IP address can be found for the host name,
8055 what happens is described in section &<<SECTbehipnot>>& below.
8056
8057 .next
8058 .cindex "@ in a host list"
8059 If the pattern is &"@"&, the primary host name is substituted and used as a
8060 domain name, as just described.
8061
8062 .next
8063 If the pattern is an IP address, it is matched against the IP address of the
8064 subject host. IPv4 addresses are given in the normal &"dotted-quad"& notation.
8065 IPv6 addresses can be given in colon-separated format, but the colons have to
8066 be doubled so as not to be taken as item separators when the default list
8067 separator is used. IPv6 addresses are recognized even when Exim is compiled
8068 without IPv6 support. This means that if they appear in a host list on an
8069 IPv4-only host, Exim will not treat them as host names. They are just addresses
8070 that can never match a client host.
8071
8072 .next
8073 .cindex "@[] in a host list"
8074 If the pattern is &"@[]"&, it matches the IP address of any IP interface on
8075 the local host. For example, if the local host is an IPv4 host with one
8076 interface address 10.45.23.56, these two ACL statements have the same effect:
8077 .code
8078 accept hosts = 127.0.0.1 : 10.45.23.56
8079 accept hosts = @[]
8080 .endd
8081 .next
8082 .cindex "CIDR notation"
8083 If the pattern is an IP address followed by a slash and a mask length (for
8084 example 10.11.42.0/24), it is matched against the IP address of the subject
8085 host under the given mask. This allows, an entire network of hosts to be
8086 included (or excluded) by a single item. The mask uses CIDR notation; it
8087 specifies the number of address bits that must match, starting from the most
8088 significant end of the address.
8089
8090 &*Note*&: The mask is &'not'& a count of addresses, nor is it the high number
8091 of a range of addresses. It is the number of bits in the network portion of the
8092 address. The above example specifies a 24-bit netmask, so it matches all 256
8093 addresses in the 10.11.42.0 network. An item such as
8094 .code
8095 192.168.23.236/31
8096 .endd
8097 matches just two addresses, 192.168.23.236 and 192.168.23.237. A mask value of
8098 32 for an IPv4 address is the same as no mask at all; just a single address
8099 matches.
8100
8101 Here is another example which shows an IPv4 and an IPv6 network:
8102 .code
8103 recipient_unqualified_hosts = 192.168.0.0/16: \
8104                               3ffe::ffff::836f::::/48
8105 .endd
8106 The doubling of list separator characters applies only when these items
8107 appear inline in a host list. It is not required when indirecting via a file.
8108 For example:
8109 .code
8110 recipient_unqualified_hosts = /opt/exim/unqualnets
8111 .endd
8112 could make use of a file containing
8113 .code
8114 172.16.0.0/12
8115 3ffe:ffff:836f::/48
8116 .endd
8117 to have exactly the same effect as the previous example. When listing IPv6
8118 addresses inline, it is usually more convenient to use the facility for
8119 changing separator characters. This list contains the same two networks:
8120 .code
8121 recipient_unqualified_hosts = <; 172.16.0.0/12; \
8122                                  3ffe:ffff:836f::/48
8123 .endd
8124 The separator is changed to semicolon by the leading &"<;"& at the start of the
8125 list.
8126 .endlist
8127
8128
8129
8130 .section "Host list patterns for single-key lookups by host address" &&&
8131          "SECThoslispatsikey"
8132 .cindex "host list" "lookup of IP address"
8133 When a host is to be identified by a single-key lookup of its complete IP
8134 address, the pattern takes this form:
8135 .display
8136 &`net-<`&&'single-key-search-type'&&`>;<`&&'search-data'&&`>`&
8137 .endd
8138 For example:
8139 .code
8140 hosts_lookup = net-cdb;/hosts-by-ip.db
8141 .endd
8142 The text form of the IP address of the subject host is used as the lookup key.
8143 IPv6 addresses are converted to an unabbreviated form, using lower case
8144 letters, with dots as separators because colon is the key terminator in
8145 &(lsearch)& files. [Colons can in fact be used in keys in &(lsearch)& files by
8146 quoting the keys, but this is a facility that was added later.] The data
8147 returned by the lookup is not used.
8148
8149 .cindex "IP address" "masking"
8150 .cindex "host list" "masked IP address"
8151 Single-key lookups can also be performed using masked IP addresses, using
8152 patterns of this form:
8153 .display
8154 &`net<`&&'number'&&`>-<`&&'single-key-search-type'&&`>;<`&&'search-data'&&`>`&
8155 .endd
8156 For example:
8157 .code
8158 net24-dbm;/networks.db
8159 .endd
8160 The IP address of the subject host is masked using <&'number'&> as the mask
8161 length. A textual string is constructed from the masked value, followed by the
8162 mask, and this is used as the lookup key. For example, if the host's IP address
8163 is 192.168.34.6, the key that is looked up for the above example is
8164 &"192.168.34.0/24"&.
8165
8166 When an IPv6 address is converted to a string, dots are normally used instead
8167 of colons, so that keys in &(lsearch)& files need not contain colons (which
8168 terminate &(lsearch)& keys). This was implemented some time before the ability
8169 to quote keys was made available in &(lsearch)& files. However, the more
8170 recently implemented &(iplsearch)& files do require colons in IPv6 keys
8171 (notated using the quoting facility) so as to distinguish them from IPv4 keys.
8172 For this reason, when the lookup type is &(iplsearch)&, IPv6 addresses are
8173 converted using colons and not dots. In all cases, full, unabbreviated IPv6
8174 addresses are always used.
8175
8176 Ideally, it would be nice to tidy up this anomalous situation by changing to
8177 colons in all cases, given that quoting is now available for &(lsearch)&.
8178 However, this would be an incompatible change that might break some existing
8179 configurations.
8180
8181 &*Warning*&: Specifying &%net32-%& (for an IPv4 address) or &%net128-%& (for an
8182 IPv6 address) is not the same as specifying just &%net-%& without a number. In
8183 the former case the key strings include the mask value, whereas in the latter
8184 case the IP address is used on its own.
8185
8186
8187
8188 .section "Host list patterns that match by host name" "SECThoslispatnam"
8189 .cindex "host" "lookup failures"
8190 .cindex "unknown host name"
8191 .cindex "host list" "matching host name"
8192 There are several types of pattern that require Exim to know the name of the
8193 remote host. These are either wildcard patterns or lookups by name. (If a
8194 complete hostname is given without any wildcarding, it is used to find an IP
8195 address to match against, as described in section &<<SECThoslispatip>>&
8196 above.)
8197
8198 If the remote host name is not already known when Exim encounters one of these
8199 patterns, it has to be found from the IP address.
8200 Although many sites on the Internet are conscientious about maintaining reverse
8201 DNS data for their hosts, there are also many that do not do this.
8202 Consequently, a name cannot always be found, and this may lead to unwanted
8203 effects. Take care when configuring host lists with wildcarded name patterns.
8204 Consider what will happen if a name cannot be found.
8205
8206 Because of the problems of determining host names from IP addresses, matching
8207 against host names is not as common as matching against IP addresses.
8208
8209 By default, in order to find a host name, Exim first does a reverse DNS lookup;
8210 if no name is found in the DNS, the system function (&[gethostbyaddr()]& or
8211 &[getipnodebyaddr()]& if available) is tried. The order in which these lookups
8212 are done can be changed by setting the &%host_lookup_order%& option. For
8213 security, once Exim has found one or more names, it looks up the IP addresses
8214 for these names and compares them with the IP address that it started with.
8215 Only those names whose IP addresses match are accepted. Any other names are
8216 discarded. If no names are left, Exim behaves as if the host name cannot be
8217 found. In the most common case there is only one name and one IP address.
8218
8219 There are some options that control what happens if a host name cannot be
8220 found. These are described in section &<<SECTbehipnot>>& below.
8221
8222 .cindex "host" "alias for"
8223 .cindex "alias for host"
8224 As a result of aliasing, hosts may have more than one name. When processing any
8225 of the following types of pattern, all the host's names are checked:
8226
8227 .ilist
8228 .cindex "asterisk" "in host list"
8229 If a pattern starts with &"*"& the remainder of the item must match the end of
8230 the host name. For example, &`*.b.c`& matches all hosts whose names end in
8231 &'.b.c'&. This special simple form is provided because this is a very common
8232 requirement. Other kinds of wildcarding require the use of a regular
8233 expression.
8234 .next
8235 .cindex "regular expressions" "in host list"
8236 .cindex "host list" "regular expression in"
8237 If the item starts with &"^"& it is taken to be a regular expression which is
8238 matched against the host name. Host names are case-independent, so this regular
8239 expression match is by default case-independent, but you can make it
8240 case-dependent by starting it with &`(?-i)`&. References to descriptions of the
8241 syntax of regular expressions are given in chapter &<<CHAPregexp>>&. For
8242 example,
8243 .code
8244 ^(a|b)\.c\.d$
8245 .endd
8246 is a regular expression that matches either of the two hosts &'a.c.d'& or
8247 &'b.c.d'&. When a regular expression is used in a host list, you must take care
8248 that backslash and dollar characters are not misinterpreted as part of the
8249 string expansion. The simplest way to do this is to use &`\N`& to mark that
8250 part of the string as non-expandable. For example:
8251 .code
8252 sender_unqualified_hosts = \N^(a|b)\.c\.d$\N : ....
8253 .endd
8254 &*Warning*&: If you want to match a complete host name, you must include the
8255 &`$`& terminating metacharacter in the regular expression, as in the above
8256 example. Without it, a match at the start of the host name is all that is
8257 required.
8258 .endlist
8259
8260
8261
8262
8263 .section "Behaviour when an IP address or name cannot be found" "SECTbehipnot"
8264 .cindex "host" "lookup failures, permanent"
8265 While processing a host list, Exim may need to look up an IP address from a
8266 name (see section &<<SECThoslispatip>>&), or it may need to look up a host name
8267 from an IP address (see section &<<SECThoslispatnam>>&). In either case, the
8268 behaviour when it fails to find the information it is seeking is the same.
8269
8270 &*Note*&: This section applies to permanent lookup failures. It does &'not'&
8271 apply to temporary DNS errors, whose handling is described in the next section.
8272
8273 .cindex "&`+include_unknown`&"
8274 .cindex "&`+ignore_unknown`&"
8275 Exim parses a host list from left to right. If it encounters a permanent
8276 lookup failure in any item in the host list before it has found a match,
8277 Exim treats it as a failure and the default behavior is as if the host
8278 does not match the list. This may not always be what you want to happen.
8279 To change Exim's behaviour, the special items &`+include_unknown`& or
8280 &`+ignore_unknown`& may appear in the list (at top level &-- they are
8281 not recognized in an indirected file).
8282
8283 .ilist
8284 If any item that follows &`+include_unknown`& requires information that
8285 cannot found, Exim behaves as if the host does match the list. For example,
8286 .code
8287 host_reject_connection = +include_unknown:*.enemy.ex
8288 .endd
8289 rejects connections from any host whose name matches &`*.enemy.ex`&, and also
8290 any hosts whose name it cannot find.
8291
8292 .next
8293 If any item that follows &`+ignore_unknown`& requires information that cannot
8294 be found, Exim ignores that item and proceeds to the rest of the list. For
8295 example:
8296 .code
8297 accept hosts = +ignore_unknown : friend.example : \
8298                192.168.4.5
8299 .endd
8300 accepts from any host whose name is &'friend.example'& and from 192.168.4.5,
8301 whether or not its host name can be found. Without &`+ignore_unknown`&, if no
8302 name can be found for 192.168.4.5, it is rejected.
8303 .endlist
8304
8305 Both &`+include_unknown`& and &`+ignore_unknown`& may appear in the same
8306 list. The effect of each one lasts until the next, or until the end of the
8307 list.
8308
8309 .new
8310 To explain the host/ip processing logic a different way for the same ACL:
8311
8312 .ilist
8313 If you have name lookups or wildcarded host names and
8314 IP addresses in the same host list, you should normally put the IP
8315 addresses first. For example, in an ACL you could have:
8316 .code
8317 accept hosts = 10.9.8.7 : *.friend.example
8318 .endd
8319 The reason you normally would order it this way lies in the
8320 left-to-right way that Exim processes lists.  It can test IP addresses
8321 without doing any DNS lookups, but when it reaches an item that requires
8322 a host name, it fails if it cannot find a host name to compare with the
8323 pattern. If the above list is given in the opposite order, the
8324 &%accept%& statement fails for a host whose name cannot be found, even
8325 if its IP address is 10.9.8.7.
8326
8327 .next
8328 If you really do want to do the name check first, and still recognize the IP
8329 address, you can rewrite the ACL like this:
8330 .code
8331 accept hosts = *.friend.example
8332 accept hosts = 10.9.8.7
8333 .endd
8334 If the first &%accept%& fails, Exim goes on to try the second one. See chapter
8335 &<<CHAPACL>>& for details of ACLs. Alternatively, you can use
8336 &`+ignore_unknown`&, which was discussed in depth in the first example in
8337 this section.
8338 .endlist
8339 .wen
8340
8341
8342
8343 .section "Temporary DNS errors when looking up host information" &&&
8344          "SECTtemdnserr"
8345 .cindex "host" "lookup failures, temporary"
8346 .cindex "&`+include_defer`&"
8347 .cindex "&`+ignore_defer`&"
8348 A temporary DNS lookup failure normally causes a defer action (except when
8349 &%dns_again_means_nonexist%& converts it into a permanent error). However,
8350 host lists can include &`+ignore_defer`& and &`+include_defer`&, analagous to
8351 &`+ignore_unknown`& and &`+include_unknown`&, as described in the previous
8352 section. These options should be used with care, probably only in non-critical
8353 host lists such as whitelists.
8354
8355
8356
8357 .section "Host list patterns for single-key lookups by host name" &&&
8358          "SECThoslispatnamsk"
8359 .cindex "unknown host name"
8360 .cindex "host list" "matching host name"
8361 If a pattern is of the form
8362 .display
8363 <&'single-key-search-type'&>;<&'search-data'&>
8364 .endd
8365 for example
8366 .code
8367 dbm;/host/accept/list
8368 .endd
8369 a single-key lookup is performed, using the host name as its key. If the
8370 lookup succeeds, the host matches the item. The actual data that is looked up
8371 is not used.
8372
8373 &*Reminder*&: With this kind of pattern, you must have host &'names'& as
8374 keys in the file, not IP addresses. If you want to do lookups based on IP
8375 addresses, you must precede the search type with &"net-"& (see section
8376 &<<SECThoslispatsikey>>&). There is, however, no reason why you could not use
8377 two items in the same list, one doing an address lookup and one doing a name
8378 lookup, both using the same file.
8379
8380
8381
8382 .section "Host list patterns for query-style lookups" "SECID81"
8383 If a pattern is of the form
8384 .display
8385 <&'query-style-search-type'&>;<&'query'&>
8386 .endd
8387 the query is obeyed, and if it succeeds, the host matches the item. The actual
8388 data that is looked up is not used. The variables &$sender_host_address$& and
8389 &$sender_host_name$& can be used in the query. For example:
8390 .code
8391 hosts_lookup = pgsql;\
8392   select ip from hostlist where ip='$sender_host_address'
8393 .endd
8394 The value of &$sender_host_address$& for an IPv6 address contains colons. You
8395 can use the &%sg%& expansion item to change this if you need to. If you want to
8396 use masked IP addresses in database queries, you can use the &%mask%& expansion
8397 operator.
8398
8399 If the query contains a reference to &$sender_host_name$&, Exim automatically
8400 looks up the host name if it has not already done so. (See section
8401 &<<SECThoslispatnam>>& for comments on finding host names.)
8402
8403 Historical note: prior to release 4.30, Exim would always attempt to find a
8404 host name before running the query, unless the search type was preceded by
8405 &`net-`&. This is no longer the case. For backwards compatibility, &`net-`& is
8406 still recognized for query-style lookups, but its presence or absence has no
8407 effect. (Of course, for single-key lookups, &`net-`& &'is'& important.
8408 See section &<<SECThoslispatsikey>>&.)
8409
8410
8411
8412 .section "Mixing wildcarded host names and addresses in host lists" &&&
8413          "SECTmixwilhos"
8414 .cindex "host list" "mixing names and addresses in"
8415 If you have name lookups or wildcarded host names and IP addresses in the same
8416 host list, you should normally put the IP addresses first. For example, in an
8417 ACL you could have:
8418 .code
8419 accept hosts = 10.9.8.7 : *.friend.example
8420 .endd
8421 The reason for this lies in the left-to-right way that Exim processes lists.
8422 It can test IP addresses without doing any DNS lookups, but when it reaches an
8423 item that requires a host name, it fails if it cannot find a host name to
8424 compare with the pattern. If the above list is given in the opposite order, the
8425 &%accept%& statement fails for a host whose name cannot be found, even if its
8426 IP address is 10.9.8.7.
8427
8428 If you really do want to do the name check first, and still recognize the IP
8429 address, you can rewrite the ACL like this:
8430 .code
8431 accept hosts = *.friend.example
8432 accept hosts = 10.9.8.7
8433 .endd
8434 If the first &%accept%& fails, Exim goes on to try the second one. See chapter
8435 &<<CHAPACL>>& for details of ACLs.
8436
8437
8438
8439
8440
8441 .section "Address lists" "SECTaddresslist"
8442 .cindex "list" "address list"
8443 .cindex "address list" "empty item"
8444 .cindex "address list" "patterns"
8445 Address lists contain patterns that are matched against mail addresses. There
8446 is one special case to be considered: the sender address of a bounce message is
8447 always empty. You can test for this by providing an empty item in an address
8448 list. For example, you can set up a router to process bounce messages by
8449 using this option setting:
8450 .code
8451 senders = :
8452 .endd
8453 The presence of the colon creates an empty item. If you do not provide any
8454 data, the list is empty and matches nothing. The empty sender can also be
8455 detected by a regular expression that matches an empty string,
8456 and by a query-style lookup that succeeds when &$sender_address$& is empty.
8457
8458 Non-empty items in an address list can be straightforward email addresses. For
8459 example:
8460 .code
8461 senders = jbc@askone.example : hs@anacreon.example
8462 .endd
8463 A certain amount of wildcarding is permitted. If a pattern contains an @
8464 character, but is not a regular expression and does not begin with a
8465 semicolon-terminated lookup type (described below), the local part of the
8466 subject address is compared with the local part of the pattern, which may start
8467 with an asterisk. If the local parts match, the domain is checked in exactly
8468 the same way as for a pattern in a domain list. For example, the domain can be
8469 wildcarded, refer to a named list, or be a lookup:
8470 .code
8471 deny senders = *@*.spamming.site:\
8472                *@+hostile_domains:\
8473                bozo@partial-lsearch;/list/of/dodgy/sites:\
8474                *@dbm;/bad/domains.db
8475 .endd
8476 .cindex "local part" "starting with !"
8477 .cindex "address list" "local part starting with !"
8478 If a local part that begins with an exclamation mark is required, it has to be
8479 specified using a regular expression, because otherwise the exclamation mark is
8480 treated as a sign of negation, as is standard in lists.
8481
8482 If a non-empty pattern that is not a regular expression or a lookup does not
8483 contain an @ character, it is matched against the domain part of the subject
8484 address. The only two formats that are recognized this way are a literal
8485 domain, or a domain pattern that starts with *. In both these cases, the effect
8486 is the same as if &`*@`& preceded the pattern. For example:
8487 .code
8488 deny senders = enemy.domain : *.enemy.domain
8489 .endd
8490
8491 The following kinds of more complicated address list pattern can match any
8492 address, including the empty address that is characteristic of bounce message
8493 senders:
8494
8495 .ilist
8496 .cindex "regular expressions" "in address list"
8497 .cindex "address list" "regular expression in"
8498 If (after expansion) a pattern starts with &"^"&, a regular expression match is
8499 done against the complete address, with the pattern as the regular expression.
8500 You must take care that backslash and dollar characters are not misinterpreted
8501 as part of the string expansion. The simplest way to do this is to use &`\N`&
8502 to mark that part of the string as non-expandable. For example:
8503 .code
8504 deny senders = \N^.*this.*@example\.com$\N : \
8505                \N^\d{8}.+@spamhaus.example$\N : ...
8506 .endd
8507 The &`\N`& sequences are removed by the expansion, so these items do indeed
8508 start with &"^"& by the time they are being interpreted as address patterns.
8509
8510 .next
8511 .cindex "address list" "lookup for complete address"
8512 Complete addresses can be looked up by using a pattern that starts with a
8513 lookup type terminated by a semicolon, followed by the data for the lookup. For
8514 example:
8515 .code
8516 deny senders = cdb;/etc/blocked.senders : \
8517   mysql;select address from blocked where \
8518   address='${quote_mysql:$sender_address}'
8519 .endd
8520 Both query-style and single-key lookup types can be used. For a single-key
8521 lookup type, Exim uses the complete address as the key. However, empty keys are
8522 not supported for single-key lookups, so a match against the empty address
8523 always fails. This restriction does not apply to query-style lookups.
8524
8525 Partial matching for single-key lookups (section &<<SECTpartiallookup>>&)
8526 cannot be used, and is ignored if specified, with an entry being written to the
8527 panic log.
8528 .cindex "*@ with single-key lookup"
8529 However, you can configure lookup defaults, as described in section
8530 &<<SECTdefaultvaluelookups>>&, but this is useful only for the &"*@"& type of
8531 default. For example, with this lookup:
8532 .code
8533 accept senders = lsearch*@;/some/file
8534 .endd
8535 the file could contains lines like this:
8536 .code
8537 user1@domain1.example
8538 *@domain2.example
8539 .endd
8540 and for the sender address &'nimrod@jaeger.example'&, the sequence of keys
8541 that are tried is:
8542 .code
8543 nimrod@jaeger.example
8544 *@jaeger.example
8545 *
8546 .endd
8547 &*Warning 1*&: Do not include a line keyed by &"*"& in the file, because that
8548 would mean that every address matches, thus rendering the test useless.
8549
8550 &*Warning 2*&: Do not confuse these two kinds of item:
8551 .code
8552 deny recipients = dbm*@;/some/file
8553 deny recipients = *@dbm;/some/file
8554 .endd
8555 The first does a whole address lookup, with defaulting, as just described,
8556 because it starts with a lookup type. The second matches the local part and
8557 domain independently, as described in a bullet point below.
8558 .endlist
8559
8560
8561 The following kinds of address list pattern can match only non-empty addresses.
8562 If the subject address is empty, a match against any of these pattern types
8563 always fails.
8564
8565
8566 .ilist
8567 .cindex "@@ with single-key lookup"
8568 .cindex "address list" "@@ lookup type"
8569 .cindex "address list" "split local part and domain"
8570 If a pattern starts with &"@@"& followed by a single-key lookup item
8571 (for example, &`@@lsearch;/some/file`&), the address that is being checked is
8572 split into a local part and a domain. The domain is looked up in the file. If
8573 it is not found, there is no match. If it is found, the data that is looked up
8574 from the file is treated as a colon-separated list of local part patterns, each
8575 of which is matched against the subject local part in turn.
8576
8577 .cindex "asterisk" "in address list"
8578 The lookup may be a partial one, and/or one involving a search for a default
8579 keyed by &"*"& (see section &<<SECTdefaultvaluelookups>>&). The local part
8580 patterns that are looked up can be regular expressions or begin with &"*"&, or
8581 even be further lookups. They may also be independently negated. For example,
8582 with
8583 .code
8584 deny senders = @@dbm;/etc/reject-by-domain
8585 .endd
8586 the data from which the DBM file is built could contain lines like
8587 .code
8588 baddomain.com:  !postmaster : *
8589 .endd
8590 to reject all senders except &%postmaster%& from that domain.
8591
8592 .cindex "local part" "starting with !"
8593 If a local part that actually begins with an exclamation mark is required, it
8594 has to be specified using a regular expression. In &(lsearch)& files, an entry
8595 may be split over several lines by indenting the second and subsequent lines,
8596 but the separating colon must still be included at line breaks. White space
8597 surrounding the colons is ignored. For example:
8598 .code
8599 aol.com:  spammer1 : spammer2 : ^[0-9]+$ :
8600   spammer3 : spammer4
8601 .endd
8602 As in all colon-separated lists in Exim, a colon can be included in an item by
8603 doubling.
8604
8605 If the last item in the list starts with a right angle-bracket, the remainder
8606 of the item is taken as a new key to look up in order to obtain a continuation
8607 list of local parts. The new key can be any sequence of characters. Thus one
8608 might have entries like
8609 .code
8610 aol.com: spammer1 : spammer 2 : >*
8611 xyz.com: spammer3 : >*
8612 *:       ^\d{8}$
8613 .endd
8614 in a file that was searched with &%@@dbm*%&, to specify a match for 8-digit
8615 local parts for all domains, in addition to the specific local parts listed for
8616 each domain. Of course, using this feature costs another lookup each time a
8617 chain is followed, but the effort needed to maintain the data is reduced.
8618
8619 .cindex "loop" "in lookups"
8620 It is possible to construct loops using this facility, and in order to catch
8621 them, the chains may be no more than fifty items long.
8622
8623 .next
8624 The @@<&'lookup'&> style of item can also be used with a query-style
8625 lookup, but in this case, the chaining facility is not available. The lookup
8626 can only return a single list of local parts.
8627 .endlist
8628
8629 &*Warning*&: There is an important difference between the address list items
8630 in these two examples:
8631 .code
8632 senders = +my_list
8633 senders = *@+my_list
8634 .endd
8635 In the first one, &`my_list`& is a named address list, whereas in the second
8636 example it is a named domain list.
8637
8638
8639
8640
8641 .section "Case of letters in address lists" "SECTcasletadd"
8642 .cindex "case of local parts"
8643 .cindex "address list" "case forcing"
8644 .cindex "case forcing in address lists"
8645 Domains in email addresses are always handled caselessly, but for local parts
8646 case may be significant on some systems (see &%caseful_local_part%& for how
8647 Exim deals with this when routing addresses). However, RFC 2505 (&'Anti-Spam
8648 Recommendations for SMTP MTAs'&) suggests that matching of addresses to
8649 blocking lists should be done in a case-independent manner. Since most address
8650 lists in Exim are used for this kind of control, Exim attempts to do this by
8651 default.
8652
8653 The domain portion of an address is always lowercased before matching it to an
8654 address list. The local part is lowercased by default, and any string
8655 comparisons that take place are done caselessly. This means that the data in
8656 the address list itself, in files included as plain file names, and in any file
8657 that is looked up using the &"@@"& mechanism, can be in any case. However, the
8658 keys in files that are looked up by a search type other than &(lsearch)& (which
8659 works caselessly) must be in lower case, because these lookups are not
8660 case-independent.
8661
8662 .cindex "&`+caseful`&"
8663 To allow for the possibility of caseful address list matching, if an item in
8664 an address list is the string &"+caseful"&, the original case of the local
8665 part is restored for any comparisons that follow, and string comparisons are no
8666 longer case-independent. This does not affect the domain, which remains in
8667 lower case. However, although independent matches on the domain alone are still
8668 performed caselessly, regular expressions that match against an entire address
8669 become case-sensitive after &"+caseful"& has been seen.
8670
8671
8672
8673 .section "Local part lists" "SECTlocparlis"
8674 .cindex "list" "local part list"
8675 .cindex "local part" "list"
8676 Case-sensitivity in local part lists is handled in the same way as for address
8677 lists, as just described. The &"+caseful"& item can be used if required. In a
8678 setting of the &%local_parts%& option in a router with &%caseful_local_part%&
8679 set false, the subject is lowercased and the matching is initially
8680 case-insensitive. In this case, &"+caseful"& will restore case-sensitive
8681 matching in the local part list, but not elsewhere in the router. If
8682 &%caseful_local_part%& is set true in a router, matching in the &%local_parts%&
8683 option is case-sensitive from the start.
8684
8685 If a local part list is indirected to a file (see section &<<SECTfilnamlis>>&),
8686 comments are handled in the same way as address lists &-- they are recognized
8687 only if the # is preceded by white space or the start of the line.
8688 Otherwise, local part lists are matched in the same way as domain lists, except
8689 that the special items that refer to the local host (&`@`&, &`@[]`&,
8690 &`@mx_any`&, &`@mx_primary`&, and &`@mx_secondary`&) are not recognized.
8691 Refer to section &<<SECTdomainlist>>& for details of the other available item
8692 types.
8693 .ecindex IIDdohoadli
8694
8695
8696
8697
8698 . ////////////////////////////////////////////////////////////////////////////
8699 . ////////////////////////////////////////////////////////////////////////////
8700
8701 .chapter "String expansions" "CHAPexpand"
8702 .scindex IIDstrexp "expansion" "of strings"
8703 Many strings in Exim's run time configuration are expanded before use. Some of
8704 them are expanded every time they are used; others are expanded only once.
8705
8706 When a string is being expanded it is copied verbatim from left to right except
8707 when a dollar or backslash character is encountered. A dollar specifies the
8708 start of a portion of the string that is interpreted and replaced as described
8709 below in section &<<SECTexpansionitems>>& onwards. Backslash is used as an
8710 escape character, as described in the following section.
8711
8712 Whether a string is expanded depends upon the context.  Usually this is solely
8713 dependent upon the option for which a value is sought; in this documentation,
8714 options for which string expansion is performed are marked with &dagger; after
8715 the data type.  ACL rules always expand strings.  A couple of expansion
8716 conditions do not expand some of the brace-delimited branches, for security
8717 reasons.
8718
8719
8720
8721 .section "Literal text in expanded strings" "SECTlittext"
8722 .cindex "expansion" "including literal text"
8723 An uninterpreted dollar can be included in an expanded string by putting a
8724 backslash in front of it. A backslash can be used to prevent any special
8725 character being treated specially in an expansion, including backslash itself.
8726 If the string appears in quotes in the configuration file, two backslashes are
8727 required because the quotes themselves cause interpretation of backslashes when
8728 the string is read in (see section &<<SECTstrings>>&).
8729
8730 .cindex "expansion" "non-expandable substrings"
8731 A portion of the string can specified as non-expandable by placing it between
8732 two occurrences of &`\N`&. This is particularly useful for protecting regular
8733 expressions, which often contain backslashes and dollar signs. For example:
8734 .code
8735 deny senders = \N^\d{8}[a-z]@some\.site\.example$\N
8736 .endd
8737 On encountering the first &`\N`&, the expander copies subsequent characters
8738 without interpretation until it reaches the next &`\N`& or the end of the
8739 string.
8740
8741
8742
8743 .section "Character escape sequences in expanded strings" "SECID82"
8744 .cindex "expansion" "escape sequences"
8745 A backslash followed by one of the letters &"n"&, &"r"&, or &"t"& in an
8746 expanded string is recognized as an escape sequence for the character newline,
8747 carriage return, or tab, respectively. A backslash followed by up to three
8748 octal digits is recognized as an octal encoding for a single character, and a
8749 backslash followed by &"x"& and up to two hexadecimal digits is a hexadecimal
8750 encoding.
8751
8752 These escape sequences are also recognized in quoted strings when they are read
8753 in. Their interpretation in expansions as well is useful for unquoted strings,
8754 and for other cases such as looked-up strings that are then expanded.
8755
8756
8757 .section "Testing string expansions" "SECID83"
8758 .cindex "expansion" "testing"
8759 .cindex "testing" "string expansion"
8760 .oindex "&%-be%&"
8761 Many expansions can be tested by calling Exim with the &%-be%& option. This
8762 takes the command arguments, or lines from the standard input if there are no
8763 arguments, runs them through the string expansion code, and writes the results
8764 to the standard output. Variables based on configuration values are set up, but
8765 since no message is being processed, variables such as &$local_part$& have no
8766 value. Nevertheless the &%-be%& option can be useful for checking out file and
8767 database lookups, and the use of expansion operators such as &%sg%&, &%substr%&
8768 and &%nhash%&.
8769
8770 Exim gives up its root privilege when it is called with the &%-be%& option, and
8771 instead runs under the uid and gid it was called with, to prevent users from
8772 using &%-be%& for reading files to which they do not have access.
8773
8774 .oindex "&%-bem%&"
8775 If you want to test expansions that include variables whose values are taken
8776 from a message, there are two other options that can be used. The &%-bem%&
8777 option is like &%-be%& except that it is followed by a file name. The file is
8778 read as a message before doing the test expansions. For example:
8779 .code
8780 exim -bem /tmp/test.message '$h_subject:'
8781 .endd
8782 The &%-Mset%& option is used in conjunction with &%-be%& and is followed by an
8783 Exim message identifier. For example:
8784 .code
8785 exim -be -Mset 1GrA8W-0004WS-LQ '$recipients'
8786 .endd
8787 This loads the message from Exim's spool before doing the test expansions, and
8788 is therefore restricted to admin users.
8789
8790
8791 .section "Forced expansion failure" "SECTforexpfai"
8792 .cindex "expansion" "forced failure"
8793 A number of expansions that are described in the following section have
8794 alternative &"true"& and &"false"& substrings, enclosed in brace characters
8795 (which are sometimes called &"curly brackets"&). Which of the two strings is
8796 used depends on some condition that is evaluated as part of the expansion. If,
8797 instead of a &"false"& substring, the word &"fail"& is used (not in braces),
8798 the entire string expansion fails in a way that can be detected by the code
8799 that requested the expansion. This is called &"forced expansion failure"&, and
8800 its consequences depend on the circumstances. In some cases it is no different
8801 from any other expansion failure, but in others a different action may be
8802 taken. Such variations are mentioned in the documentation of the option that is
8803 being expanded.
8804
8805
8806
8807
8808 .section "Expansion items" "SECTexpansionitems"
8809 The following items are recognized in expanded strings. White space may be used
8810 between sub-items that are keywords or substrings enclosed in braces inside an
8811 outer set of braces, to improve readability. &*Warning*&: Within braces,
8812 white space is significant.
8813
8814 .vlist
8815 .vitem &*$*&<&'variable&~name'&>&~or&~&*${*&<&'variable&~name'&>&*}*&
8816 .cindex "expansion" "variables"
8817 Substitute the contents of the named variable, for example:
8818 .code
8819 $local_part
8820 ${domain}
8821 .endd
8822 The second form can be used to separate the name from subsequent alphanumeric
8823 characters. This form (using braces) is available only for variables; it does
8824 &'not'& apply to message headers. The names of the variables are given in
8825 section &<<SECTexpvar>>& below. If the name of a non-existent variable is
8826 given, the expansion fails.
8827
8828 .vitem &*${*&<&'op'&>&*:*&<&'string'&>&*}*&
8829 .cindex "expansion" "operators"
8830 The string is first itself expanded, and then the operation specified by
8831 <&'op'&> is applied to it. For example:
8832 .code
8833 ${lc:$local_part}
8834 .endd
8835 The string starts with the first character after the colon, which may be
8836 leading white space. A list of operators is given in section &<<SECTexpop>>&
8837 below. The operator notation is used for simple expansion items that have just
8838 one argument, because it reduces the number of braces and therefore makes the
8839 string easier to understand.
8840
8841 .vitem &*$bheader_*&<&'header&~name'&>&*:*&&~or&~&*$bh_*&<&'header&~name'&>&*:*&
8842 This item inserts &"basic"& header lines. It is described with the &%header%&
8843 expansion item below.
8844
8845
8846 .new
8847 .vitem "&*${acl{*&<&'name'&>&*}{*&<&'arg'&>&*}...}*&"
8848 .cindex "expansion" "calling an acl"
8849 .cindex "&%acl%&" "call from expansion"
8850 The name and zero to nine argument strings are first expanded separately.  The expanded
8851 arguments are assigned to the variables &$acl_arg1$& to &$acl_arg9$& in order.
8852 Any unused are made empty.  The variable &$acl_narg$& is set to the number of
8853 arguments.  The named ACL (see chapter &<<CHAPACL>>&) is called
8854 and may use the variables; if another acl expansion is used the values
8855 are restored after it returns.  If the ACL sets
8856 a value using a "message =" modifier and returns accept or deny, the value becomes
8857 the result of the expansion.
8858 If no message is set and the ACL returns accept or deny
8859 the expansion result is an empty string.
8860 If the ACL returns defer the result is a forced-fail.  Otherwise the expansion fails.
8861 .wen
8862
8863
8864 .vitem "&*${dlfunc{*&<&'file'&>&*}{*&<&'function'&>&*}{*&<&'arg'&>&*}&&&
8865        {*&<&'arg'&>&*}...}*&"
8866 .cindex &%dlfunc%&
8867 This expansion dynamically loads and then calls a locally-written C function.
8868 This functionality is available only if Exim is compiled with
8869 .code
8870 EXPAND_DLFUNC=yes
8871 .endd
8872 set in &_Local/Makefile_&. Once loaded, Exim remembers the dynamically loaded
8873 object so that it doesn't reload the same object file in the same Exim process
8874 (but of course Exim does start new processes frequently).
8875
8876 There may be from zero to eight arguments to the function. When compiling
8877 a local function that is to be called in this way, &_local_scan.h_& should be
8878 included. The Exim variables and functions that are defined by that API
8879 are also available for dynamically loaded functions. The function itself
8880 must have the following type:
8881 .code
8882 int dlfunction(uschar **yield, int argc, uschar *argv[])
8883 .endd
8884 Where &`uschar`& is a typedef for &`unsigned char`& in &_local_scan.h_&. The
8885 function should return one of the following values:
8886
8887 &`OK`&: Success. The string that is placed in the variable &'yield'& is put
8888 into the expanded string that is being built.
8889
8890 &`FAIL`&: A non-forced expansion failure occurs, with the error message taken
8891 from &'yield'&, if it is set.
8892
8893 &`FAIL_FORCED`&: A forced expansion failure occurs, with the error message
8894 taken from &'yield'& if it is set.
8895
8896 &`ERROR`&: Same as &`FAIL`&, except that a panic log entry is written.
8897
8898 When compiling a function that is to be used in this way with gcc,
8899 you need to add &%-shared%& to the gcc command. Also, in the Exim build-time
8900 configuration, you must add &%-export-dynamic%& to EXTRALIBS.
8901
8902 .vitem "&*${extract{*&<&'key'&>&*}{*&<&'string1'&>&*}{*&<&'string2'&>&*}&&&
8903        {*&<&'string3'&>&*}}*&"
8904 .cindex "expansion" "extracting substrings by key"
8905 .cindex "&%extract%&" "substrings by key"
8906 The key and <&'string1'&> are first expanded separately. Leading and trailing
8907 white space is removed from the key (but not from any of the strings). The key
8908 must not consist entirely of digits. The expanded <&'string1'&> must be of the
8909 form:
8910 .display
8911 <&'key1'&> = <&'value1'&>  <&'key2'&> = <&'value2'&> ...
8912 .endd
8913 .vindex "&$value$&"
8914 where the equals signs and spaces (but not both) are optional. If any of the
8915 values contain white space, they must be enclosed in double quotes, and any
8916 values that are enclosed in double quotes are subject to escape processing as
8917 described in section &<<SECTstrings>>&. The expanded <&'string1'&> is searched
8918 for the value that corresponds to the key. The search is case-insensitive. If
8919 the key is found, <&'string2'&> is expanded, and replaces the whole item;
8920 otherwise <&'string3'&> is used. During the expansion of <&'string2'&> the
8921 variable &$value$& contains the value that has been extracted. Afterwards, it
8922 is restored to any previous value it might have had.
8923
8924 If {<&'string3'&>} is omitted, the item is replaced by an empty string if the
8925 key is not found. If {<&'string2'&>} is also omitted, the value that was
8926 extracted is used. Thus, for example, these two expansions are identical, and
8927 yield &"2001"&:
8928 .code
8929 ${extract{gid}{uid=1984 gid=2001}}
8930 ${extract{gid}{uid=1984 gid=2001}{$value}}
8931 .endd
8932 Instead of {<&'string3'&>} the word &"fail"& (not in curly brackets) can
8933 appear, for example:
8934 .code
8935 ${extract{Z}{A=... B=...}{$value} fail }
8936 .endd
8937 This forces an expansion failure (see section &<<SECTforexpfai>>&);
8938 {<&'string2'&>} must be present for &"fail"& to be recognized.
8939
8940
8941 .vitem "&*${extract{*&<&'number'&>&*}{*&<&'separators'&>&*}&&&
8942         {*&<&'string1'&>&*}{*&<&'string2'&>&*}{*&<&'string3'&>&*}}*&"
8943 .cindex "expansion" "extracting substrings by number"
8944 .cindex "&%extract%&" "substrings by number"
8945 The <&'number'&> argument must consist entirely of decimal digits,
8946 apart from leading and trailing white space, which is ignored.
8947 This is what distinguishes this form of &%extract%& from the previous kind. It
8948 behaves in the same way, except that, instead of extracting a named field, it
8949 extracts from <&'string1'&> the field whose number is given as the first
8950 argument. You can use &$value$& in <&'string2'&> or &`fail`& instead of
8951 <&'string3'&> as before.
8952
8953 The fields in the string are separated by any one of the characters in the
8954 separator string. These may include space or tab characters.
8955 The first field is numbered one. If the number is negative, the fields are
8956 counted from the end of the string, with the rightmost one numbered -1. If the
8957 number given is zero, the entire string is returned. If the modulus of the
8958 number is greater than the number of fields in the string, the result is the
8959 expansion of <&'string3'&>, or the empty string if <&'string3'&> is not
8960 provided. For example:
8961 .code
8962 ${extract{2}{:}{x:42:99:& Mailer::/bin/bash}}
8963 .endd
8964 yields &"42"&, and
8965 .code
8966 ${extract{-4}{:}{x:42:99:& Mailer::/bin/bash}}
8967 .endd
8968 yields &"99"&. Two successive separators mean that the field between them is
8969 empty (for example, the fifth field above).
8970
8971
8972 .vitem &*${filter{*&<&'string'&>&*}{*&<&'condition'&>&*}}*&
8973 .cindex "list" "selecting by condition"
8974 .cindex "expansion" "selecting from list by condition"
8975 .vindex "&$item$&"
8976 After expansion, <&'string'&> is interpreted as a list, colon-separated by
8977 default, but the separator can be changed in the usual way. For each item
8978 in this list, its value is place in &$item$&, and then the condition is
8979 evaluated. If the condition is true, &$item$& is added to the output as an
8980 item in a new list; if the condition is false, the item is discarded. The
8981 separator used for the output list is the same as the one used for the
8982 input, but a separator setting is not included in the output. For example:
8983 .code
8984 ${filter{a:b:c}{!eq{$item}{b}}
8985 .endd
8986 yields &`a:c`&. At the end of the expansion, the value of &$item$& is restored
8987 to what it was before. See also the &*map*& and &*reduce*& expansion items.
8988
8989
8990 .vitem &*${hash{*&<&'string1'&>&*}{*&<&'string2'&>&*}{*&<&'string3'&>&*}}*&
8991 .cindex "hash function" "textual"
8992 .cindex "expansion" "textual hash"
8993 This is a textual hashing function, and was the first to be implemented in
8994 early versions of Exim. In current releases, there are other hashing functions
8995 (numeric, MD5, and SHA-1), which are described below.
8996
8997 The first two strings, after expansion, must be numbers. Call them <&'m'&> and
8998 <&'n'&>. If you are using fixed values for these numbers, that is, if
8999 <&'string1'&> and <&'string2'&> do not change when they are expanded, you can
9000 use the simpler operator notation that avoids some of the braces:
9001 .code
9002 ${hash_<n>_<m>:<string>}
9003 .endd
9004 The second number is optional (in both notations). If <&'n'&> is greater than
9005 or equal to the length of the string, the expansion item returns the string.
9006 Otherwise it computes a new string of length <&'n'&> by applying a hashing
9007 function to the string. The new string consists of characters taken from the
9008 first <&'m'&> characters of the string
9009 .code
9010 abcdefghijklmnopqrstuvwxyzABCDEFGHIJKLMNOPQWRSTUVWXYZ0123456789
9011 .endd
9012 If <&'m'&> is not present the value 26 is used, so that only lower case
9013 letters appear. For example:
9014 .display
9015 &`$hash{3}{monty}}           `&   yields  &`jmg`&
9016 &`$hash{5}{monty}}           `&   yields  &`monty`&
9017 &`$hash{4}{62}{monty python}}`&   yields  &`fbWx`&
9018 .endd
9019
9020 .vitem "&*$header_*&<&'header&~name'&>&*:*&&~or&~&&&
9021         &*$h_*&<&'header&~name'&>&*:*&" &&&
9022        "&*$bheader_*&<&'header&~name'&>&*:*&&~or&~&&&
9023         &*$bh_*&<&'header&~name'&>&*:*&" &&&
9024        "&*$rheader_*&<&'header&~name'&>&*:*&&~or&~&&&
9025         &*$rh_*&<&'header&~name'&>&*:*&"
9026 .cindex "expansion" "header insertion"
9027 .vindex "&$header_$&"
9028 .vindex "&$bheader_$&"
9029 .vindex "&$rheader_$&"
9030 .cindex "header lines" "in expansion strings"
9031 .cindex "header lines" "character sets"
9032 .cindex "header lines" "decoding"
9033 Substitute the contents of the named message header line, for example
9034 .code
9035 $header_reply-to:
9036 .endd
9037 The newline that terminates a header line is not included in the expansion, but
9038 internal newlines (caused by splitting the header line over several physical
9039 lines) may be present.
9040
9041 The difference between &%rheader%&, &%bheader%&, and &%header%& is in the way
9042 the data in the header line is interpreted.
9043
9044 .ilist
9045 .cindex "white space" "in header lines"
9046 &%rheader%& gives the original &"raw"& content of the header line, with no
9047 processing at all, and without the removal of leading and trailing white space.
9048
9049 .next
9050 .cindex "base64 encoding" "in header lines"
9051 &%bheader%& removes leading and trailing white space, and then decodes base64
9052 or quoted-printable MIME &"words"& within the header text, but does no
9053 character set translation. If decoding of what looks superficially like a MIME
9054 &"word"& fails, the raw string is returned. If decoding
9055 .cindex "binary zero" "in header line"
9056 produces a binary zero character, it is replaced by a question mark &-- this is
9057 what Exim does for binary zeros that are actually received in header lines.
9058
9059 .next
9060 &%header%& tries to translate the string as decoded by &%bheader%& to a
9061 standard character set. This is an attempt to produce the same string as would
9062 be displayed on a user's MUA. If translation fails, the &%bheader%& string is
9063 returned. Translation is attempted only on operating systems that support the
9064 &[iconv()]& function. This is indicated by the compile-time macro HAVE_ICONV in
9065 a system Makefile or in &_Local/Makefile_&.
9066 .endlist ilist
9067
9068 In a filter file, the target character set for &%header%& can be specified by a
9069 command of the following form:
9070 .code
9071 headers charset "UTF-8"
9072 .endd
9073 This command affects all references to &$h_$& (or &$header_$&) expansions in
9074 subsequently obeyed filter commands. In the absence of this command, the target
9075 character set in a filter is taken from the setting of the &%headers_charset%&
9076 option in the runtime configuration. The value of this option defaults to the
9077 value of HEADERS_CHARSET in &_Local/Makefile_&. The ultimate default is
9078 ISO-8859-1.
9079
9080 Header names follow the syntax of RFC 2822, which states that they may contain
9081 any printing characters except space and colon. Consequently, curly brackets
9082 &'do not'& terminate header names, and should not be used to enclose them as
9083 if they were variables. Attempting to do so causes a syntax error.
9084
9085 Only header lines that are common to all copies of a message are visible to
9086 this mechanism. These are the original header lines that are received with the
9087 message, and any that are added by an ACL statement or by a system
9088 filter. Header lines that are added to a particular copy of a message by a
9089 router or transport are not accessible.
9090
9091 For incoming SMTP messages, no header lines are visible in ACLs that are obeyed
9092 before the DATA ACL, because the header structure is not set up until the
9093 message is received. Header lines that are added in a RCPT ACL (for example)
9094 are saved until the message's incoming header lines are available, at which
9095 point they are added. When a DATA ACL is running, however, header lines added
9096 by earlier ACLs are visible.
9097
9098 Upper case and lower case letters are synonymous in header names. If the
9099 following character is white space, the terminating colon may be omitted, but
9100 this is not recommended, because you may then forget it when it is needed. When
9101 white space terminates the header name, it is included in the expanded string.
9102 If the message does not contain the given header, the expansion item is
9103 replaced by an empty string. (See the &%def%& condition in section
9104 &<<SECTexpcond>>& for a means of testing for the existence of a header.)
9105
9106 If there is more than one header with the same name, they are all concatenated
9107 to form the substitution string, up to a maximum length of 64K. Unless
9108 &%rheader%& is being used, leading and trailing white space is removed from
9109 each header before concatenation, and a completely empty header is ignored. A
9110 newline character is then inserted between non-empty headers, but there is no
9111 newline at the very end. For the &%header%& and &%bheader%& expansion, for
9112 those headers that contain lists of addresses, a comma is also inserted at the
9113 junctions between headers. This does not happen for the &%rheader%& expansion.
9114
9115
9116 .vitem &*${hmac{*&<&'hashname'&>&*}{*&<&'secret'&>&*}{*&<&'string'&>&*}}*&
9117 .cindex "expansion" "hmac hashing"
9118 .cindex &%hmac%&
9119 This function uses cryptographic hashing (either MD5 or SHA-1) to convert a
9120 shared secret and some text into a message authentication code, as specified in
9121 RFC 2104. This differs from &`${md5:secret_text...}`& or
9122 &`${sha1:secret_text...}`& in that the hmac step adds a signature to the
9123 cryptographic hash, allowing for authentication that is not possible with MD5
9124 or SHA-1 alone. The hash name must expand to either &`md5`& or &`sha1`& at
9125 present. For example:
9126 .code
9127 ${hmac{md5}{somesecret}{$primary_hostname $tod_log}}
9128 .endd
9129 For the hostname &'mail.example.com'& and time 2002-10-17 11:30:59, this
9130 produces:
9131 .code
9132 dd97e3ba5d1a61b5006108f8c8252953
9133 .endd
9134 As an example of how this might be used, you might put in the main part of
9135 an Exim configuration:
9136 .code
9137 SPAMSCAN_SECRET=cohgheeLei2thahw
9138 .endd
9139 In a router or a transport you could then have:
9140 .code
9141 headers_add = \
9142   X-Spam-Scanned: ${primary_hostname} ${message_exim_id} \
9143   ${hmac{md5}{SPAMSCAN_SECRET}\
9144   {${primary_hostname},${message_exim_id},$h_message-id:}}
9145 .endd
9146 Then given a message, you can check where it was scanned by looking at the
9147 &'X-Spam-Scanned:'& header line. If you know the secret, you can check that
9148 this header line is authentic by recomputing the authentication code from the
9149 host name, message ID and the &'Message-id:'& header line. This can be done
9150 using Exim's &%-be%& option, or by other means, for example by using the
9151 &'hmac_md5_hex()'& function in Perl.
9152
9153
9154 .vitem &*${if&~*&<&'condition'&>&*&~{*&<&'string1'&>&*}{*&<&'string2'&>&*}}*&
9155 .cindex "expansion" "conditional"
9156 .cindex "&%if%&, expansion item"
9157 If <&'condition'&> is true, <&'string1'&> is expanded and replaces the whole
9158 item; otherwise <&'string2'&> is used. The available conditions are described
9159 in section &<<SECTexpcond>>& below. For example:
9160 .code
9161 ${if eq {$local_part}{postmaster} {yes}{no} }
9162 .endd
9163 The second string need not be present; if it is not and the condition is not
9164 true, the item is replaced with nothing. Alternatively, the word &"fail"& may
9165 be present instead of the second string (without any curly brackets). In this
9166 case, the expansion is forced to fail if the condition is not true (see section
9167 &<<SECTforexpfai>>&).
9168
9169 If both strings are omitted, the result is the string &`true`& if the condition
9170 is true, and the empty string if the condition is false. This makes it less
9171 cumbersome to write custom ACL and router conditions. For example, instead of
9172 .code
9173 condition = ${if >{$acl_m4}{3}{true}{false}}
9174 .endd
9175 you can use
9176 .code
9177 condition = ${if >{$acl_m4}{3}}
9178 .endd
9179
9180 .vitem &*${length{*&<&'string1'&>&*}{*&<&'string2'&>&*}}*&
9181 .cindex "expansion" "string truncation"
9182 .cindex "&%length%& expansion item"
9183 The &%length%& item is used to extract the initial portion of a string. Both
9184 strings are expanded, and the first one must yield a number, <&'n'&>, say. If
9185 you are using a fixed value for the number, that is, if <&'string1'&> does not
9186 change when expanded, you can use the simpler operator notation that avoids
9187 some of the braces:
9188 .code
9189 ${length_<n>:<string>}
9190 .endd
9191 The result of this item is either the first <&'n'&> characters or the whole
9192 of <&'string2'&>, whichever is the shorter. Do not confuse &%length%& with
9193 &%strlen%&, which gives the length of a string.
9194
9195
9196 .vitem "&*${lookup{*&<&'key'&>&*}&~*&<&'search&~type'&>&*&~&&&
9197         {*&<&'file'&>&*}&~{*&<&'string1'&>&*}&~{*&<&'string2'&>&*}}*&"
9198 This is the first of one of two different types of lookup item, which are both
9199 described in the next item.
9200
9201 .vitem "&*${lookup&~*&<&'search&~type'&>&*&~{*&<&'query'&>&*}&~&&&
9202         {*&<&'string1'&>&*}&~{*&<&'string2'&>&*}}*&"
9203 .cindex "expansion" "lookup in"
9204 .cindex "file" "lookups"
9205 .cindex "lookup" "in expanded string"
9206 The two forms of lookup item specify data lookups in files and databases, as
9207 discussed in chapter &<<CHAPfdlookup>>&. The first form is used for single-key
9208 lookups, and the second is used for query-style lookups. The <&'key'&>,
9209 <&'file'&>, and <&'query'&> strings are expanded before use.
9210
9211 If there is any white space in a lookup item which is part of a filter command,
9212 a retry or rewrite rule, a routing rule for the &(manualroute)& router, or any
9213 other place where white space is significant, the lookup item must be enclosed
9214 in double quotes. The use of data lookups in users' filter files may be locked
9215 out by the system administrator.
9216
9217 .vindex "&$value$&"
9218 If the lookup succeeds, <&'string1'&> is expanded and replaces the entire item.
9219 During its expansion, the variable &$value$& contains the data returned by the
9220 lookup. Afterwards it reverts to the value it had previously (at the outer
9221 level it is empty). If the lookup fails, <&'string2'&> is expanded and replaces
9222 the entire item. If {<&'string2'&>} is omitted, the replacement is the empty
9223 string on failure. If <&'string2'&> is provided, it can itself be a nested
9224 lookup, thus providing a mechanism for looking up a default value when the
9225 original lookup fails.
9226
9227 If a nested lookup is used as part of <&'string1'&>, &$value$& contains the
9228 data for the outer lookup while the parameters of the second lookup are
9229 expanded, and also while <&'string2'&> of the second lookup is expanded, should
9230 the second lookup fail. Instead of {<&'string2'&>} the word &"fail"& can
9231 appear, and in this case, if the lookup fails, the entire expansion is forced
9232 to fail (see section &<<SECTforexpfai>>&). If both {<&'string1'&>} and
9233 {<&'string2'&>} are omitted, the result is the looked up value in the case of a
9234 successful lookup, and nothing in the case of failure.
9235
9236 For single-key lookups, the string &"partial"& is permitted to precede the
9237 search type in order to do partial matching, and * or *@ may follow a search
9238 type to request default lookups if the key does not match (see sections
9239 &<<SECTdefaultvaluelookups>>& and &<<SECTpartiallookup>>& for details).
9240
9241 .cindex "numerical variables (&$1$& &$2$& etc)" "in lookup expansion"
9242 If a partial search is used, the variables &$1$& and &$2$& contain the wild
9243 and non-wild parts of the key during the expansion of the replacement text.
9244 They return to their previous values at the end of the lookup item.
9245
9246 This example looks up the postmaster alias in the conventional alias file:
9247 .code
9248 ${lookup {postmaster} lsearch {/etc/aliases} {$value}}
9249 .endd
9250 This example uses NIS+ to look up the full name of the user corresponding to
9251 the local part of an address, forcing the expansion to fail if it is not found:
9252 .code
9253 ${lookup nisplus {[name=$local_part],passwd.org_dir:gcos} \
9254   {$value}fail}
9255 .endd
9256
9257
9258 .vitem &*${map{*&<&'string1'&>&*}{*&<&'string2'&>&*}}*&
9259 .cindex "expansion" "list creation"
9260 .vindex "&$item$&"
9261 After expansion, <&'string1'&> is interpreted as a list, colon-separated by
9262 default, but the separator can be changed in the usual way. For each item
9263 in this list, its value is place in &$item$&, and then <&'string2'&> is
9264 expanded and added to the output as an item in a new list. The separator used
9265 for the output list is the same as the one used for the input, but a separator
9266 setting is not included in the output. For example:
9267 .code
9268 ${map{a:b:c}{[$item]}} ${map{<- x-y-z}{($item)}}
9269 .endd
9270 expands to &`[a]:[b]:[c] (x)-(y)-(z)`&. At the end of the expansion, the
9271 value of &$item$& is restored to what it was before. See also the &*filter*&
9272 and &*reduce*& expansion items.
9273
9274 .vitem &*${nhash{*&<&'string1'&>&*}{*&<&'string2'&>&*}{*&<&'string3'&>&*}}*&
9275 .cindex "expansion" "numeric hash"
9276 .cindex "hash function" "numeric"
9277 The three strings are expanded; the first two must yield numbers. Call them
9278 <&'n'&> and <&'m'&>. If you are using fixed values for these numbers, that is,
9279 if <&'string1'&> and <&'string2'&> do not change when they are expanded, you
9280 can use the simpler operator notation that avoids some of the braces:
9281 .code
9282 ${nhash_<n>_<m>:<string>}
9283 .endd
9284 The second number is optional (in both notations). If there is only one number,
9285 the result is a number in the range 0&--<&'n'&>-1. Otherwise, the string is
9286 processed by a div/mod hash function that returns two numbers, separated by a
9287 slash, in the ranges 0 to <&'n'&>-1 and 0 to <&'m'&>-1, respectively. For
9288 example,
9289 .code
9290 ${nhash{8}{64}{supercalifragilisticexpialidocious}}
9291 .endd
9292 returns the string &"6/33"&.
9293
9294
9295
9296 .vitem &*${perl{*&<&'subroutine'&>&*}{*&<&'arg'&>&*}{*&<&'arg'&>&*}...}*&
9297 .cindex "Perl" "use in expanded string"
9298 .cindex "expansion" "calling Perl from"
9299 This item is available only if Exim has been built to include an embedded Perl
9300 interpreter. The subroutine name and the arguments are first separately
9301 expanded, and then the Perl subroutine is called with those arguments. No
9302 additional arguments need be given; the maximum number permitted, including the
9303 name of the subroutine, is nine.
9304
9305 The return value of the subroutine is inserted into the expanded string, unless
9306 the return value is &%undef%&. In that case, the expansion fails in the same
9307 way as an explicit &"fail"& on a lookup item. The return value is a scalar.
9308 Whatever you return is evaluated in a scalar context. For example, if you
9309 return the name of a Perl vector, the return value is the size of the vector,
9310 not its contents.
9311
9312 If the subroutine exits by calling Perl's &%die%& function, the expansion fails
9313 with the error message that was passed to &%die%&. More details of the embedded
9314 Perl facility are given in chapter &<<CHAPperl>>&.
9315
9316 The &(redirect)& router has an option called &%forbid_filter_perl%& which locks
9317 out the use of this expansion item in filter files.
9318
9319
9320 .vitem &*${prvs{*&<&'address'&>&*}{*&<&'secret'&>&*}{*&<&'keynumber'&>&*}}*&
9321 .cindex "&%prvs%& expansion item"
9322 The first argument is a complete email address and the second is secret
9323 keystring. The third argument, specifying a key number, is optional. If absent,
9324 it defaults to 0. The result of the expansion is a prvs-signed email address,
9325 to be typically used with the &%return_path%& option on an &(smtp)& transport
9326 as part of a bounce address tag validation (BATV) scheme. For more discussion
9327 and an example, see section &<<SECTverifyPRVS>>&.
9328
9329 .vitem "&*${prvscheck{*&<&'address'&>&*}{*&<&'secret'&>&*}&&&
9330         {*&<&'string'&>&*}}*&"
9331 .cindex "&%prvscheck%& expansion item"
9332 This expansion item is the complement of the &%prvs%& item. It is used for
9333 checking prvs-signed addresses. If the expansion of the first argument does not
9334 yield a syntactically valid prvs-signed address, the whole item expands to the
9335 empty string. When the first argument does expand to a syntactically valid
9336 prvs-signed address, the second argument is expanded, with the prvs-decoded
9337 version of the address and the key number extracted from the address in the
9338 variables &$prvscheck_address$& and &$prvscheck_keynum$&, respectively.
9339
9340 These two variables can be used in the expansion of the second argument to
9341 retrieve the secret. The validity of the prvs-signed address is then checked
9342 against the secret. The result is stored in the variable &$prvscheck_result$&,
9343 which is empty for failure or &"1"& for success.
9344
9345 The third argument is optional; if it is missing, it defaults to an empty
9346 string. This argument is now expanded. If the result is an empty string, the
9347 result of the expansion is the decoded version of the address. This is the case
9348 whether or not the signature was valid. Otherwise, the result of the expansion
9349 is the expansion of the third argument.
9350
9351 All three variables can be used in the expansion of the third argument.
9352 However, once the expansion is complete, only &$prvscheck_result$& remains set.
9353 For more discussion and an example, see section &<<SECTverifyPRVS>>&.
9354
9355 .vitem &*${readfile{*&<&'file&~name'&>&*}{*&<&'eol&~string'&>&*}}*&
9356 .cindex "expansion" "inserting an entire file"
9357 .cindex "file" "inserting into expansion"
9358 .cindex "&%readfile%& expansion item"
9359 The file name and end-of-line string are first expanded separately. The file is
9360 then read, and its contents replace the entire item. All newline characters in
9361 the file are replaced by the end-of-line string if it is present. Otherwise,
9362 newlines are left in the string.
9363 String expansion is not applied to the contents of the file. If you want this,
9364 you must wrap the item in an &%expand%& operator. If the file cannot be read,
9365 the string expansion fails.
9366
9367 The &(redirect)& router has an option called &%forbid_filter_readfile%& which
9368 locks out the use of this expansion item in filter files.
9369
9370
9371
9372 .vitem "&*${readsocket{*&<&'name'&>&*}{*&<&'request'&>&*}&&&
9373         {*&<&'timeout'&>&*}{*&<&'eol&~string'&>&*}{*&<&'fail&~string'&>&*}}*&"
9374 .cindex "expansion" "inserting from a socket"
9375 .cindex "socket, use of in expansion"
9376 .cindex "&%readsocket%& expansion item"
9377 This item inserts data from a Unix domain or Internet socket into the expanded
9378 string. The minimal way of using it uses just two arguments, as in these
9379 examples:
9380 .code
9381 ${readsocket{/socket/name}{request string}}
9382 ${readsocket{inet:some.host:1234}{request string}}
9383 .endd
9384 For a Unix domain socket, the first substring must be the path to the socket.
9385 For an Internet socket, the first substring must contain &`inet:`& followed by
9386 a host name or IP address, followed by a colon and a port, which can be a
9387 number or the name of a TCP port in &_/etc/services_&. An IP address may
9388 optionally be enclosed in square brackets. This is best for IPv6 addresses. For
9389 example:
9390 .code
9391 ${readsocket{inet:[::1]:1234}{request string}}
9392 .endd
9393 Only a single host name may be given, but if looking it up yields more than
9394 one IP address, they are each tried in turn until a connection is made. For
9395 both kinds of socket, Exim makes a connection, writes the request string
9396 (unless it is an empty string) and reads from the socket until an end-of-file
9397 is read. A timeout of 5 seconds is applied. Additional, optional arguments
9398 extend what can be done. Firstly, you can vary the timeout. For example:
9399 .code
9400 ${readsocket{/socket/name}{request string}{3s}}
9401 .endd
9402 A fourth argument allows you to change any newlines that are in the data
9403 that is read, in the same way as for &%readfile%& (see above). This example
9404 turns them into spaces:
9405 .code
9406 ${readsocket{inet:127.0.0.1:3294}{request string}{3s}{ }}
9407 .endd
9408 As with all expansions, the substrings are expanded before the processing
9409 happens. Errors in these sub-expansions cause the expansion to fail. In
9410 addition, the following errors can occur:
9411
9412 .ilist
9413 Failure to create a socket file descriptor;
9414 .next
9415 Failure to connect the socket;
9416 .next
9417 Failure to write the request string;
9418 .next
9419 Timeout on reading from the socket.
9420 .endlist
9421
9422 By default, any of these errors causes the expansion to fail. However, if
9423 you supply a fifth substring, it is expanded and used when any of the above
9424 errors occurs. For example:
9425 .code
9426 ${readsocket{/socket/name}{request string}{3s}{\n}\
9427   {socket failure}}
9428 .endd
9429 You can test for the existence of a Unix domain socket by wrapping this
9430 expansion in &`${if exists`&, but there is a race condition between that test
9431 and the actual opening of the socket, so it is safer to use the fifth argument
9432 if you want to be absolutely sure of avoiding an expansion error for a
9433 non-existent Unix domain socket, or a failure to connect to an Internet socket.
9434
9435 The &(redirect)& router has an option called &%forbid_filter_readsocket%& which
9436 locks out the use of this expansion item in filter files.
9437
9438
9439 .vitem &*${reduce{*&<&'string1'&>}{<&'string2'&>&*}{*&<&'string3'&>&*}}*&
9440 .cindex "expansion" "reducing a list to a scalar"
9441 .cindex "list" "reducing to a scalar"
9442 .vindex "&$value$&"
9443 .vindex "&$item$&"
9444 This operation reduces a list to a single, scalar string. After expansion,
9445 <&'string1'&> is interpreted as a list, colon-separated by default, but the
9446 separator can be changed in the usual way. Then <&'string2'&> is expanded and
9447 assigned to the &$value$& variable. After this, each item in the <&'string1'&>
9448 list is assigned to &$item$& in turn, and <&'string3'&> is expanded for each of
9449 them. The result of that expansion is assigned to &$value$& before the next
9450 iteration. When the end of the list is reached, the final value of &$value$& is
9451 added to the expansion output. The &*reduce*& expansion item can be used in a
9452 number of ways. For example, to add up a list of numbers:
9453 .code
9454 ${reduce {<, 1,2,3}{0}{${eval:$value+$item}}}
9455 .endd
9456 The result of that expansion would be &`6`&. The maximum of a list of numbers
9457 can be found:
9458 .code
9459 ${reduce {3:0:9:4:6}{0}{${if >{$item}{$value}{$item}{$value}}}}
9460 .endd
9461 At the end of a &*reduce*& expansion, the values of &$item$& and &$value$& are
9462 restored to what they were before. See also the &*filter*& and &*map*&
9463 expansion items.
9464
9465 .vitem &*$rheader_*&<&'header&~name'&>&*:*&&~or&~&*$rh_*&<&'header&~name'&>&*:*&
9466 This item inserts &"raw"& header lines. It is described with the &%header%&
9467 expansion item above.
9468
9469 .vitem "&*${run{*&<&'command'&>&*&~*&<&'args'&>&*}{*&<&'string1'&>&*}&&&
9470         {*&<&'string2'&>&*}}*&"
9471 .cindex "expansion" "running a command"
9472 .cindex "&%run%& expansion item"
9473 The command and its arguments are first expanded separately, and then the
9474 command is run in a separate process, but under the same uid and gid. As in
9475 other command executions from Exim, a shell is not used by default. If you want
9476 a shell, you must explicitly code it.
9477
9478 The standard input for the command exists, but is empty. The standard output
9479 and standard error are set to the same file descriptor.
9480 .cindex "return code" "from &%run%& expansion"
9481 .vindex "&$value$&"
9482 If the command succeeds (gives a zero return code) <&'string1'&> is expanded
9483 and replaces the entire item; during this expansion, the standard output/error
9484 from the command is in the variable &$value$&. If the command fails,
9485 <&'string2'&>, if present, is expanded and used. Once again, during the
9486 expansion, the standard output/error from the command is in the variable
9487 &$value$&.
9488
9489 If <&'string2'&> is absent, the result is empty. Alternatively, <&'string2'&>
9490 can be the word &"fail"& (not in braces) to force expansion failure if the
9491 command does not succeed. If both strings are omitted, the result is contents
9492 of the standard output/error on success, and nothing on failure.
9493
9494 .new
9495 .vindex "&$run_in_acl$&"
9496 The standard output/error of the command is put in the variable &$value$&.
9497 In this ACL example, the output of a command is logged for the admin to
9498 troubleshoot:
9499 .code
9500 warn  condition    = ${run{/usr/bin/id}{yes}{no}}
9501       log_message  = Output of id: $value
9502 .endd
9503 If the command requires shell idioms, such as the > redirect operator, the
9504 shell must be invoked directly, such as with:
9505 .code
9506 ${run{/bin/bash -c "/usr/bin/id >/tmp/id"}{yes}{yes}}
9507 .endd
9508 .wen
9509
9510 .vindex "&$runrc$&"
9511 The return code from the command is put in the variable &$runrc$&, and this
9512 remains set afterwards, so in a filter file you can do things like this:
9513 .code
9514 if "${run{x y z}{}}$runrc" is 1 then ...
9515   elif $runrc is 2 then ...
9516   ...
9517 endif
9518 .endd
9519 If execution of the command fails (for example, the command does not exist),
9520 the return code is 127 &-- the same code that shells use for non-existent
9521 commands.
9522
9523 &*Warning*&: In a router or transport, you cannot assume the order in which
9524 option values are expanded, except for those preconditions whose order of
9525 testing is documented. Therefore, you cannot reliably expect to set &$runrc$&
9526 by the expansion of one option, and use it in another.
9527
9528 The &(redirect)& router has an option called &%forbid_filter_run%& which locks
9529 out the use of this expansion item in filter files.
9530
9531
9532 .vitem &*${sg{*&<&'subject'&>&*}{*&<&'regex'&>&*}{*&<&'replacement'&>&*}}*&
9533 .cindex "expansion" "string substitution"
9534 .cindex "&%sg%& expansion item"
9535 This item works like Perl's substitution operator (s) with the global (/g)
9536 option; hence its name. However, unlike the Perl equivalent, Exim does not
9537 modify the subject string; instead it returns the modified string for insertion
9538 into the overall expansion. The item takes three arguments: the subject string,
9539 a regular expression, and a substitution string. For example:
9540 .code
9541 ${sg{abcdefabcdef}{abc}{xyz}}
9542 .endd
9543 yields &"xyzdefxyzdef"&. Because all three arguments are expanded before use,
9544 if any $ or \ characters are required in the regular expression or in the
9545 substitution string, they have to be escaped. For example:
9546 .code
9547 ${sg{abcdef}{^(...)(...)\$}{\$2\$1}}
9548 .endd
9549 yields &"defabc"&, and
9550 .code
9551 ${sg{1=A 4=D 3=C}{\N(\d+)=\N}{K\$1=}}
9552 .endd
9553 yields &"K1=A K4=D K3=C"&. Note the use of &`\N`& to protect the contents of
9554 the regular expression from string expansion.
9555
9556
9557
9558 .vitem &*${substr{*&<&'string1'&>&*}{*&<&'string2'&>&*}{*&<&'string3'&>&*}}*&
9559 .cindex "&%substr%& expansion item"
9560 .cindex "substring extraction"
9561 .cindex "expansion" "substring extraction"
9562 The three strings are expanded; the first two must yield numbers. Call them
9563 <&'n'&> and <&'m'&>. If you are using fixed values for these numbers, that is,
9564 if <&'string1'&> and <&'string2'&> do not change when they are expanded, you
9565 can use the simpler operator notation that avoids some of the braces:
9566 .code
9567 ${substr_<n>_<m>:<string>}
9568 .endd
9569 The second number is optional (in both notations).
9570 If it is absent in the simpler format, the preceding underscore must also be
9571 omitted.
9572
9573 The &%substr%& item can be used to extract more general substrings than
9574 &%length%&. The first number, <&'n'&>, is a starting offset, and <&'m'&> is the
9575 length required. For example
9576 .code
9577 ${substr{3}{2}{$local_part}}
9578 .endd
9579 If the starting offset is greater than the string length the result is the
9580 null string; if the length plus starting offset is greater than the string
9581 length, the result is the right-hand part of the string, starting from the
9582 given offset. The first character in the string has offset zero.
9583
9584 The &%substr%& expansion item can take negative offset values to count
9585 from the right-hand end of its operand. The last character is offset -1, the
9586 second-last is offset -2, and so on. Thus, for example,
9587 .code
9588 ${substr{-5}{2}{1234567}}
9589 .endd
9590 yields &"34"&. If the absolute value of a negative offset is greater than the
9591 length of the string, the substring starts at the beginning of the string, and
9592 the length is reduced by the amount of overshoot. Thus, for example,
9593 .code
9594 ${substr{-5}{2}{12}}
9595 .endd
9596 yields an empty string, but
9597 .code
9598 ${substr{-3}{2}{12}}
9599 .endd
9600 yields &"1"&.
9601
9602 When the second number is omitted from &%substr%&, the remainder of the string
9603 is taken if the offset is positive. If it is negative, all characters in the
9604 string preceding the offset point are taken. For example, an offset of -1 and
9605 no length, as in these semantically identical examples:
9606 .code
9607 ${substr_-1:abcde}
9608 ${substr{-1}{abcde}}
9609 .endd
9610 yields all but the last character of the string, that is, &"abcd"&.
9611
9612
9613
9614 .vitem "&*${tr{*&<&'subject'&>&*}{*&<&'characters'&>&*}&&&
9615         {*&<&'replacements'&>&*}}*&"
9616 .cindex "expansion" "character translation"
9617 .cindex "&%tr%& expansion item"
9618 This item does single-character translation on its subject string. The second
9619 argument is a list of characters to be translated in the subject string. Each
9620 matching character is replaced by the corresponding character from the
9621 replacement list. For example
9622 .code
9623 ${tr{abcdea}{ac}{13}}
9624 .endd
9625 yields &`1b3de1`&. If there are duplicates in the second character string, the
9626 last occurrence is used. If the third string is shorter than the second, its
9627 last character is replicated. However, if it is empty, no translation takes
9628 place.
9629 .endlist
9630
9631
9632
9633 .section "Expansion operators" "SECTexpop"
9634 .cindex "expansion" "operators"
9635 For expansion items that perform transformations on a single argument string,
9636 the &"operator"& notation is used because it is simpler and uses fewer braces.
9637 The substring is first expanded before the operation is applied to it. The
9638 following operations can be performed:
9639
9640 .vlist
9641 .vitem &*${address:*&<&'string'&>&*}*&
9642 .cindex "expansion" "RFC 2822 address handling"
9643 .cindex "&%address%& expansion item"
9644 The string is interpreted as an RFC 2822 address, as it might appear in a
9645 header line, and the effective address is extracted from it. If the string does
9646 not parse successfully, the result is empty.
9647
9648
9649 .vitem &*${addresses:*&<&'string'&>&*}*&
9650 .cindex "expansion" "RFC 2822 address handling"
9651 .cindex "&%addresses%& expansion item"
9652 The string (after expansion) is interpreted as a list of addresses in RFC
9653 2822 format, such as can be found in a &'To:'& or &'Cc:'& header line. The
9654 operative address (&'local-part@domain'&) is extracted from each item, and the
9655 result of the expansion is a colon-separated list, with appropriate
9656 doubling of colons should any happen to be present in the email addresses.
9657 Syntactically invalid RFC2822 address items are omitted from the output.
9658
9659 It is possible to specify a character other than colon for the output
9660 separator by starting the string with > followed by the new separator
9661 character. For example:
9662 .code
9663 ${addresses:>& Chief <ceo@up.stairs>, sec@base.ment (dogsbody)}
9664 .endd
9665 expands to &`ceo@up.stairs&&sec@base.ment`&. Compare the &*address*& (singular)
9666 expansion item, which extracts the working address from a single RFC2822
9667 address. See the &*filter*&, &*map*&, and &*reduce*& items for ways of
9668 processing lists.
9669
9670 .new
9671 To clarify "list of addresses in RFC 2822 format" mentioned above, Exim follows
9672 a strict interpretation of header line formatting.  Exim parses the bare,
9673 unquoted portion of an email address and if it finds a comma, treats it as an
9674 email address seperator. For the example header line:
9675 .code
9676 From: =?iso-8859-2?Q?Last=2C_First?= <user@example.com>
9677 .endd
9678 The first example below demonstrates that Q-encoded email addresses are parsed
9679 properly if it is given the raw header (in this example, &`$rheader_from:`&).
9680 It does not see the comma because it's still encoded as "=2C".  The second
9681 example below is passed the contents of &`$header_from:`&, meaning it gets
9682 de-mimed. Exim sees the decoded "," so it treats it as &*two*& email addresses.
9683 The third example shows that the presence of a comma is skipped when it is
9684 quoted.
9685 .code
9686 # exim -be '${addresses:From: \
9687 =?iso-8859-2?Q?Last=2C_First?= <user@example.com>}'
9688 user@example.com
9689 # exim -be '${addresses:From: Last, First <user@example.com>}'
9690 Last:user@example.com
9691 # exim -be '${addresses:From: "Last, First" <user@example.com>}'
9692 user@example.com
9693 .endd
9694 .wen
9695
9696 .vitem &*${base62:*&<&'digits'&>&*}*&
9697 .cindex "&%base62%& expansion item"
9698 .cindex "expansion" "conversion to base 62"
9699 The string must consist entirely of decimal digits. The number is converted to
9700 base 62 and output as a string of six characters, including leading zeros. In
9701 the few operating environments where Exim uses base 36 instead of base 62 for
9702 its message identifiers (because those systems do not have case-sensitive file
9703 names), base 36 is used by this operator, despite its name. &*Note*&: Just to
9704 be absolutely clear: this is &'not'& base64 encoding.
9705
9706 .vitem &*${base62d:*&<&'base-62&~digits'&>&*}*&
9707 .cindex "&%base62d%& expansion item"
9708 .cindex "expansion" "conversion to base 62"
9709 The string must consist entirely of base-62 digits, or, in operating
9710 environments where Exim uses base 36 instead of base 62 for its message
9711 identifiers, base-36 digits. The number is converted to decimal and output as a
9712 string.
9713
9714
9715 .vitem &*${domain:*&<&'string'&>&*}*&
9716 .cindex "domain" "extraction"
9717 .cindex "expansion" "domain extraction"
9718 The string is interpreted as an RFC 2822 address and the domain is extracted
9719 from it. If the string does not parse successfully, the result is empty.
9720
9721
9722 .vitem &*${escape:*&<&'string'&>&*}*&
9723 .cindex "expansion" "escaping non-printing characters"
9724 .cindex "&%escape%& expansion item"
9725 If the string contains any non-printing characters, they are converted to
9726 escape sequences starting with a backslash. Whether characters with the most
9727 significant bit set (so-called &"8-bit characters"&) count as printing or not
9728 is controlled by the &%print_topbitchars%& option.
9729
9730
9731 .vitem &*${eval:*&<&'string'&>&*}*&&~and&~&*${eval10:*&<&'string'&>&*}*&
9732 .cindex "expansion" "expression evaluation"
9733 .cindex "expansion" "arithmetic expression"
9734 .cindex "&%eval%& expansion item"
9735 These items supports simple arithmetic and bitwise logical operations in
9736 expansion strings. The string (after expansion) must be a conventional
9737 arithmetic expression, but it is limited to basic arithmetic operators, bitwise
9738 logical operators, and parentheses. All operations are carried out using
9739 integer arithmetic. The operator priorities are as follows (the same as in the
9740 C programming language):
9741 .table2 70pt 300pt
9742 .irow &'highest:'& "not (~), negate (-)"
9743 .irow ""   "multiply (*), divide (/), remainder (%)"
9744 .irow ""   "plus (+), minus (-)"
9745 .irow ""   "shift-left (<<), shift-right (>>)"
9746 .irow ""   "and (&&)"
9747 .irow ""   "xor (^)"
9748 .irow &'lowest:'&  "or (|)"
9749 .endtable
9750 Binary operators with the same priority are evaluated from left to right. White
9751 space is permitted before or after operators.
9752
9753 For &%eval%&, numbers may be decimal, octal (starting with &"0"&) or
9754 hexadecimal (starting with &"0x"&). For &%eval10%&, all numbers are taken as
9755 decimal, even if they start with a leading zero; hexadecimal numbers are not
9756 permitted. This can be useful when processing numbers extracted from dates or
9757 times, which often do have leading zeros.
9758
9759 A number may be followed by &"K"&, &"M"& or &"G"& to multiply it by 1024, 1024*1024
9760 or 1024*1024*1024,
9761 respectively. Negative numbers are supported. The result of the computation is
9762 a decimal representation of the answer (without &"K"&, &"M"& or &"G"&). For example:
9763
9764 .display
9765 &`${eval:1+1}            `&  yields 2
9766 &`${eval:1+2*3}          `&  yields 7
9767 &`${eval:(1+2)*3}        `&  yields 9
9768 &`${eval:2+42%5}         `&  yields 4
9769 &`${eval:0xc&amp;5}          `&  yields 4
9770 &`${eval:0xc|5}          `&  yields 13
9771 &`${eval:0xc^5}          `&  yields 9
9772 &`${eval:0xc>>1}         `&  yields 6
9773 &`${eval:0xc<<1}         `&  yields 24
9774 &`${eval:~255&amp;0x1234}    `&  yields 4608
9775 &`${eval:-(~255&amp;0x1234)} `&  yields -4608
9776 .endd
9777
9778 As a more realistic example, in an ACL you might have
9779 .code
9780 deny   message = Too many bad recipients
9781        condition =                    \
9782          ${if and {                   \
9783            {>{$rcpt_count}{10}}       \
9784            {                          \
9785            <                          \
9786              {$recipients_count}      \
9787              {${eval:$rcpt_count/2}}  \
9788            }                          \
9789          }{yes}{no}}
9790 .endd
9791 The condition is true if there have been more than 10 RCPT commands and
9792 fewer than half of them have resulted in a valid recipient.
9793
9794
9795 .vitem &*${expand:*&<&'string'&>&*}*&
9796 .cindex "expansion" "re-expansion of substring"
9797 The &%expand%& operator causes a string to be expanded for a second time. For
9798 example,
9799 .code
9800 ${expand:${lookup{$domain}dbm{/some/file}{$value}}}
9801 .endd
9802 first looks up a string in a file while expanding the operand for &%expand%&,
9803 and then re-expands what it has found.
9804
9805
9806 .vitem &*${from_utf8:*&<&'string'&>&*}*&
9807 .cindex "Unicode"
9808 .cindex "UTF-8" "conversion from"
9809 .cindex "expansion" "UTF-8 conversion"
9810 .cindex "&%from_utf8%& expansion item"
9811 The world is slowly moving towards Unicode, although there are no standards for
9812 email yet. However, other applications (including some databases) are starting
9813 to store data in Unicode, using UTF-8 encoding. This operator converts from a
9814 UTF-8 string to an ISO-8859-1 string. UTF-8 code values greater than 255 are
9815 converted to underscores. The input must be a valid UTF-8 string. If it is not,
9816 the result is an undefined sequence of bytes.
9817
9818 Unicode code points with values less than 256 are compatible with ASCII and
9819 ISO-8859-1 (also known as Latin-1).
9820 For example, character 169 is the copyright symbol in both cases, though the
9821 way it is encoded is different. In UTF-8, more than one byte is needed for
9822 characters with code values greater than 127, whereas ISO-8859-1 is a
9823 single-byte encoding (but thereby limited to 256 characters). This makes
9824 translation from UTF-8 to ISO-8859-1 straightforward.
9825
9826
9827 .vitem &*${hash_*&<&'n'&>&*_*&<&'m'&>&*:*&<&'string'&>&*}*&
9828 .cindex "hash function" "textual"
9829 .cindex "expansion" "textual hash"
9830 The &%hash%& operator is a simpler interface to the hashing function that can
9831 be used when the two parameters are fixed numbers (as opposed to strings that
9832 change when expanded). The effect is the same as
9833 .code
9834 ${hash{<n>}{<m>}{<string>}}
9835 .endd
9836 See the description of the general &%hash%& item above for details. The
9837 abbreviation &%h%& can be used when &%hash%& is used as an operator.
9838
9839
9840
9841 .vitem &*${hex2b64:*&<&'hexstring'&>&*}*&
9842 .cindex "base64 encoding" "conversion from hex"
9843 .cindex "expansion" "hex to base64"
9844 .cindex "&%hex2b64%& expansion item"
9845 This operator converts a hex string into one that is base64 encoded. This can
9846 be useful for processing the output of the MD5 and SHA-1 hashing functions.
9847
9848
9849
9850 .new
9851 .vitem &*${hexquote:*&<&'string'&>&*}*&
9852 .cindex "quoting" "hex-encoded unprintable characters"
9853 .cindex "&%hexquote%& expansion item"
9854 This operator converts non-printable characters in a string into a hex
9855 escape form. Byte values between 33 (!) and 126 (~) inclusive are left
9856 as is, and other byte values are converted to &`\xNN`&, for example a
9857 byte value 127 is converted to &`\x7f`&.
9858 .wen
9859
9860
9861 .vitem &*${lc:*&<&'string'&>&*}*&
9862 .cindex "case forcing in strings"
9863 .cindex "string" "case forcing"
9864 .cindex "lower casing"
9865 .cindex "expansion" "case forcing"
9866 .cindex "&%lc%& expansion item"
9867 This forces the letters in the string into lower-case, for example:
9868 .code
9869 ${lc:$local_part}
9870 .endd
9871
9872 .vitem &*${length_*&<&'number'&>&*:*&<&'string'&>&*}*&
9873 .cindex "expansion" "string truncation"
9874 .cindex "&%length%& expansion item"
9875 The &%length%& operator is a simpler interface to the &%length%& function that
9876 can be used when the parameter is a fixed number (as opposed to a string that
9877 changes when expanded). The effect is the same as
9878 .code
9879 ${length{<number>}{<string>}}
9880 .endd
9881 See the description of the general &%length%& item above for details. Note that
9882 &%length%& is not the same as &%strlen%&. The abbreviation &%l%& can be used
9883 when &%length%& is used as an operator.
9884
9885
9886 .new
9887 .vitem &*${listcount:*&<&'string'&>&*}*&
9888 .cindex "expansion" "list item count"
9889 .cindex "list" "item count"
9890 .cindex "list" "count of items"
9891 .cindex "&%listcount%& expansion item"
9892 The string is interpreted as a list and the number of items is returned.
9893
9894
9895 .vitem &*${listnamed:*&<&'name'&>&*}*&&~and&~&*${listnamed_*&<&'type'&>&*:*&<&'name'&>&*}*&
9896 .cindex "expansion" "named list"
9897 .cindex "&%listnamed%& expansion item"
9898 The name is interpreted as a named list and the content of the list is returned,
9899 expanding any referenced lists, re-quoting as needed for colon-separation.
9900 If the optional type is given it must be one of "a", "d", "h" or "l"
9901 and selects address-, domain-, host- or localpart- lists to search among respectively.
9902 Otherwise all types are searched in an undefined order and the first
9903 matching list is returned.
9904 .wen
9905
9906
9907 .vitem &*${local_part:*&<&'string'&>&*}*&
9908 .cindex "expansion" "local part extraction"
9909 .cindex "&%local_part%& expansion item"
9910 The string is interpreted as an RFC 2822 address and the local part is
9911 extracted from it. If the string does not parse successfully, the result is
9912 empty.
9913
9914
9915 .vitem &*${mask:*&<&'IP&~address'&>&*/*&<&'bit&~count'&>&*}*&
9916 .cindex "masked IP address"
9917 .cindex "IP address" "masking"
9918 .cindex "CIDR notation"
9919 .cindex "expansion" "IP address masking"
9920 .cindex "&%mask%& expansion item"
9921 If the form of the string to be operated on is not an IP address followed by a
9922 slash and an integer (that is, a network address in CIDR notation), the
9923 expansion fails. Otherwise, this operator converts the IP address to binary,
9924 masks off the least significant bits according to the bit count, and converts
9925 the result back to text, with mask appended. For example,
9926 .code
9927 ${mask:10.111.131.206/28}
9928 .endd
9929 returns the string &"10.111.131.192/28"&. Since this operation is expected to
9930 be mostly used for looking up masked addresses in files, the result for an IPv6
9931 address uses dots to separate components instead of colons, because colon
9932 terminates a key string in lsearch files. So, for example,
9933 .code
9934 ${mask:3ffe:ffff:836f:0a00:000a:0800:200a:c031/99}
9935 .endd
9936 returns the string
9937 .code
9938 3ffe.ffff.836f.0a00.000a.0800.2000.0000/99
9939 .endd
9940 Letters in IPv6 addresses are always output in lower case.
9941
9942
9943 .vitem &*${md5:*&<&'string'&>&*}*&
9944 .cindex "MD5 hash"
9945 .cindex "expansion" "MD5 hash"
9946 .cindex "&%md5%& expansion item"
9947 The &%md5%& operator computes the MD5 hash value of the string, and returns it
9948 as a 32-digit hexadecimal number, in which any letters are in lower case.
9949
9950
9951 .vitem &*${nhash_*&<&'n'&>&*_*&<&'m'&>&*:*&<&'string'&>&*}*&
9952 .cindex "expansion" "numeric hash"
9953 .cindex "hash function" "numeric"
9954 The &%nhash%& operator is a simpler interface to the numeric hashing function
9955 that can be used when the two parameters are fixed numbers (as opposed to
9956 strings that change when expanded). The effect is the same as
9957 .code
9958 ${nhash{<n>}{<m>}{<string>}}
9959 .endd
9960 See the description of the general &%nhash%& item above for details.
9961
9962
9963 .vitem &*${quote:*&<&'string'&>&*}*&
9964 .cindex "quoting" "in string expansions"
9965 .cindex "expansion" "quoting"
9966 .cindex "&%quote%& expansion item"
9967 The &%quote%& operator puts its argument into double quotes if it
9968 is an empty string or
9969 contains anything other than letters, digits, underscores, dots, and hyphens.
9970 Any occurrences of double quotes and backslashes are escaped with a backslash.
9971 Newlines and carriage returns are converted to &`\n`& and &`\r`&,
9972 respectively For example,
9973 .code
9974 ${quote:ab"*"cd}
9975 .endd
9976 becomes
9977 .code
9978 "ab\"*\"cd"
9979 .endd
9980 The place where this is useful is when the argument is a substitution from a
9981 variable or a message header.
9982
9983 .vitem &*${quote_local_part:*&<&'string'&>&*}*&
9984 .cindex "&%quote_local_part%& expansion item"
9985 This operator is like &%quote%&, except that it quotes the string only if
9986 required to do so by the rules of RFC 2822 for quoting local parts. For
9987 example, a plus sign would not cause quoting (but it would for &%quote%&).
9988 If you are creating a new email address from the contents of &$local_part$&
9989 (or any other unknown data), you should always use this operator.
9990
9991
9992 .vitem &*${quote_*&<&'lookup-type'&>&*:*&<&'string'&>&*}*&
9993 .cindex "quoting" "lookup-specific"
9994 This operator applies lookup-specific quoting rules to the string. Each
9995 query-style lookup type has its own quoting rules which are described with
9996 the lookups in chapter &<<CHAPfdlookup>>&. For example,
9997 .code
9998 ${quote_ldap:two * two}
9999 .endd
10000 returns
10001 .code
10002 two%20%5C2A%20two
10003 .endd
10004 For single-key lookup types, no quoting is ever necessary and this operator
10005 yields an unchanged string.
10006
10007
10008 .vitem &*${randint:*&<&'n'&>&*}*&
10009 .cindex "random number"
10010 This operator returns a somewhat random number which is less than the
10011 supplied number and is at least 0.  The quality of this randomness depends
10012 on how Exim was built; the values are not suitable for keying material.
10013 If Exim is linked against OpenSSL then RAND_pseudo_bytes() is used.
10014 If Exim is linked against GnuTLS then gnutls_rnd(GNUTLS_RND_NONCE) is used,
10015 for versions of GnuTLS with that function.
10016 Otherwise, the implementation may be arc4random(), random() seeded by
10017 srandomdev() or srandom(), or a custom implementation even weaker than
10018 random().
10019
10020
10021 .vitem &*${reverse_ip:*&<&'ipaddr'&>&*}*&
10022 .cindex "expansion" "IP address"
10023 This operator reverses an IP address; for IPv4 addresses, the result is in
10024 dotted-quad decimal form, while for IPv6 addreses the result is in
10025 dotted-nibble hexadecimal form.  In both cases, this is the "natural" form
10026 for DNS.  For example,
10027 .code
10028 ${reverse_ip:192.0.2.4}
10029 ${reverse_ip:2001:0db8:c42:9:1:abcd:192.0.2.127}
10030 .endd
10031 returns
10032 .code
10033 4.2.0.192
10034 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
10035 .endd
10036
10037
10038 .vitem &*${rfc2047:*&<&'string'&>&*}*&
10039 .cindex "expansion" "RFC 2047"
10040 .cindex "RFC 2047" "expansion operator"
10041 .cindex "&%rfc2047%& expansion item"
10042 This operator encodes text according to the rules of RFC 2047. This is an
10043 encoding that is used in header lines to encode non-ASCII characters. It is
10044 assumed that the input string is in the encoding specified by the
10045 &%headers_charset%& option, which defaults to ISO-8859-1. If the string
10046 contains only characters in the range 33&--126, and no instances of the
10047 characters
10048 .code
10049 ? = ( ) < > @ , ; : \ " . [ ] _
10050 .endd
10051 it is not modified. Otherwise, the result is the RFC 2047 encoding of the
10052 string, using as many &"encoded words"& as necessary to encode all the
10053 characters.
10054
10055
10056 .vitem &*${rfc2047d:*&<&'string'&>&*}*&
10057 .cindex "expansion" "RFC 2047"
10058 .cindex "RFC 2047" "decoding"
10059 .cindex "&%rfc2047d%& expansion item"
10060 This operator decodes strings that are encoded as per RFC 2047. Binary zero
10061 bytes are replaced by question marks. Characters are converted into the
10062 character set defined by &%headers_charset%&. Overlong RFC 2047 &"words"& are
10063 not recognized unless &%check_rfc2047_length%& is set false.
10064
10065 &*Note*&: If you use &%$header%&_&'xxx'&&*:*& (or &%$h%&_&'xxx'&&*:*&) to
10066 access a header line, RFC 2047 decoding is done automatically. You do not need
10067 to use this operator as well.
10068
10069
10070
10071 .vitem &*${rxquote:*&<&'string'&>&*}*&
10072 .cindex "quoting" "in regular expressions"
10073 .cindex "regular expressions" "quoting"
10074 .cindex "&%rxquote%& expansion item"
10075 The &%rxquote%& operator inserts a backslash before any non-alphanumeric
10076 characters in its argument. This is useful when substituting the values of
10077 variables or headers inside regular expressions.
10078
10079
10080 .vitem &*${sha1:*&<&'string'&>&*}*&
10081 .cindex "SHA-1 hash"
10082 .cindex "expansion" "SHA-1 hashing"
10083 .cindex "&%sha2%& expansion item"
10084 The &%sha1%& operator computes the SHA-1 hash value of the string, and returns
10085 it as a 40-digit hexadecimal number, in which any letters are in upper case.
10086
10087
10088 .vitem &*${stat:*&<&'string'&>&*}*&
10089 .cindex "expansion" "statting a file"
10090 .cindex "file" "extracting characteristics"
10091 .cindex "&%stat%& expansion item"
10092 The string, after expansion, must be a file path. A call to the &[stat()]&
10093 function is made for this path. If &[stat()]& fails, an error occurs and the
10094 expansion fails. If it succeeds, the data from the stat replaces the item, as a
10095 series of <&'name'&>=<&'value'&> pairs, where the values are all numerical,
10096 except for the value of &"smode"&. The names are: &"mode"& (giving the mode as
10097 a 4-digit octal number), &"smode"& (giving the mode in symbolic format as a
10098 10-character string, as for the &'ls'& command), &"inode"&, &"device"&,
10099 &"links"&, &"uid"&, &"gid"&, &"size"&, &"atime"&, &"mtime"&, and &"ctime"&. You
10100 can extract individual fields using the &%extract%& expansion item.
10101
10102 The use of the &%stat%& expansion in users' filter files can be locked out by
10103 the system administrator. &*Warning*&: The file size may be incorrect on 32-bit
10104 systems for files larger than 2GB.
10105
10106 .vitem &*${str2b64:*&<&'string'&>&*}*&
10107 .cindex "expansion" "base64 encoding"
10108 .cindex "base64 encoding" "in string expansion"
10109 .cindex "&%str2b64%& expansion item"
10110 This operator converts a string into one that is base64 encoded.
10111
10112
10113
10114 .vitem &*${strlen:*&<&'string'&>&*}*&
10115 .cindex "expansion" "string length"
10116 .cindex "string" "length in expansion"
10117 .cindex "&%strlen%& expansion item"
10118 The item is replace by the length of the expanded string, expressed as a
10119 decimal number. &*Note*&: Do not confuse &%strlen%& with &%length%&.
10120
10121
10122 .vitem &*${substr_*&<&'start'&>&*_*&<&'length'&>&*:*&<&'string'&>&*}*&
10123 .cindex "&%substr%& expansion item"
10124 .cindex "substring extraction"
10125 .cindex "expansion" "substring expansion"
10126 The &%substr%& operator is a simpler interface to the &%substr%& function that
10127 can be used when the two parameters are fixed numbers (as opposed to strings
10128 that change when expanded). The effect is the same as
10129 .code
10130 ${substr{<start>}{<length>}{<string>}}
10131 .endd
10132 See the description of the general &%substr%& item above for details. The
10133 abbreviation &%s%& can be used when &%substr%& is used as an operator.
10134
10135 .vitem &*${time_eval:*&<&'string'&>&*}*&
10136 .cindex "&%time_eval%& expansion item"
10137 .cindex "time interval" "decoding"
10138 This item converts an Exim time interval such as &`2d4h5m`& into a number of
10139 seconds.
10140
10141 .vitem &*${time_interval:*&<&'string'&>&*}*&
10142 .cindex "&%time_interval%& expansion item"
10143 .cindex "time interval" "formatting"
10144 The argument (after sub-expansion) must be a sequence of decimal digits that
10145 represents an interval of time as a number of seconds. It is converted into a
10146 number of larger units and output in Exim's normal time format, for example,
10147 &`1w3d4h2m6s`&.
10148
10149 .vitem &*${uc:*&<&'string'&>&*}*&
10150 .cindex "case forcing in strings"
10151 .cindex "string" "case forcing"
10152 .cindex "upper casing"
10153 .cindex "expansion" "case forcing"
10154 .cindex "&%uc%& expansion item"
10155 This forces the letters in the string into upper-case.
10156 .endlist
10157
10158
10159
10160
10161
10162
10163 .section "Expansion conditions" "SECTexpcond"
10164 .scindex IIDexpcond "expansion" "conditions"
10165 The following conditions are available for testing by the &%${if%& construct
10166 while expanding strings:
10167
10168 .vlist
10169 .vitem &*!*&<&'condition'&>
10170 .cindex "expansion" "negating a condition"
10171 .cindex "negation" "in expansion condition"
10172 Preceding any condition with an exclamation mark negates the result of the
10173 condition.
10174
10175 .vitem <&'symbolic&~operator'&>&~&*{*&<&'string1'&>&*}{*&<&'string2'&>&*}*&
10176 .cindex "numeric comparison"
10177 .cindex "expansion" "numeric comparison"
10178 There are a number of symbolic operators for doing numeric comparisons. They
10179 are:
10180 .display
10181 &`=   `&   equal
10182 &`==  `&   equal
10183 &`>   `&   greater
10184 &`>=  `&   greater or equal
10185 &`<   `&   less
10186 &`<=  `&   less or equal
10187 .endd
10188 For example:
10189 .code
10190 ${if >{$message_size}{10M} ...
10191 .endd
10192 Note that the general negation operator provides for inequality testing. The
10193 two strings must take the form of optionally signed decimal integers,
10194 optionally followed by one of the letters &"K"&, &"M"& or &"G"& (in either upper or
10195 lower case), signifying multiplication by 1024, 1024*1024 or 1024*1024*1024, respectively.
10196 As a special case, the numerical value of an empty string is taken as
10197 zero.
10198
10199 In all cases, a relative comparator OP is testing if <&'string1'&> OP
10200 <&'string2'&>; the above example is checking if &$message_size$& is larger than
10201 10M, not if 10M is larger than &$message_size$&.
10202
10203
10204 .new
10205 .vitem &*acl&~{{*&<&'name'&>&*}{*&<&'arg1'&>&*}&&&
10206         {*&<&'arg2'&>&*}...}*&
10207 .cindex "expansion" "calling an acl"
10208 .cindex "&%acl%&" "expansion condition"
10209 The name and zero to nine argument strings are first expanded separately.  The expanded
10210 arguments are assigned to the variables &$acl_arg1$& to &$acl_arg9$& in order.
10211 Any unused are made empty.  The variable &$acl_narg$& is set to the number of
10212 arguments.  The named ACL (see chapter &<<CHAPACL>>&) is called
10213 and may use the variables; if another acl expansion is used the values
10214 are restored after it returns.  If the ACL sets
10215 a value using a "message =" modifier the variable $value becomes
10216 the result of the expansion, otherwise it is empty.
10217 If the ACL returns accept the condition is true; if deny, false.
10218 If the ACL returns defer the result is a forced-fail.
10219 .wen
10220
10221 .vitem &*bool&~{*&<&'string'&>&*}*&
10222 .cindex "expansion" "boolean parsing"
10223 .cindex "&%bool%& expansion condition"
10224 This condition turns a string holding a true or false representation into
10225 a boolean state.  It parses &"true"&, &"false"&, &"yes"& and &"no"&
10226 (case-insensitively); also positive integer numbers map to true if non-zero,
10227 false if zero.
10228 An empty string is treated as false.
10229 Leading and trailing whitespace is ignored;
10230 thus a string consisting only of whitespace is false.
10231 All other string values will result in expansion failure.
10232
10233 When combined with ACL variables, this expansion condition will let you
10234 make decisions in one place and act on those decisions in another place.
10235 For example:
10236 .code
10237 ${if bool{$acl_m_privileged_sender} ...
10238 .endd
10239
10240
10241 .vitem &*bool_lax&~{*&<&'string'&>&*}*&
10242 .cindex "expansion" "boolean parsing"
10243 .cindex "&%bool_lax%& expansion condition"
10244 Like &%bool%&, this condition turns a string into a boolean state.  But
10245 where &%bool%& accepts a strict set of strings, &%bool_lax%& uses the same
10246 loose definition that the Router &%condition%& option uses.  The empty string
10247 and the values &"false"&, &"no"& and &"0"& map to false, all others map to
10248 true.  Leading and trailing whitespace is ignored.
10249
10250 Note that where &"bool{00}"& is false, &"bool_lax{00}"& is true.
10251
10252 .vitem &*crypteq&~{*&<&'string1'&>&*}{*&<&'string2'&>&*}*&
10253 .cindex "expansion" "encrypted comparison"
10254 .cindex "encrypted strings, comparing"
10255 .cindex "&%crypteq%& expansion condition"
10256 This condition is included in the Exim binary if it is built to support any
10257 authentication mechanisms (see chapter &<<CHAPSMTPAUTH>>&). Otherwise, it is
10258 necessary to define SUPPORT_CRYPTEQ in &_Local/Makefile_& to get &%crypteq%&
10259 included in the binary.
10260
10261 The &%crypteq%& condition has two arguments. The first is encrypted and
10262 compared against the second, which is already encrypted. The second string may
10263 be in the LDAP form for storing encrypted strings, which starts with the
10264 encryption type in curly brackets, followed by the data. If the second string
10265 does not begin with &"{"& it is assumed to be encrypted with &[crypt()]& or
10266 &[crypt16()]& (see below), since such strings cannot begin with &"{"&.
10267 Typically this will be a field from a password file. An example of an encrypted
10268 string in LDAP form is:
10269 .code
10270 {md5}CY9rzUYh03PK3k6DJie09g==
10271 .endd
10272 If such a string appears directly in an expansion, the curly brackets have to
10273 be quoted, because they are part of the expansion syntax. For example:
10274 .code
10275 ${if crypteq {test}{\{md5\}CY9rzUYh03PK3k6DJie09g==}{yes}{no}}
10276 .endd
10277 The following encryption types (whose names are matched case-independently) are
10278 supported:
10279
10280 .ilist
10281 .cindex "MD5 hash"
10282 .cindex "base64 encoding" "in encrypted password"
10283 &%{md5}%& computes the MD5 digest of the first string, and expresses this as
10284 printable characters to compare with the remainder of the second string. If the
10285 length of the comparison string is 24, Exim assumes that it is base64 encoded
10286 (as in the above example). If the length is 32, Exim assumes that it is a
10287 hexadecimal encoding of the MD5 digest. If the length not 24 or 32, the
10288 comparison fails.
10289
10290 .next
10291 .cindex "SHA-1 hash"
10292 &%{sha1}%& computes the SHA-1 digest of the first string, and expresses this as
10293 printable characters to compare with the remainder of the second string. If the
10294 length of the comparison string is 28, Exim assumes that it is base64 encoded.
10295 If the length is 40, Exim assumes that it is a hexadecimal encoding of the
10296 SHA-1 digest. If the length is not 28 or 40, the comparison fails.
10297
10298 .next
10299 .cindex "&[crypt()]&"
10300 &%{crypt}%& calls the &[crypt()]& function, which traditionally used to use
10301 only the first eight characters of the password. However, in modern operating
10302 systems this is no longer true, and in many cases the entire password is used,
10303 whatever its length.
10304
10305 .next
10306 .cindex "&[crypt16()]&"
10307 &%{crypt16}%& calls the &[crypt16()]& function, which was originally created to
10308 use up to 16 characters of the password in some operating systems. Again, in
10309 modern operating systems, more characters may be used.
10310 .endlist
10311 Exim has its own version of &[crypt16()]&, which is just a double call to
10312 &[crypt()]&. For operating systems that have their own version, setting
10313 HAVE_CRYPT16 in &_Local/Makefile_& when building Exim causes it to use the
10314 operating system version instead of its own. This option is set by default in
10315 the OS-dependent &_Makefile_& for those operating systems that are known to
10316 support &[crypt16()]&.
10317
10318 Some years after Exim's &[crypt16()]& was implemented, a user discovered that
10319 it was not using the same algorithm as some operating systems' versions. It
10320 turns out that as well as &[crypt16()]& there is a function called
10321 &[bigcrypt()]& in some operating systems. This may or may not use the same
10322 algorithm, and both of them may be different to Exim's built-in &[crypt16()]&.
10323
10324 However, since there is now a move away from the traditional &[crypt()]&
10325 functions towards using SHA1 and other algorithms, tidying up this area of
10326 Exim is seen as very low priority.
10327
10328 If you do not put a encryption type (in curly brackets) in a &%crypteq%&
10329 comparison, the default is usually either &`{crypt}`& or &`{crypt16}`&, as
10330 determined by the setting of DEFAULT_CRYPT in &_Local/Makefile_&. The default
10331 default is &`{crypt}`&. Whatever the default, you can always use either
10332 function by specifying it explicitly in curly brackets.
10333
10334 .vitem &*def:*&<&'variable&~name'&>
10335 .cindex "expansion" "checking for empty variable"
10336 .cindex "&%def%& expansion condition"
10337 The &%def%& condition must be followed by the name of one of the expansion
10338 variables defined in section &<<SECTexpvar>>&. The condition is true if the
10339 variable does not contain the empty string. For example:
10340 .code
10341 ${if def:sender_ident {from $sender_ident}}
10342 .endd
10343 Note that the variable name is given without a leading &%$%& character. If the
10344 variable does not exist, the expansion fails.
10345
10346 .vitem "&*def:header_*&<&'header&~name'&>&*:*&&~&~or&~&&&
10347         &~&*def:h_*&<&'header&~name'&>&*:*&"
10348 .cindex "expansion" "checking header line existence"
10349 This condition is true if a message is being processed and the named header
10350 exists in the message. For example,
10351 .code
10352 ${if def:header_reply-to:{$h_reply-to:}{$h_from:}}
10353 .endd
10354 &*Note*&: No &%$%& appears before &%header_%& or &%h_%& in the condition, and
10355 the header name must be terminated by a colon if white space does not follow.
10356
10357 .vitem &*eq&~{*&<&'string1'&>&*}{*&<&'string2'&>&*}*& &&&
10358        &*eqi&~{*&<&'string1'&>&*}{*&<&'string2'&>&*}*&
10359 .cindex "string" "comparison"
10360 .cindex "expansion" "string comparison"
10361 .cindex "&%eq%& expansion condition"
10362 .cindex "&%eqi%& expansion condition"
10363 The two substrings are first expanded. The condition is true if the two
10364 resulting strings are identical. For &%eq%& the comparison includes the case of
10365 letters, whereas for &%eqi%& the comparison is case-independent.
10366
10367 .vitem &*exists&~{*&<&'file&~name'&>&*}*&
10368 .cindex "expansion" "file existence test"
10369 .cindex "file" "existence test"
10370 .cindex "&%exists%&, expansion condition"
10371 The substring is first expanded and then interpreted as an absolute path. The
10372 condition is true if the named file (or directory) exists. The existence test
10373 is done by calling the &[stat()]& function. The use of the &%exists%& test in
10374 users' filter files may be locked out by the system administrator.
10375
10376 .vitem &*first_delivery*&
10377 .cindex "delivery" "first"
10378 .cindex "first delivery"
10379 .cindex "expansion" "first delivery test"
10380 .cindex "&%first_delivery%& expansion condition"
10381 This condition, which has no data, is true during a message's first delivery
10382 attempt. It is false during any subsequent delivery attempts.
10383
10384
10385 .vitem "&*forall{*&<&'a list'&>&*}{*&<&'a condition'&>&*}*&" &&&
10386        "&*forany{*&<&'a list'&>&*}{*&<&'a condition'&>&*}*&"
10387 .cindex "list" "iterative conditions"
10388 .cindex "expansion" "&*forall*& condition"
10389 .cindex "expansion" "&*forany*& condition"
10390 .vindex "&$item$&"
10391 These conditions iterate over a list. The first argument is expanded to form
10392 the list. By default, the list separator is a colon, but it can be changed by
10393 the normal method. The second argument is interpreted as a condition that is to
10394 be applied to each item in the list in turn. During the interpretation of the
10395 condition, the current list item is placed in a variable called &$item$&.
10396 .ilist
10397 For &*forany*&, interpretation stops if the condition is true for any item, and
10398 the result of the whole condition is true. If the condition is false for all
10399 items in the list, the overall condition is false.
10400 .next
10401 For &*forall*&, interpretation stops if the condition is false for any item,
10402 and the result of the whole condition is false. If the condition is true for
10403 all items in the list, the overall condition is true.
10404 .endlist
10405 Note that negation of &*forany*& means that the condition must be false for all
10406 items for the overall condition to succeed, and negation of &*forall*& means
10407 that the condition must be false for at least one item. In this example, the
10408 list separator is changed to a comma:
10409 .code
10410 ${if forany{<, $recipients}{match{$item}{^user3@}}{yes}{no}}
10411 .endd
10412 The value of &$item$& is saved and restored while &*forany*& or &*forall*& is
10413 being processed, to enable these expansion items to be nested.
10414
10415 .new "To scan a named list, expand it with the &*listnamed*& operator."
10416
10417
10418 .vitem &*ge&~{*&<&'string1'&>&*}{*&<&'string2'&>&*}*& &&&
10419        &*gei&~{*&<&'string1'&>&*}{*&<&'string2'&>&*}*&
10420 .cindex "string" "comparison"
10421 .cindex "expansion" "string comparison"
10422 .cindex "&%ge%& expansion condition"
10423 .cindex "&%gei%& expansion condition"
10424 The two substrings are first expanded. The condition is true if the first
10425 string is lexically greater than or equal to the second string. For &%ge%& the
10426 comparison includes the case of letters, whereas for &%gei%& the comparison is
10427 case-independent.
10428
10429 .vitem &*gt&~{*&<&'string1'&>&*}{*&<&'string2'&>&*}*& &&&
10430        &*gti&~{*&<&'string1'&>&*}{*&<&'string2'&>&*}*&
10431 .cindex "string" "comparison"
10432 .cindex "expansion" "string comparison"
10433 .cindex "&%gt%& expansion condition"
10434 .cindex "&%gti%& expansion condition"
10435 The two substrings are first expanded. The condition is true if the first
10436 string is lexically greater than the second string. For &%gt%& the comparison
10437 includes the case of letters, whereas for &%gti%& the comparison is
10438 case-independent.
10439
10440 .vitem &*inlist&~{*&<&'string1'&>&*}{*&<&'string2'&>&*}*& &&&
10441        &*inlisti&~{*&<&'string1'&>&*}{*&<&'string2'&>&*}*&
10442 .cindex "string" "comparison"
10443 .cindex "list" "iterative conditions"
10444 Both strings are expanded; the second string is treated as a list of simple
10445 strings; if the first string is a member of the second, then the condition
10446 is true.
10447
10448 These are simpler to use versions of the more powerful &*forany*& condition.
10449 Examples, and the &*forany*& equivalents:
10450 .code
10451 ${if inlist{needle}{foo:needle:bar}}
10452   ${if forany{foo:needle:bar}{eq{$item}{needle}}}
10453 ${if inlisti{Needle}{fOo:NeeDLE:bAr}}
10454   ${if forany{fOo:NeeDLE:bAr}{eqi{$item}{Needle}}}
10455 .endd
10456
10457 .vitem &*isip&~{*&<&'string'&>&*}*&  &&&
10458        &*isip4&~{*&<&'string'&>&*}*& &&&
10459        &*isip6&~{*&<&'string'&>&*}*&
10460 .cindex "IP address" "testing string format"
10461 .cindex "string" "testing for IP address"
10462 .cindex "&%isip%& expansion condition"
10463 .cindex "&%isip4%& expansion condition"
10464 .cindex "&%isip6%& expansion condition"
10465 The substring is first expanded, and then tested to see if it has the form of
10466 an IP address. Both IPv4 and IPv6 addresses are valid for &%isip%&, whereas
10467 &%isip4%& and &%isip6%& test specifically for IPv4 or IPv6 addresses.
10468
10469 For an IPv4 address, the test is for four dot-separated components, each of
10470 which consists of from one to three digits. For an IPv6 address, up to eight
10471 colon-separated components are permitted, each containing from one to four
10472 hexadecimal digits. There may be fewer than eight components if an empty
10473 component (adjacent colons) is present. Only one empty component is permitted.
10474
10475 &*Note*&: The checks are just on the form of the address; actual numerical
10476 values are not considered. Thus, for example, 999.999.999.999 passes the IPv4
10477 check. The main use of these tests is to distinguish between IP addresses and
10478 host names, or between IPv4 and IPv6 addresses. For example, you could use
10479 .code
10480 ${if isip4{$sender_host_address}...
10481 .endd
10482 to test which IP version an incoming SMTP connection is using.
10483
10484 .vitem &*ldapauth&~{*&<&'ldap&~query'&>&*}*&
10485 .cindex "LDAP" "use for authentication"
10486 .cindex "expansion" "LDAP authentication test"
10487 .cindex "&%ldapauth%& expansion condition"
10488 This condition supports user authentication using LDAP. See section
10489 &<<SECTldap>>& for details of how to use LDAP in lookups and the syntax of
10490 queries. For this use, the query must contain a user name and password. The
10491 query itself is not used, and can be empty. The condition is true if the
10492 password is not empty, and the user name and password are accepted by the LDAP
10493 server. An empty password is rejected without calling LDAP because LDAP binds
10494 with an empty password are considered anonymous regardless of the username, and
10495 will succeed in most configurations. See chapter &<<CHAPSMTPAUTH>>& for details
10496 of SMTP authentication, and chapter &<<CHAPplaintext>>& for an example of how
10497 this can be used.
10498
10499
10500 .vitem &*le&~{*&<&'string1'&>&*}{*&<&'string2'&>&*}*& &&&
10501        &*lei&~{*&<&'string1'&>&*}{*&<&'string2'&>&*}*&
10502 .cindex "string" "comparison"
10503 .cindex "expansion" "string comparison"
10504 .cindex "&%le%& expansion condition"
10505 .cindex "&%lei%& expansion condition"
10506 The two substrings are first expanded. The condition is true if the first
10507 string is lexically less than or equal to the second string. For &%le%& the
10508 comparison includes the case of letters, whereas for &%lei%& the comparison is
10509 case-independent.
10510
10511 .vitem &*lt&~{*&<&'string1'&>&*}{*&<&'string2'&>&*}*& &&&
10512        &*lti&~{*&<&'string1'&>&*}{*&<&'string2'&>&*}*&
10513 .cindex "string" "comparison"
10514 .cindex "expansion" "string comparison"
10515 .cindex "&%lt%& expansion condition"
10516 .cindex "&%lti%& expansion condition"
10517 The two substrings are first expanded. The condition is true if the first
10518 string is lexically less than the second string. For &%lt%& the comparison
10519 includes the case of letters, whereas for &%lti%& the comparison is
10520 case-independent.
10521
10522
10523 .vitem &*match&~{*&<&'string1'&>&*}{*&<&'string2'&>&*}*&
10524 .cindex "expansion" "regular expression comparison"
10525 .cindex "regular expressions" "match in expanded string"
10526 .cindex "&%match%& expansion condition"
10527 The two substrings are first expanded. The second is then treated as a regular
10528 expression and applied to the first. Because of the pre-expansion, if the
10529 regular expression contains dollar, or backslash characters, they must be
10530 escaped. Care must also be taken if the regular expression contains braces
10531 (curly brackets). A closing brace must be escaped so that it is not taken as a
10532 premature termination of <&'string2'&>. The easiest approach is to use the
10533 &`\N`& feature to disable expansion of the regular expression.
10534 For example,
10535 .code
10536 ${if match {$local_part}{\N^\d{3}\N} ...
10537 .endd
10538 If the whole expansion string is in double quotes, further escaping of
10539 backslashes is also required.
10540
10541 The condition is true if the regular expression match succeeds.
10542 The regular expression is not required to begin with a circumflex
10543 metacharacter, but if there is no circumflex, the expression is not anchored,
10544 and it may match anywhere in the subject, not just at the start. If you want
10545 the pattern to match at the end of the subject, you must include the &`$`&
10546 metacharacter at an appropriate point.
10547
10548 .cindex "numerical variables (&$1$& &$2$& etc)" "in &%if%& expansion"
10549 At the start of an &%if%& expansion the values of the numeric variable
10550 substitutions &$1$& etc. are remembered. Obeying a &%match%& condition that
10551 succeeds causes them to be reset to the substrings of that condition and they
10552 will have these values during the expansion of the success string. At the end
10553 of the &%if%& expansion, the previous values are restored. After testing a
10554 combination of conditions using &%or%&, the subsequent values of the numeric
10555 variables are those of the condition that succeeded.
10556
10557 .vitem &*match_address&~{*&<&'string1'&>&*}{*&<&'string2'&>&*}*&
10558 .cindex "&%match_address%& expansion condition"
10559 See &*match_local_part*&.
10560
10561 .vitem &*match_domain&~{*&<&'string1'&>&*}{*&<&'string2'&>&*}*&
10562 .cindex "&%match_domain%& expansion condition"
10563 See &*match_local_part*&.
10564
10565 .vitem &*match_ip&~{*&<&'string1'&>&*}{*&<&'string2'&>&*}*&
10566 .cindex "&%match_ip%& expansion condition"
10567 This condition matches an IP address to a list of IP address patterns. It must
10568 be followed by two argument strings. The first (after expansion) must be an IP
10569 address or an empty string. The second (not expanded) is a restricted host
10570 list that can match only an IP address, not a host name. For example:
10571 .code
10572 ${if match_ip{$sender_host_address}{1.2.3.4:5.6.7.8}{...}{...}}
10573 .endd
10574 The specific types of host list item that are permitted in the list are:
10575
10576 .ilist
10577 An IP address, optionally with a CIDR mask.
10578 .next
10579 A single asterisk, which matches any IP address.
10580 .next
10581 An empty item, which matches only if the IP address is empty. This could be
10582 useful for testing for a locally submitted message or one from specific hosts
10583 in a single test such as
10584 . ==== As this is a nested list, any displays it contains must be indented
10585 . ==== as otherwise they are too far to the left. This comment applies to
10586 . ==== the use of xmlto plus fop. There's no problem when formatting with
10587 . ==== sdop, with or without the extra indent.
10588 .code
10589   ${if match_ip{$sender_host_address}{:4.3.2.1:...}{...}{...}}
10590 .endd
10591 where the first item in the list is the empty string.
10592 .next
10593 The item @[] matches any of the local host's interface addresses.
10594 .next
10595 Single-key lookups are assumed to be like &"net-"& style lookups in host lists,
10596 even if &`net-`& is not specified. There is never any attempt to turn the IP
10597 address into a host name. The most common type of linear search for
10598 &*match_ip*& is likely to be &*iplsearch*&, in which the file can contain CIDR
10599 masks. For example:
10600 .code
10601   ${if match_ip{$sender_host_address}{iplsearch;/some/file}...
10602 .endd
10603 It is of course possible to use other kinds of lookup, and in such a case, you
10604 do need to specify the &`net-`& prefix if you want to specify a specific
10605 address mask, for example:
10606 .code
10607   ${if match_ip{$sender_host_address}{net24-dbm;/some/file}...
10608 .endd
10609 However, unless you are combining a &%match_ip%& condition with others, it is
10610 just as easy to use the fact that a lookup is itself a condition, and write:
10611 .code
10612   ${lookup{${mask:$sender_host_address/24}}dbm{/a/file}...
10613 .endd
10614 .endlist ilist
10615
10616 Note that <&'string2'&> is not itself subject to string expansion, unless
10617 Exim was built with the EXPAND_LISTMATCH_RHS option.
10618
10619 Consult section &<<SECThoslispatip>>& for further details of these patterns.
10620
10621 .vitem &*match_local_part&~{*&<&'string1'&>&*}{*&<&'string2'&>&*}*&
10622 .cindex "domain list" "in expansion condition"
10623 .cindex "address list" "in expansion condition"
10624 .cindex "local part" "list, in expansion condition"
10625 .cindex "&%match_local_part%& expansion condition"
10626 This condition, together with &%match_address%& and &%match_domain%&, make it
10627 possible to test domain, address, and local part lists within expansions. Each
10628 condition requires two arguments: an item and a list to match. A trivial
10629 example is:
10630 .code
10631 ${if match_domain{a.b.c}{x.y.z:a.b.c:p.q.r}{yes}{no}}
10632 .endd
10633 In each case, the second argument may contain any of the allowable items for a
10634 list of the appropriate type. Also, because the second argument (after
10635 expansion) is a standard form of list, it is possible to refer to a named list.
10636 Thus, you can use conditions like this:
10637 .code
10638 ${if match_domain{$domain}{+local_domains}{...
10639 .endd
10640 .cindex "&`+caseful`&"
10641 For address lists, the matching starts off caselessly, but the &`+caseful`&
10642 item can be used, as in all address lists, to cause subsequent items to
10643 have their local parts matched casefully. Domains are always matched
10644 caselessly.
10645
10646 Note that <&'string2'&> is not itself subject to string expansion, unless
10647 Exim was built with the EXPAND_LISTMATCH_RHS option.
10648
10649 &*Note*&: Host lists are &'not'& supported in this way. This is because
10650 hosts have two identities: a name and an IP address, and it is not clear
10651 how to specify cleanly how such a test would work. However, IP addresses can be
10652 matched using &%match_ip%&.
10653
10654 .vitem &*pam&~{*&<&'string1'&>&*:*&<&'string2'&>&*:...}*&
10655 .cindex "PAM authentication"
10656 .cindex "AUTH" "with PAM"
10657 .cindex "Solaris" "PAM support"
10658 .cindex "expansion" "PAM authentication test"
10659 .cindex "&%pam%& expansion condition"
10660 &'Pluggable Authentication Modules'&
10661 (&url(http://www.kernel.org/pub/linux/libs/pam/)) are a facility that is
10662 available in the latest releases of Solaris and in some GNU/Linux
10663 distributions. The Exim support, which is intended for use in conjunction with
10664 the SMTP AUTH command, is available only if Exim is compiled with
10665 .code
10666 SUPPORT_PAM=yes
10667 .endd
10668 in &_Local/Makefile_&. You probably need to add &%-lpam%& to EXTRALIBS, and
10669 in some releases of GNU/Linux &%-ldl%& is also needed.
10670
10671 The argument string is first expanded, and the result must be a
10672 colon-separated list of strings. Leading and trailing white space is ignored.
10673 The PAM module is initialized with the service name &"exim"& and the user name
10674 taken from the first item in the colon-separated data string (<&'string1'&>).
10675 The remaining items in the data string are passed over in response to requests
10676 from the authentication function. In the simple case there will only be one
10677 request, for a password, so the data consists of just two strings.
10678
10679 There can be problems if any of the strings are permitted to contain colon
10680 characters. In the usual way, these have to be doubled to avoid being taken as
10681 separators. If the data is being inserted from a variable, the &%sg%& expansion
10682 item can be used to double any existing colons. For example, the configuration
10683 of a LOGIN authenticator might contain this setting:
10684 .code
10685 server_condition = ${if pam{$auth1:${sg{$auth2}{:}{::}}}}
10686 .endd
10687 For a PLAIN authenticator you could use:
10688 .code
10689 server_condition = ${if pam{$auth2:${sg{$auth3}{:}{::}}}}
10690 .endd
10691 In some operating systems, PAM authentication can be done only from a process
10692 running as root. Since Exim is running as the Exim user when receiving
10693 messages, this means that PAM cannot be used directly in those systems.
10694 A patched version of the &'pam_unix'& module that comes with the
10695 Linux PAM package is available from &url(http://www.e-admin.de/pam_exim/).
10696 The patched module allows one special uid/gid combination, in addition to root,
10697 to authenticate. If you build the patched module to allow the Exim user and
10698 group, PAM can then be used from an Exim authenticator.
10699
10700
10701 .vitem &*pwcheck&~{*&<&'string1'&>&*:*&<&'string2'&>&*}*&
10702 .cindex "&'pwcheck'& daemon"
10703 .cindex "Cyrus"
10704 .cindex "expansion" "&'pwcheck'& authentication test"
10705 .cindex "&%pwcheck%& expansion condition"
10706 This condition supports user authentication using the Cyrus &'pwcheck'& daemon.
10707 This is one way of making it possible for passwords to be checked by a process
10708 that is not running as root. &*Note*&: The use of &'pwcheck'& is now
10709 deprecated. Its replacement is &'saslauthd'& (see below).
10710
10711 The pwcheck support is not included in Exim by default. You need to specify
10712 the location of the pwcheck daemon's socket in &_Local/Makefile_& before
10713 building Exim. For example:
10714 .code
10715 CYRUS_PWCHECK_SOCKET=/var/pwcheck/pwcheck
10716 .endd
10717 You do not need to install the full Cyrus software suite in order to use
10718 the pwcheck daemon. You can compile and install just the daemon alone
10719 from the Cyrus SASL library. Ensure that &'exim'& is the only user that has
10720 access to the &_/var/pwcheck_& directory.
10721
10722 The &%pwcheck%& condition takes one argument, which must be the user name and
10723 password, separated by a colon. For example, in a LOGIN authenticator
10724 configuration, you might have this:
10725 .code
10726 server_condition = ${if pwcheck{$auth1:$auth2}}
10727 .endd
10728 Again, for a PLAIN authenticator configuration, this would be:
10729 .code
10730 server_condition = ${if pwcheck{$auth2:$auth3}}
10731 .endd
10732 .vitem &*queue_running*&
10733 .cindex "queue runner" "detecting when delivering from"
10734 .cindex "expansion" "queue runner test"
10735 .cindex "&%queue_running%& expansion condition"
10736 This condition, which has no data, is true during delivery attempts that are
10737 initiated by queue runner processes, and false otherwise.
10738
10739
10740 .vitem &*radius&~{*&<&'authentication&~string'&>&*}*&
10741 .cindex "Radius"
10742 .cindex "expansion" "Radius authentication"
10743 .cindex "&%radius%& expansion condition"
10744 Radius authentication (RFC 2865) is supported in a similar way to PAM. You must
10745 set RADIUS_CONFIG_FILE in &_Local/Makefile_& to specify the location of
10746 the Radius client configuration file in order to build Exim with Radius
10747 support.
10748
10749 With just that one setting, Exim expects to be linked with the &%radiusclient%&
10750 library, using the original API. If you are using release 0.4.0 or later of
10751 this library, you need to set
10752 .code
10753 RADIUS_LIB_TYPE=RADIUSCLIENTNEW
10754 .endd
10755 in &_Local/Makefile_& when building Exim. You can also link Exim with the
10756 &%libradius%& library that comes with FreeBSD. To do this, set
10757 .code
10758 RADIUS_LIB_TYPE=RADLIB
10759 .endd
10760 in &_Local/Makefile_&, in addition to setting RADIUS_CONFIGURE_FILE.
10761 You may also have to supply a suitable setting in EXTRALIBS so that the
10762 Radius library can be found when Exim is linked.
10763
10764 The string specified by RADIUS_CONFIG_FILE is expanded and passed to the
10765 Radius client library, which calls the Radius server. The condition is true if
10766 the authentication is successful. For example:
10767 .code
10768 server_condition = ${if radius{<arguments>}}
10769 .endd
10770
10771
10772 .vitem "&*saslauthd&~{{*&<&'user'&>&*}{*&<&'password'&>&*}&&&
10773         {*&<&'service'&>&*}{*&<&'realm'&>&*}}*&"
10774 .cindex "&'saslauthd'& daemon"
10775 .cindex "Cyrus"
10776 .cindex "expansion" "&'saslauthd'& authentication test"
10777 .cindex "&%saslauthd%& expansion condition"
10778 This condition supports user authentication using the Cyrus &'saslauthd'&
10779 daemon. This replaces the older &'pwcheck'& daemon, which is now deprecated.
10780 Using this daemon is one way of making it possible for passwords to be checked
10781 by a process that is not running as root.
10782
10783 The saslauthd support is not included in Exim by default. You need to specify
10784 the location of the saslauthd daemon's socket in &_Local/Makefile_& before
10785 building Exim. For example:
10786 .code
10787 CYRUS_SASLAUTHD_SOCKET=/var/state/saslauthd/mux
10788 .endd
10789 You do not need to install the full Cyrus software suite in order to use
10790 the saslauthd daemon. You can compile and install just the daemon alone
10791 from the Cyrus SASL library.
10792
10793 Up to four arguments can be supplied to the &%saslauthd%& condition, but only
10794 two are mandatory. For example:
10795 .code
10796 server_condition = ${if saslauthd{{$auth1}{$auth2}}}
10797 .endd
10798 The service and the realm are optional (which is why the arguments are enclosed
10799 in their own set of braces). For details of the meaning of the service and
10800 realm, and how to run the daemon, consult the Cyrus documentation.
10801 .endlist vlist
10802
10803
10804
10805 .section "Combining expansion conditions" "SECID84"
10806 .cindex "expansion" "combining conditions"
10807 Several conditions can be tested at once by combining them using the &%and%&
10808 and &%or%& combination conditions. Note that &%and%& and &%or%& are complete
10809 conditions on their own, and precede their lists of sub-conditions. Each
10810 sub-condition must be enclosed in braces within the overall braces that contain
10811 the list. No repetition of &%if%& is used.
10812
10813
10814 .vlist
10815 .vitem &*or&~{{*&<&'cond1'&>&*}{*&<&'cond2'&>&*}...}*&
10816 .cindex "&""or""& expansion condition"
10817 .cindex "expansion" "&""or""& of conditions"
10818 The sub-conditions are evaluated from left to right. The condition is true if
10819 any one of the sub-conditions is true.
10820 For example,
10821 .code
10822 ${if or {{eq{$local_part}{spqr}}{eq{$domain}{testing.com}}}...
10823 .endd
10824 When a true sub-condition is found, the following ones are parsed but not
10825 evaluated. If there are several &"match"& sub-conditions the values of the
10826 numeric variables afterwards are taken from the first one that succeeds.
10827
10828 .vitem &*and&~{{*&<&'cond1'&>&*}{*&<&'cond2'&>&*}...}*&
10829 .cindex "&""and""& expansion condition"
10830 .cindex "expansion" "&""and""& of conditions"
10831 The sub-conditions are evaluated from left to right. The condition is true if
10832 all of the sub-conditions are true. If there are several &"match"&
10833 sub-conditions, the values of the numeric variables afterwards are taken from
10834 the last one. When a false sub-condition is found, the following ones are
10835 parsed but not evaluated.
10836 .endlist
10837 .ecindex IIDexpcond
10838
10839
10840
10841
10842 .section "Expansion variables" "SECTexpvar"
10843 .cindex "expansion" "variables, list of"
10844 This section contains an alphabetical list of all the expansion variables. Some
10845 of them are available only when Exim is compiled with specific options such as
10846 support for TLS or the content scanning extension.
10847
10848 .vlist
10849 .vitem "&$0$&, &$1$&, etc"
10850 .cindex "numerical variables (&$1$& &$2$& etc)"
10851 When a &%match%& expansion condition succeeds, these variables contain the
10852 captured substrings identified by the regular expression during subsequent
10853 processing of the success string of the containing &%if%& expansion item.
10854 However, they do not retain their values afterwards; in fact, their previous
10855 values are restored at the end of processing an &%if%& item. The numerical
10856 variables may also be set externally by some other matching process which
10857 precedes the expansion of the string. For example, the commands available in
10858 Exim filter files include an &%if%& command with its own regular expression
10859 matching condition.
10860
10861 .vitem "&$acl_c...$&"
10862 Values can be placed in these variables by the &%set%& modifier in an ACL. They
10863 can be given any name that starts with &$acl_c$& and is at least six characters
10864 long, but the sixth character must be either a digit or an underscore. For
10865 example: &$acl_c5$&, &$acl_c_mycount$&. The values of the &$acl_c...$&
10866 variables persist throughout the lifetime of an SMTP connection. They can be
10867 used to pass information between ACLs and between different invocations of the
10868 same ACL. When a message is received, the values of these variables are saved
10869 with the message, and can be accessed by filters, routers, and transports
10870 during subsequent delivery.
10871
10872 .vitem "&$acl_m...$&"
10873 These variables are like the &$acl_c...$& variables, except that their values
10874 are reset after a message has been received. Thus, if several messages are
10875 received in one SMTP connection, &$acl_m...$& values are not passed on from one
10876 message to the next, as &$acl_c...$& values are. The &$acl_m...$& variables are
10877 also reset by MAIL, RSET, EHLO, HELO, and after starting a TLS session. When a
10878 message is received, the values of these variables are saved with the message,
10879 and can be accessed by filters, routers, and transports during subsequent
10880 delivery.
10881
10882 .vitem &$acl_verify_message$&
10883 .vindex "&$acl_verify_message$&"
10884 After an address verification has failed, this variable contains the failure
10885 message. It retains its value for use in subsequent modifiers. The message can
10886 be preserved by coding like this:
10887 .code
10888 warn !verify = sender
10889      set acl_m0 = $acl_verify_message
10890 .endd
10891 You can use &$acl_verify_message$& during the expansion of the &%message%& or
10892 &%log_message%& modifiers, to include information about the verification
10893 failure.
10894
10895 .vitem &$address_data$&
10896 .vindex "&$address_data$&"
10897 This variable is set by means of the &%address_data%& option in routers. The
10898 value then remains with the address while it is processed by subsequent routers
10899 and eventually a transport. If the transport is handling multiple addresses,
10900 the value from the first address is used. See chapter &<<CHAProutergeneric>>&
10901 for more details. &*Note*&: The contents of &$address_data$& are visible in
10902 user filter files.
10903
10904 If &$address_data$& is set when the routers are called from an ACL to verify
10905 a recipient address, the final value is still in the variable for subsequent
10906 conditions and modifiers of the ACL statement. If routing the address caused it
10907 to be redirected to just one address, the child address is also routed as part
10908 of the verification, and in this case the final value of &$address_data$& is
10909 from the child's routing.
10910
10911 If &$address_data$& is set when the routers are called from an ACL to verify a
10912 sender address, the final value is also preserved, but this time in
10913 &$sender_address_data$&, to distinguish it from data from a recipient
10914 address.
10915
10916 In both cases (recipient and sender verification), the value does not persist
10917 after the end of the current ACL statement. If you want to preserve
10918 these values for longer, you can save them in ACL variables.
10919
10920 .vitem &$address_file$&
10921 .vindex "&$address_file$&"
10922 When, as a result of aliasing, forwarding, or filtering, a message is directed
10923 to a specific file, this variable holds the name of the file when the transport
10924 is running. At other times, the variable is empty. For example, using the
10925 default configuration, if user &%r2d2%& has a &_.forward_& file containing
10926 .code
10927 /home/r2d2/savemail
10928 .endd
10929 then when the &(address_file)& transport is running, &$address_file$&
10930 contains the text string &`/home/r2d2/savemail`&.
10931 .cindex "Sieve filter" "value of &$address_file$&"
10932 For Sieve filters, the value may be &"inbox"& or a relative folder name. It is
10933 then up to the transport configuration to generate an appropriate absolute path
10934 to the relevant file.
10935
10936 .vitem &$address_pipe$&
10937 .vindex "&$address_pipe$&"
10938 When, as a result of aliasing or forwarding, a message is directed to a pipe,
10939 this variable holds the pipe command when the transport is running.
10940
10941 .vitem "&$auth1$& &-- &$auth3$&"
10942 .vindex "&$auth1$&, &$auth2$&, etc"
10943 These variables are used in SMTP authenticators (see chapters
10944 &<<CHAPplaintext>>&&--&<<CHAPspa>>&). Elsewhere, they are empty.
10945
10946 .vitem &$authenticated_id$&
10947 .cindex "authentication" "id"
10948 .vindex "&$authenticated_id$&"
10949 When a server successfully authenticates a client it may be configured to
10950 preserve some of the authentication information in the variable
10951 &$authenticated_id$& (see chapter &<<CHAPSMTPAUTH>>&). For example, a
10952 user/password authenticator configuration might preserve the user name for use
10953 in the routers. Note that this is not the same information that is saved in
10954 &$sender_host_authenticated$&.
10955 When a message is submitted locally (that is, not over a TCP connection)
10956 the value of &$authenticated_id$& is normally the login name of the calling
10957 process. However, a trusted user can override this by means of the &%-oMai%&
10958 command line option.
10959
10960 .new
10961 .vitem &$authenticated_fail_id$&
10962 .cindex "authentication" "fail" "id"
10963 .vindex "&$authenticated_fail_id$&"
10964 When an authentication attempt fails, the variable &$authenticated_fail_id$&
10965 will contain the failed authentication id. If more than one authentication
10966 id is attempted, it will contain only the last one. The variable is
10967 available for processing in the ACL's, generally the quit or notquit ACL.
10968 A message to a local recipient could still be accepted without requiring
10969 authentication, which means this variable could also be visible in all of
10970 the ACL's as well.
10971 .wen
10972
10973
10974 .vitem &$authenticated_sender$&
10975 .cindex "sender" "authenticated"
10976 .cindex "authentication" "sender"
10977 .cindex "AUTH" "on MAIL command"
10978 .vindex "&$authenticated_sender$&"
10979 When acting as a server, Exim takes note of the AUTH= parameter on an incoming
10980 SMTP MAIL command if it believes the sender is sufficiently trusted, as
10981 described in section &<<SECTauthparamail>>&. Unless the data is the string
10982 &"<>"&, it is set as the authenticated sender of the message, and the value is
10983 available during delivery in the &$authenticated_sender$& variable. If the
10984 sender is not trusted, Exim accepts the syntax of AUTH=, but ignores the data.
10985
10986 .vindex "&$qualify_domain$&"
10987 When a message is submitted locally (that is, not over a TCP connection), the
10988 value of &$authenticated_sender$& is an address constructed from the login
10989 name of the calling process and &$qualify_domain$&, except that a trusted user
10990 can override this by means of the &%-oMas%& command line option.
10991
10992
10993 .vitem &$authentication_failed$&
10994 .cindex "authentication" "failure"
10995 .vindex "&$authentication_failed$&"
10996 This variable is set to &"1"& in an Exim server if a client issues an AUTH
10997 command that does not succeed. Otherwise it is set to &"0"&. This makes it
10998 possible to distinguish between &"did not try to authenticate"&
10999 (&$sender_host_authenticated$& is empty and &$authentication_failed$& is set to
11000 &"0"&) and &"tried to authenticate but failed"& (&$sender_host_authenticated$&
11001 is empty and &$authentication_failed$& is set to &"1"&). Failure includes any
11002 negative response to an AUTH command, including (for example) an attempt to use
11003 an undefined mechanism.
11004
11005 .vitem &$av_failed$&
11006 .cindex "content scanning" "AV scanner failure"
11007 This variable is available when Exim is compiled with the content-scanning
11008 extension. It is set to &"0"& by default, but will be set to &"1"& if any
11009 problem occurs with the virus scanner (specified by &%av_scanner%&) during
11010 the ACL malware condition.
11011
11012 .vitem &$body_linecount$&
11013 .cindex "message body" "line count"
11014 .cindex "body of message" "line count"
11015 .vindex "&$body_linecount$&"
11016 When a message is being received or delivered, this variable contains the
11017 number of lines in the message's body. See also &$message_linecount$&.
11018
11019 .vitem &$body_zerocount$&
11020 .cindex "message body" "binary zero count"
11021 .cindex "body of message" "binary zero count"
11022 .cindex "binary zero" "in message body"
11023 .vindex "&$body_zerocount$&"
11024 When a message is being received or delivered, this variable contains the
11025 number of binary zero bytes (ASCII NULs) in the message's body.
11026
11027 .vitem &$bounce_recipient$&
11028 .vindex "&$bounce_recipient$&"
11029 This is set to the recipient address of a bounce message while Exim is creating
11030 it. It is useful if a customized bounce message text file is in use (see
11031 chapter &<<CHAPemsgcust>>&).
11032
11033 .vitem &$bounce_return_size_limit$&
11034 .vindex "&$bounce_return_size_limit$&"
11035 This contains the value set in the &%bounce_return_size_limit%& option, rounded
11036 up to a multiple of 1000. It is useful when a customized error message text
11037 file is in use (see chapter &<<CHAPemsgcust>>&).
11038
11039 .vitem &$caller_gid$&
11040 .cindex "gid (group id)" "caller"
11041 .vindex "&$caller_gid$&"
11042 The real group id under which the process that called Exim was running. This is
11043 not the same as the group id of the originator of a message (see
11044 &$originator_gid$&). If Exim re-execs itself, this variable in the new
11045 incarnation normally contains the Exim gid.
11046
11047 .vitem &$caller_uid$&
11048 .cindex "uid (user id)" "caller"
11049 .vindex "&$caller_uid$&"
11050 The real user id under which the process that called Exim was running. This is
11051 not the same as the user id of the originator of a message (see
11052 &$originator_uid$&). If Exim re-execs itself, this variable in the new
11053 incarnation normally contains the Exim uid.
11054
11055 .vitem &$compile_date$&
11056 .vindex "&$compile_date$&"
11057 The date on which the Exim binary was compiled.
11058
11059 .vitem &$compile_number$&
11060 .vindex "&$compile_number$&"
11061 The building process for Exim keeps a count of the number
11062 of times it has been compiled. This serves to distinguish different
11063 compilations of the same version of the program.
11064
11065 .vitem &$demime_errorlevel$&
11066 .vindex "&$demime_errorlevel$&"
11067 This variable is available when Exim is compiled with
11068 the content-scanning extension and the obsolete &%demime%& condition. For
11069 details, see section &<<SECTdemimecond>>&.
11070
11071 .vitem &$demime_reason$&
11072 .vindex "&$demime_reason$&"
11073 This variable is available when Exim is compiled with the
11074 content-scanning extension and the obsolete &%demime%& condition. For details,
11075 see section &<<SECTdemimecond>>&.
11076
11077 .vitem &$dnslist_domain$& &&&
11078        &$dnslist_matched$& &&&
11079        &$dnslist_text$& &&&
11080        &$dnslist_value$&
11081 .vindex "&$dnslist_domain$&"
11082 .vindex "&$dnslist_matched$&"
11083 .vindex "&$dnslist_text$&"
11084 .vindex "&$dnslist_value$&"
11085 .cindex "black list (DNS)"
11086 When a DNS (black) list lookup succeeds, these variables are set to contain
11087 the following data from the lookup: the list's domain name, the key that was
11088 looked up, the contents of any associated TXT record, and the value from the
11089 main A record. See section &<<SECID204>>& for more details.
11090
11091 .vitem &$domain$&
11092 .vindex "&$domain$&"
11093 When an address is being routed, or delivered on its own, this variable
11094 contains the domain. Uppercase letters in the domain are converted into lower
11095 case for &$domain$&.
11096
11097 Global address rewriting happens when a message is received, so the value of
11098 &$domain$& during routing and delivery is the value after rewriting. &$domain$&
11099 is set during user filtering, but not during system filtering, because a
11100 message may have many recipients and the system filter is called just once.
11101
11102 When more than one address is being delivered at once (for example, several
11103 RCPT commands in one SMTP delivery), &$domain$& is set only if they all
11104 have the same domain. Transports can be restricted to handling only one domain
11105 at a time if the value of &$domain$& is required at transport time &-- this is
11106 the default for local transports. For further details of the environment in
11107 which local transports are run, see chapter &<<CHAPenvironment>>&.
11108
11109 .oindex "&%delay_warning_condition%&"
11110 At the end of a delivery, if all deferred addresses have the same domain, it is
11111 set in &$domain$& during the expansion of &%delay_warning_condition%&.
11112
11113 The &$domain$& variable is also used in some other circumstances:
11114
11115 .ilist
11116 When an ACL is running for a RCPT command, &$domain$& contains the domain of
11117 the recipient address. The domain of the &'sender'& address is in
11118 &$sender_address_domain$& at both MAIL time and at RCPT time. &$domain$& is not
11119 normally set during the running of the MAIL ACL. However, if the sender address
11120 is verified with a callout during the MAIL ACL, the sender domain is placed in
11121 &$domain$& during the expansions of &%hosts%&, &%interface%&, and &%port%& in
11122 the &(smtp)& transport.
11123
11124 .next
11125 When a rewrite item is being processed (see chapter &<<CHAPrewrite>>&),
11126 &$domain$& contains the domain portion of the address that is being rewritten;
11127 it can be used in the expansion of the replacement address, for example, to
11128 rewrite domains by file lookup.
11129
11130 .next
11131 With one important exception, whenever a domain list is being scanned,
11132 &$domain$& contains the subject domain. &*Exception*&: When a domain list in
11133 a &%sender_domains%& condition in an ACL is being processed, the subject domain
11134 is in &$sender_address_domain$& and not in &$domain$&. It works this way so
11135 that, in a RCPT ACL, the sender domain list can be dependent on the
11136 recipient domain (which is what is in &$domain$& at this time).
11137
11138 .next
11139 .cindex "ETRN" "value of &$domain$&"
11140 .oindex "&%smtp_etrn_command%&"
11141 When the &%smtp_etrn_command%& option is being expanded, &$domain$& contains
11142 the complete argument of the ETRN command (see section &<<SECTETRN>>&).
11143 .endlist
11144
11145
11146 .vitem &$domain_data$&
11147 .vindex "&$domain_data$&"
11148 When the &%domains%& option on a router matches a domain by
11149 means of a lookup, the data read by the lookup is available during the running
11150 of the router as &$domain_data$&. In addition, if the driver routes the
11151 address to a transport, the value is available in that transport. If the
11152 transport is handling multiple addresses, the value from the first address is
11153 used.
11154
11155 &$domain_data$& is also set when the &%domains%& condition in an ACL matches a
11156 domain by means of a lookup. The data read by the lookup is available during
11157 the rest of the ACL statement. In all other situations, this variable expands
11158 to nothing.
11159
11160 .vitem &$exim_gid$&
11161 .vindex "&$exim_gid$&"
11162 This variable contains the numerical value of the Exim group id.
11163
11164 .vitem &$exim_path$&
11165 .vindex "&$exim_path$&"
11166 This variable contains the path to the Exim binary.
11167
11168 .vitem &$exim_uid$&
11169 .vindex "&$exim_uid$&"
11170 This variable contains the numerical value of the Exim user id.
11171
11172 .vitem &$found_extension$&
11173 .vindex "&$found_extension$&"
11174 This variable is available when Exim is compiled with the
11175 content-scanning extension and the obsolete &%demime%& condition. For details,
11176 see section &<<SECTdemimecond>>&.
11177
11178 .vitem &$header_$&<&'name'&>
11179 This is not strictly an expansion variable. It is expansion syntax for
11180 inserting the message header line with the given name. Note that the name must
11181 be terminated by colon or white space, because it may contain a wide variety of
11182 characters. Note also that braces must &'not'& be used.
11183
11184 .new
11185 .vitem &$headers_added$&
11186 .vindex "&$headers_added$&"
11187 Within an ACL this variable contains the headers added so far by
11188 the ACL modifier add_header (section &<<SECTaddheadacl>>&).
11189 The headers are a newline-separated list.
11190 .wen
11191
11192 .vitem &$home$&
11193 .vindex "&$home$&"
11194 When the &%check_local_user%& option is set for a router, the user's home
11195 directory is placed in &$home$& when the check succeeds. In particular, this
11196 means it is set during the running of users' filter files. A router may also
11197 explicitly set a home directory for use by a transport; this can be overridden
11198 by a setting on the transport itself.
11199
11200 When running a filter test via the &%-bf%& option, &$home$& is set to the value
11201 of the environment variable HOME.
11202
11203 .vitem &$host$&
11204 .vindex "&$host$&"
11205 If a router assigns an address to a transport (any transport), and passes a
11206 list of hosts with the address, the value of &$host$& when the transport starts
11207 to run is the name of the first host on the list. Note that this applies both
11208 to local and remote transports.
11209
11210 .cindex "transport" "filter"
11211 .cindex "filter" "transport filter"
11212 For the &(smtp)& transport, if there is more than one host, the value of
11213 &$host$& changes as the transport works its way through the list. In
11214 particular, when the &(smtp)& transport is expanding its options for encryption
11215 using TLS, or for specifying a transport filter (see chapter
11216 &<<CHAPtransportgeneric>>&), &$host$& contains the name of the host to which it
11217 is connected.
11218
11219 When used in the client part of an authenticator configuration (see chapter
11220 &<<CHAPSMTPAUTH>>&), &$host$& contains the name of the server to which the
11221 client is connected.
11222
11223
11224 .vitem &$host_address$&
11225 .vindex "&$host_address$&"
11226 This variable is set to the remote host's IP address whenever &$host$& is set
11227 for a remote connection. It is also set to the IP address that is being checked
11228 when the &%ignore_target_hosts%& option is being processed.
11229
11230 .vitem &$host_data$&
11231 .vindex "&$host_data$&"
11232 If a &%hosts%& condition in an ACL is satisfied by means of a lookup, the
11233 result of the lookup is made available in the &$host_data$& variable. This
11234 allows you, for example, to do things like this:
11235 .code
11236 deny  hosts = net-lsearch;/some/file
11237 message = $host_data
11238 .endd
11239 .vitem &$host_lookup_deferred$&
11240 .cindex "host name" "lookup, failure of"
11241 .vindex "&$host_lookup_deferred$&"
11242 This variable normally contains &"0"&, as does &$host_lookup_failed$&. When a
11243 message comes from a remote host and there is an attempt to look up the host's
11244 name from its IP address, and the attempt is not successful, one of these
11245 variables is set to &"1"&.
11246
11247 .ilist
11248 If the lookup receives a definite negative response (for example, a DNS lookup
11249 succeeded, but no records were found), &$host_lookup_failed$& is set to &"1"&.
11250
11251 .next
11252 If there is any kind of problem during the lookup, such that Exim cannot
11253 tell whether or not the host name is defined (for example, a timeout for a DNS
11254 lookup), &$host_lookup_deferred$& is set to &"1"&.
11255 .endlist ilist
11256
11257 Looking up a host's name from its IP address consists of more than just a
11258 single reverse lookup. Exim checks that a forward lookup of at least one of the
11259 names it receives from a reverse lookup yields the original IP address. If this
11260 is not the case, Exim does not accept the looked up name(s), and
11261 &$host_lookup_failed$& is set to &"1"&. Thus, being able to find a name from an
11262 IP address (for example, the existence of a PTR record in the DNS) is not
11263 sufficient on its own for the success of a host name lookup. If the reverse
11264 lookup succeeds, but there is a lookup problem such as a timeout when checking
11265 the result, the name is not accepted, and &$host_lookup_deferred$& is set to
11266 &"1"&. See also &$sender_host_name$&.
11267
11268 .vitem &$host_lookup_failed$&
11269 .vindex "&$host_lookup_failed$&"
11270 See &$host_lookup_deferred$&.
11271
11272
11273 .vitem &$inode$&
11274 .vindex "&$inode$&"
11275 The only time this variable is set is while expanding the &%directory_file%&
11276 option in the &(appendfile)& transport. The variable contains the inode number
11277 of the temporary file which is about to be renamed. It can be used to construct
11278 a unique name for the file.
11279
11280 .vitem &$interface_address$&
11281 .vindex "&$interface_address$&"
11282 This is an obsolete name for &$received_ip_address$&.
11283
11284 .vitem &$interface_port$&
11285 .vindex "&$interface_port$&"
11286 This is an obsolete name for &$received_port$&.
11287
11288 .vitem &$item$&
11289 .vindex "&$item$&"
11290 This variable is used during the expansion of &*forall*& and &*forany*&
11291 conditions (see section &<<SECTexpcond>>&), and &*filter*&, &*map*&, and
11292 &*reduce*& items (see section &<<SECTexpcond>>&). In other circumstances, it is
11293 empty.
11294
11295 .vitem &$ldap_dn$&
11296 .vindex "&$ldap_dn$&"
11297 This variable, which is available only when Exim is compiled with LDAP support,
11298 contains the DN from the last entry in the most recently successful LDAP
11299 lookup.
11300
11301 .vitem &$load_average$&
11302 .vindex "&$load_average$&"
11303 This variable contains the system load average, multiplied by 1000 so that it
11304 is an integer. For example, if the load average is 0.21, the value of the
11305 variable is 210. The value is recomputed every time the variable is referenced.
11306
11307 .vitem &$local_part$&
11308 .vindex "&$local_part$&"
11309 When an address is being routed, or delivered on its own, this
11310 variable contains the local part. When a number of addresses are being
11311 delivered together (for example, multiple RCPT commands in an SMTP
11312 session), &$local_part$& is not set.
11313
11314 Global address rewriting happens when a message is received, so the value of
11315 &$local_part$& during routing and delivery is the value after rewriting.
11316 &$local_part$& is set during user filtering, but not during system filtering,
11317 because a message may have many recipients and the system filter is called just
11318 once.
11319
11320 .vindex "&$local_part_prefix$&"
11321 .vindex "&$local_part_suffix$&"
11322 If a local part prefix or suffix has been recognized, it is not included in the
11323 value of &$local_part$& during routing and subsequent delivery. The values of
11324 any prefix or suffix are in &$local_part_prefix$& and
11325 &$local_part_suffix$&, respectively.
11326
11327 When a message is being delivered to a file, pipe, or autoreply transport as a
11328 result of aliasing or forwarding, &$local_part$& is set to the local part of
11329 the parent address, not to the file name or command (see &$address_file$& and
11330 &$address_pipe$&).
11331
11332 When an ACL is running for a RCPT command, &$local_part$& contains the
11333 local part of the recipient address.
11334
11335 When a rewrite item is being processed (see chapter &<<CHAPrewrite>>&),
11336 &$local_part$& contains the local part of the address that is being rewritten;
11337 it can be used in the expansion of the replacement address, for example.
11338
11339 In all cases, all quoting is removed from the local part. For example, for both
11340 the addresses
11341 .code
11342 "abc:xyz"@test.example
11343 abc\:xyz@test.example
11344 .endd
11345 the value of &$local_part$& is
11346 .code
11347 abc:xyz
11348 .endd
11349 If you use &$local_part$& to create another address, you should always wrap it
11350 inside a quoting operator. For example, in a &(redirect)& router you could
11351 have:
11352 .code
11353 data = ${quote_local_part:$local_part}@new.domain.example
11354 .endd
11355 &*Note*&: The value of &$local_part$& is normally lower cased. If you want
11356 to process local parts in a case-dependent manner in a router, you can set the
11357 &%caseful_local_part%& option (see chapter &<<CHAProutergeneric>>&).
11358
11359 .vitem &$local_part_data$&
11360 .vindex "&$local_part_data$&"
11361 When the &%local_parts%& option on a router matches a local part by means of a
11362 lookup, the data read by the lookup is available during the running of the
11363 router as &$local_part_data$&. In addition, if the driver routes the address
11364 to a transport, the value is available in that transport. If the transport is
11365 handling multiple addresses, the value from the first address is used.
11366
11367 &$local_part_data$& is also set when the &%local_parts%& condition in an ACL
11368 matches a local part by means of a lookup. The data read by the lookup is
11369 available during the rest of the ACL statement. In all other situations, this
11370 variable expands to nothing.
11371
11372 .vitem &$local_part_prefix$&
11373 .vindex "&$local_part_prefix$&"
11374 When an address is being routed or delivered, and a
11375 specific prefix for the local part was recognized, it is available in this
11376 variable, having been removed from &$local_part$&.
11377
11378 .vitem &$local_part_suffix$&
11379 .vindex "&$local_part_suffix$&"
11380 When an address is being routed or delivered, and a
11381 specific suffix for the local part was recognized, it is available in this
11382 variable, having been removed from &$local_part$&.
11383
11384 .vitem &$local_scan_data$&
11385 .vindex "&$local_scan_data$&"
11386 This variable contains the text returned by the &[local_scan()]& function when
11387 a message is received. See chapter &<<CHAPlocalscan>>& for more details.
11388
11389 .vitem &$local_user_gid$&
11390 .vindex "&$local_user_gid$&"
11391 See &$local_user_uid$&.
11392
11393 .vitem &$local_user_uid$&
11394 .vindex "&$local_user_uid$&"
11395 This variable and &$local_user_gid$& are set to the uid and gid after the
11396 &%check_local_user%& router precondition succeeds. This means that their values
11397 are available for the remaining preconditions (&%senders%&, &%require_files%&,
11398 and &%condition%&), for the &%address_data%& expansion, and for any
11399 router-specific expansions. At all other times, the values in these variables
11400 are &`(uid_t)(-1)`& and &`(gid_t)(-1)`&, respectively.
11401
11402 .vitem &$localhost_number$&
11403 .vindex "&$localhost_number$&"
11404 This contains the expanded value of the
11405 &%localhost_number%& option. The expansion happens after the main options have
11406 been read.
11407
11408 .vitem &$log_inodes$&
11409 .vindex "&$log_inodes$&"
11410 The number of free inodes in the disk partition where Exim's
11411 log files are being written. The value is recalculated whenever the variable is
11412 referenced. If the relevant file system does not have the concept of inodes,
11413 the value of is -1. See also the &%check_log_inodes%& option.
11414
11415 .vitem &$log_space$&
11416 .vindex "&$log_space$&"
11417 The amount of free space (as a number of kilobytes) in the disk
11418 partition where Exim's log files are being written. The value is recalculated
11419 whenever the variable is referenced. If the operating system does not have the
11420 ability to find the amount of free space (only true for experimental systems),
11421 the space value is -1. See also the &%check_log_space%& option.
11422
11423
11424 .vitem &$mailstore_basename$&
11425 .vindex "&$mailstore_basename$&"
11426 This variable is set only when doing deliveries in &"mailstore"& format in the
11427 &(appendfile)& transport. During the expansion of the &%mailstore_prefix%&,
11428 &%mailstore_suffix%&, &%message_prefix%&, and &%message_suffix%& options, it
11429 contains the basename of the files that are being written, that is, the name
11430 without the &".tmp"&, &".env"&, or &".msg"& suffix. At all other times, this
11431 variable is empty.
11432
11433 .vitem &$malware_name$&
11434 .vindex "&$malware_name$&"
11435 This variable is available when Exim is compiled with the
11436 content-scanning extension. It is set to the name of the virus that was found
11437 when the ACL &%malware%& condition is true (see section &<<SECTscanvirus>>&).
11438
11439 .vitem &$max_received_linelength$&
11440 .vindex "&$max_received_linelength$&"
11441 .cindex "maximum" "line length"
11442 .cindex "line length" "maximum"
11443 This variable contains the number of bytes in the longest line that was
11444 received as part of the message, not counting the line termination
11445 character(s).
11446
11447 .vitem &$message_age$&
11448 .cindex "message" "age of"
11449 .vindex "&$message_age$&"
11450 This variable is set at the start of a delivery attempt to contain the number
11451 of seconds since the message was received. It does not change during a single
11452 delivery attempt.
11453
11454 .vitem &$message_body$&
11455 .cindex "body of message" "expansion variable"
11456 .cindex "message body" "in expansion"
11457 .cindex "binary zero" "in message body"
11458 .vindex "&$message_body$&"
11459 .oindex "&%message_body_visible%&"
11460 This variable contains the initial portion of a message's body while it is
11461 being delivered, and is intended mainly for use in filter files. The maximum
11462 number of characters of the body that are put into the variable is set by the
11463 &%message_body_visible%& configuration option; the default is 500.
11464
11465 .oindex "&%message_body_newlines%&"
11466 By default, newlines are converted into spaces in &$message_body$&, to make it
11467 easier to search for phrases that might be split over a line break. However,
11468 this can be disabled by setting &%message_body_newlines%& to be true. Binary
11469 zeros are always converted into spaces.
11470
11471 .vitem &$message_body_end$&
11472 .cindex "body of message" "expansion variable"
11473 .cindex "message body" "in expansion"
11474 .vindex "&$message_body_end$&"
11475 This variable contains the final portion of a message's
11476 body while it is being delivered. The format and maximum size are as for
11477 &$message_body$&.
11478
11479 .vitem &$message_body_size$&
11480 .cindex "body of message" "size"
11481 .cindex "message body" "size"
11482 .vindex "&$message_body_size$&"
11483 When a message is being delivered, this variable contains the size of the body
11484 in bytes. The count starts from the character after the blank line that
11485 separates the body from the header. Newlines are included in the count. See
11486 also &$message_size$&, &$body_linecount$&, and &$body_zerocount$&.
11487
11488 .vitem &$message_exim_id$&
11489 .vindex "&$message_exim_id$&"
11490 When a message is being received or delivered, this variable contains the
11491 unique message id that is generated and used by Exim to identify the message.
11492 An id is not created for a message until after its header has been successfully
11493 received. &*Note*&: This is &'not'& the contents of the &'Message-ID:'& header
11494 line; it is the local id that Exim assigns to the message, for example:
11495 &`1BXTIK-0001yO-VA`&.
11496
11497 .vitem &$message_headers$&
11498 .vindex &$message_headers$&
11499 This variable contains a concatenation of all the header lines when a message
11500 is being processed, except for lines added by routers or transports. The header
11501 lines are separated by newline characters. Their contents are decoded in the
11502 same way as a header line that is inserted by &%bheader%&.
11503
11504 .vitem &$message_headers_raw$&
11505 .vindex &$message_headers_raw$&
11506 This variable is like &$message_headers$& except that no processing of the
11507 contents of header lines is done.
11508
11509 .vitem &$message_id$&
11510 This is an old name for &$message_exim_id$&, which is now deprecated.
11511
11512 .vitem &$message_linecount$&
11513 .vindex "&$message_linecount$&"
11514 This variable contains the total number of lines in the header and body of the
11515 message. Compare &$body_linecount$&, which is the count for the body only.
11516 During the DATA and content-scanning ACLs, &$message_linecount$& contains the
11517 number of lines received. Before delivery happens (that is, before filters,
11518 routers, and transports run) the count is increased to include the
11519 &'Received:'& header line that Exim standardly adds, and also any other header
11520 lines that are added by ACLs. The blank line that separates the message header
11521 from the body is not counted.
11522
11523 As with the special case of &$message_size$&, during the expansion of the
11524 appendfile transport's maildir_tag option in maildir format, the value of
11525 &$message_linecount$& is the precise size of the number of newlines in the
11526 file that has been written (minus one for the blank line between the
11527 header and the body).
11528
11529 Here is an example of the use of this variable in a DATA ACL:
11530 .code
11531 deny message   = Too many lines in message header
11532      condition = \
11533       ${if <{250}{${eval:$message_linecount - $body_linecount}}}
11534 .endd
11535 In the MAIL and RCPT ACLs, the value is zero because at that stage the
11536 message has not yet been received.
11537
11538 .vitem &$message_size$&
11539 .cindex "size" "of message"
11540 .cindex "message" "size"
11541 .vindex "&$message_size$&"
11542 When a message is being processed, this variable contains its size in bytes. In
11543 most cases, the size includes those headers that were received with the
11544 message, but not those (such as &'Envelope-to:'&) that are added to individual
11545 deliveries as they are written. However, there is one special case: during the
11546 expansion of the &%maildir_tag%& option in the &(appendfile)& transport while
11547 doing a delivery in maildir format, the value of &$message_size$& is the
11548 precise size of the file that has been written. See also
11549 &$message_body_size$&, &$body_linecount$&, and &$body_zerocount$&.
11550
11551 .cindex "RCPT" "value of &$message_size$&"
11552 While running a per message ACL (mail/rcpt/predata), &$message_size$&
11553 contains the size supplied on the MAIL command, or -1 if no size was given. The
11554 value may not, of course, be truthful.
11555
11556 .vitem &$mime_$&&'xxx'&
11557 A number of variables whose names start with &$mime$& are
11558 available when Exim is compiled with the content-scanning extension. For
11559 details, see section &<<SECTscanmimepart>>&.
11560
11561 .vitem "&$n0$& &-- &$n9$&"
11562 These variables are counters that can be incremented by means
11563 of the &%add%& command in filter files.
11564
11565 .vitem &$original_domain$&
11566 .vindex "&$domain$&"
11567 .vindex "&$original_domain$&"
11568 When a top-level address is being processed for delivery, this contains the
11569 same value as &$domain$&. However, if a &"child"& address (for example,
11570 generated by an alias, forward, or filter file) is being processed, this
11571 variable contains the domain of the original address (lower cased). This
11572 differs from &$parent_domain$& only when there is more than one level of
11573 aliasing or forwarding. When more than one address is being delivered in a
11574 single transport run, &$original_domain$& is not set.
11575
11576 If a new address is created by means of a &%deliver%& command in a system
11577 filter, it is set up with an artificial &"parent"& address. This has the local
11578 part &'system-filter'& and the default qualify domain.
11579
11580 .vitem &$original_local_part$&
11581 .vindex "&$local_part$&"
11582 .vindex "&$original_local_part$&"
11583 When a top-level address is being processed for delivery, this contains the
11584 same value as &$local_part$&, unless a prefix or suffix was removed from the
11585 local part, because &$original_local_part$& always contains the full local
11586 part. When a &"child"& address (for example, generated by an alias, forward, or
11587 filter file) is being processed, this variable contains the full local part of
11588 the original address.
11589
11590 If the router that did the redirection processed the local part
11591 case-insensitively, the value in &$original_local_part$& is in lower case.
11592 This variable differs from &$parent_local_part$& only when there is more than
11593 one level of aliasing or forwarding. When more than one address is being
11594 delivered in a single transport run, &$original_local_part$& is not set.
11595
11596 If a new address is created by means of a &%deliver%& command in a system
11597 filter, it is set up with an artificial &"parent"& address. This has the local
11598 part &'system-filter'& and the default qualify domain.
11599
11600 .vitem &$originator_gid$&
11601 .cindex "gid (group id)" "of originating user"
11602 .cindex "sender" "gid"
11603 .vindex "&$caller_gid$&"
11604 .vindex "&$originator_gid$&"
11605 This variable contains the value of &$caller_gid$& that was set when the
11606 message was received. For messages received via the command line, this is the
11607 gid of the sending user. For messages received by SMTP over TCP/IP, this is
11608 normally the gid of the Exim user.
11609
11610 .vitem &$originator_uid$&
11611 .cindex "uid (user id)" "of originating user"
11612 .cindex "sender" "uid"
11613 .vindex "&$caller_uid$&"
11614 .vindex "&$originaltor_uid$&"
11615 The value of &$caller_uid$& that was set when the message was received. For
11616 messages received via the command line, this is the uid of the sending user.
11617 For messages received by SMTP over TCP/IP, this is normally the uid of the Exim
11618 user.
11619
11620 .vitem &$parent_domain$&
11621 .vindex "&$parent_domain$&"
11622 This variable is similar to &$original_domain$& (see
11623 above), except that it refers to the immediately preceding parent address.
11624
11625 .vitem &$parent_local_part$&
11626 .vindex "&$parent_local_part$&"
11627 This variable is similar to &$original_local_part$&
11628 (see above), except that it refers to the immediately preceding parent address.
11629
11630 .vitem &$pid$&
11631 .cindex "pid (process id)" "of current process"
11632 .vindex "&$pid$&"
11633 This variable contains the current process id.
11634
11635 .vitem &$pipe_addresses$&
11636 .cindex "filter" "transport filter"
11637 .cindex "transport" "filter"
11638 .vindex "&$pipe_addresses$&"
11639 This is not an expansion variable, but is mentioned here because the string
11640 &`$pipe_addresses`& is handled specially in the command specification for the
11641 &(pipe)& transport (chapter &<<CHAPpipetransport>>&) and in transport filters
11642 (described under &%transport_filter%& in chapter &<<CHAPtransportgeneric>>&).
11643 It cannot be used in general expansion strings, and provokes an &"unknown
11644 variable"& error if encountered.
11645
11646 .vitem &$primary_hostname$&
11647 .vindex "&$primary_hostname$&"
11648 This variable contains the value set by &%primary_hostname%& in the
11649 configuration file, or read by the &[uname()]& function. If &[uname()]& returns
11650 a single-component name, Exim calls &[gethostbyname()]& (or
11651 &[getipnodebyname()]& where available) in an attempt to acquire a fully
11652 qualified host name. See also &$smtp_active_hostname$&.
11653
11654
11655 .vitem &$prvscheck_address$&
11656 This variable is used in conjunction with the &%prvscheck%& expansion item,
11657 which is described in sections &<<SECTexpansionitems>>& and
11658 &<<SECTverifyPRVS>>&.
11659
11660 .vitem &$prvscheck_keynum$&
11661 This variable is used in conjunction with the &%prvscheck%& expansion item,
11662 which is described in sections &<<SECTexpansionitems>>& and
11663 &<<SECTverifyPRVS>>&.
11664
11665 .vitem &$prvscheck_result$&
11666 This variable is used in conjunction with the &%prvscheck%& expansion item,
11667 which is described in sections &<<SECTexpansionitems>>& and
11668 &<<SECTverifyPRVS>>&.
11669
11670 .vitem &$qualify_domain$&
11671 .vindex "&$qualify_domain$&"
11672 The value set for the &%qualify_domain%& option in the configuration file.
11673
11674 .vitem &$qualify_recipient$&
11675 .vindex "&$qualify_recipient$&"
11676 The value set for the &%qualify_recipient%& option in the configuration file,
11677 or if not set, the value of &$qualify_domain$&.
11678
11679 .vitem &$rcpt_count$&
11680 .vindex "&$rcpt_count$&"
11681 When a message is being received by SMTP, this variable contains the number of
11682 RCPT commands received for the current message. If this variable is used in a
11683 RCPT ACL, its value includes the current command.
11684
11685 .vitem &$rcpt_defer_count$&
11686 .vindex "&$rcpt_defer_count$&"
11687 .cindex "4&'xx'& responses" "count of"
11688 When a message is being received by SMTP, this variable contains the number of
11689 RCPT commands in the current message that have previously been rejected with a
11690 temporary (4&'xx'&) response.
11691
11692 .vitem &$rcpt_fail_count$&
11693 .vindex "&$rcpt_fail_count$&"
11694 When a message is being received by SMTP, this variable contains the number of
11695 RCPT commands in the current message that have previously been rejected with a
11696 permanent (5&'xx'&) response.
11697
11698 .vitem &$received_count$&
11699 .vindex "&$received_count$&"
11700 This variable contains the number of &'Received:'& header lines in the message,
11701 including the one added by Exim (so its value is always greater than zero). It
11702 is available in the DATA ACL, the non-SMTP ACL, and while routing and
11703 delivering.
11704
11705 .vitem &$received_for$&
11706 .vindex "&$received_for$&"
11707 If there is only a single recipient address in an incoming message, this
11708 variable contains that address when the &'Received:'& header line is being
11709 built. The value is copied after recipient rewriting has happened, but before
11710 the &[local_scan()]& function is run.
11711
11712 .vitem &$received_ip_address$&
11713 .vindex "&$received_ip_address$&"
11714 As soon as an Exim server starts processing an incoming TCP/IP connection, this
11715 variable is set to the address of the local IP interface, and &$received_port$&
11716 is set to the local port number. (The remote IP address and port are in
11717 &$sender_host_address$& and &$sender_host_port$&.) When testing with &%-bh%&,
11718 the port value is -1 unless it has been set using the &%-oMi%& command line
11719 option.
11720
11721 As well as being useful in ACLs (including the &"connect"& ACL), these variable
11722 could be used, for example, to make the file name for a TLS certificate depend
11723 on which interface and/or port is being used for the incoming connection. The
11724 values of &$received_ip_address$& and &$received_port$& are saved with any
11725 messages that are received, thus making these variables available at delivery
11726 time.
11727
11728 &*Note:*& There are no equivalent variables for outgoing connections, because
11729 the values are unknown (unless they are explicitly set by options of the
11730 &(smtp)& transport).
11731
11732 .vitem &$received_port$&
11733 .vindex "&$received_port$&"
11734 See &$received_ip_address$&.
11735
11736 .vitem &$received_protocol$&
11737 .vindex "&$received_protocol$&"
11738 When a message is being processed, this variable contains the name of the
11739 protocol by which it was received. Most of the names used by Exim are defined
11740 by RFCs 821, 2821, and 3848. They start with &"smtp"& (the client used HELO) or
11741 &"esmtp"& (the client used EHLO). This can be followed by &"s"& for secure
11742 (encrypted) and/or &"a"& for authenticated. Thus, for example, if the protocol
11743 is set to &"esmtpsa"&, the message was received over an encrypted SMTP
11744 connection and the client was successfully authenticated.
11745
11746 Exim uses the protocol name &"smtps"& for the case when encryption is
11747 automatically set up on connection without the use of STARTTLS (see
11748 &%tls_on_connect_ports%&), and the client uses HELO to initiate the
11749 encrypted SMTP session. The name &"smtps"& is also used for the rare situation
11750 where the client initially uses EHLO, sets up an encrypted connection using
11751 STARTTLS, and then uses HELO afterwards.
11752
11753 The &%-oMr%& option provides a way of specifying a custom protocol name for
11754 messages that are injected locally by trusted callers. This is commonly used to
11755 identify messages that are being re-injected after some kind of scanning.
11756
11757 .vitem &$received_time$&
11758 .vindex "&$received_time$&"
11759 This variable contains the date and time when the current message was received,
11760 as a number of seconds since the start of the Unix epoch.
11761
11762 .vitem &$recipient_data$&
11763 .vindex "&$recipient_data$&"
11764 This variable is set after an indexing lookup success in an ACL &%recipients%&
11765 condition. It contains the data from the lookup, and the value remains set
11766 until the next &%recipients%& test. Thus, you can do things like this:
11767 .display
11768 &`require recipients  = cdb*@;/some/file`&
11769 &`deny    `&&'some further test involving'& &`$recipient_data`&
11770 .endd
11771 &*Warning*&: This variable is set only when a lookup is used as an indexing
11772 method in the address list, using the semicolon syntax as in the example above.
11773 The variable is not set for a lookup that is used as part of the string
11774 expansion that all such lists undergo before being interpreted.
11775
11776 .vitem &$recipient_verify_failure$&
11777 .vindex "&$recipient_verify_failure$&"
11778 In an ACL, when a recipient verification fails, this variable contains
11779 information about the failure. It is set to one of the following words:
11780
11781 .ilist
11782 &"qualify"&: The address was unqualified (no domain), and the message
11783 was neither local nor came from an exempted host.
11784
11785 .next
11786 &"route"&: Routing failed.
11787
11788 .next
11789 &"mail"&: Routing succeeded, and a callout was attempted; rejection occurred at
11790 or before the MAIL command (that is, on initial connection, HELO, or
11791 MAIL).
11792
11793 .next
11794 &"recipient"&: The RCPT command in a callout was rejected.
11795 .next
11796
11797 &"postmaster"&: The postmaster check in a callout was rejected.
11798 .endlist
11799
11800 The main use of this variable is expected to be to distinguish between
11801 rejections of MAIL and rejections of RCPT.
11802
11803 .vitem &$recipients$&
11804 .vindex "&$recipients$&"
11805 This variable contains a list of envelope recipients for a message. A comma and
11806 a space separate the addresses in the replacement text. However, the variable
11807 is not generally available, to prevent exposure of Bcc recipients in
11808 unprivileged users' filter files. You can use &$recipients$& only in these
11809 cases:
11810
11811 .olist
11812 In a system filter file.
11813 .next
11814 In the ACLs associated with the DATA command and with non-SMTP messages, that
11815 is, the ACLs defined by &%acl_smtp_predata%&, &%acl_smtp_data%&,
11816 &%acl_smtp_mime%&, &%acl_not_smtp_start%&, &%acl_not_smtp%&, and
11817 &%acl_not_smtp_mime%&.
11818 .next
11819 From within a &[local_scan()]& function.
11820 .endlist
11821
11822
11823 .vitem &$recipients_count$&
11824 .vindex "&$recipients_count$&"
11825 When a message is being processed, this variable contains the number of
11826 envelope recipients that came with the message. Duplicates are not excluded
11827 from the count. While a message is being received over SMTP, the number
11828 increases for each accepted recipient. It can be referenced in an ACL.
11829
11830
11831 .vitem &$regex_match_string$&
11832 .vindex "&$regex_match_string$&"
11833 This variable is set to contain the matching regular expression after a
11834 &%regex%& ACL condition has matched (see section &<<SECTscanregex>>&).
11835
11836
11837 .vitem &$reply_address$&
11838 .vindex "&$reply_address$&"
11839 When a message is being processed, this variable contains the contents of the
11840 &'Reply-To:'& header line if one exists and it is not empty, or otherwise the
11841 contents of the &'From:'& header line. Apart from the removal of leading
11842 white space, the value is not processed in any way. In particular, no RFC 2047
11843 decoding or character code translation takes place.
11844
11845 .vitem &$return_path$&
11846 .vindex "&$return_path$&"
11847 When a message is being delivered, this variable contains the return path &--
11848 the sender field that will be sent as part of the envelope. It is not enclosed
11849 in <> characters. At the start of routing an address, &$return_path$& has the
11850 same value as &$sender_address$&, but if, for example, an incoming message to a
11851 mailing list has been expanded by a router which specifies a different address
11852 for bounce messages, &$return_path$& subsequently contains the new bounce
11853 address, whereas &$sender_address$& always contains the original sender address
11854 that was received with the message. In other words, &$sender_address$& contains
11855 the incoming envelope sender, and &$return_path$& contains the outgoing
11856 envelope sender.
11857
11858 .vitem &$return_size_limit$&
11859 .vindex "&$return_size_limit$&"
11860 This is an obsolete name for &$bounce_return_size_limit$&.
11861
11862 .new
11863 .vitem &$router_name$&
11864 .cindex "router" "name"
11865 .cindex "name" "of router"
11866 .vindex "&$router_name$&"
11867 During the running of a router this variable contains its name.
11868 .wen
11869
11870 .vitem &$runrc$&
11871 .cindex "return code" "from &%run%& expansion"
11872 .vindex "&$runrc$&"
11873 This variable contains the return code from a command that is run by the
11874 &%${run...}%& expansion item. &*Warning*&: In a router or transport, you cannot
11875 assume the order in which option values are expanded, except for those
11876 preconditions whose order of testing is documented. Therefore, you cannot
11877 reliably expect to set &$runrc$& by the expansion of one option, and use it in
11878 another.
11879
11880 .vitem &$self_hostname$&
11881 .oindex "&%self%&" "value of host name"
11882 .vindex "&$self_hostname$&"
11883 When an address is routed to a supposedly remote host that turns out to be the
11884 local host, what happens is controlled by the &%self%& generic router option.
11885 One of its values causes the address to be passed to another router. When this
11886 happens, &$self_hostname$& is set to the name of the local host that the
11887 original router encountered. In other circumstances its contents are null.
11888
11889 .vitem &$sender_address$&
11890 .vindex "&$sender_address$&"
11891 When a message is being processed, this variable contains the sender's address
11892 that was received in the message's envelope. The case of letters in the address
11893 is retained, in both the local part and the domain. For bounce messages, the
11894 value of this variable is the empty string. See also &$return_path$&.
11895
11896 .vitem &$sender_address_data$&
11897 .vindex "&$address_data$&"
11898 .vindex "&$sender_address_data$&"
11899 If &$address_data$& is set when the routers are called from an ACL to verify a
11900 sender address, the final value is preserved in &$sender_address_data$&, to
11901 distinguish it from data from a recipient address. The value does not persist
11902 after the end of the current ACL statement. If you want to preserve it for
11903 longer, you can save it in an ACL variable.
11904
11905 .vitem &$sender_address_domain$&
11906 .vindex "&$sender_address_domain$&"
11907 The domain portion of &$sender_address$&.
11908
11909 .vitem &$sender_address_local_part$&
11910 .vindex "&$sender_address_local_part$&"
11911 The local part portion of &$sender_address$&.
11912
11913 .vitem &$sender_data$&
11914 .vindex "&$sender_data$&"
11915 This variable is set after a lookup success in an ACL &%senders%& condition or
11916 in a router &%senders%& option. It contains the data from the lookup, and the
11917 value remains set until the next &%senders%& test. Thus, you can do things like
11918 this:
11919 .display
11920 &`require senders      = cdb*@;/some/file`&
11921 &`deny    `&&'some further test involving'& &`$sender_data`&
11922 .endd
11923 &*Warning*&: This variable is set only when a lookup is used as an indexing
11924 method in the address list, using the semicolon syntax as in the example above.
11925 The variable is not set for a lookup that is used as part of the string
11926 expansion that all such lists undergo before being interpreted.
11927
11928 .vitem &$sender_fullhost$&
11929 .vindex "&$sender_fullhost$&"
11930 When a message is received from a remote host, this variable contains the host
11931 name and IP address in a single string. It ends with the IP address in square
11932 brackets, followed by a colon and a port number if the logging of ports is
11933 enabled. The format of the rest of the string depends on whether the host
11934 issued a HELO or EHLO SMTP command, and whether the host name was verified by
11935 looking up its IP address. (Looking up the IP address can be forced by the
11936 &%host_lookup%& option, independent of verification.) A plain host name at the
11937 start of the string is a verified host name; if this is not present,
11938 verification either failed or was not requested. A host name in parentheses is
11939 the argument of a HELO or EHLO command. This is omitted if it is identical to
11940 the verified host name or to the host's IP address in square brackets.
11941
11942 .vitem &$sender_helo_name$&
11943 .vindex "&$sender_helo_name$&"
11944 When a message is received from a remote host that has issued a HELO or EHLO
11945 command, the argument of that command is placed in this variable. It is also
11946 set if HELO or EHLO is used when a message is received using SMTP locally via
11947 the &%-bs%& or &%-bS%& options.
11948
11949 .vitem &$sender_host_address$&
11950 .vindex "&$sender_host_address$&"
11951 When a message is received from a remote host, this variable contains that
11952 host's IP address. For locally submitted messages, it is empty.
11953
11954 .vitem &$sender_host_authenticated$&
11955 .vindex "&$sender_host_authenticated$&"
11956 This variable contains the name (not the public name) of the authenticator
11957 driver that successfully authenticated the client from which the message was
11958 received. It is empty if there was no successful authentication. See also
11959 &$authenticated_id$&.
11960
11961 .new
11962 .vitem &$sender_host_dnssec$&
11963 .vindex "&$sender_host_dnssec$&"
11964 If &$sender_host_name$& has been populated (by reference, &%hosts_lookup%& or
11965 otherwise) then this boolean will have been set true if, and only if, the
11966 resolver library states that the reverse DNS was authenticated data.  At all
11967 other times, this variable is false.
11968
11969 It is likely that you will need to coerce DNSSEC support on in the resolver
11970 library, by setting:
11971 .code
11972 dns_use_dnssec = 1
11973 .endd
11974
11975 Exim does not perform DNSSEC validation itself, instead leaving that to a
11976 validating resolver (eg, unbound, or bind with suitable configuration).
11977
11978 Exim does not (currently) check to see if the forward DNS was also secured
11979 with DNSSEC, only the reverse DNS.
11980
11981 If you have changed &%host_lookup_order%& so that &`bydns`& is not the first
11982 mechanism in the list, then this variable will be false.
11983 .wen
11984
11985
11986 .vitem &$sender_host_name$&
11987 .vindex "&$sender_host_name$&"
11988 When a message is received from a remote host, this variable contains the
11989 host's name as obtained by looking up its IP address. For messages received by
11990 other means, this variable is empty.
11991
11992 .vindex "&$host_lookup_failed$&"
11993 If the host name has not previously been looked up, a reference to
11994 &$sender_host_name$& triggers a lookup (for messages from remote hosts).
11995 A looked up name is accepted only if it leads back to the original IP address
11996 via a forward lookup. If either the reverse or the forward lookup fails to find
11997 any data, or if the forward lookup does not yield the original IP address,
11998 &$sender_host_name$& remains empty, and &$host_lookup_failed$& is set to &"1"&.
11999
12000 .vindex "&$host_lookup_deferred$&"
12001 However, if either of the lookups cannot be completed (for example, there is a
12002 DNS timeout), &$host_lookup_deferred$& is set to &"1"&, and
12003 &$host_lookup_failed$& remains set to &"0"&.
12004
12005 Once &$host_lookup_failed$& is set to &"1"&, Exim does not try to look up the
12006 host name again if there is a subsequent reference to &$sender_host_name$&
12007 in the same Exim process, but it does try again if &$host_lookup_deferred$&
12008 is set to &"1"&.
12009
12010 Exim does not automatically look up every calling host's name. If you want
12011 maximum efficiency, you should arrange your configuration so that it avoids
12012 these lookups altogether. The lookup happens only if one or more of the
12013 following are true:
12014
12015 .ilist
12016 A string containing &$sender_host_name$& is expanded.
12017 .next
12018 The calling host matches the list in &%host_lookup%&. In the default
12019 configuration, this option is set to *, so it must be changed if lookups are
12020 to be avoided. (In the code, the default for &%host_lookup%& is unset.)
12021 .next
12022 Exim needs the host name in order to test an item in a host list. The items
12023 that require this are described in sections &<<SECThoslispatnam>>& and
12024 &<<SECThoslispatnamsk>>&.
12025 .next
12026 The calling host matches &%helo_try_verify_hosts%& or &%helo_verify_hosts%&.
12027 In this case, the host name is required to compare with the name quoted in any
12028 EHLO or HELO commands that the client issues.
12029 .next
12030 The remote host issues a EHLO or HELO command that quotes one of the
12031 domains in &%helo_lookup_domains%&. The default value of this option is
12032 . ==== As this is a nested list, any displays it contains must be indented
12033 . ==== as otherwise they are too far to the left.
12034 .code
12035   helo_lookup_domains = @ : @[]
12036 .endd
12037 which causes a lookup if a remote host (incorrectly) gives the server's name or
12038 IP address in an EHLO or HELO command.
12039 .endlist
12040
12041
12042 .vitem &$sender_host_port$&
12043 .vindex "&$sender_host_port$&"
12044 When a message is received from a remote host, this variable contains the port
12045 number that was used on the remote host.
12046
12047 .vitem &$sender_ident$&
12048 .vindex "&$sender_ident$&"
12049 When a message is received from a remote host, this variable contains the
12050 identification received in response to an RFC 1413 request. When a message has
12051 been received locally, this variable contains the login name of the user that
12052 called Exim.
12053
12054 .vitem &$sender_rate_$&&'xxx'&
12055 A number of variables whose names begin &$sender_rate_$& are set as part of the
12056 &%ratelimit%& ACL condition. Details are given in section
12057 &<<SECTratelimiting>>&.
12058
12059 .vitem &$sender_rcvhost$&
12060 .cindex "DNS" "reverse lookup"
12061 .cindex "reverse DNS lookup"
12062 .vindex "&$sender_rcvhost$&"
12063 This is provided specifically for use in &'Received:'& headers. It starts with
12064 either the verified host name (as obtained from a reverse DNS lookup) or, if
12065 there is no verified host name, the IP address in square brackets. After that
12066 there may be text in parentheses. When the first item is a verified host name,
12067 the first thing in the parentheses is the IP address in square brackets,
12068 followed by a colon and a port number if port logging is enabled. When the
12069 first item is an IP address, the port is recorded as &"port=&'xxxx'&"& inside
12070 the parentheses.
12071
12072 There may also be items of the form &"helo=&'xxxx'&"& if HELO or EHLO
12073 was used and its argument was not identical to the real host name or IP
12074 address, and &"ident=&'xxxx'&"& if an RFC 1413 ident string is available. If
12075 all three items are present in the parentheses, a newline and tab are inserted
12076 into the string, to improve the formatting of the &'Received:'& header.
12077
12078 .vitem &$sender_verify_failure$&
12079 .vindex "&$sender_verify_failure$&"
12080 In an ACL, when a sender verification fails, this variable contains information
12081 about the failure. The details are the same as for
12082 &$recipient_verify_failure$&.
12083
12084 .vitem &$sending_ip_address$&
12085 .vindex "&$sending_ip_address$&"
12086 This variable is set whenever an outgoing SMTP connection to another host has
12087 been set up. It contains the IP address of the local interface that is being
12088 used. This is useful if a host that has more than one IP address wants to take
12089 on different personalities depending on which one is being used. For incoming
12090 connections, see &$received_ip_address$&.
12091
12092 .vitem &$sending_port$&
12093 .vindex "&$sending_port$&"
12094 This variable is set whenever an outgoing SMTP connection to another host has
12095 been set up. It contains the local port that is being used. For incoming
12096 connections, see &$received_port$&.
12097
12098 .vitem &$smtp_active_hostname$&
12099 .vindex "&$smtp_active_hostname$&"
12100 During an incoming SMTP session, this variable contains the value of the active
12101 host name, as specified by the &%smtp_active_hostname%& option. The value of
12102 &$smtp_active_hostname$& is saved with any message that is received, so its
12103 value can be consulted during routing and delivery.
12104
12105 .vitem &$smtp_command$&
12106 .vindex "&$smtp_command$&"
12107 During the processing of an incoming SMTP command, this variable contains the
12108 entire command. This makes it possible to distinguish between HELO and EHLO in
12109 the HELO ACL, and also to distinguish between commands such as these:
12110 .code
12111 MAIL FROM:<>
12112 MAIL FROM: <>
12113 .endd
12114 For a MAIL command, extra parameters such as SIZE can be inspected. For a RCPT
12115 command, the address in &$smtp_command$& is the original address before any
12116 rewriting, whereas the values in &$local_part$& and &$domain$& are taken from
12117 the address after SMTP-time rewriting.
12118
12119 .vitem &$smtp_command_argument$&
12120 .cindex "SMTP" "command, argument for"
12121 .vindex "&$smtp_command_argument$&"
12122 While an ACL is running to check an SMTP command, this variable contains the
12123 argument, that is, the text that follows the command name, with leading white
12124 space removed. Following the introduction of &$smtp_command$&, this variable is
12125 somewhat redundant, but is retained for backwards compatibility.
12126
12127 .vitem &$smtp_count_at_connection_start$&
12128 .vindex "&$smtp_count_at_connection_start$&"
12129 This variable is set greater than zero only in processes spawned by the Exim
12130 daemon for handling incoming SMTP connections. The name is deliberately long,
12131 in order to emphasize what the contents are. When the daemon accepts a new
12132 connection, it increments this variable. A copy of the variable is passed to
12133 the child process that handles the connection, but its value is fixed, and
12134 never changes. It is only an approximation of how many incoming connections
12135 there actually are, because many other connections may come and go while a
12136 single connection is being processed. When a child process terminates, the
12137 daemon decrements its copy of the variable.
12138
12139 .vitem "&$sn0$& &-- &$sn9$&"
12140 These variables are copies of the values of the &$n0$& &-- &$n9$& accumulators
12141 that were current at the end of the system filter file. This allows a system
12142 filter file to set values that can be tested in users' filter files. For
12143 example, a system filter could set a value indicating how likely it is that a
12144 message is junk mail.
12145
12146 .vitem &$spam_$&&'xxx'&
12147 A number of variables whose names start with &$spam$& are available when Exim
12148 is compiled with the content-scanning extension. For details, see section
12149 &<<SECTscanspamass>>&.
12150
12151
12152 .vitem &$spool_directory$&
12153 .vindex "&$spool_directory$&"
12154 The name of Exim's spool directory.
12155
12156 .vitem &$spool_inodes$&
12157 .vindex "&$spool_inodes$&"
12158 The number of free inodes in the disk partition where Exim's spool files are
12159 being written. The value is recalculated whenever the variable is referenced.
12160 If the relevant file system does not have the concept of inodes, the value of
12161 is -1. See also the &%check_spool_inodes%& option.
12162
12163 .vitem &$spool_space$&
12164 .vindex "&$spool_space$&"
12165 The amount of free space (as a number of kilobytes) in the disk partition where
12166 Exim's spool files are being written. The value is recalculated whenever the
12167 variable is referenced. If the operating system does not have the ability to
12168 find the amount of free space (only true for experimental systems), the space
12169 value is -1. For example, to check in an ACL that there is at least 50
12170 megabytes free on the spool, you could write:
12171 .code
12172 condition = ${if > {$spool_space}{50000}}
12173 .endd
12174 See also the &%check_spool_space%& option.
12175
12176
12177 .vitem &$thisaddress$&
12178 .vindex "&$thisaddress$&"
12179 This variable is set only during the processing of the &%foranyaddress%&
12180 command in a filter file. Its use is explained in the description of that
12181 command, which can be found in the separate document entitled &'Exim's
12182 interfaces to mail filtering'&.
12183
12184 .new
12185 .vitem &$tls_in_bits$&
12186 .vindex "&$tls_in_bits$&"
12187 Contains an approximation of the TLS cipher's bit-strength
12188 on the inbound connection; the meaning of
12189 this depends upon the TLS implementation used.
12190 If TLS has not been negotiated, the value will be 0.
12191 The value of this is automatically fed into the Cyrus SASL authenticator
12192 when acting as a server, to specify the "external SSF" (a SASL term).
12193
12194 The deprecated &$tls_bits$& variable refers to the inbound side
12195 except when used in the context of an outbound SMTP delivery, when it refers to
12196 the outbound.
12197
12198 .vitem &$tls_out_bits$&
12199 .vindex "&$tls_out_bits$&"
12200 Contains an approximation of the TLS cipher's bit-strength
12201 on an outbound SMTP connection; the meaning of
12202 this depends upon the TLS implementation used.
12203 If TLS has not been negotiated, the value will be 0.
12204
12205 .vitem &$tls_in_certificate_verified$&
12206 .vindex "&$tls_in_certificate_verified$&"
12207 This variable is set to &"1"& if a TLS certificate was verified when the
12208 message was received, and &"0"& otherwise.
12209
12210 The deprecated &$tls_certificate_verfied$& variable refers to the inbound side
12211 except when used in the context of an outbound SMTP delivery, when it refers to
12212 the outbound.
12213
12214 .vitem &$tls_out_certificate_verified$&
12215 .vindex "&$tls_out_certificate_verified$&"
12216 This variable is set to &"1"& if a TLS certificate was verified when an
12217 outbound SMTP connection was made,
12218 and &"0"& otherwise.
12219
12220 .vitem &$tls_in_cipher$&
12221 .vindex "&$tls_in_cipher$&"
12222 .vindex "&$tls_cipher$&"
12223 When a message is received from a remote host over an encrypted SMTP
12224 connection, this variable is set to the cipher suite that was negotiated, for
12225 example DES-CBC3-SHA. In other circumstances, in particular, for message
12226 received over unencrypted connections, the variable is empty. Testing
12227 &$tls_cipher$& for emptiness is one way of distinguishing between encrypted and
12228 non-encrypted connections during ACL processing.
12229
12230 The deprecated &$tls_cipher$& variable is the same as &$tls_in_cipher$& during message reception,
12231 but in the context of an outward SMTP delivery taking place via the &(smtp)& transport
12232 becomes the same as &$tls_out_cipher$&.
12233
12234 .vitem &$tls_out_cipher$&
12235 .vindex "&$tls_out_cipher$&"
12236 This variable is
12237 cleared before any outgoing SMTP connection is made,
12238 and then set to the outgoing cipher suite if one is negotiated. See chapter
12239 &<<CHAPTLS>>& for details of TLS support and chapter &<<CHAPsmtptrans>>& for
12240 details of the &(smtp)& transport.
12241
12242 .vitem &$tls_in_peerdn$&
12243 .vindex "&$tls_in_peerdn$&"
12244 .vindex "&$tls_peerdn$&"
12245 When a message is received from a remote host over an encrypted SMTP
12246 connection, and Exim is configured to request a certificate from the client,
12247 the value of the Distinguished Name of the certificate is made available in the
12248 &$tls_in_peerdn$& during subsequent processing.
12249
12250 The deprecated &$tls_peerdn$& variable refers to the inbound side
12251 except when used in the context of an outbound SMTP delivery, when it refers to
12252 the outbound.
12253
12254 .vitem &$tls_out_peerdn$&
12255 .vindex "&$tls_out_peerdn$&"
12256 When a message is being delivered to a remote host over an encrypted SMTP
12257 connection, and Exim is configured to request a certificate from the server,
12258 the value of the Distinguished Name of the certificate is made available in the
12259 &$tls_out_peerdn$& during subsequent processing.
12260
12261 .vitem &$tls_in_sni$&
12262 .vindex "&$tls_in_sni$&"
12263 .vindex "&$tls_sni$&"
12264 .cindex "TLS" "Server Name Indication"
12265 When a TLS session is being established, if the client sends the Server
12266 Name Indication extension, the value will be placed in this variable.
12267 If the variable appears in &%tls_certificate%& then this option and
12268 some others, described in &<<SECTtlssni>>&,
12269 will be re-expanded early in the TLS session, to permit
12270 a different certificate to be presented (and optionally a different key to be
12271 used) to the client, based upon the value of the SNI extension.
12272
12273 The deprecated &$tls_sni$& variable refers to the inbound side
12274 except when used in the context of an outbound SMTP delivery, when it refers to
12275 the outbound.
12276
12277 .vitem &$tls_out_sni$&
12278 .vindex "&$tls_out_sni$&"
12279 .cindex "TLS" "Server Name Indication"
12280 During outbound
12281 SMTP deliveries, this variable reflects the value of the &%tls_sni%& option on
12282 the transport.
12283 .wen
12284
12285 .vitem &$tod_bsdinbox$&
12286 .vindex "&$tod_bsdinbox$&"
12287 The time of day and the date, in the format required for BSD-style mailbox
12288 files, for example: Thu Oct 17 17:14:09 1995.
12289
12290 .vitem &$tod_epoch$&
12291 .vindex "&$tod_epoch$&"
12292 The time and date as a number of seconds since the start of the Unix epoch.
12293
12294 .vitem &$tod_epoch_l$&
12295 .vindex "&$tod_epoch_l$&"
12296 The time and date as a number of microseconds since the start of the Unix epoch.
12297
12298 .vitem &$tod_full$&
12299 .vindex "&$tod_full$&"
12300 A full version of the time and date, for example: Wed, 16 Oct 1995 09:51:40
12301 +0100. The timezone is always given as a numerical offset from UTC, with
12302 positive values used for timezones that are ahead (east) of UTC, and negative
12303 values for those that are behind (west).
12304
12305 .vitem &$tod_log$&
12306 .vindex "&$tod_log$&"
12307 The time and date in the format used for writing Exim's log files, for example:
12308 1995-10-12 15:32:29, but without a timezone.
12309
12310 .vitem &$tod_logfile$&
12311 .vindex "&$tod_logfile$&"
12312 This variable contains the date in the format yyyymmdd. This is the format that
12313 is used for datestamping log files when &%log_file_path%& contains the &`%D`&
12314 flag.
12315
12316 .vitem &$tod_zone$&
12317 .vindex "&$tod_zone$&"
12318 This variable contains the numerical value of the local timezone, for example:
12319 -0500.
12320
12321 .vitem &$tod_zulu$&
12322 .vindex "&$tod_zulu$&"
12323 This variable contains the UTC date and time in &"Zulu"& format, as specified
12324 by ISO 8601, for example: 20030221154023Z.
12325
12326 .new
12327 .vitem &$transport_name$&
12328 .cindex "transport" "name"
12329 .cindex "name" "of transport"
12330 .vindex "&$transport_name$&"
12331 During the running of a transport, this variable contains its name.
12332 .wen
12333
12334 .vitem &$value$&
12335 .vindex "&$value$&"
12336 This variable contains the result of an expansion lookup, extraction operation,
12337 or external command, as described above. It is also used during a
12338 &*reduce*& expansion.
12339
12340 .vitem &$version_number$&
12341 .vindex "&$version_number$&"
12342 The version number of Exim.
12343
12344 .vitem &$warn_message_delay$&
12345 .vindex "&$warn_message_delay$&"
12346 This variable is set only during the creation of a message warning about a
12347 delivery delay. Details of its use are explained in section &<<SECTcustwarn>>&.
12348
12349 .vitem &$warn_message_recipients$&
12350 .vindex "&$warn_message_recipients$&"
12351 This variable is set only during the creation of a message warning about a
12352 delivery delay. Details of its use are explained in section &<<SECTcustwarn>>&.
12353 .endlist
12354 .ecindex IIDstrexp
12355
12356
12357
12358 . ////////////////////////////////////////////////////////////////////////////
12359 . ////////////////////////////////////////////////////////////////////////////
12360
12361 .chapter "Embedded Perl" "CHAPperl"
12362 .scindex IIDperl "Perl" "calling from Exim"
12363 Exim can be built to include an embedded Perl interpreter. When this is done,
12364 Perl subroutines can be called as part of the string expansion process. To make
12365 use of the Perl support, you need version 5.004 or later of Perl installed on
12366 your system. To include the embedded interpreter in the Exim binary, include
12367 the line
12368 .code
12369 EXIM_PERL = perl.o
12370 .endd
12371 in your &_Local/Makefile_& and then build Exim in the normal way.
12372
12373
12374 .section "Setting up so Perl can be used" "SECID85"
12375 .oindex "&%perl_startup%&"
12376 Access to Perl subroutines is via a global configuration option called
12377 &%perl_startup%& and an expansion string operator &%${perl ...}%&. If there is
12378 no &%perl_startup%& option in the Exim configuration file then no Perl
12379 interpreter is started and there is almost no overhead for Exim (since none of
12380 the Perl library will be paged in unless used). If there is a &%perl_startup%&
12381 option then the associated value is taken to be Perl code which is executed in
12382 a newly created Perl interpreter.
12383
12384 The value of &%perl_startup%& is not expanded in the Exim sense, so you do not
12385 need backslashes before any characters to escape special meanings. The option
12386 should usually be something like
12387 .code
12388 perl_startup = do '/etc/exim.pl'
12389 .endd
12390 where &_/etc/exim.pl_& is Perl code which defines any subroutines you want to
12391 use from Exim. Exim can be configured either to start up a Perl interpreter as
12392 soon as it is entered, or to wait until the first time it is needed. Starting
12393 the interpreter at the beginning ensures that it is done while Exim still has
12394 its setuid privilege, but can impose an unnecessary overhead if Perl is not in
12395 fact used in a particular run. Also, note that this does not mean that Exim is
12396 necessarily running as root when Perl is called at a later time. By default,
12397 the interpreter is started only when it is needed, but this can be changed in
12398 two ways:
12399
12400 .ilist
12401 .oindex "&%perl_at_start%&"
12402 Setting &%perl_at_start%& (a boolean option) in the configuration requests
12403 a startup when Exim is entered.
12404 .next
12405 The command line option &%-ps%& also requests a startup when Exim is entered,
12406 overriding the setting of &%perl_at_start%&.
12407 .endlist
12408
12409 There is also a command line option &%-pd%& (for delay) which suppresses the
12410 initial startup, even if &%perl_at_start%& is set.
12411
12412
12413 .section "Calling Perl subroutines" "SECID86"
12414 When the configuration file includes a &%perl_startup%& option you can make use
12415 of the string expansion item to call the Perl subroutines that are defined
12416 by the &%perl_startup%& code. The operator is used in any of the following
12417 forms:
12418 .code
12419 ${perl{foo}}
12420 ${perl{foo}{argument}}
12421 ${perl{foo}{argument1}{argument2} ... }
12422 .endd
12423 which calls the subroutine &%foo%& with the given arguments. A maximum of eight
12424 arguments may be passed. Passing more than this results in an expansion failure
12425 with an error message of the form
12426 .code
12427 Too many arguments passed to Perl subroutine "foo" (max is 8)
12428 .endd
12429 The return value of the Perl subroutine is evaluated in a scalar context before
12430 it is passed back to Exim to be inserted into the expanded string. If the
12431 return value is &'undef'&, the expansion is forced to fail in the same way as
12432 an explicit &"fail"& on an &%if%& or &%lookup%& item. If the subroutine aborts
12433 by obeying Perl's &%die%& function, the expansion fails with the error message
12434 that was passed to &%die%&.
12435
12436
12437 .section "Calling Exim functions from Perl" "SECID87"
12438 Within any Perl code called from Exim, the function &'Exim::expand_string()'&
12439 is available to call back into Exim's string expansion function. For example,
12440 the Perl code
12441 .code
12442 my $lp = Exim::expand_string('$local_part');
12443 .endd
12444 makes the current Exim &$local_part$& available in the Perl variable &$lp$&.
12445 Note those are single quotes and not double quotes to protect against
12446 &$local_part$& being interpolated as a Perl variable.
12447
12448 If the string expansion is forced to fail by a &"fail"& item, the result of
12449 &'Exim::expand_string()'& is &%undef%&. If there is a syntax error in the
12450 expansion string, the Perl call from the original expansion string fails with
12451 an appropriate error message, in the same way as if &%die%& were used.
12452
12453 .cindex "debugging" "from embedded Perl"
12454 .cindex "log" "writing from embedded Perl"
12455 Two other Exim functions are available for use from within Perl code.
12456 &'Exim::debug_write()'& writes a string to the standard error stream if Exim's
12457 debugging is enabled. If you want a newline at the end, you must supply it.
12458 &'Exim::log_write()'& writes a string to Exim's main log, adding a leading
12459 timestamp. In this case, you should not supply a terminating newline.
12460
12461
12462 .section "Use of standard output and error by Perl" "SECID88"
12463 .cindex "Perl" "standard output and error"
12464 You should not write to the standard error or output streams from within your
12465 Perl code, as it is not defined how these are set up. In versions of Exim
12466 before 4.50, it is possible for the standard output or error to refer to the
12467 SMTP connection during message reception via the daemon. Writing to this stream
12468 is certain to cause chaos. From Exim 4.50 onwards, the standard output and
12469 error streams are connected to &_/dev/null_& in the daemon. The chaos is
12470 avoided, but the output is lost.
12471
12472 .cindex "Perl" "use of &%warn%&"
12473 The Perl &%warn%& statement writes to the standard error stream by default.
12474 Calls to &%warn%& may be embedded in Perl modules that you use, but over which
12475 you have no control. When Exim starts up the Perl interpreter, it arranges for
12476 output from the &%warn%& statement to be written to the Exim main log. You can
12477 change this by including appropriate Perl magic somewhere in your Perl code.
12478 For example, to discard &%warn%& output completely, you need this:
12479 .code
12480 $SIG{__WARN__} = sub { };
12481 .endd
12482 Whenever a &%warn%& is obeyed, the anonymous subroutine is called. In this
12483 example, the code for the subroutine is empty, so it does nothing, but you can
12484 include any Perl code that you like. The text of the &%warn%& message is passed
12485 as the first subroutine argument.
12486 .ecindex IIDperl
12487
12488
12489 . ////////////////////////////////////////////////////////////////////////////
12490 . ////////////////////////////////////////////////////////////////////////////
12491
12492 .chapter "Starting the daemon and the use of network interfaces" &&&
12493          "CHAPinterfaces" &&&
12494          "Starting the daemon"
12495 .cindex "daemon" "starting"
12496 .cindex "interface" "listening"
12497 .cindex "network interface"
12498 .cindex "interface" "network"
12499 .cindex "IP address" "for listening"
12500 .cindex "daemon" "listening IP addresses"
12501 .cindex "TCP/IP" "setting listening interfaces"
12502 .cindex "TCP/IP" "setting listening ports"
12503 A host that is connected to a TCP/IP network may have one or more physical
12504 hardware network interfaces. Each of these interfaces may be configured as one
12505 or more &"logical"& interfaces, which are the entities that a program actually
12506 works with. Each of these logical interfaces is associated with an IP address.
12507 In addition, TCP/IP software supports &"loopback"& interfaces (127.0.0.1 in
12508 IPv4 and ::1 in IPv6), which do not use any physical hardware. Exim requires
12509 knowledge about the host's interfaces for use in three different circumstances:
12510
12511 .olist
12512 When a listening daemon is started, Exim needs to know which interfaces
12513 and ports to listen on.
12514 .next
12515 When Exim is routing an address, it needs to know which IP addresses
12516 are associated with local interfaces. This is required for the correct
12517 processing of MX lists by removing the local host and others with the
12518 same or higher priority values. Also, Exim needs to detect cases
12519 when an address is routed to an IP address that in fact belongs to the
12520 local host. Unless the &%self%& router option or the &%allow_localhost%&
12521 option of the smtp transport is set (as appropriate), this is treated
12522 as an error situation.
12523 .next
12524 When Exim connects to a remote host, it may need to know which interface to use
12525 for the outgoing connection.
12526 .endlist
12527
12528
12529 Exim's default behaviour is likely to be appropriate in the vast majority
12530 of cases. If your host has only one interface, and you want all its IP
12531 addresses to be treated in the same way, and you are using only the
12532 standard SMTP port, you should not need to take any special action. The
12533 rest of this chapter does not apply to you.
12534
12535 In a more complicated situation you may want to listen only on certain
12536 interfaces, or on different ports, and for this reason there are a number of
12537 options that can be used to influence Exim's behaviour. The rest of this
12538 chapter describes how they operate.
12539
12540 When a message is received over TCP/IP, the interface and port that were
12541 actually used are set in &$received_ip_address$& and &$received_port$&.
12542
12543
12544
12545 .section "Starting a listening daemon" "SECID89"
12546 When a listening daemon is started (by means of the &%-bd%& command line
12547 option), the interfaces and ports on which it listens are controlled by the
12548 following options:
12549
12550 .ilist
12551 &%daemon_smtp_ports%& contains a list of default ports. (For backward
12552 compatibility, this option can also be specified in the singular.)
12553 .next
12554 &%local_interfaces%& contains list of interface IP addresses on which to
12555 listen. Each item may optionally also specify a port.
12556 .endlist
12557
12558 The default list separator in both cases is a colon, but this can be changed as
12559 described in section &<<SECTlistconstruct>>&. When IPv6 addresses are involved,
12560 it is usually best to change the separator to avoid having to double all the
12561 colons. For example:
12562 .code
12563 local_interfaces = <; 127.0.0.1 ; \
12564                       192.168.23.65 ; \
12565                       ::1 ; \
12566                       3ffe:ffff:836f::fe86:a061
12567 .endd
12568 There are two different formats for specifying a port along with an IP address
12569 in &%local_interfaces%&:
12570
12571 .olist
12572 The port is added onto the address with a dot separator. For example, to listen
12573 on port 1234 on two different IP addresses:
12574 .code
12575 local_interfaces = <; 192.168.23.65.1234 ; \
12576                       3ffe:ffff:836f::fe86:a061.1234
12577 .endd
12578 .next
12579 The IP address is enclosed in square brackets, and the port is added
12580 with a colon separator, for example:
12581 .code
12582 local_interfaces = <; [192.168.23.65]:1234 ; \
12583                       [3ffe:ffff:836f::fe86:a061]:1234
12584 .endd
12585 .endlist
12586
12587 When a port is not specified, the value of &%daemon_smtp_ports%& is used. The
12588 default setting contains just one port:
12589 .code
12590 daemon_smtp_ports = smtp
12591 .endd
12592 If more than one port is listed, each interface that does not have its own port
12593 specified listens on all of them. Ports that are listed in
12594 &%daemon_smtp_ports%& can be identified either by name (defined in
12595 &_/etc/services_&) or by number. However, when ports are given with individual
12596 IP addresses in &%local_interfaces%&, only numbers (not names) can be used.
12597
12598
12599
12600 .section "Special IP listening addresses" "SECID90"
12601 The addresses 0.0.0.0 and ::0 are treated specially. They are interpreted
12602 as &"all IPv4 interfaces"& and &"all IPv6 interfaces"&, respectively. In each
12603 case, Exim tells the TCP/IP stack to &"listen on all IPv&'x'& interfaces"&
12604 instead of setting up separate listening sockets for each interface. The
12605 default value of &%local_interfaces%& is
12606 .code
12607 local_interfaces = 0.0.0.0
12608 .endd
12609 when Exim is built without IPv6 support; otherwise it is:
12610 .code
12611 local_interfaces = <; ::0 ; 0.0.0.0
12612 .endd
12613 Thus, by default, Exim listens on all available interfaces, on the SMTP port.
12614
12615
12616
12617 .section "Overriding local_interfaces and daemon_smtp_ports" "SECID91"
12618 The &%-oX%& command line option can be used to override the values of
12619 &%daemon_smtp_ports%& and/or &%local_interfaces%& for a particular daemon
12620 instance. Another way of doing this would be to use macros and the &%-D%&
12621 option. However, &%-oX%& can be used by any admin user, whereas modification of
12622 the runtime configuration by &%-D%& is allowed only when the caller is root or
12623 exim.
12624
12625 The value of &%-oX%& is a list of items. The default colon separator can be
12626 changed in the usual way if required. If there are any items that do not
12627 contain dots or colons (that is, are not IP addresses), the value of
12628 &%daemon_smtp_ports%& is replaced by the list of those items. If there are any
12629 items that do contain dots or colons, the value of &%local_interfaces%& is
12630 replaced by those items. Thus, for example,
12631 .code
12632 -oX 1225
12633 .endd
12634 overrides &%daemon_smtp_ports%&, but leaves &%local_interfaces%& unchanged,
12635 whereas
12636 .code
12637 -oX 192.168.34.5.1125
12638 .endd
12639 overrides &%local_interfaces%&, leaving &%daemon_smtp_ports%& unchanged.
12640 (However, since &%local_interfaces%& now contains no items without ports, the
12641 value of &%daemon_smtp_ports%& is no longer relevant in this example.)
12642
12643
12644
12645 .section "Support for the obsolete SSMTP (or SMTPS) protocol" "SECTsupobssmt"
12646 .cindex "ssmtp protocol"
12647 .cindex "smtps protocol"
12648 .cindex "SMTP" "ssmtp protocol"
12649 .cindex "SMTP" "smtps protocol"
12650 Exim supports the obsolete SSMTP protocol (also known as SMTPS) that was used
12651 before the STARTTLS command was standardized for SMTP. Some legacy clients
12652 still use this protocol. If the &%tls_on_connect_ports%& option is set to a
12653 list of port numbers, connections to those ports must use SSMTP. The most
12654 common use of this option is expected to be
12655 .code
12656 tls_on_connect_ports = 465
12657 .endd
12658 because 465 is the usual port number used by the legacy clients. There is also
12659 a command line option &%-tls-on-connect%&, which forces all ports to behave in
12660 this way when a daemon is started.
12661
12662 &*Warning*&: Setting &%tls_on_connect_ports%& does not of itself cause the
12663 daemon to listen on those ports. You must still specify them in
12664 &%daemon_smtp_ports%&, &%local_interfaces%&, or the &%-oX%& option. (This is
12665 because &%tls_on_connect_ports%& applies to &%inetd%& connections as well as to
12666 connections via the daemon.)
12667
12668
12669
12670
12671 .section "IPv6 address scopes" "SECID92"
12672 .cindex "IPv6" "address scopes"
12673 IPv6 addresses have &"scopes"&, and a host with multiple hardware interfaces
12674 can, in principle, have the same link-local IPv6 address on different
12675 interfaces. Thus, additional information is needed, over and above the IP
12676 address, to distinguish individual interfaces. A convention of using a
12677 percent sign followed by something (often the interface name) has been
12678 adopted in some cases, leading to addresses like this:
12679 .code
12680 fe80::202:b3ff:fe03:45c1%eth0
12681 .endd
12682 To accommodate this usage, a percent sign followed by an arbitrary string is
12683 allowed at the end of an IPv6 address. By default, Exim calls &[getaddrinfo()]&
12684 to convert a textual IPv6 address for actual use. This function recognizes the
12685 percent convention in operating systems that support it, and it processes the
12686 address appropriately. Unfortunately, some older libraries have problems with
12687 &[getaddrinfo()]&. If
12688 .code
12689 IPV6_USE_INET_PTON=yes
12690 .endd
12691 is set in &_Local/Makefile_& (or an OS-dependent Makefile) when Exim is built,
12692 Exim uses &'inet_pton()'& to convert a textual IPv6 address for actual use,
12693 instead of &[getaddrinfo()]&. (Before version 4.14, it always used this
12694 function.) Of course, this means that the additional functionality of
12695 &[getaddrinfo()]& &-- recognizing scoped addresses &-- is lost.
12696
12697 .section "Disabling IPv6" "SECID93"
12698 .cindex "IPv6" "disabling"
12699 Sometimes it happens that an Exim binary that was compiled with IPv6 support is
12700 run on a host whose kernel does not support IPv6. The binary will fall back to
12701 using IPv4, but it may waste resources looking up AAAA records, and trying to
12702 connect to IPv6 addresses, causing delays to mail delivery. If you set the
12703 .oindex "&%disable_ipv6%&"
12704 &%disable_ipv6%& option true, even if the Exim binary has IPv6 support, no IPv6
12705 activities take place. AAAA records are never looked up, and any IPv6 addresses
12706 that are listed in &%local_interfaces%&, data for the &(manualroute)& router,
12707 etc. are ignored. If IP literals are enabled, the &(ipliteral)& router declines
12708 to handle IPv6 literal addresses.
12709
12710 On the other hand, when IPv6 is in use, there may be times when you want to
12711 disable it for certain hosts or domains. You can use the &%dns_ipv4_lookup%&
12712 option to globally suppress the lookup of AAAA records for specified domains,
12713 and you can use the &%ignore_target_hosts%& generic router option to ignore
12714 IPv6 addresses in an individual router.
12715
12716
12717
12718 .section "Examples of starting a listening daemon" "SECID94"
12719 The default case in an IPv6 environment is
12720 .code
12721 daemon_smtp_ports = smtp
12722 local_interfaces = <; ::0 ; 0.0.0.0
12723 .endd
12724 This specifies listening on the smtp port on all IPv6 and IPv4 interfaces.
12725 Either one or two sockets may be used, depending on the characteristics of
12726 the TCP/IP stack. (This is complicated and messy; for more information,
12727 read the comments in the &_daemon.c_& source file.)
12728
12729 To specify listening on ports 25 and 26 on all interfaces:
12730 .code
12731 daemon_smtp_ports = 25 : 26
12732 .endd
12733 (leaving &%local_interfaces%& at the default setting) or, more explicitly:
12734 .code
12735 local_interfaces = <; ::0.25     ; ::0.26 \
12736                       0.0.0.0.25 ; 0.0.0.0.26
12737 .endd
12738 To listen on the default port on all IPv4 interfaces, and on port 26 on the
12739 IPv4 loopback address only:
12740 .code
12741 local_interfaces = 0.0.0.0 : 127.0.0.1.26
12742 .endd
12743 To specify listening on the default port on specific interfaces only:
12744 .code
12745 local_interfaces = 10.0.0.67 : 192.168.34.67
12746 .endd
12747 &*Warning*&: Such a setting excludes listening on the loopback interfaces.
12748
12749
12750
12751 .section "Recognizing the local host" "SECTreclocipadd"
12752 The &%local_interfaces%& option is also used when Exim needs to determine
12753 whether or not an IP address refers to the local host. That is, the IP
12754 addresses of all the interfaces on which a daemon is listening are always
12755 treated as local.
12756
12757 For this usage, port numbers in &%local_interfaces%& are ignored. If either of
12758 the items 0.0.0.0 or ::0 are encountered, Exim gets a complete list of
12759 available interfaces from the operating system, and extracts the relevant
12760 (that is, IPv4 or IPv6) addresses to use for checking.
12761
12762 Some systems set up large numbers of virtual interfaces in order to provide
12763 many virtual web servers. In this situation, you may want to listen for
12764 email on only a few of the available interfaces, but nevertheless treat all
12765 interfaces as local when routing. You can do this by setting
12766 &%extra_local_interfaces%& to a list of IP addresses, possibly including the
12767 &"all"& wildcard values. These addresses are recognized as local, but are not
12768 used for listening. Consider this example:
12769 .code
12770 local_interfaces = <; 127.0.0.1 ; ::1 ; \
12771                       192.168.53.235 ; \
12772                       3ffe:2101:12:1:a00:20ff:fe86:a061
12773
12774 extra_local_interfaces = <; ::0 ; 0.0.0.0
12775 .endd
12776 The daemon listens on the loopback interfaces and just one IPv4 and one IPv6
12777 address, but all available interface addresses are treated as local when
12778 Exim is routing.
12779
12780 In some environments the local host name may be in an MX list, but with an IP
12781 address that is not assigned to any local interface. In other cases it may be
12782 desirable to treat other host names as if they referred to the local host. Both
12783 these cases can be handled by setting the &%hosts_treat_as_local%& option.
12784 This contains host names rather than IP addresses. When a host is referenced
12785 during routing, either via an MX record or directly, it is treated as the local
12786 host if its name matches &%hosts_treat_as_local%&, or if any of its IP
12787 addresses match &%local_interfaces%& or &%extra_local_interfaces%&.
12788
12789
12790
12791 .section "Delivering to a remote host" "SECID95"
12792 Delivery to a remote host is handled by the smtp transport. By default, it
12793 allows the system's TCP/IP functions to choose which interface to use (if
12794 there is more than one) when connecting to a remote host. However, the
12795 &%interface%& option can be set to specify which interface is used. See the
12796 description of the smtp transport in chapter &<<CHAPsmtptrans>>& for more
12797 details.
12798
12799
12800
12801
12802 . ////////////////////////////////////////////////////////////////////////////
12803 . ////////////////////////////////////////////////////////////////////////////
12804
12805 .chapter "Main configuration" "CHAPmainconfig"
12806 .scindex IIDconfima "configuration file" "main section"
12807 .scindex IIDmaiconf "main configuration"
12808 The first part of the run time configuration file contains three types of item:
12809
12810 .ilist
12811 Macro definitions: These lines start with an upper case letter. See section
12812 &<<SECTmacrodefs>>& for details of macro processing.
12813 .next
12814 Named list definitions: These lines start with one of the words &"domainlist"&,
12815 &"hostlist"&, &"addresslist"&, or &"localpartlist"&. Their use is described in
12816 section &<<SECTnamedlists>>&.
12817 .next
12818 Main configuration settings: Each setting occupies one line of the file
12819 (with possible continuations). If any setting is preceded by the word
12820 &"hide"&, the &%-bP%& command line option displays its value to admin users
12821 only. See section &<<SECTcos>>& for a description of the syntax of these option
12822 settings.
12823 .endlist
12824
12825 This chapter specifies all the main configuration options, along with their
12826 types and default values. For ease of finding a particular option, they appear
12827 in alphabetical order in section &<<SECTalomo>>& below. However, because there
12828 are now so many options, they are first listed briefly in functional groups, as
12829 an aid to finding the name of the option you are looking for. Some options are
12830 listed in more than one group.
12831
12832 .section "Miscellaneous" "SECID96"
12833 .table2
12834 .row &%bi_command%&                  "to run for &%-bi%& command line option"
12835 .row &%disable_ipv6%&                "do no IPv6 processing"
12836 .row &%keep_malformed%&              "for broken files &-- should not happen"
12837 .row &%localhost_number%&            "for unique message ids in clusters"
12838 .row &%message_body_newlines%&       "retain newlines in &$message_body$&"
12839 .row &%message_body_visible%&        "how much to show in &$message_body$&"
12840 .row &%mua_wrapper%&                 "run in &""MUA wrapper""& mode"
12841 .row &%print_topbitchars%&           "top-bit characters are printing"
12842 .row &%timezone%&                    "force time zone"
12843 .endtable
12844
12845
12846 .section "Exim parameters" "SECID97"
12847 .table2
12848 .row &%exim_group%&                  "override compiled-in value"
12849 .row &%exim_path%&                   "override compiled-in value"
12850 .row &%exim_user%&                   "override compiled-in value"
12851 .row &%primary_hostname%&            "default from &[uname()]&"
12852 .row &%split_spool_directory%&       "use multiple directories"
12853 .row &%spool_directory%&             "override compiled-in value"
12854 .endtable
12855
12856
12857
12858 .section "Privilege controls" "SECID98"
12859 .table2
12860 .row &%admin_groups%&                "groups that are Exim admin users"
12861 .row &%deliver_drop_privilege%&      "drop root for delivery processes"
12862 .row &%local_from_check%&            "insert &'Sender:'& if necessary"
12863 .row &%local_from_prefix%&           "for testing &'From:'& for local sender"
12864 .row &%local_from_suffix%&           "for testing &'From:'& for local sender"
12865 .row &%local_sender_retain%&         "keep &'Sender:'& from untrusted user"
12866 .row &%never_users%&                 "do not run deliveries as these"
12867 .row &%prod_requires_admin%&         "forced delivery requires admin user"
12868 .row &%queue_list_requires_admin%&   "queue listing requires admin user"
12869 .row &%trusted_groups%&              "groups that are trusted"
12870 .row &%trusted_users%&               "users that are trusted"
12871 .endtable
12872
12873
12874
12875 .section "Logging" "SECID99"
12876 .table2
12877 .row &%hosts_connection_nolog%&      "exemption from connect logging"
12878 .row &%log_file_path%&               "override compiled-in value"
12879 .row &%log_selector%&                "set/unset optional logging"
12880 .row &%log_timezone%&                "add timezone to log lines"
12881 .row &%message_logs%&                "create per-message logs"
12882 .row &%preserve_message_logs%&       "after message completion"
12883 .row &%process_log_path%&            "for SIGUSR1 and &'exiwhat'&"
12884 .row &%syslog_duplication%&          "controls duplicate log lines on syslog"
12885 .row &%syslog_facility%&             "set syslog &""facility""& field"
12886 .row &%syslog_processname%&          "set syslog &""ident""& field"
12887 .row &%syslog_timestamp%&            "timestamp syslog lines"
12888 .row &%write_rejectlog%&             "control use of message log"
12889 .endtable
12890
12891
12892
12893 .section "Frozen messages" "SECID100"
12894 .table2
12895 .row &%auto_thaw%&                   "sets time for retrying frozen messages"
12896 .row &%freeze_tell%&                 "send message when freezing"
12897 .row &%move_frozen_messages%&        "to another directory"
12898 .row &%timeout_frozen_after%&        "keep frozen messages only so long"
12899 .endtable
12900
12901
12902
12903 .section "Data lookups" "SECID101"
12904 .table2
12905 .row &%ibase_servers%&               "InterBase servers"
12906 .row &%ldap_ca_cert_dir%&            "dir of CA certs to verify LDAP server's"
12907 .row &%ldap_ca_cert_file%&           "file of CA certs to verify LDAP server's"
12908 .row &%ldap_cert_file%&              "client cert file for LDAP"
12909 .row &%ldap_cert_key%&               "client key file for LDAP"
12910 .row &%ldap_cipher_suite%&           "TLS negotiation preference control"
12911 .row &%ldap_default_servers%&        "used if no server in query"
12912 .row &%ldap_require_cert%&           "action to take without LDAP server cert"
12913 .row &%ldap_start_tls%&              "require TLS within LDAP"
12914 .row &%ldap_version%&                "set protocol version"
12915 .row &%lookup_open_max%&             "lookup files held open"
12916 .row &%mysql_servers%&               "default MySQL servers"
12917 .row &%oracle_servers%&              "Oracle servers"
12918 .row &%pgsql_servers%&               "default PostgreSQL servers"
12919 .row &%sqlite_lock_timeout%&         "as it says"
12920 .endtable
12921
12922
12923
12924 .section "Message ids" "SECID102"
12925 .table2
12926 .row &%message_id_header_domain%&    "used to build &'Message-ID:'& header"
12927 .row &%message_id_header_text%&      "ditto"
12928 .endtable
12929
12930
12931
12932 .section "Embedded Perl Startup" "SECID103"
12933 .table2
12934 .row &%perl_at_start%&               "always start the interpreter"
12935 .row &%perl_startup%&                "code to obey when starting Perl"
12936 .endtable
12937
12938
12939
12940 .section "Daemon" "SECID104"
12941 .table2
12942 .row &%daemon_smtp_ports%&           "default ports"
12943 .row &%daemon_startup_retries%&      "number of times to retry"
12944 .row &%daemon_startup_sleep%&        "time to sleep between tries"
12945 .row &%extra_local_interfaces%&      "not necessarily listened on"
12946 .row &%local_interfaces%&            "on which to listen, with optional ports"
12947 .row &%pid_file_path%&               "override compiled-in value"
12948 .row &%queue_run_max%&               "maximum simultaneous queue runners"
12949 .endtable
12950
12951
12952
12953 .section "Resource control" "SECID105"
12954 .table2
12955 .row &%check_log_inodes%&            "before accepting a message"
12956 .row &%check_log_space%&             "before accepting a message"
12957 .row &%check_spool_inodes%&          "before accepting a message"
12958 .row &%check_spool_space%&           "before accepting a message"
12959 .row &%deliver_queue_load_max%&      "no queue deliveries if load high"
12960 .row &%queue_only_load%&             "queue incoming if load high"
12961 .row &%queue_only_load_latch%&       "don't re-evaluate load for each message"
12962 .row &%queue_run_max%&               "maximum simultaneous queue runners"
12963 .row &%remote_max_parallel%&         "parallel SMTP delivery per message"
12964 .row &%smtp_accept_max%&             "simultaneous incoming connections"
12965 .row &%smtp_accept_max_nonmail%&     "non-mail commands"
12966 .row &%smtp_accept_max_nonmail_hosts%& "hosts to which the limit applies"
12967 .row &%smtp_accept_max_per_connection%& "messages per connection"
12968 .row &%smtp_accept_max_per_host%&    "connections from one host"
12969 .row &%smtp_accept_queue%&           "queue mail if more connections"
12970 .row &%smtp_accept_queue_per_connection%& "queue if more messages per &&&
12971                                            connection"
12972 .row &%smtp_accept_reserve%&         "only reserve hosts if more connections"
12973 .row &%smtp_check_spool_space%&      "from SIZE on MAIL command"
12974 .row &%smtp_connect_backlog%&        "passed to TCP/IP stack"
12975 .row &%smtp_load_reserve%&           "SMTP from reserved hosts if load high"
12976 .row &%smtp_reserve_hosts%&          "these are the reserve hosts"
12977 .endtable
12978
12979
12980
12981 .section "Policy controls" "SECID106"
12982 .table2
12983 .row &%acl_not_smtp%&                "ACL for non-SMTP messages"
12984 .row &%acl_not_smtp_mime%&           "ACL for non-SMTP MIME parts"
12985 .row &%acl_not_smtp_start%&          "ACL for start of non-SMTP message"
12986 .row &%acl_smtp_auth%&               "ACL for AUTH"
12987 .row &%acl_smtp_connect%&            "ACL for connection"
12988 .row &%acl_smtp_data%&               "ACL for DATA"
12989 .row &%acl_smtp_dkim%&               "ACL for DKIM verification"
12990 .row &%acl_smtp_etrn%&               "ACL for ETRN"
12991 .row &%acl_smtp_expn%&               "ACL for EXPN"
12992 .row &%acl_smtp_helo%&               "ACL for EHLO or HELO"
12993 .row &%acl_smtp_mail%&               "ACL for MAIL"
12994 .row &%acl_smtp_mailauth%&           "ACL for AUTH on MAIL command"
12995 .row &%acl_smtp_mime%&               "ACL for MIME parts"
12996 .row &%acl_smtp_predata%&            "ACL for start of data"
12997 .row &%acl_smtp_quit%&               "ACL for QUIT"
12998 .row &%acl_smtp_rcpt%&               "ACL for RCPT"
12999 .row &%acl_smtp_starttls%&           "ACL for STARTTLS"
13000 .row &%acl_smtp_vrfy%&               "ACL for VRFY"
13001 .row &%av_scanner%&                  "specify virus scanner"
13002 .row &%check_rfc2047_length%&        "check length of RFC 2047 &""encoded &&&
13003                                       words""&"
13004 .row &%dns_csa_search_limit%&        "control CSA parent search depth"
13005 .row &%dns_csa_use_reverse%&         "en/disable CSA IP reverse search"
13006 .row &%header_maxsize%&              "total size of message header"
13007 .row &%header_line_maxsize%&         "individual header line limit"
13008 .row &%helo_accept_junk_hosts%&      "allow syntactic junk from these hosts"
13009 .row &%helo_allow_chars%&            "allow illegal chars in HELO names"
13010 .row &%helo_lookup_domains%&         "lookup hostname for these HELO names"
13011 .row &%helo_try_verify_hosts%&       "HELO soft-checked for these hosts"
13012 .row &%helo_verify_hosts%&           "HELO hard-checked for these hosts"
13013 .row &%host_lookup%&                 "host name looked up for these hosts"
13014 .row &%host_lookup_order%&           "order of DNS and local name lookups"
13015 .row &%host_reject_connection%&      "reject connection from these hosts"
13016 .row &%hosts_treat_as_local%&        "useful in some cluster configurations"
13017 .row &%local_scan_timeout%&          "timeout for &[local_scan()]&"
13018 .row &%message_size_limit%&          "for all messages"
13019 .row &%percent_hack_domains%&        "recognize %-hack for these domains"
13020 .row &%spamd_address%&               "set interface to SpamAssassin"
13021 .row &%strict_acl_vars%&             "object to unset ACL variables"
13022 .endtable
13023
13024
13025
13026 .section "Callout cache" "SECID107"
13027 .table2
13028 .row &%callout_domain_negative_expire%& "timeout for negative domain cache &&&
13029                                          item"
13030 .row &%callout_domain_positive_expire%& "timeout for positive domain cache &&&
13031                                          item"
13032 .row &%callout_negative_expire%&     "timeout for negative address cache item"
13033 .row &%callout_positive_expire%&     "timeout for positive address cache item"
13034 .row &%callout_random_local_part%&   "string to use for &""random""& testing"
13035 .endtable
13036
13037
13038
13039 .section "TLS" "SECID108"
13040 .table2
13041 .row &%gnutls_compat_mode%&          "use GnuTLS compatibility mode"
13042 .row &%gnutls_enable_pkcs11%&        "allow GnuTLS to autoload PKCS11 modules"
13043 .row &%openssl_options%&             "adjust OpenSSL compatibility options"
13044 .row &%tls_advertise_hosts%&         "advertise TLS to these hosts"
13045 .row &%tls_certificate%&             "location of server certificate"
13046 .row &%tls_crl%&                     "certificate revocation list"
13047 .row &%tls_dh_max_bits%&             "clamp D-H bit count suggestion"
13048 .row &%tls_dhparam%&                 "DH parameters for server"
13049 .row &%tls_on_connect_ports%&        "specify SSMTP (SMTPS) ports"
13050 .row &%tls_privatekey%&              "location of server private key"
13051 .row &%tls_remember_esmtp%&          "don't reset after starting TLS"
13052 .row &%tls_require_ciphers%&         "specify acceptable ciphers"
13053 .row &%tls_try_verify_hosts%&        "try to verify client certificate"
13054 .row &%tls_verify_certificates%&     "expected client certificates"
13055 .row &%tls_verify_hosts%&            "insist on client certificate verify"
13056 .endtable
13057
13058
13059
13060 .section "Local user handling" "SECID109"
13061 .table2
13062 .row &%finduser_retries%&            "useful in NIS environments"
13063 .row &%gecos_name%&                  "used when creating &'Sender:'&"
13064 .row &%gecos_pattern%&               "ditto"
13065 .row &%max_username_length%&         "for systems that truncate"
13066 .row &%unknown_login%&               "used when no login name found"
13067 .row &%unknown_username%&            "ditto"
13068 .row &%uucp_from_pattern%&           "for recognizing &""From ""& lines"
13069 .row &%uucp_from_sender%&            "ditto"
13070 .endtable
13071
13072
13073
13074 .section "All incoming messages (SMTP and non-SMTP)" "SECID110"
13075 .table2
13076 .row &%header_maxsize%&              "total size of message header"
13077 .row &%header_line_maxsize%&         "individual header line limit"
13078 .row &%message_size_limit%&          "applies to all messages"
13079 .row &%percent_hack_domains%&        "recognize %-hack for these domains"
13080 .row &%received_header_text%&        "expanded to make &'Received:'&"
13081 .row &%received_headers_max%&        "for mail loop detection"
13082 .row &%recipients_max%&              "limit per message"
13083 .row &%recipients_max_reject%&       "permanently reject excess recipients"
13084 .endtable
13085
13086
13087
13088
13089 .section "Non-SMTP incoming messages" "SECID111"
13090 .table2
13091 .row &%receive_timeout%&             "for non-SMTP messages"
13092 .endtable
13093
13094
13095
13096
13097
13098 .section "Incoming SMTP messages" "SECID112"
13099 See also the &'Policy controls'& section above.
13100
13101 .table2
13102 .row &%host_lookup%&                 "host name looked up for these hosts"
13103 .row &%host_lookup_order%&           "order of DNS and local name lookups"
13104 .row &%recipient_unqualified_hosts%& "may send unqualified recipients"
13105 .row &%rfc1413_hosts%&               "make ident calls to these hosts"
13106 .row &%rfc1413_query_timeout%&       "zero disables ident calls"
13107 .row &%sender_unqualified_hosts%&    "may send unqualified senders"
13108 .row &%smtp_accept_keepalive%&       "some TCP/IP magic"
13109 .row &%smtp_accept_max%&             "simultaneous incoming connections"
13110 .row &%smtp_accept_max_nonmail%&     "non-mail commands"
13111 .row &%smtp_accept_max_nonmail_hosts%& "hosts to which the limit applies"
13112 .row &%smtp_accept_max_per_connection%& "messages per connection"
13113 .row &%smtp_accept_max_per_host%&    "connections from one host"
13114 .row &%smtp_accept_queue%&           "queue mail if more connections"
13115 .row &%smtp_accept_queue_per_connection%& "queue if more messages per &&&
13116                                            connection"
13117 .row &%smtp_accept_reserve%&         "only reserve hosts if more connections"
13118 .row &%smtp_active_hostname%&        "host name to use in messages"
13119 .row &%smtp_banner%&                 "text for welcome banner"
13120 .row &%smtp_check_spool_space%&      "from SIZE on MAIL command"
13121 .row &%smtp_connect_backlog%&        "passed to TCP/IP stack"
13122 .row &%smtp_enforce_sync%&           "of SMTP command/responses"
13123 .row &%smtp_etrn_command%&           "what to run for ETRN"
13124 .row &%smtp_etrn_serialize%&         "only one at once"
13125 .row &%smtp_load_reserve%&           "only reserve hosts if this load"
13126 .row &%smtp_max_unknown_commands%&   "before dropping connection"
13127 .row &%smtp_ratelimit_hosts%&        "apply ratelimiting to these hosts"
13128 .row &%smtp_ratelimit_mail%&         "ratelimit for MAIL commands"
13129 .row &%smtp_ratelimit_rcpt%&         "ratelimit for RCPT commands"
13130 .row &%smtp_receive_timeout%&        "per command or data line"
13131 .row &%smtp_reserve_hosts%&          "these are the reserve hosts"
13132 .row &%smtp_return_error_details%&   "give detail on rejections"
13133 .endtable
13134
13135
13136
13137 .section "SMTP extensions" "SECID113"
13138 .table2
13139 .row &%accept_8bitmime%&             "advertise 8BITMIME"
13140 .row &%auth_advertise_hosts%&        "advertise AUTH to these hosts"
13141 .row &%ignore_fromline_hosts%&       "allow &""From ""& from these hosts"
13142 .row &%ignore_fromline_local%&       "allow &""From ""& from local SMTP"
13143 .row &%pipelining_advertise_hosts%&  "advertise pipelining to these hosts"
13144 .row &%tls_advertise_hosts%&         "advertise TLS to these hosts"
13145 .endtable
13146
13147
13148
13149 .section "Processing messages" "SECID114"
13150 .table2
13151 .row &%allow_domain_literals%&       "recognize domain literal syntax"
13152 .row &%allow_mx_to_ip%&              "allow MX to point to IP address"
13153 .row &%allow_utf8_domains%&          "in addresses"
13154 .row &%check_rfc2047_length%&        "check length of RFC 2047 &""encoded &&&
13155                                       words""&"
13156 .row &%delivery_date_remove%&        "from incoming messages"
13157 .row &%envelope_to_remove%&          "from incoming messages"
13158 .row &%extract_addresses_remove_arguments%& "affects &%-t%& processing"
13159 .row &%headers_charset%&             "default for translations"
13160 .row &%qualify_domain%&              "default for senders"
13161 .row &%qualify_recipient%&           "default for recipients"
13162 .row &%return_path_remove%&          "from incoming messages"
13163 .row &%strip_excess_angle_brackets%& "in addresses"
13164 .row &%strip_trailing_dot%&          "at end of addresses"
13165 .row &%untrusted_set_sender%&        "untrusted can set envelope sender"
13166 .endtable
13167
13168
13169
13170 .section "System filter" "SECID115"
13171 .table2
13172 .row &%system_filter%&               "locate system filter"
13173 .row &%system_filter_directory_transport%& "transport for delivery to a &&&
13174                                             directory"
13175 .row &%system_filter_file_transport%& "transport for delivery to a file"
13176 .row &%system_filter_group%&         "group for filter running"
13177 .row &%system_filter_pipe_transport%& "transport for delivery to a pipe"
13178 .row &%system_filter_reply_transport%& "transport for autoreply delivery"
13179 .row &%system_filter_user%&          "user for filter running"
13180 .endtable
13181
13182
13183
13184 .section "Routing and delivery" "SECID116"
13185 .table2
13186 .row &%disable_ipv6%&                "do no IPv6 processing"
13187 .row &%dns_again_means_nonexist%&    "for broken domains"
13188 .row &%dns_check_names_pattern%&     "pre-DNS syntax check"
13189 .row &%dns_ipv4_lookup%&             "only v4 lookup for these domains"
13190 .row &%dns_retrans%&                 "parameter for resolver"
13191 .row &%dns_retry%&                   "parameter for resolver"
13192 .row &%dns_use_dnssec%&              "parameter for resolver"
13193 .row &%dns_use_edns0%&               "parameter for resolver"
13194 .row &%hold_domains%&                "hold delivery for these domains"
13195 .row &%local_interfaces%&            "for routing checks"
13196 .row &%queue_domains%&               "no immediate delivery for these"
13197 .row &%queue_only%&                  "no immediate delivery at all"
13198 .row &%queue_only_file%&             "no immediate delivery if file exists"
13199 .row &%queue_only_load%&             "no immediate delivery if load is high"
13200 .row &%queue_only_load_latch%&       "don't re-evaluate load for each message"
13201 .row &%queue_only_override%&         "allow command line to override"
13202 .row &%queue_run_in_order%&          "order of arrival"
13203 .row &%queue_run_max%&               "of simultaneous queue runners"
13204 .row &%queue_smtp_domains%&          "no immediate SMTP delivery for these"
13205 .row &%remote_max_parallel%&         "parallel SMTP delivery per message"
13206 .row &%remote_sort_domains%&         "order of remote deliveries"
13207 .row &%retry_data_expire%&           "timeout for retry data"
13208 .row &%retry_interval_max%&          "safety net for retry rules"
13209 .endtable
13210
13211
13212
13213 .section "Bounce and warning messages" "SECID117"
13214 .table2
13215 .row &%bounce_message_file%&         "content of bounce"
13216 .row &%bounce_message_text%&         "content of bounce"
13217 .row &%bounce_return_body%&          "include body if returning message"
13218 .row &%bounce_return_message%&       "include original message in bounce"
13219 .row &%bounce_return_size_limit%&    "limit on returned message"
13220 .row &%bounce_sender_authentication%& "send authenticated sender with bounce"
13221 .row &%dsn_from%&                    "set &'From:'& contents in bounces"
13222 .row &%errors_copy%&                 "copy bounce messages"
13223 .row &%errors_reply_to%&             "&'Reply-to:'& in bounces"
13224 .row &%delay_warning%&               "time schedule"
13225 .row &%delay_warning_condition%&     "condition for warning messages"
13226 .row &%ignore_bounce_errors_after%&  "discard undeliverable bounces"
13227 .row &%smtp_return_error_details%&   "give detail on rejections"
13228 .row &%warn_message_file%&           "content of warning message"
13229 .endtable
13230
13231
13232
13233 .section "Alphabetical list of main options" "SECTalomo"
13234 Those options that undergo string expansion before use are marked with
13235 &dagger;.
13236
13237 .option accept_8bitmime main boolean true
13238 .cindex "8BITMIME"
13239 .cindex "8-bit characters"
13240 .cindex "log" "selectors"
13241 .cindex "log" "8BITMIME"
13242 This option causes Exim to send 8BITMIME in its response to an SMTP
13243 EHLO command, and to accept the BODY= parameter on MAIL commands.
13244 However, though Exim is 8-bit clean, it is not a protocol converter, and it
13245 takes no steps to do anything special with messages received by this route.
13246
13247 Historically Exim kept this option off by default, but the maintainers
13248 feel that in today's Internet, this causes more problems than it solves.
13249 It now defaults to true.
13250 A more detailed analysis of the issues is provided by Dan Bernstein:
13251 .display
13252 &url(http://cr.yp.to/smtp/8bitmime.html)
13253 .endd
13254
13255 .new
13256 To log received 8BITMIME status use
13257 .code
13258 log_selector = +8bitmime
13259 .endd
13260 .wen
13261
13262 .option acl_not_smtp main string&!! unset
13263 .cindex "&ACL;" "for non-SMTP messages"
13264 .cindex "non-SMTP messages" "ACLs for"
13265 This option defines the ACL that is run when a non-SMTP message has been
13266 read and is on the point of being accepted. See chapter &<<CHAPACL>>& for
13267 further details.
13268
13269 .option acl_not_smtp_mime main string&!! unset
13270 This option defines the ACL that is run for individual MIME parts of non-SMTP
13271 messages. It operates in exactly the same way as &%acl_smtp_mime%& operates for
13272 SMTP messages.
13273
13274 .option acl_not_smtp_start main string&!! unset
13275 .cindex "&ACL;" "at start of non-SMTP message"
13276 .cindex "non-SMTP messages" "ACLs for"
13277 This option defines the ACL that is run before Exim starts reading a
13278 non-SMTP message. See chapter &<<CHAPACL>>& for further details.
13279
13280 .option acl_smtp_auth main string&!! unset
13281 .cindex "&ACL;" "setting up for SMTP commands"
13282 .cindex "AUTH" "ACL for"
13283 This option defines the ACL that is run when an SMTP AUTH command is
13284 received. See chapter &<<CHAPACL>>& for further details.
13285
13286 .option acl_smtp_connect main string&!! unset
13287 .cindex "&ACL;" "on SMTP connection"
13288 This option defines the ACL that is run when an SMTP connection is received.
13289 See chapter &<<CHAPACL>>& for further details.
13290
13291 .option acl_smtp_data main string&!! unset
13292 .cindex "DATA" "ACL for"
13293 This option defines the ACL that is run after an SMTP DATA command has been
13294 processed and the message itself has been received, but before the final
13295 acknowledgment is sent. See chapter &<<CHAPACL>>& for further details.
13296
13297 .option acl_smtp_etrn main string&!! unset
13298 .cindex "ETRN" "ACL for"
13299 This option defines the ACL that is run when an SMTP ETRN command is
13300 received. See chapter &<<CHAPACL>>& for further details.
13301
13302 .option acl_smtp_expn main string&!! unset
13303 .cindex "EXPN" "ACL for"
13304 This option defines the ACL that is run when an SMTP EXPN command is
13305 received. See chapter &<<CHAPACL>>& for further details.
13306
13307 .option acl_smtp_helo main string&!! unset
13308 .cindex "EHLO" "ACL for"
13309 .cindex "HELO" "ACL for"
13310 This option defines the ACL that is run when an SMTP EHLO or HELO
13311 command is received. See chapter &<<CHAPACL>>& for further details.
13312
13313
13314 .option acl_smtp_mail main string&!! unset
13315 .cindex "MAIL" "ACL for"
13316 This option defines the ACL that is run when an SMTP MAIL command is
13317 received. See chapter &<<CHAPACL>>& for further details.
13318
13319 .option acl_smtp_mailauth main string&!! unset
13320 .cindex "AUTH" "on MAIL command"
13321 This option defines the ACL that is run when there is an AUTH parameter on
13322 a MAIL command. See chapter &<<CHAPACL>>& for details of ACLs, and chapter
13323 &<<CHAPSMTPAUTH>>& for details of authentication.
13324
13325 .option acl_smtp_mime main string&!! unset
13326 .cindex "MIME content scanning" "ACL for"
13327 This option is available when Exim is built with the content-scanning
13328 extension. It defines the ACL that is run for each MIME part in a message. See
13329 section &<<SECTscanmimepart>>& for details.
13330
13331 .option acl_smtp_predata main string&!! unset
13332 This option defines the ACL that is run when an SMTP DATA command is
13333 received, before the message itself is received. See chapter &<<CHAPACL>>& for
13334 further details.
13335
13336 .option acl_smtp_quit main string&!! unset
13337 .cindex "QUIT, ACL for"
13338 This option defines the ACL that is run when an SMTP QUIT command is
13339 received. See chapter &<<CHAPACL>>& for further details.
13340
13341 .option acl_smtp_rcpt main string&!! unset
13342 .cindex "RCPT" "ACL for"
13343 This option defines the ACL that is run when an SMTP RCPT command is
13344 received. See chapter &<<CHAPACL>>& for further details.
13345
13346 .option acl_smtp_starttls main string&!! unset
13347 .cindex "STARTTLS, ACL for"
13348 This option defines the ACL that is run when an SMTP STARTTLS command is
13349 received. See chapter &<<CHAPACL>>& for further details.
13350
13351 .option acl_smtp_vrfy main string&!! unset
13352 .cindex "VRFY" "ACL for"
13353 This option defines the ACL that is run when an SMTP VRFY command is
13354 received. See chapter &<<CHAPACL>>& for further details.
13355
13356 .option admin_groups main "string list&!!" unset
13357 .cindex "admin user"
13358 This option is expanded just once, at the start of Exim's processing. If the
13359 current group or any of the supplementary groups of an Exim caller is in this
13360 colon-separated list, the caller has admin privileges. If all your system
13361 programmers are in a specific group, for example, you can give them all Exim
13362 admin privileges by putting that group in &%admin_groups%&. However, this does
13363 not permit them to read Exim's spool files (whose group owner is the Exim gid).
13364 To permit this, you have to add individuals to the Exim group.
13365
13366 .option allow_domain_literals main boolean false
13367 .cindex "domain literal"
13368 If this option is set, the RFC 2822 domain literal format is permitted in
13369 email addresses. The option is not set by default, because the domain literal
13370 format is not normally required these days, and few people know about it. It
13371 has, however, been exploited by mail abusers.
13372
13373 Unfortunately, it seems that some DNS black list maintainers are using this
13374 format to report black listing to postmasters. If you want to accept messages
13375 addressed to your hosts by IP address, you need to set
13376 &%allow_domain_literals%& true, and also to add &`@[]`& to the list of local
13377 domains (defined in the named domain list &%local_domains%& in the default
13378 configuration). This &"magic string"& matches the domain literal form of all
13379 the local host's IP addresses.
13380
13381
13382 .option allow_mx_to_ip main boolean false
13383 .cindex "MX record" "pointing to IP address"
13384 It appears that more and more DNS zone administrators are breaking the rules
13385 and putting domain names that look like IP addresses on the right hand side of
13386 MX records. Exim follows the rules and rejects this, giving an error message
13387 that explains the mis-configuration. However, some other MTAs support this
13388 practice, so to avoid &"Why can't Exim do this?"& complaints,
13389 &%allow_mx_to_ip%& exists, in order to enable this heinous activity. It is not
13390 recommended, except when you have no other choice.
13391
13392 .option allow_utf8_domains main boolean false
13393 .cindex "domain" "UTF-8 characters in"
13394 .cindex "UTF-8" "in domain name"
13395 Lots of discussion is going on about internationalized domain names. One
13396 camp is strongly in favour of just using UTF-8 characters, and it seems
13397 that at least two other MTAs permit this. This option allows Exim users to
13398 experiment if they wish.
13399
13400 If it is set true, Exim's domain parsing function allows valid
13401 UTF-8 multicharacters to appear in domain name components, in addition to
13402 letters, digits, and hyphens. However, just setting this option is not
13403 enough; if you want to look up these domain names in the DNS, you must also
13404 adjust the value of &%dns_check_names_pattern%& to match the extended form. A
13405 suitable setting is:
13406 .code
13407 dns_check_names_pattern = (?i)^(?>(?(1)\.|())[a-z0-9\xc0-\xff]\
13408   (?>[-a-z0-9\x80-\xff]*[a-z0-9\x80-\xbf])?)+$
13409 .endd
13410 Alternatively, you can just disable this feature by setting
13411 .code
13412 dns_check_names_pattern =
13413 .endd
13414 That is, set the option to an empty string so that no check is done.
13415
13416
13417 .option auth_advertise_hosts main "host list&!!" *
13418 .cindex "authentication" "advertising"
13419 .cindex "AUTH" "advertising"
13420 If any server authentication mechanisms are configured, Exim advertises them in
13421 response to an EHLO command only if the calling host matches this list.
13422 Otherwise, Exim does not advertise AUTH.
13423 Exim does not accept AUTH commands from clients to which it has not
13424 advertised the availability of AUTH. The advertising of individual
13425 authentication mechanisms can be controlled by the use of the
13426 &%server_advertise_condition%& generic authenticator option on the individual
13427 authenticators. See chapter &<<CHAPSMTPAUTH>>& for further details.
13428
13429 Certain mail clients (for example, Netscape) require the user to provide a name
13430 and password for authentication if AUTH is advertised, even though it may
13431 not be needed (the host may accept messages from hosts on its local LAN without
13432 authentication, for example). The &%auth_advertise_hosts%& option can be used
13433 to make these clients more friendly by excluding them from the set of hosts to
13434 which Exim advertises AUTH.
13435
13436 .cindex "AUTH" "advertising when encrypted"
13437 If you want to advertise the availability of AUTH only when the connection
13438 is encrypted using TLS, you can make use of the fact that the value of this
13439 option is expanded, with a setting like this:
13440 .code
13441 auth_advertise_hosts = ${if eq{$tls_in_cipher}{}{}{*}}
13442 .endd
13443 .vindex "&$tls_in_cipher$&"
13444 If &$tls_in_cipher$& is empty, the session is not encrypted, and the result of
13445 the expansion is empty, thus matching no hosts. Otherwise, the result of the
13446 expansion is *, which matches all hosts.
13447
13448
13449 .option auto_thaw main time 0s
13450 .cindex "thawing messages"
13451 .cindex "unfreezing messages"
13452 If this option is set to a time greater than zero, a queue runner will try a
13453 new delivery attempt on any frozen message, other than a bounce message, if
13454 this much time has passed since it was frozen. This may result in the message
13455 being re-frozen if nothing has changed since the last attempt. It is a way of
13456 saying &"keep on trying, even though there are big problems"&.
13457
13458 &*Note*&: This is an old option, which predates &%timeout_frozen_after%& and
13459 &%ignore_bounce_errors_after%&. It is retained for compatibility, but it is not
13460 thought to be very useful any more, and its use should probably be avoided.
13461
13462
13463 .option av_scanner main string "see below"
13464 This option is available if Exim is built with the content-scanning extension.
13465 It specifies which anti-virus scanner to use. The default value is:
13466 .code
13467 sophie:/var/run/sophie
13468 .endd
13469 If the value of &%av_scanner%& starts with a dollar character, it is expanded
13470 before use. See section &<<SECTscanvirus>>& for further details.
13471
13472
13473 .option bi_command main string unset
13474 .oindex "&%-bi%&"
13475 This option supplies the name of a command that is run when Exim is called with
13476 the &%-bi%& option (see chapter &<<CHAPcommandline>>&). The string value is
13477 just the command name, it is not a complete command line. If an argument is
13478 required, it must come from the &%-oA%& command line option.
13479
13480
13481 .option bounce_message_file main string unset
13482 .cindex "bounce message" "customizing"
13483 .cindex "customizing" "bounce message"
13484 This option defines a template file containing paragraphs of text to be used
13485 for constructing bounce messages.  Details of the file's contents are given in
13486 chapter &<<CHAPemsgcust>>&. See also &%warn_message_file%&.
13487
13488
13489 .option bounce_message_text main string unset
13490 When this option is set, its contents are included in the default bounce
13491 message immediately after &"This message was created automatically by mail
13492 delivery software."& It is not used if &%bounce_message_file%& is set.
13493
13494 .option bounce_return_body main boolean true
13495 .cindex "bounce message" "including body"
13496 This option controls whether the body of an incoming message is included in a
13497 bounce message when &%bounce_return_message%& is true. The default setting
13498 causes the entire message, both header and body, to be returned (subject to the
13499 value of &%bounce_return_size_limit%&). If this option is false, only the
13500 message header is included. In the case of a non-SMTP message containing an
13501 error that is detected during reception, only those header lines preceding the
13502 point at which the error was detected are returned.
13503 .cindex "bounce message" "including original"
13504
13505 .option bounce_return_message main boolean true
13506 If this option is set false, none of the original message is included in
13507 bounce messages generated by Exim. See also &%bounce_return_size_limit%& and
13508 &%bounce_return_body%&.
13509
13510
13511 .option bounce_return_size_limit main integer 100K
13512 .cindex "size" "of bounce, limit"
13513 .cindex "bounce message" "size limit"
13514 .cindex "limit" "bounce message size"
13515 This option sets a limit in bytes on the size of messages that are returned to
13516 senders as part of bounce messages when &%bounce_return_message%& is true. The
13517 limit should be less than the value of the global &%message_size_limit%& and of
13518 any &%message_size_limit%& settings on transports, to allow for the bounce text
13519 that Exim generates. If this option is set to zero there is no limit.
13520
13521 When the body of any message that is to be included in a bounce message is
13522 greater than the limit, it is truncated, and a comment pointing this out is
13523 added at the top. The actual cutoff may be greater than the value given, owing
13524 to the use of buffering for transferring the message in chunks (typically 8K in
13525 size). The idea is to save bandwidth on those undeliverable 15-megabyte
13526 messages.
13527
13528 .option bounce_sender_authentication main string unset
13529 .cindex "bounce message" "sender authentication"
13530 .cindex "authentication" "bounce message"
13531 .cindex "AUTH" "on bounce message"
13532 This option provides an authenticated sender address that is sent with any
13533 bounce messages generated by Exim that are sent over an authenticated SMTP
13534 connection. A typical setting might be:
13535 .code
13536 bounce_sender_authentication = mailer-daemon@my.domain.example
13537 .endd
13538 which would cause bounce messages to be sent using the SMTP command:
13539 .code
13540 MAIL FROM:<> AUTH=mailer-daemon@my.domain.example
13541 .endd
13542 The value of &%bounce_sender_authentication%& must always be a complete email
13543 address.
13544
13545 .option callout_domain_negative_expire main time 3h
13546 .cindex "caching" "callout timeouts"
13547 .cindex "callout" "caching timeouts"
13548 This option specifies the expiry time for negative callout cache data for a
13549 domain. See section &<<SECTcallver>>& for details of callout verification, and
13550 section &<<SECTcallvercache>>& for details of the caching.
13551
13552
13553 .option callout_domain_positive_expire main time 7d
13554 This option specifies the expiry time for positive callout cache data for a
13555 domain. See section &<<SECTcallver>>& for details of callout verification, and
13556 section &<<SECTcallvercache>>& for details of the caching.
13557
13558
13559 .option callout_negative_expire main time 2h
13560 This option specifies the expiry time for negative callout cache data for an
13561 address. See section &<<SECTcallver>>& for details of callout verification, and
13562 section &<<SECTcallvercache>>& for details of the caching.
13563
13564
13565 .option callout_positive_expire main time 24h
13566 This option specifies the expiry time for positive callout cache data for an
13567 address. See section &<<SECTcallver>>& for details of callout verification, and
13568 section &<<SECTcallvercache>>& for details of the caching.
13569
13570
13571 .option callout_random_local_part main string&!! "see below"
13572 This option defines the &"random"& local part that can be used as part of
13573 callout verification. The default value is
13574 .code
13575 $primary_hostname-$tod_epoch-testing
13576 .endd
13577 See section &<<CALLaddparcall>>& for details of how this value is used.
13578
13579
13580 .option check_log_inodes main integer 0
13581 See &%check_spool_space%& below.
13582
13583
13584 .option check_log_space main integer 0
13585 See &%check_spool_space%& below.
13586
13587 .oindex "&%check_rfc2047_length%&"
13588 .cindex "RFC 2047" "disabling length check"
13589 .option check_rfc2047_length main boolean true
13590 RFC 2047 defines a way of encoding non-ASCII characters in headers using a
13591 system of &"encoded words"&. The RFC specifies a maximum length for an encoded
13592 word; strings to be encoded that exceed this length are supposed to use
13593 multiple encoded words. By default, Exim does not recognize encoded words that
13594 exceed the maximum length. However, it seems that some software, in violation
13595 of the RFC, generates overlong encoded words. If &%check_rfc2047_length%& is
13596 set false, Exim recognizes encoded words of any length.
13597
13598
13599 .option check_spool_inodes main integer 0
13600 See &%check_spool_space%& below.
13601
13602
13603 .option check_spool_space main integer 0
13604 .cindex "checking disk space"
13605 .cindex "disk space, checking"
13606 .cindex "spool directory" "checking space"
13607 The four &%check_...%& options allow for checking of disk resources before a
13608 message is accepted.
13609
13610 .vindex "&$log_inodes$&"
13611 .vindex "&$log_space$&"
13612 .vindex "&$spool_inodes$&"
13613 .vindex "&$spool_space$&"
13614 When any of these options are set, they apply to all incoming messages. If you
13615 want to apply different checks to different kinds of message, you can do so by
13616 testing the variables &$log_inodes$&, &$log_space$&, &$spool_inodes$&, and
13617 &$spool_space$& in an ACL with appropriate additional conditions.
13618
13619
13620 &%check_spool_space%& and &%check_spool_inodes%& check the spool partition if
13621 either value is greater than zero, for example:
13622 .code
13623 check_spool_space = 10M
13624 check_spool_inodes = 100
13625 .endd
13626 The spool partition is the one that contains the directory defined by
13627 SPOOL_DIRECTORY in &_Local/Makefile_&. It is used for holding messages in
13628 transit.
13629
13630 &%check_log_space%& and &%check_log_inodes%&  check the partition in which log
13631 files are written if either is greater than zero. These should be set only if
13632 &%log_file_path%& and &%spool_directory%& refer to different partitions.
13633
13634 If there is less space or fewer inodes than requested, Exim refuses to accept
13635 incoming mail. In the case of SMTP input this is done by giving a 452 temporary
13636 error response to the MAIL command. If ESMTP is in use and there was a
13637 SIZE parameter on the MAIL command, its value is added to the
13638 &%check_spool_space%& value, and the check is performed even if
13639 &%check_spool_space%& is zero, unless &%no_smtp_check_spool_space%& is set.
13640
13641 The values for &%check_spool_space%& and &%check_log_space%& are held as a
13642 number of kilobytes. If a non-multiple of 1024 is specified, it is rounded up.
13643
13644 For non-SMTP input and for batched SMTP input, the test is done at start-up; on
13645 failure a message is written to stderr and Exim exits with a non-zero code, as
13646 it obviously cannot send an error message of any kind.
13647
13648 .option daemon_smtp_ports main string &`smtp`&
13649 .cindex "port" "for daemon"
13650 .cindex "TCP/IP" "setting listening ports"
13651 This option specifies one or more default SMTP ports on which the Exim daemon
13652 listens. See chapter &<<CHAPinterfaces>>& for details of how it is used. For
13653 backward compatibility, &%daemon_smtp_port%& (singular) is a synonym.
13654
13655 .option daemon_startup_retries main integer 9
13656 .cindex "daemon startup, retrying"
13657 This option, along with &%daemon_startup_sleep%&, controls the retrying done by
13658 the daemon at startup when it cannot immediately bind a listening socket
13659 (typically because the socket is already in use): &%daemon_startup_retries%&
13660 defines the number of retries after the first failure, and
13661 &%daemon_startup_sleep%& defines the length of time to wait between retries.
13662
13663 .option daemon_startup_sleep main time 30s
13664 See &%daemon_startup_retries%&.
13665
13666 .option delay_warning main "time list" 24h
13667 .cindex "warning of delay"
13668 .cindex "delay warning, specifying"
13669 When a message is delayed, Exim sends a warning message to the sender at
13670 intervals specified by this option. The data is a colon-separated list of times
13671 after which to send warning messages. If the value of the option is an empty
13672 string or a zero time, no warnings are sent. Up to 10 times may be given. If a
13673 message has been on the queue for longer than the last time, the last interval
13674 between the times is used to compute subsequent warning times. For example,
13675 with
13676 .code
13677 delay_warning = 4h:8h:24h
13678 .endd
13679 the first message is sent after 4 hours, the second after 8 hours, and
13680 the third one after 24 hours. After that, messages are sent every 16 hours,
13681 because that is the interval between the last two times on the list. If you set
13682 just one time, it specifies the repeat interval. For example, with:
13683 .code
13684 delay_warning = 6h
13685 .endd
13686 messages are repeated every six hours. To stop warnings after a given time, set
13687 a very large time at the end of the list. For example:
13688 .code
13689 delay_warning = 2h:12h:99d
13690 .endd
13691
13692 .option delay_warning_condition main string&!! "see below"
13693 .vindex "&$domain$&"
13694 The string is expanded at the time a warning message might be sent. If all the
13695 deferred addresses have the same domain, it is set in &$domain$& during the
13696 expansion. Otherwise &$domain$& is empty. If the result of the expansion is a
13697 forced failure, an empty string, or a string matching any of &"0"&, &"no"& or
13698 &"false"& (the comparison being done caselessly) then the warning message is
13699 not sent. The default is:
13700 .code
13701 delay_warning_condition = ${if or {\
13702   { !eq{$h_list-id:$h_list-post:$h_list-subscribe:}{} }\
13703   { match{$h_precedence:}{(?i)bulk|list|junk} }\
13704   { match{$h_auto-submitted:}{(?i)auto-generated|auto-replied} }\
13705   } {no}{yes}}
13706 .endd
13707 This suppresses the sending of warnings for messages that contain &'List-ID:'&,
13708 &'List-Post:'&, or &'List-Subscribe:'& headers, or have &"bulk"&, &"list"& or
13709 &"junk"& in a &'Precedence:'& header, or have &"auto-generated"& or
13710 &"auto-replied"& in an &'Auto-Submitted:'& header.
13711
13712 .option deliver_drop_privilege main boolean false
13713 .cindex "unprivileged delivery"
13714 .cindex "delivery" "unprivileged"
13715 If this option is set true, Exim drops its root privilege at the start of a
13716 delivery process, and runs as the Exim user throughout. This severely restricts
13717 the kinds of local delivery that are possible, but is viable in certain types
13718 of configuration. There is a discussion about the use of root privilege in
13719 chapter &<<CHAPsecurity>>&.
13720
13721 .option deliver_queue_load_max main fixed-point unset
13722 .cindex "load average"
13723 .cindex "queue runner" "abandoning"
13724 When this option is set, a queue run is abandoned if the system load average
13725 becomes greater than the value of the option. The option has no effect on
13726 ancient operating systems on which Exim cannot determine the load average.
13727 See also &%queue_only_load%& and &%smtp_load_reserve%&.
13728
13729
13730 .option delivery_date_remove main boolean true
13731 .cindex "&'Delivery-date:'& header line"
13732 Exim's transports have an option for adding a &'Delivery-date:'& header to a
13733 message when it is delivered, in exactly the same way as &'Return-path:'& is
13734 handled. &'Delivery-date:'& records the actual time of delivery. Such headers
13735 should not be present in incoming messages, and this option causes them to be
13736 removed at the time the message is received, to avoid any problems that might
13737 occur when a delivered message is subsequently sent on to some other recipient.
13738
13739 .option disable_fsync main boolean false
13740 .cindex "&[fsync()]&, disabling"
13741 This option is available only if Exim was built with the compile-time option
13742 ENABLE_DISABLE_FSYNC. When this is not set, a reference to &%disable_fsync%& in
13743 a runtime configuration generates an &"unknown option"& error. You should not
13744 build Exim with ENABLE_DISABLE_FSYNC or set &%disable_fsync%& unless you
13745 really, really, really understand what you are doing. &'No pre-compiled
13746 distributions of Exim should ever make this option available.'&
13747
13748 When &%disable_fsync%& is set true, Exim no longer calls &[fsync()]& to force
13749 updated files' data to be written to disc before continuing. Unexpected events
13750 such as crashes and power outages may cause data to be lost or scrambled.
13751 Here be Dragons. &*Beware.*&
13752
13753
13754 .option disable_ipv6 main boolean false
13755 .cindex "IPv6" "disabling"
13756 If this option is set true, even if the Exim binary has IPv6 support, no IPv6
13757 activities take place. AAAA records are never looked up, and any IPv6 addresses
13758 that are listed in &%local_interfaces%&, data for the &%manualroute%& router,
13759 etc. are ignored. If IP literals are enabled, the &(ipliteral)& router declines
13760 to handle IPv6 literal addresses.
13761
13762
13763 .option dns_again_means_nonexist main "domain list&!!" unset
13764 .cindex "DNS" "&""try again""& response; overriding"
13765 DNS lookups give a &"try again"& response for the DNS errors
13766 &"non-authoritative host not found"& and &"SERVERFAIL"&. This can cause Exim to
13767 keep trying to deliver a message, or to give repeated temporary errors to
13768 incoming mail. Sometimes the effect is caused by a badly set up name server and
13769 may persist for a long time. If a domain which exhibits this problem matches
13770 anything in &%dns_again_means_nonexist%&, it is treated as if it did not exist.
13771 This option should be used with care. You can make it apply to reverse lookups
13772 by a setting such as this:
13773 .code
13774 dns_again_means_nonexist = *.in-addr.arpa
13775 .endd
13776 This option applies to all DNS lookups that Exim does. It also applies when the
13777 &[gethostbyname()]& or &[getipnodebyname()]& functions give temporary errors,
13778 since these are most likely to be caused by DNS lookup problems. The
13779 &(dnslookup)& router has some options of its own for controlling what happens
13780 when lookups for MX or SRV records give temporary errors. These more specific
13781 options are applied after this global option.
13782
13783 .option dns_check_names_pattern main string "see below"
13784 .cindex "DNS" "pre-check of name syntax"
13785 When this option is set to a non-empty string, it causes Exim to check domain
13786 names for characters that are not allowed in host names before handing them to
13787 the DNS resolver, because some resolvers give temporary errors for names that
13788 contain unusual characters. If a domain name contains any unwanted characters,
13789 a &"not found"& result is forced, and the resolver is not called. The check is
13790 done by matching the domain name against a regular expression, which is the
13791 value of this option. The default pattern is
13792 .code
13793 dns_check_names_pattern = \
13794   (?i)^(?>(?(1)\.|())[^\W_](?>[a-z0-9/-]*[^\W_])?)+$
13795 .endd
13796 which permits only letters, digits, slashes, and hyphens in components, but
13797 they must start and end with a letter or digit. Slashes are not, in fact,
13798 permitted in host names, but they are found in certain NS records (which can be
13799 accessed in Exim by using a &%dnsdb%& lookup). If you set
13800 &%allow_utf8_domains%&, you must modify this pattern, or set the option to an
13801 empty string.
13802
13803 .option dns_csa_search_limit main integer 5
13804 This option controls the depth of parental searching for CSA SRV records in the
13805 DNS, as described in more detail in section &<<SECTverifyCSA>>&.
13806
13807 .option dns_csa_use_reverse main boolean true
13808 This option controls whether or not an IP address, given as a CSA domain, is
13809 reversed and looked up in the reverse DNS, as described in more detail in
13810 section &<<SECTverifyCSA>>&.
13811
13812 .option dns_ipv4_lookup main "domain list&!!" unset
13813 .cindex "IPv6" "DNS lookup for AAAA records"
13814 .cindex "DNS" "IPv6 lookup for AAAA records"
13815 When Exim is compiled with IPv6 support and &%disable_ipv6%& is not set, it
13816 looks for IPv6 address records (AAAA records) as well as IPv4 address records
13817 (A records) when trying to find IP addresses for hosts, unless the host's
13818 domain matches this list.
13819
13820 This is a fudge to help with name servers that give big delays or otherwise do
13821 not work for the AAAA record type. In due course, when the world's name
13822 servers have all been upgraded, there should be no need for this option.
13823
13824
13825 .option dns_retrans main time 0s
13826 .cindex "DNS" "resolver options"
13827 The options &%dns_retrans%& and &%dns_retry%& can be used to set the
13828 retransmission and retry parameters for DNS lookups. Values of zero (the
13829 defaults) leave the system default settings unchanged. The first value is the
13830 time between retries, and the second is the number of retries. It isn't
13831 totally clear exactly how these settings affect the total time a DNS lookup may
13832 take. I haven't found any documentation about timeouts on DNS lookups; these
13833 parameter values are available in the external resolver interface structure,
13834 but nowhere does it seem to describe how they are used or what you might want
13835 to set in them.
13836
13837
13838 .option dns_retry main integer 0
13839 See &%dns_retrans%& above.
13840
13841
13842 .new
13843 .option dns_use_dnssec main integer -1
13844 .cindex "DNS" "resolver options"
13845 .cindex "DNS" "DNSSEC"
13846 If this option is set to a non-negative number then Exim will initialise the
13847 DNS resolver library to either use or not use DNSSEC, overriding the system
13848 default. A value of 0 coerces DNSSEC off, a value of 1 coerces DNSSEC on.
13849
13850 If the resolver library does not support DNSSEC then this option has no effect.
13851 .wen
13852
13853
13854 .option dns_use_edns0 main integer -1
13855 .cindex "DNS" "resolver options"
13856 .cindex "DNS" "EDNS0"
13857 If this option is set to a non-negative number then Exim will initialise the
13858 DNS resolver library to either use or not use EDNS0 extensions, overriding
13859 the system default. A value of 0 coerces EDNS0 off, a value of 1 coerces EDNS0
13860 on.
13861
13862 If the resolver library does not support EDNS0 then this option has no effect.
13863
13864
13865 .option drop_cr main boolean false
13866 This is an obsolete option that is now a no-op. It used to affect the way Exim
13867 handled CR and LF characters in incoming messages. What happens now is
13868 described in section &<<SECTlineendings>>&.
13869
13870 .option dsn_from main "string&!!" "see below"
13871 .cindex "&'From:'& header line" "in bounces"
13872 .cindex "bounce messages" "&'From:'& line, specifying"
13873 This option can be used to vary the contents of &'From:'& header lines in
13874 bounces and other automatically generated messages (&"Delivery Status
13875 Notifications"& &-- hence the name of the option). The default setting is:
13876 .code
13877 dsn_from = Mail Delivery System <Mailer-Daemon@$qualify_domain>
13878 .endd
13879 The value is expanded every time it is needed. If the expansion fails, a
13880 panic is logged, and the default value is used.
13881
13882 .option envelope_to_remove main boolean true
13883 .cindex "&'Envelope-to:'& header line"
13884 Exim's transports have an option for adding an &'Envelope-to:'& header to a
13885 message when it is delivered, in exactly the same way as &'Return-path:'& is
13886 handled. &'Envelope-to:'& records the original recipient address from the
13887 messages's envelope that caused the delivery to happen. Such headers should not
13888 be present in incoming messages, and this option causes them to be removed at
13889 the time the message is received, to avoid any problems that might occur when a
13890 delivered message is subsequently sent on to some other recipient.
13891
13892
13893 .option errors_copy main "string list&!!" unset
13894 .cindex "bounce message" "copy to other address"
13895 .cindex "copy of bounce message"
13896 Setting this option causes Exim to send bcc copies of bounce messages that it
13897 generates to other addresses. &*Note*&: This does not apply to bounce messages
13898 coming from elsewhere. The value of the option is a colon-separated list of
13899 items. Each item consists of a pattern, terminated by white space, followed by
13900 a comma-separated list of email addresses. If a pattern contains spaces, it
13901 must be enclosed in double quotes.
13902
13903 Each pattern is processed in the same way as a single item in an address list
13904 (see section &<<SECTaddresslist>>&). When a pattern matches the recipient of
13905 the bounce message, the message is copied to the addresses on the list. The
13906 items are scanned in order, and once a matching one is found, no further items
13907 are examined. For example:
13908 .code
13909 errors_copy = spqr@mydomain   postmaster@mydomain.example :\
13910               rqps@mydomain   hostmaster@mydomain.example,\
13911                               postmaster@mydomain.example
13912 .endd
13913 .vindex "&$domain$&"
13914 .vindex "&$local_part$&"
13915 The address list is expanded before use. The expansion variables &$local_part$&
13916 and &$domain$& are set from the original recipient of the error message, and if
13917 there was any wildcard matching in the pattern, the expansion
13918 .cindex "numerical variables (&$1$& &$2$& etc)" "in &%errors_copy%&"
13919 variables &$0$&, &$1$&, etc. are set in the normal way.
13920
13921
13922 .option errors_reply_to main string unset
13923 .cindex "bounce message" "&'Reply-to:'& in"
13924 By default, Exim's bounce and delivery warning messages contain the header line
13925 .display
13926 &`From: Mail Delivery System <Mailer-Daemon@`&&'qualify-domain'&&`>`&
13927 .endd
13928 .oindex &%quota_warn_message%&
13929 where &'qualify-domain'& is the value of the &%qualify_domain%& option.
13930 A warning message that is generated by the &%quota_warn_message%& option in an
13931 &(appendfile)& transport may contain its own &'From:'& header line that
13932 overrides the default.
13933
13934 Experience shows that people reply to bounce messages. If the
13935 &%errors_reply_to%& option is set, a &'Reply-To:'& header is added to bounce
13936 and warning messages. For example:
13937 .code
13938 errors_reply_to = postmaster@my.domain.example
13939 .endd
13940 The value of the option is not expanded. It must specify a valid RFC 2822
13941 address. However, if a warning message that is generated by the
13942 &%quota_warn_message%& option in an &(appendfile)& transport contain its
13943 own &'Reply-To:'& header line, the value of the &%errors_reply_to%& option is
13944 not used.
13945
13946
13947 .option exim_group main string "compile-time configured"
13948 .cindex "gid (group id)" "Exim's own"
13949 .cindex "Exim group"
13950 This option changes the gid under which Exim runs when it gives up root
13951 privilege. The default value is compiled into the binary. The value of this
13952 option is used only when &%exim_user%& is also set. Unless it consists entirely
13953 of digits, the string is looked up using &[getgrnam()]&, and failure causes a
13954 configuration error. See chapter &<<CHAPsecurity>>& for a discussion of
13955 security issues.
13956
13957
13958 .option exim_path main string "see below"
13959 .cindex "Exim binary, path name"
13960 This option specifies the path name of the Exim binary, which is used when Exim
13961 needs to re-exec itself. The default is set up to point to the file &'exim'& in
13962 the directory configured at compile time by the BIN_DIRECTORY setting. It
13963 is necessary to change &%exim_path%& if, exceptionally, Exim is run from some
13964 other place.
13965 &*Warning*&: Do not use a macro to define the value of this option, because
13966 you will break those Exim utilities that scan the configuration file to find
13967 where the binary is. (They then use the &%-bP%& option to extract option
13968 settings such as the value of &%spool_directory%&.)
13969
13970
13971 .option exim_user main string "compile-time configured"
13972 .cindex "uid (user id)" "Exim's own"
13973 .cindex "Exim user"
13974 This option changes the uid under which Exim runs when it gives up root
13975 privilege. The default value is compiled into the binary. Ownership of the run
13976 time configuration file and the use of the &%-C%& and &%-D%& command line
13977 options is checked against the values in the binary, not what is set here.
13978
13979 Unless it consists entirely of digits, the string is looked up using
13980 &[getpwnam()]&, and failure causes a configuration error. If &%exim_group%& is
13981 not also supplied, the gid is taken from the result of &[getpwnam()]& if it is
13982 used. See chapter &<<CHAPsecurity>>& for a discussion of security issues.
13983
13984
13985 .option extra_local_interfaces main "string list" unset
13986 This option defines network interfaces that are to be considered local when
13987 routing, but which are not used for listening by the daemon. See section
13988 &<<SECTreclocipadd>>& for details.
13989
13990
13991 . Allow this long option name to split; give it unsplit as a fifth argument
13992 . for the automatic .oindex that is generated by .option.
13993
13994 .option "extract_addresses_remove_ &~&~arguments" main boolean true &&&
13995          extract_addresses_remove_arguments
13996 .oindex "&%-t%&"
13997 .cindex "command line" "addresses with &%-t%&"
13998 .cindex "Sendmail compatibility" "&%-t%& option"
13999 According to some Sendmail documentation (Sun, IRIX, HP-UX), if any addresses
14000 are present on the command line when the &%-t%& option is used to build an
14001 envelope from a message's &'To:'&, &'Cc:'& and &'Bcc:'& headers, the command
14002 line addresses are removed from the recipients list. This is also how Smail
14003 behaves. However, other Sendmail documentation (the O'Reilly book) states that
14004 command line addresses are added to those obtained from the header lines. When
14005 &%extract_addresses_remove_arguments%& is true (the default), Exim subtracts
14006 argument headers. If it is set false, Exim adds rather than removes argument
14007 addresses.
14008
14009
14010 .option finduser_retries main integer 0
14011 .cindex "NIS, retrying user lookups"
14012 On systems running NIS or other schemes in which user and group information is
14013 distributed from a remote system, there can be times when &[getpwnam()]& and
14014 related functions fail, even when given valid data, because things time out.
14015 Unfortunately these failures cannot be distinguished from genuine &"not found"&
14016 errors. If &%finduser_retries%& is set greater than zero, Exim will try that
14017 many extra times to find a user or a group, waiting for one second between
14018 retries.
14019
14020 .cindex "&_/etc/passwd_&" "multiple reading of"
14021 You should not set this option greater than zero if your user information is in
14022 a traditional &_/etc/passwd_& file, because it will cause Exim needlessly to
14023 search the file multiple times for non-existent users, and also cause delay.
14024
14025
14026
14027 .option freeze_tell main "string list, comma separated" unset
14028 .cindex "freezing messages" "sending a message when freezing"
14029 On encountering certain errors, or when configured to do so in a system filter,
14030 ACL, or special router, Exim freezes a message. This means that no further
14031 delivery attempts take place until an administrator thaws the message, or the
14032 &%auto_thaw%&, &%ignore_bounce_errors_after%&, or &%timeout_frozen_after%&
14033 feature cause it to be processed. If &%freeze_tell%& is set, Exim generates a
14034 warning message whenever it freezes something, unless the message it is
14035 freezing is a locally-generated bounce message. (Without this exception there
14036 is the possibility of looping.) The warning message is sent to the addresses
14037 supplied as the comma-separated value of this option. If several of the
14038 message's addresses cause freezing, only a single message is sent. If the
14039 freezing was automatic, the reason(s) for freezing can be found in the message
14040 log. If you configure freezing in a filter or ACL, you must arrange for any
14041 logging that you require.
14042
14043
14044 .option gecos_name main string&!! unset
14045 .cindex "HP-UX"
14046 .cindex "&""gecos""& field, parsing"
14047 Some operating systems, notably HP-UX, use the &"gecos"& field in the system
14048 password file to hold other information in addition to users' real names. Exim
14049 looks up this field for use when it is creating &'Sender:'& or &'From:'&
14050 headers. If either &%gecos_pattern%& or &%gecos_name%& are unset, the contents
14051 of the field are used unchanged, except that, if an ampersand is encountered,
14052 it is replaced by the user's login name with the first character forced to
14053 upper case, since this is a convention that is observed on many systems.
14054
14055 When these options are set, &%gecos_pattern%& is treated as a regular
14056 expression that is to be applied to the field (again with && replaced by the
14057 login name), and if it matches, &%gecos_name%& is expanded and used as the
14058 user's name.
14059
14060 .cindex "numerical variables (&$1$& &$2$& etc)" "in &%gecos_name%&"
14061 Numeric variables such as &$1$&, &$2$&, etc. can be used in the expansion to
14062 pick up sub-fields that were matched by the pattern. In HP-UX, where the user's
14063 name terminates at the first comma, the following can be used:
14064 .code
14065 gecos_pattern = ([^,]*)
14066 gecos_name = $1
14067 .endd
14068
14069 .option gecos_pattern main string unset
14070 See &%gecos_name%& above.
14071
14072
14073 .option gnutls_compat_mode main boolean unset
14074 This option controls whether GnuTLS is used in compatibility mode in an Exim
14075 server. This reduces security slightly, but improves interworking with older
14076 implementations of TLS.
14077
14078
14079 .new
14080 option gnutls_enable_pkcs11 main boolean unset
14081 This option will let GnuTLS (2.12.0 or later) autoload PKCS11 modules with
14082 the p11-kit configuration files in &_/etc/pkcs11/modules/_&.
14083
14084 See
14085 &url(http://www.gnutls.org/manual/gnutls.html#Smart-cards-and-HSMs)
14086 for documentation.
14087 .wen
14088
14089
14090
14091 .option headers_charset main string "see below"
14092 This option sets a default character set for translating from encoded MIME
14093 &"words"& in header lines, when referenced by an &$h_xxx$& expansion item. The
14094 default is the value of HEADERS_CHARSET in &_Local/Makefile_&. The
14095 ultimate default is ISO-8859-1. For more details see the description of header
14096 insertions in section &<<SECTexpansionitems>>&.
14097
14098
14099
14100 .option header_maxsize main integer "see below"
14101 .cindex "header section" "maximum size of"
14102 .cindex "limit" "size of message header section"
14103 This option controls the overall maximum size of a message's header
14104 section. The default is the value of HEADER_MAXSIZE in
14105 &_Local/Makefile_&; the default for that is 1M. Messages with larger header
14106 sections are rejected.
14107
14108
14109 .option header_line_maxsize main integer 0
14110 .cindex "header lines" "maximum size of"
14111 .cindex "limit" "size of one header line"
14112 This option limits the length of any individual header line in a message, after
14113 all the continuations have been joined together. Messages with individual
14114 header lines that are longer than the limit are rejected. The default value of
14115 zero means &"no limit"&.
14116
14117
14118
14119
14120 .option helo_accept_junk_hosts main "host list&!!" unset
14121 .cindex "HELO" "accepting junk data"
14122 .cindex "EHLO" "accepting junk data"
14123 Exim checks the syntax of HELO and EHLO commands for incoming SMTP
14124 mail, and gives an error response for invalid data. Unfortunately, there are
14125 some SMTP clients that send syntactic junk. They can be accommodated by setting
14126 this option. Note that this is a syntax check only. See &%helo_verify_hosts%&
14127 if you want to do semantic checking.
14128 See also &%helo_allow_chars%& for a way of extending the permitted character
14129 set.
14130
14131
14132 .option helo_allow_chars main string unset
14133 .cindex "HELO" "underscores in"
14134 .cindex "EHLO" "underscores in"
14135 .cindex "underscore in EHLO/HELO"
14136 This option can be set to a string of rogue characters that are permitted in
14137 all EHLO and HELO names in addition to the standard letters, digits,
14138 hyphens, and dots. If you really must allow underscores, you can set
14139 .code
14140 helo_allow_chars = _
14141 .endd
14142 Note that the value is one string, not a list.
14143
14144
14145 .option helo_lookup_domains main "domain list&!!" &`@:@[]`&
14146 .cindex "HELO" "forcing reverse lookup"
14147 .cindex "EHLO" "forcing reverse lookup"
14148 If the domain given by a client in a HELO or EHLO command matches this
14149 list, a reverse lookup is done in order to establish the host's true name. The
14150 default forces a lookup if the client host gives the server's name or any of
14151 its IP addresses (in brackets), something that broken clients have been seen to
14152 do.
14153
14154
14155 .option helo_try_verify_hosts main "host list&!!" unset
14156 .cindex "HELO verifying" "optional"
14157 .cindex "EHLO" "verifying, optional"
14158 By default, Exim just checks the syntax of HELO and EHLO commands (see
14159 &%helo_accept_junk_hosts%& and &%helo_allow_chars%&). However, some sites like
14160 to do more extensive checking of the data supplied by these commands. The ACL
14161 condition &`verify = helo`& is provided to make this possible.
14162 Formerly, it was necessary also to set this option (&%helo_try_verify_hosts%&)
14163 to force the check to occur. From release 4.53 onwards, this is no longer
14164 necessary. If the check has not been done before &`verify = helo`& is
14165 encountered, it is done at that time. Consequently, this option is obsolete.
14166 Its specification is retained here for backwards compatibility.
14167
14168 When an EHLO or HELO command is received, if the calling host matches
14169 &%helo_try_verify_hosts%&, Exim checks that the host name given in the HELO or
14170 EHLO command either:
14171
14172 .ilist
14173 is an IP literal matching the calling address of the host, or
14174 .next
14175 .cindex "DNS" "reverse lookup"
14176 .cindex "reverse DNS lookup"
14177 matches the host name that Exim obtains by doing a reverse lookup of the
14178 calling host address, or
14179 .next
14180 when looked up using &[gethostbyname()]& (or &[getipnodebyname()]& when
14181 available) yields the calling host address.
14182 .endlist
14183
14184 However, the EHLO or HELO command is not rejected if any of the checks
14185 fail. Processing continues, but the result of the check is remembered, and can
14186 be detected later in an ACL by the &`verify = helo`& condition.
14187
14188 .option helo_verify_hosts main "host list&!!" unset
14189 .cindex "HELO verifying" "mandatory"
14190 .cindex "EHLO" "verifying, mandatory"
14191 Like &%helo_try_verify_hosts%&, this option is obsolete, and retained only for
14192 backwards compatibility. For hosts that match this option, Exim checks the host
14193 name given in the HELO or EHLO in the same way as for
14194 &%helo_try_verify_hosts%&. If the check fails, the HELO or EHLO command is
14195 rejected with a 550 error, and entries are written to the main and reject logs.
14196 If a MAIL command is received before EHLO or HELO, it is rejected with a 503
14197 error.
14198
14199 .option hold_domains main "domain list&!!" unset
14200 .cindex "domain" "delaying delivery"
14201 .cindex "delivery" "delaying certain domains"
14202 This option allows mail for particular domains to be held on the queue
14203 manually. The option is overridden if a message delivery is forced with the
14204 &%-M%&, &%-qf%&, &%-Rf%& or &%-Sf%& options, and also while testing or
14205 verifying addresses using &%-bt%& or &%-bv%&. Otherwise, if a domain matches an
14206 item in &%hold_domains%&, no routing or delivery for that address is done, and
14207 it is deferred every time the message is looked at.
14208
14209 This option is intended as a temporary operational measure for delaying the
14210 delivery of mail while some problem is being sorted out, or some new
14211 configuration tested. If you just want to delay the processing of some
14212 domains until a queue run occurs, you should use &%queue_domains%& or
14213 &%queue_smtp_domains%&, not &%hold_domains%&.
14214
14215 A setting of &%hold_domains%& does not override Exim's code for removing
14216 messages from the queue if they have been there longer than the longest retry
14217 time in any retry rule. If you want to hold messages for longer than the normal
14218 retry times, insert a dummy retry rule with a long retry time.
14219
14220
14221 .option host_lookup main "host list&!!" unset
14222 .cindex "host name" "lookup, forcing"
14223 Exim does not look up the name of a calling host from its IP address unless it
14224 is required to compare against some host list, or the host matches
14225 &%helo_try_verify_hosts%& or &%helo_verify_hosts%&, or the host matches this
14226 option (which normally contains IP addresses rather than host names). The
14227 default configuration file contains
14228 .code
14229 host_lookup = *
14230 .endd
14231 which causes a lookup to happen for all hosts. If the expense of these lookups
14232 is felt to be too great, the setting can be changed or removed.
14233
14234 After a successful reverse lookup, Exim does a forward lookup on the name it
14235 has obtained, to verify that it yields the IP address that it started with. If
14236 this check fails, Exim behaves as if the name lookup failed.
14237
14238 .vindex "&$host_lookup_failed$&"
14239 .vindex "&$sender_host_name$&"
14240 After any kind of failure, the host name (in &$sender_host_name$&) remains
14241 unset, and &$host_lookup_failed$& is set to the string &"1"&. See also
14242 &%dns_again_means_nonexist%&, &%helo_lookup_domains%&, and
14243 &`verify = reverse_host_lookup`& in ACLs.
14244
14245
14246 .option host_lookup_order main "string list" &`bydns:byaddr`&
14247 This option specifies the order of different lookup methods when Exim is trying
14248 to find a host name from an IP address. The default is to do a DNS lookup
14249 first, and then to try a local lookup (using &[gethostbyaddr()]& or equivalent)
14250 if that fails. You can change the order of these lookups, or omit one entirely,
14251 if you want.
14252
14253 &*Warning*&: The &"byaddr"& method does not always yield aliases when there are
14254 multiple PTR records in the DNS and the IP address is not listed in
14255 &_/etc/hosts_&. Different operating systems give different results in this
14256 case. That is why the default tries a DNS lookup first.
14257
14258
14259
14260 .option host_reject_connection main "host list&!!" unset
14261 .cindex "host" "rejecting connections from"
14262 If this option is set, incoming SMTP calls from the hosts listed are rejected
14263 as soon as the connection is made.
14264 This option is obsolete, and retained only for backward compatibility, because
14265 nowadays the ACL specified by &%acl_smtp_connect%& can also reject incoming
14266 connections immediately.
14267
14268 The ability to give an immediate rejection (either by this option or using an
14269 ACL) is provided for use in unusual cases. Many hosts will just try again,
14270 sometimes without much delay. Normally, it is better to use an ACL to reject
14271 incoming messages at a later stage, such as after RCPT commands. See
14272 chapter &<<CHAPACL>>&.
14273
14274
14275 .option hosts_connection_nolog main "host list&!!" unset
14276 .cindex "host" "not logging connections from"
14277 This option defines a list of hosts for which connection logging does not
14278 happen, even though the &%smtp_connection%& log selector is set. For example,
14279 you might want not to log SMTP connections from local processes, or from
14280 127.0.0.1, or from your local LAN. This option is consulted in the main loop of
14281 the daemon; you should therefore strive to restrict its value to a short inline
14282 list of IP addresses and networks. To disable logging SMTP connections from
14283 local processes, you must create a host list with an empty item. For example:
14284 .code
14285 hosts_connection_nolog = :
14286 .endd
14287 If the &%smtp_connection%& log selector is not set, this option has no effect.
14288
14289
14290
14291 .option hosts_treat_as_local main "domain list&!!" unset
14292 .cindex "local host" "domains treated as"
14293 .cindex "host" "treated as local"
14294 If this option is set, any host names that match the domain list are treated as
14295 if they were the local host when Exim is scanning host lists obtained from MX
14296 records
14297 or other sources. Note that the value of this option is a domain list, not a
14298 host list, because it is always used to check host names, not IP addresses.
14299
14300 This option also applies when Exim is matching the special items
14301 &`@mx_any`&, &`@mx_primary`&, and &`@mx_secondary`& in a domain list (see
14302 section &<<SECTdomainlist>>&), and when checking the &%hosts%& option in the
14303 &(smtp)& transport for the local host (see the &%allow_localhost%& option in
14304 that transport). See also &%local_interfaces%&, &%extra_local_interfaces%&, and
14305 chapter &<<CHAPinterfaces>>&, which contains a discussion about local network
14306 interfaces and recognizing the local host.
14307
14308
14309 .option ibase_servers main "string list" unset
14310 .cindex "InterBase" "server list"
14311 This option provides a list of InterBase servers and associated connection data,
14312 to be used in conjunction with &(ibase)& lookups (see section &<<SECID72>>&).
14313 The option is available only if Exim has been built with InterBase support.
14314
14315
14316
14317 .option ignore_bounce_errors_after main time 10w
14318 .cindex "bounce message" "discarding"
14319 .cindex "discarding bounce message"
14320 This option affects the processing of bounce messages that cannot be delivered,
14321 that is, those that suffer a permanent delivery failure. (Bounce messages that
14322 suffer temporary delivery failures are of course retried in the usual way.)
14323
14324 After a permanent delivery failure, bounce messages are frozen,
14325 because there is no sender to whom they can be returned. When a frozen bounce
14326 message has been on the queue for more than the given time, it is unfrozen at
14327 the next queue run, and a further delivery is attempted. If delivery fails
14328 again, the bounce message is discarded. This makes it possible to keep failed
14329 bounce messages around for a shorter time than the normal maximum retry time
14330 for frozen messages. For example,
14331 .code
14332 ignore_bounce_errors_after = 12h
14333 .endd
14334 retries failed bounce message deliveries after 12 hours, discarding any further
14335 failures. If the value of this option is set to a zero time period, bounce
14336 failures are discarded immediately. Setting a very long time (as in the default
14337 value) has the effect of disabling this option. For ways of automatically
14338 dealing with other kinds of frozen message, see &%auto_thaw%& and
14339 &%timeout_frozen_after%&.
14340
14341
14342 .option ignore_fromline_hosts main "host list&!!" unset
14343 .cindex "&""From""& line"
14344 .cindex "UUCP" "&""From""& line"
14345 Some broken SMTP clients insist on sending a UUCP-like &"From&~"& line before
14346 the headers of a message. By default this is treated as the start of the
14347 message's body, which means that any following headers are not recognized as
14348 such. Exim can be made to ignore it by setting &%ignore_fromline_hosts%& to
14349 match those hosts that insist on sending it. If the sender is actually a local
14350 process rather than a remote host, and is using &%-bs%& to inject the messages,
14351 &%ignore_fromline_local%& must be set to achieve this effect.
14352
14353
14354 .option ignore_fromline_local main boolean false
14355 See &%ignore_fromline_hosts%& above.
14356
14357
14358 .option keep_malformed main time 4d
14359 This option specifies the length of time to keep messages whose spool files
14360 have been corrupted in some way. This should, of course, never happen. At the
14361 next attempt to deliver such a message, it gets removed. The incident is
14362 logged.
14363
14364
14365 .option ldap_ca_cert_dir main string unset
14366 .cindex "LDAP", "TLS CA certificate directory"
14367 This option indicates which directory contains CA certificates for verifying
14368 a TLS certificate presented by an LDAP server.
14369 While Exim does not provide a default value, your SSL library may.
14370 Analogous to &%tls_verify_certificates%& but as a client-side option for LDAP
14371 and constrained to be a directory.
14372
14373
14374 .option ldap_ca_cert_file main string unset
14375 .cindex "LDAP", "TLS CA certificate file"
14376 This option indicates which file contains CA certificates for verifying
14377 a TLS certificate presented by an LDAP server.
14378 While Exim does not provide a default value, your SSL library may.
14379 Analogous to &%tls_verify_certificates%& but as a client-side option for LDAP
14380 and constrained to be a file.
14381
14382
14383 .option ldap_cert_file main string unset
14384 .cindex "LDAP" "TLS client certificate file"
14385 This option indicates which file contains an TLS client certificate which
14386 Exim should present to the LDAP server during TLS negotiation.
14387 Should be used together with &%ldap_cert_key%&.
14388
14389
14390 .option ldap_cert_key main string unset
14391 .cindex "LDAP" "TLS client key file"
14392 This option indicates which file contains the secret/private key to use
14393 to prove identity to the LDAP server during TLS negotiation.
14394 Should be used together with &%ldap_cert_file%&, which contains the
14395 identity to be proven.
14396
14397
14398 .option ldap_cipher_suite main string unset
14399 .cindex "LDAP" "TLS cipher suite"
14400 This controls the TLS cipher-suite negotiation during TLS negotiation with
14401 the LDAP server.  See &<<SECTreqciphssl>>& for more details of the format of
14402 cipher-suite options with OpenSSL (as used by LDAP client libraries).
14403
14404
14405 .option ldap_default_servers main "string list" unset
14406 .cindex "LDAP" "default servers"
14407 This option provides a list of LDAP servers which are tried in turn when an
14408 LDAP query does not contain a server. See section &<<SECTforldaque>>& for
14409 details of LDAP queries. This option is available only when Exim has been built
14410 with LDAP support.
14411
14412
14413 .option ldap_require_cert main string unset.
14414 .cindex "LDAP" "policy for LDAP server TLS cert presentation"
14415 This should be one of the values "hard", "demand", "allow", "try" or "never".
14416 A value other than one of these is interpreted as "never".
14417 See the entry "TLS_REQCERT" in your system man page for ldap.conf(5).
14418 Although Exim does not set a default, the LDAP library probably defaults
14419 to hard/demand.
14420
14421
14422 .option ldap_start_tls main boolean false
14423 .cindex "LDAP" "whether or not to negotiate TLS"
14424 If set, Exim will attempt to negotiate TLS with the LDAP server when
14425 connecting on a regular LDAP port.  This is the LDAP equivalent of SMTP's
14426 "STARTTLS".  This is distinct from using "ldaps", which is the LDAP form
14427 of SSL-on-connect.
14428 In the event of failure to negotiate TLS, the action taken is controlled
14429 by &%ldap_require_cert%&.
14430
14431
14432 .option ldap_version main integer unset
14433 .cindex "LDAP" "protocol version, forcing"
14434 This option can be used to force Exim to set a specific protocol version for
14435 LDAP. If it option is unset, it is shown by the &%-bP%& command line option as
14436 -1. When this is the case, the default is 3 if LDAP_VERSION3 is defined in
14437 the LDAP headers; otherwise it is 2. This option is available only when Exim
14438 has been built with LDAP support.
14439
14440
14441
14442 .option local_from_check main boolean true
14443 .cindex "&'Sender:'& header line" "disabling addition of"
14444 .cindex "&'From:'& header line" "disabling checking of"
14445 When a message is submitted locally (that is, not over a TCP/IP connection) by
14446 an untrusted user, Exim removes any existing &'Sender:'& header line, and
14447 checks that the &'From:'& header line matches the login of the calling user and
14448 the domain specified by &%qualify_domain%&.
14449
14450 &*Note*&: An unqualified address (no domain) in the &'From:'& header in a
14451 locally submitted message is automatically qualified by Exim, unless the
14452 &%-bnq%& command line option is used.
14453
14454 You can use &%local_from_prefix%& and &%local_from_suffix%& to permit affixes
14455 on the local part. If the &'From:'& header line does not match, Exim adds a
14456 &'Sender:'& header with an address constructed from the calling user's login
14457 and the default qualify domain.
14458
14459 If &%local_from_check%& is set false, the &'From:'& header check is disabled,
14460 and no &'Sender:'& header is ever added. If, in addition, you want to retain
14461 &'Sender:'& header lines supplied by untrusted users, you must also set
14462 &%local_sender_retain%& to be true.
14463
14464 .cindex "envelope sender"
14465 These options affect only the header lines in the message. The envelope sender
14466 is still forced to be the login id at the qualify domain unless
14467 &%untrusted_set_sender%& permits the user to supply an envelope sender.
14468
14469 For messages received over TCP/IP, an ACL can specify &"submission mode"& to
14470 request similar header line checking. See section &<<SECTthesenhea>>&, which
14471 has more details about &'Sender:'& processing.
14472
14473
14474
14475
14476 .option local_from_prefix main string unset
14477 When Exim checks the &'From:'& header line of locally submitted messages for
14478 matching the login id (see &%local_from_check%& above), it can be configured to
14479 ignore certain prefixes and suffixes in the local part of the address. This is
14480 done by setting &%local_from_prefix%& and/or &%local_from_suffix%& to
14481 appropriate lists, in the same form as the &%local_part_prefix%& and
14482 &%local_part_suffix%& router options (see chapter &<<CHAProutergeneric>>&). For
14483 example, if
14484 .code
14485 local_from_prefix = *-
14486 .endd
14487 is set, a &'From:'& line containing
14488 .code
14489 From: anything-user@your.domain.example
14490 .endd
14491 will not cause a &'Sender:'& header to be added if &'user@your.domain.example'&
14492 matches the actual sender address that is constructed from the login name and
14493 qualify domain.
14494
14495
14496 .option local_from_suffix main string unset
14497 See &%local_from_prefix%& above.
14498
14499
14500 .option local_interfaces main "string list" "see below"
14501 This option controls which network interfaces are used by the daemon for
14502 listening; they are also used to identify the local host when routing. Chapter
14503 &<<CHAPinterfaces>>& contains a full description of this option and the related
14504 options &%daemon_smtp_ports%&, &%extra_local_interfaces%&,
14505 &%hosts_treat_as_local%&, and &%tls_on_connect_ports%&. The default value for
14506 &%local_interfaces%& is
14507 .code
14508 local_interfaces = 0.0.0.0
14509 .endd
14510 when Exim is built without IPv6 support; otherwise it is
14511 .code
14512 local_interfaces = <; ::0 ; 0.0.0.0
14513 .endd
14514
14515 .option local_scan_timeout main time 5m
14516 .cindex "timeout" "for &[local_scan()]& function"
14517 .cindex "&[local_scan()]& function" "timeout"
14518 This timeout applies to the &[local_scan()]& function (see chapter
14519 &<<CHAPlocalscan>>&). Zero means &"no timeout"&. If the timeout is exceeded,
14520 the incoming message is rejected with a temporary error if it is an SMTP
14521 message. For a non-SMTP message, the message is dropped and Exim ends with a
14522 non-zero code. The incident is logged on the main and reject logs.
14523
14524
14525
14526 .option local_sender_retain main boolean false
14527 .cindex "&'Sender:'& header line" "retaining from local submission"
14528 When a message is submitted locally (that is, not over a TCP/IP connection) by
14529 an untrusted user, Exim removes any existing &'Sender:'& header line. If you
14530 do not want this to happen, you must set &%local_sender_retain%&, and you must
14531 also set &%local_from_check%& to be false (Exim will complain if you do not).
14532 See also the ACL modifier &`control = suppress_local_fixups`&. Section
14533 &<<SECTthesenhea>>& has more details about &'Sender:'& processing.
14534
14535
14536
14537
14538 .option localhost_number main string&!! unset
14539 .cindex "host" "locally unique number for"
14540 .cindex "message ids" "with multiple hosts"
14541 .vindex "&$localhost_number$&"
14542 Exim's message ids are normally unique only within the local host. If
14543 uniqueness among a set of hosts is required, each host must set a different
14544 value for the &%localhost_number%& option. The string is expanded immediately
14545 after reading the configuration file (so that a number can be computed from the
14546 host name, for example) and the result of the expansion must be a number in the
14547 range 0&--16 (or 0&--10 on operating systems with case-insensitive file
14548 systems). This is available in subsequent string expansions via the variable
14549 &$localhost_number$&. When &%localhost_number is set%&, the final two
14550 characters of the message id, instead of just being a fractional part of the
14551 time, are computed from the time and the local host number as described in
14552 section &<<SECTmessiden>>&.
14553
14554
14555
14556 .option log_file_path main "string list&!!" "set at compile time"
14557 .cindex "log" "file path for"
14558 This option sets the path which is used to determine the names of Exim's log
14559 files, or indicates that logging is to be to syslog, or both. It is expanded
14560 when Exim is entered, so it can, for example, contain a reference to the host
14561 name. If no specific path is set for the log files at compile or run time, they
14562 are written in a sub-directory called &_log_& in Exim's spool directory.
14563 Chapter &<<CHAPlog>>& contains further details about Exim's logging, and
14564 section &<<SECTwhelogwri>>& describes how the contents of &%log_file_path%& are
14565 used. If this string is fixed at your installation (contains no expansion
14566 variables) it is recommended that you do not set this option in the
14567 configuration file, but instead supply the path using LOG_FILE_PATH in
14568 &_Local/Makefile_& so that it is available to Exim for logging errors detected
14569 early on &-- in particular, failure to read the configuration file.
14570
14571
14572 .option log_selector main string unset
14573 .cindex "log" "selectors"
14574 This option can be used to reduce or increase the number of things that Exim
14575 writes to its log files. Its argument is made up of names preceded by plus or
14576 minus characters. For example:
14577 .code
14578 log_selector = +arguments -retry_defer
14579 .endd
14580 A list of possible names and what they control is given in the chapter on
14581 logging, in section &<<SECTlogselector>>&.
14582
14583
14584 .option log_timezone main boolean false
14585 .cindex "log" "timezone for entries"
14586 .vindex "&$tod_log$&"
14587 .vindex "&$tod_zone$&"
14588 By default, the timestamps on log lines are in local time without the
14589 timezone. This means that if your timezone changes twice a year, the timestamps
14590 in log lines are ambiguous for an hour when the clocks go back. One way of
14591 avoiding this problem is to set the timezone to UTC. An alternative is to set
14592 &%log_timezone%& true. This turns on the addition of the timezone offset to
14593 timestamps in log lines. Turning on this option can add quite a lot to the size
14594 of log files because each line is extended by 6 characters. Note that the
14595 &$tod_log$& variable contains the log timestamp without the zone, but there is
14596 another variable called &$tod_zone$& that contains just the timezone offset.
14597
14598
14599 .option lookup_open_max main integer 25
14600 .cindex "too many open files"
14601 .cindex "open files, too many"
14602 .cindex "file" "too many open"
14603 .cindex "lookup" "maximum open files"
14604 .cindex "limit" "open files for lookups"
14605 This option limits the number of simultaneously open files for single-key
14606 lookups that use regular files (that is, &(lsearch)&, &(dbm)&, and &(cdb)&).
14607 Exim normally keeps these files open during routing, because often the same
14608 file is required several times. If the limit is reached, Exim closes the least
14609 recently used file. Note that if you are using the &'ndbm'& library, it
14610 actually opens two files for each logical DBM database, though it still counts
14611 as one for the purposes of &%lookup_open_max%&. If you are getting &"too many
14612 open files"& errors with NDBM, you need to reduce the value of
14613 &%lookup_open_max%&.
14614
14615
14616 .option max_username_length main integer 0
14617 .cindex "length of login name"
14618 .cindex "user name" "maximum length"
14619 .cindex "limit" "user name length"
14620 Some operating systems are broken in that they truncate long arguments to
14621 &[getpwnam()]& to eight characters, instead of returning &"no such user"&. If
14622 this option is set greater than zero, any attempt to call &[getpwnam()]& with
14623 an argument that is longer behaves as if &[getpwnam()]& failed.
14624
14625
14626 .option message_body_newlines main bool false
14627 .cindex "message body" "newlines in variables"
14628 .cindex "newline" "in message body variables"
14629 .vindex "&$message_body$&"
14630 .vindex "&$message_body_end$&"
14631 By default, newlines in the message body are replaced by spaces when setting
14632 the &$message_body$& and &$message_body_end$& expansion variables. If this
14633 option is set true, this no longer happens.
14634
14635
14636 .option message_body_visible main integer 500
14637 .cindex "body of message" "visible size"
14638 .cindex "message body" "visible size"
14639 .vindex "&$message_body$&"
14640 .vindex "&$message_body_end$&"
14641 This option specifies how much of a message's body is to be included in the
14642 &$message_body$& and &$message_body_end$& expansion variables.
14643
14644
14645 .option message_id_header_domain main string&!! unset
14646 .cindex "&'Message-ID:'& header line"
14647 If this option is set, the string is expanded and used as the right hand side
14648 (domain) of the &'Message-ID:'& header that Exim creates if a
14649 locally-originated incoming message does not have one. &"Locally-originated"&
14650 means &"not received over TCP/IP."&
14651 Otherwise, the primary host name is used.
14652 Only letters, digits, dot and hyphen are accepted; any other characters are
14653 replaced by hyphens. If the expansion is forced to fail, or if the result is an
14654 empty string, the option is ignored.
14655
14656
14657 .option message_id_header_text main string&!! unset
14658 If this variable is set, the string is expanded and used to augment the text of
14659 the &'Message-id:'& header that Exim creates if a locally-originated incoming
14660 message does not have one. The text of this header is required by RFC 2822 to
14661 take the form of an address. By default, Exim uses its internal message id as
14662 the local part, and the primary host name as the domain. If this option is set,
14663 it is expanded, and provided the expansion is not forced to fail, and does not
14664 yield an empty string, the result is inserted into the header immediately
14665 before the @, separated from the internal message id by a dot. Any characters
14666 that are illegal in an address are automatically converted into hyphens. This
14667 means that variables such as &$tod_log$& can be used, because the spaces and
14668 colons will become hyphens.
14669
14670
14671 .option message_logs main boolean true
14672 .cindex "message logs" "disabling"
14673 .cindex "log" "message log; disabling"
14674 If this option is turned off, per-message log files are not created in the
14675 &_msglog_& spool sub-directory. This reduces the amount of disk I/O required by
14676 Exim, by reducing the number of files involved in handling a message from a
14677 minimum of four (header spool file, body spool file, delivery journal, and
14678 per-message log) to three. The other major I/O activity is Exim's main log,
14679 which is not affected by this option.
14680
14681
14682 .option message_size_limit main string&!! 50M
14683 .cindex "message" "size limit"
14684 .cindex "limit" "message size"
14685 .cindex "size" "of message, limit"
14686 This option limits the maximum size of message that Exim will process. The
14687 value is expanded for each incoming connection so, for example, it can be made
14688 to depend on the IP address of the remote host for messages arriving via
14689 TCP/IP. After expansion, the value must be a sequence of decimal digits,
14690 optionally followed by K or M.
14691
14692 &*Note*&: This limit cannot be made to depend on a message's sender or any
14693 other properties of an individual message, because it has to be advertised in
14694 the server's response to EHLO. String expansion failure causes a temporary
14695 error. A value of zero means no limit, but its use is not recommended. See also
14696 &%bounce_return_size_limit%&.
14697
14698 Incoming SMTP messages are failed with a 552 error if the limit is
14699 exceeded; locally-generated messages either get a stderr message or a delivery
14700 failure message to the sender, depending on the &%-oe%& setting. Rejection of
14701 an oversized message is logged in both the main and the reject logs. See also
14702 the generic transport option &%message_size_limit%&, which limits the size of
14703 message that an individual transport can process.
14704
14705 If you use a virus-scanner and set this option to to a value larger than the
14706 maximum size that your virus-scanner is configured to support, you may get
14707 failures triggered by large mails.  The right size to configure for the
14708 virus-scanner depends upon what data is passed and the options in use but it's
14709 probably safest to just set it to a little larger than this value.  Eg, with a
14710 default Exim message size of 50M and a default ClamAV StreamMaxLength of 10M,
14711 some problems may result.
14712
14713 A value of 0 will disable size limit checking; Exim will still advertise the
14714 SIZE extension in an EHLO response, but without a limit, so as to permit
14715 SMTP clients to still indicate the message size along with the MAIL verb.
14716
14717
14718 .option move_frozen_messages main boolean false
14719 .cindex "frozen messages" "moving"
14720 This option, which is available only if Exim has been built with the setting
14721 .code
14722 SUPPORT_MOVE_FROZEN_MESSAGES=yes
14723 .endd
14724 in &_Local/Makefile_&, causes frozen messages and their message logs to be
14725 moved from the &_input_& and &_msglog_& directories on the spool to &_Finput_&
14726 and &_Fmsglog_&, respectively. There is currently no support in Exim or the
14727 standard utilities for handling such moved messages, and they do not show up in
14728 lists generated by &%-bp%& or by the Exim monitor.
14729
14730
14731 .option mua_wrapper main boolean false
14732 Setting this option true causes Exim to run in a very restrictive mode in which
14733 it passes messages synchronously to a smart host. Chapter &<<CHAPnonqueueing>>&
14734 contains a full description of this facility.
14735
14736
14737
14738 .option mysql_servers main "string list" unset
14739 .cindex "MySQL" "server list"
14740 This option provides a list of MySQL servers and associated connection data, to
14741 be used in conjunction with &(mysql)& lookups (see section &<<SECID72>>&). The
14742 option is available only if Exim has been built with MySQL support.
14743
14744
14745 .option never_users main "string list&!!" unset
14746 This option is expanded just once, at the start of Exim's processing. Local
14747 message deliveries are normally run in processes that are setuid to the
14748 recipient, and remote deliveries are normally run under Exim's own uid and gid.
14749 It is usually desirable to prevent any deliveries from running as root, as a
14750 safety precaution.
14751
14752 When Exim is built, an option called FIXED_NEVER_USERS can be set to a
14753 list of users that must not be used for local deliveries. This list is fixed in
14754 the binary and cannot be overridden by the configuration file. By default, it
14755 contains just the single user name &"root"&. The &%never_users%& runtime option
14756 can be used to add more users to the fixed list.
14757
14758 If a message is to be delivered as one of the users on the fixed list or the
14759 &%never_users%& list, an error occurs, and delivery is deferred. A common
14760 example is
14761 .code
14762 never_users = root:daemon:bin
14763 .endd
14764 Including root is redundant if it is also on the fixed list, but it does no
14765 harm. This option overrides the &%pipe_as_creator%& option of the &(pipe)&
14766 transport driver.
14767
14768
14769 .option openssl_options main "string list" "+no_sslv2"
14770 .cindex "OpenSSL "compatibility options"
14771 This option allows an administrator to adjust the SSL options applied
14772 by OpenSSL to connections.  It is given as a space-separated list of items,
14773 each one to be +added or -subtracted from the current value.
14774
14775 This option is only available if Exim is built against OpenSSL.  The values
14776 available for this option vary according to the age of your OpenSSL install.
14777 The &"all"& value controls a subset of flags which are available, typically
14778 the bug workaround options.  The &'SSL_CTX_set_options'& man page will
14779 list the values known on your system and Exim should support all the
14780 &"bug workaround"& options and many of the &"modifying"& options.  The Exim
14781 names lose the leading &"SSL_OP_"& and are lower-cased.
14782
14783 Note that adjusting the options can have severe impact upon the security of
14784 SSL as used by Exim.  It is possible to disable safety checks and shoot
14785 yourself in the foot in various unpleasant ways.  This option should not be
14786 adjusted lightly.  An unrecognised item will be detected at startup, by
14787 invoking Exim with the &%-bV%& flag.
14788
14789 Historical note: prior to release 4.80, Exim defaulted this value to
14790 "+dont_insert_empty_fragments", which may still be needed for compatibility
14791 with some clients, but which lowers security by increasing exposure to
14792 some now infamous attacks.
14793
14794 An example:
14795 .code
14796 # Make both old MS and old Eudora happy:
14797 openssl_options = -all +microsoft_big_sslv3_buffer \
14798                        +dont_insert_empty_fragments
14799 .endd
14800
14801 Possible options may include:
14802 .ilist
14803 &`all`&
14804 .next
14805 &`allow_unsafe_legacy_renegotiation`&
14806 .next
14807 &`cipher_server_preference`&
14808 .next
14809 &`dont_insert_empty_fragments`&
14810 .next
14811 &`ephemeral_rsa`&
14812 .next
14813 &`legacy_server_connect`&
14814 .next
14815 &`microsoft_big_sslv3_buffer`&
14816 .next
14817 &`microsoft_sess_id_bug`&
14818 .next
14819 &`msie_sslv2_rsa_padding`&
14820 .next
14821 &`netscape_challenge_bug`&
14822 .next
14823 &`netscape_reuse_cipher_change_bug`&
14824 .next
14825 &`no_compression`&
14826 .next
14827 &`no_session_resumption_on_renegotiation`&
14828 .next
14829 &`no_sslv2`&
14830 .next
14831 &`no_sslv3`&
14832 .next
14833 &`no_ticket`&
14834 .next
14835 &`no_tlsv1`&
14836 .next
14837 &`no_tlsv1_1`&
14838 .next
14839 &`no_tlsv1_2`&
14840 .next
14841 .new
14842 &`safari_ecdhe_ecdsa_bug`&
14843 .wen
14844 .next
14845 &`single_dh_use`&
14846 .next
14847 &`single_ecdh_use`&
14848 .next
14849 &`ssleay_080_client_dh_bug`&
14850 .next
14851 &`sslref2_reuse_cert_type_bug`&
14852 .next
14853 &`tls_block_padding_bug`&
14854 .next
14855 &`tls_d5_bug`&
14856 .next
14857 &`tls_rollback_bug`&
14858 .endlist
14859
14860 .new
14861 As an aside, the &`safari_ecdhe_ecdsa_bug`& item is a misnomer and affects
14862 all clients connecting using the MacOS SecureTransport TLS facility prior
14863 to MacOS 10.8.4, including email clients.  If you see old MacOS clients failing
14864 to negotiate TLS then this option value might help, provided that your OpenSSL
14865 release is new enough to contain this work-around.  This may be a situation
14866 where you have to upgrade OpenSSL to get buggy clients working.
14867 .wen
14868
14869
14870 .option oracle_servers main "string list" unset
14871 .cindex "Oracle" "server list"
14872 This option provides a list of Oracle servers and associated connection data,
14873 to be used in conjunction with &(oracle)& lookups (see section &<<SECID72>>&).
14874 The option is available only if Exim has been built with Oracle support.
14875
14876
14877 .option percent_hack_domains main "domain list&!!" unset
14878 .cindex "&""percent hack""&"
14879 .cindex "source routing" "in email address"
14880 .cindex "address" "source-routed"
14881 The &"percent hack"& is the convention whereby a local part containing a
14882 percent sign is re-interpreted as a new email address, with the percent
14883 replaced by @. This is sometimes called &"source routing"&, though that term is
14884 also applied to RFC 2822 addresses that begin with an @ character. If this
14885 option is set, Exim implements the percent facility for those domains listed,
14886 but no others. This happens before an incoming SMTP address is tested against
14887 an ACL.
14888
14889 &*Warning*&: The &"percent hack"& has often been abused by people who are
14890 trying to get round relaying restrictions. For this reason, it is best avoided
14891 if at all possible. Unfortunately, a number of less security-conscious MTAs
14892 implement it unconditionally. If you are running Exim on a gateway host, and
14893 routing mail through to internal MTAs without processing the local parts, it is
14894 a good idea to reject recipient addresses with percent characters in their
14895 local parts. Exim's default configuration does this.
14896
14897
14898 .option perl_at_start main boolean false
14899 This option is available only when Exim is built with an embedded Perl
14900 interpreter. See chapter &<<CHAPperl>>& for details of its use.
14901
14902
14903 .option perl_startup main string unset
14904 This option is available only when Exim is built with an embedded Perl
14905 interpreter. See chapter &<<CHAPperl>>& for details of its use.
14906
14907
14908 .option pgsql_servers main "string list" unset
14909 .cindex "PostgreSQL lookup type" "server list"
14910 This option provides a list of PostgreSQL servers and associated connection
14911 data, to be used in conjunction with &(pgsql)& lookups (see section
14912 &<<SECID72>>&). The option is available only if Exim has been built with
14913 PostgreSQL support.
14914
14915
14916 .option pid_file_path main string&!! "set at compile time"
14917 .cindex "daemon" "pid file path"
14918 .cindex "pid file, path for"
14919 This option sets the name of the file to which the Exim daemon writes its
14920 process id. The string is expanded, so it can contain, for example, references
14921 to the host name:
14922 .code
14923 pid_file_path = /var/log/$primary_hostname/exim.pid
14924 .endd
14925 If no path is set, the pid is written to the file &_exim-daemon.pid_& in Exim's
14926 spool directory.
14927 The value set by the option can be overridden by the &%-oP%& command line
14928 option. A pid file is not written if a &"non-standard"& daemon is run by means
14929 of the &%-oX%& option, unless a path is explicitly supplied by &%-oP%&.
14930
14931
14932 .option pipelining_advertise_hosts main "host list&!!" *
14933 .cindex "PIPELINING" "suppressing advertising"
14934 This option can be used to suppress the advertisement of the SMTP
14935 PIPELINING extension to specific hosts. See also the &*no_pipelining*&
14936 control in section &<<SECTcontrols>>&. When PIPELINING is not advertised and
14937 &%smtp_enforce_sync%& is true, an Exim server enforces strict synchronization
14938 for each SMTP command and response. When PIPELINING is advertised, Exim assumes
14939 that clients will use it; &"out of order"& commands that are &"expected"& do
14940 not count as protocol errors (see &%smtp_max_synprot_errors%&).
14941
14942
14943 .option preserve_message_logs main boolean false
14944 .cindex "message logs" "preserving"
14945 If this option is set, message log files are not deleted when messages are
14946 completed. Instead, they are moved to a sub-directory of the spool directory
14947 called &_msglog.OLD_&, where they remain available for statistical or debugging
14948 purposes. This is a dangerous option to set on systems with any appreciable
14949 volume of mail. Use with care!
14950
14951
14952 .option primary_hostname main string "see below"
14953 .cindex "name" "of local host"
14954 .cindex "host" "name of local"
14955 .cindex "local host" "name of"
14956 .vindex "&$primary_hostname$&"
14957 This specifies the name of the current host. It is used in the default EHLO or
14958 HELO command for outgoing SMTP messages (changeable via the &%helo_data%&
14959 option in the &(smtp)& transport), and as the default for &%qualify_domain%&.
14960 The value is also used by default in some SMTP response messages from an Exim
14961 server. This can be changed dynamically by setting &%smtp_active_hostname%&.
14962
14963 If &%primary_hostname%& is not set, Exim calls &[uname()]& to find the host
14964 name. If this fails, Exim panics and dies. If the name returned by &[uname()]&
14965 contains only one component, Exim passes it to &[gethostbyname()]& (or
14966 &[getipnodebyname()]& when available) in order to obtain the fully qualified
14967 version. The variable &$primary_hostname$& contains the host name, whether set
14968 explicitly by this option, or defaulted.
14969
14970
14971 .option print_topbitchars main boolean false
14972 .cindex "printing characters"
14973 .cindex "8-bit characters"
14974 By default, Exim considers only those characters whose codes lie in the range
14975 32&--126 to be printing characters. In a number of circumstances (for example,
14976 when writing log entries) non-printing characters are converted into escape
14977 sequences, primarily to avoid messing up the layout. If &%print_topbitchars%&
14978 is set, code values of 128 and above are also considered to be printing
14979 characters.
14980
14981 This option also affects the header syntax checks performed by the
14982 &(autoreply)& transport, and whether Exim uses RFC 2047 encoding of
14983 the user's full name when constructing From: and Sender: addresses (as
14984 described in section &<<SECTconstr>>&). Setting this option can cause
14985 Exim to generate eight bit message headers that do not conform to the
14986 standards.
14987
14988
14989 .option process_log_path main string unset
14990 .cindex "process log path"
14991 .cindex "log" "process log"
14992 .cindex "&'exiwhat'&"
14993 This option sets the name of the file to which an Exim process writes its
14994 &"process log"& when sent a USR1 signal. This is used by the &'exiwhat'&
14995 utility script. If this option is unset, the file called &_exim-process.info_&
14996 in Exim's spool directory is used. The ability to specify the name explicitly
14997 can be useful in environments where two different Exims are running, using
14998 different spool directories.
14999
15000
15001 .option prod_requires_admin main boolean true
15002 .oindex "&%-M%&"
15003 .oindex "&%-R%&"
15004 .oindex "&%-q%&"
15005 The &%-M%&, &%-R%&, and &%-q%& command-line options require the caller to be an
15006 admin user unless &%prod_requires_admin%& is set false. See also
15007 &%queue_list_requires_admin%&.
15008
15009
15010 .option qualify_domain main string "see below"
15011 .cindex "domain" "for qualifying addresses"
15012 .cindex "address" "qualification"
15013 This option specifies the domain name that is added to any envelope sender
15014 addresses that do not have a domain qualification. It also applies to
15015 recipient addresses if &%qualify_recipient%& is not set. Unqualified addresses
15016 are accepted by default only for locally-generated messages. Qualification is
15017 also applied to addresses in header lines such as &'From:'& and &'To:'& for
15018 locally-generated messages, unless the &%-bnq%& command line option is used.
15019
15020 Messages from external sources must always contain fully qualified addresses,
15021 unless the sending host matches &%sender_unqualified_hosts%& or
15022 &%recipient_unqualified_hosts%& (as appropriate), in which case incoming
15023 addresses are qualified with &%qualify_domain%& or &%qualify_recipient%& as
15024 necessary. Internally, Exim always works with fully qualified envelope
15025 addresses. If &%qualify_domain%& is not set, it defaults to the
15026 &%primary_hostname%& value.
15027
15028
15029 .option qualify_recipient main string "see below"
15030 This option allows you to specify a different domain for qualifying recipient
15031 addresses to the one that is used for senders. See &%qualify_domain%& above.
15032
15033
15034
15035 .option queue_domains main "domain list&!!" unset
15036 .cindex "domain" "specifying non-immediate delivery"
15037 .cindex "queueing incoming messages"
15038 .cindex "message" "queueing certain domains"
15039 This option lists domains for which immediate delivery is not required.
15040 A delivery process is started whenever a message is received, but only those
15041 domains that do not match are processed. All other deliveries wait until the
15042 next queue run. See also &%hold_domains%& and &%queue_smtp_domains%&.
15043
15044
15045 .option queue_list_requires_admin main boolean true
15046 .oindex "&%-bp%&"
15047 The &%-bp%& command-line option, which lists the messages that are on the
15048 queue, requires the caller to be an admin user unless
15049 &%queue_list_requires_admin%& is set false. See also &%prod_requires_admin%&.
15050
15051
15052 .option queue_only main boolean false
15053 .cindex "queueing incoming messages"
15054 .cindex "message" "queueing unconditionally"
15055 If &%queue_only%& is set, a delivery process is not automatically started
15056 whenever a message is received. Instead, the message waits on the queue for the
15057 next queue run. Even if &%queue_only%& is false, incoming messages may not get
15058 delivered immediately when certain conditions (such as heavy load) occur.
15059
15060 The &%-odq%& command line has the same effect as &%queue_only%&. The &%-odb%&
15061 and &%-odi%& command line options override &%queue_only%& unless
15062 &%queue_only_override%& is set false. See also &%queue_only_file%&,
15063 &%queue_only_load%&, and &%smtp_accept_queue%&.
15064
15065
15066 .option queue_only_file main string unset
15067 .cindex "queueing incoming messages"
15068 .cindex "message" "queueing by file existence"
15069 This option can be set to a colon-separated list of absolute path names, each
15070 one optionally preceded by &"smtp"&. When Exim is receiving a message,
15071 it tests for the existence of each listed path using a call to &[stat()]&. For
15072 each path that exists, the corresponding queueing option is set.
15073 For paths with no prefix, &%queue_only%& is set; for paths prefixed by
15074 &"smtp"&, &%queue_smtp_domains%& is set to match all domains. So, for example,
15075 .code
15076 queue_only_file = smtp/some/file
15077 .endd
15078 causes Exim to behave as if &%queue_smtp_domains%& were set to &"*"& whenever
15079 &_/some/file_& exists.
15080
15081
15082 .option queue_only_load main fixed-point unset
15083 .cindex "load average"
15084 .cindex "queueing incoming messages"
15085 .cindex "message" "queueing by load"
15086 If the system load average is higher than this value, incoming messages from
15087 all sources are queued, and no automatic deliveries are started. If this
15088 happens during local or remote SMTP input, all subsequent messages received on
15089 the same SMTP connection are queued by default, whatever happens to the load in
15090 the meantime, but this can be changed by setting &%queue_only_load_latch%&
15091 false.
15092
15093 Deliveries will subsequently be performed by queue runner processes. This
15094 option has no effect on ancient operating systems on which Exim cannot
15095 determine the load average. See also &%deliver_queue_load_max%& and
15096 &%smtp_load_reserve%&.
15097
15098
15099 .option queue_only_load_latch main boolean true
15100 .cindex "load average" "re-evaluating per message"
15101 When this option is true (the default), once one message has been queued
15102 because the load average is higher than the value set by &%queue_only_load%&,
15103 all subsequent messages received on the same SMTP connection are also queued.
15104 This is a deliberate choice; even though the load average may fall below the
15105 threshold, it doesn't seem right to deliver later messages on the same
15106 connection when not delivering earlier ones. However, there are special
15107 circumstances such as very long-lived connections from scanning appliances
15108 where this is not the best strategy. In such cases, &%queue_only_load_latch%&
15109 should be set false. This causes the value of the load average to be
15110 re-evaluated for each message.
15111
15112
15113 .option queue_only_override main boolean true
15114 .cindex "queueing incoming messages"
15115 When this option is true, the &%-od%&&'x'& command line options override the
15116 setting of &%queue_only%& or &%queue_only_file%& in the configuration file. If
15117 &%queue_only_override%& is set false, the &%-od%&&'x'& options cannot be used
15118 to override; they are accepted, but ignored.
15119
15120
15121 .option queue_run_in_order main boolean false
15122 .cindex "queue runner" "processing messages in order"
15123 If this option is set, queue runs happen in order of message arrival instead of
15124 in an arbitrary order. For this to happen, a complete list of the entire queue
15125 must be set up before the deliveries start. When the queue is all held in a
15126 single directory (the default), a single list is created for both the ordered
15127 and the non-ordered cases. However, if &%split_spool_directory%& is set, a
15128 single list is not created when &%queue_run_in_order%& is false. In this case,
15129 the sub-directories are processed one at a time (in a random order), and this
15130 avoids setting up one huge list for the whole queue. Thus, setting
15131 &%queue_run_in_order%& with &%split_spool_directory%& may degrade performance
15132 when the queue is large, because of the extra work in setting up the single,
15133 large list. In most situations, &%queue_run_in_order%& should not be set.
15134
15135
15136
15137 .option queue_run_max main integer 5
15138 .cindex "queue runner" "maximum number of"
15139 This controls the maximum number of queue runner processes that an Exim daemon
15140 can run simultaneously. This does not mean that it starts them all at once,
15141 but rather that if the maximum number are still running when the time comes to
15142 start another one, it refrains from starting another one. This can happen with
15143 very large queues and/or very sluggish deliveries. This option does not,
15144 however, interlock with other processes, so additional queue runners can be
15145 started by other means, or by killing and restarting the daemon.
15146
15147 Setting this option to zero does not suppress queue runs; rather, it disables
15148 the limit, allowing any number of simultaneous queue runner processes to be
15149 run. If you do not want queue runs to occur, omit the &%-q%&&'xx'& setting on
15150 the daemon's command line.
15151
15152 .option queue_smtp_domains main "domain list&!!" unset
15153 .cindex "queueing incoming messages"
15154 .cindex "message" "queueing remote deliveries"
15155 When this option is set, a delivery process is started whenever a message is
15156 received, routing is performed, and local deliveries take place.
15157 However, if any SMTP deliveries are required for domains that match
15158 &%queue_smtp_domains%&, they are not immediately delivered, but instead the
15159 message waits on the queue for the next queue run. Since routing of the message
15160 has taken place, Exim knows to which remote hosts it must be delivered, and so
15161 when the queue run happens, multiple messages for the same host are delivered
15162 over a single SMTP connection. The &%-odqs%& command line option causes all
15163 SMTP deliveries to be queued in this way, and is equivalent to setting
15164 &%queue_smtp_domains%& to &"*"&. See also &%hold_domains%& and
15165 &%queue_domains%&.
15166
15167
15168 .option receive_timeout main time 0s
15169 .cindex "timeout" "for non-SMTP input"
15170 This option sets the timeout for accepting a non-SMTP message, that is, the
15171 maximum time that Exim waits when reading a message on the standard input. If
15172 the value is zero, it will wait for ever. This setting is overridden by the
15173 &%-or%& command line option. The timeout for incoming SMTP messages is
15174 controlled by &%smtp_receive_timeout%&.
15175
15176 .option received_header_text main string&!! "see below"
15177 .cindex "customizing" "&'Received:'& header"
15178 .cindex "&'Received:'& header line" "customizing"
15179 This string defines the contents of the &'Received:'& message header that is
15180 added to each message, except for the timestamp, which is automatically added
15181 on at the end (preceded by a semicolon). The string is expanded each time it is
15182 used. If the expansion yields an empty string, no &'Received:'& header line is
15183 added to the message. Otherwise, the string should start with the text
15184 &"Received:"& and conform to the RFC 2822 specification for &'Received:'&
15185 header lines. The default setting is:
15186
15187 .code
15188 received_header_text = Received: \
15189   ${if def:sender_rcvhost {from $sender_rcvhost\n\t}\
15190   {${if def:sender_ident \
15191   {from ${quote_local_part:$sender_ident} }}\
15192   ${if def:sender_helo_name {(helo=$sender_helo_name)\n\t}}}}\
15193   by $primary_hostname \
15194   ${if def:received_protocol {with $received_protocol}} \
15195   ${if def:tls_in_cipher {($tls_in_cipher)\n\t}}\
15196   (Exim $version_number)\n\t\
15197   ${if def:sender_address \
15198   {(envelope-from <$sender_address>)\n\t}}\
15199   id $message_exim_id\
15200   ${if def:received_for {\n\tfor $received_for}}
15201 .endd
15202
15203 The reference to the TLS cipher is omitted when Exim is built without TLS
15204 support. The use of conditional expansions ensures that this works for both
15205 locally generated messages and messages received from remote hosts, giving
15206 header lines such as the following:
15207 .code
15208 Received: from scrooge.carol.example ([192.168.12.25] ident=root)
15209 by marley.carol.example with esmtp (Exim 4.00)
15210 (envelope-from <bob@carol.example>)
15211 id 16IOWa-00019l-00
15212 for chas@dickens.example; Tue, 25 Dec 2001 14:43:44 +0000
15213 Received: by scrooge.carol.example with local (Exim 4.00)
15214 id 16IOWW-000083-00; Tue, 25 Dec 2001 14:43:41 +0000
15215 .endd
15216 Until the body of the message has been received, the timestamp is the time when
15217 the message started to be received. Once the body has arrived, and all policy
15218 checks have taken place, the timestamp is updated to the time at which the
15219 message was accepted.
15220
15221
15222 .option received_headers_max main integer 30
15223 .cindex "loop" "prevention"
15224 .cindex "mail loop prevention"
15225 .cindex "&'Received:'& header line" "counting"
15226 When a message is to be delivered, the number of &'Received:'& headers is
15227 counted, and if it is greater than this parameter, a mail loop is assumed to
15228 have occurred, the delivery is abandoned, and an error message is generated.
15229 This applies to both local and remote deliveries.
15230
15231
15232 .option recipient_unqualified_hosts main "host list&!!" unset
15233 .cindex "unqualified addresses"
15234 .cindex "host" "unqualified addresses from"
15235 This option lists those hosts from which Exim is prepared to accept unqualified
15236 recipient addresses in message envelopes. The addresses are made fully
15237 qualified by the addition of the &%qualify_recipient%& value. This option also
15238 affects message header lines. Exim does not reject unqualified recipient
15239 addresses in headers, but it qualifies them only if the message came from a
15240 host that matches &%recipient_unqualified_hosts%&,
15241 or if the message was submitted locally (not using TCP/IP), and the &%-bnq%&
15242 option was not set.
15243
15244
15245 .option recipients_max main integer 0
15246 .cindex "limit" "number of recipients"
15247 .cindex "recipient" "maximum number"
15248 If this option is set greater than zero, it specifies the maximum number of
15249 original recipients for any message. Additional recipients that are generated
15250 by aliasing or forwarding do not count. SMTP messages get a 452 response for
15251 all recipients over the limit; earlier recipients are delivered as normal.
15252 Non-SMTP messages with too many recipients are failed, and no deliveries are
15253 done.
15254
15255 .cindex "RCPT" "maximum number of incoming"
15256 &*Note*&: The RFCs specify that an SMTP server should accept at least 100
15257 RCPT commands in a single message.
15258
15259
15260 .option recipients_max_reject main boolean false
15261 If this option is set true, Exim rejects SMTP messages containing too many
15262 recipients by giving 552 errors to the surplus RCPT commands, and a 554
15263 error to the eventual DATA command. Otherwise (the default) it gives a 452
15264 error to the surplus RCPT commands and accepts the message on behalf of the
15265 initial set of recipients. The remote server should then re-send the message
15266 for the remaining recipients at a later time.
15267
15268
15269 .option remote_max_parallel main integer 2
15270 .cindex "delivery" "parallelism for remote"
15271 This option controls parallel delivery of one message to a number of remote
15272 hosts. If the value is less than 2, parallel delivery is disabled, and Exim
15273 does all the remote deliveries for a message one by one. Otherwise, if a single
15274 message has to be delivered to more than one remote host, or if several copies
15275 have to be sent to the same remote host, up to &%remote_max_parallel%&
15276 deliveries are done simultaneously. If more than &%remote_max_parallel%&
15277 deliveries are required, the maximum number of processes are started, and as
15278 each one finishes, another is begun. The order of starting processes is the
15279 same as if sequential delivery were being done, and can be controlled by the
15280 &%remote_sort_domains%& option. If parallel delivery takes place while running
15281 with debugging turned on, the debugging output from each delivery process is
15282 tagged with its process id.
15283
15284 This option controls only the maximum number of parallel deliveries for one
15285 message in one Exim delivery process. Because Exim has no central queue
15286 manager, there is no way of controlling the total number of simultaneous
15287 deliveries if the configuration allows a delivery attempt as soon as a message
15288 is received.
15289
15290 .cindex "number of deliveries"
15291 .cindex "delivery" "maximum number of"
15292 If you want to control the total number of deliveries on the system, you
15293 need to set the &%queue_only%& option. This ensures that all incoming messages
15294 are added to the queue without starting a delivery process. Then set up an Exim
15295 daemon to start queue runner processes at appropriate intervals (probably
15296 fairly often, for example, every minute), and limit the total number of queue
15297 runners by setting the &%queue_run_max%& parameter. Because each queue runner
15298 delivers only one message at a time, the maximum number of deliveries that can
15299 then take place at once is &%queue_run_max%& multiplied by
15300 &%remote_max_parallel%&.
15301
15302 If it is purely remote deliveries you want to control, use
15303 &%queue_smtp_domains%& instead of &%queue_only%&. This has the added benefit of
15304 doing the SMTP routing before queueing, so that several messages for the same
15305 host will eventually get delivered down the same connection.
15306
15307
15308 .option remote_sort_domains main "domain list&!!" unset
15309 .cindex "sorting remote deliveries"
15310 .cindex "delivery" "sorting remote"
15311 When there are a number of remote deliveries for a message, they are sorted by
15312 domain into the order given by this list. For example,
15313 .code
15314 remote_sort_domains = *.cam.ac.uk:*.uk
15315 .endd
15316 would attempt to deliver to all addresses in the &'cam.ac.uk'& domain first,
15317 then to those in the &%uk%& domain, then to any others.
15318
15319
15320 .option retry_data_expire main time 7d
15321 .cindex "hints database" "data expiry"
15322 This option sets a &"use before"& time on retry information in Exim's hints
15323 database. Any older retry data is ignored. This means that, for example, once a
15324 host has not been tried for 7 days, Exim behaves as if it has no knowledge of
15325 past failures.
15326
15327
15328 .option retry_interval_max main time 24h
15329 .cindex "retry" "limit on interval"
15330 .cindex "limit" "on retry interval"
15331 Chapter &<<CHAPretry>>& describes Exim's mechanisms for controlling the
15332 intervals between delivery attempts for messages that cannot be delivered
15333 straight away. This option sets an overall limit to the length of time between
15334 retries. It cannot be set greater than 24 hours; any attempt to do so forces
15335 the default value.
15336
15337
15338 .option return_path_remove main boolean true
15339 .cindex "&'Return-path:'& header line" "removing"
15340 RFC 2821, section 4.4, states that an SMTP server must insert a
15341 &'Return-path:'& header line into a message when it makes a &"final delivery"&.
15342 The &'Return-path:'& header preserves the sender address as received in the
15343 MAIL command. This description implies that this header should not be present
15344 in an incoming message. If &%return_path_remove%& is true, any existing
15345 &'Return-path:'& headers are removed from messages at the time they are
15346 received. Exim's transports have options for adding &'Return-path:'& headers at
15347 the time of delivery. They are normally used only for final local deliveries.
15348
15349
15350 .option return_size_limit main integer 100K
15351 This option is an obsolete synonym for &%bounce_return_size_limit%&.
15352
15353
15354 .option rfc1413_hosts main "host list&!!" *
15355 .cindex "RFC 1413"
15356 .cindex "host" "for RFC 1413 calls"
15357 RFC 1413 identification calls are made to any client host which matches an item
15358 in the list.
15359
15360 .option rfc1413_query_timeout main time 5s
15361 .cindex "RFC 1413" "query timeout"
15362 .cindex "timeout" "for RFC 1413 call"
15363 This sets the timeout on RFC 1413 identification calls. If it is set to zero,
15364 no RFC 1413 calls are ever made.
15365
15366
15367 .option sender_unqualified_hosts main "host list&!!" unset
15368 .cindex "unqualified addresses"
15369 .cindex "host" "unqualified addresses from"
15370 This option lists those hosts from which Exim is prepared to accept unqualified
15371 sender addresses. The addresses are made fully qualified by the addition of
15372 &%qualify_domain%&. This option also affects message header lines. Exim does
15373 not reject unqualified addresses in headers that contain sender addresses, but
15374 it qualifies them only if the message came from a host that matches
15375 &%sender_unqualified_hosts%&, or if the message was submitted locally (not
15376 using TCP/IP), and the &%-bnq%& option was not set.
15377
15378
15379 .option smtp_accept_keepalive main boolean true
15380 .cindex "keepalive" "on incoming connection"
15381 This option controls the setting of the SO_KEEPALIVE option on incoming
15382 TCP/IP socket connections. When set, it causes the kernel to probe idle
15383 connections periodically, by sending packets with &"old"& sequence numbers. The
15384 other end of the connection should send an acknowledgment if the connection is
15385 still okay or a reset if the connection has been aborted. The reason for doing
15386 this is that it has the beneficial effect of freeing up certain types of
15387 connection that can get stuck when the remote host is disconnected without
15388 tidying up the TCP/IP call properly. The keepalive mechanism takes several
15389 hours to detect unreachable hosts.
15390
15391
15392
15393 .option smtp_accept_max main integer 20
15394 .cindex "limit" "incoming SMTP connections"
15395 .cindex "SMTP" "incoming connection count"
15396 .cindex "inetd"
15397 This option specifies the maximum number of simultaneous incoming SMTP calls
15398 that Exim will accept. It applies only to the listening daemon; there is no
15399 control (in Exim) when incoming SMTP is being handled by &'inetd'&. If the
15400 value is set to zero, no limit is applied. However, it is required to be
15401 non-zero if either &%smtp_accept_max_per_host%& or &%smtp_accept_queue%& is
15402 set. See also &%smtp_accept_reserve%& and &%smtp_load_reserve%&.
15403
15404 A new SMTP connection is immediately rejected if the &%smtp_accept_max%& limit
15405 has been reached. If not, Exim first checks &%smtp_accept_max_per_host%&. If
15406 that limit has not been reached for the client host, &%smtp_accept_reserve%&
15407 and &%smtp_load_reserve%& are then checked before accepting the connection.
15408
15409
15410 .option smtp_accept_max_nonmail main integer 10
15411 .cindex "limit" "non-mail SMTP commands"
15412 .cindex "SMTP" "limiting non-mail commands"
15413 Exim counts the number of &"non-mail"& commands in an SMTP session, and drops
15414 the connection if there are too many. This option defines &"too many"&. The
15415 check catches some denial-of-service attacks, repeated failing AUTHs, or a mad
15416 client looping sending EHLO, for example. The check is applied only if the
15417 client host matches &%smtp_accept_max_nonmail_hosts%&.
15418
15419 When a new message is expected, one occurrence of RSET is not counted. This
15420 allows a client to send one RSET between messages (this is not necessary,
15421 but some clients do it). Exim also allows one uncounted occurrence of HELO
15422 or EHLO, and one occurrence of STARTTLS between messages. After
15423 starting up a TLS session, another EHLO is expected, and so it too is not
15424 counted. The first occurrence of AUTH in a connection, or immediately
15425 following STARTTLS is not counted. Otherwise, all commands other than
15426 MAIL, RCPT, DATA, and QUIT are counted.
15427
15428
15429 .option smtp_accept_max_nonmail_hosts main "host list&!!" *
15430 You can control which hosts are subject to the &%smtp_accept_max_nonmail%&
15431 check by setting this option. The default value makes it apply to all hosts. By
15432 changing the value, you can exclude any badly-behaved hosts that you have to
15433 live with.
15434
15435
15436 . Allow this long option name to split; give it unsplit as a fifth argument
15437 . for the automatic .oindex that is generated by .option.
15438 . We insert " &~&~" which is both pretty nasty visually and results in
15439 . non-searchable text.  HowItWorks.txt mentions an option for inserting
15440 . zero-width-space, which would be nicer visually and results in (at least)
15441 . html that Firefox will split on when it's forced to reflow (rather than
15442 . inserting a horizontal scrollbar).  However, the text is still not
15443 . searchable.  NM changed this occurrence for bug 1197 to no longer allow
15444 . the option name to split.
15445
15446 .option "smtp_accept_max_per_connection" main integer 1000 &&&
15447          smtp_accept_max_per_connection
15448 .cindex "SMTP" "limiting incoming message count"
15449 .cindex "limit" "messages per SMTP connection"
15450 The value of this option limits the number of MAIL commands that Exim is
15451 prepared to accept over a single SMTP connection, whether or not each command
15452 results in the transfer of a message. After the limit is reached, a 421
15453 response is given to subsequent MAIL commands. This limit is a safety
15454 precaution against a client that goes mad (incidents of this type have been
15455 seen).
15456
15457
15458 .option smtp_accept_max_per_host main string&!! unset
15459 .cindex "limit" "SMTP connections from one host"
15460 .cindex "host" "limiting SMTP connections from"
15461 This option restricts the number of simultaneous IP connections from a single
15462 host (strictly, from a single IP address) to the Exim daemon. The option is
15463 expanded, to enable different limits to be applied to different hosts by
15464 reference to &$sender_host_address$&. Once the limit is reached, additional
15465 connection attempts from the same host are rejected with error code 421. This
15466 is entirely independent of &%smtp_accept_reserve%&. The option's default value
15467 of zero imposes no limit. If this option is set greater than zero, it is
15468 required that &%smtp_accept_max%& be non-zero.
15469
15470 &*Warning*&: When setting this option you should not use any expansion
15471 constructions that take an appreciable amount of time. The expansion and test
15472 happen in the main daemon loop, in order to reject additional connections
15473 without forking additional processes (otherwise a denial-of-service attack
15474 could cause a vast number or processes to be created). While the daemon is
15475 doing this processing, it cannot accept any other incoming connections.
15476
15477
15478
15479 .option smtp_accept_queue main integer 0
15480 .cindex "SMTP" "incoming connection count"
15481 .cindex "queueing incoming messages"
15482 .cindex "message" "queueing by SMTP connection count"
15483 If the number of simultaneous incoming SMTP connections being handled via the
15484 listening daemon exceeds this value, messages received by SMTP are just placed
15485 on the queue; no delivery processes are started automatically. The count is
15486 fixed at the start of an SMTP connection. It cannot be updated in the
15487 subprocess that receives messages, and so the queueing or not queueing applies
15488 to all messages received in the same connection.
15489
15490 A value of zero implies no limit, and clearly any non-zero value is useful only
15491 if it is less than the &%smtp_accept_max%& value (unless that is zero). See
15492 also &%queue_only%&, &%queue_only_load%&, &%queue_smtp_domains%&, and the
15493 various &%-od%&&'x'& command line options.
15494
15495
15496 . See the comment on smtp_accept_max_per_connection
15497
15498 .option "smtp_accept_queue_per_connection" main integer 10 &&&
15499          smtp_accept_queue_per_connection
15500 .cindex "queueing incoming messages"
15501 .cindex "message" "queueing by message count"
15502 This option limits the number of delivery processes that Exim starts
15503 automatically when receiving messages via SMTP, whether via the daemon or by
15504 the use of &%-bs%& or &%-bS%&. If the value of the option is greater than zero,
15505 and the number of messages received in a single SMTP session exceeds this
15506 number, subsequent messages are placed on the queue, but no delivery processes
15507 are started. This helps to limit the number of Exim processes when a server
15508 restarts after downtime and there is a lot of mail waiting for it on other
15509 systems. On large systems, the default should probably be increased, and on
15510 dial-in client systems it should probably be set to zero (that is, disabled).
15511
15512
15513 .option smtp_accept_reserve main integer 0
15514 .cindex "SMTP" "incoming call count"
15515 .cindex "host" "reserved"
15516 When &%smtp_accept_max%& is set greater than zero, this option specifies a
15517 number of SMTP connections that are reserved for connections from the hosts
15518 that are specified in &%smtp_reserve_hosts%&. The value set in
15519 &%smtp_accept_max%& includes this reserve pool. The specified hosts are not
15520 restricted to this number of connections; the option specifies a minimum number
15521 of connection slots for them, not a maximum. It is a guarantee that this group
15522 of hosts can always get at least &%smtp_accept_reserve%& connections. However,
15523 the limit specified by &%smtp_accept_max_per_host%& is still applied to each
15524 individual host.
15525
15526 For example, if &%smtp_accept_max%& is set to 50 and &%smtp_accept_reserve%& is
15527 set to 5, once there are 45 active connections (from any hosts), new
15528 connections are accepted only from hosts listed in &%smtp_reserve_hosts%&,
15529 provided the other criteria for acceptance are met.
15530
15531
15532 .option smtp_active_hostname main string&!! unset
15533 .cindex "host" "name in SMTP responses"
15534 .cindex "SMTP" "host name in responses"
15535 .vindex "&$primary_hostname$&"
15536 This option is provided for multi-homed servers that want to masquerade as
15537 several different hosts. At the start of an incoming SMTP connection, its value
15538 is expanded and used instead of the value of &$primary_hostname$& in SMTP
15539 responses. For example, it is used as domain name in the response to an
15540 incoming HELO or EHLO command.
15541
15542 .vindex "&$smtp_active_hostname$&"
15543 The active hostname is placed in the &$smtp_active_hostname$& variable, which
15544 is saved with any messages that are received. It is therefore available for use
15545 in routers and transports when the message is later delivered.
15546
15547 If this option is unset, or if its expansion is forced to fail, or if the
15548 expansion results in an empty string, the value of &$primary_hostname$& is
15549 used. Other expansion failures cause a message to be written to the main and
15550 panic logs, and the SMTP command receives a temporary error. Typically, the
15551 value of &%smtp_active_hostname%& depends on the incoming interface address.
15552 For example:
15553 .code
15554 smtp_active_hostname = ${if eq{$received_ip_address}{10.0.0.1}\
15555   {cox.mydomain}{box.mydomain}}
15556 .endd
15557
15558 Although &$smtp_active_hostname$& is primarily concerned with incoming
15559 messages, it is also used as the default for HELO commands in callout
15560 verification if there is no remote transport from which to obtain a
15561 &%helo_data%& value.
15562
15563 .option smtp_banner main string&!! "see below"
15564 .cindex "SMTP" "welcome banner"
15565 .cindex "banner for SMTP"
15566 .cindex "welcome banner for SMTP"
15567 .cindex "customizing" "SMTP banner"
15568 This string, which is expanded every time it is used, is output as the initial
15569 positive response to an SMTP connection. The default setting is:
15570 .code
15571 smtp_banner = $smtp_active_hostname ESMTP Exim \
15572   $version_number $tod_full
15573 .endd
15574 Failure to expand the string causes a panic error. If you want to create a
15575 multiline response to the initial SMTP connection, use &"\n"& in the string at
15576 appropriate points, but not at the end. Note that the 220 code is not included
15577 in this string. Exim adds it automatically (several times in the case of a
15578 multiline response).
15579
15580
15581 .option smtp_check_spool_space main boolean true
15582 .cindex "checking disk space"
15583 .cindex "disk space, checking"
15584 .cindex "spool directory" "checking space"
15585 When this option is set, if an incoming SMTP session encounters the SIZE
15586 option on a MAIL command, it checks that there is enough space in the
15587 spool directory's partition to accept a message of that size, while still
15588 leaving free the amount specified by &%check_spool_space%& (even if that value
15589 is zero). If there isn't enough space, a temporary error code is returned.
15590
15591
15592 .option smtp_connect_backlog main integer 20
15593 .cindex "connection backlog"
15594 .cindex "SMTP" "connection backlog"
15595 .cindex "backlog of connections"
15596 This option specifies a maximum number of waiting SMTP connections. Exim passes
15597 this value to the TCP/IP system when it sets up its listener. Once this number
15598 of connections are waiting for the daemon's attention, subsequent connection
15599 attempts are refused at the TCP/IP level. At least, that is what the manuals
15600 say; in some circumstances such connection attempts have been observed to time
15601 out instead. For large systems it is probably a good idea to increase the
15602 value (to 50, say). It also gives some protection against denial-of-service
15603 attacks by SYN flooding.
15604
15605
15606 .option smtp_enforce_sync main boolean true
15607 .cindex "SMTP" "synchronization checking"
15608 .cindex "synchronization checking in SMTP"
15609 The SMTP protocol specification requires the client to wait for a response from
15610 the server at certain points in the dialogue. Without PIPELINING these
15611 synchronization points are after every command; with PIPELINING they are
15612 fewer, but they still exist.
15613
15614 Some spamming sites send out a complete set of SMTP commands without waiting
15615 for any response. Exim protects against this by rejecting a message if the
15616 client has sent further input when it should not have. The error response &"554
15617 SMTP synchronization error"& is sent, and the connection is dropped. Testing
15618 for this error cannot be perfect because of transmission delays (unexpected
15619 input may be on its way but not yet received when Exim checks). However, it
15620 does detect many instances.
15621
15622 The check can be globally disabled by setting &%smtp_enforce_sync%& false.
15623 If you want to disable the check selectively (for example, only for certain
15624 hosts), you can do so by an appropriate use of a &%control%& modifier in an ACL
15625 (see section &<<SECTcontrols>>&). See also &%pipelining_advertise_hosts%&.
15626
15627
15628
15629 .option smtp_etrn_command main string&!! unset
15630 .cindex "ETRN" "command to be run"
15631 .vindex "&$domain$&"
15632 If this option is set, the given command is run whenever an SMTP ETRN
15633 command is received from a host that is permitted to issue such commands (see
15634 chapter &<<CHAPACL>>&). The string is split up into separate arguments which
15635 are independently expanded. The expansion variable &$domain$& is set to the
15636 argument of the ETRN command, and no syntax checking is done on it. For
15637 example:
15638 .code
15639 smtp_etrn_command = /etc/etrn_command $domain \
15640                     $sender_host_address
15641 .endd
15642 A new process is created to run the command, but Exim does not wait for it to
15643 complete. Consequently, its status cannot be checked. If the command cannot be
15644 run, a line is written to the panic log, but the ETRN caller still receives
15645 a 250 success response. Exim is normally running under its own uid when
15646 receiving SMTP, so it is not possible for it to change the uid before running
15647 the command.
15648
15649
15650 .option smtp_etrn_serialize main boolean true
15651 .cindex "ETRN" "serializing"
15652 When this option is set, it prevents the simultaneous execution of more than
15653 one identical command as a result of ETRN in an SMTP connection. See
15654 section &<<SECTETRN>>& for details.
15655
15656
15657 .option smtp_load_reserve main fixed-point unset
15658 .cindex "load average"
15659 If the system load average ever gets higher than this, incoming SMTP calls are
15660 accepted only from those hosts that match an entry in &%smtp_reserve_hosts%&.
15661 If &%smtp_reserve_hosts%& is not set, no incoming SMTP calls are accepted when
15662 the load is over the limit. The option has no effect on ancient operating
15663 systems on which Exim cannot determine the load average. See also
15664 &%deliver_queue_load_max%& and &%queue_only_load%&.
15665
15666
15667
15668 .option smtp_max_synprot_errors main integer 3
15669 .cindex "SMTP" "limiting syntax and protocol errors"
15670 .cindex "limit" "SMTP syntax and protocol errors"
15671 Exim rejects SMTP commands that contain syntax or protocol errors. In
15672 particular, a syntactically invalid email address, as in this command:
15673 .code
15674 RCPT TO:<abc xyz@a.b.c>
15675 .endd
15676 causes immediate rejection of the command, before any other tests are done.
15677 (The ACL cannot be run if there is no valid address to set up for it.) An
15678 example of a protocol error is receiving RCPT before MAIL. If there are
15679 too many syntax or protocol errors in one SMTP session, the connection is
15680 dropped. The limit is set by this option.
15681
15682 .cindex "PIPELINING" "expected errors"
15683 When the PIPELINING extension to SMTP is in use, some protocol errors are
15684 &"expected"&, for instance, a RCPT command after a rejected MAIL command.
15685 Exim assumes that PIPELINING will be used if it advertises it (see
15686 &%pipelining_advertise_hosts%&), and in this situation, &"expected"& errors do
15687 not count towards the limit.
15688
15689
15690
15691 .option smtp_max_unknown_commands main integer 3
15692 .cindex "SMTP" "limiting unknown commands"
15693 .cindex "limit" "unknown SMTP commands"
15694 If there are too many unrecognized commands in an incoming SMTP session, an
15695 Exim server drops the connection. This is a defence against some kinds of abuse
15696 that subvert web
15697 clients
15698 into making connections to SMTP ports; in these circumstances, a number of
15699 non-SMTP command lines are sent first.
15700
15701
15702
15703 .option smtp_ratelimit_hosts main "host list&!!" unset
15704 .cindex "SMTP" "rate limiting"
15705 .cindex "limit" "rate of message arrival"
15706 .cindex "RCPT" "rate limiting"
15707 Some sites find it helpful to be able to limit the rate at which certain hosts
15708 can send them messages, and the rate at which an individual message can specify
15709 recipients.
15710
15711 Exim has two rate-limiting facilities. This section describes the older
15712 facility, which can limit rates within a single connection. The newer
15713 &%ratelimit%& ACL condition can limit rates across all connections. See section
15714 &<<SECTratelimiting>>& for details of the newer facility.
15715
15716 When a host matches &%smtp_ratelimit_hosts%&, the values of
15717 &%smtp_ratelimit_mail%& and &%smtp_ratelimit_rcpt%& are used to control the
15718 rate of acceptance of MAIL and RCPT commands in a single SMTP session,
15719 respectively. Each option, if set, must contain a set of four comma-separated
15720 values:
15721
15722 .ilist
15723 A threshold, before which there is no rate limiting.
15724 .next
15725 An initial time delay. Unlike other times in Exim, numbers with decimal
15726 fractional parts are allowed here.
15727 .next
15728 A factor by which to increase the delay each time.
15729 .next
15730 A maximum value for the delay. This should normally be less than 5 minutes,
15731 because after that time, the client is liable to timeout the SMTP command.
15732 .endlist
15733
15734 For example, these settings have been used successfully at the site which
15735 first suggested this feature, for controlling mail from their customers:
15736 .code
15737 smtp_ratelimit_mail = 2,0.5s,1.05,4m
15738 smtp_ratelimit_rcpt = 4,0.25s,1.015,4m
15739 .endd
15740 The first setting specifies delays that are applied to MAIL commands after
15741 two have been received over a single connection. The initial delay is 0.5
15742 seconds, increasing by a factor of 1.05 each time. The second setting applies
15743 delays to RCPT commands when more than four occur in a single message.
15744
15745
15746 .option smtp_ratelimit_mail main string unset
15747 See &%smtp_ratelimit_hosts%& above.
15748
15749
15750 .option smtp_ratelimit_rcpt main string unset
15751 See &%smtp_ratelimit_hosts%& above.
15752
15753
15754 .option smtp_receive_timeout main time 5m
15755 .cindex "timeout" "for SMTP input"
15756 .cindex "SMTP" "input timeout"
15757 This sets a timeout value for SMTP reception. It applies to all forms of SMTP
15758 input, including batch SMTP. If a line of input (either an SMTP command or a
15759 data line) is not received within this time, the SMTP connection is dropped and
15760 the message is abandoned.
15761 A line is written to the log containing one of the following messages:
15762 .code
15763 SMTP command timeout on connection from...
15764 SMTP data timeout on connection from...
15765 .endd
15766 The former means that Exim was expecting to read an SMTP command; the latter
15767 means that it was in the DATA phase, reading the contents of a message.
15768
15769
15770 .oindex "&%-os%&"
15771 The value set by this option can be overridden by the
15772 &%-os%& command-line option. A setting of zero time disables the timeout, but
15773 this should never be used for SMTP over TCP/IP. (It can be useful in some cases
15774 of local input using &%-bs%& or &%-bS%&.) For non-SMTP input, the reception
15775 timeout is controlled by &%receive_timeout%& and &%-or%&.
15776
15777
15778 .option smtp_reserve_hosts main "host list&!!" unset
15779 This option defines hosts for which SMTP connections are reserved; see
15780 &%smtp_accept_reserve%& and &%smtp_load_reserve%& above.
15781
15782
15783 .option smtp_return_error_details main boolean false
15784 .cindex "SMTP" "details policy failures"
15785 .cindex "policy control" "rejection, returning details"
15786 In the default state, Exim uses bland messages such as
15787 &"Administrative prohibition"& when it rejects SMTP commands for policy
15788 reasons. Many sysadmins like this because it gives away little information
15789 to spammers. However, some other sysadmins who are applying strict checking
15790 policies want to give out much fuller information about failures. Setting
15791 &%smtp_return_error_details%& true causes Exim to be more forthcoming. For
15792 example, instead of &"Administrative prohibition"&, it might give:
15793 .code
15794 550-Rejected after DATA: '>' missing at end of address:
15795 550 failing address in "From" header is: <user@dom.ain
15796 .endd
15797
15798 .option spamd_address main string "see below"
15799 This option is available when Exim is compiled with the content-scanning
15800 extension. It specifies how Exim connects to SpamAssassin's &%spamd%& daemon.
15801 The default value is
15802 .code
15803 127.0.0.1 783
15804 .endd
15805 See section &<<SECTscanspamass>>& for more details.
15806
15807
15808
15809 .option split_spool_directory main boolean false
15810 .cindex "multiple spool directories"
15811 .cindex "spool directory" "split"
15812 .cindex "directories, multiple"
15813 If this option is set, it causes Exim to split its input directory into 62
15814 subdirectories, each with a single alphanumeric character as its name. The
15815 sixth character of the message id is used to allocate messages to
15816 subdirectories; this is the least significant base-62 digit of the time of
15817 arrival of the message.
15818
15819 Splitting up the spool in this way may provide better performance on systems
15820 where there are long mail queues, by reducing the number of files in any one
15821 directory. The msglog directory is also split up in a similar way to the input
15822 directory; however, if &%preserve_message_logs%& is set, all old msglog files
15823 are still placed in the single directory &_msglog.OLD_&.
15824
15825 It is not necessary to take any special action for existing messages when
15826 changing &%split_spool_directory%&. Exim notices messages that are in the
15827 &"wrong"& place, and continues to process them. If the option is turned off
15828 after a period of being on, the subdirectories will eventually empty and be
15829 automatically deleted.
15830
15831 When &%split_spool_directory%& is set, the behaviour of queue runner processes
15832 changes. Instead of creating a list of all messages in the queue, and then
15833 trying to deliver each one in turn, it constructs a list of those in one
15834 sub-directory and tries to deliver them, before moving on to the next
15835 sub-directory. The sub-directories are processed in a random order. This
15836 spreads out the scanning of the input directories, and uses less memory. It is
15837 particularly beneficial when there are lots of messages on the queue. However,
15838 if &%queue_run_in_order%& is set, none of this new processing happens. The
15839 entire queue has to be scanned and sorted before any deliveries can start.
15840
15841
15842 .option spool_directory main string&!! "set at compile time"
15843 .cindex "spool directory" "path to"
15844 This defines the directory in which Exim keeps its spool, that is, the messages
15845 it is waiting to deliver. The default value is taken from the compile-time
15846 configuration setting, if there is one. If not, this option must be set. The
15847 string is expanded, so it can contain, for example, a reference to
15848 &$primary_hostname$&.
15849
15850 If the spool directory name is fixed on your installation, it is recommended
15851 that you set it at build time rather than from this option, particularly if the
15852 log files are being written to the spool directory (see &%log_file_path%&).
15853 Otherwise log files cannot be used for errors that are detected early on, such
15854 as failures in the configuration file.
15855
15856 By using this option to override the compiled-in path, it is possible to run
15857 tests of Exim without using the standard spool.
15858
15859 .option sqlite_lock_timeout main time 5s
15860 .cindex "sqlite lookup type" "lock timeout"
15861 This option controls the timeout that the &(sqlite)& lookup uses when trying to
15862 access an SQLite database. See section &<<SECTsqlite>>& for more details.
15863
15864 .option strict_acl_vars main boolean false
15865 .cindex "&ACL;" "variables, handling unset"
15866 This option controls what happens if a syntactically valid but undefined ACL
15867 variable is referenced. If it is false (the default), an empty string
15868 is substituted; if it is true, an error is generated. See section
15869 &<<SECTaclvariables>>& for details of ACL variables.
15870
15871 .option strip_excess_angle_brackets main boolean false
15872 .cindex "angle brackets, excess"
15873 If this option is set, redundant pairs of angle brackets round &"route-addr"&
15874 items in addresses are stripped. For example, &'<<xxx@a.b.c.d>>'& is
15875 treated as &'<xxx@a.b.c.d>'&. If this is in the envelope and the message is
15876 passed on to another MTA, the excess angle brackets are not passed on. If this
15877 option is not set, multiple pairs of angle brackets cause a syntax error.
15878
15879
15880 .option strip_trailing_dot main boolean false
15881 .cindex "trailing dot on domain"
15882 .cindex "dot" "trailing on domain"
15883 If this option is set, a trailing dot at the end of a domain in an address is
15884 ignored. If this is in the envelope and the message is passed on to another
15885 MTA, the dot is not passed on. If this option is not set, a dot at the end of a
15886 domain causes a syntax error.
15887 However, addresses in header lines are checked only when an ACL requests header
15888 syntax checking.
15889
15890
15891 .option syslog_duplication main boolean true
15892 .cindex "syslog" "duplicate log lines; suppressing"
15893 When Exim is logging to syslog, it writes the log lines for its three
15894 separate logs at different syslog priorities so that they can in principle
15895 be separated on the logging hosts. Some installations do not require this
15896 separation, and in those cases, the duplication of certain log lines is a
15897 nuisance. If &%syslog_duplication%& is set false, only one copy of any
15898 particular log line is written to syslog. For lines that normally go to
15899 both the main log and the reject log, the reject log version (possibly
15900 containing message header lines) is written, at LOG_NOTICE priority.
15901 Lines that normally go to both the main and the panic log are written at
15902 the LOG_ALERT priority.
15903
15904
15905 .option syslog_facility main string unset
15906 .cindex "syslog" "facility; setting"
15907 This option sets the syslog &"facility"& name, used when Exim is logging to
15908 syslog. The value must be one of the strings &"mail"&, &"user"&, &"news"&,
15909 &"uucp"&, &"daemon"&, or &"local&'x'&"& where &'x'& is a digit between 0 and 7.
15910 If this option is unset, &"mail"& is used. See chapter &<<CHAPlog>>& for
15911 details of Exim's logging.
15912
15913
15914
15915 .option syslog_processname main string &`exim`&
15916 .cindex "syslog" "process name; setting"
15917 This option sets the syslog &"ident"& name, used when Exim is logging to
15918 syslog. The value must be no longer than 32 characters. See chapter
15919 &<<CHAPlog>>& for details of Exim's logging.
15920
15921
15922
15923 .option syslog_timestamp main boolean true
15924 .cindex "syslog" "timestamps"
15925 If &%syslog_timestamp%& is set false, the timestamps on Exim's log lines are
15926 omitted when these lines are sent to syslog. See chapter &<<CHAPlog>>& for
15927 details of Exim's logging.
15928
15929
15930 .option system_filter main string&!! unset
15931 .cindex "filter" "system filter"
15932 .cindex "system filter" "specifying"
15933 .cindex "Sieve filter" "not available for system filter"
15934 This option specifies an Exim filter file that is applied to all messages at
15935 the start of each delivery attempt, before any routing is done. System filters
15936 must be Exim filters; they cannot be Sieve filters. If the system filter
15937 generates any deliveries to files or pipes, or any new mail messages, the
15938 appropriate &%system_filter_..._transport%& option(s) must be set, to define
15939 which transports are to be used. Details of this facility are given in chapter
15940 &<<CHAPsystemfilter>>&.
15941
15942
15943 .option system_filter_directory_transport main string&!! unset
15944 .vindex "&$address_file$&"
15945 This sets the name of the transport driver that is to be used when the
15946 &%save%& command in a system message filter specifies a path ending in &"/"&,
15947 implying delivery of each message into a separate file in some directory.
15948 During the delivery, the variable &$address_file$& contains the path name.
15949
15950
15951 .option system_filter_file_transport main string&!! unset
15952 .cindex "file" "transport for system filter"
15953 This sets the name of the transport driver that is to be used when the &%save%&
15954 command in a system message filter specifies a path not ending in &"/"&. During
15955 the delivery, the variable &$address_file$& contains the path name.
15956
15957 .option system_filter_group main string unset
15958 .cindex "gid (group id)" "system filter"
15959 This option is used only when &%system_filter_user%& is also set. It sets the
15960 gid under which the system filter is run, overriding any gid that is associated
15961 with the user. The value may be numerical or symbolic.
15962
15963 .option system_filter_pipe_transport main string&!! unset
15964 .cindex "&(pipe)& transport" "for system filter"
15965 .vindex "&$address_pipe$&"
15966 This specifies the transport driver that is to be used when a &%pipe%& command
15967 is used in a system filter. During the delivery, the variable &$address_pipe$&
15968 contains the pipe command.
15969
15970
15971 .option system_filter_reply_transport main string&!! unset
15972 .cindex "&(autoreply)& transport" "for system filter"
15973 This specifies the transport driver that is to be used when a &%mail%& command
15974 is used in a system filter.
15975
15976
15977 .option system_filter_user main string unset
15978 .cindex "uid (user id)" "system filter"
15979 If this option is set to root, the system filter is run in the main Exim
15980 delivery process, as root.  Otherwise, the system filter runs in a separate
15981 process, as the given user, defaulting to the Exim run-time user.
15982 Unless the string consists entirely of digits, it
15983 is looked up in the password data. Failure to find the named user causes a
15984 configuration error. The gid is either taken from the password data, or
15985 specified by &%system_filter_group%&. When the uid is specified numerically,
15986 &%system_filter_group%& is required to be set.
15987
15988 If the system filter generates any pipe, file, or reply deliveries, the uid
15989 under which the filter is run is used when transporting them, unless a
15990 transport option overrides.
15991
15992
15993 .option tcp_nodelay main boolean true
15994 .cindex "daemon" "TCP_NODELAY on sockets"
15995 .cindex "Nagle algorithm"
15996 .cindex "TCP_NODELAY on listening sockets"
15997 If this option is set false, it stops the Exim daemon setting the
15998 TCP_NODELAY option on its listening sockets. Setting TCP_NODELAY
15999 turns off the &"Nagle algorithm"&, which is a way of improving network
16000 performance in interactive (character-by-character) situations. Turning it off
16001 should improve Exim's performance a bit, so that is what happens by default.
16002 However, it appears that some broken clients cannot cope, and time out. Hence
16003 this option. It affects only those sockets that are set up for listening by the
16004 daemon. Sockets created by the smtp transport for delivering mail always set
16005 TCP_NODELAY.
16006
16007
16008 .option timeout_frozen_after main time 0s
16009 .cindex "frozen messages" "timing out"
16010 .cindex "timeout" "frozen messages"
16011 If &%timeout_frozen_after%& is set to a time greater than zero, a frozen
16012 message of any kind that has been on the queue for longer than the given time
16013 is automatically cancelled at the next queue run. If the frozen message is a
16014 bounce message, it is just discarded; otherwise, a bounce is sent to the
16015 sender, in a similar manner to cancellation by the &%-Mg%& command line option.
16016 If you want to timeout frozen bounce messages earlier than other kinds of
16017 frozen message, see &%ignore_bounce_errors_after%&.
16018
16019 &*Note:*& the default value of zero means no timeouts; with this setting,
16020 frozen messages remain on the queue forever (except for any frozen bounce
16021 messages that are released by &%ignore_bounce_errors_after%&).
16022
16023
16024 .option timezone main string unset
16025 .cindex "timezone, setting"
16026 The value of &%timezone%& is used to set the environment variable TZ while
16027 running Exim (if it is different on entry). This ensures that all timestamps
16028 created by Exim are in the required timezone. If you want all your timestamps
16029 to be in UTC (aka GMT) you should set
16030 .code
16031 timezone = UTC
16032 .endd
16033 The default value is taken from TIMEZONE_DEFAULT in &_Local/Makefile_&,
16034 or, if that is not set, from the value of the TZ environment variable when Exim
16035 is built. If &%timezone%& is set to the empty string, either at build or run
16036 time, any existing TZ variable is removed from the environment when Exim
16037 runs. This is appropriate behaviour for obtaining wall-clock time on some, but
16038 unfortunately not all, operating systems.
16039
16040
16041 .option tls_advertise_hosts main "host list&!!" unset
16042 .cindex "TLS" "advertising"
16043 .cindex "encryption" "on SMTP connection"
16044 .cindex "SMTP" "encrypted connection"
16045 When Exim is built with support for TLS encrypted connections, the availability
16046 of the STARTTLS command to set up an encrypted session is advertised in
16047 response to EHLO only to those client hosts that match this option. See
16048 chapter &<<CHAPTLS>>& for details of Exim's support for TLS.
16049
16050
16051 .option tls_certificate main string&!! unset
16052 .cindex "TLS" "server certificate; location of"
16053 .cindex "certificate" "server, location of"
16054 The value of this option is expanded, and must then be the absolute path to a
16055 file which contains the server's certificates. The server's private key is also
16056 assumed to be in this file if &%tls_privatekey%& is unset. See chapter
16057 &<<CHAPTLS>>& for further details.
16058
16059 &*Note*&: The certificates defined by this option are used only when Exim is
16060 receiving incoming messages as a server. If you want to supply certificates for
16061 use when sending messages as a client, you must set the &%tls_certificate%&
16062 option in the relevant &(smtp)& transport.
16063
16064 If the option contains &$tls_out_sni$& and Exim is built against OpenSSL, then
16065 if the OpenSSL build supports TLS extensions and the TLS client sends the
16066 Server Name Indication extension, then this option and others documented in
16067 &<<SECTtlssni>>& will be re-expanded.
16068
16069 .option tls_crl main string&!! unset
16070 .cindex "TLS" "server certificate revocation list"
16071 .cindex "certificate" "revocation list for server"
16072 This option specifies a certificate revocation list. The expanded value must
16073 be the name of a file that contains a CRL in PEM format.
16074
16075 See &<<SECTtlssni>>& for discussion of when this option might be re-expanded.
16076
16077
16078 .option tls_dh_max_bits main integer 2236
16079 .cindex "TLS" "D-H bit count"
16080 The number of bits used for Diffie-Hellman key-exchange may be suggested by
16081 the chosen TLS library.  That value might prove to be too high for
16082 interoperability.  This option provides a maximum clamp on the value
16083 suggested, trading off security for interoperability.
16084
16085 The value must be at least 1024.
16086
16087 The value 2236 was chosen because, at time of adding the option, it was the
16088 hard-coded maximum value supported by the NSS cryptographic library, as used
16089 by Thunderbird, while GnuTLS was suggesting 2432 bits as normal.
16090
16091 If you prefer more security and are willing to break some clients, raise this
16092 number.
16093
16094 Note that the value passed to GnuTLS for *generating* a new prime may be a
16095 little less than this figure, because GnuTLS is inexact and may produce a
16096 larger prime than requested.
16097
16098
16099 .option tls_dhparam main string&!! unset
16100 .cindex "TLS" "D-H parameters for server"
16101 The value of this option is expanded and indicates the source of DH parameters
16102 to be used by Exim.
16103
16104 If it is a filename starting with a &`/`&, then it names a file from which DH
16105 parameters should be loaded.  If the file exists, it should hold a PEM-encoded
16106 PKCS#3 representation of the DH prime.  If the file does not exist, for
16107 OpenSSL it is an error.  For GnuTLS, Exim will attempt to create the file and
16108 fill it with a generated DH prime.  For OpenSSL, if the DH bit-count from
16109 loading the file is greater than &%tls_dh_max_bits%& then it will be ignored,
16110 and treated as though the &%tls_dhparam%& were set to "none".
16111
16112 If this option expands to the string "none", then no DH parameters will be
16113 loaded by Exim.
16114
16115 If this option expands to the string "historic" and Exim is using GnuTLS, then
16116 Exim will attempt to load a file from inside the spool directory.  If the file
16117 does not exist, Exim will attempt to create it.
16118 See section &<<SECTgnutlsparam>>& for further details.
16119
16120 If Exim is using OpenSSL and this option is empty or unset, then Exim will load
16121 a default DH prime; the default is the 2048 bit prime described in section
16122 2.2 of RFC 5114, "2048-bit MODP Group with 224-bit Prime Order Subgroup", which
16123 in IKE is assigned number 23.
16124
16125 Otherwise, the option must expand to the name used by Exim for any of a number
16126 of DH primes specified in RFC 2409, RFC 3526 and RFC 5114.  As names, Exim uses
16127 "ike" followed by the number used by IKE, of "default" which corresponds to
16128 "ike23".
16129
16130 The available primes are:
16131 &`ike1`&, &`ike2`&, &`ike5`&,
16132 &`ike14`&, &`ike15`&, &`ike16`&, &`ike17`&, &`ike18`&,
16133 &`ike22`&, &`ike23`& (aka &`default`&) and &`ike24`&.
16134
16135 Some of these will be too small to be accepted by clients.
16136 Some may be too large to be accepted by clients.
16137
16138 .new
16139 The TLS protocol does not negotiate an acceptable size for this; clients tend
16140 to hard-drop connections if what is offered by the server is unacceptable,
16141 whether too large or too small, and there's no provision for the client to
16142 tell the server what these constraints are.  Thus, as a server operator, you
16143 need to make an educated guess as to what is most likely to work for your
16144 userbase.
16145
16146 Some known size constraints suggest that a bit-size in the range 2048 to 2236
16147 is most likely to maximise interoperability.  The upper bound comes from
16148 applications using the Mozilla Network Security Services (NSS) library, which
16149 used to set its &`DH_MAX_P_BITS`& upper-bound to 2236.  This affects many
16150 mail user agents (MUAs). The lower bound comes from Debian installs of Exim4
16151 prior to the 4.80 release, as Debian used to patch Exim to raise the minimum
16152 acceptable bound from 1024 to 2048.
16153 .wen
16154
16155
16156 .option tls_on_connect_ports main "string list" unset
16157 This option specifies a list of incoming SSMTP (aka SMTPS) ports that should
16158 operate the obsolete SSMTP (SMTPS) protocol, where a TLS session is immediately
16159 set up without waiting for the client to issue a STARTTLS command. For
16160 further details, see section &<<SECTsupobssmt>>&.
16161
16162
16163
16164 .option tls_privatekey main string&!! unset
16165 .cindex "TLS" "server private key; location of"
16166 The value of this option is expanded, and must then be the absolute path to a
16167 file which contains the server's private key. If this option is unset, or if
16168 the expansion is forced to fail, or the result is an empty string, the private
16169 key is assumed to be in the same file as the server's certificates. See chapter
16170 &<<CHAPTLS>>& for further details.
16171
16172 See &<<SECTtlssni>>& for discussion of when this option might be re-expanded.
16173
16174
16175 .option tls_remember_esmtp main boolean false
16176 .cindex "TLS" "esmtp state; remembering"
16177 .cindex "TLS" "broken clients"
16178 If this option is set true, Exim violates the RFCs by remembering that it is in
16179 &"esmtp"& state after successfully negotiating a TLS session. This provides
16180 support for broken clients that fail to send a new EHLO after starting a
16181 TLS session.
16182
16183
16184 .option tls_require_ciphers main string&!! unset
16185 .cindex "TLS" "requiring specific ciphers"
16186 .cindex "cipher" "requiring specific"
16187 This option controls which ciphers can be used for incoming TLS connections.
16188 The &(smtp)& transport has an option of the same name for controlling outgoing
16189 connections. This option is expanded for each connection, so can be varied for
16190 different clients if required. The value of this option must be a list of
16191 permitted cipher suites. The OpenSSL and GnuTLS libraries handle cipher control
16192 in somewhat different ways. If GnuTLS is being used, the client controls the
16193 preference order of the available ciphers. Details are given in sections
16194 &<<SECTreqciphssl>>& and &<<SECTreqciphgnu>>&.
16195
16196
16197 .option tls_try_verify_hosts main "host list&!!" unset
16198 .cindex "TLS" "client certificate verification"
16199 .cindex "certificate" "verification of client"
16200 See &%tls_verify_hosts%& below.
16201
16202
16203 .option tls_verify_certificates main string&!! unset
16204 .cindex "TLS" "client certificate verification"
16205 .cindex "certificate" "verification of client"
16206 The value of this option is expanded, and must then be the absolute path to
16207 a file containing permitted certificates for clients that
16208 match &%tls_verify_hosts%& or &%tls_try_verify_hosts%&. Alternatively, if you
16209 are using OpenSSL, you can set &%tls_verify_certificates%& to the name of a
16210 directory containing certificate files. This does not work with GnuTLS; the
16211 option must be set to the name of a single file if you are using GnuTLS.
16212
16213 These certificates should be for the certificate authorities trusted, rather
16214 than the public cert of individual clients.  With both OpenSSL and GnuTLS, if
16215 the value is a file then the certificates are sent by Exim as a server to
16216 connecting clients, defining the list of accepted certificate authorities.
16217 Thus the values defined should be considered public data.  To avoid this,
16218 use OpenSSL with a directory.
16219
16220 See &<<SECTtlssni>>& for discussion of when this option might be re-expanded.
16221
16222 .new
16223 A forced expansion failure or setting to an empty string is equivalent to
16224 being unset.
16225 .wen
16226
16227
16228 .option tls_verify_hosts main "host list&!!" unset
16229 .cindex "TLS" "client certificate verification"
16230 .cindex "certificate" "verification of client"
16231 This option, along with &%tls_try_verify_hosts%&, controls the checking of
16232 certificates from clients. The expected certificates are defined by
16233 &%tls_verify_certificates%&, which must be set. A configuration error occurs if
16234 either &%tls_verify_hosts%& or &%tls_try_verify_hosts%& is set and
16235 &%tls_verify_certificates%& is not set.
16236
16237 Any client that matches &%tls_verify_hosts%& is constrained by
16238 &%tls_verify_certificates%&. When the client initiates a TLS session, it must
16239 present one of the listed certificates. If it does not, the connection is
16240 aborted. &*Warning*&: Including a host in &%tls_verify_hosts%& does not require
16241 the host to use TLS. It can still send SMTP commands through unencrypted
16242 connections. Forcing a client to use TLS has to be done separately using an
16243 ACL to reject inappropriate commands when the connection is not encrypted.
16244
16245 A weaker form of checking is provided by &%tls_try_verify_hosts%&. If a client
16246 matches this option (but not &%tls_verify_hosts%&), Exim requests a
16247 certificate and checks it against &%tls_verify_certificates%&, but does not
16248 abort the connection if there is no certificate or if it does not match. This
16249 state can be detected in an ACL, which makes it possible to implement policies
16250 such as &"accept for relay only if a verified certificate has been received,
16251 but accept for local delivery if encrypted, even without a verified
16252 certificate"&.
16253
16254 Client hosts that match neither of these lists are not asked to present
16255 certificates.
16256
16257
16258 .option trusted_groups main "string list&!!" unset
16259 .cindex "trusted groups"
16260 .cindex "groups" "trusted"
16261 This option is expanded just once, at the start of Exim's processing. If this
16262 option is set, any process that is running in one of the listed groups, or
16263 which has one of them as a supplementary group, is trusted. The groups can be
16264 specified numerically or by name. See section &<<SECTtrustedadmin>>& for
16265 details of what trusted callers are permitted to do. If neither
16266 &%trusted_groups%& nor &%trusted_users%& is set, only root and the Exim user
16267 are trusted.
16268
16269 .option trusted_users main "string list&!!" unset
16270 .cindex "trusted users"
16271 .cindex "user" "trusted"
16272 This option is expanded just once, at the start of Exim's processing. If this
16273 option is set, any process that is running as one of the listed users is
16274 trusted. The users can be specified numerically or by name. See section
16275 &<<SECTtrustedadmin>>& for details of what trusted callers are permitted to do.
16276 If neither &%trusted_groups%& nor &%trusted_users%& is set, only root and the
16277 Exim user are trusted.
16278
16279 .option unknown_login main string&!! unset
16280 .cindex "uid (user id)" "unknown caller"
16281 .vindex "&$caller_uid$&"
16282 This is a specialized feature for use in unusual configurations. By default, if
16283 the uid of the caller of Exim cannot be looked up using &[getpwuid()]&, Exim
16284 gives up. The &%unknown_login%& option can be used to set a login name to be
16285 used in this circumstance. It is expanded, so values like &%user$caller_uid%&
16286 can be set. When &%unknown_login%& is used, the value of &%unknown_username%&
16287 is used for the user's real name (gecos field), unless this has been set by the
16288 &%-F%& option.
16289
16290 .option unknown_username main string unset
16291 See &%unknown_login%&.
16292
16293 .option untrusted_set_sender main "address list&!!" unset
16294 .cindex "trusted users"
16295 .cindex "sender" "setting by untrusted user"
16296 .cindex "untrusted user setting sender"
16297 .cindex "user" "untrusted setting sender"
16298 .cindex "envelope sender"
16299 When an untrusted user submits a message to Exim using the standard input, Exim
16300 normally creates an envelope sender address from the user's login and the
16301 default qualification domain. Data from the &%-f%& option (for setting envelope
16302 senders on non-SMTP messages) or the SMTP MAIL command (if &%-bs%& or &%-bS%&
16303 is used) is ignored.
16304
16305 However, untrusted users are permitted to set an empty envelope sender address,
16306 to declare that a message should never generate any bounces. For example:
16307 .code
16308 exim -f '<>' user@domain.example
16309 .endd
16310 .vindex "&$sender_ident$&"
16311 The &%untrusted_set_sender%& option allows you to permit untrusted users to set
16312 other envelope sender addresses in a controlled way. When it is set, untrusted
16313 users are allowed to set envelope sender addresses that match any of the
16314 patterns in the list. Like all address lists, the string is expanded. The
16315 identity of the user is in &$sender_ident$&, so you can, for example, restrict
16316 users to setting senders that start with their login ids
16317 followed by a hyphen
16318 by a setting like this:
16319 .code
16320 untrusted_set_sender = ^$sender_ident-
16321 .endd
16322 If you want to allow untrusted users to set envelope sender addresses without
16323 restriction, you can use
16324 .code
16325 untrusted_set_sender = *
16326 .endd
16327 The &%untrusted_set_sender%& option applies to all forms of local input, but
16328 only to the setting of the envelope sender. It does not permit untrusted users
16329 to use the other options which trusted user can use to override message
16330 parameters. Furthermore, it does not stop Exim from removing an existing
16331 &'Sender:'& header in the message, or from adding a &'Sender:'& header if
16332 necessary. See &%local_sender_retain%& and &%local_from_check%& for ways of
16333 overriding these actions. The handling of the &'Sender:'& header is also
16334 described in section &<<SECTthesenhea>>&.
16335
16336 The log line for a message's arrival shows the envelope sender following
16337 &"<="&. For local messages, the user's login always follows, after &"U="&. In
16338 &%-bp%& displays, and in the Exim monitor, if an untrusted user sets an
16339 envelope sender address, the user's login is shown in parentheses after the
16340 sender address.
16341
16342
16343 .option uucp_from_pattern main string "see below"
16344 .cindex "&""From""& line"
16345 .cindex "UUCP" "&""From""& line"
16346 Some applications that pass messages to an MTA via a command line interface use
16347 an initial line starting with &"From&~"& to pass the envelope sender. In
16348 particular, this is used by UUCP software. Exim recognizes such a line by means
16349 of a regular expression that is set in &%uucp_from_pattern%&. When the pattern
16350 matches, the sender address is constructed by expanding the contents of
16351 &%uucp_from_sender%&, provided that the caller of Exim is a trusted user. The
16352 default pattern recognizes lines in the following two forms:
16353 .code
16354 From ph10 Fri Jan  5 12:35 GMT 1996
16355 From ph10 Fri, 7 Jan 97 14:00:00 GMT
16356 .endd
16357 The pattern can be seen by running
16358 .code
16359 exim -bP uucp_from_pattern
16360 .endd
16361 It checks only up to the hours and minutes, and allows for a 2-digit or 4-digit
16362 year in the second case. The first word after &"From&~"& is matched in the
16363 regular expression by a parenthesized subpattern. The default value for
16364 &%uucp_from_sender%& is &"$1"&, which therefore just uses this first word
16365 (&"ph10"& in the example above) as the message's sender. See also
16366 &%ignore_fromline_hosts%&.
16367
16368
16369 .option uucp_from_sender main string&!! &`$1`&
16370 See &%uucp_from_pattern%& above.
16371
16372
16373 .option warn_message_file main string unset
16374 .cindex "warning of delay" "customizing the message"
16375 .cindex "customizing" "warning message"
16376 This option defines a template file containing paragraphs of text to be used
16377 for constructing the warning message which is sent by Exim when a message has
16378 been on the queue for a specified amount of time, as specified by
16379 &%delay_warning%&. Details of the file's contents are given in chapter
16380 &<<CHAPemsgcust>>&. See also &%bounce_message_file%&.
16381
16382
16383 .option write_rejectlog main boolean true
16384 .cindex "reject log" "disabling"
16385 If this option is set false, Exim no longer writes anything to the reject log.
16386 See chapter &<<CHAPlog>>& for details of what Exim writes to its logs.
16387 .ecindex IIDconfima
16388 .ecindex IIDmaiconf
16389
16390
16391
16392
16393 . ////////////////////////////////////////////////////////////////////////////
16394 . ////////////////////////////////////////////////////////////////////////////
16395
16396 .chapter "Generic options for routers" "CHAProutergeneric"
16397 .scindex IIDgenoprou1 "options" "generic; for routers"
16398 .scindex IIDgenoprou2 "generic options" "router"
16399 This chapter describes the generic options that apply to all routers.
16400 Those that are preconditions are marked with &Dagger; in the &"use"& field.
16401
16402 For a general description of how a router operates, see sections
16403 &<<SECTrunindrou>>& and &<<SECTrouprecon>>&. The latter specifies the order in
16404 which the preconditions are tested. The order of expansion of the options that
16405 provide data for a transport is: &%errors_to%&, &%headers_add%&,
16406 &%headers_remove%&, &%transport%&.
16407
16408
16409
16410 .option address_data routers string&!! unset
16411 .cindex "router" "data attached to address"
16412 The string is expanded just before the router is run, that is, after all the
16413 precondition tests have succeeded. If the expansion is forced to fail, the
16414 router declines, the value of &%address_data%& remains unchanged, and the
16415 &%more%& option controls what happens next. Other expansion failures cause
16416 delivery of the address to be deferred.
16417
16418 .vindex "&$address_data$&"
16419 When the expansion succeeds, the value is retained with the address, and can be
16420 accessed using the variable &$address_data$& in the current router, subsequent
16421 routers, and the eventual transport.
16422
16423 &*Warning*&: If the current or any subsequent router is a &(redirect)& router
16424 that runs a user's filter file, the contents of &$address_data$& are accessible
16425 in the filter. This is not normally a problem, because such data is usually
16426 either not confidential or it &"belongs"& to the current user, but if you do
16427 put confidential data into &$address_data$& you need to remember this point.
16428
16429 Even if the router declines or passes, the value of &$address_data$& remains
16430 with the address, though it can be changed by another &%address_data%& setting
16431 on a subsequent router. If a router generates child addresses, the value of
16432 &$address_data$& propagates to them. This also applies to the special kind of
16433 &"child"& that is generated by a router with the &%unseen%& option.
16434
16435 The idea of &%address_data%& is that you can use it to look up a lot of data
16436 for the address once, and then pick out parts of the data later. For example,
16437 you could use a single LDAP lookup to return a string of the form
16438 .code
16439 uid=1234 gid=5678 mailbox=/mail/xyz forward=/home/xyz/.forward
16440 .endd
16441 In the transport you could pick out the mailbox by a setting such as
16442 .code
16443 file = ${extract{mailbox}{$address_data}}
16444 .endd
16445 This makes the configuration file less messy, and also reduces the number of
16446 lookups (though Exim does cache lookups).
16447
16448 .vindex "&$sender_address_data$&"
16449 .vindex "&$address_data$&"
16450 The &%address_data%& facility is also useful as a means of passing information
16451 from one router to another, and from a router to a transport. In addition, if
16452 &$address_data$& is set by a router when verifying a recipient address from an
16453 ACL, it remains available for use in the rest of the ACL statement. After
16454 verifying a sender, the value is transferred to &$sender_address_data$&.
16455
16456
16457
16458 .option address_test routers&!? boolean true
16459 .oindex "&%-bt%&"
16460 .cindex "router" "skipping when address testing"
16461 If this option is set false, the router is skipped when routing is being tested
16462 by means of the &%-bt%& command line option. This can be a convenience when
16463 your first router sends messages to an external scanner, because it saves you
16464 having to set the &"already scanned"& indicator when testing real address
16465 routing.
16466
16467
16468
16469 .option cannot_route_message routers string&!! unset
16470 .cindex "router" "customizing &""cannot route""& message"
16471 .cindex "customizing" "&""cannot route""& message"
16472 This option specifies a text message that is used when an address cannot be
16473 routed because Exim has run out of routers. The default message is
16474 &"Unrouteable address"&. This option is useful only on routers that have
16475 &%more%& set false, or on the very last router in a configuration, because the
16476 value that is used is taken from the last router that is considered. This
16477 includes a router that is skipped because its preconditions are not met, as
16478 well as a router that declines. For example, using the default configuration,
16479 you could put:
16480 .code
16481 cannot_route_message = Remote domain not found in DNS
16482 .endd
16483 on the first router, which is a &(dnslookup)& router with &%more%& set false,
16484 and
16485 .code
16486 cannot_route_message = Unknown local user
16487 .endd
16488 on the final router that checks for local users. If string expansion fails for
16489 this option, the default message is used. Unless the expansion failure was
16490 explicitly forced, a message about the failure is written to the main and panic
16491 logs, in addition to the normal message about the routing failure.
16492
16493
16494 .option caseful_local_part routers boolean false
16495 .cindex "case of local parts"
16496 .cindex "router" "case of local parts"
16497 By default, routers handle the local parts of addresses in a case-insensitive
16498 manner, though the actual case is preserved for transmission with the message.
16499 If you want the case of letters to be significant in a router, you must set
16500 this option true. For individual router options that contain address or local
16501 part lists (for example, &%local_parts%&), case-sensitive matching can be
16502 turned on by &"+caseful"& as a list item. See section &<<SECTcasletadd>>& for
16503 more details.
16504
16505 .vindex "&$local_part$&"
16506 .vindex "&$original_local_part$&"
16507 .vindex "&$parent_local_part$&"
16508 The value of the &$local_part$& variable is forced to lower case while a
16509 router is running unless &%caseful_local_part%& is set. When a router assigns
16510 an address to a transport, the value of &$local_part$& when the transport runs
16511 is the same as it was in the router. Similarly, when a router generates child
16512 addresses by aliasing or forwarding, the values of &$original_local_part$&
16513 and &$parent_local_part$& are those that were used by the redirecting router.
16514
16515 This option applies to the processing of an address by a router. When a
16516 recipient address is being processed in an ACL, there is a separate &%control%&
16517 modifier that can be used to specify case-sensitive processing within the ACL
16518 (see section &<<SECTcontrols>>&).
16519
16520
16521
16522 .option check_local_user routers&!? boolean false
16523 .cindex "local user, checking in router"
16524 .cindex "router" "checking for local user"
16525 .cindex "&_/etc/passwd_&"
16526 .vindex "&$home$&"
16527 When this option is true, Exim checks that the local part of the recipient
16528 address (with affixes removed if relevant) is the name of an account on the
16529 local system. The check is done by calling the &[getpwnam()]& function rather
16530 than trying to read &_/etc/passwd_& directly. This means that other methods of
16531 holding password data (such as NIS) are supported. If the local part is a local
16532 user, &$home$& is set from the password data, and can be tested in other
16533 preconditions that are evaluated after this one (the order of evaluation is
16534 given in section &<<SECTrouprecon>>&). However, the value of &$home$& can be
16535 overridden by &%router_home_directory%&. If the local part is not a local user,
16536 the router is skipped.
16537
16538 If you want to check that the local part is either the name of a local user
16539 or matches something else, you cannot combine &%check_local_user%& with a
16540 setting of &%local_parts%&, because that specifies the logical &'and'& of the
16541 two conditions. However, you can use a &(passwd)& lookup in a &%local_parts%&
16542 setting to achieve this. For example:
16543 .code
16544 local_parts = passwd;$local_part : lsearch;/etc/other/users
16545 .endd
16546 Note, however, that the side effects of &%check_local_user%& (such as setting
16547 up a home directory) do not occur when a &(passwd)& lookup is used in a
16548 &%local_parts%& (or any other) precondition.
16549
16550
16551
16552 .option condition routers&!? string&!! unset
16553 .cindex "router" "customized precondition"
16554 This option specifies a general precondition test that has to succeed for the
16555 router to be called. The &%condition%& option is the last precondition to be
16556 evaluated (see section &<<SECTrouprecon>>&). The string is expanded, and if the
16557 result is a forced failure, or an empty string, or one of the strings &"0"& or
16558 &"no"& or &"false"& (checked without regard to the case of the letters), the
16559 router is skipped, and the address is offered to the next one.
16560
16561 If the result is any other value, the router is run (as this is the last
16562 precondition to be evaluated, all the other preconditions must be true).
16563
16564 This option is unusual in that multiple &%condition%& options may be present.
16565 All &%condition%& options must succeed.
16566
16567 The &%condition%& option provides a means of applying custom conditions to the
16568 running of routers. Note that in the case of a simple conditional expansion,
16569 the default expansion values are exactly what is wanted. For example:
16570 .code
16571 condition = ${if >{$message_age}{600}}
16572 .endd
16573 Because of the default behaviour of the string expansion, this is equivalent to
16574 .code
16575 condition = ${if >{$message_age}{600}{true}{}}
16576 .endd
16577
16578 A multiple condition example, which succeeds:
16579 .code
16580 condition = ${if >{$message_age}{600}}
16581 condition = ${if !eq{${lc:$local_part}}{postmaster}}
16582 condition = foobar
16583 .endd
16584
16585 If the expansion fails (other than forced failure) delivery is deferred. Some
16586 of the other precondition options are common special cases that could in fact
16587 be specified using &%condition%&.
16588
16589
16590 .option debug_print routers string&!! unset
16591 .cindex "testing" "variables in drivers"
16592 If this option is set and debugging is enabled (see the &%-d%& command line
16593 option) or in address-testing mode (see the &%-bt%& command line option),
16594 the string is expanded and included in the debugging output.
16595 If expansion of the string fails, the error message is written to the debugging
16596 output, and Exim carries on processing.
16597 This option is provided to help with checking out the values of variables and
16598 so on when debugging router configurations. For example, if a &%condition%&
16599 option appears not to be working, &%debug_print%& can be used to output the
16600 variables it references. The output happens after checks for &%domains%&,
16601 &%local_parts%&, and &%check_local_user%& but before any other preconditions
16602 are tested. A newline is added to the text if it does not end with one.
16603 The variable &$router_name$& contains the name of the router.
16604
16605
16606
16607 .option disable_logging routers boolean false
16608 If this option is set true, nothing is logged for any routing errors
16609 or for any deliveries caused by this router. You should not set this option
16610 unless you really, really know what you are doing. See also the generic
16611 transport option of the same name.
16612
16613
16614 .option domains routers&!? "domain list&!!" unset
16615 .cindex "router" "restricting to specific domains"
16616 .vindex "&$domain_data$&"
16617 If this option is set, the router is skipped unless the current domain matches
16618 the list. If the match is achieved by means of a file lookup, the data that the
16619 lookup returned for the domain is placed in &$domain_data$& for use in string
16620 expansions of the driver's private options. See section &<<SECTrouprecon>>& for
16621 a list of the order in which preconditions are evaluated.
16622
16623
16624
16625 .option driver routers string unset
16626 This option must always be set. It specifies which of the available routers is
16627 to be used.
16628
16629
16630
16631 .option errors_to routers string&!! unset
16632 .cindex "envelope sender"
16633 .cindex "router" "changing address for errors"
16634 If a router successfully handles an address, it may assign the address to a
16635 transport for delivery or it may generate child addresses. In both cases, if
16636 there is a delivery problem during later processing, the resulting bounce
16637 message is sent to the address that results from expanding this string,
16638 provided that the address verifies successfully. The &%errors_to%& option is
16639 expanded before &%headers_add%&, &%headers_remove%&, and &%transport%&.
16640
16641 The &%errors_to%& setting associated with an address can be overridden if it
16642 subsequently passes through other routers that have their own &%errors_to%&
16643 settings, or if the message is delivered by a transport with a &%return_path%&
16644 setting.
16645
16646 If &%errors_to%& is unset, or the expansion is forced to fail, or the result of
16647 the expansion fails to verify, the errors address associated with the incoming
16648 address is used. At top level, this is the envelope sender. A non-forced
16649 expansion failure causes delivery to be deferred.
16650
16651 If an address for which &%errors_to%& has been set ends up being delivered over
16652 SMTP, the envelope sender for that delivery is the &%errors_to%& value, so that
16653 any bounces that are generated by other MTAs on the delivery route are also
16654 sent there. You can set &%errors_to%& to the empty string by either of these
16655 settings:
16656 .code
16657 errors_to =
16658 errors_to = ""
16659 .endd
16660 An expansion item that yields an empty string has the same effect. If you do
16661 this, a locally detected delivery error for addresses processed by this router
16662 no longer gives rise to a bounce message; the error is discarded. If the
16663 address is delivered to a remote host, the return path is set to &`<>`&, unless
16664 overridden by the &%return_path%& option on the transport.
16665
16666 .vindex "&$address_data$&"
16667 If for some reason you want to discard local errors, but use a non-empty
16668 MAIL command for remote delivery, you can preserve the original return
16669 path in &$address_data$& in the router, and reinstate it in the transport by
16670 setting &%return_path%&.
16671
16672 The most common use of &%errors_to%& is to direct mailing list bounces to the
16673 manager of the list, as described in section &<<SECTmailinglists>>&, or to
16674 implement VERP (Variable Envelope Return Paths) (see section &<<SECTverp>>&).
16675
16676
16677
16678 .option expn routers&!? boolean true
16679 .cindex "address" "testing"
16680 .cindex "testing" "addresses"
16681 .cindex "EXPN" "router skipping"
16682 .cindex "router" "skipping for EXPN"
16683 If this option is turned off, the router is skipped when testing an address
16684 as a result of processing an SMTP EXPN command. You might, for example,
16685 want to turn it off on a router for users' &_.forward_& files, while leaving it
16686 on for the system alias file.
16687 See section &<<SECTrouprecon>>& for a list of the order in which preconditions
16688 are evaluated.
16689
16690 The use of the SMTP EXPN command is controlled by an ACL (see chapter
16691 &<<CHAPACL>>&). When Exim is running an EXPN command, it is similar to testing
16692 an address with &%-bt%&. Compare VRFY, whose counterpart is &%-bv%&.
16693
16694
16695
16696 .option fail_verify routers boolean false
16697 .cindex "router" "forcing verification failure"
16698 Setting this option has the effect of setting both &%fail_verify_sender%& and
16699 &%fail_verify_recipient%& to the same value.
16700
16701
16702
16703 .option fail_verify_recipient routers boolean false
16704 If this option is true and an address is accepted by this router when
16705 verifying a recipient, verification fails.
16706
16707
16708
16709 .option fail_verify_sender routers boolean false
16710 If this option is true and an address is accepted by this router when
16711 verifying a sender, verification fails.
16712
16713
16714
16715 .option fallback_hosts routers "string list" unset
16716 .cindex "router" "fallback hosts"
16717 .cindex "fallback" "hosts specified on router"
16718 String expansion is not applied to this option. The argument must be a
16719 colon-separated list of host names or IP addresses. The list separator can be
16720 changed (see section &<<SECTlistconstruct>>&), and a port can be specified with
16721 each name or address. In fact, the format of each item is exactly the same as
16722 defined for the list of hosts in a &(manualroute)& router (see section
16723 &<<SECTformatonehostitem>>&).
16724
16725 If a router queues an address for a remote transport, this host list is
16726 associated with the address, and used instead of the transport's fallback host
16727 list. If &%hosts_randomize%& is set on the transport, the order of the list is
16728 randomized for each use. See the &%fallback_hosts%& option of the &(smtp)&
16729 transport for further details.
16730
16731
16732 .option group routers string&!! "see below"
16733 .cindex "gid (group id)" "local delivery"
16734 .cindex "local transports" "uid and gid"
16735 .cindex "transport" "local"
16736 .cindex "router" "setting group"
16737 When a router queues an address for a transport, and the transport does not
16738 specify a group, the group given here is used when running the delivery
16739 process.
16740 The group may be specified numerically or by name. If expansion fails, the
16741 error is logged and delivery is deferred.
16742 The default is unset, unless &%check_local_user%& is set, when the default
16743 is taken from the password information. See also &%initgroups%& and &%user%&
16744 and the discussion in chapter &<<CHAPenvironment>>&.
16745
16746
16747
16748 .option headers_add routers string&!! unset
16749 .cindex "header lines" "adding"
16750 .cindex "router" "adding header lines"
16751 This option specifies a string of text that is expanded at routing time, and
16752 associated with any addresses that are accepted by the router. However, this
16753 option has no effect when an address is just being verified. The way in which
16754 the text is used to add header lines at transport time is described in section
16755 &<<SECTheadersaddrem>>&. New header lines are not actually added until the
16756 message is in the process of being transported. This means that references to
16757 header lines in string expansions in the transport's configuration do not
16758 &"see"& the added header lines.
16759
16760 The &%headers_add%& option is expanded after &%errors_to%&, but before
16761 &%headers_remove%& and &%transport%&. If the expanded string is empty, or if
16762 the expansion is forced to fail, the option has no effect. Other expansion
16763 failures are treated as configuration errors.
16764
16765 .new
16766 Unlike most options, &%headers_add%& can be specified multiple times
16767 for a router; all listed headers are added.
16768 .wen
16769
16770 &*Warning 1*&: The &%headers_add%& option cannot be used for a &(redirect)&
16771 router that has the &%one_time%& option set.
16772
16773 .cindex "duplicate addresses"
16774 .oindex "&%unseen%&"
16775 &*Warning 2*&: If the &%unseen%& option is set on the router, all header
16776 additions are deleted when the address is passed on to subsequent routers.
16777 For a &%redirect%& router, if a generated address is the same as the incoming
16778 address, this can lead to duplicate addresses with different header
16779 modifications. Exim does not do duplicate deliveries (except, in certain
16780 circumstances, to pipes -- see section &<<SECTdupaddr>>&), but it is undefined
16781 which of the duplicates is discarded, so this ambiguous situation should be
16782 avoided. The &%repeat_use%& option of the &%redirect%& router may be of help.
16783
16784
16785
16786 .option headers_remove routers string&!! unset
16787 .cindex "header lines" "removing"
16788 .cindex "router" "removing header lines"
16789 This option specifies a string of text that is expanded at routing time, and
16790 associated with any addresses that are accepted by the router. However, this
16791 option has no effect when an address is just being verified. The way in which
16792 the text is used to remove header lines at transport time is described in
16793 section &<<SECTheadersaddrem>>&. Header lines are not actually removed until
16794 the message is in the process of being transported. This means that references
16795 to header lines in string expansions in the transport's configuration still
16796 &"see"& the original header lines.
16797
16798 The &%headers_remove%& option is expanded after &%errors_to%& and
16799 &%headers_add%&, but before &%transport%&. If the expansion is forced to fail,
16800 the option has no effect. Other expansion failures are treated as configuration
16801 errors.
16802
16803 Unlike most options, &%headers_remove%& can be specified multiple times
16804 for a router; all listed headers are removed.
16805
16806 &*Warning 1*&: The &%headers_remove%& option cannot be used for a &(redirect)&
16807 router that has the &%one_time%& option set.
16808
16809 &*Warning 2*&: If the &%unseen%& option is set on the router, all header
16810 removal requests are deleted when the address is passed on to subsequent
16811 routers, and this can lead to problems with duplicates -- see the similar
16812 warning for &%headers_add%& above.
16813
16814
16815 .option ignore_target_hosts routers "host list&!!" unset
16816 .cindex "IP address" "discarding"
16817 .cindex "router" "discarding IP addresses"
16818 Although this option is a host list, it should normally contain IP address
16819 entries rather than names. If any host that is looked up by the router has an
16820 IP address that matches an item in this list, Exim behaves as if that IP
16821 address did not exist. This option allows you to cope with rogue DNS entries
16822 like
16823 .code
16824 remote.domain.example.  A  127.0.0.1
16825 .endd
16826 by setting
16827 .code
16828 ignore_target_hosts = 127.0.0.1
16829 .endd
16830 on the relevant router. If all the hosts found by a &(dnslookup)& router are
16831 discarded in this way, the router declines. In a conventional configuration, an
16832 attempt to mail to such a domain would normally provoke the &"unrouteable
16833 domain"& error, and an attempt to verify an address in the domain would fail.
16834 Similarly, if &%ignore_target_hosts%& is set on an &(ipliteral)& router, the
16835 router declines if presented with one of the listed addresses.
16836
16837 You can use this option to disable the use of IPv4 or IPv6 for mail delivery by
16838 means of the first or the second of the following settings, respectively:
16839 .code
16840 ignore_target_hosts = 0.0.0.0/0
16841 ignore_target_hosts = <; 0::0/0
16842 .endd
16843 The pattern in the first line matches all IPv4 addresses, whereas the pattern
16844 in the second line matches all IPv6 addresses.
16845
16846 This option may also be useful for ignoring link-local and site-local IPv6
16847 addresses. Because, like all host lists, the value of &%ignore_target_hosts%&
16848 is expanded before use as a list, it is possible to make it dependent on the
16849 domain that is being routed.
16850
16851 .vindex "&$host_address$&"
16852 During its expansion, &$host_address$& is set to the IP address that is being
16853 checked.
16854
16855 .option initgroups routers boolean false
16856 .cindex "additional groups"
16857 .cindex "groups" "additional"
16858 .cindex "local transports" "uid and gid"
16859 .cindex "transport" "local"
16860 If the router queues an address for a transport, and this option is true, and
16861 the uid supplied by the router is not overridden by the transport, the
16862 &[initgroups()]& function is called when running the transport to ensure that
16863 any additional groups associated with the uid are set up. See also &%group%&
16864 and &%user%& and the discussion in chapter &<<CHAPenvironment>>&.
16865
16866
16867
16868 .option local_part_prefix routers&!? "string list" unset
16869 .cindex "router" "prefix for local part"
16870 .cindex "prefix" "for local part, used in router"
16871 If this option is set, the router is skipped unless the local part starts with
16872 one of the given strings, or &%local_part_prefix_optional%& is true. See
16873 section &<<SECTrouprecon>>& for a list of the order in which preconditions are
16874 evaluated.
16875
16876 The list is scanned from left to right, and the first prefix that matches is
16877 used. A limited form of wildcard is available; if the prefix begins with an
16878 asterisk, it matches the longest possible sequence of arbitrary characters at
16879 the start of the local part. An asterisk should therefore always be followed by
16880 some character that does not occur in normal local parts.
16881 .cindex "multiple mailboxes"
16882 .cindex "mailbox" "multiple"
16883 Wildcarding can be used to set up multiple user mailboxes, as described in
16884 section &<<SECTmulbox>>&.
16885
16886 .vindex "&$local_part$&"
16887 .vindex "&$local_part_prefix$&"
16888 During the testing of the &%local_parts%& option, and while the router is
16889 running, the prefix is removed from the local part, and is available in the
16890 expansion variable &$local_part_prefix$&. When a message is being delivered, if
16891 the router accepts the address, this remains true during subsequent delivery by
16892 a transport. In particular, the local part that is transmitted in the RCPT
16893 command for LMTP, SMTP, and BSMTP deliveries has the prefix removed by default.
16894 This behaviour can be overridden by setting &%rcpt_include_affixes%& true on
16895 the relevant transport.
16896
16897 When an address is being verified, &%local_part_prefix%& affects only the
16898 behaviour of the router. If the callout feature of verification is in use, this
16899 means that the full address, including the prefix, will be used during the
16900 callout.
16901
16902 The prefix facility is commonly used to handle local parts of the form
16903 &%owner-something%&. Another common use is to support local parts of the form
16904 &%real-username%& to bypass a user's &_.forward_& file &-- helpful when trying
16905 to tell a user their forwarding is broken &-- by placing a router like this one
16906 immediately before the router that handles &_.forward_& files:
16907 .code
16908 real_localuser:
16909   driver = accept
16910   local_part_prefix = real-
16911   check_local_user
16912   transport = local_delivery
16913 .endd
16914 For security, it would probably be a good idea to restrict the use of this
16915 router to locally-generated messages, using a condition such as this:
16916 .code
16917   condition = ${if match {$sender_host_address}\
16918                          {\N^(|127\.0\.0\.1)$\N}}
16919 .endd
16920
16921 If both &%local_part_prefix%& and &%local_part_suffix%& are set for a router,
16922 both conditions must be met if not optional. Care must be taken if wildcards
16923 are used in both a prefix and a suffix on the same router. Different
16924 separator characters must be used to avoid ambiguity.
16925
16926
16927 .option local_part_prefix_optional routers boolean false
16928 See &%local_part_prefix%& above.
16929
16930
16931
16932 .option local_part_suffix routers&!? "string list" unset
16933 .cindex "router" "suffix for local part"
16934 .cindex "suffix for local part" "used in router"
16935 This option operates in the same way as &%local_part_prefix%&, except that the
16936 local part must end (rather than start) with the given string, the
16937 &%local_part_suffix_optional%& option determines whether the suffix is
16938 mandatory, and the wildcard * character, if present, must be the last
16939 character of the suffix. This option facility is commonly used to handle local
16940 parts of the form &%something-request%& and multiple user mailboxes of the form
16941 &%username-foo%&.
16942
16943
16944 .option local_part_suffix_optional routers boolean false
16945 See &%local_part_suffix%& above.
16946
16947
16948
16949 .option local_parts routers&!? "local part list&!!" unset
16950 .cindex "router" "restricting to specific local parts"
16951 .cindex "local part" "checking in router"
16952 The router is run only if the local part of the address matches the list.
16953 See section &<<SECTrouprecon>>& for a list of the order in which preconditions
16954 are evaluated, and
16955 section &<<SECTlocparlis>>& for a discussion of local part lists. Because the
16956 string is expanded, it is possible to make it depend on the domain, for
16957 example:
16958 .code
16959 local_parts = dbm;/usr/local/specials/$domain
16960 .endd
16961 .vindex "&$local_part_data$&"
16962 If the match is achieved by a lookup, the data that the lookup returned
16963 for the local part is placed in the variable &$local_part_data$& for use in
16964 expansions of the router's private options. You might use this option, for
16965 example, if you have a large number of local virtual domains, and you want to
16966 send all postmaster mail to the same place without having to set up an alias in
16967 each virtual domain:
16968 .code
16969 postmaster:
16970   driver = redirect
16971   local_parts = postmaster
16972   data = postmaster@real.domain.example
16973 .endd
16974
16975
16976 .option log_as_local routers boolean "see below"
16977 .cindex "log" "delivery line"
16978 .cindex "delivery" "log line format"
16979 Exim has two logging styles for delivery, the idea being to make local
16980 deliveries stand out more visibly from remote ones. In the &"local"& style, the
16981 recipient address is given just as the local part, without a domain. The use of
16982 this style is controlled by this option. It defaults to true for the &(accept)&
16983 router, and false for all the others. This option applies only when a
16984 router assigns an address to a transport. It has no effect on routers that
16985 redirect addresses.
16986
16987
16988
16989 .option more routers boolean&!! true
16990 The result of string expansion for this option must be a valid boolean value,
16991 that is, one of the strings &"yes"&, &"no"&, &"true"&, or &"false"&. Any other
16992 result causes an error, and delivery is deferred. If the expansion is forced to
16993 fail, the default value for the option (true) is used. Other failures cause
16994 delivery to be deferred.
16995
16996 If this option is set false, and the router declines to handle the address, no
16997 further routers are tried, routing fails, and the address is bounced.
16998 .oindex "&%self%&"
16999 However, if the router explicitly passes an address to the following router by
17000 means of the setting
17001 .code
17002 self = pass
17003 .endd
17004 or otherwise, the setting of &%more%& is ignored. Also, the setting of &%more%&
17005 does not affect the behaviour if one of the precondition tests fails. In that
17006 case, the address is always passed to the next router.
17007
17008 Note that &%address_data%& is not considered to be a precondition. If its
17009 expansion is forced to fail, the router declines, and the value of &%more%&
17010 controls what happens next.
17011
17012
17013 .option pass_on_timeout routers boolean false
17014 .cindex "timeout" "of router"
17015 .cindex "router" "timeout"
17016 If a router times out during a host lookup, it normally causes deferral of the
17017 address. If &%pass_on_timeout%& is set, the address is passed on to the next
17018 router, overriding &%no_more%&. This may be helpful for systems that are
17019 intermittently connected to the Internet, or those that want to pass to a smart
17020 host any messages that cannot immediately be delivered.
17021
17022 There are occasional other temporary errors that can occur while doing DNS
17023 lookups. They are treated in the same way as a timeout, and this option
17024 applies to all of them.
17025
17026
17027
17028 .option pass_router routers string unset
17029 .cindex "router" "go to after &""pass""&"
17030 Routers that recognize the generic &%self%& option (&(dnslookup)&,
17031 &(ipliteral)&, and &(manualroute)&) are able to return &"pass"&, forcing
17032 routing to continue, and overriding a false setting of &%more%&. When one of
17033 these routers returns &"pass"&, the address is normally handed on to the next
17034 router in sequence. This can be changed by setting &%pass_router%& to the name
17035 of another router. However (unlike &%redirect_router%&) the named router must
17036 be below the current router, to avoid loops. Note that this option applies only
17037 to the special case of &"pass"&. It does not apply when a router returns
17038 &"decline"& because it cannot handle an address.
17039
17040
17041
17042 .option redirect_router routers string unset
17043 .cindex "router" "start at after redirection"
17044 Sometimes an administrator knows that it is pointless to reprocess addresses
17045 generated from alias or forward files with the same router again. For
17046 example, if an alias file translates real names into login ids there is no
17047 point searching the alias file a second time, especially if it is a large file.
17048
17049 The &%redirect_router%& option can be set to the name of any router instance.
17050 It causes the routing of any generated addresses to start at the named router
17051 instead of at the first router. This option has no effect if the router in
17052 which it is set does not generate new addresses.
17053
17054
17055
17056 .option require_files routers&!? "string list&!!" unset
17057 .cindex "file" "requiring for router"
17058 .cindex "router" "requiring file existence"
17059 This option provides a general mechanism for predicating the running of a
17060 router on the existence or non-existence of certain files or directories.
17061 Before running a router, as one of its precondition tests, Exim works its way
17062 through the &%require_files%& list, expanding each item separately.
17063
17064 Because the list is split before expansion, any colons in expansion items must
17065 be doubled, or the facility for using a different list separator must be used.
17066 If any expansion is forced to fail, the item is ignored. Other expansion
17067 failures cause routing of the address to be deferred.
17068
17069 If any expanded string is empty, it is ignored. Otherwise, except as described
17070 below, each string must be a fully qualified file path, optionally preceded by
17071 &"!"&. The paths are passed to the &[stat()]& function to test for the
17072 existence of the files or directories. The router is skipped if any paths not
17073 preceded by &"!"& do not exist, or if any paths preceded by &"!"& do exist.
17074
17075 .cindex "NFS"
17076 If &[stat()]& cannot determine whether a file exists or not, delivery of
17077 the message is deferred. This can happen when NFS-mounted filesystems are
17078 unavailable.
17079
17080 This option is checked after the &%domains%&, &%local_parts%&, and &%senders%&
17081 options, so you cannot use it to check for the existence of a file in which to
17082 look up a domain, local part, or sender. (See section &<<SECTrouprecon>>& for a
17083 full list of the order in which preconditions are evaluated.) However, as
17084 these options are all expanded, you can use the &%exists%& expansion condition
17085 to make such tests. The &%require_files%& option is intended for checking files
17086 that the router may be going to use internally, or which are needed by a
17087 transport (for example &_.procmailrc_&).
17088
17089 During delivery, the &[stat()]& function is run as root, but there is a
17090 facility for some checking of the accessibility of a file by another user.
17091 This is not a proper permissions check, but just a &"rough"& check that
17092 operates as follows:
17093
17094 If an item in a &%require_files%& list does not contain any forward slash
17095 characters, it is taken to be the user (and optional group, separated by a
17096 comma) to be checked for subsequent files in the list. If no group is specified
17097 but the user is specified symbolically, the gid associated with the uid is
17098 used. For example:
17099 .code
17100 require_files = mail:/some/file
17101 require_files = $local_part:$home/.procmailrc
17102 .endd
17103 If a user or group name in a &%require_files%& list does not exist, the
17104 &%require_files%& condition fails.
17105
17106 Exim performs the check by scanning along the components of the file path, and
17107 checking the access for the given uid and gid. It checks for &"x"& access on
17108 directories, and &"r"& access on the final file. Note that this means that file
17109 access control lists, if the operating system has them, are ignored.
17110
17111 &*Warning 1*&: When the router is being run to verify addresses for an
17112 incoming SMTP message, Exim is not running as root, but under its own uid. This
17113 may affect the result of a &%require_files%& check. In particular, &[stat()]&
17114 may yield the error EACCES (&"Permission denied"&). This means that the Exim
17115 user is not permitted to read one of the directories on the file's path.
17116
17117 &*Warning 2*&: Even when Exim is running as root while delivering a message,
17118 &[stat()]& can yield EACCES for a file in an NFS directory that is mounted
17119 without root access. In this case, if a check for access by a particular user
17120 is requested, Exim creates a subprocess that runs as that user, and tries the
17121 check again in that process.
17122
17123 The default action for handling an unresolved EACCES is to consider it to
17124 be caused by a configuration error, and routing is deferred because the
17125 existence or non-existence of the file cannot be determined. However, in some
17126 circumstances it may be desirable to treat this condition as if the file did
17127 not exist. If the file name (or the exclamation mark that precedes the file
17128 name for non-existence) is preceded by a plus sign, the EACCES error is treated
17129 as if the file did not exist. For example:
17130 .code
17131 require_files = +/some/file
17132 .endd
17133 If the router is not an essential part of verification (for example, it
17134 handles users' &_.forward_& files), another solution is to set the &%verify%&
17135 option false so that the router is skipped when verifying.
17136
17137
17138
17139 .option retry_use_local_part routers boolean "see below"
17140 .cindex "hints database" "retry keys"
17141 .cindex "local part" "in retry keys"
17142 When a delivery suffers a temporary routing failure, a retry record is created
17143 in Exim's hints database. For addresses whose routing depends only on the
17144 domain, the key for the retry record should not involve the local part, but for
17145 other addresses, both the domain and the local part should be included.
17146 Usually, remote routing is of the former kind, and local routing is of the
17147 latter kind.
17148
17149 This option controls whether the local part is used to form the key for retry
17150 hints for addresses that suffer temporary errors while being handled by this
17151 router. The default value is true for any router that has &%check_local_user%&
17152 set, and false otherwise. Note that this option does not apply to hints keys
17153 for transport delays; they are controlled by a generic transport option of the
17154 same name.
17155
17156 The setting of &%retry_use_local_part%& applies only to the router on which it
17157 appears. If the router generates child addresses, they are routed
17158 independently; this setting does not become attached to them.
17159
17160
17161
17162 .option router_home_directory routers string&!! unset
17163 .cindex "router" "home directory for"
17164 .cindex "home directory" "for router"
17165 .vindex "&$home$&"
17166 This option sets a home directory for use while the router is running. (Compare
17167 &%transport_home_directory%&, which sets a home directory for later
17168 transporting.) In particular, if used on a &(redirect)& router, this option
17169 sets a value for &$home$& while a filter is running. The value is expanded;
17170 forced expansion failure causes the option to be ignored &-- other failures
17171 cause the router to defer.
17172
17173 Expansion of &%router_home_directory%& happens immediately after the
17174 &%check_local_user%& test (if configured), before any further expansions take
17175 place.
17176 (See section &<<SECTrouprecon>>& for a list of the order in which preconditions
17177 are evaluated.)
17178 While the router is running, &%router_home_directory%& overrides the value of
17179 &$home$& that came from &%check_local_user%&.
17180
17181 When a router accepts an address and assigns it to a local transport (including
17182 the cases when a &(redirect)& router generates a pipe, file, or autoreply
17183 delivery), the home directory setting for the transport is taken from the first
17184 of these values that is set:
17185
17186 .ilist
17187 The &%home_directory%& option on the transport;
17188 .next
17189 The &%transport_home_directory%& option on the router;
17190 .next
17191 The password data if &%check_local_user%& is set on the router;
17192 .next
17193 The &%router_home_directory%& option on the router.
17194 .endlist
17195
17196 In other words, &%router_home_directory%& overrides the password data for the
17197 router, but not for the transport.
17198
17199
17200
17201 .option self routers string freeze
17202 .cindex "MX record" "pointing to local host"
17203 .cindex "local host" "MX pointing to"
17204 This option applies to those routers that use a recipient address to find a
17205 list of remote hosts. Currently, these are the &(dnslookup)&, &(ipliteral)&,
17206 and &(manualroute)& routers.
17207 Certain configurations of the &(queryprogram)& router can also specify a list
17208 of remote hosts.
17209 Usually such routers are configured to send the message to a remote host via an
17210 &(smtp)& transport. The &%self%& option specifies what happens when the first
17211 host on the list turns out to be the local host.
17212 The way in which Exim checks for the local host is described in section
17213 &<<SECTreclocipadd>>&.
17214
17215 Normally this situation indicates either an error in Exim's configuration (for
17216 example, the router should be configured not to process this domain), or an
17217 error in the DNS (for example, the MX should not point to this host). For this
17218 reason, the default action is to log the incident, defer the address, and
17219 freeze the message. The following alternatives are provided for use in special
17220 cases:
17221
17222 .vlist
17223 .vitem &%defer%&
17224 Delivery of the message is tried again later, but the message is not frozen.
17225
17226 .vitem "&%reroute%&: <&'domain'&>"
17227 The domain is changed to the given domain, and the address is passed back to
17228 be reprocessed by the routers. No rewriting of headers takes place. This
17229 behaviour is essentially a redirection.
17230
17231 .vitem "&%reroute: rewrite:%& <&'domain'&>"
17232 The domain is changed to the given domain, and the address is passed back to be
17233 reprocessed by the routers. Any headers that contain the original domain are
17234 rewritten.
17235
17236 .vitem &%pass%&
17237 .oindex "&%more%&"
17238 .vindex "&$self_hostname$&"
17239 The router passes the address to the next router, or to the router named in the
17240 &%pass_router%& option if it is set. This overrides &%no_more%&. During
17241 subsequent routing and delivery, the variable &$self_hostname$& contains the
17242 name of the local host that the router encountered. This can be used to
17243 distinguish between different cases for hosts with multiple names. The
17244 combination
17245 .code
17246 self = pass
17247 no_more
17248 .endd
17249 ensures that only those addresses that routed to the local host are passed on.
17250 Without &%no_more%&, addresses that were declined for other reasons would also
17251 be passed to the next router.
17252
17253 .vitem &%fail%&
17254 Delivery fails and an error report is generated.
17255
17256 .vitem &%send%&
17257 .cindex "local host" "sending to"
17258 The anomaly is ignored and the address is queued for the transport. This
17259 setting should be used with extreme caution. For an &(smtp)& transport, it
17260 makes sense only in cases where the program that is listening on the SMTP port
17261 is not this version of Exim. That is, it must be some other MTA, or Exim with a
17262 different configuration file that handles the domain in another way.
17263 .endlist
17264
17265
17266
17267 .option senders routers&!? "address list&!!" unset
17268 .cindex "router" "checking senders"
17269 If this option is set, the router is skipped unless the message's sender
17270 address matches something on the list.
17271 See section &<<SECTrouprecon>>& for a list of the order in which preconditions
17272 are evaluated.
17273
17274 There are issues concerning verification when the running of routers is
17275 dependent on the sender. When Exim is verifying the address in an &%errors_to%&
17276 setting, it sets the sender to the null string. When using the &%-bt%& option
17277 to check a configuration file, it is necessary also to use the &%-f%& option to
17278 set an appropriate sender. For incoming mail, the sender is unset when
17279 verifying the sender, but is available when verifying any recipients. If the
17280 SMTP VRFY command is enabled, it must be used after MAIL if the sender address
17281 matters.
17282
17283
17284 .option translate_ip_address routers string&!! unset
17285 .cindex "IP address" "translating"
17286 .cindex "packet radio"
17287 .cindex "router" "IP address translation"
17288 There exist some rare networking situations (for example, packet radio) where
17289 it is helpful to be able to translate IP addresses generated by normal routing
17290 mechanisms into other IP addresses, thus performing a kind of manual IP
17291 routing. This should be done only if the normal IP routing of the TCP/IP stack
17292 is inadequate or broken. Because this is an extremely uncommon requirement, the
17293 code to support this option is not included in the Exim binary unless
17294 SUPPORT_TRANSLATE_IP_ADDRESS=yes is set in &_Local/Makefile_&.
17295
17296 .vindex "&$host_address$&"
17297 The &%translate_ip_address%& string is expanded for every IP address generated
17298 by the router, with the generated address set in &$host_address$&. If the
17299 expansion is forced to fail, no action is taken.
17300 For any other expansion error, delivery of the message is deferred.
17301 If the result of the expansion is an IP address, that replaces the original
17302 address; otherwise the result is assumed to be a host name &-- this is looked
17303 up using &[gethostbyname()]& (or &[getipnodebyname()]& when available) to
17304 produce one or more replacement IP addresses. For example, to subvert all IP
17305 addresses in some specific networks, this could be added to a router:
17306 .code
17307 translate_ip_address = \
17308   ${lookup{${mask:$host_address/26}}lsearch{/some/file}\
17309     {$value}fail}}
17310 .endd
17311 The file would contain lines like
17312 .code
17313 10.2.3.128/26    some.host
17314 10.8.4.34/26     10.44.8.15
17315 .endd
17316 You should not make use of this facility unless you really understand what you
17317 are doing.
17318
17319
17320
17321 .option transport routers string&!! unset
17322 This option specifies the transport to be used when a router accepts an address
17323 and sets it up for delivery. A transport is never needed if a router is used
17324 only for verification. The value of the option is expanded at routing time,
17325 after the expansion of &%errors_to%&, &%headers_add%&, and &%headers_remove%&,
17326 and result must be the name of one of the configured transports. If it is not,
17327 delivery is deferred.
17328
17329 The &%transport%& option is not used by the &(redirect)& router, but it does
17330 have some private options that set up transports for pipe and file deliveries
17331 (see chapter &<<CHAPredirect>>&).
17332
17333
17334
17335 .option transport_current_directory routers string&!! unset
17336 .cindex "current directory for local transport"
17337 This option associates a current directory with any address that is routed
17338 to a local transport. This can happen either because a transport is
17339 explicitly configured for the router, or because it generates a delivery to a
17340 file or a pipe. During the delivery process (that is, at transport time), this
17341 option string is expanded and is set as the current directory, unless
17342 overridden by a setting on the transport.
17343 If the expansion fails for any reason, including forced failure, an error is
17344 logged, and delivery is deferred.
17345 See chapter &<<CHAPenvironment>>& for details of the local delivery
17346 environment.
17347
17348
17349
17350
17351 .option transport_home_directory routers string&!! "see below"
17352 .cindex "home directory" "for local transport"
17353 This option associates a home directory with any address that is routed to a
17354 local transport. This can happen either because a transport is explicitly
17355 configured for the router, or because it generates a delivery to a file or a
17356 pipe. During the delivery process (that is, at transport time), the option
17357 string is expanded and is set as the home directory, unless overridden by a
17358 setting of &%home_directory%& on the transport.
17359 If the expansion fails for any reason, including forced failure, an error is
17360 logged, and delivery is deferred.
17361
17362 If the transport does not specify a home directory, and
17363 &%transport_home_directory%& is not set for the router, the home directory for
17364 the transport is taken from the password data if &%check_local_user%& is set for
17365 the router. Otherwise it is taken from &%router_home_directory%& if that option
17366 is set; if not, no home directory is set for the transport.
17367
17368 See chapter &<<CHAPenvironment>>& for further details of the local delivery
17369 environment.
17370
17371
17372
17373
17374 .option unseen routers boolean&!! false
17375 .cindex "router" "carrying on after success"
17376 The result of string expansion for this option must be a valid boolean value,
17377 that is, one of the strings &"yes"&, &"no"&, &"true"&, or &"false"&. Any other
17378 result causes an error, and delivery is deferred. If the expansion is forced to
17379 fail, the default value for the option (false) is used. Other failures cause
17380 delivery to be deferred.
17381
17382 When this option is set true, routing does not cease if the router accepts the
17383 address. Instead, a copy of the incoming address is passed to the next router,
17384 overriding a false setting of &%more%&. There is little point in setting
17385 &%more%& false if &%unseen%& is always true, but it may be useful in cases when
17386 the value of &%unseen%& contains expansion items (and therefore, presumably, is
17387 sometimes true and sometimes false).
17388
17389 .cindex "copy of message (&%unseen%& option)"
17390 Setting the &%unseen%& option has a similar effect to the &%unseen%& command
17391 qualifier in filter files. It can be used to cause copies of messages to be
17392 delivered to some other destination, while also carrying out a normal delivery.
17393 In effect, the current address is made into a &"parent"& that has two children
17394 &-- one that is delivered as specified by this router, and a clone that goes on
17395 to be routed further. For this reason, &%unseen%& may not be combined with the
17396 &%one_time%& option in a &(redirect)& router.
17397
17398 &*Warning*&: Header lines added to the address (or specified for removal) by
17399 this router or by previous routers affect the &"unseen"& copy of the message
17400 only. The clone that continues to be processed by further routers starts with
17401 no added headers and none specified for removal. For a &%redirect%& router, if
17402 a generated address is the same as the incoming address, this can lead to
17403 duplicate addresses with different header modifications. Exim does not do
17404 duplicate deliveries (except, in certain circumstances, to pipes -- see section
17405 &<<SECTdupaddr>>&), but it is undefined which of the duplicates is discarded,
17406 so this ambiguous situation should be avoided. The &%repeat_use%& option of the
17407 &%redirect%& router may be of help.
17408
17409 Unlike the handling of header modifications, any data that was set by the
17410 &%address_data%& option in the current or previous routers &'is'& passed on to
17411 subsequent routers.
17412
17413
17414 .option user routers string&!! "see below"
17415 .cindex "uid (user id)" "local delivery"
17416 .cindex "local transports" "uid and gid"
17417 .cindex "transport" "local"
17418 .cindex "router" "user for filter processing"
17419 .cindex "filter" "user for processing"
17420 When a router queues an address for a transport, and the transport does not
17421 specify a user, the user given here is used when running the delivery process.
17422 The user may be specified numerically or by name. If expansion fails, the
17423 error is logged and delivery is deferred.
17424 This user is also used by the &(redirect)& router when running a filter file.
17425 The default is unset, except when &%check_local_user%& is set. In this case,
17426 the default is taken from the password information. If the user is specified as
17427 a name, and &%group%& is not set, the group associated with the user is used.
17428 See also &%initgroups%& and &%group%& and the discussion in chapter
17429 &<<CHAPenvironment>>&.
17430
17431
17432
17433 .option verify routers&!? boolean true
17434 Setting this option has the effect of setting &%verify_sender%& and
17435 &%verify_recipient%& to the same value.
17436
17437
17438 .option verify_only routers&!? boolean false
17439 .cindex "EXPN" "with &%verify_only%&"
17440 .oindex "&%-bv%&"
17441 .cindex "router" "used only when verifying"
17442 If this option is set, the router is used only when verifying an address,
17443 .new "delivering in cutthrough mode or"
17444 testing with the &%-bv%& option, not when actually doing a delivery, testing
17445 with the &%-bt%& option, or running the SMTP EXPN command. It can be further
17446 restricted to verifying only senders or recipients by means of
17447 &%verify_sender%& and &%verify_recipient%&.
17448
17449 &*Warning*&: When the router is being run to verify addresses for an incoming
17450 SMTP message, Exim is not running as root, but under its own uid. If the router
17451 accesses any files, you need to make sure that they are accessible to the Exim
17452 user or group.
17453
17454
17455 .option verify_recipient routers&!? boolean true
17456 If this option is false, the router is skipped when verifying recipient
17457 addresses,
17458 delivering in cutthrough mode
17459 or testing recipient verification using &%-bv%&.
17460 See section &<<SECTrouprecon>>& for a list of the order in which preconditions
17461 are evaluated.
17462
17463
17464 .option verify_sender routers&!? boolean true
17465 If this option is false, the router is skipped when verifying sender addresses
17466 or testing sender verification using &%-bvs%&.
17467 See section &<<SECTrouprecon>>& for a list of the order in which preconditions
17468 are evaluated.
17469 .ecindex IIDgenoprou1
17470 .ecindex IIDgenoprou2
17471
17472
17473
17474
17475
17476
17477 . ////////////////////////////////////////////////////////////////////////////
17478 . ////////////////////////////////////////////////////////////////////////////
17479
17480 .chapter "The accept router" "CHID4"
17481 .cindex "&(accept)& router"
17482 .cindex "routers" "&(accept)&"
17483 The &(accept)& router has no private options of its own. Unless it is being
17484 used purely for verification (see &%verify_only%&) a transport is required to
17485 be defined by the generic &%transport%& option. If the preconditions that are
17486 specified by generic options are met, the router accepts the address and queues
17487 it for the given transport. The most common use of this router is for setting
17488 up deliveries to local mailboxes. For example:
17489 .code
17490 localusers:
17491   driver = accept
17492   domains = mydomain.example
17493   check_local_user
17494   transport = local_delivery
17495 .endd
17496 The &%domains%& condition in this example checks the domain of the address, and
17497 &%check_local_user%& checks that the local part is the login of a local user.
17498 When both preconditions are met, the &(accept)& router runs, and queues the
17499 address for the &(local_delivery)& transport.
17500
17501
17502
17503
17504
17505
17506 . ////////////////////////////////////////////////////////////////////////////
17507 . ////////////////////////////////////////////////////////////////////////////
17508
17509 .chapter "The dnslookup router" "CHAPdnslookup"
17510 .scindex IIDdnsrou1 "&(dnslookup)& router"
17511 .scindex IIDdnsrou2 "routers" "&(dnslookup)&"
17512 The &(dnslookup)& router looks up the hosts that handle mail for the
17513 recipient's domain in the DNS. A transport must always be set for this router,
17514 unless &%verify_only%& is set.
17515
17516 If SRV support is configured (see &%check_srv%& below), Exim first searches for
17517 SRV records. If none are found, or if SRV support is not configured,
17518 MX records are looked up. If no MX records exist, address records are sought.
17519 However, &%mx_domains%& can be set to disable the direct use of address
17520 records.
17521
17522 MX records of equal priority are sorted by Exim into a random order. Exim then
17523 looks for address records for the host names obtained from MX or SRV records.
17524 When a host has more than one IP address, they are sorted into a random order,
17525 except that IPv6 addresses are always sorted before IPv4 addresses. If all the
17526 IP addresses found are discarded by a setting of the &%ignore_target_hosts%&
17527 generic option, the router declines.
17528
17529 Unless they have the highest priority (lowest MX value), MX records that point
17530 to the local host, or to any host name that matches &%hosts_treat_as_local%&,
17531 are discarded, together with any other MX records of equal or lower priority.
17532
17533 .cindex "MX record" "pointing to local host"
17534 .cindex "local host" "MX pointing to"
17535 .oindex "&%self%&" "in &(dnslookup)& router"
17536 If the host pointed to by the highest priority MX record, or looked up as an
17537 address record, is the local host, or matches &%hosts_treat_as_local%&, what
17538 happens is controlled by the generic &%self%& option.
17539
17540
17541 .section "Problems with DNS lookups" "SECTprowitdnsloo"
17542 There have been problems with DNS servers when SRV records are looked up.
17543 Some mis-behaving servers return a DNS error or timeout when a non-existent
17544 SRV record is sought. Similar problems have in the past been reported for
17545 MX records. The global &%dns_again_means_nonexist%& option can help with this
17546 problem, but it is heavy-handed because it is a global option.
17547
17548 For this reason, there are two options, &%srv_fail_domains%& and
17549 &%mx_fail_domains%&, that control what happens when a DNS lookup in a
17550 &(dnslookup)& router results in a DNS failure or a &"try again"& response. If
17551 an attempt to look up an SRV or MX record causes one of these results, and the
17552 domain matches the relevant list, Exim behaves as if the DNS had responded &"no
17553 such record"&. In the case of an SRV lookup, this means that the router
17554 proceeds to look for MX records; in the case of an MX lookup, it proceeds to
17555 look for A or AAAA records, unless the domain matches &%mx_domains%&, in which
17556 case routing fails.
17557
17558
17559 .section "Declining addresses by dnslookup" "SECTdnslookupdecline"
17560 .cindex "&(dnslookup)& router" "declines"
17561 There are a few cases where a &(dnslookup)& router will decline to accept
17562 an address; if such a router is expected to handle "all remaining non-local
17563 domains", then it is important to set &%no_more%&.
17564
17565 Reasons for a &(dnslookup)& router to decline currently include:
17566 .ilist
17567 The domain does not exist in DNS
17568 .next
17569 The domain exists but the MX record's host part is just "."; this is a common
17570 convention (borrowed from SRV) used to indicate that there is no such service
17571 for this domain and to not fall back to trying A/AAAA records.
17572 .next
17573 Ditto, but for SRV records, when &%check_srv%& is set on this router.
17574 .next
17575 MX record points to a non-existent host.
17576 .next
17577 MX record points to an IP address and the main section option
17578 &%allow_mx_to_ip%& is not set.
17579 .next
17580 MX records exist and point to valid hosts, but all hosts resolve only to
17581 addresses blocked by the &%ignore_target_hosts%& generic option on this router.
17582 .next
17583 The domain is not syntactically valid (see also &%allow_utf8_domains%& and
17584 &%dns_check_names_pattern%& for handling one variant of this)
17585 .next
17586 &%check_secondary_mx%& is set on this router but the local host can
17587 not be found in the MX records (see below)
17588 .endlist
17589
17590
17591
17592
17593 .section "Private options for dnslookup" "SECID118"
17594 .cindex "options" "&(dnslookup)& router"
17595 The private options for the &(dnslookup)& router are as follows:
17596
17597 .option check_secondary_mx dnslookup boolean false
17598 .cindex "MX record" "checking for secondary"
17599 If this option is set, the router declines unless the local host is found in
17600 (and removed from) the list of hosts obtained by MX lookup. This can be used to
17601 process domains for which the local host is a secondary mail exchanger
17602 differently to other domains. The way in which Exim decides whether a host is
17603 the local host is described in section &<<SECTreclocipadd>>&.
17604
17605
17606 .option check_srv dnslookup string&!! unset
17607 .cindex "SRV record" "enabling use of"
17608 The &(dnslookup)& router supports the use of SRV records (see RFC 2782) in
17609 addition to MX and address records. The support is disabled by default. To
17610 enable SRV support, set the &%check_srv%& option to the name of the service
17611 required. For example,
17612 .code
17613 check_srv = smtp
17614 .endd
17615 looks for SRV records that refer to the normal smtp service. The option is
17616 expanded, so the service name can vary from message to message or address
17617 to address. This might be helpful if SRV records are being used for a
17618 submission service. If the expansion is forced to fail, the &%check_srv%&
17619 option is ignored, and the router proceeds to look for MX records in the
17620 normal way.
17621
17622 When the expansion succeeds, the router searches first for SRV records for
17623 the given service (it assumes TCP protocol). A single SRV record with a
17624 host name that consists of just a single dot indicates &"no such service for
17625 this domain"&; if this is encountered, the router declines. If other kinds of
17626 SRV record are found, they are used to construct a host list for delivery
17627 according to the rules of RFC 2782. MX records are not sought in this case.
17628
17629 When no SRV records are found, MX records (and address records) are sought in
17630 the traditional way. In other words, SRV records take precedence over MX
17631 records, just as MX records take precedence over address records. Note that
17632 this behaviour is not sanctioned by RFC 2782, though a previous draft RFC
17633 defined it. It is apparently believed that MX records are sufficient for email
17634 and that SRV records should not be used for this purpose. However, SRV records
17635 have an additional &"weight"& feature which some people might find useful when
17636 trying to split an SMTP load between hosts of different power.
17637
17638 See section &<<SECTprowitdnsloo>>& above for a discussion of Exim's behaviour
17639 when there is a DNS lookup error.
17640
17641
17642
17643 .option mx_domains dnslookup "domain list&!!" unset
17644 .cindex "MX record" "required to exist"
17645 .cindex "SRV record" "required to exist"
17646 A domain that matches &%mx_domains%& is required to have either an MX or an SRV
17647 record in order to be recognized. (The name of this option could be improved.)
17648 For example, if all the mail hosts in &'fict.example'& are known to have MX
17649 records, except for those in &'discworld.fict.example'&, you could use this
17650 setting:
17651 .code
17652 mx_domains = ! *.discworld.fict.example : *.fict.example
17653 .endd
17654 This specifies that messages addressed to a domain that matches the list but
17655 has no MX record should be bounced immediately instead of being routed using
17656 the address record.
17657
17658
17659 .option mx_fail_domains dnslookup "domain list&!!" unset
17660 If the DNS lookup for MX records for one of the domains in this list causes a
17661 DNS lookup error, Exim behaves as if no MX records were found. See section
17662 &<<SECTprowitdnsloo>>& for more discussion.
17663
17664
17665
17666
17667 .option qualify_single dnslookup boolean true
17668 .cindex "DNS" "resolver options"
17669 .cindex "DNS" "qualifying single-component names"
17670 When this option is true, the resolver option RES_DEFNAMES is set for DNS
17671 lookups. Typically, but not standardly, this causes the resolver to qualify
17672 single-component names with the default domain. For example, on a machine
17673 called &'dictionary.ref.example'&, the domain &'thesaurus'& would be changed to
17674 &'thesaurus.ref.example'& inside the resolver. For details of what your
17675 resolver actually does, consult your man pages for &'resolver'& and
17676 &'resolv.conf'&.
17677
17678
17679
17680 .option rewrite_headers dnslookup boolean true
17681 .cindex "rewriting" "header lines"
17682 .cindex "header lines" "rewriting"
17683 If the domain name in the address that is being processed is not fully
17684 qualified, it may be expanded to its full form by a DNS lookup. For example, if
17685 an address is specified as &'dormouse@teaparty'&, the domain might be
17686 expanded to &'teaparty.wonderland.fict.example'&. Domain expansion can also
17687 occur as a result of setting the &%widen_domains%& option. If
17688 &%rewrite_headers%& is true, all occurrences of the abbreviated domain name in
17689 any &'Bcc:'&, &'Cc:'&, &'From:'&, &'Reply-to:'&, &'Sender:'&, and &'To:'&
17690 header lines of the message are rewritten with the full domain name.
17691
17692 This option should be turned off only when it is known that no message is
17693 ever going to be sent outside an environment where the abbreviation makes
17694 sense.
17695
17696 When an MX record is looked up in the DNS and matches a wildcard record, name
17697 servers normally return a record containing the name that has been looked up,
17698 making it impossible to detect whether a wildcard was present or not. However,
17699 some name servers have recently been seen to return the wildcard entry. If the
17700 name returned by a DNS lookup begins with an asterisk, it is not used for
17701 header rewriting.
17702
17703
17704 .option same_domain_copy_routing dnslookup boolean false
17705 .cindex "address" "copying routing"
17706 Addresses with the same domain are normally routed by the &(dnslookup)& router
17707 to the same list of hosts. However, this cannot be presumed, because the router
17708 options and preconditions may refer to the local part of the address. By
17709 default, therefore, Exim routes each address in a message independently. DNS
17710 servers run caches, so repeated DNS lookups are not normally expensive, and in
17711 any case, personal messages rarely have more than a few recipients.
17712
17713 If you are running mailing lists with large numbers of subscribers at the same
17714 domain, and you are using a &(dnslookup)& router which is independent of the
17715 local part, you can set &%same_domain_copy_routing%& to bypass repeated DNS
17716 lookups for identical domains in one message. In this case, when &(dnslookup)&
17717 routes an address to a remote transport, any other unrouted addresses in the
17718 message that have the same domain are automatically given the same routing
17719 without processing them independently,
17720 provided the following conditions are met:
17721
17722 .ilist
17723 No router that processed the address specified &%headers_add%& or
17724 &%headers_remove%&.
17725 .next
17726 The router did not change the address in any way, for example, by &"widening"&
17727 the domain.
17728 .endlist
17729
17730
17731
17732
17733 .option search_parents dnslookup boolean false
17734 .cindex "DNS" "resolver options"
17735 When this option is true, the resolver option RES_DNSRCH is set for DNS
17736 lookups. This is different from the &%qualify_single%& option in that it
17737 applies to domains containing dots. Typically, but not standardly, it causes
17738 the resolver to search for the name in the current domain and in parent
17739 domains. For example, on a machine in the &'fict.example'& domain, if looking
17740 up &'teaparty.wonderland'& failed, the resolver would try
17741 &'teaparty.wonderland.fict.example'&. For details of what your resolver
17742 actually does, consult your man pages for &'resolver'& and &'resolv.conf'&.
17743
17744 Setting this option true can cause problems in domains that have a wildcard MX
17745 record, because any domain that does not have its own MX record matches the
17746 local wildcard.
17747
17748
17749
17750 .option srv_fail_domains dnslookup "domain list&!!" unset
17751 If the DNS lookup for SRV records for one of the domains in this list causes a
17752 DNS lookup error, Exim behaves as if no SRV records were found. See section
17753 &<<SECTprowitdnsloo>>& for more discussion.
17754
17755
17756
17757
17758 .option widen_domains dnslookup "string list" unset
17759 .cindex "domain" "partial; widening"
17760 If a DNS lookup fails and this option is set, each of its strings in turn is
17761 added onto the end of the domain, and the lookup is tried again. For example,
17762 if
17763 .code
17764 widen_domains = fict.example:ref.example
17765 .endd
17766 is set and a lookup of &'klingon.dictionary'& fails,
17767 &'klingon.dictionary.fict.example'& is looked up, and if this fails,
17768 &'klingon.dictionary.ref.example'& is tried. Note that the &%qualify_single%&
17769 and &%search_parents%& options can cause some widening to be undertaken inside
17770 the DNS resolver. &%widen_domains%& is not applied to sender addresses
17771 when verifying, unless &%rewrite_headers%& is false (not the default).
17772
17773
17774 .section "Effect of qualify_single and search_parents" "SECID119"
17775 When a domain from an envelope recipient is changed by the resolver as a result
17776 of the &%qualify_single%& or &%search_parents%& options, Exim rewrites the
17777 corresponding address in the message's header lines unless &%rewrite_headers%&
17778 is set false. Exim then re-routes the address, using the full domain.
17779
17780 These two options affect only the DNS lookup that takes place inside the router
17781 for the domain of the address that is being routed. They do not affect lookups
17782 such as that implied by
17783 .code
17784 domains = @mx_any
17785 .endd
17786 that may happen while processing a router precondition before the router is
17787 entered. No widening ever takes place for these lookups.
17788 .ecindex IIDdnsrou1
17789 .ecindex IIDdnsrou2
17790
17791
17792
17793
17794
17795
17796
17797
17798
17799 . ////////////////////////////////////////////////////////////////////////////
17800 . ////////////////////////////////////////////////////////////////////////////
17801
17802 .chapter "The ipliteral router" "CHID5"
17803 .cindex "&(ipliteral)& router"
17804 .cindex "domain literal" "routing"
17805 .cindex "routers" "&(ipliteral)&"
17806 This router has no private options. Unless it is being used purely for
17807 verification (see &%verify_only%&) a transport is required to be defined by the
17808 generic &%transport%& option. The router accepts the address if its domain part
17809 takes the form of an RFC 2822 domain literal. For example, the &(ipliteral)&
17810 router handles the address
17811 .code
17812 root@[192.168.1.1]
17813 .endd
17814 by setting up delivery to the host with that IP address. IPv4 domain literals
17815 consist of an IPv4 address enclosed in square brackets. IPv6 domain literals
17816 are similar, but the address is preceded by &`ipv6:`&. For example:
17817 .code
17818 postmaster@[ipv6:fe80::a00:20ff:fe86:a061.5678]
17819 .endd
17820 Exim allows &`ipv4:`& before IPv4 addresses, for consistency, and on the
17821 grounds that sooner or later somebody will try it.
17822
17823 .oindex "&%self%&" "in &(ipliteral)& router"
17824 If the IP address matches something in &%ignore_target_hosts%&, the router
17825 declines. If an IP literal turns out to refer to the local host, the generic
17826 &%self%& option determines what happens.
17827
17828 The RFCs require support for domain literals; however, their use is
17829 controversial in today's Internet. If you want to use this router, you must
17830 also set the main configuration option &%allow_domain_literals%&. Otherwise,
17831 Exim will not recognize the domain literal syntax in addresses.
17832
17833
17834
17835 . ////////////////////////////////////////////////////////////////////////////
17836 . ////////////////////////////////////////////////////////////////////////////
17837
17838 .chapter "The iplookup router" "CHID6"
17839 .cindex "&(iplookup)& router"
17840 .cindex "routers" "&(iplookup)&"
17841 The &(iplookup)& router was written to fulfil a specific requirement in
17842 Cambridge University (which in fact no longer exists). For this reason, it is
17843 not included in the binary of Exim by default. If you want to include it, you
17844 must set
17845 .code
17846 ROUTER_IPLOOKUP=yes
17847 .endd
17848 in your &_Local/Makefile_& configuration file.
17849
17850 The &(iplookup)& router routes an address by sending it over a TCP or UDP
17851 connection to one or more specific hosts. The host can then return the same or
17852 a different address &-- in effect rewriting the recipient address in the
17853 message's envelope. The new address is then passed on to subsequent routers. If
17854 this process fails, the address can be passed on to other routers, or delivery
17855 can be deferred. Since &(iplookup)& is just a rewriting router, a transport
17856 must not be specified for it.
17857
17858 .cindex "options" "&(iplookup)& router"
17859 .option hosts iplookup string unset
17860 This option must be supplied. Its value is a colon-separated list of host
17861 names. The hosts are looked up using &[gethostbyname()]&
17862 (or &[getipnodebyname()]& when available)
17863 and are tried in order until one responds to the query. If none respond, what
17864 happens is controlled by &%optional%&.
17865
17866
17867 .option optional iplookup boolean false
17868 If &%optional%& is true, if no response is obtained from any host, the address
17869 is passed to the next router, overriding &%no_more%&. If &%optional%& is false,
17870 delivery to the address is deferred.
17871
17872
17873 .option port iplookup integer 0
17874 .cindex "port" "&(iplookup)& router"
17875 This option must be supplied. It specifies the port number for the TCP or UDP
17876 call.
17877
17878
17879 .option protocol iplookup string udp
17880 This option can be set to &"udp"& or &"tcp"& to specify which of the two
17881 protocols is to be used.
17882
17883
17884 .option query iplookup string&!! "see below"
17885 This defines the content of the query that is sent to the remote hosts. The
17886 default value is:
17887 .code
17888 $local_part@$domain $local_part@$domain
17889 .endd
17890 The repetition serves as a way of checking that a response is to the correct
17891 query in the default case (see &%response_pattern%& below).
17892
17893
17894 .option reroute iplookup string&!! unset
17895 If this option is not set, the rerouted address is precisely the byte string
17896 returned by the remote host, up to the first white space, if any. If set, the
17897 string is expanded to form the rerouted address. It can include parts matched
17898 in the response by &%response_pattern%& by means of numeric variables such as
17899 &$1$&, &$2$&, etc. The variable &$0$& refers to the entire input string,
17900 whether or not a pattern is in use. In all cases, the rerouted address must end
17901 up in the form &'local_part@domain'&.
17902
17903
17904 .option response_pattern iplookup string unset
17905 This option can be set to a regular expression that is applied to the string
17906 returned from the remote host. If the pattern does not match the response, the
17907 router declines. If &%response_pattern%& is not set, no checking of the
17908 response is done, unless the query was defaulted, in which case there is a
17909 check that the text returned after the first white space is the original
17910 address. This checks that the answer that has been received is in response to
17911 the correct question. For example, if the response is just a new domain, the
17912 following could be used:
17913 .code
17914 response_pattern = ^([^@]+)$
17915 reroute = $local_part@$1
17916 .endd
17917
17918 .option timeout iplookup time 5s
17919 This specifies the amount of time to wait for a response from the remote
17920 machine. The same timeout is used for the &[connect()]& function for a TCP
17921 call. It does not apply to UDP.
17922
17923
17924
17925
17926 . ////////////////////////////////////////////////////////////////////////////
17927 . ////////////////////////////////////////////////////////////////////////////
17928
17929 .chapter "The manualroute router" "CHID7"
17930 .scindex IIDmanrou1 "&(manualroute)& router"
17931 .scindex IIDmanrou2 "routers" "&(manualroute)&"
17932 .cindex "domain" "manually routing"
17933 The &(manualroute)& router is so-called because it provides a way of manually
17934 routing an address according to its domain. It is mainly used when you want to
17935 route addresses to remote hosts according to your own rules, bypassing the
17936 normal DNS routing that looks up MX records. However, &(manualroute)& can also
17937 route to local transports, a facility that may be useful if you want to save
17938 messages for dial-in hosts in local files.
17939
17940 The &(manualroute)& router compares a list of domain patterns with the domain
17941 it is trying to route. If there is no match, the router declines. Each pattern
17942 has associated with it a list of hosts and some other optional data, which may
17943 include a transport. The combination of a pattern and its data is called a
17944 &"routing rule"&. For patterns that do not have an associated transport, the
17945 generic &%transport%& option must specify a transport, unless the router is
17946 being used purely for verification (see &%verify_only%&).
17947
17948 .vindex "&$host$&"
17949 In the case of verification, matching the domain pattern is sufficient for the
17950 router to accept the address. When actually routing an address for delivery,
17951 an address that matches a domain pattern is queued for the associated
17952 transport. If the transport is not a local one, a host list must be associated
17953 with the pattern; IP addresses are looked up for the hosts, and these are
17954 passed to the transport along with the mail address. For local transports, a
17955 host list is optional. If it is present, it is passed in &$host$& as a single
17956 text string.
17957
17958 The list of routing rules can be provided as an inline string in
17959 &%route_list%&, or the data can be obtained by looking up the domain in a file
17960 or database by setting &%route_data%&. Only one of these settings may appear in
17961 any one instance of &(manualroute)&. The format of routing rules is described
17962 below, following the list of private options.
17963
17964
17965 .section "Private options for manualroute" "SECTprioptman"
17966
17967 .cindex "options" "&(manualroute)& router"
17968 The private options for the &(manualroute)& router are as follows:
17969
17970 .option host_all_ignored manualroute string defer
17971 See &%host_find_failed%&.
17972
17973 .option host_find_failed manualroute string freeze
17974 This option controls what happens when &(manualroute)& tries to find an IP
17975 address for a host, and the host does not exist. The option can be set to one
17976 of the following values:
17977 .code
17978 decline
17979 defer
17980 fail
17981 freeze
17982 ignore
17983 pass
17984 .endd
17985 The default (&"freeze"&) assumes that this state is a serious configuration
17986 error. The difference between &"pass"& and &"decline"& is that the former
17987 forces the address to be passed to the next router (or the router defined by
17988 &%pass_router%&),
17989 .oindex "&%more%&"
17990 overriding &%no_more%&, whereas the latter passes the address to the next
17991 router only if &%more%& is true.
17992
17993 The value &"ignore"& causes Exim to completely ignore a host whose IP address
17994 cannot be found. If all the hosts in the list are ignored, the behaviour is
17995 controlled by the &%host_all_ignored%& option. This takes the same values
17996 as &%host_find_failed%&, except that it cannot be set to &"ignore"&.
17997
17998 The &%host_find_failed%& option applies only to a definite &"does not exist"&
17999 state; if a host lookup gets a temporary error, delivery is deferred unless the
18000 generic &%pass_on_timeout%& option is set.
18001
18002
18003 .option hosts_randomize manualroute boolean false
18004 .cindex "randomized host list"
18005 .cindex "host" "list of; randomized"
18006 If this option is set, the order of the items in a host list in a routing rule
18007 is randomized each time the list is used, unless an option in the routing rule
18008 overrides (see below). Randomizing the order of a host list can be used to do
18009 crude load sharing. However, if more than one mail address is routed by the
18010 same router to the same host list, the host lists are considered to be the same
18011 (even though they may be randomized into different orders) for the purpose of
18012 deciding whether to batch the deliveries into a single SMTP transaction.
18013
18014 When &%hosts_randomize%& is true, a host list may be split
18015 into groups whose order is separately randomized. This makes it possible to
18016 set up MX-like behaviour. The boundaries between groups are indicated by an
18017 item that is just &`+`& in the host list. For example:
18018 .code
18019 route_list = * host1:host2:host3:+:host4:host5
18020 .endd
18021 The order of the first three hosts and the order of the last two hosts is
18022 randomized for each use, but the first three always end up before the last two.
18023 If &%hosts_randomize%& is not set, a &`+`& item in the list is ignored. If a
18024 randomized host list is passed to an &(smtp)& transport that also has
18025 &%hosts_randomize set%&, the list is not re-randomized.
18026
18027
18028 .option route_data manualroute string&!! unset
18029 If this option is set, it must expand to yield the data part of a routing rule.
18030 Typically, the expansion string includes a lookup based on the domain. For
18031 example:
18032 .code
18033 route_data = ${lookup{$domain}dbm{/etc/routes}}
18034 .endd
18035 If the expansion is forced to fail, or the result is an empty string, the
18036 router declines. Other kinds of expansion failure cause delivery to be
18037 deferred.
18038
18039
18040 .option route_list manualroute "string list" unset
18041 This string is a list of routing rules, in the form defined below. Note that,
18042 unlike most string lists, the items are separated by semicolons. This is so
18043 that they may contain colon-separated host lists.
18044
18045
18046 .option same_domain_copy_routing manualroute boolean false
18047 .cindex "address" "copying routing"
18048 Addresses with the same domain are normally routed by the &(manualroute)&
18049 router to the same list of hosts. However, this cannot be presumed, because the
18050 router options and preconditions may refer to the local part of the address. By
18051 default, therefore, Exim routes each address in a message independently. DNS
18052 servers run caches, so repeated DNS lookups are not normally expensive, and in
18053 any case, personal messages rarely have more than a few recipients.
18054
18055 If you are running mailing lists with large numbers of subscribers at the same
18056 domain, and you are using a &(manualroute)& router which is independent of the
18057 local part, you can set &%same_domain_copy_routing%& to bypass repeated DNS
18058 lookups for identical domains in one message. In this case, when
18059 &(manualroute)& routes an address to a remote transport, any other unrouted
18060 addresses in the message that have the same domain are automatically given the
18061 same routing without processing them independently. However, this is only done
18062 if &%headers_add%& and &%headers_remove%& are unset.
18063
18064
18065
18066
18067 .section "Routing rules in route_list" "SECID120"
18068 The value of &%route_list%& is a string consisting of a sequence of routing
18069 rules, separated by semicolons. If a semicolon is needed in a rule, it can be
18070 entered as two semicolons. Alternatively, the list separator can be changed as
18071 described (for colon-separated lists) in section &<<SECTlistconstruct>>&.
18072 Empty rules are ignored. The format of each rule is
18073 .display
18074 <&'domain pattern'&>  <&'list of hosts'&>  <&'options'&>
18075 .endd
18076 The following example contains two rules, each with a simple domain pattern and
18077 no options:
18078 .code
18079 route_list = \
18080   dict.ref.example  mail-1.ref.example:mail-2.ref.example ; \
18081   thes.ref.example  mail-3.ref.example:mail-4.ref.example
18082 .endd
18083 The three parts of a rule are separated by white space. The pattern and the
18084 list of hosts can be enclosed in quotes if necessary, and if they are, the
18085 usual quoting rules apply. Each rule in a &%route_list%& must start with a
18086 single domain pattern, which is the only mandatory item in the rule. The
18087 pattern is in the same format as one item in a domain list (see section
18088 &<<SECTdomainlist>>&),
18089 except that it may not be the name of an interpolated file.
18090 That is, it may be wildcarded, or a regular expression, or a file or database
18091 lookup (with semicolons doubled, because of the use of semicolon as a separator
18092 in a &%route_list%&).
18093
18094 The rules in &%route_list%& are searched in order until one of the patterns
18095 matches the domain that is being routed. The list of hosts and then options are
18096 then used as described below. If there is no match, the router declines. When
18097 &%route_list%& is set, &%route_data%& must not be set.
18098
18099
18100
18101 .section "Routing rules in route_data" "SECID121"
18102 The use of &%route_list%& is convenient when there are only a small number of
18103 routing rules. For larger numbers, it is easier to use a file or database to
18104 hold the routing information, and use the &%route_data%& option instead.
18105 The value of &%route_data%& is a list of hosts, followed by (optional) options.
18106 Most commonly, &%route_data%& is set as a string that contains an
18107 expansion lookup. For example, suppose we place two routing rules in a file
18108 like this:
18109 .code
18110 dict.ref.example:  mail-1.ref.example:mail-2.ref.example
18111 thes.ref.example:  mail-3.ref.example:mail-4.ref.example
18112 .endd
18113 This data can be accessed by setting
18114 .code
18115 route_data = ${lookup{$domain}lsearch{/the/file/name}}
18116 .endd
18117 Failure of the lookup results in an empty string, causing the router to
18118 decline. However, you do not have to use a lookup in &%route_data%&. The only
18119 requirement is that the result of expanding the string is a list of hosts,
18120 possibly followed by options, separated by white space. The list of hosts must
18121 be enclosed in quotes if it contains white space.
18122
18123
18124
18125
18126 .section "Format of the list of hosts" "SECID122"
18127 A list of hosts, whether obtained via &%route_data%& or &%route_list%&, is
18128 always separately expanded before use. If the expansion fails, the router
18129 declines. The result of the expansion must be a colon-separated list of names
18130 and/or IP addresses, optionally also including ports. The format of each item
18131 in the list is described in the next section. The list separator can be changed
18132 as described in section &<<SECTlistconstruct>>&.
18133
18134 If the list of hosts was obtained from a &%route_list%& item, the following
18135 variables are set during its expansion:
18136
18137 .ilist
18138 .cindex "numerical variables (&$1$& &$2$&  etc)" "in &(manualroute)& router"
18139 If the domain was matched against a regular expression, the numeric variables
18140 &$1$&, &$2$&, etc. may be set. For example:
18141 .code
18142 route_list = ^domain(\d+)   host-$1.text.example
18143 .endd
18144 .next
18145 &$0$& is always set to the entire domain.
18146 .next
18147 &$1$& is also set when partial matching is done in a file lookup.
18148
18149 .next
18150 .vindex "&$value$&"
18151 If the pattern that matched the domain was a lookup item, the data that was
18152 looked up is available in the expansion variable &$value$&. For example:
18153 .code
18154 route_list = lsearch;;/some/file.routes  $value
18155 .endd
18156 .endlist
18157
18158 Note the doubling of the semicolon in the pattern that is necessary because
18159 semicolon is the default route list separator.
18160
18161
18162
18163 .section "Format of one host item" "SECTformatonehostitem"
18164 Each item in the list of hosts is either a host name or an IP address,
18165 optionally with an attached port number. When no port is given, an IP address
18166 is not enclosed in brackets. When a port is specified, it overrides the port
18167 specification on the transport. The port is separated from the name or address
18168 by a colon. This leads to some complications:
18169
18170 .ilist
18171 Because colon is the default separator for the list of hosts, either
18172 the colon that specifies a port must be doubled, or the list separator must
18173 be changed. The following two examples have the same effect:
18174 .code
18175 route_list = * "host1.tld::1225 : host2.tld::1226"
18176 route_list = * "<+ host1.tld:1225 + host2.tld:1226"
18177 .endd
18178 .next
18179 When IPv6 addresses are involved, it gets worse, because they contain
18180 colons of their own. To make this case easier, it is permitted to
18181 enclose an IP address (either v4 or v6) in square brackets if a port
18182 number follows. For example:
18183 .code
18184 route_list = * "</ [10.1.1.1]:1225 / [::1]:1226"
18185 .endd
18186 .endlist
18187
18188 .section "How the list of hosts is used" "SECThostshowused"
18189 When an address is routed to an &(smtp)& transport by &(manualroute)&, each of
18190 the hosts is tried, in the order specified, when carrying out the SMTP
18191 delivery. However, the order can be changed by setting the &%hosts_randomize%&
18192 option, either on the router (see section &<<SECTprioptman>>& above), or on the
18193 transport.
18194
18195 Hosts may be listed by name or by IP address. An unadorned name in the list of
18196 hosts is interpreted as a host name. A name that is followed by &`/MX`& is
18197 interpreted as an indirection to a sublist of hosts obtained by looking up MX
18198 records in the DNS. For example:
18199 .code
18200 route_list = *  x.y.z:p.q.r/MX:e.f.g
18201 .endd
18202 If this feature is used with a port specifier, the port must come last. For
18203 example:
18204 .code
18205 route_list = *  dom1.tld/mx::1225
18206 .endd
18207 If the &%hosts_randomize%& option is set, the order of the items in the list is
18208 randomized before any lookups are done. Exim then scans the list; for any name
18209 that is not followed by &`/MX`& it looks up an IP address. If this turns out to
18210 be an interface on the local host and the item is not the first in the list,
18211 Exim discards it and any subsequent items. If it is the first item, what
18212 happens is controlled by the
18213 .oindex "&%self%&" "in &(manualroute)& router"
18214 &%self%& option of the router.
18215
18216 A name on the list that is followed by &`/MX`& is replaced with the list of
18217 hosts obtained by looking up MX records for the name. This is always a DNS
18218 lookup; the &%bydns%& and &%byname%& options (see section &<<SECThowoptused>>&
18219 below) are not relevant here. The order of these hosts is determined by the
18220 preference values in the MX records, according to the usual rules. Because
18221 randomizing happens before the MX lookup, it does not affect the order that is
18222 defined by MX preferences.
18223
18224 If the local host is present in the sublist obtained from MX records, but is
18225 not the most preferred host in that list, it and any equally or less
18226 preferred hosts are removed before the sublist is inserted into the main list.
18227
18228 If the local host is the most preferred host in the MX list, what happens
18229 depends on where in the original list of hosts the &`/MX`& item appears. If it
18230 is not the first item (that is, there are previous hosts in the main list),
18231 Exim discards this name and any subsequent items in the main list.
18232
18233 If the MX item is first in the list of hosts, and the local host is the
18234 most preferred host, what happens is controlled by the &%self%& option of the
18235 router.
18236
18237 DNS failures when lookup up the MX records are treated in the same way as DNS
18238 failures when looking up IP addresses: &%pass_on_timeout%& and
18239 &%host_find_failed%& are used when relevant.
18240
18241 The generic &%ignore_target_hosts%& option applies to all hosts in the list,
18242 whether obtained from an MX lookup or not.
18243
18244
18245
18246 .section "How the options are used" "SECThowoptused"
18247 The options are a sequence of words; in practice no more than three are ever
18248 present. One of the words can be the name of a transport; this overrides the
18249 &%transport%& option on the router for this particular routing rule only. The
18250 other words (if present) control randomization of the list of hosts on a
18251 per-rule basis, and how the IP addresses of the hosts are to be found when
18252 routing to a remote transport. These options are as follows:
18253
18254 .ilist
18255 &%randomize%&: randomize the order of the hosts in this list, overriding the
18256 setting of &%hosts_randomize%& for this routing rule only.
18257 .next
18258 &%no_randomize%&: do not randomize the order of the hosts in this list,
18259 overriding the setting of &%hosts_randomize%& for this routing rule only.
18260 .next
18261 &%byname%&: use &[getipnodebyname()]& (&[gethostbyname()]& on older systems) to
18262 find IP addresses. This function may ultimately cause a DNS lookup, but it may
18263 also look in &_/etc/hosts_& or other sources of information.
18264 .next
18265 &%bydns%&: look up address records for the hosts directly in the DNS; fail if
18266 no address records are found. If there is a temporary DNS error (such as a
18267 timeout), delivery is deferred.
18268 .endlist
18269
18270 For example:
18271 .code
18272 route_list = domain1  host1:host2:host3  randomize bydns;\
18273              domain2  host4:host5
18274 .endd
18275 If neither &%byname%& nor &%bydns%& is given, Exim behaves as follows: First, a
18276 DNS lookup is done. If this yields anything other than HOST_NOT_FOUND, that
18277 result is used. Otherwise, Exim goes on to try a call to &[getipnodebyname()]&
18278 or &[gethostbyname()]&, and the result of the lookup is the result of that
18279 call.
18280
18281 &*Warning*&: It has been discovered that on some systems, if a DNS lookup
18282 called via &[getipnodebyname()]& times out, HOST_NOT_FOUND is returned
18283 instead of TRY_AGAIN. That is why the default action is to try a DNS
18284 lookup first. Only if that gives a definite &"no such host"& is the local
18285 function called.
18286
18287
18288
18289 If no IP address for a host can be found, what happens is controlled by the
18290 &%host_find_failed%& option.
18291
18292 .vindex "&$host$&"
18293 When an address is routed to a local transport, IP addresses are not looked up.
18294 The host list is passed to the transport in the &$host$& variable.
18295
18296
18297
18298 .section "Manualroute examples" "SECID123"
18299 In some of the examples that follow, the presence of the &%remote_smtp%&
18300 transport, as defined in the default configuration file, is assumed:
18301
18302 .ilist
18303 .cindex "smart host" "example router"
18304 The &(manualroute)& router can be used to forward all external mail to a
18305 &'smart host'&. If you have set up, in the main part of the configuration, a
18306 named domain list that contains your local domains, for example:
18307 .code
18308 domainlist local_domains = my.domain.example
18309 .endd
18310 You can arrange for all other domains to be routed to a smart host by making
18311 your first router something like this:
18312 .code
18313 smart_route:
18314   driver = manualroute
18315   domains = !+local_domains
18316   transport = remote_smtp
18317   route_list = * smarthost.ref.example
18318 .endd
18319 This causes all non-local addresses to be sent to the single host
18320 &'smarthost.ref.example'&. If a colon-separated list of smart hosts is given,
18321 they are tried in order
18322 (but you can use &%hosts_randomize%& to vary the order each time).
18323 Another way of configuring the same thing is this:
18324 .code
18325 smart_route:
18326   driver = manualroute
18327   transport = remote_smtp
18328   route_list = !+local_domains  smarthost.ref.example
18329 .endd
18330 There is no difference in behaviour between these two routers as they stand.
18331 However, they behave differently if &%no_more%& is added to them. In the first
18332 example, the router is skipped if the domain does not match the &%domains%&
18333 precondition; the following router is always tried. If the router runs, it
18334 always matches the domain and so can never decline. Therefore, &%no_more%&
18335 would have no effect. In the second case, the router is never skipped; it
18336 always runs. However, if it doesn't match the domain, it declines. In this case
18337 &%no_more%& would prevent subsequent routers from running.
18338
18339 .next
18340 .cindex "mail hub example"
18341 A &'mail hub'& is a host which receives mail for a number of domains via MX
18342 records in the DNS and delivers it via its own private routing mechanism. Often
18343 the final destinations are behind a firewall, with the mail hub being the one
18344 machine that can connect to machines both inside and outside the firewall. The
18345 &(manualroute)& router is usually used on a mail hub to route incoming messages
18346 to the correct hosts. For a small number of domains, the routing can be inline,
18347 using the &%route_list%& option, but for a larger number a file or database
18348 lookup is easier to manage.
18349
18350 If the domain names are in fact the names of the machines to which the mail is
18351 to be sent by the mail hub, the configuration can be quite simple. For
18352 example:
18353 .code
18354 hub_route:
18355   driver = manualroute
18356   transport = remote_smtp
18357   route_list = *.rhodes.tvs.example  $domain
18358 .endd
18359 This configuration routes domains that match &`*.rhodes.tvs.example`& to hosts
18360 whose names are the same as the mail domains. A similar approach can be taken
18361 if the host name can be obtained from the domain name by a string manipulation
18362 that the expansion facilities can handle. Otherwise, a lookup based on the
18363 domain can be used to find the host:
18364 .code
18365 through_firewall:
18366   driver = manualroute
18367   transport = remote_smtp
18368   route_data = ${lookup {$domain} cdb {/internal/host/routes}}
18369 .endd
18370 The result of the lookup must be the name or IP address of the host (or
18371 hosts) to which the address is to be routed. If the lookup fails, the route
18372 data is empty, causing the router to decline. The address then passes to the
18373 next router.
18374
18375 .next
18376 .cindex "batched SMTP output example"
18377 .cindex "SMTP" "batched outgoing; example"
18378 You can use &(manualroute)& to deliver messages to pipes or files in batched
18379 SMTP format for onward transportation by some other means. This is one way of
18380 storing mail for a dial-up host when it is not connected. The route list entry
18381 can be as simple as a single domain name in a configuration like this:
18382 .code
18383 save_in_file:
18384   driver = manualroute
18385   transport = batchsmtp_appendfile
18386   route_list = saved.domain.example
18387 .endd
18388 though often a pattern is used to pick up more than one domain. If there are
18389 several domains or groups of domains with different transport requirements,
18390 different transports can be listed in the routing information:
18391 .code
18392 save_in_file:
18393   driver = manualroute
18394   route_list = \
18395     *.saved.domain1.example  $domain  batch_appendfile; \
18396     *.saved.domain2.example  \
18397       ${lookup{$domain}dbm{/domain2/hosts}{$value}fail} \
18398       batch_pipe
18399 .endd
18400 .vindex "&$domain$&"
18401 .vindex "&$host$&"
18402 The first of these just passes the domain in the &$host$& variable, which
18403 doesn't achieve much (since it is also in &$domain$&), but the second does a
18404 file lookup to find a value to pass, causing the router to decline to handle
18405 the address if the lookup fails.
18406
18407 .next
18408 .cindex "UUCP" "example of router for"
18409 Routing mail directly to UUCP software is a specific case of the use of
18410 &(manualroute)& in a gateway to another mail environment. This is an example of
18411 one way it can be done:
18412 .code
18413 # Transport
18414 uucp:
18415   driver = pipe
18416   user = nobody
18417   command = /usr/local/bin/uux -r - \
18418     ${substr_-5:$host}!rmail ${local_part}
18419   return_fail_output = true
18420
18421 # Router
18422 uucphost:
18423   transport = uucp
18424   driver = manualroute
18425   route_data = \
18426     ${lookup{$domain}lsearch{/usr/local/exim/uucphosts}}
18427 .endd
18428 The file &_/usr/local/exim/uucphosts_& contains entries like
18429 .code
18430 darksite.ethereal.example:           darksite.UUCP
18431 .endd
18432 It can be set up more simply without adding and removing &".UUCP"& but this way
18433 makes clear the distinction between the domain name
18434 &'darksite.ethereal.example'& and the UUCP host name &'darksite'&.
18435 .endlist
18436 .ecindex IIDmanrou1
18437 .ecindex IIDmanrou2
18438
18439
18440
18441
18442
18443
18444
18445
18446 . ////////////////////////////////////////////////////////////////////////////
18447 . ////////////////////////////////////////////////////////////////////////////
18448
18449 .chapter "The queryprogram router" "CHAPdriverlast"
18450 .scindex IIDquerou1 "&(queryprogram)& router"
18451 .scindex IIDquerou2 "routers" "&(queryprogram)&"
18452 .cindex "routing" "by external program"
18453 The &(queryprogram)& router routes an address by running an external command
18454 and acting on its output. This is an expensive way to route, and is intended
18455 mainly for use in lightly-loaded systems, or for performing experiments.
18456 However, if it is possible to use the precondition options (&%domains%&,
18457 &%local_parts%&, etc) to skip this router for most addresses, it could sensibly
18458 be used in special cases, even on a busy host. There are the following private
18459 options:
18460 .cindex "options" "&(queryprogram)& router"
18461
18462 .option command queryprogram string&!! unset
18463 This option must be set. It specifies the command that is to be run. The
18464 command is split up into a command name and arguments, and then each is
18465 expanded separately (exactly as for a &(pipe)& transport, described in chapter
18466 &<<CHAPpipetransport>>&).
18467
18468
18469 .option command_group queryprogram string unset
18470 .cindex "gid (group id)" "in &(queryprogram)& router"
18471 This option specifies a gid to be set when running the command while routing an
18472 address for deliver. It must be set if &%command_user%& specifies a numerical
18473 uid. If it begins with a digit, it is interpreted as the numerical value of the
18474 gid. Otherwise it is looked up using &[getgrnam()]&.
18475
18476
18477 .option command_user queryprogram string unset
18478 .cindex "uid (user id)" "for &(queryprogram)&"
18479 This option must be set. It specifies the uid which is set when running the
18480 command while routing an address for delivery. If the value begins with a digit,
18481 it is interpreted as the numerical value of the uid. Otherwise, it is looked up
18482 using &[getpwnam()]& to obtain a value for the uid and, if &%command_group%& is
18483 not set, a value for the gid also.
18484
18485 &*Warning:*& Changing uid and gid is possible only when Exim is running as
18486 root, which it does during a normal delivery in a conventional configuration.
18487 However, when an address is being verified during message reception, Exim is
18488 usually running as the Exim user, not as root. If the &(queryprogram)& router
18489 is called from a non-root process, Exim cannot change uid or gid before running
18490 the command. In this circumstance the command runs under the current uid and
18491 gid.
18492
18493
18494 .option current_directory queryprogram string /
18495 This option specifies an absolute path which is made the current directory
18496 before running the command.
18497
18498
18499 .option timeout queryprogram time 1h
18500 If the command does not complete within the timeout period, its process group
18501 is killed and the message is frozen. A value of zero time specifies no
18502 timeout.
18503
18504
18505 The standard output of the command is connected to a pipe, which is read when
18506 the command terminates. It should consist of a single line of output,
18507 containing up to five fields, separated by white space. The maximum length of
18508 the line is 1023 characters. Longer lines are silently truncated. The first
18509 field is one of the following words (case-insensitive):
18510
18511 .ilist
18512 &'Accept'&: routing succeeded; the remaining fields specify what to do (see
18513 below).
18514 .next
18515 &'Decline'&: the router declines; pass the address to the next router, unless
18516 &%no_more%& is set.
18517 .next
18518 &'Fail'&: routing failed; do not pass the address to any more routers. Any
18519 subsequent text on the line is an error message. If the router is run as part
18520 of address verification during an incoming SMTP message, the message is
18521 included in the SMTP response.
18522 .next
18523 &'Defer'&: routing could not be completed at this time; try again later. Any
18524 subsequent text on the line is an error message which is logged. It is not
18525 included in any SMTP response.
18526 .next
18527 &'Freeze'&: the same as &'defer'&, except that the message is frozen.
18528 .next
18529 &'Pass'&: pass the address to the next router (or the router specified by
18530 &%pass_router%&), overriding &%no_more%&.
18531 .next
18532 &'Redirect'&: the message is redirected. The remainder of the line is a list of
18533 new addresses, which are routed independently, starting with the first router,
18534 or the router specified by &%redirect_router%&, if set.
18535 .endlist
18536
18537 When the first word is &'accept'&, the remainder of the line consists of a
18538 number of keyed data values, as follows (split into two lines here, to fit on
18539 the page):
18540 .code
18541 ACCEPT TRANSPORT=<transport> HOSTS=<list of hosts>
18542 LOOKUP=byname|bydns DATA=<text>
18543 .endd
18544 The data items can be given in any order, and all are optional. If no transport
18545 is included, the transport specified by the generic &%transport%& option is
18546 used. The list of hosts and the lookup type are needed only if the transport is
18547 an &(smtp)& transport that does not itself supply a list of hosts.
18548
18549 The format of the list of hosts is the same as for the &(manualroute)& router.
18550 As well as host names and IP addresses with optional port numbers, as described
18551 in section &<<SECTformatonehostitem>>&, it may contain names followed by
18552 &`/MX`& to specify sublists of hosts that are obtained by looking up MX records
18553 (see section &<<SECThostshowused>>&).
18554
18555 If the lookup type is not specified, Exim behaves as follows when trying to
18556 find an IP address for each host: First, a DNS lookup is done. If this yields
18557 anything other than HOST_NOT_FOUND, that result is used. Otherwise, Exim
18558 goes on to try a call to &[getipnodebyname()]& or &[gethostbyname()]&, and the
18559 result of the lookup is the result of that call.
18560
18561 .vindex "&$address_data$&"
18562 If the DATA field is set, its value is placed in the &$address_data$&
18563 variable. For example, this return line
18564 .code
18565 accept hosts=x1.y.example:x2.y.example data="rule1"
18566 .endd
18567 routes the address to the default transport, passing a list of two hosts. When
18568 the transport runs, the string &"rule1"& is in &$address_data$&.
18569 .ecindex IIDquerou1
18570 .ecindex IIDquerou2
18571
18572
18573
18574
18575 . ////////////////////////////////////////////////////////////////////////////
18576 . ////////////////////////////////////////////////////////////////////////////
18577
18578 .chapter "The redirect router" "CHAPredirect"
18579 .scindex IIDredrou1 "&(redirect)& router"
18580 .scindex IIDredrou2 "routers" "&(redirect)&"
18581 .cindex "alias file" "in a &(redirect)& router"
18582 .cindex "address redirection" "&(redirect)& router"
18583 The &(redirect)& router handles several kinds of address redirection. Its most
18584 common uses are for resolving local part aliases from a central alias file
18585 (usually called &_/etc/aliases_&) and for handling users' personal &_.forward_&
18586 files, but it has many other potential uses. The incoming address can be
18587 redirected in several different ways:
18588
18589 .ilist
18590 It can be replaced by one or more new addresses which are themselves routed
18591 independently.
18592 .next
18593 It can be routed to be delivered to a given file or directory.
18594 .next
18595 It can be routed to be delivered to a specified pipe command.
18596 .next
18597 It can cause an automatic reply to be generated.
18598 .next
18599 It can be forced to fail, optionally with a custom error message.
18600 .next
18601 It can be temporarily deferred, optionally with a custom message.
18602 .next
18603 It can be discarded.
18604 .endlist
18605
18606 The generic &%transport%& option must not be set for &(redirect)& routers.
18607 However, there are some private options which define transports for delivery to
18608 files and pipes, and for generating autoreplies. See the &%file_transport%&,
18609 &%pipe_transport%& and &%reply_transport%& descriptions below.
18610
18611
18612
18613 .section "Redirection data" "SECID124"
18614 The router operates by interpreting a text string which it obtains either by
18615 expanding the contents of the &%data%& option, or by reading the entire
18616 contents of a file whose name is given in the &%file%& option. These two
18617 options are mutually exclusive. The first is commonly used for handling system
18618 aliases, in a configuration like this:
18619 .code
18620 system_aliases:
18621   driver = redirect
18622   data = ${lookup{$local_part}lsearch{/etc/aliases}}
18623 .endd
18624 If the lookup fails, the expanded string in this example is empty. When the
18625 expansion of &%data%& results in an empty string, the router declines. A forced
18626 expansion failure also causes the router to decline; other expansion failures
18627 cause delivery to be deferred.
18628
18629 A configuration using &%file%& is commonly used for handling users'
18630 &_.forward_& files, like this:
18631 .code
18632 userforward:
18633   driver = redirect
18634   check_local_user
18635   file = $home/.forward
18636   no_verify
18637 .endd
18638 If the file does not exist, or causes no action to be taken (for example, it is
18639 empty or consists only of comments), the router declines. &*Warning*&: This
18640 is not the case when the file contains syntactically valid items that happen to
18641 yield empty addresses, for example, items containing only RFC 2822 address
18642 comments.
18643
18644
18645
18646 .section "Forward files and address verification" "SECID125"
18647 .cindex "address redirection" "while verifying"
18648 It is usual to set &%no_verify%& on &(redirect)& routers which handle users'
18649 &_.forward_& files, as in the example above. There are two reasons for this:
18650
18651 .ilist
18652 When Exim is receiving an incoming SMTP message from a remote host, it is
18653 running under the Exim uid, not as root. Exim is unable to change uid to read
18654 the file as the user, and it may not be able to read it as the Exim user. So in
18655 practice the router may not be able to operate.
18656 .next
18657 However, even when the router can operate, the existence of a &_.forward_& file
18658 is unimportant when verifying an address. What should be checked is whether the
18659 local part is a valid user name or not. Cutting out the redirection processing
18660 saves some resources.
18661 .endlist
18662
18663
18664
18665
18666
18667
18668 .section "Interpreting redirection data" "SECID126"
18669 .cindex "Sieve filter" "specifying in redirection data"
18670 .cindex "filter" "specifying in redirection data"
18671 The contents of the data string, whether obtained from &%data%& or &%file%&,
18672 can be interpreted in two different ways:
18673
18674 .ilist
18675 If the &%allow_filter%& option is set true, and the data begins with the text
18676 &"#Exim filter"& or &"#Sieve filter"&, it is interpreted as a list of
18677 &'filtering'& instructions in the form of an Exim or Sieve filter file,
18678 respectively. Details of the syntax and semantics of filter files are described
18679 in a separate document entitled &'Exim's interfaces to mail filtering'&; this
18680 document is intended for use by end users.
18681 .next
18682 Otherwise, the data must be a comma-separated list of redirection items, as
18683 described in the next section.
18684 .endlist
18685
18686 When a message is redirected to a file (a &"mail folder"&), the file name given
18687 in a non-filter redirection list must always be an absolute path. A filter may
18688 generate a relative path &-- how this is handled depends on the transport's
18689 configuration. See section &<<SECTfildiropt>>& for a discussion of this issue
18690 for the &(appendfile)& transport.
18691
18692
18693
18694 .section "Items in a non-filter redirection list" "SECTitenonfilred"
18695 .cindex "address redirection" "non-filter list items"
18696 When the redirection data is not an Exim or Sieve filter, for example, if it
18697 comes from a conventional alias or forward file, it consists of a list of
18698 addresses, file names, pipe commands, or certain special items (see section
18699 &<<SECTspecitredli>>& below). The special items can be individually enabled or
18700 disabled by means of options whose names begin with &%allow_%& or &%forbid_%&,
18701 depending on their default values. The items in the list are separated by
18702 commas or newlines.
18703 If a comma is required in an item, the entire item must be enclosed in double
18704 quotes.
18705
18706 Lines starting with a # character are comments, and are ignored, and # may
18707 also appear following a comma, in which case everything between the # and the
18708 next newline character is ignored.
18709
18710 If an item is entirely enclosed in double quotes, these are removed. Otherwise
18711 double quotes are retained because some forms of mail address require their use
18712 (but never to enclose the entire address). In the following description,
18713 &"item"& refers to what remains after any surrounding double quotes have been
18714 removed.
18715
18716 .vindex "&$local_part$&"
18717 &*Warning*&: If you use an Exim expansion to construct a redirection address,
18718 and the expansion contains a reference to &$local_part$&, you should make use
18719 of the &%quote_local_part%& expansion operator, in case the local part contains
18720 special characters. For example, to redirect all mail for the domain
18721 &'obsolete.example'&, retaining the existing local part, you could use this
18722 setting:
18723 .code
18724 data = ${quote_local_part:$local_part}@newdomain.example
18725 .endd
18726
18727
18728 .section "Redirecting to a local mailbox" "SECTredlocmai"
18729 .cindex "routing" "loops in"
18730 .cindex "loop" "while routing, avoidance of"
18731 .cindex "address redirection" "to local mailbox"
18732 A redirection item may safely be the same as the address currently under
18733 consideration. This does not cause a routing loop, because a router is
18734 automatically skipped if any ancestor of the address that is being processed
18735 is the same as the current address and was processed by the current router.
18736 Such an address is therefore passed to the following routers, so it is handled
18737 as if there were no redirection. When making this loop-avoidance test, the
18738 complete local part, including any prefix or suffix, is used.
18739
18740 .cindex "address redirection" "local part without domain"
18741 Specifying the same local part without a domain is a common usage in personal
18742 filter files when the user wants to have messages delivered to the local
18743 mailbox and also forwarded elsewhere. For example, the user whose login is
18744 &'cleo'& might have a &_.forward_& file containing this:
18745 .code
18746 cleo, cleopatra@egypt.example
18747 .endd
18748 .cindex "backslash in alias file"
18749 .cindex "alias file" "backslash in"
18750 For compatibility with other MTAs, such unqualified local parts may be
18751 preceded by &"\"&, but this is not a requirement for loop prevention. However,
18752 it does make a difference if more than one domain is being handled
18753 synonymously.
18754
18755 If an item begins with &"\"& and the rest of the item parses as a valid RFC
18756 2822 address that does not include a domain, the item is qualified using the
18757 domain of the incoming address. In the absence of a leading &"\"&, unqualified
18758 addresses are qualified using the value in &%qualify_recipient%&, but you can
18759 force the incoming domain to be used by setting &%qualify_preserve_domain%&.
18760
18761 Care must be taken if there are alias names for local users.
18762 Consider an MTA handling a single local domain where the system alias file
18763 contains:
18764 .code
18765 Sam.Reman: spqr
18766 .endd
18767 Now suppose that Sam (whose login id is &'spqr'&) wants to save copies of
18768 messages in the local mailbox, and also forward copies elsewhere. He creates
18769 this forward file:
18770 .code
18771 Sam.Reman, spqr@reme.elsewhere.example
18772 .endd
18773 With these settings, an incoming message addressed to &'Sam.Reman'& fails. The
18774 &(redirect)& router for system aliases does not process &'Sam.Reman'& the
18775 second time round, because it has previously routed it,
18776 and the following routers presumably cannot handle the alias. The forward file
18777 should really contain
18778 .code
18779 spqr, spqr@reme.elsewhere.example
18780 .endd
18781 but because this is such a common error, the &%check_ancestor%& option (see
18782 below) exists to provide a way to get round it. This is normally set on a
18783 &(redirect)& router that is handling users' &_.forward_& files.
18784
18785
18786
18787 .section "Special items in redirection lists" "SECTspecitredli"
18788 In addition to addresses, the following types of item may appear in redirection
18789 lists (that is, in non-filter redirection data):
18790
18791 .ilist
18792 .cindex "pipe" "in redirection list"
18793 .cindex "address redirection" "to pipe"
18794 An item is treated as a pipe command if it begins with &"|"& and does not parse
18795 as a valid RFC 2822 address that includes a domain. A transport for running the
18796 command must be specified by the &%pipe_transport%& option.
18797 Normally, either the router or the transport specifies a user and a group under
18798 which to run the delivery. The default is to use the Exim user and group.
18799
18800 Single or double quotes can be used for enclosing the individual arguments of
18801 the pipe command; no interpretation of escapes is done for single quotes. If
18802 the command contains a comma character, it is necessary to put the whole item
18803 in double quotes, for example:
18804 .code
18805 "|/some/command ready,steady,go"
18806 .endd
18807 since items in redirection lists are terminated by commas. Do not, however,
18808 quote just the command. An item such as
18809 .code
18810 |"/some/command ready,steady,go"
18811 .endd
18812 is interpreted as a pipe with a rather strange command name, and no arguments.
18813
18814 .new
18815 Note that the above example assumes that the text comes from a lookup source
18816 of some sort, so that the quotes are part of the data.  If composing a
18817 redirect router with a &%data%& option directly specifying this command, the
18818 quotes will be used by the configuration parser to define the extent of one
18819 string, but will not be passed down into the redirect router itself.  There
18820 are two main approaches to get around this: escape quotes to be part of the
18821 data itself, or avoid using this mechanism and instead create a custom
18822 transport with the &%command%& option set and reference that transport from
18823 an &%accept%& router.
18824 .wen
18825
18826 .next
18827 .cindex "file" "in redirection list"
18828 .cindex "address redirection" "to file"
18829 An item is interpreted as a path name if it begins with &"/"& and does not
18830 parse as a valid RFC 2822 address that includes a domain. For example,
18831 .code
18832 /home/world/minbari
18833 .endd
18834 is treated as a file name, but
18835 .code
18836 /s=molari/o=babylon/@x400gate.way
18837 .endd
18838 is treated as an address. For a file name, a transport must be specified using
18839 the &%file_transport%& option. However, if the generated path name ends with a
18840 forward slash character, it is interpreted as a directory name rather than a
18841 file name, and &%directory_transport%& is used instead.
18842
18843 Normally, either the router or the transport specifies a user and a group under
18844 which to run the delivery. The default is to use the Exim user and group.
18845
18846 .cindex "&_/dev/null_&"
18847 However, if a redirection item is the path &_/dev/null_&, delivery to it is
18848 bypassed at a high level, and the log entry shows &"**bypassed**"&
18849 instead of a transport name. In this case the user and group are not used.
18850
18851 .next
18852 .cindex "included address list"
18853 .cindex "address redirection" "included external list"
18854 If an item is of the form
18855 .code
18856 :include:<path name>
18857 .endd
18858 a list of further items is taken from the given file and included at that
18859 point. &*Note*&: Such a file can not be a filter file; it is just an
18860 out-of-line addition to the list. The items in the included list are separated
18861 by commas or newlines and are not subject to expansion. If this is the first
18862 item in an alias list in an &(lsearch)& file, a colon must be used to terminate
18863 the alias name. This example is incorrect:
18864 .code
18865 list1    :include:/opt/lists/list1
18866 .endd
18867 It must be given as
18868 .code
18869 list1:   :include:/opt/lists/list1
18870 .endd
18871 .next
18872 .cindex "address redirection" "to black hole"
18873 Sometimes you want to throw away mail to a particular local part. Making the
18874 &%data%& option expand to an empty string does not work, because that causes
18875 the router to decline. Instead, the alias item
18876 .cindex "black hole"
18877 .cindex "abandoning mail"
18878 &':blackhole:'& can be used. It does what its name implies. No delivery is
18879 done, and no error message is generated. This has the same effect as specifing
18880 &_/dev/null_& as a destination, but it can be independently disabled.
18881
18882 &*Warning*&: If &':blackhole:'& appears anywhere in a redirection list, no
18883 delivery is done for the original local part, even if other redirection items
18884 are present. If you are generating a multi-item list (for example, by reading a
18885 database) and need the ability to provide a no-op item, you must use
18886 &_/dev/null_&.
18887
18888 .next
18889 .cindex "delivery" "forcing failure"
18890 .cindex "delivery" "forcing deferral"
18891 .cindex "failing delivery" "forcing"
18892 .cindex "deferred delivery, forcing"
18893 .cindex "customizing" "failure message"
18894 An attempt to deliver a particular address can be deferred or forced to fail by
18895 redirection items of the form
18896 .code
18897 :defer:
18898 :fail:
18899 .endd
18900 respectively. When a redirection list contains such an item, it applies
18901 to the entire redirection; any other items in the list are ignored. Any
18902 text following &':fail:'& or &':defer:'& is placed in the error text
18903 associated with the failure. For example, an alias file might contain:
18904 .code
18905 X.Employee:  :fail: Gone away, no forwarding address
18906 .endd
18907 In the case of an address that is being verified from an ACL or as the subject
18908 of a
18909 .cindex "VRFY" "error text, display of"
18910 VRFY command, the text is included in the SMTP error response by
18911 default.
18912 .cindex "EXPN" "error text, display of"
18913 The text is not included in the response to an EXPN command. In non-SMTP cases
18914 the text is included in the error message that Exim generates.
18915
18916 .cindex "SMTP" "error codes"
18917 By default, Exim sends a 451 SMTP code for a &':defer:'&, and 550 for
18918 &':fail:'&. However, if the message starts with three digits followed by a
18919 space, optionally followed by an extended code of the form &'n.n.n'&, also
18920 followed by a space, and the very first digit is the same as the default error
18921 code, the code from the message is used instead. If the very first digit is
18922 incorrect, a panic error is logged, and the default code is used. You can
18923 suppress the use of the supplied code in a redirect router by setting the
18924 &%forbid_smtp_code%& option true. In this case, any SMTP code is quietly
18925 ignored.
18926
18927 .vindex "&$acl_verify_message$&"
18928 In an ACL, an explicitly provided message overrides the default, but the
18929 default message is available in the variable &$acl_verify_message$& and can
18930 therefore be included in a custom message if this is desired.
18931
18932 Normally the error text is the rest of the redirection list &-- a comma does
18933 not terminate it &-- but a newline does act as a terminator. Newlines are not
18934 normally present in alias expansions. In &(lsearch)& lookups they are removed
18935 as part of the continuation process, but they may exist in other kinds of
18936 lookup and in &':include:'& files.
18937
18938 During routing for message delivery (as opposed to verification), a redirection
18939 containing &':fail:'& causes an immediate failure of the incoming address,
18940 whereas &':defer:'& causes the message to remain on the queue so that a
18941 subsequent delivery attempt can happen at a later time. If an address is
18942 deferred for too long, it will ultimately fail, because the normal retry
18943 rules still apply.
18944
18945 .next
18946 .cindex "alias file" "exception to default"
18947 Sometimes it is useful to use a single-key search type with a default (see
18948 chapter &<<CHAPfdlookup>>&) to look up aliases. However, there may be a need
18949 for exceptions to the default. These can be handled by aliasing them to
18950 &':unknown:'&. This differs from &':fail:'& in that it causes the &(redirect)&
18951 router to decline, whereas &':fail:'& forces routing to fail. A lookup which
18952 results in an empty redirection list has the same effect.
18953 .endlist
18954
18955
18956 .section "Duplicate addresses" "SECTdupaddr"
18957 .cindex "duplicate addresses"
18958 .cindex "address duplicate, discarding"
18959 .cindex "pipe" "duplicated"
18960 Exim removes duplicate addresses from the list to which it is delivering, so as
18961 to deliver just one copy to each address. This does not apply to deliveries
18962 routed to pipes by different immediate parent addresses, but an indirect
18963 aliasing scheme of the type
18964 .code
18965 pipe:       |/some/command $local_part
18966 localpart1: pipe
18967 localpart2: pipe
18968 .endd
18969 does not work with a message that is addressed to both local parts, because
18970 when the second is aliased to the intermediate local part &"pipe"& it gets
18971 discarded as being the same as a previously handled address. However, a scheme
18972 such as
18973 .code
18974 localpart1: |/some/command $local_part
18975 localpart2: |/some/command $local_part
18976 .endd
18977 does result in two different pipe deliveries, because the immediate parents of
18978 the pipes are distinct.
18979
18980
18981
18982 .section "Repeated redirection expansion" "SECID128"
18983 .cindex "repeated redirection expansion"
18984 .cindex "address redirection" "repeated for each delivery attempt"
18985 When a message cannot be delivered to all of its recipients immediately,
18986 leading to two or more delivery attempts, redirection expansion is carried out
18987 afresh each time for those addresses whose children were not all previously
18988 delivered. If redirection is being used as a mailing list, this can lead to new
18989 members of the list receiving copies of old messages. The &%one_time%& option
18990 can be used to avoid this.
18991
18992
18993 .section "Errors in redirection lists" "SECID129"
18994 .cindex "address redirection" "errors"
18995 If &%skip_syntax_errors%& is set, a malformed address that causes a parsing
18996 error is skipped, and an entry is written to the main log. This may be useful
18997 for mailing lists that are automatically managed. Otherwise, if an error is
18998 detected while generating the list of new addresses, the original address is
18999 deferred. See also &%syntax_errors_to%&.
19000
19001
19002
19003 .section "Private options for the redirect router" "SECID130"
19004
19005 .cindex "options" "&(redirect)& router"
19006 The private options for the &(redirect)& router are as follows:
19007
19008
19009 .option allow_defer redirect boolean false
19010 Setting this option allows the use of &':defer:'& in non-filter redirection
19011 data, or the &%defer%& command in an Exim filter file.
19012
19013
19014 .option allow_fail redirect boolean false
19015 .cindex "failing delivery" "from filter"
19016 If this option is true, the &':fail:'& item can be used in a redirection list,
19017 and the &%fail%& command may be used in an Exim filter file.
19018
19019
19020 .option allow_filter redirect boolean false
19021 .cindex "filter" "enabling use of"
19022 .cindex "Sieve filter" "enabling use of"
19023 Setting this option allows Exim to interpret redirection data that starts with
19024 &"#Exim filter"& or &"#Sieve filter"& as a set of filtering instructions. There
19025 are some features of Exim filter files that some administrators may wish to
19026 lock out; see the &%forbid_filter_%&&'xxx'& options below.
19027
19028 It is also possible to lock out Exim filters or Sieve filters while allowing
19029 the other type; see &%forbid_exim_filter%& and &%forbid_sieve_filter%&.
19030
19031
19032 The filter is run using the uid and gid set by the generic &%user%& and
19033 &%group%& options. These take their defaults from the password data if
19034 &%check_local_user%& is set, so in the normal case of users' personal filter
19035 files, the filter is run as the relevant user. When &%allow_filter%& is set
19036 true, Exim insists that either &%check_local_user%& or &%user%& is set.
19037
19038
19039
19040 .option allow_freeze redirect boolean false
19041 .cindex "freezing messages" "allowing in filter"
19042 Setting this option allows the use of the &%freeze%& command in an Exim filter.
19043 This command is more normally encountered in system filters, and is disabled by
19044 default for redirection filters because it isn't something you usually want to
19045 let ordinary users do.
19046
19047
19048
19049 .option check_ancestor redirect boolean false
19050 This option is concerned with handling generated addresses that are the same
19051 as some address in the list of redirection ancestors of the current address.
19052 Although it is turned off by default in the code, it is set in the default
19053 configuration file for handling users' &_.forward_& files. It is recommended
19054 for this use of the &(redirect)& router.
19055
19056 When &%check_ancestor%& is set, if a generated address (including the domain)
19057 is the same as any ancestor of the current address, it is replaced by a copy of
19058 the current address. This helps in the case where local part A is aliased to B,
19059 and B has a &_.forward_& file pointing back to A. For example, within a single
19060 domain, the local part &"Joe.Bloggs"& is aliased to &"jb"& and
19061 &_&~jb/.forward_& contains:
19062 .code
19063 \Joe.Bloggs, <other item(s)>
19064 .endd
19065 Without the &%check_ancestor%& setting, either local part (&"jb"& or
19066 &"joe.bloggs"&) gets processed once by each router and so ends up as it was
19067 originally. If &"jb"& is the real mailbox name, mail to &"jb"& gets delivered
19068 (having been turned into &"joe.bloggs"& by the &_.forward_& file and back to
19069 &"jb"& by the alias), but mail to &"joe.bloggs"& fails. Setting
19070 &%check_ancestor%& on the &(redirect)& router that handles the &_.forward_&
19071 file prevents it from turning &"jb"& back into &"joe.bloggs"& when that was the
19072 original address. See also the &%repeat_use%& option below.
19073
19074
19075 .option check_group redirect boolean "see below"
19076 When the &%file%& option is used, the group owner of the file is checked only
19077 when this option is set. The permitted groups are those listed in the
19078 &%owngroups%& option, together with the user's default group if
19079 &%check_local_user%& is set. If the file has the wrong group, routing is
19080 deferred. The default setting for this option is true if &%check_local_user%&
19081 is set and the &%modemask%& option permits the group write bit, or if the
19082 &%owngroups%& option is set. Otherwise it is false, and no group check occurs.
19083
19084
19085
19086 .option check_owner redirect boolean "see below"
19087 When the &%file%& option is used, the owner of the file is checked only when
19088 this option is set. If &%check_local_user%& is set, the local user is
19089 permitted; otherwise the owner must be one of those listed in the &%owners%&
19090 option. The default value for this option is true if &%check_local_user%& or
19091 &%owners%& is set. Otherwise the default is false, and no owner check occurs.
19092
19093
19094 .option data redirect string&!! unset
19095 This option is mutually exclusive with &%file%&. One or other of them must be
19096 set, but not both. The contents of &%data%& are expanded, and then used as the
19097 list of forwarding items, or as a set of filtering instructions. If the
19098 expansion is forced to fail, or the result is an empty string or a string that
19099 has no effect (consists entirely of comments), the router declines.
19100
19101 When filtering instructions are used, the string must begin with &"#Exim
19102 filter"&, and all comments in the string, including this initial one, must be
19103 terminated with newline characters. For example:
19104 .code
19105 data = #Exim filter\n\
19106        if $h_to: contains Exim then save $home/mail/exim endif
19107 .endd
19108 If you are reading the data from a database where newlines cannot be included,
19109 you can use the &${sg}$& expansion item to turn the escape string of your
19110 choice into a newline.
19111
19112
19113 .option directory_transport redirect string&!! unset
19114 A &(redirect)& router sets up a direct delivery to a directory when a path name
19115 ending with a slash is specified as a new &"address"&. The transport used is
19116 specified by this option, which, after expansion, must be the name of a
19117 configured transport. This should normally be an &(appendfile)& transport.
19118
19119
19120 .option file redirect string&!! unset
19121 This option specifies the name of a file that contains the redirection data. It
19122 is mutually exclusive with the &%data%& option. The string is expanded before
19123 use; if the expansion is forced to fail, the router declines. Other expansion
19124 failures cause delivery to be deferred. The result of a successful expansion
19125 must be an absolute path. The entire file is read and used as the redirection
19126 data. If the data is an empty string or a string that has no effect (consists
19127 entirely of comments), the router declines.
19128
19129 .cindex "NFS" "checking for file existence"
19130 If the attempt to open the file fails with a &"does not exist"& error, Exim
19131 runs a check on the containing directory,
19132 unless &%ignore_enotdir%& is true (see below).
19133 If the directory does not appear to exist, delivery is deferred. This can
19134 happen when users' &_.forward_& files are in NFS-mounted directories, and there
19135 is a mount problem. If the containing directory does exist, but the file does
19136 not, the router declines.
19137
19138
19139 .option file_transport redirect string&!! unset
19140 .vindex "&$address_file$&"
19141 A &(redirect)& router sets up a direct delivery to a file when a path name not
19142 ending in a slash is specified as a new &"address"&. The transport used is
19143 specified by this option, which, after expansion, must be the name of a
19144 configured transport. This should normally be an &(appendfile)& transport. When
19145 it is running, the file name is in &$address_file$&.
19146
19147
19148 .option filter_prepend_home redirect boolean true
19149 When this option is true, if a &(save)& command in an Exim filter specifies a
19150 relative path, and &$home$& is defined, it is automatically prepended to the
19151 relative path. If this option is set false, this action does not happen. The
19152 relative path is then passed to the transport unmodified.
19153
19154
19155 .option forbid_blackhole redirect boolean false
19156 If this option is true, the &':blackhole:'& item may not appear in a
19157 redirection list.
19158
19159
19160 .option forbid_exim_filter redirect boolean false
19161 If this option is set true, only Sieve filters are permitted when
19162 &%allow_filter%& is true.
19163
19164
19165
19166
19167 .option forbid_file redirect boolean false
19168 .cindex "delivery" "to file; forbidding"
19169 .cindex "Sieve filter" "forbidding delivery to a file"
19170 .cindex "Sieve filter" "&""keep""& facility; disabling"
19171 If this option is true, this router may not generate a new address that
19172 specifies delivery to a local file or directory, either from a filter or from a
19173 conventional forward file. This option is forced to be true if &%one_time%& is
19174 set. It applies to Sieve filters as well as to Exim filters, but if true, it
19175 locks out the Sieve's &"keep"& facility.
19176
19177
19178 .option forbid_filter_dlfunc redirect boolean false
19179 .cindex "filter" "locking out certain features"
19180 If this option is true, string expansions in Exim filters are not allowed to
19181 make use of the &%dlfunc%& expansion facility to run dynamically loaded
19182 functions.
19183
19184 .option forbid_filter_existstest redirect boolean false
19185 .cindex "expansion" "statting a file"
19186 If this option is true, string expansions in Exim filters are not allowed to
19187 make use of the &%exists%& condition or the &%stat%& expansion item.
19188
19189 .option forbid_filter_logwrite redirect boolean false
19190 If this option is true, use of the logging facility in Exim filters is not
19191 permitted. Logging is in any case available only if the filter is being run
19192 under some unprivileged uid (which is normally the case for ordinary users'
19193 &_.forward_& files).
19194
19195
19196 .option forbid_filter_lookup redirect boolean false
19197 If this option is true, string expansions in Exim filter files are not allowed
19198 to make use of &%lookup%& items.
19199
19200
19201 .option forbid_filter_perl redirect boolean false
19202 This option has an effect only if Exim is built with embedded Perl support. If
19203 it is true, string expansions in Exim filter files are not allowed to make use
19204 of the embedded Perl support.
19205
19206
19207 .option forbid_filter_readfile redirect boolean false
19208 If this option is true, string expansions in Exim filter files are not allowed
19209 to make use of &%readfile%& items.
19210
19211
19212 .option forbid_filter_readsocket redirect boolean false
19213 If this option is true, string expansions in Exim filter files are not allowed
19214 to make use of &%readsocket%& items.
19215
19216
19217 .option forbid_filter_reply redirect boolean false
19218 If this option is true, this router may not generate an automatic reply
19219 message. Automatic replies can be generated only from Exim or Sieve filter
19220 files, not from traditional forward files. This option is forced to be true if
19221 &%one_time%& is set.
19222
19223
19224 .option forbid_filter_run redirect boolean false
19225 If this option is true, string expansions in Exim filter files are not allowed
19226 to make use of &%run%& items.
19227
19228
19229 .option forbid_include redirect boolean false
19230 If this option is true, items of the form
19231 .code
19232 :include:<path name>
19233 .endd
19234 are not permitted in non-filter redirection lists.
19235
19236
19237 .option forbid_pipe redirect boolean false
19238 .cindex "delivery" "to pipe; forbidding"
19239 If this option is true, this router may not generate a new address which
19240 specifies delivery to a pipe, either from an Exim filter or from a conventional
19241 forward file. This option is forced to be true if &%one_time%& is set.
19242
19243
19244 .option forbid_sieve_filter redirect boolean false
19245 If this option is set true, only Exim filters are permitted when
19246 &%allow_filter%& is true.
19247
19248
19249 .cindex "SMTP" "error codes"
19250 .option forbid_smtp_code redirect boolean false
19251 If this option is set true, any SMTP error codes that are present at the start
19252 of messages specified for &`:defer:`& or &`:fail:`& are quietly ignored, and
19253 the default codes (451 and 550, respectively) are always used.
19254
19255
19256
19257
19258 .option hide_child_in_errmsg redirect boolean false
19259 .cindex "bounce message" "redirection details; suppressing"
19260 If this option is true, it prevents Exim from quoting a child address if it
19261 generates a bounce or delay message for it. Instead it says &"an address
19262 generated from <&'the top level address'&>"&. Of course, this applies only to
19263 bounces generated locally. If a message is forwarded to another host, &'its'&
19264 bounce may well quote the generated address.
19265
19266
19267 .option ignore_eacces redirect boolean false
19268 .cindex "EACCES"
19269 If this option is set and an attempt to open a redirection file yields the
19270 EACCES error (permission denied), the &(redirect)& router behaves as if the
19271 file did not exist.
19272
19273
19274 .option ignore_enotdir redirect boolean false
19275 .cindex "ENOTDIR"
19276 If this option is set and an attempt to open a redirection file yields the
19277 ENOTDIR error (something on the path is not a directory), the &(redirect)&
19278 router behaves as if the file did not exist.
19279
19280 Setting &%ignore_enotdir%& has another effect as well: When a &(redirect)&
19281 router that has the &%file%& option set discovers that the file does not exist
19282 (the ENOENT error), it tries to &[stat()]& the parent directory, as a check
19283 against unmounted NFS directories. If the parent can not be statted, delivery
19284 is deferred. However, it seems wrong to do this check when &%ignore_enotdir%&
19285 is set, because that option tells Exim to ignore &"something on the path is not
19286 a directory"& (the ENOTDIR error). This is a confusing area, because it seems
19287 that some operating systems give ENOENT where others give ENOTDIR.
19288
19289
19290
19291 .option include_directory redirect string unset
19292 If this option is set, the path names of any &':include:'& items in a
19293 redirection list must start with this directory.
19294
19295
19296 .option modemask redirect "octal integer" 022
19297 This specifies mode bits which must not be set for a file specified by the
19298 &%file%& option. If any of the forbidden bits are set, delivery is deferred.
19299
19300
19301 .option one_time redirect boolean false
19302 .cindex "one-time aliasing/forwarding expansion"
19303 .cindex "alias file" "one-time expansion"
19304 .cindex "forward file" "one-time expansion"
19305 .cindex "mailing lists" "one-time expansion"
19306 .cindex "address redirection" "one-time expansion"
19307 Sometimes the fact that Exim re-evaluates aliases and reprocesses redirection
19308 files each time it tries to deliver a message causes a problem when one or more
19309 of the generated addresses fails be delivered at the first attempt. The problem
19310 is not one of duplicate delivery &-- Exim is clever enough to handle that &--
19311 but of what happens when the redirection list changes during the time that the
19312 message is on Exim's queue. This is particularly true in the case of mailing
19313 lists, where new subscribers might receive copies of messages that were posted
19314 before they subscribed.
19315
19316 If &%one_time%& is set and any addresses generated by the router fail to
19317 deliver at the first attempt, the failing addresses are added to the message as
19318 &"top level"& addresses, and the parent address that generated them is marked
19319 &"delivered"&. Thus, redirection does not happen again at the next delivery
19320 attempt.
19321
19322 &*Warning 1*&: Any header line addition or removal that is specified by this
19323 router would be lost if delivery did not succeed at the first attempt. For this
19324 reason, the &%headers_add%& and &%headers_remove%& generic options are not
19325 permitted when &%one_time%& is set.
19326
19327 &*Warning 2*&: To ensure that the router generates only addresses (as opposed
19328 to pipe or file deliveries or auto-replies) &%forbid_file%&, &%forbid_pipe%&,
19329 and &%forbid_filter_reply%& are forced to be true when &%one_time%& is set.
19330
19331 &*Warning 3*&: The &%unseen%& generic router option may not be set with
19332 &%one_time%&.
19333
19334 The original top-level address is remembered with each of the generated
19335 addresses, and is output in any log messages. However, any intermediate parent
19336 addresses are not recorded. This makes a difference to the log only if
19337 &%all_parents%& log selector is set. It is expected that &%one_time%& will
19338 typically be used for mailing lists, where there is normally just one level of
19339 expansion.
19340
19341
19342 .option owners redirect "string list" unset
19343 .cindex "ownership" "alias file"
19344 .cindex "ownership" "forward file"
19345 .cindex "alias file" "ownership"
19346 .cindex "forward file" "ownership"
19347 This specifies a list of permitted owners for the file specified by &%file%&.
19348 This list is in addition to the local user when &%check_local_user%& is set.
19349 See &%check_owner%& above.
19350
19351
19352 .option owngroups redirect "string list" unset
19353 This specifies a list of permitted groups for the file specified by &%file%&.
19354 The list is in addition to the local user's primary group when
19355 &%check_local_user%& is set. See &%check_group%& above.
19356
19357
19358 .option pipe_transport redirect string&!! unset
19359 .vindex "&$address_pipe$&"
19360 A &(redirect)& router sets up a direct delivery to a pipe when a string
19361 starting with a vertical bar character is specified as a new &"address"&. The
19362 transport used is specified by this option, which, after expansion, must be the
19363 name of a configured transport. This should normally be a &(pipe)& transport.
19364 When the transport is run, the pipe command is in &$address_pipe$&.
19365
19366
19367 .option qualify_domain redirect string&!! unset
19368 .vindex "&$qualify_recipient$&"
19369 If this option is set, and an unqualified address (one without a domain) is
19370 generated, and that address would normally be qualified by the global setting
19371 in &%qualify_recipient%&, it is instead qualified with the domain specified by
19372 expanding this string. If the expansion fails, the router declines. If you want
19373 to revert to the default, you can have the expansion generate
19374 &$qualify_recipient$&.
19375
19376 This option applies to all unqualified addresses generated by Exim filters,
19377 but for traditional &_.forward_& files, it applies only to addresses that are
19378 not preceded by a backslash. Sieve filters cannot generate unqualified
19379 addresses.
19380
19381 .option qualify_preserve_domain redirect boolean false
19382 .cindex "domain" "in redirection; preserving"
19383 .cindex "preserving domain in redirection"
19384 .cindex "address redirection" "domain; preserving"
19385 If this option is set, the router's local &%qualify_domain%& option must not be
19386 set (a configuration error occurs if it is). If an unqualified address (one
19387 without a domain) is generated, it is qualified with the domain of the parent
19388 address (the immediately preceding ancestor) instead of the global
19389 &%qualify_recipient%& value. In the case of a traditional &_.forward_& file,
19390 this applies whether or not the address is preceded by a backslash.
19391
19392
19393 .option repeat_use redirect boolean true
19394 If this option is set false, the router is skipped for a child address that has
19395 any ancestor that was routed by this router. This test happens before any of
19396 the other preconditions are tested. Exim's default anti-looping rules skip
19397 only when the ancestor is the same as the current address. See also
19398 &%check_ancestor%& above and the generic &%redirect_router%& option.
19399
19400
19401 .option reply_transport redirect string&!! unset
19402 A &(redirect)& router sets up an automatic reply when a &%mail%& or
19403 &%vacation%& command is used in a filter file. The transport used is specified
19404 by this option, which, after expansion, must be the name of a configured
19405 transport. This should normally be an &(autoreply)& transport. Other transports
19406 are unlikely to do anything sensible or useful.
19407
19408
19409 .option rewrite redirect boolean true
19410 .cindex "address redirection" "disabling rewriting"
19411 If this option is set false, addresses generated by the router are not
19412 subject to address rewriting. Otherwise, they are treated like new addresses
19413 and are rewritten according to the global rewriting rules.
19414
19415
19416 .option sieve_subaddress redirect string&!! unset
19417 The value of this option is passed to a Sieve filter to specify the
19418 :subaddress part of an address.
19419
19420 .option sieve_useraddress redirect string&!! unset
19421 The value of this option is passed to a Sieve filter to specify the :user part
19422 of an address. However, if it is unset, the entire original local part
19423 (including any prefix or suffix) is used for :user.
19424
19425
19426 .option sieve_vacation_directory redirect string&!! unset
19427 .cindex "Sieve filter" "vacation directory"
19428 To enable the &"vacation"& extension for Sieve filters, you must set
19429 &%sieve_vacation_directory%& to the directory where vacation databases are held
19430 (do not put anything else in that directory), and ensure that the
19431 &%reply_transport%& option refers to an &(autoreply)& transport. Each user
19432 needs their own directory; Exim will create it if necessary.
19433
19434
19435
19436 .option skip_syntax_errors redirect boolean false
19437 .cindex "forward file" "broken"
19438 .cindex "address redirection" "broken files"
19439 .cindex "alias file" "broken"
19440 .cindex "broken alias or forward files"
19441 .cindex "ignoring faulty addresses"
19442 .cindex "skipping faulty addresses"
19443 .cindex "error" "skipping bad syntax"
19444 If &%skip_syntax_errors%& is set, syntactically malformed addresses in
19445 non-filter redirection data are skipped, and each failing address is logged. If
19446 &%syntax_errors_to%& is set, a message is sent to the address it defines,
19447 giving details of the failures. If &%syntax_errors_text%& is set, its contents
19448 are expanded and placed at the head of the error message generated by
19449 &%syntax_errors_to%&. Usually it is appropriate to set &%syntax_errors_to%& to
19450 be the same address as the generic &%errors_to%& option. The
19451 &%skip_syntax_errors%& option is often used when handling mailing lists.
19452
19453 If all the addresses in a redirection list are skipped because of syntax
19454 errors, the router declines to handle the original address, and it is passed to
19455 the following routers.
19456
19457 If &%skip_syntax_errors%& is set when an Exim filter is interpreted, any syntax
19458 error in the filter causes filtering to be abandoned without any action being
19459 taken. The incident is logged, and the router declines to handle the address,
19460 so it is passed to the following routers.
19461
19462 .cindex "Sieve filter" "syntax errors in"
19463 Syntax errors in a Sieve filter file cause the &"keep"& action to occur. This
19464 action is specified by RFC 3028. The values of &%skip_syntax_errors%&,
19465 &%syntax_errors_to%&, and &%syntax_errors_text%& are not used.
19466
19467 &%skip_syntax_errors%& can be used to specify that errors in users' forward
19468 lists or filter files should not prevent delivery. The &%syntax_errors_to%&
19469 option, used with an address that does not get redirected, can be used to
19470 notify users of these errors, by means of a router like this:
19471 .code
19472 userforward:
19473   driver = redirect
19474   allow_filter
19475   check_local_user
19476   file = $home/.forward
19477   file_transport = address_file
19478   pipe_transport = address_pipe
19479   reply_transport = address_reply
19480   no_verify
19481   skip_syntax_errors
19482   syntax_errors_to = real-$local_part@$domain
19483   syntax_errors_text = \
19484    This is an automatically generated message. An error has\n\
19485    been found in your .forward file. Details of the error are\n\
19486    reported below. While this error persists, you will receive\n\
19487    a copy of this message for every message that is addressed\n\
19488    to you. If your .forward file is a filter file, or if it is\n\
19489    a non-filter file containing no valid forwarding addresses,\n\
19490    a copy of each incoming message will be put in your normal\n\
19491    mailbox. If a non-filter file contains at least one valid\n\
19492    forwarding address, forwarding to the valid addresses will\n\
19493    happen, and those will be the only deliveries that occur.
19494 .endd
19495 You also need a router to ensure that local addresses that are prefixed by
19496 &`real-`& are recognized, but not forwarded or filtered. For example, you could
19497 put this immediately before the &(userforward)& router:
19498 .code
19499 real_localuser:
19500   driver = accept
19501   check_local_user
19502   local_part_prefix = real-
19503   transport = local_delivery
19504 .endd
19505 For security, it would probably be a good idea to restrict the use of this
19506 router to locally-generated messages, using a condition such as this:
19507 .code
19508   condition = ${if match {$sender_host_address}\
19509                          {\N^(|127\.0\.0\.1)$\N}}
19510 .endd
19511
19512
19513 .option syntax_errors_text redirect string&!! unset
19514 See &%skip_syntax_errors%& above.
19515
19516
19517 .option syntax_errors_to redirect string unset
19518 See &%skip_syntax_errors%& above.
19519 .ecindex IIDredrou1
19520 .ecindex IIDredrou2
19521
19522
19523
19524
19525
19526
19527 . ////////////////////////////////////////////////////////////////////////////
19528 . ////////////////////////////////////////////////////////////////////////////
19529
19530 .chapter "Environment for running local transports" "CHAPenvironment" &&&
19531          "Environment for local transports"
19532 .scindex IIDenvlotra1 "local transports" "environment for"
19533 .scindex IIDenvlotra2 "environment for local transports"
19534 .scindex IIDenvlotra3 "transport" "local; environment for"
19535 Local transports handle deliveries to files and pipes. (The &(autoreply)&
19536 transport can be thought of as similar to a pipe.) Exim always runs transports
19537 in subprocesses, under specified uids and gids. Typical deliveries to local
19538 mailboxes run under the uid and gid of the local user.
19539
19540 Exim also sets a specific current directory while running the transport; for
19541 some transports a home directory setting is also relevant. The &(pipe)&
19542 transport is the only one that sets up environment variables; see section
19543 &<<SECTpipeenv>>& for details.
19544
19545 The values used for the uid, gid, and the directories may come from several
19546 different places. In many cases, the router that handles the address associates
19547 settings with that address as a result of its &%check_local_user%&, &%group%&,
19548 or &%user%& options. However, values may also be given in the transport's own
19549 configuration, and these override anything that comes from the router.
19550
19551
19552
19553 .section "Concurrent deliveries" "SECID131"
19554 .cindex "concurrent deliveries"
19555 .cindex "simultaneous deliveries"
19556 If two different messages for the same local recipient arrive more or less
19557 simultaneously, the two delivery processes are likely to run concurrently. When
19558 the &(appendfile)& transport is used to write to a file, Exim applies locking
19559 rules to stop concurrent processes from writing to the same file at the same
19560 time.
19561
19562 However, when you use a &(pipe)& transport, it is up to you to arrange any
19563 locking that is needed. Here is a silly example:
19564 .code
19565 my_transport:
19566   driver = pipe
19567   command = /bin/sh -c 'cat >>/some/file'
19568 .endd
19569 This is supposed to write the message at the end of the file. However, if two
19570 messages arrive at the same time, the file will be scrambled. You can use the
19571 &%exim_lock%& utility program (see section &<<SECTmailboxmaint>>&) to lock a
19572 file using the same algorithm that Exim itself uses.
19573
19574
19575
19576
19577 .section "Uids and gids" "SECTenvuidgid"
19578 .cindex "local transports" "uid and gid"
19579 .cindex "transport" "local; uid and gid"
19580 All transports have the options &%group%& and &%user%&. If &%group%& is set, it
19581 overrides any group that the router set in the address, even if &%user%& is not
19582 set for the transport. This makes it possible, for example, to run local mail
19583 delivery under the uid of the recipient (set by the router), but in a special
19584 group (set by the transport). For example:
19585 .code
19586 # Routers ...
19587 # User/group are set by check_local_user in this router
19588 local_users:
19589   driver = accept
19590   check_local_user
19591   transport = group_delivery
19592
19593 # Transports ...
19594 # This transport overrides the group
19595 group_delivery:
19596   driver = appendfile
19597   file = /var/spool/mail/$local_part
19598   group = mail
19599 .endd
19600 If &%user%& is set for a transport, its value overrides what is set in the
19601 address by the router. If &%user%& is non-numeric and &%group%& is not set, the
19602 gid associated with the user is used. If &%user%& is numeric, &%group%& must be
19603 set.
19604
19605 .oindex "&%initgroups%&"
19606 When the uid is taken from the transport's configuration, the &[initgroups()]&
19607 function is called for the groups associated with that uid if the
19608 &%initgroups%& option is set for the transport. When the uid is not specified
19609 by the transport, but is associated with the address by a router, the option
19610 for calling &[initgroups()]& is taken from the router configuration.
19611
19612 .cindex "&(pipe)& transport" "uid for"
19613 The &(pipe)& transport contains the special option &%pipe_as_creator%&. If this
19614 is set and &%user%& is not set, the uid of the process that called Exim to
19615 receive the message is used, and if &%group%& is not set, the corresponding
19616 original gid is also used.
19617
19618 This is the detailed preference order for obtaining a gid; the first of the
19619 following that is set is used:
19620
19621 .ilist
19622 A &%group%& setting of the transport;
19623 .next
19624 A &%group%& setting of the router;
19625 .next
19626 A gid associated with a user setting of the router, either as a result of
19627 &%check_local_user%& or an explicit non-numeric &%user%& setting;
19628 .next
19629 The group associated with a non-numeric &%user%& setting of the transport;
19630 .next
19631 In a &(pipe)& transport, the creator's gid if &%deliver_as_creator%& is set and
19632 the uid is the creator's uid;
19633 .next
19634 The Exim gid if the Exim uid is being used as a default.
19635 .endlist
19636
19637 If, for example, the user is specified numerically on the router and there are
19638 no group settings, no gid is available. In this situation, an error occurs.
19639 This is different for the uid, for which there always is an ultimate default.
19640 The first of the following that is set is used:
19641
19642 .ilist
19643 A &%user%& setting of the transport;
19644 .next
19645 In a &(pipe)& transport, the creator's uid if &%deliver_as_creator%& is set;
19646 .next
19647 A &%user%& setting of the router;
19648 .next
19649 A &%check_local_user%& setting of the router;
19650 .next
19651 The Exim uid.
19652 .endlist
19653
19654 Of course, an error will still occur if the uid that is chosen is on the
19655 &%never_users%& list.
19656
19657
19658
19659
19660
19661 .section "Current and home directories" "SECID132"
19662 .cindex "current directory for local transport"
19663 .cindex "home directory" "for local transport"
19664 .cindex "transport" "local; home directory for"
19665 .cindex "transport" "local; current directory for"
19666 Routers may set current and home directories for local transports by means of
19667 the &%transport_current_directory%& and &%transport_home_directory%& options.
19668 However, if the transport's &%current_directory%& or &%home_directory%& options
19669 are set, they override the router's values. In detail, the home directory
19670 for a local transport is taken from the first of these values that is set:
19671
19672 .ilist
19673 The &%home_directory%& option on the transport;
19674 .next
19675 The &%transport_home_directory%& option on the router;
19676 .next
19677 The password data if &%check_local_user%& is set on the router;
19678 .next
19679 The &%router_home_directory%& option on the router.
19680 .endlist
19681
19682 The current directory is taken from the first of these values that is set:
19683
19684 .ilist
19685 The &%current_directory%& option on the transport;
19686 .next
19687 The &%transport_current_directory%& option on the router.
19688 .endlist
19689
19690
19691 If neither the router nor the transport sets a current directory, Exim uses the
19692 value of the home directory, if it is set. Otherwise it sets the current
19693 directory to &_/_& before running a local transport.
19694
19695
19696
19697 .section "Expansion variables derived from the address" "SECID133"
19698 .vindex "&$domain$&"
19699 .vindex "&$local_part$&"
19700 .vindex "&$original_domain$&"
19701 Normally a local delivery is handling a single address, and in that case the
19702 variables such as &$domain$& and &$local_part$& are set during local
19703 deliveries. However, in some circumstances more than one address may be handled
19704 at once (for example, while writing batch SMTP for onward transmission by some
19705 other means). In this case, the variables associated with the local part are
19706 never set, &$domain$& is set only if all the addresses have the same domain,
19707 and &$original_domain$& is never set.
19708 .ecindex IIDenvlotra1
19709 .ecindex IIDenvlotra2
19710 .ecindex IIDenvlotra3
19711
19712
19713
19714
19715
19716
19717
19718 . ////////////////////////////////////////////////////////////////////////////
19719 . ////////////////////////////////////////////////////////////////////////////
19720
19721 .chapter "Generic options for transports" "CHAPtransportgeneric"
19722 .scindex IIDgenoptra1 "generic options" "transport"
19723 .scindex IIDgenoptra2 "options" "generic; for transports"
19724 .scindex IIDgenoptra3 "transport" "generic options for"
19725 The following generic options apply to all transports:
19726
19727
19728 .option body_only transports boolean false
19729 .cindex "transport" "body only"
19730 .cindex "message" "transporting body only"
19731 .cindex "body of message" "transporting"
19732 If this option is set, the message's headers are not transported. It is
19733 mutually exclusive with &%headers_only%&. If it is used with the &(appendfile)&
19734 or &(pipe)& transports, the settings of &%message_prefix%& and
19735 &%message_suffix%& should be checked, because this option does not
19736 automatically suppress them.
19737
19738
19739 .option current_directory transports string&!! unset
19740 .cindex "transport" "current directory for"
19741 This specifies the current directory that is to be set while running the
19742 transport, overriding any value that may have been set by the router.
19743 If the expansion fails for any reason, including forced failure, an error is
19744 logged, and delivery is deferred.
19745
19746
19747 .option disable_logging transports boolean false
19748 If this option is set true, nothing is logged for any
19749 deliveries by the transport or for any
19750 transport errors. You should not set this option unless you really, really know
19751 what you are doing.
19752
19753
19754 .option debug_print transports string&!! unset
19755 .cindex "testing" "variables in drivers"
19756 If this option is set and debugging is enabled (see the &%-d%& command line
19757 option), the string is expanded and included in the debugging output when the
19758 transport is run.
19759 If expansion of the string fails, the error message is written to the debugging
19760 output, and Exim carries on processing.
19761 This facility is provided to help with checking out the values of variables and
19762 so on when debugging driver configurations. For example, if a &%headers_add%&
19763 option is not working properly, &%debug_print%& could be used to output the
19764 variables it references. A newline is added to the text if it does not end with
19765 one.
19766 .new
19767 The variables &$transport_name$& and &$router_name$& contain the name of the
19768 transport and the router that called it.
19769 .wen
19770
19771 .option delivery_date_add transports boolean false
19772 .cindex "&'Delivery-date:'& header line"
19773 If this option is true, a &'Delivery-date:'& header is added to the message.
19774 This gives the actual time the delivery was made. As this is not a standard
19775 header, Exim has a configuration option (&%delivery_date_remove%&) which
19776 requests its removal from incoming messages, so that delivered messages can
19777 safely be resent to other recipients.
19778
19779
19780 .option driver transports string unset
19781 This specifies which of the available transport drivers is to be used.
19782 There is no default, and this option must be set for every transport.
19783
19784
19785 .option envelope_to_add transports boolean false
19786 .cindex "&'Envelope-to:'& header line"
19787 If this option is true, an &'Envelope-to:'& header is added to the message.
19788 This gives the original address(es) in the incoming envelope that caused this
19789 delivery to happen. More than one address may be present if the transport is
19790 configured to handle several addresses at once, or if more than one original
19791 address was redirected to the same final address. As this is not a standard
19792 header, Exim has a configuration option (&%envelope_to_remove%&) which requests
19793 its removal from incoming messages, so that delivered messages can safely be
19794 resent to other recipients.
19795
19796
19797 .option group transports string&!! "Exim group"
19798 .cindex "transport" "group; specifying"
19799 This option specifies a gid for running the transport process, overriding any
19800 value that the router supplies, and also overriding any value associated with
19801 &%user%& (see below).
19802
19803
19804 .option headers_add transports string&!! unset
19805 .cindex "header lines" "adding in transport"
19806 .cindex "transport" "header lines; adding"
19807 This option specifies a string of text that is expanded and added to the header
19808 portion of a message as it is transported, as described in section
19809 &<<SECTheadersaddrem>>&. Additional header lines can also be specified by
19810 routers. If the result of the expansion is an empty string, or if the expansion
19811 is forced to fail, no action is taken. Other expansion failures are treated as
19812 errors and cause the delivery to be deferred.
19813
19814 .new
19815 Unlike most options, &%headers_add%& can be specified multiple times
19816 for a transport; all listed headers are added.
19817 .wen
19818
19819
19820 .option headers_only transports boolean false
19821 .cindex "transport" "header lines only"
19822 .cindex "message" "transporting headers only"
19823 .cindex "header lines" "transporting"
19824 If this option is set, the message's body is not transported. It is mutually
19825 exclusive with &%body_only%&. If it is used with the &(appendfile)& or &(pipe)&
19826 transports, the settings of &%message_prefix%& and &%message_suffix%& should be
19827 checked, since this option does not automatically suppress them.
19828
19829
19830 .option headers_remove transports string&!! unset
19831 .cindex "header lines" "removing"
19832 .cindex "transport" "header lines; removing"
19833 This option specifies a string that is expanded into a list of header names;
19834 these headers are omitted from the message as it is transported, as described
19835 in section &<<SECTheadersaddrem>>&. Header removal can also be specified by
19836 routers. If the result of the expansion is an empty string, or if the expansion
19837 is forced to fail, no action is taken. Other expansion failures are treated as
19838 errors and cause the delivery to be deferred.
19839
19840 Unlike most options, &%headers_remove%& can be specified multiple times
19841 for a router; all listed headers are added.
19842
19843
19844
19845 .option headers_rewrite transports string unset
19846 .cindex "transport" "header lines; rewriting"
19847 .cindex "rewriting" "at transport time"
19848 This option allows addresses in header lines to be rewritten at transport time,
19849 that is, as the message is being copied to its destination. The contents of the
19850 option are a colon-separated list of rewriting rules. Each rule is in exactly
19851 the same form as one of the general rewriting rules that are applied when a
19852 message is received. These are described in chapter &<<CHAPrewrite>>&. For
19853 example,
19854 .code
19855 headers_rewrite = a@b c@d f : \
19856                   x@y w@z
19857 .endd
19858 changes &'a@b'& into &'c@d'& in &'From:'& header lines, and &'x@y'& into
19859 &'w@z'& in all address-bearing header lines. The rules are applied to the
19860 header lines just before they are written out at transport time, so they affect
19861 only those copies of the message that pass through the transport. However, only
19862 the message's original header lines, and any that were added by a system
19863 filter, are rewritten. If a router or transport adds header lines, they are not
19864 affected by this option. These rewriting rules are &'not'& applied to the
19865 envelope. You can change the return path using &%return_path%&, but you cannot
19866 change envelope recipients at this time.
19867
19868
19869 .option home_directory transports string&!! unset
19870 .cindex "transport" "home directory for"
19871 .vindex "&$home$&"
19872 This option specifies a home directory setting for a local transport,
19873 overriding any value that may be set by the router. The home directory is
19874 placed in &$home$& while expanding the transport's private options. It is also
19875 used as the current directory if no current directory is set by the
19876 &%current_directory%& option on the transport or the
19877 &%transport_current_directory%& option on the router. If the expansion fails
19878 for any reason, including forced failure, an error is logged, and delivery is
19879 deferred.
19880
19881
19882 .option initgroups transports boolean false
19883 .cindex "additional groups"
19884 .cindex "groups" "additional"
19885 .cindex "transport" "group; additional"
19886 If this option is true and the uid for the delivery process is provided by the
19887 transport, the &[initgroups()]& function is called when running the transport
19888 to ensure that any additional groups associated with the uid are set up.
19889
19890
19891 .option message_size_limit transports string&!! 0
19892 .cindex "limit" "message size per transport"
19893 .cindex "size" "of message, limit"
19894 .cindex "transport" "message size; limiting"
19895 This option controls the size of messages passed through the transport. It is
19896 expanded before use; the result of the expansion must be a sequence of decimal
19897 digits, optionally followed by K or M. If the expansion fails for any reason,
19898 including forced failure, or if the result is not of the required form,
19899 delivery is deferred. If the value is greater than zero and the size of a
19900 message exceeds this limit, the address is failed. If there is any chance that
19901 the resulting bounce message could be routed to the same transport, you should
19902 ensure that &%return_size_limit%& is less than the transport's
19903 &%message_size_limit%&, as otherwise the bounce message will fail to get
19904 delivered.
19905
19906
19907
19908 .option rcpt_include_affixes transports boolean false
19909 .cindex "prefix" "for local part, including in envelope"
19910 .cindex "suffix for local part" "including in envelope"
19911 .cindex "local part" "prefix"
19912 .cindex "local part" "suffix"
19913 When this option is false (the default), and an address that has had any
19914 affixes (prefixes or suffixes) removed from the local part is delivered by any
19915 form of SMTP or LMTP, the affixes are not included. For example, if a router
19916 that contains
19917 .code
19918 local_part_prefix = *-
19919 .endd
19920 routes the address &'abc-xyz@some.domain'& to an SMTP transport, the envelope
19921 is delivered with
19922 .code
19923 RCPT TO:<xyz@some.domain>
19924 .endd
19925 This is also the case when an ACL-time callout is being used to verify a
19926 recipient address. However, if &%rcpt_include_affixes%& is set true, the
19927 whole local part is included in the RCPT command. This option applies to BSMTP
19928 deliveries by the &(appendfile)& and &(pipe)& transports as well as to the
19929 &(lmtp)& and &(smtp)& transports.
19930
19931
19932 .option retry_use_local_part transports boolean "see below"
19933 .cindex "hints database" "retry keys"
19934 When a delivery suffers a temporary failure, a retry record is created
19935 in Exim's hints database. For remote deliveries, the key for the retry record
19936 is based on the name and/or IP address of the failing remote host. For local
19937 deliveries, the key is normally the entire address, including both the local
19938 part and the domain. This is suitable for most common cases of local delivery
19939 temporary failure &-- for example, exceeding a mailbox quota should delay only
19940 deliveries to that mailbox, not to the whole domain.
19941
19942 However, in some special cases you may want to treat a temporary local delivery
19943 as a failure associated with the domain, and not with a particular local part.
19944 (For example, if you are storing all mail for some domain in files.) You can do
19945 this by setting &%retry_use_local_part%& false.
19946
19947 For all the local transports, its default value is true. For remote transports,
19948 the default value is false for tidiness, but changing the value has no effect
19949 on a remote transport in the current implementation.
19950
19951
19952 .option return_path transports string&!! unset
19953 .cindex "envelope sender"
19954 .cindex "transport" "return path; changing"
19955 .cindex "return path" "changing in transport"
19956 If this option is set, the string is expanded at transport time and replaces
19957 the existing return path (envelope sender) value in the copy of the message
19958 that is being delivered. An empty return path is permitted. This feature is
19959 designed for remote deliveries, where the value of this option is used in the
19960 SMTP MAIL command. If you set &%return_path%& for a local transport, the
19961 only effect is to change the address that is placed in the &'Return-path:'&
19962 header line, if one is added to the message (see the next option).
19963
19964 &*Note:*& A changed return path is not logged unless you add
19965 &%return_path_on_delivery%& to the log selector.
19966
19967 .vindex "&$return_path$&"
19968 The expansion can refer to the existing value via &$return_path$&. This is
19969 either the message's envelope sender, or an address set by the
19970 &%errors_to%& option on a router. If the expansion is forced to fail, no
19971 replacement occurs; if it fails for another reason, delivery is deferred. This
19972 option can be used to support VERP (Variable Envelope Return Paths) &-- see
19973 section &<<SECTverp>>&.
19974
19975 &*Note*&: If a delivery error is detected locally, including the case when a
19976 remote server rejects a message at SMTP time, the bounce message is not sent to
19977 the value of this option. It is sent to the previously set errors address.
19978 This defaults to the incoming sender address, but can be changed by setting
19979 &%errors_to%& in a router.
19980
19981
19982
19983 .option return_path_add transports boolean false
19984 .cindex "&'Return-path:'& header line"
19985 If this option is true, a &'Return-path:'& header is added to the message.
19986 Although the return path is normally available in the prefix line of BSD
19987 mailboxes, this is commonly not displayed by MUAs, and so the user does not
19988 have easy access to it.
19989
19990 RFC 2821 states that the &'Return-path:'& header is added to a message &"when
19991 the delivery SMTP server makes the final delivery"&. This implies that this
19992 header should not be present in incoming messages. Exim has a configuration
19993 option, &%return_path_remove%&, which requests removal of this header from
19994 incoming messages, so that delivered messages can safely be resent to other
19995 recipients.
19996
19997
19998 .option shadow_condition transports string&!! unset
19999 See &%shadow_transport%& below.
20000
20001
20002 .option shadow_transport transports string unset
20003 .cindex "shadow transport"
20004 .cindex "transport" "shadow"
20005 A local transport may set the &%shadow_transport%& option to the name of
20006 another local transport. Shadow remote transports are not supported.
20007
20008 Whenever a delivery to the main transport succeeds, and either
20009 &%shadow_condition%& is unset, or its expansion does not result in the empty
20010 string or one of the strings &"0"& or &"no"& or &"false"&, the message is also
20011 passed to the shadow transport, with the same delivery address or addresses. If
20012 expansion fails, no action is taken except that non-forced expansion failures
20013 cause a log line to be written.
20014
20015 The result of the shadow transport is discarded and does not affect the
20016 subsequent processing of the message. Only a single level of shadowing is
20017 provided; the &%shadow_transport%& option is ignored on any transport when it
20018 is running as a shadow. Options concerned with output from pipes are also
20019 ignored. The log line for the successful delivery has an item added on the end,
20020 of the form
20021 .code
20022 ST=<shadow transport name>
20023 .endd
20024 If the shadow transport did not succeed, the error message is put in
20025 parentheses afterwards. Shadow transports can be used for a number of different
20026 purposes, including keeping more detailed log information than Exim normally
20027 provides, and implementing automatic acknowledgment policies based on message
20028 headers that some sites insist on.
20029
20030
20031 .option transport_filter transports string&!! unset
20032 .cindex "transport" "filter"
20033 .cindex "filter" "transport filter"
20034 This option sets up a filtering (in the Unix shell sense) process for messages
20035 at transport time. It should not be confused with mail filtering as set up by
20036 individual users or via a system filter.
20037
20038 When the message is about to be written out, the command specified by
20039 &%transport_filter%& is started up in a separate, parallel process, and
20040 the entire message, including the header lines, is passed to it on its standard
20041 input (this in fact is done from a third process, to avoid deadlock). The
20042 command must be specified as an absolute path.
20043
20044 The lines of the message that are written to the transport filter are
20045 terminated by newline (&"\n"&). The message is passed to the filter before any
20046 SMTP-specific processing, such as turning &"\n"& into &"\r\n"& and escaping
20047 lines beginning with a dot, and also before any processing implied by the
20048 settings of &%check_string%& and &%escape_string%& in the &(appendfile)& or
20049 &(pipe)& transports.
20050
20051 The standard error for the filter process is set to the same destination as its
20052 standard output; this is read and written to the message's ultimate
20053 destination. The process that writes the message to the filter, the
20054 filter itself, and the original process that reads the result and delivers it
20055 are all run in parallel, like a shell pipeline.
20056
20057 The filter can perform any transformations it likes, but of course should take
20058 care not to break RFC 2822 syntax. Exim does not check the result, except to
20059 test for a final newline when SMTP is in use. All messages transmitted over
20060 SMTP must end with a newline, so Exim supplies one if it is missing.
20061
20062 .cindex "content scanning" "per user"
20063 A transport filter can be used to provide content-scanning on a per-user basis
20064 at delivery time if the only required effect of the scan is to modify the
20065 message. For example, a content scan could insert a new header line containing
20066 a spam score. This could be interpreted by a filter in the user's MUA. It is
20067 not possible to discard a message at this stage.
20068
20069 .cindex "SMTP" "SIZE"
20070 A problem might arise if the filter increases the size of a message that is
20071 being sent down an SMTP connection. If the receiving SMTP server has indicated
20072 support for the SIZE parameter, Exim will have sent the size of the message
20073 at the start of the SMTP session. If what is actually sent is substantially
20074 more, the server might reject the message. This can be worked round by setting
20075 the &%size_addition%& option on the &(smtp)& transport, either to allow for
20076 additions to the message, or to disable the use of SIZE altogether.
20077
20078 .vindex "&$pipe_addresses$&"
20079 The value of the &%transport_filter%& option is the command string for starting
20080 the filter, which is run directly from Exim, not under a shell. The string is
20081 parsed by Exim in the same way as a command string for the &(pipe)& transport:
20082 Exim breaks it up into arguments and then expands each argument separately (see
20083 section &<<SECThowcommandrun>>&). Any kind of expansion failure causes delivery
20084 to be deferred. The special argument &$pipe_addresses$& is replaced by a number
20085 of arguments, one for each address that applies to this delivery. (This isn't
20086 an ideal name for this feature here, but as it was already implemented for the
20087 &(pipe)& transport, it seemed sensible not to change it.)
20088
20089 .vindex "&$host$&"
20090 .vindex "&$host_address$&"
20091 The expansion variables &$host$& and &$host_address$& are available when the
20092 transport is a remote one. They contain the name and IP address of the host to
20093 which the message is being sent. For example:
20094 .code
20095 transport_filter = /some/directory/transport-filter.pl \
20096   $host $host_address $sender_address $pipe_addresses
20097 .endd
20098
20099 Two problems arise if you want to use more complicated expansion items to
20100 generate transport filter commands, both of which due to the fact that the
20101 command is split up &'before'& expansion.
20102 .ilist
20103 If an expansion item contains white space, you must quote it, so that it is all
20104 part of the same command item. If the entire option setting is one such
20105 expansion item, you have to take care what kind of quoting you use. For
20106 example:
20107 .code
20108 transport_filter = '/bin/cmd${if eq{$host}{a.b.c}{1}{2}}'
20109 .endd
20110 This runs the command &(/bin/cmd1)& if the host name is &'a.b.c'&, and
20111 &(/bin/cmd2)& otherwise. If double quotes had been used, they would have been
20112 stripped by Exim when it read the option's value. When the value is used, if
20113 the single quotes were missing, the line would be split into two items,
20114 &`/bin/cmd${if`& and &`eq{$host}{a.b.c}{1}{2}`&, and an error would occur when
20115 Exim tried to expand the first one.
20116 .next
20117 Except for the special case of &$pipe_addresses$& that is mentioned above, an
20118 expansion cannot generate multiple arguments, or a command name followed by
20119 arguments. Consider this example:
20120 .code
20121 transport_filter = ${lookup{$host}lsearch{/a/file}\
20122                     {$value}{/bin/cat}}
20123 .endd
20124 The result of the lookup is interpreted as the name of the command, even
20125 if it contains white space. The simplest way round this is to use a shell:
20126 .code
20127 transport_filter = /bin/sh -c ${lookup{$host}lsearch{/a/file}\
20128                                {$value}{/bin/cat}}
20129 .endd
20130 .endlist
20131
20132 The filter process is run under the same uid and gid as the normal delivery.
20133 For remote deliveries this is the Exim uid/gid by default. The command should
20134 normally yield a zero return code. Transport filters are not supposed to fail.
20135 A non-zero code is taken to mean that the transport filter encountered some
20136 serious problem. Delivery of the message is deferred; the message remains on
20137 the queue and is tried again later. It is not possible to cause a message to be
20138 bounced from a transport filter.
20139
20140 If a transport filter is set on an autoreply transport, the original message is
20141 passed through the filter as it is being copied into the newly generated
20142 message, which happens if the &%return_message%& option is set.
20143
20144
20145 .option transport_filter_timeout transports time 5m
20146 .cindex "transport" "filter, timeout"
20147 When Exim is reading the output of a transport filter, it applies a timeout
20148 that can be set by this option. Exceeding the timeout is normally treated as a
20149 temporary delivery failure. However, if a transport filter is used with a
20150 &(pipe)& transport, a timeout in the transport filter is treated in the same
20151 way as a timeout in the pipe command itself. By default, a timeout is a hard
20152 error, but if the &(pipe)& transport's &%timeout_defer%& option is set true, it
20153 becomes a temporary error.
20154
20155
20156 .option user transports string&!! "Exim user"
20157 .cindex "uid (user id)" "local delivery"
20158 .cindex "transport" "user, specifying"
20159 This option specifies the user under whose uid the delivery process is to be
20160 run, overriding any uid that may have been set by the router. If the user is
20161 given as a name, the uid is looked up from the password data, and the
20162 associated group is taken as the value of the gid to be used if the &%group%&
20163 option is not set.
20164
20165 For deliveries that use local transports, a user and group are normally
20166 specified explicitly or implicitly (for example, as a result of
20167 &%check_local_user%&) by the router or transport.
20168
20169 .cindex "hints database" "access by remote transport"
20170 For remote transports, you should leave this option unset unless you really are
20171 sure you know what you are doing. When a remote transport is running, it needs
20172 to be able to access Exim's hints databases, because each host may have its own
20173 retry data.
20174 .ecindex IIDgenoptra1
20175 .ecindex IIDgenoptra2
20176 .ecindex IIDgenoptra3
20177
20178
20179
20180
20181
20182
20183 . ////////////////////////////////////////////////////////////////////////////
20184 . ////////////////////////////////////////////////////////////////////////////
20185
20186 .chapter "Address batching in local transports" "CHAPbatching" &&&
20187          "Address batching"
20188 .cindex "transport" "local; address batching in"
20189 The only remote transport (&(smtp)&) is normally configured to handle more than
20190 one address at a time, so that when several addresses are routed to the same
20191 remote host, just one copy of the message is sent. Local transports, however,
20192 normally handle one address at a time. That is, a separate instance of the
20193 transport is run for each address that is routed to the transport. A separate
20194 copy of the message is delivered each time.
20195
20196 .cindex "batched local delivery"
20197 .oindex "&%batch_max%&"
20198 .oindex "&%batch_id%&"
20199 In special cases, it may be desirable to handle several addresses at once in a
20200 local transport, for example:
20201
20202 .ilist
20203 In an &(appendfile)& transport, when storing messages in files for later
20204 delivery by some other means, a single copy of the message with multiple
20205 recipients saves space.
20206 .next
20207 In an &(lmtp)& transport, when delivering over &"local SMTP"& to some process,
20208 a single copy saves time, and is the normal way LMTP is expected to work.
20209 .next
20210 In a &(pipe)& transport, when passing the message
20211 to a scanner program or
20212 to some other delivery mechanism such as UUCP, multiple recipients may be
20213 acceptable.
20214 .endlist
20215
20216 These three local transports all have the same options for controlling multiple
20217 (&"batched"&) deliveries, namely &%batch_max%& and &%batch_id%&. To save
20218 repeating the information for each transport, these options are described here.
20219
20220 The &%batch_max%& option specifies the maximum number of addresses that can be
20221 delivered together in a single run of the transport. Its default value is one
20222 (no batching). When more than one address is routed to a transport that has a
20223 &%batch_max%& value greater than one, the addresses are delivered in a batch
20224 (that is, in a single run of the transport with multiple recipients), subject
20225 to certain conditions:
20226
20227 .ilist
20228 .vindex "&$local_part$&"
20229 If any of the transport's options contain a reference to &$local_part$&, no
20230 batching is possible.
20231 .next
20232 .vindex "&$domain$&"
20233 If any of the transport's options contain a reference to &$domain$&, only
20234 addresses with the same domain are batched.
20235 .next
20236 .cindex "customizing" "batching condition"
20237 If &%batch_id%& is set, it is expanded for each address, and only those
20238 addresses with the same expanded value are batched. This allows you to specify
20239 customized batching conditions. Failure of the expansion for any reason,
20240 including forced failure, disables batching, but it does not stop the delivery
20241 from taking place.
20242 .next
20243 Batched addresses must also have the same errors address (where to send
20244 delivery errors), the same header additions and removals, the same user and
20245 group for the transport, and if a host list is present, the first host must
20246 be the same.
20247 .endlist
20248
20249 In the case of the &(appendfile)& and &(pipe)& transports, batching applies
20250 both when the file or pipe command is specified in the transport, and when it
20251 is specified by a &(redirect)& router, but all the batched addresses must of
20252 course be routed to the same file or pipe command. These two transports have an
20253 option called &%use_bsmtp%&, which causes them to deliver the message in
20254 &"batched SMTP"& format, with the envelope represented as SMTP commands. The
20255 &%check_string%& and &%escape_string%& options are forced to the values
20256 .code
20257 check_string = "."
20258 escape_string = ".."
20259 .endd
20260 when batched SMTP is in use. A full description of the batch SMTP mechanism is
20261 given in section &<<SECTbatchSMTP>>&. The &(lmtp)& transport does not have a
20262 &%use_bsmtp%& option, because it always delivers using the SMTP protocol.
20263
20264 .cindex "&'Envelope-to:'& header line"
20265 If the generic &%envelope_to_add%& option is set for a batching transport, the
20266 &'Envelope-to:'& header that is added to the message contains all the addresses
20267 that are being processed together. If you are using a batching &(appendfile)&
20268 transport without &%use_bsmtp%&, the only way to preserve the recipient
20269 addresses is to set the &%envelope_to_add%& option.
20270
20271 .cindex "&(pipe)& transport" "with multiple addresses"
20272 .vindex "&$pipe_addresses$&"
20273 If you are using a &(pipe)& transport without BSMTP, and setting the
20274 transport's &%command%& option, you can include &$pipe_addresses$& as part of
20275 the command. This is not a true variable; it is a bit of magic that causes each
20276 of the recipient addresses to be inserted into the command as a separate
20277 argument. This provides a way of accessing all the addresses that are being
20278 delivered in the batch. &*Note:*& This is not possible for pipe commands that
20279 are specified by a &(redirect)& router.
20280
20281
20282
20283
20284 . ////////////////////////////////////////////////////////////////////////////
20285 . ////////////////////////////////////////////////////////////////////////////
20286
20287 .chapter "The appendfile transport" "CHAPappendfile"
20288 .scindex IIDapptra1 "&(appendfile)& transport"
20289 .scindex IIDapptra2 "transports" "&(appendfile)&"
20290 .cindex "directory creation"
20291 .cindex "creating directories"
20292 The &(appendfile)& transport delivers a message by appending it to an existing
20293 file, or by creating an entirely new file in a specified directory. Single
20294 files to which messages are appended can be in the traditional Unix mailbox
20295 format, or optionally in the MBX format supported by the Pine MUA and
20296 University of Washington IMAP daemon, &'inter alia'&. When each message is
20297 being delivered as a separate file, &"maildir"& format can optionally be used
20298 to give added protection against failures that happen part-way through the
20299 delivery. A third form of separate-file delivery known as &"mailstore"& is also
20300 supported. For all file formats, Exim attempts to create as many levels of
20301 directory as necessary, provided that &%create_directory%& is set.
20302
20303 The code for the optional formats is not included in the Exim binary by
20304 default. It is necessary to set SUPPORT_MBX, SUPPORT_MAILDIR and/or
20305 SUPPORT_MAILSTORE in &_Local/Makefile_& to have the appropriate code
20306 included.
20307
20308 .cindex "quota" "system"
20309 Exim recognizes system quota errors, and generates an appropriate message. Exim
20310 also supports its own quota control within the transport, for use when the
20311 system facility is unavailable or cannot be used for some reason.
20312
20313 If there is an error while appending to a file (for example, quota exceeded or
20314 partition filled), Exim attempts to reset the file's length and last
20315 modification time back to what they were before. If there is an error while
20316 creating an entirely new file, the new file is removed.
20317
20318 Before appending to a file, a number of security checks are made, and the
20319 file is locked. A detailed description is given below, after the list of
20320 private options.
20321
20322 The &(appendfile)& transport is most commonly used for local deliveries to
20323 users' mailboxes. However, it can also be used as a pseudo-remote transport for
20324 putting messages into files for remote delivery by some means other than Exim.
20325 &"Batch SMTP"& format is often used in this case (see the &%use_bsmtp%&
20326 option).
20327
20328
20329
20330 .section "The file and directory options" "SECTfildiropt"
20331 The &%file%& option specifies a single file, to which the message is appended;
20332 the &%directory%& option specifies a directory, in which a new file containing
20333 the message is created. Only one of these two options can be set, and for
20334 normal deliveries to mailboxes, one of them &'must'& be set.
20335
20336 .vindex "&$address_file$&"
20337 .vindex "&$local_part$&"
20338 However, &(appendfile)& is also used for delivering messages to files or
20339 directories whose names (or parts of names) are obtained from alias,
20340 forwarding, or filtering operations (for example, a &%save%& command in a
20341 user's Exim filter). When such a transport is running, &$local_part$& contains
20342 the local part that was aliased or forwarded, and &$address_file$& contains the
20343 name (or partial name) of the file or directory generated by the redirection
20344 operation. There are two cases:
20345
20346 .ilist
20347 If neither &%file%& nor &%directory%& is set, the redirection operation
20348 must specify an absolute path (one that begins with &`/`&). This is the most
20349 common case when users with local accounts use filtering to sort mail into
20350 different folders. See for example, the &(address_file)& transport in the
20351 default configuration. If the path ends with a slash, it is assumed to be the
20352 name of a directory. A delivery to a directory can also be forced by setting
20353 &%maildir_format%& or &%mailstore_format%&.
20354 .next
20355 If &%file%& or &%directory%& is set for a delivery from a redirection, it is
20356 used to determine the file or directory name for the delivery. Normally, the
20357 contents of &$address_file$& are used in some way in the string expansion.
20358 .endlist
20359
20360
20361 .cindex "Sieve filter" "configuring &(appendfile)&"
20362 .cindex "Sieve filter" "relative mailbox path handling"
20363 As an example of the second case, consider an environment where users do not
20364 have home directories. They may be permitted to use Exim filter commands of the
20365 form:
20366 .code
20367 save folder23
20368 .endd
20369 or Sieve filter commands of the form:
20370 .code
20371 require "fileinto";
20372 fileinto "folder23";
20373 .endd
20374 In this situation, the expansion of &%file%& or &%directory%& in the transport
20375 must transform the relative path into an appropriate absolute file name. In the
20376 case of Sieve filters, the name &'inbox'& must be handled. It is the name that
20377 is used as a result of a &"keep"& action in the filter. This example shows one
20378 way of handling this requirement:
20379 .code
20380 file = ${if eq{$address_file}{inbox} \
20381             {/var/mail/$local_part} \
20382             {${if eq{${substr_0_1:$address_file}}{/} \
20383                   {$address_file} \
20384                   {$home/mail/$address_file} \
20385             }} \
20386        }
20387 .endd
20388 With this setting of &%file%&, &'inbox'& refers to the standard mailbox
20389 location, absolute paths are used without change, and other folders are in the
20390 &_mail_& directory within the home directory.
20391
20392 &*Note 1*&: While processing an Exim filter, a relative path such as
20393 &_folder23_& is turned into an absolute path if a home directory is known to
20394 the router. In particular, this is the case if &%check_local_user%& is set. If
20395 you want to prevent this happening at routing time, you can set
20396 &%router_home_directory%& empty. This forces the router to pass the relative
20397 path to the transport.
20398
20399 &*Note 2*&: An absolute path in &$address_file$& is not treated specially;
20400 the &%file%& or &%directory%& option is still used if it is set.
20401
20402
20403
20404
20405 .section "Private options for appendfile" "SECID134"
20406 .cindex "options" "&(appendfile)& transport"
20407
20408
20409
20410 .option allow_fifo appendfile boolean false
20411 .cindex "fifo (named pipe)"
20412 .cindex "named pipe (fifo)"
20413 .cindex "pipe" "named (fifo)"
20414 Setting this option permits delivery to named pipes (FIFOs) as well as to
20415 regular files. If no process is reading the named pipe at delivery time, the
20416 delivery is deferred.
20417
20418
20419 .option allow_symlink appendfile boolean false
20420 .cindex "symbolic link" "to mailbox"
20421 .cindex "mailbox" "symbolic link"
20422 By default, &(appendfile)& will not deliver if the path name for the file is
20423 that of a symbolic link. Setting this option relaxes that constraint, but there
20424 are security issues involved in the use of symbolic links. Be sure you know
20425 what you are doing if you set this. Details of exactly what this option affects
20426 are included in the discussion which follows this list of options.
20427
20428
20429 .option batch_id appendfile string&!! unset
20430 See the description of local delivery batching in chapter &<<CHAPbatching>>&.
20431 However, batching is automatically disabled for &(appendfile)& deliveries that
20432 happen as a result of forwarding or aliasing or other redirection directly to a
20433 file.
20434
20435
20436 .option batch_max appendfile integer 1
20437 See the description of local delivery batching in chapter &<<CHAPbatching>>&.
20438
20439
20440 .option check_group appendfile boolean false
20441 When this option is set, the group owner of the file defined by the &%file%&
20442 option is checked to see that it is the same as the group under which the
20443 delivery process is running. The default setting is false because the default
20444 file mode is 0600, which means that the group is irrelevant.
20445
20446
20447 .option check_owner appendfile boolean true
20448 When this option is set, the owner of the file defined by the &%file%& option
20449 is checked to ensure that it is the same as the user under which the delivery
20450 process is running.
20451
20452
20453 .option check_string appendfile string "see below"
20454 .cindex "&""From""& line"
20455 As &(appendfile)& writes the message, the start of each line is tested for
20456 matching &%check_string%&, and if it does, the initial matching characters are
20457 replaced by the contents of &%escape_string%&. The value of &%check_string%& is
20458 a literal string, not a regular expression, and the case of any letters it
20459 contains is significant.
20460
20461 If &%use_bsmtp%& is set the values of &%check_string%& and &%escape_string%&
20462 are forced to &"."& and &".."& respectively, and any settings in the
20463 configuration are ignored. Otherwise, they default to &"From&~"& and
20464 &">From&~"& when the &%file%& option is set, and unset when any of the
20465 &%directory%&, &%maildir%&, or &%mailstore%& options are set.
20466
20467 The default settings, along with &%message_prefix%& and &%message_suffix%&, are
20468 suitable for traditional &"BSD"& mailboxes, where a line beginning with
20469 &"From&~"& indicates the start of a new message. All four options need changing
20470 if another format is used. For example, to deliver to mailboxes in MMDF format:
20471 .cindex "MMDF format mailbox"
20472 .cindex "mailbox" "MMDF format"
20473 .code
20474 check_string = "\1\1\1\1\n"
20475 escape_string = "\1\1\1\1 \n"
20476 message_prefix = "\1\1\1\1\n"
20477 message_suffix = "\1\1\1\1\n"
20478 .endd
20479 .option create_directory appendfile boolean true
20480 .cindex "directory creation"
20481 When this option is true, Exim attempts to create any missing superior
20482 directories for the file that it is about to write. A created directory's mode
20483 is given by the &%directory_mode%& option.
20484
20485 The group ownership of a newly created directory is highly dependent on the
20486 operating system (and possibly the file system) that is being used. For
20487 example, in Solaris, if the parent directory has the setgid bit set, its group
20488 is propagated to the child; if not, the currently set group is used. However,
20489 in FreeBSD, the parent's group is always used.
20490
20491
20492
20493 .option create_file appendfile string anywhere
20494 This option constrains the location of files and directories that are created
20495 by this transport. It applies to files defined by the &%file%& option and
20496 directories defined by the &%directory%& option. In the case of maildir
20497 delivery, it applies to the top level directory, not the maildir directories
20498 beneath.
20499
20500 The option must be set to one of the words &"anywhere"&, &"inhome"&, or
20501 &"belowhome"&. In the second and third cases, a home directory must have been
20502 set for the transport. This option is not useful when an explicit file name is
20503 given for normal mailbox deliveries. It is intended for the case when file
20504 names are generated from users' &_.forward_& files. These are usually handled
20505 by an &(appendfile)& transport called &%address_file%&. See also
20506 &%file_must_exist%&.
20507
20508
20509 .option directory appendfile string&!! unset
20510 This option is mutually exclusive with the &%file%& option, but one of &%file%&
20511 or &%directory%& must be set, unless the delivery is the direct result of a
20512 redirection (see section &<<SECTfildiropt>>&).
20513
20514 When &%directory%& is set, the string is expanded, and the message is delivered
20515 into a new file or files in or below the given directory, instead of being
20516 appended to a single mailbox file. A number of different formats are provided
20517 (see &%maildir_format%& and &%mailstore_format%&), and see section
20518 &<<SECTopdir>>& for further details of this form of delivery.
20519
20520
20521 .option directory_file appendfile string&!! "see below"
20522 .cindex "base62"
20523 .vindex "&$inode$&"
20524 When &%directory%& is set, but neither &%maildir_format%& nor
20525 &%mailstore_format%& is set, &(appendfile)& delivers each message into a file
20526 whose name is obtained by expanding this string. The default value is:
20527 .code
20528 q${base62:$tod_epoch}-$inode
20529 .endd
20530 This generates a unique name from the current time, in base 62 form, and the
20531 inode of the file. The variable &$inode$& is available only when expanding this
20532 option.
20533
20534
20535 .option directory_mode appendfile "octal integer" 0700
20536 If &(appendfile)& creates any directories as a result of the
20537 &%create_directory%& option, their mode is specified by this option.
20538
20539
20540 .option escape_string appendfile string "see description"
20541 See &%check_string%& above.
20542
20543
20544 .option file appendfile string&!! unset
20545 This option is mutually exclusive with the &%directory%& option, but one of
20546 &%file%& or &%directory%& must be set, unless the delivery is the direct result
20547 of a redirection (see section &<<SECTfildiropt>>&). The &%file%& option
20548 specifies a single file, to which the message is appended. One or more of
20549 &%use_fcntl_lock%&, &%use_flock_lock%&, or &%use_lockfile%& must be set with
20550 &%file%&.
20551
20552 .cindex "NFS" "lock file"
20553 .cindex "locking files"
20554 .cindex "lock files"
20555 If you are using more than one host to deliver over NFS into the same
20556 mailboxes, you should always use lock files.
20557
20558 The string value is expanded for each delivery, and must yield an absolute
20559 path. The most common settings of this option are variations on one of these
20560 examples:
20561 .code
20562 file = /var/spool/mail/$local_part
20563 file = /home/$local_part/inbox
20564 file = $home/inbox
20565 .endd
20566 .cindex "&""sticky""& bit"
20567 In the first example, all deliveries are done into the same directory. If Exim
20568 is configured to use lock files (see &%use_lockfile%& below) it must be able to
20569 create a file in the directory, so the &"sticky"& bit must be turned on for
20570 deliveries to be possible, or alternatively the &%group%& option can be used to
20571 run the delivery under a group id which has write access to the directory.
20572
20573
20574
20575 .option file_format appendfile string unset
20576 .cindex "file" "mailbox; checking existing format"
20577 This option requests the transport to check the format of an existing file
20578 before adding to it. The check consists of matching a specific string at the
20579 start of the file. The value of the option consists of an even number of
20580 colon-separated strings. The first of each pair is the test string, and the
20581 second is the name of a transport. If the transport associated with a matched
20582 string is not the current transport, control is passed over to the other
20583 transport. For example, suppose the standard &(local_delivery)& transport has
20584 this added to it:
20585 .code
20586 file_format = "From       : local_delivery :\
20587                \1\1\1\1\n : local_mmdf_delivery"
20588 .endd
20589 Mailboxes that begin with &"From"& are still handled by this transport, but if
20590 a mailbox begins with four binary ones followed by a newline, control is passed
20591 to a transport called &%local_mmdf_delivery%&, which presumably is configured
20592 to do the delivery in MMDF format. If a mailbox does not exist or is empty, it
20593 is assumed to match the current transport. If the start of a mailbox doesn't
20594 match any string, or if the transport named for a given string is not defined,
20595 delivery is deferred.
20596
20597
20598 .option file_must_exist appendfile boolean false
20599 If this option is true, the file specified by the &%file%& option must exist.
20600 A temporary error occurs if it does not, causing delivery to be deferred.
20601 If this option is false, the file is created if it does not exist.
20602
20603
20604 .option lock_fcntl_timeout appendfile time 0s
20605 .cindex "timeout" "mailbox locking"
20606 .cindex "mailbox" "locking, blocking and non-blocking"
20607 .cindex "locking files"
20608 By default, the &(appendfile)& transport uses non-blocking calls to &[fcntl()]&
20609 when locking an open mailbox file. If the call fails, the delivery process
20610 sleeps for &%lock_interval%& and tries again, up to &%lock_retries%& times.
20611 Non-blocking calls are used so that the file is not kept open during the wait
20612 for the lock; the reason for this is to make it as safe as possible for
20613 deliveries over NFS in the case when processes might be accessing an NFS
20614 mailbox without using a lock file. This should not be done, but
20615 misunderstandings and hence misconfigurations are not unknown.
20616
20617 On a busy system, however, the performance of a non-blocking lock approach is
20618 not as good as using a blocking lock with a timeout. In this case, the waiting
20619 is done inside the system call, and Exim's delivery process acquires the lock
20620 and can proceed as soon as the previous lock holder releases it.
20621
20622 If &%lock_fcntl_timeout%& is set to a non-zero time, blocking locks, with that
20623 timeout, are used. There may still be some retrying: the maximum number of
20624 retries is
20625 .code
20626 (lock_retries * lock_interval) / lock_fcntl_timeout
20627 .endd
20628 rounded up to the next whole number. In other words, the total time during
20629 which &(appendfile)& is trying to get a lock is roughly the same, unless
20630 &%lock_fcntl_timeout%& is set very large.
20631
20632 You should consider setting this option if you are getting a lot of delayed
20633 local deliveries because of errors of the form
20634 .code
20635 failed to lock mailbox /some/file (fcntl)
20636 .endd
20637
20638 .option lock_flock_timeout appendfile time 0s
20639 This timeout applies to file locking when using &[flock()]& (see
20640 &%use_flock%&); the timeout operates in a similar manner to
20641 &%lock_fcntl_timeout%&.
20642
20643
20644 .option lock_interval appendfile time 3s
20645 This specifies the time to wait between attempts to lock the file. See below
20646 for details of locking.
20647
20648
20649 .option lock_retries appendfile integer 10
20650 This specifies the maximum number of attempts to lock the file. A value of zero
20651 is treated as 1. See below for details of locking.
20652
20653
20654 .option lockfile_mode appendfile "octal integer" 0600
20655 This specifies the mode of the created lock file, when a lock file is being
20656 used (see &%use_lockfile%& and &%use_mbx_lock%&).
20657
20658
20659 .option lockfile_timeout appendfile time 30m
20660 .cindex "timeout" "mailbox locking"
20661 When a lock file is being used (see &%use_lockfile%&), if a lock file already
20662 exists and is older than this value, it is assumed to have been left behind by
20663 accident, and Exim attempts to remove it.
20664
20665
20666 .option mailbox_filecount appendfile string&!! unset
20667 .cindex "mailbox" "specifying size of"
20668 .cindex "size" "of mailbox"
20669 If this option is set, it is expanded, and the result is taken as the current
20670 number of files in the mailbox. It must be a decimal number, optionally
20671 followed by K or M. This provides a way of obtaining this information from an
20672 external source that maintains the data.
20673
20674
20675 .option mailbox_size appendfile string&!! unset
20676 .cindex "mailbox" "specifying size of"
20677 .cindex "size" "of mailbox"
20678 If this option is set, it is expanded, and the result is taken as the current
20679 size the mailbox. It must be a decimal number, optionally followed by K or M.
20680 This provides a way of obtaining this information from an external source that
20681 maintains the data. This is likely to be helpful for maildir deliveries where
20682 it is computationally expensive to compute the size of a mailbox.
20683
20684
20685
20686 .option maildir_format appendfile boolean false
20687 .cindex "maildir format" "specifying"
20688 If this option is set with the &%directory%& option, the delivery is into a new
20689 file, in the &"maildir"& format that is used by other mail software. When the
20690 transport is activated directly from a &(redirect)& router (for example, the
20691 &(address_file)& transport in the default configuration), setting
20692 &%maildir_format%& causes the path received from the router to be treated as a
20693 directory, whether or not it ends with &`/`&. This option is available only if
20694 SUPPORT_MAILDIR is present in &_Local/Makefile_&. See section
20695 &<<SECTmaildirdelivery>>& below for further details.
20696
20697
20698 .option maildir_quota_directory_regex appendfile string "See below"
20699 .cindex "maildir format" "quota; directories included in"
20700 .cindex "quota" "maildir; directories included in"
20701 This option is relevant only when &%maildir_use_size_file%& is set. It defines
20702 a regular expression for specifying directories, relative to the quota
20703 directory (see &%quota_directory%&), that should be included in the quota
20704 calculation. The default value is:
20705 .code
20706 maildir_quota_directory_regex = ^(?:cur|new|\..*)$
20707 .endd
20708 This includes the &_cur_& and &_new_& directories, and any maildir++ folders
20709 (directories whose names begin with a dot). If you want to exclude the
20710 &_Trash_&
20711 folder from the count (as some sites do), you need to change this setting to
20712 .code
20713 maildir_quota_directory_regex = ^(?:cur|new|\.(?!Trash).*)$
20714 .endd
20715 This uses a negative lookahead in the regular expression to exclude the
20716 directory whose name is &_.Trash_&. When a directory is excluded from quota
20717 calculations, quota processing is bypassed for any messages that are delivered
20718 directly into that directory.
20719
20720
20721 .option maildir_retries appendfile integer 10
20722 This option specifies the number of times to retry when writing a file in
20723 &"maildir"& format. See section &<<SECTmaildirdelivery>>& below.
20724
20725
20726 .option maildir_tag appendfile string&!! unset
20727 This option applies only to deliveries in maildir format, and is described in
20728 section &<<SECTmaildirdelivery>>& below.
20729
20730
20731 .option maildir_use_size_file appendfile&!! boolean false
20732 .cindex "maildir format" "&_maildirsize_& file"
20733 The result of string expansion for this option must be a valid boolean value.
20734 If it is true, it enables support for &_maildirsize_& files. Exim
20735 creates a &_maildirsize_& file in a maildir if one does not exist, taking the
20736 quota from the &%quota%& option of the transport. If &%quota%& is unset, the
20737 value is zero. See &%maildir_quota_directory_regex%& above and section
20738 &<<SECTmaildirdelivery>>& below for further details.
20739
20740 .option maildirfolder_create_regex appendfile string unset
20741 .cindex "maildir format" "&_maildirfolder_& file"
20742 .cindex "&_maildirfolder_&, creating"
20743 The value of this option is a regular expression. If it is unset, it has no
20744 effect. Otherwise, before a maildir delivery takes place, the pattern is
20745 matched against the name of the maildir directory, that is, the directory
20746 containing the &_new_& and &_tmp_& subdirectories that will be used for the
20747 delivery. If there is a match, Exim checks for the existence of a file called
20748 &_maildirfolder_& in the directory, and creates it if it does not exist.
20749 See section &<<SECTmaildirdelivery>>& for more details.
20750
20751
20752 .option mailstore_format appendfile boolean false
20753 .cindex "mailstore format" "specifying"
20754 If this option is set with the &%directory%& option, the delivery is into two
20755 new files in  &"mailstore"& format. The option is available only if
20756 SUPPORT_MAILSTORE is present in &_Local/Makefile_&. See section &<<SECTopdir>>&
20757 below for further details.
20758
20759
20760 .option mailstore_prefix appendfile string&!! unset
20761 This option applies only to deliveries in mailstore format, and is described in
20762 section &<<SECTopdir>>& below.
20763
20764
20765 .option mailstore_suffix appendfile string&!! unset
20766 This option applies only to deliveries in mailstore format, and is described in
20767 section &<<SECTopdir>>& below.
20768
20769
20770 .option mbx_format appendfile boolean false
20771 .cindex "locking files"
20772 .cindex "file" "locking"
20773 .cindex "file" "MBX format"
20774 .cindex "MBX format, specifying"
20775 This option is available only if Exim has been compiled with SUPPORT_MBX
20776 set in &_Local/Makefile_&. If &%mbx_format%& is set with the &%file%& option,
20777 the message is appended to the mailbox file in MBX format instead of
20778 traditional Unix format. This format is supported by Pine4 and its associated
20779 IMAP and POP daemons, by means of the &'c-client'& library that they all use.
20780
20781 &*Note*&: The &%message_prefix%& and &%message_suffix%& options are not
20782 automatically changed by the use of &%mbx_format%&. They should normally be set
20783 empty when using MBX format, so this option almost always appears in this
20784 combination:
20785 .code
20786 mbx_format = true
20787 message_prefix =
20788 message_suffix =
20789 .endd
20790 If none of the locking options are mentioned in the configuration,
20791 &%use_mbx_lock%& is assumed and the other locking options default to false. It
20792 is possible to specify the other kinds of locking with &%mbx_format%&, but
20793 &%use_fcntl_lock%& and &%use_mbx_lock%& are mutually exclusive. MBX locking
20794 interworks with &'c-client'&, providing for shared access to the mailbox. It
20795 should not be used if any program that does not use this form of locking is
20796 going to access the mailbox, nor should it be used if the mailbox file is NFS
20797 mounted, because it works only when the mailbox is accessed from a single host.
20798
20799 If you set &%use_fcntl_lock%& with an MBX-format mailbox, you cannot use
20800 the standard version of &'c-client'&, because as long as it has a mailbox open
20801 (this means for the whole of a Pine or IMAP session), Exim will not be able to
20802 append messages to it.
20803
20804
20805 .option message_prefix appendfile string&!! "see below"
20806 .cindex "&""From""& line"
20807 The string specified here is expanded and output at the start of every message.
20808 The default is unset unless &%file%& is specified and &%use_bsmtp%& is not set,
20809 in which case it is:
20810 .code
20811 message_prefix = "From ${if def:return_path{$return_path}\
20812   {MAILER-DAEMON}} $tod_bsdinbox\n"
20813 .endd
20814 &*Note:*& If you set &%use_crlf%& true, you must change any occurrences of
20815 &`\n`& to &`\r\n`& in &%message_prefix%&.
20816
20817 .option message_suffix appendfile string&!! "see below"
20818 The string specified here is expanded and output at the end of every message.
20819 The default is unset unless &%file%& is specified and &%use_bsmtp%& is not set,
20820 in which case it is a single newline character. The suffix can be suppressed by
20821 setting
20822 .code
20823 message_suffix =
20824 .endd
20825 &*Note:*& If you set &%use_crlf%& true, you must change any occurrences of
20826 &`\n`& to &`\r\n`& in &%message_suffix%&.
20827
20828 .option mode appendfile "octal integer" 0600
20829 If the output file is created, it is given this mode. If it already exists and
20830 has wider permissions, they are reduced to this mode. If it has narrower
20831 permissions, an error occurs unless &%mode_fail_narrower%& is false. However,
20832 if the delivery is the result of a &%save%& command in a filter file specifying
20833 a particular mode, the mode of the output file is always forced to take that
20834 value, and this option is ignored.
20835
20836
20837 .option mode_fail_narrower appendfile boolean true
20838 This option applies in the case when an existing mailbox file has a narrower
20839 mode than that specified by the &%mode%& option. If &%mode_fail_narrower%& is
20840 true, the delivery is deferred (&"mailbox has the wrong mode"&); otherwise Exim
20841 continues with the delivery attempt, using the existing mode of the file.
20842
20843
20844 .option notify_comsat appendfile boolean false
20845 If this option is true, the &'comsat'& daemon is notified after every
20846 successful delivery to a user mailbox. This is the daemon that notifies logged
20847 on users about incoming mail.
20848
20849
20850 .option quota appendfile string&!! unset
20851 .cindex "quota" "imposed by Exim"
20852 This option imposes a limit on the size of the file to which Exim is appending,
20853 or to the total space used in the directory tree when the &%directory%& option
20854 is set. In the latter case, computation of the space used is expensive, because
20855 all the files in the directory (and any sub-directories) have to be
20856 individually inspected and their sizes summed. (See &%quota_size_regex%& and
20857 &%maildir_use_size_file%& for ways to avoid this in environments where users
20858 have no shell access to their mailboxes).
20859
20860 As there is no interlock against two simultaneous deliveries into a
20861 multi-file mailbox, it is possible for the quota to be overrun in this case.
20862 For single-file mailboxes, of course, an interlock is a necessity.
20863
20864 A file's size is taken as its &'used'& value. Because of blocking effects, this
20865 may be a lot less than the actual amount of disk space allocated to the file.
20866 If the sizes of a number of files are being added up, the rounding effect can
20867 become quite noticeable, especially on systems that have large block sizes.
20868 Nevertheless, it seems best to stick to the &'used'& figure, because this is
20869 the obvious value which users understand most easily.
20870
20871 The value of the option is expanded, and must then be a numerical value
20872 (decimal point allowed), optionally followed by one of the letters K, M, or G,
20873 for kilobytes, megabytes, or gigabytes. If Exim is running on a system with
20874 large file support (Linux and FreeBSD have this), mailboxes larger than 2G can
20875 be handled.
20876
20877 &*Note*&: A value of zero is interpreted as &"no quota"&.
20878
20879 The expansion happens while Exim is running as root, before it changes uid for
20880 the delivery. This means that files that are inaccessible to the end user can
20881 be used to hold quota values that are looked up in the expansion. When delivery
20882 fails because this quota is exceeded, the handling of the error is as for
20883 system quota failures.
20884
20885 By default, Exim's quota checking mimics system quotas, and restricts the
20886 mailbox to the specified maximum size, though the value is not accurate to the
20887 last byte, owing to separator lines and additional headers that may get added
20888 during message delivery. When a mailbox is nearly full, large messages may get
20889 refused even though small ones are accepted, because the size of the current
20890 message is added to the quota when the check is made. This behaviour can be
20891 changed by setting &%quota_is_inclusive%& false. When this is done, the check
20892 for exceeding the quota does not include the current message. Thus, deliveries
20893 continue until the quota has been exceeded; thereafter, no further messages are
20894 delivered. See also &%quota_warn_threshold%&.
20895
20896
20897 .option quota_directory appendfile string&!! unset
20898 This option defines the directory to check for quota purposes when delivering
20899 into individual files. The default is the delivery directory, or, if a file
20900 called &_maildirfolder_& exists in a maildir directory, the parent of the
20901 delivery directory.
20902
20903
20904 .option quota_filecount appendfile string&!! 0
20905 This option applies when the &%directory%& option is set. It limits the total
20906 number of files in the directory (compare the inode limit in system quotas). It
20907 can only be used if &%quota%& is also set. The value is expanded; an expansion
20908 failure causes delivery to be deferred. A value of zero is interpreted as
20909 &"no quota"&.
20910
20911
20912 .option quota_is_inclusive appendfile boolean true
20913 See &%quota%& above.
20914
20915
20916 .option quota_size_regex appendfile string unset
20917 This option applies when one of the delivery modes that writes a separate file
20918 for each message is being used. When Exim wants to find the size of one of
20919 these files in order to test the quota, it first checks &%quota_size_regex%&.
20920 If this is set to a regular expression that matches the file name, and it
20921 captures one string, that string is interpreted as a representation of the
20922 file's size. The value of &%quota_size_regex%& is not expanded.
20923
20924 This feature is useful only when users have no shell access to their mailboxes
20925 &-- otherwise they could defeat the quota simply by renaming the files. This
20926 facility can be used with maildir deliveries, by setting &%maildir_tag%& to add
20927 the file length to the file name. For example:
20928 .code
20929 maildir_tag = ,S=$message_size
20930 quota_size_regex = ,S=(\d+)
20931 .endd
20932 An alternative to &$message_size$& is &$message_linecount$&, which contains the
20933 number of lines in the message.
20934
20935 The regular expression should not assume that the length is at the end of the
20936 file name (even though &%maildir_tag%& puts it there) because maildir MUAs
20937 sometimes add other information onto the ends of message file names.
20938
20939 Section &<<SECID136>>& contains further information.
20940
20941
20942 .option quota_warn_message appendfile string&!! "see below"
20943 See below for the use of this option. If it is not set when
20944 &%quota_warn_threshold%& is set, it defaults to
20945 .code
20946 quota_warn_message = "\
20947   To: $local_part@$domain\n\
20948   Subject: Your mailbox\n\n\
20949   This message is automatically created \
20950   by mail delivery software.\n\n\
20951   The size of your mailbox has exceeded \
20952   a warning threshold that is\n\
20953   set by the system administrator.\n"
20954 .endd
20955
20956
20957 .option quota_warn_threshold appendfile string&!! 0
20958 .cindex "quota" "warning threshold"
20959 .cindex "mailbox" "size warning"
20960 .cindex "size" "of mailbox"
20961 This option is expanded in the same way as &%quota%& (see above). If the
20962 resulting value is greater than zero, and delivery of the message causes the
20963 size of the file or total space in the directory tree to cross the given
20964 threshold, a warning message is sent. If &%quota%& is also set, the threshold
20965 may be specified as a percentage of it by following the value with a percent
20966 sign. For example:
20967 .code
20968 quota = 10M
20969 quota_warn_threshold = 75%
20970 .endd
20971 If &%quota%& is not set, a setting of &%quota_warn_threshold%& that ends with a
20972 percent sign is ignored.
20973
20974 The warning message itself is specified by the &%quota_warn_message%& option,
20975 and it must start with a &'To:'& header line containing the recipient(s) of the
20976 warning message. These do not necessarily have to include the recipient(s) of
20977 the original message. A &'Subject:'& line should also normally be supplied. You
20978 can include any other header lines that you want. If you do not include a
20979 &'From:'& line, the default is:
20980 .code
20981 From: Mail Delivery System <mailer-daemon@$qualify_domain_sender>
20982 .endd
20983 .oindex &%errors_reply_to%&
20984 If you supply a &'Reply-To:'& line, it overrides the global &%errors_reply_to%&
20985 option.
20986
20987 The &%quota%& option does not have to be set in order to use this option; they
20988 are independent of one another except when the threshold is specified as a
20989 percentage.
20990
20991
20992 .option use_bsmtp appendfile boolean false
20993 .cindex "envelope sender"
20994 If this option is set true, &(appendfile)& writes messages in &"batch SMTP"&
20995 format, with the envelope sender and recipient(s) included as SMTP commands. If
20996 you want to include a leading HELO command with such messages, you can do
20997 so by setting the &%message_prefix%& option. See section &<<SECTbatchSMTP>>&
20998 for details of batch SMTP.
20999
21000
21001 .option use_crlf appendfile boolean false
21002 .cindex "carriage return"
21003 .cindex "linefeed"
21004 This option causes lines to be terminated with the two-character CRLF sequence
21005 (carriage return, linefeed) instead of just a linefeed character. In the case
21006 of batched SMTP, the byte sequence written to the file is then an exact image
21007 of what would be sent down a real SMTP connection.
21008
21009 &*Note:*& The contents of the &%message_prefix%& and &%message_suffix%& options
21010 (which are used to supply the traditional &"From&~"& and blank line separators
21011 in Berkeley-style mailboxes) are written verbatim, so must contain their own
21012 carriage return characters if these are needed. In cases where these options
21013 have non-empty defaults, the values end with a single linefeed, so they must be
21014 changed to end with &`\r\n`& if &%use_crlf%& is set.
21015
21016
21017 .option use_fcntl_lock appendfile boolean "see below"
21018 This option controls the use of the &[fcntl()]& function to lock a file for
21019 exclusive use when a message is being appended. It is set by default unless
21020 &%use_flock_lock%& is set. Otherwise, it should be turned off only if you know
21021 that all your MUAs use lock file locking. When both &%use_fcntl_lock%& and
21022 &%use_flock_lock%& are unset, &%use_lockfile%& must be set.
21023
21024
21025 .option use_flock_lock appendfile boolean false
21026 This option is provided to support the use of &[flock()]& for file locking, for
21027 the few situations where it is needed. Most modern operating systems support
21028 &[fcntl()]& and &[lockf()]& locking, and these two functions interwork with
21029 each other. Exim uses &[fcntl()]& locking by default.
21030
21031 This option is required only if you are using an operating system where
21032 &[flock()]& is used by programs that access mailboxes (typically MUAs), and
21033 where &[flock()]& does not correctly interwork with &[fcntl()]&. You can use
21034 both &[fcntl()]& and &[flock()]& locking simultaneously if you want.
21035
21036 .cindex "Solaris" "&[flock()]& support"
21037 Not all operating systems provide &[flock()]&. Some versions of Solaris do not
21038 have it (and some, I think, provide a not quite right version built on top of
21039 &[lockf()]&). If the OS does not have &[flock()]&, Exim will be built without
21040 the ability to use it, and any attempt to do so will cause a configuration
21041 error.
21042
21043 &*Warning*&: &[flock()]& locks do not work on NFS files (unless &[flock()]&
21044 is just being mapped onto &[fcntl()]& by the OS).
21045
21046
21047 .option use_lockfile appendfile boolean "see below"
21048 If this option is turned off, Exim does not attempt to create a lock file when
21049 appending to a mailbox file. In this situation, the only locking is by
21050 &[fcntl()]&. You should only turn &%use_lockfile%& off if you are absolutely
21051 sure that every MUA that is ever going to look at your users' mailboxes uses
21052 &[fcntl()]& rather than a lock file, and even then only when you are not
21053 delivering over NFS from more than one host.
21054
21055 .cindex "NFS" "lock file"
21056 In order to append to an NFS file safely from more than one host, it is
21057 necessary to take out a lock &'before'& opening the file, and the lock file
21058 achieves this. Otherwise, even with &[fcntl()]& locking, there is a risk of
21059 file corruption.
21060
21061 The &%use_lockfile%& option is set by default unless &%use_mbx_lock%& is set.
21062 It is not possible to turn both &%use_lockfile%& and &%use_fcntl_lock%& off,
21063 except when &%mbx_format%& is set.
21064
21065
21066 .option use_mbx_lock appendfile boolean "see below"
21067 This option is available only if Exim has been compiled with SUPPORT_MBX
21068 set in &_Local/Makefile_&. Setting the option specifies that special MBX
21069 locking rules be used. It is set by default if &%mbx_format%& is set and none
21070 of the locking options are mentioned in the configuration. The locking rules
21071 are the same as are used by the &'c-client'& library that underlies Pine and
21072 the IMAP4 and POP daemons that come with it (see the discussion below). The
21073 rules allow for shared access to the mailbox. However, this kind of locking
21074 does not work when the mailbox is NFS mounted.
21075
21076 You can set &%use_mbx_lock%& with either (or both) of &%use_fcntl_lock%& and
21077 &%use_flock_lock%& to control what kind of locking is used in implementing the
21078 MBX locking rules. The default is to use &[fcntl()]& if &%use_mbx_lock%& is set
21079 without &%use_fcntl_lock%& or &%use_flock_lock%&.
21080
21081
21082
21083
21084 .section "Operational details for appending" "SECTopappend"
21085 .cindex "appending to a file"
21086 .cindex "file" "appending"
21087 Before appending to a file, the following preparations are made:
21088
21089 .ilist
21090 If the name of the file is &_/dev/null_&, no action is taken, and a success
21091 return is given.
21092
21093 .next
21094 .cindex "directory creation"
21095 If any directories on the file's path are missing, Exim creates them if the
21096 &%create_directory%& option is set. A created directory's mode is given by the
21097 &%directory_mode%& option.
21098
21099 .next
21100 If &%file_format%& is set, the format of an existing file is checked. If this
21101 indicates that a different transport should be used, control is passed to that
21102 transport.
21103
21104 .next
21105 .cindex "file" "locking"
21106 .cindex "locking files"
21107 .cindex "NFS" "lock file"
21108 If &%use_lockfile%& is set, a lock file is built in a way that will work
21109 reliably over NFS, as follows:
21110
21111 .olist
21112 Create a &"hitching post"& file whose name is that of the lock file with the
21113 current time, primary host name, and process id added, by opening for writing
21114 as a new file. If this fails with an access error, delivery is deferred.
21115 .next
21116 Close the hitching post file, and hard link it to the lock file name.
21117 .next
21118 If the call to &[link()]& succeeds, creation of the lock file has succeeded.
21119 Unlink the hitching post name.
21120 .next
21121 Otherwise, use &[stat()]& to get information about the hitching post file, and
21122 then unlink hitching post name. If the number of links is exactly two, creation
21123 of the lock file succeeded but something (for example, an NFS server crash and
21124 restart) caused this fact not to be communicated to the &[link()]& call.
21125 .next
21126 If creation of the lock file failed, wait for &%lock_interval%& and try again,
21127 up to &%lock_retries%& times. However, since any program that writes to a
21128 mailbox should complete its task very quickly, it is reasonable to time out old
21129 lock files that are normally the result of user agent and system crashes. If an
21130 existing lock file is older than &%lockfile_timeout%& Exim attempts to unlink
21131 it before trying again.
21132 .endlist olist
21133
21134 .next
21135 A call is made to &[lstat()]& to discover whether the main file exists, and if
21136 so, what its characteristics are. If &[lstat()]& fails for any reason other
21137 than non-existence, delivery is deferred.
21138
21139 .next
21140 .cindex "symbolic link" "to mailbox"
21141 .cindex "mailbox" "symbolic link"
21142 If the file does exist and is a symbolic link, delivery is deferred, unless the
21143 &%allow_symlink%& option is set, in which case the ownership of the link is
21144 checked, and then &[stat()]& is called to find out about the real file, which
21145 is then subjected to the checks below. The check on the top-level link
21146 ownership prevents one user creating a link for another's mailbox in a sticky
21147 directory, though allowing symbolic links in this case is definitely not a good
21148 idea. If there is a chain of symbolic links, the intermediate ones are not
21149 checked.
21150
21151 .next
21152 If the file already exists but is not a regular file, or if the file's owner
21153 and group (if the group is being checked &-- see &%check_group%& above) are
21154 different from the user and group under which the delivery is running,
21155 delivery is deferred.
21156
21157 .next
21158 If the file's permissions are more generous than specified, they are reduced.
21159 If they are insufficient, delivery is deferred, unless &%mode_fail_narrower%&
21160 is set false, in which case the delivery is tried using the existing
21161 permissions.
21162
21163 .next
21164 The file's inode number is saved, and the file is then opened for appending.
21165 If this fails because the file has vanished, &(appendfile)& behaves as if it
21166 hadn't existed (see below). For any other failures, delivery is deferred.
21167
21168 .next
21169 If the file is opened successfully, check that the inode number hasn't
21170 changed, that it is still a regular file, and that the owner and permissions
21171 have not changed. If anything is wrong, defer delivery and freeze the message.
21172
21173 .next
21174 If the file did not exist originally, defer delivery if the &%file_must_exist%&
21175 option is set. Otherwise, check that the file is being created in a permitted
21176 directory if the &%create_file%& option is set (deferring on failure), and then
21177 open for writing as a new file, with the O_EXCL and O_CREAT options,
21178 except when dealing with a symbolic link (the &%allow_symlink%& option must be
21179 set). In this case, which can happen if the link points to a non-existent file,
21180 the file is opened for writing using O_CREAT but not O_EXCL, because
21181 that prevents link following.
21182
21183 .next
21184 .cindex "loop" "while file testing"
21185 If opening fails because the file exists, obey the tests given above for
21186 existing files. However, to avoid looping in a situation where the file is
21187 being continuously created and destroyed, the exists/not-exists loop is broken
21188 after 10 repetitions, and the message is then frozen.
21189
21190 .next
21191 If opening fails with any other error, defer delivery.
21192
21193 .next
21194 .cindex "file" "locking"
21195 .cindex "locking files"
21196 Once the file is open, unless both &%use_fcntl_lock%& and &%use_flock_lock%&
21197 are false, it is locked using &[fcntl()]& or &[flock()]& or both. If
21198 &%use_mbx_lock%& is false, an exclusive lock is requested in each case.
21199 However, if &%use_mbx_lock%& is true, Exim takes out a shared lock on the open
21200 file, and an exclusive lock on the file whose name is
21201 .code
21202 /tmp/.<device-number>.<inode-number>
21203 .endd
21204 using the device and inode numbers of the open mailbox file, in accordance with
21205 the MBX locking rules. This file is created with a mode that is specified by
21206 the &%lockfile_mode%& option.
21207
21208 If Exim fails to lock the file, there are two possible courses of action,
21209 depending on the value of the locking timeout. This is obtained from
21210 &%lock_fcntl_timeout%& or &%lock_flock_timeout%&, as appropriate.
21211
21212 If the timeout value is zero, the file is closed, Exim waits for
21213 &%lock_interval%&, and then goes back and re-opens the file as above and tries
21214 to lock it again. This happens up to &%lock_retries%& times, after which the
21215 delivery is deferred.
21216
21217 If the timeout has a value greater than zero, blocking calls to &[fcntl()]& or
21218 &[flock()]& are used (with the given timeout), so there has already been some
21219 waiting involved by the time locking fails. Nevertheless, Exim does not give up
21220 immediately. It retries up to
21221 .code
21222 (lock_retries * lock_interval) / <timeout>
21223 .endd
21224 times (rounded up).
21225 .endlist
21226
21227 At the end of delivery, Exim closes the file (which releases the &[fcntl()]&
21228 and/or &[flock()]& locks) and then deletes the lock file if one was created.
21229
21230
21231 .section "Operational details for delivery to a new file" "SECTopdir"
21232 .cindex "delivery" "to single file"
21233 .cindex "&""From""& line"
21234 When the &%directory%& option is set instead of &%file%&, each message is
21235 delivered into a newly-created file or set of files. When &(appendfile)& is
21236 activated directly from a &(redirect)& router, neither &%file%& nor
21237 &%directory%& is normally set, because the path for delivery is supplied by the
21238 router. (See for example, the &(address_file)& transport in the default
21239 configuration.) In this case, delivery is to a new file if either the path name
21240 ends in &`/`&, or the &%maildir_format%& or &%mailstore_format%& option is set.
21241
21242 No locking is required while writing the message to a new file, so the various
21243 locking options of the transport are ignored. The &"From"& line that by default
21244 separates messages in a single file is not normally needed, nor is the escaping
21245 of message lines that start with &"From"&, and there is no need to ensure a
21246 newline at the end of each message. Consequently, the default values for
21247 &%check_string%&, &%message_prefix%&, and &%message_suffix%& are all unset when
21248 any of &%directory%&, &%maildir_format%&, or &%mailstore_format%& is set.
21249
21250 If Exim is required to check a &%quota%& setting, it adds up the sizes of all
21251 the files in the delivery directory by default. However, you can specify a
21252 different directory by setting &%quota_directory%&. Also, for maildir
21253 deliveries (see below) the &_maildirfolder_& convention is honoured.
21254
21255
21256 .cindex "maildir format"
21257 .cindex "mailstore format"
21258 There are three different ways in which delivery to individual files can be
21259 done, controlled by the settings of the &%maildir_format%& and
21260 &%mailstore_format%& options. Note that code to support maildir or mailstore
21261 formats is not included in the binary unless SUPPORT_MAILDIR or
21262 SUPPORT_MAILSTORE, respectively, is set in &_Local/Makefile_&.
21263
21264 .cindex "directory creation"
21265 In all three cases an attempt is made to create the directory and any necessary
21266 sub-directories if they do not exist, provided that the &%create_directory%&
21267 option is set (the default). The location of a created directory can be
21268 constrained by setting &%create_file%&. A created directory's mode is given by
21269 the &%directory_mode%& option. If creation fails, or if the
21270 &%create_directory%& option is not set when creation is required, delivery is
21271 deferred.
21272
21273
21274
21275 .section "Maildir delivery" "SECTmaildirdelivery"
21276 .cindex "maildir format" "description of"
21277 If the &%maildir_format%& option is true, Exim delivers each message by writing
21278 it to a file whose name is &_tmp/<stime>.H<mtime>P<pid>.<host>_& in the
21279 directory that is defined by the &%directory%& option (the &"delivery
21280 directory"&). If the delivery is successful, the file is renamed into the
21281 &_new_& subdirectory.
21282
21283 In the file name, <&'stime'&> is the current time of day in seconds, and
21284 <&'mtime'&> is the microsecond fraction of the time. After a maildir delivery,
21285 Exim checks that the time-of-day clock has moved on by at least one microsecond
21286 before terminating the delivery process. This guarantees uniqueness for the
21287 file name. However, as a precaution, Exim calls &[stat()]& for the file before
21288 opening it. If any response other than ENOENT (does not exist) is given,
21289 Exim waits 2 seconds and tries again, up to &%maildir_retries%& times.
21290
21291 Before Exim carries out a maildir delivery, it ensures that subdirectories
21292 called &_new_&, &_cur_&, and &_tmp_& exist in the delivery directory. If they
21293 do not exist, Exim tries to create them and any superior directories in their
21294 path, subject to the &%create_directory%& and &%create_file%& options. If the
21295 &%maildirfolder_create_regex%& option is set, and the regular expression it
21296 contains matches the delivery directory, Exim also ensures that a file called
21297 &_maildirfolder_& exists in the delivery directory. If a missing directory or
21298 &_maildirfolder_& file cannot be created, delivery is deferred.
21299
21300 These features make it possible to use Exim to create all the necessary files
21301 and directories in a maildir mailbox, including subdirectories for maildir++
21302 folders. Consider this example:
21303 .code
21304 maildir_format = true
21305 directory = /var/mail/$local_part\
21306            ${if eq{$local_part_suffix}{}{}\
21307            {/.${substr_1:$local_part_suffix}}}
21308 maildirfolder_create_regex = /\.[^/]+$
21309 .endd
21310 If &$local_part_suffix$& is empty (there was no suffix for the local part),
21311 delivery is into a toplevel maildir with a name like &_/var/mail/pimbo_& (for
21312 the user called &'pimbo'&). The pattern in &%maildirfolder_create_regex%& does
21313 not match this name, so Exim will not look for or create the file
21314 &_/var/mail/pimbo/maildirfolder_&, though it will create
21315 &_/var/mail/pimbo/{cur,new,tmp}_& if necessary.
21316
21317 However, if &$local_part_suffix$& contains &`-eximusers`& (for example),
21318 delivery is into the maildir++ folder &_/var/mail/pimbo/.eximusers_&, which
21319 does match &%maildirfolder_create_regex%&. In this case, Exim will create
21320 &_/var/mail/pimbo/.eximusers/maildirfolder_& as well as the three maildir
21321 directories &_/var/mail/pimbo/.eximusers/{cur,new,tmp}_&.
21322
21323 &*Warning:*& Take care when setting &%maildirfolder_create_regex%& that it does
21324 not inadvertently match the toplevel maildir directory, because a
21325 &_maildirfolder_& file at top level would completely break quota calculations.
21326
21327 .cindex "quota" "in maildir delivery"
21328 .cindex "maildir++"
21329 If Exim is required to check a &%quota%& setting before a maildir delivery, and
21330 &%quota_directory%& is not set, it looks for a file called &_maildirfolder_& in
21331 the maildir directory (alongside &_new_&, &_cur_&, &_tmp_&). If this exists,
21332 Exim assumes the directory is a maildir++ folder directory, which is one level
21333 down from the user's top level mailbox directory. This causes it to start at
21334 the parent directory instead of the current directory when calculating the
21335 amount of space used.
21336
21337 One problem with delivering into a multi-file mailbox is that it is
21338 computationally expensive to compute the size of the mailbox for quota
21339 checking. Various approaches have been taken to reduce the amount of work
21340 needed. The next two sections describe two of them. A third alternative is to
21341 use some external process for maintaining the size data, and use the expansion
21342 of the &%mailbox_size%& option as a way of importing it into Exim.
21343
21344
21345
21346
21347 .section "Using tags to record message sizes" "SECID135"
21348 If &%maildir_tag%& is set, the string is expanded for each delivery.
21349 When the maildir file is renamed into the &_new_& sub-directory, the
21350 tag is added to its name. However, if adding the tag takes the length of the
21351 name to the point where the test &[stat()]& call fails with ENAMETOOLONG,
21352 the tag is dropped and the maildir file is created with no tag.
21353
21354
21355 .vindex "&$message_size$&"
21356 Tags can be used to encode the size of files in their names; see
21357 &%quota_size_regex%& above for an example. The expansion of &%maildir_tag%&
21358 happens after the message has been written. The value of the &$message_size$&
21359 variable is set to the number of bytes actually written. If the expansion is
21360 forced to fail, the tag is ignored, but a non-forced failure causes delivery to
21361 be deferred. The expanded tag may contain any printing characters except &"/"&.
21362 Non-printing characters in the string are ignored; if the resulting string is
21363 empty, it is ignored. If it starts with an alphanumeric character, a leading
21364 colon is inserted; this default has not proven to be the path that popular
21365 maildir implementations have chosen (but changing it in Exim would break
21366 backwards compatibility).
21367
21368 For one common implementation, you might set:
21369 .code
21370 maildir_tag = ,S=${message_size}
21371 .endd
21372 but you should check the documentation of the other software to be sure.
21373
21374 It is advisable to also set &%quota_size_regex%& when setting &%maildir_tag%&
21375 as this allows Exim to extract the size from your tag, instead of having to
21376 &[stat()]& each message file.
21377
21378
21379 .section "Using a maildirsize file" "SECID136"
21380 .cindex "quota" "in maildir delivery"
21381 .cindex "maildir format" "&_maildirsize_& file"
21382 If &%maildir_use_size_file%& is true, Exim implements the maildir++ rules for
21383 storing quota and message size information in a file called &_maildirsize_&
21384 within the toplevel maildir directory. If this file does not exist, Exim
21385 creates it, setting the quota from the &%quota%& option of the transport. If
21386 the maildir directory itself does not exist, it is created before any attempt
21387 to write a &_maildirsize_& file.
21388
21389 The &_maildirsize_& file is used to hold information about the sizes of
21390 messages in the maildir, thus speeding up quota calculations. The quota value
21391 in the file is just a cache; if the quota is changed in the transport, the new
21392 value overrides the cached value when the next message is delivered. The cache
21393 is maintained for the benefit of other programs that access the maildir and
21394 need to know the quota.
21395
21396 If the &%quota%& option in the transport is unset or zero, the &_maildirsize_&
21397 file is maintained (with a zero quota setting), but no quota is imposed.
21398
21399 A regular expression is available for controlling which directories in the
21400 maildir participate in quota calculations when a &_maildirsizefile_& is in use.
21401 See the description of the &%maildir_quota_directory_regex%& option above for
21402 details.
21403
21404
21405 .section "Mailstore delivery" "SECID137"
21406 .cindex "mailstore format" "description of"
21407 If the &%mailstore_format%& option is true, each message is written as two
21408 files in the given directory. A unique base name is constructed from the
21409 message id and the current delivery process, and the files that are written use
21410 this base name plus the suffixes &_.env_& and &_.msg_&. The &_.env_& file
21411 contains the message's envelope, and the &_.msg_& file contains the message
21412 itself. The base name is placed in the variable &$mailstore_basename$&.
21413
21414 During delivery, the envelope is first written to a file with the suffix
21415 &_.tmp_&. The &_.msg_& file is then written, and when it is complete, the
21416 &_.tmp_& file is renamed as the &_.env_& file. Programs that access messages in
21417 mailstore format should wait for the presence of both a &_.msg_& and a &_.env_&
21418 file before accessing either of them. An alternative approach is to wait for
21419 the absence of a &_.tmp_& file.
21420
21421 The envelope file starts with any text defined by the &%mailstore_prefix%&
21422 option, expanded and terminated by a newline if there isn't one. Then follows
21423 the sender address on one line, then all the recipient addresses, one per line.
21424 There can be more than one recipient only if the &%batch_max%& option is set
21425 greater than one. Finally, &%mailstore_suffix%& is expanded and the result
21426 appended to the file, followed by a newline if it does not end with one.
21427
21428 If expansion of &%mailstore_prefix%& or &%mailstore_suffix%& ends with a forced
21429 failure, it is ignored. Other expansion errors are treated as serious
21430 configuration errors, and delivery is deferred. The variable
21431 &$mailstore_basename$& is available for use during these expansions.
21432
21433
21434 .section "Non-special new file delivery" "SECID138"
21435 If neither &%maildir_format%& nor &%mailstore_format%& is set, a single new
21436 file is created directly in the named directory. For example, when delivering
21437 messages into files in batched SMTP format for later delivery to some host (see
21438 section &<<SECTbatchSMTP>>&), a setting such as
21439 .code
21440 directory = /var/bsmtp/$host
21441 .endd
21442 might be used. A message is written to a file with a temporary name, which is
21443 then renamed when the delivery is complete. The final name is obtained by
21444 expanding the contents of the &%directory_file%& option.
21445 .ecindex IIDapptra1
21446 .ecindex IIDapptra2
21447
21448
21449
21450
21451
21452
21453 . ////////////////////////////////////////////////////////////////////////////
21454 . ////////////////////////////////////////////////////////////////////////////
21455
21456 .chapter "The autoreply transport" "CHID8"
21457 .scindex IIDauttra1 "transports" "&(autoreply)&"
21458 .scindex IIDauttra2 "&(autoreply)& transport"
21459 The &(autoreply)& transport is not a true transport in that it does not cause
21460 the message to be transmitted. Instead, it generates a new mail message as an
21461 automatic reply to the incoming message. &'References:'& and
21462 &'Auto-Submitted:'& header lines are included. These are constructed according
21463 to the rules in RFCs 2822 and 3834, respectively.
21464
21465 If the router that passes the message to this transport does not have the
21466 &%unseen%& option set, the original message (for the current recipient) is not
21467 delivered anywhere. However, when the &%unseen%& option is set on the router
21468 that passes the message to this transport, routing of the address continues, so
21469 another router can set up a normal message delivery.
21470
21471
21472 The &(autoreply)& transport is usually run as the result of mail filtering, a
21473 &"vacation"& message being the standard example. However, it can also be run
21474 directly from a router like any other transport. To reduce the possibility of
21475 message cascades, messages created by the &(autoreply)& transport always have
21476 empty envelope sender addresses, like bounce messages.
21477
21478 The parameters of the message to be sent can be specified in the configuration
21479 by options described below. However, these are used only when the address
21480 passed to the transport does not contain its own reply information. When the
21481 transport is run as a consequence of a
21482 &%mail%&
21483 or &%vacation%& command in a filter file, the parameters of the message are
21484 supplied by the filter, and passed with the address. The transport's options
21485 that define the message are then ignored (so they are not usually set in this
21486 case). The message is specified entirely by the filter or by the transport; it
21487 is never built from a mixture of options. However, the &%file_optional%&,
21488 &%mode%&, and &%return_message%& options apply in all cases.
21489
21490 &(Autoreply)& is implemented as a local transport. When used as a result of a
21491 command in a user's filter file, &(autoreply)& normally runs under the uid and
21492 gid of the user, and with appropriate current and home directories (see chapter
21493 &<<CHAPenvironment>>&).
21494
21495 There is a subtle difference between routing a message to a &(pipe)& transport
21496 that generates some text to be returned to the sender, and routing it to an
21497 &(autoreply)& transport. This difference is noticeable only if more than one
21498 address from the same message is so handled. In the case of a pipe, the
21499 separate outputs from the different addresses are gathered up and returned to
21500 the sender in a single message, whereas if &(autoreply)& is used, a separate
21501 message is generated for each address that is passed to it.
21502
21503 Non-printing characters are not permitted in the header lines generated for the
21504 message that &(autoreply)& creates, with the exception of newlines that are
21505 immediately followed by white space. If any non-printing characters are found,
21506 the transport defers.
21507 Whether characters with the top bit set count as printing characters or not is
21508 controlled by the &%print_topbitchars%& global option.
21509
21510 If any of the generic options for manipulating headers (for example,
21511 &%headers_add%&) are set on an &(autoreply)& transport, they apply to the copy
21512 of the original message that is included in the generated message when
21513 &%return_message%& is set. They do not apply to the generated message itself.
21514
21515 .vindex "&$sender_address$&"
21516 If the &(autoreply)& transport receives return code 2 from Exim when it submits
21517 the message, indicating that there were no recipients, it does not treat this
21518 as an error. This means that autoreplies sent to &$sender_address$& when this
21519 is empty (because the incoming message is a bounce message) do not cause
21520 problems. They are just discarded.
21521
21522
21523
21524 .section "Private options for autoreply" "SECID139"
21525 .cindex "options" "&(autoreply)& transport"
21526
21527 .option bcc autoreply string&!! unset
21528 This specifies the addresses that are to receive &"blind carbon copies"& of the
21529 message when the message is specified by the transport.
21530
21531
21532 .option cc autoreply string&!! unset
21533 This specifies recipients of the message and the contents of the &'Cc:'& header
21534 when the message is specified by the transport.
21535
21536
21537 .option file autoreply string&!! unset
21538 The contents of the file are sent as the body of the message when the message
21539 is specified by the transport. If both &%file%& and &%text%& are set, the text
21540 string comes first.
21541
21542
21543 .option file_expand autoreply boolean false
21544 If this is set, the contents of the file named by the &%file%& option are
21545 subjected to string expansion as they are added to the message.
21546
21547
21548 .option file_optional autoreply boolean false
21549 If this option is true, no error is generated if the file named by the &%file%&
21550 option or passed with the address does not exist or cannot be read.
21551
21552
21553 .option from autoreply string&!! unset
21554 This specifies the contents of the &'From:'& header when the message is
21555 specified by the transport.
21556
21557
21558 .option headers autoreply string&!! unset
21559 This specifies additional RFC 2822 headers that are to be added to the message
21560 when the message is specified by the transport. Several can be given by using
21561 &"\n"& to separate them. There is no check on the format.
21562
21563
21564 .option log autoreply string&!! unset
21565 This option names a file in which a record of every message sent is logged when
21566 the message is specified by the transport.
21567
21568
21569 .option mode autoreply "octal integer" 0600
21570 If either the log file or the &"once"& file has to be created, this mode is
21571 used.
21572
21573
21574 .option never_mail autoreply "address list&!!" unset
21575 If any run of the transport creates a message with a recipient that matches any
21576 item in the list, that recipient is quietly discarded. If all recipients are
21577 discarded, no message is created. This applies both when the recipients are
21578 generated by a filter and when they are specified in the transport.
21579
21580
21581
21582 .option once autoreply string&!! unset
21583 This option names a file or DBM database in which a record of each &'To:'&
21584 recipient is kept when the message is specified by the transport. &*Note*&:
21585 This does not apply to &'Cc:'& or &'Bcc:'& recipients.
21586
21587 If &%once%& is unset, or is set to an empty string, the message is always sent.
21588 By default, if &%once%& is set to a non-empty file name, the message
21589 is not sent if a potential recipient is already listed in the database.
21590 However, if the &%once_repeat%& option specifies a time greater than zero, the
21591 message is sent if that much time has elapsed since a message was last sent to
21592 this recipient. A setting of zero time for &%once_repeat%& (the default)
21593 prevents a message from being sent a second time &-- in this case, zero means
21594 infinity.
21595
21596 If &%once_file_size%& is zero, a DBM database is used to remember recipients,
21597 and it is allowed to grow as large as necessary. If &%once_file_size%& is set
21598 greater than zero, it changes the way Exim implements the &%once%& option.
21599 Instead of using a DBM file to record every recipient it sends to, it uses a
21600 regular file, whose size will never get larger than the given value.
21601
21602 In the file, Exim keeps a linear list of recipient addresses and the times at
21603 which they were sent messages. If the file is full when a new address needs to
21604 be added, the oldest address is dropped. If &%once_repeat%& is not set, this
21605 means that a given recipient may receive multiple messages, but at
21606 unpredictable intervals that depend on the rate of turnover of addresses in the
21607 file. If &%once_repeat%& is set, it specifies a maximum time between repeats.
21608
21609
21610 .option once_file_size autoreply integer 0
21611 See &%once%& above.
21612
21613
21614 .option once_repeat autoreply time&!! 0s
21615 See &%once%& above.
21616 After expansion, the value of this option must be a valid time value.
21617
21618
21619 .option reply_to autoreply string&!! unset
21620 This specifies the contents of the &'Reply-To:'& header when the message is
21621 specified by the transport.
21622
21623
21624 .option return_message autoreply boolean false
21625 If this is set, a copy of the original message is returned with the new
21626 message, subject to the maximum size set in the &%return_size_limit%& global
21627 configuration option.
21628
21629
21630 .option subject autoreply string&!! unset
21631 This specifies the contents of the &'Subject:'& header when the message is
21632 specified by the transport. It is tempting to quote the original subject in
21633 automatic responses. For example:
21634 .code
21635 subject = Re: $h_subject:
21636 .endd
21637 There is a danger in doing this, however. It may allow a third party to
21638 subscribe your users to an opt-in mailing list, provided that the list accepts
21639 bounce messages as subscription confirmations. Well-managed lists require a
21640 non-bounce message to confirm a subscription, so the danger is relatively
21641 small.
21642
21643
21644
21645 .option text autoreply string&!! unset
21646 This specifies a single string to be used as the body of the message when the
21647 message is specified by the transport. If both &%text%& and &%file%& are set,
21648 the text comes first.
21649
21650
21651 .option to autoreply string&!! unset
21652 This specifies recipients of the message and the contents of the &'To:'& header
21653 when the message is specified by the transport.
21654 .ecindex IIDauttra1
21655 .ecindex IIDauttra2
21656
21657
21658
21659
21660 . ////////////////////////////////////////////////////////////////////////////
21661 . ////////////////////////////////////////////////////////////////////////////
21662
21663 .chapter "The lmtp transport" "CHAPLMTP"
21664 .cindex "transports" "&(lmtp)&"
21665 .cindex "&(lmtp)& transport"
21666 .cindex "LMTP" "over a pipe"
21667 .cindex "LMTP" "over a socket"
21668 The &(lmtp)& transport runs the LMTP protocol (RFC 2033) over a pipe to a
21669 specified command
21670 or by interacting with a Unix domain socket.
21671 This transport is something of a cross between the &(pipe)& and &(smtp)&
21672 transports. Exim also has support for using LMTP over TCP/IP; this is
21673 implemented as an option for the &(smtp)& transport. Because LMTP is expected
21674 to be of minority interest, the default build-time configure in &_src/EDITME_&
21675 has it commented out. You need to ensure that
21676 .code
21677 TRANSPORT_LMTP=yes
21678 .endd
21679 .cindex "options" "&(lmtp)& transport"
21680 is present in your &_Local/Makefile_& in order to have the &(lmtp)& transport
21681 included in the Exim binary. The private options of the &(lmtp)& transport are
21682 as follows:
21683
21684 .option batch_id lmtp string&!! unset
21685 See the description of local delivery batching in chapter &<<CHAPbatching>>&.
21686
21687
21688 .option batch_max lmtp integer 1
21689 This limits the number of addresses that can be handled in a single delivery.
21690 Most LMTP servers can handle several addresses at once, so it is normally a
21691 good idea to increase this value. See the description of local delivery
21692 batching in chapter &<<CHAPbatching>>&.
21693
21694
21695 .option command lmtp string&!! unset
21696 This option must be set if &%socket%& is not set. The string is a command which
21697 is run in a separate process. It is split up into a command name and list of
21698 arguments, each of which is separately expanded (so expansion cannot change the
21699 number of arguments). The command is run directly, not via a shell. The message
21700 is passed to the new process using the standard input and output to operate the
21701 LMTP protocol.
21702
21703 .option ignore_quota lmtp boolean false
21704 .cindex "LMTP" "ignoring quota errors"
21705 If this option is set true, the string &`IGNOREQUOTA`& is added to RCPT
21706 commands, provided that the LMTP server has advertised support for IGNOREQUOTA
21707 in its response to the LHLO command.
21708
21709 .option socket lmtp string&!! unset
21710 This option must be set if &%command%& is not set. The result of expansion must
21711 be the name of a Unix domain socket. The transport connects to the socket and
21712 delivers the message to it using the LMTP protocol.
21713
21714
21715 .option timeout lmtp time 5m
21716 The transport is aborted if the created process or Unix domain socket does not
21717 respond to LMTP commands or message input within this timeout. Delivery
21718 is deferred, and will be tried again later. Here is an example of a typical
21719 LMTP transport:
21720 .code
21721 lmtp:
21722   driver = lmtp
21723   command = /some/local/lmtp/delivery/program
21724   batch_max = 20
21725   user = exim
21726 .endd
21727 This delivers up to 20 addresses at a time, in a mixture of domains if
21728 necessary, running as the user &'exim'&.
21729
21730
21731
21732 . ////////////////////////////////////////////////////////////////////////////
21733 . ////////////////////////////////////////////////////////////////////////////
21734
21735 .chapter "The pipe transport" "CHAPpipetransport"
21736 .scindex IIDpiptra1 "transports" "&(pipe)&"
21737 .scindex IIDpiptra2 "&(pipe)& transport"
21738 The &(pipe)& transport is used to deliver messages via a pipe to a command
21739 running in another process. One example is the use of &(pipe)& as a
21740 pseudo-remote transport for passing messages to some other delivery mechanism
21741 (such as UUCP). Another is the use by individual users to automatically process
21742 their incoming messages. The &(pipe)& transport can be used in one of the
21743 following ways:
21744
21745 .ilist
21746 .vindex "&$local_part$&"
21747 A router routes one address to a transport in the normal way, and the
21748 transport is configured as a &(pipe)& transport. In this case, &$local_part$&
21749 contains the local part of the address (as usual), and the command that is run
21750 is specified by the &%command%& option on the transport.
21751 .next
21752 .vindex "&$pipe_addresses$&"
21753 If the &%batch_max%& option is set greater than 1 (the default is 1), the
21754 transport can handle more than one address in a single run. In this case, when
21755 more than one address is routed to the transport, &$local_part$& is not set
21756 (because it is not unique). However, the pseudo-variable &$pipe_addresses$&
21757 (described in section &<<SECThowcommandrun>>& below) contains all the addresses
21758 that are routed to the transport.
21759 .next
21760 .vindex "&$address_pipe$&"
21761 A router redirects an address directly to a pipe command (for example, from an
21762 alias or forward file). In this case, &$address_pipe$& contains the text of the
21763 pipe command, and the &%command%& option on the transport is ignored unless
21764 &%force_command%& is set. If only one address is being transported
21765 (&%batch_max%& is not greater than one, or only one address was redirected to
21766 this pipe command), &$local_part$& contains the local part that was redirected.
21767 .endlist
21768
21769
21770 The &(pipe)& transport is a non-interactive delivery method. Exim can also
21771 deliver messages over pipes using the LMTP interactive protocol. This is
21772 implemented by the &(lmtp)& transport.
21773
21774 In the case when &(pipe)& is run as a consequence of an entry in a local user's
21775 &_.forward_& file, the command runs under the uid and gid of that user. In
21776 other cases, the uid and gid have to be specified explicitly, either on the
21777 transport or on the router that handles the address. Current and &"home"&
21778 directories are also controllable. See chapter &<<CHAPenvironment>>& for
21779 details of the local delivery environment and chapter &<<CHAPbatching>>&
21780 for a discussion of local delivery batching.
21781
21782
21783 .section "Concurrent delivery" "SECID140"
21784 If two messages arrive at almost the same time, and both are routed to a pipe
21785 delivery, the two pipe transports may be run concurrently. You must ensure that
21786 any pipe commands you set up are robust against this happening. If the commands
21787 write to a file, the &%exim_lock%& utility might be of use.
21788
21789
21790
21791
21792 .section "Returned status and data" "SECID141"
21793 .cindex "&(pipe)& transport" "returned data"
21794 If the command exits with a non-zero return code, the delivery is deemed to
21795 have failed, unless either the &%ignore_status%& option is set (in which case
21796 the return code is treated as zero), or the return code is one of those listed
21797 in the &%temp_errors%& option, which are interpreted as meaning &"try again
21798 later"&. In this case, delivery is deferred. Details of a permanent failure are
21799 logged, but are not included in the bounce message, which merely contains
21800 &"local delivery failed"&.
21801
21802 If the command exits on a signal and the &%freeze_signal%& option is set then
21803 the message will be frozen in the queue. If that option is not set, a bounce
21804 will be sent as normal.
21805
21806 If the return code is greater than 128 and the command being run is a shell
21807 script, it normally means that the script was terminated by a signal whose
21808 value is the return code minus 128. The &%freeze_signal%& option does not
21809 apply in this case.
21810
21811 If Exim is unable to run the command (that is, if &[execve()]& fails), the
21812 return code is set to 127. This is the value that a shell returns if it is
21813 asked to run a non-existent command. The wording for the log line suggests that
21814 a non-existent command may be the problem.
21815
21816 The &%return_output%& option can affect the result of a pipe delivery. If it is
21817 set and the command produces any output on its standard output or standard
21818 error streams, the command is considered to have failed, even if it gave a zero
21819 return code or if &%ignore_status%& is set. The output from the command is
21820 included as part of the bounce message. The &%return_fail_output%& option is
21821 similar, except that output is returned only when the command exits with a
21822 failure return code, that is, a value other than zero or a code that matches
21823 &%temp_errors%&.
21824
21825
21826
21827 .section "How the command is run" "SECThowcommandrun"
21828 .cindex "&(pipe)& transport" "path for command"
21829 The command line is (by default) broken down into a command name and arguments
21830 by the &(pipe)& transport itself. The &%allow_commands%& and
21831 &%restrict_to_path%& options can be used to restrict the commands that may be
21832 run.
21833
21834 .cindex "quoting" "in pipe command"
21835 Unquoted arguments are delimited by white space. If an argument appears in
21836 double quotes, backslash is interpreted as an escape character in the usual
21837 way. If an argument appears in single quotes, no escaping is done.
21838
21839 String expansion is applied to the command line except when it comes from a
21840 traditional &_.forward_& file (commands from a filter file are expanded). The
21841 expansion is applied to each argument in turn rather than to the whole line.
21842 For this reason, any string expansion item that contains white space must be
21843 quoted so as to be contained within a single argument. A setting such as
21844 .code
21845 command = /some/path ${if eq{$local_part}{postmaster}{xx}{yy}}
21846 .endd
21847 will not work, because the expansion item gets split between several
21848 arguments. You have to write
21849 .code
21850 command = /some/path "${if eq{$local_part}{postmaster}{xx}{yy}}"
21851 .endd
21852 to ensure that it is all in one argument. The expansion is done in this way,
21853 argument by argument, so that the number of arguments cannot be changed as a
21854 result of expansion, and quotes or backslashes in inserted variables do not
21855 interact with external quoting. However, this leads to problems if you want to
21856 generate multiple arguments (or the command name plus arguments) from a single
21857 expansion. In this situation, the simplest solution is to use a shell. For
21858 example:
21859 .code
21860 command = /bin/sh -c ${lookup{$local_part}lsearch{/some/file}}
21861 .endd
21862
21863 .cindex "transport" "filter"
21864 .cindex "filter" "transport filter"
21865 .vindex "&$pipe_addresses$&"
21866 Special handling takes place when an argument consists of precisely the text
21867 &`$pipe_addresses`&. This is not a general expansion variable; the only
21868 place this string is recognized is when it appears as an argument for a pipe or
21869 transport filter command. It causes each address that is being handled to be
21870 inserted in the argument list at that point &'as a separate argument'&. This
21871 avoids any problems with spaces or shell metacharacters, and is of use when a
21872 &(pipe)& transport is handling groups of addresses in a batch.
21873
21874 .new
21875 If &%force_command%& is enabled on the transport, Special handling takes place
21876 for an argument that consists of precisely the text &`$address_pipe`&.  It
21877 is handled similarly to &$pipe_addresses$& above.  It is expanded and each
21878 argument is inserted in the argument list at that point
21879 &'as a separate argument'&.  The &`$address_pipe`& item does not need to be
21880 the only item in the argument; in fact, if it were then &%force_command%&
21881 should behave as a no-op.  Rather, it should be used to adjust the command
21882 run while preserving the argument vector separation.
21883 .wen
21884
21885 After splitting up into arguments and expansion, the resulting command is run
21886 in a subprocess directly from the transport, &'not'& under a shell. The
21887 message that is being delivered is supplied on the standard input, and the
21888 standard output and standard error are both connected to a single pipe that is
21889 read by Exim. The &%max_output%& option controls how much output the command
21890 may produce, and the &%return_output%& and &%return_fail_output%& options
21891 control what is done with it.
21892
21893 Not running the command under a shell (by default) lessens the security risks
21894 in cases when a command from a user's filter file is built out of data that was
21895 taken from an incoming message. If a shell is required, it can of course be
21896 explicitly specified as the command to be run. However, there are circumstances
21897 where existing commands (for example, in &_.forward_& files) expect to be run
21898 under a shell and cannot easily be modified. To allow for these cases, there is
21899 an option called &%use_shell%&, which changes the way the &(pipe)& transport
21900 works. Instead of breaking up the command line as just described, it expands it
21901 as a single string and passes the result to &_/bin/sh_&. The
21902 &%restrict_to_path%& option and the &$pipe_addresses$& facility cannot be used
21903 with &%use_shell%&, and the whole mechanism is inherently less secure.
21904
21905
21906
21907 .section "Environment variables" "SECTpipeenv"
21908 .cindex "&(pipe)& transport" "environment for command"
21909 .cindex "environment for pipe transport"
21910 The environment variables listed below are set up when the command is invoked.
21911 This list is a compromise for maximum compatibility with other MTAs. Note that
21912 the &%environment%& option can be used to add additional variables to this
21913 environment.
21914 .display
21915 &`DOMAIN            `&   the domain of the address
21916 &`HOME              `&   the home directory, if set
21917 &`HOST              `&   the host name when called from a router (see below)
21918 &`LOCAL_PART        `&   see below
21919 &`LOCAL_PART_PREFIX `&   see below
21920 &`LOCAL_PART_SUFFIX `&   see below
21921 &`LOGNAME           `&   see below
21922 &`MESSAGE_ID        `&   Exim's local ID for the message
21923 &`PATH              `&   as specified by the &%path%& option below
21924 &`QUALIFY_DOMAIN    `&   the sender qualification domain
21925 &`RECIPIENT         `&   the complete recipient address
21926 &`SENDER            `&   the sender of the message (empty if a bounce)
21927 &`SHELL             `&   &`/bin/sh`&
21928 &`TZ                `&   the value of the &%timezone%& option, if set
21929 &`USER              `&   see below
21930 .endd
21931 When a &(pipe)& transport is called directly from (for example) an &(accept)&
21932 router, LOCAL_PART is set to the local part of the address. When it is
21933 called as a result of a forward or alias expansion, LOCAL_PART is set to
21934 the local part of the address that was expanded. In both cases, any affixes are
21935 removed from the local part, and made available in LOCAL_PART_PREFIX and
21936 LOCAL_PART_SUFFIX, respectively. LOGNAME and USER are set to the
21937 same value as LOCAL_PART for compatibility with other MTAs.
21938
21939 .cindex "HOST"
21940 HOST is set only when a &(pipe)& transport is called from a router that
21941 associates hosts with an address, typically when using &(pipe)& as a
21942 pseudo-remote transport. HOST is set to the first host name specified by
21943 the router.
21944
21945 .cindex "HOME"
21946 If the transport's generic &%home_directory%& option is set, its value is used
21947 for the HOME environment variable. Otherwise, a home directory may be set
21948 by the router's &%transport_home_directory%& option, which defaults to the
21949 user's home directory if &%check_local_user%& is set.
21950
21951
21952 .section "Private options for pipe" "SECID142"
21953 .cindex "options" "&(pipe)& transport"
21954
21955
21956
21957 .option allow_commands pipe "string list&!!" unset
21958 .cindex "&(pipe)& transport" "permitted commands"
21959 The string is expanded, and is then interpreted as a colon-separated list of
21960 permitted commands. If &%restrict_to_path%& is not set, the only commands
21961 permitted are those in the &%allow_commands%& list. They need not be absolute
21962 paths; the &%path%& option is still used for relative paths. If
21963 &%restrict_to_path%& is set with &%allow_commands%&, the command must either be
21964 in the &%allow_commands%& list, or a name without any slashes that is found on
21965 the path. In other words, if neither &%allow_commands%& nor
21966 &%restrict_to_path%& is set, there is no restriction on the command, but
21967 otherwise only commands that are permitted by one or the other are allowed. For
21968 example, if
21969 .code
21970 allow_commands = /usr/bin/vacation
21971 .endd
21972 and &%restrict_to_path%& is not set, the only permitted command is
21973 &_/usr/bin/vacation_&. The &%allow_commands%& option may not be set if
21974 &%use_shell%& is set.
21975
21976
21977 .option batch_id pipe string&!! unset
21978 See the description of local delivery batching in chapter &<<CHAPbatching>>&.
21979
21980
21981 .option batch_max pipe integer 1
21982 This limits the number of addresses that can be handled in a single delivery.
21983 See the description of local delivery batching in chapter &<<CHAPbatching>>&.
21984
21985
21986 .option check_string pipe string unset
21987 As &(pipe)& writes the message, the start of each line is tested for matching
21988 &%check_string%&, and if it does, the initial matching characters are replaced
21989 by the contents of &%escape_string%&, provided both are set. The value of
21990 &%check_string%& is a literal string, not a regular expression, and the case of
21991 any letters it contains is significant. When &%use_bsmtp%& is set, the contents
21992 of &%check_string%& and &%escape_string%& are forced to values that implement
21993 the SMTP escaping protocol. Any settings made in the configuration file are
21994 ignored.
21995
21996
21997 .option command pipe string&!! unset
21998 This option need not be set when &(pipe)& is being used to deliver to pipes
21999 obtained directly from address redirections. In other cases, the option must be
22000 set, to provide a command to be run. It need not yield an absolute path (see
22001 the &%path%& option below). The command is split up into separate arguments by
22002 Exim, and each argument is separately expanded, as described in section
22003 &<<SECThowcommandrun>>& above.
22004
22005
22006 .option environment pipe string&!! unset
22007 .cindex "&(pipe)& transport" "environment for command"
22008 .cindex "environment for &(pipe)& transport"
22009 This option is used to add additional variables to the environment in which the
22010 command runs (see section &<<SECTpipeenv>>& for the default list). Its value is
22011 a string which is expanded, and then interpreted as a colon-separated list of
22012 environment settings of the form <&'name'&>=<&'value'&>.
22013
22014
22015 .option escape_string pipe string unset
22016 See &%check_string%& above.
22017
22018
22019 .option freeze_exec_fail pipe boolean false
22020 .cindex "exec failure"
22021 .cindex "failure of exec"
22022 .cindex "&(pipe)& transport" "failure of exec"
22023 Failure to exec the command in a pipe transport is by default treated like
22024 any other failure while running the command. However, if &%freeze_exec_fail%&
22025 is set, failure to exec is treated specially, and causes the message to be
22026 frozen, whatever the setting of &%ignore_status%&.
22027
22028
22029 .option freeze_signal pipe boolean false
22030 .cindex "signal exit"
22031 .cindex "&(pipe)& transport", "signal exit"
22032 Normally if the process run by a command in a pipe transport exits on a signal,
22033 a bounce message is sent. If &%freeze_signal%& is set, the message will be
22034 frozen in Exim's queue instead.
22035
22036
22037 .new
22038 .option force_command pipe boolean false
22039 .cindex "force command"
22040 .cindex "&(pipe)& transport", "force command"
22041 Normally when a router redirects an address directly to a pipe command
22042 the &%command%& option on the transport is ignored.  If &%force_command%&
22043 is set, the &%command%& option will used. This is especially
22044 useful for forcing a wrapper or additional argument to be added to the
22045 command. For example:
22046 .code
22047 command = /usr/bin/remote_exec myhost -- $address_pipe
22048 force_command
22049 .endd
22050
22051 Note that &$address_pipe$& is handled specially in &%command%& when
22052 &%force_command%& is set, expanding out to the original argument vector as
22053 separate items, similarly to a Unix shell &`"$@"`& construct.
22054 .wen
22055
22056 .option ignore_status pipe boolean false
22057 If this option is true, the status returned by the subprocess that is set up to
22058 run the command is ignored, and Exim behaves as if zero had been returned.
22059 Otherwise, a non-zero status or termination by signal causes an error return
22060 from the transport unless the status value is one of those listed in
22061 &%temp_errors%&; these cause the delivery to be deferred and tried again later.
22062
22063 &*Note*&: This option does not apply to timeouts, which do not return a status.
22064 See the &%timeout_defer%& option for how timeouts are handled.
22065
22066 .option log_defer_output pipe boolean false
22067 .cindex "&(pipe)& transport" "logging output"
22068 If this option is set, and the status returned by the command is
22069 one of the codes listed in &%temp_errors%& (that is, delivery was deferred),
22070 and any output was produced, the first line of it is written to the main log.
22071
22072
22073 .option log_fail_output pipe boolean false
22074 If this option is set, and the command returns any output, and also ends with a
22075 return code that is neither zero nor one of the return codes listed in
22076 &%temp_errors%& (that is, the delivery failed), the first line of output is
22077 written to the main log. This option and &%log_output%& are mutually exclusive.
22078 Only one of them may be set.
22079
22080
22081
22082 .option log_output pipe boolean false
22083 If this option is set and the command returns any output, the first line of
22084 output is written to the main log, whatever the return code. This option and
22085 &%log_fail_output%& are mutually exclusive. Only one of them may be set.
22086
22087
22088
22089 .option max_output pipe integer 20K
22090 This specifies the maximum amount of output that the command may produce on its
22091 standard output and standard error file combined. If the limit is exceeded, the
22092 process running the command is killed. This is intended as a safety measure to
22093 catch runaway processes. The limit is applied independently of the settings of
22094 the options that control what is done with such output (for example,
22095 &%return_output%&). Because of buffering effects, the amount of output may
22096 exceed the limit by a small amount before Exim notices.
22097
22098
22099 .option message_prefix pipe string&!! "see below"
22100 The string specified here is expanded and output at the start of every message.
22101 The default is unset if &%use_bsmtp%& is set. Otherwise it is
22102 .code
22103 message_prefix = \
22104   From ${if def:return_path{$return_path}{MAILER-DAEMON}}\
22105   ${tod_bsdinbox}\n
22106 .endd
22107 .cindex "Cyrus"
22108 .cindex "&%tmail%&"
22109 .cindex "&""From""& line"
22110 This is required by the commonly used &_/usr/bin/vacation_& program.
22111 However, it must &'not'& be present if delivery is to the Cyrus IMAP server,
22112 or to the &%tmail%& local delivery agent. The prefix can be suppressed by
22113 setting
22114 .code
22115 message_prefix =
22116 .endd
22117 &*Note:*& If you set &%use_crlf%& true, you must change any occurrences of
22118 &`\n`& to &`\r\n`& in &%message_prefix%&.
22119
22120
22121 .option message_suffix pipe string&!! "see below"
22122 The string specified here is expanded and output at the end of every message.
22123 The default is unset if &%use_bsmtp%& is set. Otherwise it is a single newline.
22124 The suffix can be suppressed by setting
22125 .code
22126 message_suffix =
22127 .endd
22128 &*Note:*& If you set &%use_crlf%& true, you must change any occurrences of
22129 &`\n`& to &`\r\n`& in &%message_suffix%&.
22130
22131
22132 .option path pipe string "see below"
22133 This option specifies the string that is set up in the PATH environment
22134 variable of the subprocess. The default is:
22135 .code
22136 /bin:/usr/bin
22137 .endd
22138 If the &%command%& option does not yield an absolute path name, the command is
22139 sought in the PATH directories, in the usual way. &*Warning*&: This does not
22140 apply to a command specified as a transport filter.
22141
22142
22143 .option permit_coredump pipe boolean false
22144 Normally Exim inhibits core-dumps during delivery.  If you have a need to get
22145 a core-dump of a pipe command, enable this command.  This enables core-dumps
22146 during delivery and affects both the Exim binary and the pipe command run.
22147 It is recommended that this option remain off unless and until you have a need
22148 for it and that this only be enabled when needed, as the risk of excessive
22149 resource consumption can be quite high.  Note also that Exim is typically
22150 installed as a setuid binary and most operating systems will inhibit coredumps
22151 of these by default, so further OS-specific action may be required.
22152
22153
22154 .option pipe_as_creator pipe boolean false
22155 .cindex "uid (user id)" "local delivery"
22156 If the generic &%user%& option is not set and this option is true, the delivery
22157 process is run under the uid that was in force when Exim was originally called
22158 to accept the message. If the group id is not otherwise set (via the generic
22159 &%group%& option), the gid that was in force when Exim was originally called to
22160 accept the message is used.
22161
22162
22163 .option restrict_to_path pipe boolean false
22164 When this option is set, any command name not listed in &%allow_commands%& must
22165 contain no slashes. The command is searched for only in the directories listed
22166 in the &%path%& option. This option is intended for use in the case when a pipe
22167 command has been generated from a user's &_.forward_& file. This is usually
22168 handled by a &(pipe)& transport called &%address_pipe%&.
22169
22170
22171 .option return_fail_output pipe boolean false
22172 If this option is true, and the command produced any output and ended with a
22173 return code other than zero or one of the codes listed in &%temp_errors%& (that
22174 is, the delivery failed), the output is returned in the bounce message.
22175 However, if the message has a null sender (that is, it is itself a bounce
22176 message), output from the command is discarded. This option and
22177 &%return_output%& are mutually exclusive. Only one of them may be set.
22178
22179
22180
22181 .option return_output pipe boolean false
22182 If this option is true, and the command produced any output, the delivery is
22183 deemed to have failed whatever the return code from the command, and the output
22184 is returned in the bounce message. Otherwise, the output is just discarded.
22185 However, if the message has a null sender (that is, it is a bounce message),
22186 output from the command is always discarded, whatever the setting of this
22187 option. This option and &%return_fail_output%& are mutually exclusive. Only one
22188 of them may be set.
22189
22190
22191
22192 .option temp_errors pipe "string list" "see below"
22193 .cindex "&(pipe)& transport" "temporary failure"
22194 This option contains either a colon-separated list of numbers, or a single
22195 asterisk. If &%ignore_status%& is false
22196 and &%return_output%& is not set,
22197 and the command exits with a non-zero return code, the failure is treated as
22198 temporary and the delivery is deferred if the return code matches one of the
22199 numbers, or if the setting is a single asterisk. Otherwise, non-zero return
22200 codes are treated as permanent errors. The default setting contains the codes
22201 defined by EX_TEMPFAIL and EX_CANTCREAT in &_sysexits.h_&. If Exim is
22202 compiled on a system that does not define these macros, it assumes values of 75
22203 and 73, respectively.
22204
22205
22206 .option timeout pipe time 1h
22207 If the command fails to complete within this time, it is killed. This normally
22208 causes the delivery to fail (but see &%timeout_defer%&). A zero time interval
22209 specifies no timeout. In order to ensure that any subprocesses created by the
22210 command are also killed, Exim makes the initial process a process group leader,
22211 and kills the whole process group on a timeout. However, this can be defeated
22212 if one of the processes starts a new process group.
22213
22214 .option timeout_defer pipe boolean false
22215 A timeout in a &(pipe)& transport, either in the command that the transport
22216 runs, or in a transport filter that is associated with it, is by default
22217 treated as a hard error, and the delivery fails. However, if &%timeout_defer%&
22218 is set true, both kinds of timeout become temporary errors, causing the
22219 delivery to be deferred.
22220
22221 .option umask pipe "octal integer" 022
22222 This specifies the umask setting for the subprocess that runs the command.
22223
22224
22225 .option use_bsmtp pipe boolean false
22226 .cindex "envelope sender"
22227 If this option is set true, the &(pipe)& transport writes messages in &"batch
22228 SMTP"& format, with the envelope sender and recipient(s) included as SMTP
22229 commands. If you want to include a leading HELO command with such messages,
22230 you can do so by setting the &%message_prefix%& option. See section
22231 &<<SECTbatchSMTP>>& for details of batch SMTP.
22232
22233 .option use_classresources pipe boolean false
22234 .cindex "class resources (BSD)"
22235 This option is available only when Exim is running on FreeBSD, NetBSD, or
22236 BSD/OS. If it is set true, the &[setclassresources()]& function is used to set
22237 resource limits when a &(pipe)& transport is run to perform a delivery. The
22238 limits for the uid under which the pipe is to run are obtained from the login
22239 class database.
22240
22241
22242 .option use_crlf pipe boolean false
22243 .cindex "carriage return"
22244 .cindex "linefeed"
22245 This option causes lines to be terminated with the two-character CRLF sequence
22246 (carriage return, linefeed) instead of just a linefeed character. In the case
22247 of batched SMTP, the byte sequence written to the pipe is then an exact image
22248 of what would be sent down a real SMTP connection.
22249
22250 The contents of the &%message_prefix%& and &%message_suffix%& options are
22251 written verbatim, so must contain their own carriage return characters if these
22252 are needed. When &%use_bsmtp%& is not set, the default values for both
22253 &%message_prefix%& and &%message_suffix%& end with a single linefeed, so their
22254 values must be changed to end with &`\r\n`& if &%use_crlf%& is set.
22255
22256
22257 .option use_shell pipe boolean false
22258 .vindex "&$pipe_addresses$&"
22259 If this option is set, it causes the command to be passed to &_/bin/sh_&
22260 instead of being run directly from the transport, as described in section
22261 &<<SECThowcommandrun>>&. This is less secure, but is needed in some situations
22262 where the command is expected to be run under a shell and cannot easily be
22263 modified. The &%allow_commands%& and &%restrict_to_path%& options, and the
22264 &`$pipe_addresses`& facility are incompatible with &%use_shell%&. The
22265 command is expanded as a single string, and handed to &_/bin/sh_& as data for
22266 its &%-c%& option.
22267
22268
22269
22270 .section "Using an external local delivery agent" "SECID143"
22271 .cindex "local delivery" "using an external agent"
22272 .cindex "&'procmail'&"
22273 .cindex "external local delivery"
22274 .cindex "delivery" "&'procmail'&"
22275 .cindex "delivery" "by external agent"
22276 The &(pipe)& transport can be used to pass all messages that require local
22277 delivery to a separate local delivery agent such as &%procmail%&. When doing
22278 this, care must be taken to ensure that the pipe is run under an appropriate
22279 uid and gid. In some configurations one wants this to be a uid that is trusted
22280 by the delivery agent to supply the correct sender of the message. It may be
22281 necessary to recompile or reconfigure the delivery agent so that it trusts an
22282 appropriate user. The following is an example transport and router
22283 configuration for &%procmail%&:
22284 .code
22285 # transport
22286 procmail_pipe:
22287   driver = pipe
22288   command = /usr/local/bin/procmail -d $local_part
22289   return_path_add
22290   delivery_date_add
22291   envelope_to_add
22292   check_string = "From "
22293   escape_string = ">From "
22294   umask = 077
22295   user = $local_part
22296   group = mail
22297
22298 # router
22299 procmail:
22300   driver = accept
22301   check_local_user
22302   transport = procmail_pipe
22303 .endd
22304 In this example, the pipe is run as the local user, but with the group set to
22305 &'mail'&. An alternative is to run the pipe as a specific user such as &'mail'&
22306 or &'exim'&, but in this case you must arrange for &%procmail%& to trust that
22307 user to supply a correct sender address. If you do not specify either a
22308 &%group%& or a &%user%& option, the pipe command is run as the local user. The
22309 home directory is the user's home directory by default.
22310
22311 &*Note*&: The command that the pipe transport runs does &'not'& begin with
22312 .code
22313 IFS=" "
22314 .endd
22315 as shown in some &%procmail%& documentation, because Exim does not by default
22316 use a shell to run pipe commands.
22317
22318 .cindex "Cyrus"
22319 The next example shows a transport and a router for a system where local
22320 deliveries are handled by the Cyrus IMAP server.
22321 .code
22322 # transport
22323 local_delivery_cyrus:
22324   driver = pipe
22325   command = /usr/cyrus/bin/deliver \
22326             -m ${substr_1:$local_part_suffix} -- $local_part
22327   user = cyrus
22328   group = mail
22329   return_output
22330   log_output
22331   message_prefix =
22332   message_suffix =
22333
22334 # router
22335 local_user_cyrus:
22336   driver = accept
22337   check_local_user
22338   local_part_suffix = .*
22339   transport = local_delivery_cyrus
22340 .endd
22341 Note the unsetting of &%message_prefix%& and &%message_suffix%&, and the use of
22342 &%return_output%& to cause any text written by Cyrus to be returned to the
22343 sender.
22344 .ecindex IIDpiptra1
22345 .ecindex IIDpiptra2
22346
22347
22348 . ////////////////////////////////////////////////////////////////////////////
22349 . ////////////////////////////////////////////////////////////////////////////
22350
22351 .chapter "The smtp transport" "CHAPsmtptrans"
22352 .scindex IIDsmttra1 "transports" "&(smtp)&"
22353 .scindex IIDsmttra2 "&(smtp)& transport"
22354 The &(smtp)& transport delivers messages over TCP/IP connections using the SMTP
22355 or LMTP protocol. The list of hosts to try can either be taken from the address
22356 that is being processed (having been set up by the router), or specified
22357 explicitly for the transport. Timeout and retry processing (see chapter
22358 &<<CHAPretry>>&) is applied to each IP address independently.
22359
22360
22361 .section "Multiple messages on a single connection" "SECID144"
22362 The sending of multiple messages over a single TCP/IP connection can arise in
22363 two ways:
22364
22365 .ilist
22366 If a message contains more than &%max_rcpt%& (see below) addresses that are
22367 routed to the same host, more than one copy of the message has to be sent to
22368 that host. In this situation, multiple copies may be sent in a single run of
22369 the &(smtp)& transport over a single TCP/IP connection. (What Exim actually
22370 does when it has too many addresses to send in one message also depends on the
22371 value of the global &%remote_max_parallel%& option. Details are given in
22372 section &<<SECToutSMTPTCP>>&.)
22373 .next
22374 .cindex "hints database" "remembering routing"
22375 When a message has been successfully delivered over a TCP/IP connection, Exim
22376 looks in its hints database to see if there are any other messages awaiting a
22377 connection to the same host. If there are, a new delivery process is started
22378 for one of them, and the current TCP/IP connection is passed on to it. The new
22379 process may in turn send multiple copies and possibly create yet another
22380 process.
22381 .endlist
22382
22383
22384 For each copy sent over the same TCP/IP connection, a sequence counter is
22385 incremented, and if it ever gets to the value of &%connection_max_messages%&,
22386 no further messages are sent over that connection.
22387
22388
22389
22390 .section "Use of the $host and $host_address variables" "SECID145"
22391 .vindex "&$host$&"
22392 .vindex "&$host_address$&"
22393 At the start of a run of the &(smtp)& transport, the values of &$host$& and
22394 &$host_address$& are the name and IP address of the first host on the host list
22395 passed by the router. However, when the transport is about to connect to a
22396 specific host, and while it is connected to that host, &$host$& and
22397 &$host_address$& are set to the values for that host. These are the values
22398 that are in force when the &%helo_data%&, &%hosts_try_auth%&, &%interface%&,
22399 &%serialize_hosts%&, and the various TLS options are expanded.
22400
22401
22402 .section "Use of $tls_cipher and $tls_peerdn" "usecippeer"
22403 .vindex &$tls_bits$&
22404 .vindex &$tls_cipher$&
22405 .vindex &$tls_peerdn$&
22406 .vindex &$tls_sni$&
22407 At the start of a run of the &(smtp)& transport, the values of &$tls_bits$&,
22408 &$tls_cipher$&, &$tls_peerdn$& and &$tls_sni$&
22409 are the values that were set when the message was received.
22410 These are the values that are used for options that are expanded before any
22411 SMTP connections are made. Just before each connection is made, these four
22412 variables are emptied. If TLS is subsequently started, they are set to the
22413 appropriate values for the outgoing connection, and these are the values that
22414 are in force when any authenticators are run and when the
22415 &%authenticated_sender%& option is expanded.
22416
22417 .new
22418 These variables are deprecated in favour of &$tls_in_cipher$& et. al.
22419 and will be removed in a future release.
22420 .wen
22421
22422
22423 .section "Private options for smtp" "SECID146"
22424 .cindex "options" "&(smtp)& transport"
22425 The private options of the &(smtp)& transport are as follows:
22426
22427
22428 .option address_retry_include_sender smtp boolean true
22429 .cindex "4&'xx'& responses" "retrying after"
22430 When an address is delayed because of a 4&'xx'& response to a RCPT command, it
22431 is the combination of sender and recipient that is delayed in subsequent queue
22432 runs until the retry time is reached. You can delay the recipient without
22433 reference to the sender (which is what earlier versions of Exim did), by
22434 setting &%address_retry_include_sender%& false. However, this can lead to
22435 problems with servers that regularly issue 4&'xx'& responses to RCPT commands.
22436
22437 .option allow_localhost smtp boolean false
22438 .cindex "local host" "sending to"
22439 .cindex "fallback" "hosts specified on transport"
22440 When a host specified in &%hosts%& or &%fallback_hosts%& (see below) turns out
22441 to be the local host, or is listed in &%hosts_treat_as_local%&, delivery is
22442 deferred by default. However, if &%allow_localhost%& is set, Exim goes on to do
22443 the delivery anyway. This should be used only in special cases when the
22444 configuration ensures that no looping will result (for example, a differently
22445 configured Exim is listening on the port to which the message is sent).
22446
22447
22448 .option authenticated_sender smtp string&!! unset
22449 .cindex "Cyrus"
22450 When Exim has authenticated as a client, or if &%authenticated_sender_force%&
22451 is true, this option sets a value for the AUTH= item on outgoing MAIL commands,
22452 overriding any existing authenticated sender value. If the string expansion is
22453 forced to fail, the option is ignored. Other expansion failures cause delivery
22454 to be deferred. If the result of expansion is an empty string, that is also
22455 ignored.
22456
22457 The expansion happens after the outgoing connection has been made and TLS
22458 started, if required. This means that the &$host$&, &$host_address$&,
22459 &$tls_out_cipher$&, and &$tls_out_peerdn$& variables are set according to the
22460 particular connection.
22461
22462 If the SMTP session is not authenticated, the expansion of
22463 &%authenticated_sender%& still happens (and can cause the delivery to be
22464 deferred if it fails), but no AUTH= item is added to MAIL commands
22465 unless &%authenticated_sender_force%& is true.
22466
22467 This option allows you to use the &(smtp)& transport in LMTP mode to
22468 deliver mail to Cyrus IMAP and provide the proper local part as the
22469 &"authenticated sender"&, via a setting such as:
22470 .code
22471 authenticated_sender = $local_part
22472 .endd
22473 This removes the need for IMAP subfolders to be assigned special ACLs to
22474 allow direct delivery to those subfolders.
22475
22476 Because of expected uses such as that just described for Cyrus (when no
22477 domain is involved), there is no checking on the syntax of the provided
22478 value.
22479
22480
22481 .option authenticated_sender_force smtp boolean false
22482 If this option is set true, the &%authenticated_sender%& option's value
22483 is used for the AUTH= item on outgoing MAIL commands, even if Exim has not
22484 authenticated as a client.
22485
22486
22487 .option command_timeout smtp time 5m
22488 This sets a timeout for receiving a response to an SMTP command that has been
22489 sent out. It is also used when waiting for the initial banner line from the
22490 remote host. Its value must not be zero.
22491
22492
22493 .option connect_timeout smtp time 5m
22494 This sets a timeout for the &[connect()]& function, which sets up a TCP/IP call
22495 to a remote host. A setting of zero allows the system timeout (typically
22496 several minutes) to act. To have any effect, the value of this option must be
22497 less than the system timeout. However, it has been observed that on some
22498 systems there is no system timeout, which is why the default value for this
22499 option is 5 minutes, a value recommended by RFC 1123.
22500
22501
22502 .option connection_max_messages smtp integer 500
22503 .cindex "SMTP" "passed connection"
22504 .cindex "SMTP" "multiple deliveries"
22505 .cindex "multiple SMTP deliveries"
22506 This controls the maximum number of separate message deliveries that are sent
22507 over a single TCP/IP connection. If the value is zero, there is no limit.
22508 For testing purposes, this value can be overridden by the &%-oB%& command line
22509 option.
22510
22511
22512 .option data_timeout smtp time 5m
22513 This sets a timeout for the transmission of each block in the data portion of
22514 the message. As a result, the overall timeout for a message depends on the size
22515 of the message. Its value must not be zero. See also &%final_timeout%&.
22516
22517
22518 .option delay_after_cutoff smtp boolean true
22519 This option controls what happens when all remote IP addresses for a given
22520 domain have been inaccessible for so long that they have passed their retry
22521 cutoff times.
22522
22523 In the default state, if the next retry time has not been reached for any of
22524 them, the address is bounced without trying any deliveries. In other words,
22525 Exim delays retrying an IP address after the final cutoff time until a new
22526 retry time is reached, and can therefore bounce an address without ever trying
22527 a delivery, when machines have been down for a long time. Some people are
22528 unhappy at this prospect, so...
22529
22530 If &%delay_after_cutoff%& is set false, Exim behaves differently. If all IP
22531 addresses are past their final cutoff time, Exim tries to deliver to those
22532 IP addresses that have not been tried since the message arrived. If there are
22533 none, of if they all fail, the address is bounced. In other words, it does not
22534 delay when a new message arrives, but immediately tries those expired IP
22535 addresses that haven't been tried since the message arrived. If there is a
22536 continuous stream of messages for the dead hosts, unsetting
22537 &%delay_after_cutoff%& means that there will be many more attempts to deliver
22538 to them.
22539
22540
22541 .option dns_qualify_single smtp boolean true
22542 If the &%hosts%& or &%fallback_hosts%& option is being used,
22543 and the &%gethostbyname%& option is false,
22544 the RES_DEFNAMES resolver option is set. See the &%qualify_single%& option
22545 in chapter &<<CHAPdnslookup>>& for more details.
22546
22547
22548 .option dns_search_parents smtp boolean false
22549 If the &%hosts%& or &%fallback_hosts%& option is being used, and the
22550 &%gethostbyname%& option is false, the RES_DNSRCH resolver option is set.
22551 See the &%search_parents%& option in chapter &<<CHAPdnslookup>>& for more
22552 details.
22553
22554
22555 .new
22556 .option dscp smtp string&!! unset
22557 .cindex "DCSP" "outbound"
22558 This option causes the DSCP value associated with a socket to be set to one
22559 of a number of fixed strings or to numeric value.
22560 The &%-bI:dscp%& option may be used to ask Exim which names it knows of.
22561 Common values include &`throughput`&, &`mincost`&, and on newer systems
22562 &`ef`&, &`af41`&, etc.  Numeric values may be in the range 0 to 0x3F.
22563
22564 The outbound packets from Exim will be marked with this value in the header
22565 (for IPv4, the TOS field; for IPv6, the TCLASS field); there is no guarantee
22566 that these values will have any effect, not be stripped by networking
22567 equipment, or do much of anything without cooperation with your Network
22568 Engineer and those of all network operators between the source and destination.
22569 .wen
22570
22571
22572 .option fallback_hosts smtp "string list" unset
22573 .cindex "fallback" "hosts specified on transport"
22574 String expansion is not applied to this option. The argument must be a
22575 colon-separated list of host names or IP addresses, optionally also including
22576 port numbers, though the separator can be changed, as described in section
22577 &<<SECTlistconstruct>>&. Each individual item in the list is the same as an
22578 item in a &%route_list%& setting for the &(manualroute)& router, as described
22579 in section &<<SECTformatonehostitem>>&.
22580
22581 Fallback hosts can also be specified on routers, which associate them with the
22582 addresses they process. As for the &%hosts%& option without &%hosts_override%&,
22583 &%fallback_hosts%& specified on the transport is used only if the address does
22584 not have its own associated fallback host list. Unlike &%hosts%&, a setting of
22585 &%fallback_hosts%& on an address is not overridden by &%hosts_override%&.
22586 However, &%hosts_randomize%& does apply to fallback host lists.
22587
22588 If Exim is unable to deliver to any of the hosts for a particular address, and
22589 the errors are not permanent rejections, the address is put on a separate
22590 transport queue with its host list replaced by the fallback hosts, unless the
22591 address was routed via MX records and the current host was in the original MX
22592 list. In that situation, the fallback host list is not used.
22593
22594 Once normal deliveries are complete, the fallback queue is delivered by
22595 re-running the same transports with the new host lists. If several failing
22596 addresses have the same fallback hosts (and &%max_rcpt%& permits it), a single
22597 copy of the message is sent.
22598
22599 The resolution of the host names on the fallback list is controlled by the
22600 &%gethostbyname%& option, as for the &%hosts%& option. Fallback hosts apply
22601 both to cases when the host list comes with the address and when it is taken
22602 from &%hosts%&. This option provides a &"use a smart host only if delivery
22603 fails"& facility.
22604
22605
22606 .option final_timeout smtp time 10m
22607 This is the timeout that applies while waiting for the response to the final
22608 line containing just &"."& that terminates a message. Its value must not be
22609 zero.
22610
22611 .option gethostbyname smtp boolean false
22612 If this option is true when the &%hosts%& and/or &%fallback_hosts%& options are
22613 being used, names are looked up using &[gethostbyname()]&
22614 (or &[getipnodebyname()]& when available)
22615 instead of using the DNS. Of course, that function may in fact use the DNS, but
22616 it may also consult other sources of information such as &_/etc/hosts_&.
22617
22618 .option gnutls_compat_mode smtp boolean unset
22619 This option controls whether GnuTLS is used in compatibility mode in an Exim
22620 server. This reduces security slightly, but improves interworking with older
22621 implementations of TLS.
22622
22623 .option helo_data smtp string&!! "see below"
22624 .cindex "HELO" "argument, setting"
22625 .cindex "EHLO" "argument, setting"
22626 .cindex "LHLO argument setting"
22627 The value of this option is expanded after a connection to a another host has
22628 been set up. The result is used as the argument for the EHLO, HELO, or LHLO
22629 command that starts the outgoing SMTP or LMTP session. The default value of the
22630 option is:
22631 .code
22632 $primary_hostname
22633 .endd
22634 During the expansion, the variables &$host$& and &$host_address$& are set to
22635 the identity of the remote host, and the variables &$sending_ip_address$& and
22636 &$sending_port$& are set to the local IP address and port number that are being
22637 used. These variables can be used to generate different values for different
22638 servers or different local IP addresses. For example, if you want the string
22639 that is used for &%helo_data%& to be obtained by a DNS lookup of the outgoing
22640 interface address, you could use this:
22641 .code
22642 helo_data = ${lookup dnsdb{ptr=$sending_ip_address}{$value}\
22643   {$primary_hostname}}
22644 .endd
22645 The use of &%helo_data%& applies both to sending messages and when doing
22646 callouts.
22647
22648 .option hosts smtp "string list&!!" unset
22649 Hosts are associated with an address by a router such as &(dnslookup)&, which
22650 finds the hosts by looking up the address domain in the DNS, or by
22651 &(manualroute)&, which has lists of hosts in its configuration. However,
22652 email addresses can be passed to the &(smtp)& transport by any router, and not
22653 all of them can provide an associated list of hosts.
22654
22655 The &%hosts%& option specifies a list of hosts to be used if the address being
22656 processed does not have any hosts associated with it. The hosts specified by
22657 &%hosts%& are also used, whether or not the address has its own hosts, if
22658 &%hosts_override%& is set.
22659
22660 The string is first expanded, before being interpreted as a colon-separated
22661 list of host names or IP addresses, possibly including port numbers. The
22662 separator may be changed to something other than colon, as described in section
22663 &<<SECTlistconstruct>>&. Each individual item in the list is the same as an
22664 item in a &%route_list%& setting for the &(manualroute)& router, as described
22665 in section &<<SECTformatonehostitem>>&. However, note that the &`/MX`& facility
22666 of the &(manualroute)& router is not available here.
22667
22668 If the expansion fails, delivery is deferred. Unless the failure was caused by
22669 the inability to complete a lookup, the error is logged to the panic log as
22670 well as the main log. Host names are looked up either by searching directly for
22671 address records in the DNS or by calling &[gethostbyname()]& (or
22672 &[getipnodebyname()]& when available), depending on the setting of the
22673 &%gethostbyname%& option. When Exim is compiled with IPv6 support, if a host
22674 that is looked up in the DNS has both IPv4 and IPv6 addresses, both types of
22675 address are used.
22676
22677 During delivery, the hosts are tried in order, subject to their retry status,
22678 unless &%hosts_randomize%& is set.
22679
22680
22681 .option hosts_avoid_esmtp smtp "host list&!!" unset
22682 .cindex "ESMTP, avoiding use of"
22683 .cindex "HELO" "forcing use of"
22684 .cindex "EHLO" "avoiding use of"
22685 .cindex "PIPELINING" "avoiding the use of"
22686 This option is for use with broken hosts that announce ESMTP facilities (for
22687 example, PIPELINING) and then fail to implement them properly. When a host
22688 matches &%hosts_avoid_esmtp%&, Exim sends HELO rather than EHLO at the
22689 start of the SMTP session. This means that it cannot use any of the ESMTP
22690 facilities such as AUTH, PIPELINING, SIZE, and STARTTLS.
22691
22692
22693 .option hosts_avoid_pipelining smtp "host list&!!" unset
22694 .cindex "PIPELINING" "avoiding the use of"
22695 Exim will not use the SMTP PIPELINING extension when delivering to any host
22696 that matches this list, even if the server host advertises PIPELINING support.
22697
22698
22699 .option hosts_avoid_tls smtp "host list&!!" unset
22700 .cindex "TLS" "avoiding for certain hosts"
22701 Exim will not try to start a TLS session when delivering to any host that
22702 matches this list. See chapter &<<CHAPTLS>>& for details of TLS.
22703
22704 .new
22705 .option hosts_verify_avoid_tls smtp "host list&!!" *
22706 .cindex "TLS" "avoiding for certain hosts"
22707 Exim will not try to start a TLS session for a verify callout,
22708 or when delivering in cutthrough mode,
22709 to any host that matches this list.
22710 Note that the default is to not use TLS.
22711 .wen
22712
22713
22714 .option hosts_max_try smtp integer 5
22715 .cindex "host" "maximum number to try"
22716 .cindex "limit" "number of hosts tried"
22717 .cindex "limit" "number of MX tried"
22718 .cindex "MX record" "maximum tried"
22719 This option limits the number of IP addresses that are tried for any one
22720 delivery in cases where there are temporary delivery errors. Section
22721 &<<SECTvalhosmax>>& describes in detail how the value of this option is used.
22722
22723
22724 .option hosts_max_try_hardlimit smtp integer 50
22725 This is an additional check on the maximum number of IP addresses that Exim
22726 tries for any one delivery. Section &<<SECTvalhosmax>>& describes its use and
22727 why it exists.
22728
22729
22730
22731 .option hosts_nopass_tls smtp "host list&!!" unset
22732 .cindex "TLS" "passing connection"
22733 .cindex "multiple SMTP deliveries"
22734 .cindex "TLS" "multiple message deliveries"
22735 For any host that matches this list, a connection on which a TLS session has
22736 been started will not be passed to a new delivery process for sending another
22737 message on the same connection. See section &<<SECTmulmessam>>& for an
22738 explanation of when this might be needed.
22739
22740
22741 .option hosts_override smtp boolean false
22742 If this option is set and the &%hosts%& option is also set, any hosts that are
22743 attached to the address are ignored, and instead the hosts specified by the
22744 &%hosts%& option are always used. This option does not apply to
22745 &%fallback_hosts%&.
22746
22747
22748 .option hosts_randomize smtp boolean false
22749 .cindex "randomized host list"
22750 .cindex "host" "list of; randomized"
22751 .cindex "fallback" "randomized hosts"
22752 If this option is set, and either the list of hosts is taken from the
22753 &%hosts%& or the &%fallback_hosts%& option, or the hosts supplied by the router
22754 were not obtained from MX records (this includes fallback hosts from the
22755 router), and were not randomized by the router, the order of trying the hosts
22756 is randomized each time the transport runs. Randomizing the order of a host
22757 list can be used to do crude load sharing.
22758
22759 When &%hosts_randomize%& is true, a host list may be split into groups whose
22760 order is separately randomized. This makes it possible to set up MX-like
22761 behaviour. The boundaries between groups are indicated by an item that is just
22762 &`+`& in the host list. For example:
22763 .code
22764 hosts = host1:host2:host3:+:host4:host5
22765 .endd
22766 The order of the first three hosts and the order of the last two hosts is
22767 randomized for each use, but the first three always end up before the last two.
22768 If &%hosts_randomize%& is not set, a &`+`& item in the list is ignored.
22769
22770 .option hosts_require_auth smtp "host list&!!" unset
22771 .cindex "authentication" "required by client"
22772 This option provides a list of servers for which authentication must succeed
22773 before Exim will try to transfer a message. If authentication fails for
22774 servers which are not in this list, Exim tries to send unauthenticated. If
22775 authentication fails for one of these servers, delivery is deferred. This
22776 temporary error is detectable in the retry rules, so it can be turned into a
22777 hard failure if required. See also &%hosts_try_auth%&, and chapter
22778 &<<CHAPSMTPAUTH>>& for details of authentication.
22779
22780
22781 .option hosts_require_tls smtp "host list&!!" unset
22782 .cindex "TLS" "requiring for certain servers"
22783 Exim will insist on using a TLS session when delivering to any host that
22784 matches this list. See chapter &<<CHAPTLS>>& for details of TLS.
22785 &*Note*&: This option affects outgoing mail only. To insist on TLS for
22786 incoming messages, use an appropriate ACL.
22787
22788 .option hosts_try_auth smtp "host list&!!" unset
22789 .cindex "authentication" "optional in client"
22790 This option provides a list of servers to which, provided they announce
22791 authentication support, Exim will attempt to authenticate as a client when it
22792 connects. If authentication fails, Exim will try to transfer the message
22793 unauthenticated. See also &%hosts_require_auth%&, and chapter
22794 &<<CHAPSMTPAUTH>>& for details of authentication.
22795
22796 .option interface smtp "string list&!!" unset
22797 .cindex "bind IP address"
22798 .cindex "IP address" "binding"
22799 .vindex "&$host$&"
22800 .vindex "&$host_address$&"
22801 This option specifies which interface to bind to when making an outgoing SMTP
22802 call. The value is an IP address, not an interface name such as
22803 &`eth0`&. Do not confuse this with the interface address that was used when a
22804 message was received, which is in &$received_ip_address$&, formerly known as
22805 &$interface_address$&. The name was changed to minimize confusion with the
22806 outgoing interface address. There is no variable that contains an outgoing
22807 interface address because, unless it is set by this option, its value is
22808 unknown.
22809
22810 During the expansion of the &%interface%& option the variables &$host$& and
22811 &$host_address$& refer to the host to which a connection is about to be made
22812 during the expansion of the string. Forced expansion failure, or an empty
22813 string result causes the option to be ignored. Otherwise, after expansion, the
22814 string must be a list of IP addresses, colon-separated by default, but the
22815 separator can be changed in the usual way. For example:
22816 .code
22817 interface = <; 192.168.123.123 ; 3ffe:ffff:836f::fe86:a061
22818 .endd
22819 The first interface of the correct type (IPv4 or IPv6) is used for the outgoing
22820 connection. If none of them are the correct type, the option is ignored. If
22821 &%interface%& is not set, or is ignored, the system's IP functions choose which
22822 interface to use if the host has more than one.
22823
22824
22825 .option keepalive smtp boolean true
22826 .cindex "keepalive" "on outgoing connection"
22827 This option controls the setting of SO_KEEPALIVE on outgoing TCP/IP socket
22828 connections. When set, it causes the kernel to probe idle connections
22829 periodically, by sending packets with &"old"& sequence numbers. The other end
22830 of the connection should send a acknowledgment if the connection is still okay
22831 or a reset if the connection has been aborted. The reason for doing this is
22832 that it has the beneficial effect of freeing up certain types of connection
22833 that can get stuck when the remote host is disconnected without tidying up the
22834 TCP/IP call properly. The keepalive mechanism takes several hours to detect
22835 unreachable hosts.
22836
22837
22838 .option lmtp_ignore_quota smtp boolean false
22839 .cindex "LMTP" "ignoring quota errors"
22840 If this option is set true when the &%protocol%& option is set to &"lmtp"&, the
22841 string &`IGNOREQUOTA`& is added to RCPT commands, provided that the LMTP server
22842 has advertised support for IGNOREQUOTA in its response to the LHLO command.
22843
22844 .option max_rcpt smtp integer 100
22845 .cindex "RCPT" "maximum number of outgoing"
22846 This option limits the number of RCPT commands that are sent in a single
22847 SMTP message transaction. Each set of addresses is treated independently, and
22848 so can cause parallel connections to the same host if &%remote_max_parallel%&
22849 permits this.
22850
22851
22852 .option multi_domain smtp boolean true
22853 .vindex "&$domain$&"
22854 When this option is set, the &(smtp)& transport can handle a number of
22855 addresses containing a mixture of different domains provided they all resolve
22856 to the same list of hosts. Turning the option off restricts the transport to
22857 handling only one domain at a time. This is useful if you want to use
22858 &$domain$& in an expansion for the transport, because it is set only when there
22859 is a single domain involved in a remote delivery.
22860
22861
22862 .option port smtp string&!! "see below"
22863 .cindex "port" "sending TCP/IP"
22864 .cindex "TCP/IP" "setting outgoing port"
22865 This option specifies the TCP/IP port on the server to which Exim connects.
22866 &*Note:*& Do not confuse this with the port that was used when a message was
22867 received, which is in &$received_port$&, formerly known as &$interface_port$&.
22868 The name was changed to minimize confusion with the outgoing port. There is no
22869 variable that contains an outgoing port.
22870
22871 If the value of this option begins with a digit it is taken as a port number;
22872 otherwise it is looked up using &[getservbyname()]&. The default value is
22873 normally &"smtp"&, but if &%protocol%& is set to &"lmtp"&, the default is
22874 &"lmtp"&. If the expansion fails, or if a port number cannot be found, delivery
22875 is deferred.
22876
22877
22878
22879 .option protocol smtp string smtp
22880 .cindex "LMTP" "over TCP/IP"
22881 .cindex "ssmtp protocol" "outbound"
22882 .cindex "TLS" "SSL-on-connect outbound"
22883 .vindex "&$port$&"
22884 If this option is set to &"lmtp"& instead of &"smtp"&, the default value for
22885 the &%port%& option changes to &"lmtp"&, and the transport operates the LMTP
22886 protocol (RFC 2033) instead of SMTP. This protocol is sometimes used for local
22887 deliveries into closed message stores. Exim also has support for running LMTP
22888 over a pipe to a local process &-- see chapter &<<CHAPLMTP>>&.
22889
22890 If this option is set to &"smtps"&, the default vaule for the &%port%& option
22891 changes to &"smtps"&, and the transport initiates TLS immediately after
22892 connecting, as an outbound SSL-on-connect, instead of using STARTTLS to upgrade.
22893 The Internet standards bodies strongly discourage use of this mode.
22894
22895
22896 .option retry_include_ip_address smtp boolean true
22897 Exim normally includes both the host name and the IP address in the key it
22898 constructs for indexing retry data after a temporary delivery failure. This
22899 means that when one of several IP addresses for a host is failing, it gets
22900 tried periodically (controlled by the retry rules), but use of the other IP
22901 addresses is not affected.
22902
22903 However, in some dialup environments hosts are assigned a different IP address
22904 each time they connect. In this situation the use of the IP address as part of
22905 the retry key leads to undesirable behaviour. Setting this option false causes
22906 Exim to use only the host name. This should normally be done on a separate
22907 instance of the &(smtp)& transport, set up specially to handle the dialup
22908 hosts.
22909
22910
22911 .option serialize_hosts smtp "host list&!!" unset
22912 .cindex "serializing connections"
22913 .cindex "host" "serializing connections"
22914 Because Exim operates in a distributed manner, if several messages for the same
22915 host arrive at around the same time, more than one simultaneous connection to
22916 the remote host can occur. This is not usually a problem except when there is a
22917 slow link between the hosts. In that situation it may be helpful to restrict
22918 Exim to one connection at a time. This can be done by setting
22919 &%serialize_hosts%& to match the relevant hosts.
22920
22921 .cindex "hints database" "serializing deliveries to a host"
22922 Exim implements serialization by means of a hints database in which a record is
22923 written whenever a process connects to one of the restricted hosts. The record
22924 is deleted when the connection is completed. Obviously there is scope for
22925 records to get left lying around if there is a system or program crash. To
22926 guard against this, Exim ignores any records that are more than six hours old.
22927
22928 If you set up this kind of serialization, you should also arrange to delete the
22929 relevant hints database whenever your system reboots. The names of the files
22930 start with &_misc_& and they are kept in the &_spool/db_& directory. There
22931 may be one or two files, depending on the type of DBM in use. The same files
22932 are used for ETRN serialization.
22933
22934
22935 .option size_addition smtp integer 1024
22936 .cindex "SMTP" "SIZE"
22937 .cindex "message" "size issue for transport filter"
22938 .cindex "size" "of message"
22939 .cindex "transport" "filter"
22940 .cindex "filter" "transport filter"
22941 If a remote SMTP server indicates that it supports the SIZE option of the
22942 MAIL command, Exim uses this to pass over the message size at the start of
22943 an SMTP transaction. It adds the value of &%size_addition%& to the value it
22944 sends, to allow for headers and other text that may be added during delivery by
22945 configuration options or in a transport filter. It may be necessary to increase
22946 this if a lot of text is added to messages.
22947
22948 Alternatively, if the value of &%size_addition%& is set negative, it disables
22949 the use of the SIZE option altogether.
22950
22951
22952 .option tls_certificate smtp string&!! unset
22953 .cindex "TLS" "client certificate, location of"
22954 .cindex "certificate" "client, location of"
22955 .vindex "&$host$&"
22956 .vindex "&$host_address$&"
22957 The value of this option must be the absolute path to a file which contains the
22958 client's certificate, for possible use when sending a message over an encrypted
22959 connection. The values of &$host$& and &$host_address$& are set to the name and
22960 address of the server during the expansion. See chapter &<<CHAPTLS>>& for
22961 details of TLS.
22962
22963 &*Note*&: This option must be set if you want Exim to be able to use a TLS
22964 certificate when sending messages as a client. The global option of the same
22965 name specifies the certificate for Exim as a server; it is not automatically
22966 assumed that the same certificate should be used when Exim is operating as a
22967 client.
22968
22969
22970 .option tls_crl smtp string&!! unset
22971 .cindex "TLS" "client certificate revocation list"
22972 .cindex "certificate" "revocation list for client"
22973 This option specifies a certificate revocation list. The expanded value must
22974 be the name of a file that contains a CRL in PEM format.
22975
22976
22977 .new
22978 .option tls_dh_min_bits smtp integer 1024
22979 .cindex "TLS" "Diffie-Hellman minimum acceptable size"
22980 When establishing a TLS session, if a ciphersuite which uses Diffie-Hellman
22981 key agreement is negotiated, the server will provide a large prime number
22982 for use.  This option establishes the minimum acceptable size of that number.
22983 If the parameter offered by the server is too small, then the TLS handshake
22984 will fail.
22985
22986 Only supported when using GnuTLS.
22987 .wen
22988
22989
22990 .option tls_privatekey smtp string&!! unset
22991 .cindex "TLS" "client private key, location of"
22992 .vindex "&$host$&"
22993 .vindex "&$host_address$&"
22994 The value of this option must be the absolute path to a file which contains the
22995 client's private key. This is used when sending a message over an encrypted
22996 connection using a client certificate. The values of &$host$& and
22997 &$host_address$& are set to the name and address of the server during the
22998 expansion. If this option is unset, or the expansion is forced to fail, or the
22999 result is an empty string, the private key is assumed to be in the same file as
23000 the certificate. See chapter &<<CHAPTLS>>& for details of TLS.
23001
23002
23003 .option tls_require_ciphers smtp string&!! unset
23004 .cindex "TLS" "requiring specific ciphers"
23005 .cindex "cipher" "requiring specific"
23006 .vindex "&$host$&"
23007 .vindex "&$host_address$&"
23008 The value of this option must be a list of permitted cipher suites, for use
23009 when setting up an outgoing encrypted connection. (There is a global option of
23010 the same name for controlling incoming connections.) The values of &$host$& and
23011 &$host_address$& are set to the name and address of the server during the
23012 expansion. See chapter &<<CHAPTLS>>& for details of TLS; note that this option
23013 is used in different ways by OpenSSL and GnuTLS (see sections
23014 &<<SECTreqciphssl>>& and &<<SECTreqciphgnu>>&). For GnuTLS, the order of the
23015 ciphers is a preference order.
23016
23017
23018
23019 .option tls_sni smtp string&!! unset
23020 .cindex "TLS" "Server Name Indication"
23021 .vindex "&$tls_sni$&"
23022 If this option is set then it sets the $tls_out_sni variable and causes any
23023 TLS session to pass this value as the Server Name Indication extension to
23024 the remote side, which can be used by the remote side to select an appropriate
23025 certificate and private key for the session.
23026
23027 See &<<SECTtlssni>>& for more information.
23028
23029 Note that for OpenSSL, this feature requires a build of OpenSSL that supports
23030 TLS extensions.
23031
23032
23033
23034
23035 .option tls_tempfail_tryclear smtp boolean true
23036 .cindex "4&'xx'& responses" "to STARTTLS"
23037 When the server host is not in &%hosts_require_tls%&, and there is a problem in
23038 setting up a TLS session, this option determines whether or not Exim should try
23039 to deliver the message unencrypted. If it is set false, delivery to the
23040 current host is deferred; if there are other hosts, they are tried. If this
23041 option is set true, Exim attempts to deliver unencrypted after a 4&'xx'&
23042 response to STARTTLS. Also, if STARTTLS is accepted, but the subsequent
23043 TLS negotiation fails, Exim closes the current connection (because it is in an
23044 unknown state), opens a new one to the same host, and then tries the delivery
23045 in clear.
23046
23047
23048 .option tls_verify_certificates smtp string&!! unset
23049 .cindex "TLS" "server certificate verification"
23050 .cindex "certificate" "verification of server"
23051 .vindex "&$host$&"
23052 .vindex "&$host_address$&"
23053 The value of this option must be the absolute path to a file containing
23054 permitted server certificates, for use when setting up an encrypted connection.
23055 Alternatively, if you are using OpenSSL, you can set
23056 &%tls_verify_certificates%& to the name of a directory containing certificate
23057 files. This does not work with GnuTLS; the option must be set to the name of a
23058 single file if you are using GnuTLS. The values of &$host$& and
23059 &$host_address$& are set to the name and address of the server during the
23060 expansion of this option. See chapter &<<CHAPTLS>>& for details of TLS.
23061
23062
23063
23064
23065 .section "How the limits for the number of hosts to try are used" &&&
23066          "SECTvalhosmax"
23067 .cindex "host" "maximum number to try"
23068 .cindex "limit" "hosts; maximum number tried"
23069 There are two options that are concerned with the number of hosts that are
23070 tried when an SMTP delivery takes place. They are &%hosts_max_try%& and
23071 &%hosts_max_try_hardlimit%&.
23072
23073
23074 The &%hosts_max_try%& option limits the number of hosts that are tried
23075 for a single delivery. However, despite the term &"host"& in its name, the
23076 option actually applies to each IP address independently. In other words, a
23077 multihomed host is treated as several independent hosts, just as it is for
23078 retrying.
23079
23080 Many of the larger ISPs have multiple MX records which often point to
23081 multihomed hosts. As a result, a list of a dozen or more IP addresses may be
23082 created as a result of routing one of these domains.
23083
23084 Trying every single IP address on such a long list does not seem sensible; if
23085 several at the top of the list fail, it is reasonable to assume there is some
23086 problem that is likely to affect all of them. Roughly speaking, the value of
23087 &%hosts_max_try%& is the maximum number that are tried before deferring the
23088 delivery. However, the logic cannot be quite that simple.
23089
23090 Firstly, IP addresses that are skipped because their retry times have not
23091 arrived do not count, and in addition, addresses that are past their retry
23092 limits are also not counted, even when they are tried. This means that when
23093 some IP addresses are past their retry limits, more than the value of
23094 &%hosts_max_retry%& may be tried. The reason for this behaviour is to ensure
23095 that all IP addresses are considered before timing out an email address (but
23096 see below for an exception).
23097
23098 Secondly, when the &%hosts_max_try%& limit is reached, Exim looks down the host
23099 list to see if there is a subsequent host with a different (higher valued) MX.
23100 If there is, that host is considered next, and the current IP address is used
23101 but not counted. This behaviour helps in the case of a domain with a retry rule
23102 that hardly ever delays any hosts, as is now explained:
23103
23104 Consider the case of a long list of hosts with one MX value, and a few with a
23105 higher MX value. If &%hosts_max_try%& is small (the default is 5) only a few
23106 hosts at the top of the list are tried at first. With the default retry rule,
23107 which specifies increasing retry times, the higher MX hosts are eventually
23108 tried when those at the top of the list are skipped because they have not
23109 reached their retry times.
23110
23111 However, it is common practice to put a fixed short retry time on domains for
23112 large ISPs, on the grounds that their servers are rarely down for very long.
23113 Unfortunately, these are exactly the domains that tend to resolve to long lists
23114 of hosts. The short retry time means that the lowest MX hosts are tried every
23115 time. The attempts may be in a different order because of random sorting, but
23116 without the special MX check, the higher MX hosts would never be tried until
23117 all the lower MX hosts had timed out (which might be several days), because
23118 there are always some lower MX hosts that have reached their retry times. With
23119 the special check, Exim considers at least one IP address from each MX value at
23120 every delivery attempt, even if the &%hosts_max_try%& limit has already been
23121 reached.
23122
23123 The above logic means that &%hosts_max_try%& is not a hard limit, and in
23124 particular, Exim normally eventually tries all the IP addresses before timing
23125 out an email address. When &%hosts_max_try%& was implemented, this seemed a
23126 reasonable thing to do. Recently, however, some lunatic DNS configurations have
23127 been set up with hundreds of IP addresses for some domains. It can
23128 take a very long time indeed for an address to time out in these cases.
23129
23130 The &%hosts_max_try_hardlimit%& option was added to help with this problem.
23131 Exim never tries more than this number of IP addresses; if it hits this limit
23132 and they are all timed out, the email address is bounced, even though not all
23133 possible IP addresses have been tried.
23134 .ecindex IIDsmttra1
23135 .ecindex IIDsmttra2
23136
23137
23138
23139
23140
23141 . ////////////////////////////////////////////////////////////////////////////
23142 . ////////////////////////////////////////////////////////////////////////////
23143
23144 .chapter "Address rewriting" "CHAPrewrite"
23145 .scindex IIDaddrew "rewriting" "addresses"
23146 There are some circumstances in which Exim automatically rewrites domains in
23147 addresses. The two most common are when an address is given without a domain
23148 (referred to as an &"unqualified address"&) or when an address contains an
23149 abbreviated domain that is expanded by DNS lookup.
23150
23151 Unqualified envelope addresses are accepted only for locally submitted
23152 messages, or for messages that are received from hosts matching
23153 &%sender_unqualified_hosts%& or &%recipient_unqualified_hosts%&, as
23154 appropriate. Unqualified addresses in header lines are qualified if they are in
23155 locally submitted messages, or messages from hosts that are permitted to send
23156 unqualified envelope addresses. Otherwise, unqualified addresses in header
23157 lines are neither qualified nor rewritten.
23158
23159 One situation in which Exim does &'not'& automatically rewrite a domain is
23160 when it is the name of a CNAME record in the DNS. The older RFCs suggest that
23161 such a domain should be rewritten using the &"canonical"& name, and some MTAs
23162 do this. The new RFCs do not contain this suggestion.
23163
23164
23165 .section "Explicitly configured address rewriting" "SECID147"
23166 This chapter describes the rewriting rules that can be used in the
23167 main rewrite section of the configuration file, and also in the generic
23168 &%headers_rewrite%& option that can be set on any transport.
23169
23170 Some people believe that configured address rewriting is a Mortal Sin.
23171 Others believe that life is not possible without it. Exim provides the
23172 facility; you do not have to use it.
23173
23174 The main rewriting rules that appear in the &"rewrite"& section of the
23175 configuration file are applied to addresses in incoming messages, both envelope
23176 addresses and addresses in header lines. Each rule specifies the types of
23177 address to which it applies.
23178
23179 Whether or not addresses in header lines are rewritten depends on the origin of
23180 the headers and the type of rewriting. Global rewriting, that is, rewriting
23181 rules from the rewrite section of the configuration file, is applied only to
23182 those headers that were received with the message. Header lines that are added
23183 by ACLs or by a system filter or by individual routers or transports (which
23184 are specific to individual recipient addresses) are not rewritten by the global
23185 rules.
23186
23187 Rewriting at transport time, by means of the &%headers_rewrite%& option,
23188 applies all headers except those added by routers and transports. That is, as
23189 well as the headers that were received with the message, it also applies to
23190 headers that were added by an ACL or a system filter.
23191
23192
23193 In general, rewriting addresses from your own system or domain has some
23194 legitimacy. Rewriting other addresses should be done only with great care and
23195 in special circumstances. The author of Exim believes that rewriting should be
23196 used sparingly, and mainly for &"regularizing"& addresses in your own domains.
23197 Although it can sometimes be used as a routing tool, this is very strongly
23198 discouraged.
23199
23200 There are two commonly encountered circumstances where rewriting is used, as
23201 illustrated by these examples:
23202
23203 .ilist
23204 The company whose domain is &'hitch.fict.example'& has a number of hosts that
23205 exchange mail with each other behind a firewall, but there is only a single
23206 gateway to the outer world. The gateway rewrites &'*.hitch.fict.example'& as
23207 &'hitch.fict.example'& when sending mail off-site.
23208 .next
23209 A host rewrites the local parts of its own users so that, for example,
23210 &'fp42@hitch.fict.example'& becomes &'Ford.Prefect@hitch.fict.example'&.
23211 .endlist
23212
23213
23214
23215 .section "When does rewriting happen?" "SECID148"
23216 .cindex "rewriting" "timing of"
23217 .cindex "&ACL;" "rewriting addresses in"
23218 Configured address rewriting can take place at several different stages of a
23219 message's processing.
23220
23221 .vindex "&$sender_address$&"
23222 At the start of an ACL for MAIL, the sender address may have been rewritten
23223 by a special SMTP-time rewrite rule (see section &<<SECTrewriteS>>&), but no
23224 ordinary rewrite rules have yet been applied. If, however, the sender address
23225 is verified in the ACL, it is rewritten before verification, and remains
23226 rewritten thereafter. The subsequent value of &$sender_address$& is the
23227 rewritten address. This also applies if sender verification happens in a
23228 RCPT ACL. Otherwise, when the sender address is not verified, it is
23229 rewritten as soon as a message's header lines have been received.
23230
23231 .vindex "&$domain$&"
23232 .vindex "&$local_part$&"
23233 Similarly, at the start of an ACL for RCPT, the current recipient's address
23234 may have been rewritten by a special SMTP-time rewrite rule, but no ordinary
23235 rewrite rules have yet been applied to it. However, the behaviour is different
23236 from the sender address when a recipient is verified. The address is rewritten
23237 for the verification, but the rewriting is not remembered at this stage. The
23238 value of &$local_part$& and &$domain$& after verification are always the same
23239 as they were before (that is, they contain the unrewritten &-- except for
23240 SMTP-time rewriting &-- address).
23241
23242 As soon as a message's header lines have been received, all the envelope
23243 recipient addresses are permanently rewritten, and rewriting is also applied to
23244 the addresses in the header lines (if configured). This happens before adding
23245 any header lines that were specified in MAIL or RCPT ACLs, and
23246 .cindex "&[local_scan()]& function" "address rewriting; timing of"
23247 before the DATA ACL and &[local_scan()]& functions are run.
23248
23249 When an address is being routed, either for delivery or for verification,
23250 rewriting is applied immediately to child addresses that are generated by
23251 redirection, unless &%no_rewrite%& is set on the router.
23252
23253 .cindex "envelope sender" "rewriting at transport time"
23254 .cindex "rewriting" "at transport time"
23255 .cindex "header lines" "rewriting at transport time"
23256 At transport time, additional rewriting of addresses in header lines can be
23257 specified by setting the generic &%headers_rewrite%& option on a transport.
23258 This option contains rules that are identical in form to those in the rewrite
23259 section of the configuration file. They are applied to the original message
23260 header lines and any that were added by ACLs or a system filter. They are not
23261 applied to header lines that are added by routers or the transport.
23262
23263 The outgoing envelope sender can be rewritten by means of the &%return_path%&
23264 transport option. However, it is not possible to rewrite envelope recipients at
23265 transport time.
23266
23267
23268
23269
23270 .section "Testing the rewriting rules that apply on input" "SECID149"
23271 .cindex "rewriting" "testing"
23272 .cindex "testing" "rewriting"
23273 Exim's input rewriting configuration appears in a part of the run time
23274 configuration file headed by &"begin rewrite"&. It can be tested by the
23275 &%-brw%& command line option. This takes an address (which can be a full RFC
23276 2822 address) as its argument. The output is a list of how the address would be
23277 transformed by the rewriting rules for each of the different places it might
23278 appear in an incoming message, that is, for each different header and for the
23279 envelope sender and recipient fields. For example,
23280 .code
23281 exim -brw ph10@exim.workshop.example
23282 .endd
23283 might produce the output
23284 .code
23285 sender: Philip.Hazel@exim.workshop.example
23286 from: Philip.Hazel@exim.workshop.example
23287 to: ph10@exim.workshop.example
23288 cc: ph10@exim.workshop.example
23289 bcc: ph10@exim.workshop.example
23290 reply-to: Philip.Hazel@exim.workshop.example
23291 env-from: Philip.Hazel@exim.workshop.example
23292 env-to: ph10@exim.workshop.example
23293 .endd
23294 which shows that rewriting has been set up for that address when used in any of
23295 the source fields, but not when it appears as a recipient address. At the
23296 present time, there is no equivalent way of testing rewriting rules that are
23297 set for a particular transport.
23298
23299
23300 .section "Rewriting rules" "SECID150"
23301 .cindex "rewriting" "rules"
23302 The rewrite section of the configuration file consists of lines of rewriting
23303 rules in the form
23304 .display
23305 <&'source pattern'&>  <&'replacement'&>  <&'flags'&>
23306 .endd
23307 Rewriting rules that are specified for the &%headers_rewrite%& generic
23308 transport option are given as a colon-separated list. Each item in the list
23309 takes the same form as a line in the main rewriting configuration (except that
23310 any colons must be doubled, of course).
23311
23312 The formats of source patterns and replacement strings are described below.
23313 Each is terminated by white space, unless enclosed in double quotes, in which
23314 case normal quoting conventions apply inside the quotes. The flags are single
23315 characters which may appear in any order. Spaces and tabs between them are
23316 ignored.
23317
23318 For each address that could potentially be rewritten, the rules are scanned in
23319 order, and replacements for the address from earlier rules can themselves be
23320 replaced by later rules (but see the &"q"& and &"R"& flags).
23321
23322 The order in which addresses are rewritten is undefined, may change between
23323 releases, and must not be relied on, with one exception: when a message is
23324 received, the envelope sender is always rewritten first, before any header
23325 lines are rewritten. For example, the replacement string for a rewrite of an
23326 address in &'To:'& must not assume that the message's address in &'From:'& has
23327 (or has not) already been rewritten. However, a rewrite of &'From:'& may assume
23328 that the envelope sender has already been rewritten.
23329
23330 .vindex "&$domain$&"
23331 .vindex "&$local_part$&"
23332 The variables &$local_part$& and &$domain$& can be used in the replacement
23333 string to refer to the address that is being rewritten. Note that lookup-driven
23334 rewriting can be done by a rule of the form
23335 .code
23336 *@*   ${lookup ...
23337 .endd
23338 where the lookup key uses &$1$& and &$2$& or &$local_part$& and &$domain$& to
23339 refer to the address that is being rewritten.
23340
23341
23342 .section "Rewriting patterns" "SECID151"
23343 .cindex "rewriting" "patterns"
23344 .cindex "address list" "in a rewriting pattern"
23345 The source pattern in a rewriting rule is any item which may appear in an
23346 address list (see section &<<SECTaddresslist>>&). It is in fact processed as a
23347 single-item address list, which means that it is expanded before being tested
23348 against the address. As always, if you use a regular expression as a pattern,
23349 you must take care to escape dollar and backslash characters, or use the &`\N`&
23350 facility to suppress string expansion within the regular expression.
23351
23352 Domains in patterns should be given in lower case. Local parts in patterns are
23353 case-sensitive. If you want to do case-insensitive matching of local parts, you
23354 can use a regular expression that starts with &`^(?i)`&.
23355
23356 .cindex "numerical variables (&$1$& &$2$& etc)" "in rewriting rules"
23357 After matching, the numerical variables &$1$&, &$2$&, etc. may be set,
23358 depending on the type of match which occurred. These can be used in the
23359 replacement string to insert portions of the incoming address. &$0$& always
23360 refers to the complete incoming address. When a regular expression is used, the
23361 numerical variables are set from its capturing subexpressions. For other types
23362 of pattern they are set as follows:
23363
23364 .ilist
23365 If a local part or domain starts with an asterisk, the numerical variables
23366 refer to the character strings matched by asterisks, with &$1$& associated with
23367 the first asterisk, and &$2$& with the second, if present. For example, if the
23368 pattern
23369 .code
23370 *queen@*.fict.example
23371 .endd
23372 is matched against the address &'hearts-queen@wonderland.fict.example'& then
23373 .code
23374 $0 = hearts-queen@wonderland.fict.example
23375 $1 = hearts-
23376 $2 = wonderland
23377 .endd
23378 Note that if the local part does not start with an asterisk, but the domain
23379 does, it is &$1$& that contains the wild part of the domain.
23380
23381 .next
23382 If the domain part of the pattern is a partial lookup, the wild and fixed parts
23383 of the domain are placed in the next available numerical variables. Suppose,
23384 for example, that the address &'foo@bar.baz.example'& is processed by a
23385 rewriting rule of the form
23386 .display
23387 &`*@partial-dbm;/some/dbm/file`&    <&'replacement string'&>
23388 .endd
23389 and the key in the file that matches the domain is &`*.baz.example`&. Then
23390 .code
23391 $1 = foo
23392 $2 = bar
23393 $3 = baz.example
23394 .endd
23395 If the address &'foo@baz.example'& is looked up, this matches the same
23396 wildcard file entry, and in this case &$2$& is set to the empty string, but
23397 &$3$& is still set to &'baz.example'&. If a non-wild key is matched in a
23398 partial lookup, &$2$& is again set to the empty string and &$3$& is set to the
23399 whole domain. For non-partial domain lookups, no numerical variables are set.
23400 .endlist
23401
23402
23403 .section "Rewriting replacements" "SECID152"
23404 .cindex "rewriting" "replacements"
23405 If the replacement string for a rule is a single asterisk, addresses that
23406 match the pattern and the flags are &'not'& rewritten, and no subsequent
23407 rewriting rules are scanned. For example,
23408 .code
23409 hatta@lookingglass.fict.example  *  f
23410 .endd
23411 specifies that &'hatta@lookingglass.fict.example'& is never to be rewritten in
23412 &'From:'& headers.
23413
23414 .vindex "&$domain$&"
23415 .vindex "&$local_part$&"
23416 If the replacement string is not a single asterisk, it is expanded, and must
23417 yield a fully qualified address. Within the expansion, the variables
23418 &$local_part$& and &$domain$& refer to the address that is being rewritten.
23419 Any letters they contain retain their original case &-- they are not lower
23420 cased. The numerical variables are set up according to the type of pattern that
23421 matched the address, as described above. If the expansion is forced to fail by
23422 the presence of &"fail"& in a conditional or lookup item, rewriting by the
23423 current rule is abandoned, but subsequent rules may take effect. Any other
23424 expansion failure causes the entire rewriting operation to be abandoned, and an
23425 entry written to the panic log.
23426
23427
23428
23429 .section "Rewriting flags" "SECID153"
23430 There are three different kinds of flag that may appear on rewriting rules:
23431
23432 .ilist
23433 Flags that specify which headers and envelope addresses to rewrite: E, F, T, b,
23434 c, f, h, r, s, t.
23435 .next
23436 A flag that specifies rewriting at SMTP time: S.
23437 .next
23438 Flags that control the rewriting process: Q, q, R, w.
23439 .endlist
23440
23441 For rules that are part of the &%headers_rewrite%& generic transport option,
23442 E, F, T, and S are not permitted.
23443
23444
23445
23446 .section "Flags specifying which headers and envelope addresses to rewrite" &&&
23447          "SECID154"
23448 .cindex "rewriting" "flags"
23449 If none of the following flag letters, nor the &"S"& flag (see section
23450 &<<SECTrewriteS>>&) are present, a main rewriting rule applies to all headers
23451 and to both the sender and recipient fields of the envelope, whereas a
23452 transport-time rewriting rule just applies to all headers. Otherwise, the
23453 rewriting rule is skipped unless the relevant addresses are being processed.
23454 .display
23455 &`E`&       rewrite all envelope fields
23456 &`F`&       rewrite the envelope From field
23457 &`T`&       rewrite the envelope To field
23458 &`b`&       rewrite the &'Bcc:'& header
23459 &`c`&       rewrite the &'Cc:'& header
23460 &`f`&       rewrite the &'From:'& header
23461 &`h`&       rewrite all headers
23462 &`r`&       rewrite the &'Reply-To:'& header
23463 &`s`&       rewrite the &'Sender:'& header
23464 &`t`&       rewrite the &'To:'& header
23465 .endd
23466 "All headers" means all of the headers listed above that can be selected
23467 individually, plus their &'Resent-'& versions. It does not include
23468 other headers such as &'Subject:'& etc.
23469
23470 You should be particularly careful about rewriting &'Sender:'& headers, and
23471 restrict this to special known cases in your own domains.
23472
23473
23474 .section "The SMTP-time rewriting flag" "SECTrewriteS"
23475 .cindex "SMTP" "rewriting malformed addresses"
23476 .cindex "RCPT" "rewriting argument of"
23477 .cindex "MAIL" "rewriting argument of"
23478 The rewrite flag &"S"& specifies a rewrite of incoming envelope addresses at
23479 SMTP time, as soon as an address is received in a MAIL or RCPT command, and
23480 before any other processing; even before syntax checking. The pattern is
23481 required to be a regular expression, and it is matched against the whole of the
23482 data for the command, including any surrounding angle brackets.
23483
23484 .vindex "&$domain$&"
23485 .vindex "&$local_part$&"
23486 This form of rewrite rule allows for the handling of addresses that are not
23487 compliant with RFCs 2821 and 2822 (for example, &"bang paths"& in batched SMTP
23488 input). Because the input is not required to be a syntactically valid address,
23489 the variables &$local_part$& and &$domain$& are not available during the
23490 expansion of the replacement string. The result of rewriting replaces the
23491 original address in the MAIL or RCPT command.
23492
23493
23494 .section "Flags controlling the rewriting process" "SECID155"
23495 There are four flags which control the way the rewriting process works. These
23496 take effect only when a rule is invoked, that is, when the address is of the
23497 correct type (matches the flags) and matches the pattern:
23498
23499 .ilist
23500 If the &"Q"& flag is set on a rule, the rewritten address is permitted to be an
23501 unqualified local part. It is qualified with &%qualify_recipient%&. In the
23502 absence of &"Q"& the rewritten address must always include a domain.
23503 .next
23504 If the &"q"& flag is set on a rule, no further rewriting rules are considered,
23505 even if no rewriting actually takes place because of a &"fail"& in the
23506 expansion. The &"q"& flag is not effective if the address is of the wrong type
23507 (does not match the flags) or does not match the pattern.
23508 .next
23509 The &"R"& flag causes a successful rewriting rule to be re-applied to the new
23510 address, up to ten times. It can be combined with the &"q"& flag, to stop
23511 rewriting once it fails to match (after at least one successful rewrite).
23512 .next
23513 .cindex "rewriting" "whole addresses"
23514 When an address in a header is rewritten, the rewriting normally applies only
23515 to the working part of the address, with any comments and RFC 2822 &"phrase"&
23516 left unchanged. For example, rewriting might change
23517 .code
23518 From: Ford Prefect <fp42@restaurant.hitch.fict.example>
23519 .endd
23520 into
23521 .code
23522 From: Ford Prefect <prefectf@hitch.fict.example>
23523 .endd
23524 .cindex "RFC 2047"
23525 Sometimes there is a need to replace the whole address item, and this can be
23526 done by adding the flag letter &"w"& to a rule. If this is set on a rule that
23527 causes an address in a header line to be rewritten, the entire address is
23528 replaced, not just the working part. The replacement must be a complete RFC
23529 2822 address, including the angle brackets if necessary. If text outside angle
23530 brackets contains a character whose value is greater than 126 or less than 32
23531 (except for tab), the text is encoded according to RFC 2047. The character set
23532 is taken from &%headers_charset%&, which defaults to ISO-8859-1.
23533
23534 When the &"w"& flag is set on a rule that causes an envelope address to be
23535 rewritten, all but the working part of the replacement address is discarded.
23536 .endlist
23537
23538
23539 .section "Rewriting examples" "SECID156"
23540 Here is an example of the two common rewriting paradigms:
23541 .code
23542 *@*.hitch.fict.example  $1@hitch.fict.example
23543 *@hitch.fict.example    ${lookup{$1}dbm{/etc/realnames}\
23544                      {$value}fail}@hitch.fict.example bctfrF
23545 .endd
23546 Note the use of &"fail"& in the lookup expansion in the second rule, forcing
23547 the string expansion to fail if the lookup does not succeed. In this context it
23548 has the effect of leaving the original address unchanged, but Exim goes on to
23549 consider subsequent rewriting rules, if any, because the &"q"& flag is not
23550 present in that rule. An alternative to &"fail"& would be to supply &$1$&
23551 explicitly, which would cause the rewritten address to be the same as before,
23552 at the cost of a small bit of processing. Not supplying either of these is an
23553 error, since the rewritten address would then contain no local part.
23554
23555 The first example above replaces the domain with a superior, more general
23556 domain. This may not be desirable for certain local parts. If the rule
23557 .code
23558 root@*.hitch.fict.example  *
23559 .endd
23560 were inserted before the first rule, rewriting would be suppressed for the
23561 local part &'root'& at any domain ending in &'hitch.fict.example'&.
23562
23563 Rewriting can be made conditional on a number of tests, by making use of
23564 &${if$& in the expansion item. For example, to apply a rewriting rule only to
23565 messages that originate outside the local host:
23566 .code
23567 *@*.hitch.fict.example  "${if !eq {$sender_host_address}{}\
23568                          {$1@hitch.fict.example}fail}"
23569 .endd
23570 The replacement string is quoted in this example because it contains white
23571 space.
23572
23573 .cindex "rewriting" "bang paths"
23574 .cindex "bang paths" "rewriting"
23575 Exim does not handle addresses in the form of &"bang paths"&. If it sees such
23576 an address it treats it as an unqualified local part which it qualifies with
23577 the local qualification domain (if the source of the message is local or if the
23578 remote host is permitted to send unqualified addresses). Rewriting can
23579 sometimes be used to handle simple bang paths with a fixed number of
23580 components. For example, the rule
23581 .code
23582 \N^([^!]+)!(.*)@your.domain.example$\N   $2@$1
23583 .endd
23584 rewrites a two-component bang path &'host.name!user'& as the domain address
23585 &'user@host.name'&. However, there is a security implication in using this as
23586 a global rewriting rule for envelope addresses. It can provide a backdoor
23587 method for using your system as a relay, because the incoming addresses appear
23588 to be local. If the bang path addresses are received via SMTP, it is safer to
23589 use the &"S"& flag to rewrite them as they are received, so that relay checking
23590 can be done on the rewritten addresses.
23591 .ecindex IIDaddrew
23592
23593
23594
23595
23596
23597 . ////////////////////////////////////////////////////////////////////////////
23598 . ////////////////////////////////////////////////////////////////////////////
23599
23600 .chapter "Retry configuration" "CHAPretry"
23601 .scindex IIDretconf1 "retry" "configuration, description of"
23602 .scindex IIDregconf2 "configuration file" "retry section"
23603 The &"retry"& section of the runtime configuration file contains a list of
23604 retry rules that control how often Exim tries to deliver messages that cannot
23605 be delivered at the first attempt. If there are no retry rules (the section is
23606 empty or not present), there are no retries. In this situation, temporary
23607 errors are treated as permanent. The default configuration contains a single,
23608 general-purpose retry rule (see section &<<SECID57>>&). The &%-brt%& command
23609 line option can be used to test which retry rule will be used for a given
23610 address, domain and error.
23611
23612 The most common cause of retries is temporary failure to deliver to a remote
23613 host because the host is down, or inaccessible because of a network problem.
23614 Exim's retry processing in this case is applied on a per-host (strictly, per IP
23615 address) basis, not on a per-message basis. Thus, if one message has recently
23616 been delayed, delivery of a new message to the same host is not immediately
23617 tried, but waits for the host's retry time to arrive. If the &%retry_defer%&
23618 log selector is set, the message
23619 .cindex "retry" "time not reached"
23620 &"retry time not reached"& is written to the main log whenever a delivery is
23621 skipped for this reason. Section &<<SECToutSMTPerr>>& contains more details of
23622 the handling of errors during remote deliveries.
23623
23624 Retry processing applies to routing as well as to delivering, except as covered
23625 in the next paragraph. The retry rules do not distinguish between these
23626 actions. It is not possible, for example, to specify different behaviour for
23627 failures to route the domain &'snark.fict.example'& and failures to deliver to
23628 the host &'snark.fict.example'&. I didn't think anyone would ever need this
23629 added complication, so did not implement it. However, although they share the
23630 same retry rule, the actual retry times for routing and transporting a given
23631 domain are maintained independently.
23632
23633 When a delivery is not part of a queue run (typically an immediate delivery on
23634 receipt of a message), the routers are always run, and local deliveries are
23635 always attempted, even if retry times are set for them. This makes for better
23636 behaviour if one particular message is causing problems (for example, causing
23637 quota overflow, or provoking an error in a filter file). If such a delivery
23638 suffers a temporary failure, the retry data is updated as normal, and
23639 subsequent delivery attempts from queue runs occur only when the retry time for
23640 the local address is reached.
23641
23642 .section "Changing retry rules" "SECID157"
23643 If you change the retry rules in your configuration, you should consider
23644 whether or not to delete the retry data that is stored in Exim's spool area in
23645 files with names like &_db/retry_&. Deleting any of Exim's hints files is
23646 always safe; that is why they are called &"hints"&.
23647
23648 The hints retry data contains suggested retry times based on the previous
23649 rules. In the case of a long-running problem with a remote host, it might
23650 record the fact that the host has timed out. If your new rules increase the
23651 timeout time for such a host, you should definitely remove the old retry data
23652 and let Exim recreate it, based on the new rules. Otherwise Exim might bounce
23653 messages that it should now be retaining.
23654
23655
23656
23657 .section "Format of retry rules" "SECID158"
23658 .cindex "retry" "rules"
23659 Each retry rule occupies one line and consists of three or four parts,
23660 separated by white space: a pattern, an error name, an optional list of sender
23661 addresses, and a list of retry parameters. The pattern and sender lists must be
23662 enclosed in double quotes if they contain white space. The rules are searched
23663 in order until one is found where the pattern, error name, and sender list (if
23664 present) match the failing host or address, the error that occurred, and the
23665 message's sender, respectively.
23666
23667
23668 The pattern is any single item that may appear in an address list (see section
23669 &<<SECTaddresslist>>&). It is in fact processed as a one-item address list,
23670 which means that it is expanded before being tested against the address that
23671 has been delayed. A negated address list item is permitted. Address
23672 list processing treats a plain domain name as if it were preceded by &"*@"&,
23673 which makes it possible for many retry rules to start with just a domain. For
23674 example,
23675 .code
23676 lookingglass.fict.example        *  F,24h,30m;
23677 .endd
23678 provides a rule for any address in the &'lookingglass.fict.example'& domain,
23679 whereas
23680 .code
23681 alice@lookingglass.fict.example  *  F,24h,30m;
23682 .endd
23683 applies only to temporary failures involving the local part &%alice%&.
23684 In practice, almost all rules start with a domain name pattern without a local
23685 part.
23686
23687 .cindex "regular expressions" "in retry rules"
23688 &*Warning*&: If you use a regular expression in a retry rule pattern, it
23689 must match a complete address, not just a domain, because that is how regular
23690 expressions work in address lists.
23691 .display
23692 &`^\Nxyz\d+\.abc\.example$\N        *  G,1h,10m,2`&     &%Wrong%&
23693 &`^\N[^@]+@xyz\d+\.abc\.example$\N  *  G,1h,10m,2`&     &%Right%&
23694 .endd
23695
23696
23697 .section "Choosing which retry rule to use for address errors" "SECID159"
23698 When Exim is looking for a retry rule after a routing attempt has failed (for
23699 example, after a DNS timeout), each line in the retry configuration is tested
23700 against the complete address only if &%retry_use_local_part%& is set for the
23701 router. Otherwise, only the domain is used, except when matching against a
23702 regular expression, when the local part of the address is replaced with &"*"&.
23703 A domain on its own can match a domain pattern, or a pattern that starts with
23704 &"*@"&. By default, &%retry_use_local_part%& is true for routers where
23705 &%check_local_user%& is true, and false for other routers.
23706
23707 Similarly, when Exim is looking for a retry rule after a local delivery has
23708 failed (for example, after a mailbox full error), each line in the retry
23709 configuration is tested against the complete address only if
23710 &%retry_use_local_part%& is set for the transport (it defaults true for all
23711 local transports).
23712
23713 .cindex "4&'xx'& responses" "retry rules for"
23714 However, when Exim is looking for a retry rule after a remote delivery attempt
23715 suffers an address error (a 4&'xx'& SMTP response for a recipient address), the
23716 whole address is always used as the key when searching the retry rules. The
23717 rule that is found is used to create a retry time for the combination of the
23718 failing address and the message's sender. It is the combination of sender and
23719 recipient that is delayed in subsequent queue runs until its retry time is
23720 reached. You can delay the recipient without regard to the sender by setting
23721 &%address_retry_include_sender%& false in the &(smtp)& transport but this can
23722 lead to problems with servers that regularly issue 4&'xx'& responses to RCPT
23723 commands.
23724
23725
23726
23727 .section "Choosing which retry rule to use for host and message errors" &&&
23728          "SECID160"
23729 For a temporary error that is not related to an individual address (for
23730 example, a connection timeout), each line in the retry configuration is checked
23731 twice. First, the name of the remote host is used as a domain name (preceded by
23732 &"*@"& when matching a regular expression). If this does not match the line,
23733 the domain from the email address is tried in a similar fashion. For example,
23734 suppose the MX records for &'a.b.c.example'& are
23735 .code
23736 a.b.c.example  MX  5  x.y.z.example
23737                MX  6  p.q.r.example
23738                MX  7  m.n.o.example
23739 .endd
23740 and the retry rules are
23741 .code
23742 p.q.r.example    *      F,24h,30m;
23743 a.b.c.example    *      F,4d,45m;
23744 .endd
23745 and a delivery to the host &'x.y.z.example'& suffers a connection failure. The
23746 first rule matches neither the host nor the domain, so Exim looks at the second
23747 rule. This does not match the host, but it does match the domain, so it is used
23748 to calculate the retry time for the host &'x.y.z.example'&. Meanwhile, Exim
23749 tries to deliver to &'p.q.r.example'&. If this also suffers a host error, the
23750 first retry rule is used, because it matches the host.
23751
23752 In other words, temporary failures to deliver to host &'p.q.r.example'& use the
23753 first rule to determine retry times, but for all the other hosts for the domain
23754 &'a.b.c.example'&, the second rule is used. The second rule is also used if
23755 routing to &'a.b.c.example'& suffers a temporary failure.
23756
23757 &*Note*&: The host name is used when matching the patterns, not its IP address.
23758 However, if a message is routed directly to an IP address without the use of a
23759 host name, for example, if a &(manualroute)& router contains a setting such as:
23760 .code
23761 route_list = *.a.example  192.168.34.23
23762 .endd
23763 then the &"host name"& that is used when searching for a retry rule is the
23764 textual form of the IP address.
23765
23766 .section "Retry rules for specific errors" "SECID161"
23767 .cindex "retry" "specific errors; specifying"
23768 The second field in a retry rule is the name of a particular error, or an
23769 asterisk, which matches any error. The errors that can be tested for are:
23770
23771 .vlist
23772 .vitem &%auth_failed%&
23773 Authentication failed when trying to send to a host in the
23774 &%hosts_require_auth%& list in an &(smtp)& transport.
23775
23776 .vitem &%data_4xx%&
23777 A 4&'xx'& error was received for an outgoing DATA command, either immediately
23778 after the command, or after sending the message's data.
23779
23780 .vitem &%mail_4xx%&
23781 A 4&'xx'& error was received for an outgoing MAIL command.
23782
23783 .vitem &%rcpt_4xx%&
23784 A 4&'xx'& error was received for an outgoing RCPT command.
23785 .endlist
23786
23787 For the three 4&'xx'& errors, either the first or both of the x's can be given
23788 as specific digits, for example: &`mail_45x`& or &`rcpt_436`&. For example, to
23789 recognize 452 errors given to RCPT commands for addresses in a certain domain,
23790 and have retries every ten minutes with a one-hour timeout, you could set up a
23791 retry rule of this form:
23792 .code
23793 the.domain.name  rcpt_452   F,1h,10m
23794 .endd
23795 These errors apply to both outgoing SMTP (the &(smtp)& transport) and outgoing
23796 LMTP (either the &(lmtp)& transport, or the &(smtp)& transport in LMTP mode).
23797
23798 .vlist
23799 .vitem &%lost_connection%&
23800 A server unexpectedly closed the SMTP connection. There may, of course,
23801 legitimate reasons for this (host died, network died), but if it repeats a lot
23802 for the same host, it indicates something odd.
23803
23804 .vitem &%refused_MX%&
23805 A connection to a host obtained from an MX record was refused.
23806
23807 .vitem &%refused_A%&
23808 A connection to a host not obtained from an MX record was refused.
23809
23810 .vitem &%refused%&
23811 A connection was refused.
23812
23813 .vitem &%timeout_connect_MX%&
23814 A connection attempt to a host obtained from an MX record timed out.
23815
23816 .vitem &%timeout_connect_A%&
23817 A connection attempt to a host not obtained from an MX record timed out.
23818
23819 .vitem &%timeout_connect%&
23820 A connection attempt timed out.
23821
23822 .vitem &%timeout_MX%&
23823 There was a timeout while connecting or during an SMTP session with a host
23824 obtained from an MX record.
23825
23826 .vitem &%timeout_A%&
23827 There was a timeout while connecting or during an SMTP session with a host not
23828 obtained from an MX record.
23829
23830 .vitem &%timeout%&
23831 There was a timeout while connecting or during an SMTP session.
23832
23833 .vitem &%tls_required%&
23834 The server was required to use TLS (it matched &%hosts_require_tls%& in the
23835 &(smtp)& transport), but either did not offer TLS, or it responded with 4&'xx'&
23836 to STARTTLS, or there was a problem setting up the TLS connection.
23837
23838 .vitem &%quota%&
23839 A mailbox quota was exceeded in a local delivery by the &(appendfile)&
23840 transport.
23841
23842 .vitem &%quota_%&<&'time'&>
23843 .cindex "quota" "error testing in retry rule"
23844 .cindex "retry" "quota error testing"
23845 A mailbox quota was exceeded in a local delivery by the &(appendfile)&
23846 transport, and the mailbox has not been accessed for <&'time'&>. For example,
23847 &'quota_4d'& applies to a quota error when the mailbox has not been accessed
23848 for four days.
23849 .endlist
23850
23851 .cindex "mailbox" "time of last read"
23852 The idea of &%quota_%&<&'time'&> is to make it possible to have shorter
23853 timeouts when the mailbox is full and is not being read by its owner. Ideally,
23854 it should be based on the last time that the user accessed the mailbox.
23855 However, it is not always possible to determine this. Exim uses the following
23856 heuristic rules:
23857
23858 .ilist
23859 If the mailbox is a single file, the time of last access (the &"atime"&) is
23860 used. As no new messages are being delivered (because the mailbox is over
23861 quota), Exim does not access the file, so this is the time of last user access.
23862 .next
23863 .cindex "maildir format" "time of last read"
23864 For a maildir delivery, the time of last modification of the &_new_&
23865 subdirectory is used. As the mailbox is over quota, no new files are created in
23866 the &_new_& subdirectory, because no new messages are being delivered. Any
23867 change to the &_new_& subdirectory is therefore assumed to be the result of an
23868 MUA moving a new message to the &_cur_& directory when it is first read. The
23869 time that is used is therefore the last time that the user read a new message.
23870 .next
23871 For other kinds of multi-file mailbox, the time of last access cannot be
23872 obtained, so a retry rule that uses this type of error field is never matched.
23873 .endlist
23874
23875 The quota errors apply both to system-enforced quotas and to Exim's own quota
23876 mechanism in the &(appendfile)& transport. The &'quota'& error also applies
23877 when a local delivery is deferred because a partition is full (the ENOSPC
23878 error).
23879
23880
23881
23882 .section "Retry rules for specified senders" "SECID162"
23883 .cindex "retry" "rules; sender-specific"
23884 You can specify retry rules that apply only when the failing message has a
23885 specific sender. In particular, this can be used to define retry rules that
23886 apply only to bounce messages. The third item in a retry rule can be of this
23887 form:
23888 .display
23889 &`senders=`&<&'address list'&>
23890 .endd
23891 The retry timings themselves are then the fourth item. For example:
23892 .code
23893 *   rcpt_4xx   senders=:   F,1h,30m
23894 .endd
23895 matches recipient 4&'xx'& errors for bounce messages sent to any address at any
23896 host. If the address list contains white space, it must be enclosed in quotes.
23897 For example:
23898 .code
23899 a.domain  rcpt_452  senders="xb.dom : yc.dom"  G,8h,10m,1.5
23900 .endd
23901 &*Warning*&: This facility can be unhelpful if it is used for host errors
23902 (which do not depend on the recipient). The reason is that the sender is used
23903 only to match the retry rule. Once the rule has been found for a host error,
23904 its contents are used to set a retry time for the host, and this will apply to
23905 all messages, not just those with specific senders.
23906
23907 When testing retry rules using &%-brt%&, you can supply a sender using the
23908 &%-f%& command line option, like this:
23909 .code
23910 exim -f "" -brt user@dom.ain
23911 .endd
23912 If you do not set &%-f%& with &%-brt%&, a retry rule that contains a senders
23913 list is never matched.
23914
23915
23916
23917
23918
23919 .section "Retry parameters" "SECID163"
23920 .cindex "retry" "parameters in rules"
23921 The third (or fourth, if a senders list is present) field in a retry rule is a
23922 sequence of retry parameter sets, separated by semicolons. Each set consists of
23923 .display
23924 <&'letter'&>,<&'cutoff time'&>,<&'arguments'&>
23925 .endd
23926 The letter identifies the algorithm for computing a new retry time; the cutoff
23927 time is the time beyond which this algorithm no longer applies, and the
23928 arguments vary the algorithm's action. The cutoff time is measured from the
23929 time that the first failure for the domain (combined with the local part if
23930 relevant) was detected, not from the time the message was received.
23931
23932 .cindex "retry" "algorithms"
23933 .cindex "retry" "fixed intervals"
23934 .cindex "retry" "increasing intervals"
23935 .cindex "retry" "random intervals"
23936 The available algorithms are:
23937
23938 .ilist
23939 &'F'&: retry at fixed intervals. There is a single time parameter specifying
23940 the interval.
23941 .next
23942 &'G'&: retry at geometrically increasing intervals. The first argument
23943 specifies a starting value for the interval, and the second a multiplier, which
23944 is used to increase the size of the interval at each retry.
23945 .next
23946 &'H'&: retry at randomized intervals. The arguments are as for &'G'&. For each
23947 retry, the previous interval is multiplied by the factor in order to get a
23948 maximum for the next interval. The minimum interval is the first argument of
23949 the parameter, and an actual interval is chosen randomly between them. Such a
23950 rule has been found to be helpful in cluster configurations when all the
23951 members of the cluster restart at once, and may therefore synchronize their
23952 queue processing times.
23953 .endlist
23954
23955 When computing the next retry time, the algorithm definitions are scanned in
23956 order until one whose cutoff time has not yet passed is reached. This is then
23957 used to compute a new retry time that is later than the current time. In the
23958 case of fixed interval retries, this simply means adding the interval to the
23959 current time. For geometrically increasing intervals, retry intervals are
23960 computed from the rule's parameters until one that is greater than the previous
23961 interval is found. The main configuration variable
23962 .cindex "limit" "retry interval"
23963 .cindex "retry" "interval, maximum"
23964 .oindex "&%retry_interval_max%&"
23965 &%retry_interval_max%& limits the maximum interval between retries. It
23966 cannot be set greater than &`24h`&, which is its default value.
23967
23968 A single remote domain may have a number of hosts associated with it, and each
23969 host may have more than one IP address. Retry algorithms are selected on the
23970 basis of the domain name, but are applied to each IP address independently. If,
23971 for example, a host has two IP addresses and one is unusable, Exim will
23972 generate retry times for it and will not try to use it until its next retry
23973 time comes. Thus the good IP address is likely to be tried first most of the
23974 time.
23975
23976 .cindex "hints database" "use for retrying"
23977 Retry times are hints rather than promises. Exim does not make any attempt to
23978 run deliveries exactly at the computed times. Instead, a queue runner process
23979 starts delivery processes for delayed messages periodically, and these attempt
23980 new deliveries only for those addresses that have passed their next retry time.
23981 If a new message arrives for a deferred address, an immediate delivery attempt
23982 occurs only if the address has passed its retry time. In the absence of new
23983 messages, the minimum time between retries is the interval between queue runner
23984 processes. There is not much point in setting retry times of five minutes if
23985 your queue runners happen only once an hour, unless there are a significant
23986 number of incoming messages (which might be the case on a system that is
23987 sending everything to a smart host, for example).
23988
23989 The data in the retry hints database can be inspected by using the
23990 &'exim_dumpdb'& or &'exim_fixdb'& utility programs (see chapter
23991 &<<CHAPutils>>&). The latter utility can also be used to change the data. The
23992 &'exinext'& utility script can be used to find out what the next retry times
23993 are for the hosts associated with a particular mail domain, and also for local
23994 deliveries that have been deferred.
23995
23996
23997 .section "Retry rule examples" "SECID164"
23998 Here are some example retry rules:
23999 .code
24000 alice@wonderland.fict.example quota_5d  F,7d,3h
24001 wonderland.fict.example       quota_5d
24002 wonderland.fict.example       *         F,1h,15m; G,2d,1h,2;
24003 lookingglass.fict.example     *         F,24h,30m;
24004 *                 refused_A   F,2h,20m;
24005 *                 *           F,2h,15m; G,16h,1h,1.5; F,5d,8h
24006 .endd
24007 The first rule sets up special handling for mail to
24008 &'alice@wonderland.fict.example'& when there is an over-quota error and the
24009 mailbox has not been read for at least 5 days. Retries continue every three
24010 hours for 7 days. The second rule handles over-quota errors for all other local
24011 parts at &'wonderland.fict.example'&; the absence of a local part has the same
24012 effect as supplying &"*@"&. As no retry algorithms are supplied, messages that
24013 fail are bounced immediately if the mailbox has not been read for at least 5
24014 days.
24015
24016 The third rule handles all other errors at &'wonderland.fict.example'&; retries
24017 happen every 15 minutes for an hour, then with geometrically increasing
24018 intervals until two days have passed since a delivery first failed. After the
24019 first hour there is a delay of one hour, then two hours, then four hours, and
24020 so on (this is a rather extreme example).
24021
24022 The fourth rule controls retries for the domain &'lookingglass.fict.example'&.
24023 They happen every 30 minutes for 24 hours only. The remaining two rules handle
24024 all other domains, with special action for connection refusal from hosts that
24025 were not obtained from an MX record.
24026
24027 The final rule in a retry configuration should always have asterisks in the
24028 first two fields so as to provide a general catch-all for any addresses that do
24029 not have their own special handling. This example tries every 15 minutes for 2
24030 hours, then with intervals starting at one hour and increasing by a factor of
24031 1.5 up to 16 hours, then every 8 hours up to 5 days.
24032
24033
24034
24035 .section "Timeout of retry data" "SECID165"
24036 .cindex "timeout" "of retry data"
24037 .oindex "&%retry_data_expire%&"
24038 .cindex "hints database" "data expiry"
24039 .cindex "retry" "timeout of data"
24040 Exim timestamps the data that it writes to its retry hints database. When it
24041 consults the data during a delivery it ignores any that is older than the value
24042 set in &%retry_data_expire%& (default 7 days). If, for example, a host hasn't
24043 been tried for 7 days, Exim will try to deliver to it immediately a message
24044 arrives, and if that fails, it will calculate a retry time as if it were
24045 failing for the first time.
24046
24047 This improves the behaviour for messages routed to rarely-used hosts such as MX
24048 backups. If such a host was down at one time, and happens to be down again when
24049 Exim tries a month later, using the old retry data would imply that it had been
24050 down all the time, which is not a justified assumption.
24051
24052 If a host really is permanently dead, this behaviour causes a burst of retries
24053 every now and again, but only if messages routed to it are rare. If there is a
24054 message at least once every 7 days the retry data never expires.
24055
24056
24057
24058
24059 .section "Long-term failures" "SECID166"
24060 .cindex "delivery failure, long-term"
24061 .cindex "retry" "after long-term failure"
24062 Special processing happens when an email address has been failing for so long
24063 that the cutoff time for the last algorithm is reached. For example, using the
24064 default retry rule:
24065 .code
24066 * * F,2h,15m; G,16h,1h,1.5; F,4d,6h
24067 .endd
24068 the cutoff time is four days. Reaching the retry cutoff is independent of how
24069 long any specific message has been failing; it is the length of continuous
24070 failure for the recipient address that counts.
24071
24072 When the cutoff time is reached for a local delivery, or for all the IP
24073 addresses associated with a remote delivery, a subsequent delivery failure
24074 causes Exim to give up on the address, and a bounce message is generated.
24075 In order to cater for new messages that use the failing address, a next retry
24076 time is still computed from the final algorithm, and is used as follows:
24077
24078 For local deliveries, one delivery attempt is always made for any subsequent
24079 messages. If this delivery fails, the address fails immediately. The
24080 post-cutoff retry time is not used.
24081
24082 If the delivery is remote, there are two possibilities, controlled by the
24083 .oindex "&%delay_after_cutoff%&"
24084 &%delay_after_cutoff%& option of the &(smtp)& transport. The option is true by
24085 default. Until the post-cutoff retry time for one of the IP addresses is
24086 reached, the failing email address is bounced immediately, without a delivery
24087 attempt taking place. After that time, one new delivery attempt is made to
24088 those IP addresses that are past their retry times, and if that still fails,
24089 the address is bounced and new retry times are computed.
24090
24091 In other words, when all the hosts for a given email address have been failing
24092 for a long time, Exim bounces rather then defers until one of the hosts' retry
24093 times is reached. Then it tries once, and bounces if that attempt fails. This
24094 behaviour ensures that few resources are wasted in repeatedly trying to deliver
24095 to a broken destination, but if the host does recover, Exim will eventually
24096 notice.
24097
24098 If &%delay_after_cutoff%& is set false, Exim behaves differently. If all IP
24099 addresses are past their final cutoff time, Exim tries to deliver to those IP
24100 addresses that have not been tried since the message arrived. If there are
24101 no suitable IP addresses, or if they all fail, the address is bounced. In other
24102 words, it does not delay when a new message arrives, but tries the expired
24103 addresses immediately, unless they have been tried since the message arrived.
24104 If there is a continuous stream of messages for the failing domains, setting
24105 &%delay_after_cutoff%& false means that there will be many more attempts to
24106 deliver to permanently failing IP addresses than when &%delay_after_cutoff%& is
24107 true.
24108
24109 .section "Deliveries that work intermittently" "SECID167"
24110 .cindex "retry" "intermittently working deliveries"
24111 Some additional logic is needed to cope with cases where a host is
24112 intermittently available, or when a message has some attribute that prevents
24113 its delivery when others to the same address get through. In this situation,
24114 because some messages are successfully delivered, the &"retry clock"& for the
24115 host or address keeps getting reset by the successful deliveries, and so
24116 failing messages remain on the queue for ever because the cutoff time is never
24117 reached.
24118
24119 Two exceptional actions are applied to prevent this happening. The first
24120 applies to errors that are related to a message rather than a remote host.
24121 Section &<<SECToutSMTPerr>>& has a discussion of the different kinds of error;
24122 examples of message-related errors are 4&'xx'& responses to MAIL or DATA
24123 commands, and quota failures. For this type of error, if a message's arrival
24124 time is earlier than the &"first failed"& time for the error, the earlier time
24125 is used when scanning the retry rules to decide when to try next and when to
24126 time out the address.
24127
24128 The exceptional second action applies in all cases. If a message has been on
24129 the queue for longer than the cutoff time of any applicable retry rule for a
24130 given address, a delivery is attempted for that address, even if it is not yet
24131 time, and if this delivery fails, the address is timed out. A new retry time is
24132 not computed in this case, so that other messages for the same address are
24133 considered immediately.
24134 .ecindex IIDretconf1
24135 .ecindex IIDregconf2
24136
24137
24138
24139
24140
24141
24142 . ////////////////////////////////////////////////////////////////////////////
24143 . ////////////////////////////////////////////////////////////////////////////
24144
24145 .chapter "SMTP authentication" "CHAPSMTPAUTH"
24146 .scindex IIDauthconf1 "SMTP" "authentication configuration"
24147 .scindex IIDauthconf2 "authentication"
24148 The &"authenticators"& section of Exim's run time configuration is concerned
24149 with SMTP authentication. This facility is an extension to the SMTP protocol,
24150 described in RFC 2554, which allows a client SMTP host to authenticate itself
24151 to a server. This is a common way for a server to recognize clients that are
24152 permitted to use it as a relay. SMTP authentication is not of relevance to the
24153 transfer of mail between servers that have no managerial connection with each
24154 other.
24155
24156 .cindex "AUTH" "description of"
24157 Very briefly, the way SMTP authentication works is as follows:
24158
24159 .ilist
24160 The server advertises a number of authentication &'mechanisms'& in response to
24161 the client's EHLO command.
24162 .next
24163 The client issues an AUTH command, naming a specific mechanism. The command
24164 may, optionally, contain some authentication data.
24165 .next
24166 The server may issue one or more &'challenges'&, to which the client must send
24167 appropriate responses. In simple authentication mechanisms, the challenges are
24168 just prompts for user names and passwords. The server does not have to issue
24169 any challenges &-- in some mechanisms the relevant data may all be transmitted
24170 with the AUTH command.
24171 .next
24172 The server either accepts or denies authentication.
24173 .next
24174 If authentication succeeds, the client may optionally make use of the AUTH
24175 option on the MAIL command to pass an authenticated sender in subsequent
24176 mail transactions. Authentication lasts for the remainder of the SMTP
24177 connection.
24178 .next
24179 If authentication fails, the client may give up, or it may try a different
24180 authentication mechanism, or it may try transferring mail over the
24181 unauthenticated connection.
24182 .endlist
24183
24184 If you are setting up a client, and want to know which authentication
24185 mechanisms the server supports, you can use Telnet to connect to port 25 (the
24186 SMTP port) on the server, and issue an EHLO command. The response to this
24187 includes the list of supported mechanisms. For example:
24188 .display
24189 &`$ `&&*&`telnet server.example 25`&*&
24190 &`Trying 192.168.34.25...`&
24191 &`Connected to server.example.`&
24192 &`Escape character is &#x0027;^]&#x0027;.`&
24193 &`220 server.example ESMTP Exim 4.20 ...`&
24194 &*&`ehlo client.example`&*&
24195 &`250-server.example Hello client.example [10.8.4.5]`&
24196 &`250-SIZE 52428800`&
24197 &`250-PIPELINING`&
24198 &`250-AUTH PLAIN`&
24199 &`250 HELP`&
24200 .endd
24201 The second-last line of this example output shows that the server supports
24202 authentication using the PLAIN mechanism. In Exim, the different authentication
24203 mechanisms are configured by specifying &'authenticator'& drivers. Like the
24204 routers and transports, which authenticators are included in the binary is
24205 controlled by build-time definitions. The following are currently available,
24206 included by setting
24207 .code
24208 AUTH_CRAM_MD5=yes
24209 AUTH_CYRUS_SASL=yes
24210 AUTH_DOVECOT=yes
24211 AUTH_GSASL=yes
24212 AUTH_HEIMDAL_GSSAPI=yes
24213 AUTH_PLAINTEXT=yes
24214 AUTH_SPA=yes
24215 .endd
24216 in &_Local/Makefile_&, respectively. The first of these supports the CRAM-MD5
24217 authentication mechanism (RFC 2195), and the second provides an interface to
24218 the Cyrus SASL authentication library.
24219 The third is an interface to Dovecot's authentication system, delegating the
24220 work via a socket interface.
24221 The fourth provides an interface to the GNU SASL authentication library, which
24222 provides mechanisms but typically not data sources.
24223 The fifth provides direct access to Heimdal GSSAPI, geared for Kerberos, but
24224 supporting setting a server keytab.
24225 The sixth can be configured to support
24226 the PLAIN authentication mechanism (RFC 2595) or the LOGIN mechanism, which is
24227 not formally documented, but used by several MUAs. The seventh authenticator
24228 supports Microsoft's &'Secure Password Authentication'& mechanism.
24229
24230 The authenticators are configured using the same syntax as other drivers (see
24231 section &<<SECTfordricon>>&). If no authenticators are required, no
24232 authentication section need be present in the configuration file. Each
24233 authenticator can in principle have both server and client functions. When Exim
24234 is receiving SMTP mail, it is acting as a server; when it is sending out
24235 messages over SMTP, it is acting as a client. Authenticator configuration
24236 options are provided for use in both these circumstances.
24237
24238 To make it clear which options apply to which situation, the prefixes
24239 &%server_%& and &%client_%& are used on option names that are specific to
24240 either the server or the client function, respectively. Server and client
24241 functions are disabled if none of their options are set. If an authenticator is
24242 to be used for both server and client functions, a single definition, using
24243 both sets of options, is required. For example:
24244 .code
24245 cram:
24246   driver = cram_md5
24247   public_name = CRAM-MD5
24248   server_secret = ${if eq{$auth1}{ph10}{secret1}fail}
24249   client_name = ph10
24250   client_secret = secret2
24251 .endd
24252 The &%server_%& option is used when Exim is acting as a server, and the
24253 &%client_%& options when it is acting as a client.
24254
24255 Descriptions of the individual authenticators are given in subsequent chapters.
24256 The remainder of this chapter covers the generic options for the
24257 authenticators, followed by general discussion of the way authentication works
24258 in Exim.
24259
24260 &*Beware:*& the meaning of &$auth1$&, &$auth2$&, ... varies on a per-driver and
24261 per-mechanism basis.  Please read carefully to determine which variables hold
24262 account labels such as usercodes and which hold passwords or other
24263 authenticating data.
24264
24265 Note that some mechanisms support two different identifiers for accounts: the
24266 &'authentication id'& and the &'authorization id'&.  The contractions &'authn'&
24267 and &'authz'& are commonly encountered.  The American spelling is standard here.
24268 Conceptually, authentication data such as passwords are tied to the identifier
24269 used to authenticate; servers may have rules to permit one user to act as a
24270 second user, so that after login the session is treated as though that second
24271 user had logged in.  That second user is the &'authorization id'&.  A robust
24272 configuration might confirm that the &'authz'& field is empty or matches the
24273 &'authn'& field.  Often this is just ignored.  The &'authn'& can be considered
24274 as verified data, the &'authz'& as an unverified request which the server might
24275 choose to honour.
24276
24277 A &'realm'& is a text string, typically a domain name, presented by a server
24278 to a client to help it select an account and credentials to use.  In some
24279 mechanisms, the client and server provably agree on the realm, but clients
24280 typically can not treat the realm as secure data to be blindly trusted.
24281
24282
24283
24284 .section "Generic options for authenticators" "SECID168"
24285 .cindex "authentication" "generic options"
24286 .cindex "options" "generic; for authenticators"
24287
24288 .option client_condition authenticators string&!! unset
24289 When Exim is authenticating as a client, it skips any authenticator whose
24290 &%client_condition%& expansion yields &"0"&, &"no"&, or &"false"&. This can be
24291 used, for example, to skip plain text authenticators when the connection is not
24292 encrypted by a setting such as:
24293 .code
24294 client_condition = ${if !eq{$tls_out_cipher}{}}
24295 .endd
24296
24297
24298 .new
24299 .option client_set_id authenticators string&!! unset
24300 When client authentication succeeds, this condition is expanded; the
24301 result is used in the log lines for outbound messasges.
24302 Typically it will be the user name used for authentication.
24303 .wen
24304
24305
24306 .option driver authenticators string unset
24307 This option must always be set. It specifies which of the available
24308 authenticators is to be used.
24309
24310
24311 .option public_name authenticators string unset
24312 This option specifies the name of the authentication mechanism that the driver
24313 implements, and by which it is known to the outside world. These names should
24314 contain only upper case letters, digits, underscores, and hyphens (RFC 2222),
24315 but Exim in fact matches them caselessly. If &%public_name%& is not set, it
24316 defaults to the driver's instance name.
24317
24318
24319 .option server_advertise_condition authenticators string&!! unset
24320 When a server is about to advertise an authentication mechanism, the condition
24321 is expanded. If it yields the empty string, &"0"&, &"no"&, or &"false"&, the
24322 mechanism is not advertised.
24323 If the expansion fails, the mechanism is not advertised. If the failure was not
24324 forced, and was not caused by a lookup defer, the incident is logged.
24325 See section &<<SECTauthexiser>>& below for further discussion.
24326
24327
24328 .option server_condition authenticators string&!! unset
24329 This option must be set for a &%plaintext%& server authenticator, where it
24330 is used directly to control authentication. See section &<<SECTplainserver>>&
24331 for details.
24332
24333 For the &(gsasl)& authenticator, this option is required for various
24334 mechanisms; see chapter &<<CHAPgsasl>>& for details.
24335
24336 For the other authenticators, &%server_condition%& can be used as an additional
24337 authentication or authorization mechanism that is applied after the other
24338 authenticator conditions succeed. If it is set, it is expanded when the
24339 authenticator would otherwise return a success code. If the expansion is forced
24340 to fail, authentication fails. Any other expansion failure causes a temporary
24341 error code to be returned. If the result of a successful expansion is an empty
24342 string, &"0"&, &"no"&, or &"false"&, authentication fails. If the result of the
24343 expansion is &"1"&, &"yes"&, or &"true"&, authentication succeeds. For any
24344 other result, a temporary error code is returned, with the expanded string as
24345 the error text.
24346
24347
24348 .option server_debug_print authenticators string&!! unset
24349 If this option is set and authentication debugging is enabled (see the &%-d%&
24350 command line option), the string is expanded and included in the debugging
24351 output when the authenticator is run as a server. This can help with checking
24352 out the values of variables.
24353 If expansion of the string fails, the error message is written to the debugging
24354 output, and Exim carries on processing.
24355
24356
24357 .option server_set_id authenticators string&!! unset
24358 .vindex "&$authenticated_id$&"
24359 When an Exim server successfully authenticates a client, this string is
24360 expanded using data from the authentication, and preserved for any incoming
24361 messages in the variable &$authenticated_id$&. It is also included in the log
24362 lines for incoming messages. For example, a user/password authenticator
24363 configuration might preserve the user name that was used to authenticate, and
24364 refer to it subsequently during delivery of the message.
24365 If expansion fails, the option is ignored.
24366
24367
24368 .option server_mail_auth_condition authenticators string&!! unset
24369 This option allows a server to discard authenticated sender addresses supplied
24370 as part of MAIL commands in SMTP connections that are authenticated by the
24371 driver on which &%server_mail_auth_condition%& is set. The option is not used
24372 as part of the authentication process; instead its (unexpanded) value is
24373 remembered for later use.
24374 How it is used is described in the following section.
24375
24376
24377
24378
24379
24380 .section "The AUTH parameter on MAIL commands" "SECTauthparamail"
24381 .cindex "authentication" "sender; authenticated"
24382 .cindex "AUTH" "on MAIL command"
24383 When a client supplied an AUTH= item on a MAIL command, Exim applies
24384 the following checks before accepting it as the authenticated sender of the
24385 message:
24386
24387 .ilist
24388 If the connection is not using extended SMTP (that is, HELO was used rather
24389 than EHLO), the use of AUTH= is a syntax error.
24390 .next
24391 If the value of the AUTH= parameter is &"<>"&, it is ignored.
24392 .next
24393 .vindex "&$authenticated_sender$&"
24394 If &%acl_smtp_mailauth%& is defined, the ACL it specifies is run. While it is
24395 running, the value of &$authenticated_sender$& is set to the value obtained
24396 from the AUTH= parameter. If the ACL does not yield &"accept"&, the value of
24397 &$authenticated_sender$& is deleted. The &%acl_smtp_mailauth%& ACL may not
24398 return &"drop"& or &"discard"&. If it defers, a temporary error code (451) is
24399 given for the MAIL command.
24400 .next
24401 If &%acl_smtp_mailauth%& is not defined, the value of the AUTH= parameter
24402 is accepted and placed in &$authenticated_sender$& only if the client has
24403 authenticated.
24404 .next
24405 If the AUTH= value was accepted by either of the two previous rules, and
24406 the client has authenticated, and the authenticator has a setting for the
24407 &%server_mail_auth_condition%&, the condition is checked at this point. The
24408 valued that was saved from the authenticator is expanded. If the expansion
24409 fails, or yields an empty string, &"0"&, &"no"&, or &"false"&, the value of
24410 &$authenticated_sender$& is deleted. If the expansion yields any other value,
24411 the value of &$authenticated_sender$& is retained and passed on with the
24412 message.
24413 .endlist
24414
24415
24416 When &$authenticated_sender$& is set for a message, it is passed on to other
24417 hosts to which Exim authenticates as a client. Do not confuse this value with
24418 &$authenticated_id$&, which is a string obtained from the authentication
24419 process, and which is not usually a complete email address.
24420
24421 .vindex "&$sender_address$&"
24422 Whenever an AUTH= value is ignored, the incident is logged. The ACL for
24423 MAIL, if defined, is run after AUTH= is accepted or ignored. It can
24424 therefore make use of &$authenticated_sender$&. The converse is not true: the
24425 value of &$sender_address$& is not yet set up when the &%acl_smtp_mailauth%&
24426 ACL is run.
24427
24428
24429
24430 .section "Authentication on an Exim server" "SECTauthexiser"
24431 .cindex "authentication" "on an Exim server"
24432 When Exim receives an EHLO command, it advertises the public names of those
24433 authenticators that are configured as servers, subject to the following
24434 conditions:
24435
24436 .ilist
24437 The client host must match &%auth_advertise_hosts%& (default *).
24438 .next
24439 It the &%server_advertise_condition%& option is set, its expansion must not
24440 yield the empty string, &"0"&, &"no"&, or &"false"&.
24441 .endlist
24442
24443 The order in which the authenticators are defined controls the order in which
24444 the mechanisms are advertised.
24445
24446 Some mail clients (for example, some versions of Netscape) require the user to
24447 provide a name and password for authentication whenever AUTH is advertised,
24448 even though authentication may not in fact be needed (for example, Exim may be
24449 set up to allow unconditional relaying from the client by an IP address check).
24450 You can make such clients more friendly by not advertising AUTH to them.
24451 For example, if clients on the 10.9.8.0/24 network are permitted (by the ACL
24452 that runs for RCPT) to relay without authentication, you should set
24453 .code
24454 auth_advertise_hosts = ! 10.9.8.0/24
24455 .endd
24456 so that no authentication mechanisms are advertised to them.
24457
24458 The &%server_advertise_condition%& controls the advertisement of individual
24459 authentication mechanisms. For example, it can be used to restrict the
24460 advertisement of a particular mechanism to encrypted connections, by a setting
24461 such as:
24462 .code
24463 server_advertise_condition = ${if eq{$tls_in_cipher}{}{no}{yes}}
24464 .endd
24465 .vindex "&$tls_in_cipher$&"
24466 If the session is encrypted, &$tls_in_cipher$& is not empty, and so the expansion
24467 yields &"yes"&, which allows the advertisement to happen.
24468
24469 When an Exim server receives an AUTH command from a client, it rejects it
24470 immediately if AUTH was not advertised in response to an earlier EHLO
24471 command. This is the case if
24472
24473 .ilist
24474 The client host does not match &%auth_advertise_hosts%&; or
24475 .next
24476 No authenticators are configured with server options; or
24477 .next
24478 Expansion of &%server_advertise_condition%& blocked the advertising of all the
24479 server authenticators.
24480 .endlist
24481
24482
24483 Otherwise, Exim runs the ACL specified by &%acl_smtp_auth%& in order
24484 to decide whether to accept the command. If &%acl_smtp_auth%& is not set,
24485 AUTH is accepted from any client host.
24486
24487 If AUTH is not rejected by the ACL, Exim searches its configuration for a
24488 server authentication mechanism that was advertised in response to EHLO and
24489 that matches the one named in the AUTH command. If it finds one, it runs
24490 the appropriate authentication protocol, and authentication either succeeds or
24491 fails. If there is no matching advertised mechanism, the AUTH command is
24492 rejected with a 504 error.
24493
24494 .vindex "&$received_protocol$&"
24495 .vindex "&$sender_host_authenticated$&"
24496 When a message is received from an authenticated host, the value of
24497 &$received_protocol$& is set to &"esmtpa"& or &"esmtpsa"& instead of &"esmtp"&
24498 or &"esmtps"&, and &$sender_host_authenticated$& contains the name (not the
24499 public name) of the authenticator driver that successfully authenticated the
24500 client from which the message was received. This variable is empty if there was
24501 no successful authentication.
24502
24503
24504
24505
24506 .section "Testing server authentication" "SECID169"
24507 .cindex "authentication" "testing a server"
24508 .cindex "AUTH" "testing a server"
24509 .cindex "base64 encoding" "creating authentication test data"
24510 Exim's &%-bh%& option can be useful for testing server authentication
24511 configurations. The data for the AUTH command has to be sent using base64
24512 encoding. A quick way to produce such data for testing is the following Perl
24513 script:
24514 .code
24515 use MIME::Base64;
24516 printf ("%s", encode_base64(eval "\"$ARGV[0]\""));
24517 .endd
24518 .cindex "binary zero" "in authentication data"
24519 This interprets its argument as a Perl string, and then encodes it. The
24520 interpretation as a Perl string allows binary zeros, which are required for
24521 some kinds of authentication, to be included in the data. For example, a
24522 command line to run this script on such data might be
24523 .code
24524 encode '\0user\0password'
24525 .endd
24526 Note the use of single quotes to prevent the shell interpreting the
24527 backslashes, so that they can be interpreted by Perl to specify characters
24528 whose code value is zero.
24529
24530 &*Warning 1*&: If either of the user or password strings starts with an octal
24531 digit, you must use three zeros instead of one after the leading backslash. If
24532 you do not, the octal digit that starts your string will be incorrectly
24533 interpreted as part of the code for the first character.
24534
24535 &*Warning 2*&: If there are characters in the strings that Perl interprets
24536 specially, you must use a Perl escape to prevent them being misinterpreted. For
24537 example, a command such as
24538 .code
24539 encode '\0user@domain.com\0pas$$word'
24540 .endd
24541 gives an incorrect answer because of the unescaped &"@"& and &"$"& characters.
24542
24543 If you have the &%mimencode%& command installed, another way to do produce
24544 base64-encoded strings is to run the command
24545 .code
24546 echo -e -n `\0user\0password' | mimencode
24547 .endd
24548 The &%-e%& option of &%echo%& enables the interpretation of backslash escapes
24549 in the argument, and the &%-n%& option specifies no newline at the end of its
24550 output. However, not all versions of &%echo%& recognize these options, so you
24551 should check your version before relying on this suggestion.
24552
24553
24554
24555 .section "Authentication by an Exim client" "SECID170"
24556 .cindex "authentication" "on an Exim client"
24557 The &(smtp)& transport has two options called &%hosts_require_auth%& and
24558 &%hosts_try_auth%&. When the &(smtp)& transport connects to a server that
24559 announces support for authentication, and the host matches an entry in either
24560 of these options, Exim (as a client) tries to authenticate as follows:
24561
24562 .ilist
24563 For each authenticator that is configured as a client, in the order in which
24564 they are defined in the configuration, it searches the authentication
24565 mechanisms announced by the server for one whose name matches the public name
24566 of the authenticator.
24567 .next
24568 .vindex "&$host$&"
24569 .vindex "&$host_address$&"
24570 When it finds one that matches, it runs the authenticator's client code. The
24571 variables &$host$& and &$host_address$& are available for any string expansions
24572 that the client might do. They are set to the server's name and IP address. If
24573 any expansion is forced to fail, the authentication attempt is abandoned, and
24574 Exim moves on to the next authenticator. Otherwise an expansion failure causes
24575 delivery to be deferred.
24576 .next
24577 If the result of the authentication attempt is a temporary error or a timeout,
24578 Exim abandons trying to send the message to the host for the moment. It will
24579 try again later. If there are any backup hosts available, they are tried in the
24580 usual way.
24581 .next
24582 If the response to authentication is a permanent error (5&'xx'& code), Exim
24583 carries on searching the list of authenticators and tries another one if
24584 possible. If all authentication attempts give permanent errors, or if there are
24585 no attempts because no mechanisms match (or option expansions force failure),
24586 what happens depends on whether the host matches &%hosts_require_auth%& or
24587 &%hosts_try_auth%&. In the first case, a temporary error is generated, and
24588 delivery is deferred. The error can be detected in the retry rules, and thereby
24589 turned into a permanent error if you wish. In the second case, Exim tries to
24590 deliver the message unauthenticated.
24591 .endlist
24592
24593 .cindex "AUTH" "on MAIL command"
24594 When Exim has authenticated itself to a remote server, it adds the AUTH
24595 parameter to the MAIL commands it sends, if it has an authenticated sender for
24596 the message. If the message came from a remote host, the authenticated sender
24597 is the one that was receiving on an incoming MAIL command, provided that the
24598 incoming connection was authenticated and the &%server_mail_auth%& condition
24599 allowed the authenticated sender to be retained. If a local process calls Exim
24600 to send a message, the sender address that is built from the login name and
24601 &%qualify_domain%& is treated as authenticated. However, if the
24602 &%authenticated_sender%& option is set on the &(smtp)& transport, it overrides
24603 the authenticated sender that was received with the message.
24604 .ecindex IIDauthconf1
24605 .ecindex IIDauthconf2
24606
24607
24608
24609
24610
24611
24612 . ////////////////////////////////////////////////////////////////////////////
24613 . ////////////////////////////////////////////////////////////////////////////
24614
24615 .chapter "The plaintext authenticator" "CHAPplaintext"
24616 .scindex IIDplaiauth1 "&(plaintext)& authenticator"
24617 .scindex IIDplaiauth2 "authenticators" "&(plaintext)&"
24618 The &(plaintext)& authenticator can be configured to support the PLAIN and
24619 LOGIN authentication mechanisms, both of which transfer authentication data as
24620 plain (unencrypted) text (though base64 encoded). The use of plain text is a
24621 security risk; you are strongly advised to insist on the use of SMTP encryption
24622 (see chapter &<<CHAPTLS>>&) if you use the PLAIN or LOGIN mechanisms. If you do
24623 use unencrypted plain text, you should not use the same passwords for SMTP
24624 connections as you do for login accounts.
24625
24626 .section "Plaintext options" "SECID171"
24627 .cindex "options" "&(plaintext)& authenticator (server)"
24628 When configured as a server, &(plaintext)& uses the following options:
24629
24630 .option server_condition authenticators string&!! unset
24631 This is actually a global authentication option, but it must be set in order to
24632 configure the &(plaintext)& driver as a server. Its use is described below.
24633
24634 .option server_prompts plaintext string&!! unset
24635 The contents of this option, after expansion, must be a colon-separated list of
24636 prompt strings. If expansion fails, a temporary authentication rejection is
24637 given.
24638
24639 .section "Using plaintext in a server" "SECTplainserver"
24640 .cindex "AUTH" "in &(plaintext)& authenticator"
24641 .cindex "binary zero" "in &(plaintext)& authenticator"
24642 .cindex "numerical variables (&$1$& &$2$& etc)" &&&
24643         "in &(plaintext)& authenticator"
24644 .vindex "&$auth1$&, &$auth2$&, etc"
24645 .cindex "base64 encoding" "in &(plaintext)& authenticator"
24646
24647 When running as a server, &(plaintext)& performs the authentication test by
24648 expanding a string. The data sent by the client with the AUTH command, or in
24649 response to subsequent prompts, is base64 encoded, and so may contain any byte
24650 values when decoded. If any data is supplied with the command, it is treated as
24651 a list of strings, separated by NULs (binary zeros), the first three of which
24652 are placed in the expansion variables &$auth1$&, &$auth2$&, and &$auth3$&
24653 (neither LOGIN nor PLAIN uses more than three strings).
24654
24655 For compatibility with previous releases of Exim, the values are also placed in
24656 the expansion variables &$1$&, &$2$&, and &$3$&. However, the use of these
24657 variables for this purpose is now deprecated, as it can lead to confusion in
24658 string expansions that also use them for other things.
24659
24660 If there are more strings in &%server_prompts%& than the number of strings
24661 supplied with the AUTH command, the remaining prompts are used to obtain more
24662 data. Each response from the client may be a list of NUL-separated strings.
24663
24664 .vindex "&$authenticated_id$&"
24665 Once a sufficient number of data strings have been received,
24666 &%server_condition%& is expanded. If the expansion is forced to fail,
24667 authentication fails. Any other expansion failure causes a temporary error code
24668 to be returned. If the result of a successful expansion is an empty string,
24669 &"0"&, &"no"&, or &"false"&, authentication fails. If the result of the
24670 expansion is &"1"&, &"yes"&, or &"true"&, authentication succeeds and the
24671 generic &%server_set_id%& option is expanded and saved in &$authenticated_id$&.
24672 For any other result, a temporary error code is returned, with the expanded
24673 string as the error text
24674 .new ", and the failed id saved in &$authenticated_fail_id$&."
24675
24676 &*Warning*&: If you use a lookup in the expansion to find the user's
24677 password, be sure to make the authentication fail if the user is unknown.
24678 There are good and bad examples at the end of the next section.
24679
24680
24681
24682 .section "The PLAIN authentication mechanism" "SECID172"
24683 .cindex "PLAIN authentication mechanism"
24684 .cindex "authentication" "PLAIN mechanism"
24685 .cindex "binary zero" "in &(plaintext)& authenticator"
24686 The PLAIN authentication mechanism (RFC 2595) specifies that three strings be
24687 sent as one item of data (that is, one combined string containing two NUL
24688 separators). The data is sent either as part of the AUTH command, or
24689 subsequently in response to an empty prompt from the server.
24690
24691 The second and third strings are a user name and a corresponding password.
24692 Using a single fixed user name and password as an example, this could be
24693 configured as follows:
24694 .code
24695 fixed_plain:
24696   driver = plaintext
24697   public_name = PLAIN
24698   server_prompts = :
24699   server_condition = \
24700     ${if and {{eq{$auth2}{username}}{eq{$auth3}{mysecret}}}}
24701   server_set_id = $auth2
24702 .endd
24703 Note that the default result strings from &%if%& (&"true"& or an empty string)
24704 are exactly what we want here, so they need not be specified. Obviously, if the
24705 password contains expansion-significant characters such as dollar, backslash,
24706 or closing brace, they have to be escaped.
24707
24708 The &%server_prompts%& setting specifies a single, empty prompt (empty items at
24709 the end of a string list are ignored). If all the data comes as part of the
24710 AUTH command, as is commonly the case, the prompt is not used. This
24711 authenticator is advertised in the response to EHLO as
24712 .code
24713 250-AUTH PLAIN
24714 .endd
24715 and a client host can authenticate itself by sending the command
24716 .code
24717 AUTH PLAIN AHVzZXJuYW1lAG15c2VjcmV0
24718 .endd
24719 As this contains three strings (more than the number of prompts), no further
24720 data is required from the client. Alternatively, the client may just send
24721 .code
24722 AUTH PLAIN
24723 .endd
24724 to initiate authentication, in which case the server replies with an empty
24725 prompt. The client must respond with the combined data string.
24726
24727 The data string is base64 encoded, as required by the RFC. This example,
24728 when decoded, is <&'NUL'&>&`username`&<&'NUL'&>&`mysecret`&, where <&'NUL'&>
24729 represents a zero byte. This is split up into three strings, the first of which
24730 is empty. The &%server_condition%& option in the authenticator checks that the
24731 second two are &`username`& and &`mysecret`& respectively.
24732
24733 Having just one fixed user name and password, as in this example, is not very
24734 realistic, though for a small organization with only a handful of
24735 authenticating clients it could make sense.
24736
24737 A more sophisticated instance of this authenticator could use the user name in
24738 &$auth2$& to look up a password in a file or database, and maybe do an encrypted
24739 comparison (see &%crypteq%& in chapter &<<CHAPexpand>>&). Here is a example of
24740 this approach, where the passwords are looked up in a DBM file. &*Warning*&:
24741 This is an incorrect example:
24742 .code
24743 server_condition = \
24744   ${if eq{$auth3}{${lookup{$auth2}dbm{/etc/authpwd}}}}
24745 .endd
24746 The expansion uses the user name (&$auth2$&) as the key to look up a password,
24747 which it then compares to the supplied password (&$auth3$&). Why is this example
24748 incorrect? It works fine for existing users, but consider what happens if a
24749 non-existent user name is given. The lookup fails, but as no success/failure
24750 strings are given for the lookup, it yields an empty string. Thus, to defeat
24751 the authentication, all a client has to do is to supply a non-existent user
24752 name and an empty password. The correct way of writing this test is:
24753 .code
24754 server_condition = ${lookup{$auth2}dbm{/etc/authpwd}\
24755   {${if eq{$value}{$auth3}}} {false}}
24756 .endd
24757 In this case, if the lookup succeeds, the result is checked; if the lookup
24758 fails, &"false"& is returned and authentication fails. If &%crypteq%& is being
24759 used instead of &%eq%&, the first example is in fact safe, because &%crypteq%&
24760 always fails if its second argument is empty. However, the second way of
24761 writing the test makes the logic clearer.
24762
24763
24764 .section "The LOGIN authentication mechanism" "SECID173"
24765 .cindex "LOGIN authentication mechanism"
24766 .cindex "authentication" "LOGIN mechanism"
24767 The LOGIN authentication mechanism is not documented in any RFC, but is in use
24768 in a number of programs. No data is sent with the AUTH command. Instead, a
24769 user name and password are supplied separately, in response to prompts. The
24770 plaintext authenticator can be configured to support this as in this example:
24771 .code
24772 fixed_login:
24773   driver = plaintext
24774   public_name = LOGIN
24775   server_prompts = User Name : Password
24776   server_condition = \
24777     ${if and {{eq{$auth1}{username}}{eq{$auth2}{mysecret}}}}
24778   server_set_id = $auth1
24779 .endd
24780 Because of the way plaintext operates, this authenticator accepts data supplied
24781 with the AUTH command (in contravention of the specification of LOGIN), but
24782 if the client does not supply it (as is the case for LOGIN clients), the prompt
24783 strings are used to obtain two data items.
24784
24785 Some clients are very particular about the precise text of the prompts. For
24786 example, Outlook Express is reported to recognize only &"Username:"& and
24787 &"Password:"&. Here is an example of a LOGIN authenticator that uses those
24788 strings. It uses the &%ldapauth%& expansion condition to check the user
24789 name and password by binding to an LDAP server:
24790 .code
24791 login:
24792   driver = plaintext
24793   public_name = LOGIN
24794   server_prompts = Username:: : Password::
24795   server_condition = ${if and{{ \
24796     !eq{}{$auth1} }{ \
24797     ldapauth{\
24798       user="uid=${quote_ldap_dn:$auth1},ou=people,o=example.org" \
24799       pass=${quote:$auth2} \
24800       ldap://ldap.example.org/} }} }
24801   server_set_id = uid=$auth1,ou=people,o=example.org
24802 .endd
24803 We have to check that the username is not empty before using it, because LDAP
24804 does not permit empty DN components. We must also use the &%quote_ldap_dn%&
24805 operator to correctly quote the DN for authentication. However, the basic
24806 &%quote%& operator, rather than any of the LDAP quoting operators, is the
24807 correct one to use for the password, because quoting is needed only to make
24808 the password conform to the Exim syntax. At the LDAP level, the password is an
24809 uninterpreted string.
24810
24811
24812 .section "Support for different kinds of authentication" "SECID174"
24813 A number of string expansion features are provided for the purpose of
24814 interfacing to different ways of user authentication. These include checking
24815 traditionally encrypted passwords from &_/etc/passwd_& (or equivalent), PAM,
24816 Radius, &%ldapauth%&, &'pwcheck'&, and &'saslauthd'&. For details see section
24817 &<<SECTexpcond>>&.
24818
24819
24820
24821
24822 .section "Using plaintext in a client" "SECID175"
24823 .cindex "options" "&(plaintext)& authenticator (client)"
24824 The &(plaintext)& authenticator has two client options:
24825
24826 .option client_ignore_invalid_base64 plaintext boolean false
24827 If the client receives a server prompt that is not a valid base64 string,
24828 authentication is abandoned by default. However, if this option is set true,
24829 the error in the challenge is ignored and the client sends the response as
24830 usual.
24831
24832 .option client_send plaintext string&!! unset
24833 The string is a colon-separated list of authentication data strings. Each
24834 string is independently expanded before being sent to the server. The first
24835 string is sent with the AUTH command; any more strings are sent in response
24836 to prompts from the server. Before each string is expanded, the value of the
24837 most recent prompt is placed in the next &$auth$&<&'n'&> variable, starting
24838 with &$auth1$& for the first prompt. Up to three prompts are stored in this
24839 way. Thus, the prompt that is received in response to sending the first string
24840 (with the AUTH command) can be used in the expansion of the second string, and
24841 so on. If an invalid base64 string is received when
24842 &%client_ignore_invalid_base64%& is set, an empty string is put in the
24843 &$auth$&<&'n'&> variable.
24844
24845 &*Note*&: You cannot use expansion to create multiple strings, because
24846 splitting takes priority and happens first.
24847
24848 Because the PLAIN authentication mechanism requires NUL (binary zero) bytes in
24849 the data, further processing is applied to each string before it is sent. If
24850 there are any single circumflex characters in the string, they are converted to
24851 NULs. Should an actual circumflex be required as data, it must be doubled in
24852 the string.
24853
24854 This is an example of a client configuration that implements the PLAIN
24855 authentication mechanism with a fixed user name and password:
24856 .code
24857 fixed_plain:
24858   driver = plaintext
24859   public_name = PLAIN
24860   client_send = ^username^mysecret
24861 .endd
24862 The lack of colons means that the entire text is sent with the AUTH
24863 command, with the circumflex characters converted to NULs. A similar example
24864 that uses the LOGIN mechanism is:
24865 .code
24866 fixed_login:
24867   driver = plaintext
24868   public_name = LOGIN
24869   client_send = : username : mysecret
24870 .endd
24871 The initial colon means that the first string is empty, so no data is sent with
24872 the AUTH command itself. The remaining strings are sent in response to
24873 prompts.
24874 .ecindex IIDplaiauth1
24875 .ecindex IIDplaiauth2
24876
24877
24878
24879
24880 . ////////////////////////////////////////////////////////////////////////////
24881 . ////////////////////////////////////////////////////////////////////////////
24882
24883 .chapter "The cram_md5 authenticator" "CHID9"
24884 .scindex IIDcramauth1 "&(cram_md5)& authenticator"
24885 .scindex IIDcramauth2 "authenticators" "&(cram_md5)&"
24886 .cindex "CRAM-MD5 authentication mechanism"
24887 .cindex "authentication" "CRAM-MD5 mechanism"
24888 The CRAM-MD5 authentication mechanism is described in RFC 2195. The server
24889 sends a challenge string to the client, and the response consists of a user
24890 name and the CRAM-MD5 digest of the challenge string combined with a secret
24891 string (password) which is known to both server and client. Thus, the secret
24892 is not sent over the network as plain text, which makes this authenticator more
24893 secure than &(plaintext)&. However, the downside is that the secret has to be
24894 available in plain text at either end.
24895
24896
24897 .section "Using cram_md5 as a server" "SECID176"
24898 .cindex "options" "&(cram_md5)& authenticator (server)"
24899 This authenticator has one server option, which must be set to configure the
24900 authenticator as a server:
24901
24902 .option server_secret cram_md5 string&!! unset
24903 .cindex "numerical variables (&$1$& &$2$& etc)" "in &(cram_md5)& authenticator"
24904 When the server receives the client's response, the user name is placed in
24905 the expansion variable &$auth1$&, and &%server_secret%& is expanded to
24906 obtain the password for that user. The server then computes the CRAM-MD5 digest
24907 that the client should have sent, and checks that it received the correct
24908 string. If the expansion of &%server_secret%& is forced to fail, authentication
24909 fails. If the expansion fails for some other reason, a temporary error code is
24910 returned to the client.
24911
24912 For compatibility with previous releases of Exim, the user name is also placed
24913 in &$1$&. However, the use of this variables for this purpose is now
24914 deprecated, as it can lead to confusion in string expansions that also use
24915 numeric variables for other things.
24916
24917 For example, the following authenticator checks that the user name given by the
24918 client is &"ph10"&, and if so, uses &"secret"& as the password. For any other
24919 user name, authentication fails.
24920 .code
24921 fixed_cram:
24922   driver = cram_md5
24923   public_name = CRAM-MD5
24924   server_secret = ${if eq{$auth1}{ph10}{secret}fail}
24925   server_set_id = $auth1
24926 .endd
24927 .vindex "&$authenticated_id$&"
24928 If authentication succeeds, the setting of &%server_set_id%& preserves the user
24929 name in &$authenticated_id$&. A more typical configuration might look up the
24930 secret string in a file, using the user name as the key. For example:
24931 .code
24932 lookup_cram:
24933   driver = cram_md5
24934   public_name = CRAM-MD5
24935   server_secret = ${lookup{$auth1}lsearch{/etc/authpwd}\
24936                   {$value}fail}
24937   server_set_id = $auth1
24938 .endd
24939 Note that this expansion explicitly forces failure if the lookup fails
24940 because &$auth1$& contains an unknown user name.
24941
24942 As another example, if you wish to re-use a Cyrus SASL sasldb2 file without
24943 using the relevant libraries, you need to know the realm to specify in the
24944 lookup and then ask for the &"userPassword"& attribute for that user in that
24945 realm, with:
24946 .code
24947 cyrusless_crammd5:
24948   driver = cram_md5
24949   public_name = CRAM-MD5
24950   server_secret = ${lookup{$auth1:mail.example.org:userPassword}\
24951                   dbmjz{/etc/sasldb2}}
24952   server_set_id = $auth1
24953 .endd
24954
24955 .section "Using cram_md5 as a client" "SECID177"
24956 .cindex "options" "&(cram_md5)& authenticator (client)"
24957 When used as a client, the &(cram_md5)& authenticator has two options:
24958
24959
24960
24961 .option client_name cram_md5 string&!! "the primary host name"
24962 This string is expanded, and the result used as the user name data when
24963 computing the response to the server's challenge.
24964
24965
24966 .option client_secret cram_md5 string&!! unset
24967 This option must be set for the authenticator to work as a client. Its value is
24968 expanded and the result used as the secret string when computing the response.
24969
24970
24971 .vindex "&$host$&"
24972 .vindex "&$host_address$&"
24973 Different user names and secrets can be used for different servers by referring
24974 to &$host$& or &$host_address$& in the options. Forced failure of either
24975 expansion string is treated as an indication that this authenticator is not
24976 prepared to handle this case. Exim moves on to the next configured client
24977 authenticator. Any other expansion failure causes Exim to give up trying to
24978 send the message to the current server.
24979
24980 A simple example configuration of a &(cram_md5)& authenticator, using fixed
24981 strings, is:
24982 .code
24983 fixed_cram:
24984   driver = cram_md5
24985   public_name = CRAM-MD5
24986   client_name = ph10
24987   client_secret = secret
24988 .endd
24989 .ecindex IIDcramauth1
24990 .ecindex IIDcramauth2
24991
24992
24993
24994 . ////////////////////////////////////////////////////////////////////////////
24995 . ////////////////////////////////////////////////////////////////////////////
24996
24997 .chapter "The cyrus_sasl authenticator" "CHID10"
24998 .scindex IIDcyrauth1 "&(cyrus_sasl)& authenticator"
24999 .scindex IIDcyrauth2 "authenticators" "&(cyrus_sasl)&"
25000 .cindex "Cyrus" "SASL library"
25001 .cindex "Kerberos"
25002 The code for this authenticator was provided by Matthew Byng-Maddick of A L
25003 Digital Ltd (&url(http://www.aldigital.co.uk)).
25004
25005 The &(cyrus_sasl)& authenticator provides server support for the Cyrus SASL
25006 library implementation of the RFC 2222 (&"Simple Authentication and Security
25007 Layer"&). This library supports a number of authentication mechanisms,
25008 including PLAIN and LOGIN, but also several others that Exim does not support
25009 directly. In particular, there is support for Kerberos authentication.
25010
25011 The &(cyrus_sasl)& authenticator provides a gatewaying mechanism directly to
25012 the Cyrus interface, so if your Cyrus library can do, for example, CRAM-MD5,
25013 then so can the &(cyrus_sasl)& authenticator. By default it uses the public
25014 name of the driver to determine which mechanism to support.
25015
25016 Where access to some kind of secret file is required, for example in GSSAPI
25017 or CRAM-MD5, it is worth noting that the authenticator runs as the Exim
25018 user, and that the Cyrus SASL library has no way of escalating privileges
25019 by default. You may also find you need to set environment variables,
25020 depending on the driver you are using.
25021
25022 The application name provided by Exim is &"exim"&, so various SASL options may
25023 be set in &_exim.conf_& in your SASL directory. If you are using GSSAPI for
25024 Kerberos, note that because of limitations in the GSSAPI interface,
25025 changing the server keytab might need to be communicated down to the Kerberos
25026 layer independently. The mechanism for doing so is dependent upon the Kerberos
25027 implementation.
25028
25029 For example, for older releases of Heimdal, the environment variable KRB5_KTNAME
25030 may be set to point to an alternative keytab file. Exim will pass this
25031 variable through from its own inherited environment when started as root or the
25032 Exim user. The keytab file needs to be readable by the Exim user.
25033 With newer releases of Heimdal, a setuid Exim may cause Heimdal to discard the
25034 environment variable.  In practice, for those releases, the Cyrus authenticator
25035 is not a suitable interface for GSSAPI (Kerberos) support.  Instead, consider
25036 the &(heimdal_gssapi)& authenticator, described in chapter &<<CHAPheimdalgss>>&
25037
25038
25039 .section "Using cyrus_sasl as a server" "SECID178"
25040 The &(cyrus_sasl)& authenticator has four private options. It puts the username
25041 (on a successful authentication) into &$auth1$&. For compatibility with
25042 previous releases of Exim, the username is also placed in &$1$&. However, the
25043 use of this variable for this purpose is now deprecated, as it can lead to
25044 confusion in string expansions that also use numeric variables for other
25045 things.
25046
25047
25048 .option server_hostname cyrus_sasl string&!! "see below"
25049 This option selects the hostname that is used when communicating with the
25050 library. The default value is &`$primary_hostname`&. It is up to the underlying
25051 SASL plug-in what it does with this data.
25052
25053
25054 .option server_mech cyrus_sasl string "see below"
25055 This option selects the authentication mechanism this driver should use. The
25056 default is the value of the generic &%public_name%& option. This option allows
25057 you to use a different underlying mechanism from the advertised name. For
25058 example:
25059 .code
25060 sasl:
25061   driver = cyrus_sasl
25062   public_name = X-ANYTHING
25063   server_mech = CRAM-MD5
25064   server_set_id = $auth1
25065 .endd
25066
25067 .option server_realm cyrus_sasl string&!! unset
25068 This specifies the SASL realm that the server claims to be in.
25069
25070
25071 .option server_service cyrus_sasl string &`smtp`&
25072 This is the SASL service that the server claims to implement.
25073
25074
25075 For straightforward cases, you do not need to set any of the authenticator's
25076 private options. All you need to do is to specify an appropriate mechanism as
25077 the public name. Thus, if you have a SASL library that supports CRAM-MD5 and
25078 PLAIN, you could have two authenticators as follows:
25079 .code
25080 sasl_cram_md5:
25081   driver = cyrus_sasl
25082   public_name = CRAM-MD5
25083   server_set_id = $auth1
25084
25085 sasl_plain:
25086   driver = cyrus_sasl
25087   public_name = PLAIN
25088   server_set_id = $auth2
25089 .endd
25090 Cyrus SASL does implement the LOGIN authentication method, even though it is
25091 not a standard method. It is disabled by default in the source distribution,
25092 but it is present in many binary distributions.
25093 .ecindex IIDcyrauth1
25094 .ecindex IIDcyrauth2
25095
25096
25097
25098
25099 . ////////////////////////////////////////////////////////////////////////////
25100 . ////////////////////////////////////////////////////////////////////////////
25101 .chapter "The dovecot authenticator" "CHAPdovecot"
25102 .scindex IIDdcotauth1 "&(dovecot)& authenticator"
25103 .scindex IIDdcotauth2 "authenticators" "&(dovecot)&"
25104 This authenticator is an interface to the authentication facility of the
25105 Dovecot POP/IMAP server, which can support a number of authentication methods.
25106 If you are using Dovecot to authenticate POP/IMAP clients, it might be helpful
25107 to use the same mechanisms for SMTP authentication. This is a server
25108 authenticator only. There is only one option:
25109
25110 .option server_socket dovecot string unset
25111
25112 This option must specify the socket that is the interface to Dovecot
25113 authentication. The &%public_name%& option must specify an authentication
25114 mechanism that Dovecot is configured to support. You can have several
25115 authenticators for different mechanisms. For example:
25116 .code
25117 dovecot_plain:
25118   driver = dovecot
25119   public_name = PLAIN
25120   server_socket = /var/run/dovecot/auth-client
25121   server_set_id = $auth2
25122
25123 dovecot_ntlm:
25124   driver = dovecot
25125   public_name = NTLM
25126   server_socket = /var/run/dovecot/auth-client
25127   server_set_id = $auth1
25128 .endd
25129 If the SMTP connection is encrypted, or if &$sender_host_address$& is equal to
25130 &$received_ip_address$& (that is, the connection is local), the &"secured"&
25131 option is passed in the Dovecot authentication command. If, for a TLS
25132 connection, a client certificate has been verified, the &"valid-client-cert"&
25133 option is passed. When authentication succeeds, the identity of the user
25134 who authenticated is placed in &$auth1$&.
25135 .ecindex IIDdcotauth1
25136 .ecindex IIDdcotauth2
25137
25138
25139 . ////////////////////////////////////////////////////////////////////////////
25140 . ////////////////////////////////////////////////////////////////////////////
25141 .chapter "The gsasl authenticator" "CHAPgsasl"
25142 .scindex IIDgsaslauth1 "&(gsasl)& authenticator"
25143 .scindex IIDgsaslauth2 "authenticators" "&(gsasl)&"
25144 .cindex "authentication" "GNU SASL"
25145 .cindex "authentication" "SASL"
25146 .cindex "authentication" "EXTERNAL"
25147 .cindex "authentication" "ANONYMOUS"
25148 .cindex "authentication" "PLAIN"
25149 .cindex "authentication" "LOGIN"
25150 .cindex "authentication" "DIGEST-MD5"
25151 .cindex "authentication" "CRAM-MD5"
25152 .cindex "authentication" "SCRAM-SHA-1"
25153 The &(gsasl)& authenticator provides server integration for the GNU SASL
25154 library and the mechanisms it provides.  This is new as of the 4.80 release
25155 and there are a few areas where the library does not let Exim smoothly
25156 scale to handle future authentication mechanisms, so no guarantee can be
25157 made that any particular new authentication mechanism will be supported
25158 without code changes in Exim.
25159
25160
25161 .option server_channelbinding gsasl boolean false
25162 Some authentication mechanisms are able to use external context at both ends
25163 of the session to bind the authentication to that context, and fail the
25164 authentication process if that context differs.  Specifically, some TLS
25165 ciphersuites can provide identifying information about the cryptographic
25166 context.
25167
25168 This means that certificate identity and verification becomes a non-issue,
25169 as a man-in-the-middle attack will cause the correct client and server to
25170 see different identifiers and authentication will fail.
25171
25172 This is currently only supported when using the GnuTLS library.  This is
25173 only usable by mechanisms which support "channel binding"; at time of
25174 writing, that's the SCRAM family.
25175
25176 This defaults off to ensure smooth upgrade across Exim releases, in case
25177 this option causes some clients to start failing.  Some future release
25178 of Exim may switch the default to be true.
25179
25180
25181 .option server_hostname gsasl string&!! "see below"
25182 This option selects the hostname that is used when communicating with the
25183 library. The default value is &`$primary_hostname`&.
25184 Some mechanisms will use this data.
25185
25186
25187 .option server_mech gsasl string "see below"
25188 This option selects the authentication mechanism this driver should use. The
25189 default is the value of the generic &%public_name%& option. This option allows
25190 you to use a different underlying mechanism from the advertised name. For
25191 example:
25192 .code
25193 sasl:
25194   driver = gsasl
25195   public_name = X-ANYTHING
25196   server_mech = CRAM-MD5
25197   server_set_id = $auth1
25198 .endd
25199
25200
25201 .option server_password gsasl string&!! unset
25202 Various mechanisms need access to the cleartext password on the server, so
25203 that proof-of-possession can be demonstrated on the wire, without sending
25204 the password itself.
25205
25206 The data available for lookup varies per mechanism.
25207 In all cases, &$auth1$& is set to the &'authentication id'&.
25208 The &$auth2$& variable will always be the &'authorization id'& (&'authz'&)
25209 if available, else the empty string.
25210 The &$auth3$& variable will always be the &'realm'& if available,
25211 else the empty string.
25212
25213 A forced failure will cause authentication to defer.
25214
25215 If using this option, it may make sense to set the &%server_condition%&
25216 option to be simply "true".
25217
25218
25219 .option server_realm gsasl string&!! unset
25220 This specifies the SASL realm that the server claims to be in.
25221 Some mechanisms will use this data.
25222
25223
25224 .option server_scram_iter gsasl string&!! unset
25225 This option provides data for the SCRAM family of mechanisms.
25226 &$auth1$& is not available at evaluation time.
25227 (This may change, as we receive feedback on use)
25228
25229
25230 .option server_scram_salt gsasl string&!! unset
25231 This option provides data for the SCRAM family of mechanisms.
25232 &$auth1$& is not available at evaluation time.
25233 (This may change, as we receive feedback on use)
25234
25235
25236 .option server_service gsasl string &`smtp`&
25237 This is the SASL service that the server claims to implement.
25238 Some mechanisms will use this data.
25239
25240
25241 .section "&(gsasl)& auth variables" "SECTgsaslauthvar"
25242 .vindex "&$auth1$&, &$auth2$&, etc"
25243 These may be set when evaluating specific options, as detailed above.
25244 They will also be set when evaluating &%server_condition%&.
25245
25246 Unless otherwise stated below, the &(gsasl)& integration will use the following
25247 meanings for these variables:
25248
25249 .ilist
25250 .vindex "&$auth1$&"
25251 &$auth1$&: the &'authentication id'&
25252 .next
25253 .vindex "&$auth2$&"
25254 &$auth2$&: the &'authorization id'&
25255 .next
25256 .vindex "&$auth3$&"
25257 &$auth3$&: the &'realm'&
25258 .endlist
25259
25260 On a per-mechanism basis:
25261
25262 .ilist
25263 .cindex "authentication" "EXTERNAL"
25264 EXTERNAL: only &$auth1$& is set, to the possibly empty &'authorization id'&;
25265 the &%server_condition%& option must be present.
25266 .next
25267 .cindex "authentication" "ANONYMOUS"
25268 ANONYMOUS: only &$auth1$& is set, to the possibly empty &'anonymous token'&;
25269 the &%server_condition%& option must be present.
25270 .next
25271 .cindex "authentication" "GSSAPI"
25272 GSSAPI: &$auth1$& will be set to the &'GSSAPI Display Name'&;
25273 &$auth2$& will be set to the &'authorization id'&,
25274 the &%server_condition%& option must be present.
25275 .endlist
25276
25277 An &'anonymous token'& is something passed along as an unauthenticated
25278 identifier; this is analogous to FTP anonymous authentication passing an
25279 email address, or software-identifier@, as the "password".
25280
25281
25282 An example showing the password having the realm specified in the callback
25283 and demonstrating a Cyrus SASL to GSASL migration approach is:
25284 .code
25285 gsasl_cyrusless_crammd5:
25286   driver = gsasl
25287   public_name = CRAM-MD5
25288   server_realm = imap.example.org
25289   server_password = ${lookup{$auth1:$auth3:userPassword}\
25290                     dbmjz{/etc/sasldb2}{$value}fail}
25291   server_set_id = ${quote:$auth1}
25292   server_condition = yes
25293 .endd
25294
25295
25296 . ////////////////////////////////////////////////////////////////////////////
25297 . ////////////////////////////////////////////////////////////////////////////
25298
25299 .chapter "The heimdal_gssapi authenticator" "CHAPheimdalgss"
25300 .scindex IIDheimdalgssauth1 "&(heimdal_gssapi)& authenticator"
25301 .scindex IIDheimdalgssauth2 "authenticators" "&(heimdal_gssapi)&"
25302 .cindex "authentication" "GSSAPI"
25303 .cindex "authentication" "Kerberos"
25304 The &(heimdal_gssapi)& authenticator provides server integration for the
25305 Heimdal GSSAPI/Kerberos library, permitting Exim to set a keytab pathname
25306 reliably.
25307
25308 .option server_hostname heimdal_gssapi string&!! "see below"
25309 This option selects the hostname that is used, with &%server_service%&,
25310 for constructing the GSS server name, as a &'GSS_C_NT_HOSTBASED_SERVICE'&
25311 identifier.  The default value is &`$primary_hostname`&.
25312
25313 .option server_keytab heimdal_gssapi string&!! unset
25314 If set, then Heimdal will not use the system default keytab (typically
25315 &_/etc/krb5.keytab_&) but instead the pathname given in this option.
25316 The value should be a pathname, with no &"file:"& prefix.
25317
25318 .option server_service heimdal_gssapi string&!! "smtp"
25319 This option specifies the service identifier used, in conjunction with
25320 &%server_hostname%&, for building the identifer for finding credentials
25321 from the keytab.
25322
25323
25324 .section "&(heimdal_gssapi)& auth variables" "SECTheimdalgssauthvar"
25325 Beware that these variables will typically include a realm, thus will appear
25326 to be roughly like an email address already.  The &'authzid'& in &$auth2$& is
25327 not verified, so a malicious client can set it to anything.
25328
25329 The &$auth1$& field should be safely trustable as a value from the Key
25330 Distribution Center.  Note that these are not quite email addresses.
25331 Each identifier is for a role, and so the left-hand-side may include a
25332 role suffix.  For instance, &"joe/admin@EXAMPLE.ORG"&.
25333
25334 .vindex "&$auth1$&, &$auth2$&, etc"
25335 .ilist
25336 .vindex "&$auth1$&"
25337 &$auth1$&: the &'authentication id'&, set to the GSS Display Name.
25338 .next
25339 .vindex "&$auth2$&"
25340 &$auth2$&: the &'authorization id'&, sent within SASL encapsulation after
25341 authentication.  If that was empty, this will also be set to the
25342 GSS Display Name.
25343 .endlist
25344
25345
25346 . ////////////////////////////////////////////////////////////////////////////
25347 . ////////////////////////////////////////////////////////////////////////////
25348
25349 .chapter "The spa authenticator" "CHAPspa"
25350 .scindex IIDspaauth1 "&(spa)& authenticator"
25351 .scindex IIDspaauth2 "authenticators" "&(spa)&"
25352 .cindex "authentication" "Microsoft Secure Password"
25353 .cindex "authentication" "NTLM"
25354 .cindex "Microsoft Secure Password Authentication"
25355 .cindex "NTLM authentication"
25356 The &(spa)& authenticator provides client support for Microsoft's &'Secure
25357 Password Authentication'& mechanism,
25358 which is also sometimes known as NTLM (NT LanMan). The code for client side of
25359 this authenticator was contributed by Marc Prud'hommeaux, and much of it is
25360 taken from the Samba project (&url(http://www.samba.org)). The code for the
25361 server side was subsequently contributed by Tom Kistner. The mechanism works as
25362 follows:
25363
25364 .ilist
25365 After the AUTH command has been accepted, the client sends an SPA
25366 authentication request based on the user name and optional domain.
25367 .next
25368 The server sends back a challenge.
25369 .next
25370 The client builds a challenge response which makes use of the user's password
25371 and sends it to the server, which then accepts or rejects it.
25372 .endlist
25373
25374 Encryption is used to protect the password in transit.
25375
25376
25377
25378 .section "Using spa as a server" "SECID179"
25379 .cindex "options" "&(spa)& authenticator (server)"
25380 The &(spa)& authenticator has just one server option:
25381
25382 .option server_password spa string&!! unset
25383 .cindex "numerical variables (&$1$& &$2$& etc)" "in &(spa)& authenticator"
25384 This option is expanded, and the result must be the cleartext password for the
25385 authenticating user, whose name is at this point in &$auth1$&. For
25386 compatibility with previous releases of Exim, the user name is also placed in
25387 &$1$&. However, the use of this variable for this purpose is now deprecated, as
25388 it can lead to confusion in string expansions that also use numeric variables
25389 for other things. For example:
25390 .code
25391 spa:
25392   driver = spa
25393   public_name = NTLM
25394   server_password = \
25395     ${lookup{$auth1}lsearch{/etc/exim/spa_clearpass}{$value}fail}
25396 .endd
25397 If the expansion is forced to fail, authentication fails. Any other expansion
25398 failure causes a temporary error code to be returned.
25399
25400
25401
25402
25403
25404 .section "Using spa as a client" "SECID180"
25405 .cindex "options" "&(spa)& authenticator (client)"
25406 The &(spa)& authenticator has the following client options:
25407
25408
25409
25410 .option client_domain spa string&!! unset
25411 This option specifies an optional domain for the authentication.
25412
25413
25414 .option client_password spa string&!! unset
25415 This option specifies the user's password, and must be set.
25416
25417
25418 .option client_username spa string&!! unset
25419 This option specifies the user name, and must be set. Here is an example of a
25420 configuration of this authenticator for use with the mail servers at
25421 &'msn.com'&:
25422 .code
25423 msn:
25424   driver = spa
25425   public_name = MSN
25426   client_username = msn/msn_username
25427   client_password = msn_plaintext_password
25428   client_domain = DOMAIN_OR_UNSET
25429 .endd
25430 .ecindex IIDspaauth1
25431 .ecindex IIDspaauth2
25432
25433
25434
25435
25436
25437 . ////////////////////////////////////////////////////////////////////////////
25438 . ////////////////////////////////////////////////////////////////////////////
25439
25440 .chapter "Encrypted SMTP connections using TLS/SSL" "CHAPTLS" &&&
25441          "Encrypted SMTP connections"
25442 .scindex IIDencsmtp1 "encryption" "on SMTP connection"
25443 .scindex IIDencsmtp2 "SMTP" "encryption"
25444 .cindex "TLS" "on SMTP connection"
25445 .cindex "OpenSSL"
25446 .cindex "GnuTLS"
25447 Support for TLS (Transport Layer Security), formerly known as SSL (Secure
25448 Sockets Layer), is implemented by making use of the OpenSSL library or the
25449 GnuTLS library (Exim requires GnuTLS release 1.0 or later). There is no
25450 cryptographic code in the Exim distribution itself for implementing TLS. In
25451 order to use this feature you must install OpenSSL or GnuTLS, and then build a
25452 version of Exim that includes TLS support (see section &<<SECTinctlsssl>>&).
25453 You also need to understand the basic concepts of encryption at a managerial
25454 level, and in particular, the way that public keys, private keys, and
25455 certificates are used.
25456
25457 RFC 3207 defines how SMTP connections can make use of encryption. Once a
25458 connection is established, the client issues a STARTTLS command. If the
25459 server accepts this, the client and the server negotiate an encryption
25460 mechanism. If the negotiation succeeds, the data that subsequently passes
25461 between them is encrypted.
25462
25463 Exim's ACLs can detect whether the current SMTP session is encrypted or not,
25464 and if so, what cipher suite is in use, whether the client supplied a
25465 certificate, and whether or not that certificate was verified. This makes it
25466 possible for an Exim server to deny or accept certain commands based on the
25467 encryption state.
25468
25469 &*Warning*&: Certain types of firewall and certain anti-virus products can
25470 disrupt TLS connections. You need to turn off SMTP scanning for these products
25471 in order to get TLS to work.
25472
25473
25474
25475 .section "Support for the legacy &""ssmtp""& (aka &""smtps""&) protocol" &&&
25476          "SECID284"
25477 .cindex "ssmtp protocol"
25478 .cindex "smtps protocol"
25479 .cindex "SMTP" "ssmtp protocol"
25480 .cindex "SMTP" "smtps protocol"
25481 Early implementations of encrypted SMTP used a different TCP port from normal
25482 SMTP, and expected an encryption negotiation to start immediately, instead of
25483 waiting for a STARTTLS command from the client using the standard SMTP
25484 port. The protocol was called &"ssmtp"& or &"smtps"&, and port 465 was
25485 allocated for this purpose.
25486
25487 This approach was abandoned when encrypted SMTP was standardized, but there are
25488 still some legacy clients that use it. Exim supports these clients by means of
25489 the &%tls_on_connect_ports%& global option. Its value must be a list of port
25490 numbers; the most common use is expected to be:
25491 .code
25492 tls_on_connect_ports = 465
25493 .endd
25494 The port numbers specified by this option apply to all SMTP connections, both
25495 via the daemon and via &'inetd'&. You still need to specify all the ports that
25496 the daemon uses (by setting &%daemon_smtp_ports%& or &%local_interfaces%& or
25497 the &%-oX%& command line option) because &%tls_on_connect_ports%& does not add
25498 an extra port &-- rather, it specifies different behaviour on a port that is
25499 defined elsewhere.
25500
25501 There is also a &%-tls-on-connect%& command line option. This overrides
25502 &%tls_on_connect_ports%&; it forces the legacy behaviour for all ports.
25503
25504
25505
25506
25507
25508
25509 .section "OpenSSL vs GnuTLS" "SECTopenvsgnu"
25510 .cindex "TLS" "OpenSSL &'vs'& GnuTLS"
25511 The first TLS support in Exim was implemented using OpenSSL. Support for GnuTLS
25512 followed later, when the first versions of GnuTLS were released. To build Exim
25513 to use GnuTLS, you need to set
25514 .code
25515 USE_GNUTLS=yes
25516 .endd
25517 in Local/Makefile, in addition to
25518 .code
25519 SUPPORT_TLS=yes
25520 .endd
25521 You must also set TLS_LIBS and TLS_INCLUDE appropriately, so that the
25522 include files and libraries for GnuTLS can be found.
25523
25524 There are some differences in usage when using GnuTLS instead of OpenSSL:
25525
25526 .ilist
25527 The &%tls_verify_certificates%& option must contain the name of a file, not the
25528 name of a directory (for OpenSSL it can be either).
25529 .next
25530 The default value for &%tls_dhparam%& differs for historical reasons.
25531 .next
25532 .vindex "&$tls_in_peerdn$&"
25533 .vindex "&$tls_out_peerdn$&"
25534 Distinguished Name (DN) strings reported by the OpenSSL library use a slash for
25535 separating fields; GnuTLS uses commas, in accordance with RFC 2253. This
25536 affects the value of the &$tls_in_peerdn$& and &$tls_out_peerdn$& variables.
25537 .next
25538 OpenSSL identifies cipher suites using hyphens as separators, for example:
25539 DES-CBC3-SHA. GnuTLS historically used underscores, for example:
25540 RSA_ARCFOUR_SHA. What is more, OpenSSL complains if underscores are present
25541 in a cipher list. To make life simpler, Exim changes underscores to hyphens
25542 for OpenSSL and passes the string unchanged to GnuTLS (expecting the library
25543 to handle its own older variants) when processing lists of cipher suites in the
25544 &%tls_require_ciphers%& options (the global option and the &(smtp)& transport
25545 option).
25546 .next
25547 The &%tls_require_ciphers%& options operate differently, as described in the
25548 sections &<<SECTreqciphssl>>& and &<<SECTreqciphgnu>>&.
25549 .next
25550 .new
25551 The &%tls_dh_min_bits%& SMTP transport option is only honoured by GnuTLS.
25552 When using OpenSSL, this option is ignored.
25553 (If an API is found to let OpenSSL be configured in this way,
25554 let the Exim Maintainers know and we'll likely use it).
25555 .wen
25556 .next
25557 Some other recently added features may only be available in one or the other.
25558 This should be documented with the feature.  If the documentation does not
25559 explicitly state that the feature is infeasible in the other TLS
25560 implementation, then patches are welcome.
25561 .endlist
25562
25563
25564 .section "GnuTLS parameter computation" "SECTgnutlsparam"
25565 This section only applies if &%tls_dhparam%& is set to &`historic`& or to
25566 an explicit path; if the latter, then the text about generation still applies,
25567 but not the chosen filename.
25568 By default, as of Exim 4.80 a hard-coded D-H prime is used.
25569 See the documentation of &%tls_dhparam%& for more information.
25570
25571 GnuTLS uses D-H parameters that may take a substantial amount of time
25572 to compute. It is unreasonable to re-compute them for every TLS session.
25573 Therefore, Exim keeps this data in a file in its spool directory, called
25574 &_gnutls-params-NNNN_& for some value of NNNN, corresponding to the number
25575 of bits requested.
25576 The file is owned by the Exim user and is readable only by
25577 its owner. Every Exim process that start up GnuTLS reads the D-H
25578 parameters from this file. If the file does not exist, the first Exim process
25579 that needs it computes the data and writes it to a temporary file which is
25580 renamed once it is complete. It does not matter if several Exim processes do
25581 this simultaneously (apart from wasting a few resources). Once a file is in
25582 place, new Exim processes immediately start using it.
25583
25584 For maximum security, the parameters that are stored in this file should be
25585 recalculated periodically, the frequency depending on your paranoia level.
25586 If you are avoiding using the fixed D-H primes published in RFCs, then you
25587 are concerned about some advanced attacks and will wish to do this; if you do
25588 not regenerate then you might as well stick to the standard primes.
25589
25590 Arranging this is easy in principle; just delete the file when you want new
25591 values to be computed. However, there may be a problem. The calculation of new
25592 parameters needs random numbers, and these are obtained from &_/dev/random_&.
25593 If the system is not very active, &_/dev/random_& may delay returning data
25594 until enough randomness (entropy) is available. This may cause Exim to hang for
25595 a substantial amount of time, causing timeouts on incoming connections.
25596
25597 The solution is to generate the parameters externally to Exim. They are stored
25598 in &_gnutls-params-N_& in PEM format, which means that they can be
25599 generated externally using the &(certtool)& command that is part of GnuTLS.
25600
25601 To replace the parameters with new ones, instead of deleting the file
25602 and letting Exim re-create it, you can generate new parameters using
25603 &(certtool)& and, when this has been done, replace Exim's cache file by
25604 renaming. The relevant commands are something like this:
25605 .code
25606 # ls
25607 [ look for file; assume gnutls-params-2236 is the most recent ]
25608 # rm -f new-params
25609 # touch new-params
25610 # chown exim:exim new-params
25611 # chmod 0600 new-params
25612 # certtool --generate-dh-params --bits 2236 >>new-params
25613 # openssl dhparam -noout -text -in new-params | head
25614 [ check the first line, make sure it's not more than 2236;
25615   if it is, then go back to the start ("rm") and repeat
25616   until the size generated is at most the size requested ]
25617 # chmod 0400 new-params
25618 # mv new-params gnutls-params-2236
25619 .endd
25620 If Exim never has to generate the parameters itself, the possibility of
25621 stalling is removed.
25622
25623 The filename changed in Exim 4.80, to gain the -bits suffix.  The value which
25624 Exim will choose depends upon the version of GnuTLS in use.  For older GnuTLS,
25625 the value remains hard-coded in Exim as 1024.  As of GnuTLS 2.12.x, there is
25626 a way for Exim to ask for the "normal" number of bits for D-H public-key usage,
25627 and Exim does so.  This attempt to remove Exim from TLS policy decisions
25628 failed, as GnuTLS 2.12 returns a value higher than the current hard-coded limit
25629 of the NSS library.  Thus Exim gains the &%tls_dh_max_bits%& global option,
25630 which applies to all D-H usage, client or server.  If the value returned by
25631 GnuTLS is greater than &%tls_dh_max_bits%& then the value will be clamped down
25632 to &%tls_dh_max_bits%&.  The default value has been set at the current NSS
25633 limit, which is still much higher than Exim historically used.
25634
25635 The filename and bits used will change as the GnuTLS maintainers change the
25636 value for their parameter &`GNUTLS_SEC_PARAM_NORMAL`&, as clamped by
25637 &%tls_dh_max_bits%&.  At the time of writing (mid 2012), GnuTLS 2.12 recommends
25638 2432 bits, while NSS is limited to 2236 bits.
25639
25640 In fact, the requested value will be *lower* than &%tls_dh_max_bits%&, to
25641 increase the chance of the generated prime actually being within acceptable
25642 bounds, as GnuTLS has been observed to overshoot.  Note the check step in the
25643 procedure above.  There is no sane procedure available to Exim to double-check
25644 the size of the generated prime, so it might still be too large.
25645
25646
25647 .section "Requiring specific ciphers in OpenSSL" "SECTreqciphssl"
25648 .cindex "TLS" "requiring specific ciphers (OpenSSL)"
25649 .oindex "&%tls_require_ciphers%&" "OpenSSL"
25650 There is a function in the OpenSSL library that can be passed a list of cipher
25651 suites before the cipher negotiation takes place. This specifies which ciphers
25652 are acceptable. The list is colon separated and may contain names like
25653 DES-CBC3-SHA. Exim passes the expanded value of &%tls_require_ciphers%&
25654 directly to this function call.
25655 Many systems will install the OpenSSL manual-pages, so you may have
25656 &'ciphers(1)'& available to you.
25657 The following quotation from the OpenSSL
25658 documentation specifies what forms of item are allowed in the cipher string:
25659
25660 .ilist
25661 It can consist of a single cipher suite such as RC4-SHA.
25662 .next
25663 It can represent a list of cipher suites containing a certain algorithm,
25664 or cipher suites of a certain type. For example SHA1 represents all
25665 ciphers suites using the digest algorithm SHA1 and SSLv3 represents all
25666 SSL v3 algorithms.
25667 .next
25668 Lists of cipher suites can be combined in a single cipher string using
25669 the + character. This is used as a logical and operation. For example
25670 SHA1+DES represents all cipher suites containing the SHA1 and the DES
25671 algorithms.
25672 .endlist
25673
25674 Each cipher string can be optionally preceded by one of the characters &`!`&,
25675 &`-`& or &`+`&.
25676 .ilist
25677 If &`!`& is used, the ciphers are permanently deleted from the list. The
25678 ciphers deleted can never reappear in the list even if they are explicitly
25679 stated.
25680 .next
25681 If &`-`& is used, the ciphers are deleted from the list, but some or all
25682 of the ciphers can be added again by later options.
25683 .next
25684 If &`+`& is used, the ciphers are moved to the end of the list. This
25685 option does not add any new ciphers; it just moves matching existing ones.
25686 .endlist
25687
25688 If none of these characters is present, the string is interpreted as
25689 a list of ciphers to be appended to the current preference list. If the list
25690 includes any ciphers already present they will be ignored: that is, they will
25691 not be moved to the end of the list.
25692 .endlist
25693
25694 The OpenSSL &'ciphers(1)'& command may be used to test the results of a given
25695 string:
25696 .code
25697 # note single-quotes to get ! past any shell history expansion
25698 $ openssl ciphers 'HIGH:!MD5:!SHA1'
25699 .endd
25700
25701 This example will let the library defaults be permitted on the MX port, where
25702 there's probably no identity verification anyway, but ups the ante on the
25703 submission ports where the administrator might have some influence on the
25704 choice of clients used:
25705 .code
25706 # OpenSSL variant; see man ciphers(1)
25707 tls_require_ciphers = ${if =={$received_port}{25}\
25708                            {DEFAULT}\
25709                            {HIGH:!MD5:!SHA1}}
25710 .endd
25711
25712
25713
25714 .section "Requiring specific ciphers or other parameters in GnuTLS" &&&
25715          "SECTreqciphgnu"
25716 .cindex "GnuTLS" "specifying parameters for"
25717 .cindex "TLS" "specifying ciphers (GnuTLS)"
25718 .cindex "TLS" "specifying key exchange methods (GnuTLS)"
25719 .cindex "TLS" "specifying MAC algorithms (GnuTLS)"
25720 .cindex "TLS" "specifying protocols (GnuTLS)"
25721 .cindex "TLS" "specifying priority string (GnuTLS)"
25722 .oindex "&%tls_require_ciphers%&" "GnuTLS"
25723 The GnuTLS library allows the caller to provide a "priority string", documented
25724 as part of the &[gnutls_priority_init]& function.  This is very similar to the
25725 ciphersuite specification in OpenSSL.
25726
25727 The &%tls_require_ciphers%& option is treated as the GnuTLS priority string.
25728
25729 The &%tls_require_ciphers%& option is available both as an global option,
25730 controlling how Exim behaves as a server, and also as an option of the
25731 &(smtp)& transport, controlling how Exim behaves as a client.  In both cases
25732 the value is string expanded.  The resulting string is not an Exim list and
25733 the string is given to the GnuTLS library, so that Exim does not need to be
25734 aware of future feature enhancements of GnuTLS.
25735
25736 Documentation of the strings accepted may be found in the GnuTLS manual, under
25737 "Priority strings".  This is online as
25738 &url(http://www.gnutls.org/manual/html_node/Priority-Strings.html),
25739 but beware that this relates to GnuTLS 3, which may be newer than the version
25740 installed on your system.  If you are using GnuTLS 3,
25741 &url(http://www.gnutls.org/manual/gnutls.html#Listing-the-ciphersuites-in-a-priority-string, then the example code)
25742 on that site can be used to test a given string.
25743
25744 Prior to Exim 4.80, an older API of GnuTLS was used, and Exim supported three
25745 additional options, "&%gnutls_require_kx%&", "&%gnutls_require_mac%&" and
25746 "&%gnutls_require_protocols%&".  &%tls_require_ciphers%& was an Exim list.
25747
25748 This example will let the library defaults be permitted on the MX port, where
25749 there's probably no identity verification anyway, and lowers security further
25750 by increasing compatibility; but this ups the ante on the submission ports
25751 where the administrator might have some influence on the choice of clients
25752 used:
25753 .code
25754 # GnuTLS variant
25755 tls_require_ciphers = ${if =={$received_port}{25}\
25756                            {NORMAL:%COMPAT}\
25757                            {SECURE128}}
25758 .endd
25759
25760
25761 .section "Configuring an Exim server to use TLS" "SECID182"
25762 .cindex "TLS" "configuring an Exim server"
25763 When Exim has been built with TLS support, it advertises the availability of
25764 the STARTTLS command to client hosts that match &%tls_advertise_hosts%&,
25765 but not to any others. The default value of this option is unset, which means
25766 that STARTTLS is not advertised at all. This default is chosen because you
25767 need to set some other options in order to make TLS available, and also it is
25768 sensible for systems that want to use TLS only as a client.
25769
25770 If a client issues a STARTTLS command and there is some configuration
25771 problem in the server, the command is rejected with a 454 error. If the client
25772 persists in trying to issue SMTP commands, all except QUIT are rejected
25773 with the error
25774 .code
25775 554 Security failure
25776 .endd
25777 If a STARTTLS command is issued within an existing TLS session, it is
25778 rejected with a 554 error code.
25779
25780 To enable TLS operations on a server, you must set &%tls_advertise_hosts%& to
25781 match some hosts. You can, of course, set it to * to match all hosts.
25782 However, this is not all you need to do. TLS sessions to a server won't work
25783 without some further configuration at the server end.
25784
25785 It is rumoured that all existing clients that support TLS/SSL use RSA
25786 encryption. To make this work you need to set, in the server,
25787 .code
25788 tls_certificate = /some/file/name
25789 tls_privatekey = /some/file/name
25790 .endd
25791 These options are, in fact, expanded strings, so you can make them depend on
25792 the identity of the client that is connected if you wish. The first file
25793 contains the server's X509 certificate, and the second contains the private key
25794 that goes with it. These files need to be readable by the Exim user, and must
25795 always be given as full path names. They can be the same file if both the
25796 certificate and the key are contained within it. If &%tls_privatekey%& is not
25797 set, or if its expansion is forced to fail or results in an empty string, this
25798 is assumed to be the case. The certificate file may also contain intermediate
25799 certificates that need to be sent to the client to enable it to authenticate
25800 the server's certificate.
25801
25802 If you do not understand about certificates and keys, please try to find a
25803 source of this background information, which is not Exim-specific. (There are a
25804 few comments below in section &<<SECTcerandall>>&.)
25805
25806 &*Note*&: These options do not apply when Exim is operating as a client &--
25807 they apply only in the case of a server. If you need to use a certificate in an
25808 Exim client, you must set the options of the same names in an &(smtp)&
25809 transport.
25810
25811 With just these options, an Exim server will be able to use TLS. It does not
25812 require the client to have a certificate (but see below for how to insist on
25813 this). There is one other option that may be needed in other situations. If
25814 .code
25815 tls_dhparam = /some/file/name
25816 .endd
25817 is set, the SSL library is initialized for the use of Diffie-Hellman ciphers
25818 with the parameters contained in the file.
25819 Set this to &`none`& to disable use of DH entirely, by making no prime
25820 available:
25821 .code
25822 tls_dhparam = none
25823 .endd
25824 This may also be set to a string identifying a standard prime to be used for
25825 DH; if it is set to &`default`& or, for OpenSSL, is unset, then the prime
25826 used is &`ike23`&.  There are a few standard primes available, see the
25827 documentation for &%tls_dhparam%& for the complete list.
25828
25829 See the command
25830 .code
25831 openssl dhparam
25832 .endd
25833 for a way of generating file data.
25834
25835 The strings supplied for these three options are expanded every time a client
25836 host connects. It is therefore possible to use different certificates and keys
25837 for different hosts, if you so wish, by making use of the client's IP address
25838 in &$sender_host_address$& to control the expansion. If a string expansion is
25839 forced to fail, Exim behaves as if the option is not set.
25840
25841 .cindex "cipher" "logging"
25842 .cindex "log" "TLS cipher"
25843 .vindex "&$tls_in_cipher$&"
25844 The variable &$tls_in_cipher$& is set to the cipher suite that was negotiated for
25845 an incoming TLS connection. It is included in the &'Received:'& header of an
25846 incoming message (by default &-- you can, of course, change this), and it is
25847 also included in the log line that records a message's arrival, keyed by
25848 &"X="&, unless the &%tls_cipher%& log selector is turned off. The &%encrypted%&
25849 condition can be used to test for specific cipher suites in ACLs.
25850
25851 Once TLS has been established, the ACLs that run for subsequent SMTP commands
25852 can check the name of the cipher suite and vary their actions accordingly. The
25853 cipher suite names vary, depending on which TLS library is being used. For
25854 example, OpenSSL uses the name DES-CBC3-SHA for the cipher suite which in other
25855 contexts is known as TLS_RSA_WITH_3DES_EDE_CBC_SHA. Check the OpenSSL or GnuTLS
25856 documentation for more details.
25857
25858 .new
25859 For outgoing SMTP deliveries, &$tls_out_cipher$& is used and logged
25860 (again depending on the &%tls_cipher%& log selector).
25861 .wen
25862
25863
25864 .section "Requesting and verifying client certificates" "SECID183"
25865 .cindex "certificate" "verification of client"
25866 .cindex "TLS" "client certificate verification"
25867 If you want an Exim server to request a certificate when negotiating a TLS
25868 session with a client, you must set either &%tls_verify_hosts%& or
25869 &%tls_try_verify_hosts%&. You can, of course, set either of them to * to
25870 apply to all TLS connections. For any host that matches one of these options,
25871 Exim requests a certificate as part of the setup of the TLS session. The
25872 contents of the certificate are verified by comparing it with a list of
25873 expected certificates. These must be available in a file or,
25874 for OpenSSL only (not GnuTLS), a directory, identified by
25875 &%tls_verify_certificates%&.
25876
25877 A file can contain multiple certificates, concatenated end to end. If a
25878 directory is used
25879 (OpenSSL only),
25880 each certificate must be in a separate file, with a name (or a symbolic link)
25881 of the form <&'hash'&>.0, where <&'hash'&> is a hash value constructed from the
25882 certificate. You can compute the relevant hash by running the command
25883 .code
25884 openssl x509 -hash -noout -in /cert/file
25885 .endd
25886 where &_/cert/file_& contains a single certificate.
25887
25888 The difference between &%tls_verify_hosts%& and &%tls_try_verify_hosts%& is
25889 what happens if the client does not supply a certificate, or if the certificate
25890 does not match any of the certificates in the collection named by
25891 &%tls_verify_certificates%&. If the client matches &%tls_verify_hosts%&, the
25892 attempt to set up a TLS session is aborted, and the incoming connection is
25893 dropped. If the client matches &%tls_try_verify_hosts%&, the (encrypted) SMTP
25894 session continues. ACLs that run for subsequent SMTP commands can detect the
25895 fact that no certificate was verified, and vary their actions accordingly. For
25896 example, you can insist on a certificate before accepting a message for
25897 relaying, but not when the message is destined for local delivery.
25898
25899 .vindex "&$tls_in_peerdn$&"
25900 When a client supplies a certificate (whether it verifies or not), the value of
25901 the Distinguished Name of the certificate is made available in the variable
25902 &$tls_in_peerdn$& during subsequent processing of the message.
25903
25904 .cindex "log" "distinguished name"
25905 Because it is often a long text string, it is not included in the log line or
25906 &'Received:'& header by default. You can arrange for it to be logged, keyed by
25907 &"DN="&, by setting the &%tls_peerdn%& log selector, and you can use
25908 &%received_header_text%& to change the &'Received:'& header. When no
25909 certificate is supplied, &$tls_in_peerdn$& is empty.
25910
25911
25912 .section "Revoked certificates" "SECID184"
25913 .cindex "TLS" "revoked certificates"
25914 .cindex "revocation list"
25915 .cindex "certificate" "revocation list"
25916 Certificate issuing authorities issue Certificate Revocation Lists (CRLs) when
25917 certificates are revoked. If you have such a list, you can pass it to an Exim
25918 server using the global option called &%tls_crl%& and to an Exim client using
25919 an identically named option for the &(smtp)& transport. In each case, the value
25920 of the option is expanded and must then be the name of a file that contains a
25921 CRL in PEM format.
25922
25923
25924 .section "Configuring an Exim client to use TLS" "SECID185"
25925 .cindex "cipher" "logging"
25926 .cindex "log" "TLS cipher"
25927 .cindex "log" "distinguished name"
25928 .cindex "TLS" "configuring an Exim client"
25929 The &%tls_cipher%& and &%tls_peerdn%& log selectors apply to outgoing SMTP
25930 deliveries as well as to incoming, the latter one causing logging of the
25931 server certificate's DN. The remaining client configuration for TLS is all
25932 within the &(smtp)& transport.
25933
25934 It is not necessary to set any options to have TLS work in the &(smtp)&
25935 transport. If Exim is built with TLS support, and TLS is advertised by a
25936 server, the &(smtp)& transport always tries to start a TLS session. However,
25937 this can be prevented by setting &%hosts_avoid_tls%& (an option of the
25938 transport) to a list of server hosts for which TLS should not be used.
25939
25940 If you do not want Exim to attempt to send messages unencrypted when an attempt
25941 to set up an encrypted connection fails in any way, you can set
25942 &%hosts_require_tls%& to a list of hosts for which encryption is mandatory. For
25943 those hosts, delivery is always deferred if an encrypted connection cannot be
25944 set up. If there are any other hosts for the address, they are tried in the
25945 usual way.
25946
25947 When the server host is not in &%hosts_require_tls%&, Exim may try to deliver
25948 the message unencrypted. It always does this if the response to STARTTLS is
25949 a 5&'xx'& code. For a temporary error code, or for a failure to negotiate a TLS
25950 session after a success response code, what happens is controlled by the
25951 &%tls_tempfail_tryclear%& option of the &(smtp)& transport. If it is false,
25952 delivery to this host is deferred, and other hosts (if available) are tried. If
25953 it is true, Exim attempts to deliver unencrypted after a 4&'xx'& response to
25954 STARTTLS, and if STARTTLS is accepted, but the subsequent TLS
25955 negotiation fails, Exim closes the current connection (because it is in an
25956 unknown state), opens a new one to the same host, and then tries the delivery
25957 unencrypted.
25958
25959 The &%tls_certificate%& and &%tls_privatekey%& options of the &(smtp)&
25960 transport provide the client with a certificate, which is passed to the server
25961 if it requests it. If the server is Exim, it will request a certificate only if
25962 &%tls_verify_hosts%& or &%tls_try_verify_hosts%& matches the client.
25963
25964 If the &%tls_verify_certificates%& option is set on the &(smtp)& transport, it
25965 must name a file or,
25966 for OpenSSL only (not GnuTLS), a directory, that contains a collection of
25967 expected server certificates. The client verifies the server's certificate
25968 against this collection, taking into account any revoked certificates that are
25969 in the list defined by &%tls_crl%&.
25970
25971 If
25972 &%tls_require_ciphers%& is set on the &(smtp)& transport, it must contain a
25973 list of permitted cipher suites. If either of these checks fails, delivery to
25974 the current host is abandoned, and the &(smtp)& transport tries to deliver to
25975 alternative hosts, if any.
25976
25977  &*Note*&:
25978 These options must be set in the &(smtp)& transport for Exim to use TLS when it
25979 is operating as a client. Exim does not assume that a server certificate (set
25980 by the global options of the same name) should also be used when operating as a
25981 client.
25982
25983 .vindex "&$host$&"
25984 .vindex "&$host_address$&"
25985 All the TLS options in the &(smtp)& transport are expanded before use, with
25986 &$host$& and &$host_address$& containing the name and address of the server to
25987 which the client is connected. Forced failure of an expansion causes Exim to
25988 behave as if the relevant option were unset.
25989
25990 .vindex &$tls_out_bits$&
25991 .vindex &$tls_out_cipher$&
25992 .vindex &$tls_out_peerdn$&
25993 .vindex &$tls_out_sni$&
25994 Before an SMTP connection is established, the
25995 &$tls_out_bits$&, &$tls_out_cipher$&, &$tls_out_peerdn$& and &$tls_out_sni$&
25996 variables are emptied. (Until the first connection, they contain the values
25997 that were set when the message was received.) If STARTTLS is subsequently
25998 successfully obeyed, these variables are set to the relevant values for the
25999 outgoing connection.
26000
26001
26002
26003 .section "Use of TLS Server Name Indication" "SECTtlssni"
26004 .cindex "TLS" "Server Name Indication"
26005 .vindex "&$tls_in_sni$&"
26006 .oindex "&%tls_in_sni%&"
26007 With TLS1.0 or above, there is an extension mechanism by which extra
26008 information can be included at various points in the protocol.  One of these
26009 extensions, documented in RFC 6066 (and before that RFC 4366) is
26010 &"Server Name Indication"&, commonly &"SNI"&.  This extension is sent by the
26011 client in the initial handshake, so that the server can examine the servername
26012 within and possibly choose to use different certificates and keys (and more)
26013 for this session.
26014
26015 This is analagous to HTTP's &"Host:"& header, and is the main mechanism by
26016 which HTTPS-enabled web-sites can be virtual-hosted, many sites to one IP
26017 address.
26018
26019 With SMTP to MX, there are the same problems here as in choosing the identity
26020 against which to validate a certificate: you can't rely on insecure DNS to
26021 provide the identity which you then cryptographically verify.  So this will
26022 be of limited use in that environment.
26023
26024 With SMTP to Submission, there is a well-defined hostname which clients are
26025 connecting to and can validate certificates against.  Thus clients &*can*&
26026 choose to include this information in the TLS negotiation.  If this becomes
26027 wide-spread, then hosters can choose to present different certificates to
26028 different clients.  Or even negotiate different cipher suites.
26029
26030 The &%tls_sni%& option on an SMTP transport is an expanded string; the result,
26031 if not empty, will be sent on a TLS session as part of the handshake.  There's
26032 nothing more to it.  Choosing a sensible value not derived insecurely is the
26033 only point of caution.  The &$tls_out_sni$& variable will be set to this string
26034 for the lifetime of the client connection (including during authentication).
26035
26036 Except during SMTP client sessions, if &$tls_in_sni$& is set then it is a string
26037 received from a client.
26038 It can be logged with the &%log_selector%& item &`+tls_sni`&.
26039
26040 If the string &`tls_in_sni`& appears in the main section's &%tls_certificate%&
26041 option (prior to expansion) then the following options will be re-expanded
26042 during TLS session handshake, to permit alternative values to be chosen:
26043
26044 .ilist
26045 .vindex "&%tls_certificate%&"
26046 &%tls_certificate%&
26047 .next
26048 .vindex "&%tls_crl%&"
26049 &%tls_crl%&
26050 .next
26051 .vindex "&%tls_privatekey%&"
26052 &%tls_privatekey%&
26053 .next
26054 .vindex "&%tls_verify_certificates%&"
26055 &%tls_verify_certificates%&
26056 .endlist
26057
26058 Great care should be taken to deal with matters of case, various injection
26059 attacks in the string (&`../`& or SQL), and ensuring that a valid filename
26060 can always be referenced; it is important to remember that &$tls_sni$& is
26061 arbitrary unverified data provided prior to authentication.
26062
26063 The Exim developers are proceeding cautiously and so far no other TLS options
26064 are re-expanded.
26065
26066 When Exim is built againt OpenSSL, OpenSSL must have been built with support
26067 for TLS Extensions.  This holds true for OpenSSL 1.0.0+ and 0.9.8+ with
26068 enable-tlsext in EXTRACONFIGURE.  If you invoke &(openssl s_client -h)& and
26069 see &`-servername`& in the output, then OpenSSL has support.
26070
26071 When Exim is built against GnuTLS, SNI support is available as of GnuTLS
26072 0.5.10.  (Its presence predates the current API which Exim uses, so if Exim
26073 built, then you have SNI support).
26074
26075
26076
26077 .section "Multiple messages on the same encrypted TCP/IP connection" &&&
26078          "SECTmulmessam"
26079 .cindex "multiple SMTP deliveries with TLS"
26080 .cindex "TLS" "multiple message deliveries"
26081 Exim sends multiple messages down the same TCP/IP connection by starting up
26082 an entirely new delivery process for each message, passing the socket from
26083 one process to the next. This implementation does not fit well with the use
26084 of TLS, because there is quite a lot of state information associated with a TLS
26085 connection, not just a socket identification. Passing all the state information
26086 to a new process is not feasible. Consequently, Exim shuts down an existing TLS
26087 session before passing the socket to a new process. The new process may then
26088 try to start a new TLS session, and if successful, may try to re-authenticate
26089 if AUTH is in use, before sending the next message.
26090
26091 The RFC is not clear as to whether or not an SMTP session continues in clear
26092 after TLS has been shut down, or whether TLS may be restarted again later, as
26093 just described. However, if the server is Exim, this shutdown and
26094 reinitialization works. It is not known which (if any) other servers operate
26095 successfully if the client closes a TLS session and continues with unencrypted
26096 SMTP, but there are certainly some that do not work. For such servers, Exim
26097 should not pass the socket to another process, because the failure of the
26098 subsequent attempt to use it would cause Exim to record a temporary host error,
26099 and delay other deliveries to that host.
26100
26101 To test for this case, Exim sends an EHLO command to the server after
26102 closing down the TLS session. If this fails in any way, the connection is
26103 closed instead of being passed to a new delivery process, but no retry
26104 information is recorded.
26105
26106 There is also a manual override; you can set &%hosts_nopass_tls%& on the
26107 &(smtp)& transport to match those hosts for which Exim should not pass
26108 connections to new processes if TLS has been used.
26109
26110
26111
26112
26113 .section "Certificates and all that" "SECTcerandall"
26114 .cindex "certificate" "references to discussion"
26115 In order to understand fully how TLS works, you need to know about
26116 certificates, certificate signing, and certificate authorities. This is not the
26117 place to give a tutorial, especially as I do not know very much about it
26118 myself. Some helpful introduction can be found in the FAQ for the SSL addition
26119 to Apache, currently at
26120 .display
26121 &url(http://www.modssl.org/docs/2.7/ssl_faq.html#ToC24)
26122 .endd
26123 Other parts of the &'modssl'& documentation are also helpful, and have
26124 links to further files.
26125 Eric Rescorla's book, &'SSL and TLS'&, published by Addison-Wesley (ISBN
26126 0-201-61598-3), contains both introductory and more in-depth descriptions.
26127 Some sample programs taken from the book are available from
26128 .display
26129 &url(http://www.rtfm.com/openssl-examples/)
26130 .endd
26131
26132
26133 .section "Certificate chains" "SECID186"
26134 The file named by &%tls_certificate%& may contain more than one
26135 certificate. This is useful in the case where the certificate that is being
26136 sent is validated by an intermediate certificate which the other end does
26137 not have. Multiple certificates must be in the correct order in the file.
26138 First the host's certificate itself, then the first intermediate
26139 certificate to validate the issuer of the host certificate, then the next
26140 intermediate certificate to validate the issuer of the first intermediate
26141 certificate, and so on, until finally (optionally) the root certificate.
26142 The root certificate must already be trusted by the recipient for
26143 validation to succeed, of course, but if it's not preinstalled, sending the
26144 root certificate along with the rest makes it available for the user to
26145 install if the receiving end is a client MUA that can interact with a user.
26146
26147
26148 .section "Self-signed certificates" "SECID187"
26149 .cindex "certificate" "self-signed"
26150 You can create a self-signed certificate using the &'req'& command provided
26151 with OpenSSL, like this:
26152 .new
26153 . ==== Do not shorten the duration here without reading and considering
26154 . ==== the text below.  Please leave it at 9999 days.
26155 .wen
26156 .code
26157 openssl req -x509 -newkey rsa:1024 -keyout file1 -out file2 \
26158             -days 9999 -nodes
26159 .endd
26160 &_file1_& and &_file2_& can be the same file; the key and the certificate are
26161 delimited and so can be identified independently. The &%-days%& option
26162 specifies a period for which the certificate is valid. The &%-nodes%& option is
26163 important: if you do not set it, the key is encrypted with a passphrase
26164 that you are prompted for, and any use that is made of the key causes more
26165 prompting for the passphrase. This is not helpful if you are going to use
26166 this certificate and key in an MTA, where prompting is not possible.
26167
26168 .new
26169 . ==== I expect to still be working 26 years from now.  The less technical
26170 . ==== debt I create, in terms of storing up trouble for my later years, the
26171 . ==== happier I will be then.  We really have reached the point where we
26172 . ==== should start, at the very least, provoking thought and making folks
26173 . ==== pause before proceeding, instead of leaving all the fixes until two
26174 . ==== years before 2^31 seconds after the 1970 Unix epoch.
26175 . ==== -pdp, 2012
26176 NB: we are now past the point where 9999 days takes us past the 32-bit Unix
26177 epoch.  If your system uses unsigned time_t (most do) and is 32-bit, then
26178 the above command might produce a date in the past.  Think carefully about
26179 the lifetime of the systems you're deploying, and either reduce the duration
26180 of the certificate or reconsider your platform deployment.  (At time of
26181 writing, reducing the duration is the most likely choice, but the inexorable
26182 progression of time takes us steadily towards an era where this will not
26183 be a sensible resolution).
26184 .wen
26185
26186 A self-signed certificate made in this way is sufficient for testing, and
26187 may be adequate for all your requirements if you are mainly interested in
26188 encrypting transfers, and not in secure identification.
26189
26190 However, many clients require that the certificate presented by the server be a
26191 user (also called &"leaf"& or &"site"&) certificate, and not a self-signed
26192 certificate. In this situation, the self-signed certificate described above
26193 must be installed on the client host as a trusted root &'certification
26194 authority'& (CA), and the certificate used by Exim must be a user certificate
26195 signed with that self-signed certificate.
26196
26197 For information on creating self-signed CA certificates and using them to sign
26198 user certificates, see the &'General implementation overview'& chapter of the
26199 Open-source PKI book, available online at
26200 &url(http://ospkibook.sourceforge.net/).
26201 .ecindex IIDencsmtp1
26202 .ecindex IIDencsmtp2
26203
26204
26205
26206 . ////////////////////////////////////////////////////////////////////////////
26207 . ////////////////////////////////////////////////////////////////////////////
26208
26209 .chapter "Access control lists" "CHAPACL"
26210 .scindex IIDacl "&ACL;" "description"
26211 .cindex "control of incoming mail"
26212 .cindex "message" "controlling incoming"
26213 .cindex "policy control" "access control lists"
26214 Access Control Lists (ACLs) are defined in a separate section of the run time
26215 configuration file, headed by &"begin acl"&. Each ACL definition starts with a
26216 name, terminated by a colon. Here is a complete ACL section that contains just
26217 one very small ACL:
26218 .code
26219 begin acl
26220 small_acl:
26221   accept   hosts = one.host.only
26222 .endd
26223 You can have as many lists as you like in the ACL section, and the order in
26224 which they appear does not matter. The lists are self-terminating.
26225
26226 The majority of ACLs are used to control Exim's behaviour when it receives
26227 certain SMTP commands. This applies both to incoming TCP/IP connections, and
26228 when a local process submits a message using SMTP by specifying the &%-bs%&
26229 option. The most common use is for controlling which recipients are accepted
26230 in incoming messages. In addition, you can define an ACL that is used to check
26231 local non-SMTP messages. The default configuration file contains an example of
26232 a realistic ACL for checking RCPT commands. This is discussed in chapter
26233 &<<CHAPdefconfil>>&.
26234
26235
26236 .section "Testing ACLs" "SECID188"
26237 The &%-bh%& command line option provides a way of testing your ACL
26238 configuration locally by running a fake SMTP session with which you interact.
26239 The host &'relay-test.mail-abuse.org'& provides a service for checking your
26240 relaying configuration (see section &<<SECTcheralcon>>& for more details).
26241
26242
26243
26244 .section "Specifying when ACLs are used" "SECID189"
26245 .cindex "&ACL;" "options for specifying"
26246 In order to cause an ACL to be used, you have to name it in one of the relevant
26247 options in the main part of the configuration. These options are:
26248 .cindex "AUTH" "ACL for"
26249 .cindex "DATA" "ACLs for"
26250 .cindex "ETRN" "ACL for"
26251 .cindex "EXPN" "ACL for"
26252 .cindex "HELO" "ACL for"
26253 .cindex "EHLO" "ACL for"
26254 .cindex "MAIL" "ACL for"
26255 .cindex "QUIT, ACL for"
26256 .cindex "RCPT" "ACL for"
26257 .cindex "STARTTLS, ACL for"
26258 .cindex "VRFY" "ACL for"
26259 .cindex "SMTP" "connection, ACL for"
26260 .cindex "non-SMTP messages" "ACLs for"
26261 .cindex "MIME content scanning" "ACL for"
26262
26263 .table2 140pt
26264 .irow &%acl_not_smtp%&         "ACL for non-SMTP messages"
26265 .irow &%acl_not_smtp_mime%&    "ACL for non-SMTP MIME parts"
26266 .irow &%acl_not_smtp_start%&   "ACL at start of non-SMTP message"
26267 .irow &%acl_smtp_auth%&        "ACL for AUTH"
26268 .irow &%acl_smtp_connect%&     "ACL for start of SMTP connection"
26269 .irow &%acl_smtp_data%&        "ACL after DATA is complete"
26270 .irow &%acl_smtp_etrn%&        "ACL for ETRN"
26271 .irow &%acl_smtp_expn%&        "ACL for EXPN"
26272 .irow &%acl_smtp_helo%&        "ACL for HELO or EHLO"
26273 .irow &%acl_smtp_mail%&        "ACL for MAIL"
26274 .irow &%acl_smtp_mailauth%&    "ACL for the AUTH parameter of MAIL"
26275 .irow &%acl_smtp_mime%&        "ACL for content-scanning MIME parts"
26276 .irow &%acl_smtp_notquit%&     "ACL for non-QUIT terminations"
26277 .irow &%acl_smtp_predata%&     "ACL at start of DATA command"
26278 .irow &%acl_smtp_quit%&        "ACL for QUIT"
26279 .irow &%acl_smtp_rcpt%&        "ACL for RCPT"
26280 .irow &%acl_smtp_starttls%&    "ACL for STARTTLS"
26281 .irow &%acl_smtp_vrfy%&        "ACL for VRFY"
26282 .endtable
26283
26284 For example, if you set
26285 .code
26286 acl_smtp_rcpt = small_acl
26287 .endd
26288 the little ACL defined above is used whenever Exim receives a RCPT command
26289 in an SMTP dialogue. The majority of policy tests on incoming messages can be
26290 done when RCPT commands arrive. A rejection of RCPT should cause the
26291 sending MTA to give up on the recipient address contained in the RCPT
26292 command, whereas rejection at other times may cause the client MTA to keep on
26293 trying to deliver the message. It is therefore recommended that you do as much
26294 testing as possible at RCPT time.
26295
26296
26297 .section "The non-SMTP ACLs" "SECID190"
26298 .cindex "non-SMTP messages" "ACLs for"
26299 The non-SMTP ACLs apply to all non-interactive incoming messages, that is, they
26300 apply to batched SMTP as well as to non-SMTP messages. (Batched SMTP is not
26301 really SMTP.) Many of the ACL conditions (for example, host tests, and tests on
26302 the state of the SMTP connection such as encryption and authentication) are not
26303 relevant and are forbidden in these ACLs. However, the sender and recipients
26304 are known, so the &%senders%& and &%sender_domains%& conditions and the
26305 &$sender_address$& and &$recipients$& variables can be used. Variables such as
26306 &$authenticated_sender$& are also available. You can specify added header lines
26307 in any of these ACLs.
26308
26309 The &%acl_not_smtp_start%& ACL is run right at the start of receiving a
26310 non-SMTP message, before any of the message has been read. (This is the
26311 analogue of the &%acl_smtp_predata%& ACL for SMTP input.) In the case of
26312 batched SMTP input, it runs after the DATA command has been reached. The
26313 result of this ACL is ignored; it cannot be used to reject a message. If you
26314 really need to, you could set a value in an ACL variable here and reject based
26315 on that in the &%acl_not_smtp%& ACL. However, this ACL can be used to set
26316 controls, and in particular, it can be used to set
26317 .code
26318 control = suppress_local_fixups
26319 .endd
26320 This cannot be used in the other non-SMTP ACLs because by the time they are
26321 run, it is too late.
26322
26323 The &%acl_not_smtp_mime%& ACL is available only when Exim is compiled with the
26324 content-scanning extension. For details, see chapter &<<CHAPexiscan>>&.
26325
26326 The &%acl_not_smtp%& ACL is run just before the &[local_scan()]& function. Any
26327 kind of rejection is treated as permanent, because there is no way of sending a
26328 temporary error for these kinds of message.
26329
26330
26331 .section "The SMTP connect ACL" "SECID191"
26332 .cindex "SMTP" "connection, ACL for"
26333 .oindex &%smtp_banner%&
26334 The ACL test specified by &%acl_smtp_connect%& happens at the start of an SMTP
26335 session, after the test specified by &%host_reject_connection%& (which is now
26336 an anomaly) and any TCP Wrappers testing (if configured). If the connection is
26337 accepted by an &%accept%& verb that has a &%message%& modifier, the contents of
26338 the message override the banner message that is otherwise specified by the
26339 &%smtp_banner%& option.
26340
26341
26342 .section "The EHLO/HELO ACL" "SECID192"
26343 .cindex "EHLO" "ACL for"
26344 .cindex "HELO" "ACL for"
26345 The ACL test specified by &%acl_smtp_helo%& happens when the client issues an
26346 EHLO or HELO command, after the tests specified by &%helo_accept_junk_hosts%&,
26347 &%helo_allow_chars%&, &%helo_verify_hosts%&, and &%helo_try_verify_hosts%&.
26348 Note that a client may issue more than one EHLO or HELO command in an SMTP
26349 session, and indeed is required to issue a new EHLO or HELO after successfully
26350 setting up encryption following a STARTTLS command.
26351
26352 If the command is accepted by an &%accept%& verb that has a &%message%&
26353 modifier, the message may not contain more than one line (it will be truncated
26354 at the first newline and a panic logged if it does). Such a message cannot
26355 affect the EHLO options that are listed on the second and subsequent lines of
26356 an EHLO response.
26357
26358
26359 .section "The DATA ACLs" "SECID193"
26360 .cindex "DATA" "ACLs for"
26361 Two ACLs are associated with the DATA command, because it is two-stage
26362 command, with two responses being sent to the client.
26363 When the DATA command is received, the ACL defined by &%acl_smtp_predata%&
26364 is obeyed. This gives you control after all the RCPT commands, but before
26365 the message itself is received. It offers the opportunity to give a negative
26366 response to the DATA command before the data is transmitted. Header lines
26367 added by MAIL or RCPT ACLs are not visible at this time, but any that
26368 are defined here are visible when the &%acl_smtp_data%& ACL is run.
26369
26370 You cannot test the contents of the message, for example, to verify addresses
26371 in the headers, at RCPT time or when the DATA command is received. Such
26372 tests have to appear in the ACL that is run after the message itself has been
26373 received, before the final response to the DATA command is sent. This is
26374 the ACL specified by &%acl_smtp_data%&, which is the second ACL that is
26375 associated with the DATA command.
26376
26377 For both of these ACLs, it is not possible to reject individual recipients. An
26378 error response rejects the entire message. Unfortunately, it is known that some
26379 MTAs do not treat hard (5&'xx'&) responses to the DATA command (either
26380 before or after the data) correctly &-- they keep the message on their queues
26381 and try again later, but that is their problem, though it does waste some of
26382 your resources.
26383
26384 .new
26385 The &%acl_smtp_data%& ACL is run after both the &%acl_smtp_dkim%& and
26386 the &%acl_smtp_mime%& ACLs.
26387 .wen
26388
26389 .section "The SMTP DKIM ACL" "SECTDKIMACL"
26390 The &%acl_smtp_dkim%& ACL is available only when Exim is compiled with DKIM support
26391 enabled (which is the default).
26392
26393 The ACL test specified by &%acl_smtp_dkim%& happens after a message has been
26394 received, and is executed for each DKIM signature found in a message.  If not
26395 otherwise specified, the default action is to accept.
26396
26397 .new
26398 This ACL is evaluated before &%acl_smtp_mime%& and &%acl_smtp_data%&.
26399
26400 For details on the operation of DKIM, see chapter &<<CHAPdkim>>&.
26401 .wen
26402
26403
26404 .section "The SMTP MIME ACL" "SECID194"
26405 The &%acl_smtp_mime%& option is available only when Exim is compiled with the
26406 content-scanning extension. For details, see chapter &<<CHAPexiscan>>&.
26407
26408 This ACL is evaluated after &%acl_smtp_dkim%& but before &%acl_smtp_data%&.
26409
26410
26411 .section "The QUIT ACL" "SECTQUITACL"
26412 .cindex "QUIT, ACL for"
26413 The ACL for the SMTP QUIT command is anomalous, in that the outcome of the ACL
26414 does not affect the response code to QUIT, which is always 221. Thus, the ACL
26415 does not in fact control any access. For this reason, the only verbs that are
26416 permitted are &%accept%& and &%warn%&.
26417
26418 This ACL can be used for tasks such as custom logging at the end of an SMTP
26419 session. For example, you can use ACL variables in other ACLs to count
26420 messages, recipients, etc., and log the totals at QUIT time using one or
26421 more &%logwrite%& modifiers on a &%warn%& verb.
26422
26423 &*Warning*&: Only the &$acl_c$&&'x'& variables can be used for this, because
26424 the &$acl_m$&&'x'& variables are reset at the end of each incoming message.
26425
26426 You do not need to have a final &%accept%&, but if you do, you can use a
26427 &%message%& modifier to specify custom text that is sent as part of the 221
26428 response to QUIT.
26429
26430 This ACL is run only for a &"normal"& QUIT. For certain kinds of disastrous
26431 failure (for example, failure to open a log file, or when Exim is bombing out
26432 because it has detected an unrecoverable error), all SMTP commands from the
26433 client are given temporary error responses until QUIT is received or the
26434 connection is closed. In these special cases, the QUIT ACL does not run.
26435
26436
26437 .section "The not-QUIT ACL" "SECTNOTQUITACL"
26438 .vindex &$acl_smtp_notquit$&
26439 The not-QUIT ACL, specified by &%acl_smtp_notquit%&, is run in most cases when
26440 an SMTP session ends without sending QUIT. However, when Exim itself is in bad
26441 trouble, such as being unable to write to its log files, this ACL is not run,
26442 because it might try to do things (such as write to log files) that make the
26443 situation even worse.
26444
26445 Like the QUIT ACL, this ACL is provided to make it possible to do customized
26446 logging or to gather statistics, and its outcome is ignored. The &%delay%&
26447 modifier is forbidden in this ACL, and the only permitted verbs are &%accept%&
26448 and &%warn%&.
26449
26450 .vindex &$smtp_notquit_reason$&
26451 When the not-QUIT ACL is running, the variable &$smtp_notquit_reason$& is set
26452 to a string that indicates the reason for the termination of the SMTP
26453 connection. The possible values are:
26454 .table2
26455 .irow &`acl-drop`&                 "Another ACL issued a &%drop%& command"
26456 .irow &`bad-commands`&             "Too many unknown or non-mail commands"
26457 .irow &`command-timeout`&          "Timeout while reading SMTP commands"
26458 .irow &`connection-lost`&          "The SMTP connection has been lost"
26459 .irow &`data-timeout`&             "Timeout while reading message data"
26460 .irow &`local-scan-error`&         "The &[local_scan()]& function crashed"
26461 .irow &`local-scan-timeout`&       "The &[local_scan()]& function timed out"
26462 .irow &`signal-exit`&              "SIGTERM or SIGINT"
26463 .irow &`synchronization-error`&    "SMTP synchronization error"
26464 .irow &`tls-failed`&               "TLS failed to start"
26465 .endtable
26466 In most cases when an SMTP connection is closed without having received QUIT,
26467 Exim sends an SMTP response message before actually closing the connection.
26468 With the exception of the &`acl-drop`& case, the default message can be
26469 overridden by the &%message%& modifier in the not-QUIT ACL. In the case of a
26470 &%drop%& verb in another ACL, it is the message from the other ACL that is
26471 used.
26472
26473
26474 .section "Finding an ACL to use" "SECID195"
26475 .cindex "&ACL;" "finding which to use"
26476 The value of an &%acl_smtp_%&&'xxx'& option is expanded before use, so
26477 you can use different ACLs in different circumstances. For example,
26478 .code
26479 acl_smtp_rcpt = ${if ={25}{$interface_port} \
26480                      {acl_check_rcpt} {acl_check_rcpt_submit} }
26481 .endd
26482 In the default configuration file there are some example settings for
26483 providing an RFC 4409 message submission service on port 587 and a
26484 non-standard &"smtps"& service on port 465. You can use a string
26485 expansion like this to choose an ACL for MUAs on these ports which is
26486 more appropriate for this purpose than the default ACL on port 25.
26487
26488 The expanded string does not have to be the name of an ACL in the
26489 configuration file; there are other possibilities. Having expanded the
26490 string, Exim searches for an ACL as follows:
26491
26492 .ilist
26493 If the string begins with a slash, Exim uses it as a file name, and reads its
26494 contents as an ACL. The lines are processed in the same way as lines in the
26495 Exim configuration file. In particular, continuation lines are supported, blank
26496 lines are ignored, as are lines whose first non-whitespace character is &"#"&.
26497 If the file does not exist or cannot be read, an error occurs (typically
26498 causing a temporary failure of whatever caused the ACL to be run). For example:
26499 .code
26500 acl_smtp_data = /etc/acls/\
26501   ${lookup{$sender_host_address}lsearch\
26502   {/etc/acllist}{$value}{default}}
26503 .endd
26504 This looks up an ACL file to use on the basis of the host's IP address, falling
26505 back to a default if the lookup fails. If an ACL is successfully read from a
26506 file, it is retained in memory for the duration of the Exim process, so that it
26507 can be re-used without having to re-read the file.
26508 .next
26509 If the string does not start with a slash, and does not contain any spaces,
26510 Exim searches the ACL section of the configuration for an ACL whose name
26511 matches the string.
26512 .next
26513 If no named ACL is found, or if the string contains spaces, Exim parses
26514 the string as an inline ACL. This can save typing in cases where you just
26515 want to have something like
26516 .code
26517 acl_smtp_vrfy = accept
26518 .endd
26519 in order to allow free use of the VRFY command. Such a string may contain
26520 newlines; it is processed in the same way as an ACL that is read from a file.
26521 .endlist
26522
26523
26524
26525
26526 .section "ACL return codes" "SECID196"
26527 .cindex "&ACL;" "return codes"
26528 Except for the QUIT ACL, which does not affect the SMTP return code (see
26529 section &<<SECTQUITACL>>& above), the result of running an ACL is either
26530 &"accept"& or &"deny"&, or, if some test cannot be completed (for example, if a
26531 database is down), &"defer"&. These results cause 2&'xx'&, 5&'xx'&, and 4&'xx'&
26532 return codes, respectively, to be used in the SMTP dialogue. A fourth return,
26533 &"error"&, occurs when there is an error such as invalid syntax in the ACL.
26534 This also causes a 4&'xx'& return code.
26535
26536 For the non-SMTP ACL, &"defer"& and &"error"& are treated in the same way as
26537 &"deny"&, because there is no mechanism for passing temporary errors to the
26538 submitters of non-SMTP messages.
26539
26540
26541 ACLs that are relevant to message reception may also return &"discard"&. This
26542 has the effect of &"accept"&, but causes either the entire message or an
26543 individual recipient address to be discarded. In other words, it is a
26544 blackholing facility. Use it with care.
26545
26546 If the ACL for MAIL returns &"discard"&, all recipients are discarded, and no
26547 ACL is run for subsequent RCPT commands. The effect of &"discard"& in a
26548 RCPT ACL is to discard just the one recipient address. If there are no
26549 recipients left when the message's data is received, the DATA ACL is not
26550 run. A &"discard"& return from the DATA or the non-SMTP ACL discards all the
26551 remaining recipients. The &"discard"& return is not permitted for the
26552 &%acl_smtp_predata%& ACL.
26553
26554
26555 .cindex "&[local_scan()]& function" "when all recipients discarded"
26556 The &[local_scan()]& function is always run, even if there are no remaining
26557 recipients; it may create new recipients.
26558
26559
26560
26561 .section "Unset ACL options" "SECID197"
26562 .cindex "&ACL;" "unset options"
26563 The default actions when any of the &%acl_%&&'xxx'& options are unset are not
26564 all the same. &*Note*&: These defaults apply only when the relevant ACL is
26565 not defined at all. For any defined ACL, the default action when control
26566 reaches the end of the ACL statements is &"deny"&.
26567
26568 For &%acl_smtp_quit%& and &%acl_not_smtp_start%& there is no default because
26569 these two are ACLs that are used only for their side effects. They cannot be
26570 used to accept or reject anything.
26571
26572 For &%acl_not_smtp%&, &%acl_smtp_auth%&, &%acl_smtp_connect%&,
26573 &%acl_smtp_data%&, &%acl_smtp_helo%&, &%acl_smtp_mail%&, &%acl_smtp_mailauth%&,
26574 &%acl_smtp_mime%&, &%acl_smtp_predata%&, and &%acl_smtp_starttls%&, the action
26575 when the ACL is not defined is &"accept"&.
26576
26577 For the others (&%acl_smtp_etrn%&, &%acl_smtp_expn%&, &%acl_smtp_rcpt%&, and
26578 &%acl_smtp_vrfy%&), the action when the ACL is not defined is &"deny"&.
26579 This means that &%acl_smtp_rcpt%& must be defined in order to receive any
26580 messages over an SMTP connection. For an example, see the ACL in the default
26581 configuration file.
26582
26583
26584
26585
26586 .section "Data for message ACLs" "SECID198"
26587 .cindex "&ACL;" "data for message ACL"
26588 .vindex &$domain$&
26589 .vindex &$local_part$&
26590 .vindex &$sender_address$&
26591 .vindex &$sender_host_address$&
26592 .vindex &$smtp_command$&
26593 When a MAIL or RCPT ACL, or either of the DATA ACLs, is running, the variables
26594 that contain information about the host and the message's sender (for example,
26595 &$sender_host_address$& and &$sender_address$&) are set, and can be used in ACL
26596 statements. In the case of RCPT (but not MAIL or DATA), &$domain$& and
26597 &$local_part$& are set from the argument address. The entire SMTP command
26598 is available in &$smtp_command$&.
26599
26600 When an ACL for the AUTH parameter of MAIL is running, the variables that
26601 contain information about the host are set, but &$sender_address$& is not yet
26602 set. Section &<<SECTauthparamail>>& contains a discussion of this parameter and
26603 how it is used.
26604
26605 .vindex "&$message_size$&"
26606 The &$message_size$& variable is set to the value of the SIZE parameter on
26607 the MAIL command at MAIL, RCPT and pre-data time, or to -1 if
26608 that parameter is not given. The value is updated to the true message size by
26609 the time the final DATA ACL is run (after the message data has been
26610 received).
26611
26612 .vindex "&$rcpt_count$&"
26613 .vindex "&$recipients_count$&"
26614 The &$rcpt_count$& variable increases by one for each RCPT command received.
26615 The &$recipients_count$& variable increases by one each time a RCPT command is
26616 accepted, so while an ACL for RCPT is being processed, it contains the number
26617 of previously accepted recipients. At DATA time (for both the DATA ACLs),
26618 &$rcpt_count$& contains the total number of RCPT commands, and
26619 &$recipients_count$& contains the total number of accepted recipients.
26620
26621
26622
26623
26624
26625 .section "Data for non-message ACLs" "SECTdatfornon"
26626 .cindex "&ACL;" "data for non-message ACL"
26627 .vindex &$smtp_command_argument$&
26628 .vindex &$smtp_command$&
26629 When an ACL is being run for AUTH, EHLO, ETRN, EXPN, HELO, STARTTLS, or VRFY,
26630 the remainder of the SMTP command line is placed in &$smtp_command_argument$&,
26631 and the entire SMTP command is available in &$smtp_command$&.
26632 These variables can be tested using a &%condition%& condition. For example,
26633 here is an ACL for use with AUTH, which insists that either the session is
26634 encrypted, or the CRAM-MD5 authentication method is used. In other words, it
26635 does not permit authentication methods that use cleartext passwords on
26636 unencrypted connections.
26637 .code
26638 acl_check_auth:
26639   accept encrypted = *
26640   accept condition = ${if eq{${uc:$smtp_command_argument}}\
26641                      {CRAM-MD5}}
26642   deny   message   = TLS encryption or CRAM-MD5 required
26643 .endd
26644 (Another way of applying this restriction is to arrange for the authenticators
26645 that use cleartext passwords not to be advertised when the connection is not
26646 encrypted. You can use the generic &%server_advertise_condition%& authenticator
26647 option to do this.)
26648
26649
26650
26651 .section "Format of an ACL" "SECID199"
26652 .cindex "&ACL;" "format of"
26653 .cindex "&ACL;" "verbs, definition of"
26654 An individual ACL consists of a number of statements. Each statement starts
26655 with a verb, optionally followed by a number of conditions and &"modifiers"&.
26656 Modifiers can change the way the verb operates, define error and log messages,
26657 set variables, insert delays, and vary the processing of accepted messages.
26658
26659 If all the conditions are met, the verb is obeyed. The same condition may be
26660 used (with different arguments) more than once in the same statement. This
26661 provides a means of specifying an &"and"& conjunction between conditions. For
26662 example:
26663 .code
26664 deny  dnslists = list1.example
26665 dnslists = list2.example
26666 .endd
26667 If there are no conditions, the verb is always obeyed. Exim stops evaluating
26668 the conditions and modifiers when it reaches a condition that fails. What
26669 happens then depends on the verb (and in one case, on a special modifier). Not
26670 all the conditions make sense at every testing point. For example, you cannot
26671 test a sender address in the ACL that is run for a VRFY command.
26672
26673
26674 .section "ACL verbs" "SECID200"
26675 The ACL verbs are as follows:
26676
26677 .ilist
26678 .cindex "&%accept%& ACL verb"
26679 &%accept%&: If all the conditions are met, the ACL returns &"accept"&. If any
26680 of the conditions are not met, what happens depends on whether &%endpass%&
26681 appears among the conditions (for syntax see below). If the failing condition
26682 is before &%endpass%&, control is passed to the next ACL statement; if it is
26683 after &%endpass%&, the ACL returns &"deny"&. Consider this statement, used to
26684 check a RCPT command:
26685 .code
26686 accept domains = +local_domains
26687 endpass
26688 verify = recipient
26689 .endd
26690 If the recipient domain does not match the &%domains%& condition, control
26691 passes to the next statement. If it does match, the recipient is verified, and
26692 the command is accepted if verification succeeds. However, if verification
26693 fails, the ACL yields &"deny"&, because the failing condition is after
26694 &%endpass%&.
26695
26696 The &%endpass%& feature has turned out to be confusing to many people, so its
26697 use is not recommended nowadays. It is always possible to rewrite an ACL so
26698 that &%endpass%& is not needed, and it is no longer used in the default
26699 configuration.
26700
26701 .cindex "&%message%& ACL modifier" "with &%accept%&"
26702 If a &%message%& modifier appears on an &%accept%& statement, its action
26703 depends on whether or not &%endpass%& is present. In the absence of &%endpass%&
26704 (when an &%accept%& verb either accepts or passes control to the next
26705 statement), &%message%& can be used to vary the message that is sent when an
26706 SMTP command is accepted. For example, in a RCPT ACL you could have:
26707 .display
26708 &`accept  `&<&'some conditions'&>
26709 &`        message = OK, I will allow you through today`&
26710 .endd
26711 You can specify an SMTP response code, optionally followed by an &"extended
26712 response code"& at the start of the message, but the first digit must be the
26713 same as would be sent by default, which is 2 for an &%accept%& verb.
26714
26715 If &%endpass%& is present in an &%accept%& statement, &%message%& specifies
26716 an error message that is used when access is denied. This behaviour is retained
26717 for backward compatibility, but current &"best practice"& is to avoid the use
26718 of &%endpass%&.
26719
26720
26721 .next
26722 .cindex "&%defer%& ACL verb"
26723 &%defer%&: If all the conditions are true, the ACL returns &"defer"& which, in
26724 an SMTP session, causes a 4&'xx'& response to be given. For a non-SMTP ACL,
26725 &%defer%& is the same as &%deny%&, because there is no way of sending a
26726 temporary error. For a RCPT command, &%defer%& is much the same as using a
26727 &(redirect)& router and &`:defer:`& while verifying, but the &%defer%& verb can
26728 be used in any ACL, and even for a recipient it might be a simpler approach.
26729
26730
26731 .next
26732 .cindex "&%deny%& ACL verb"
26733 &%deny%&: If all the conditions are met, the ACL returns &"deny"&. If any of
26734 the conditions are not met, control is passed to the next ACL statement. For
26735 example,
26736 .code
26737 deny dnslists = blackholes.mail-abuse.org
26738 .endd
26739 rejects commands from hosts that are on a DNS black list.
26740
26741
26742 .next
26743 .cindex "&%discard%& ACL verb"
26744 &%discard%&: This verb behaves like &%accept%&, except that it returns
26745 &"discard"& from the ACL instead of &"accept"&. It is permitted only on ACLs
26746 that are concerned with receiving messages. When all the conditions are true,
26747 the sending entity receives a &"success"& response. However, &%discard%& causes
26748 recipients to be discarded. If it is used in an ACL for RCPT, just the one
26749 recipient is discarded; if used for MAIL, DATA or in the non-SMTP ACL, all the
26750 message's recipients are discarded. Recipients that are discarded before DATA
26751 do not appear in the log line when the &%received_recipients%& log selector is set.
26752
26753 If the &%log_message%& modifier is set when &%discard%& operates,
26754 its contents are added to the line that is automatically written to the log.
26755 The &%message%& modifier operates exactly as it does for &%accept%&.
26756
26757
26758 .next
26759 .cindex "&%drop%& ACL verb"
26760 &%drop%&: This verb behaves like &%deny%&, except that an SMTP connection is
26761 forcibly closed after the 5&'xx'& error message has been sent. For example:
26762 .code
26763 drop   message   = I don't take more than 20 RCPTs
26764        condition = ${if > {$rcpt_count}{20}}
26765 .endd
26766 There is no difference between &%deny%& and &%drop%& for the connect-time ACL.
26767 The connection is always dropped after sending a 550 response.
26768
26769 .next
26770 .cindex "&%require%& ACL verb"
26771 &%require%&: If all the conditions are met, control is passed to the next ACL
26772 statement. If any of the conditions are not met, the ACL returns &"deny"&. For
26773 example, when checking a RCPT command,
26774 .code
26775 require message = Sender did not verify
26776         verify  = sender
26777 .endd
26778 passes control to subsequent statements only if the message's sender can be
26779 verified. Otherwise, it rejects the command. Note the positioning of the
26780 &%message%& modifier, before the &%verify%& condition. The reason for this is
26781 discussed in section &<<SECTcondmodproc>>&.
26782
26783 .next
26784 .cindex "&%warn%& ACL verb"
26785 &%warn%&: If all the conditions are true, a line specified by the
26786 &%log_message%& modifier is written to Exim's main log. Control always passes
26787 to the next ACL statement. If any condition is false, the log line is not
26788 written. If an identical log line is requested several times in the same
26789 message, only one copy is actually written to the log. If you want to force
26790 duplicates to be written, use the &%logwrite%& modifier instead.
26791
26792 If &%log_message%& is not present, a &%warn%& verb just checks its conditions
26793 and obeys any &"immediate"& modifiers (such as &%control%&, &%set%&,
26794 &%logwrite%&, &%add_header%&, and &%remove_header%&) that appear before the
26795 first failing condition. There is more about adding header lines in section
26796 &<<SECTaddheadacl>>&.
26797
26798 If any condition on a &%warn%& statement cannot be completed (that is, there is
26799 some sort of defer), the log line specified by &%log_message%& is not written.
26800 This does not include the case of a forced failure from a lookup, which
26801 is considered to be a successful completion. After a defer, no further
26802 conditions or modifiers in the &%warn%& statement are processed. The incident
26803 is logged, and the ACL continues to be processed, from the next statement
26804 onwards.
26805
26806
26807 .vindex "&$acl_verify_message$&"
26808 When one of the &%warn%& conditions is an address verification that fails, the
26809 text of the verification failure message is in &$acl_verify_message$&. If you
26810 want this logged, you must set it up explicitly. For example:
26811 .code
26812 warn   !verify = sender
26813        log_message = sender verify failed: $acl_verify_message
26814 .endd
26815 .endlist
26816
26817 At the end of each ACL there is an implicit unconditional &%deny%&.
26818
26819 As you can see from the examples above, the conditions and modifiers are
26820 written one to a line, with the first one on the same line as the verb, and
26821 subsequent ones on following lines. If you have a very long condition, you can
26822 continue it onto several physical lines by the usual backslash continuation
26823 mechanism. It is conventional to align the conditions vertically.
26824
26825
26826
26827 .section "ACL variables" "SECTaclvariables"
26828 .cindex "&ACL;" "variables"
26829 There are some special variables that can be set during ACL processing. They
26830 can be used to pass information between different ACLs, different invocations
26831 of the same ACL in the same SMTP connection, and between ACLs and the routers,
26832 transports, and filters that are used to deliver a message. The names of these
26833 variables must begin with &$acl_c$& or &$acl_m$&, followed either by a digit or
26834 an underscore, but the remainder of the name can be any sequence of
26835 alphanumeric characters and underscores that you choose. There is no limit on
26836 the number of ACL variables. The two sets act as follows:
26837 .ilist
26838 The values of those variables whose names begin with &$acl_c$& persist
26839 throughout an SMTP connection. They are never reset. Thus, a value that is set
26840 while receiving one message is still available when receiving the next message
26841 on the same SMTP connection.
26842 .next
26843 The values of those variables whose names begin with &$acl_m$& persist only
26844 while a message is being received. They are reset afterwards. They are also
26845 reset by MAIL, RSET, EHLO, HELO, and after starting up a TLS session.
26846 .endlist
26847
26848 When a message is accepted, the current values of all the ACL variables are
26849 preserved with the message and are subsequently made available at delivery
26850 time. The ACL variables are set by a modifier called &%set%&. For example:
26851 .code
26852 accept hosts = whatever
26853        set acl_m4 = some value
26854 accept authenticated = *
26855        set acl_c_auth = yes
26856 .endd
26857 &*Note*&: A leading dollar sign is not used when naming a variable that is to
26858 be set. If you want to set a variable without taking any action, you can use a
26859 &%warn%& verb without any other modifiers or conditions.
26860
26861 .oindex &%strict_acl_vars%&
26862 What happens if a syntactically valid but undefined ACL variable is
26863 referenced depends on the setting of the &%strict_acl_vars%& option. If it is
26864 false (the default), an empty string is substituted; if it is true, an
26865 error is generated.
26866
26867 Versions of Exim before 4.64 have a limited set of numbered variables, but
26868 their names are compatible, so there is no problem with upgrading.
26869
26870
26871 .section "Condition and modifier processing" "SECTcondmodproc"
26872 .cindex "&ACL;" "conditions; processing"
26873 .cindex "&ACL;" "modifiers; processing"
26874 An exclamation mark preceding a condition negates its result. For example:
26875 .code
26876 deny   domains = *.dom.example
26877       !verify  = recipient
26878 .endd
26879 causes the ACL to return &"deny"& if the recipient domain ends in
26880 &'dom.example'& and the recipient address cannot be verified. Sometimes
26881 negation can be used on the right-hand side of a condition. For example, these
26882 two statements are equivalent:
26883 .code
26884 deny  hosts = !192.168.3.4
26885 deny !hosts =  192.168.3.4
26886 .endd
26887 However, for many conditions (&%verify%& being a good example), only left-hand
26888 side negation of the whole condition is possible.
26889
26890 The arguments of conditions and modifiers are expanded. A forced failure
26891 of an expansion causes a condition to be ignored, that is, it behaves as if the
26892 condition is true. Consider these two statements:
26893 .code
26894 accept  senders = ${lookup{$host_name}lsearch\
26895                   {/some/file}{$value}fail}
26896 accept  senders = ${lookup{$host_name}lsearch\
26897                   {/some/file}{$value}{}}
26898 .endd
26899 Each attempts to look up a list of acceptable senders. If the lookup succeeds,
26900 the returned list is searched, but if the lookup fails the behaviour is
26901 different in the two cases. The &%fail%& in the first statement causes the
26902 condition to be ignored, leaving no further conditions. The &%accept%& verb
26903 therefore succeeds. The second statement, however, generates an empty list when
26904 the lookup fails. No sender can match an empty list, so the condition fails,
26905 and therefore the &%accept%& also fails.
26906
26907 ACL modifiers appear mixed in with conditions in ACL statements. Some of them
26908 specify actions that are taken as the conditions for a statement are checked;
26909 others specify text for messages that are used when access is denied or a
26910 warning is generated. The &%control%& modifier affects the way an incoming
26911 message is handled.
26912
26913 The positioning of the modifiers in an ACL statement is important, because the
26914 processing of a verb ceases as soon as its outcome is known. Only those
26915 modifiers that have already been encountered will take effect. For example,
26916 consider this use of the &%message%& modifier:
26917 .code
26918 require message = Can't verify sender
26919         verify  = sender
26920         message = Can't verify recipient
26921         verify  = recipient
26922         message = This message cannot be used
26923 .endd
26924 If sender verification fails, Exim knows that the result of the statement is
26925 &"deny"&, so it goes no further. The first &%message%& modifier has been seen,
26926 so its text is used as the error message. If sender verification succeeds, but
26927 recipient verification fails, the second message is used. If recipient
26928 verification succeeds, the third message becomes &"current"&, but is never used
26929 because there are no more conditions to cause failure.
26930
26931 For the &%deny%& verb, on the other hand, it is always the last &%message%&
26932 modifier that is used, because all the conditions must be true for rejection to
26933 happen. Specifying more than one &%message%& modifier does not make sense, and
26934 the message can even be specified after all the conditions. For example:
26935 .code
26936 deny   hosts = ...
26937       !senders = *@my.domain.example
26938        message = Invalid sender from client host
26939 .endd
26940 The &"deny"& result does not happen until the end of the statement is reached,
26941 by which time Exim has set up the message.
26942
26943
26944
26945 .section "ACL modifiers" "SECTACLmodi"
26946 .cindex "&ACL;" "modifiers; list of"
26947 The ACL modifiers are as follows:
26948
26949 .vlist
26950 .vitem &*add_header*&&~=&~<&'text'&>
26951 This modifier specifies one or more header lines that are to be added to an
26952 incoming message, assuming, of course, that the message is ultimately
26953 accepted. For details, see section &<<SECTaddheadacl>>&.
26954
26955 .vitem &*continue*&&~=&~<&'text'&>
26956 .cindex "&%continue%& ACL modifier"
26957 .cindex "database" "updating in ACL"
26958 This modifier does nothing of itself, and processing of the ACL always
26959 continues with the next condition or modifier. The value of &%continue%& is in
26960 the side effects of expanding its argument. Typically this could be used to
26961 update a database. It is really just a syntactic tidiness, to avoid having to
26962 write rather ugly lines like this:
26963 .display
26964 &`condition = ${if eq{0}{`&<&'some expansion'&>&`}{true}{true}}`&
26965 .endd
26966 Instead, all you need is
26967 .display
26968 &`continue = `&<&'some expansion'&>
26969 .endd
26970
26971 .vitem &*control*&&~=&~<&'text'&>
26972 .cindex "&%control%& ACL modifier"
26973 This modifier affects the subsequent processing of the SMTP connection or of an
26974 incoming message that is accepted. The effect of the first type of control
26975 lasts for the duration of the connection, whereas the effect of the second type
26976 lasts only until the current message has been received. The message-specific
26977 controls always apply to the whole message, not to individual recipients,
26978 even if the &%control%& modifier appears in a RCPT ACL.
26979
26980 As there are now quite a few controls that can be applied, they are described
26981 separately in section &<<SECTcontrols>>&. The &%control%& modifier can be used
26982 in several different ways. For example:
26983
26984 . ==== As this is a nested list, any displays it contains must be indented
26985 . ==== as otherwise they are too far to the left. That comment applies only
26986 . ==== when xmlto and fop are used; formatting with sdop gets it right either
26987 . ==== way.
26988
26989 .ilist
26990 It can be at the end of an &%accept%& statement:
26991 .code
26992     accept  ...some conditions
26993             control = queue_only
26994 .endd
26995 In this case, the control is applied when this statement yields &"accept"&, in
26996 other words, when the conditions are all true.
26997
26998 .next
26999 It can be in the middle of an &%accept%& statement:
27000 .code
27001     accept  ...some conditions...
27002             control = queue_only
27003             ...some more conditions...
27004 .endd
27005 If the first set of conditions are true, the control is applied, even if the
27006 statement does not accept because one of the second set of conditions is false.
27007 In this case, some subsequent statement must yield &"accept"& for the control
27008 to be relevant.
27009
27010 .next
27011 It can be used with &%warn%& to apply the control, leaving the
27012 decision about accepting or denying to a subsequent verb. For
27013 example:
27014 .code
27015     warn    ...some conditions...
27016             control = freeze
27017     accept  ...
27018 .endd
27019 This example of &%warn%& does not contain &%message%&, &%log_message%&, or
27020 &%logwrite%&, so it does not add anything to the message and does not write a
27021 log entry.
27022
27023 .next
27024 If you want to apply a control unconditionally, you can use it with a
27025 &%require%& verb. For example:
27026 .code
27027     require  control = no_multiline_responses
27028 .endd
27029 .endlist
27030
27031 .vitem &*delay*&&~=&~<&'time'&>
27032 .cindex "&%delay%& ACL modifier"
27033 .oindex "&%-bh%&"
27034 This modifier may appear in any ACL except notquit. It causes Exim to wait for
27035 the time interval before proceeding. However, when testing Exim using the
27036 &%-bh%& option, the delay is not actually imposed (an appropriate message is
27037 output instead). The time is given in the usual Exim notation, and the delay
27038 happens as soon as the modifier is processed. In an SMTP session, pending
27039 output is flushed before the delay is imposed.
27040
27041 Like &%control%&, &%delay%& can be used with &%accept%& or &%deny%&, for
27042 example:
27043 .code
27044 deny    ...some conditions...
27045         delay = 30s
27046 .endd
27047 The delay happens if all the conditions are true, before the statement returns
27048 &"deny"&. Compare this with:
27049 .code
27050 deny    delay = 30s
27051         ...some conditions...
27052 .endd
27053 which waits for 30s before processing the conditions. The &%delay%& modifier
27054 can also be used with &%warn%& and together with &%control%&:
27055 .code
27056 warn    ...some conditions...
27057         delay = 2m
27058         control = freeze
27059 accept  ...
27060 .endd
27061
27062 If &%delay%& is encountered when the SMTP PIPELINING extension is in use,
27063 responses to several commands are no longer buffered and sent in one packet (as
27064 they would normally be) because all output is flushed before imposing the
27065 delay. This optimization is disabled so that a number of small delays do not
27066 appear to the client as one large aggregated delay that might provoke an
27067 unwanted timeout. You can, however, disable output flushing for &%delay%& by
27068 using a &%control%& modifier to set &%no_delay_flush%&.
27069
27070
27071 .vitem &*endpass*&
27072 .cindex "&%endpass%& ACL modifier"
27073 This modifier, which has no argument, is recognized only in &%accept%& and
27074 &%discard%& statements. It marks the boundary between the conditions whose
27075 failure causes control to pass to the next statement, and the conditions whose
27076 failure causes the ACL to return &"deny"&. This concept has proved to be
27077 confusing to some people, so the use of &%endpass%& is no longer recommended as
27078 &"best practice"&. See the description of &%accept%& above for more details.
27079
27080
27081 .vitem &*log_message*&&~=&~<&'text'&>
27082 .cindex "&%log_message%& ACL modifier"
27083 This modifier sets up a message that is used as part of the log message if the
27084 ACL denies access or a &%warn%& statement's conditions are true. For example:
27085 .code
27086 require log_message = wrong cipher suite $tls_in_cipher
27087         encrypted   = DES-CBC3-SHA
27088 .endd
27089 &%log_message%& is also used when recipients are discarded by &%discard%&. For
27090 example:
27091 .display
27092 &`discard `&<&'some conditions'&>
27093 &`        log_message = Discarded $local_part@$domain because...`&
27094 .endd
27095 When access is denied, &%log_message%& adds to any underlying error message
27096 that may exist because of a condition failure. For example, while verifying a
27097 recipient address, a &':fail:'& redirection might have already set up a
27098 message.
27099
27100 The message may be defined before the conditions to which it applies, because
27101 the string expansion does not happen until Exim decides that access is to be
27102 denied. This means that any variables that are set by the condition are
27103 available for inclusion in the message. For example, the &$dnslist_$&<&'xxx'&>
27104 variables are set after a DNS black list lookup succeeds. If the expansion of
27105 &%log_message%& fails, or if the result is an empty string, the modifier is
27106 ignored.
27107
27108 .vindex "&$acl_verify_message$&"
27109 If you want to use a &%warn%& statement to log the result of an address
27110 verification, you can use &$acl_verify_message$& to include the verification
27111 error message.
27112
27113 If &%log_message%& is used with a &%warn%& statement, &"Warning:"& is added to
27114 the start of the logged message. If the same warning log message is requested
27115 more than once while receiving  a single email message, only one copy is
27116 actually logged. If you want to log multiple copies, use &%logwrite%& instead
27117 of &%log_message%&. In the absence of &%log_message%& and &%logwrite%&, nothing
27118 is logged for a successful &%warn%& statement.
27119
27120 If &%log_message%& is not present and there is no underlying error message (for
27121 example, from the failure of address verification), but &%message%& is present,
27122 the &%message%& text is used for logging rejections. However, if any text for
27123 logging contains newlines, only the first line is logged. In the absence of
27124 both &%log_message%& and &%message%&, a default built-in message is used for
27125 logging rejections.
27126
27127
27128 .vitem "&*log_reject_target*&&~=&~<&'log name list'&>"
27129 .cindex "&%log_reject_target%& ACL modifier"
27130 .cindex "logging in ACL" "specifying which log"
27131 This modifier makes it possible to specify which logs are used for messages
27132 about ACL rejections. Its argument is a colon-separated list of words that can
27133 be &"main"&, &"reject"&, or &"panic"&. The default is &`main:reject`&. The list
27134 may be empty, in which case a rejection is not logged at all. For example, this
27135 ACL fragment writes no logging information when access is denied:
27136 .display
27137 &`deny `&<&'some conditions'&>
27138 &`     log_reject_target =`&
27139 .endd
27140 This modifier can be used in SMTP and non-SMTP ACLs. It applies to both
27141 permanent and temporary rejections. Its effect lasts for the rest of the
27142 current ACL.
27143
27144
27145 .vitem &*logwrite*&&~=&~<&'text'&>
27146 .cindex "&%logwrite%& ACL modifier"
27147 .cindex "logging in ACL" "immediate"
27148 This modifier writes a message to a log file as soon as it is encountered when
27149 processing an ACL. (Compare &%log_message%&, which, except in the case of
27150 &%warn%& and &%discard%&, is used only if the ACL statement denies
27151 access.) The &%logwrite%& modifier can be used to log special incidents in
27152 ACLs. For example:
27153 .display
27154 &`accept `&<&'some special conditions'&>
27155 &`       control  = freeze`&
27156 &`       logwrite = froze message because ...`&
27157 .endd
27158 By default, the message is written to the main log. However, it may begin
27159 with a colon, followed by a comma-separated list of log names, and then
27160 another colon, to specify exactly which logs are to be written. For
27161 example:
27162 .code
27163 logwrite = :main,reject: text for main and reject logs
27164 logwrite = :panic: text for panic log only
27165 .endd
27166
27167
27168 .vitem &*message*&&~=&~<&'text'&>
27169 .cindex "&%message%& ACL modifier"
27170 This modifier sets up a text string that is expanded and used as a response
27171 message when an ACL statement terminates the ACL with an &"accept"&, &"deny"&,
27172 or &"defer"& response. (In the case of the &%accept%& and &%discard%& verbs,
27173 there is some complication if &%endpass%& is involved; see the description of
27174 &%accept%& for details.)
27175
27176 The expansion of the message happens at the time Exim decides that the ACL is
27177 to end, not at the time it processes &%message%&. If the expansion fails, or
27178 generates an empty string, the modifier is ignored. Here is an example where
27179 &%message%& must be specified first, because the ACL ends with a rejection if
27180 the &%hosts%& condition fails:
27181 .code
27182 require  message = Host not recognized
27183          hosts = 10.0.0.0/8
27184 .endd
27185 (Once a condition has failed, no further conditions or modifiers are
27186 processed.)
27187
27188 .cindex "SMTP" "error codes"
27189 .oindex "&%smtp_banner%&
27190 For ACLs that are triggered by SMTP commands, the message is returned as part
27191 of the SMTP response. The use of &%message%& with &%accept%& (or &%discard%&)
27192 is meaningful only for SMTP, as no message is returned when a non-SMTP message
27193 is accepted. In the case of the connect ACL, accepting with a message modifier
27194 overrides the value of &%smtp_banner%&. For the EHLO/HELO ACL, a customized
27195 accept message may not contain more than one line (otherwise it will be
27196 truncated at the first newline and a panic logged), and it cannot affect the
27197 EHLO options.
27198
27199 When SMTP is involved, the message may begin with an overriding response code,
27200 consisting of three digits optionally followed by an &"extended response code"&
27201 of the form &'n.n.n'&, each code being followed by a space. For example:
27202 .code
27203 deny  message = 599 1.2.3 Host not welcome
27204       hosts = 192.168.34.0/24
27205 .endd
27206 The first digit of the supplied response code must be the same as would be sent
27207 by default. A panic occurs if it is not. Exim uses a 550 code when it denies
27208 access, but for the predata ACL, note that the default success code is 354, not
27209 2&'xx'&.
27210
27211 Notwithstanding the previous paragraph, for the QUIT ACL, unlike the others,
27212 the message modifier cannot override the 221 response code.
27213
27214 The text in a &%message%& modifier is literal; any quotes are taken as
27215 literals, but because the string is expanded, backslash escapes are processed
27216 anyway. If the message contains newlines, this gives rise to a multi-line SMTP
27217 response.
27218
27219 .vindex "&$acl_verify_message$&"
27220 If &%message%& is used on a statement that verifies an address, the message
27221 specified overrides any message that is generated by the verification process.
27222 However, the original message is available in the variable
27223 &$acl_verify_message$&, so you can incorporate it into your message if you
27224 wish. In particular, if you want the text from &%:fail:%& items in &(redirect)&
27225 routers to be passed back as part of the SMTP response, you should either not
27226 use a &%message%& modifier, or make use of &$acl_verify_message$&.
27227
27228 For compatibility with previous releases of Exim, a &%message%& modifier that
27229 is used with a &%warn%& verb behaves in a similar way to the &%add_header%&
27230 modifier, but this usage is now deprecated. However, &%message%& acts only when
27231 all the conditions are true, wherever it appears in an ACL command, whereas
27232 &%add_header%& acts as soon as it is encountered. If &%message%& is used with
27233 &%warn%& in an ACL that is not concerned with receiving a message, it has no
27234 effect.
27235
27236
27237 .new
27238 .vitem &*remove_header*&&~=&~<&'text'&>
27239 This modifier specifies one or more header names in a colon-separated list
27240  that are to be removed from an incoming message, assuming, of course, that
27241 the message is ultimately accepted. For details, see section &<<SECTremoveheadacl>>&.
27242 .wen
27243
27244
27245 .vitem &*set*&&~<&'acl_name'&>&~=&~<&'value'&>
27246 .cindex "&%set%& ACL modifier"
27247 This modifier puts a value into one of the ACL variables (see section
27248 &<<SECTaclvariables>>&).
27249
27250
27251 .new
27252 .vitem &*udpsend*&&~=&~<&'parameters'&>
27253 This modifier sends a UDP packet, for purposes such as statistics
27254 collection or behaviour monitoring. The parameters are expanded, and
27255 the result of the expansion must be a colon-separated list consisting
27256 of a destination server, port number, and the packet contents. The
27257 server can be specified as a host name or IPv4 or IPv6 address. The
27258 separator can be changed with the usual angle bracket syntax. For
27259 example, you might want to collect information on which hosts connect
27260 when:
27261 .code
27262 udpsend = <; 2001:dB8::dead:beef ; 1234 ;\
27263              $tod_zulu $sender_host_address
27264 .endd
27265 .wen
27266 .endlist
27267
27268
27269
27270
27271 .section "Use of the control modifier" "SECTcontrols"
27272 .cindex "&%control%& ACL modifier"
27273 The &%control%& modifier supports the following settings:
27274
27275 .vlist
27276 .vitem &*control&~=&~allow_auth_unadvertised*&
27277 This modifier allows a client host to use the SMTP AUTH command even when it
27278 has not been advertised in response to EHLO. Furthermore, because there are
27279 apparently some really broken clients that do this, Exim will accept AUTH after
27280 HELO (rather than EHLO) when this control is set. It should be used only if you
27281 really need it, and you should limit its use to those broken clients that do
27282 not work without it. For example:
27283 .code
27284 warn hosts   = 192.168.34.25
27285      control = allow_auth_unadvertised
27286 .endd
27287 Normally, when an Exim server receives an AUTH command, it checks the name of
27288 the authentication mechanism that is given in the command to ensure that it
27289 matches an advertised mechanism. When this control is set, the check that a
27290 mechanism has been advertised is bypassed. Any configured mechanism can be used
27291 by the client. This control is permitted only in the connection and HELO ACLs.
27292
27293
27294 .vitem &*control&~=&~caseful_local_part*& &&&
27295        &*control&~=&~caselower_local_part*&
27296 .cindex "&ACL;" "case of local part in"
27297 .cindex "case of local parts"
27298 .vindex "&$local_part$&"
27299 These two controls are permitted only in the ACL specified by &%acl_smtp_rcpt%&
27300 (that is, during RCPT processing). By default, the contents of &$local_part$&
27301 are lower cased before ACL processing. If &"caseful_local_part"& is specified,
27302 any uppercase letters in the original local part are restored in &$local_part$&
27303 for the rest of the ACL, or until a control that sets &"caselower_local_part"&
27304 is encountered.
27305
27306 These controls affect only the current recipient. Moreover, they apply only to
27307 local part handling that takes place directly in the ACL (for example, as a key
27308 in lookups). If a test to verify the recipient is obeyed, the case-related
27309 handling of the local part during the verification is controlled by the router
27310 configuration (see the &%caseful_local_part%& generic router option).
27311
27312 This facility could be used, for example, to add a spam score to local parts
27313 containing upper case letters. For example, using &$acl_m4$& to accumulate the
27314 spam score:
27315 .code
27316 warn  control = caseful_local_part
27317       set acl_m4 = ${eval:\
27318                      $acl_m4 + \
27319                      ${if match{$local_part}{[A-Z]}{1}{0}}\
27320                     }
27321       control = caselower_local_part
27322 .endd
27323 Notice that we put back the lower cased version afterwards, assuming that
27324 is what is wanted for subsequent tests.
27325
27326
27327 .new
27328 .vitem &*control&~=&~cutthrough_delivery*&
27329 .cindex "&ACL;" "cutthrough routing"
27330 .cindex "cutthrough" "requesting"
27331 This option requests delivery be attempted while the item is being received.
27332 It is usable in the RCPT ACL and valid only for single-recipient mails forwarded
27333 from one SMTP connection to another.  If a recipient-verify callout connection is
27334 requested in the same ACL it is held open and used for the data, otherwise one is made
27335 after the ACL completes.
27336 .new "Note that routers are used in verify mode."
27337
27338 Should the ultimate destination system positively accept or reject the mail,
27339 a corresponding indication is given to the source system and nothing is queued.
27340 If there is a temporary error the item is queued for later delivery in the
27341 usual fashion. If the item is successfully delivered in cutthrough mode the log line
27342 is tagged with ">>" rather than "=>" and appears before the acceptance "<="
27343 line.
27344
27345 Delivery in this mode avoids the generation of a bounce mail to a (possibly faked)
27346 sender when the destination system is doing content-scan based rejection.
27347 .wen
27348
27349
27350 .new
27351 .vitem &*control&~=&~debug/*&<&'options'&>
27352 .cindex "&ACL;" "enabling debug logging"
27353 .cindex "debugging" "enabling from an ACL"
27354 This control turns on debug logging, almost as though Exim had been invoked
27355 with &`-d`&, with the output going to a new logfile, by default called
27356 &'debuglog'&.  The filename can be adjusted with the &'tag'& option, which
27357 may access any variables already defined.  The logging may be adjusted with
27358 the &'opts'& option, which takes the same values as the &`-d`& command-line
27359 option.  Some examples (which depend on variables that don't exist in all
27360 contexts):
27361 .code
27362       control = debug
27363       control = debug/tag=.$sender_host_address
27364       control = debug/opts=+expand+acl
27365       control = debug/tag=.$message_exim_id/opts=+expand
27366 .endd
27367 .wen
27368
27369
27370 .vitem &*control&~=&~dkim_disable_verify*&
27371 .cindex "disable DKIM verify"
27372 .cindex "DKIM" "disable verify"
27373 This control turns off DKIM verification processing entirely.  For details on
27374 the operation and configuration of DKIM, see chapter &<<CHAPdkim>>&.
27375
27376
27377 .new
27378 .vitem &*control&~=&~dscp/*&<&'value'&>
27379 .cindex "&ACL;" "setting DSCP value"
27380 .cindex "DSCP" "inbound"
27381 This option causes the DSCP value associated with the socket for the inbound
27382 connection to be adjusted to a given value, given as one of a number of fixed
27383 strings or to numeric value.
27384 The &%-bI:dscp%& option may be used to ask Exim which names it knows of.
27385 Common values include &`throughput`&, &`mincost`&, and on newer systems
27386 &`ef`&, &`af41`&, etc.  Numeric values may be in the range 0 to 0x3F.
27387
27388 The outbound packets from Exim will be marked with this value in the header
27389 (for IPv4, the TOS field; for IPv6, the TCLASS field); there is no guarantee
27390 that these values will have any effect, not be stripped by networking
27391 equipment, or do much of anything without cooperation with your Network
27392 Engineer and those of all network operators between the source and destination.
27393 .wen
27394
27395
27396 .vitem &*control&~=&~enforce_sync*& &&&
27397        &*control&~=&~no_enforce_sync*&
27398 .cindex "SMTP" "synchronization checking"
27399 .cindex "synchronization checking in SMTP"
27400 These controls make it possible to be selective about when SMTP synchronization
27401 is enforced. The global option &%smtp_enforce_sync%& specifies the initial
27402 state of the switch (it is true by default). See the description of this option
27403 in chapter &<<CHAPmainconfig>>& for details of SMTP synchronization checking.
27404
27405 The effect of these two controls lasts for the remainder of the SMTP
27406 connection. They can appear in any ACL except the one for the non-SMTP
27407 messages. The most straightforward place to put them is in the ACL defined by
27408 &%acl_smtp_connect%&, which is run at the start of an incoming SMTP connection,
27409 before the first synchronization check. The expected use is to turn off the
27410 synchronization checks for badly-behaved hosts that you nevertheless need to
27411 work with.
27412
27413
27414 .vitem &*control&~=&~fakedefer/*&<&'message'&>
27415 .cindex "fake defer"
27416 .cindex "defer, fake"
27417 This control works in exactly the same way as &%fakereject%& (described below)
27418 except that it causes an SMTP 450 response after the message data instead of a
27419 550 response. You must take care when using &%fakedefer%& because it causes the
27420 messages to be duplicated when the sender retries. Therefore, you should not
27421 use &%fakedefer%& if the message is to be delivered normally.
27422
27423 .vitem &*control&~=&~fakereject/*&<&'message'&>
27424 .cindex "fake rejection"
27425 .cindex "rejection, fake"
27426 This control is permitted only for the MAIL, RCPT, and DATA ACLs, in other
27427 words, only when an SMTP message is being received. If Exim accepts the
27428 message, instead the final 250 response, a 550 rejection message is sent.
27429 However, Exim proceeds to deliver the message as normal. The control applies
27430 only to the current message, not to any subsequent ones that may be received in
27431 the same SMTP connection.
27432
27433 The text for the 550 response is taken from the &%control%& modifier. If no
27434 message is supplied, the following is used:
27435 .code
27436 550-Your message has been rejected but is being
27437 550-kept for evaluation.
27438 550-If it was a legitimate message, it may still be
27439 550 delivered to the target recipient(s).
27440 .endd
27441 This facility should be used with extreme caution.
27442
27443 .vitem &*control&~=&~freeze*&
27444 .cindex "frozen messages" "forcing in ACL"
27445 This control is permitted only for the MAIL, RCPT, DATA, and non-SMTP ACLs, in
27446 other words, only when a message is being received. If the message is accepted,
27447 it is placed on Exim's queue and frozen. The control applies only to the
27448 current message, not to any subsequent ones that may be received in the same
27449 SMTP connection.
27450
27451 This modifier can optionally be followed by &`/no_tell`&. If the global option
27452 &%freeze_tell%& is set, it is ignored for the current message (that is, nobody
27453 is told about the freezing), provided all the &*control=freeze*& modifiers that
27454 are obeyed for the current message have the &`/no_tell`& option.
27455
27456 .vitem &*control&~=&~no_delay_flush*&
27457 .cindex "SMTP" "output flushing, disabling for delay"
27458 Exim normally flushes SMTP output before implementing a delay in an ACL, to
27459 avoid unexpected timeouts in clients when the SMTP PIPELINING extension is in
27460 use. This control, as long as it is encountered before the &%delay%& modifier,
27461 disables such output flushing.
27462
27463 .vitem &*control&~=&~no_callout_flush*&
27464 .cindex "SMTP" "output flushing, disabling for callout"
27465 Exim normally flushes SMTP output before performing a callout in an ACL, to
27466 avoid unexpected timeouts in clients when the SMTP PIPELINING extension is in
27467 use. This control, as long as it is encountered before the &%verify%& condition
27468 that causes the callout, disables such output flushing.
27469
27470 .vitem &*control&~=&~no_mbox_unspool*&
27471 This control is available when Exim is compiled with the content scanning
27472 extension. Content scanning may require a copy of the current message, or parts
27473 of it, to be written in &"mbox format"& to a spool file, for passing to a virus
27474 or spam scanner. Normally, such copies are deleted when they are no longer
27475 needed. If this control is set, the copies are not deleted. The control applies
27476 only to the current message, not to any subsequent ones that may be received in
27477 the same SMTP connection. It is provided for debugging purposes and is unlikely
27478 to be useful in production.
27479
27480 .vitem &*control&~=&~no_multiline_responses*&
27481 .cindex "multiline responses, suppressing"
27482 This control is permitted for any ACL except the one for non-SMTP messages.
27483 It seems that there are broken clients in use that cannot handle multiline
27484 SMTP responses, despite the fact that RFC 821 defined them over 20 years ago.
27485
27486 If this control is set, multiline SMTP responses from ACL rejections are
27487 suppressed. One way of doing this would have been to put out these responses as
27488 one long line. However, RFC 2821 specifies a maximum of 512 bytes per response
27489 (&"use multiline responses for more"& it says &-- ha!), and some of the
27490 responses might get close to that. So this facility, which is after all only a
27491 sop to broken clients, is implemented by doing two very easy things:
27492
27493 .ilist
27494 Extra information that is normally output as part of a rejection caused by
27495 sender verification failure is omitted. Only the final line (typically &"sender
27496 verification failed"&) is sent.
27497 .next
27498 If a &%message%& modifier supplies a multiline response, only the first
27499 line is output.
27500 .endlist
27501
27502 The setting of the switch can, of course, be made conditional on the
27503 calling host. Its effect lasts until the end of the SMTP connection.
27504
27505 .vitem &*control&~=&~no_pipelining*&
27506 .cindex "PIPELINING" "suppressing advertising"
27507 This control turns off the advertising of the PIPELINING extension to SMTP in
27508 the current session. To be useful, it must be obeyed before Exim sends its
27509 response to an EHLO command. Therefore, it should normally appear in an ACL
27510 controlled by &%acl_smtp_connect%& or &%acl_smtp_helo%&. See also
27511 &%pipelining_advertise_hosts%&.
27512
27513 .vitem &*control&~=&~queue_only*&
27514 .oindex "&%queue_only%&"
27515 .cindex "queueing incoming messages"
27516 This control is permitted only for the MAIL, RCPT, DATA, and non-SMTP ACLs, in
27517 other words, only when a message is being received. If the message is accepted,
27518 it is placed on Exim's queue and left there for delivery by a subsequent queue
27519 runner. No immediate delivery process is started. In other words, it has the
27520 effect as the &%queue_only%& global option. However, the control applies only
27521 to the current message, not to any subsequent ones that may be received in the
27522 same SMTP connection.
27523
27524 .vitem &*control&~=&~submission/*&<&'options'&>
27525 .cindex "message" "submission"
27526 .cindex "submission mode"
27527 This control is permitted only for the MAIL, RCPT, and start of data ACLs (the
27528 latter is the one defined by &%acl_smtp_predata%&). Setting it tells Exim that
27529 the current message is a submission from a local MUA. In this case, Exim
27530 operates in &"submission mode"&, and applies certain fixups to the message if
27531 necessary. For example, it adds a &'Date:'& header line if one is not present.
27532 This control is not permitted in the &%acl_smtp_data%& ACL, because that is too
27533 late (the message has already been created).
27534
27535 Chapter &<<CHAPmsgproc>>& describes the processing that Exim applies to
27536 messages. Section &<<SECTsubmodnon>>& covers the processing that happens in
27537 submission mode; the available options for this control are described there.
27538 The control applies only to the current message, not to any subsequent ones
27539 that may be received in the same SMTP connection.
27540
27541 .vitem &*control&~=&~suppress_local_fixups*&
27542 .cindex "submission fixups, suppressing"
27543 This control applies to locally submitted (non TCP/IP) messages, and is the
27544 complement of &`control = submission`&. It disables the fixups that are
27545 normally applied to locally-submitted messages. Specifically:
27546
27547 .ilist
27548 Any &'Sender:'& header line is left alone (in this respect, it is a
27549 dynamic version of &%local_sender_retain%&).
27550 .next
27551 No &'Message-ID:'&, &'From:'&, or &'Date:'& header lines are added.
27552 .next
27553 There is no check that &'From:'& corresponds to the actual sender.
27554 .endlist ilist
27555
27556 This control may be useful when a remotely-originated message is accepted,
27557 passed to some scanning program, and then re-submitted for delivery. It can be
27558 used only in the &%acl_smtp_mail%&, &%acl_smtp_rcpt%&, &%acl_smtp_predata%&,
27559 and &%acl_not_smtp_start%& ACLs, because it has to be set before the message's
27560 data is read.
27561
27562 &*Note:*& This control applies only to the current message, not to any others
27563 that are being submitted at the same time using &%-bs%& or &%-bS%&.
27564 .endlist vlist
27565
27566
27567 .section "Summary of message fixup control" "SECTsummesfix"
27568 All four possibilities for message fixups can be specified:
27569
27570 .ilist
27571 Locally submitted, fixups applied: the default.
27572 .next
27573 Locally submitted, no fixups applied: use
27574 &`control = suppress_local_fixups`&.
27575 .next
27576 Remotely submitted, no fixups applied: the default.
27577 .next
27578 Remotely submitted, fixups applied: use &`control = submission`&.
27579 .endlist
27580
27581
27582
27583 .section "Adding header lines in ACLs" "SECTaddheadacl"
27584 .cindex "header lines" "adding in an ACL"
27585 .cindex "header lines" "position of added lines"
27586 .cindex "&%add_header%& ACL modifier"
27587 The &%add_header%& modifier can be used to add one or more extra header lines
27588 to an incoming message, as in this example:
27589 .code
27590 warn dnslists = sbl.spamhaus.org : \
27591                 dialup.mail-abuse.org
27592      add_header = X-blacklisted-at: $dnslist_domain
27593 .endd
27594 The &%add_header%& modifier is permitted in the MAIL, RCPT, PREDATA, DATA,
27595 MIME, and non-SMTP ACLs (in other words, those that are concerned with
27596 receiving a message). The message must ultimately be accepted for
27597 &%add_header%& to have any significant effect. You can use &%add_header%& with
27598 any ACL verb, including &%deny%& (though this is potentially useful only in a
27599 RCPT ACL).
27600
27601 Leading and trailing newlines are removed from
27602 the data for the &%add_header%& modifier; if it then
27603 contains one or more newlines that
27604 are not followed by a space or a tab, it is assumed to contain multiple header
27605 lines. Each one is checked for valid syntax; &`X-ACL-Warn:`& is added to the
27606 front of any line that is not a valid header line.
27607
27608 Added header lines are accumulated during the MAIL, RCPT, and predata ACLs.
27609 They are added to the message before processing the DATA and MIME ACLs.
27610 However, if an identical header line is requested more than once, only one copy
27611 is actually added to the message. Further header lines may be accumulated
27612 during the DATA and MIME ACLs, after which they are added to the message, again
27613 with duplicates suppressed. Thus, it is possible to add two identical header
27614 lines to an SMTP message, but only if one is added before DATA and one after.
27615 In the case of non-SMTP messages, new headers are accumulated during the
27616 non-SMTP ACLs, and are added to the message after all the ACLs have run. If a
27617 message is rejected after DATA or by the non-SMTP ACL, all added header lines
27618 are included in the entry that is written to the reject log.
27619
27620 .cindex "header lines" "added; visibility of"
27621 Header lines are not visible in string expansions
27622 of message headers
27623 until they are added to the
27624 message. It follows that header lines defined in the MAIL, RCPT, and predata
27625 ACLs are not visible until the DATA ACL and MIME ACLs are run. Similarly,
27626 header lines that are added by the DATA or MIME ACLs are not visible in those
27627 ACLs. Because of this restriction, you cannot use header lines as a way of
27628 passing data between (for example) the MAIL and RCPT ACLs. If you want to do
27629 this, you can use ACL variables, as described in section
27630 &<<SECTaclvariables>>&.
27631
27632 .new
27633 The list of headers yet to be added is given by the &%$headers_added%& variable.
27634 .wen
27635
27636 The &%add_header%& modifier acts immediately as it is encountered during the
27637 processing of an ACL. Notice the difference between these two cases:
27638 .display
27639 &`accept add_header = ADDED: some text`&
27640 &`       `&<&'some condition'&>
27641
27642 &`accept `&<&'some condition'&>
27643 &`       add_header = ADDED: some text`&
27644 .endd
27645 In the first case, the header line is always added, whether or not the
27646 condition is true. In the second case, the header line is added only if the
27647 condition is true. Multiple occurrences of &%add_header%& may occur in the same
27648 ACL statement. All those that are encountered before a condition fails are
27649 honoured.
27650
27651 .cindex "&%warn%& ACL verb"
27652 For compatibility with previous versions of Exim, a &%message%& modifier for a
27653 &%warn%& verb acts in the same way as &%add_header%&, except that it takes
27654 effect only if all the conditions are true, even if it appears before some of
27655 them. Furthermore, only the last occurrence of &%message%& is honoured. This
27656 usage of &%message%& is now deprecated. If both &%add_header%& and &%message%&
27657 are present on a &%warn%& verb, both are processed according to their
27658 specifications.
27659
27660 By default, new header lines are added to a message at the end of the existing
27661 header lines. However, you can specify that any particular header line should
27662 be added right at the start (before all the &'Received:'& lines), immediately
27663 after the first block of &'Received:'& lines, or immediately before any line
27664 that is not a &'Received:'& or &'Resent-something:'& header.
27665
27666 This is done by specifying &":at_start:"&, &":after_received:"&, or
27667 &":at_start_rfc:"& (or, for completeness, &":at_end:"&) before the text of the
27668 header line, respectively. (Header text cannot start with a colon, as there has
27669 to be a header name first.) For example:
27670 .code
27671 warn add_header = \
27672        :after_received:X-My-Header: something or other...
27673 .endd
27674 If more than one header line is supplied in a single &%add_header%& modifier,
27675 each one is treated independently and can therefore be placed differently. If
27676 you add more than one line at the start, or after the Received: block, they end
27677 up in reverse order.
27678
27679 &*Warning*&: This facility currently applies only to header lines that are
27680 added in an ACL. It does NOT work for header lines that are added in a
27681 system filter or in a router or transport.
27682
27683
27684
27685 .new
27686 .section "Removing header lines in ACLs" "SECTremoveheadacl"
27687 .cindex "header lines" "removing in an ACL"
27688 .cindex "header lines" "position of removed lines"
27689 .cindex "&%remove_header%& ACL modifier"
27690 The &%remove_header%& modifier can be used to remove one or more header lines
27691 from an incoming message, as in this example:
27692 .code
27693 warn   message        = Remove internal headers
27694        remove_header  = x-route-mail1 : x-route-mail2
27695 .endd
27696 The &%remove_header%& modifier is permitted in the MAIL, RCPT, PREDATA, DATA,
27697 MIME, and non-SMTP ACLs (in other words, those that are concerned with
27698 receiving a message). The message must ultimately be accepted for
27699 &%remove_header%& to have any significant effect. You can use &%remove_header%&
27700 with any ACL verb, including &%deny%&, though this is really not useful for
27701 any verb that doesn't result in a delivered message.
27702
27703 More than one header can be removed at the same time by using a colon separated
27704 list of header names. The header matching is case insensitive. Wildcards are
27705 not permitted, nor is list expansion performed, so you cannot use hostlists to
27706 create a list of headers, however both connection and message variable expansion
27707 are performed (&%$acl_c_*%& and &%$acl_m_*%&), illustrated in this example:
27708 .code
27709 warn   hosts           = +internal_hosts
27710        set acl_c_ihdrs = x-route-mail1 : x-route-mail2
27711 warn   message         = Remove internal headers
27712        remove_header   = $acl_c_ihdrs
27713 .endd
27714 Removed header lines are accumulated during the MAIL, RCPT, and predata ACLs.
27715 They are removed from the message before processing the DATA and MIME ACLs.
27716 There is no harm in attempting to remove the same header twice nor is removing
27717 a non-existent header. Further header lines to be removed may be accumulated
27718 during the DATA and MIME ACLs, after which they are removed from the message,
27719 if present. In the case of non-SMTP messages, headers to be removed are
27720 accumulated during the non-SMTP ACLs, and are removed from the message after
27721 all the ACLs have run. If a message is rejected after DATA or by the non-SMTP
27722 ACL, there really is no effect because there is no logging of what headers
27723 would have been removed.
27724
27725 .cindex "header lines" "removed; visibility of"
27726 Header lines are not visible in string expansions until the DATA phase when it
27727 is received. Any header lines removed in the MAIL, RCPT, and predata ACLs are
27728 not visible in the DATA ACL and MIME ACLs. Similarly, header lines that are
27729 removed by the DATA or MIME ACLs are still visible in those ACLs. Because of
27730 this restriction, you cannot use header lines as a way of controlling data
27731 passed between (for example) the MAIL and RCPT ACLs. If you want to do this,
27732 you should instead use ACL variables, as described in section
27733 &<<SECTaclvariables>>&.
27734
27735 The &%remove_header%& modifier acts immediately as it is encountered during the
27736 processing of an ACL. Notice the difference between these two cases:
27737 .display
27738 &`accept remove_header = X-Internal`&
27739 &`       `&<&'some condition'&>
27740
27741 &`accept `&<&'some condition'&>
27742 &`       remove_header = X-Internal`&
27743 .endd
27744 In the first case, the header line is always removed, whether or not the
27745 condition is true. In the second case, the header line is removed only if the
27746 condition is true. Multiple occurrences of &%remove_header%& may occur in the
27747 same ACL statement. All those that are encountered before a condition fails
27748 are honoured.
27749
27750 &*Warning*&: This facility currently applies only to header lines that are
27751 present during ACL processing. It does NOT remove header lines that are added
27752 in a system filter or in a router or transport.
27753 .wen
27754
27755
27756
27757
27758 .section "ACL conditions" "SECTaclconditions"
27759 .cindex "&ACL;" "conditions; list of"
27760 Some of the conditions listed in this section are available only when Exim is
27761 compiled with the content-scanning extension. They are included here briefly
27762 for completeness. More detailed descriptions can be found in the discussion on
27763 content scanning in chapter &<<CHAPexiscan>>&.
27764
27765 Not all conditions are relevant in all circumstances. For example, testing
27766 senders and recipients does not make sense in an ACL that is being run as the
27767 result of the arrival of an ETRN command, and checks on message headers can be
27768 done only in the ACLs specified by &%acl_smtp_data%& and &%acl_not_smtp%&. You
27769 can use the same condition (with different parameters) more than once in the
27770 same ACL statement. This provides a way of specifying an &"and"& conjunction.
27771 The conditions are as follows:
27772
27773
27774 .vlist
27775 .vitem &*acl&~=&~*&<&'name&~of&~acl&~or&~ACL&~string&~or&~file&~name&~'&>
27776 .cindex "&ACL;" "nested"
27777 .cindex "&ACL;" "indirect"
27778 .cindex "&ACL;" "arguments"
27779 .cindex "&%acl%& ACL condition"
27780 The possible values of the argument are the same as for the
27781 &%acl_smtp_%&&'xxx'& options. The named or inline ACL is run. If it returns
27782 &"accept"& the condition is true; if it returns &"deny"& the condition is
27783 false. If it returns &"defer"&, the current ACL returns &"defer"& unless the
27784 condition is on a &%warn%& verb. In that case, a &"defer"& return makes the
27785 condition false. This means that further processing of the &%warn%& verb
27786 ceases, but processing of the ACL continues.
27787
27788 .new
27789 If the argument is a named ACL, up to nine space-separated optional values
27790 can be appended; they appear within the called ACL in $acl_arg1 to $acl_arg9,
27791 and $acl_narg is set to the count of values.
27792 Previous values of these variables are restored after the call returns.
27793 The name and values are expanded separately.
27794 .wen
27795
27796 If the nested &%acl%& returns &"drop"& and the outer condition denies access,
27797 the connection is dropped. If it returns &"discard"&, the verb must be
27798 &%accept%& or &%discard%&, and the action is taken immediately &-- no further
27799 conditions are tested.
27800
27801 ACLs may be nested up to 20 deep; the limit exists purely to catch runaway
27802 loops. This condition allows you to use different ACLs in different
27803 circumstances. For example, different ACLs can be used to handle RCPT commands
27804 for different local users or different local domains.
27805
27806 .vitem &*authenticated&~=&~*&<&'string&~list'&>
27807 .cindex "&%authenticated%& ACL condition"
27808 .cindex "authentication" "ACL checking"
27809 .cindex "&ACL;" "testing for authentication"
27810 If the SMTP connection is not authenticated, the condition is false. Otherwise,
27811 the name of the authenticator is tested against the list. To test for
27812 authentication by any authenticator, you can set
27813 .code
27814 authenticated = *
27815 .endd
27816
27817 .vitem &*condition&~=&~*&<&'string'&>
27818 .cindex "&%condition%& ACL condition"
27819 .cindex "customizing" "ACL condition"
27820 .cindex "&ACL;" "customized test"
27821 .cindex "&ACL;" "testing, customized"
27822 This feature allows you to make up custom conditions. If the result of
27823 expanding the string is an empty string, the number zero, or one of the strings
27824 &"no"& or &"false"&, the condition is false. If the result is any non-zero
27825 number, or one of the strings &"yes"& or &"true"&, the condition is true. For
27826 any other value, some error is assumed to have occurred, and the ACL returns
27827 &"defer"&. However, if the expansion is forced to fail, the condition is
27828 ignored. The effect is to treat it as true, whether it is positive or
27829 negative.
27830
27831 .vitem &*decode&~=&~*&<&'location'&>
27832 .cindex "&%decode%& ACL condition"
27833 This condition is available only when Exim is compiled with the
27834 content-scanning extension, and it is allowed only in the ACL defined by
27835 &%acl_smtp_mime%&. It causes the current MIME part to be decoded into a file.
27836 If all goes well, the condition is true. It is false only if there are
27837 problems such as a syntax error or a memory shortage. For more details, see
27838 chapter &<<CHAPexiscan>>&.
27839
27840 .vitem &*demime&~=&~*&<&'extension&~list'&>
27841 .cindex "&%demime%& ACL condition"
27842 This condition is available only when Exim is compiled with the
27843 content-scanning extension. Its use is described in section
27844 &<<SECTdemimecond>>&.
27845
27846 .vitem &*dnslists&~=&~*&<&'list&~of&~domain&~names&~and&~other&~data'&>
27847 .cindex "&%dnslists%& ACL condition"
27848 .cindex "DNS list" "in ACL"
27849 .cindex "black list (DNS)"
27850 .cindex "&ACL;" "testing a DNS list"
27851 This condition checks for entries in DNS black lists. These are also known as
27852 &"RBL lists"&, after the original Realtime Blackhole List, but note that the
27853 use of the lists at &'mail-abuse.org'& now carries a charge. There are too many
27854 different variants of this condition to describe briefly here. See sections
27855 &<<SECTmorednslists>>&&--&<<SECTmorednslistslast>>& for details.
27856
27857 .vitem &*domains&~=&~*&<&'domain&~list'&>
27858 .cindex "&%domains%& ACL condition"
27859 .cindex "domain" "ACL checking"
27860 .cindex "&ACL;" "testing a recipient domain"
27861 .vindex "&$domain_data$&"
27862 This condition is relevant only after a RCPT command. It checks that the domain
27863 of the recipient address is in the domain list. If percent-hack processing is
27864 enabled, it is done before this test is done. If the check succeeds with a
27865 lookup, the result of the lookup is placed in &$domain_data$& until the next
27866 &%domains%& test.
27867
27868 &*Note carefully*& (because many people seem to fall foul of this): you cannot
27869 use &%domains%& in a DATA ACL.
27870
27871
27872 .vitem &*encrypted&~=&~*&<&'string&~list'&>
27873 .cindex "&%encrypted%& ACL condition"
27874 .cindex "encryption" "checking in an ACL"
27875 .cindex "&ACL;" "testing for encryption"
27876 If the SMTP connection is not encrypted, the condition is false. Otherwise, the
27877 name of the cipher suite in use is tested against the list. To test for
27878 encryption without testing for any specific cipher suite(s), set
27879 .code
27880 encrypted = *
27881 .endd
27882
27883
27884 .vitem &*hosts&~=&~*&<&'host&~list'&>
27885 .cindex "&%hosts%& ACL condition"
27886 .cindex "host" "ACL checking"
27887 .cindex "&ACL;" "testing the client host"
27888 This condition tests that the calling host matches the host list. If you have
27889 name lookups or wildcarded host names and IP addresses in the same host list,
27890 you should normally put the IP addresses first. For example, you could have:
27891 .code
27892 accept hosts = 10.9.8.7 : dbm;/etc/friendly/hosts
27893 .endd
27894 The lookup in this example uses the host name for its key. This is implied by
27895 the lookup type &"dbm"&. (For a host address lookup you would use &"net-dbm"&
27896 and it wouldn't matter which way round you had these two items.)
27897
27898 The reason for the problem with host names lies in the left-to-right way that
27899 Exim processes lists. It can test IP addresses without doing any DNS lookups,
27900 but when it reaches an item that requires a host name, it fails if it cannot
27901 find a host name to compare with the pattern. If the above list is given in the
27902 opposite order, the &%accept%& statement fails for a host whose name cannot be
27903 found, even if its IP address is 10.9.8.7.
27904
27905 If you really do want to do the name check first, and still recognize the IP
27906 address even if the name lookup fails, you can rewrite the ACL like this:
27907 .code
27908 accept hosts = dbm;/etc/friendly/hosts
27909 accept hosts = 10.9.8.7
27910 .endd
27911 The default action on failing to find the host name is to assume that the host
27912 is not in the list, so the first &%accept%& statement fails. The second
27913 statement can then check the IP address.
27914
27915 .vindex "&$host_data$&"
27916 If a &%hosts%& condition is satisfied by means of a lookup, the result
27917 of the lookup is made available in the &$host_data$& variable. This
27918 allows you, for example, to set up a statement like this:
27919 .code
27920 deny  hosts = net-lsearch;/some/file
27921 message = $host_data
27922 .endd
27923 which gives a custom error message for each denied host.
27924
27925 .vitem &*local_parts&~=&~*&<&'local&~part&~list'&>
27926 .cindex "&%local_parts%& ACL condition"
27927 .cindex "local part" "ACL checking"
27928 .cindex "&ACL;" "testing a local part"
27929 .vindex "&$local_part_data$&"
27930 This condition is relevant only after a RCPT command. It checks that the local
27931 part of the recipient address is in the list. If percent-hack processing is
27932 enabled, it is done before this test. If the check succeeds with a lookup, the
27933 result of the lookup is placed in &$local_part_data$&, which remains set until
27934 the next &%local_parts%& test.
27935
27936 .vitem &*malware&~=&~*&<&'option'&>
27937 .cindex "&%malware%& ACL condition"
27938 .cindex "&ACL;" "virus scanning"
27939 .cindex "&ACL;" "scanning for viruses"
27940 This condition is available only when Exim is compiled with the
27941 content-scanning extension. It causes the incoming message to be scanned for
27942 viruses. For details, see chapter &<<CHAPexiscan>>&.
27943
27944 .vitem &*mime_regex&~=&~*&<&'list&~of&~regular&~expressions'&>
27945 .cindex "&%mime_regex%& ACL condition"
27946 .cindex "&ACL;" "testing by regex matching"
27947 This condition is available only when Exim is compiled with the
27948 content-scanning extension, and it is allowed only in the ACL defined by
27949 &%acl_smtp_mime%&. It causes the current MIME part to be scanned for a match
27950 with any of the regular expressions. For details, see chapter
27951 &<<CHAPexiscan>>&.
27952
27953 .vitem &*ratelimit&~=&~*&<&'parameters'&>
27954 .cindex "rate limiting"
27955 This condition can be used to limit the rate at which a user or host submits
27956 messages. Details are given in section &<<SECTratelimiting>>&.
27957
27958 .vitem &*recipients&~=&~*&<&'address&~list'&>
27959 .cindex "&%recipients%& ACL condition"
27960 .cindex "recipient" "ACL checking"
27961 .cindex "&ACL;" "testing a recipient"
27962 This condition is relevant only after a RCPT command. It checks the entire
27963 recipient address against a list of recipients.
27964
27965 .vitem &*regex&~=&~*&<&'list&~of&~regular&~expressions'&>
27966 .cindex "&%regex%& ACL condition"
27967 .cindex "&ACL;" "testing by regex matching"
27968 This condition is available only when Exim is compiled with the
27969 content-scanning extension, and is available only in the DATA, MIME, and
27970 non-SMTP ACLs. It causes the incoming message to be scanned for a match with
27971 any of the regular expressions. For details, see chapter &<<CHAPexiscan>>&.
27972
27973 .vitem &*sender_domains&~=&~*&<&'domain&~list'&>
27974 .cindex "&%sender_domains%& ACL condition"
27975 .cindex "sender" "ACL checking"
27976 .cindex "&ACL;" "testing a sender domain"
27977 .vindex "&$domain$&"
27978 .vindex "&$sender_address_domain$&"
27979 This condition tests the domain of the sender of the message against the given
27980 domain list. &*Note*&: The domain of the sender address is in
27981 &$sender_address_domain$&. It is &'not'& put in &$domain$& during the testing
27982 of this condition. This is an exception to the general rule for testing domain
27983 lists. It is done this way so that, if this condition is used in an ACL for a
27984 RCPT command, the recipient's domain (which is in &$domain$&) can be used to
27985 influence the sender checking.
27986
27987 &*Warning*&: It is a bad idea to use this condition on its own as a control on
27988 relaying, because sender addresses are easily, and commonly, forged.
27989
27990 .vitem &*senders&~=&~*&<&'address&~list'&>
27991 .cindex "&%senders%& ACL condition"
27992 .cindex "sender" "ACL checking"
27993 .cindex "&ACL;" "testing a sender"
27994 This condition tests the sender of the message against the given list. To test
27995 for a bounce message, which has an empty sender, set
27996 .code
27997 senders = :
27998 .endd
27999 &*Warning*&: It is a bad idea to use this condition on its own as a control on
28000 relaying, because sender addresses are easily, and commonly, forged.
28001
28002 .vitem &*spam&~=&~*&<&'username'&>
28003 .cindex "&%spam%& ACL condition"
28004 .cindex "&ACL;" "scanning for spam"
28005 This condition is available only when Exim is compiled with the
28006 content-scanning extension. It causes the incoming message to be scanned by
28007 SpamAssassin. For details, see chapter &<<CHAPexiscan>>&.
28008
28009 .vitem &*verify&~=&~certificate*&
28010 .cindex "&%verify%& ACL condition"
28011 .cindex "TLS" "client certificate verification"
28012 .cindex "certificate" "verification of client"
28013 .cindex "&ACL;" "certificate verification"
28014 .cindex "&ACL;" "testing a TLS certificate"
28015 This condition is true in an SMTP session if the session is encrypted, and a
28016 certificate was received from the client, and the certificate was verified. The
28017 server requests a certificate only if the client matches &%tls_verify_hosts%&
28018 or &%tls_try_verify_hosts%& (see chapter &<<CHAPTLS>>&).
28019
28020 .vitem &*verify&~=&~csa*&
28021 .cindex "CSA verification"
28022 This condition checks whether the sending host (the client) is authorized to
28023 send email. Details of how this works are given in section
28024 &<<SECTverifyCSA>>&.
28025
28026 .vitem &*verify&~=&~header_sender/*&<&'options'&>
28027 .cindex "&%verify%& ACL condition"
28028 .cindex "&ACL;" "verifying sender in the header"
28029 .cindex "header lines" "verifying the sender in"
28030 .cindex "sender" "verifying in header"
28031 .cindex "verifying" "sender in header"
28032 This condition is relevant only in an ACL that is run after a message has been
28033 received, that is, in an ACL specified by &%acl_smtp_data%& or
28034 &%acl_not_smtp%&. It checks that there is a verifiable address in at least one
28035 of the &'Sender:'&, &'Reply-To:'&, or &'From:'& header lines. Such an address
28036 is loosely thought of as a &"sender"& address (hence the name of the test).
28037 However, an address that appears in one of these headers need not be an address
28038 that accepts bounce messages; only sender addresses in envelopes are required
28039 to accept bounces. Therefore, if you use the callout option on this check, you
28040 might want to arrange for a non-empty address in the MAIL command.
28041
28042 Details of address verification and the options are given later, starting at
28043 section &<<SECTaddressverification>>& (callouts are described in section
28044 &<<SECTcallver>>&). You can combine this condition with the &%senders%&
28045 condition to restrict it to bounce messages only:
28046 .code
28047 deny    senders = :
28048         message = A valid sender header is required for bounces
28049        !verify  = header_sender
28050 .endd
28051
28052 .vitem &*verify&~=&~header_syntax*&
28053 .cindex "&%verify%& ACL condition"
28054 .cindex "&ACL;" "verifying header syntax"
28055 .cindex "header lines" "verifying syntax"
28056 .cindex "verifying" "header syntax"
28057 This condition is relevant only in an ACL that is run after a message has been
28058 received, that is, in an ACL specified by &%acl_smtp_data%& or
28059 &%acl_not_smtp%&. It checks the syntax of all header lines that can contain
28060 lists of addresses (&'Sender:'&, &'From:'&, &'Reply-To:'&, &'To:'&, &'Cc:'&,
28061 and &'Bcc:'&). Unqualified addresses (local parts without domains) are
28062 permitted only in locally generated messages and from hosts that match
28063 &%sender_unqualified_hosts%& or &%recipient_unqualified_hosts%&, as
28064 appropriate.
28065
28066 Note that this condition is a syntax check only. However, a common spamming
28067 ploy used to be to send syntactically invalid headers such as
28068 .code
28069 To: @
28070 .endd
28071 and this condition can be used to reject such messages, though they are not as
28072 common as they used to be.
28073
28074 .vitem &*verify&~=&~helo*&
28075 .cindex "&%verify%& ACL condition"
28076 .cindex "&ACL;" "verifying HELO/EHLO"
28077 .cindex "HELO" "verifying"
28078 .cindex "EHLO" "verifying"
28079 .cindex "verifying" "EHLO"
28080 .cindex "verifying" "HELO"
28081 This condition is true if a HELO or EHLO command has been received from the
28082 client host, and its contents have been verified. If there has been no previous
28083 attempt to verify the HELO/EHLO contents, it is carried out when this
28084 condition is encountered. See the description of the &%helo_verify_hosts%& and
28085 &%helo_try_verify_hosts%& options for details of how to request verification
28086 independently of this condition.
28087
28088 For SMTP input that does not come over TCP/IP (the &%-bs%& command line
28089 option), this condition is always true.
28090
28091
28092 .vitem &*verify&~=&~not_blind*&
28093 .cindex "verifying" "not blind"
28094 .cindex "bcc recipients, verifying none"
28095 This condition checks that there are no blind (bcc) recipients in the message.
28096 Every envelope recipient must appear either in a &'To:'& header line or in a
28097 &'Cc:'& header line for this condition to be true. Local parts are checked
28098 case-sensitively; domains are checked case-insensitively. If &'Resent-To:'& or
28099 &'Resent-Cc:'& header lines exist, they are also checked. This condition can be
28100 used only in a DATA or non-SMTP ACL.
28101
28102 There are, of course, many legitimate messages that make use of blind (bcc)
28103 recipients. This check should not be used on its own for blocking messages.
28104
28105
28106 .vitem &*verify&~=&~recipient/*&<&'options'&>
28107 .cindex "&%verify%& ACL condition"
28108 .cindex "&ACL;" "verifying recipient"
28109 .cindex "recipient" "verifying"
28110 .cindex "verifying" "recipient"
28111 .vindex "&$address_data$&"
28112 This condition is relevant only after a RCPT command. It verifies the current
28113 recipient. Details of address verification are given later, starting at section
28114 &<<SECTaddressverification>>&. After a recipient has been verified, the value
28115 of &$address_data$& is the last value that was set while routing the address.
28116 This applies even if the verification fails. When an address that is being
28117 verified is redirected to a single address, verification continues with the new
28118 address, and in that case, the subsequent value of &$address_data$& is the
28119 value for the child address.
28120
28121 .vitem &*verify&~=&~reverse_host_lookup*&
28122 .cindex "&%verify%& ACL condition"
28123 .cindex "&ACL;" "verifying host reverse lookup"
28124 .cindex "host" "verifying reverse lookup"
28125 This condition ensures that a verified host name has been looked up from the IP
28126 address of the client host. (This may have happened already if the host name
28127 was needed for checking a host list, or if the host matched &%host_lookup%&.)
28128 Verification ensures that the host name obtained from a reverse DNS lookup, or
28129 one of its aliases, does, when it is itself looked up in the DNS, yield the
28130 original IP address.
28131
28132 If this condition is used for a locally generated message (that is, when there
28133 is no client host involved), it always succeeds.
28134
28135 .vitem &*verify&~=&~sender/*&<&'options'&>
28136 .cindex "&%verify%& ACL condition"
28137 .cindex "&ACL;" "verifying sender"
28138 .cindex "sender" "verifying"
28139 .cindex "verifying" "sender"
28140 This condition is relevant only after a MAIL or RCPT command, or after a
28141 message has been received (the &%acl_smtp_data%& or &%acl_not_smtp%& ACLs). If
28142 the message's sender is empty (that is, this is a bounce message), the
28143 condition is true. Otherwise, the sender address is verified.
28144
28145 .vindex "&$address_data$&"
28146 .vindex "&$sender_address_data$&"
28147 If there is data in the &$address_data$& variable at the end of routing, its
28148 value is placed in &$sender_address_data$& at the end of verification. This
28149 value can be used in subsequent conditions and modifiers in the same ACL
28150 statement. It does not persist after the end of the current statement. If you
28151 want to preserve the value for longer, you can save it in an ACL variable.
28152
28153 Details of verification are given later, starting at section
28154 &<<SECTaddressverification>>&. Exim caches the result of sender verification,
28155 to avoid doing it more than once per message.
28156
28157 .vitem &*verify&~=&~sender=*&<&'address'&>&*/*&<&'options'&>
28158 .cindex "&%verify%& ACL condition"
28159 This is a variation of the previous option, in which a modified address is
28160 verified as a sender.
28161 .endlist
28162
28163
28164
28165 .section "Using DNS lists" "SECTmorednslists"
28166 .cindex "DNS list" "in ACL"
28167 .cindex "black list (DNS)"
28168 .cindex "&ACL;" "testing a DNS list"
28169 In its simplest form, the &%dnslists%& condition tests whether the calling host
28170 is on at least one of a number of DNS lists by looking up the inverted IP
28171 address in one or more DNS domains. (Note that DNS list domains are not mail
28172 domains, so the &`+`& syntax for named lists doesn't work - it is used for
28173 special options instead.) For example, if the calling host's IP
28174 address is 192.168.62.43, and the ACL statement is
28175 .code
28176 deny dnslists = blackholes.mail-abuse.org : \
28177                 dialups.mail-abuse.org
28178 .endd
28179 the following records are looked up:
28180 .code
28181 43.62.168.192.blackholes.mail-abuse.org
28182 43.62.168.192.dialups.mail-abuse.org
28183 .endd
28184 As soon as Exim finds an existing DNS record, processing of the list stops.
28185 Thus, multiple entries on the list provide an &"or"& conjunction. If you want
28186 to test that a host is on more than one list (an &"and"& conjunction), you can
28187 use two separate conditions:
28188 .code
28189 deny dnslists = blackholes.mail-abuse.org
28190      dnslists = dialups.mail-abuse.org
28191 .endd
28192 If a DNS lookup times out or otherwise fails to give a decisive answer, Exim
28193 behaves as if the host does not match the list item, that is, as if the DNS
28194 record does not exist. If there are further items in the DNS list, they are
28195 processed.
28196
28197 This is usually the required action when &%dnslists%& is used with &%deny%&
28198 (which is the most common usage), because it prevents a DNS failure from
28199 blocking mail. However, you can change this behaviour by putting one of the
28200 following special items in the list:
28201 .display
28202 &`+include_unknown `&   behave as if the item is on the list
28203 &`+exclude_unknown `&   behave as if the item is not on the list (default)
28204 &`+defer_unknown   `&   give a temporary error
28205 .endd
28206 .cindex "&`+include_unknown`&"
28207 .cindex "&`+exclude_unknown`&"
28208 .cindex "&`+defer_unknown`&"
28209 Each of these applies to any subsequent items on the list. For example:
28210 .code
28211 deny dnslists = +defer_unknown : foo.bar.example
28212 .endd
28213 Testing the list of domains stops as soon as a match is found. If you want to
28214 warn for one list and block for another, you can use two different statements:
28215 .code
28216 deny  dnslists = blackholes.mail-abuse.org
28217 warn  message  = X-Warn: sending host is on dialups list
28218       dnslists = dialups.mail-abuse.org
28219 .endd
28220 DNS list lookups are cached by Exim for the duration of the SMTP session,
28221 so a lookup based on the IP address is done at most once for any incoming
28222 connection. Exim does not share information between multiple incoming
28223 connections (but your local name server cache should be active).
28224
28225
28226
28227 .section "Specifying the IP address for a DNS list lookup" "SECID201"
28228 .cindex "DNS list" "keyed by explicit IP address"
28229 By default, the IP address that is used in a DNS list lookup is the IP address
28230 of the calling host. However, you can specify another IP address by listing it
28231 after the domain name, introduced by a slash. For example:
28232 .code
28233 deny dnslists = black.list.tld/192.168.1.2
28234 .endd
28235 This feature is not very helpful with explicit IP addresses; it is intended for
28236 use with IP addresses that are looked up, for example, the IP addresses of the
28237 MX hosts or nameservers of an email sender address. For an example, see section
28238 &<<SECTmulkeyfor>>& below.
28239
28240
28241
28242
28243 .section "DNS lists keyed on domain names" "SECID202"
28244 .cindex "DNS list" "keyed by domain name"
28245 There are some lists that are keyed on domain names rather than inverted IP
28246 addresses (see for example the &'domain based zones'& link at
28247 &url(http://www.rfc-ignorant.org/)). No reversing of components is used
28248 with these lists. You can change the name that is looked up in a DNS list by
28249 listing it after the domain name, introduced by a slash. For example,
28250 .code
28251 deny  message  = Sender's domain is listed at $dnslist_domain
28252       dnslists = dsn.rfc-ignorant.org/$sender_address_domain
28253 .endd
28254 This particular example is useful only in ACLs that are obeyed after the
28255 RCPT or DATA commands, when a sender address is available. If (for
28256 example) the message's sender is &'user@tld.example'& the name that is looked
28257 up by this example is
28258 .code
28259 tld.example.dsn.rfc-ignorant.org
28260 .endd
28261 A single &%dnslists%& condition can contain entries for both names and IP
28262 addresses. For example:
28263 .code
28264 deny dnslists = sbl.spamhaus.org : \
28265                 dsn.rfc-ignorant.org/$sender_address_domain
28266 .endd
28267 The first item checks the sending host's IP address; the second checks a domain
28268 name. The whole condition is true if either of the DNS lookups succeeds.
28269
28270
28271
28272
28273 .section "Multiple explicit keys for a DNS list" "SECTmulkeyfor"
28274 .cindex "DNS list" "multiple keys for"
28275 The syntax described above for looking up explicitly-defined values (either
28276 names or IP addresses) in a DNS blacklist is a simplification. After the domain
28277 name for the DNS list, what follows the slash can in fact be a list of items.
28278 As with all lists in Exim, the default separator is a colon. However, because
28279 this is a sublist within the list of DNS blacklist domains, it is necessary
28280 either to double the separators like this:
28281 .code
28282 dnslists = black.list.tld/name.1::name.2
28283 .endd
28284 or to change the separator character, like this:
28285 .code
28286 dnslists = black.list.tld/<;name.1;name.2
28287 .endd
28288 If an item in the list is an IP address, it is inverted before the DNS
28289 blacklist domain is appended. If it is not an IP address, no inversion
28290 occurs. Consider this condition:
28291 .code
28292 dnslists = black.list.tld/<;192.168.1.2;a.domain
28293 .endd
28294 The DNS lookups that occur are:
28295 .code
28296 2.1.168.192.black.list.tld
28297 a.domain.black.list.tld
28298 .endd
28299 Once a DNS record has been found (that matches a specific IP return
28300 address, if specified &-- see section &<<SECTaddmatcon>>&), no further lookups
28301 are done. If there is a temporary DNS error, the rest of the sublist of domains
28302 or IP addresses is tried. A temporary error for the whole dnslists item occurs
28303 only if no other DNS lookup in this sublist succeeds. In other words, a
28304 successful lookup for any of the items in the sublist overrides a temporary
28305 error for a previous item.
28306
28307 The ability to supply a list of items after the slash is in some sense just a
28308 syntactic convenience. These two examples have the same effect:
28309 .code
28310 dnslists = black.list.tld/a.domain : black.list.tld/b.domain
28311 dnslists = black.list.tld/a.domain::b.domain
28312 .endd
28313 However, when the data for the list is obtained from a lookup, the second form
28314 is usually much more convenient. Consider this example:
28315 .code
28316 deny message  = The mail servers for the domain \
28317                 $sender_address_domain \
28318                 are listed at $dnslist_domain ($dnslist_value); \
28319                 see $dnslist_text.
28320      dnslists = sbl.spamhaus.org/<|${lookup dnsdb {>|a=<|\
28321                                    ${lookup dnsdb {>|mxh=\
28322                                    $sender_address_domain} }} }
28323 .endd
28324 Note the use of &`>|`& in the dnsdb lookup to specify the separator for
28325 multiple DNS records. The inner dnsdb lookup produces a list of MX hosts
28326 and the outer dnsdb lookup finds the IP addresses for these hosts. The result
28327 of expanding the condition might be something like this:
28328 .code
28329 dnslists = sbl.spahmaus.org/<|192.168.2.3|192.168.5.6|...
28330 .endd
28331 Thus, this example checks whether or not the IP addresses of the sender
28332 domain's mail servers are on the Spamhaus black list.
28333
28334 The key that was used for a successful DNS list lookup is put into the variable
28335 &$dnslist_matched$& (see section &<<SECID204>>&).
28336
28337
28338
28339
28340 .section "Data returned by DNS lists" "SECID203"
28341 .cindex "DNS list" "data returned from"
28342 DNS lists are constructed using address records in the DNS. The original RBL
28343 just used the address 127.0.0.1 on the right hand side of each record, but the
28344 RBL+ list and some other lists use a number of values with different meanings.
28345 The values used on the RBL+ list are:
28346 .display
28347 127.1.0.1  RBL
28348 127.1.0.2  DUL
28349 127.1.0.3  DUL and RBL
28350 127.1.0.4  RSS
28351 127.1.0.5  RSS and RBL
28352 127.1.0.6  RSS and DUL
28353 127.1.0.7  RSS and DUL and RBL
28354 .endd
28355 Section &<<SECTaddmatcon>>& below describes how you can distinguish between
28356 different values. Some DNS lists may return more than one address record;
28357 see section &<<SECThanmuldnsrec>>& for details of how they are checked.
28358
28359
28360 .section "Variables set from DNS lists" "SECID204"
28361 .cindex "expansion" "variables, set from DNS list"
28362 .cindex "DNS list" "variables set from"
28363 .vindex "&$dnslist_domain$&"
28364 .vindex "&$dnslist_matched$&"
28365 .vindex "&$dnslist_text$&"
28366 .vindex "&$dnslist_value$&"
28367 When an entry is found in a DNS list, the variable &$dnslist_domain$& contains
28368 the name of the overall domain that matched (for example,
28369 &`spamhaus.example`&), &$dnslist_matched$& contains the key within that domain
28370 (for example, &`192.168.5.3`&), and &$dnslist_value$& contains the data from
28371 the DNS record. When the key is an IP address, it is not reversed in
28372 &$dnslist_matched$& (though it is, of course, in the actual lookup). In simple
28373 cases, for example:
28374 .code
28375 deny dnslists = spamhaus.example
28376 .endd
28377 the key is also available in another variable (in this case,
28378 &$sender_host_address$&). In more complicated cases, however, this is not true.
28379 For example, using a data lookup (as described in section &<<SECTmulkeyfor>>&)
28380 might generate a dnslists lookup like this:
28381 .code
28382 deny dnslists = spamhaus.example/<|192.168.1.2|192.168.6.7|...
28383 .endd
28384 If this condition succeeds, the value in &$dnslist_matched$& might be
28385 &`192.168.6.7`& (for example).
28386
28387 If more than one address record is returned by the DNS lookup, all the IP
28388 addresses are included in &$dnslist_value$&, separated by commas and spaces.
28389 The variable &$dnslist_text$& contains the contents of any associated TXT
28390 record. For lists such as RBL+ the TXT record for a merged entry is often not
28391 very meaningful. See section &<<SECTmordetinf>>& for a way of obtaining more
28392 information.
28393
28394 You can use the DNS list variables in &%message%& or &%log_message%& modifiers
28395 &-- although these appear before the condition in the ACL, they are not
28396 expanded until after it has failed. For example:
28397 .code
28398 deny    hosts = !+local_networks
28399         message = $sender_host_address is listed \
28400                   at $dnslist_domain
28401         dnslists = rbl-plus.mail-abuse.example
28402 .endd
28403
28404
28405
28406 .section "Additional matching conditions for DNS lists" "SECTaddmatcon"
28407 .cindex "DNS list" "matching specific returned data"
28408 You can add an equals sign and an IP address after a &%dnslists%& domain name
28409 in order to restrict its action to DNS records with a matching right hand side.
28410 For example,
28411 .code
28412 deny dnslists = rblplus.mail-abuse.org=127.0.0.2
28413 .endd
28414 rejects only those hosts that yield 127.0.0.2. Without this additional data,
28415 any address record is considered to be a match. For the moment, we assume
28416 that the DNS lookup returns just one record. Section &<<SECThanmuldnsrec>>&
28417 describes how multiple records are handled.
28418
28419 More than one IP address may be given for checking, using a comma as a
28420 separator. These are alternatives &-- if any one of them matches, the
28421 &%dnslists%& condition is true. For example:
28422 .code
28423 deny  dnslists = a.b.c=127.0.0.2,127.0.0.3
28424 .endd
28425 If you want to specify a constraining address list and also specify names or IP
28426 addresses to be looked up, the constraining address list must be specified
28427 first. For example:
28428 .code
28429 deny dnslists = dsn.rfc-ignorant.org\
28430                 =127.0.0.2/$sender_address_domain
28431 .endd
28432
28433 If the character &`&&`& is used instead of &`=`&, the comparison for each
28434 listed IP address is done by a bitwise &"and"& instead of by an equality test.
28435 In other words, the listed addresses are used as bit masks. The comparison is
28436 true if all the bits in the mask are present in the address that is being
28437 tested. For example:
28438 .code
28439 dnslists = a.b.c&0.0.0.3
28440 .endd
28441 matches if the address is &'x.x.x.'&3, &'x.x.x.'&7, &'x.x.x.'&11, etc. If you
28442 want to test whether one bit or another bit is present (as opposed to both
28443 being present), you must use multiple values. For example:
28444 .code
28445 dnslists = a.b.c&0.0.0.1,0.0.0.2
28446 .endd
28447 matches if the final component of the address is an odd number or two times
28448 an odd number.
28449
28450
28451
28452 .section "Negated DNS matching conditions" "SECID205"
28453 You can supply a negative list of IP addresses as part of a &%dnslists%&
28454 condition. Whereas
28455 .code
28456 deny  dnslists = a.b.c=127.0.0.2,127.0.0.3
28457 .endd
28458 means &"deny if the host is in the black list at the domain &'a.b.c'& and the
28459 IP address yielded by the list is either 127.0.0.2 or 127.0.0.3"&,
28460 .code
28461 deny  dnslists = a.b.c!=127.0.0.2,127.0.0.3
28462 .endd
28463 means &"deny if the host is in the black list at the domain &'a.b.c'& and the
28464 IP address yielded by the list is not 127.0.0.2 and not 127.0.0.3"&. In other
28465 words, the result of the test is inverted if an exclamation mark appears before
28466 the &`=`& (or the &`&&`&) sign.
28467
28468 &*Note*&: This kind of negation is not the same as negation in a domain,
28469 host, or address list (which is why the syntax is different).
28470
28471 If you are using just one list, the negation syntax does not gain you much. The
28472 previous example is precisely equivalent to
28473 .code
28474 deny  dnslists = a.b.c
28475      !dnslists = a.b.c=127.0.0.2,127.0.0.3
28476 .endd
28477 However, if you are using multiple lists, the negation syntax is clearer.
28478 Consider this example:
28479 .code
28480 deny  dnslists = sbl.spamhaus.org : \
28481                  list.dsbl.org : \
28482                  dnsbl.njabl.org!=127.0.0.3 : \
28483                  relays.ordb.org
28484 .endd
28485 Using only positive lists, this would have to be:
28486 .code
28487 deny  dnslists = sbl.spamhaus.org : \
28488                  list.dsbl.org
28489 deny  dnslists = dnsbl.njabl.org
28490      !dnslists = dnsbl.njabl.org=127.0.0.3
28491 deny  dnslists = relays.ordb.org
28492 .endd
28493 which is less clear, and harder to maintain.
28494
28495
28496
28497
28498 .section "Handling multiple DNS records from a DNS list" "SECThanmuldnsrec"
28499 A DNS lookup for a &%dnslists%& condition may return more than one DNS record,
28500 thereby providing more than one IP address. When an item in a &%dnslists%& list
28501 is followed by &`=`& or &`&&`& and a list of IP addresses, in order to restrict
28502 the match to specific results from the DNS lookup, there are two ways in which
28503 the checking can be handled. For example, consider the condition:
28504 .code
28505 dnslists = a.b.c=127.0.0.1
28506 .endd
28507 What happens if the DNS lookup for the incoming IP address yields both
28508 127.0.0.1 and 127.0.0.2 by means of two separate DNS records? Is the
28509 condition true because at least one given value was found, or is it false
28510 because at least one of the found values was not listed? And how does this
28511 affect negated conditions? Both possibilities are provided for with the help of
28512 additional separators &`==`& and &`=&&`&.
28513
28514 .ilist
28515 If &`=`& or &`&&`& is used, the condition is true if any one of the looked up
28516 IP addresses matches one of the listed addresses. For the example above, the
28517 condition is true because 127.0.0.1 matches.
28518 .next
28519 If &`==`& or &`=&&`& is used, the condition is true only if every one of the
28520 looked up IP addresses matches one of the listed addresses. If the condition is
28521 changed to:
28522 .code
28523 dnslists = a.b.c==127.0.0.1
28524 .endd
28525 and the DNS lookup yields both 127.0.0.1 and 127.0.0.2, the condition is
28526 false because 127.0.0.2 is not listed. You would need to have:
28527 .code
28528 dnslists = a.b.c==127.0.0.1,127.0.0.2
28529 .endd
28530 for the condition to be true.
28531 .endlist
28532
28533 When &`!`& is used to negate IP address matching, it inverts the result, giving
28534 the precise opposite of the behaviour above. Thus:
28535 .ilist
28536 If &`!=`& or &`!&&`& is used, the condition is true if none of the looked up IP
28537 addresses matches one of the listed addresses. Consider:
28538 .code
28539 dnslists = a.b.c!&0.0.0.1
28540 .endd
28541 If the DNS lookup yields both 127.0.0.1 and 127.0.0.2, the condition is
28542 false because 127.0.0.1 matches.
28543 .next
28544 If &`!==`& or &`!=&&`& is used, the condition is true if there is at least one
28545 looked up IP address that does not match. Consider:
28546 .code
28547 dnslists = a.b.c!=&0.0.0.1
28548 .endd
28549 If the DNS lookup yields both 127.0.0.1 and 127.0.0.2, the condition is
28550 true, because 127.0.0.2 does not match. You would need to have:
28551 .code
28552 dnslists = a.b.c!=&0.0.0.1,0.0.0.2
28553 .endd
28554 for the condition to be false.
28555 .endlist
28556 When the DNS lookup yields only a single IP address, there is no difference
28557 between &`=`& and &`==`& and between &`&&`& and &`=&&`&.
28558
28559
28560
28561
28562 .section "Detailed information from merged DNS lists" "SECTmordetinf"
28563 .cindex "DNS list" "information from merged"
28564 When the facility for restricting the matching IP values in a DNS list is used,
28565 the text from the TXT record that is set in &$dnslist_text$& may not reflect
28566 the true reason for rejection. This happens when lists are merged and the IP
28567 address in the A record is used to distinguish them; unfortunately there is
28568 only one TXT record. One way round this is not to use merged lists, but that
28569 can be inefficient because it requires multiple DNS lookups where one would do
28570 in the vast majority of cases when the host of interest is not on any of the
28571 lists.
28572
28573 A less inefficient way of solving this problem is available. If
28574 two domain names, comma-separated, are given, the second is used first to
28575 do an initial check, making use of any IP value restrictions that are set.
28576 If there is a match, the first domain is used, without any IP value
28577 restrictions, to get the TXT record. As a byproduct of this, there is also
28578 a check that the IP being tested is indeed on the first list. The first
28579 domain is the one that is put in &$dnslist_domain$&. For example:
28580 .code
28581 reject message  = \
28582          rejected because $sender_host_address is blacklisted \
28583          at $dnslist_domain\n$dnslist_text
28584        dnslists = \
28585          sbl.spamhaus.org,sbl-xbl.spamhaus.org=127.0.0.2 : \
28586          dul.dnsbl.sorbs.net,dnsbl.sorbs.net=127.0.0.10
28587 .endd
28588 For the first blacklist item, this starts by doing a lookup in
28589 &'sbl-xbl.spamhaus.org'& and testing for a 127.0.0.2 return. If there is a
28590 match, it then looks in &'sbl.spamhaus.org'&, without checking the return
28591 value, and as long as something is found, it looks for the corresponding TXT
28592 record. If there is no match in &'sbl-xbl.spamhaus.org'&, nothing more is done.
28593 The second blacklist item is processed similarly.
28594
28595 If you are interested in more than one merged list, the same list must be
28596 given several times, but because the results of the DNS lookups are cached,
28597 the DNS calls themselves are not repeated. For example:
28598 .code
28599 reject dnslists = \
28600          http.dnsbl.sorbs.net,dnsbl.sorbs.net=127.0.0.2 : \
28601          socks.dnsbl.sorbs.net,dnsbl.sorbs.net=127.0.0.3 : \
28602          misc.dnsbl.sorbs.net,dnsbl.sorbs.net=127.0.0.4 : \
28603          dul.dnsbl.sorbs.net,dnsbl.sorbs.net=127.0.0.10
28604 .endd
28605 In this case there is one lookup in &'dnsbl.sorbs.net'&, and if none of the IP
28606 values matches (or if no record is found), this is the only lookup that is
28607 done. Only if there is a match is one of the more specific lists consulted.
28608
28609
28610
28611 .section "DNS lists and IPv6" "SECTmorednslistslast"
28612 .cindex "IPv6" "DNS black lists"
28613 .cindex "DNS list" "IPv6 usage"
28614 If Exim is asked to do a dnslist lookup for an IPv6 address, it inverts it
28615 nibble by nibble. For example, if the calling host's IP address is
28616 3ffe:ffff:836f:0a00:000a:0800:200a:c031, Exim might look up
28617 .code
28618 1.3.0.c.a.0.0.2.0.0.8.0.a.0.0.0.0.0.a.0.f.6.3.8.
28619   f.f.f.f.e.f.f.3.blackholes.mail-abuse.org
28620 .endd
28621 (split over two lines here to fit on the page). Unfortunately, some of the DNS
28622 lists contain wildcard records, intended for IPv4, that interact badly with
28623 IPv6. For example, the DNS entry
28624 .code
28625 *.3.some.list.example.    A    127.0.0.1
28626 .endd
28627 is probably intended to put the entire 3.0.0.0/8 IPv4 network on the list.
28628 Unfortunately, it also matches the entire 3::/4 IPv6 network.
28629
28630 You can exclude IPv6 addresses from DNS lookups by making use of a suitable
28631 &%condition%& condition, as in this example:
28632 .code
28633 deny   condition = ${if isip4{$sender_host_address}}
28634        dnslists  = some.list.example
28635 .endd
28636
28637 .section "Rate limiting incoming messages" "SECTratelimiting"
28638 .cindex "rate limiting" "client sending"
28639 .cindex "limiting client sending rates"
28640 .oindex "&%smtp_ratelimit_*%&"
28641 The &%ratelimit%& ACL condition can be used to measure and control the rate at
28642 which clients can send email. This is more powerful than the
28643 &%smtp_ratelimit_*%& options, because those options control the rate of
28644 commands in a single SMTP session only, whereas the &%ratelimit%& condition
28645 works across all connections (concurrent and sequential) from the same client
28646 host. The syntax of the &%ratelimit%& condition is:
28647 .display
28648 &`ratelimit =`& <&'m'&> &`/`& <&'p'&> &`/`& <&'options'&> &`/`& <&'key'&>
28649 .endd
28650 If the average client sending rate is less than &'m'& messages per time
28651 period &'p'& then the condition is false; otherwise it is true.
28652
28653 As a side-effect, the &%ratelimit%& condition sets the expansion variable
28654 &$sender_rate$& to the client's computed rate, &$sender_rate_limit$& to the
28655 configured value of &'m'&, and &$sender_rate_period$& to the configured value
28656 of &'p'&.
28657
28658 The parameter &'p'& is the smoothing time constant, in the form of an Exim
28659 time interval, for example, &`8h`& for eight hours. A larger time constant
28660 means that it takes Exim longer to forget a client's past behaviour. The
28661 parameter &'m'& is the maximum number of messages that a client is permitted to
28662 send in each time interval. It also specifies the number of messages permitted
28663 in a fast burst. By increasing both &'m'& and &'p'& but keeping &'m/p'&
28664 constant, you can allow a client to send more messages in a burst without
28665 changing its long-term sending rate limit. Conversely, if &'m'& and &'p'& are
28666 both small, messages must be sent at an even rate.
28667
28668 There is a script in &_util/ratelimit.pl_& which extracts sending rates from
28669 log files, to assist with choosing appropriate settings for &'m'& and &'p'&
28670 when deploying the &%ratelimit%& ACL condition. The script prints usage
28671 instructions when it is run with no arguments.
28672
28673 The key is used to look up the data for calculating the client's average
28674 sending rate. This data is stored in Exim's spool directory, alongside the
28675 retry and other hints databases. The default key is &$sender_host_address$&,
28676 which means Exim computes the sending rate of each client host IP address.
28677 By changing the key you can change how Exim identifies clients for the purpose
28678 of ratelimiting. For example, to limit the sending rate of each authenticated
28679 user, independent of the computer they are sending from, set the key to
28680 &$authenticated_id$&. You must ensure that the lookup key is meaningful; for
28681 example, &$authenticated_id$& is only meaningful if the client has
28682 authenticated (which you can check with the &%authenticated%& ACL condition).
28683
28684 The lookup key does not have to identify clients: If you want to limit the
28685 rate at which a recipient receives messages, you can use the key
28686 &`$local_part@$domain`& with the &%per_rcpt%& option (see below) in a RCPT
28687 ACL.
28688
28689 Each &%ratelimit%& condition can have up to four options. A &%per_*%& option
28690 specifies what Exim measures the rate of, for example messages or recipients
28691 or bytes. You can adjust the measurement using the &%unique=%& and/or
28692 &%count=%& options. You can also control when Exim updates the recorded rate
28693 using a &%strict%&, &%leaky%&, or &%readonly%& option. The options are
28694 separated by a slash, like the other parameters. They may appear in any order.
28695
28696 Internally, Exim appends the smoothing constant &'p'& onto the lookup key with
28697 any options that alter the meaning of the stored data. The limit &'m'& is not
28698 stored, so you can alter the configured maximum rate and Exim will still
28699 remember clients' past behaviour. If you change the &%per_*%& mode or add or
28700 remove the &%unique=%& option, the lookup key changes so Exim will forget past
28701 behaviour. The lookup key is not affected by changes to the update mode and
28702 the &%count=%& option.
28703
28704
28705 .section "Ratelimit options for what is being measured" "ratoptmea"
28706 .cindex "rate limiting" "per_* options"
28707 The &%per_conn%& option limits the client's connection rate. It is not
28708 normally used in the &%acl_not_smtp%&, &%acl_not_smtp_mime%&, or
28709 &%acl_not_smtp_start%& ACLs.
28710
28711 The &%per_mail%& option limits the client's rate of sending messages. This is
28712 the default if none of the &%per_*%& options is specified. It can be used in
28713 &%acl_smtp_mail%&, &%acl_smtp_rcpt%&, &%acl_smtp_predata%&, &%acl_smtp_mime%&,
28714 &%acl_smtp_data%&, or &%acl_not_smtp%&.
28715
28716 The &%per_byte%& option limits the sender's email bandwidth. It can be used in
28717 the same ACLs as the &%per_mail%& option, though it is best to use this option
28718 in the &%acl_smtp_mime%&, &%acl_smtp_data%& or &%acl_not_smtp%& ACLs; if it is
28719 used in an earlier ACL, Exim relies on the SIZE parameter given by the client
28720 in its MAIL command, which may be inaccurate or completely missing. You can
28721 follow the limit &'m'& in the configuration with K, M, or G to specify limits
28722 in kilobytes, megabytes, or gigabytes, respectively.
28723
28724 The &%per_rcpt%& option causes Exim to limit the rate at which recipients are
28725 accepted. It can be used in the &%acl_smtp_rcpt%&, &%acl_smtp_predata%&,
28726 &%acl_smtp_mime%&, &%acl_smtp_data%&, or &%acl_smtp_rcpt%& ACLs. In
28727 &%acl_smtp_rcpt%& the rate is updated one recipient at a time; in the other
28728 ACLs the rate is updated with the total recipient count in one go. Note that
28729 in either case the rate limiting engine will see a message with many
28730 recipients as a large high-speed burst.
28731
28732 The &%per_addr%& option is like the &%per_rcpt%& option, except it counts the
28733 number of different recipients that the client has sent messages to in the
28734 last time period. That is, if the client repeatedly sends messages to the same
28735 recipient, its measured rate is not increased. This option can only be used in
28736 &%acl_smtp_rcpt%&.
28737
28738 The &%per_cmd%& option causes Exim to recompute the rate every time the
28739 condition is processed. This can be used to limit the rate of any SMTP
28740 command. If it is used in multiple ACLs it can limit the aggregate rate of
28741 multiple different commands.
28742
28743 The &%count=%& option can be used to alter how much Exim adds to the client's
28744 measured rate. For example, the &%per_byte%& option is equivalent to
28745 &`per_mail/count=$message_size`&. If there is no &%count=%& option, Exim
28746 increases the measured rate by one (except for the &%per_rcpt%& option in ACLs
28747 other than &%acl_smtp_rcpt%&). The count does not have to be an integer.
28748
28749 The &%unique=%& option is described in section &<<ratoptuniq>>& below.
28750
28751
28752 .section "Ratelimit update modes" "ratoptupd"
28753 .cindex "rate limiting" "reading data without updating"
28754 You can specify one of three options with the &%ratelimit%& condition to
28755 control when its database is updated. This section describes the &%readonly%&
28756 mode, and the next section describes the &%strict%& and &%leaky%& modes.
28757
28758 If the &%ratelimit%& condition is used in &%readonly%& mode, Exim looks up a
28759 previously-computed rate to check against the limit.
28760
28761 For example, you can test the client's sending rate and deny it access (when
28762 it is too fast) in the connect ACL. If the client passes this check then it
28763 can go on to send a message, in which case its recorded rate will be updated
28764 in the MAIL ACL. Subsequent connections from the same client will check this
28765 new rate.
28766 .code
28767 acl_check_connect:
28768  deny ratelimit = 100 / 5m / readonly
28769     log_message = RATE CHECK: $sender_rate/$sender_rate_period \
28770                   (max $sender_rate_limit)
28771 # ...
28772 acl_check_mail:
28773  warn ratelimit = 100 / 5m / strict
28774     log_message = RATE UPDATE: $sender_rate/$sender_rate_period \
28775                   (max $sender_rate_limit)
28776 .endd
28777
28778 If Exim encounters multiple &%ratelimit%& conditions with the same key when
28779 processing a message then it may increase the client's measured rate more than
28780 it should. For example, this will happen if you check the &%per_rcpt%& option
28781 in both &%acl_smtp_rcpt%& and &%acl_smtp_data%&. However it's OK to check the
28782 same &%ratelimit%& condition multiple times in the same ACL. You can avoid any
28783 multiple update problems by using the &%readonly%& option on later ratelimit
28784 checks.
28785
28786 The &%per_*%& options described above do not make sense in some ACLs. If you
28787 use a &%per_*%& option in an ACL where it is not normally permitted then the
28788 update mode defaults to &%readonly%& and you cannot specify the &%strict%& or
28789 &%leaky%& modes. In other ACLs the default update mode is &%leaky%& (see the
28790 next section) so you must specify the &%readonly%& option explicitly.
28791
28792
28793 .section "Ratelimit options for handling fast clients" "ratoptfast"
28794 .cindex "rate limiting" "strict and leaky modes"
28795 If a client's average rate is greater than the maximum, the rate limiting
28796 engine can react in two possible ways, depending on the presence of the
28797 &%strict%& or &%leaky%& update modes. This is independent of the other
28798 counter-measures (such as rejecting the message) that may be specified by the
28799 rest of the ACL.
28800
28801 The &%leaky%& (default) option means that the client's recorded rate is not
28802 updated if it is above the limit. The effect of this is that Exim measures the
28803 client's average rate of successfully sent email, which cannot be greater than
28804 the maximum allowed. If the client is over the limit it may suffer some
28805 counter-measures (as specified in the ACL), but it will still be able to send
28806 email at the configured maximum rate, whatever the rate of its attempts. This
28807 is generally the better choice if you have clients that retry automatically.
28808 For example, it does not prevent a sender with an over-aggressive retry rate
28809 from getting any email through.
28810
28811 The &%strict%& option means that the client's recorded rate is always
28812 updated. The effect of this is that Exim measures the client's average rate
28813 of attempts to send email, which can be much higher than the maximum it is
28814 actually allowed. If the client is over the limit it may be subjected to
28815 counter-measures by the ACL. It must slow down and allow sufficient time to
28816 pass that its computed rate falls below the maximum before it can send email
28817 again. The time (the number of smoothing periods) it must wait and not
28818 attempt to send mail can be calculated with this formula:
28819 .code
28820         ln(peakrate/maxrate)
28821 .endd
28822
28823
28824 .section "Limiting the rate of different events" "ratoptuniq"
28825 .cindex "rate limiting" "counting unique events"
28826 The &%ratelimit%& &%unique=%& option controls a mechanism for counting the
28827 rate of different events. For example, the &%per_addr%& option uses this
28828 mechanism to count the number of different recipients that the client has
28829 sent messages to in the last time period; it is equivalent to
28830 &`per_rcpt/unique=$local_part@$domain`&. You could use this feature to
28831 measure the rate that a client uses different sender addresses with the
28832 options &`per_mail/unique=$sender_address`&.
28833
28834 For each &%ratelimit%& key Exim stores the set of &%unique=%& values that it
28835 has seen for that key. The whole set is thrown away when it is older than the
28836 rate smoothing period &'p'&, so each different event is counted at most once
28837 per period. In the &%leaky%& update mode, an event that causes the client to
28838 go over the limit is not added to the set, in the same way that the client's
28839 recorded rate is not updated in the same situation.
28840
28841 When you combine the &%unique=%& and &%readonly%& options, the specific
28842 &%unique=%& value is ignored, and Exim just retrieves the client's stored
28843 rate.
28844
28845 The &%unique=%& mechanism needs more space in the ratelimit database than the
28846 other &%ratelimit%& options in order to store the event set. The number of
28847 unique values is potentially as large as the rate limit, so the extra space
28848 required increases with larger limits.
28849
28850 The uniqueification is not perfect: there is a small probability that Exim
28851 will think a new event has happened before. If the sender's rate is less than
28852 the limit, Exim should be more than 99.9% correct. However in &%strict%& mode
28853 the measured rate can go above the limit, in which case Exim may under-count
28854 events by a significant margin. Fortunately, if the rate is high enough (2.7
28855 times the limit) that the false positive rate goes above 9%, then Exim will
28856 throw away the over-full event set before the measured rate falls below the
28857 limit. Therefore the only harm should be that exceptionally high sending rates
28858 are logged incorrectly; any countermeasures you configure will be as effective
28859 as intended.
28860
28861
28862 .section "Using rate limiting" "useratlim"
28863 Exim's other ACL facilities are used to define what counter-measures are taken
28864 when the rate limit is exceeded. This might be anything from logging a warning
28865 (for example, while measuring existing sending rates in order to define
28866 policy), through time delays to slow down fast senders, up to rejecting the
28867 message. For example:
28868 .code
28869 # Log all senders' rates
28870 warn ratelimit = 0 / 1h / strict
28871      log_message = Sender rate $sender_rate / $sender_rate_period
28872
28873 # Slow down fast senders; note the need to truncate $sender_rate
28874 # at the decimal point.
28875 warn ratelimit = 100 / 1h / per_rcpt / strict
28876      delay     = ${eval: ${sg{$sender_rate}{[.].*}{}} - \
28877                    $sender_rate_limit }s
28878
28879 # Keep authenticated users under control
28880 deny authenticated = *
28881      ratelimit = 100 / 1d / strict / $authenticated_id
28882
28883 # System-wide rate limit
28884 defer message = Sorry, too busy. Try again later.
28885      ratelimit = 10 / 1s / $primary_hostname
28886
28887 # Restrict incoming rate from each host, with a default
28888 # set using a macro and special cases looked up in a table.
28889 defer message = Sender rate exceeds $sender_rate_limit \
28890                messages per $sender_rate_period
28891      ratelimit = ${lookup {$sender_host_address} \
28892                    cdb {DB/ratelimits.cdb} \
28893                    {$value} {RATELIMIT} }
28894 .endd
28895 &*Warning*&: If you have a busy server with a lot of &%ratelimit%& tests,
28896 especially with the &%per_rcpt%& option, you may suffer from a performance
28897 bottleneck caused by locking on the ratelimit hints database. Apart from
28898 making your ACLs less complicated, you can reduce the problem by using a
28899 RAM disk for Exim's hints directory (usually &_/var/spool/exim/db/_&). However
28900 this means that Exim will lose its hints data after a reboot (including retry
28901 hints, the callout cache, and ratelimit data).
28902
28903
28904
28905 .section "Address verification" "SECTaddressverification"
28906 .cindex "verifying address" "options for"
28907 .cindex "policy control" "address verification"
28908 Several of the &%verify%& conditions described in section
28909 &<<SECTaclconditions>>& cause addresses to be verified. Section
28910 &<<SECTsenaddver>>& discusses the reporting of sender verification failures.
28911 The verification conditions can be followed by options that modify the
28912 verification process. The options are separated from the keyword and from each
28913 other by slashes, and some of them contain parameters. For example:
28914 .code
28915 verify = sender/callout
28916 verify = recipient/defer_ok/callout=10s,defer_ok
28917 .endd
28918 The first stage of address verification, which always happens, is to run the
28919 address through the routers, in &"verify mode"&. Routers can detect the
28920 difference between verification and routing for delivery, and their actions can
28921 be varied by a number of generic options such as &%verify%& and &%verify_only%&
28922 (see chapter &<<CHAProutergeneric>>&). If routing fails, verification fails.
28923 The available options are as follows:
28924
28925 .ilist
28926 If the &%callout%& option is specified, successful routing to one or more
28927 remote hosts is followed by a &"callout"& to those hosts as an additional
28928 check. Callouts and their sub-options are discussed in the next section.
28929 .next
28930 If there is a defer error while doing verification routing, the ACL
28931 normally returns &"defer"&. However, if you include &%defer_ok%& in the
28932 options, the condition is forced to be true instead. Note that this is a main
28933 verification option as well as a suboption for callouts.
28934 .next
28935 The &%no_details%& option is covered in section &<<SECTsenaddver>>&, which
28936 discusses the reporting of sender address verification failures.
28937 .next
28938 The &%success_on_redirect%& option causes verification always to succeed
28939 immediately after a successful redirection. By default, if a redirection
28940 generates just one address, that address is also verified. See further
28941 discussion in section &<<SECTredirwhilveri>>&.
28942 .endlist
28943
28944 .cindex "verifying address" "differentiating failures"
28945 .vindex "&$recipient_verify_failure$&"
28946 .vindex "&$sender_verify_failure$&"
28947 .vindex "&$acl_verify_message$&"
28948 After an address verification failure, &$acl_verify_message$& contains the
28949 error message that is associated with the failure. It can be preserved by
28950 coding like this:
28951 .code
28952 warn  !verify = sender
28953        set acl_m0 = $acl_verify_message
28954 .endd
28955 If you are writing your own custom rejection message or log message when
28956 denying access, you can use this variable to include information about the
28957 verification failure.
28958
28959 In addition, &$sender_verify_failure$& or &$recipient_verify_failure$& (as
28960 appropriate) contains one of the following words:
28961
28962 .ilist
28963 &%qualify%&: The address was unqualified (no domain), and the message
28964 was neither local nor came from an exempted host.
28965 .next
28966 &%route%&: Routing failed.
28967 .next
28968 &%mail%&: Routing succeeded, and a callout was attempted; rejection
28969 occurred at or before the MAIL command (that is, on initial
28970 connection, HELO, or MAIL).
28971 .next
28972 &%recipient%&: The RCPT command in a callout was rejected.
28973 .next
28974 &%postmaster%&: The postmaster check in a callout was rejected.
28975 .endlist
28976
28977 The main use of these variables is expected to be to distinguish between
28978 rejections of MAIL and rejections of RCPT in callouts.
28979
28980
28981
28982
28983 .section "Callout verification" "SECTcallver"
28984 .cindex "verifying address" "by callout"
28985 .cindex "callout" "verification"
28986 .cindex "SMTP" "callout verification"
28987 For non-local addresses, routing verifies the domain, but is unable to do any
28988 checking of the local part. There are situations where some means of verifying
28989 the local part is desirable. One way this can be done is to make an SMTP
28990 &'callback'& to a delivery host for the sender address or a &'callforward'& to
28991 a subsequent host for a recipient address, to see if the host accepts the
28992 address. We use the term &'callout'& to cover both cases. Note that for a
28993 sender address, the callback is not to the client host that is trying to
28994 deliver the message, but to one of the hosts that accepts incoming mail for the
28995 sender's domain.
28996
28997 Exim does not do callouts by default. If you want them to happen, you must
28998 request them by setting appropriate options on the &%verify%& condition, as
28999 described below. This facility should be used with care, because it can add a
29000 lot of resource usage to the cost of verifying an address. However, Exim does
29001 cache the results of callouts, which helps to reduce the cost. Details of
29002 caching are in section &<<SECTcallvercache>>&.
29003
29004 Recipient callouts are usually used only between hosts that are controlled by
29005 the same administration. For example, a corporate gateway host could use
29006 callouts to check for valid recipients on an internal mailserver. A successful
29007 callout does not guarantee that a real delivery to the address would succeed;
29008 on the other hand, a failing callout does guarantee that a delivery would fail.
29009
29010 If the &%callout%& option is present on a condition that verifies an address, a
29011 second stage of verification occurs if the address is successfully routed to
29012 one or more remote hosts. The usual case is routing by a &(dnslookup)& or a
29013 &(manualroute)& router, where the router specifies the hosts. However, if a
29014 router that does not set up hosts routes to an &(smtp)& transport with a
29015 &%hosts%& setting, the transport's hosts are used. If an &(smtp)& transport has
29016 &%hosts_override%& set, its hosts are always used, whether or not the router
29017 supplies a host list.
29018
29019 The port that is used is taken from the transport, if it is specified and is a
29020 remote transport. (For routers that do verification only, no transport need be
29021 specified.) Otherwise, the default SMTP port is used. If a remote transport
29022 specifies an outgoing interface, this is used; otherwise the interface is not
29023 specified. Likewise, the text that is used for the HELO command is taken from
29024 the transport's &%helo_data%& option; if there is no transport, the value of
29025 &$smtp_active_hostname$& is used.
29026
29027 For a sender callout check, Exim makes SMTP connections to the remote hosts, to
29028 test whether a bounce message could be delivered to the sender address. The
29029 following SMTP commands are sent:
29030 .display
29031 &`HELO `&<&'local host name'&>
29032 &`MAIL FROM:<>`&
29033 &`RCPT TO:`&<&'the address to be tested'&>
29034 &`QUIT`&
29035 .endd
29036 LHLO is used instead of HELO if the transport's &%protocol%& option is
29037 set to &"lmtp"&.
29038
29039 .new
29040 The callout may use EHLO, AUTH and/or STARTTLS given appropriate option
29041 settings.
29042 .wen
29043
29044 A recipient callout check is similar. By default, it also uses an empty address
29045 for the sender. This default is chosen because most hosts do not make use of
29046 the sender address when verifying a recipient. Using the same address means
29047 that a single cache entry can be used for each recipient. Some sites, however,
29048 do make use of the sender address when verifying. These are catered for by the
29049 &%use_sender%& and &%use_postmaster%& options, described in the next section.
29050
29051 If the response to the RCPT command is a 2&'xx'& code, the verification
29052 succeeds. If it is 5&'xx'&, the verification fails. For any other condition,
29053 Exim tries the next host, if any. If there is a problem with all the remote
29054 hosts, the ACL yields &"defer"&, unless the &%defer_ok%& parameter of the
29055 &%callout%& option is given, in which case the condition is forced to succeed.
29056
29057 .cindex "SMTP" "output flushing, disabling for callout"
29058 A callout may take a little time. For this reason, Exim normally flushes SMTP
29059 output before performing a callout in an ACL, to avoid unexpected timeouts in
29060 clients when the SMTP PIPELINING extension is in use. The flushing can be
29061 disabled by using a &%control%& modifier to set &%no_callout_flush%&.
29062
29063
29064
29065
29066 .section "Additional parameters for callouts" "CALLaddparcall"
29067 .cindex "callout" "additional parameters for"
29068 The &%callout%& option can be followed by an equals sign and a number of
29069 optional parameters, separated by commas. For example:
29070 .code
29071 verify = recipient/callout=10s,defer_ok
29072 .endd
29073 The old syntax, which had &%callout_defer_ok%& and &%check_postmaster%& as
29074 separate verify options, is retained for backwards compatibility, but is now
29075 deprecated. The additional parameters for &%callout%& are as follows:
29076
29077
29078 .vlist
29079 .vitem <&'a&~time&~interval'&>
29080 .cindex "callout" "timeout, specifying"
29081 This specifies the timeout that applies for the callout attempt to each host.
29082 For example:
29083 .code
29084 verify = sender/callout=5s
29085 .endd
29086 The default is 30 seconds. The timeout is used for each response from the
29087 remote host. It is also used for the initial connection, unless overridden by
29088 the &%connect%& parameter.
29089
29090
29091 .vitem &*connect&~=&~*&<&'time&~interval'&>
29092 .cindex "callout" "connection timeout, specifying"
29093 This parameter makes it possible to set a different (usually smaller) timeout
29094 for making the SMTP connection. For example:
29095 .code
29096 verify = sender/callout=5s,connect=1s
29097 .endd
29098 If not specified, this timeout defaults to the general timeout value.
29099
29100 .vitem &*defer_ok*&
29101 .cindex "callout" "defer, action on"
29102 When this parameter is present, failure to contact any host, or any other kind
29103 of temporary error, is treated as success by the ACL. However, the cache is not
29104 updated in this circumstance.
29105
29106 .vitem &*fullpostmaster*&
29107 .cindex "callout" "full postmaster check"
29108 This operates like the &%postmaster%& option (see below), but if the check for
29109 &'postmaster@domain'& fails, it tries just &'postmaster'&, without a domain, in
29110 accordance with the specification in RFC 2821. The RFC states that the
29111 unqualified address &'postmaster'& should be accepted.
29112
29113
29114 .vitem &*mailfrom&~=&~*&<&'email&~address'&>
29115 .cindex "callout" "sender when verifying header"
29116 When verifying addresses in header lines using the &%header_sender%&
29117 verification option, Exim behaves by default as if the addresses are envelope
29118 sender addresses from a message. Callout verification therefore tests to see
29119 whether a bounce message could be delivered, by using an empty address in the
29120 MAIL command. However, it is arguable that these addresses might never be used
29121 as envelope senders, and could therefore justifiably reject bounce messages
29122 (empty senders). The &%mailfrom%& callout parameter allows you to specify what
29123 address to use in the MAIL command. For example:
29124 .code
29125 require  verify = header_sender/callout=mailfrom=abcd@x.y.z
29126 .endd
29127 This parameter is available only for the &%header_sender%& verification option.
29128
29129
29130 .vitem &*maxwait&~=&~*&<&'time&~interval'&>
29131 .cindex "callout" "overall timeout, specifying"
29132 This parameter sets an overall timeout for performing a callout verification.
29133 For example:
29134 .code
29135 verify = sender/callout=5s,maxwait=30s
29136 .endd
29137 This timeout defaults to four times the callout timeout for individual SMTP
29138 commands. The overall timeout applies when there is more than one host that can
29139 be tried. The timeout is checked before trying the next host. This prevents
29140 very long delays if there are a large number of hosts and all are timing out
29141 (for example, when network connections are timing out).
29142
29143
29144 .vitem &*no_cache*&
29145 .cindex "callout" "cache, suppressing"
29146 .cindex "caching callout, suppressing"
29147 When this parameter is given, the callout cache is neither read nor updated.
29148
29149 .vitem &*postmaster*&
29150 .cindex "callout" "postmaster; checking"
29151 When this parameter is set, a successful callout check is followed by a similar
29152 check for the local part &'postmaster'& at the same domain. If this address is
29153 rejected, the callout fails (but see &%fullpostmaster%& above). The result of
29154 the postmaster check is recorded in a cache record; if it is a failure, this is
29155 used to fail subsequent callouts for the domain without a connection being
29156 made, until the cache record expires.
29157
29158 .vitem &*postmaster_mailfrom&~=&~*&<&'email&~address'&>
29159 The postmaster check uses an empty sender in the MAIL command by default.
29160 You can use this parameter to do a postmaster check using a different address.
29161 For example:
29162 .code
29163 require  verify = sender/callout=postmaster_mailfrom=abc@x.y.z
29164 .endd
29165 If both &%postmaster%& and &%postmaster_mailfrom%& are present, the rightmost
29166 one overrides. The &%postmaster%& parameter is equivalent to this example:
29167 .code
29168 require  verify = sender/callout=postmaster_mailfrom=
29169 .endd
29170 &*Warning*&: The caching arrangements for postmaster checking do not take
29171 account of the sender address. It is assumed that either the empty address or
29172 a fixed non-empty address will be used. All that Exim remembers is that the
29173 postmaster check for the domain succeeded or failed.
29174
29175
29176 .vitem &*random*&
29177 .cindex "callout" "&""random""& check"
29178 When this parameter is set, before doing the normal callout check, Exim does a
29179 check for a &"random"& local part at the same domain. The local part is not
29180 really random &-- it is defined by the expansion of the option
29181 &%callout_random_local_part%&, which defaults to
29182 .code
29183 $primary_hostname-$tod_epoch-testing
29184 .endd
29185 The idea here is to try to determine whether the remote host accepts all local
29186 parts without checking. If it does, there is no point in doing callouts for
29187 specific local parts. If the &"random"& check succeeds, the result is saved in
29188 a cache record, and used to force the current and subsequent callout checks to
29189 succeed without a connection being made, until the cache record expires.
29190
29191 .vitem &*use_postmaster*&
29192 .cindex "callout" "sender for recipient check"
29193 This parameter applies to recipient callouts only. For example:
29194 .code
29195 deny  !verify = recipient/callout=use_postmaster
29196 .endd
29197 .vindex "&$qualify_domain$&"
29198 It causes a non-empty postmaster address to be used in the MAIL command when
29199 performing the callout for the recipient, and also for a &"random"& check if
29200 that is configured. The local part of the address is &`postmaster`& and the
29201 domain is the contents of &$qualify_domain$&.
29202
29203 .vitem &*use_sender*&
29204 This option applies to recipient callouts only. For example:
29205 .code
29206 require  verify = recipient/callout=use_sender
29207 .endd
29208 It causes the message's actual sender address to be used in the MAIL
29209 command when performing the callout, instead of an empty address. There is no
29210 need to use this option unless you know that the called hosts make use of the
29211 sender when checking recipients. If used indiscriminately, it reduces the
29212 usefulness of callout caching.
29213 .endlist
29214
29215 If you use any of the parameters that set a non-empty sender for the MAIL
29216 command (&%mailfrom%&, &%postmaster_mailfrom%&, &%use_postmaster%&, or
29217 &%use_sender%&), you should think about possible loops. Recipient checking is
29218 usually done between two hosts that are under the same management, and the host
29219 that receives the callouts is not normally configured to do callouts itself.
29220 Therefore, it is normally safe to use &%use_postmaster%& or &%use_sender%& in
29221 these circumstances.
29222
29223 However, if you use a non-empty sender address for a callout to an arbitrary
29224 host, there is the likelihood that the remote host will itself initiate a
29225 callout check back to your host. As it is checking what appears to be a message
29226 sender, it is likely to use an empty address in MAIL, thus avoiding a
29227 callout loop. However, to be on the safe side it would be best to set up your
29228 own ACLs so that they do not do sender verification checks when the recipient
29229 is the address you use for header sender or postmaster callout checking.
29230
29231 Another issue to think about when using non-empty senders for callouts is
29232 caching. When you set &%mailfrom%& or &%use_sender%&, the cache record is keyed
29233 by the sender/recipient combination; thus, for any given recipient, many more
29234 actual callouts are performed than when an empty sender or postmaster is used.
29235
29236
29237
29238
29239 .section "Callout caching" "SECTcallvercache"
29240 .cindex "hints database" "callout cache"
29241 .cindex "callout" "cache, description of"
29242 .cindex "caching" "callout"
29243 Exim caches the results of callouts in order to reduce the amount of resources
29244 used, unless you specify the &%no_cache%& parameter with the &%callout%&
29245 option. A hints database called &"callout"& is used for the cache. Two
29246 different record types are used: one records the result of a callout check for
29247 a specific address, and the other records information that applies to the
29248 entire domain (for example, that it accepts the local part &'postmaster'&).
29249
29250 When an original callout fails, a detailed SMTP error message is given about
29251 the failure. However, for subsequent failures use the cache data, this message
29252 is not available.
29253
29254 The expiry times for negative and positive address cache records are
29255 independent, and can be set by the global options &%callout_negative_expire%&
29256 (default 2h) and &%callout_positive_expire%& (default 24h), respectively.
29257
29258 If a host gives a negative response to an SMTP connection, or rejects any
29259 commands up to and including
29260 .code
29261 MAIL FROM:<>
29262 .endd
29263 (but not including the MAIL command with a non-empty address),
29264 any callout attempt is bound to fail. Exim remembers such failures in a
29265 domain cache record, which it uses to fail callouts for the domain without
29266 making new connections, until the domain record times out. There are two
29267 separate expiry times for domain cache records:
29268 &%callout_domain_negative_expire%& (default 3h) and
29269 &%callout_domain_positive_expire%& (default 7d).
29270
29271 Domain records expire when the negative expiry time is reached if callouts
29272 cannot be made for the domain, or if the postmaster check failed.
29273 Otherwise, they expire when the positive expiry time is reached. This
29274 ensures that, for example, a host that stops accepting &"random"& local parts
29275 will eventually be noticed.
29276
29277 The callout caching mechanism is based on the domain of the address that is
29278 being tested. If the domain routes to several hosts, it is assumed that their
29279 behaviour will be the same.
29280
29281
29282
29283 .section "Sender address verification reporting" "SECTsenaddver"
29284 .cindex "verifying" "suppressing error details"
29285 See section &<<SECTaddressverification>>& for a general discussion of
29286 verification. When sender verification fails in an ACL, the details of the
29287 failure are given as additional output lines before the 550 response to the
29288 relevant SMTP command (RCPT or DATA). For example, if sender callout is in use,
29289 you might see:
29290 .code
29291 MAIL FROM:<xyz@abc.example>
29292 250 OK
29293 RCPT TO:<pqr@def.example>
29294 550-Verification failed for <xyz@abc.example>
29295 550-Called:   192.168.34.43
29296 550-Sent:     RCPT TO:<xyz@abc.example>
29297 550-Response: 550 Unknown local part xyz in <xyz@abc.example>
29298 550 Sender verification failed
29299 .endd
29300 If more than one RCPT command fails in the same way, the details are given
29301 only for the first of them. However, some administrators do not want to send
29302 out this much information. You can suppress the details by adding
29303 &`/no_details`& to the ACL statement that requests sender verification. For
29304 example:
29305 .code
29306 verify = sender/no_details
29307 .endd
29308
29309 .section "Redirection while verifying" "SECTredirwhilveri"
29310 .cindex "verifying" "redirection while"
29311 .cindex "address redirection" "while verifying"
29312 A dilemma arises when a local address is redirected by aliasing or forwarding
29313 during verification: should the generated addresses themselves be verified,
29314 or should the successful expansion of the original address be enough to verify
29315 it? By default, Exim takes the following pragmatic approach:
29316
29317 .ilist
29318 When an incoming address is redirected to just one child address, verification
29319 continues with the child address, and if that fails to verify, the original
29320 verification also fails.
29321 .next
29322 When an incoming address is redirected to more than one child address,
29323 verification does not continue. A success result is returned.
29324 .endlist
29325
29326 This seems the most reasonable behaviour for the common use of aliasing as a
29327 way of redirecting different local parts to the same mailbox. It means, for
29328 example, that a pair of alias entries of the form
29329 .code
29330 A.Wol:   aw123
29331 aw123:   :fail: Gone away, no forwarding address
29332 .endd
29333 work as expected, with both local parts causing verification failure. When a
29334 redirection generates more than one address, the behaviour is more like a
29335 mailing list, where the existence of the alias itself is sufficient for
29336 verification to succeed.
29337
29338 It is possible, however, to change the default behaviour so that all successful
29339 redirections count as successful verifications, however many new addresses are
29340 generated. This is specified by the &%success_on_redirect%& verification
29341 option. For example:
29342 .code
29343 require verify = recipient/success_on_redirect/callout=10s
29344 .endd
29345 In this example, verification succeeds if a router generates a new address, and
29346 the callout does not occur, because no address was routed to a remote host.
29347
29348 When verification is being tested via the &%-bv%& option, the treatment of
29349 redirections is as just described, unless the &%-v%& or any debugging option is
29350 also specified. In that case, full verification is done for every generated
29351 address and a report is output for each of them.
29352
29353
29354
29355 .section "Client SMTP authorization (CSA)" "SECTverifyCSA"
29356 .cindex "CSA" "verifying"
29357 Client SMTP Authorization is a system that allows a site to advertise
29358 which machines are and are not permitted to send email. This is done by placing
29359 special SRV records in the DNS; these are looked up using the client's HELO
29360 domain. At the time of writing, CSA is still an Internet Draft. Client SMTP
29361 Authorization checks in Exim are performed by the ACL condition:
29362 .code
29363 verify = csa
29364 .endd
29365 This fails if the client is not authorized. If there is a DNS problem, or if no
29366 valid CSA SRV record is found, or if the client is authorized, the condition
29367 succeeds. These three cases can be distinguished using the expansion variable
29368 &$csa_status$&, which can take one of the values &"fail"&, &"defer"&,
29369 &"unknown"&, or &"ok"&. The condition does not itself defer because that would
29370 be likely to cause problems for legitimate email.
29371
29372 The error messages produced by the CSA code include slightly more
29373 detail. If &$csa_status$& is &"defer"&, this may be because of problems
29374 looking up the CSA SRV record, or problems looking up the CSA target
29375 address record. There are four reasons for &$csa_status$& being &"fail"&:
29376
29377 .ilist
29378 The client's host name is explicitly not authorized.
29379 .next
29380 The client's IP address does not match any of the CSA target IP addresses.
29381 .next
29382 The client's host name is authorized but it has no valid target IP addresses
29383 (for example, the target's addresses are IPv6 and the client is using IPv4).
29384 .next
29385 The client's host name has no CSA SRV record but a parent domain has asserted
29386 that all subdomains must be explicitly authorized.
29387 .endlist
29388
29389 The &%csa%& verification condition can take an argument which is the domain to
29390 use for the DNS query. The default is:
29391 .code
29392 verify = csa/$sender_helo_name
29393 .endd
29394 This implementation includes an extension to CSA. If the query domain
29395 is an address literal such as [192.0.2.95], or if it is a bare IP
29396 address, Exim searches for CSA SRV records in the reverse DNS as if
29397 the HELO domain was (for example) &'95.2.0.192.in-addr.arpa'&. Therefore it is
29398 meaningful to say:
29399 .code
29400 verify = csa/$sender_host_address
29401 .endd
29402 In fact, this is the check that Exim performs if the client does not say HELO.
29403 This extension can be turned off by setting the main configuration option
29404 &%dns_csa_use_reverse%& to be false.
29405
29406 If a CSA SRV record is not found for the domain itself, a search
29407 is performed through its parent domains for a record which might be
29408 making assertions about subdomains. The maximum depth of this search is limited
29409 using the main configuration option &%dns_csa_search_limit%&, which is 5 by
29410 default. Exim does not look for CSA SRV records in a top level domain, so the
29411 default settings handle HELO domains as long as seven
29412 (&'hostname.five.four.three.two.one.com'&). This encompasses the vast majority
29413 of legitimate HELO domains.
29414
29415 The &'dnsdb'& lookup also has support for CSA. Although &'dnsdb'& also supports
29416 direct SRV lookups, this is not sufficient because of the extra parent domain
29417 search behaviour of CSA, and (as with PTR lookups) &'dnsdb'& also turns IP
29418 addresses into lookups in the reverse DNS space. The result of a successful
29419 lookup such as:
29420 .code
29421 ${lookup dnsdb {csa=$sender_helo_name}}
29422 .endd
29423 has two space-separated fields: an authorization code and a target host name.
29424 The authorization code can be &"Y"& for yes, &"N"& for no, &"X"& for explicit
29425 authorization required but absent, or &"?"& for unknown.
29426
29427
29428
29429
29430 .section "Bounce address tag validation" "SECTverifyPRVS"
29431 .cindex "BATV, verifying"
29432 Bounce address tag validation (BATV) is a scheme whereby the envelope senders
29433 of outgoing messages have a cryptographic, timestamped &"tag"& added to them.
29434 Genuine incoming bounce messages should therefore always be addressed to
29435 recipients that have a valid tag. This scheme is a way of detecting unwanted
29436 bounce messages caused by sender address forgeries (often called &"collateral
29437 spam"&), because the recipients of such messages do not include valid tags.
29438
29439 There are two expansion items to help with the implementation of the BATV
29440 &"prvs"& (private signature) scheme in an Exim configuration. This scheme signs
29441 the original envelope sender address by using a simple key to add a hash of the
29442 address and some time-based randomizing information. The &%prvs%& expansion
29443 item creates a signed address, and the &%prvscheck%& expansion item checks one.
29444 The syntax of these expansion items is described in section
29445 &<<SECTexpansionitems>>&.
29446
29447 As an example, suppose the secret per-address keys are stored in an MySQL
29448 database. A query to look up the key for an address could be defined as a macro
29449 like this:
29450 .code
29451 PRVSCHECK_SQL = ${lookup mysql{SELECT secret FROM batv_prvs \
29452                 WHERE sender='${quote_mysql:$prvscheck_address}'\
29453                 }{$value}}
29454 .endd
29455 Suppose also that the senders who make use of BATV are defined by an address
29456 list called &%batv_senders%&. Then, in the ACL for RCPT commands, you could
29457 use this:
29458 .code
29459 # Bounces: drop unsigned addresses for BATV senders
29460 deny message = This address does not send an unsigned reverse path
29461      senders = :
29462      recipients = +batv_senders
29463
29464 # Bounces: In case of prvs-signed address, check signature.
29465 deny message = Invalid reverse path signature.
29466      senders = :
29467      condition  = ${prvscheck {$local_part@$domain}\
29468                   {PRVSCHECK_SQL}{1}}
29469      !condition = $prvscheck_result
29470 .endd
29471 The first statement rejects recipients for bounce messages that are addressed
29472 to plain BATV sender addresses, because it is known that BATV senders do not
29473 send out messages with plain sender addresses. The second statement rejects
29474 recipients that are prvs-signed, but with invalid signatures (either because
29475 the key is wrong, or the signature has timed out).
29476
29477 A non-prvs-signed address is not rejected by the second statement, because the
29478 &%prvscheck%& expansion yields an empty string if its first argument is not a
29479 prvs-signed address, thus causing the &%condition%& condition to be false. If
29480 the first argument is a syntactically valid prvs-signed address, the yield is
29481 the third string (in this case &"1"&), whether or not the cryptographic and
29482 timeout checks succeed. The &$prvscheck_result$& variable contains the result
29483 of the checks (empty for failure, &"1"& for success).
29484
29485 There is one more issue you must consider when implementing prvs-signing:
29486 you have to ensure that the routers accept prvs-signed addresses and
29487 deliver them correctly. The easiest way to handle this is to use a &(redirect)&
29488 router to remove the signature with a configuration along these lines:
29489 .code
29490 batv_redirect:
29491   driver = redirect
29492   data = ${prvscheck {$local_part@$domain}{PRVSCHECK_SQL}}
29493 .endd
29494 This works because, if the third argument of &%prvscheck%& is empty, the result
29495 of the expansion of a prvs-signed address is the decoded value of the original
29496 address. This router should probably be the first of your routers that handles
29497 local addresses.
29498
29499 To create BATV-signed addresses in the first place, a transport of this form
29500 can be used:
29501 .code
29502 external_smtp_batv:
29503   driver = smtp
29504   return_path = ${prvs {$return_path} \
29505                        {${lookup mysql{SELECT \
29506                        secret FROM batv_prvs WHERE \
29507                        sender='${quote_mysql:$sender_address}'} \
29508                        {$value}fail}}}
29509 .endd
29510 If no key can be found for the existing return path, no signing takes place.
29511
29512
29513
29514 .section "Using an ACL to control relaying" "SECTrelaycontrol"
29515 .cindex "&ACL;" "relay control"
29516 .cindex "relaying" "control by ACL"
29517 .cindex "policy control" "relay control"
29518 An MTA is said to &'relay'& a message if it receives it from some host and
29519 delivers it directly to another host as a result of a remote address contained
29520 within it. Redirecting a local address via an alias or forward file and then
29521 passing the message on to another host is not relaying,
29522 .cindex "&""percent hack""&"
29523 but a redirection as a result of the &"percent hack"& is.
29524
29525 Two kinds of relaying exist, which are termed &"incoming"& and &"outgoing"&.
29526 A host which is acting as a gateway or an MX backup is concerned with incoming
29527 relaying from arbitrary hosts to a specific set of domains. On the other hand,
29528 a host which is acting as a smart host for a number of clients is concerned
29529 with outgoing relaying from those clients to the Internet at large. Often the
29530 same host is fulfilling both functions,
29531 . ///
29532 . as illustrated in the diagram below,
29533 . ///
29534 but in principle these two kinds of relaying are entirely independent. What is
29535 not wanted is the transmission of mail from arbitrary remote hosts through your
29536 system to arbitrary domains.
29537
29538
29539 You can implement relay control by means of suitable statements in the ACL that
29540 runs for each RCPT command. For convenience, it is often easiest to use
29541 Exim's named list facility to define the domains and hosts involved. For
29542 example, suppose you want to do the following:
29543
29544 .ilist
29545 Deliver a number of domains to mailboxes on the local host (or process them
29546 locally in some other way). Let's say these are &'my.dom1.example'& and
29547 &'my.dom2.example'&.
29548 .next
29549 Relay mail for a number of other domains for which you are the secondary MX.
29550 These might be &'friend1.example'& and &'friend2.example'&.
29551 .next
29552 Relay mail from the hosts on your local LAN, to whatever domains are involved.
29553 Suppose your LAN is 192.168.45.0/24.
29554 .endlist
29555
29556
29557 In the main part of the configuration, you put the following definitions:
29558 .code
29559 domainlist local_domains    = my.dom1.example : my.dom2.example
29560 domainlist relay_to_domains = friend1.example : friend2.example
29561 hostlist   relay_from_hosts = 192.168.45.0/24
29562 .endd
29563 Now you can use these definitions in the ACL that is run for every RCPT
29564 command:
29565 .code
29566 acl_check_rcpt:
29567   accept domains = +local_domains : +relay_to_domains
29568   accept hosts   = +relay_from_hosts
29569 .endd
29570 The first statement accepts any RCPT command that contains an address in
29571 the local or relay domains. For any other domain, control passes to the second
29572 statement, which accepts the command only if it comes from one of the relay
29573 hosts. In practice, you will probably want to make your ACL more sophisticated
29574 than this, for example, by including sender and recipient verification. The
29575 default configuration includes a more comprehensive example, which is described
29576 in chapter &<<CHAPdefconfil>>&.
29577
29578
29579
29580 .section "Checking a relay configuration" "SECTcheralcon"
29581 .cindex "relaying" "checking control of"
29582 You can check the relay characteristics of your configuration in the same way
29583 that you can test any ACL behaviour for an incoming SMTP connection, by using
29584 the &%-bh%& option to run a fake SMTP session with which you interact.
29585
29586 For specifically testing for unwanted relaying, the host
29587 &'relay-test.mail-abuse.org'& provides a useful service. If you telnet to this
29588 host from the host on which Exim is running, using the normal telnet port, you
29589 will see a normal telnet connection message and then quite a long delay. Be
29590 patient. The remote host is making an SMTP connection back to your host, and
29591 trying a number of common probes to test for open relay vulnerability. The
29592 results of the tests will eventually appear on your terminal.
29593 .ecindex IIDacl
29594
29595
29596
29597 . ////////////////////////////////////////////////////////////////////////////
29598 . ////////////////////////////////////////////////////////////////////////////
29599
29600 .chapter "Content scanning at ACL time" "CHAPexiscan"
29601 .scindex IIDcosca "content scanning" "at ACL time"
29602 The extension of Exim to include content scanning at ACL time, formerly known
29603 as &"exiscan"&, was originally implemented as a patch by Tom Kistner. The code
29604 was integrated into the main source for Exim release 4.50, and Tom continues to
29605 maintain it. Most of the wording of this chapter is taken from Tom's
29606 specification.
29607
29608 It is also possible to scan the content of messages at other times. The
29609 &[local_scan()]& function (see chapter &<<CHAPlocalscan>>&) allows for content
29610 scanning after all the ACLs have run. A transport filter can be used to scan
29611 messages at delivery time (see the &%transport_filter%& option, described in
29612 chapter &<<CHAPtransportgeneric>>&).
29613
29614 If you want to include the ACL-time content-scanning features when you compile
29615 Exim, you need to arrange for WITH_CONTENT_SCAN to be defined in your
29616 &_Local/Makefile_&. When you do that, the Exim binary is built with:
29617
29618 .ilist
29619 Two additional ACLs (&%acl_smtp_mime%& and &%acl_not_smtp_mime%&) that are run
29620 for all MIME parts for SMTP and non-SMTP messages, respectively.
29621 .next
29622 Additional ACL conditions and modifiers: &%decode%&, &%malware%&,
29623 &%mime_regex%&, &%regex%&, and &%spam%&. These can be used in the ACL that is
29624 run at the end of message reception (the &%acl_smtp_data%& ACL).
29625 .next
29626 An additional control feature (&"no_mbox_unspool"&) that saves spooled copies
29627 of messages, or parts of messages, for debugging purposes.
29628 .next
29629 Additional expansion variables that are set in the new ACL and by the new
29630 conditions.
29631 .next
29632 Two new main configuration options: &%av_scanner%& and &%spamd_address%&.
29633 .endlist
29634
29635 There is another content-scanning configuration option for &_Local/Makefile_&,
29636 called WITH_OLD_DEMIME. If this is set, the old, deprecated &%demime%& ACL
29637 condition is compiled, in addition to all the other content-scanning features.
29638
29639 Content-scanning is continually evolving, and new features are still being
29640 added. While such features are still unstable and liable to incompatible
29641 changes, they are made available in Exim by setting options whose names begin
29642 EXPERIMENTAL_ in &_Local/Makefile_&. Such features are not documented in
29643 this manual. You can find out about them by reading the file called
29644 &_doc/experimental.txt_&.
29645
29646 All the content-scanning facilities work on a MBOX copy of the message that is
29647 temporarily created in a file called:
29648 .display
29649 <&'spool_directory'&>&`/scan/`&<&'message_id'&>/<&'message_id'&>&`.eml`&
29650 .endd
29651 The &_.eml_& extension is a friendly hint to virus scanners that they can
29652 expect an MBOX-like structure inside that file. The file is created when the
29653 first content scanning facility is called. Subsequent calls to content
29654 scanning conditions open the same file again. The directory is recursively
29655 removed when the &%acl_smtp_data%& ACL has finished running, unless
29656 .code
29657 control = no_mbox_unspool
29658 .endd
29659 has been encountered. When the MIME ACL decodes files, they are put into the
29660 same directory by default.
29661
29662
29663
29664 .section "Scanning for viruses" "SECTscanvirus"
29665 .cindex "virus scanning"
29666 .cindex "content scanning" "for viruses"
29667 .cindex "content scanning" "the &%malware%& condition"
29668 The &%malware%& ACL condition lets you connect virus scanner software to Exim.
29669 It supports a &"generic"& interface to scanners called via the shell, and
29670 specialized interfaces for &"daemon"& type virus scanners, which are resident
29671 in memory and thus are much faster.
29672
29673
29674 .oindex "&%av_scanner%&"
29675 You can set the &%av_scanner%& option in first part of the Exim configuration
29676 file to specify which scanner to use, together with any additional options that
29677 are needed. The basic syntax is as follows:
29678 .display
29679 &`av_scanner = <`&&'scanner-type'&&`>:<`&&'option1'&&`>:<`&&'option2'&&`>:[...]`&
29680 .endd
29681 If you do not set &%av_scanner%&, it defaults to
29682 .code
29683 av_scanner = sophie:/var/run/sophie
29684 .endd
29685 If the value of &%av_scanner%& starts with a dollar character, it is expanded
29686 before use.
29687 The usual list-parsing of the content (see &<<SECTlistconstruct>>&) applies.
29688 The following scanner types are supported in this release:
29689
29690 .vlist
29691 .vitem &%aveserver%&
29692 .cindex "virus scanners" "Kaspersky"
29693 This is the scanner daemon of Kaspersky Version 5. You can get a trial version
29694 at &url(http://www.kaspersky.com). This scanner type takes one option,
29695 which is the path to the daemon's UNIX socket. The default is shown in this
29696 example:
29697 .code
29698 av_scanner = aveserver:/var/run/aveserver
29699 .endd
29700
29701
29702 .vitem &%clamd%&
29703 .cindex "virus scanners" "clamd"
29704 This daemon-type scanner is GPL and free. You can get it at
29705 &url(http://www.clamav.net/). Some older versions of clamd do not seem to
29706 unpack MIME containers, so it used to be recommended to unpack MIME attachments
29707 in the MIME ACL. This no longer believed to be necessary. One option is
29708 required: either the path and name of a UNIX socket file, or a hostname or IP
29709 number, and a port, separated by space, as in the second of these examples:
29710 .code
29711 av_scanner = clamd:/opt/clamd/socket
29712 av_scanner = clamd:192.0.2.3 1234
29713 av_scanner = clamd:192.0.2.3 1234:local
29714 av_scanner = clamd:192.0.2.3 1234 : 192.0.2.4 1234
29715 .endd
29716 If the value of av_scanner points to a UNIX socket file or contains the local
29717 keyword, then the ClamAV interface will pass a filename containing the data
29718 to be scanned, which will should normally result in less I/O happening and be
29719 more efficient.  Normally in the TCP case, the data is streamed to ClamAV as
29720 Exim does not assume that there is a common filesystem with the remote host.
29721 There is an option WITH_OLD_CLAMAV_STREAM in &_src/EDITME_& available, should
29722 you be running a version of ClamAV prior to 0.95.
29723
29724 .new
29725 The final example shows that multiple TCP targets can be specified.  Exim will
29726 randomly use one for each incoming email (i.e. it load balances them).  Note
29727 that only TCP targets may be used if specifying a list of scanners; a UNIX
29728 socket cannot be mixed in with TCP targets.  If one of the servers becomes
29729 unavailable, Exim will try the remaining one(s) until it finds one that works.
29730 When a clamd server becomes unreachable, Exim will log a message.  Exim does
29731 not keep track of scanner state between multiple messages, and the scanner
29732 selection is random, so the message will get logged in the mainlog for each
29733 email that the down scanner gets chosen first (message wrapped to be readable):
29734 .code
29735 2013-10-09 14:30:39 1VTumd-0000Y8-BQ malware acl condition:
29736    clamd: connection to localhost, port 3310 failed
29737    (Connection refused)
29738 .endd
29739 .wen
29740
29741 If the option is unset, the default is &_/tmp/clamd_&. Thanks to David Saez for
29742 contributing the code for this scanner.
29743
29744 .vitem &%cmdline%&
29745 .cindex "virus scanners" "command line interface"
29746 This is the keyword for the generic command line scanner interface. It can be
29747 used to attach virus scanners that are invoked from the shell. This scanner
29748 type takes 3 mandatory options:
29749
29750 .olist
29751 The full path and name of the scanner binary, with all command line options,
29752 and a placeholder (&`%s`&) for the directory to scan.
29753
29754 .next
29755 A regular expression to match against the STDOUT and STDERR output of the
29756 virus scanner. If the expression matches, a virus was found. You must make
29757 absolutely sure that this expression matches on &"virus found"&. This is called
29758 the &"trigger"& expression.
29759
29760 .next
29761 Another regular expression, containing exactly one pair of parentheses, to
29762 match the name of the virus found in the scanners output. This is called the
29763 &"name"& expression.
29764 .endlist olist
29765
29766 For example, Sophos Sweep reports a virus on a line like this:
29767 .code
29768 Virus 'W32/Magistr-B' found in file ./those.bat
29769 .endd
29770 For the trigger expression, we can match the phrase &"found in file"&. For the
29771 name expression, we want to extract the W32/Magistr-B string, so we can match
29772 for the single quotes left and right of it. Altogether, this makes the
29773 configuration setting:
29774 .code
29775 av_scanner = cmdline:\
29776              /path/to/sweep -ss -all -rec -archive %s:\
29777              found in file:'(.+)'
29778 .endd
29779 .vitem &%drweb%&
29780 .cindex "virus scanners" "DrWeb"
29781 The DrWeb daemon scanner (&url(http://www.sald.com/)) interface takes one
29782 argument, either a full path to a UNIX socket, or an IP address and port
29783 separated by white space, as in these examples:
29784 .code
29785 av_scanner = drweb:/var/run/drwebd.sock
29786 av_scanner = drweb:192.168.2.20 31337
29787 .endd
29788 If you omit the argument, the default path &_/usr/local/drweb/run/drwebd.sock_&
29789 is used. Thanks to Alex Miller for contributing the code for this scanner.
29790
29791 .vitem &%fsecure%&
29792 .cindex "virus scanners" "F-Secure"
29793 The F-Secure daemon scanner (&url(http://www.f-secure.com)) takes one
29794 argument which is the path to a UNIX socket. For example:
29795 .code
29796 av_scanner = fsecure:/path/to/.fsav
29797 .endd
29798 If no argument is given, the default is &_/var/run/.fsav_&. Thanks to Johan
29799 Thelmen for contributing the code for this scanner.
29800
29801 .vitem &%kavdaemon%&
29802 .cindex "virus scanners" "Kaspersky"
29803 This is the scanner daemon of Kaspersky Version 4. This version of the
29804 Kaspersky scanner is outdated. Please upgrade (see &%aveserver%& above). This
29805 scanner type takes one option, which is the path to the daemon's UNIX socket.
29806 For example:
29807 .code
29808 av_scanner = kavdaemon:/opt/AVP/AvpCtl
29809 .endd
29810 The default path is &_/var/run/AvpCtl_&.
29811
29812 .vitem &%mksd%&
29813 .cindex "virus scanners" "mksd"
29814 This is a daemon type scanner that is aimed mainly at Polish users, though some
29815 parts of documentation are now available in English. You can get it at
29816 &url(http://linux.mks.com.pl/). The only option for this scanner type is
29817 the maximum number of processes used simultaneously to scan the attachments,
29818 provided that the demime facility is employed and also provided that mksd has
29819 been run with at least the same number of child processes. For example:
29820 .code
29821 av_scanner = mksd:2
29822 .endd
29823 You can safely omit this option (the default value is 1).
29824
29825 .vitem &%sophie%&
29826 .cindex "virus scanners" "Sophos and Sophie"
29827 Sophie is a daemon that uses Sophos' &%libsavi%& library to scan for viruses.
29828 You can get Sophie at &url(http://www.clanfield.info/sophie/). The only option
29829 for this scanner type is the path to the UNIX socket that Sophie uses for
29830 client communication. For example:
29831 .code
29832 av_scanner = sophie:/tmp/sophie
29833 .endd
29834 The default path is &_/var/run/sophie_&, so if you are using this, you can omit
29835 the option.
29836 .endlist
29837
29838 When &%av_scanner%& is correctly set, you can use the &%malware%& condition in
29839 the DATA ACL. &*Note*&: You cannot use the &%malware%& condition in the MIME
29840 ACL.
29841
29842 The &%av_scanner%& option is expanded each time &%malware%& is called. This
29843 makes it possible to use different scanners. See further below for an example.
29844 The &%malware%& condition caches its results, so when you use it multiple times
29845 for the same message, the actual scanning process is only carried out once.
29846 However, using expandable items in &%av_scanner%& disables this caching, in
29847 which case each use of the &%malware%& condition causes a new scan of the
29848 message.
29849
29850 The &%malware%& condition takes a right-hand argument that is expanded before
29851 use. It can then be one of
29852
29853 .ilist
29854 &"true"&, &"*"&, or &"1"&, in which case the message is scanned for viruses.
29855 The condition succeeds if a virus was found, and fail otherwise. This is the
29856 recommended usage.
29857 .next
29858 &"false"& or &"0"& or an empty string, in which case no scanning is done and
29859 the condition fails immediately.
29860 .next
29861 A regular expression, in which case the message is scanned for viruses. The
29862 condition succeeds if a virus is found and its name matches the regular
29863 expression. This allows you to take special actions on certain types of virus.
29864 .endlist
29865
29866 You can append &`/defer_ok`& to the &%malware%& condition to accept messages
29867 even if there is a problem with the virus scanner. Otherwise, such a problem
29868 causes the ACL to defer.
29869
29870 .vindex "&$malware_name$&"
29871 When a virus is found, the condition sets up an expansion variable called
29872 &$malware_name$& that contains the name of the virus. You can use it in a
29873 &%message%& modifier that specifies the error returned to the sender, and/or in
29874 logging data.
29875
29876 If your virus scanner cannot unpack MIME and TNEF containers itself, you should
29877 use the &%demime%& condition (see section &<<SECTdemimecond>>&) before the
29878 &%malware%& condition.
29879
29880 Beware the interaction of Exim's &%message_size_limit%& with any size limits
29881 imposed by your anti-virus scanner.
29882
29883 Here is a very simple scanning example:
29884 .code
29885 deny message = This message contains malware ($malware_name)
29886      demime = *
29887      malware = *
29888 .endd
29889 The next example accepts messages when there is a problem with the scanner:
29890 .code
29891 deny message = This message contains malware ($malware_name)
29892      demime = *
29893      malware = */defer_ok
29894 .endd
29895 The next example shows how to use an ACL variable to scan with both sophie and
29896 aveserver. It assumes you have set:
29897 .code
29898 av_scanner = $acl_m0
29899 .endd
29900 in the main Exim configuration.
29901 .code
29902 deny message = This message contains malware ($malware_name)
29903      set acl_m0 = sophie
29904      malware = *
29905
29906 deny message = This message contains malware ($malware_name)
29907      set acl_m0 = aveserver
29908      malware = *
29909 .endd
29910
29911
29912 .section "Scanning with SpamAssassin" "SECTscanspamass"
29913 .cindex "content scanning" "for spam"
29914 .cindex "spam scanning"
29915 .cindex "SpamAssassin"
29916 The &%spam%& ACL condition calls SpamAssassin's &%spamd%& daemon to get a spam
29917 score and a report for the message. You can get SpamAssassin at
29918 &url(http://www.spamassassin.org), or, if you have a working Perl
29919 installation, you can use CPAN by running:
29920 .code
29921 perl -MCPAN -e 'install Mail::SpamAssassin'
29922 .endd
29923 SpamAssassin has its own set of configuration files. Please review its
29924 documentation to see how you can tweak it. The default installation should work
29925 nicely, however.
29926
29927 .oindex "&%spamd_address%&"
29928 After having installed and configured SpamAssassin, start the &%spamd%& daemon.
29929 By default, it listens on 127.0.0.1, TCP port 783. If you use another host or
29930 port for &%spamd%&, you must set the &%spamd_address%& option in the global
29931 part of the Exim configuration as follows (example):
29932 .code
29933 spamd_address = 192.168.99.45 387
29934 .endd
29935 You do not need to set this option if you use the default. As of version 2.60,
29936 &%spamd%& also supports communication over UNIX sockets. If you want to use
29937 these, supply &%spamd_address%& with an absolute file name instead of a
29938 address/port pair:
29939 .code
29940 spamd_address = /var/run/spamd_socket
29941 .endd
29942 You can have multiple &%spamd%& servers to improve scalability. These can
29943 reside on other hardware reachable over the network. To specify multiple
29944 &%spamd%& servers, put multiple address/port pairs in the &%spamd_address%&
29945 option, separated with colons:
29946 .code
29947 spamd_address = 192.168.2.10 783 : \
29948                 192.168.2.11 783 : \
29949                 192.168.2.12 783
29950 .endd
29951 Up to 32 &%spamd%& servers are supported. The servers are queried in a random
29952 fashion. When a server fails to respond to the connection attempt, all other
29953 servers are tried until one succeeds. If no server responds, the &%spam%&
29954 condition defers.
29955
29956 &*Warning*&: It is not possible to use the UNIX socket connection method with
29957 multiple &%spamd%& servers.
29958
29959 The &%spamd_address%& variable is expanded before use if it starts with
29960 a dollar sign. In this case, the expansion may return a string that is
29961 used as the list so that multiple spamd servers can be the result of an
29962 expansion.
29963
29964 .section "Calling SpamAssassin from an Exim ACL" "SECID206"
29965 Here is a simple example of the use of the &%spam%& condition in a DATA ACL:
29966 .code
29967 deny message = This message was classified as SPAM
29968      spam = joe
29969 .endd
29970 The right-hand side of the &%spam%& condition specifies a name. This is
29971 relevant if you have set up multiple SpamAssassin profiles. If you do not want
29972 to scan using a specific profile, but rather use the SpamAssassin system-wide
29973 default profile, you can scan for an unknown name, or simply use &"nobody"&.
29974 However, you must put something on the right-hand side.
29975
29976 The name allows you to use per-domain or per-user antispam profiles in
29977 principle, but this is not straightforward in practice, because a message may
29978 have multiple recipients, not necessarily all in the same domain. Because the
29979 &%spam%& condition has to be called from a DATA ACL in order to be able to
29980 read the contents of the message, the variables &$local_part$& and &$domain$&
29981 are not set.
29982
29983 The right-hand side of the &%spam%& condition is expanded before being used, so
29984 you can put lookups or conditions there. When the right-hand side evaluates to
29985 &"0"& or &"false"&, no scanning is done and the condition fails immediately.
29986
29987
29988 Scanning with SpamAssassin uses a lot of resources. If you scan every message,
29989 large ones may cause significant performance degradation. As most spam messages
29990 are quite small, it is recommended that you do not scan the big ones. For
29991 example:
29992 .code
29993 deny message = This message was classified as SPAM
29994      condition = ${if < {$message_size}{10K}}
29995      spam = nobody
29996 .endd
29997
29998 The &%spam%& condition returns true if the threshold specified in the user's
29999 SpamAssassin profile has been matched or exceeded. If you want to use the
30000 &%spam%& condition for its side effects (see the variables below), you can make
30001 it always return &"true"& by appending &`:true`& to the username.
30002
30003 .cindex "spam scanning" "returned variables"
30004 When the &%spam%& condition is run, it sets up a number of expansion
30005 variables. These variables are saved with the received message, thus they are
30006 available for use at delivery time.
30007
30008 .vlist
30009 .vitem &$spam_score$&
30010 The spam score of the message, for example &"3.4"& or &"30.5"&. This is useful
30011 for inclusion in log or reject messages.
30012
30013 .vitem &$spam_score_int$&
30014 The spam score of the message, multiplied by ten, as an integer value. For
30015 example &"34"& or &"305"&. It may appear to disagree with &$spam_score$&
30016 because &$spam_score$& is rounded and &$spam_score_int$& is truncated.
30017 The integer value is useful for numeric comparisons in conditions.
30018
30019 .vitem &$spam_bar$&
30020 A string consisting of a number of &"+"& or &"-"& characters, representing the
30021 integer part of the spam score value. A spam score of 4.4 would have a
30022 &$spam_bar$& value of &"++++"&. This is useful for inclusion in warning
30023 headers, since MUAs can match on such strings.
30024
30025 .vitem &$spam_report$&
30026 A multiline text table, containing the full SpamAssassin report for the
30027 message. Useful for inclusion in headers or reject messages.
30028 .endlist
30029
30030 The &%spam%& condition caches its results unless expansion in
30031 spamd_address was used. If you call it again with the same user name, it
30032 does not scan again, but rather returns the same values as before.
30033
30034 The &%spam%& condition returns DEFER if there is any error while running
30035 the message through SpamAssassin or if the expansion of spamd_address
30036 failed. If you want to treat DEFER as FAIL (to pass on to the next ACL
30037 statement block), append &`/defer_ok`& to the right-hand side of the
30038 spam condition, like this:
30039 .code
30040 deny message = This message was classified as SPAM
30041      spam    = joe/defer_ok
30042 .endd
30043 This causes messages to be accepted even if there is a problem with &%spamd%&.
30044
30045 Here is a longer, commented example of the use of the &%spam%&
30046 condition:
30047 .code
30048 # put headers in all messages (no matter if spam or not)
30049 warn  spam = nobody:true
30050       add_header = X-Spam-Score: $spam_score ($spam_bar)
30051       add_header = X-Spam-Report: $spam_report
30052
30053 # add second subject line with *SPAM* marker when message
30054 # is over threshold
30055 warn  spam = nobody
30056       add_header = Subject: *SPAM* $h_Subject:
30057
30058 # reject spam at high scores (> 12)
30059 deny  message = This message scored $spam_score spam points.
30060       spam = nobody:true
30061       condition = ${if >{$spam_score_int}{120}{1}{0}}
30062 .endd
30063
30064
30065
30066 .section "Scanning MIME parts" "SECTscanmimepart"
30067 .cindex "content scanning" "MIME parts"
30068 .cindex "MIME content scanning"
30069 .oindex "&%acl_smtp_mime%&"
30070 .oindex "&%acl_not_smtp_mime%&"
30071 The &%acl_smtp_mime%& global option specifies an ACL that is called once for
30072 each MIME part of an SMTP message, including multipart types, in the sequence
30073 of their position in the message. Similarly, the &%acl_not_smtp_mime%& option
30074 specifies an ACL that is used for the MIME parts of non-SMTP messages. These
30075 options may both refer to the same ACL if you want the same processing in both
30076 cases.
30077
30078 These ACLs are called (possibly many times) just before the &%acl_smtp_data%&
30079 ACL in the case of an SMTP message, or just before the &%acl_not_smtp%& ACL in
30080 the case of a non-SMTP message. However, a MIME ACL is called only if the
30081 message contains a &'Content-Type:'& header line. When a call to a MIME
30082 ACL does not yield &"accept"&, ACL processing is aborted and the appropriate
30083 result code is sent to the client. In the case of an SMTP message, the
30084 &%acl_smtp_data%& ACL is not called when this happens.
30085
30086 You cannot use the &%malware%& or &%spam%& conditions in a MIME ACL; these can
30087 only be used in the DATA or non-SMTP ACLs. However, you can use the &%regex%&
30088 condition to match against the raw MIME part. You can also use the
30089 &%mime_regex%& condition to match against the decoded MIME part (see section
30090 &<<SECTscanregex>>&).
30091
30092 At the start of a MIME ACL, a number of variables are set from the header
30093 information for the relevant MIME part. These are described below. The contents
30094 of the MIME part are not by default decoded into a disk file except for MIME
30095 parts whose content-type is &"message/rfc822"&. If you want to decode a MIME
30096 part into a disk file, you can use the &%decode%& condition. The general
30097 syntax is:
30098 .display
30099 &`decode = [/`&<&'path'&>&`/]`&<&'filename'&>
30100 .endd
30101 The right hand side is expanded before use. After expansion,
30102 the value can be:
30103
30104 .olist
30105 &"0"& or &"false"&, in which case no decoding is done.
30106 .next
30107 The string &"default"&. In that case, the file is put in the temporary
30108 &"default"& directory <&'spool_directory'&>&_/scan/_&<&'message_id'&>&_/_& with
30109 a sequential file name consisting of the message id and a sequence number. The
30110 full path and name is available in &$mime_decoded_filename$& after decoding.
30111 .next
30112 A full path name starting with a slash. If the full name is an existing
30113 directory, it is used as a replacement for the default directory. The filename
30114 is then sequentially assigned. If the path does not exist, it is used as
30115 the full path and file name.
30116 .next
30117 If the string does not start with a slash, it is used as the
30118 filename, and the default path is then used.
30119 .endlist
30120 The &%decode%& condition normally succeeds. It is only false for syntax
30121 errors or unusual circumstances such as memory shortages. You can easily decode
30122 a file with its original, proposed filename using
30123 .code
30124 decode = $mime_filename
30125 .endd
30126 However, you should keep in mind that &$mime_filename$& might contain
30127 anything. If you place files outside of the default path, they are not
30128 automatically unlinked.
30129
30130 For RFC822 attachments (these are messages attached to messages, with a
30131 content-type of &"message/rfc822"&), the ACL is called again in the same manner
30132 as for the primary message, only that the &$mime_is_rfc822$& expansion
30133 variable is set (see below). Attached messages are always decoded to disk
30134 before being checked, and the files are unlinked once the check is done.
30135
30136 The MIME ACL supports the &%regex%& and &%mime_regex%& conditions. These can be
30137 used to match regular expressions against raw and decoded MIME parts,
30138 respectively. They are described in section &<<SECTscanregex>>&.
30139
30140 .cindex "MIME content scanning" "returned variables"
30141 The following list describes all expansion variables that are
30142 available in the MIME ACL:
30143
30144 .vlist
30145 .vitem &$mime_boundary$&
30146 If the current part is a multipart (see &$mime_is_multipart$&) below, it should
30147 have a boundary string, which is stored in this variable. If the current part
30148 has no boundary parameter in the &'Content-Type:'& header, this variable
30149 contains the empty string.
30150
30151 .vitem &$mime_charset$&
30152 This variable contains the character set identifier, if one was found in the
30153 &'Content-Type:'& header. Examples for charset identifiers are:
30154 .code
30155 us-ascii
30156 gb2312 (Chinese)
30157 iso-8859-1
30158 .endd
30159 Please note that this value is not normalized, so you should do matches
30160 case-insensitively.
30161
30162 .vitem &$mime_content_description$&
30163 This variable contains the normalized content of the &'Content-Description:'&
30164 header. It can contain a human-readable description of the parts content. Some
30165 implementations repeat the filename for attachments here, but they are usually
30166 only used for display purposes.
30167
30168 .vitem &$mime_content_disposition$&
30169 This variable contains the normalized content of the &'Content-Disposition:'&
30170 header. You can expect strings like &"attachment"& or &"inline"& here.
30171
30172 .vitem &$mime_content_id$&
30173 This variable contains the normalized content of the &'Content-ID:'& header.
30174 This is a unique ID that can be used to reference a part from another part.
30175
30176 .vitem &$mime_content_size$&
30177 This variable is set only after the &%decode%& modifier (see above) has been
30178 successfully run. It contains the size of the decoded part in kilobytes. The
30179 size is always rounded up to full kilobytes, so only a completely empty part
30180 has a &$mime_content_size$& of zero.
30181
30182 .vitem &$mime_content_transfer_encoding$&
30183 This variable contains the normalized content of the
30184 &'Content-transfer-encoding:'& header. This is a symbolic name for an encoding
30185 type. Typical values are &"base64"& and &"quoted-printable"&.
30186
30187 .vitem &$mime_content_type$&
30188 If the MIME part has a &'Content-Type:'& header, this variable contains its
30189 value, lowercased, and without any options (like &"name"& or &"charset"&). Here
30190 are some examples of popular MIME types, as they may appear in this variable:
30191 .code
30192 text/plain
30193 text/html
30194 application/octet-stream
30195 image/jpeg
30196 audio/midi
30197 .endd
30198 If the MIME part has no &'Content-Type:'& header, this variable contains the
30199 empty string.
30200
30201 .vitem &$mime_decoded_filename$&
30202 This variable is set only after the &%decode%& modifier (see above) has been
30203 successfully run. It contains the full path and file name of the file
30204 containing the decoded data.
30205 .endlist
30206
30207 .cindex "RFC 2047"
30208 .vlist
30209 .vitem &$mime_filename$&
30210 This is perhaps the most important of the MIME variables. It contains a
30211 proposed filename for an attachment, if one was found in either the
30212 &'Content-Type:'& or &'Content-Disposition:'& headers. The filename will be
30213 RFC2047 decoded, but no additional sanity checks are done. If no filename was
30214 found, this variable contains the empty string.
30215
30216 .vitem &$mime_is_coverletter$&
30217 This variable attempts to differentiate the &"cover letter"& of an e-mail from
30218 attached data. It can be used to clamp down on flashy or unnecessarily encoded
30219 content in the cover letter, while not restricting attachments at all.
30220
30221 The variable contains 1 (true) for a MIME part believed to be part of the
30222 cover letter, and 0 (false) for an attachment. At present, the algorithm is as
30223 follows:
30224
30225 .olist
30226 The outermost MIME part of a message is always a cover letter.
30227
30228 .next
30229 If a multipart/alternative or multipart/related MIME part is a cover letter,
30230 so are all MIME subparts within that multipart.
30231
30232 .next
30233 If any other multipart is a cover letter, the first subpart is a cover letter,
30234 and the rest are attachments.
30235
30236 .next
30237 All parts contained within an attachment multipart are attachments.
30238 .endlist olist
30239
30240 As an example, the following will ban &"HTML mail"& (including that sent with
30241 alternative plain text), while allowing HTML files to be attached. HTML
30242 coverletter mail attached to non-HMTL coverletter mail will also be allowed:
30243 .code
30244 deny message = HTML mail is not accepted here
30245 !condition = $mime_is_rfc822
30246 condition = $mime_is_coverletter
30247 condition = ${if eq{$mime_content_type}{text/html}{1}{0}}
30248 .endd
30249 .vitem &$mime_is_multipart$&
30250 This variable has the value 1 (true) when the current part has the main type
30251 &"multipart"&, for example &"multipart/alternative"& or &"multipart/mixed"&.
30252 Since multipart entities only serve as containers for other parts, you may not
30253 want to carry out specific actions on them.
30254
30255 .vitem &$mime_is_rfc822$&
30256 This variable has the value 1 (true) if the current part is not a part of the
30257 checked message itself, but part of an attached message. Attached message
30258 decoding is fully recursive.
30259
30260 .vitem &$mime_part_count$&
30261 This variable is a counter that is raised for each processed MIME part. It
30262 starts at zero for the very first part (which is usually a multipart). The
30263 counter is per-message, so it is reset when processing RFC822 attachments (see
30264 &$mime_is_rfc822$&). The counter stays set after &%acl_smtp_mime%& is
30265 complete, so you can use it in the DATA ACL to determine the number of MIME
30266 parts of a message. For non-MIME messages, this variable contains the value -1.
30267 .endlist
30268
30269
30270
30271 .section "Scanning with regular expressions" "SECTscanregex"
30272 .cindex "content scanning" "with regular expressions"
30273 .cindex "regular expressions" "content scanning with"
30274 You can specify your own custom regular expression matches on the full body of
30275 the message, or on individual MIME parts.
30276
30277 The &%regex%& condition takes one or more regular expressions as arguments and
30278 matches them against the full message (when called in the DATA ACL) or a raw
30279 MIME part (when called in the MIME ACL). The &%regex%& condition matches
30280 linewise, with a maximum line length of 32K characters. That means you cannot
30281 have multiline matches with the &%regex%& condition.
30282
30283 The &%mime_regex%& condition can be called only in the MIME ACL. It matches up
30284 to 32K of decoded content (the whole content at once, not linewise). If the
30285 part has not been decoded with the &%decode%& modifier earlier in the ACL, it
30286 is decoded automatically when &%mime_regex%& is executed (using default path
30287 and filename values). If the decoded data is larger than  32K, only the first
30288 32K characters are checked.
30289
30290 The regular expressions are passed as a colon-separated list. To include a
30291 literal colon, you must double it. Since the whole right-hand side string is
30292 expanded before being used, you must also escape dollar signs and backslashes
30293 with more backslashes, or use the &`\N`& facility to disable expansion.
30294 Here is a simple example that contains two regular expressions:
30295 .code
30296 deny message = contains blacklisted regex ($regex_match_string)
30297      regex = [Mm]ortgage : URGENT BUSINESS PROPOSAL
30298 .endd
30299 The conditions returns true if any one of the regular expressions matches. The
30300 &$regex_match_string$& expansion variable is then set up and contains the
30301 matching regular expression.
30302
30303 &*Warning*&: With large messages, these conditions can be fairly
30304 CPU-intensive.
30305
30306
30307
30308
30309 .section "The demime condition" "SECTdemimecond"
30310 .cindex "content scanning" "MIME checking"
30311 .cindex "MIME content scanning"
30312 The &%demime%& ACL condition provides MIME unpacking, sanity checking and file
30313 extension blocking. It is usable only in the DATA and non-SMTP ACLs. The
30314 &%demime%& condition uses a simpler interface to MIME decoding than the MIME
30315 ACL functionality, but provides no additional facilities. Please note that this
30316 condition is deprecated and kept only for backward compatibility. You must set
30317 the WITH_OLD_DEMIME option in &_Local/Makefile_& at build time to be able to
30318 use the &%demime%& condition.
30319
30320 The &%demime%& condition unpacks MIME containers in the message. It detects
30321 errors in MIME containers and can match file extensions found in the message
30322 against a list. Using this facility produces files containing the unpacked MIME
30323 parts of the message in the temporary scan directory. If you do antivirus
30324 scanning, it is recommended that you use the &%demime%& condition before the
30325 antivirus (&%malware%&) condition.
30326
30327 On the right-hand side of the &%demime%& condition you can pass a
30328 colon-separated list of file extensions that it should match against. For
30329 example:
30330 .code
30331 deny message = Found blacklisted file attachment
30332      demime  = vbs:com:bat:pif:prf:lnk
30333 .endd
30334 If one of the file extensions is found, the condition is true, otherwise it is
30335 false. If there is a temporary error while demimeing (for example, &"disk
30336 full"&), the condition defers, and the message is temporarily rejected (unless
30337 the condition is on a &%warn%& verb).
30338
30339 The right-hand side is expanded before being treated as a list, so you can have
30340 conditions and lookups there. If it expands to an empty string, &"false"&, or
30341 zero (&"0"&), no demimeing is done and the condition is false.
30342
30343 The &%demime%& condition set the following variables:
30344
30345 .vlist
30346 .vitem &$demime_errorlevel$&
30347 .vindex "&$demime_errorlevel$&"
30348 When an error is detected in a MIME container, this variable contains the
30349 severity of the error, as an integer number. The higher the value, the more
30350 severe the error (the current maximum value is 3). If this variable is unset or
30351 zero, no error occurred.
30352
30353 .vitem &$demime_reason$&
30354 .vindex "&$demime_reason$&"
30355 When &$demime_errorlevel$& is greater than zero, this variable contains a
30356 human-readable text string describing the MIME error that occurred.
30357 .endlist
30358
30359 .vlist
30360 .vitem &$found_extension$&
30361 .vindex "&$found_extension$&"
30362 When the &%demime%& condition is true, this variable contains the file
30363 extension it found.
30364 .endlist
30365
30366 Both &$demime_errorlevel$& and &$demime_reason$& are set by the first call of
30367 the &%demime%& condition, and are not changed on subsequent calls.
30368
30369 If you do not want to check for file extensions, but rather use the &%demime%&
30370 condition for unpacking or error checking purposes, pass &"*"& as the
30371 right-hand side value. Here is a more elaborate example of how to use this
30372 facility:
30373 .code
30374 # Reject messages with serious MIME container errors
30375 deny  message = Found MIME error ($demime_reason).
30376       demime = *
30377       condition = ${if >{$demime_errorlevel}{2}{1}{0}}
30378
30379 # Reject known virus spreading file extensions.
30380 # Accepting these is pretty much braindead.
30381 deny  message = contains $found_extension file (blacklisted).
30382       demime  = com:vbs:bat:pif:scr
30383
30384 # Freeze .exe and .doc files. Postmaster can
30385 # examine them and eventually thaw them.
30386 deny  log_message = Another $found_extension file.
30387       demime = exe:doc
30388       control = freeze
30389 .endd
30390 .ecindex IIDcosca
30391
30392
30393
30394
30395 . ////////////////////////////////////////////////////////////////////////////
30396 . ////////////////////////////////////////////////////////////////////////////
30397
30398 .chapter "Adding a local scan function to Exim" "CHAPlocalscan" &&&
30399          "Local scan function"
30400 .scindex IIDlosca "&[local_scan()]& function" "description of"
30401 .cindex "customizing" "input scan using C function"
30402 .cindex "policy control" "by local scan function"
30403 In these days of email worms, viruses, and ever-increasing spam, some sites
30404 want to apply a lot of checking to messages before accepting them.
30405
30406 The content scanning extension (chapter &<<CHAPexiscan>>&) has facilities for
30407 passing messages to external virus and spam scanning software. You can also do
30408 a certain amount in Exim itself through string expansions and the &%condition%&
30409 condition in the ACL that runs after the SMTP DATA command or the ACL for
30410 non-SMTP messages (see chapter &<<CHAPACL>>&), but this has its limitations.
30411
30412 To allow for further customization to a site's own requirements, there is the
30413 possibility of linking Exim with a private message scanning function, written
30414 in C. If you want to run code that is written in something other than C, you
30415 can of course use a little C stub to call it.
30416
30417 The local scan function is run once for every incoming message, at the point
30418 when Exim is just about to accept the message.
30419 It can therefore be used to control non-SMTP messages from local processes as
30420 well as messages arriving via SMTP.
30421
30422 Exim applies a timeout to calls of the local scan function, and there is an
30423 option called &%local_scan_timeout%& for setting it. The default is 5 minutes.
30424 Zero means &"no timeout"&.
30425 Exim also sets up signal handlers for SIGSEGV, SIGILL, SIGFPE, and SIGBUS
30426 before calling the local scan function, so that the most common types of crash
30427 are caught. If the timeout is exceeded or one of those signals is caught, the
30428 incoming message is rejected with a temporary error if it is an SMTP message.
30429 For a non-SMTP message, the message is dropped and Exim ends with a non-zero
30430 code. The incident is logged on the main and reject logs.
30431
30432
30433
30434 .section "Building Exim to use a local scan function" "SECID207"
30435 .cindex "&[local_scan()]& function" "building Exim to use"
30436 To make use of the local scan function feature, you must tell Exim where your
30437 function is before building Exim, by setting LOCAL_SCAN_SOURCE in your
30438 &_Local/Makefile_&. A recommended place to put it is in the &_Local_&
30439 directory, so you might set
30440 .code
30441 LOCAL_SCAN_SOURCE=Local/local_scan.c
30442 .endd
30443 for example. The function must be called &[local_scan()]&. It is called by
30444 Exim after it has received a message, when the success return code is about to
30445 be sent. This is after all the ACLs have been run. The return code from your
30446 function controls whether the message is actually accepted or not. There is a
30447 commented template function (that just accepts the message) in the file
30448 _src/local_scan.c_.
30449
30450 If you want to make use of Exim's run time configuration file to set options
30451 for your &[local_scan()]& function, you must also set
30452 .code
30453 LOCAL_SCAN_HAS_OPTIONS=yes
30454 .endd
30455 in &_Local/Makefile_& (see section &<<SECTconoptloc>>& below).
30456
30457
30458
30459
30460 .section "API for local_scan()" "SECTapiforloc"
30461 .cindex "&[local_scan()]& function" "API description"
30462 You must include this line near the start of your code:
30463 .code
30464 #include "local_scan.h"
30465 .endd
30466 This header file defines a number of variables and other values, and the
30467 prototype for the function itself. Exim is coded to use unsigned char values
30468 almost exclusively, and one of the things this header defines is a shorthand
30469 for &`unsigned char`& called &`uschar`&.
30470 It also contains the following macro definitions, to simplify casting character
30471 strings and pointers to character strings:
30472 .code
30473 #define CS   (char *)
30474 #define CCS  (const char *)
30475 #define CSS  (char **)
30476 #define US   (unsigned char *)
30477 #define CUS  (const unsigned char *)
30478 #define USS  (unsigned char **)
30479 .endd
30480 The function prototype for &[local_scan()]& is:
30481 .code
30482 extern int local_scan(int fd, uschar **return_text);
30483 .endd
30484 The arguments are as follows:
30485
30486 .ilist
30487 &%fd%& is a file descriptor for the file that contains the body of the message
30488 (the -D file). The file is open for reading and writing, but updating it is not
30489 recommended. &*Warning*&: You must &'not'& close this file descriptor.
30490
30491 The descriptor is positioned at character 19 of the file, which is the first
30492 character of the body itself, because the first 19 characters are the message
30493 id followed by &`-D`& and a newline. If you rewind the file, you should use the
30494 macro SPOOL_DATA_START_OFFSET to reset to the start of the data, just in
30495 case this changes in some future version.
30496 .next
30497 &%return_text%& is an address which you can use to return a pointer to a text
30498 string at the end of the function. The value it points to on entry is NULL.
30499 .endlist
30500
30501 The function must return an &%int%& value which is one of the following macros:
30502
30503 .vlist
30504 .vitem &`LOCAL_SCAN_ACCEPT`&
30505 .vindex "&$local_scan_data$&"
30506 The message is accepted. If you pass back a string of text, it is saved with
30507 the message, and made available in the variable &$local_scan_data$&. No
30508 newlines are permitted (if there are any, they are turned into spaces) and the
30509 maximum length of text is 1000 characters.
30510
30511 .vitem &`LOCAL_SCAN_ACCEPT_FREEZE`&
30512 This behaves as LOCAL_SCAN_ACCEPT, except that the accepted message is
30513 queued without immediate delivery, and is frozen.
30514
30515 .vitem &`LOCAL_SCAN_ACCEPT_QUEUE`&
30516 This behaves as LOCAL_SCAN_ACCEPT, except that the accepted message is
30517 queued without immediate delivery.
30518
30519 .vitem &`LOCAL_SCAN_REJECT`&
30520 The message is rejected; the returned text is used as an error message which is
30521 passed back to the sender and which is also logged. Newlines are permitted &--
30522 they cause a multiline response for SMTP rejections, but are converted to
30523 &`\n`& in log lines. If no message is given, &"Administrative prohibition"& is
30524 used.
30525
30526 .vitem &`LOCAL_SCAN_TEMPREJECT`&
30527 The message is temporarily rejected; the returned text is used as an error
30528 message as for LOCAL_SCAN_REJECT. If no message is given, &"Temporary local
30529 problem"& is used.
30530
30531 .vitem &`LOCAL_SCAN_REJECT_NOLOGHDR`&
30532 This behaves as LOCAL_SCAN_REJECT, except that the header of the rejected
30533 message is not written to the reject log. It has the effect of unsetting the
30534 &%rejected_header%& log selector for just this rejection. If
30535 &%rejected_header%& is already unset (see the discussion of the
30536 &%log_selection%& option in section &<<SECTlogselector>>&), this code is the
30537 same as LOCAL_SCAN_REJECT.
30538
30539 .vitem &`LOCAL_SCAN_TEMPREJECT_NOLOGHDR`&
30540 This code is a variation of LOCAL_SCAN_TEMPREJECT in the same way that
30541 LOCAL_SCAN_REJECT_NOLOGHDR is a variation of LOCAL_SCAN_REJECT.
30542 .endlist
30543
30544 If the message is not being received by interactive SMTP, rejections are
30545 reported by writing to &%stderr%& or by sending an email, as configured by the
30546 &%-oe%& command line options.
30547
30548
30549
30550 .section "Configuration options for local_scan()" "SECTconoptloc"
30551 .cindex "&[local_scan()]& function" "configuration options"
30552 It is possible to have option settings in the main configuration file
30553 that set values in static variables in the &[local_scan()]& module. If you
30554 want to do this, you must have the line
30555 .code
30556 LOCAL_SCAN_HAS_OPTIONS=yes
30557 .endd
30558 in your &_Local/Makefile_& when you build Exim. (This line is in
30559 &_OS/Makefile-Default_&, commented out). Then, in the &[local_scan()]& source
30560 file, you must define static variables to hold the option values, and a table
30561 to define them.
30562
30563 The table must be a vector called &%local_scan_options%&, of type
30564 &`optionlist`&. Each entry is a triplet, consisting of a name, an option type,
30565 and a pointer to the variable that holds the value. The entries must appear in
30566 alphabetical order. Following &%local_scan_options%& you must also define a
30567 variable called &%local_scan_options_count%& that contains the number of
30568 entries in the table. Here is a short example, showing two kinds of option:
30569 .code
30570 static int my_integer_option = 42;
30571 static uschar *my_string_option = US"a default string";
30572
30573 optionlist local_scan_options[] = {
30574   { "my_integer", opt_int,       &my_integer_option },
30575   { "my_string",  opt_stringptr, &my_string_option }
30576 };
30577
30578 int local_scan_options_count =
30579   sizeof(local_scan_options)/sizeof(optionlist);
30580 .endd
30581 The values of the variables can now be changed from Exim's runtime
30582 configuration file by including a local scan section as in this example:
30583 .code
30584 begin local_scan
30585 my_integer = 99
30586 my_string = some string of text...
30587 .endd
30588 The available types of option data are as follows:
30589
30590 .vlist
30591 .vitem &*opt_bool*&
30592 This specifies a boolean (true/false) option. The address should point to a
30593 variable of type &`BOOL`&, which will be set to TRUE or FALSE, which are macros
30594 that are defined as &"1"& and &"0"&, respectively. If you want to detect
30595 whether such a variable has been set at all, you can initialize it to
30596 TRUE_UNSET. (BOOL variables are integers underneath, so can hold more than two
30597 values.)
30598
30599 .vitem &*opt_fixed*&
30600 This specifies a fixed point number, such as is used for load averages.
30601 The address should point to a variable of type &`int`&. The value is stored
30602 multiplied by 1000, so, for example, 1.4142 is truncated and stored as 1414.
30603
30604 .vitem &*opt_int*&
30605 This specifies an integer; the address should point to a variable of type
30606 &`int`&. The value may be specified in any of the integer formats accepted by
30607 Exim.
30608
30609 .vitem &*opt_mkint*&
30610 This is the same as &%opt_int%&, except that when such a value is output in a
30611 &%-bP%& listing, if it is an exact number of kilobytes or megabytes, it is
30612 printed with the suffix K or M.
30613
30614 .vitem &*opt_octint*&
30615 This also specifies an integer, but the value is always interpreted as an
30616 octal integer, whether or not it starts with the digit zero, and it is
30617 always output in octal.
30618
30619 .vitem &*opt_stringptr*&
30620 This specifies a string value; the address must be a pointer to a
30621 variable that points to a string (for example, of type &`uschar *`&).
30622
30623 .vitem &*opt_time*&
30624 This specifies a time interval value. The address must point to a variable of
30625 type &`int`&. The value that is placed there is a number of seconds.
30626 .endlist
30627
30628 If the &%-bP%& command line option is followed by &`local_scan`&, Exim prints
30629 out the values of all the &[local_scan()]& options.
30630
30631
30632
30633 .section "Available Exim variables" "SECID208"
30634 .cindex "&[local_scan()]& function" "available Exim variables"
30635 The header &_local_scan.h_& gives you access to a number of C variables. These
30636 are the only ones that are guaranteed to be maintained from release to release.
30637 Note, however, that you can obtain the value of any Exim expansion variable,
30638 including &$recipients$&, by calling &'expand_string()'&. The exported
30639 C variables are as follows:
30640
30641 .vlist
30642 .vitem &*int&~body_linecount*&
30643 This variable contains the number of lines in the message's body.
30644
30645 .vitem &*int&~body_zerocount*&
30646 This variable contains the number of binary zero bytes in the message's body.
30647
30648 .vitem &*unsigned&~int&~debug_selector*&
30649 This variable is set to zero when no debugging is taking place. Otherwise, it
30650 is a bitmap of debugging selectors. Two bits are identified for use in
30651 &[local_scan()]&; they are defined as macros:
30652
30653 .ilist
30654 The &`D_v`& bit is set when &%-v%& was present on the command line. This is a
30655 testing option that is not privileged &-- any caller may set it. All the
30656 other selector bits can be set only by admin users.
30657
30658 .next
30659 The &`D_local_scan`& bit is provided for use by &[local_scan()]&; it is set
30660 by the &`+local_scan`& debug selector. It is not included in the default set
30661 of debugging bits.
30662 .endlist ilist
30663
30664 Thus, to write to the debugging output only when &`+local_scan`& has been
30665 selected, you should use code like this:
30666 .code
30667 if ((debug_selector & D_local_scan) != 0)
30668   debug_printf("xxx", ...);
30669 .endd
30670 .vitem &*uschar&~*expand_string_message*&
30671 After a failing call to &'expand_string()'& (returned value NULL), the
30672 variable &%expand_string_message%& contains the error message, zero-terminated.
30673
30674 .vitem &*header_line&~*header_list*&
30675 A pointer to a chain of header lines. The &%header_line%& structure is
30676 discussed below.
30677
30678 .vitem &*header_line&~*header_last*&
30679 A pointer to the last of the header lines.
30680
30681 .vitem &*uschar&~*headers_charset*&
30682 The value of the &%headers_charset%& configuration option.
30683
30684 .vitem &*BOOL&~host_checking*&
30685 This variable is TRUE during a host checking session that is initiated by the
30686 &%-bh%& command line option.
30687
30688 .vitem &*uschar&~*interface_address*&
30689 The IP address of the interface that received the message, as a string. This
30690 is NULL for locally submitted messages.
30691
30692 .vitem &*int&~interface_port*&
30693 The port on which this message was received. When testing with the &%-bh%&
30694 command line option, the value of this variable is -1 unless a port has been
30695 specified via the &%-oMi%& option.
30696
30697 .vitem &*uschar&~*message_id*&
30698 This variable contains Exim's message id for the incoming message (the value of
30699 &$message_exim_id$&) as a zero-terminated string.
30700
30701 .vitem &*uschar&~*received_protocol*&
30702 The name of the protocol by which the message was received.
30703
30704 .vitem &*int&~recipients_count*&
30705 The number of accepted recipients.
30706
30707 .vitem &*recipient_item&~*recipients_list*&
30708 .cindex "recipient" "adding in local scan"
30709 .cindex "recipient" "removing in local scan"
30710 The list of accepted recipients, held in a vector of length
30711 &%recipients_count%&. The &%recipient_item%& structure is discussed below. You
30712 can add additional recipients by calling &'receive_add_recipient()'& (see
30713 below). You can delete recipients by removing them from the vector and
30714 adjusting the value in &%recipients_count%&. In particular, by setting
30715 &%recipients_count%& to zero you remove all recipients. If you then return the
30716 value &`LOCAL_SCAN_ACCEPT`&, the message is accepted, but immediately
30717 blackholed. To replace the recipients, you can set &%recipients_count%& to zero
30718 and then call &'receive_add_recipient()'& as often as needed.
30719
30720 .vitem &*uschar&~*sender_address*&
30721 The envelope sender address. For bounce messages this is the empty string.
30722
30723 .vitem &*uschar&~*sender_host_address*&
30724 The IP address of the sending host, as a string. This is NULL for
30725 locally-submitted messages.
30726
30727 .vitem &*uschar&~*sender_host_authenticated*&
30728 The name of the authentication mechanism that was used, or NULL if the message
30729 was not received over an authenticated SMTP connection.
30730
30731 .vitem &*uschar&~*sender_host_name*&
30732 The name of the sending host, if known.
30733
30734 .vitem &*int&~sender_host_port*&
30735 The port on the sending host.
30736
30737 .vitem &*BOOL&~smtp_input*&
30738 This variable is TRUE for all SMTP input, including BSMTP.
30739
30740 .vitem &*BOOL&~smtp_batched_input*&
30741 This variable is TRUE for BSMTP input.
30742
30743 .vitem &*int&~store_pool*&
30744 The contents of this variable control which pool of memory is used for new
30745 requests. See section &<<SECTmemhanloc>>& for details.
30746 .endlist
30747
30748
30749 .section "Structure of header lines" "SECID209"
30750 The &%header_line%& structure contains the members listed below.
30751 You can add additional header lines by calling the &'header_add()'& function
30752 (see below). You can cause header lines to be ignored (deleted) by setting
30753 their type to *.
30754
30755
30756 .vlist
30757 .vitem &*struct&~header_line&~*next*&
30758 A pointer to the next header line, or NULL for the last line.
30759
30760 .vitem &*int&~type*&
30761 A code identifying certain headers that Exim recognizes. The codes are printing
30762 characters, and are documented in chapter &<<CHAPspool>>& of this manual.
30763 Notice in particular that any header line whose type is * is not transmitted
30764 with the message. This flagging is used for header lines that have been
30765 rewritten, or are to be removed (for example, &'Envelope-sender:'& header
30766 lines.) Effectively, * means &"deleted"&.
30767
30768 .vitem &*int&~slen*&
30769 The number of characters in the header line, including the terminating and any
30770 internal newlines.
30771
30772 .vitem &*uschar&~*text*&
30773 A pointer to the text of the header. It always ends with a newline, followed by
30774 a zero byte. Internal newlines are preserved.
30775 .endlist
30776
30777
30778
30779 .section "Structure of recipient items" "SECID210"
30780 The &%recipient_item%& structure contains these members:
30781
30782 .vlist
30783 .vitem &*uschar&~*address*&
30784 This is a pointer to the recipient address as it was received.
30785
30786 .vitem &*int&~pno*&
30787 This is used in later Exim processing when top level addresses are created by
30788 the &%one_time%& option. It is not relevant at the time &[local_scan()]& is run
30789 and must always contain -1 at this stage.
30790
30791 .vitem &*uschar&~*errors_to*&
30792 If this value is not NULL, bounce messages caused by failing to deliver to the
30793 recipient are sent to the address it contains. In other words, it overrides the
30794 envelope sender for this one recipient. (Compare the &%errors_to%& generic
30795 router option.) If a &[local_scan()]& function sets an &%errors_to%& field to
30796 an unqualified address, Exim qualifies it using the domain from
30797 &%qualify_recipient%&. When &[local_scan()]& is called, the &%errors_to%& field
30798 is NULL for all recipients.
30799 .endlist
30800
30801
30802
30803 .section "Available Exim functions" "SECID211"
30804 .cindex "&[local_scan()]& function" "available Exim functions"
30805 The header &_local_scan.h_& gives you access to a number of Exim functions.
30806 These are the only ones that are guaranteed to be maintained from release to
30807 release:
30808
30809 .vlist
30810 .vitem "&*pid_t&~child_open(uschar&~**argv,&~uschar&~**envp,&~int&~newumask,&&&
30811        &~int&~*infdptr,&~int&~*outfdptr, &~&~BOOL&~make_leader)*&"
30812
30813 This function creates a child process that runs the command specified by
30814 &%argv%&. The environment for the process is specified by &%envp%&, which can
30815 be NULL if no environment variables are to be passed. A new umask is supplied
30816 for the process in &%newumask%&.
30817
30818 Pipes to the standard input and output of the new process are set up
30819 and returned to the caller via the &%infdptr%& and &%outfdptr%& arguments. The
30820 standard error is cloned to the standard output. If there are any file
30821 descriptors &"in the way"& in the new process, they are closed. If the final
30822 argument is TRUE, the new process is made into a process group leader.
30823
30824 The function returns the pid of the new process, or -1 if things go wrong.
30825
30826 .vitem &*int&~child_close(pid_t&~pid,&~int&~timeout)*&
30827 This function waits for a child process to terminate, or for a timeout (in
30828 seconds) to expire. A timeout value of zero means wait as long as it takes. The
30829 return value is as follows:
30830
30831 .ilist
30832 >= 0
30833
30834 The process terminated by a normal exit and the value is the process
30835 ending status.
30836
30837 .next
30838 < 0 and > &--256
30839
30840 The process was terminated by a signal and the value is the negation of the
30841 signal number.
30842
30843 .next
30844 &--256
30845
30846 The process timed out.
30847 .next
30848 &--257
30849
30850 The was some other error in wait(); &%errno%& is still set.
30851 .endlist
30852
30853 .vitem &*pid_t&~child_open_exim(int&~*fd)*&
30854 This function provide you with a means of submitting a new message to
30855 Exim. (Of course, you can also call &_/usr/sbin/sendmail_& yourself if you
30856 want, but this packages it all up for you.) The function creates a pipe,
30857 forks a subprocess that is running
30858 .code
30859 exim -t -oem -oi -f <>
30860 .endd
30861 and returns to you (via the &`int *`& argument) a file descriptor for the pipe
30862 that is connected to the standard input. The yield of the function is the PID
30863 of the subprocess. You can then write a message to the file descriptor, with
30864 recipients in &'To:'&, &'Cc:'&, and/or &'Bcc:'& header lines.
30865
30866 When you have finished, call &'child_close()'& to wait for the process to
30867 finish and to collect its ending status. A timeout value of zero is usually
30868 fine in this circumstance. Unless you have made a mistake with the recipient
30869 addresses, you should get a return code of zero.
30870
30871
30872 .vitem &*pid_t&~child_open_exim2(int&~*fd,&~uschar&~*sender,&~uschar&~&&&
30873        *sender_authentication)*&
30874 This function is a more sophisticated version of &'child_open()'&. The command
30875 that it runs is:
30876 .display
30877 &`exim -t -oem -oi -f `&&'sender'&&` -oMas `&&'sender_authentication'&
30878 .endd
30879 The third argument may be NULL, in which case the &%-oMas%& option is omitted.
30880
30881
30882 .vitem &*void&~debug_printf(char&~*,&~...)*&
30883 This is Exim's debugging function, with arguments as for &'(printf()'&. The
30884 output is written to the standard error stream. If no debugging is selected,
30885 calls to &'debug_printf()'& have no effect. Normally, you should make calls
30886 conditional on the &`local_scan`& debug selector by coding like this:
30887 .code
30888 if ((debug_selector & D_local_scan) != 0)
30889   debug_printf("xxx", ...);
30890 .endd
30891
30892 .vitem &*uschar&~*expand_string(uschar&~*string)*&
30893 This is an interface to Exim's string expansion code. The return value is the
30894 expanded string, or NULL if there was an expansion failure.
30895 The C variable &%expand_string_message%& contains an error message after an
30896 expansion failure. If expansion does not change the string, the return value is
30897 the pointer to the input string. Otherwise, the return value points to a new
30898 block of memory that was obtained by a call to &'store_get()'&. See section
30899 &<<SECTmemhanloc>>& below for a discussion of memory handling.
30900
30901 .vitem &*void&~header_add(int&~type,&~char&~*format,&~...)*&
30902 This function allows you to an add additional header line at the end of the
30903 existing ones. The first argument is the type, and should normally be a space
30904 character. The second argument is a format string and any number of
30905 substitution arguments as for &[sprintf()]&. You may include internal newlines
30906 if you want, and you must ensure that the string ends with a newline.
30907
30908 .vitem "&*void&~header_add_at_position(BOOL&~after,&~uschar&~*name,&~&&&
30909         BOOL&~topnot,&~int&~type,&~char&~*format, &~&~...)*&"
30910 This function adds a new header line at a specified point in the header
30911 chain. The header itself is specified as for &'header_add()'&.
30912
30913 If &%name%& is NULL, the new header is added at the end of the chain if
30914 &%after%& is true, or at the start if &%after%& is false. If &%name%& is not
30915 NULL, the header lines are searched for the first non-deleted header that
30916 matches the name. If one is found, the new header is added before it if
30917 &%after%& is false. If &%after%& is true, the new header is added after the
30918 found header and any adjacent subsequent ones with the same name (even if
30919 marked &"deleted"&). If no matching non-deleted header is found, the &%topnot%&
30920 option controls where the header is added. If it is true, addition is at the
30921 top; otherwise at the bottom. Thus, to add a header after all the &'Received:'&
30922 headers, or at the top if there are no &'Received:'& headers, you could use
30923 .code
30924 header_add_at_position(TRUE, US"Received", TRUE,
30925   ' ', "X-xxx: ...");
30926 .endd
30927 Normally, there is always at least one non-deleted &'Received:'& header, but
30928 there may not be if &%received_header_text%& expands to an empty string.
30929
30930
30931 .vitem &*void&~header_remove(int&~occurrence,&~uschar&~*name)*&
30932 This function removes header lines. If &%occurrence%& is zero or negative, all
30933 occurrences of the header are removed. If occurrence is greater than zero, that
30934 particular instance of the header is removed. If no header(s) can be found that
30935 match the specification, the function does nothing.
30936
30937
30938 .vitem "&*BOOL&~header_testname(header_line&~*hdr,&~uschar&~*name,&~&&&
30939         int&~length,&~BOOL&~notdel)*&"
30940 This function tests whether the given header has the given name. It is not just
30941 a string comparison, because white space is permitted between the name and the
30942 colon. If the &%notdel%& argument is true, a false return is forced for all
30943 &"deleted"& headers; otherwise they are not treated specially. For example:
30944 .code
30945 if (header_testname(h, US"X-Spam", 6, TRUE)) ...
30946 .endd
30947 .vitem &*uschar&~*lss_b64encode(uschar&~*cleartext,&~int&~length)*&
30948 .cindex "base64 encoding" "functions for &[local_scan()]& use"
30949 This function base64-encodes a string, which is passed by address and length.
30950 The text may contain bytes of any value, including zero. The result is passed
30951 back in dynamic memory that is obtained by calling &'store_get()'&. It is
30952 zero-terminated.
30953
30954 .vitem &*int&~lss_b64decode(uschar&~*codetext,&~uschar&~**cleartext)*&
30955 This function decodes a base64-encoded string. Its arguments are a
30956 zero-terminated base64-encoded string and the address of a variable that is set
30957 to point to the result, which is in dynamic memory. The length of the decoded
30958 string is the yield of the function. If the input is invalid base64 data, the
30959 yield is -1. A zero byte is added to the end of the output string to make it
30960 easy to interpret as a C string (assuming it contains no zeros of its own). The
30961 added zero byte is not included in the returned count.
30962
30963 .vitem &*int&~lss_match_domain(uschar&~*domain,&~uschar&~*list)*&
30964 This function checks for a match in a domain list. Domains are always
30965 matched caselessly. The return value is one of the following:
30966 .display
30967 &`OK     `& match succeeded
30968 &`FAIL   `& match failed
30969 &`DEFER  `& match deferred
30970 .endd
30971 DEFER is usually caused by some kind of lookup defer, such as the
30972 inability to contact a database.
30973
30974 .vitem "&*int&~lss_match_local_part(uschar&~*localpart,&~uschar&~*list,&~&&&
30975         BOOL&~caseless)*&"
30976 This function checks for a match in a local part list. The third argument
30977 controls case-sensitivity. The return values are as for
30978 &'lss_match_domain()'&.
30979
30980 .vitem "&*int&~lss_match_address(uschar&~*address,&~uschar&~*list,&~&&&
30981         BOOL&~caseless)*&"
30982 This function checks for a match in an address list. The third argument
30983 controls the case-sensitivity of the local part match. The domain is always
30984 matched caselessly. The return values are as for &'lss_match_domain()'&.
30985
30986 .vitem "&*int&~lss_match_host(uschar&~*host_name,&~uschar&~*host_address,&~&&&
30987         uschar&~*list)*&"
30988 This function checks for a match in a host list. The most common usage is
30989 expected to be
30990 .code
30991 lss_match_host(sender_host_name, sender_host_address, ...)
30992 .endd
30993 .vindex "&$sender_host_address$&"
30994 An empty address field matches an empty item in the host list. If the host name
30995 is NULL, the name corresponding to &$sender_host_address$& is automatically
30996 looked up if a host name is required to match an item in the list. The return
30997 values are as for &'lss_match_domain()'&, but in addition, &'lss_match_host()'&
30998 returns ERROR in the case when it had to look up a host name, but the lookup
30999 failed.
31000
31001 .vitem "&*void&~log_write(unsigned&~int&~selector,&~int&~which,&~char&~&&&
31002         *format,&~...)*&"
31003 This function writes to Exim's log files. The first argument should be zero (it
31004 is concerned with &%log_selector%&). The second argument can be &`LOG_MAIN`& or
31005 &`LOG_REJECT`& or &`LOG_PANIC`& or the inclusive &"or"& of any combination of
31006 them. It specifies to which log or logs the message is written. The remaining
31007 arguments are a format and relevant insertion arguments. The string should not
31008 contain any newlines, not even at the end.
31009
31010
31011 .vitem &*void&~receive_add_recipient(uschar&~*address,&~int&~pno)*&
31012 This function adds an additional recipient to the message. The first argument
31013 is the recipient address. If it is unqualified (has no domain), it is qualified
31014 with the &%qualify_recipient%& domain. The second argument must always be -1.
31015
31016 This function does not allow you to specify a private &%errors_to%& address (as
31017 described with the structure of &%recipient_item%& above), because it pre-dates
31018 the addition of that field to the structure. However, it is easy to add such a
31019 value afterwards. For example:
31020 .code
31021  receive_add_recipient(US"monitor@mydom.example", -1);
31022  recipients_list[recipients_count-1].errors_to =
31023    US"postmaster@mydom.example";
31024 .endd
31025
31026 .vitem &*BOOL&~receive_remove_recipient(uschar&~*recipient)*&
31027 This is a convenience function to remove a named recipient from the list of
31028 recipients. It returns true if a recipient was removed, and false if no
31029 matching recipient could be found. The argument must be a complete email
31030 address.
31031 .endlist
31032
31033
31034 .cindex "RFC 2047"
31035 .vlist
31036 .vitem "&*uschar&~rfc2047_decode(uschar&~*string,&~BOOL&~lencheck,&&&
31037   &~uschar&~*target,&~int&~zeroval,&~int&~*lenptr, &~&~uschar&~**error)*&"
31038 This function decodes strings that are encoded according to RFC 2047. Typically
31039 these are the contents of header lines. First, each &"encoded word"& is decoded
31040 from the Q or B encoding into a byte-string. Then, if provided with the name of
31041 a charset encoding, and if the &[iconv()]& function is available, an attempt is
31042 made  to translate the result to the named character set. If this fails, the
31043 binary string is returned with an error message.
31044
31045 The first argument is the string to be decoded. If &%lencheck%& is TRUE, the
31046 maximum MIME word length is enforced. The third argument is the target
31047 encoding, or NULL if no translation is wanted.
31048
31049 .cindex "binary zero" "in RFC 2047 decoding"
31050 .cindex "RFC 2047" "binary zero in"
31051 If a binary zero is encountered in the decoded string, it is replaced by the
31052 contents of the &%zeroval%& argument. For use with Exim headers, the value must
31053 not be 0 because header lines are handled as zero-terminated strings.
31054
31055 The function returns the result of processing the string, zero-terminated; if
31056 &%lenptr%& is not NULL, the length of the result is set in the variable to
31057 which it points. When &%zeroval%& is 0, &%lenptr%& should not be NULL.
31058
31059 If an error is encountered, the function returns NULL and uses the &%error%&
31060 argument to return an error message. The variable pointed to by &%error%& is
31061 set to NULL if there is no error; it may be set non-NULL even when the function
31062 returns a non-NULL value if decoding was successful, but there was a problem
31063 with translation.
31064
31065
31066 .vitem &*int&~smtp_fflush(void)*&
31067 This function is used in conjunction with &'smtp_printf()'&, as described
31068 below.
31069
31070 .vitem &*void&~smtp_printf(char&~*,&~...)*&
31071 The arguments of this function are like &[printf()]&; it writes to the SMTP
31072 output stream. You should use this function only when there is an SMTP output
31073 stream, that is, when the incoming message is being received via interactive
31074 SMTP. This is the case when &%smtp_input%& is TRUE and &%smtp_batched_input%&
31075 is FALSE. If you want to test for an incoming message from another host (as
31076 opposed to a local process that used the &%-bs%& command line option), you can
31077 test the value of &%sender_host_address%&, which is non-NULL when a remote host
31078 is involved.
31079
31080 If an SMTP TLS connection is established, &'smtp_printf()'& uses the TLS
31081 output function, so it can be used for all forms of SMTP connection.
31082
31083 Strings that are written by &'smtp_printf()'& from within &[local_scan()]&
31084 must start with an appropriate response code: 550 if you are going to return
31085 LOCAL_SCAN_REJECT, 451 if you are going to return
31086 LOCAL_SCAN_TEMPREJECT, and 250 otherwise. Because you are writing the
31087 initial lines of a multi-line response, the code must be followed by a hyphen
31088 to indicate that the line is not the final response line. You must also ensure
31089 that the lines you write terminate with CRLF. For example:
31090 .code
31091 smtp_printf("550-this is some extra info\r\n");
31092 return LOCAL_SCAN_REJECT;
31093 .endd
31094 Note that you can also create multi-line responses by including newlines in
31095 the data returned via the &%return_text%& argument. The added value of using
31096 &'smtp_printf()'& is that, for instance, you could introduce delays between
31097 multiple output lines.
31098
31099 The &'smtp_printf()'& function does not return any error indication, because it
31100 does not automatically flush pending output, and therefore does not test
31101 the state of the stream. (In the main code of Exim, flushing and error
31102 detection is done when Exim is ready for the next SMTP input command.) If
31103 you want to flush the output and check for an error (for example, the
31104 dropping of a TCP/IP connection), you can call &'smtp_fflush()'&, which has no
31105 arguments. It flushes the output stream, and returns a non-zero value if there
31106 is an error.
31107
31108 .vitem &*void&~*store_get(int)*&
31109 This function accesses Exim's internal store (memory) manager. It gets a new
31110 chunk of memory whose size is given by the argument. Exim bombs out if it ever
31111 runs out of memory. See the next section for a discussion of memory handling.
31112
31113 .vitem &*void&~*store_get_perm(int)*&
31114 This function is like &'store_get()'&, but it always gets memory from the
31115 permanent pool. See the next section for a discussion of memory handling.
31116
31117 .vitem &*uschar&~*string_copy(uschar&~*string)*&
31118 See below.
31119
31120 .vitem &*uschar&~*string_copyn(uschar&~*string,&~int&~length)*&
31121 See below.
31122
31123 .vitem &*uschar&~*string_sprintf(char&~*format,&~...)*&
31124 These three functions create strings using Exim's dynamic memory facilities.
31125 The first makes a copy of an entire string. The second copies up to a maximum
31126 number of characters, indicated by the second argument. The third uses a format
31127 and insertion arguments to create a new string. In each case, the result is a
31128 pointer to a new string in the current memory pool. See the next section for
31129 more discussion.
31130 .endlist
31131
31132
31133
31134 .section "More about Exim's memory handling" "SECTmemhanloc"
31135 .cindex "&[local_scan()]& function" "memory handling"
31136 No function is provided for freeing memory, because that is never needed.
31137 The dynamic memory that Exim uses when receiving a message is automatically
31138 recycled if another message is received by the same process (this applies only
31139 to incoming SMTP connections &-- other input methods can supply only one
31140 message at a time). After receiving the last message, a reception process
31141 terminates.
31142
31143 Because it is recycled, the normal dynamic memory cannot be used for holding
31144 data that must be preserved over a number of incoming messages on the same SMTP
31145 connection. However, Exim in fact uses two pools of dynamic memory; the second
31146 one is not recycled, and can be used for this purpose.
31147
31148 If you want to allocate memory that remains available for subsequent messages
31149 in the same SMTP connection, you should set
31150 .code
31151 store_pool = POOL_PERM
31152 .endd
31153 before calling the function that does the allocation. There is no need to
31154 restore the value if you do not need to; however, if you do want to revert to
31155 the normal pool, you can either restore the previous value of &%store_pool%& or
31156 set it explicitly to POOL_MAIN.
31157
31158 The pool setting applies to all functions that get dynamic memory, including
31159 &'expand_string()'&, &'store_get()'&, and the &'string_xxx()'& functions.
31160 There is also a convenience function called &'store_get_perm()'& that gets a
31161 block of memory from the permanent pool while preserving the value of
31162 &%store_pool%&.
31163 .ecindex IIDlosca
31164
31165
31166
31167
31168 . ////////////////////////////////////////////////////////////////////////////
31169 . ////////////////////////////////////////////////////////////////////////////
31170
31171 .chapter "System-wide message filtering" "CHAPsystemfilter"
31172 .scindex IIDsysfil1 "filter" "system filter"
31173 .scindex IIDsysfil2 "filtering all mail"
31174 .scindex IIDsysfil3 "system filter"
31175 The previous chapters (on ACLs and the local scan function) describe checks
31176 that can be applied to messages before they are accepted by a host. There is
31177 also a mechanism for checking messages once they have been received, but before
31178 they are delivered. This is called the &'system filter'&.
31179
31180 The system filter operates in a similar manner to users' filter files, but it
31181 is run just once per message (however many recipients the message has).
31182 It should not normally be used as a substitute for routing, because &%deliver%&
31183 commands in a system router provide new envelope recipient addresses.
31184 The system filter must be an Exim filter. It cannot be a Sieve filter.
31185
31186 The system filter is run at the start of a delivery attempt, before any routing
31187 is done. If a message fails to be completely delivered at the first attempt,
31188 the system filter is run again at the start of every retry.
31189 If you want your filter to do something only once per message, you can make use
31190 of the &%first_delivery%& condition in an &%if%& command in the filter to
31191 prevent it happening on retries.
31192
31193 .vindex "&$domain$&"
31194 .vindex "&$local_part$&"
31195 &*Warning*&: Because the system filter runs just once, variables that are
31196 specific to individual recipient addresses, such as &$local_part$& and
31197 &$domain$&, are not set, and the &"personal"& condition is not meaningful. If
31198 you want to run a centrally-specified filter for each recipient address
31199 independently, you can do so by setting up a suitable &(redirect)& router, as
31200 described in section &<<SECTperaddfil>>& below.
31201
31202
31203 .section "Specifying a system filter" "SECID212"
31204 .cindex "uid (user id)" "system filter"
31205 .cindex "gid (group id)" "system filter"
31206 The name of the file that contains the system filter must be specified by
31207 setting &%system_filter%&. If you want the filter to run under a uid and gid
31208 other than root, you must also set &%system_filter_user%& and
31209 &%system_filter_group%& as appropriate. For example:
31210 .code
31211 system_filter = /etc/mail/exim.filter
31212 system_filter_user = exim
31213 .endd
31214 If a system filter generates any deliveries directly to files or pipes (via the
31215 &%save%& or &%pipe%& commands), transports to handle these deliveries must be
31216 specified by setting &%system_filter_file_transport%& and
31217 &%system_filter_pipe_transport%&, respectively. Similarly,
31218 &%system_filter_reply_transport%& must be set to handle any messages generated
31219 by the &%reply%& command.
31220
31221
31222 .section "Testing a system filter" "SECID213"
31223 You can run simple tests of a system filter in the same way as for a user
31224 filter, but you should use &%-bF%& rather than &%-bf%&, so that features that
31225 are permitted only in system filters are recognized.
31226
31227 If you want to test the combined effect of a system filter and a user filter,
31228 you can use both &%-bF%& and &%-bf%& on the same command line.
31229
31230
31231
31232 .section "Contents of a system filter" "SECID214"
31233 The language used to specify system filters is the same as for users' filter
31234 files. It is described in the separate end-user document &'Exim's interface to
31235 mail filtering'&. However, there are some additional features that are
31236 available only in system filters; these are described in subsequent sections.
31237 If they are encountered in a user's filter file or when testing with &%-bf%&,
31238 they cause errors.
31239
31240 .cindex "frozen messages" "manual thaw; testing in filter"
31241 There are two special conditions which, though available in users' filter
31242 files, are designed for use in system filters. The condition &%first_delivery%&
31243 is true only for the first attempt at delivering a message, and
31244 &%manually_thawed%& is true only if the message has been frozen, and
31245 subsequently thawed by an admin user. An explicit forced delivery counts as a
31246 manual thaw, but thawing as a result of the &%auto_thaw%& setting does not.
31247
31248 &*Warning*&: If a system filter uses the &%first_delivery%& condition to
31249 specify an &"unseen"& (non-significant) delivery, and that delivery does not
31250 succeed, it will not be tried again.
31251 If you want Exim to retry an unseen delivery until it succeeds, you should
31252 arrange to set it up every time the filter runs.
31253
31254 When a system filter finishes running, the values of the variables &$n0$& &--
31255 &$n9$& are copied into &$sn0$& &-- &$sn9$& and are thereby made available to
31256 users' filter files. Thus a system filter can, for example, set up &"scores"&
31257 to which users' filter files can refer.
31258
31259
31260
31261 .section "Additional variable for system filters" "SECID215"
31262 .vindex "&$recipients$&"
31263 The expansion variable &$recipients$&, containing a list of all the recipients
31264 of the message (separated by commas and white space), is available in system
31265 filters. It is not available in users' filters for privacy reasons.
31266
31267
31268
31269 .section "Defer, freeze, and fail commands for system filters" "SECID216"
31270 .cindex "freezing messages"
31271 .cindex "message" "freezing"
31272 .cindex "message" "forced failure"
31273 .cindex "&%fail%&" "in system filter"
31274 .cindex "&%freeze%& in system filter"
31275 .cindex "&%defer%& in system filter"
31276 There are three extra commands (&%defer%&, &%freeze%& and &%fail%&) which are
31277 always available in system filters, but are not normally enabled in users'
31278 filters. (See the &%allow_defer%&, &%allow_freeze%& and &%allow_fail%& options
31279 for the &(redirect)& router.) These commands can optionally be followed by the
31280 word &%text%& and a string containing an error message, for example:
31281 .code
31282 fail text "this message looks like spam to me"
31283 .endd
31284 The keyword &%text%& is optional if the next character is a double quote.
31285
31286 The &%defer%& command defers delivery of the original recipients of the
31287 message. The &%fail%& command causes all the original recipients to be failed,
31288 and a bounce message to be created. The &%freeze%& command suspends all
31289 delivery attempts for the original recipients. In all cases, any new deliveries
31290 that are specified by the filter are attempted as normal after the filter has
31291 run.
31292
31293 The &%freeze%& command is ignored if the message has been manually unfrozen and
31294 not manually frozen since. This means that automatic freezing by a system
31295 filter can be used as a way of checking out suspicious messages. If a message
31296 is found to be all right, manually unfreezing it allows it to be delivered.
31297
31298 .cindex "log" "&%fail%& command log line"
31299 .cindex "&%fail%&" "log line; reducing"
31300 The text given with a fail command is used as part of the bounce message as
31301 well as being written to the log. If the message is quite long, this can fill
31302 up a lot of log space when such failures are common. To reduce the size of the
31303 log message, Exim interprets the text in a special way if it starts with the
31304 two characters &`<<`& and contains &`>>`& later. The text between these two
31305 strings is written to the log, and the rest of the text is used in the bounce
31306 message. For example:
31307 .code
31308 fail "<<filter test 1>>Your message is rejected \
31309      because it contains attachments that we are \
31310      not prepared to receive."
31311 .endd
31312
31313 .cindex "loop" "caused by &%fail%&"
31314 Take great care with the &%fail%& command when basing the decision to fail on
31315 the contents of the message, because the bounce message will of course include
31316 the contents of the original message and will therefore trigger the &%fail%&
31317 command again (causing a mail loop) unless steps are taken to prevent this.
31318 Testing the &%error_message%& condition is one way to prevent this. You could
31319 use, for example
31320 .code
31321 if $message_body contains "this is spam" and not error_message
31322 then fail text "spam is not wanted here" endif
31323 .endd
31324 though of course that might let through unwanted bounce messages. The
31325 alternative is clever checking of the body and/or headers to detect bounces
31326 generated by the filter.
31327
31328 The interpretation of a system filter file ceases after a
31329 &%defer%&,
31330 &%freeze%&, or &%fail%& command is obeyed. However, any deliveries that were
31331 set up earlier in the filter file are honoured, so you can use a sequence such
31332 as
31333 .code
31334 mail ...
31335 freeze
31336 .endd
31337 to send a specified message when the system filter is freezing (or deferring or
31338 failing) a message. The normal deliveries for the message do not, of course,
31339 take place.
31340
31341
31342
31343 .section "Adding and removing headers in a system filter" "SECTaddremheasys"
31344 .cindex "header lines" "adding; in system filter"
31345 .cindex "header lines" "removing; in system filter"
31346 .cindex "filter" "header lines; adding/removing"
31347 Two filter commands that are available only in system filters are:
31348 .code
31349 headers add <string>
31350 headers remove <string>
31351 .endd
31352 The argument for the &%headers add%& is a string that is expanded and then
31353 added to the end of the message's headers. It is the responsibility of the
31354 filter maintainer to make sure it conforms to RFC 2822 syntax. Leading white
31355 space is ignored, and if the string is otherwise empty, or if the expansion is
31356 forced to fail, the command has no effect.
31357
31358 You can use &"\n"& within the string, followed by white space, to specify
31359 continued header lines. More than one header may be added in one command by
31360 including &"\n"& within the string without any following white space. For
31361 example:
31362 .code
31363 headers add "X-header-1: ....\n  \
31364              continuation of X-header-1 ...\n\
31365              X-header-2: ...."
31366 .endd
31367 Note that the header line continuation white space after the first newline must
31368 be placed before the backslash that continues the input string, because white
31369 space after input continuations is ignored.
31370
31371 The argument for &%headers remove%& is a colon-separated list of header names.
31372 This command applies only to those headers that are stored with the message;
31373 those that are added at delivery time (such as &'Envelope-To:'& and
31374 &'Return-Path:'&) cannot be removed by this means. If there is more than one
31375 header with the same name, they are all removed.
31376
31377 The &%headers%& command in a system filter makes an immediate change to the set
31378 of header lines that was received with the message (with possible additions
31379 from ACL processing). Subsequent commands in the system filter operate on the
31380 modified set, which also forms the basis for subsequent message delivery.
31381 Unless further modified during routing or transporting, this set of headers is
31382 used for all recipients of the message.
31383
31384 During routing and transporting, the variables that refer to the contents of
31385 header lines refer only to those lines that are in this set. Thus, header lines
31386 that are added by a system filter are visible to users' filter files and to all
31387 routers and transports. This contrasts with the manipulation of header lines by
31388 routers and transports, which is not immediate, but which instead is saved up
31389 until the message is actually being written (see section
31390 &<<SECTheadersaddrem>>&).
31391
31392 If the message is not delivered at the first attempt, header lines that were
31393 added by the system filter are stored with the message, and so are still
31394 present at the next delivery attempt. Header lines that were removed are still
31395 present, but marked &"deleted"& so that they are not transported with the
31396 message. For this reason, it is usual to make the &%headers%& command
31397 conditional on &%first_delivery%& so that the set of header lines is not
31398 modified more than once.
31399
31400 Because header modification in a system filter acts immediately, you have to
31401 use an indirect approach if you want to modify the contents of a header line.
31402 For example:
31403 .code
31404 headers add "Old-Subject: $h_subject:"
31405 headers remove "Subject"
31406 headers add "Subject: new subject (was: $h_old-subject:)"
31407 headers remove "Old-Subject"
31408 .endd
31409
31410
31411
31412 .section "Setting an errors address in a system filter" "SECID217"
31413 .cindex "envelope sender"
31414 In a system filter, if a &%deliver%& command is followed by
31415 .code
31416 errors_to <some address>
31417 .endd
31418 in order to change the envelope sender (and hence the error reporting) for that
31419 delivery, any address may be specified. (In a user filter, only the current
31420 user's address can be set.) For example, if some mail is being monitored, you
31421 might use
31422 .code
31423 unseen deliver monitor@spying.example errors_to root@local.example
31424 .endd
31425 to take a copy which would not be sent back to the normal error reporting
31426 address if its delivery failed.
31427
31428
31429
31430 .section "Per-address filtering" "SECTperaddfil"
31431 .vindex "&$domain$&"
31432 .vindex "&$local_part$&"
31433 In contrast to the system filter, which is run just once per message for each
31434 delivery attempt, it is also possible to set up a system-wide filtering
31435 operation that runs once for each recipient address. In this case, variables
31436 such as &$local_part$& and &$domain$& can be used, and indeed, the choice of
31437 filter file could be made dependent on them. This is an example of a router
31438 which implements such a filter:
31439 .code
31440 central_filter:
31441   check_local_user
31442   driver = redirect
31443   domains = +local_domains
31444   file = /central/filters/$local_part
31445   no_verify
31446   allow_filter
31447   allow_freeze
31448 .endd
31449 The filter is run in a separate process under its own uid. Therefore, either
31450 &%check_local_user%& must be set (as above), in which case the filter is run as
31451 the local user, or the &%user%& option must be used to specify which user to
31452 use. If both are set, &%user%& overrides.
31453
31454 Care should be taken to ensure that none of the commands in the filter file
31455 specify a significant delivery if the message is to go on to be delivered to
31456 its intended recipient. The router will not then claim to have dealt with the
31457 address, so it will be passed on to subsequent routers to be delivered in the
31458 normal way.
31459 .ecindex IIDsysfil1
31460 .ecindex IIDsysfil2
31461 .ecindex IIDsysfil3
31462
31463
31464
31465
31466
31467
31468 . ////////////////////////////////////////////////////////////////////////////
31469 . ////////////////////////////////////////////////////////////////////////////
31470
31471 .chapter "Message processing" "CHAPmsgproc"
31472 .scindex IIDmesproc "message" "general processing"
31473 Exim performs various transformations on the sender and recipient addresses of
31474 all messages that it handles, and also on the messages' header lines. Some of
31475 these are optional and configurable, while others always take place. All of
31476 this processing, except rewriting as a result of routing, and the addition or
31477 removal of header lines while delivering, happens when a message is received,
31478 before it is placed on Exim's queue.
31479
31480 Some of the automatic processing takes place by default only for
31481 &"locally-originated"& messages. This adjective is used to describe messages
31482 that are not received over TCP/IP, but instead are passed to an Exim process on
31483 its standard input. This includes the interactive &"local SMTP"& case that is
31484 set up by the &%-bs%& command line option.
31485
31486 &*Note*&: Messages received over TCP/IP on the loopback interface (127.0.0.1
31487 or ::1) are not considered to be locally-originated. Exim does not treat the
31488 loopback interface specially in any way.
31489
31490 If you want the loopback interface to be treated specially, you must ensure
31491 that there are appropriate entries in your ACLs.
31492
31493
31494
31495
31496 .section "Submission mode for non-local messages" "SECTsubmodnon"
31497 .cindex "message" "submission"
31498 .cindex "submission mode"
31499 Processing that happens automatically for locally-originated messages (unless
31500 &%suppress_local_fixups%& is set) can also be requested for messages that are
31501 received over TCP/IP. The term &"submission mode"& is used to describe this
31502 state. Submission mode is set by the modifier
31503 .code
31504 control = submission
31505 .endd
31506 in a MAIL, RCPT, or pre-data ACL for an incoming message (see sections
31507 &<<SECTACLmodi>>& and &<<SECTcontrols>>&). This makes Exim treat the message as
31508 a local submission, and is normally used when the source of the message is
31509 known to be an MUA running on a client host (as opposed to an MTA). For
31510 example, to set submission mode for messages originating on the IPv4 loopback
31511 interface, you could include the following in the MAIL ACL:
31512 .code
31513 warn  hosts = 127.0.0.1
31514       control = submission
31515 .endd
31516 .cindex "&%sender_retain%& submission option"
31517 There are some options that can be used when setting submission mode. A slash
31518 is used to separate options. For example:
31519 .code
31520 control = submission/sender_retain
31521 .endd
31522 Specifying &%sender_retain%& has the effect of setting &%local_sender_retain%&
31523 true and &%local_from_check%& false for the current incoming message. The first
31524 of these allows an existing &'Sender:'& header in the message to remain, and
31525 the second suppresses the check to ensure that &'From:'& matches the
31526 authenticated sender. With this setting, Exim still fixes up messages by adding
31527 &'Date:'& and &'Message-ID:'& header lines if they are missing, but makes no
31528 attempt to check sender authenticity in header lines.
31529
31530 When &%sender_retain%& is not set, a submission mode setting may specify a
31531 domain to be used when generating a &'From:'& or &'Sender:'& header line. For
31532 example:
31533 .code
31534 control = submission/domain=some.domain
31535 .endd
31536 The domain may be empty. How this value is used is described in sections
31537 &<<SECTthefrohea>>& and &<<SECTthesenhea>>&. There is also a &%name%& option
31538 that allows you to specify the user's full name for inclusion in a created
31539 &'Sender:'& or &'From:'& header line. For example:
31540 .code
31541 accept authenticated = *
31542        control = submission/domain=wonderland.example/\
31543                             name=${lookup {$authenticated_id} \
31544                                    lsearch {/etc/exim/namelist}}
31545 .endd
31546 Because the name may contain any characters, including slashes, the &%name%&
31547 option must be given last. The remainder of the string is used as the name. For
31548 the example above, if &_/etc/exim/namelist_& contains:
31549 .code
31550 bigegg:  Humpty Dumpty
31551 .endd
31552 then when the sender has authenticated as &'bigegg'&, the generated &'Sender:'&
31553 line would be:
31554 .code
31555 Sender: Humpty Dumpty <bigegg@wonderland.example>
31556 .endd
31557 .cindex "return path" "in submission mode"
31558 By default, submission mode forces the return path to the same address as is
31559 used to create the &'Sender:'& header. However, if &%sender_retain%& is
31560 specified, the return path is also left unchanged.
31561
31562 &*Note*&: The changes caused by submission mode take effect after the predata
31563 ACL. This means that any sender checks performed before the fix-ups use the
31564 untrusted sender address specified by the user, not the trusted sender address
31565 specified by submission mode. Although this might be slightly unexpected, it
31566 does mean that you can configure ACL checks to spot that a user is trying to
31567 spoof another's address.
31568
31569 .section "Line endings" "SECTlineendings"
31570 .cindex "line endings"
31571 .cindex "carriage return"
31572 .cindex "linefeed"
31573 RFC 2821 specifies that CRLF (two characters: carriage-return, followed by
31574 linefeed) is the line ending for messages transmitted over the Internet using
31575 SMTP over TCP/IP. However, within individual operating systems, different
31576 conventions are used. For example, Unix-like systems use just LF, but others
31577 use CRLF or just CR.
31578
31579 Exim was designed for Unix-like systems, and internally, it stores messages
31580 using the system's convention of a single LF as a line terminator. When
31581 receiving a message, all line endings are translated to this standard format.
31582 Originally, it was thought that programs that passed messages directly to an
31583 MTA within an operating system would use that system's convention. Experience
31584 has shown that this is not the case; for example, there are Unix applications
31585 that use CRLF in this circumstance. For this reason, and for compatibility with
31586 other MTAs, the way Exim handles line endings for all messages is now as
31587 follows:
31588
31589 .ilist
31590 LF not preceded by CR is treated as a line ending.
31591 .next
31592 CR is treated as a line ending; if it is immediately followed by LF, the LF
31593 is ignored.
31594 .next
31595 The sequence &"CR, dot, CR"& does not terminate an incoming SMTP message,
31596 nor a local message in the state where a line containing only a dot is a
31597 terminator.
31598 .next
31599 If a bare CR is encountered within a header line, an extra space is added after
31600 the line terminator so as not to end the header line. The reasoning behind this
31601 is that bare CRs in header lines are most likely either to be mistakes, or
31602 people trying to play silly games.
31603 .next
31604 If the first header line received in a message ends with CRLF, a subsequent
31605 bare LF in a header line is treated in the same way as a bare CR in a header
31606 line.
31607 .endlist
31608
31609
31610
31611
31612
31613 .section "Unqualified addresses" "SECID218"
31614 .cindex "unqualified addresses"
31615 .cindex "address" "qualification"
31616 By default, Exim expects every envelope address it receives from an external
31617 host to be fully qualified. Unqualified addresses cause negative responses to
31618 SMTP commands. However, because SMTP is used as a means of transporting
31619 messages from MUAs running on personal workstations, there is sometimes a
31620 requirement to accept unqualified addresses from specific hosts or IP networks.
31621
31622 Exim has two options that separately control which hosts may send unqualified
31623 sender or recipient addresses in SMTP commands, namely
31624 &%sender_unqualified_hosts%& and &%recipient_unqualified_hosts%&. In both
31625 cases, if an unqualified address is accepted, it is qualified by adding the
31626 value of &%qualify_domain%& or &%qualify_recipient%&, as appropriate.
31627
31628 .oindex "&%qualify_domain%&"
31629 .oindex "&%qualify_recipient%&"
31630 Unqualified addresses in header lines are automatically qualified for messages
31631 that are locally originated, unless the &%-bnq%& option is given on the command
31632 line. For messages received over SMTP, unqualified addresses in header lines
31633 are qualified only if unqualified addresses are permitted in SMTP commands. In
31634 other words, such qualification is also controlled by
31635 &%sender_unqualified_hosts%& and &%recipient_unqualified_hosts%&,
31636
31637
31638
31639
31640 .section "The UUCP From line" "SECID219"
31641 .cindex "&""From""& line"
31642 .cindex "UUCP" "&""From""& line"
31643 .cindex "sender" "address"
31644 .oindex "&%uucp_from_pattern%&"
31645 .oindex "&%uucp_from_sender%&"
31646 .cindex "envelope sender"
31647 .cindex "Sendmail compatibility" "&""From""& line"
31648 Messages that have come from UUCP (and some other applications) often begin
31649 with a line containing the envelope sender and a timestamp, following the word
31650 &"From"&. Examples of two common formats are:
31651 .code
31652 From a.oakley@berlin.mus Fri Jan  5 12:35 GMT 1996
31653 From f.butler@berlin.mus Fri, 7 Jan 97 14:00:00 GMT
31654 .endd
31655 This line precedes the RFC 2822 header lines. For compatibility with Sendmail,
31656 Exim recognizes such lines at the start of messages that are submitted to it
31657 via the command line (that is, on the standard input). It does not recognize
31658 such lines in incoming SMTP messages, unless the sending host matches
31659 &%ignore_fromline_hosts%& or the &%-bs%& option was used for a local message
31660 and &%ignore_fromline_local%& is set. The recognition is controlled by a
31661 regular expression that is defined by the &%uucp_from_pattern%& option, whose
31662 default value matches the two common cases shown above and puts the address
31663 that follows &"From"& into &$1$&.
31664
31665 .cindex "numerical variables (&$1$& &$2$& etc)" "in &""From ""& line handling"
31666 When the caller of Exim for a non-SMTP message that contains a &"From"& line is
31667 a trusted user, the message's sender address is constructed by expanding the
31668 contents of &%uucp_sender_address%&, whose default value is &"$1"&. This is
31669 then parsed as an RFC 2822 address. If there is no domain, the local part is
31670 qualified with &%qualify_domain%& unless it is the empty string. However, if
31671 the command line &%-f%& option is used, it overrides the &"From"& line.
31672
31673 If the caller of Exim is not trusted, the &"From"& line is recognized, but the
31674 sender address is not changed. This is also the case for incoming SMTP messages
31675 that are permitted to contain &"From"& lines.
31676
31677 Only one &"From"& line is recognized. If there is more than one, the second is
31678 treated as a data line that starts the body of the message, as it is not valid
31679 as a header line. This also happens if a &"From"& line is present in an
31680 incoming SMTP message from a source that is not permitted to send them.
31681
31682
31683
31684 .section "Resent- header lines" "SECID220"
31685 .cindex "&%Resent-%& header lines"
31686 RFC 2822 makes provision for sets of header lines starting with the string
31687 &`Resent-`& to be added to a message when it is resent by the original
31688 recipient to somebody else. These headers are &'Resent-Date:'&,
31689 &'Resent-From:'&, &'Resent-Sender:'&, &'Resent-To:'&, &'Resent-Cc:'&,
31690 &'Resent-Bcc:'& and &'Resent-Message-ID:'&. The RFC says:
31691
31692 .blockquote
31693 &'Resent fields are strictly informational. They MUST NOT be used in the normal
31694 processing of replies or other such automatic actions on messages.'&
31695 .endblockquote
31696
31697 This leaves things a bit vague as far as other processing actions such as
31698 address rewriting are concerned. Exim treats &%Resent-%& header lines as
31699 follows:
31700
31701 .ilist
31702 A &'Resent-From:'& line that just contains the login id of the submitting user
31703 is automatically rewritten in the same way as &'From:'& (see below).
31704 .next
31705 If there's a rewriting rule for a particular header line, it is also applied to
31706 &%Resent-%& header lines of the same type. For example, a rule that rewrites
31707 &'From:'& also rewrites &'Resent-From:'&.
31708 .next
31709 For local messages, if &'Sender:'& is removed on input, &'Resent-Sender:'& is
31710 also removed.
31711 .next
31712 For a locally-submitted message,
31713 if there are any &%Resent-%& header lines but no &'Resent-Date:'&,
31714 &'Resent-From:'&, or &'Resent-Message-Id:'&, they are added as necessary. It is
31715 the contents of &'Resent-Message-Id:'& (rather than &'Message-Id:'&) which are
31716 included in log lines in this case.
31717 .next
31718 The logic for adding &'Sender:'& is duplicated for &'Resent-Sender:'& when any
31719 &%Resent-%& header lines are present.
31720 .endlist
31721
31722
31723
31724
31725 .section "The Auto-Submitted: header line" "SECID221"
31726 Whenever Exim generates an autoreply, a bounce, or a delay warning message, it
31727 includes the header line:
31728 .code
31729 Auto-Submitted: auto-replied
31730 .endd
31731
31732 .section "The Bcc: header line" "SECID222"
31733 .cindex "&'Bcc:'& header line"
31734 If Exim is called with the &%-t%& option, to take recipient addresses from a
31735 message's header, it removes any &'Bcc:'& header line that may exist (after
31736 extracting its addresses). If &%-t%& is not present on the command line, any
31737 existing &'Bcc:'& is not removed.
31738
31739
31740 .section "The Date: header line" "SECID223"
31741 .cindex "&'Date:'& header line"
31742 If a locally-generated or submission-mode message has no &'Date:'& header line,
31743 Exim adds one, using the current date and time, unless the
31744 &%suppress_local_fixups%& control has been specified.
31745
31746 .section "The Delivery-date: header line" "SECID224"
31747 .cindex "&'Delivery-date:'& header line"
31748 .oindex "&%delivery_date_remove%&"
31749 &'Delivery-date:'& header lines are not part of the standard RFC 2822 header
31750 set. Exim can be configured to add them to the final delivery of messages. (See
31751 the generic &%delivery_date_add%& transport option.) They should not be present
31752 in messages in transit. If the &%delivery_date_remove%& configuration option is
31753 set (the default), Exim removes &'Delivery-date:'& header lines from incoming
31754 messages.
31755
31756
31757 .section "The Envelope-to: header line" "SECID225"
31758 .cindex "&'Envelope-to:'& header line"
31759 .oindex "&%envelope_to_remove%&"
31760 &'Envelope-to:'& header lines are not part of the standard RFC 2822 header set.
31761 Exim can be configured to add them to the final delivery of messages. (See the
31762 generic &%envelope_to_add%& transport option.) They should not be present in
31763 messages in transit. If the &%envelope_to_remove%& configuration option is set
31764 (the default), Exim removes &'Envelope-to:'& header lines from incoming
31765 messages.
31766
31767
31768 .section "The From: header line" "SECTthefrohea"
31769 .cindex "&'From:'& header line"
31770 .cindex "Sendmail compatibility" "&""From""& line"
31771 .cindex "message" "submission"
31772 .cindex "submission mode"
31773 If a submission-mode message does not contain a &'From:'& header line, Exim
31774 adds one if either of the following conditions is true:
31775
31776 .ilist
31777 The envelope sender address is not empty (that is, this is not a bounce
31778 message). The added header line copies the envelope sender address.
31779 .next
31780 .vindex "&$authenticated_id$&"
31781 The SMTP session is authenticated and &$authenticated_id$& is not empty.
31782 .olist
31783 .vindex "&$qualify_domain$&"
31784 If no domain is specified by the submission control, the local part is
31785 &$authenticated_id$& and the domain is &$qualify_domain$&.
31786 .next
31787 If a non-empty domain is specified by the submission control, the local
31788 part is &$authenticated_id$&, and the domain is the specified domain.
31789 .next
31790 If an empty domain is specified by the submission control,
31791 &$authenticated_id$& is assumed to be the complete address.
31792 .endlist
31793 .endlist
31794
31795 A non-empty envelope sender takes precedence.
31796
31797 If a locally-generated incoming message does not contain a &'From:'& header
31798 line, and the &%suppress_local_fixups%& control is not set, Exim adds one
31799 containing the sender's address. The calling user's login name and full name
31800 are used to construct the address, as described in section &<<SECTconstr>>&.
31801 They are obtained from the password data by calling &[getpwuid()]& (but see the
31802 &%unknown_login%& configuration option). The address is qualified with
31803 &%qualify_domain%&.
31804
31805 For compatibility with Sendmail, if an incoming, non-SMTP message has a
31806 &'From:'& header line containing just the unqualified login name of the calling
31807 user, this is replaced by an address containing the user's login name and full
31808 name as described in section &<<SECTconstr>>&.
31809
31810
31811 .section "The Message-ID: header line" "SECID226"
31812 .cindex "&'Message-ID:'& header line"
31813 .cindex "message" "submission"
31814 .oindex "&%message_id_header_text%&"
31815 If a locally-generated or submission-mode incoming message does not contain a
31816 &'Message-ID:'& or &'Resent-Message-ID:'& header line, and the
31817 &%suppress_local_fixups%& control is not set, Exim adds a suitable header line
31818 to the message. If there are any &'Resent-:'& headers in the message, it
31819 creates &'Resent-Message-ID:'&. The id is constructed from Exim's internal
31820 message id, preceded by the letter E to ensure it starts with a letter, and
31821 followed by @ and the primary host name. Additional information can be included
31822 in this header line by setting the &%message_id_header_text%& and/or
31823 &%message_id_header_domain%& options.
31824
31825
31826 .section "The Received: header line" "SECID227"
31827 .cindex "&'Received:'& header line"
31828 A &'Received:'& header line is added at the start of every message. The
31829 contents are defined by the &%received_header_text%& configuration option, and
31830 Exim automatically adds a semicolon and a timestamp to the configured string.
31831
31832 The &'Received:'& header is generated as soon as the message's header lines
31833 have been received. At this stage, the timestamp in the &'Received:'& header
31834 line is the time that the message started to be received. This is the value
31835 that is seen by the DATA ACL and by the &[local_scan()]& function.
31836
31837 Once a message is accepted, the timestamp in the &'Received:'& header line is
31838 changed to the time of acceptance, which is (apart from a small delay while the
31839 -H spool file is written) the earliest time at which delivery could start.
31840
31841
31842 .section "The References: header line" "SECID228"
31843 .cindex "&'References:'& header line"
31844 Messages created by the &(autoreply)& transport include a &'References:'&
31845 header line. This is constructed according to the rules that are described in
31846 section 3.64 of RFC 2822 (which states that replies should contain such a
31847 header line), and section 3.14 of RFC 3834 (which states that automatic
31848 responses are not different in this respect). However, because some mail
31849 processing software does not cope well with very long header lines, no more
31850 than 12 message IDs are copied from the &'References:'& header line in the
31851 incoming message. If there are more than 12, the first one and then the final
31852 11 are copied, before adding the message ID of the incoming message.
31853
31854
31855
31856 .section "The Return-path: header line" "SECID229"
31857 .cindex "&'Return-path:'& header line"
31858 .oindex "&%return_path_remove%&"
31859 &'Return-path:'& header lines are defined as something an MTA may insert when
31860 it does the final delivery of messages. (See the generic &%return_path_add%&
31861 transport option.) Therefore, they should not be present in messages in
31862 transit. If the &%return_path_remove%& configuration option is set (the
31863 default), Exim removes &'Return-path:'& header lines from incoming messages.
31864
31865
31866
31867 .section "The Sender: header line" "SECTthesenhea"
31868 .cindex "&'Sender:'& header line"
31869 .cindex "message" "submission"
31870 For a locally-originated message from an untrusted user, Exim may remove an
31871 existing &'Sender:'& header line, and it may add a new one. You can modify
31872 these actions by setting the &%local_sender_retain%& option true, the
31873 &%local_from_check%& option false, or by using the &%suppress_local_fixups%&
31874 control setting.
31875
31876 When a local message is received from an untrusted user and
31877 &%local_from_check%& is true (the default), and the &%suppress_local_fixups%&
31878 control has not been set, a check is made to see if the address given in the
31879 &'From:'& header line is the correct (local) sender of the message. The address
31880 that is expected has the login name as the local part and the value of
31881 &%qualify_domain%& as the domain. Prefixes and suffixes for the local part can
31882 be permitted by setting &%local_from_prefix%& and &%local_from_suffix%&
31883 appropriately. If &'From:'& does not contain the correct sender, a &'Sender:'&
31884 line is added to the message.
31885
31886 If you set &%local_from_check%& false, this checking does not occur. However,
31887 the removal of an existing &'Sender:'& line still happens, unless you also set
31888 &%local_sender_retain%& to be true. It is not possible to set both of these
31889 options true at the same time.
31890
31891 .cindex "submission mode"
31892 By default, no processing of &'Sender:'& header lines is done for messages
31893 received over TCP/IP or for messages submitted by trusted users. However, when
31894 a message is received over TCP/IP in submission mode, and &%sender_retain%& is
31895 not specified on the submission control, the following processing takes place:
31896
31897 .vindex "&$authenticated_id$&"
31898 First, any existing &'Sender:'& lines are removed. Then, if the SMTP session is
31899 authenticated, and &$authenticated_id$& is not empty, a sender address is
31900 created as follows:
31901
31902 .ilist
31903 .vindex "&$qualify_domain$&"
31904 If no domain is specified by the submission control, the local part is
31905 &$authenticated_id$& and the domain is &$qualify_domain$&.
31906 .next
31907 If a non-empty domain is specified by the submission control, the local part
31908 is &$authenticated_id$&, and the domain is the specified domain.
31909 .next
31910 If an empty domain is specified by the submission control,
31911 &$authenticated_id$& is assumed to be the complete address.
31912 .endlist
31913
31914 This address is compared with the address in the &'From:'& header line. If they
31915 are different, a &'Sender:'& header line containing the created address is
31916 added. Prefixes and suffixes for the local part in &'From:'& can be permitted
31917 by setting &%local_from_prefix%& and &%local_from_suffix%& appropriately.
31918
31919 .cindex "return path" "created from &'Sender:'&"
31920 &*Note*&: Whenever a &'Sender:'& header line is created, the return path for
31921 the message (the envelope sender address) is changed to be the same address,
31922 except in the case of submission mode when &%sender_retain%& is specified.
31923
31924
31925
31926 .section "Adding and removing header lines in routers and transports" &&&
31927          "SECTheadersaddrem"
31928 .cindex "header lines" "adding; in router or transport"
31929 .cindex "header lines" "removing; in router or transport"
31930 When a message is delivered, the addition and removal of header lines can be
31931 specified in a system filter, or on any of the routers and transports that
31932 process the message. Section &<<SECTaddremheasys>>& contains details about
31933 modifying headers in a system filter. Header lines can also be added in an ACL
31934 as a message is received (see section &<<SECTaddheadacl>>&).
31935
31936 In contrast to what happens in a system filter, header modifications that are
31937 specified on routers and transports apply only to the particular recipient
31938 addresses that are being processed by those routers and transports. These
31939 changes do not actually take place until a copy of the message is being
31940 transported. Therefore, they do not affect the basic set of header lines, and
31941 they do not affect the values of the variables that refer to header lines.
31942
31943 &*Note*&: In particular, this means that any expansions in the configuration of
31944 the transport cannot refer to the modified header lines, because such
31945 expansions all occur before the message is actually transported.
31946
31947 For both routers and transports, the result of expanding a &%headers_add%&
31948 option must be in the form of one or more RFC 2822 header lines, separated by
31949 newlines (coded as &"\n"&). For example:
31950 .code
31951 headers_add = X-added-header: added by $primary_hostname\n\
31952               X-added-second: another added header line
31953 .endd
31954 Exim does not check the syntax of these added header lines.
31955
31956 .new
31957 Multiple &%headers_add%& options for a single router or transport can be
31958 specified; the values will be concatenated (with a separating newline
31959 added) before expansion.
31960 .wen
31961
31962 The result of expanding &%headers_remove%& must consist of a colon-separated
31963 list of header names. This is confusing, because header names themselves are
31964 often terminated by colons. In this case, the colons are the list separators,
31965 not part of the names. For example:
31966 .code
31967 headers_remove = return-receipt-to:acknowledge-to
31968 .endd
31969
31970 Multiple &%headers_remove%& options for a single router or transport can be
31971 specified; the values will be concatenated (with a separating colon
31972 added) before expansion.
31973
31974 When &%headers_add%& or &%headers_remove%& is specified on a router, its value
31975 is expanded at routing time, and then associated with all addresses that are
31976 accepted by that router, and also with any new addresses that it generates. If
31977 an address passes through several routers as a result of aliasing or
31978 forwarding, the changes are cumulative.
31979
31980 .oindex "&%unseen%&"
31981 However, this does not apply to multiple routers that result from the use of
31982 the &%unseen%& option. Any header modifications that were specified by the
31983 &"unseen"& router or its predecessors apply only to the &"unseen"& delivery.
31984
31985 Addresses that end up with different &%headers_add%& or &%headers_remove%&
31986 settings cannot be delivered together in a batch, so a transport is always
31987 dealing with a set of addresses that have the same header-processing
31988 requirements.
31989
31990 The transport starts by writing the original set of header lines that arrived
31991 with the message, possibly modified by the system filter. As it writes out
31992 these lines, it consults the list of header names that were attached to the
31993 recipient address(es) by &%headers_remove%& options in routers, and it also
31994 consults the transport's own &%headers_remove%& option. Header lines whose
31995 names are on either of these lists are not written out. If there are multiple
31996 instances of any listed header, they are all skipped.
31997
31998 After the remaining original header lines have been written, new header
31999 lines that were specified by routers' &%headers_add%& options are written, in
32000 the order in which they were attached to the address. These are followed by any
32001 header lines specified by the transport's &%headers_add%& option.
32002
32003 This way of handling header line modifications in routers and transports has
32004 the following consequences:
32005
32006 .ilist
32007 The original set of header lines, possibly modified by the system filter,
32008 remains &"visible"&, in the sense that the &$header_$&&'xxx'& variables refer
32009 to it, at all times.
32010 .next
32011 Header lines that are added by a router's
32012 &%headers_add%& option are not accessible by means of the &$header_$&&'xxx'&
32013 expansion syntax in subsequent routers or the transport.
32014 .next
32015 Conversely, header lines that are specified for removal by &%headers_remove%&
32016 in a router remain visible to subsequent routers and the transport.
32017 .next
32018 Headers added to an address by &%headers_add%& in a router cannot be removed by
32019 a later router or by a transport.
32020 .next
32021 An added header can refer to the contents of an original header that is to be
32022 removed, even it has the same name as the added header. For example:
32023 .code
32024 headers_remove = subject
32025 headers_add = Subject: new subject (was: $h_subject:)
32026 .endd
32027 .endlist
32028
32029 &*Warning*&: The &%headers_add%& and &%headers_remove%& options cannot be used
32030 for a &(redirect)& router that has the &%one_time%& option set.
32031
32032
32033
32034
32035
32036 .section "Constructed addresses" "SECTconstr"
32037 .cindex "address" "constructed"
32038 .cindex "constructed address"
32039 When Exim constructs a sender address for a locally-generated message, it uses
32040 the form
32041 .display
32042 <&'user name'&>&~&~<&'login'&&`@`&&'qualify_domain'&>
32043 .endd
32044 For example:
32045 .code
32046 Zaphod Beeblebrox <zaphod@end.univ.example>
32047 .endd
32048 The user name is obtained from the &%-F%& command line option if set, or
32049 otherwise by looking up the calling user by &[getpwuid()]& and extracting the
32050 &"gecos"& field from the password entry. If the &"gecos"& field contains an
32051 ampersand character, this is replaced by the login name with the first letter
32052 upper cased, as is conventional in a number of operating systems. See the
32053 &%gecos_name%& option for a way to tailor the handling of the &"gecos"& field.
32054 The &%unknown_username%& option can be used to specify user names in cases when
32055 there is no password file entry.
32056
32057 .cindex "RFC 2047"
32058 In all cases, the user name is made to conform to RFC 2822 by quoting all or
32059 parts of it if necessary. In addition, if it contains any non-printing
32060 characters, it is encoded as described in RFC 2047, which defines a way of
32061 including non-ASCII characters in header lines. The value of the
32062 &%headers_charset%& option specifies the name of the encoding that is used (the
32063 characters are assumed to be in this encoding). The setting of
32064 &%print_topbitchars%& controls whether characters with the top bit set (that
32065 is, with codes greater than 127) count as printing characters or not.
32066
32067
32068
32069 .section "Case of local parts" "SECID230"
32070 .cindex "case of local parts"
32071 .cindex "local part" "case of"
32072 RFC 2822 states that the case of letters in the local parts of addresses cannot
32073 be assumed to be non-significant. Exim preserves the case of local parts of
32074 addresses, but by default it uses a lower-cased form when it is routing,
32075 because on most Unix systems, usernames are in lower case and case-insensitive
32076 routing is required. However, any particular router can be made to use the
32077 original case for local parts by setting the &%caseful_local_part%& generic
32078 router option.
32079
32080 .cindex "mixed-case login names"
32081 If you must have mixed-case user names on your system, the best way to proceed,
32082 assuming you want case-independent handling of incoming email, is to set up
32083 your first router to convert incoming local parts in your domains to the
32084 correct case by means of a file lookup. For example:
32085 .code
32086 correct_case:
32087   driver = redirect
32088   domains = +local_domains
32089   data = ${lookup{$local_part}cdb\
32090               {/etc/usercased.cdb}{$value}fail}\
32091               @$domain
32092 .endd
32093 For this router, the local part is forced to lower case by the default action
32094 (&%caseful_local_part%& is not set). The lower-cased local part is used to look
32095 up a new local part in the correct case. If you then set &%caseful_local_part%&
32096 on any subsequent routers which process your domains, they will operate on
32097 local parts with the correct case in a case-sensitive manner.
32098
32099
32100
32101 .section "Dots in local parts" "SECID231"
32102 .cindex "dot" "in local part"
32103 .cindex "local part" "dots in"
32104 RFC 2822 forbids empty components in local parts. That is, an unquoted local
32105 part may not begin or end with a dot, nor have two consecutive dots in the
32106 middle. However, it seems that many MTAs do not enforce this, so Exim permits
32107 empty components for compatibility.
32108
32109
32110
32111 .section "Rewriting addresses" "SECID232"
32112 .cindex "rewriting" "addresses"
32113 Rewriting of sender and recipient addresses, and addresses in headers, can
32114 happen automatically, or as the result of configuration options, as described
32115 in chapter &<<CHAPrewrite>>&. The headers that may be affected by this are
32116 &'Bcc:'&, &'Cc:'&, &'From:'&, &'Reply-To:'&, &'Sender:'&, and &'To:'&.
32117
32118 Automatic rewriting includes qualification, as mentioned above. The other case
32119 in which it can happen is when an incomplete non-local domain is given. The
32120 routing process may cause this to be expanded into the full domain name. For
32121 example, a header such as
32122 .code
32123 To: hare@teaparty
32124 .endd
32125 might get rewritten as
32126 .code
32127 To: hare@teaparty.wonderland.fict.example
32128 .endd
32129 Rewriting as a result of routing is the one kind of message processing that
32130 does not happen at input time, as it cannot be done until the address has
32131 been routed.
32132
32133 Strictly, one should not do &'any'& deliveries of a message until all its
32134 addresses have been routed, in case any of the headers get changed as a
32135 result of routing. However, doing this in practice would hold up many
32136 deliveries for unreasonable amounts of time, just because one address could not
32137 immediately be routed. Exim therefore does not delay other deliveries when
32138 routing of one or more addresses is deferred.
32139 .ecindex IIDmesproc
32140
32141
32142
32143 . ////////////////////////////////////////////////////////////////////////////
32144 . ////////////////////////////////////////////////////////////////////////////
32145
32146 .chapter "SMTP processing" "CHAPSMTP"
32147 .scindex IIDsmtpproc1 "SMTP" "processing details"
32148 .scindex IIDsmtpproc2 "LMTP" "processing details"
32149 Exim supports a number of different ways of using the SMTP protocol, and its
32150 LMTP variant, which is an interactive protocol for transferring messages into a
32151 closed mail store application. This chapter contains details of how SMTP is
32152 processed. For incoming mail, the following are available:
32153
32154 .ilist
32155 SMTP over TCP/IP (Exim daemon or &'inetd'&);
32156 .next
32157 SMTP over the standard input and output (the &%-bs%& option);
32158 .next
32159 Batched SMTP on the standard input (the &%-bS%& option).
32160 .endlist
32161
32162 For mail delivery, the following are available:
32163
32164 .ilist
32165 SMTP over TCP/IP (the &(smtp)& transport);
32166 .next
32167 LMTP over TCP/IP (the &(smtp)& transport with the &%protocol%& option set to
32168 &"lmtp"&);
32169 .next
32170 LMTP over a pipe to a process running in the local host (the &(lmtp)&
32171 transport);
32172 .next
32173 Batched SMTP to a file or pipe (the &(appendfile)& and &(pipe)& transports with
32174 the &%use_bsmtp%& option set).
32175 .endlist
32176
32177 &'Batched SMTP'& is the name for a process in which batches of messages are
32178 stored in or read from files (or pipes), in a format in which SMTP commands are
32179 used to contain the envelope information.
32180
32181
32182
32183 .section "Outgoing SMTP and LMTP over TCP/IP" "SECToutSMTPTCP"
32184 .cindex "SMTP" "outgoing over TCP/IP"
32185 .cindex "outgoing SMTP over TCP/IP"
32186 .cindex "LMTP" "over TCP/IP"
32187 .cindex "outgoing LMTP over TCP/IP"
32188 .cindex "EHLO"
32189 .cindex "HELO"
32190 .cindex "SIZE option on MAIL command"
32191 Outgoing SMTP and LMTP over TCP/IP is implemented by the &(smtp)& transport.
32192 The &%protocol%& option selects which protocol is to be used, but the actual
32193 processing is the same in both cases.
32194
32195 If, in response to its EHLO command, Exim is told that the SIZE
32196 parameter is supported, it adds SIZE=<&'n'&> to each subsequent MAIL
32197 command. The value of <&'n'&> is the message size plus the value of the
32198 &%size_addition%& option (default 1024) to allow for additions to the message
32199 such as per-transport header lines, or changes made in a
32200 .cindex "transport" "filter"
32201 .cindex "filter" "transport filter"
32202 transport filter. If &%size_addition%& is set negative, the use of SIZE is
32203 suppressed.
32204
32205 If the remote server advertises support for PIPELINING, Exim uses the
32206 pipelining extension to SMTP (RFC 2197) to reduce the number of TCP/IP packets
32207 required for the transaction.
32208
32209 If the remote server advertises support for the STARTTLS command, and Exim
32210 was built to support TLS encryption, it tries to start a TLS session unless the
32211 server matches &%hosts_avoid_tls%&. See chapter &<<CHAPTLS>>& for more details.
32212 Either a match in that or &%hosts_verify_avoid_tls%& apply when the transport
32213 is called for verification.
32214
32215 If the remote server advertises support for the AUTH command, Exim scans
32216 the authenticators configuration for any suitable client settings, as described
32217 in chapter &<<CHAPSMTPAUTH>>&.
32218
32219 .cindex "carriage return"
32220 .cindex "linefeed"
32221 Responses from the remote host are supposed to be terminated by CR followed by
32222 LF. However, there are known to be hosts that do not send CR characters, so in
32223 order to be able to interwork with such hosts, Exim treats LF on its own as a
32224 line terminator.
32225
32226 If a message contains a number of different addresses, all those with the same
32227 characteristics (for example, the same envelope sender) that resolve to the
32228 same set of hosts, in the same order, are sent in a single SMTP transaction,
32229 even if they are for different domains, unless there are more than the setting
32230 of the &%max_rcpt%&s option in the &(smtp)& transport allows, in which case
32231 they are split into groups containing no more than &%max_rcpt%&s addresses
32232 each. If &%remote_max_parallel%& is greater than one, such groups may be sent
32233 in parallel sessions. The order of hosts with identical MX values is not
32234 significant when checking whether addresses can be batched in this way.
32235
32236 When the &(smtp)& transport suffers a temporary failure that is not
32237 message-related, Exim updates its transport-specific database, which contains
32238 records indexed by host name that remember which messages are waiting for each
32239 particular host. It also updates the retry database with new retry times.
32240
32241 .cindex "hints database" "retry keys"
32242 Exim's retry hints are based on host name plus IP address, so if one address of
32243 a multi-homed host is broken, it will soon be skipped most of the time.
32244 See the next section for more detail about error handling.
32245
32246 .cindex "SMTP" "passed connection"
32247 .cindex "SMTP" "batching over TCP/IP"
32248 When a message is successfully delivered over a TCP/IP SMTP connection, Exim
32249 looks in the hints database for the transport to see if there are any queued
32250 messages waiting for the host to which it is connected. If it finds one, it
32251 creates a new Exim process using the &%-MC%& option (which can only be used by
32252 a process running as root or the Exim user) and passes the TCP/IP socket to it
32253 so that it can deliver another message using the same socket. The new process
32254 does only those deliveries that are routed to the connected host, and may in
32255 turn pass the socket on to a third process, and so on.
32256
32257 The &%connection_max_messages%& option of the &(smtp)& transport can be used to
32258 limit the number of messages sent down a single TCP/IP connection.
32259
32260 .cindex "asterisk" "after IP address"
32261 The second and subsequent messages delivered down an existing connection are
32262 identified in the main log by the addition of an asterisk after the closing
32263 square bracket of the IP address.
32264
32265
32266
32267
32268 .section "Errors in outgoing SMTP" "SECToutSMTPerr"
32269 .cindex "error" "in outgoing SMTP"
32270 .cindex "SMTP" "errors in outgoing"
32271 .cindex "host" "error"
32272 Three different kinds of error are recognized for outgoing SMTP: host errors,
32273 message errors, and recipient errors.
32274
32275 .vlist
32276 .vitem "&*Host errors*&"
32277 A host error is not associated with a particular message or with a
32278 particular recipient of a message. The host errors are:
32279
32280 .ilist
32281 Connection refused or timed out,
32282 .next
32283 Any error response code on connection,
32284 .next
32285 Any error response code to EHLO or HELO,
32286 .next
32287 Loss of connection at any time, except after &"."&,
32288 .next
32289 I/O errors at any time,
32290 .next
32291 Timeouts during the session, other than in response to MAIL, RCPT or
32292 the &"."& at the end of the data.
32293 .endlist ilist
32294
32295 For a host error, a permanent error response on connection, or in response to
32296 EHLO, causes all addresses routed to the host to be failed. Any other host
32297 error causes all addresses to be deferred, and retry data to be created for the
32298 host. It is not tried again, for any message, until its retry time arrives. If
32299 the current set of addresses are not all delivered in this run (to some
32300 alternative host), the message is added to the list of those waiting for this
32301 host, so if it is still undelivered when a subsequent successful delivery is
32302 made to the host, it will be sent down the same SMTP connection.
32303
32304 .vitem "&*Message errors*&"
32305 .cindex "message" "error"
32306 A message error is associated with a particular message when sent to a
32307 particular host, but not with a particular recipient of the message. The
32308 message errors are:
32309
32310 .ilist
32311 Any error response code to MAIL, DATA, or the &"."& that terminates
32312 the data,
32313 .next
32314 Timeout after MAIL,
32315 .next
32316 Timeout or loss of connection after the &"."& that terminates the data. A
32317 timeout after the DATA command itself is treated as a host error, as is loss of
32318 connection at any other time.
32319 .endlist ilist
32320
32321 For a message error, a permanent error response (5&'xx'&) causes all addresses
32322 to be failed, and a delivery error report to be returned to the sender. A
32323 temporary error response (4&'xx'&), or one of the timeouts, causes all
32324 addresses to be deferred. Retry data is not created for the host, but instead,
32325 a retry record for the combination of host plus message id is created. The
32326 message is not added to the list of those waiting for this host. This ensures
32327 that the failing message will not be sent to this host again until the retry
32328 time arrives. However, other messages that are routed to the host are not
32329 affected, so if it is some property of the message that is causing the error,
32330 it will not stop the delivery of other mail.
32331
32332 If the remote host specified support for the SIZE parameter in its response
32333 to EHLO, Exim adds SIZE=&'nnn'& to the MAIL command, so an
32334 over-large message will cause a message error because the error arrives as a
32335 response to MAIL.
32336
32337 .vitem "&*Recipient errors*&"
32338 .cindex "recipient" "error"
32339 A recipient error is associated with a particular recipient of a message. The
32340 recipient errors are:
32341
32342 .ilist
32343 Any error response to RCPT,
32344 .next
32345 Timeout after RCPT.
32346 .endlist
32347
32348 For a recipient error, a permanent error response (5&'xx'&) causes the
32349 recipient address to be failed, and a bounce message to be returned to the
32350 sender. A temporary error response (4&'xx'&) or a timeout causes the failing
32351 address to be deferred, and routing retry data to be created for it. This is
32352 used to delay processing of the address in subsequent queue runs, until its
32353 routing retry time arrives. This applies to all messages, but because it
32354 operates only in queue runs, one attempt will be made to deliver a new message
32355 to the failing address before the delay starts to operate. This ensures that,
32356 if the failure is really related to the message rather than the recipient
32357 (&"message too big for this recipient"& is a possible example), other messages
32358 have a chance of getting delivered. If a delivery to the address does succeed,
32359 the retry information gets cleared, so all stuck messages get tried again, and
32360 the retry clock is reset.
32361
32362 The message is not added to the list of those waiting for this host. Use of the
32363 host for other messages is unaffected, and except in the case of a timeout,
32364 other recipients are processed independently, and may be successfully delivered
32365 in the current SMTP session. After a timeout it is of course impossible to
32366 proceed with the session, so all addresses get deferred. However, those other
32367 than the one that failed do not suffer any subsequent retry delays. Therefore,
32368 if one recipient is causing trouble, the others have a chance of getting
32369 through when a subsequent delivery attempt occurs before the failing
32370 recipient's retry time.
32371 .endlist
32372
32373 In all cases, if there are other hosts (or IP addresses) available for the
32374 current set of addresses (for example, from multiple MX records), they are
32375 tried in this run for any undelivered addresses, subject of course to their
32376 own retry data. In other words, recipient error retry data does not take effect
32377 until the next delivery attempt.
32378
32379 Some hosts have been observed to give temporary error responses to every
32380 MAIL command at certain times (&"insufficient space"& has been seen). It
32381 would be nice if such circumstances could be recognized, and defer data for the
32382 host itself created, but this is not possible within the current Exim design.
32383 What actually happens is that retry data for every (host, message) combination
32384 is created.
32385
32386 The reason that timeouts after MAIL and RCPT are treated specially is that
32387 these can sometimes arise as a result of the remote host's verification
32388 procedures. Exim makes this assumption, and treats them as if a temporary error
32389 response had been received. A timeout after &"."& is treated specially because
32390 it is known that some broken implementations fail to recognize the end of the
32391 message if the last character of the last line is a binary zero. Thus, it is
32392 helpful to treat this case as a message error.
32393
32394 Timeouts at other times are treated as host errors, assuming a problem with the
32395 host, or the connection to it. If a timeout after MAIL, RCPT,
32396 or &"."& is really a connection problem, the assumption is that at the next try
32397 the timeout is likely to occur at some other point in the dialogue, causing it
32398 then to be treated as a host error.
32399
32400 There is experimental evidence that some MTAs drop the connection after the
32401 terminating &"."& if they do not like the contents of the message for some
32402 reason, in contravention of the RFC, which indicates that a 5&'xx'& response
32403 should be given. That is why Exim treats this case as a message rather than a
32404 host error, in order not to delay other messages to the same host.
32405
32406
32407
32408
32409 .section "Incoming SMTP messages over TCP/IP" "SECID233"
32410 .cindex "SMTP" "incoming over TCP/IP"
32411 .cindex "incoming SMTP over TCP/IP"
32412 .cindex "inetd"
32413 .cindex "daemon"
32414 Incoming SMTP messages can be accepted in one of two ways: by running a
32415 listening daemon, or by using &'inetd'&. In the latter case, the entry in
32416 &_/etc/inetd.conf_& should be like this:
32417 .code
32418 smtp stream tcp nowait exim /opt/exim/bin/exim in.exim -bs
32419 .endd
32420 Exim distinguishes between this case and the case of a locally running user
32421 agent using the &%-bs%& option by checking whether or not the standard input is
32422 a socket. When it is, either the port must be privileged (less than 1024), or
32423 the caller must be root or the Exim user. If any other user passes a socket
32424 with an unprivileged port number, Exim prints a message on the standard error
32425 stream and exits with an error code.
32426
32427 By default, Exim does not make a log entry when a remote host connects or
32428 disconnects (either via the daemon or &'inetd'&), unless the disconnection is
32429 unexpected. It can be made to write such log entries by setting the
32430 &%smtp_connection%& log selector.
32431
32432 .cindex "carriage return"
32433 .cindex "linefeed"
32434 Commands from the remote host are supposed to be terminated by CR followed by
32435 LF. However, there are known to be hosts that do not send CR characters. In
32436 order to be able to interwork with such hosts, Exim treats LF on its own as a
32437 line terminator.
32438 Furthermore, because common code is used for receiving messages from all
32439 sources, a CR on its own is also interpreted as a line terminator. However, the
32440 sequence &"CR, dot, CR"& does not terminate incoming SMTP data.
32441
32442 .cindex "EHLO" "invalid data"
32443 .cindex "HELO" "invalid data"
32444 One area that sometimes gives rise to problems concerns the EHLO or
32445 HELO commands. Some clients send syntactically invalid versions of these
32446 commands, which Exim rejects by default. (This is nothing to do with verifying
32447 the data that is sent, so &%helo_verify_hosts%& is not relevant.) You can tell
32448 Exim not to apply a syntax check by setting &%helo_accept_junk_hosts%& to
32449 match the broken hosts that send invalid commands.
32450
32451 .cindex "SIZE option on MAIL command"
32452 .cindex "MAIL" "SIZE option"
32453 The amount of disk space available is checked whenever SIZE is received on
32454 a MAIL command, independently of whether &%message_size_limit%& or
32455 &%check_spool_space%& is configured, unless &%smtp_check_spool_space%& is set
32456 false. A temporary error is given if there is not enough space. If
32457 &%check_spool_space%& is set, the check is for that amount of space plus the
32458 value given with SIZE, that is, it checks that the addition of the incoming
32459 message will not reduce the space below the threshold.
32460
32461 When a message is successfully received, Exim includes the local message id in
32462 its response to the final &"."& that terminates the data. If the remote host
32463 logs this text it can help with tracing what has happened to a message.
32464
32465 The Exim daemon can limit the number of simultaneous incoming connections it is
32466 prepared to handle (see the &%smtp_accept_max%& option). It can also limit the
32467 number of simultaneous incoming connections from a single remote host (see the
32468 &%smtp_accept_max_per_host%& option). Additional connection attempts are
32469 rejected using the SMTP temporary error code 421.
32470
32471 The Exim daemon does not rely on the SIGCHLD signal to detect when a
32472 subprocess has finished, as this can get lost at busy times. Instead, it looks
32473 for completed subprocesses every time it wakes up. Provided there are other
32474 things happening (new incoming calls, starts of queue runs), completed
32475 processes will be noticed and tidied away. On very quiet systems you may
32476 sometimes see a &"defunct"& Exim process hanging about. This is not a problem;
32477 it will be noticed when the daemon next wakes up.
32478
32479 When running as a daemon, Exim can reserve some SMTP slots for specific hosts,
32480 and can also be set up to reject SMTP calls from non-reserved hosts at times of
32481 high system load &-- for details see the &%smtp_accept_reserve%&,
32482 &%smtp_load_reserve%&, and &%smtp_reserve_hosts%& options. The load check
32483 applies in both the daemon and &'inetd'& cases.
32484
32485 Exim normally starts a delivery process for each message received, though this
32486 can be varied by means of the &%-odq%& command line option and the
32487 &%queue_only%&, &%queue_only_file%&, and &%queue_only_load%& options. The
32488 number of simultaneously running delivery processes started in this way from
32489 SMTP input can be limited by the &%smtp_accept_queue%& and
32490 &%smtp_accept_queue_per_connection%& options. When either limit is reached,
32491 subsequently received messages are just put on the input queue without starting
32492 a delivery process.
32493
32494 The controls that involve counts of incoming SMTP calls (&%smtp_accept_max%&,
32495 &%smtp_accept_queue%&, &%smtp_accept_reserve%&) are not available when Exim is
32496 started up from the &'inetd'& daemon, because in that case each connection is
32497 handled by an entirely independent Exim process. Control by load average is,
32498 however, available with &'inetd'&.
32499
32500 Exim can be configured to verify addresses in incoming SMTP commands as they
32501 are received. See chapter &<<CHAPACL>>& for details. It can also be configured
32502 to rewrite addresses at this time &-- before any syntax checking is done. See
32503 section &<<SECTrewriteS>>&.
32504
32505 Exim can also be configured to limit the rate at which a client host submits
32506 MAIL and RCPT commands in a single SMTP session. See the
32507 &%smtp_ratelimit_hosts%& option.
32508
32509
32510
32511 .section "Unrecognized SMTP commands" "SECID234"
32512 .cindex "SMTP" "unrecognized commands"
32513 If Exim receives more than &%smtp_max_unknown_commands%& unrecognized SMTP
32514 commands during a single SMTP connection, it drops the connection after sending
32515 the error response to the last command. The default value for
32516 &%smtp_max_unknown_commands%& is 3. This is a defence against some kinds of
32517 abuse that subvert web servers into making connections to SMTP ports; in these
32518 circumstances, a number of non-SMTP lines are sent first.
32519
32520
32521 .section "Syntax and protocol errors in SMTP commands" "SECID235"
32522 .cindex "SMTP" "syntax errors"
32523 .cindex "SMTP" "protocol errors"
32524 A syntax error is detected if an SMTP command is recognized, but there is
32525 something syntactically wrong with its data, for example, a malformed email
32526 address in a RCPT command. Protocol errors include invalid command
32527 sequencing such as RCPT before MAIL. If Exim receives more than
32528 &%smtp_max_synprot_errors%& such commands during a single SMTP connection, it
32529 drops the connection after sending the error response to the last command. The
32530 default value for &%smtp_max_synprot_errors%& is 3. This is a defence against
32531 broken clients that loop sending bad commands (yes, it has been seen).
32532
32533
32534
32535 .section "Use of non-mail SMTP commands" "SECID236"
32536 .cindex "SMTP" "non-mail commands"
32537 The &"non-mail"& SMTP commands are those other than MAIL, RCPT, and
32538 DATA. Exim counts such commands, and drops the connection if there are too
32539 many of them in a single SMTP session. This action catches some
32540 denial-of-service attempts and things like repeated failing AUTHs, or a mad
32541 client looping sending EHLO. The global option &%smtp_accept_max_nonmail%&
32542 defines what &"too many"& means. Its default value is 10.
32543
32544 When a new message is expected, one occurrence of RSET is not counted. This
32545 allows a client to send one RSET between messages (this is not necessary,
32546 but some clients do it). Exim also allows one uncounted occurrence of HELO
32547 or EHLO, and one occurrence of STARTTLS between messages. After
32548 starting up a TLS session, another EHLO is expected, and so it too is not
32549 counted.
32550
32551 The first occurrence of AUTH in a connection, or immediately following
32552 STARTTLS is also not counted. Otherwise, all commands other than MAIL,
32553 RCPT, DATA, and QUIT are counted.
32554
32555 You can control which hosts are subject to the limit set by
32556 &%smtp_accept_max_nonmail%& by setting
32557 &%smtp_accept_max_nonmail_hosts%&. The default value is &`*`&, which makes
32558 the limit apply to all hosts. This option means that you can exclude any
32559 specific badly-behaved hosts that you have to live with.
32560
32561
32562
32563
32564 .section "The VRFY and EXPN commands" "SECID237"
32565 When Exim receives a VRFY or EXPN command on a TCP/IP connection, it
32566 runs the ACL specified by &%acl_smtp_vrfy%& or &%acl_smtp_expn%& (as
32567 appropriate) in order to decide whether the command should be accepted or not.
32568 If no ACL is defined, the command is rejected.
32569
32570 .cindex "VRFY" "processing"
32571 When VRFY is accepted, it runs exactly the same code as when Exim is
32572 called with the &%-bv%& option.
32573
32574 .cindex "EXPN" "processing"
32575 When EXPN is accepted, a single-level expansion of the address is done.
32576 EXPN is treated as an &"address test"& (similar to the &%-bt%& option) rather
32577 than a verification (the &%-bv%& option). If an unqualified local part is given
32578 as the argument to EXPN, it is qualified with &%qualify_domain%&. Rejections
32579 of VRFY and EXPN commands are logged on the main and reject logs, and
32580 VRFY verification failures are logged on the main log for consistency with
32581 RCPT failures.
32582
32583
32584
32585 .section "The ETRN command" "SECTETRN"
32586 .cindex "ETRN" "processing"
32587 RFC 1985 describes an SMTP command called ETRN that is designed to
32588 overcome the security problems of the TURN command (which has fallen into
32589 disuse). When Exim receives an ETRN command on a TCP/IP connection, it runs
32590 the ACL specified by &%acl_smtp_etrn%& in order to decide whether the command
32591 should be accepted or not. If no ACL is defined, the command is rejected.
32592
32593 The ETRN command is concerned with &"releasing"& messages that are awaiting
32594 delivery to certain hosts. As Exim does not organize its message queue by host,
32595 the only form of ETRN that is supported by default is the one where the
32596 text starts with the &"#"& prefix, in which case the remainder of the text is
32597 specific to the SMTP server. A valid ETRN command causes a run of Exim with
32598 the &%-R%& option to happen, with the remainder of the ETRN text as its
32599 argument. For example,
32600 .code
32601 ETRN #brigadoon
32602 .endd
32603 runs the command
32604 .code
32605 exim -R brigadoon
32606 .endd
32607 which causes a delivery attempt on all messages with undelivered addresses
32608 containing the text &"brigadoon"&. When &%smtp_etrn_serialize%& is set (the
32609 default), Exim prevents the simultaneous execution of more than one queue run
32610 for the same argument string as a result of an ETRN command. This stops
32611 a misbehaving client from starting more than one queue runner at once.
32612
32613 .cindex "hints database" "ETRN serialization"
32614 Exim implements the serialization by means of a hints database in which a
32615 record is written whenever a process is started by ETRN, and deleted when
32616 the process completes. However, Exim does not keep the SMTP session waiting for
32617 the ETRN process to complete. Once ETRN is accepted, the client is sent
32618 a &"success"& return code. Obviously there is scope for hints records to get
32619 left lying around if there is a system or program crash. To guard against this,
32620 Exim ignores any records that are more than six hours old.
32621
32622 .oindex "&%smtp_etrn_command%&"
32623 For more control over what ETRN does, the &%smtp_etrn_command%& option can
32624 used. This specifies a command that is run whenever ETRN is received,
32625 whatever the form of its argument. For
32626 example:
32627 .code
32628 smtp_etrn_command = /etc/etrn_command $domain \
32629                     $sender_host_address
32630 .endd
32631 .vindex "&$domain$&"
32632 The string is split up into arguments which are independently expanded. The
32633 expansion variable &$domain$& is set to the argument of the ETRN command,
32634 and no syntax checking is done on the contents of this argument. Exim does not
32635 wait for the command to complete, so its status code is not checked. Exim runs
32636 under its own uid and gid when receiving incoming SMTP, so it is not possible
32637 for it to change them before running the command.
32638
32639
32640
32641 .section "Incoming local SMTP" "SECID238"
32642 .cindex "SMTP" "local incoming"
32643 Some user agents use SMTP to pass messages to their local MTA using the
32644 standard input and output, as opposed to passing the envelope on the command
32645 line and writing the message to the standard input. This is supported by the
32646 &%-bs%& option. This form of SMTP is handled in the same way as incoming
32647 messages over TCP/IP (including the use of ACLs), except that the envelope
32648 sender given in a MAIL command is ignored unless the caller is trusted. In
32649 an ACL you can detect this form of SMTP input by testing for an empty host
32650 identification. It is common to have this as the first line in the ACL that
32651 runs for RCPT commands:
32652 .code
32653 accept hosts = :
32654 .endd
32655 This accepts SMTP messages from local processes without doing any other tests.
32656
32657
32658
32659 .section "Outgoing batched SMTP" "SECTbatchSMTP"
32660 .cindex "SMTP" "batched outgoing"
32661 .cindex "batched SMTP output"
32662 Both the &(appendfile)& and &(pipe)& transports can be used for handling
32663 batched SMTP. Each has an option called &%use_bsmtp%& which causes messages to
32664 be output in BSMTP format. No SMTP responses are possible for this form of
32665 delivery. All it is doing is using SMTP commands as a way of transmitting the
32666 envelope along with the message.
32667
32668 The message is written to the file or pipe preceded by the SMTP commands
32669 MAIL and RCPT, and followed by a line containing a single dot. Lines in
32670 the message that start with a dot have an extra dot added. The SMTP command
32671 HELO is not normally used. If it is required, the &%message_prefix%& option
32672 can be used to specify it.
32673
32674 Because &(appendfile)& and &(pipe)& are both local transports, they accept only
32675 one recipient address at a time by default. However, you can arrange for them
32676 to handle several addresses at once by setting the &%batch_max%& option. When
32677 this is done for BSMTP, messages may contain multiple RCPT commands. See
32678 chapter &<<CHAPbatching>>& for more details.
32679
32680 .vindex "&$host$&"
32681 When one or more addresses are routed to a BSMTP transport by a router that
32682 sets up a host list, the name of the first host on the list is available to the
32683 transport in the variable &$host$&. Here is an example of such a transport and
32684 router:
32685 .code
32686 begin routers
32687 route_append:
32688   driver = manualroute
32689   transport = smtp_appendfile
32690   route_list = domain.example  batch.host.example
32691
32692 begin transports
32693 smtp_appendfile:
32694   driver = appendfile
32695   directory = /var/bsmtp/$host
32696   batch_max = 1000
32697   use_bsmtp
32698   user = exim
32699 .endd
32700 This causes messages addressed to &'domain.example'& to be written in BSMTP
32701 format to &_/var/bsmtp/batch.host.example_&, with only a single copy of each
32702 message (unless there are more than 1000 recipients).
32703
32704
32705
32706 .section "Incoming batched SMTP" "SECTincomingbatchedSMTP"
32707 .cindex "SMTP" "batched incoming"
32708 .cindex "batched SMTP input"
32709 The &%-bS%& command line option causes Exim to accept one or more messages by
32710 reading SMTP on the standard input, but to generate no responses. If the caller
32711 is trusted, the senders in the MAIL commands are believed; otherwise the
32712 sender is always the caller of Exim. Unqualified senders and receivers are not
32713 rejected (there seems little point) but instead just get qualified. HELO
32714 and EHLO act as RSET; VRFY, EXPN, ETRN and  HELP, act
32715 as NOOP; QUIT quits.
32716
32717 Minimal policy checking is done for BSMTP input. Only the non-SMTP
32718 ACL is run in the same way as for non-SMTP local input.
32719
32720 If an error is detected while reading a message, including a missing &"."& at
32721 the end, Exim gives up immediately. It writes details of the error to the
32722 standard output in a stylized way that the calling program should be able to
32723 make some use of automatically, for example:
32724 .code
32725 554 Unexpected end of file
32726 Transaction started in line 10
32727 Error detected in line 14
32728 .endd
32729 It writes a more verbose version, for human consumption, to the standard error
32730 file, for example:
32731 .code
32732 An error was detected while processing a file of BSMTP input.
32733 The error message was:
32734
32735 501 '>' missing at end of address
32736
32737 The SMTP transaction started in line 10.
32738 The error was detected in line 12.
32739 The SMTP command at fault was:
32740
32741 rcpt to:<malformed@in.com.plete
32742
32743 1 previous message was successfully processed.
32744 The rest of the batch was abandoned.
32745 .endd
32746 The return code from Exim is zero only if there were no errors. It is 1 if some
32747 messages were accepted before an error was detected, and 2 if no messages were
32748 accepted.
32749 .ecindex IIDsmtpproc1
32750 .ecindex IIDsmtpproc2
32751
32752
32753
32754 . ////////////////////////////////////////////////////////////////////////////
32755 . ////////////////////////////////////////////////////////////////////////////
32756
32757 .chapter "Customizing bounce and warning messages" "CHAPemsgcust" &&&
32758          "Customizing messages"
32759 When a message fails to be delivered, or remains on the queue for more than a
32760 configured amount of time, Exim sends a message to the original sender, or
32761 to an alternative configured address. The text of these messages is built into
32762 the code of Exim, but it is possible to change it, either by adding a single
32763 string, or by replacing each of the paragraphs by text supplied in a file.
32764
32765 The &'From:'& and &'To:'& header lines are automatically generated; you can
32766 cause a &'Reply-To:'& line to be added by setting the &%errors_reply_to%&
32767 option. Exim also adds the line
32768 .code
32769 Auto-Submitted: auto-generated
32770 .endd
32771 to all warning and bounce messages,
32772
32773
32774 .section "Customizing bounce messages" "SECID239"
32775 .cindex "customizing" "bounce message"
32776 .cindex "bounce message" "customizing"
32777 If &%bounce_message_text%& is set, its contents are included in the default
32778 message immediately after &"This message was created automatically by mail
32779 delivery software."& The string is not expanded. It is not used if
32780 &%bounce_message_file%& is set.
32781
32782 When &%bounce_message_file%& is set, it must point to a template file for
32783 constructing error messages. The file consists of a series of text items,
32784 separated by lines consisting of exactly four asterisks. If the file cannot be
32785 opened, default text is used and a message is written to the main and panic
32786 logs. If any text item in the file is empty, default text is used for that
32787 item.
32788
32789 .vindex "&$bounce_recipient$&"
32790 .vindex "&$bounce_return_size_limit$&"
32791 Each item of text that is read from the file is expanded, and there are two
32792 expansion variables which can be of use here: &$bounce_recipient$& is set to
32793 the recipient of an error message while it is being created, and
32794 &$bounce_return_size_limit$& contains the value of the &%return_size_limit%&
32795 option, rounded to a whole number.
32796
32797 The items must appear in the file in the following order:
32798
32799 .ilist
32800 The first item is included in the headers, and should include at least a
32801 &'Subject:'& header. Exim does not check the syntax of these headers.
32802 .next
32803 The second item forms the start of the error message. After it, Exim lists the
32804 failing addresses with their error messages.
32805 .next
32806 The third item is used to introduce any text from pipe transports that is to be
32807 returned to the sender. It is omitted if there is no such text.
32808 .next
32809 The fourth item is used to introduce the copy of the message that is returned
32810 as part of the error report.
32811 .next
32812 The fifth item is added after the fourth one if the returned message is
32813 truncated because it is bigger than &%return_size_limit%&.
32814 .next
32815 The sixth item is added after the copy of the original message.
32816 .endlist
32817
32818 The default state (&%bounce_message_file%& unset) is equivalent to the
32819 following file, in which the sixth item is empty. The &'Subject:'& and some
32820 other lines have been split in order to fit them on the page:
32821 .code
32822 Subject: Mail delivery failed
32823   ${if eq{$sender_address}{$bounce_recipient}
32824   {: returning message to sender}}
32825 ****
32826 This message was created automatically by mail delivery software.
32827
32828 A message ${if eq{$sender_address}{$bounce_recipient}
32829   {that you sent }{sent by
32830
32831 <$sender_address>
32832
32833 }}could not be delivered to all of its recipients.
32834 This is a permanent error. The following address(es) failed:
32835 ****
32836 The following text was generated during the delivery attempt(s):
32837 ****
32838 ------ This is a copy of the message, including all the headers.
32839   ------
32840 ****
32841 ------ The body of the message is $message_size characters long;
32842   only the first
32843 ------ $bounce_return_size_limit or so are included here.
32844 ****
32845 .endd
32846 .section "Customizing warning messages" "SECTcustwarn"
32847 .cindex "customizing" "warning message"
32848 .cindex "warning of delay" "customizing the message"
32849 The option &%warn_message_file%& can be pointed at a template file for use when
32850 warnings about message delays are created. In this case there are only three
32851 text sections:
32852
32853 .ilist
32854 The first item is included in the headers, and should include at least a
32855 &'Subject:'& header. Exim does not check the syntax of these headers.
32856 .next
32857 The second item forms the start of the warning message. After it, Exim lists
32858 the delayed addresses.
32859 .next
32860 The third item then ends the message.
32861 .endlist
32862
32863 The default state is equivalent to the following file, except that some lines
32864 have been split here, in order to fit them on the page:
32865 .code
32866 Subject: Warning: message $message_exim_id delayed
32867   $warn_message_delay
32868 ****
32869 This message was created automatically by mail delivery software.
32870
32871 A message ${if eq{$sender_address}{$warn_message_recipients}
32872 {that you sent }{sent by
32873
32874 <$sender_address>
32875
32876 }}has not been delivered to all of its recipients after
32877 more than $warn_message_delay on the queue on $primary_hostname.
32878
32879 The message identifier is:     $message_exim_id
32880 The subject of the message is: $h_subject
32881 The date of the message is:    $h_date
32882
32883 The following address(es) have not yet been delivered:
32884 ****
32885 No action is required on your part. Delivery attempts will
32886 continue for some time, and this warning may be repeated at
32887 intervals if the message remains undelivered. Eventually the
32888 mail delivery software will give up, and when that happens,
32889 the message will be returned to you.
32890 .endd
32891 .vindex "&$warn_message_delay$&"
32892 .vindex "&$warn_message_recipients$&"
32893 However, in the default state the subject and date lines are omitted if no
32894 appropriate headers exist. During the expansion of this file,
32895 &$warn_message_delay$& is set to the delay time in one of the forms &"<&'n'&>
32896 minutes"& or &"<&'n'&> hours"&, and &$warn_message_recipients$& contains a list
32897 of recipients for the warning message. There may be more than one if there are
32898 multiple addresses with different &%errors_to%& settings on the routers that
32899 handled them.
32900
32901
32902
32903
32904 . ////////////////////////////////////////////////////////////////////////////
32905 . ////////////////////////////////////////////////////////////////////////////
32906
32907 .chapter "Some common configuration settings" "CHAPcomconreq"
32908 This chapter discusses some configuration settings that seem to be fairly
32909 common. More examples and discussion can be found in the Exim book.
32910
32911
32912
32913 .section "Sending mail to a smart host" "SECID240"
32914 .cindex "smart host" "example router"
32915 If you want to send all mail for non-local domains to a &"smart host"&, you
32916 should replace the default &(dnslookup)& router with a router which does the
32917 routing explicitly:
32918 .code
32919 send_to_smart_host:
32920   driver = manualroute
32921   route_list = !+local_domains smart.host.name
32922   transport = remote_smtp
32923 .endd
32924 You can use the smart host's IP address instead of the name if you wish.
32925 If you are using Exim only to submit messages to a smart host, and not for
32926 receiving incoming messages, you can arrange for it to do the submission
32927 synchronously by setting the &%mua_wrapper%& option (see chapter
32928 &<<CHAPnonqueueing>>&).
32929
32930
32931
32932
32933 .section "Using Exim to handle mailing lists" "SECTmailinglists"
32934 .cindex "mailing lists"
32935 Exim can be used to run simple mailing lists, but for large and/or complicated
32936 requirements, the use of additional specialized mailing list software such as
32937 Majordomo or Mailman is recommended.
32938
32939 The &(redirect)& router can be used to handle mailing lists where each list
32940 is maintained in a separate file, which can therefore be managed by an
32941 independent manager. The &%domains%& router option can be used to run these
32942 lists in a separate domain from normal mail. For example:
32943 .code
32944 lists:
32945   driver = redirect
32946   domains = lists.example
32947   file = /usr/lists/$local_part
32948   forbid_pipe
32949   forbid_file
32950   errors_to = $local_part-request@lists.example
32951   no_more
32952 .endd
32953 This router is skipped for domains other than &'lists.example'&. For addresses
32954 in that domain, it looks for a file that matches the local part. If there is no
32955 such file, the router declines, but because &%no_more%& is set, no subsequent
32956 routers are tried, and so the whole delivery fails.
32957
32958 The &%forbid_pipe%& and &%forbid_file%& options prevent a local part from being
32959 expanded into a file name or a pipe delivery, which is usually inappropriate in
32960 a mailing list.
32961
32962 .oindex "&%errors_to%&"
32963 The &%errors_to%& option specifies that any delivery errors caused by addresses
32964 taken from a mailing list are to be sent to the given address rather than the
32965 original sender of the message. However, before acting on this, Exim verifies
32966 the error address, and ignores it if verification fails.
32967
32968 For example, using the configuration above, mail sent to
32969 &'dicts@lists.example'& is passed on to those addresses contained in
32970 &_/usr/lists/dicts_&, with error reports directed to
32971 &'dicts-request@lists.example'&, provided that this address can be verified.
32972 There could be a file called &_/usr/lists/dicts-request_& containing
32973 the address(es) of this particular list's manager(s), but other approaches,
32974 such as setting up an earlier router (possibly using the &%local_part_prefix%&
32975 or &%local_part_suffix%& options) to handle addresses of the form
32976 &%owner-%&&'xxx'& or &%xxx-%&&'request'&, are also possible.
32977
32978
32979
32980 .section "Syntax errors in mailing lists" "SECID241"
32981 .cindex "mailing lists" "syntax errors in"
32982 If an entry in redirection data contains a syntax error, Exim normally defers
32983 delivery of the original address. That means that a syntax error in a mailing
32984 list holds up all deliveries to the list. This may not be appropriate when a
32985 list is being maintained automatically from data supplied by users, and the
32986 addresses are not rigorously checked.
32987
32988 If the &%skip_syntax_errors%& option is set, the &(redirect)& router just skips
32989 entries that fail to parse, noting the incident in the log. If in addition
32990 &%syntax_errors_to%& is set to a verifiable address, a message is sent to it
32991 whenever a broken address is skipped. It is usually appropriate to set
32992 &%syntax_errors_to%& to the same address as &%errors_to%&.
32993
32994
32995
32996 .section "Re-expansion of mailing lists" "SECID242"
32997 .cindex "mailing lists" "re-expansion of"
32998 Exim remembers every individual address to which a message has been delivered,
32999 in order to avoid duplication, but it normally stores only the original
33000 recipient addresses with a message. If all the deliveries to a mailing list
33001 cannot be done at the first attempt, the mailing list is re-expanded when the
33002 delivery is next tried. This means that alterations to the list are taken into
33003 account at each delivery attempt, so addresses that have been added to
33004 the list since the message arrived will therefore receive a copy of the
33005 message, even though it pre-dates their subscription.
33006
33007 If this behaviour is felt to be undesirable, the &%one_time%& option can be set
33008 on the &(redirect)& router. If this is done, any addresses generated by the
33009 router that fail to deliver at the first attempt are added to the message as
33010 &"top level"& addresses, and the parent address that generated them is marked
33011 &"delivered"&. Thus, expansion of the mailing list does not happen again at the
33012 subsequent delivery attempts. The disadvantage of this is that if any of the
33013 failing addresses are incorrect, correcting them in the file has no effect on
33014 pre-existing messages.
33015
33016 The original top-level address is remembered with each of the generated
33017 addresses, and is output in any log messages. However, any intermediate parent
33018 addresses are not recorded. This makes a difference to the log only if the
33019 &%all_parents%& selector is set, but for mailing lists there is normally only
33020 one level of expansion anyway.
33021
33022
33023
33024 .section "Closed mailing lists" "SECID243"
33025 .cindex "mailing lists" "closed"
33026 The examples so far have assumed open mailing lists, to which anybody may
33027 send mail. It is also possible to set up closed lists, where mail is accepted
33028 from specified senders only. This is done by making use of the generic
33029 &%senders%& option to restrict the router that handles the list.
33030
33031 The following example uses the same file as a list of recipients and as a list
33032 of permitted senders. It requires three routers:
33033 .code
33034 lists_request:
33035   driver = redirect
33036   domains = lists.example
33037   local_part_suffix = -request
33038   file = /usr/lists/$local_part$local_part_suffix
33039   no_more
33040
33041 lists_post:
33042   driver = redirect
33043   domains = lists.example
33044   senders = ${if exists {/usr/lists/$local_part}\
33045              {lsearch;/usr/lists/$local_part}{*}}
33046   file = /usr/lists/$local_part
33047   forbid_pipe
33048   forbid_file
33049   errors_to = $local_part-request@lists.example
33050   no_more
33051
33052 lists_closed:
33053   driver = redirect
33054   domains = lists.example
33055   allow_fail
33056   data = :fail: $local_part@lists.example is a closed mailing list
33057 .endd
33058 All three routers have the same &%domains%& setting, so for any other domains,
33059 they are all skipped. The first router runs only if the local part ends in
33060 &%-request%&. It handles messages to the list manager(s) by means of an open
33061 mailing list.
33062
33063 The second router runs only if the &%senders%& precondition is satisfied. It
33064 checks for the existence of a list that corresponds to the local part, and then
33065 checks that the sender is on the list by means of a linear search. It is
33066 necessary to check for the existence of the file before trying to search it,
33067 because otherwise Exim thinks there is a configuration error. If the file does
33068 not exist, the expansion of &%senders%& is *, which matches all senders. This
33069 means that the router runs, but because there is no list, declines, and
33070 &%no_more%& ensures that no further routers are run. The address fails with an
33071 &"unrouteable address"& error.
33072
33073 The third router runs only if the second router is skipped, which happens when
33074 a mailing list exists, but the sender is not on it. This router forcibly fails
33075 the address, giving a suitable error message.
33076
33077
33078
33079
33080 .section "Variable Envelope Return Paths (VERP)" "SECTverp"
33081 .cindex "VERP"
33082 .cindex "Variable Envelope Return Paths"
33083 .cindex "envelope sender"
33084 Variable Envelope Return Paths &-- see &url(http://cr.yp.to/proto/verp.txt) &--
33085 are a way of helping mailing list administrators discover which subscription
33086 address is the cause of a particular delivery failure. The idea is to encode
33087 the original recipient address in the outgoing envelope sender address, so that
33088 if the message is forwarded by another host and then subsequently bounces, the
33089 original recipient can be extracted from the recipient address of the bounce.
33090
33091 .oindex &%errors_to%&
33092 .oindex &%return_path%&
33093 Envelope sender addresses can be modified by Exim using two different
33094 facilities: the &%errors_to%& option on a router (as shown in previous mailing
33095 list examples), or the &%return_path%& option on a transport. The second of
33096 these is effective only if the message is successfully delivered to another
33097 host; it is not used for errors detected on the local host (see the description
33098 of &%return_path%& in chapter &<<CHAPtransportgeneric>>&). Here is an example
33099 of the use of &%return_path%& to implement VERP on an &(smtp)& transport:
33100 .code
33101 verp_smtp:
33102   driver = smtp
33103   max_rcpt = 1
33104   return_path = \
33105     ${if match {$return_path}{^(.+?)-request@your.dom.example\$}\
33106       {$1-request+$local_part=$domain@your.dom.example}fail}
33107 .endd
33108 This has the effect of rewriting the return path (envelope sender) on outgoing
33109 SMTP messages, if the local part of the original return path ends in
33110 &"-request"&, and the domain is &'your.dom.example'&. The rewriting inserts the
33111 local part and domain of the recipient into the return path. Suppose, for
33112 example, that a message whose return path has been set to
33113 &'somelist-request@your.dom.example'& is sent to
33114 &'subscriber@other.dom.example'&. In the transport, the return path is
33115 rewritten as
33116 .code
33117 somelist-request+subscriber=other.dom.example@your.dom.example
33118 .endd
33119 .vindex "&$local_part$&"
33120 For this to work, you must tell Exim to send multiple copies of messages that
33121 have more than one recipient, so that each copy has just one recipient. This is
33122 achieved by setting &%max_rcpt%& to 1. Without this, a single copy of a message
33123 might be sent to several different recipients in the same domain, in which case
33124 &$local_part$& is not available in the transport, because it is not unique.
33125
33126 Unless your host is doing nothing but mailing list deliveries, you should
33127 probably use a separate transport for the VERP deliveries, so as not to use
33128 extra resources in making one-per-recipient copies for other deliveries. This
33129 can easily be done by expanding the &%transport%& option in the router:
33130 .code
33131 dnslookup:
33132   driver = dnslookup
33133   domains = ! +local_domains
33134   transport = \
33135     ${if match {$return_path}{^(.+?)-request@your.dom.example\$}\
33136       {verp_smtp}{remote_smtp}}
33137   no_more
33138 .endd
33139 If you want to change the return path using &%errors_to%& in a router instead
33140 of using &%return_path%& in the transport, you need to set &%errors_to%& on all
33141 routers that handle mailing list addresses. This will ensure that all delivery
33142 errors, including those detected on the local host, are sent to the VERP
33143 address.
33144
33145 On a host that does no local deliveries and has no manual routing, only the
33146 &(dnslookup)& router needs to be changed. A special transport is not needed for
33147 SMTP deliveries. Every mailing list recipient has its own return path value,
33148 and so Exim must hand them to the transport one at a time. Here is an example
33149 of a &(dnslookup)& router that implements VERP:
33150 .code
33151 verp_dnslookup:
33152   driver = dnslookup
33153   domains = ! +local_domains
33154   transport = remote_smtp
33155   errors_to = \
33156     ${if match {$return_path}{^(.+?)-request@your.dom.example\$}}
33157      {$1-request+$local_part=$domain@your.dom.example}fail}
33158   no_more
33159 .endd
33160 Before you start sending out messages with VERPed return paths, you must also
33161 configure Exim to accept the bounce messages that come back to those paths.
33162 Typically this is done by setting a &%local_part_suffix%& option for a
33163 router, and using this to route the messages to wherever you want to handle
33164 them.
33165
33166 The overhead incurred in using VERP depends very much on the size of the
33167 message, the number of recipient addresses that resolve to the same remote
33168 host, and the speed of the connection over which the message is being sent. If
33169 a lot of addresses resolve to the same host and the connection is slow, sending
33170 a separate copy of the message for each address may take substantially longer
33171 than sending a single copy with many recipients (for which VERP cannot be
33172 used).
33173
33174
33175
33176
33177
33178
33179 .section "Virtual domains" "SECTvirtualdomains"
33180 .cindex "virtual domains"
33181 .cindex "domain" "virtual"
33182 The phrase &'virtual domain'& is unfortunately used with two rather different
33183 meanings:
33184
33185 .ilist
33186 A domain for which there are no real mailboxes; all valid local parts are
33187 aliases for other email addresses. Common examples are organizational
33188 top-level domains and &"vanity"& domains.
33189 .next
33190 One of a number of independent domains that are all handled by the same host,
33191 with mailboxes on that host, but where the mailbox owners do not necessarily
33192 have login accounts on that host.
33193 .endlist
33194
33195 The first usage is probably more common, and does seem more &"virtual"& than
33196 the second. This kind of domain can be handled in Exim with a straightforward
33197 aliasing router. One approach is to create a separate alias file for each
33198 virtual domain. Exim can test for the existence of the alias file to determine
33199 whether the domain exists. The &(dsearch)& lookup type is useful here, leading
33200 to a router of this form:
33201 .code
33202 virtual:
33203   driver = redirect
33204   domains = dsearch;/etc/mail/virtual
33205   data = ${lookup{$local_part}lsearch{/etc/mail/virtual/$domain}}
33206   no_more
33207 .endd
33208 The &%domains%& option specifies that the router is to be skipped, unless there
33209 is a file in the &_/etc/mail/virtual_& directory whose name is the same as the
33210 domain that is being processed. When the router runs, it looks up the local
33211 part in the file to find a new address (or list of addresses). The &%no_more%&
33212 setting ensures that if the lookup fails (leading to &%data%& being an empty
33213 string), Exim gives up on the address without trying any subsequent routers.
33214
33215 This one router can handle all the virtual domains because the alias file names
33216 follow a fixed pattern. Permissions can be arranged so that appropriate people
33217 can edit the different alias files. A successful aliasing operation results in
33218 a new envelope recipient address, which is then routed from scratch.
33219
33220 The other kind of &"virtual"& domain can also be handled in a straightforward
33221 way. One approach is to create a file for each domain containing a list of
33222 valid local parts, and use it in a router like this:
33223 .code
33224 my_domains:
33225   driver = accept
33226   domains = dsearch;/etc/mail/domains
33227   local_parts = lsearch;/etc/mail/domains/$domain
33228   transport = my_mailboxes
33229 .endd
33230 The address is accepted if there is a file for the domain, and the local part
33231 can be found in the file. The &%domains%& option is used to check for the
33232 file's existence because &%domains%& is tested before the &%local_parts%&
33233 option (see section &<<SECTrouprecon>>&). You cannot use &%require_files%&,
33234 because that option is tested after &%local_parts%&. The transport is as
33235 follows:
33236 .code
33237 my_mailboxes:
33238   driver = appendfile
33239   file = /var/mail/$domain/$local_part
33240   user = mail
33241 .endd
33242 This uses a directory of mailboxes for each domain. The &%user%& setting is
33243 required, to specify which uid is to be used for writing to the mailboxes.
33244
33245 The configuration shown here is just one example of how you might support this
33246 requirement. There are many other ways this kind of configuration can be set
33247 up, for example, by using a database instead of separate files to hold all the
33248 information about the domains.
33249
33250
33251
33252 .section "Multiple user mailboxes" "SECTmulbox"
33253 .cindex "multiple mailboxes"
33254 .cindex "mailbox" "multiple"
33255 .cindex "local part" "prefix"
33256 .cindex "local part" "suffix"
33257 Heavy email users often want to operate with multiple mailboxes, into which
33258 incoming mail is automatically sorted. A popular way of handling this is to
33259 allow users to use multiple sender addresses, so that replies can easily be
33260 identified. Users are permitted to add prefixes or suffixes to their local
33261 parts for this purpose. The wildcard facility of the generic router options
33262 &%local_part_prefix%& and &%local_part_suffix%& can be used for this. For
33263 example, consider this router:
33264 .code
33265 userforward:
33266   driver = redirect
33267   check_local_user
33268   file = $home/.forward
33269   local_part_suffix = -*
33270   local_part_suffix_optional
33271   allow_filter
33272 .endd
33273 .vindex "&$local_part_suffix$&"
33274 It runs a user's &_.forward_& file for all local parts of the form
33275 &'username-*'&. Within the filter file the user can distinguish different
33276 cases by testing the variable &$local_part_suffix$&. For example:
33277 .code
33278 if $local_part_suffix contains -special then
33279 save /home/$local_part/Mail/special
33280 endif
33281 .endd
33282 If the filter file does not exist, or does not deal with such addresses, they
33283 fall through to subsequent routers, and, assuming no subsequent use of the
33284 &%local_part_suffix%& option is made, they presumably fail. Thus, users have
33285 control over which suffixes are valid.
33286
33287 Alternatively, a suffix can be used to trigger the use of a different
33288 &_.forward_& file &-- which is the way a similar facility is implemented in
33289 another MTA:
33290 .code
33291 userforward:
33292   driver = redirect
33293   check_local_user
33294   file = $home/.forward$local_part_suffix
33295   local_part_suffix = -*
33296   local_part_suffix_optional
33297   allow_filter
33298 .endd
33299 If there is no suffix, &_.forward_& is used; if the suffix is &'-special'&, for
33300 example, &_.forward-special_& is used. Once again, if the appropriate file
33301 does not exist, or does not deal with the address, it is passed on to
33302 subsequent routers, which could, if required, look for an unqualified
33303 &_.forward_& file to use as a default.
33304
33305
33306
33307 .section "Simplified vacation processing" "SECID244"
33308 .cindex "vacation processing"
33309 The traditional way of running the &'vacation'& program is for a user to set up
33310 a pipe command in a &_.forward_& file
33311 (see section &<<SECTspecitredli>>& for syntax details).
33312 This is prone to error by inexperienced users. There are two features of Exim
33313 that can be used to make this process simpler for users:
33314
33315 .ilist
33316 A local part prefix such as &"vacation-"& can be specified on a router which
33317 can cause the message to be delivered directly to the &'vacation'& program, or
33318 alternatively can use Exim's &(autoreply)& transport. The contents of a user's
33319 &_.forward_& file are then much simpler. For example:
33320 .code
33321 spqr, vacation-spqr
33322 .endd
33323 .next
33324 The &%require_files%& generic router option can be used to trigger a
33325 vacation delivery by checking for the existence of a certain file in the
33326 user's home directory. The &%unseen%& generic option should also be used, to
33327 ensure that the original delivery also proceeds. In this case, all the user has
33328 to do is to create a file called, say, &_.vacation_&, containing a vacation
33329 message.
33330 .endlist
33331
33332 Another advantage of both these methods is that they both work even when the
33333 use of arbitrary pipes by users is locked out.
33334
33335
33336
33337 .section "Taking copies of mail" "SECID245"
33338 .cindex "message" "copying every"
33339 Some installations have policies that require archive copies of all messages to
33340 be made. A single copy of each message can easily be taken by an appropriate
33341 command in a system filter, which could, for example, use a different file for
33342 each day's messages.
33343
33344 There is also a shadow transport mechanism that can be used to take copies of
33345 messages that are successfully delivered by local transports, one copy per
33346 delivery. This could be used, &'inter alia'&, to implement automatic
33347 notification of delivery by sites that insist on doing such things.
33348
33349
33350
33351 .section "Intermittently connected hosts" "SECID246"
33352 .cindex "intermittently connected hosts"
33353 It has become quite common (because it is cheaper) for hosts to connect to the
33354 Internet periodically rather than remain connected all the time. The normal
33355 arrangement is that mail for such hosts accumulates on a system that is
33356 permanently connected.
33357
33358 Exim was designed for use on permanently connected hosts, and so it is not
33359 particularly well-suited to use in an intermittently connected environment.
33360 Nevertheless there are some features that can be used.
33361
33362
33363 .section "Exim on the upstream server host" "SECID247"
33364 It is tempting to arrange for incoming mail for the intermittently connected
33365 host to remain on Exim's queue until the client connects. However, this
33366 approach does not scale very well. Two different kinds of waiting message are
33367 being mixed up in the same queue &-- those that cannot be delivered because of
33368 some temporary problem, and those that are waiting for their destination host
33369 to connect. This makes it hard to manage the queue, as well as wasting
33370 resources, because each queue runner scans the entire queue.
33371
33372 A better approach is to separate off those messages that are waiting for an
33373 intermittently connected host. This can be done by delivering these messages
33374 into local files in batch SMTP, &"mailstore"&, or other envelope-preserving
33375 format, from where they are transmitted by other software when their
33376 destination connects. This makes it easy to collect all the mail for one host
33377 in a single directory, and to apply local timeout rules on a per-message basis
33378 if required.
33379
33380 On a very small scale, leaving the mail on Exim's queue can be made to work. If
33381 you are doing this, you should configure Exim with a long retry period for the
33382 intermittent host. For example:
33383 .code
33384 cheshire.wonderland.fict.example    *   F,5d,24h
33385 .endd
33386 This stops a lot of failed delivery attempts from occurring, but Exim remembers
33387 which messages it has queued up for that host. Once the intermittent host comes
33388 online, forcing delivery of one message (either by using the &%-M%& or &%-R%&
33389 options, or by using the ETRN SMTP command (see section &<<SECTETRN>>&)
33390 causes all the queued up messages to be delivered, often down a single SMTP
33391 connection. While the host remains connected, any new messages get delivered
33392 immediately.
33393
33394 If the connecting hosts do not have fixed IP addresses, that is, if a host is
33395 issued with a different IP address each time it connects, Exim's retry
33396 mechanisms on the holding host get confused, because the IP address is normally
33397 used as part of the key string for holding retry information. This can be
33398 avoided by unsetting &%retry_include_ip_address%& on the &(smtp)& transport.
33399 Since this has disadvantages for permanently connected hosts, it is best to
33400 arrange a separate transport for the intermittently connected ones.
33401
33402
33403
33404 .section "Exim on the intermittently connected client host" "SECID248"
33405 The value of &%smtp_accept_queue_per_connection%& should probably be
33406 increased, or even set to zero (that is, disabled) on the intermittently
33407 connected host, so that all incoming messages down a single connection get
33408 delivered immediately.
33409
33410 .cindex "SMTP" "passed connection"
33411 .cindex "SMTP" "multiple deliveries"
33412 .cindex "multiple SMTP deliveries"
33413 Mail waiting to be sent from an intermittently connected host will probably
33414 not have been routed, because without a connection DNS lookups are not
33415 possible. This means that if a normal queue run is done at connection time,
33416 each message is likely to be sent in a separate SMTP session. This can be
33417 avoided by starting the queue run with a command line option beginning with
33418 &%-qq%& instead of &%-q%&. In this case, the queue is scanned twice. In the
33419 first pass, routing is done but no deliveries take place. The second pass is a
33420 normal queue run; since all the messages have been previously routed, those
33421 destined for the same host are likely to get sent as multiple deliveries in a
33422 single SMTP connection.
33423
33424
33425
33426 . ////////////////////////////////////////////////////////////////////////////
33427 . ////////////////////////////////////////////////////////////////////////////
33428
33429 .chapter "Using Exim as a non-queueing client" "CHAPnonqueueing" &&&
33430          "Exim as a non-queueing client"
33431 .cindex "client, non-queueing"
33432 .cindex "smart host" "suppressing queueing"
33433 On a personal computer, it is a common requirement for all
33434 email to be sent to a &"smart host"&. There are plenty of MUAs that can be
33435 configured to operate that way, for all the popular operating systems.
33436 However, there are some MUAs for Unix-like systems that cannot be so
33437 configured: they submit messages using the command line interface of
33438 &_/usr/sbin/sendmail_&. Furthermore, utility programs such as &'cron'& submit
33439 messages this way.
33440
33441 If the personal computer runs continuously, there is no problem, because it can
33442 run a conventional MTA that handles delivery to the smart host, and deal with
33443 any delays via its queueing mechanism. However, if the computer does not run
33444 continuously or runs different operating systems at different times, queueing
33445 email is not desirable.
33446
33447 There is therefore a requirement for something that can provide the
33448 &_/usr/sbin/sendmail_& interface but deliver messages to a smart host without
33449 any queueing or retrying facilities. Furthermore, the delivery to the smart
33450 host should be synchronous, so that if it fails, the sending MUA is immediately
33451 informed. In other words, we want something that extends an MUA that submits
33452 to a local MTA via the command line so that it behaves like one that submits
33453 to a remote smart host using TCP/SMTP.
33454
33455 There are a number of applications (for example, there is one called &'ssmtp'&)
33456 that do this job. However, people have found them to be lacking in various
33457 ways. For instance, you might want to allow aliasing and forwarding to be done
33458 before sending a message to the smart host.
33459
33460 Exim already had the necessary infrastructure for doing this job. Just a few
33461 tweaks were needed to make it behave as required, though it is somewhat of an
33462 overkill to use a fully-featured MTA for this purpose.
33463
33464 .oindex "&%mua_wrapper%&"
33465 There is a Boolean global option called &%mua_wrapper%&, defaulting false.
33466 Setting &%mua_wrapper%& true causes Exim to run in a special mode where it
33467 assumes that it is being used to &"wrap"& a command-line MUA in the manner
33468 just described. As well as setting &%mua_wrapper%&, you also need to provide a
33469 compatible router and transport configuration. Typically there will be just one
33470 router and one transport, sending everything to a smart host.
33471
33472 When run in MUA wrapping mode, the behaviour of Exim changes in the
33473 following ways:
33474
33475 .ilist
33476 A daemon cannot be run, nor will Exim accept incoming messages from &'inetd'&.
33477 In other words, the only way to submit messages is via the command line.
33478 .next
33479 Each message is synchronously delivered as soon as it is received (&%-odi%& is
33480 assumed). All queueing options (&%queue_only%&, &%queue_smtp_domains%&,
33481 &%control%& in an ACL, etc.) are quietly ignored. The Exim reception process
33482 does not finish until the delivery attempt is complete. If the delivery is
33483 successful, a zero return code is given.
33484 .next
33485 Address redirection is permitted, but the final routing for all addresses must
33486 be to the same remote transport, and to the same list of hosts. Furthermore,
33487 the return address (envelope sender) must be the same for all recipients, as
33488 must any added or deleted header lines. In other words, it must be possible to
33489 deliver the message in a single SMTP transaction, however many recipients there
33490 are.
33491 .next
33492 If these conditions are not met, or if routing any address results in a
33493 failure or defer status, or if Exim is unable to deliver all the recipients
33494 successfully to one of the smart hosts, delivery of the entire message fails.
33495 .next
33496 Because no queueing is allowed, all failures are treated as permanent; there
33497 is no distinction between 4&'xx'& and 5&'xx'& SMTP response codes from the
33498 smart host. Furthermore, because only a single yes/no response can be given to
33499 the caller, it is not possible to deliver to some recipients and not others. If
33500 there is an error (temporary or permanent) for any recipient, all are failed.
33501 .next
33502 If more than one smart host is listed, Exim will try another host after a
33503 connection failure or a timeout, in the normal way. However, if this kind of
33504 failure happens for all the hosts, the delivery fails.
33505 .next
33506 When delivery fails, an error message is written to the standard error stream
33507 (as well as to Exim's log), and Exim exits to the caller with a return code
33508 value 1. The message is expunged from Exim's spool files. No bounce messages
33509 are ever generated.
33510 .next
33511 No retry data is maintained, and any retry rules are ignored.
33512 .next
33513 A number of Exim options are overridden: &%deliver_drop_privilege%& is forced
33514 true, &%max_rcpt%& in the &(smtp)& transport is forced to &"unlimited"&,
33515 &%remote_max_parallel%& is forced to one, and fallback hosts are ignored.
33516 .endlist
33517
33518 The overall effect is that Exim makes a single synchronous attempt to deliver
33519 the message, failing if there is any kind of problem. Because no local
33520 deliveries are done and no daemon can be run, Exim does not need root
33521 privilege. It should be possible to run it setuid to &'exim'& instead of setuid
33522 to &'root'&. See section &<<SECTrunexiwitpri>>& for a general discussion about
33523 the advantages and disadvantages of running without root privilege.
33524
33525
33526
33527
33528 . ////////////////////////////////////////////////////////////////////////////
33529 . ////////////////////////////////////////////////////////////////////////////
33530
33531 .chapter "Log files" "CHAPlog"
33532 .scindex IIDloggen "log" "general description"
33533 .cindex "log" "types of"
33534 Exim writes three different logs, referred to as the main log, the reject log,
33535 and the panic log:
33536
33537 .ilist
33538 .cindex "main log"
33539 The main log records the arrival of each message and each delivery in a single
33540 line in each case. The format is as compact as possible, in an attempt to keep
33541 down the size of log files. Two-character flag sequences make it easy to pick
33542 out these lines. A number of other events are recorded in the main log. Some of
33543 them are optional, in which case the &%log_selector%& option controls whether
33544 they are included or not. A Perl script called &'eximstats'&, which does simple
33545 analysis of main log files, is provided in the Exim distribution (see section
33546 &<<SECTmailstat>>&).
33547 .next
33548 .cindex "reject log"
33549 The reject log records information from messages that are rejected as a result
33550 of a configuration option (that is, for policy reasons).
33551 The first line of each rejection is a copy of the line that is also written to
33552 the main log. Then, if the message's header has been read at the time the log
33553 is written, its contents are written to this log. Only the original header
33554 lines are available; header lines added by ACLs are not logged. You can use the
33555 reject log to check that your policy controls are working correctly; on a busy
33556 host this may be easier than scanning the main log for rejection messages. You
33557 can suppress the writing of the reject log by setting &%write_rejectlog%&
33558 false.
33559 .next
33560 .cindex "panic log"
33561 .cindex "system log"
33562 When certain serious errors occur, Exim writes entries to its panic log. If the
33563 error is sufficiently disastrous, Exim bombs out afterwards. Panic log entries
33564 are usually written to the main log as well, but can get lost amid the mass of
33565 other entries. The panic log should be empty under normal circumstances. It is
33566 therefore a good idea to check it (or to have a &'cron'& script check it)
33567 regularly, in order to become aware of any problems. When Exim cannot open its
33568 panic log, it tries as a last resort to write to the system log (syslog). This
33569 is opened with LOG_PID+LOG_CONS and the facility code of LOG_MAIL. The
33570 message itself is written at priority LOG_CRIT.
33571 .endlist
33572
33573 Every log line starts with a timestamp, in the format shown in the following
33574 example. Note that many of the examples shown in this chapter are line-wrapped.
33575 In the log file, this would be all on one line:
33576 .code
33577 2001-09-16 16:09:47 SMTP connection from [127.0.0.1] closed
33578   by QUIT
33579 .endd
33580 By default, the timestamps are in the local timezone. There are two
33581 ways of changing this:
33582
33583 .ilist
33584 You can set the &%timezone%& option to a different time zone; in particular, if
33585 you set
33586 .code
33587 timezone = UTC
33588 .endd
33589 the timestamps will be in UTC (aka GMT).
33590 .next
33591 If you set &%log_timezone%& true, the time zone is added to the timestamp, for
33592 example:
33593 .code
33594 2003-04-25 11:17:07 +0100 Start queue run: pid=12762
33595 .endd
33596 .endlist
33597
33598 .cindex "log" "process ids in"
33599 .cindex "pid (process id)" "in log lines"
33600 Exim does not include its process id in log lines by default, but you can
33601 request that it does so by specifying the &`pid`& log selector (see section
33602 &<<SECTlogselector>>&). When this is set, the process id is output, in square
33603 brackets, immediately after the time and date.
33604
33605
33606
33607
33608 .section "Where the logs are written" "SECTwhelogwri"
33609 .cindex "log" "destination"
33610 .cindex "log" "to file"
33611 .cindex "log" "to syslog"
33612 .cindex "syslog"
33613 The logs may be written to local files, or to syslog, or both. However, it
33614 should be noted that many syslog implementations use UDP as a transport, and
33615 are therefore unreliable in the sense that messages are not guaranteed to
33616 arrive at the loghost, nor is the ordering of messages necessarily maintained.
33617 It has also been reported that on large log files (tens of megabytes) you may
33618 need to tweak syslog to prevent it syncing the file with each write &-- on
33619 Linux this has been seen to make syslog take 90% plus of CPU time.
33620
33621 The destination for Exim's logs is configured by setting LOG_FILE_PATH in
33622 &_Local/Makefile_& or by setting &%log_file_path%& in the run time
33623 configuration. This latter string is expanded, so it can contain, for example,
33624 references to the host name:
33625 .code
33626 log_file_path = /var/log/$primary_hostname/exim_%slog
33627 .endd
33628 It is generally advisable, however, to set the string in &_Local/Makefile_&
33629 rather than at run time, because then the setting is available right from the
33630 start of Exim's execution. Otherwise, if there's something it wants to log
33631 before it has read the configuration file (for example, an error in the
33632 configuration file) it will not use the path you want, and may not be able to
33633 log at all.
33634
33635 The value of LOG_FILE_PATH or &%log_file_path%& is a colon-separated
33636 list, currently limited to at most two items. This is one option where the
33637 facility for changing a list separator may not be used. The list must always be
33638 colon-separated. If an item in the list is &"syslog"& then syslog is used;
33639 otherwise the item must either be an absolute path, containing &`%s`& at the
33640 point where &"main"&, &"reject"&, or &"panic"& is to be inserted, or be empty,
33641 implying the use of a default path.
33642
33643 When Exim encounters an empty item in the list, it searches the list defined by
33644 LOG_FILE_PATH, and uses the first item it finds that is neither empty nor
33645 &"syslog"&. This means that an empty item in &%log_file_path%& can be used to
33646 mean &"use the path specified at build time"&. It no such item exists, log
33647 files are written in the &_log_& subdirectory of the spool directory. This is
33648 equivalent to the setting:
33649 .code
33650 log_file_path = $spool_directory/log/%slog
33651 .endd
33652 If you do not specify anything at build time or run time, that is where the
33653 logs are written.
33654
33655 A log file path may also contain &`%D`& or &`%M`& if datestamped log file names
33656 are in use &-- see section &<<SECTdatlogfil>>& below.
33657
33658 Here are some examples of possible settings:
33659 .display
33660 &`LOG_FILE_PATH=syslog                    `& syslog only
33661 &`LOG_FILE_PATH=:syslog                   `& syslog and default path
33662 &`LOG_FILE_PATH=syslog : /usr/log/exim_%s `& syslog and specified path
33663 &`LOG_FILE_PATH=/usr/log/exim_%s          `& specified path only
33664 .endd
33665 If there are more than two paths in the list, the first is used and a panic
33666 error is logged.
33667
33668
33669
33670 .section "Logging to local files that are periodically &""cycled""&" "SECID285"
33671 .cindex "log" "cycling local files"
33672 .cindex "cycling logs"
33673 .cindex "&'exicyclog'&"
33674 .cindex "log" "local files; writing to"
33675 Some operating systems provide centralized and standardized methods for cycling
33676 log files. For those that do not, a utility script called &'exicyclog'& is
33677 provided (see section &<<SECTcyclogfil>>&). This renames and compresses the
33678 main and reject logs each time it is called. The maximum number of old logs to
33679 keep can be set. It is suggested this script is run as a daily &'cron'& job.
33680
33681 An Exim delivery process opens the main log when it first needs to write to it,
33682 and it keeps the file open in case subsequent entries are required &-- for
33683 example, if a number of different deliveries are being done for the same
33684 message. However, remote SMTP deliveries can take a long time, and this means
33685 that the file may be kept open long after it is renamed if &'exicyclog'& or
33686 something similar is being used to rename log files on a regular basis. To
33687 ensure that a switch of log files is noticed as soon as possible, Exim calls
33688 &[stat()]& on the main log's name before reusing an open file, and if the file
33689 does not exist, or its inode has changed, the old file is closed and Exim
33690 tries to open the main log from scratch. Thus, an old log file may remain open
33691 for quite some time, but no Exim processes should write to it once it has been
33692 renamed.
33693
33694
33695
33696 .section "Datestamped log files" "SECTdatlogfil"
33697 .cindex "log" "datestamped files"
33698 Instead of cycling the main and reject log files by renaming them
33699 periodically, some sites like to use files whose names contain a datestamp,
33700 for example, &_mainlog-20031225_&. The datestamp is in the form &_yyyymmdd_& or
33701 &_yyyymm_&. Exim has support for this way of working. It is enabled by setting
33702 the &%log_file_path%& option to a path that includes &`%D`& or &`%M`& at the
33703 point where the datestamp is required. For example:
33704 .code
33705 log_file_path = /var/spool/exim/log/%slog-%D
33706 log_file_path = /var/log/exim-%s-%D.log
33707 log_file_path = /var/spool/exim/log/%D-%slog
33708 log_file_path = /var/log/exim/%s.%M
33709 .endd
33710 As before, &`%s`& is replaced by &"main"& or &"reject"&; the following are
33711 examples of names generated by the above examples:
33712 .code
33713 /var/spool/exim/log/mainlog-20021225
33714 /var/log/exim-reject-20021225.log
33715 /var/spool/exim/log/20021225-mainlog
33716 /var/log/exim/main.200212
33717 .endd
33718 When this form of log file is specified, Exim automatically switches to new
33719 files at midnight. It does not make any attempt to compress old logs; you
33720 will need to write your own script if you require this. You should not
33721 run &'exicyclog'& with this form of logging.
33722
33723 The location of the panic log is also determined by &%log_file_path%&, but it
33724 is not datestamped, because rotation of the panic log does not make sense.
33725 When generating the name of the panic log, &`%D`& or &`%M`& are removed from
33726 the string. In addition, if it immediately follows a slash, a following
33727 non-alphanumeric character is removed; otherwise a preceding non-alphanumeric
33728 character is removed. Thus, the four examples above would give these panic
33729 log names:
33730 .code
33731 /var/spool/exim/log/paniclog
33732 /var/log/exim-panic.log
33733 /var/spool/exim/log/paniclog
33734 /var/log/exim/panic
33735 .endd
33736
33737
33738 .section "Logging to syslog" "SECID249"
33739 .cindex "log" "syslog; writing to"
33740 The use of syslog does not change what Exim logs or the format of its messages,
33741 except in one respect. If &%syslog_timestamp%& is set false, the timestamps on
33742 Exim's log lines are omitted when these lines are sent to syslog. Apart from
33743 that, the same strings are written to syslog as to log files. The syslog
33744 &"facility"& is set to LOG_MAIL, and the program name to &"exim"&
33745 by default, but you can change these by setting the &%syslog_facility%& and
33746 &%syslog_processname%& options, respectively. If Exim was compiled with
33747 SYSLOG_LOG_PID set in &_Local/Makefile_& (this is the default in
33748 &_src/EDITME_&), then, on systems that permit it (all except ULTRIX), the
33749 LOG_PID flag is set so that the &[syslog()]& call adds the pid as well as
33750 the time and host name to each line.
33751 The three log streams are mapped onto syslog priorities as follows:
33752
33753 .ilist
33754 &'mainlog'& is mapped to LOG_INFO
33755 .next
33756 &'rejectlog'& is mapped to LOG_NOTICE
33757 .next
33758 &'paniclog'& is mapped to LOG_ALERT
33759 .endlist
33760
33761 Many log lines are written to both &'mainlog'& and &'rejectlog'&, and some are
33762 written to both &'mainlog'& and &'paniclog'&, so there will be duplicates if
33763 these are routed by syslog to the same place. You can suppress this duplication
33764 by setting &%syslog_duplication%& false.
33765
33766 Exim's log lines can sometimes be very long, and some of its &'rejectlog'&
33767 entries contain multiple lines when headers are included. To cope with both
33768 these cases, entries written to syslog are split into separate &[syslog()]&
33769 calls at each internal newline, and also after a maximum of
33770 870 data characters. (This allows for a total syslog line length of 1024, when
33771 additions such as timestamps are added.) If you are running a syslog
33772 replacement that can handle lines longer than the 1024 characters allowed by
33773 RFC 3164, you should set
33774 .code
33775 SYSLOG_LONG_LINES=yes
33776 .endd
33777 in &_Local/Makefile_& before building Exim. That stops Exim from splitting long
33778 lines, but it still splits at internal newlines in &'reject'& log entries.
33779
33780 To make it easy to re-assemble split lines later, each component of a split
33781 entry starts with a string of the form [<&'n'&>/<&'m'&>] or [<&'n'&>\<&'m'&>]
33782 where <&'n'&> is the component number and <&'m'&> is the total number of
33783 components in the entry. The / delimiter is used when the line was split
33784 because it was too long; if it was split because of an internal newline, the \
33785 delimiter is used. For example, supposing the length limit to be 50 instead of
33786 870, the following would be the result of a typical rejection message to
33787 &'mainlog'& (LOG_INFO), each line in addition being preceded by the time, host
33788 name, and pid as added by syslog:
33789 .code
33790 [1/5] 2002-09-16 16:09:43 16RdAL-0006pc-00 rejected from
33791 [2/5]  [127.0.0.1] (ph10): syntax error in 'From' header
33792 [3/5]  when scanning for sender: missing or malformed lo
33793 [4/5] cal part in "<>" (envelope sender is <ph10@cam.exa
33794 [5/5] mple>)
33795 .endd
33796 The same error might cause the following lines to be written to &"rejectlog"&
33797 (LOG_NOTICE):
33798 .code
33799 [1/18] 2002-09-16 16:09:43 16RdAL-0006pc-00 rejected fro
33800 [2/18] m [127.0.0.1] (ph10): syntax error in 'From' head
33801 [3/18] er when scanning for sender: missing or malformed
33802 [4/18]  local part in "<>" (envelope sender is <ph10@cam
33803 [5\18] .example>)
33804 [6\18] Recipients: ph10@some.domain.cam.example
33805 [7\18] P Received: from [127.0.0.1] (ident=ph10)
33806 [8\18]        by xxxxx.cam.example with smtp (Exim 4.00)
33807 [9\18]        id 16RdAL-0006pc-00
33808 [10/18]        for ph10@cam.example; Mon, 16 Sep 2002 16:
33809 [11\18] 09:43 +0100
33810 [12\18] F From: <>
33811 [13\18]   Subject: this is a test header
33812 [18\18]   X-something: this is another header
33813 [15/18] I Message-Id: <E16RdAL-0006pc-00@xxxxx.cam.examp
33814 [16\18] le>
33815 [17\18] B Bcc:
33816 [18/18]   Date: Mon, 16 Sep 2002 16:09:43 +0100
33817 .endd
33818 Log lines that are neither too long nor contain newlines are written to syslog
33819 without modification.
33820
33821 If only syslog is being used, the Exim monitor is unable to provide a log tail
33822 display, unless syslog is routing &'mainlog'& to a file on the local host and
33823 the environment variable EXIMON_LOG_FILE_PATH is set to tell the monitor
33824 where it is.
33825
33826
33827
33828 .section "Log line flags" "SECID250"
33829 One line is written to the main log for each message received, and for each
33830 successful, unsuccessful, and delayed delivery. These lines can readily be
33831 picked out by the distinctive two-character flags that immediately follow the
33832 timestamp. The flags are:
33833 .display
33834 &`<=`&     message arrival
33835 &`=>`&     normal message delivery
33836 &`->`&     additional address in same delivery
33837 .new
33838 &`>>`&     cutthrough message delivery
33839 .wen
33840 &`*>`&     delivery suppressed by &%-N%&
33841 &`**`&     delivery failed; address bounced
33842 &`==`&     delivery deferred; temporary problem
33843 .endd
33844
33845
33846 .section "Logging message reception" "SECID251"
33847 .cindex "log" "reception line"
33848 The format of the single-line entry in the main log that is written for every
33849 message received is shown in the basic example below, which is split over
33850 several lines in order to fit it on the page:
33851 .code
33852 2002-10-31 08:57:53 16ZCW1-0005MB-00 <= kryten@dwarf.fict.example
33853   H=mailer.fict.example [192.168.123.123] U=exim
33854   P=smtp S=5678 id=<incoming message id>
33855 .endd
33856 The address immediately following &"<="& is the envelope sender address. A
33857 bounce message is shown with the sender address &"<>"&, and if it is locally
33858 generated, this is followed by an item of the form
33859 .code
33860 R=<message id>
33861 .endd
33862 which is a reference to the message that caused the bounce to be sent.
33863
33864 .cindex "HELO"
33865 .cindex "EHLO"
33866 For messages from other hosts, the H and U fields identify the remote host and
33867 record the RFC 1413 identity of the user that sent the message, if one was
33868 received. The number given in square brackets is the IP address of the sending
33869 host. If there is a single, unparenthesized  host name in the H field, as
33870 above, it has been verified to correspond to the IP address (see the
33871 &%host_lookup%& option). If the name is in parentheses, it was the name quoted
33872 by the remote host in the SMTP HELO or EHLO command, and has not been
33873 verified. If verification yields a different name to that given for HELO or
33874 EHLO, the verified name appears first, followed by the HELO or EHLO
33875 name in parentheses.
33876
33877 Misconfigured hosts (and mail forgers) sometimes put an IP address, with or
33878 without brackets, in the HELO or EHLO command, leading to entries in
33879 the log containing text like these examples:
33880 .code
33881 H=(10.21.32.43) [192.168.8.34]
33882 H=([10.21.32.43]) [192.168.8.34]
33883 .endd
33884 This can be confusing. Only the final address in square brackets can be relied
33885 on.
33886
33887 For locally generated messages (that is, messages not received over TCP/IP),
33888 the H field is omitted, and the U field contains the login name of the caller
33889 of Exim.
33890
33891 .cindex "authentication" "logging"
33892 .cindex "AUTH" "logging"
33893 For all messages, the P field specifies the protocol used to receive the
33894 message. This is the value that is stored in &$received_protocol$&. In the case
33895 of incoming SMTP messages, the value indicates whether or not any SMTP
33896 extensions (ESMTP), encryption, or authentication were used. If the SMTP
33897 session was encrypted, there is an additional X field that records the cipher
33898 suite that was used.
33899
33900 The protocol is set to &"esmtpsa"& or &"esmtpa"& for messages received from
33901 hosts that have authenticated themselves using the SMTP AUTH command. The first
33902 value is used when the SMTP connection was encrypted (&"secure"&). In this case
33903 there is an additional item A= followed by the name of the authenticator that
33904 was used. If an authenticated identification was set up by the authenticator's
33905 &%server_set_id%& option, this is logged too, separated by a colon from the
33906 authenticator name.
33907
33908 .cindex "size" "of message"
33909 The id field records the existing message id, if present. The size of the
33910 received message is given by the S field. When the message is delivered,
33911 headers may be removed or added, so that the size of delivered copies of the
33912 message may not correspond with this value (and indeed may be different to each
33913 other).
33914
33915 The &%log_selector%& option can be used to request the logging of additional
33916 data when a message is received. See section &<<SECTlogselector>>& below.
33917
33918
33919
33920 .section "Logging deliveries" "SECID252"
33921 .cindex "log" "delivery line"
33922 The format of the single-line entry in the main log that is written for every
33923 delivery is shown in one of the examples below, for local and remote
33924 deliveries, respectively. Each example has been split into two lines in order
33925 to fit it on the page:
33926 .code
33927 2002-10-31 08:59:13 16ZCW1-0005MB-00 => marv
33928   <marv@hitch.fict.example> R=localuser T=local_delivery
33929 2002-10-31 09:00:10 16ZCW1-0005MB-00 =>
33930   monk@holistic.fict.example R=dnslookup T=remote_smtp
33931   H=holistic.fict.example [192.168.234.234]
33932 .endd
33933 For ordinary local deliveries, the original address is given in angle brackets
33934 after the final delivery address, which might be a pipe or a file. If
33935 intermediate address(es) exist between the original and the final address, the
33936 last of these is given in parentheses after the final address. The R and T
33937 fields record the router and transport that were used to process the address.
33938
33939 .new
33940 If SMTP AUTH was used for the delivery there is an additional item A=
33941 followed by the name of the authenticator that was used.
33942 If an authenticated identification was set up by the authenticator's &%client_set_id%&
33943 option, this is logged too, separated by a colon from the authenticator name.
33944 .wen
33945
33946 If a shadow transport was run after a successful local delivery, the log line
33947 for the successful delivery has an item added on the end, of the form
33948 .display
33949 &`ST=<`&&'shadow transport name'&&`>`&
33950 .endd
33951 If the shadow transport did not succeed, the error message is put in
33952 parentheses afterwards.
33953
33954 .cindex "asterisk" "after IP address"
33955 When more than one address is included in a single delivery (for example, two
33956 SMTP RCPT commands in one transaction) the second and subsequent addresses are
33957 flagged with &`->`& instead of &`=>`&. When two or more messages are delivered
33958 down a single SMTP connection, an asterisk follows the IP address in the log
33959 lines for the second and subsequent messages.
33960
33961 .new
33962 .cindex "delivery" "cutthrough; logging"
33963 .cindex "cutthrough" "logging"
33964 When delivery is done in cutthrough mode it is flagged with &`>>`& and the log
33965 line precedes the reception line, since cutthrough waits for a possible
33966 rejection from the destination in case it can reject the sourced item.
33967 .wen
33968
33969 The generation of a reply message by a filter file gets logged as a
33970 &"delivery"& to the addressee, preceded by &">"&.
33971
33972 The &%log_selector%& option can be used to request the logging of additional
33973 data when a message is delivered. See section &<<SECTlogselector>>& below.
33974
33975
33976 .section "Discarded deliveries" "SECID253"
33977 .cindex "discarded messages"
33978 .cindex "message" "discarded"
33979 .cindex "delivery" "discarded; logging"
33980 When a message is discarded as a result of the command &"seen finish"& being
33981 obeyed in a filter file which generates no deliveries, a log entry of the form
33982 .code
33983 2002-12-10 00:50:49 16auJc-0001UB-00 => discarded
33984   <low.club@bridge.example> R=userforward
33985 .endd
33986 is written, to record why no deliveries are logged. When a message is discarded
33987 because it is aliased to &":blackhole:"& the log line is like this:
33988 .code
33989 1999-03-02 09:44:33 10HmaX-0005vi-00 => :blackhole:
33990   <hole@nowhere.example> R=blackhole_router
33991 .endd
33992
33993
33994 .section "Deferred deliveries" "SECID254"
33995 When a delivery is deferred, a line of the following form is logged:
33996 .code
33997 2002-12-19 16:20:23 16aiQz-0002Q5-00 == marvin@endrest.example
33998   R=dnslookup T=smtp defer (146): Connection refused
33999 .endd
34000 In the case of remote deliveries, the error is the one that was given for the
34001 last IP address that was tried. Details of individual SMTP failures are also
34002 written to the log, so the above line would be preceded by something like
34003 .code
34004 2002-12-19 16:20:23 16aiQz-0002Q5-00 Failed to connect to
34005   mail1.endrest.example [192.168.239.239]: Connection refused
34006 .endd
34007 When a deferred address is skipped because its retry time has not been reached,
34008 a message is written to the log, but this can be suppressed by setting an
34009 appropriate value in &%log_selector%&.
34010
34011
34012
34013 .section "Delivery failures" "SECID255"
34014 .cindex "delivery" "failure; logging"
34015 If a delivery fails because an address cannot be routed, a line of the
34016 following form is logged:
34017 .code
34018 1995-12-19 16:20:23 0tRiQz-0002Q5-00 ** jim@trek99.example
34019   <jim@trek99.example>: unknown mail domain
34020 .endd
34021 If a delivery fails at transport time, the router and transport are shown, and
34022 the response from the remote host is included, as in this example:
34023 .code
34024 2002-07-11 07:14:17 17SXDU-000189-00 ** ace400@pb.example
34025   R=dnslookup T=remote_smtp: SMTP error from remote mailer
34026   after pipelined RCPT TO:<ace400@pb.example>: host
34027   pbmail3.py.example [192.168.63.111]: 553 5.3.0
34028   <ace400@pb.example>...Addressee unknown
34029 .endd
34030 The word &"pipelined"& indicates that the SMTP PIPELINING extension was being
34031 used. See &%hosts_avoid_esmtp%& in the &(smtp)& transport for a way of
34032 disabling PIPELINING. The log lines for all forms of delivery failure are
34033 flagged with &`**`&.
34034
34035
34036
34037 .section "Fake deliveries" "SECID256"
34038 .cindex "delivery" "fake; logging"
34039 If a delivery does not actually take place because the &%-N%& option has been
34040 used to suppress it, a normal delivery line is written to the log, except that
34041 &"=>"& is replaced by &"*>"&.
34042
34043
34044
34045 .section "Completion" "SECID257"
34046 A line of the form
34047 .code
34048 2002-10-31 09:00:11 16ZCW1-0005MB-00 Completed
34049 .endd
34050 is written to the main log when a message is about to be removed from the spool
34051 at the end of its processing.
34052
34053
34054
34055
34056 .section "Summary of Fields in Log Lines" "SECID258"
34057 .cindex "log" "summary of fields"
34058 A summary of the field identifiers that are used in log lines is shown in
34059 the following table:
34060 .display
34061 &`A   `&        authenticator name (and optional id and sender)
34062 &`C   `&        SMTP confirmation on delivery
34063 &`    `&        command list for &"no mail in SMTP session"&
34064 &`CV  `&        certificate verification status
34065 &`D   `&        duration of &"no mail in SMTP session"&
34066 &`DN  `&        distinguished name from peer certificate
34067 &`DT  `&        on &`=>`& lines: time taken for a delivery
34068 &`F   `&        sender address (on delivery lines)
34069 &`H   `&        host name and IP address
34070 &`I   `&        local interface used
34071 &`id  `&        message id for incoming message
34072 &`P   `&        on &`<=`& lines: protocol used
34073 &`    `&        on &`=>`& and &`**`& lines: return path
34074 &`QT  `&        on &`=>`& lines: time spent on queue so far
34075 &`    `&        on &"Completed"& lines: time spent on queue
34076 &`R   `&        on &`<=`& lines: reference for local bounce
34077 &`    `&        on &`=>`&  &`**`& and &`==`& lines: router name
34078 &`S   `&        size of message
34079 &`ST  `&        shadow transport name
34080 &`T   `&        on &`<=`& lines: message subject (topic)
34081 &`    `&        on &`=>`& &`**`& and &`==`& lines: transport name
34082 &`U   `&        local user or RFC 1413 identity
34083 &`X   `&        TLS cipher suite
34084 .endd
34085
34086
34087 .section "Other log entries" "SECID259"
34088 Various other types of log entry are written from time to time. Most should be
34089 self-explanatory. Among the more common are:
34090
34091 .ilist
34092 .cindex "retry" "time not reached"
34093 &'retry time not reached'&&~&~An address previously suffered a temporary error
34094 during routing or local delivery, and the time to retry has not yet arrived.
34095 This message is not written to an individual message log file unless it happens
34096 during the first delivery attempt.
34097 .next
34098 &'retry time not reached for any host'&&~&~An address previously suffered
34099 temporary errors during remote delivery, and the retry time has not yet arrived
34100 for any of the hosts to which it is routed.
34101 .next
34102 .cindex "spool directory" "file locked"
34103 &'spool file locked'&&~&~An attempt to deliver a message cannot proceed because
34104 some other Exim process is already working on the message. This can be quite
34105 common if queue running processes are started at frequent intervals. The
34106 &'exiwhat'& utility script can be used to find out what Exim processes are
34107 doing.
34108 .next
34109 .cindex "error" "ignored"
34110 &'error ignored'&&~&~There are several circumstances that give rise to this
34111 message:
34112 .olist
34113 Exim failed to deliver a bounce message whose age was greater than
34114 &%ignore_bounce_errors_after%&. The bounce was discarded.
34115 .next
34116 A filter file set up a delivery using the &"noerror"& option, and the delivery
34117 failed. The delivery was discarded.
34118 .next
34119 A delivery set up by a router configured with
34120 . ==== As this is a nested list, any displays it contains must be indented
34121 . ==== as otherwise they are too far to the left.
34122 .code
34123     errors_to = <>
34124 .endd
34125 failed. The delivery was discarded.
34126 .endlist olist
34127 .endlist ilist
34128
34129
34130
34131
34132
34133 .section "Reducing or increasing what is logged" "SECTlogselector"
34134 .cindex "log" "selectors"
34135 By setting the &%log_selector%& global option, you can disable some of Exim's
34136 default logging, or you can request additional logging. The value of
34137 &%log_selector%& is made up of names preceded by plus or minus characters. For
34138 example:
34139 .code
34140 log_selector = +arguments -retry_defer
34141 .endd
34142 The list of optional log items is in the following table, with the default
34143 selection marked by asterisks:
34144 .display
34145 .new
34146 &` 8bitmime                   `&  received 8BITMIME status
34147 .wen
34148 &`*acl_warn_skipped           `&  skipped &%warn%& statement in ACL
34149 &` address_rewrite            `&  address rewriting
34150 &` all_parents                `&  all parents in => lines
34151 &` arguments                  `&  command line arguments
34152 &`*connection_reject          `&  connection rejections
34153 &`*delay_delivery             `&  immediate delivery delayed
34154 &` deliver_time               `&  time taken to perform delivery
34155 &` delivery_size              `&  add &`S=`&&'nnn'& to => lines
34156 &`*dnslist_defer              `&  defers of DNS list (aka RBL) lookups
34157 &`*etrn                       `&  ETRN commands
34158 &`*host_lookup_failed         `&  as it says
34159 &` ident_timeout              `&  timeout for ident connection
34160 &` incoming_interface         `&  incoming interface on <= lines
34161 &` incoming_port              `&  incoming port on <= lines
34162 &`*lost_incoming_connection   `&  as it says (includes timeouts)
34163 &` outgoing_port              `&  add remote port to => lines
34164 &`*queue_run                  `&  start and end queue runs
34165 &` queue_time                 `&  time on queue for one recipient
34166 &` queue_time_overall         `&  time on queue for whole message
34167 &` pid                        `&  Exim process id
34168 &` received_recipients        `&  recipients on <= lines
34169 &` received_sender            `&  sender on <= lines
34170 &`*rejected_header            `&  header contents on reject log
34171 &`*retry_defer                `&  &"retry time not reached"&
34172 &` return_path_on_delivery    `&  put return path on => and ** lines
34173 &` sender_on_delivery         `&  add sender to => lines
34174 &`*sender_verify_fail         `&  sender verification failures
34175 &`*size_reject                `&  rejection because too big
34176 &`*skip_delivery              `&  delivery skipped in a queue run
34177 .new
34178 &`*smtp_confirmation          `&  SMTP confirmation on => lines
34179 .wen
34180 &` smtp_connection            `&  SMTP connections
34181 &` smtp_incomplete_transaction`&  incomplete SMTP transactions
34182 .new
34183 &` smtp_mailauth              `&  AUTH argument to MAIL commands
34184 .wen
34185 &` smtp_no_mail               `&  session with no MAIL commands
34186 &` smtp_protocol_error        `&  SMTP protocol errors
34187 &` smtp_syntax_error          `&  SMTP syntax errors
34188 &` subject                    `&  contents of &'Subject:'& on <= lines
34189 &` tls_certificate_verified   `&  certificate verification status
34190 &`*tls_cipher                 `&  TLS cipher suite on <= and => lines
34191 &` tls_peerdn                 `&  TLS peer DN on <= and => lines
34192 &` tls_sni                    `&  TLS SNI on <= lines
34193 &` unknown_in_list            `&  DNS lookup failed in list match
34194
34195 &` all                        `&  all of the above
34196 .endd
34197 More details on each of these items follows:
34198
34199 .ilist
34200 .new
34201 .cindex "8BITMIME"
34202 .cindex "log" "8BITMIME"
34203 &%8bitmime%&: This causes Exim to log any 8BITMIME status of received messages,
34204 which may help in tracking down interoperability issues with ancient MTAs
34205 that are not 8bit clean.  This is added to the &"<="& line, tagged with
34206 &`M8S=`& and a value of &`0`&, &`7`& or &`8`&, corresponding to "not given",
34207 &`7BIT`& and &`8BITMIME`& respectively.
34208 .wen
34209 .next
34210 .cindex "&%warn%& ACL verb" "log when skipping"
34211 &%acl_warn_skipped%&: When an ACL &%warn%& statement is skipped because one of
34212 its conditions cannot be evaluated, a log line to this effect is written if
34213 this log selector is set.
34214 .next
34215 .cindex "log" "rewriting"
34216 .cindex "rewriting" "logging"
34217 &%address_rewrite%&: This applies both to global rewrites and per-transport
34218 rewrites, but not to rewrites in filters run as an unprivileged user (because
34219 such users cannot access the log).
34220 .next
34221 .cindex "log" "full parentage"
34222 &%all_parents%&: Normally only the original and final addresses are logged on
34223 delivery lines; with this selector, intermediate parents are given in
34224 parentheses between them.
34225 .next
34226 .cindex "log" "Exim arguments"
34227 .cindex "Exim arguments, logging"
34228 &%arguments%&: This causes Exim to write the arguments with which it was called
34229 to the main log, preceded by the current working directory. This is a debugging
34230 feature, added to make it easier to find out how certain MUAs call
34231 &_/usr/sbin/sendmail_&. The logging does not happen if Exim has given up root
34232 privilege because it was called with the &%-C%& or &%-D%& options. Arguments
34233 that are empty or that contain white space are quoted. Non-printing characters
34234 are shown as escape sequences. This facility cannot log unrecognized arguments,
34235 because the arguments are checked before the configuration file is read. The
34236 only way to log such cases is to interpose a script such as &_util/logargs.sh_&
34237 between the caller and Exim.
34238 .next
34239 .cindex "log" "connection rejections"
34240 &%connection_reject%&: A log entry is written whenever an incoming SMTP
34241 connection is rejected, for whatever reason.
34242 .next
34243 .cindex "log" "delayed delivery"
34244 .cindex "delayed delivery, logging"
34245 &%delay_delivery%&: A log entry is written whenever a delivery process is not
34246 started for an incoming message because the load is too high or too many
34247 messages were received on one connection. Logging does not occur if no delivery
34248 process is started because &%queue_only%& is set or &%-odq%& was used.
34249 .next
34250 .cindex "log" "delivery duration"
34251 &%deliver_time%&: For each delivery, the amount of real time it has taken to
34252 perform the actual delivery is logged as DT=<&'time'&>, for example, &`DT=1s`&.
34253 .next
34254 .cindex "log" "message size on delivery"
34255 .cindex "size" "of message"
34256 &%delivery_size%&: For each delivery, the size of message delivered is added to
34257 the &"=>"& line, tagged with S=.
34258 .next
34259 .cindex "log" "dnslist defer"
34260 .cindex "DNS list" "logging defer"
34261 .cindex "black list (DNS)"
34262 &%dnslist_defer%&: A log entry is written if an attempt to look up a host in a
34263 DNS black list suffers a temporary error.
34264 .next
34265 .cindex "log" "ETRN commands"
34266 .cindex "ETRN" "logging"
34267 &%etrn%&: Every valid ETRN command that is received is logged, before the ACL
34268 is run to determine whether or not it is actually accepted. An invalid ETRN
34269 command, or one received within a message transaction is not logged by this
34270 selector (see &%smtp_syntax_error%& and &%smtp_protocol_error%&).
34271 .next
34272 .cindex "log" "host lookup failure"
34273 &%host_lookup_failed%&: When a lookup of a host's IP addresses fails to find
34274 any addresses, or when a lookup of an IP address fails to find a host name, a
34275 log line is written. This logging does not apply to direct DNS lookups when
34276 routing email addresses, but it does apply to &"byname"& lookups.
34277 .next
34278 .cindex "log" "ident timeout"
34279 .cindex "RFC 1413" "logging timeout"
34280 &%ident_timeout%&: A log line is written whenever an attempt to connect to a
34281 client's ident port times out.
34282 .next
34283 .cindex "log" "incoming interface"
34284 .cindex "interface" "logging"
34285 &%incoming_interface%&: The interface on which a message was received is added
34286 to the &"<="& line as an IP address in square brackets, tagged by I= and
34287 followed by a colon and the port number. The local interface and port are also
34288 added to other SMTP log lines, for example &"SMTP connection from"&, and to
34289 rejection lines.
34290 .next
34291 .cindex "log" "incoming remote port"
34292 .cindex "port" "logging remote"
34293 .cindex "TCP/IP" "logging incoming remote port"
34294 .vindex "&$sender_fullhost$&"
34295 .vindex "&$sender_rcvhost$&"
34296 &%incoming_port%&: The remote port number from which a message was received is
34297 added to log entries and &'Received:'& header lines, following the IP address
34298 in square brackets, and separated from it by a colon. This is implemented by
34299 changing the value that is put in the &$sender_fullhost$& and
34300 &$sender_rcvhost$& variables. Recording the remote port number has become more
34301 important with the widening use of NAT (see RFC 2505).
34302 .next
34303 .cindex "log" "dropped connection"
34304 &%lost_incoming_connection%&: A log line is written when an incoming SMTP
34305 connection is unexpectedly dropped.
34306 .next
34307 .cindex "log" "outgoing remote port"
34308 .cindex "port" "logging outgoint remote"
34309 .cindex "TCP/IP" "logging ougtoing remote port"
34310 &%outgoing_port%&: The remote port number is added to delivery log lines (those
34311 containing => tags) following the IP address. This option is not included in
34312 the default setting, because for most ordinary configurations, the remote port
34313 number is always 25 (the SMTP port).
34314 .next
34315 .cindex "log" "process ids in"
34316 .cindex "pid (process id)" "in log lines"
34317 &%pid%&: The current process id is added to every log line, in square brackets,
34318 immediately after the time and date.
34319 .next
34320 .cindex "log" "queue run"
34321 .cindex "queue runner" "logging"
34322 &%queue_run%&: The start and end of every queue run are logged.
34323 .next
34324 .cindex "log" "queue time"
34325 &%queue_time%&: The amount of time the message has been in the queue on the
34326 local host is logged as QT=<&'time'&> on delivery (&`=>`&) lines, for example,
34327 &`QT=3m45s`&. The clock starts when Exim starts to receive the message, so it
34328 includes reception time as well as the delivery time for the current address.
34329 This means that it may be longer than the difference between the arrival and
34330 delivery log line times, because the arrival log line is not written until the
34331 message has been successfully received.
34332 .next
34333 &%queue_time_overall%&: The amount of time the message has been in the queue on
34334 the local host is logged as QT=<&'time'&> on &"Completed"& lines, for
34335 example, &`QT=3m45s`&. The clock starts when Exim starts to receive the
34336 message, so it includes reception time as well as the total delivery time.
34337 .next
34338 .cindex "log" "recipients"
34339 &%received_recipients%&: The recipients of a message are listed in the main log
34340 as soon as the message is received. The list appears at the end of the log line
34341 that is written when a message is received, preceded by the word &"for"&. The
34342 addresses are listed after they have been qualified, but before any rewriting
34343 has taken place.
34344 Recipients that were discarded by an ACL for MAIL or RCPT do not appear
34345 in the list.
34346 .next
34347 .cindex "log" "sender reception"
34348 &%received_sender%&: The unrewritten original sender of a message is added to
34349 the end of the log line that records the message's arrival, after the word
34350 &"from"& (before the recipients if &%received_recipients%& is also set).
34351 .next
34352 .cindex "log" "header lines for rejection"
34353 &%rejected_header%&: If a message's header has been received at the time a
34354 rejection is written to the reject log, the complete header is added to the
34355 log. Header logging can be turned off individually for messages that are
34356 rejected by the &[local_scan()]& function (see section &<<SECTapiforloc>>&).
34357 .next
34358 .cindex "log" "retry defer"
34359 &%retry_defer%&: A log line is written if a delivery is deferred because a
34360 retry time has not yet been reached. However, this &"retry time not reached"&
34361 message is always omitted from individual message logs after the first delivery
34362 attempt.
34363 .next
34364 .cindex "log" "return path"
34365 &%return_path_on_delivery%&: The return path that is being transmitted with
34366 the message is included in delivery and bounce lines, using the tag P=.
34367 This is omitted if no delivery actually happens, for example, if routing fails,
34368 or if delivery is to &_/dev/null_& or to &`:blackhole:`&.
34369 .next
34370 .cindex "log" "sender on delivery"
34371 &%sender_on_delivery%&: The message's sender address is added to every delivery
34372 and bounce line, tagged by F= (for &"from"&).
34373 This is the original sender that was received with the message; it is not
34374 necessarily the same as the outgoing return path.
34375 .next
34376 .cindex "log" "sender verify failure"
34377 &%sender_verify_fail%&: If this selector is unset, the separate log line that
34378 gives details of a sender verification failure is not written. Log lines for
34379 the rejection of SMTP commands contain just &"sender verify failed"&, so some
34380 detail is lost.
34381 .next
34382 .cindex "log" "size rejection"
34383 &%size_reject%&: A log line is written whenever a message is rejected because
34384 it is too big.
34385 .next
34386 .cindex "log" "frozen messages; skipped"
34387 .cindex "frozen messages" "logging skipping"
34388 &%skip_delivery%&: A log line is written whenever a message is skipped during a
34389 queue run because it is frozen or because another process is already delivering
34390 it.
34391 .cindex "&""spool file is locked""&"
34392 The message that is written is &"spool file is locked"&.
34393 .next
34394 .cindex "log" "smtp confirmation"
34395 .cindex "SMTP" "logging confirmation"
34396 &%smtp_confirmation%&: The response to the final &"."& in the SMTP dialogue for
34397 outgoing messages is added to delivery log lines in the form &`C=`&<&'text'&>.
34398 A number of MTAs (including Exim) return an identifying string in this
34399 response.
34400 .next
34401 .cindex "log" "SMTP connections"
34402 .cindex "SMTP" "logging connections"
34403 &%smtp_connection%&: A log line is written whenever an SMTP connection is
34404 established or closed, unless the connection is from a host that matches
34405 &%hosts_connection_nolog%&. (In contrast, &%lost_incoming_connection%& applies
34406 only when the closure is unexpected.) This applies to connections from local
34407 processes that use &%-bs%& as well as to TCP/IP connections. If a connection is
34408 dropped in the middle of a message, a log line is always written, whether or
34409 not this selector is set, but otherwise nothing is written at the start and end
34410 of connections unless this selector is enabled.
34411
34412 For TCP/IP connections to an Exim daemon, the current number of connections is
34413 included in the log message for each new connection, but note that the count is
34414 reset if the daemon is restarted.
34415 Also, because connections are closed (and the closure is logged) in
34416 subprocesses, the count may not include connections that have been closed but
34417 whose termination the daemon has not yet noticed. Thus, while it is possible to
34418 match up the opening and closing of connections in the log, the value of the
34419 logged counts may not be entirely accurate.
34420 .next
34421 .cindex "log" "SMTP transaction; incomplete"
34422 .cindex "SMTP" "logging incomplete transactions"
34423 &%smtp_incomplete_transaction%&: When a mail transaction is aborted by
34424 RSET, QUIT, loss of connection, or otherwise, the incident is logged,
34425 and the message sender plus any accepted recipients are included in the log
34426 line. This can provide evidence of dictionary attacks.
34427 .next
34428 .cindex "log" "non-MAIL SMTP sessions"
34429 .cindex "MAIL" "logging session without"
34430 &%smtp_no_mail%&: A line is written to the main log whenever an accepted SMTP
34431 connection terminates without having issued a MAIL command. This includes both
34432 the case when the connection is dropped, and the case when QUIT is used. It
34433 does not include cases where the connection is rejected right at the start (by
34434 an ACL, or because there are too many connections, or whatever). These cases
34435 already have their own log lines.
34436
34437 The log line that is written contains the identity of the client in the usual
34438 way, followed by D= and a time, which records the duration of the connection.
34439 If the connection was authenticated, this fact is logged exactly as it is for
34440 an incoming message, with an A= item. If the connection was encrypted, CV=,
34441 DN=, and X= items may appear as they do for an incoming message, controlled by
34442 the same logging options.
34443
34444 Finally, if any SMTP commands were issued during the connection, a C= item
34445 is added to the line, listing the commands that were used. For example,
34446 .code
34447 C=EHLO,QUIT
34448 .endd
34449 shows that the client issued QUIT straight after EHLO. If there were fewer
34450 than 20 commands, they are all listed. If there were more than 20 commands,
34451 the last 20 are listed, preceded by &"..."&. However, with the default
34452 setting of 10 for &%smtp_accep_max_nonmail%&, the connection will in any case
34453 have been aborted before 20 non-mail commands are processed.
34454 .next
34455 .new
34456 &%smtp_mailauth%&: A third subfield with the authenticated sender,
34457 colon-separated, is appended to the A= item for a message arrival or delivery
34458 log line, if an AUTH argument to the SMTP MAIL command (see &<<SECTauthparamail>>&)
34459 was accepted or used.
34460 .wen
34461 .next
34462 .cindex "log" "SMTP protocol error"
34463 .cindex "SMTP" "logging protocol error"
34464 &%smtp_protocol_error%&: A log line is written for every SMTP protocol error
34465 encountered. Exim does not have perfect detection of all protocol errors
34466 because of transmission delays and the use of pipelining. If PIPELINING has
34467 been advertised to a client, an Exim server assumes that the client will use
34468 it, and therefore it does not count &"expected"& errors (for example, RCPT
34469 received after rejecting MAIL) as protocol errors.
34470 .next
34471 .cindex "SMTP" "logging syntax errors"
34472 .cindex "SMTP" "syntax errors; logging"
34473 .cindex "SMTP" "unknown command; logging"
34474 .cindex "log" "unknown SMTP command"
34475 .cindex "log" "SMTP syntax error"
34476 &%smtp_syntax_error%&: A log line is written for every SMTP syntax error
34477 encountered. An unrecognized command is treated as a syntax error. For an
34478 external connection, the host identity is given; for an internal connection
34479 using &%-bs%& the sender identification (normally the calling user) is given.
34480 .next
34481 .cindex "log" "subject"
34482 .cindex "subject, logging"
34483 &%subject%&: The subject of the message is added to the arrival log line,
34484 preceded by &"T="& (T for &"topic"&, since S is already used for &"size"&).
34485 Any MIME &"words"& in the subject are decoded. The &%print_topbitchars%& option
34486 specifies whether characters with values greater than 127 should be logged
34487 unchanged, or whether they should be rendered as escape sequences.
34488 .next
34489 .cindex "log" "certificate verification"
34490 &%tls_certificate_verified%&: An extra item is added to <= and => log lines
34491 when TLS is in use. The item is &`CV=yes`& if the peer's certificate was
34492 verified, and &`CV=no`& if not.
34493 .next
34494 .cindex "log" "TLS cipher"
34495 .cindex "TLS" "logging cipher"
34496 &%tls_cipher%&: When a message is sent or received over an encrypted
34497 connection, the cipher suite used is added to the log line, preceded by X=.
34498 .next
34499 .cindex "log" "TLS peer DN"
34500 .cindex "TLS" "logging peer DN"
34501 &%tls_peerdn%&: When a message is sent or received over an encrypted
34502 connection, and a certificate is supplied by the remote host, the peer DN is
34503 added to the log line, preceded by DN=.
34504 .next
34505 .cindex "log" "TLS SNI"
34506 .cindex "TLS" "logging SNI"
34507 &%tls_sni%&: When a message is received over an encrypted connection, and
34508 the remote host provided the Server Name Indication extension, the SNI is
34509 added to the log line, preceded by SNI=.
34510 .next
34511 .cindex "log" "DNS failure in list"
34512 &%unknown_in_list%&: This setting causes a log entry to be written when the
34513 result of a list match is failure because a DNS lookup failed.
34514 .endlist
34515
34516
34517 .section "Message log" "SECID260"
34518 .cindex "message" "log file for"
34519 .cindex "log" "message log; description of"
34520 .cindex "&_msglog_& directory"
34521 .oindex "&%preserve_message_logs%&"
34522 In addition to the general log files, Exim writes a log file for each message
34523 that it handles. The names of these per-message logs are the message ids, and
34524 they are kept in the &_msglog_& sub-directory of the spool directory. Each
34525 message log contains copies of the log lines that apply to the message. This
34526 makes it easier to inspect the status of an individual message without having
34527 to search the main log. A message log is deleted when processing of the message
34528 is complete, unless &%preserve_message_logs%& is set, but this should be used
34529 only with great care because they can fill up your disk very quickly.
34530
34531 On a heavily loaded system, it may be desirable to disable the use of
34532 per-message logs, in order to reduce disk I/O. This can be done by setting the
34533 &%message_logs%& option false.
34534 .ecindex IIDloggen
34535
34536
34537
34538
34539 . ////////////////////////////////////////////////////////////////////////////
34540 . ////////////////////////////////////////////////////////////////////////////
34541
34542 .chapter "Exim utilities" "CHAPutils"
34543 .scindex IIDutils "utilities"
34544 A number of utility scripts and programs are supplied with Exim and are
34545 described in this chapter. There is also the Exim Monitor, which is covered in
34546 the next chapter. The utilities described here are:
34547
34548 .itable none 0 0 3  7* left  15* left  40* left
34549 .irow &<<SECTfinoutwha>>&     &'exiwhat'&       &&&
34550   "list what Exim processes are doing"
34551 .irow &<<SECTgreptheque>>&    &'exiqgrep'&      "grep the queue"
34552 .irow &<<SECTsumtheque>>&     &'exiqsumm'&      "summarize the queue"
34553 .irow &<<SECTextspeinf>>&     &'exigrep'&       "search the main log"
34554 .irow &<<SECTexipick>>&       &'exipick'&       "select messages on &&&
34555                                                 various criteria"
34556 .irow &<<SECTcyclogfil>>&     &'exicyclog'&     "cycle (rotate) log files"
34557 .irow &<<SECTmailstat>>&      &'eximstats'&     &&&
34558   "extract statistics from the log"
34559 .irow &<<SECTcheckaccess>>&   &'exim_checkaccess'& &&&
34560   "check address acceptance from given IP"
34561 .irow &<<SECTdbmbuild>>&      &'exim_dbmbuild'& "build a DBM file"
34562 .irow &<<SECTfinindret>>&     &'exinext'&       "extract retry information"
34563 .irow &<<SECThindatmai>>&     &'exim_dumpdb'&   "dump a hints database"
34564 .irow &<<SECThindatmai>>&     &'exim_tidydb'&   "clean up a hints database"
34565 .irow &<<SECThindatmai>>&     &'exim_fixdb'&    "patch a hints database"
34566 .irow &<<SECTmailboxmaint>>&  &'exim_lock'&     "lock a mailbox file"
34567 .endtable
34568
34569 Another utility that might be of use to sites with many MTAs is Tom Kistner's
34570 &'exilog'&. It provides log visualizations across multiple Exim servers. See
34571 &url(http://duncanthrax.net/exilog/) for details.
34572
34573
34574
34575
34576 .section "Finding out what Exim processes are doing (exiwhat)" "SECTfinoutwha"
34577 .cindex "&'exiwhat'&"
34578 .cindex "process, querying"
34579 .cindex "SIGUSR1"
34580 On operating systems that can restart a system call after receiving a signal
34581 (most modern OS), an Exim process responds to the SIGUSR1 signal by writing
34582 a line describing what it is doing to the file &_exim-process.info_& in the
34583 Exim spool directory. The &'exiwhat'& script sends the signal to all Exim
34584 processes it can find, having first emptied the file. It then waits for one
34585 second to allow the Exim processes to react before displaying the results. In
34586 order to run &'exiwhat'& successfully you have to have sufficient privilege to
34587 send the signal to the Exim processes, so it is normally run as root.
34588
34589 &*Warning*&: This is not an efficient process. It is intended for occasional
34590 use by system administrators. It is not sensible, for example, to set up a
34591 script that sends SIGUSR1 signals to Exim processes at short intervals.
34592
34593
34594 Unfortunately, the &'ps'& command that &'exiwhat'& uses to find Exim processes
34595 varies in different operating systems. Not only are different options used,
34596 but the format of the output is different. For this reason, there are some
34597 system configuration options that configure exactly how &'exiwhat'& works. If
34598 it doesn't seem to be working for you, check the following compile-time
34599 options:
34600 .display
34601 &`EXIWHAT_PS_CMD    `& the command for running &'ps'&
34602 &`EXIWHAT_PS_ARG    `& the argument for &'ps'&
34603 &`EXIWHAT_EGREP_ARG `& the argument for &'egrep'& to select from &'ps'& output
34604 &`EXIWHAT_KILL_ARG  `& the argument for the &'kill'& command
34605 .endd
34606 An example of typical output from &'exiwhat'& is
34607 .code
34608 164 daemon: -q1h, listening on port 25
34609 10483 running queue: waiting for 0tAycK-0002ij-00 (10492)
34610 10492 delivering 0tAycK-0002ij-00 to mail.ref.example
34611   [10.19.42.42] (editor@ref.example)
34612 10592 handling incoming call from [192.168.243.242]
34613 10628 accepting a local non-SMTP message
34614 .endd
34615 The first number in the output line is the process number. The third line has
34616 been split here, in order to fit it on the page.
34617
34618
34619
34620 .section "Selective queue listing (exiqgrep)" "SECTgreptheque"
34621 .cindex "&'exiqgrep'&"
34622 .cindex "queue" "grepping"
34623 This utility is a Perl script contributed by Matt Hubbard. It runs
34624 .code
34625 exim -bpu
34626 .endd
34627 to obtain a queue listing with undelivered recipients only, and then greps the
34628 output to select messages that match given criteria. The following selection
34629 options are available:
34630
34631 .vlist
34632 .vitem &*-f*&&~<&'regex'&>
34633 Match the sender address using a case-insensitive search. The field that is
34634 tested is enclosed in angle brackets, so you can test for bounce messages with
34635 .code
34636 exiqgrep -f '^<>$'
34637 .endd
34638 .vitem &*-r*&&~<&'regex'&>
34639 Match a recipient address using a case-insensitve search. The field that is
34640 tested is not enclosed in angle brackets.
34641
34642 .vitem &*-s*&&~<&'regex'&>
34643 Match against the size field.
34644
34645 .vitem &*-y*&&~<&'seconds'&>
34646 Match messages that are younger than the given time.
34647
34648 .vitem &*-o*&&~<&'seconds'&>
34649 Match messages that are older than the given time.
34650
34651 .vitem &*-z*&
34652 Match only frozen messages.
34653
34654 .vitem &*-x*&
34655 Match only non-frozen messages.
34656 .endlist
34657
34658 The following options control the format of the output:
34659
34660 .vlist
34661 .vitem &*-c*&
34662 Display only the count of matching messages.
34663
34664 .vitem &*-l*&
34665 Long format &-- display the full message information as output by Exim. This is
34666 the default.
34667
34668 .vitem &*-i*&
34669 Display message ids only.
34670
34671 .vitem &*-b*&
34672 Brief format &-- one line per message.
34673
34674 .vitem &*-R*&
34675 Display messages in reverse order.
34676 .endlist
34677
34678 There is one more option, &%-h%&, which outputs a list of options.
34679
34680
34681
34682 .section "Summarizing the queue (exiqsumm)" "SECTsumtheque"
34683 .cindex "&'exiqsumm'&"
34684 .cindex "queue" "summary"
34685 The &'exiqsumm'& utility is a Perl script which reads the output of &`exim
34686 -bp`& and produces a summary of the messages on the queue. Thus, you use it by
34687 running a command such as
34688 .code
34689 exim -bp | exiqsumm
34690 .endd
34691 The output consists of one line for each domain that has messages waiting for
34692 it, as in the following example:
34693 .code
34694 3   2322   74m   66m  msn.com.example
34695 .endd
34696 Each line lists the number of pending deliveries for a domain, their total
34697 volume, and the length of time that the oldest and the newest messages have
34698 been waiting. Note that the number of pending deliveries is greater than the
34699 number of messages when messages have more than one recipient.
34700
34701 A summary line is output at the end. By default the output is sorted on the
34702 domain name, but &'exiqsumm'& has the options &%-a%& and &%-c%&, which cause
34703 the output to be sorted by oldest message and by count of messages,
34704 respectively. There are also three options that split the messages for each
34705 domain into two or more subcounts: &%-b%& separates bounce messages, &%-f%&
34706 separates frozen messages, and &%-s%& separates messages according to their
34707 sender.
34708
34709 The output of &'exim -bp'& contains the original addresses in the message, so
34710 this also applies to the output from &'exiqsumm'&. No domains from addresses
34711 generated by aliasing or forwarding are included (unless the &%one_time%&
34712 option of the &(redirect)& router has been used to convert them into &"top
34713 level"& addresses).
34714
34715
34716
34717
34718 .section "Extracting specific information from the log (exigrep)" &&&
34719          "SECTextspeinf"
34720 .cindex "&'exigrep'&"
34721 .cindex "log" "extracts; grepping for"
34722 The &'exigrep'& utility is a Perl script that searches one or more main log
34723 files for entries that match a given pattern. When it finds a match, it
34724 extracts all the log entries for the relevant message, not just those that
34725 match the pattern. Thus, &'exigrep'& can extract complete log entries for a
34726 given message, or all mail for a given user, or for a given host, for example.
34727 The input files can be in Exim log format or syslog format.
34728 If a matching log line is not associated with a specific message, it is
34729 included in &'exigrep'&'s output without any additional lines. The usage is:
34730 .display
34731 &`exigrep [-t<`&&'n'&&`>] [-I] [-l] [-v] <`&&'pattern'&&`> [<`&&'log file'&&`>] ...`&
34732 .endd
34733 If no log file names are given on the command line, the standard input is read.
34734
34735 The &%-t%& argument specifies a number of seconds. It adds an additional
34736 condition for message selection. Messages that are complete are shown only if
34737 they spent more than <&'n'&> seconds on the queue.
34738
34739 By default, &'exigrep'& does case-insensitive matching. The &%-I%& option
34740 makes it case-sensitive. This may give a performance improvement when searching
34741 large log files. Without &%-I%&, the Perl pattern matches use Perl's &`/i`&
34742 option; with &%-I%& they do not. In both cases it is possible to change the
34743 case sensitivity within the pattern by using &`(?i)`& or &`(?-i)`&.
34744
34745 The &%-l%& option means &"literal"&, that is, treat all characters in the
34746 pattern as standing for themselves. Otherwise the pattern must be a Perl
34747 regular expression.
34748
34749 The &%-v%& option inverts the matching condition. That is, a line is selected
34750 if it does &'not'& match the pattern.
34751
34752 If the location of a &'zcat'& command is known from the definition of
34753 ZCAT_COMMAND in &_Local/Makefile_&, &'exigrep'& automatically passes any file
34754 whose name ends in COMPRESS_SUFFIX through &'zcat'& as it searches it.
34755
34756
34757 .section "Selecting messages by various criteria (exipick)" "SECTexipick"
34758 .cindex "&'exipick'&"
34759 John Jetmore's &'exipick'& utility is included in the Exim distribution. It
34760 lists messages from the queue according to a variety of criteria. For details
34761 of &'exipick'&'s facilities, visit the web page at
34762 &url(http://www.exim.org/eximwiki/ToolExipickManPage) or run &'exipick'& with
34763 the &%--help%& option.
34764
34765
34766 .section "Cycling log files (exicyclog)" "SECTcyclogfil"
34767 .cindex "log" "cycling local files"
34768 .cindex "cycling logs"
34769 .cindex "&'exicyclog'&"
34770 The &'exicyclog'& script can be used to cycle (rotate) &'mainlog'& and
34771 &'rejectlog'& files. This is not necessary if only syslog is being used, or if
34772 you are using log files with datestamps in their names (see section
34773 &<<SECTdatlogfil>>&). Some operating systems have their own standard mechanisms
34774 for log cycling, and these can be used instead of &'exicyclog'& if preferred.
34775 There are two command line options for &'exicyclog'&:
34776 .ilist
34777 &%-k%& <&'count'&> specifies the number of log files to keep, overriding the
34778 default that is set when Exim is built. The default default is 10.
34779 .next
34780 &%-l%& <&'path'&> specifies the log file path, in the same format as Exim's
34781 &%log_file_path%& option (for example, &`/var/log/exim_%slog`&), again
34782 overriding the script's default, which is to find the setting from Exim's
34783 configuration.
34784 .endlist
34785
34786 Each time &'exicyclog'& is run the file names get &"shuffled down"& by one. If
34787 the main log file name is &_mainlog_& (the default) then when &'exicyclog'& is
34788 run &_mainlog_& becomes &_mainlog.01_&, the previous &_mainlog.01_& becomes
34789 &_mainlog.02_& and so on, up to the limit that is set in the script or by the
34790 &%-k%& option. Log files whose numbers exceed the limit are discarded. Reject
34791 logs are handled similarly.
34792
34793 If the limit is greater than 99, the script uses 3-digit numbers such as
34794 &_mainlog.001_&, &_mainlog.002_&, etc. If you change from a number less than 99
34795 to one that is greater, or &'vice versa'&, you will have to fix the names of
34796 any existing log files.
34797
34798 If no &_mainlog_& file exists, the script does nothing. Files that &"drop off"&
34799 the end are deleted. All files with numbers greater than 01 are compressed,
34800 using a compression command which is configured by the COMPRESS_COMMAND
34801 setting in &_Local/Makefile_&. It is usual to run &'exicyclog'& daily from a
34802 root &%crontab%& entry of the form
34803 .code
34804 1 0 * * * su exim -c /usr/exim/bin/exicyclog
34805 .endd
34806 assuming you have used the name &"exim"& for the Exim user. You can run
34807 &'exicyclog'& as root if you wish, but there is no need.
34808
34809
34810
34811 .section "Mail statistics (eximstats)" "SECTmailstat"
34812 .cindex "statistics"
34813 .cindex "&'eximstats'&"
34814 A Perl script called &'eximstats'& is provided for extracting statistical
34815 information from log files. The output is either plain text, or HTML.
34816 Exim log files are also supported by the &'Lire'& system produced by the
34817 LogReport Foundation &url(http://www.logreport.org).
34818
34819 The &'eximstats'& script has been hacked about quite a bit over time. The
34820 latest version is the result of some extensive revision by Steve Campbell. A
34821 lot of information is given by default, but there are options for suppressing
34822 various parts of it. Following any options, the arguments to the script are a
34823 list of files, which should be main log files. For example:
34824 .code
34825 eximstats -nr /var/spool/exim/log/mainlog.01
34826 .endd
34827 By default, &'eximstats'& extracts information about the number and volume of
34828 messages received from or delivered to various hosts. The information is sorted
34829 both by message count and by volume, and the top fifty hosts in each category
34830 are listed on the standard output. Similar information, based on email
34831 addresses or domains instead of hosts can be requested by means of various
34832 options. For messages delivered and received locally, similar statistics are
34833 also produced per user.
34834
34835 The output also includes total counts and statistics about delivery errors, and
34836 histograms showing the number of messages received and deliveries made in each
34837 hour of the day. A delivery with more than one address in its envelope (for
34838 example, an SMTP transaction with more than one RCPT command) is counted
34839 as a single delivery by &'eximstats'&.
34840
34841 Though normally more deliveries than receipts are reported (as messages may
34842 have multiple recipients), it is possible for &'eximstats'& to report more
34843 messages received than delivered, even though the queue is empty at the start
34844 and end of the period in question. If an incoming message contains no valid
34845 recipients, no deliveries are recorded for it. A bounce message is handled as
34846 an entirely separate message.
34847
34848 &'eximstats'& always outputs a grand total summary giving the volume and number
34849 of messages received and deliveries made, and the number of hosts involved in
34850 each case. It also outputs the number of messages that were delayed (that is,
34851 not completely delivered at the first attempt), and the number that had at
34852 least one address that failed.
34853
34854 The remainder of the output is in sections that can be independently disabled
34855 or modified by various options. It consists of a summary of deliveries by
34856 transport, histograms of messages received and delivered per time interval
34857 (default per hour), information about the time messages spent on the queue,
34858 a list of relayed messages, lists of the top fifty sending hosts, local
34859 senders, destination hosts, and destination local users by count and by volume,
34860 and a list of delivery errors that occurred.
34861
34862 The relay information lists messages that were actually relayed, that is, they
34863 came from a remote host and were directly delivered to some other remote host,
34864 without being processed (for example, for aliasing or forwarding) locally.
34865
34866 There are quite a few options for &'eximstats'& to control exactly what it
34867 outputs. These are documented in the Perl script itself, and can be extracted
34868 by running the command &(perldoc)& on the script. For example:
34869 .code
34870 perldoc /usr/exim/bin/eximstats
34871 .endd
34872
34873 .section "Checking access policy (exim_checkaccess)" "SECTcheckaccess"
34874 .cindex "&'exim_checkaccess'&"
34875 .cindex "policy control" "checking access"
34876 .cindex "checking access"
34877 The &%-bh%& command line argument allows you to run a fake SMTP session with
34878 debugging output, in order to check what Exim is doing when it is applying
34879 policy controls to incoming SMTP mail. However, not everybody is sufficiently
34880 familiar with the SMTP protocol to be able to make full use of &%-bh%&, and
34881 sometimes you just want to answer the question &"Does this address have
34882 access?"& without bothering with any further details.
34883
34884 The &'exim_checkaccess'& utility is a &"packaged"& version of &%-bh%&. It takes
34885 two arguments, an IP address and an email address:
34886 .code
34887 exim_checkaccess 10.9.8.7 A.User@a.domain.example
34888 .endd
34889 The utility runs a call to Exim with the &%-bh%& option, to test whether the
34890 given email address would be accepted in a RCPT command in a TCP/IP
34891 connection from the host with the given IP address. The output of the utility
34892 is either the word &"accepted"&, or the SMTP error response, for example:
34893 .code
34894 Rejected:
34895 550 Relay not permitted
34896 .endd
34897 When running this test, the utility uses &`<>`& as the envelope sender address
34898 for the MAIL command, but you can change this by providing additional
34899 options. These are passed directly to the Exim command. For example, to specify
34900 that the test is to be run with the sender address &'himself@there.example'&
34901 you can use:
34902 .code
34903 exim_checkaccess 10.9.8.7 A.User@a.domain.example \
34904                  -f himself@there.example
34905 .endd
34906 Note that these additional Exim command line items must be given after the two
34907 mandatory arguments.
34908
34909 Because the &%exim_checkaccess%& uses &%-bh%&, it does not perform callouts
34910 while running its checks. You can run checks that include callouts by using
34911 &%-bhc%&, but this is not yet available in a &"packaged"& form.
34912
34913
34914
34915 .section "Making DBM files (exim_dbmbuild)" "SECTdbmbuild"
34916 .cindex "DBM" "building dbm files"
34917 .cindex "building DBM files"
34918 .cindex "&'exim_dbmbuild'&"
34919 .cindex "lower casing"
34920 .cindex "binary zero" "in lookup key"
34921 The &'exim_dbmbuild'& program reads an input file containing keys and data in
34922 the format used by the &(lsearch)& lookup (see section
34923 &<<SECTsinglekeylookups>>&). It writes a DBM file using the lower-cased alias
34924 names as keys and the remainder of the information as data. The lower-casing
34925 can be prevented by calling the program with the &%-nolc%& option.
34926
34927 A terminating zero is included as part of the key string. This is expected by
34928 the &(dbm)& lookup type. However, if the option &%-nozero%& is given,
34929 &'exim_dbmbuild'& creates files without terminating zeroes in either the key
34930 strings or the data strings. The &(dbmnz)& lookup type can be used with such
34931 files.
34932
34933 The program requires two arguments: the name of the input file (which can be a
34934 single hyphen to indicate the standard input), and the name of the output file.
34935 It creates the output under a temporary name, and then renames it if all went
34936 well.
34937
34938 .cindex "USE_DB"
34939 If the native DB interface is in use (USE_DB is set in a compile-time
34940 configuration file &-- this is common in free versions of Unix) the two file
34941 names must be different, because in this mode the Berkeley DB functions create
34942 a single output file using exactly the name given. For example,
34943 .code
34944 exim_dbmbuild /etc/aliases /etc/aliases.db
34945 .endd
34946 reads the system alias file and creates a DBM version of it in
34947 &_/etc/aliases.db_&.
34948
34949 In systems that use the &'ndbm'& routines (mostly proprietary versions of
34950 Unix), two files are used, with the suffixes &_.dir_& and &_.pag_&. In this
34951 environment, the suffixes are added to the second argument of
34952 &'exim_dbmbuild'&, so it can be the same as the first. This is also the case
34953 when the Berkeley functions are used in compatibility mode (though this is not
34954 recommended), because in that case it adds a &_.db_& suffix to the file name.
34955
34956 If a duplicate key is encountered, the program outputs a warning, and when it
34957 finishes, its return code is 1 rather than zero, unless the &%-noduperr%&
34958 option is used. By default, only the first of a set of duplicates is used &--
34959 this makes it compatible with &(lsearch)& lookups. There is an option
34960 &%-lastdup%& which causes it to use the data for the last duplicate instead.
34961 There is also an option &%-nowarn%&, which stops it listing duplicate keys to
34962 &%stderr%&. For other errors, where it doesn't actually make a new file, the
34963 return code is 2.
34964
34965
34966
34967
34968 .section "Finding individual retry times (exinext)" "SECTfinindret"
34969 .cindex "retry" "times"
34970 .cindex "&'exinext'&"
34971 A utility called &'exinext'& (mostly a Perl script) provides the ability to
34972 fish specific information out of the retry database. Given a mail domain (or a
34973 complete address), it looks up the hosts for that domain, and outputs any retry
34974 information for the hosts or for the domain. At present, the retry information
34975 is obtained by running &'exim_dumpdb'& (see below) and post-processing the
34976 output. For example:
34977 .code
34978 $ exinext piglet@milne.fict.example
34979 kanga.milne.example:192.168.8.1 error 146: Connection refused
34980   first failed: 21-Feb-1996 14:57:34
34981   last tried:   21-Feb-1996 14:57:34
34982   next try at:  21-Feb-1996 15:02:34
34983 roo.milne.example:192.168.8.3 error 146: Connection refused
34984   first failed: 20-Jan-1996 13:12:08
34985   last tried:   21-Feb-1996 11:42:03
34986   next try at:  21-Feb-1996 19:42:03
34987   past final cutoff time
34988 .endd
34989 You can also give &'exinext'& a local part, without a domain, and it
34990 will give any retry information for that local part in your default domain.
34991 A message id can be used to obtain retry information pertaining to a specific
34992 message. This exists only when an attempt to deliver a message to a remote host
34993 suffers a message-specific error (see section &<<SECToutSMTPerr>>&).
34994 &'exinext'& is not particularly efficient, but then it is not expected to be
34995 run very often.
34996
34997 The &'exinext'& utility calls Exim to find out information such as the location
34998 of the spool directory. The utility has &%-C%& and &%-D%& options, which are
34999 passed on to the &'exim'& commands. The first specifies an alternate Exim
35000 configuration file, and the second sets macros for use within the configuration
35001 file. These features are mainly to help in testing, but might also be useful in
35002 environments where more than one configuration file is in use.
35003
35004
35005
35006 .section "Hints database maintenance" "SECThindatmai"
35007 .cindex "hints database" "maintenance"
35008 .cindex "maintaining Exim's hints database"
35009 Three utility programs are provided for maintaining the DBM files that Exim
35010 uses to contain its delivery hint information. Each program requires two
35011 arguments. The first specifies the name of Exim's spool directory, and the
35012 second is the name of the database it is to operate on. These are as follows:
35013
35014 .ilist
35015 &'retry'&: the database of retry information
35016 .next
35017 &'wait-'&<&'transport name'&>: databases of information about messages waiting
35018 for remote hosts
35019 .next
35020 &'callout'&: the callout cache
35021 .next
35022 &'ratelimit'&: the data for implementing the ratelimit ACL condition
35023 .next
35024 &'misc'&: other hints data
35025 .endlist
35026
35027 The &'misc'& database is used for
35028
35029 .ilist
35030 Serializing ETRN runs (when &%smtp_etrn_serialize%& is set)
35031 .next
35032 Serializing delivery to a specific host (when &%serialize_hosts%& is set in an
35033 &(smtp)& transport)
35034 .endlist
35035
35036
35037
35038 .section "exim_dumpdb" "SECID261"
35039 .cindex "&'exim_dumpdb'&"
35040 The entire contents of a database are written to the standard output by the
35041 &'exim_dumpdb'& program, which has no options or arguments other than the
35042 spool and database names. For example, to dump the retry database:
35043 .code
35044 exim_dumpdb /var/spool/exim retry
35045 .endd
35046 Two lines of output are produced for each entry:
35047 .code
35048 T:mail.ref.example:192.168.242.242 146 77 Connection refused
35049 31-Oct-1995 12:00:12 02-Nov-1995 12:21:39 02-Nov-1995 20:21:39 *
35050 .endd
35051 The first item on the first line is the key of the record. It starts with one
35052 of the letters R, or T, depending on whether it refers to a routing or
35053 transport retry. For a local delivery, the next part is the local address; for
35054 a remote delivery it is the name of the remote host, followed by its failing IP
35055 address (unless &%retry_include_ip_address%& is set false on the &(smtp)&
35056 transport). If the remote port is not the standard one (port 25), it is added
35057 to the IP address. Then there follows an error code, an additional error code,
35058 and a textual description of the error.
35059
35060 The three times on the second line are the time of first failure, the time of
35061 the last delivery attempt, and the computed time for the next attempt. The line
35062 ends with an asterisk if the cutoff time for the last retry rule has been
35063 exceeded.
35064
35065 Each output line from &'exim_dumpdb'& for the &'wait-xxx'& databases
35066 consists of a host name followed by a list of ids for messages that are or were
35067 waiting to be delivered to that host. If there are a very large number for any
35068 one host, continuation records, with a sequence number added to the host name,
35069 may be seen. The data in these records is often out of date, because a message
35070 may be routed to several alternative hosts, and Exim makes no effort to keep
35071 cross-references.
35072
35073
35074
35075 .section "exim_tidydb" "SECID262"
35076 .cindex "&'exim_tidydb'&"
35077 The &'exim_tidydb'& utility program is used to tidy up the contents of a hints
35078 database. If run with no options, it removes all records that are more than 30
35079 days old. The age is calculated from the date and time that the record was last
35080 updated. Note that, in the case of the retry database, it is &'not'& the time
35081 since the first delivery failure. Information about a host that has been down
35082 for more than 30 days will remain in the database, provided that the record is
35083 updated sufficiently often.
35084
35085 The cutoff date can be altered by means of the &%-t%& option, which must be
35086 followed by a time. For example, to remove all records older than a week from
35087 the retry database:
35088 .code
35089 exim_tidydb -t 7d /var/spool/exim retry
35090 .endd
35091 Both the &'wait-xxx'& and &'retry'& databases contain items that involve
35092 message ids. In the former these appear as data in records keyed by host &--
35093 they were messages that were waiting for that host &-- and in the latter they
35094 are the keys for retry information for messages that have suffered certain
35095 types of error. When &'exim_tidydb'& is run, a check is made to ensure that
35096 message ids in database records are those of messages that are still on the
35097 queue. Message ids for messages that no longer exist are removed from
35098 &'wait-xxx'& records, and if this leaves any records empty, they are deleted.
35099 For the &'retry'& database, records whose keys are non-existent message ids are
35100 removed. The &'exim_tidydb'& utility outputs comments on the standard output
35101 whenever it removes information from the database.
35102
35103 Certain records are automatically removed by Exim when they are no longer
35104 needed, but others are not. For example, if all the MX hosts for a domain are
35105 down, a retry record is created for each one. If the primary MX host comes back
35106 first, its record is removed when Exim successfully delivers to it, but the
35107 records for the others remain because Exim has not tried to use those hosts.
35108
35109 It is important, therefore, to run &'exim_tidydb'& periodically on all the
35110 hints databases. You should do this at a quiet time of day, because it requires
35111 a database to be locked (and therefore inaccessible to Exim) while it does its
35112 work. Removing records from a DBM file does not normally make the file smaller,
35113 but all the common DBM libraries are able to re-use the space that is released.
35114 After an initial phase of increasing in size, the databases normally reach a
35115 point at which they no longer get any bigger, as long as they are regularly
35116 tidied.
35117
35118 &*Warning*&: If you never run &'exim_tidydb'&, the space used by the hints
35119 databases is likely to keep on increasing.
35120
35121
35122
35123
35124 .section "exim_fixdb" "SECID263"
35125 .cindex "&'exim_fixdb'&"
35126 The &'exim_fixdb'& program is a utility for interactively modifying databases.
35127 Its main use is for testing Exim, but it might also be occasionally useful for
35128 getting round problems in a live system. It has no options, and its interface
35129 is somewhat crude. On entry, it prompts for input with a right angle-bracket. A
35130 key of a database record can then be entered, and the data for that record is
35131 displayed.
35132
35133 If &"d"& is typed at the next prompt, the entire record is deleted. For all
35134 except the &'retry'& database, that is the only operation that can be carried
35135 out. For the &'retry'& database, each field is output preceded by a number, and
35136 data for individual fields can be changed by typing the field number followed
35137 by new data, for example:
35138 .code
35139 > 4 951102:1000
35140 .endd
35141 resets the time of the next delivery attempt. Time values are given as a
35142 sequence of digit pairs for year, month, day, hour, and minute. Colons can be
35143 used as optional separators.
35144
35145
35146
35147
35148 .section "Mailbox maintenance (exim_lock)" "SECTmailboxmaint"
35149 .cindex "mailbox" "maintenance"
35150 .cindex "&'exim_lock'&"
35151 .cindex "locking mailboxes"
35152 The &'exim_lock'& utility locks a mailbox file using the same algorithm as
35153 Exim. For a discussion of locking issues, see section &<<SECTopappend>>&.
35154 &'Exim_lock'& can be used to prevent any modification of a mailbox by Exim or
35155 a user agent while investigating a problem. The utility requires the name of
35156 the file as its first argument. If the locking is successful, the second
35157 argument is run as a command (using C's &[system()]& function); if there is no
35158 second argument, the value of the SHELL environment variable is used; if this
35159 is unset or empty, &_/bin/sh_& is run. When the command finishes, the mailbox
35160 is unlocked and the utility ends. The following options are available:
35161
35162 .vlist
35163 .vitem &%-fcntl%&
35164 Use &[fcntl()]& locking on the open mailbox.
35165
35166 .vitem &%-flock%&
35167 Use &[flock()]& locking on the open mailbox, provided the operating system
35168 supports it.
35169
35170 .vitem &%-interval%&
35171 This must be followed by a number, which is a number of seconds; it sets the
35172 interval to sleep between retries (default 3).
35173
35174 .vitem &%-lockfile%&
35175 Create a lock file before opening the mailbox.
35176
35177 .vitem &%-mbx%&
35178 Lock the mailbox using MBX rules.
35179
35180 .vitem &%-q%&
35181 Suppress verification output.
35182
35183 .vitem &%-retries%&
35184 This must be followed by a number; it sets the number of times to try to get
35185 the lock (default 10).
35186
35187 .vitem &%-restore_time%&
35188 This option causes &%exim_lock%& to restore the modified and read times to the
35189 locked file before exiting. This allows you to access a locked mailbox (for
35190 example, to take a backup copy) without disturbing the times that the user
35191 subsequently sees.
35192
35193 .vitem &%-timeout%&
35194 This must be followed by a number, which is a number of seconds; it sets a
35195 timeout to be used with a blocking &[fcntl()]& lock. If it is not set (the
35196 default), a non-blocking call is used.
35197
35198 .vitem &%-v%&
35199 Generate verbose output.
35200 .endlist
35201
35202 If none of &%-fcntl%&, &%-flock%&, &%-lockfile%& or &%-mbx%& are given, the
35203 default is to create a lock file and also to use &[fcntl()]& locking on the
35204 mailbox, which is the same as Exim's default. The use of &%-flock%& or
35205 &%-fcntl%& requires that the file be writeable; the use of &%-lockfile%&
35206 requires that the directory containing the file be writeable. Locking by lock
35207 file does not last for ever; Exim assumes that a lock file is expired if it is
35208 more than 30 minutes old.
35209
35210 The &%-mbx%& option can be used with either or both of &%-fcntl%& or
35211 &%-flock%&. It assumes &%-fcntl%& by default. MBX locking causes a shared lock
35212 to be taken out on the open mailbox, and an exclusive lock on the file
35213 &_/tmp/.n.m_& where &'n'& and &'m'& are the device number and inode
35214 number of the mailbox file. When the locking is released, if an exclusive lock
35215 can be obtained for the mailbox, the file in &_/tmp_& is deleted.
35216
35217 The default output contains verification of the locking that takes place. The
35218 &%-v%& option causes some additional information to be given. The &%-q%& option
35219 suppresses all output except error messages.
35220
35221 A command such as
35222 .code
35223 exim_lock /var/spool/mail/spqr
35224 .endd
35225 runs an interactive shell while the file is locked, whereas
35226 .display
35227 &`exim_lock -q /var/spool/mail/spqr <<End`&
35228 <&'some commands'&>
35229 &`End`&
35230 .endd
35231 runs a specific non-interactive sequence of commands while the file is locked,
35232 suppressing all verification output. A single command can be run by a command
35233 such as
35234 .code
35235 exim_lock -q /var/spool/mail/spqr \
35236   "cp /var/spool/mail/spqr /some/where"
35237 .endd
35238 Note that if a command is supplied, it must be entirely contained within the
35239 second argument &-- hence the quotes.
35240 .ecindex IIDutils
35241
35242
35243 . ////////////////////////////////////////////////////////////////////////////
35244 . ////////////////////////////////////////////////////////////////////////////
35245
35246 .chapter "The Exim monitor" "CHAPeximon"
35247 .scindex IIDeximon "Exim monitor" "description"
35248 .cindex "X-windows"
35249 .cindex "&'eximon'&"
35250 .cindex "Local/eximon.conf"
35251 .cindex "&_exim_monitor/EDITME_&"
35252 The Exim monitor is an application which displays in an X window information
35253 about the state of Exim's queue and what Exim is doing. An admin user can
35254 perform certain operations on messages from this GUI interface; however all
35255 such facilities are also available from the command line, and indeed, the
35256 monitor itself makes use of the command line to perform any actions requested.
35257
35258
35259
35260 .section "Running the monitor" "SECID264"
35261 The monitor is started by running the script called &'eximon'&. This is a shell
35262 script that sets up a number of environment variables, and then runs the
35263 binary called &_eximon.bin_&. The default appearance of the monitor window can
35264 be changed by editing the &_Local/eximon.conf_& file created by editing
35265 &_exim_monitor/EDITME_&. Comments in that file describe what the various
35266 parameters are for.
35267
35268 The parameters that get built into the &'eximon'& script can be overridden for
35269 a particular invocation by setting up environment variables of the same names,
35270 preceded by &`EXIMON_`&. For example, a shell command such as
35271 .code
35272 EXIMON_LOG_DEPTH=400 eximon
35273 .endd
35274 (in a Bourne-compatible shell) runs &'eximon'& with an overriding setting of
35275 the LOG_DEPTH parameter. If EXIMON_LOG_FILE_PATH is set in the environment, it
35276 overrides the Exim log file configuration. This makes it possible to have
35277 &'eximon'& tailing log data that is written to syslog, provided that MAIL.INFO
35278 syslog messages are routed to a file on the local host.
35279
35280 X resources can be used to change the appearance of the window in the normal
35281 way. For example, a resource setting of the form
35282 .code
35283 Eximon*background: gray94
35284 .endd
35285 changes the colour of the background to light grey rather than white. The
35286 stripcharts are drawn with both the data lines and the reference lines in
35287 black. This means that the reference lines are not visible when on top of the
35288 data. However, their colour can be changed by setting a resource called
35289 &"highlight"& (an odd name, but that's what the Athena stripchart widget uses).
35290 For example, if your X server is running Unix, you could set up lighter
35291 reference lines in the stripcharts by obeying
35292 .code
35293 xrdb -merge <<End
35294 Eximon*highlight: gray
35295 End
35296 .endd
35297 .cindex "admin user"
35298 In order to see the contents of messages on the queue, and to operate on them,
35299 &'eximon'& must either be run as root or by an admin user.
35300
35301 The command-line parameters of &'eximon'& are passed to &_eximon.bin_& and may
35302 contain X11 resource parameters interpreted by the X11 library.  In addition,
35303 if the first parameter starts with the string "gdb" then it is removed and the
35304 binary is invoked under gdb (the parameter is used as the gdb command-name, so
35305 versioned variants of gdb can be invoked).
35306
35307 The monitor's window is divided into three parts. The first contains one or
35308 more stripcharts and two action buttons, the second contains a &"tail"& of the
35309 main log file, and the third is a display of the queue of messages awaiting
35310 delivery, with two more action buttons. The following sections describe these
35311 different parts of the display.
35312
35313
35314
35315
35316 .section "The stripcharts" "SECID265"
35317 .cindex "stripchart"
35318 The first stripchart is always a count of messages on the queue. Its name can
35319 be configured by setting QUEUE_STRIPCHART_NAME in the
35320 &_Local/eximon.conf_& file. The remaining stripcharts are defined in the
35321 configuration script by regular expression matches on log file entries, making
35322 it possible to display, for example, counts of messages delivered to certain
35323 hosts or using certain transports. The supplied defaults display counts of
35324 received and delivered messages, and of local and SMTP deliveries. The default
35325 period between stripchart updates is one minute; this can be adjusted by a
35326 parameter in the &_Local/eximon.conf_& file.
35327
35328 The stripchart displays rescale themselves automatically as the value they are
35329 displaying changes. There are always 10 horizontal lines in each chart; the
35330 title string indicates the value of each division when it is greater than one.
35331 For example, &"x2"& means that each division represents a value of 2.
35332
35333 It is also possible to have a stripchart which shows the percentage fullness of
35334 a particular disk partition, which is useful when local deliveries are confined
35335 to a single partition.
35336
35337 .cindex "&%statvfs%& function"
35338 This relies on the availability of the &[statvfs()]& function or equivalent in
35339 the operating system. Most, but not all versions of Unix that support Exim have
35340 this. For this particular stripchart, the top of the chart always represents
35341 100%, and the scale is given as &"x10%"&. This chart is configured by setting
35342 SIZE_STRIPCHART and (optionally) SIZE_STRIPCHART_NAME in the
35343 &_Local/eximon.conf_& file.
35344
35345
35346
35347
35348 .section "Main action buttons" "SECID266"
35349 .cindex "size" "of monitor window"
35350 .cindex "Exim monitor" "window size"
35351 .cindex "window size"
35352 Below the stripcharts there is an action button for quitting the monitor. Next
35353 to this is another button marked &"Size"&. They are placed here so that
35354 shrinking the window to its default minimum size leaves just the queue count
35355 stripchart and these two buttons visible. Pressing the &"Size"& button causes
35356 the window to expand to its maximum size, unless it is already at the maximum,
35357 in which case it is reduced to its minimum.
35358
35359 When expanding to the maximum, if the window cannot be fully seen where it
35360 currently is, it is moved back to where it was the last time it was at full
35361 size. When it is expanding from its minimum size, the old position is
35362 remembered, and next time it is reduced to the minimum it is moved back there.
35363
35364 The idea is that you can keep a reduced window just showing one or two
35365 stripcharts at a convenient place on your screen, easily expand it to show
35366 the full window when required, and just as easily put it back to what it was.
35367 The idea is copied from what the &'twm'& window manager does for its
35368 &'f.fullzoom'& action. The minimum size of the window can be changed by setting
35369 the MIN_HEIGHT and MIN_WIDTH values in &_Local/eximon.conf_&.
35370
35371 Normally, the monitor starts up with the window at its full size, but it can be
35372 built so that it starts up with the window at its smallest size, by setting
35373 START_SMALL=yes in &_Local/eximon.conf_&.
35374
35375
35376
35377 .section "The log display" "SECID267"
35378 .cindex "log" "tail of; in monitor"
35379 The second section of the window is an area in which a display of the tail of
35380 the main log is maintained.
35381 To save space on the screen, the timestamp on each log line is shortened by
35382 removing the date and, if &%log_timezone%& is set, the timezone.
35383 The log tail is not available when the only destination for logging data is
35384 syslog, unless the syslog lines are routed to a local file whose name is passed
35385 to &'eximon'& via the EXIMON_LOG_FILE_PATH environment variable.
35386
35387 The log sub-window has a scroll bar at its lefthand side which can be used to
35388 move back to look at earlier text, and the up and down arrow keys also have a
35389 scrolling effect. The amount of log that is kept depends on the setting of
35390 LOG_BUFFER in &_Local/eximon.conf_&, which specifies the amount of memory
35391 to use. When this is full, the earlier 50% of data is discarded &-- this is
35392 much more efficient than throwing it away line by line. The sub-window also has
35393 a horizontal scroll bar for accessing the ends of long log lines. This is the
35394 only means of horizontal scrolling; the right and left arrow keys are not
35395 available. Text can be cut from this part of the window using the mouse in the
35396 normal way. The size of this subwindow is controlled by parameters in the
35397 configuration file &_Local/eximon.conf_&.
35398
35399 Searches of the text in the log window can be carried out by means of the ^R
35400 and ^S keystrokes, which default to a reverse and a forward search,
35401 respectively. The search covers only the text that is displayed in the window.
35402 It cannot go further back up the log.
35403
35404 The point from which the search starts is indicated by a caret marker. This is
35405 normally at the end of the text in the window, but can be positioned explicitly
35406 by pointing and clicking with the left mouse button, and is moved automatically
35407 by a successful search. If new text arrives in the window when it is scrolled
35408 back, the caret remains where it is, but if the window is not scrolled back,
35409 the caret is moved to the end of the new text.
35410
35411 Pressing ^R or ^S pops up a window into which the search text can be typed.
35412 There are buttons for selecting forward or reverse searching, for carrying out
35413 the search, and for cancelling. If the &"Search"& button is pressed, the search
35414 happens and the window remains so that further searches can be done. If the
35415 &"Return"& key is pressed, a single search is done and the window is closed. If
35416 ^C is typed the search is cancelled.
35417
35418 The searching facility is implemented using the facilities of the Athena text
35419 widget. By default this pops up a window containing both &"search"& and
35420 &"replace"& options. In order to suppress the unwanted &"replace"& portion for
35421 eximon, a modified version of the &%TextPop%& widget is distributed with Exim.
35422 However, the linkers in BSDI and HP-UX seem unable to handle an externally
35423 provided version of &%TextPop%& when the remaining parts of the text widget
35424 come from the standard libraries. The compile-time option EXIMON_TEXTPOP can be
35425 unset to cut out the modified &%TextPop%&, making it possible to build Eximon
35426 on these systems, at the expense of having unwanted items in the search popup
35427 window.
35428
35429
35430
35431 .section "The queue display" "SECID268"
35432 .cindex "queue" "display in monitor"
35433 The bottom section of the monitor window contains a list of all messages that
35434 are on the queue, which includes those currently being received or delivered,
35435 as well as those awaiting delivery. The size of this subwindow is controlled by
35436 parameters in the configuration file &_Local/eximon.conf_&, and the frequency
35437 at which it is updated is controlled by another parameter in the same file &--
35438 the default is 5 minutes, since queue scans can be quite expensive. However,
35439 there is an &"Update"& action button just above the display which can be used
35440 to force an update of the queue display at any time.
35441
35442 When a host is down for some time, a lot of pending mail can build up for it,
35443 and this can make it hard to deal with other messages on the queue. To help
35444 with this situation there is a button next to &"Update"& called &"Hide"&. If
35445 pressed, a dialogue box called &"Hide addresses ending with"& is put up. If you
35446 type anything in here and press &"Return"&, the text is added to a chain of
35447 such texts, and if every undelivered address in a message matches at least one
35448 of the texts, the message is not displayed.
35449
35450 If there is an address that does not match any of the texts, all the addresses
35451 are displayed as normal. The matching happens on the ends of addresses so, for
35452 example, &'cam.ac.uk'& specifies all addresses in Cambridge, while
35453 &'xxx@foo.com.example'& specifies just one specific address. When any hiding
35454 has been set up, a button called &"Unhide"& is displayed. If pressed, it
35455 cancels all hiding. Also, to ensure that hidden messages do not get forgotten,
35456 a hide request is automatically cancelled after one hour.
35457
35458 While the dialogue box is displayed, you can't press any buttons or do anything
35459 else to the monitor window. For this reason, if you want to cut text from the
35460 queue display to use in the dialogue box, you have to do the cutting before
35461 pressing the &"Hide"& button.
35462
35463 The queue display contains, for each unhidden queued message, the length of
35464 time it has been on the queue, the size of the message, the message id, the
35465 message sender, and the first undelivered recipient, all on one line. If it is
35466 a bounce message, the sender is shown as &"<>"&. If there is more than one
35467 recipient to which the message has not yet been delivered, subsequent ones are
35468 listed on additional lines, up to a maximum configured number, following which
35469 an ellipsis is displayed. Recipients that have already received the message are
35470 not shown.
35471
35472 .cindex "frozen messages" "display"
35473 If a message is frozen, an asterisk is displayed at the left-hand side.
35474
35475 The queue display has a vertical scroll bar, and can also be scrolled by means
35476 of the arrow keys. Text can be cut from it using the mouse in the normal way.
35477 The text searching facilities, as described above for the log window, are also
35478 available, but the caret is always moved to the end of the text when the queue
35479 display is updated.
35480
35481
35482
35483 .section "The queue menu" "SECID269"
35484 .cindex "queue" "menu in monitor"
35485 If the &%shift%& key is held down and the left button is clicked when the mouse
35486 pointer is over the text for any message, an action menu pops up, and the first
35487 line of the queue display for the message is highlighted. This does not affect
35488 any selected text.
35489
35490 If you want to use some other event for popping up the menu, you can set the
35491 MENU_EVENT parameter in &_Local/eximon.conf_& to change the default, or
35492 set EXIMON_MENU_EVENT in the environment before starting the monitor. The
35493 value set in this parameter is a standard X event description. For example, to
35494 run eximon using &%ctrl%& rather than &%shift%& you could use
35495 .code
35496 EXIMON_MENU_EVENT='Ctrl<Btn1Down>' eximon
35497 .endd
35498 The title of the menu is the message id, and it contains entries which act as
35499 follows:
35500
35501 .ilist
35502 &'message log'&: The contents of the message log for the message are displayed
35503 in a new text window.
35504 .next
35505 &'headers'&: Information from the spool file that contains the envelope
35506 information and headers is displayed in a new text window. See chapter
35507 &<<CHAPspool>>& for a description of the format of spool files.
35508 .next
35509 &'body'&: The contents of the spool file containing the body of the message are
35510 displayed in a new text window. There is a default limit of 20,000 bytes to the
35511 amount of data displayed. This can be changed by setting the BODY_MAX
35512 option at compile time, or the EXIMON_BODY_MAX option at run time.
35513 .next
35514 &'deliver message'&: A call to Exim is made using the &%-M%& option to request
35515 delivery of the message. This causes an automatic thaw if the message is
35516 frozen. The &%-v%& option is also set, and the output from Exim is displayed in
35517 a new text window. The delivery is run in a separate process, to avoid holding
35518 up the monitor while the delivery proceeds.
35519 .next
35520 &'freeze message'&: A call to Exim is made using the &%-Mf%& option to request
35521 that the message be frozen.
35522 .next
35523 .cindex "thawing messages"
35524 .cindex "unfreezing messages"
35525 .cindex "frozen messages" "thawing"
35526 &'thaw message'&: A call to Exim is made using the &%-Mt%& option to request
35527 that the message be thawed.
35528 .next
35529 .cindex "delivery" "forcing failure"
35530 &'give up on msg'&: A call to Exim is made using the &%-Mg%& option to request
35531 that Exim gives up trying to deliver the message. A bounce message is generated
35532 for any remaining undelivered addresses.
35533 .next
35534 &'remove message'&: A call to Exim is made using the &%-Mrm%& option to request
35535 that the message be deleted from the system without generating a bounce
35536 message.
35537 .next
35538 &'add recipient'&: A dialog box is displayed into which a recipient address can
35539 be typed. If the address is not qualified and the QUALIFY_DOMAIN parameter
35540 is set in &_Local/eximon.conf_&, the address is qualified with that domain.
35541 Otherwise it must be entered as a fully qualified address. Pressing RETURN
35542 causes a call to Exim to be made using the &%-Mar%& option to request that an
35543 additional recipient be added to the message, unless the entry box is empty, in
35544 which case no action is taken.
35545 .next
35546 &'mark delivered'&: A dialog box is displayed into which a recipient address
35547 can be typed. If the address is not qualified and the QUALIFY_DOMAIN parameter
35548 is set in &_Local/eximon.conf_&, the address is qualified with that domain.
35549 Otherwise it must be entered as a fully qualified address. Pressing RETURN
35550 causes a call to Exim to be made using the &%-Mmd%& option to mark the given
35551 recipient address as already delivered, unless the entry box is empty, in which
35552 case no action is taken.
35553 .next
35554 &'mark all delivered'&: A call to Exim is made using the &%-Mmad%& option to
35555 mark all recipient addresses as already delivered.
35556 .next
35557 &'edit sender'&: A dialog box is displayed initialized with the current
35558 sender's address. Pressing RETURN causes a call to Exim to be made using the
35559 &%-Mes%& option to replace the sender address, unless the entry box is empty,
35560 in which case no action is taken. If you want to set an empty sender (as in
35561 bounce messages), you must specify it as &"<>"&. Otherwise, if the address is
35562 not qualified and the QUALIFY_DOMAIN parameter is set in &_Local/eximon.conf_&,
35563 the address is qualified with that domain.
35564 .endlist
35565
35566 When a delivery is forced, a window showing the &%-v%& output is displayed. In
35567 other cases when a call to Exim is made, if there is any output from Exim (in
35568 particular, if the command fails) a window containing the command and the
35569 output is displayed. Otherwise, the results of the action are normally apparent
35570 from the log and queue displays. However, if you set ACTION_OUTPUT=yes in
35571 &_Local/eximon.conf_&, a window showing the Exim command is always opened, even
35572 if no output is generated.
35573
35574 The queue display is automatically updated for actions such as freezing and
35575 thawing, unless ACTION_QUEUE_UPDATE=no has been set in
35576 &_Local/eximon.conf_&. In this case the &"Update"& button has to be used to
35577 force an update of the display after one of these actions.
35578
35579 In any text window that is displayed as result of a menu action, the normal
35580 cut-and-paste facility is available, and searching can be carried out using ^R
35581 and ^S, as described above for the log tail window.
35582 .ecindex IIDeximon
35583
35584
35585
35586
35587
35588 . ////////////////////////////////////////////////////////////////////////////
35589 . ////////////////////////////////////////////////////////////////////////////
35590
35591 .chapter "Security considerations" "CHAPsecurity"
35592 .scindex IIDsecurcon "security" "discussion of"
35593 This chapter discusses a number of issues concerned with security, some of
35594 which are also covered in other parts of this manual.
35595
35596 For reasons that this author does not understand, some people have promoted
35597 Exim as a &"particularly secure"& mailer. Perhaps it is because of the
35598 existence of this chapter in the documentation. However, the intent of the
35599 chapter is simply to describe the way Exim works in relation to certain
35600 security concerns, not to make any specific claims about the effectiveness of
35601 its security as compared with other MTAs.
35602
35603 What follows is a description of the way Exim is supposed to be. Best efforts
35604 have been made to try to ensure that the code agrees with the theory, but an
35605 absence of bugs can never be guaranteed. Any that are reported will get fixed
35606 as soon as possible.
35607
35608
35609 .section "Building a more &""hardened""& Exim" "SECID286"
35610 .cindex "security" "build-time features"
35611 There are a number of build-time options that can be set in &_Local/Makefile_&
35612 to create Exim binaries that are &"harder"& to attack, in particular by a rogue
35613 Exim administrator who does not have the root password, or by someone who has
35614 penetrated the Exim (but not the root) account. These options are as follows:
35615
35616 .ilist
35617 ALT_CONFIG_PREFIX can be set to a string that is required to match the
35618 start of any file names used with the &%-C%& option. When it is set, these file
35619 names are also not allowed to contain the sequence &"/../"&. (However, if the
35620 value of the &%-C%& option is identical to the value of CONFIGURE_FILE in
35621 &_Local/Makefile_&, Exim ignores &%-C%& and proceeds as usual.) There is no
35622 default setting for &%ALT_CONFIG_PREFIX%&.
35623
35624 If the permitted configuration files are confined to a directory to
35625 which only root has access, this guards against someone who has broken
35626 into the Exim account from running a privileged Exim with an arbitrary
35627 configuration file, and using it to break into other accounts.
35628 .next
35629
35630 If a non-trusted configuration file (i.e. not the default configuration file
35631 or one which is trusted by virtue of being listed in the TRUSTED_CONFIG_LIST
35632 file) is specified with &%-C%&, or if macros are given with &%-D%& (but see
35633 the next item), then root privilege is retained only if the caller of Exim is
35634 root. This locks out the possibility of testing a configuration using &%-C%&
35635 right through message reception and delivery, even if the caller is root. The
35636 reception works, but by that time, Exim is running as the Exim user, so when
35637 it re-execs to regain privilege for the delivery, the use of &%-C%& causes
35638 privilege to be lost. However, root can test reception and delivery using two
35639 separate commands.
35640
35641 .next
35642 The WHITELIST_D_MACROS build option declares some macros to be safe to override
35643 with &%-D%& if the real uid is one of root, the Exim run-time user or the
35644 CONFIGURE_OWNER, if defined.  The potential impact of this option is limited by
35645 requiring the run-time value supplied to &%-D%& to match a regex that errs on
35646 the restrictive side.  Requiring build-time selection of safe macros is onerous
35647 but this option is intended solely as a transition mechanism to permit
35648 previously-working configurations to continue to work after release 4.73.
35649 .next
35650 If DISABLE_D_OPTION is defined, the use of the &%-D%& command line option
35651 is disabled.
35652 .next
35653 FIXED_NEVER_USERS can be set to a colon-separated list of users that are
35654 never to be used for any deliveries. This is like the &%never_users%& runtime
35655 option, but it cannot be overridden; the runtime option adds additional users
35656 to the list. The default setting is &"root"&; this prevents a non-root user who
35657 is permitted to modify the runtime file from using Exim as a way to get root.
35658 .endlist
35659
35660
35661
35662 .section "Root privilege" "SECID270"
35663 .cindex "setuid"
35664 .cindex "root privilege"
35665 The Exim binary is normally setuid to root, which means that it gains root
35666 privilege (runs as root) when it starts execution. In some special cases (for
35667 example, when the daemon is not in use and there are no local deliveries), it
35668 may be possible to run Exim setuid to some user other than root. This is
35669 discussed in the next section. However, in most installations, root privilege
35670 is required for two things:
35671
35672 .ilist
35673 To set up a socket connected to the standard SMTP port (25) when initialising
35674 the listening daemon. If Exim is run from &'inetd'&, this privileged action is
35675 not required.
35676 .next
35677 To be able to change uid and gid in order to read users' &_.forward_& files and
35678 perform local deliveries as the receiving user or as specified in the
35679 configuration.
35680 .endlist
35681
35682 It is not necessary to be root to do any of the other things Exim does, such as
35683 receiving messages and delivering them externally over SMTP, and it is
35684 obviously more secure if Exim does not run as root except when necessary.
35685 For this reason, a user and group for Exim to use must be defined in
35686 &_Local/Makefile_&. These are known as &"the Exim user"& and &"the Exim
35687 group"&. Their values can be changed by the run time configuration, though this
35688 is not recommended. Often a user called &'exim'& is used, but some sites use
35689 &'mail'& or another user name altogether.
35690
35691 Exim uses &[setuid()]& whenever it gives up root privilege. This is a permanent
35692 abdication; the process cannot regain root afterwards. Prior to release 4.00,
35693 &[seteuid()]& was used in some circumstances, but this is no longer the case.
35694
35695 After a new Exim process has interpreted its command line options, it changes
35696 uid and gid in the following cases:
35697
35698 .ilist
35699 .oindex "&%-C%&"
35700 .oindex "&%-D%&"
35701 If the &%-C%& option is used to specify an alternate configuration file, or if
35702 the &%-D%& option is used to define macro values for the configuration, and the
35703 calling process is not running as root, the uid and gid are changed to those of
35704 the calling process.
35705 However, if DISABLE_D_OPTION is defined in &_Local/Makefile_&, the &%-D%&
35706 option may not be used at all.
35707 If WHITELIST_D_MACROS is defined in &_Local/Makefile_&, then some macro values
35708 can be supplied if the calling process is running as root, the Exim run-time
35709 user or CONFIGURE_OWNER, if defined.
35710 .next
35711 .oindex "&%-be%&"
35712 .oindex "&%-bf%&"
35713 .oindex "&%-bF%&"
35714 If the expansion test option (&%-be%&) or one of the filter testing options
35715 (&%-bf%& or &%-bF%&) are used, the uid and gid are changed to those of the
35716 calling process.
35717 .next
35718 If the process is not a daemon process or a queue runner process or a delivery
35719 process or a process for testing address routing (started with &%-bt%&), the
35720 uid and gid are changed to the Exim user and group. This means that Exim always
35721 runs under its own uid and gid when receiving messages. This also applies when
35722 testing address verification
35723 .oindex "&%-bv%&"
35724 .oindex "&%-bh%&"
35725 (the &%-bv%& option) and testing incoming message policy controls (the &%-bh%&
35726 option).
35727 .next
35728 For a daemon, queue runner, delivery, or address testing process, the uid
35729 remains as root at this stage, but the gid is changed to the Exim group.
35730 .endlist
35731
35732 The processes that initially retain root privilege behave as follows:
35733
35734 .ilist
35735 A daemon process changes the gid to the Exim group and the uid to the Exim
35736 user after setting up one or more listening sockets. The &[initgroups()]&
35737 function is called, so that if the Exim user is in any additional groups, they
35738 will be used during message reception.
35739 .next
35740 A queue runner process retains root privilege throughout its execution. Its
35741 job is to fork a controlled sequence of delivery processes.
35742 .next
35743 A delivery process retains root privilege throughout most of its execution,
35744 but any actual deliveries (that is, the transports themselves) are run in
35745 subprocesses which always change to a non-root uid and gid. For local
35746 deliveries this is typically the uid and gid of the owner of the mailbox; for
35747 remote deliveries, the Exim uid and gid are used. Once all the delivery
35748 subprocesses have been run, a delivery process changes to the Exim uid and gid
35749 while doing post-delivery tidying up such as updating the retry database and
35750 generating bounce and warning messages.
35751
35752 While the recipient addresses in a message are being routed, the delivery
35753 process runs as root. However, if a user's filter file has to be processed,
35754 this is done in a subprocess that runs under the individual user's uid and
35755 gid. A system filter is run as root unless &%system_filter_user%& is set.
35756 .next
35757 A process that is testing addresses (the &%-bt%& option) runs as root so that
35758 the routing is done in the same environment as a message delivery.
35759 .endlist
35760
35761
35762
35763
35764 .section "Running Exim without privilege" "SECTrunexiwitpri"
35765 .cindex "privilege, running without"
35766 .cindex "unprivileged running"
35767 .cindex "root privilege" "running without"
35768 Some installations like to run Exim in an unprivileged state for more of its
35769 operation, for added security. Support for this mode of operation is provided
35770 by the global option &%deliver_drop_privilege%&. When this is set, the uid and
35771 gid are changed to the Exim user and group at the start of a delivery process
35772 (and also queue runner and address testing processes). This means that address
35773 routing is no longer run as root, and the deliveries themselves cannot change
35774 to any other uid.
35775
35776 .cindex SIGHUP
35777 .cindex "daemon" "restarting"
35778 Leaving the binary setuid to root, but setting &%deliver_drop_privilege%& means
35779 that the daemon can still be started in the usual way, and it can respond
35780 correctly to SIGHUP because the re-invocation regains root privilege.
35781
35782 An alternative approach is to make Exim setuid to the Exim user and also setgid
35783 to the Exim group. If you do this, the daemon must be started from a root
35784 process. (Calling Exim from a root process makes it behave in the way it does
35785 when it is setuid root.) However, the daemon cannot restart itself after a
35786 SIGHUP signal because it cannot regain privilege.
35787
35788 It is still useful to set &%deliver_drop_privilege%& in this case, because it
35789 stops Exim from trying to re-invoke itself to do a delivery after a message has
35790 been received. Such a re-invocation is a waste of resources because it has no
35791 effect.
35792
35793 If restarting the daemon is not an issue (for example, if &%mua_wrapper%& is
35794 set, or &'inetd'& is being used instead of a daemon), having the binary setuid
35795 to the Exim user seems a clean approach, but there is one complication:
35796
35797 In this style of operation, Exim is running with the real uid and gid set to
35798 those of the calling process, and the effective uid/gid set to Exim's values.
35799 Ideally, any association with the calling process' uid/gid should be dropped,
35800 that is, the real uid/gid should be reset to the effective values so as to
35801 discard any privileges that the caller may have. While some operating systems
35802 have a function that permits this action for a non-root effective uid, quite a
35803 number of them do not. Because of this lack of standardization, Exim does not
35804 address this problem at this time.
35805
35806 For this reason, the recommended approach for &"mostly unprivileged"& running
35807 is to keep the Exim binary setuid to root, and to set
35808 &%deliver_drop_privilege%&. This also has the advantage of allowing a daemon to
35809 be used in the most straightforward way.
35810
35811 If you configure Exim not to run delivery processes as root, there are a
35812 number of restrictions on what you can do:
35813
35814 .ilist
35815 You can deliver only as the Exim user/group. You should  explicitly use the
35816 &%user%& and &%group%& options to override routers or local transports that
35817 normally deliver as the recipient. This makes sure that configurations that
35818 work in this mode function the same way in normal mode. Any implicit or
35819 explicit specification of another user causes an error.
35820 .next
35821 Use of &_.forward_& files is severely restricted, such that it is usually
35822 not worthwhile to include them in the configuration.
35823 .next
35824 Users who wish to use &_.forward_& would have to make their home directory and
35825 the file itself accessible to the Exim user. Pipe and append-to-file entries,
35826 and their equivalents in Exim filters, cannot be used. While they could be
35827 enabled in the Exim user's name, that would be insecure and not very useful.
35828 .next
35829 Unless the local user mailboxes are all owned by the Exim user (possible in
35830 some POP3 or IMAP-only environments):
35831
35832 .olist
35833 They must be owned by the Exim group and be writeable by that group. This
35834 implies you must set &%mode%& in the appendfile configuration, as well as the
35835 mode of the mailbox files themselves.
35836 .next
35837 You must set &%no_check_owner%&, since most or all of the files will not be
35838 owned by the Exim user.
35839 .next
35840 You must set &%file_must_exist%&, because Exim cannot set the owner correctly
35841 on a newly created mailbox when unprivileged. This also implies that new
35842 mailboxes need to be created manually.
35843 .endlist olist
35844 .endlist ilist
35845
35846
35847 These restrictions severely restrict what can be done in local deliveries.
35848 However, there are no restrictions on remote deliveries. If you are running a
35849 gateway host that does no local deliveries, setting &%deliver_drop_privilege%&
35850 gives more security at essentially no cost.
35851
35852 If you are using the &%mua_wrapper%& facility (see chapter
35853 &<<CHAPnonqueueing>>&), &%deliver_drop_privilege%& is forced to be true.
35854
35855
35856
35857
35858 .section "Delivering to local files" "SECID271"
35859 Full details of the checks applied by &(appendfile)& before it writes to a file
35860 are given in chapter &<<CHAPappendfile>>&.
35861
35862
35863
35864 .new
35865 .section "Running local commands" "SECTsecconslocalcmds"
35866 There are a number of ways in which an administrator can configure Exim to run
35867 commands based upon received, untrustworthy, data. Further, in some
35868 configurations a user who can control a &_.forward_& file can also arrange to
35869 run commands. Configuration to check includes, but is not limited to:
35870
35871 .ilist
35872 Use of &%use_shell%& in the pipe transport: various forms of shell command
35873 injection may be possible with this option present. It is dangerous and should
35874 be used only with considerable caution. Consider constraints which whitelist
35875 allowed characters in a variable which is to be used in a pipe transport that
35876 has &%use_shell%& enabled.
35877 .next
35878 A number of options such as &%forbid_filter_run%&, &%forbid_filter_perl%&,
35879 &%forbid_filter_dlfunc%& and so forth which restrict facilities available to
35880 &_.forward_& files in a redirect router. If Exim is running on a central mail
35881 hub to which ordinary users do not have shell access, but home directories are
35882 NFS mounted (for instance) then administrators should review the list of these
35883 forbid options available, and should bear in mind that the options that may
35884 need forbidding can change as new features are added between releases.
35885 .next
35886 The &%${run...}%& expansion item does not use a shell by default, but
35887 administrators can configure use of &_/bin/sh_& as part of the command.
35888 Such invocations should be viewed with prejudicial suspicion.
35889 .next
35890 Administrators who use embedded Perl are advised to explore how Perl's
35891 taint checking might apply to their usage.
35892 .next
35893 Use of &%${expand...}%& is somewhat analagous to shell's eval builtin and
35894 administrators are well advised to view its use with suspicion, in case (for
35895 instance) it allows a local-part to contain embedded Exim directives.
35896 .next
35897 Use of &%${match_local_part...}%& and friends becomes more dangerous if
35898 Exim was built with EXPAND_LISTMATCH_RHS defined: the second string in
35899 each can reference arbitrary lists and files, rather than just being a list
35900 of opaque strings.
35901 The EXPAND_LISTMATCH_RHS option was added and set false by default because of
35902 real-world security vulnerabilities caused by its use with untrustworthy data
35903 injected in, for SQL injection attacks.
35904 Consider the use of the &%inlisti%& expansion condition instead.
35905 .endlist
35906 .wen
35907
35908
35909
35910 .section "IPv4 source routing" "SECID272"
35911 .cindex "source routing" "in IP packets"
35912 .cindex "IP source routing"
35913 Many operating systems suppress IP source-routed packets in the kernel, but
35914 some cannot be made to do this, so Exim does its own check. It logs incoming
35915 IPv4 source-routed TCP calls, and then drops them. Things are all different in
35916 IPv6. No special checking is currently done.
35917
35918
35919
35920 .section "The VRFY, EXPN, and ETRN commands in SMTP" "SECID273"
35921 Support for these SMTP commands is disabled by default. If required, they can
35922 be enabled by defining suitable ACLs.
35923
35924
35925
35926
35927 .section "Privileged users" "SECID274"
35928 .cindex "trusted users"
35929 .cindex "admin user"
35930 .cindex "privileged user"
35931 .cindex "user" "trusted"
35932 .cindex "user" "admin"
35933 Exim recognizes two sets of users with special privileges. Trusted users are
35934 able to submit new messages to Exim locally, but supply their own sender
35935 addresses and information about a sending host. For other users submitting
35936 local messages, Exim sets up the sender address from the uid, and doesn't
35937 permit a remote host to be specified.
35938
35939 .oindex "&%-f%&"
35940 However, an untrusted user is permitted to use the &%-f%& command line option
35941 in the special form &%-f <>%& to indicate that a delivery failure for the
35942 message should not cause an error report. This affects the message's envelope,
35943 but it does not affect the &'Sender:'& header. Untrusted users may also be
35944 permitted to use specific forms of address with the &%-f%& option by setting
35945 the &%untrusted_set_sender%& option.
35946
35947 Trusted users are used to run processes that receive mail messages from some
35948 other mail domain and pass them on to Exim for delivery either locally, or over
35949 the Internet. Exim trusts a caller that is running as root, as the Exim user,
35950 as any user listed in the &%trusted_users%& configuration option, or under any
35951 group listed in the &%trusted_groups%& option.
35952
35953 Admin users are permitted to do things to the messages on Exim's queue. They
35954 can freeze or thaw messages, cause them to be returned to their senders, remove
35955 them entirely, or modify them in various ways. In addition, admin users can run
35956 the Exim monitor and see all the information it is capable of providing, which
35957 includes the contents of files on the spool.
35958
35959 .oindex "&%-M%&"
35960 .oindex "&%-q%&"
35961 By default, the use of the &%-M%& and &%-q%& options to cause Exim to attempt
35962 delivery of messages on its queue is restricted to admin users. This
35963 restriction can be relaxed by setting the &%no_prod_requires_admin%& option.
35964 Similarly, the use of &%-bp%& (and its variants) to list the contents of the
35965 queue is also restricted to admin users. This restriction can be relaxed by
35966 setting &%no_queue_list_requires_admin%&.
35967
35968 Exim recognizes an admin user if the calling process is running as root or as
35969 the Exim user or if any of the groups associated with the calling process is
35970 the Exim group. It is not necessary actually to be running under the Exim
35971 group. However, if admin users who are not root or the Exim user are to access
35972 the contents of files on the spool via the Exim monitor (which runs
35973 unprivileged), Exim must be built to allow group read access to its spool
35974 files.
35975
35976
35977
35978 .section "Spool files" "SECID275"
35979 .cindex "spool directory" "files"
35980 Exim's spool directory and everything it contains is owned by the Exim user and
35981 set to the Exim group. The mode for spool files is defined in the
35982 &_Local/Makefile_& configuration file, and defaults to 0640. This means that
35983 any user who is a member of the Exim group can access these files.
35984
35985
35986
35987 .section "Use of argv[0]" "SECID276"
35988 Exim examines the last component of &%argv[0]%&, and if it matches one of a set
35989 of specific strings, Exim assumes certain options. For example, calling Exim
35990 with the last component of &%argv[0]%& set to &"rsmtp"& is exactly equivalent
35991 to calling it with the option &%-bS%&. There are no security implications in
35992 this.
35993
35994
35995
35996 .section "Use of %f formatting" "SECID277"
35997 The only use made of &"%f"& by Exim is in formatting load average values. These
35998 are actually stored in integer variables as 1000 times the load average.
35999 Consequently, their range is limited and so therefore is the length of the
36000 converted output.
36001
36002
36003
36004 .section "Embedded Exim path" "SECID278"
36005 Exim uses its own path name, which is embedded in the code, only when it needs
36006 to re-exec in order to regain root privilege. Therefore, it is not root when it
36007 does so. If some bug allowed the path to get overwritten, it would lead to an
36008 arbitrary program's being run as exim, not as root.
36009
36010
36011
36012 .section "Dynamic module directory" "SECTdynmoddir"
36013 Any dynamically loadable modules must be installed into the directory
36014 defined in &`LOOKUP_MODULE_DIR`& in &_Local/Makefile_& for Exim to permit
36015 loading it.
36016
36017
36018 .section "Use of sprintf()" "SECID279"
36019 .cindex "&[sprintf()]&"
36020 A large number of occurrences of &"sprintf"& in the code are actually calls to
36021 &'string_sprintf()'&, a function that returns the result in malloc'd store.
36022 The intermediate formatting is done into a large fixed buffer by a function
36023 that runs through the format string itself, and checks the length of each
36024 conversion before performing it, thus preventing buffer overruns.
36025
36026 The remaining uses of &[sprintf()]& happen in controlled circumstances where
36027 the output buffer is known to be sufficiently long to contain the converted
36028 string.
36029
36030
36031
36032 .section "Use of debug_printf() and log_write()" "SECID280"
36033 Arbitrary strings are passed to both these functions, but they do their
36034 formatting by calling the function &'string_vformat()'&, which runs through
36035 the format string itself, and checks the length of each conversion.
36036
36037
36038
36039 .section "Use of strcat() and strcpy()" "SECID281"
36040 These are used only in cases where the output buffer is known to be large
36041 enough to hold the result.
36042 .ecindex IIDsecurcon
36043
36044
36045
36046
36047 . ////////////////////////////////////////////////////////////////////////////
36048 . ////////////////////////////////////////////////////////////////////////////
36049
36050 .chapter "Format of spool files" "CHAPspool"
36051 .scindex IIDforspo1 "format" "spool files"
36052 .scindex IIDforspo2 "spool directory" "format of files"
36053 .scindex IIDforspo3 "spool files" "format of"
36054 .cindex "spool files" "editing"
36055 A message on Exim's queue consists of two files, whose names are the message id
36056 followed by -D and -H, respectively. The data portion of the message is kept in
36057 the -D file on its own. The message's envelope, status, and headers are all
36058 kept in the -H file, whose format is described in this chapter. Each of these
36059 two files contains the final component of its own name as its first line. This
36060 is insurance against disk crashes where the directory is lost but the files
36061 themselves are recoverable.
36062
36063 Some people are tempted into editing -D files in order to modify messages. You
36064 need to be extremely careful if you do this; it is not recommended and you are
36065 on your own if you do it. Here are some of the pitfalls:
36066
36067 .ilist
36068 You must ensure that Exim does not try to deliver the message while you are
36069 fiddling with it. The safest way is to take out a write lock on the -D file,
36070 which is what Exim itself does, using &[fcntl()]&. If you update the file in
36071 place, the lock will be retained. If you write a new file and rename it, the
36072 lock will be lost at the instant of rename.
36073 .next
36074 .vindex "&$body_linecount$&"
36075 If you change the number of lines in the file, the value of
36076 &$body_linecount$&, which is stored in the -H file, will be incorrect. At
36077 present, this value is not used by Exim, but there is no guarantee that this
36078 will always be the case.
36079 .next
36080 If the message is in MIME format, you must take care not to break it.
36081 .next
36082 If the message is cryptographically signed, any change will invalidate the
36083 signature.
36084 .endlist
36085 All in all, modifying -D files is fraught with danger.
36086
36087 Files whose names end with -J may also be seen in the &_input_& directory (or
36088 its subdirectories when &%split_spool_directory%& is set). These are journal
36089 files, used to record addresses to which the message has been delivered during
36090 the course of a delivery attempt. If there are still undelivered recipients at
36091 the end, the -H file is updated, and the -J file is deleted. If, however, there
36092 is some kind of crash (for example, a power outage) before this happens, the -J
36093 file remains in existence. When Exim next processes the message, it notices the
36094 -J file and uses it to update the -H file before starting the next delivery
36095 attempt.
36096
36097 .section "Format of the -H file" "SECID282"
36098 .cindex "uid (user id)" "in spool file"
36099 .cindex "gid (group id)" "in spool file"
36100 The second line of the -H file contains the login name for the uid of the
36101 process that called Exim to read the message, followed by the numerical uid and
36102 gid. For a locally generated message, this is normally the user who sent the
36103 message. For a message received over TCP/IP via the daemon, it is
36104 normally the Exim user.
36105
36106 The third line of the file contains the address of the message's sender as
36107 transmitted in the envelope, contained in angle brackets. The sender address is
36108 empty for bounce messages. For incoming SMTP mail, the sender address is given
36109 in the MAIL command. For locally generated mail, the sender address is
36110 created by Exim from the login name of the current user and the configured
36111 &%qualify_domain%&. However, this can be overridden by the &%-f%& option or a
36112 leading &"From&~"& line if the caller is trusted, or if the supplied address is
36113 &"<>"& or an address that matches &%untrusted_set_senders%&.
36114
36115 The fourth line contains two numbers. The first is the time that the message
36116 was received, in the conventional Unix form &-- the number of seconds since the
36117 start of the epoch. The second number is a count of the number of messages
36118 warning of delayed delivery that have been sent to the sender.
36119
36120 There follow a number of lines starting with a hyphen. These can appear in any
36121 order, and are omitted when not relevant:
36122
36123 .vlist
36124 .vitem "&%-acl%&&~<&'number'&>&~<&'length'&>"
36125 This item is obsolete, and is not generated from Exim release 4.61 onwards;
36126 &%-aclc%& and &%-aclm%& are used instead. However, &%-acl%& is still
36127 recognized, to provide backward compatibility. In the old format, a line of
36128 this form is present for every ACL variable that is not empty. The number
36129 identifies the variable; the &%acl_c%&&*x*& variables are numbered 0&--9 and
36130 the &%acl_m%&&*x*& variables are numbered 10&--19. The length is the length of
36131 the data string for the variable. The string itself starts at the beginning of
36132 the next line, and is followed by a newline character. It may contain internal
36133 newlines.
36134
36135 .vitem "&%-aclc%&&~<&'rest-of-name'&>&~<&'length'&>"
36136 A line of this form is present for every ACL connection variable that is
36137 defined. Note that there is a space between &%-aclc%& and the rest of the name.
36138 The length is the length of the data string for the variable. The string itself
36139 starts at the beginning of the next line, and is followed by a newline
36140 character. It may contain internal newlines.
36141
36142 .vitem "&%-aclm%&&~<&'rest-of-name'&>&~<&'length'&>"
36143 A line of this form is present for every ACL message variable that is defined.
36144 Note that there is a space between &%-aclm%& and the rest of the name. The
36145 length is the length of the data string for the variable. The string itself
36146 starts at the beginning of the next line, and is followed by a newline
36147 character. It may contain internal newlines.
36148
36149 .vitem "&%-active_hostname%&&~<&'hostname'&>"
36150 This is present if, when the message was received over SMTP, the value of
36151 &$smtp_active_hostname$& was different to the value of &$primary_hostname$&.
36152
36153 .vitem &%-allow_unqualified_recipient%&
36154 This is present if unqualified recipient addresses are permitted in header
36155 lines (to stop such addresses from being qualified if rewriting occurs at
36156 transport time). Local messages that were input using &%-bnq%& and remote
36157 messages from hosts that match &%recipient_unqualified_hosts%& set this flag.
36158
36159 .vitem &%-allow_unqualified_sender%&
36160 This is present if unqualified sender addresses are permitted in header lines
36161 (to stop such addresses from being qualified if rewriting occurs at transport
36162 time). Local messages that were input using &%-bnq%& and remote messages from
36163 hosts that match &%sender_unqualified_hosts%& set this flag.
36164
36165 .vitem "&%-auth_id%&&~<&'text'&>"
36166 The id information for a message received on an authenticated SMTP connection
36167 &-- the value of the &$authenticated_id$& variable.
36168
36169 .vitem "&%-auth_sender%&&~<&'address'&>"
36170 The address of an authenticated sender &-- the value of the
36171 &$authenticated_sender$& variable.
36172
36173 .vitem "&%-body_linecount%&&~<&'number'&>"
36174 This records the number of lines in the body of the message, and is always
36175 present.
36176
36177 .vitem "&%-body_zerocount%&&~<&'number'&>"
36178 This records the number of binary zero bytes in the body of the message, and is
36179 present if the number is greater than zero.
36180
36181 .vitem &%-deliver_firsttime%&
36182 This is written when a new message is first added to the spool. When the spool
36183 file is updated after a deferral, it is omitted.
36184
36185 .vitem "&%-frozen%&&~<&'time'&>"
36186 .cindex "frozen messages" "spool data"
36187 The message is frozen, and the freezing happened at <&'time'&>.
36188
36189 .vitem "&%-helo_name%&&~<&'text'&>"
36190 This records the host name as specified by a remote host in a HELO or EHLO
36191 command.
36192
36193 .vitem "&%-host_address%&&~<&'address'&>.<&'port'&>"
36194 This records the IP address of the host from which the message was received and
36195 the remote port number that was used. It is omitted for locally generated
36196 messages.
36197
36198 .vitem "&%-host_auth%&&~<&'text'&>"
36199 If the message was received on an authenticated SMTP connection, this records
36200 the name of the authenticator &-- the value of the
36201 &$sender_host_authenticated$& variable.
36202
36203 .vitem &%-host_lookup_failed%&
36204 This is present if an attempt to look up the sending host's name from its IP
36205 address failed. It corresponds to the &$host_lookup_failed$& variable.
36206
36207 .vitem "&%-host_name%&&~<&'text'&>"
36208 .cindex "reverse DNS lookup"
36209 .cindex "DNS" "reverse lookup"
36210 This records the name of the remote host from which the message was received,
36211 if the host name was looked up from the IP address when the message was being
36212 received. It is not present if no reverse lookup was done.
36213
36214 .vitem "&%-ident%&&~<&'text'&>"
36215 For locally submitted messages, this records the login of the originating user,
36216 unless it was a trusted user and the &%-oMt%& option was used to specify an
36217 ident value. For messages received over TCP/IP, this records the ident string
36218 supplied by the remote host, if any.
36219
36220 .vitem "&%-interface_address%&&~<&'address'&>.<&'port'&>"
36221 This records the IP address of the local interface and the port number through
36222 which a message was received from a remote host. It is omitted for locally
36223 generated messages.
36224
36225 .vitem &%-local%&
36226 The message is from a local sender.
36227
36228 .vitem &%-localerror%&
36229 The message is a locally-generated bounce message.
36230
36231 .vitem "&%-local_scan%&&~<&'string'&>"
36232 This records the data string that was returned by the &[local_scan()]& function
36233 when the message was received &-- the value of the &$local_scan_data$&
36234 variable. It is omitted if no data was returned.
36235
36236 .vitem &%-manual_thaw%&
36237 The message was frozen but has been thawed manually, that is, by an explicit
36238 Exim command rather than via the auto-thaw process.
36239
36240 .vitem &%-N%&
36241 A testing delivery process was started using the &%-N%& option to suppress any
36242 actual deliveries, but delivery was deferred. At any further delivery attempts,
36243 &%-N%& is assumed.
36244
36245 .vitem &%-received_protocol%&
36246 This records the value of the &$received_protocol$& variable, which contains
36247 the name of the protocol by which the message was received.
36248
36249 .vitem &%-sender_set_untrusted%&
36250 The envelope sender of this message was set by an untrusted local caller (used
36251 to ensure that the caller is displayed in queue listings).
36252
36253 .vitem "&%-spam_score_int%&&~<&'number'&>"
36254 If a message was scanned by SpamAssassin, this is present. It records the value
36255 of &$spam_score_int$&.
36256
36257 .vitem &%-tls_certificate_verified%&
36258 A TLS certificate was received from the client that sent this message, and the
36259 certificate was verified by the server.
36260
36261 .vitem "&%-tls_cipher%&&~<&'cipher name'&>"
36262 When the message was received over an encrypted connection, this records the
36263 name of the cipher suite that was used.
36264
36265 .vitem "&%-tls_peerdn%&&~<&'peer DN'&>"
36266 When the message was received over an encrypted connection, and a certificate
36267 was received from the client, this records the Distinguished Name from that
36268 certificate.
36269 .endlist
36270
36271 Following the options there is a list of those addresses to which the message
36272 is not to be delivered. This set of addresses is initialized from the command
36273 line when the &%-t%& option is used and &%extract_addresses_remove_arguments%&
36274 is set; otherwise it starts out empty. Whenever a successful delivery is made,
36275 the address is added to this set. The addresses are kept internally as a
36276 balanced binary tree, and it is a representation of that tree which is written
36277 to the spool file. If an address is expanded via an alias or forward file, the
36278 original address is added to the tree when deliveries to all its child
36279 addresses are complete.
36280
36281 If the tree is empty, there is a single line in the spool file containing just
36282 the text &"XX"&. Otherwise, each line consists of two letters, which are either
36283 Y or N, followed by an address. The address is the value for the node of the
36284 tree, and the letters indicate whether the node has a left branch and/or a
36285 right branch attached to it, respectively. If branches exist, they immediately
36286 follow. Here is an example of a three-node tree:
36287 .code
36288 YY darcy@austen.fict.example
36289 NN alice@wonderland.fict.example
36290 NN editor@thesaurus.ref.example
36291 .endd
36292 After the non-recipients tree, there is a list of the message's recipients.
36293 This is a simple list, preceded by a count. It includes all the original
36294 recipients of the message, including those to whom the message has already been
36295 delivered. In the simplest case, the list contains one address per line. For
36296 example:
36297 .code
36298 4
36299 editor@thesaurus.ref.example
36300 darcy@austen.fict.example
36301 rdo@foundation
36302 alice@wonderland.fict.example
36303 .endd
36304 However, when a child address has been added to the top-level addresses as a
36305 result of the use of the &%one_time%& option on a &(redirect)& router, each
36306 line is of the following form:
36307 .display
36308 <&'top-level address'&> <&'errors_to address'&> &&&
36309   <&'length'&>,<&'parent number'&>#<&'flag bits'&>
36310 .endd
36311 The 01 flag bit indicates the presence of the three other fields that follow
36312 the top-level address. Other bits may be used in future to support additional
36313 fields. The <&'parent number'&> is the offset in the recipients list of the
36314 original parent of the &"one time"& address. The first two fields are the
36315 envelope sender that is associated with this address and its length. If the
36316 length is zero, there is no special envelope sender (there are then two space
36317 characters in the line). A non-empty field can arise from a &(redirect)& router
36318 that has an &%errors_to%& setting.
36319
36320
36321 A blank line separates the envelope and status information from the headers
36322 which follow. A header may occupy several lines of the file, and to save effort
36323 when reading it in, each header is preceded by a number and an identifying
36324 character. The number is the number of characters in the header, including any
36325 embedded newlines and the terminating newline. The character is one of the
36326 following:
36327
36328 .table2 50pt
36329 .row <&'blank'&>         "header in which Exim has no special interest"
36330 .row &`B`&               "&'Bcc:'& header"
36331 .row &`C`&               "&'Cc:'& header"
36332 .row &`F`&               "&'From:'& header"
36333 .row &`I`&               "&'Message-id:'& header"
36334 .row &`P`&               "&'Received:'& header &-- P for &""postmark""&"
36335 .row &`R`&               "&'Reply-To:'& header"
36336 .row &`S`&               "&'Sender:'& header"
36337 .row &`T`&               "&'To:'& header"
36338 .row &`*`&               "replaced or deleted header"
36339 .endtable
36340
36341 Deleted or replaced (rewritten) headers remain in the spool file for debugging
36342 purposes. They are not transmitted when the message is delivered. Here is a
36343 typical set of headers:
36344 .code
36345 111P Received: by hobbit.fict.example with local (Exim 4.00)
36346 id 14y9EI-00026G-00; Fri, 11 May 2001 10:28:59 +0100
36347 049  Message-Id: <E14y9EI-00026G-00@hobbit.fict.example>
36348 038* X-rewrote-sender: bb@hobbit.fict.example
36349 042* From: Bilbo Baggins <bb@hobbit.fict.example>
36350 049F From: Bilbo Baggins <B.Baggins@hobbit.fict.example>
36351 099* To: alice@wonderland.fict.example, rdo@foundation,
36352 darcy@austen.fict.example, editor@thesaurus.ref.example
36353 104T To: alice@wonderland.fict.example, rdo@foundation.example,
36354 darcy@austen.fict.example, editor@thesaurus.ref.example
36355 038  Date: Fri, 11 May 2001 10:28:59 +0100
36356 .endd
36357 The asterisked headers indicate that the envelope sender, &'From:'& header, and
36358 &'To:'& header have been rewritten, the last one because routing expanded the
36359 unqualified domain &'foundation'&.
36360 .ecindex IIDforspo1
36361 .ecindex IIDforspo2
36362 .ecindex IIDforspo3
36363
36364 . ////////////////////////////////////////////////////////////////////////////
36365 . ////////////////////////////////////////////////////////////////////////////
36366
36367 .chapter "Support for DKIM (DomainKeys Identified Mail)" "CHAPdkim" &&&
36368          "DKIM Support"
36369 .cindex "DKIM"
36370
36371 DKIM is a mechanism by which messages sent by some entity can be provably
36372 linked to a domain which that entity controls.  It permits reputation to
36373 be tracked on a per-domain basis, rather than merely upon source IP address.
36374 DKIM is documented in RFC 4871.
36375
36376 Since version 4.70, DKIM support is compiled into Exim by default. It can be
36377 disabled by setting DISABLE_DKIM=yes in Local/Makefile.
36378
36379 Exim's DKIM implementation allows to
36380 .olist
36381 Sign outgoing messages: This function is implemented in the SMTP transport.
36382 It can co-exist with all other Exim features, including transport filters.
36383 .next
36384 Verify signatures in incoming messages: This is implemented by an additional
36385 ACL (acl_smtp_dkim), which can be called several times per message, with
36386 different signature contexts.
36387 .endlist
36388
36389 In typical Exim style, the verification implementation does not include any
36390 default "policy". Instead it enables you to build your own policy using
36391 Exim's standard controls.
36392
36393 Please note that verification of DKIM signatures in incoming mail is turned
36394 on by default for logging purposes. For each signature in incoming email,
36395 exim will log a line displaying the most important signature details, and the
36396 signature status. Here is an example (with line-breaks added for clarity):
36397 .code
36398 2009-09-09 10:22:28 1MlIRf-0003LU-U3 DKIM:
36399     d=facebookmail.com s=q1-2009b
36400     c=relaxed/relaxed a=rsa-sha1
36401     i=@facebookmail.com t=1252484542 [verification succeeded]
36402 .endd
36403 You might want to turn off DKIM verification processing entirely for internal
36404 or relay mail sources. To do that, set the &%dkim_disable_verify%& ACL
36405 control modifier. This should typically be done in the RCPT ACL, at points
36406 where you accept mail from relay sources (internal hosts or authenticated
36407 senders).
36408
36409
36410 .section "Signing outgoing messages" "SECID513"
36411 .cindex "DKIM" "signing"
36412
36413 Signing is implemented by setting private options on the SMTP transport.
36414 These options take (expandable) strings as arguments.
36415
36416 .option dkim_domain smtp string&!! unset
36417 MANDATORY:
36418 The domain you want to sign with. The result of this expanded
36419 option is put into the &%$dkim_domain%& expansion variable.
36420
36421 .option dkim_selector smtp string&!! unset
36422 MANDATORY:
36423 This sets the key selector string. You can use the &%$dkim_domain%& expansion
36424 variable to look up a matching selector. The result is put in the expansion
36425 variable &%$dkim_selector%& which should be used in the &%dkim_private_key%&
36426 option along with &%$dkim_domain%&.
36427
36428 .option dkim_private_key smtp string&!! unset
36429 MANDATORY:
36430 This sets the private key to use. You can use the &%$dkim_domain%& and
36431 &%$dkim_selector%& expansion variables to determine the private key to use.
36432 The result can either
36433 .ilist
36434 be a valid RSA private key in ASCII armor, including line breaks.
36435 .next
36436 start with a slash, in which case it is treated as a file that contains
36437 the private key.
36438 .next
36439 be "0", "false" or the empty string, in which case the message will not
36440 be signed. This case will not result in an error, even if &%dkim_strict%&
36441 is set.
36442 .endlist
36443
36444 .option dkim_canon smtp string&!! unset
36445 OPTIONAL:
36446 This option sets the canonicalization method used when signing a message.
36447 The DKIM RFC currently supports two methods: "simple" and "relaxed".
36448 The option defaults to "relaxed" when unset. Note: the current implementation
36449 only supports using the same canonicalization method for both headers and body.
36450
36451 .option dkim_strict smtp string&!! unset
36452 OPTIONAL:
36453 This  option  defines  how  Exim  behaves  when  signing a message that
36454 should be signed fails for some reason.  When the expansion evaluates to
36455 either "1" or "true", Exim will defer. Otherwise Exim will send the message
36456 unsigned. You can use the &%$dkim_domain%& and &%$dkim_selector%& expansion
36457 variables here.
36458
36459 .option dkim_sign_headers smtp string&!! unset
36460 OPTIONAL:
36461 When set, this option must expand to (or be specified as) a colon-separated
36462 list of header names. Headers with these names will be included in the message
36463 signature. When unspecified, the header names recommended in RFC4871 will be
36464 used.
36465
36466
36467 .section "Verifying DKIM signatures in incoming mail" "SECID514"
36468 .cindex "DKIM" "verification"
36469
36470 Verification of DKIM signatures in incoming email is implemented via the
36471 &%acl_smtp_dkim%& ACL. By default, this ACL is called once for each
36472 syntactically(!) correct signature in the incoming message.
36473
36474 To evaluate the signature in the ACL a large number of expansion variables
36475 containing the signature status and its details are set up during the
36476 runtime of the ACL.
36477
36478 Calling the ACL only for existing signatures is not sufficient to build
36479 more advanced policies. For that reason, the global option
36480 &%dkim_verify_signers%&, and a global expansion variable
36481 &%$dkim_signers%& exist.
36482
36483 The global option &%dkim_verify_signers%& can be set to a colon-separated
36484 list of DKIM domains or identities for which the ACL &%acl_smtp_dkim%& is
36485 called. It is expanded when the message has been received. At this point,
36486 the expansion variable &%$dkim_signers%& already contains a colon-separated
36487 list of signer domains and identities for the message. When
36488 &%dkim_verify_signers%& is not specified in the main configuration,
36489 it defaults as:
36490 .code
36491 dkim_verify_signers = $dkim_signers
36492 .endd
36493 This leads to the default behaviour of calling &%acl_smtp_dkim%& for each
36494 DKIM signature in the message. Current DKIM verifiers may want to explicitly
36495 call the ACL for known domains or identities. This would be achieved as follows:
36496 .code
36497 dkim_verify_signers = paypal.com:ebay.com:$dkim_signers
36498 .endd
36499 This would result in &%acl_smtp_dkim%& always being called for "paypal.com"
36500 and "ebay.com", plus all domains and identities that have signatures in the message.
36501 You can also be more creative in constructing your policy. For example:
36502 .code
36503 dkim_verify_signers = $sender_address_domain:$dkim_signers
36504 .endd
36505
36506 If a domain or identity is listed several times in the (expanded) value of
36507 &%dkim_verify_signers%&, the ACL is only called once for that domain or identity.
36508
36509
36510 Inside the &%acl_smtp_dkim%&, the following expansion variables are
36511 available (from most to least important):
36512
36513
36514 .vlist
36515 .vitem &%$dkim_cur_signer%&
36516 The signer that is being evaluated in this ACL run. This can be a domain or
36517 an identity. This is one of the list items from the expanded main option
36518 &%dkim_verify_signers%& (see above).
36519 .vitem &%$dkim_verify_status%&
36520 A string describing the general status of the signature. One of
36521 .ilist
36522 &%none%&: There is no signature in the message for the current domain or
36523 identity (as reflected by &%$dkim_cur_signer%&).
36524 .next
36525 &%invalid%&: The signature could not be verified due to a processing error.
36526 More detail is available in &%$dkim_verify_reason%&.
36527 .next
36528 &%fail%&: Verification of the signature failed.  More detail is
36529 available in &%$dkim_verify_reason%&.
36530 .next
36531 &%pass%&: The signature passed verification. It is valid.
36532 .endlist
36533 .vitem &%$dkim_verify_reason%&
36534 A string giving a litte bit more detail when &%$dkim_verify_status%& is either
36535 "fail" or "invalid". One of
36536 .ilist
36537 &%pubkey_unavailable%& (when &%$dkim_verify_status%&="invalid"): The public
36538 key for the domain could not be retrieved. This may be a temporary problem.
36539 .next
36540 &%pubkey_syntax%& (when &%$dkim_verify_status%&="invalid"): The public key
36541 record for the domain is syntactically invalid.
36542 .next
36543 &%bodyhash_mismatch%& (when &%$dkim_verify_status%&="fail"): The calculated
36544 body hash does not match the one specified in the signature header. This
36545 means that the message body was modified in transit.
36546 .next
36547 &%signature_incorrect%& (when &%$dkim_verify_status%&="fail"): The signature
36548 could not be verified. This may mean that headers were modified,
36549 re-written or otherwise changed in a way which is incompatible with
36550 DKIM verification. It may of course also mean that the signature is forged.
36551 .endlist
36552 .vitem &%$dkim_domain%&
36553 The signing domain. IMPORTANT: This variable is only populated if there is
36554 an actual signature in the message for the current domain or identity (as
36555 reflected by &%$dkim_cur_signer%&).
36556 .vitem &%$dkim_identity%&
36557 The signing identity, if present. IMPORTANT: This variable is only populated
36558 if there is an actual signature in the message for the current domain or
36559 identity (as reflected by &%$dkim_cur_signer%&).
36560 .vitem &%$dkim_selector%&
36561 The key record selector string.
36562 .vitem &%$dkim_algo%&
36563 The algorithm used. One of 'rsa-sha1' or 'rsa-sha256'.
36564 .vitem &%$dkim_canon_body%&
36565 The body canonicalization method. One of 'relaxed' or 'simple'.
36566 .vitem &%dkim_canon_headers%&
36567 The header canonicalization method. One of 'relaxed' or 'simple'.
36568 .vitem &%$dkim_copiedheaders%&
36569 A transcript of headers and their values which are included in the signature
36570 (copied from the 'z=' tag of the signature).
36571 .vitem &%$dkim_bodylength%&
36572 The number of signed body bytes. If zero ("0"), the body is unsigned. If no
36573 limit was set by the signer, "9999999999999" is returned. This makes sure
36574 that this variable always expands to an integer value.
36575 .vitem &%$dkim_created%&
36576 UNIX timestamp reflecting the date and time when the signature was created.
36577 When this was not specified by the signer, "0" is returned.
36578 .vitem &%$dkim_expires%&
36579 UNIX timestamp reflecting the date and time when the signer wants the
36580 signature to be treated as "expired". When this was not specified by the
36581 signer, "9999999999999" is returned. This makes it possible to do useful
36582 integer size comparisons against this value.
36583 .vitem &%$dkim_headernames%&
36584 A colon-separated list of names of headers included in the signature.
36585 .vitem &%$dkim_key_testing%&
36586 "1" if the key record has the "testing" flag set, "0" if not.
36587 .vitem &%$dkim_key_nosubdomains%&
36588 "1" if the key record forbids subdomaining, "0" otherwise.
36589 .vitem &%$dkim_key_srvtype%&
36590 Service type (tag s=) from the key record. Defaults to "*" if not specified
36591 in the key record.
36592 .vitem &%$dkim_key_granularity%&
36593 Key granularity (tag g=) from the key record. Defaults to "*" if not specified
36594 in the key record.
36595 .vitem &%$dkim_key_notes%&
36596 Notes from the key record (tag n=).
36597 .endlist
36598
36599 In addition, two ACL conditions are provided:
36600
36601 .vlist
36602 .vitem &%dkim_signers%&
36603 ACL condition that checks a colon-separated list of domains or identities
36604 for a match against the domain or identity that the ACL is currently verifying
36605 (reflected by &%$dkim_cur_signer%&). This is typically used to restrict an ACL
36606 verb to a group of domains or identities. For example:
36607
36608 .code
36609 # Warn when Mail purportedly from GMail has no signature at all
36610 warn log_message = GMail sender without DKIM signature
36611      sender_domains = gmail.com
36612      dkim_signers = gmail.com
36613      dkim_status = none
36614 .endd
36615
36616 .vitem &%dkim_status%&
36617 ACL condition that checks a colon-separated list of possible DKIM verification
36618 results against the actual result of verification. This is typically used
36619 to restrict an ACL verb to a list of verification outcomes, for example:
36620
36621 .code
36622 deny message = Mail from Paypal with invalid/missing signature
36623      sender_domains = paypal.com:paypal.de
36624      dkim_signers = paypal.com:paypal.de
36625      dkim_status = none:invalid:fail
36626 .endd
36627
36628 The possible status keywords are: 'none','invalid','fail' and 'pass'. Please
36629 see the documentation of the &%$dkim_verify_status%& expansion variable above
36630 for more information of what they mean.
36631 .endlist
36632
36633 . ////////////////////////////////////////////////////////////////////////////
36634 . ////////////////////////////////////////////////////////////////////////////
36635
36636 .chapter "Adding new drivers or lookup types" "CHID13" &&&
36637          "Adding drivers or lookups"
36638 .cindex "adding drivers"
36639 .cindex "new drivers, adding"
36640 .cindex "drivers" "adding new"
36641 The following actions have to be taken in order to add a new router, transport,
36642 authenticator, or lookup type to Exim:
36643
36644 .olist
36645 Choose a name for the driver or lookup type that does not conflict with any
36646 existing name; I will use &"newdriver"& in what follows.
36647 .next
36648 Add to &_src/EDITME_& the line:
36649 .display
36650 <&'type'&>&`_NEWDRIVER=yes`&
36651 .endd
36652 where <&'type'&> is ROUTER, TRANSPORT, AUTH, or LOOKUP. If the
36653 code is not to be included in the binary by default, comment this line out. You
36654 should also add any relevant comments about the driver or lookup type.
36655 .next
36656 Add to &_src/config.h.defaults_& the line:
36657 .code
36658 #define <type>_NEWDRIVER
36659 .endd
36660 .next
36661 Edit &_src/drtables.c_&, adding conditional code to pull in the private header
36662 and create a table entry as is done for all the other drivers and lookup types.
36663 .next
36664 .new
36665 Edit &_scripts/lookups-Makefile_& if this is a new lookup; there is a for-loop
36666 near the bottom, ranging the &`name_mod`& variable over a list of all lookups.
36667 Add your &`NEWDRIVER`& to that list.
36668 As long as the dynamic module would be named &_newdriver.so_&, you can use the
36669 simple form that most lookups have.
36670 .wen
36671 .next
36672 Edit &_Makefile_& in the appropriate sub-directory (&_src/routers_&,
36673 &_src/transports_&, &_src/auths_&, or &_src/lookups_&); add a line for the new
36674 driver or lookup type and add it to the definition of OBJ.
36675 .next
36676 Create &_newdriver.h_& and &_newdriver.c_& in the appropriate sub-directory of
36677 &_src_&.
36678 .next
36679 Edit &_scripts/MakeLinks_& and add commands to link the &_.h_& and &_.c_& files
36680 as for other drivers and lookups.
36681 .endlist
36682
36683 Then all you need to do is write the code! A good way to start is to make a
36684 proforma by copying an existing module of the same type, globally changing all
36685 occurrences of the name, and cutting out most of the code. Note that any
36686 options you create must be listed in alphabetical order, because the tables are
36687 searched using a binary chop procedure.
36688
36689 There is a &_README_& file in each of the sub-directories of &_src_& describing
36690 the interface that is expected.
36691
36692
36693
36694
36695 . ////////////////////////////////////////////////////////////////////////////
36696 . ////////////////////////////////////////////////////////////////////////////
36697
36698 . /////////////////////////////////////////////////////////////////////////////
36699 . These lines are processing instructions for the Simple DocBook Processor that
36700 . Philip Hazel has developed as a less cumbersome way of making PostScript and
36701 . PDFs than using xmlto and fop. They will be ignored by all other XML
36702 . processors.
36703 . /////////////////////////////////////////////////////////////////////////////
36704
36705 .literal xml
36706 <?sdop
36707   format="newpage"
36708   foot_right_recto="&chaptertitle;"
36709   foot_right_verso="&chaptertitle;"
36710 ?>
36711 .literal off
36712
36713 .makeindex "Options index"   "option"
36714 .makeindex "Variables index" "variable"
36715 .makeindex "Concept index"   "concept"
36716
36717
36718 . /////////////////////////////////////////////////////////////////////////////
36719 . /////////////////////////////////////////////////////////////////////////////