De-duplicate two documentation sections
[users/heiko/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 2014
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 Releases have also been authorized to be performed by Todd Lyons who signs with
557 key &'0xC4F4F94804D29EBA'&. A direct trust path exists between previous RE Phil
558 Pennock and Todd Lyons through a common associate.
559
560 The signatures for the tar bundles are in:
561 .display
562 &_exim-n.nn.tar.gz.asc_&
563 &_exim-n.nn.tar.bz2.asc_&
564 .endd
565 For each released version, the log of changes is made separately available in a
566 separate file in the directory &_ChangeLogs_& so that it is possible to
567 find out what has changed without having to download the entire distribution.
568
569 .cindex "documentation" "available formats"
570 The main distribution contains ASCII versions of this specification and other
571 documentation; other formats of the documents are available in separate files
572 inside the &_exim4_& directory of the FTP site:
573 .display
574 &_exim-html-n.nn.tar.gz_&
575 &_exim-pdf-n.nn.tar.gz_&
576 &_exim-postscript-n.nn.tar.gz_&
577 &_exim-texinfo-n.nn.tar.gz_&
578 .endd
579 These tar files contain only the &_doc_& directory, not the complete
580 distribution, and are also available in &_.bz2_& as well as &_.gz_& forms.
581
582
583 .section "Limitations" "SECID6"
584 .ilist
585 .cindex "limitations of Exim"
586 .cindex "bang paths" "not handled by Exim"
587 Exim is designed for use as an Internet MTA, and therefore handles addresses in
588 RFC 2822 domain format only. It cannot handle UUCP &"bang paths"&, though
589 simple two-component bang paths can be converted by a straightforward rewriting
590 configuration. This restriction does not prevent Exim from being interfaced to
591 UUCP as a transport mechanism, provided that domain addresses are used.
592 .next
593 .cindex "domainless addresses"
594 .cindex "address" "without domain"
595 Exim insists that every address it handles has a domain attached. For incoming
596 local messages, domainless addresses are automatically qualified with a
597 configured domain value. Configuration options specify from which remote
598 systems unqualified addresses are acceptable. These are then qualified on
599 arrival.
600 .next
601 .cindex "transport" "external"
602 .cindex "external transports"
603 The only external transport mechanisms that are currently implemented are SMTP
604 and LMTP over a TCP/IP network (including support for IPv6). However, a pipe
605 transport is available, and there are facilities for writing messages to files
606 and pipes, optionally in &'batched SMTP'& format; these facilities can be used
607 to send messages to other transport mechanisms such as UUCP, provided they can
608 handle domain-style addresses. Batched SMTP input is also catered for.
609 .next
610 Exim is not designed for storing mail for dial-in hosts. When the volumes of
611 such mail are large, it is better to get the messages &"delivered"& into files
612 (that is, off Exim's queue) and subsequently passed on to the dial-in hosts by
613 other means.
614 .next
615 Although Exim does have basic facilities for scanning incoming messages, these
616 are not comprehensive enough to do full virus or spam scanning. Such operations
617 are best carried out using additional specialized software packages. If you
618 compile Exim with the content-scanning extension, straightforward interfaces to
619 a number of common scanners are provided.
620 .endlist
621
622
623 .section "Run time configuration" "SECID7"
624 Exim's run time configuration is held in a single text file that is divided
625 into a number of sections. The entries in this file consist of keywords and
626 values, in the style of Smail 3 configuration files. A default configuration
627 file which is suitable for simple online installations is provided in the
628 distribution, and is described in chapter &<<CHAPdefconfil>>& below.
629
630
631 .section "Calling interface" "SECID8"
632 .cindex "Sendmail compatibility" "command line interface"
633 Like many MTAs, Exim has adopted the Sendmail command line interface so that it
634 can be a straight replacement for &_/usr/lib/sendmail_& or
635 &_/usr/sbin/sendmail_& when sending mail, but you do not need to know anything
636 about Sendmail in order to run Exim. For actions other than sending messages,
637 Sendmail-compatible options also exist, but those that produce output (for
638 example, &%-bp%&, which lists the messages on the queue) do so in Exim's own
639 format. There are also some additional options that are compatible with Smail
640 3, and some further options that are new to Exim. Chapter &<<CHAPcommandline>>&
641 documents all Exim's command line options. This information is automatically
642 made into the man page that forms part of the Exim distribution.
643
644 Control of messages on the queue can be done via certain privileged command
645 line options. There is also an optional monitor program called &'eximon'&,
646 which displays current information in an X window, and which contains a menu
647 interface to Exim's command line administration options.
648
649
650
651 .section "Terminology" "SECID9"
652 .cindex "terminology definitions"
653 .cindex "body of message" "definition of"
654 The &'body'& of a message is the actual data that the sender wants to transmit.
655 It is the last part of a message, and is separated from the &'header'& (see
656 below) by a blank line.
657
658 .cindex "bounce message" "definition of"
659 When a message cannot be delivered, it is normally returned to the sender in a
660 delivery failure message or a &"non-delivery report"& (NDR). The term
661 &'bounce'& is commonly used for this action, and the error reports are often
662 called &'bounce messages'&. This is a convenient shorthand for &"delivery
663 failure error report"&. Such messages have an empty sender address in the
664 message's &'envelope'& (see below) to ensure that they cannot themselves give
665 rise to further bounce messages.
666
667 The term &'default'& appears frequently in this manual. It is used to qualify a
668 value which is used in the absence of any setting in the configuration. It may
669 also qualify an action which is taken unless a configuration setting specifies
670 otherwise.
671
672 The term &'defer'& is used when the delivery of a message to a specific
673 destination cannot immediately take place for some reason (a remote host may be
674 down, or a user's local mailbox may be full). Such deliveries are &'deferred'&
675 until a later time.
676
677 The word &'domain'& is sometimes used to mean all but the first component of a
678 host's name. It is &'not'& used in that sense here, where it normally refers to
679 the part of an email address following the @ sign.
680
681 .cindex "envelope, definition of"
682 .cindex "sender" "definition of"
683 A message in transit has an associated &'envelope'&, as well as a header and a
684 body. The envelope contains a sender address (to which bounce messages should
685 be delivered), and any number of recipient addresses. References to the
686 sender or the recipients of a message usually mean the addresses in the
687 envelope. An MTA uses these addresses for delivery, and for returning bounce
688 messages, not the addresses that appear in the header lines.
689
690 .cindex "message" "header, definition of"
691 .cindex "header section" "definition of"
692 The &'header'& of a message is the first part of a message's text, consisting
693 of a number of lines, each of which has a name such as &'From:'&, &'To:'&,
694 &'Subject:'&, etc. Long header lines can be split over several text lines by
695 indenting the continuations. The header is separated from the body by a blank
696 line.
697
698 .cindex "local part" "definition of"
699 .cindex "domain" "definition of"
700 The term &'local part'&, which is taken from RFC 2822, is used to refer to that
701 part of an email address that precedes the @ sign. The part that follows the
702 @ sign is called the &'domain'& or &'mail domain'&.
703
704 .cindex "local delivery" "definition of"
705 .cindex "remote delivery, definition of"
706 The terms &'local delivery'& and &'remote delivery'& are used to distinguish
707 delivery to a file or a pipe on the local host from delivery by SMTP over
708 TCP/IP to another host. As far as Exim is concerned, all hosts other than the
709 host it is running on are &'remote'&.
710
711 .cindex "return path" "definition of"
712 &'Return path'& is another name that is used for the sender address in a
713 message's envelope.
714
715 .cindex "queue" "definition of"
716 The term &'queue'& is used to refer to the set of messages awaiting delivery,
717 because this term is in widespread use in the context of MTAs. However, in
718 Exim's case the reality is more like a pool than a queue, because there is
719 normally no ordering of waiting messages.
720
721 .cindex "queue runner" "definition of"
722 The term &'queue runner'& is used to describe a process that scans the queue
723 and attempts to deliver those messages whose retry times have come. This term
724 is used by other MTAs, and also relates to the command &%runq%&, but in Exim
725 the waiting messages are normally processed in an unpredictable order.
726
727 .cindex "spool directory" "definition of"
728 The term &'spool directory'& is used for a directory in which Exim keeps the
729 messages on its queue &-- that is, those that it is in the process of
730 delivering. This should not be confused with the directory in which local
731 mailboxes are stored, which is called a &"spool directory"& by some people. In
732 the Exim documentation, &"spool"& is always used in the first sense.
733
734
735
736
737
738
739 . ////////////////////////////////////////////////////////////////////////////
740 . ////////////////////////////////////////////////////////////////////////////
741
742 .chapter "Incorporated code" "CHID2"
743 .cindex "incorporated code"
744 .cindex "regular expressions" "library"
745 .cindex "PCRE"
746 .cindex "OpenDMARC"
747 A number of pieces of external code are included in the Exim distribution.
748
749 .ilist
750 Regular expressions are supported in the main Exim program and in the
751 Exim monitor using the freely-distributable PCRE library, copyright
752 &copy; University of Cambridge. The source to PCRE is no longer shipped with
753 Exim, so you will need to use the version of PCRE shipped with your system,
754 or obtain and install the full version of the library from
755 &url(ftp://ftp.csx.cam.ac.uk/pub/software/programming/pcre).
756 .next
757 .cindex "cdb" "acknowledgment"
758 Support for the cdb (Constant DataBase) lookup method is provided by code
759 contributed by Nigel Metheringham of (at the time he contributed it) Planet
760 Online Ltd. The implementation is completely contained within the code of Exim.
761 It does not link against an external cdb library. The code contains the
762 following statements:
763
764 .blockquote
765 Copyright &copy; 1998 Nigel Metheringham, Planet Online Ltd
766
767 This program is free software; you can redistribute it and/or modify it under
768 the terms of the GNU General Public License as published by the Free Software
769 Foundation; either version 2 of the License, or (at your option) any later
770 version.
771 This code implements Dan Bernstein's Constant DataBase (cdb) spec. Information,
772 the spec and sample code for cdb can be obtained from
773 &url(http://www.pobox.com/~djb/cdb.html). This implementation borrows
774 some code from Dan Bernstein's implementation (which has no license
775 restrictions applied to it).
776 .endblockquote
777 .next
778 .cindex "SPA authentication"
779 .cindex "Samba project"
780 .cindex "Microsoft Secure Password Authentication"
781 Client support for Microsoft's &'Secure Password Authentication'& is provided
782 by code contributed by Marc Prud'hommeaux. Server support was contributed by
783 Tom Kistner. This includes code taken from the Samba project, which is released
784 under the Gnu GPL.
785 .next
786 .cindex "Cyrus"
787 .cindex "&'pwcheck'& daemon"
788 .cindex "&'pwauthd'& daemon"
789 Support for calling the Cyrus &'pwcheck'& and &'saslauthd'& daemons is provided
790 by code taken from the Cyrus-SASL library and adapted by Alexander S.
791 Sabourenkov. The permission notice appears below, in accordance with the
792 conditions expressed therein.
793
794 .blockquote
795 Copyright &copy; 2001 Carnegie Mellon University.  All rights reserved.
796
797 Redistribution and use in source and binary forms, with or without
798 modification, are permitted provided that the following conditions
799 are met:
800
801 .olist
802 Redistributions of source code must retain the above copyright
803 notice, this list of conditions and the following disclaimer.
804 .next
805 Redistributions in binary form must reproduce the above copyright
806 notice, this list of conditions and the following disclaimer in
807 the documentation and/or other materials provided with the
808 distribution.
809 .next
810 The name &"Carnegie Mellon University"& must not be used to
811 endorse or promote products derived from this software without
812 prior written permission. For permission or any other legal
813 details, please contact
814 .display
815               Office of Technology Transfer
816               Carnegie Mellon University
817               5000 Forbes Avenue
818               Pittsburgh, PA  15213-3890
819               (412) 268-4387, fax: (412) 268-7395
820               tech-transfer@andrew.cmu.edu
821 .endd
822 .next
823 Redistributions of any form whatsoever must retain the following
824 acknowledgment:
825
826 &"This product includes software developed by Computing Services
827 at Carnegie Mellon University (&url(http://www.cmu.edu/computing/)."&
828
829 CARNEGIE MELLON UNIVERSITY DISCLAIMS ALL WARRANTIES WITH REGARD TO
830 THIS SOFTWARE, INCLUDING ALL IMPLIED WARRANTIES OF MERCHANTABILITY
831 AND FITNESS, IN NO EVENT SHALL CARNEGIE MELLON UNIVERSITY BE LIABLE
832 FOR ANY SPECIAL, INDIRECT OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES
833 WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS, WHETHER IN
834 AN ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING
835 OUT OF OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE.
836 .endlist
837 .endblockquote
838
839 .next
840 .cindex "Exim monitor" "acknowledgment"
841 .cindex "X-windows"
842 .cindex "Athena"
843 The Exim Monitor program, which is an X-Window application, includes
844 modified versions of the Athena StripChart and TextPop widgets.
845 This code is copyright by DEC and MIT, and their permission notice appears
846 below, in accordance with the conditions expressed therein.
847
848 .blockquote
849 Copyright 1987, 1988 by Digital Equipment Corporation, Maynard, Massachusetts,
850 and the Massachusetts Institute of Technology, Cambridge, Massachusetts.
851
852 All Rights Reserved
853
854 Permission to use, copy, modify, and distribute this software and its
855 documentation for any purpose and without fee is hereby granted,
856 provided that the above copyright notice appear in all copies and that
857 both that copyright notice and this permission notice appear in
858 supporting documentation, and that the names of Digital or MIT not be
859 used in advertising or publicity pertaining to distribution of the
860 software without specific, written prior permission.
861
862 DIGITAL DISCLAIMS ALL WARRANTIES WITH REGARD TO THIS SOFTWARE, INCLUDING
863 ALL IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS, IN NO EVENT SHALL
864 DIGITAL BE LIABLE FOR ANY SPECIAL, INDIRECT OR CONSEQUENTIAL DAMAGES OR
865 ANY DAMAGES WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS,
866 WHETHER IN AN ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION,
867 ARISING OUT OF OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS
868 SOFTWARE.
869 .endblockquote
870
871 .next
872 .cindex "opendmarc" "acknowledgment"
873 The DMARC implementation uses the OpenDMARC library which is Copyrighted by
874 The Trusted Domain Project. Portions of Exim source which use OpenDMARC
875 derived code are indicated in the respective source files. The full OpenDMARC
876 license is provided in the LICENSE.opendmarc file contained in the distributed
877 source code.
878
879 .next
880 Many people have contributed code fragments, some large, some small, that were
881 not covered by any specific licence requirements. It is assumed that the
882 contributors are happy to see their code incorporated into Exim under the GPL.
883 .endlist
884
885
886
887
888
889 . ////////////////////////////////////////////////////////////////////////////
890 . ////////////////////////////////////////////////////////////////////////////
891
892 .chapter "How Exim receives and delivers mail" "CHID11" &&&
893          "Receiving and delivering mail"
894
895
896 .section "Overall philosophy" "SECID10"
897 .cindex "design philosophy"
898 Exim is designed to work efficiently on systems that are permanently connected
899 to the Internet and are handling a general mix of mail. In such circumstances,
900 most messages can be delivered immediately. Consequently, Exim does not
901 maintain independent queues of messages for specific domains or hosts, though
902 it does try to send several messages in a single SMTP connection after a host
903 has been down, and it also maintains per-host retry information.
904
905
906 .section "Policy control" "SECID11"
907 .cindex "policy control" "overview"
908 Policy controls are now an important feature of MTAs that are connected to the
909 Internet. Perhaps their most important job is to stop MTAs being abused as
910 &"open relays"& by misguided individuals who send out vast amounts of
911 unsolicited junk, and want to disguise its source. Exim provides flexible
912 facilities for specifying policy controls on incoming mail:
913
914 .ilist
915 .cindex "&ACL;" "introduction"
916 Exim 4 (unlike previous versions of Exim) implements policy controls on
917 incoming mail by means of &'Access Control Lists'& (ACLs). Each list is a
918 series of statements that may either grant or deny access. ACLs can be used at
919 several places in the SMTP dialogue while receiving a message from a remote
920 host. However, the most common places are after each RCPT command, and at the
921 very end of the message. The sysadmin can specify conditions for accepting or
922 rejecting individual recipients or the entire message, respectively, at these
923 two points (see chapter &<<CHAPACL>>&). Denial of access results in an SMTP
924 error code.
925 .next
926 An ACL is also available for locally generated, non-SMTP messages. In this
927 case, the only available actions are to accept or deny the entire message.
928 .next
929 When Exim is compiled with the content-scanning extension, facilities are
930 provided in the ACL mechanism for passing the message to external virus and/or
931 spam scanning software. The result of such a scan is passed back to the ACL,
932 which can then use it to decide what to do with the message.
933 .next
934 When a message has been received, either from a remote host or from the local
935 host, but before the final acknowledgment has been sent, a locally supplied C
936 function called &[local_scan()]& can be run to inspect the message and decide
937 whether to accept it or not (see chapter &<<CHAPlocalscan>>&). If the message
938 is accepted, the list of recipients can be modified by the function.
939 .next
940 Using the &[local_scan()]& mechanism is another way of calling external scanner
941 software. The &%SA-Exim%& add-on package works this way. It does not require
942 Exim to be compiled with the content-scanning extension.
943 .next
944 After a message has been accepted, a further checking mechanism is available in
945 the form of the &'system filter'& (see chapter &<<CHAPsystemfilter>>&). This
946 runs at the start of every delivery process.
947 .endlist
948
949
950
951 .section "User filters" "SECID12"
952 .cindex "filter" "introduction"
953 .cindex "Sieve filter"
954 In a conventional Exim configuration, users are able to run private filters by
955 setting up appropriate &_.forward_& files in their home directories. See
956 chapter &<<CHAPredirect>>& (about the &(redirect)& router) for the
957 configuration needed to support this, and the separate document entitled
958 &'Exim's interfaces to mail filtering'& for user details. Two different kinds
959 of filtering are available:
960
961 .ilist
962 Sieve filters are written in the standard filtering language that is defined
963 by RFC 3028.
964 .next
965 Exim filters are written in a syntax that is unique to Exim, but which is more
966 powerful than Sieve, which it pre-dates.
967 .endlist
968
969 User filters are run as part of the routing process, described below.
970
971
972
973 .section "Message identification" "SECTmessiden"
974 .cindex "message ids" "details of format"
975 .cindex "format" "of message id"
976 .cindex "id of message"
977 .cindex "base62"
978 .cindex "base36"
979 .cindex "Darwin"
980 .cindex "Cygwin"
981 Every message handled by Exim is given a &'message id'& which is sixteen
982 characters long. It is divided into three parts, separated by hyphens, for
983 example &`16VDhn-0001bo-D3`&. Each part is a sequence of letters and digits,
984 normally encoding numbers in base 62. However, in the Darwin operating
985 system (Mac OS X) and when Exim is compiled to run under Cygwin, base 36
986 (avoiding the use of lower case letters) is used instead, because the message
987 id is used to construct file names, and the names of files in those systems are
988 not always case-sensitive.
989
990 .cindex "pid (process id)" "re-use of"
991 The detail of the contents of the message id have changed as Exim has evolved.
992 Earlier versions relied on the operating system not re-using a process id (pid)
993 within one second. On modern operating systems, this assumption can no longer
994 be made, so the algorithm had to be changed. To retain backward compatibility,
995 the format of the message id was retained, which is why the following rules are
996 somewhat eccentric:
997
998 .ilist
999 The first six characters of the message id are the time at which the message
1000 started to be received, to a granularity of one second. That is, this field
1001 contains the number of seconds since the start of the epoch (the normal Unix
1002 way of representing the date and time of day).
1003 .next
1004 After the first hyphen, the next six characters are the id of the process that
1005 received the message.
1006 .next
1007 There are two different possibilities for the final two characters:
1008 .olist
1009 .oindex "&%localhost_number%&"
1010 If &%localhost_number%& is not set, this value is the fractional part of the
1011 time of reception, normally in units of 1/2000 of a second, but for systems
1012 that must use base 36 instead of base 62 (because of case-insensitive file
1013 systems), the units are 1/1000 of a second.
1014 .next
1015 If &%localhost_number%& is set, it is multiplied by 200 (100) and added to
1016 the fractional part of the time, which in this case is in units of 1/200
1017 (1/100) of a second.
1018 .endlist
1019 .endlist
1020
1021 After a message has been received, Exim waits for the clock to tick at the
1022 appropriate resolution before proceeding, so that if another message is
1023 received by the same process, or by another process with the same (re-used)
1024 pid, it is guaranteed that the time will be different. In most cases, the clock
1025 will already have ticked while the message was being received.
1026
1027
1028 .section "Receiving mail" "SECID13"
1029 .cindex "receiving mail"
1030 .cindex "message" "reception"
1031 The only way Exim can receive mail from another host is using SMTP over
1032 TCP/IP, in which case the sender and recipient addresses are transferred using
1033 SMTP commands. However, from a locally running process (such as a user's MUA),
1034 there are several possibilities:
1035
1036 .ilist
1037 If the process runs Exim with the &%-bm%& option, the message is read
1038 non-interactively (usually via a pipe), with the recipients taken from the
1039 command line, or from the body of the message if &%-t%& is also used.
1040 .next
1041 If the process runs Exim with the &%-bS%& option, the message is also read
1042 non-interactively, but in this case the recipients are listed at the start of
1043 the message in a series of SMTP RCPT commands, terminated by a DATA
1044 command. This is so-called &"batch SMTP"& format,
1045 but it isn't really SMTP. The SMTP commands are just another way of passing
1046 envelope addresses in a non-interactive submission.
1047 .next
1048 If the process runs Exim with the &%-bs%& option, the message is read
1049 interactively, using the SMTP protocol. A two-way pipe is normally used for
1050 passing data between the local process and the Exim process.
1051 This is &"real"& SMTP and is handled in the same way as SMTP over TCP/IP. For
1052 example, the ACLs for SMTP commands are used for this form of submission.
1053 .next
1054 A local process may also make a TCP/IP call to the host's loopback address
1055 (127.0.0.1) or any other of its IP addresses. When receiving messages, Exim
1056 does not treat the loopback address specially. It treats all such connections
1057 in the same way as connections from other hosts.
1058 .endlist
1059
1060
1061 .cindex "message sender, constructed by Exim"
1062 .cindex "sender" "constructed by Exim"
1063 In the three cases that do not involve TCP/IP, the sender address is
1064 constructed from the login name of the user that called Exim and a default
1065 qualification domain (which can be set by the &%qualify_domain%& configuration
1066 option). For local or batch SMTP, a sender address that is passed using the
1067 SMTP MAIL command is ignored. However, the system administrator may allow
1068 certain users (&"trusted users"&) to specify a different sender address
1069 unconditionally, or all users to specify certain forms of different sender
1070 address. The &%-f%& option or the SMTP MAIL command is used to specify these
1071 different addresses. See section &<<SECTtrustedadmin>>& for details of trusted
1072 users, and the &%untrusted_set_sender%& option for a way of allowing untrusted
1073 users to change sender addresses.
1074
1075 Messages received by either of the non-interactive mechanisms are subject to
1076 checking by the non-SMTP ACL, if one is defined. Messages received using SMTP
1077 (either over TCP/IP, or interacting with a local process) can be checked by a
1078 number of ACLs that operate at different times during the SMTP session. Either
1079 individual recipients, or the entire message, can be rejected if local policy
1080 requirements are not met. The &[local_scan()]& function (see chapter
1081 &<<CHAPlocalscan>>&) is run for all incoming messages.
1082
1083 Exim can be configured not to start a delivery process when a message is
1084 received; this can be unconditional, or depend on the number of incoming SMTP
1085 connections or the system load. In these situations, new messages wait on the
1086 queue until a queue runner process picks them up. However, in standard
1087 configurations under normal conditions, delivery is started as soon as a
1088 message is received.
1089
1090
1091
1092
1093
1094 .section "Handling an incoming message" "SECID14"
1095 .cindex "spool directory" "files that hold a message"
1096 .cindex "file" "how a message is held"
1097 When Exim accepts a message, it writes two files in its spool directory. The
1098 first contains the envelope information, the current status of the message, and
1099 the header lines, and the second contains the body of the message. The names of
1100 the two spool files consist of the message id, followed by &`-H`& for the
1101 file containing the envelope and header, and &`-D`& for the data file.
1102
1103 .cindex "spool directory" "&_input_& sub-directory"
1104 By default all these message files are held in a single directory called
1105 &_input_& inside the general Exim spool directory. Some operating systems do
1106 not perform very well if the number of files in a directory gets large; to
1107 improve performance in such cases, the &%split_spool_directory%& option can be
1108 used. This causes Exim to split up the input files into 62 sub-directories
1109 whose names are single letters or digits. When this is done, the queue is
1110 processed one sub-directory at a time instead of all at once, which can improve
1111 overall performance even when there are not enough files in each directory to
1112 affect file system performance.
1113
1114 The envelope information consists of the address of the message's sender and
1115 the addresses of the recipients. This information is entirely separate from
1116 any addresses contained in the header lines. The status of the message includes
1117 a list of recipients who have already received the message. The format of the
1118 first spool file is described in chapter &<<CHAPspool>>&.
1119
1120 .cindex "rewriting" "addresses"
1121 Address rewriting that is specified in the rewrite section of the configuration
1122 (see chapter &<<CHAPrewrite>>&) is done once and for all on incoming addresses,
1123 both in the header lines and the envelope, at the time the message is accepted.
1124 If during the course of delivery additional addresses are generated (for
1125 example, via aliasing), these new addresses are rewritten as soon as they are
1126 generated. At the time a message is actually delivered (transported) further
1127 rewriting can take place; because this is a transport option, it can be
1128 different for different forms of delivery. It is also possible to specify the
1129 addition or removal of certain header lines at the time the message is
1130 delivered (see chapters &<<CHAProutergeneric>>& and
1131 &<<CHAPtransportgeneric>>&).
1132
1133
1134
1135 .section "Life of a message" "SECID15"
1136 .cindex "message" "life of"
1137 .cindex "message" "frozen"
1138 A message remains in the spool directory until it is completely delivered to
1139 its recipients or to an error address, or until it is deleted by an
1140 administrator or by the user who originally created it. In cases when delivery
1141 cannot proceed &-- for example, when a message can neither be delivered to its
1142 recipients nor returned to its sender, the message is marked &"frozen"& on the
1143 spool, and no more deliveries are attempted.
1144
1145 .cindex "frozen messages" "thawing"
1146 .cindex "message" "thawing frozen"
1147 An administrator can &"thaw"& such messages when the problem has been
1148 corrected, and can also freeze individual messages by hand if necessary. In
1149 addition, an administrator can force a delivery error, causing a bounce message
1150 to be sent.
1151
1152 .oindex "&%timeout_frozen_after%&"
1153 .oindex "&%ignore_bounce_errors_after%&"
1154 There are options called &%ignore_bounce_errors_after%& and
1155 &%timeout_frozen_after%&, which discard frozen messages after a certain time.
1156 The first applies only to frozen bounces, the second to any frozen messages.
1157
1158 .cindex "message" "log file for"
1159 .cindex "log" "file for each message"
1160 While Exim is working on a message, it writes information about each delivery
1161 attempt to its main log file. This includes successful, unsuccessful, and
1162 delayed deliveries for each recipient (see chapter &<<CHAPlog>>&). The log
1163 lines are also written to a separate &'message log'& file for each message.
1164 These logs are solely for the benefit of the administrator, and are normally
1165 deleted along with the spool files when processing of a message is complete.
1166 The use of individual message logs can be disabled by setting
1167 &%no_message_logs%&; this might give an improvement in performance on very busy
1168 systems.
1169
1170 .cindex "journal file"
1171 .cindex "file" "journal"
1172 All the information Exim itself needs to set up a delivery is kept in the first
1173 spool file, along with the header lines. When a successful delivery occurs, the
1174 address is immediately written at the end of a journal file, whose name is the
1175 message id followed by &`-J`&. At the end of a delivery run, if there are some
1176 addresses left to be tried again later, the first spool file (the &`-H`& file)
1177 is updated to indicate which these are, and the journal file is then deleted.
1178 Updating the spool file is done by writing a new file and renaming it, to
1179 minimize the possibility of data loss.
1180
1181 Should the system or the program crash after a successful delivery but before
1182 the spool file has been updated, the journal is left lying around. The next
1183 time Exim attempts to deliver the message, it reads the journal file and
1184 updates the spool file before proceeding. This minimizes the chances of double
1185 deliveries caused by crashes.
1186
1187
1188
1189 .section "Processing an address for delivery" "SECTprocaddress"
1190 .cindex "drivers" "definition of"
1191 .cindex "router" "definition of"
1192 .cindex "transport" "definition of"
1193 The main delivery processing elements of Exim are called &'routers'& and
1194 &'transports'&, and collectively these are known as &'drivers'&. Code for a
1195 number of them is provided in the source distribution, and compile-time options
1196 specify which ones are included in the binary. Run time options specify which
1197 ones are actually used for delivering messages.
1198
1199 .cindex "drivers" "instance definition"
1200 Each driver that is specified in the run time configuration is an &'instance'&
1201 of that particular driver type. Multiple instances are allowed; for example,
1202 you can set up several different &(smtp)& transports, each with different
1203 option values that might specify different ports or different timeouts. Each
1204 instance has its own identifying name. In what follows we will normally use the
1205 instance name when discussing one particular instance (that is, one specific
1206 configuration of the driver), and the generic driver name when discussing
1207 the driver's features in general.
1208
1209 A &'router'& is a driver that operates on an address, either determining how
1210 its delivery should happen, by assigning it to a specific transport, or
1211 converting the address into one or more new addresses (for example, via an
1212 alias file). A router may also explicitly choose to fail an address, causing it
1213 to be bounced.
1214
1215 A &'transport'& is a driver that transmits a copy of the message from Exim's
1216 spool to some destination. There are two kinds of transport: for a &'local'&
1217 transport, the destination is a file or a pipe on the local host, whereas for a
1218 &'remote'& transport the destination is some other host. A message is passed
1219 to a specific transport as a result of successful routing. If a message has
1220 several recipients, it may be passed to a number of different transports.
1221
1222 .cindex "preconditions" "definition of"
1223 An address is processed by passing it to each configured router instance in
1224 turn, subject to certain preconditions, until a router accepts the address or
1225 specifies that it should be bounced. We will describe this process in more
1226 detail shortly. First, as a simple example, we consider how each recipient
1227 address in a message is processed in a small configuration of three routers.
1228
1229 To make this a more concrete example, it is described in terms of some actual
1230 routers, but remember, this is only an example. You can configure Exim's
1231 routers in many different ways, and there may be any number of routers in a
1232 configuration.
1233
1234 The first router that is specified in a configuration is often one that handles
1235 addresses in domains that are not recognized specially by the local host. These
1236 are typically addresses for arbitrary domains on the Internet. A precondition
1237 is set up which looks for the special domains known to the host (for example,
1238 its own domain name), and the router is run for addresses that do &'not'&
1239 match. Typically, this is a router that looks up domains in the DNS in order to
1240 find the hosts to which this address routes. If it succeeds, the address is
1241 assigned to a suitable SMTP transport; if it does not succeed, the router is
1242 configured to fail the address.
1243
1244 The second router is reached only when the domain is recognized as one that
1245 &"belongs"& to the local host. This router does redirection &-- also known as
1246 aliasing and forwarding. When it generates one or more new addresses from the
1247 original, each of them is routed independently from the start. Otherwise, the
1248 router may cause an address to fail, or it may simply decline to handle the
1249 address, in which case the address is passed to the next router.
1250
1251 The final router in many configurations is one that checks to see if the
1252 address belongs to a local mailbox. The precondition may involve a check to
1253 see if the local part is the name of a login account, or it may look up the
1254 local part in a file or a database. If its preconditions are not met, or if
1255 the router declines, we have reached the end of the routers. When this happens,
1256 the address is bounced.
1257
1258
1259
1260 .section "Processing an address for verification" "SECID16"
1261 .cindex "router" "for verification"
1262 .cindex "verifying address" "overview"
1263 As well as being used to decide how to deliver to an address, Exim's routers
1264 are also used for &'address verification'&. Verification can be requested as
1265 one of the checks to be performed in an ACL for incoming messages, on both
1266 sender and recipient addresses, and it can be tested using the &%-bv%& and
1267 &%-bvs%& command line options.
1268
1269 When an address is being verified, the routers are run in &"verify mode"&. This
1270 does not affect the way the routers work, but it is a state that can be
1271 detected. By this means, a router can be skipped or made to behave differently
1272 when verifying. A common example is a configuration in which the first router
1273 sends all messages to a message-scanning program, unless they have been
1274 previously scanned. Thus, the first router accepts all addresses without any
1275 checking, making it useless for verifying. Normally, the &%no_verify%& option
1276 would be set for such a router, causing it to be skipped in verify mode.
1277
1278
1279
1280
1281 .section "Running an individual router" "SECTrunindrou"
1282 .cindex "router" "running details"
1283 .cindex "preconditions" "checking"
1284 .cindex "router" "result of running"
1285 As explained in the example above, a number of preconditions are checked before
1286 running a router. If any are not met, the router is skipped, and the address is
1287 passed to the next router. When all the preconditions on a router &'are'& met,
1288 the router is run. What happens next depends on the outcome, which is one of
1289 the following:
1290
1291 .ilist
1292 &'accept'&: The router accepts the address, and either assigns it to a
1293 transport, or generates one or more &"child"& addresses. Processing the
1294 original address ceases,
1295 .oindex "&%unseen%&"
1296 unless the &%unseen%& option is set on the router. This option
1297 can be used to set up multiple deliveries with different routing (for example,
1298 for keeping archive copies of messages). When &%unseen%& is set, the address is
1299 passed to the next router. Normally, however, an &'accept'& return marks the
1300 end of routing.
1301
1302 Any child addresses generated by the router are processed independently,
1303 starting with the first router by default. It is possible to change this by
1304 setting the &%redirect_router%& option to specify which router to start at for
1305 child addresses. Unlike &%pass_router%& (see below) the router specified by
1306 &%redirect_router%& may be anywhere in the router configuration.
1307 .next
1308 &'pass'&: The router recognizes the address, but cannot handle it itself. It
1309 requests that the address be passed to another router. By default the address
1310 is passed to the next router, but this can be changed by setting the
1311 &%pass_router%& option. However, (unlike &%redirect_router%&) the named router
1312 must be below the current router (to avoid loops).
1313 .next
1314 &'decline'&: The router declines to accept the address because it does not
1315 recognize it at all. By default, the address is passed to the next router, but
1316 this can be prevented by setting the &%no_more%& option. When &%no_more%& is
1317 set, all the remaining routers are skipped. In effect, &%no_more%& converts
1318 &'decline'& into &'fail'&.
1319 .next
1320 &'fail'&: The router determines that the address should fail, and queues it for
1321 the generation of a bounce message. There is no further processing of the
1322 original address unless &%unseen%& is set on the router.
1323 .next
1324 &'defer'&: The router cannot handle the address at the present time. (A
1325 database may be offline, or a DNS lookup may have timed out.) No further
1326 processing of the address happens in this delivery attempt. It is tried again
1327 next time the message is considered for delivery.
1328 .next
1329 &'error'&: There is some error in the router (for example, a syntax error in
1330 its configuration). The action is as for defer.
1331 .endlist
1332
1333 If an address reaches the end of the routers without having been accepted by
1334 any of them, it is bounced as unrouteable. The default error message in this
1335 situation is &"unrouteable address"&, but you can set your own message by
1336 making use of the &%cannot_route_message%& option. This can be set for any
1337 router; the value from the last router that &"saw"& the address is used.
1338
1339 Sometimes while routing you want to fail a delivery when some conditions are
1340 met but others are not, instead of passing the address on for further routing.
1341 You can do this by having a second router that explicitly fails the delivery
1342 when the relevant conditions are met. The &(redirect)& router has a &"fail"&
1343 facility for this purpose.
1344
1345
1346 .section "Duplicate addresses" "SECID17"
1347 .cindex "case of local parts"
1348 .cindex "address duplicate, discarding"
1349 .cindex "duplicate addresses"
1350 Once routing is complete, Exim scans the addresses that are assigned to local
1351 and remote transports, and discards any duplicates that it finds. During this
1352 check, local parts are treated as case-sensitive. This happens only when
1353 actually delivering a message; when testing routers with &%-bt%&, all the
1354 routed addresses are shown.
1355
1356
1357
1358 .section "Router preconditions" "SECTrouprecon"
1359 .cindex "router" "preconditions, order of processing"
1360 .cindex "preconditions" "order of processing"
1361 The preconditions that are tested for each router are listed below, in the
1362 order in which they are tested. The individual configuration options are
1363 described in more detail in chapter &<<CHAProutergeneric>>&.
1364
1365 .ilist
1366 The &%local_part_prefix%& and &%local_part_suffix%& options can specify that
1367 the local parts handled by the router may or must have certain prefixes and/or
1368 suffixes. If a mandatory affix (prefix or suffix) is not present, the router is
1369 skipped. These conditions are tested first. When an affix is present, it is
1370 removed from the local part before further processing, including the evaluation
1371 of any other conditions.
1372 .next
1373 Routers can be designated for use only when not verifying an address, that is,
1374 only when routing it for delivery (or testing its delivery routing). If the
1375 &%verify%& option is set false, the router is skipped when Exim is verifying an
1376 address.
1377 Setting the &%verify%& option actually sets two options, &%verify_sender%& and
1378 &%verify_recipient%&, which independently control the use of the router for
1379 sender and recipient verification. You can set these options directly if
1380 you want a router to be used for only one type of verification.
1381 Note that cutthrough delivery is classed as a recipient verification for this purpose.
1382 .next
1383 If the &%address_test%& option is set false, the router is skipped when Exim is
1384 run with the &%-bt%& option to test an address routing. This can be helpful
1385 when the first router sends all new messages to a scanner of some sort; it
1386 makes it possible to use &%-bt%& to test subsequent delivery routing without
1387 having to simulate the effect of the scanner.
1388 .next
1389 Routers can be designated for use only when verifying an address, as
1390 opposed to routing it for delivery. The &%verify_only%& option controls this.
1391 Again, cutthrough delivery counts as a verification.
1392 .next
1393 Individual routers can be explicitly skipped when running the routers to
1394 check an address given in the SMTP EXPN command (see the &%expn%& option).
1395 .next
1396 If the &%domains%& option is set, the domain of the address must be in the set
1397 of domains that it defines.
1398 .next
1399 .vindex "&$local_part_prefix$&"
1400 .vindex "&$local_part$&"
1401 .vindex "&$local_part_suffix$&"
1402 If the &%local_parts%& option is set, the local part of the address must be in
1403 the set of local parts that it defines. If &%local_part_prefix%& or
1404 &%local_part_suffix%& is in use, the prefix or suffix is removed from the local
1405 part before this check. If you want to do precondition tests on local parts
1406 that include affixes, you can do so by using a &%condition%& option (see below)
1407 that uses the variables &$local_part$&, &$local_part_prefix$&, and
1408 &$local_part_suffix$& as necessary.
1409 .next
1410 .vindex "&$local_user_uid$&"
1411 .vindex "&$local_user_gid$&"
1412 .vindex "&$home$&"
1413 If the &%check_local_user%& option is set, the local part must be the name of
1414 an account on the local host. If this check succeeds, the uid and gid of the
1415 local user are placed in &$local_user_uid$& and &$local_user_gid$& and the
1416 user's home directory is placed in &$home$&; these values can be used in the
1417 remaining preconditions.
1418 .next
1419 If the &%router_home_directory%& option is set, it is expanded at this point,
1420 because it overrides the value of &$home$&. If this expansion were left till
1421 later, the value of &$home$& as set by &%check_local_user%& would be used in
1422 subsequent tests. Having two different values of &$home$& in the same router
1423 could lead to confusion.
1424 .next
1425 If the &%senders%& option is set, the envelope sender address must be in the
1426 set of addresses that it defines.
1427 .next
1428 If the &%require_files%& option is set, the existence or non-existence of
1429 specified files is tested.
1430 .next
1431 .cindex "customizing" "precondition"
1432 If the &%condition%& option is set, it is evaluated and tested. This option
1433 uses an expanded string to allow you to set up your own custom preconditions.
1434 Expanded strings are described in chapter &<<CHAPexpand>>&.
1435 .endlist
1436
1437
1438 Note that &%require_files%& comes near the end of the list, so you cannot use
1439 it to check for the existence of a file in which to lookup up a domain, local
1440 part, or sender. However, as these options are all expanded, you can use the
1441 &%exists%& expansion condition to make such tests within each condition. The
1442 &%require_files%& option is intended for checking files that the router may be
1443 going to use internally, or which are needed by a specific transport (for
1444 example, &_.procmailrc_&).
1445
1446
1447
1448 .section "Delivery in detail" "SECID18"
1449 .cindex "delivery" "in detail"
1450 When a message is to be delivered, the sequence of events is as follows:
1451
1452 .ilist
1453 If a system-wide filter file is specified, the message is passed to it. The
1454 filter may add recipients to the message, replace the recipients, discard the
1455 message, cause a new message to be generated, or cause the message delivery to
1456 fail. The format of the system filter file is the same as for Exim user filter
1457 files, described in the separate document entitled &'Exim's interfaces to mail
1458 filtering'&.
1459 .cindex "Sieve filter" "not available for system filter"
1460 (&*Note*&: Sieve cannot be used for system filter files.)
1461
1462 Some additional features are available in system filters &-- see chapter
1463 &<<CHAPsystemfilter>>& for details. Note that a message is passed to the system
1464 filter only once per delivery attempt, however many recipients it has. However,
1465 if there are several delivery attempts because one or more addresses could not
1466 be immediately delivered, the system filter is run each time. The filter
1467 condition &%first_delivery%& can be used to detect the first run of the system
1468 filter.
1469 .next
1470 Each recipient address is offered to each configured router in turn, subject to
1471 its preconditions, until one is able to handle it. If no router can handle the
1472 address, that is, if they all decline, the address is failed. Because routers
1473 can be targeted at particular domains, several locally handled domains can be
1474 processed entirely independently of each other.
1475 .next
1476 .cindex "routing" "loops in"
1477 .cindex "loop" "while routing"
1478 A router that accepts an address may assign it to a local or a remote
1479 transport. However, the transport is not run at this time. Instead, the address
1480 is placed on a list for the particular transport, which will be run later.
1481 Alternatively, the router may generate one or more new addresses (typically
1482 from alias, forward, or filter files). New addresses are fed back into this
1483 process from the top, but in order to avoid loops, a router ignores any address
1484 which has an identically-named ancestor that was processed by itself.
1485 .next
1486 When all the routing has been done, addresses that have been successfully
1487 handled are passed to their assigned transports. When local transports are
1488 doing real local deliveries, they handle only one address at a time, but if a
1489 local transport is being used as a pseudo-remote transport (for example, to
1490 collect batched SMTP messages for transmission by some other means) multiple
1491 addresses can be handled. Remote transports can always handle more than one
1492 address at a time, but can be configured not to do so, or to restrict multiple
1493 addresses to the same domain.
1494 .next
1495 Each local delivery to a file or a pipe runs in a separate process under a
1496 non-privileged uid, and these deliveries are run one at a time. Remote
1497 deliveries also run in separate processes, normally under a uid that is private
1498 to Exim (&"the Exim user"&), but in this case, several remote deliveries can be
1499 run in parallel. The maximum number of simultaneous remote deliveries for any
1500 one message is set by the &%remote_max_parallel%& option.
1501 The order in which deliveries are done is not defined, except that all local
1502 deliveries happen before any remote deliveries.
1503 .next
1504 .cindex "queue runner"
1505 When it encounters a local delivery during a queue run, Exim checks its retry
1506 database to see if there has been a previous temporary delivery failure for the
1507 address before running the local transport. If there was a previous failure,
1508 Exim does not attempt a new delivery until the retry time for the address is
1509 reached. However, this happens only for delivery attempts that are part of a
1510 queue run. Local deliveries are always attempted when delivery immediately
1511 follows message reception, even if retry times are set for them. This makes for
1512 better behaviour if one particular message is causing problems (for example,
1513 causing quota overflow, or provoking an error in a filter file).
1514 .next
1515 .cindex "delivery" "retry in remote transports"
1516 Remote transports do their own retry handling, since an address may be
1517 deliverable to one of a number of hosts, each of which may have a different
1518 retry time. If there have been previous temporary failures and no host has
1519 reached its retry time, no delivery is attempted, whether in a queue run or
1520 not. See chapter &<<CHAPretry>>& for details of retry strategies.
1521 .next
1522 If there were any permanent errors, a bounce message is returned to an
1523 appropriate address (the sender in the common case), with details of the error
1524 for each failing address. Exim can be configured to send copies of bounce
1525 messages to other addresses.
1526 .next
1527 .cindex "delivery" "deferral"
1528 If one or more addresses suffered a temporary failure, the message is left on
1529 the queue, to be tried again later. Delivery of these addresses is said to be
1530 &'deferred'&.
1531 .next
1532 When all the recipient addresses have either been delivered or bounced,
1533 handling of the message is complete. The spool files and message log are
1534 deleted, though the message log can optionally be preserved if required.
1535 .endlist
1536
1537
1538
1539
1540 .section "Retry mechanism" "SECID19"
1541 .cindex "delivery" "retry mechanism"
1542 .cindex "retry" "description of mechanism"
1543 .cindex "queue runner"
1544 Exim's mechanism for retrying messages that fail to get delivered at the first
1545 attempt is the queue runner process. You must either run an Exim daemon that
1546 uses the &%-q%& option with a time interval to start queue runners at regular
1547 intervals, or use some other means (such as &'cron'&) to start them. If you do
1548 not arrange for queue runners to be run, messages that fail temporarily at the
1549 first attempt will remain on your queue for ever. A queue runner process works
1550 its way through the queue, one message at a time, trying each delivery that has
1551 passed its retry time.
1552 You can run several queue runners at once.
1553
1554 Exim uses a set of configured rules to determine when next to retry the failing
1555 address (see chapter &<<CHAPretry>>&). These rules also specify when Exim
1556 should give up trying to deliver to the address, at which point it generates a
1557 bounce message. If no retry rules are set for a particular host, address, and
1558 error combination, no retries are attempted, and temporary errors are treated
1559 as permanent.
1560
1561
1562
1563 .section "Temporary delivery failure" "SECID20"
1564 .cindex "delivery" "temporary failure"
1565 There are many reasons why a message may not be immediately deliverable to a
1566 particular address. Failure to connect to a remote machine (because it, or the
1567 connection to it, is down) is one of the most common. Temporary failures may be
1568 detected during routing as well as during the transport stage of delivery.
1569 Local deliveries may be delayed if NFS files are unavailable, or if a mailbox
1570 is on a file system where the user is over quota. Exim can be configured to
1571 impose its own quotas on local mailboxes; where system quotas are set they will
1572 also apply.
1573
1574 If a host is unreachable for a period of time, a number of messages may be
1575 waiting for it by the time it recovers, and sending them in a single SMTP
1576 connection is clearly beneficial. Whenever a delivery to a remote host is
1577 deferred,
1578 .cindex "hints database"
1579 Exim makes a note in its hints database, and whenever a successful
1580 SMTP delivery has happened, it looks to see if any other messages are waiting
1581 for the same host. If any are found, they are sent over the same SMTP
1582 connection, subject to a configuration limit as to the maximum number in any
1583 one connection.
1584
1585
1586
1587 .section "Permanent delivery failure" "SECID21"
1588 .cindex "delivery" "permanent failure"
1589 .cindex "bounce message" "when generated"
1590 When a message cannot be delivered to some or all of its intended recipients, a
1591 bounce message is generated. Temporary delivery failures turn into permanent
1592 errors when their timeout expires. All the addresses that fail in a given
1593 delivery attempt are listed in a single message. If the original message has
1594 many recipients, it is possible for some addresses to fail in one delivery
1595 attempt and others to fail subsequently, giving rise to more than one bounce
1596 message. The wording of bounce messages can be customized by the administrator.
1597 See chapter &<<CHAPemsgcust>>& for details.
1598
1599 .cindex "&'X-Failed-Recipients:'& header line"
1600 Bounce messages contain an &'X-Failed-Recipients:'& header line that lists the
1601 failed addresses, for the benefit of programs that try to analyse such messages
1602 automatically.
1603
1604 .cindex "bounce message" "recipient of"
1605 A bounce message is normally sent to the sender of the original message, as
1606 obtained from the message's envelope. For incoming SMTP messages, this is the
1607 address given in the MAIL command. However, when an address is expanded via a
1608 forward or alias file, an alternative address can be specified for delivery
1609 failures of the generated addresses. For a mailing list expansion (see section
1610 &<<SECTmailinglists>>&) it is common to direct bounce messages to the manager
1611 of the list.
1612
1613
1614
1615 .section "Failures to deliver bounce messages" "SECID22"
1616 .cindex "bounce message" "failure to deliver"
1617 If a bounce message (either locally generated or received from a remote host)
1618 itself suffers a permanent delivery failure, the message is left on the queue,
1619 but it is frozen, awaiting the attention of an administrator. There are options
1620 that can be used to make Exim discard such failed messages, or to keep them
1621 for only a short time (see &%timeout_frozen_after%& and
1622 &%ignore_bounce_errors_after%&).
1623
1624
1625
1626
1627
1628 . ////////////////////////////////////////////////////////////////////////////
1629 . ////////////////////////////////////////////////////////////////////////////
1630
1631 .chapter "Building and installing Exim" "CHID3"
1632 .scindex IIDbuex "building Exim"
1633
1634 .section "Unpacking" "SECID23"
1635 Exim is distributed as a gzipped or bzipped tar file which, when unpacked,
1636 creates a directory with the name of the current release (for example,
1637 &_exim-&version()_&) into which the following files are placed:
1638
1639 .table2 140pt
1640 .irow &_ACKNOWLEDGMENTS_& "contains some acknowledgments"
1641 .irow &_CHANGES_&         "contains a reference to where changes are &&&
1642   documented"
1643 .irow &_LICENCE_&         "the GNU General Public Licence"
1644 .irow &_Makefile_&        "top-level make file"
1645 .irow &_NOTICE_&          "conditions for the use of Exim"
1646 .irow &_README_&          "list of files, directories and simple build &&&
1647   instructions"
1648 .endtable
1649
1650 Other files whose names begin with &_README_& may also be present. The
1651 following subdirectories are created:
1652
1653 .table2 140pt
1654 .irow &_Local_&           "an empty directory for local configuration files"
1655 .irow &_OS_&              "OS-specific files"
1656 .irow &_doc_&             "documentation files"
1657 .irow &_exim_monitor_&    "source files for the Exim monitor"
1658 .irow &_scripts_&         "scripts used in the build process"
1659 .irow &_src_&             "remaining source files"
1660 .irow &_util_&            "independent utilities"
1661 .endtable
1662
1663 The main utility programs are contained in the &_src_& directory, and are built
1664 with the Exim binary. The &_util_& directory contains a few optional scripts
1665 that may be useful to some sites.
1666
1667
1668 .section "Multiple machine architectures and operating systems" "SECID24"
1669 .cindex "building Exim" "multiple OS/architectures"
1670 The building process for Exim is arranged to make it easy to build binaries for
1671 a number of different architectures and operating systems from the same set of
1672 source files. Compilation does not take place in the &_src_& directory.
1673 Instead, a &'build directory'& is created for each architecture and operating
1674 system.
1675 .cindex "symbolic link" "to build directory"
1676 Symbolic links to the sources are installed in this directory, which is where
1677 the actual building takes place. In most cases, Exim can discover the machine
1678 architecture and operating system for itself, but the defaults can be
1679 overridden if necessary.
1680
1681
1682 .section "PCRE library" "SECTpcre"
1683 .cindex "PCRE library"
1684 Exim no longer has an embedded PCRE library as the vast majority of
1685 modern systems include PCRE as a system library, although you may need
1686 to install the PCRE or PCRE development package for your operating
1687 system. If your system has a normal PCRE installation the Exim build
1688 process will need no further configuration. If the library or the
1689 headers are in an unusual location you will need to either set the PCRE_LIBS
1690 and INCLUDE directives appropriately,
1691 or set PCRE_CONFIG=yes to use the installed &(pcre-config)& command.
1692 If your operating system has no
1693 PCRE support then you will need to obtain and build the current PCRE
1694 from &url(ftp://ftp.csx.cam.ac.uk/pub/software/programming/pcre/).
1695 More information on PCRE is available at &url(http://www.pcre.org/).
1696
1697 .section "DBM libraries" "SECTdb"
1698 .cindex "DBM libraries" "discussion of"
1699 .cindex "hints database" "DBM files used for"
1700 Even if you do not use any DBM files in your configuration, Exim still needs a
1701 DBM library in order to operate, because it uses indexed files for its hints
1702 databases. Unfortunately, there are a number of DBM libraries in existence, and
1703 different operating systems often have different ones installed.
1704
1705 .cindex "Solaris" "DBM library for"
1706 .cindex "IRIX, DBM library for"
1707 .cindex "BSD, DBM library for"
1708 .cindex "Linux, DBM library for"
1709 If you are using Solaris, IRIX, one of the modern BSD systems, or a modern
1710 Linux distribution, the DBM configuration should happen automatically, and you
1711 may be able to ignore this section. Otherwise, you may have to learn more than
1712 you would like about DBM libraries from what follows.
1713
1714 .cindex "&'ndbm'& DBM library"
1715 Licensed versions of Unix normally contain a library of DBM functions operating
1716 via the &'ndbm'& interface, and this is what Exim expects by default. Free
1717 versions of Unix seem to vary in what they contain as standard. In particular,
1718 some early versions of Linux have no default DBM library, and different
1719 distributors have chosen to bundle different libraries with their packaged
1720 versions. However, the more recent releases seem to have standardized on the
1721 Berkeley DB library.
1722
1723 Different DBM libraries have different conventions for naming the files they
1724 use. When a program opens a file called &_dbmfile_&, there are several
1725 possibilities:
1726
1727 .olist
1728 A traditional &'ndbm'& implementation, such as that supplied as part of
1729 Solaris, operates on two files called &_dbmfile.dir_& and &_dbmfile.pag_&.
1730 .next
1731 .cindex "&'gdbm'& DBM library"
1732 The GNU library, &'gdbm'&, operates on a single file. If used via its &'ndbm'&
1733 compatibility interface it makes two different hard links to it with names
1734 &_dbmfile.dir_& and &_dbmfile.pag_&, but if used via its native interface, the
1735 file name is used unmodified.
1736 .next
1737 .cindex "Berkeley DB library"
1738 The Berkeley DB package, if called via its &'ndbm'& compatibility interface,
1739 operates on a single file called &_dbmfile.db_&, but otherwise looks to the
1740 programmer exactly the same as the traditional &'ndbm'& implementation.
1741 .next
1742 If the Berkeley package is used in its native mode, it operates on a single
1743 file called &_dbmfile_&; the programmer's interface is somewhat different to
1744 the traditional &'ndbm'& interface.
1745 .next
1746 To complicate things further, there are several very different versions of the
1747 Berkeley DB package. Version 1.85 was stable for a very long time, releases
1748 2.&'x'& and 3.&'x'& were current for a while, but the latest versions are now
1749 numbered 4.&'x'&. Maintenance of some of the earlier releases has ceased. All
1750 versions of Berkeley DB can be obtained from
1751 &url(http://www.sleepycat.com/).
1752 .next
1753 .cindex "&'tdb'& DBM library"
1754 Yet another DBM library, called &'tdb'&, is available from
1755 &url(http://download.sourceforge.net/tdb). It has its own interface, and also
1756 operates on a single file.
1757 .endlist
1758
1759 .cindex "USE_DB"
1760 .cindex "DBM libraries" "configuration for building"
1761 Exim and its utilities can be compiled to use any of these interfaces. In order
1762 to use any version of the Berkeley DB package in native mode, you must set
1763 USE_DB in an appropriate configuration file (typically
1764 &_Local/Makefile_&). For example:
1765 .code
1766 USE_DB=yes
1767 .endd
1768 Similarly, for gdbm you set USE_GDBM, and for tdb you set USE_TDB. An
1769 error is diagnosed if you set more than one of these.
1770
1771 At the lowest level, the build-time configuration sets none of these options,
1772 thereby assuming an interface of type (1). However, some operating system
1773 configuration files (for example, those for the BSD operating systems and
1774 Linux) assume type (4) by setting USE_DB as their default, and the
1775 configuration files for Cygwin set USE_GDBM. Anything you set in
1776 &_Local/Makefile_&, however, overrides these system defaults.
1777
1778 As well as setting USE_DB, USE_GDBM, or USE_TDB, it may also be
1779 necessary to set DBMLIB, to cause inclusion of the appropriate library, as
1780 in one of these lines:
1781 .code
1782 DBMLIB = -ldb
1783 DBMLIB = -ltdb
1784 .endd
1785 Settings like that will work if the DBM library is installed in the standard
1786 place. Sometimes it is not, and the library's header file may also not be in
1787 the default path. You may need to set INCLUDE to specify where the header
1788 file is, and to specify the path to the library more fully in DBMLIB, as in
1789 this example:
1790 .code
1791 INCLUDE=-I/usr/local/include/db-4.1
1792 DBMLIB=/usr/local/lib/db-4.1/libdb.a
1793 .endd
1794 There is further detailed discussion about the various DBM libraries in the
1795 file &_doc/dbm.discuss.txt_& in the Exim distribution.
1796
1797
1798
1799 .section "Pre-building configuration" "SECID25"
1800 .cindex "building Exim" "pre-building configuration"
1801 .cindex "configuration for building Exim"
1802 .cindex "&_Local/Makefile_&"
1803 .cindex "&_src/EDITME_&"
1804 Before building Exim, a local configuration file that specifies options
1805 independent of any operating system has to be created with the name
1806 &_Local/Makefile_&. A template for this file is supplied as the file
1807 &_src/EDITME_&, and it contains full descriptions of all the option settings
1808 therein. These descriptions are therefore not repeated here. If you are
1809 building Exim for the first time, the simplest thing to do is to copy
1810 &_src/EDITME_& to &_Local/Makefile_&, then read it and edit it appropriately.
1811
1812 There are three settings that you must supply, because Exim will not build
1813 without them. They are the location of the run time configuration file
1814 (CONFIGURE_FILE), the directory in which Exim binaries will be installed
1815 (BIN_DIRECTORY), and the identity of the Exim user (EXIM_USER and
1816 maybe EXIM_GROUP as well). The value of CONFIGURE_FILE can in fact be
1817 a colon-separated list of file names; Exim uses the first of them that exists.
1818
1819 There are a few other parameters that can be specified either at build time or
1820 at run time, to enable the same binary to be used on a number of different
1821 machines. However, if the locations of Exim's spool directory and log file
1822 directory (if not within the spool directory) are fixed, it is recommended that
1823 you specify them in &_Local/Makefile_& instead of at run time, so that errors
1824 detected early in Exim's execution (such as a malformed configuration file) can
1825 be logged.
1826
1827 .cindex "content scanning" "specifying at build time"
1828 Exim's interfaces for calling virus and spam scanning software directly from
1829 access control lists are not compiled by default. If you want to include these
1830 facilities, you need to set
1831 .code
1832 WITH_CONTENT_SCAN=yes
1833 .endd
1834 in your &_Local/Makefile_&. For details of the facilities themselves, see
1835 chapter &<<CHAPexiscan>>&.
1836
1837
1838 .cindex "&_Local/eximon.conf_&"
1839 .cindex "&_exim_monitor/EDITME_&"
1840 If you are going to build the Exim monitor, a similar configuration process is
1841 required. The file &_exim_monitor/EDITME_& must be edited appropriately for
1842 your installation and saved under the name &_Local/eximon.conf_&. If you are
1843 happy with the default settings described in &_exim_monitor/EDITME_&,
1844 &_Local/eximon.conf_& can be empty, but it must exist.
1845
1846 This is all the configuration that is needed in straightforward cases for known
1847 operating systems. However, the building process is set up so that it is easy
1848 to override options that are set by default or by operating-system-specific
1849 configuration files, for example to change the name of the C compiler, which
1850 defaults to &%gcc%&. See section &<<SECToverride>>& below for details of how to
1851 do this.
1852
1853
1854
1855 .section "Support for iconv()" "SECID26"
1856 .cindex "&[iconv()]& support"
1857 .cindex "RFC 2047"
1858 The contents of header lines in messages may be encoded according to the rules
1859 described RFC 2047. This makes it possible to transmit characters that are not
1860 in the ASCII character set, and to label them as being in a particular
1861 character set. When Exim is inspecting header lines by means of the &%$h_%&
1862 mechanism, it decodes them, and translates them into a specified character set
1863 (default ISO-8859-1). The translation is possible only if the operating system
1864 supports the &[iconv()]& function.
1865
1866 However, some of the operating systems that supply &[iconv()]& do not support
1867 very many conversions. The GNU &%libiconv%& library (available from
1868 &url(http://www.gnu.org/software/libiconv/)) can be installed on such
1869 systems to remedy this deficiency, as well as on systems that do not supply
1870 &[iconv()]& at all. After installing &%libiconv%&, you should add
1871 .code
1872 HAVE_ICONV=yes
1873 .endd
1874 to your &_Local/Makefile_& and rebuild Exim.
1875
1876
1877
1878 .section "Including TLS/SSL encryption support" "SECTinctlsssl"
1879 .cindex "TLS" "including support for TLS"
1880 .cindex "encryption" "including support for"
1881 .cindex "SUPPORT_TLS"
1882 .cindex "OpenSSL" "building Exim with"
1883 .cindex "GnuTLS" "building Exim with"
1884 Exim can be built to support encrypted SMTP connections, using the STARTTLS
1885 command as per RFC 2487. It can also support legacy clients that expect to
1886 start a TLS session immediately on connection to a non-standard port (see the
1887 &%tls_on_connect_ports%& runtime option and the &%-tls-on-connect%& command
1888 line option).
1889
1890 If you want to build Exim with TLS support, you must first install either the
1891 OpenSSL or GnuTLS library. There is no cryptographic code in Exim itself for
1892 implementing SSL.
1893
1894 If OpenSSL is installed, you should set
1895 .code
1896 SUPPORT_TLS=yes
1897 TLS_LIBS=-lssl -lcrypto
1898 .endd
1899 in &_Local/Makefile_&. You may also need to specify the locations of the
1900 OpenSSL library and include files. For example:
1901 .code
1902 SUPPORT_TLS=yes
1903 TLS_LIBS=-L/usr/local/openssl/lib -lssl -lcrypto
1904 TLS_INCLUDE=-I/usr/local/openssl/include/
1905 .endd
1906 .cindex "pkg-config" "OpenSSL"
1907 If you have &'pkg-config'& available, then instead you can just use:
1908 .code
1909 SUPPORT_TLS=yes
1910 USE_OPENSSL_PC=openssl
1911 .endd
1912 .cindex "USE_GNUTLS"
1913 If GnuTLS is installed, you should set
1914 .code
1915 SUPPORT_TLS=yes
1916 USE_GNUTLS=yes
1917 TLS_LIBS=-lgnutls -ltasn1 -lgcrypt
1918 .endd
1919 in &_Local/Makefile_&, and again you may need to specify the locations of the
1920 library and include files. For example:
1921 .code
1922 SUPPORT_TLS=yes
1923 USE_GNUTLS=yes
1924 TLS_LIBS=-L/usr/gnu/lib -lgnutls -ltasn1 -lgcrypt
1925 TLS_INCLUDE=-I/usr/gnu/include
1926 .endd
1927 .cindex "pkg-config" "GnuTLS"
1928 If you have &'pkg-config'& available, then instead you can just use:
1929 .code
1930 SUPPORT_TLS=yes
1931 USE_GNUTLS=yes
1932 USE_GNUTLS_PC=gnutls
1933 .endd
1934
1935 You do not need to set TLS_INCLUDE if the relevant directory is already
1936 specified in INCLUDE. Details of how to configure Exim to make use of TLS are
1937 given in chapter &<<CHAPTLS>>&.
1938
1939
1940
1941
1942 .section "Use of tcpwrappers" "SECID27"
1943
1944 .cindex "tcpwrappers, building Exim to support"
1945 .cindex "USE_TCP_WRAPPERS"
1946 .cindex "TCP_WRAPPERS_DAEMON_NAME"
1947 .cindex "tcp_wrappers_daemon_name"
1948 Exim can be linked with the &'tcpwrappers'& library in order to check incoming
1949 SMTP calls using the &'tcpwrappers'& control files. This may be a convenient
1950 alternative to Exim's own checking facilities for installations that are
1951 already making use of &'tcpwrappers'& for other purposes. To do this, you
1952 should set USE_TCP_WRAPPERS in &_Local/Makefile_&, arrange for the file
1953 &_tcpd.h_& to be available at compile time, and also ensure that the library
1954 &_libwrap.a_& is available at link time, typically by including &%-lwrap%& in
1955 EXTRALIBS_EXIM. For example, if &'tcpwrappers'& is installed in &_/usr/local_&,
1956 you might have
1957 .code
1958 USE_TCP_WRAPPERS=yes
1959 CFLAGS=-O -I/usr/local/include
1960 EXTRALIBS_EXIM=-L/usr/local/lib -lwrap
1961 .endd
1962 in &_Local/Makefile_&. The daemon name to use in the &'tcpwrappers'& control
1963 files is &"exim"&. For example, the line
1964 .code
1965 exim : LOCAL  192.168.1.  .friendly.domain.example
1966 .endd
1967 in your &_/etc/hosts.allow_& file allows connections from the local host, from
1968 the subnet 192.168.1.0/24, and from all hosts in &'friendly.domain.example'&.
1969 All other connections are denied. The daemon name used by &'tcpwrappers'&
1970 can be changed at build time by setting TCP_WRAPPERS_DAEMON_NAME in
1971 &_Local/Makefile_&, or by setting tcp_wrappers_daemon_name in the
1972 configure file. Consult the &'tcpwrappers'& documentation for
1973 further details.
1974
1975
1976 .section "Including support for IPv6" "SECID28"
1977 .cindex "IPv6" "including support for"
1978 Exim contains code for use on systems that have IPv6 support. Setting
1979 &`HAVE_IPV6=YES`& in &_Local/Makefile_& causes the IPv6 code to be included;
1980 it may also be necessary to set IPV6_INCLUDE and IPV6_LIBS on systems
1981 where the IPv6 support is not fully integrated into the normal include and
1982 library files.
1983
1984 Two different types of DNS record for handling IPv6 addresses have been
1985 defined. AAAA records (analogous to A records for IPv4) are in use, and are
1986 currently seen as the mainstream. Another record type called A6 was proposed
1987 as better than AAAA because it had more flexibility. However, it was felt to be
1988 over-complex, and its status was reduced to &"experimental"&. It is not known
1989 if anyone is actually using A6 records. Exim has support for A6 records, but
1990 this is included only if you set &`SUPPORT_A6=YES`& in &_Local/Makefile_&. The
1991 support has not been tested for some time.
1992
1993
1994
1995 .section "Dynamically loaded lookup module support" "SECTdynamicmodules"
1996 .cindex "lookup modules"
1997 .cindex "dynamic modules"
1998 .cindex ".so building"
1999 On some platforms, Exim supports not compiling all lookup types directly into
2000 the main binary, instead putting some into external modules which can be loaded
2001 on demand.
2002 This permits packagers to build Exim with support for lookups with extensive
2003 library dependencies without requiring all users to install all of those
2004 dependencies.
2005 Most, but not all, lookup types can be built this way.
2006
2007 Set &`LOOKUP_MODULE_DIR`& to the directory into which the modules will be
2008 installed; Exim will only load modules from that directory, as a security
2009 measure.  You will need to set &`CFLAGS_DYNAMIC`& if not already defined
2010 for your OS; see &_OS/Makefile-Linux_& for an example.
2011 Some other requirements for adjusting &`EXTRALIBS`& may also be necessary,
2012 see &_src/EDITME_& for details.
2013
2014 Then, for each module to be loaded dynamically, define the relevant
2015 &`LOOKUP_`&<&'lookup_type'&> flags to have the value "2" instead of "yes".
2016 For example, this will build in lsearch but load sqlite and mysql support
2017 on demand:
2018 .code
2019 LOOKUP_LSEARCH=yes
2020 LOOKUP_SQLITE=2
2021 LOOKUP_MYSQL=2
2022 .endd
2023
2024
2025 .section "The building process" "SECID29"
2026 .cindex "build directory"
2027 Once &_Local/Makefile_& (and &_Local/eximon.conf_&, if required) have been
2028 created, run &'make'& at the top level. It determines the architecture and
2029 operating system types, and creates a build directory if one does not exist.
2030 For example, on a Sun system running Solaris 8, the directory
2031 &_build-SunOS5-5.8-sparc_& is created.
2032 .cindex "symbolic link" "to source files"
2033 Symbolic links to relevant source files are installed in the build directory.
2034
2035 &*Warning*&: The &%-j%& (parallel) flag must not be used with &'make'&; the
2036 building process fails if it is set.
2037
2038 If this is the first time &'make'& has been run, it calls a script that builds
2039 a make file inside the build directory, using the configuration files from the
2040 &_Local_& directory. The new make file is then passed to another instance of
2041 &'make'&. This does the real work, building a number of utility scripts, and
2042 then compiling and linking the binaries for the Exim monitor (if configured), a
2043 number of utility programs, and finally Exim itself. The command &`make
2044 makefile`& can be used to force a rebuild of the make file in the build
2045 directory, should this ever be necessary.
2046
2047 If you have problems building Exim, check for any comments there may be in the
2048 &_README_& file concerning your operating system, and also take a look at the
2049 FAQ, where some common problems are covered.
2050
2051
2052
2053 .section 'Output from &"make"&' "SECID283"
2054 The output produced by the &'make'& process for compile lines is often very
2055 unreadable, because these lines can be very long. For this reason, the normal
2056 output is suppressed by default, and instead output similar to that which
2057 appears when compiling the 2.6 Linux kernel is generated: just a short line for
2058 each module that is being compiled or linked. However, it is still possible to
2059 get the full output, by calling &'make'& like this:
2060 .code
2061 FULLECHO='' make -e
2062 .endd
2063 The value of FULLECHO defaults to &"@"&, the flag character that suppresses
2064 command reflection in &'make'&. When you ask for the full output, it is
2065 given in addition to the short output.
2066
2067
2068
2069 .section "Overriding build-time options for Exim" "SECToverride"
2070 .cindex "build-time options, overriding"
2071 The main make file that is created at the beginning of the building process
2072 consists of the concatenation of a number of files which set configuration
2073 values, followed by a fixed set of &'make'& instructions. If a value is set
2074 more than once, the last setting overrides any previous ones. This provides a
2075 convenient way of overriding defaults. The files that are concatenated are, in
2076 order:
2077 .display
2078 &_OS/Makefile-Default_&
2079 &_OS/Makefile-_&<&'ostype'&>
2080 &_Local/Makefile_&
2081 &_Local/Makefile-_&<&'ostype'&>
2082 &_Local/Makefile-_&<&'archtype'&>
2083 &_Local/Makefile-_&<&'ostype'&>-<&'archtype'&>
2084 &_OS/Makefile-Base_&
2085 .endd
2086 .cindex "&_Local/Makefile_&"
2087 .cindex "building Exim" "operating system type"
2088 .cindex "building Exim" "architecture type"
2089 where <&'ostype'&> is the operating system type and <&'archtype'&> is the
2090 architecture type. &_Local/Makefile_& is required to exist, and the building
2091 process fails if it is absent. The other three &_Local_& files are optional,
2092 and are often not needed.
2093
2094 The values used for <&'ostype'&> and <&'archtype'&> are obtained from scripts
2095 called &_scripts/os-type_& and &_scripts/arch-type_& respectively. If either of
2096 the environment variables EXIM_OSTYPE or EXIM_ARCHTYPE is set, their
2097 values are used, thereby providing a means of forcing particular settings.
2098 Otherwise, the scripts try to get values from the &%uname%& command. If this
2099 fails, the shell variables OSTYPE and ARCHTYPE are inspected. A number
2100 of &'ad hoc'& transformations are then applied, to produce the standard names
2101 that Exim expects. You can run these scripts directly from the shell in order
2102 to find out what values are being used on your system.
2103
2104
2105 &_OS/Makefile-Default_& contains comments about the variables that are set
2106 therein. Some (but not all) are mentioned below. If there is something that
2107 needs changing, review the contents of this file and the contents of the make
2108 file for your operating system (&_OS/Makefile-<ostype>_&) to see what the
2109 default values are.
2110
2111
2112 .cindex "building Exim" "overriding default settings"
2113 If you need to change any of the values that are set in &_OS/Makefile-Default_&
2114 or in &_OS/Makefile-<ostype>_&, or to add any new definitions, you do not
2115 need to change the original files. Instead, you should make the changes by
2116 putting the new values in an appropriate &_Local_& file. For example,
2117 .cindex "Tru64-Unix build-time settings"
2118 when building Exim in many releases of the Tru64-Unix (formerly Digital UNIX,
2119 formerly DEC-OSF1) operating system, it is necessary to specify that the C
2120 compiler is called &'cc'& rather than &'gcc'&. Also, the compiler must be
2121 called with the option &%-std1%&, to make it recognize some of the features of
2122 Standard C that Exim uses. (Most other compilers recognize Standard C by
2123 default.) To do this, you should create a file called &_Local/Makefile-OSF1_&
2124 containing the lines
2125 .code
2126 CC=cc
2127 CFLAGS=-std1
2128 .endd
2129 If you are compiling for just one operating system, it may be easier to put
2130 these lines directly into &_Local/Makefile_&.
2131
2132 Keeping all your local configuration settings separate from the distributed
2133 files makes it easy to transfer them to new versions of Exim simply by copying
2134 the contents of the &_Local_& directory.
2135
2136
2137 .cindex "NIS lookup type" "including support for"
2138 .cindex "NIS+ lookup type" "including support for"
2139 .cindex "LDAP" "including support for"
2140 .cindex "lookup" "inclusion in binary"
2141 Exim contains support for doing LDAP, NIS, NIS+, and other kinds of file
2142 lookup, but not all systems have these components installed, so the default is
2143 not to include the relevant code in the binary. All the different kinds of file
2144 and database lookup that Exim supports are implemented as separate code modules
2145 which are included only if the relevant compile-time options are set. In the
2146 case of LDAP, NIS, and NIS+, the settings for &_Local/Makefile_& are:
2147 .code
2148 LOOKUP_LDAP=yes
2149 LOOKUP_NIS=yes
2150 LOOKUP_NISPLUS=yes
2151 .endd
2152 and similar settings apply to the other lookup types. They are all listed in
2153 &_src/EDITME_&. In many cases the relevant include files and interface
2154 libraries need to be installed before compiling Exim.
2155 .cindex "cdb" "including support for"
2156 However, there are some optional lookup types (such as cdb) for which
2157 the code is entirely contained within Exim, and no external include
2158 files or libraries are required. When a lookup type is not included in the
2159 binary, attempts to configure Exim to use it cause run time configuration
2160 errors.
2161
2162 .cindex "pkg-config" "lookups"
2163 .cindex "pkg-config" "authenticators"
2164 Many systems now use a tool called &'pkg-config'& to encapsulate information
2165 about how to compile against a library; Exim has some initial support for
2166 being able to use pkg-config for lookups and authenticators.  For any given
2167 makefile variable which starts &`LOOKUP_`& or &`AUTH_`&, you can add a new
2168 variable with the &`_PC`& suffix in the name and assign as the value the
2169 name of the package to be queried.  The results of querying via the
2170 &'pkg-config'& command will be added to the appropriate Makefile variables
2171 with &`+=`& directives, so your version of &'make'& will need to support that
2172 syntax.  For instance:
2173 .code
2174 LOOKUP_SQLITE=yes
2175 LOOKUP_SQLITE_PC=sqlite3
2176 AUTH_GSASL=yes
2177 AUTH_GSASL_PC=libgsasl
2178 AUTH_HEIMDAL_GSSAPI=yes
2179 AUTH_HEIMDAL_GSSAPI_PC=heimdal-gssapi
2180 .endd
2181
2182 .cindex "Perl" "including support for"
2183 Exim can be linked with an embedded Perl interpreter, allowing Perl
2184 subroutines to be called during string expansion. To enable this facility,
2185 .code
2186 EXIM_PERL=perl.o
2187 .endd
2188 must be defined in &_Local/Makefile_&. Details of this facility are given in
2189 chapter &<<CHAPperl>>&.
2190
2191 .cindex "X11 libraries, location of"
2192 The location of the X11 libraries is something that varies a lot between
2193 operating systems, and there may be different versions of X11 to cope
2194 with. Exim itself makes no use of X11, but if you are compiling the Exim
2195 monitor, the X11 libraries must be available.
2196 The following three variables are set in &_OS/Makefile-Default_&:
2197 .code
2198 X11=/usr/X11R6
2199 XINCLUDE=-I$(X11)/include
2200 XLFLAGS=-L$(X11)/lib
2201 .endd
2202 These are overridden in some of the operating-system configuration files. For
2203 example, in &_OS/Makefile-SunOS5_& there is
2204 .code
2205 X11=/usr/openwin
2206 XINCLUDE=-I$(X11)/include
2207 XLFLAGS=-L$(X11)/lib -R$(X11)/lib
2208 .endd
2209 If you need to override the default setting for your operating system, place a
2210 definition of all three of these variables into your
2211 &_Local/Makefile-<ostype>_& file.
2212
2213 .cindex "EXTRALIBS"
2214 If you need to add any extra libraries to the link steps, these can be put in a
2215 variable called EXTRALIBS, which appears in all the link commands, but by
2216 default is not defined. In contrast, EXTRALIBS_EXIM is used only on the
2217 command for linking the main Exim binary, and not for any associated utilities.
2218
2219 .cindex "DBM libraries" "configuration for building"
2220 There is also DBMLIB, which appears in the link commands for binaries that
2221 use DBM functions (see also section &<<SECTdb>>&). Finally, there is
2222 EXTRALIBS_EXIMON, which appears only in the link step for the Exim monitor
2223 binary, and which can be used, for example, to include additional X11
2224 libraries.
2225
2226 .cindex "configuration file" "editing"
2227 The make file copes with rebuilding Exim correctly if any of the configuration
2228 files are edited. However, if an optional configuration file is deleted, it is
2229 necessary to touch the associated non-optional file (that is,
2230 &_Local/Makefile_& or &_Local/eximon.conf_&) before rebuilding.
2231
2232
2233 .section "OS-specific header files" "SECID30"
2234 .cindex "&_os.h_&"
2235 .cindex "building Exim" "OS-specific C header files"
2236 The &_OS_& directory contains a number of files with names of the form
2237 &_os.h-<ostype>_&. These are system-specific C header files that should not
2238 normally need to be changed. There is a list of macro settings that are
2239 recognized in the file &_OS/os.configuring_&, which should be consulted if you
2240 are porting Exim to a new operating system.
2241
2242
2243
2244 .section "Overriding build-time options for the monitor" "SECID31"
2245 .cindex "building Eximon"
2246 A similar process is used for overriding things when building the Exim monitor,
2247 where the files that are involved are
2248 .display
2249 &_OS/eximon.conf-Default_&
2250 &_OS/eximon.conf-_&<&'ostype'&>
2251 &_Local/eximon.conf_&
2252 &_Local/eximon.conf-_&<&'ostype'&>
2253 &_Local/eximon.conf-_&<&'archtype'&>
2254 &_Local/eximon.conf-_&<&'ostype'&>-<&'archtype'&>
2255 .endd
2256 .cindex "&_Local/eximon.conf_&"
2257 As with Exim itself, the final three files need not exist, and in this case the
2258 &_OS/eximon.conf-<ostype>_& file is also optional. The default values in
2259 &_OS/eximon.conf-Default_& can be overridden dynamically by setting environment
2260 variables of the same name, preceded by EXIMON_. For example, setting
2261 EXIMON_LOG_DEPTH in the environment overrides the value of
2262 LOG_DEPTH at run time.
2263 .ecindex IIDbuex
2264
2265
2266 .section "Installing Exim binaries and scripts" "SECID32"
2267 .cindex "installing Exim"
2268 .cindex "BIN_DIRECTORY"
2269 The command &`make install`& runs the &(exim_install)& script with no
2270 arguments. The script copies binaries and utility scripts into the directory
2271 whose name is specified by the BIN_DIRECTORY setting in &_Local/Makefile_&.
2272 .cindex "setuid" "installing Exim with"
2273 The install script copies files only if they are newer than the files they are
2274 going to replace. The Exim binary is required to be owned by root and have the
2275 &'setuid'& bit set, for normal configurations. Therefore, you must run &`make
2276 install`& as root so that it can set up the Exim binary in this way. However, in
2277 some special situations (for example, if a host is doing no local deliveries)
2278 it may be possible to run Exim without making the binary setuid root (see
2279 chapter &<<CHAPsecurity>>& for details).
2280
2281 .cindex "CONFIGURE_FILE"
2282 Exim's run time configuration file is named by the CONFIGURE_FILE setting
2283 in &_Local/Makefile_&. If this names a single file, and the file does not
2284 exist, the default configuration file &_src/configure.default_& is copied there
2285 by the installation script. If a run time configuration file already exists, it
2286 is left alone. If CONFIGURE_FILE is a colon-separated list, naming several
2287 alternative files, no default is installed.
2288
2289 .cindex "system aliases file"
2290 .cindex "&_/etc/aliases_&"
2291 One change is made to the default configuration file when it is installed: the
2292 default configuration contains a router that references a system aliases file.
2293 The path to this file is set to the value specified by
2294 SYSTEM_ALIASES_FILE in &_Local/Makefile_& (&_/etc/aliases_& by default).
2295 If the system aliases file does not exist, the installation script creates it,
2296 and outputs a comment to the user.
2297
2298 The created file contains no aliases, but it does contain comments about the
2299 aliases a site should normally have. Mail aliases have traditionally been
2300 kept in &_/etc/aliases_&. However, some operating systems are now using
2301 &_/etc/mail/aliases_&. You should check if yours is one of these, and change
2302 Exim's configuration if necessary.
2303
2304 The default configuration uses the local host's name as the only local domain,
2305 and is set up to do local deliveries into the shared directory &_/var/mail_&,
2306 running as the local user. System aliases and &_.forward_& files in users' home
2307 directories are supported, but no NIS or NIS+ support is configured. Domains
2308 other than the name of the local host are routed using the DNS, with delivery
2309 over SMTP.
2310
2311 It is possible to install Exim for special purposes (such as building a binary
2312 distribution) in a private part of the file system. You can do this by a
2313 command such as
2314 .code
2315 make DESTDIR=/some/directory/ install
2316 .endd
2317 This has the effect of pre-pending the specified directory to all the file
2318 paths, except the name of the system aliases file that appears in the default
2319 configuration. (If a default alias file is created, its name &'is'& modified.)
2320 For backwards compatibility, ROOT is used if DESTDIR is not set,
2321 but this usage is deprecated.
2322
2323 .cindex "installing Exim" "what is not installed"
2324 Running &'make install'& does not copy the Exim 4 conversion script
2325 &'convert4r4'&. You will probably run this only once if you are
2326 upgrading from Exim 3. None of the documentation files in the &_doc_&
2327 directory are copied, except for the info files when you have set
2328 INFO_DIRECTORY, as described in section &<<SECTinsinfdoc>>& below.
2329
2330 For the utility programs, old versions are renamed by adding the suffix &_.O_&
2331 to their names. The Exim binary itself, however, is handled differently. It is
2332 installed under a name that includes the version number and the compile number,
2333 for example &_exim-&version()-1_&. The script then arranges for a symbolic link
2334 called &_exim_& to point to the binary. If you are updating a previous version
2335 of Exim, the script takes care to ensure that the name &_exim_& is never absent
2336 from the directory (as seen by other processes).
2337
2338 .cindex "installing Exim" "testing the script"
2339 If you want to see what the &'make install'& will do before running it for
2340 real, you can pass the &%-n%& option to the installation script by this
2341 command:
2342 .code
2343 make INSTALL_ARG=-n install
2344 .endd
2345 The contents of the variable INSTALL_ARG are passed to the installation
2346 script. You do not need to be root to run this test. Alternatively, you can run
2347 the installation script directly, but this must be from within the build
2348 directory. For example, from the top-level Exim directory you could use this
2349 command:
2350 .code
2351 (cd build-SunOS5-5.5.1-sparc; ../scripts/exim_install -n)
2352 .endd
2353 .cindex "installing Exim" "install script options"
2354 There are two other options that can be supplied to the installation script.
2355
2356 .ilist
2357 &%-no_chown%& bypasses the call to change the owner of the installed binary
2358 to root, and the call to make it a setuid binary.
2359 .next
2360 &%-no_symlink%& bypasses the setting up of the symbolic link &_exim_& to the
2361 installed binary.
2362 .endlist
2363
2364 INSTALL_ARG can be used to pass these options to the script. For example:
2365 .code
2366 make INSTALL_ARG=-no_symlink install
2367 .endd
2368 The installation script can also be given arguments specifying which files are
2369 to be copied. For example, to install just the Exim binary, and nothing else,
2370 without creating the symbolic link, you could use:
2371 .code
2372 make INSTALL_ARG='-no_symlink exim' install
2373 .endd
2374
2375
2376
2377 .section "Installing info documentation" "SECTinsinfdoc"
2378 .cindex "installing Exim" "&'info'& documentation"
2379 Not all systems use the GNU &'info'& system for documentation, and for this
2380 reason, the Texinfo source of Exim's documentation is not included in the main
2381 distribution. Instead it is available separately from the ftp site (see section
2382 &<<SECTavail>>&).
2383
2384 If you have defined INFO_DIRECTORY in &_Local/Makefile_& and the Texinfo
2385 source of the documentation is found in the source tree, running &`make
2386 install`& automatically builds the info files and installs them.
2387
2388
2389
2390 .section "Setting up the spool directory" "SECID33"
2391 .cindex "spool directory" "creating"
2392 When it starts up, Exim tries to create its spool directory if it does not
2393 exist. The Exim uid and gid are used for the owner and group of the spool
2394 directory. Sub-directories are automatically created in the spool directory as
2395 necessary.
2396
2397
2398
2399
2400 .section "Testing" "SECID34"
2401 .cindex "testing" "installation"
2402 Having installed Exim, you can check that the run time configuration file is
2403 syntactically valid by running the following command, which assumes that the
2404 Exim binary directory is within your PATH environment variable:
2405 .code
2406 exim -bV
2407 .endd
2408 If there are any errors in the configuration file, Exim outputs error messages.
2409 Otherwise it outputs the version number and build date,
2410 the DBM library that is being used, and information about which drivers and
2411 other optional code modules are included in the binary.
2412 Some simple routing tests can be done by using the address testing option. For
2413 example,
2414 .display
2415 &`exim -bt`& <&'local username'&>
2416 .endd
2417 should verify that it recognizes a local mailbox, and
2418 .display
2419 &`exim -bt`& <&'remote address'&>
2420 .endd
2421 a remote one. Then try getting it to deliver mail, both locally and remotely.
2422 This can be done by passing messages directly to Exim, without going through a
2423 user agent. For example:
2424 .code
2425 exim -v postmaster@your.domain.example
2426 From: user@your.domain.example
2427 To: postmaster@your.domain.example
2428 Subject: Testing Exim
2429
2430 This is a test message.
2431 ^D
2432 .endd
2433 The &%-v%& option causes Exim to output some verification of what it is doing.
2434 In this case you should see copies of three log lines, one for the message's
2435 arrival, one for its delivery, and one containing &"Completed"&.
2436
2437 .cindex "delivery" "problems with"
2438 If you encounter problems, look at Exim's log files (&'mainlog'& and
2439 &'paniclog'&) to see if there is any relevant information there. Another source
2440 of information is running Exim with debugging turned on, by specifying the
2441 &%-d%& option. If a message is stuck on Exim's spool, you can force a delivery
2442 with debugging turned on by a command of the form
2443 .display
2444 &`exim -d -M`& <&'exim-message-id'&>
2445 .endd
2446 You must be root or an &"admin user"& in order to do this. The &%-d%& option
2447 produces rather a lot of output, but you can cut this down to specific areas.
2448 For example, if you use &%-d-all+route%& only the debugging information
2449 relevant to routing is included. (See the &%-d%& option in chapter
2450 &<<CHAPcommandline>>& for more details.)
2451
2452 .cindex '&"sticky"& bit'
2453 .cindex "lock files"
2454 One specific problem that has shown up on some sites is the inability to do
2455 local deliveries into a shared mailbox directory, because it does not have the
2456 &"sticky bit"& set on it. By default, Exim tries to create a lock file before
2457 writing to a mailbox file, and if it cannot create the lock file, the delivery
2458 is deferred. You can get round this either by setting the &"sticky bit"& on the
2459 directory, or by setting a specific group for local deliveries and allowing
2460 that group to create files in the directory (see the comments above the
2461 &(local_delivery)& transport in the default configuration file). Another
2462 approach is to configure Exim not to use lock files, but just to rely on
2463 &[fcntl()]& locking instead. However, you should do this only if all user
2464 agents also use &[fcntl()]& locking. For further discussion of locking issues,
2465 see chapter &<<CHAPappendfile>>&.
2466
2467 One thing that cannot be tested on a system that is already running an MTA is
2468 the receipt of incoming SMTP mail on the standard SMTP port. However, the
2469 &%-oX%& option can be used to run an Exim daemon that listens on some other
2470 port, or &'inetd'& can be used to do this. The &%-bh%& option and the
2471 &'exim_checkaccess'& utility can be used to check out policy controls on
2472 incoming SMTP mail.
2473
2474 Testing a new version on a system that is already running Exim can most easily
2475 be done by building a binary with a different CONFIGURE_FILE setting. From
2476 within the run time configuration, all other file and directory names
2477 that Exim uses can be altered, in order to keep it entirely clear of the
2478 production version.
2479
2480
2481 .section "Replacing another MTA with Exim" "SECID35"
2482 .cindex "replacing another MTA"
2483 Building and installing Exim for the first time does not of itself put it in
2484 general use. The name by which the system's MTA is called by mail user agents
2485 is either &_/usr/sbin/sendmail_&, or &_/usr/lib/sendmail_& (depending on the
2486 operating system), and it is necessary to make this name point to the &'exim'&
2487 binary in order to get the user agents to pass messages to Exim. This is
2488 normally done by renaming any existing file and making &_/usr/sbin/sendmail_&
2489 or &_/usr/lib/sendmail_&
2490 .cindex "symbolic link" "to &'exim'& binary"
2491 a symbolic link to the &'exim'& binary. It is a good idea to remove any setuid
2492 privilege and executable status from the old MTA. It is then necessary to stop
2493 and restart the mailer daemon, if one is running.
2494
2495 .cindex "FreeBSD, MTA indirection"
2496 .cindex "&_/etc/mail/mailer.conf_&"
2497 Some operating systems have introduced alternative ways of switching MTAs. For
2498 example, if you are running FreeBSD, you need to edit the file
2499 &_/etc/mail/mailer.conf_& instead of setting up a symbolic link as just
2500 described. A typical example of the contents of this file for running Exim is
2501 as follows:
2502 .code
2503 sendmail            /usr/exim/bin/exim
2504 send-mail           /usr/exim/bin/exim
2505 mailq               /usr/exim/bin/exim -bp
2506 newaliases          /usr/bin/true
2507 .endd
2508 Once you have set up the symbolic link, or edited &_/etc/mail/mailer.conf_&,
2509 your Exim installation is &"live"&. Check it by sending a message from your
2510 favourite user agent.
2511
2512 You should consider what to tell your users about the change of MTA. Exim may
2513 have different capabilities to what was previously running, and there are
2514 various operational differences such as the text of messages produced by
2515 command line options and in bounce messages. If you allow your users to make
2516 use of Exim's filtering capabilities, you should make the document entitled
2517 &'Exim's interface to mail filtering'& available to them.
2518
2519
2520
2521 .section "Upgrading Exim" "SECID36"
2522 .cindex "upgrading Exim"
2523 If you are already running Exim on your host, building and installing a new
2524 version automatically makes it available to MUAs, or any other programs that
2525 call the MTA directly. However, if you are running an Exim daemon, you do need
2526 to send it a HUP signal, to make it re-execute itself, and thereby pick up the
2527 new binary. You do not need to stop processing mail in order to install a new
2528 version of Exim. The install script does not modify an existing runtime
2529 configuration file.
2530
2531
2532
2533
2534 .section "Stopping the Exim daemon on Solaris" "SECID37"
2535 .cindex "Solaris" "stopping Exim on"
2536 The standard command for stopping the mailer daemon on Solaris is
2537 .code
2538 /etc/init.d/sendmail stop
2539 .endd
2540 If &_/usr/lib/sendmail_& has been turned into a symbolic link, this script
2541 fails to stop Exim because it uses the command &'ps -e'& and greps the output
2542 for the text &"sendmail"&; this is not present because the actual program name
2543 (that is, &"exim"&) is given by the &'ps'& command with these options. A
2544 solution is to replace the line that finds the process id with something like
2545 .code
2546 pid=`cat /var/spool/exim/exim-daemon.pid`
2547 .endd
2548 to obtain the daemon's pid directly from the file that Exim saves it in.
2549
2550 Note, however, that stopping the daemon does not &"stop Exim"&. Messages can
2551 still be received from local processes, and if automatic delivery is configured
2552 (the normal case), deliveries will still occur.
2553
2554
2555
2556
2557 . ////////////////////////////////////////////////////////////////////////////
2558 . ////////////////////////////////////////////////////////////////////////////
2559
2560 .chapter "The Exim command line" "CHAPcommandline"
2561 .scindex IIDclo1 "command line" "options"
2562 .scindex IIDclo2 "options" "command line"
2563 Exim's command line takes the standard Unix form of a sequence of options,
2564 each starting with a hyphen character, followed by a number of arguments. The
2565 options are compatible with the main options of Sendmail, and there are also
2566 some additional options, some of which are compatible with Smail 3. Certain
2567 combinations of options do not make sense, and provoke an error if used.
2568 The form of the arguments depends on which options are set.
2569
2570
2571 .section "Setting options by program name" "SECID38"
2572 .cindex "&'mailq'&"
2573 If Exim is called under the name &'mailq'&, it behaves as if the option &%-bp%&
2574 were present before any other options.
2575 The &%-bp%& option requests a listing of the contents of the mail queue on the
2576 standard output.
2577 This feature is for compatibility with some systems that contain a command of
2578 that name in one of the standard libraries, symbolically linked to
2579 &_/usr/sbin/sendmail_& or &_/usr/lib/sendmail_&.
2580
2581 .cindex "&'rsmtp'&"
2582 If Exim is called under the name &'rsmtp'& it behaves as if the option &%-bS%&
2583 were present before any other options, for compatibility with Smail. The
2584 &%-bS%& option is used for reading in a number of messages in batched SMTP
2585 format.
2586
2587 .cindex "&'rmail'&"
2588 If Exim is called under the name &'rmail'& it behaves as if the &%-i%& and
2589 &%-oee%& options were present before any other options, for compatibility with
2590 Smail. The name &'rmail'& is used as an interface by some UUCP systems.
2591
2592 .cindex "&'runq'&"
2593 .cindex "queue runner"
2594 If Exim is called under the name &'runq'& it behaves as if the option &%-q%&
2595 were present before any other options, for compatibility with Smail. The &%-q%&
2596 option causes a single queue runner process to be started.
2597
2598 .cindex "&'newaliases'&"
2599 .cindex "alias file" "building"
2600 .cindex "Sendmail compatibility" "calling Exim as &'newaliases'&"
2601 If Exim is called under the name &'newaliases'& it behaves as if the option
2602 &%-bi%& were present before any other options, for compatibility with Sendmail.
2603 This option is used for rebuilding Sendmail's alias file. Exim does not have
2604 the concept of a single alias file, but can be configured to run a given
2605 command if called with the &%-bi%& option.
2606
2607
2608 .section "Trusted and admin users" "SECTtrustedadmin"
2609 Some Exim options are available only to &'trusted users'& and others are
2610 available only to &'admin users'&. In the description below, the phrases &"Exim
2611 user"& and &"Exim group"& mean the user and group defined by EXIM_USER and
2612 EXIM_GROUP in &_Local/Makefile_& or set by the &%exim_user%& and
2613 &%exim_group%& options. These do not necessarily have to use the name &"exim"&.
2614
2615 .ilist
2616 .cindex "trusted users" "definition of"
2617 .cindex "user" "trusted definition of"
2618 The trusted users are root, the Exim user, any user listed in the
2619 &%trusted_users%& configuration option, and any user whose current group or any
2620 supplementary group is one of those listed in the &%trusted_groups%&
2621 configuration option. Note that the Exim group is not automatically trusted.
2622
2623 .cindex '&"From"& line'
2624 .cindex "envelope sender"
2625 Trusted users are always permitted to use the &%-f%& option or a leading
2626 &"From&~"& line to specify the envelope sender of a message that is passed to
2627 Exim through the local interface (see the &%-bm%& and &%-f%& options below).
2628 See the &%untrusted_set_sender%& option for a way of permitting non-trusted
2629 users to set envelope senders.
2630
2631 .cindex "&'From:'& header line"
2632 .cindex "&'Sender:'& header line"
2633 For a trusted user, there is never any check on the contents of the &'From:'&
2634 header line, and a &'Sender:'& line is never added. Furthermore, any existing
2635 &'Sender:'& line in incoming local (non-TCP/IP) messages is not removed.
2636
2637 Trusted users may also specify a host name, host address, interface address,
2638 protocol name, ident value, and authentication data when submitting a message
2639 locally. Thus, they are able to insert messages into Exim's queue locally that
2640 have the characteristics of messages received from a remote host. Untrusted
2641 users may in some circumstances use &%-f%&, but can never set the other values
2642 that are available to trusted users.
2643 .next
2644 .cindex "user" "admin definition of"
2645 .cindex "admin user" "definition of"
2646 The admin users are root, the Exim user, and any user that is a member of the
2647 Exim group or of any group listed in the &%admin_groups%& configuration option.
2648 The current group does not have to be one of these groups.
2649
2650 Admin users are permitted to list the queue, and to carry out certain
2651 operations on messages, for example, to force delivery failures. It is also
2652 necessary to be an admin user in order to see the full information provided by
2653 the Exim monitor, and full debugging output.
2654
2655 By default, the use of the &%-M%&, &%-q%&, &%-R%&, and &%-S%& options to cause
2656 Exim to attempt delivery of messages on its queue is restricted to admin users.
2657 However, this restriction can be relaxed by setting the &%prod_requires_admin%&
2658 option false (that is, specifying &%no_prod_requires_admin%&).
2659
2660 Similarly, the use of the &%-bp%& option to list all the messages in the queue
2661 is restricted to admin users unless &%queue_list_requires_admin%& is set
2662 false.
2663 .endlist
2664
2665
2666 &*Warning*&: If you configure your system so that admin users are able to
2667 edit Exim's configuration file, you are giving those users an easy way of
2668 getting root. There is further discussion of this issue at the start of chapter
2669 &<<CHAPconf>>&.
2670
2671
2672
2673
2674 .section "Command line options" "SECID39"
2675 Exim's command line options are described in alphabetical order below. If none
2676 of the options that specifies a specific action (such as starting the daemon or
2677 a queue runner, or testing an address, or receiving a message in a specific
2678 format, or listing the queue) are present, and there is at least one argument
2679 on the command line, &%-bm%& (accept a local message on the standard input,
2680 with the arguments specifying the recipients) is assumed. Otherwise, Exim
2681 outputs a brief message about itself and exits.
2682
2683 . ////////////////////////////////////////////////////////////////////////////
2684 . Insert a stylized XML comment here, to identify the start of the command line
2685 . options. This is for the benefit of the Perl script that automatically
2686 . creates a man page for the options.
2687 . ////////////////////////////////////////////////////////////////////////////
2688
2689 .literal xml
2690 <!-- === Start of command line options === -->
2691 .literal off
2692
2693
2694 .vlist
2695 .vitem &%--%&
2696 .oindex "--"
2697 .cindex "options" "command line; terminating"
2698 This is a pseudo-option whose only purpose is to terminate the options and
2699 therefore to cause subsequent command line items to be treated as arguments
2700 rather than options, even if they begin with hyphens.
2701
2702 .vitem &%--help%&
2703 .oindex "&%--help%&"
2704 This option causes Exim to output a few sentences stating what it is.
2705 The same output is generated if the Exim binary is called with no options and
2706 no arguments.
2707
2708 .vitem &%--version%&
2709 .oindex "&%--version%&"
2710 This option is an alias for &%-bV%& and causes version information to be
2711 displayed.
2712
2713 .vitem &%-Ac%& &&&
2714        &%-Am%&
2715 .oindex "&%-Ac%&"
2716 .oindex "&%-Am%&"
2717 These options are used by Sendmail for selecting configuration files and are
2718 ignored by Exim.
2719
2720 .vitem &%-B%&<&'type'&>
2721 .oindex "&%-B%&"
2722 .cindex "8-bit characters"
2723 .cindex "Sendmail compatibility" "8-bit characters"
2724 This is a Sendmail option for selecting 7 or 8 bit processing. Exim is 8-bit
2725 clean; it ignores this option.
2726
2727 .vitem &%-bd%&
2728 .oindex "&%-bd%&"
2729 .cindex "daemon"
2730 .cindex "SMTP" "listener"
2731 .cindex "queue runner"
2732 This option runs Exim as a daemon, awaiting incoming SMTP connections. Usually
2733 the &%-bd%& option is combined with the &%-q%&<&'time'&> option, to specify
2734 that the daemon should also initiate periodic queue runs.
2735
2736 The &%-bd%& option can be used only by an admin user. If either of the &%-d%&
2737 (debugging) or &%-v%& (verifying) options are set, the daemon does not
2738 disconnect from the controlling terminal. When running this way, it can be
2739 stopped by pressing ctrl-C.
2740
2741 By default, Exim listens for incoming connections to the standard SMTP port on
2742 all the host's running interfaces. However, it is possible to listen on other
2743 ports, on multiple ports, and only on specific interfaces. Chapter
2744 &<<CHAPinterfaces>>& contains a description of the options that control this.
2745
2746 When a listening daemon
2747 .cindex "daemon" "process id (pid)"
2748 .cindex "pid (process id)" "of daemon"
2749 is started without the use of &%-oX%& (that is, without overriding the normal
2750 configuration), it writes its process id to a file called &_exim-daemon.pid_&
2751 in Exim's spool directory. This location can be overridden by setting
2752 PID_FILE_PATH in &_Local/Makefile_&. The file is written while Exim is still
2753 running as root.
2754
2755 When &%-oX%& is used on the command line to start a listening daemon, the
2756 process id is not written to the normal pid file path. However, &%-oP%& can be
2757 used to specify a path on the command line if a pid file is required.
2758
2759 The SIGHUP signal
2760 .cindex "SIGHUP"
2761 .cindex "daemon" "restarting"
2762 can be used to cause the daemon to re-execute itself. This should be done
2763 whenever Exim's configuration file, or any file that is incorporated into it by
2764 means of the &%.include%& facility, is changed, and also whenever a new version
2765 of Exim is installed. It is not necessary to do this when other files that are
2766 referenced from the configuration (for example, alias files) are changed,
2767 because these are reread each time they are used.
2768
2769 .vitem &%-bdf%&
2770 .oindex "&%-bdf%&"
2771 This option has the same effect as &%-bd%& except that it never disconnects
2772 from the controlling terminal, even when no debugging is specified.
2773
2774 .vitem &%-be%&
2775 .oindex "&%-be%&"
2776 .cindex "testing" "string expansion"
2777 .cindex "expansion" "testing"
2778 Run Exim in expansion testing mode. Exim discards its root privilege, to
2779 prevent ordinary users from using this mode to read otherwise inaccessible
2780 files. If no arguments are given, Exim runs interactively, prompting for lines
2781 of data. Otherwise, it processes each argument in turn.
2782
2783 If Exim was built with USE_READLINE=yes in &_Local/Makefile_&, it tries
2784 to load the &%libreadline%& library dynamically whenever the &%-be%& option is
2785 used without command line arguments. If successful, it uses the &[readline()]&
2786 function, which provides extensive line-editing facilities, for reading the
2787 test data. A line history is supported.
2788
2789 Long expansion expressions can be split over several lines by using backslash
2790 continuations. As in Exim's run time configuration, white space at the start of
2791 continuation lines is ignored. Each argument or data line is passed through the
2792 string expansion mechanism, and the result is output. Variable values from the
2793 configuration file (for example, &$qualify_domain$&) are available, but no
2794 message-specific values (such as &$sender_domain$&) are set, because no message
2795 is being processed (but see &%-bem%& and &%-Mset%&).
2796
2797 &*Note*&: If you use this mechanism to test lookups, and you change the data
2798 files or databases you are using, you must exit and restart Exim before trying
2799 the same lookup again. Otherwise, because each Exim process caches the results
2800 of lookups, you will just get the same result as before.
2801
2802 .vitem &%-bem%&&~<&'filename'&>
2803 .oindex "&%-bem%&"
2804 .cindex "testing" "string expansion"
2805 .cindex "expansion" "testing"
2806 This option operates like &%-be%& except that it must be followed by the name
2807 of a file. For example:
2808 .code
2809 exim -bem /tmp/testmessage
2810 .endd
2811 The file is read as a message (as if receiving a locally-submitted non-SMTP
2812 message) before any of the test expansions are done. Thus, message-specific
2813 variables such as &$message_size$& and &$header_from:$& are available. However,
2814 no &'Received:'& header is added to the message. If the &%-t%& option is set,
2815 recipients are read from the headers in the normal way, and are shown in the
2816 &$recipients$& variable. Note that recipients cannot be given on the command
2817 line, because further arguments are taken as strings to expand (just like
2818 &%-be%&).
2819
2820 .vitem &%-bF%&&~<&'filename'&>
2821 .oindex "&%-bF%&"
2822 .cindex "system filter" "testing"
2823 .cindex "testing" "system filter"
2824 This option is the same as &%-bf%& except that it assumes that the filter being
2825 tested is a system filter. The additional commands that are available only in
2826 system filters are recognized.
2827
2828 .vitem &%-bf%&&~<&'filename'&>
2829 .oindex "&%-bf%&"
2830 .cindex "filter" "testing"
2831 .cindex "testing" "filter file"
2832 .cindex "forward file" "testing"
2833 .cindex "testing" "forward file"
2834 .cindex "Sieve filter" "testing"
2835 This option runs Exim in user filter testing mode; the file is the filter file
2836 to be tested, and a test message must be supplied on the standard input. If
2837 there are no message-dependent tests in the filter, an empty file can be
2838 supplied.
2839
2840 If you want to test a system filter file, use &%-bF%& instead of &%-bf%&. You
2841 can use both &%-bF%& and &%-bf%& on the same command, in order to test a system
2842 filter and a user filter in the same run. For example:
2843 .code
2844 exim -bF /system/filter -bf /user/filter </test/message
2845 .endd
2846 This is helpful when the system filter adds header lines or sets filter
2847 variables that are used by the user filter.
2848
2849 If the test filter file does not begin with one of the special lines
2850 .code
2851 # Exim filter
2852 # Sieve filter
2853 .endd
2854 it is taken to be a normal &_.forward_& file, and is tested for validity under
2855 that interpretation. See sections &<<SECTitenonfilred>>& to
2856 &<<SECTspecitredli>>& for a description of the possible contents of non-filter
2857 redirection lists.
2858
2859 The result of an Exim command that uses &%-bf%&, provided no errors are
2860 detected, is a list of the actions that Exim would try to take if presented
2861 with the message for real. More details of filter testing are given in the
2862 separate document entitled &'Exim's interfaces to mail filtering'&.
2863
2864 When testing a filter file,
2865 .cindex "&""From""& line"
2866 .cindex "envelope sender"
2867 .oindex "&%-f%&" "for filter testing"
2868 the envelope sender can be set by the &%-f%& option,
2869 or by a &"From&~"& line at the start of the test message. Various parameters
2870 that would normally be taken from the envelope recipient address of the message
2871 can be set by means of additional command line options (see the next four
2872 options).
2873
2874 .vitem &%-bfd%&&~<&'domain'&>
2875 .oindex "&%-bfd%&"
2876 .vindex "&$qualify_domain$&"
2877 This sets the domain of the recipient address when a filter file is being
2878 tested by means of the &%-bf%& option. The default is the value of
2879 &$qualify_domain$&.
2880
2881 .vitem &%-bfl%&&~<&'local&~part'&>
2882 .oindex "&%-bfl%&"
2883 This sets the local part of the recipient address when a filter file is being
2884 tested by means of the &%-bf%& option. The default is the username of the
2885 process that calls Exim. A local part should be specified with any prefix or
2886 suffix stripped, because that is how it appears to the filter when a message is
2887 actually being delivered.
2888
2889 .vitem &%-bfp%&&~<&'prefix'&>
2890 .oindex "&%-bfp%&"
2891 This sets the prefix of the local part of the recipient address when a filter
2892 file is being tested by means of the &%-bf%& option. The default is an empty
2893 prefix.
2894
2895 .vitem &%-bfs%&&~<&'suffix'&>
2896 .oindex "&%-bfs%&"
2897 This sets the suffix 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 suffix.
2900
2901 .vitem &%-bh%&&~<&'IP&~address'&>
2902 .oindex "&%-bh%&"
2903 .cindex "testing" "incoming SMTP"
2904 .cindex "SMTP" "testing incoming"
2905 .cindex "testing" "relay control"
2906 .cindex "relaying" "testing configuration"
2907 .cindex "policy control" "testing"
2908 .cindex "debugging" "&%-bh%& option"
2909 This option runs a fake SMTP session as if from the given IP address, using the
2910 standard input and output. The IP address may include a port number at the end,
2911 after a full stop. For example:
2912 .code
2913 exim -bh 10.9.8.7.1234
2914 exim -bh fe80::a00:20ff:fe86:a061.5678
2915 .endd
2916 When an IPv6 address is given, it is converted into canonical form. In the case
2917 of the second example above, the value of &$sender_host_address$& after
2918 conversion to the canonical form is
2919 &`fe80:0000:0000:0a00:20ff:fe86:a061.5678`&.
2920
2921 Comments as to what is going on are written to the standard error file. These
2922 include lines beginning with &"LOG"& for anything that would have been logged.
2923 This facility is provided for testing configuration options for incoming
2924 messages, to make sure they implement the required policy. For example, you can
2925 test your relay controls using &%-bh%&.
2926
2927 &*Warning 1*&:
2928 .cindex "RFC 1413"
2929 You can test features of the configuration that rely on ident (RFC 1413)
2930 information by using the &%-oMt%& option. However, Exim cannot actually perform
2931 an ident callout when testing using &%-bh%& because there is no incoming SMTP
2932 connection.
2933
2934 &*Warning 2*&: Address verification callouts (see section &<<SECTcallver>>&)
2935 are also skipped when testing using &%-bh%&. If you want these callouts to
2936 occur, use &%-bhc%& instead.
2937
2938 Messages supplied during the testing session are discarded, and nothing is
2939 written to any of the real log files. There may be pauses when DNS (and other)
2940 lookups are taking place, and of course these may time out. The &%-oMi%& option
2941 can be used to specify a specific IP interface and port if this is important,
2942 and &%-oMaa%& and &%-oMai%& can be used to set parameters as if the SMTP
2943 session were authenticated.
2944
2945 The &'exim_checkaccess'& utility is a &"packaged"& version of &%-bh%& whose
2946 output just states whether a given recipient address from a given host is
2947 acceptable or not. See section &<<SECTcheckaccess>>&.
2948
2949 Features such as authentication and encryption, where the client input is not
2950 plain text, cannot easily be tested with &%-bh%&. Instead, you should use a
2951 specialized SMTP test program such as
2952 &url(http://jetmore.org/john/code/#swaks,swaks).
2953
2954 .vitem &%-bhc%&&~<&'IP&~address'&>
2955 .oindex "&%-bhc%&"
2956 This option operates in the same way as &%-bh%&, except that address
2957 verification callouts are performed if required. This includes consulting and
2958 updating the callout cache database.
2959
2960 .vitem &%-bi%&
2961 .oindex "&%-bi%&"
2962 .cindex "alias file" "building"
2963 .cindex "building alias file"
2964 .cindex "Sendmail compatibility" "&%-bi%& option"
2965 Sendmail interprets the &%-bi%& option as a request to rebuild its alias file.
2966 Exim does not have the concept of a single alias file, and so it cannot mimic
2967 this behaviour. However, calls to &_/usr/lib/sendmail_& with the &%-bi%& option
2968 tend to appear in various scripts such as NIS make files, so the option must be
2969 recognized.
2970
2971 If &%-bi%& is encountered, the command specified by the &%bi_command%&
2972 configuration option is run, under the uid and gid of the caller of Exim. If
2973 the &%-oA%& option is used, its value is passed to the command as an argument.
2974 The command set by &%bi_command%& may not contain arguments. The command can
2975 use the &'exim_dbmbuild'& utility, or some other means, to rebuild alias files
2976 if this is required. If the &%bi_command%& option is not set, calling Exim with
2977 &%-bi%& is a no-op.
2978
2979 . // Keep :help first, then the rest in alphabetical order
2980 .vitem &%-bI:help%&
2981 .oindex "&%-bI:help%&"
2982 .cindex "querying exim information"
2983 We shall provide various options starting &`-bI:`& for querying Exim for
2984 information.  The output of many of these will be intended for machine
2985 consumption.  This one is not.  The &%-bI:help%& option asks Exim for a
2986 synopsis of supported options beginning &`-bI:`&.  Use of any of these
2987 options shall cause Exim to exit after producing the requested output.
2988
2989 .vitem &%-bI:dscp%&
2990 .oindex "&%-bI:dscp%&"
2991 .cindex "DSCP" "values"
2992 This option causes Exim to emit an alphabetically sorted list of all
2993 recognised DSCP names.
2994
2995 .vitem &%-bI:sieve%&
2996 .oindex "&%-bI:sieve%&"
2997 .cindex "Sieve filter" "capabilities"
2998 This option causes Exim to emit an alphabetically sorted list of all supported
2999 Sieve protocol extensions on stdout, one per line.  This is anticipated to be
3000 useful for ManageSieve (RFC 5804) implementations, in providing that protocol's
3001 &`SIEVE`& capability response line.  As the precise list may depend upon
3002 compile-time build options, which this option will adapt to, this is the only
3003 way to guarantee a correct response.
3004
3005 .vitem &%-bm%&
3006 .oindex "&%-bm%&"
3007 .cindex "local message reception"
3008 This option runs an Exim receiving process that accepts an incoming,
3009 locally-generated message on the standard input. The recipients are given as the
3010 command arguments (except when &%-t%& is also present &-- see below). Each
3011 argument can be a comma-separated list of RFC 2822 addresses. This is the
3012 default option for selecting the overall action of an Exim call; it is assumed
3013 if no other conflicting option is present.
3014
3015 If any addresses in the message are unqualified (have no domain), they are
3016 qualified by the values of the &%qualify_domain%& or &%qualify_recipient%&
3017 options, as appropriate. The &%-bnq%& option (see below) provides a way of
3018 suppressing this for special cases.
3019
3020 Policy checks on the contents of local messages can be enforced by means of
3021 the non-SMTP ACL. See chapter &<<CHAPACL>>& for details.
3022
3023 .cindex "return code" "for &%-bm%&"
3024 The return code is zero if the message is successfully accepted. Otherwise, the
3025 action is controlled by the &%-oe%&&'x'& option setting &-- see below.
3026
3027 The format
3028 .cindex "message" "format"
3029 .cindex "format" "message"
3030 .cindex "&""From""& line"
3031 .cindex "UUCP" "&""From""& line"
3032 .cindex "Sendmail compatibility" "&""From""& line"
3033 of the message must be as defined in RFC 2822, except that, for
3034 compatibility with Sendmail and Smail, a line in one of the forms
3035 .code
3036 From sender Fri Jan  5 12:55 GMT 1997
3037 From sender Fri, 5 Jan 97 12:55:01
3038 .endd
3039 (with the weekday optional, and possibly with additional text after the date)
3040 is permitted to appear at the start of the message. There appears to be no
3041 authoritative specification of the format of this line. Exim recognizes it by
3042 matching against the regular expression defined by the &%uucp_from_pattern%&
3043 option, which can be changed if necessary.
3044
3045 .oindex "&%-f%&" "overriding &""From""& line"
3046 The specified sender is treated as if it were given as the argument to the
3047 &%-f%& option, but if a &%-f%& option is also present, its argument is used in
3048 preference to the address taken from the message. The caller of Exim must be a
3049 trusted user for the sender of a message to be set in this way.
3050
3051 .vitem &%-bmalware%&&~<&'filename'&>
3052 .oindex "&%-bmalware%&"
3053 .cindex "testing", "malware"
3054 .cindex "malware scan test"
3055 This debugging option causes Exim to scan the given file,
3056 using the malware scanning framework.  The option of &%av_scanner%& influences
3057 this option, so if &%av_scanner%&'s value is dependent upon an expansion then
3058 the expansion should have defaults which apply to this invocation.  ACLs are
3059 not invoked, so if &%av_scanner%& references an ACL variable then that variable
3060 will never be populated and &%-bmalware%& will fail.
3061
3062 Exim will have changed working directory before resolving the filename, so
3063 using fully qualified pathnames is advisable.  Exim will be running as the Exim
3064 user when it tries to open the file, rather than as the invoking user.
3065 This option requires admin privileges.
3066
3067 The &%-bmalware%& option will not be extended to be more generally useful,
3068 there are better tools for file-scanning.  This option exists to help
3069 administrators verify their Exim and AV scanner configuration.
3070
3071 .vitem &%-bnq%&
3072 .oindex "&%-bnq%&"
3073 .cindex "address qualification, suppressing"
3074 By default, Exim automatically qualifies unqualified addresses (those
3075 without domains) that appear in messages that are submitted locally (that
3076 is, not over TCP/IP). This qualification applies both to addresses in
3077 envelopes, and addresses in header lines. Sender addresses are qualified using
3078 &%qualify_domain%&, and recipient addresses using &%qualify_recipient%& (which
3079 defaults to the value of &%qualify_domain%&).
3080
3081 Sometimes, qualification is not wanted. For example, if &%-bS%& (batch SMTP) is
3082 being used to re-submit messages that originally came from remote hosts after
3083 content scanning, you probably do not want to qualify unqualified addresses in
3084 header lines. (Such lines will be present only if you have not enabled a header
3085 syntax check in the appropriate ACL.)
3086
3087 The &%-bnq%& option suppresses all qualification of unqualified addresses in
3088 messages that originate on the local host. When this is used, unqualified
3089 addresses in the envelope provoke errors (causing message rejection) and
3090 unqualified addresses in header lines are left alone.
3091
3092
3093 .vitem &%-bP%&
3094 .oindex "&%-bP%&"
3095 .cindex "configuration options" "extracting"
3096 .cindex "options" "configuration &-- extracting"
3097 If this option is given with no arguments, it causes the values of all Exim's
3098 main configuration options to be written to the standard output. The values
3099 of one or more specific options can be requested by giving their names as
3100 arguments, for example:
3101 .code
3102 exim -bP qualify_domain hold_domains
3103 .endd
3104 .cindex "hiding configuration option values"
3105 .cindex "configuration options" "hiding value of"
3106 .cindex "options" "hiding value of"
3107 However, any option setting that is preceded by the word &"hide"& in the
3108 configuration file is not shown in full, except to an admin user. For other
3109 users, the output is as in this example:
3110 .code
3111 mysql_servers = <value not displayable>
3112 .endd
3113 If &%configure_file%& is given as an argument, the name of the run time
3114 configuration file is output.
3115 If a list of configuration files was supplied, the value that is output here
3116 is the name of the file that was actually used.
3117
3118 .cindex "options" "hiding name of"
3119 If the &%-n%& flag is given, then for most modes of &%-bP%& operation the
3120 name will not be output.
3121
3122 .cindex "daemon" "process id (pid)"
3123 .cindex "pid (process id)" "of daemon"
3124 If &%log_file_path%& or &%pid_file_path%& are given, the names of the
3125 directories where log files and daemon pid files are written are output,
3126 respectively. If these values are unset, log files are written in a
3127 sub-directory of the spool directory called &%log%&, and the pid file is
3128 written directly into the spool directory.
3129
3130 If &%-bP%& is followed by a name preceded by &`+`&, for example,
3131 .code
3132 exim -bP +local_domains
3133 .endd
3134 it searches for a matching named list of any type (domain, host, address, or
3135 local part) and outputs what it finds.
3136
3137 .cindex "options" "router &-- extracting"
3138 .cindex "options" "transport &-- extracting"
3139 .cindex "options" "authenticator &-- extracting"
3140 If one of the words &%router%&, &%transport%&, or &%authenticator%& is given,
3141 followed by the name of an appropriate driver instance, the option settings for
3142 that driver are output. For example:
3143 .code
3144 exim -bP transport local_delivery
3145 .endd
3146 The generic driver options are output first, followed by the driver's private
3147 options. A list of the names of drivers of a particular type can be obtained by
3148 using one of the words &%router_list%&, &%transport_list%&, or
3149 &%authenticator_list%&, and a complete list of all drivers with their option
3150 settings can be obtained by using &%routers%&, &%transports%&, or
3151 &%authenticators%&.
3152
3153 .cindex "options" "macro &-- extracting"
3154 If invoked by an admin user, then &%macro%&, &%macro_list%& and &%macros%&
3155 are available, similarly to the drivers.  Because macros are sometimes used
3156 for storing passwords, this option is restricted.
3157 The output format is one item per line.
3158
3159 .vitem &%-bp%&
3160 .oindex "&%-bp%&"
3161 .cindex "queue" "listing messages on"
3162 .cindex "listing" "messages on the queue"
3163 This option requests a listing of the contents of the mail queue on the
3164 standard output. If the &%-bp%& option is followed by a list of message ids,
3165 just those messages are listed. By default, this option can be used only by an
3166 admin user. However, the &%queue_list_requires_admin%& option can be set false
3167 to allow any user to see the queue.
3168
3169 Each message on the queue is displayed as in the following example:
3170 .code
3171 25m  2.9K 0t5C6f-0000c8-00 <alice@wonderland.fict.example>
3172           red.king@looking-glass.fict.example
3173           <other addresses>
3174 .endd
3175 .cindex "message" "size in queue listing"
3176 .cindex "size" "of message"
3177 The first line contains the length of time the message has been on the queue
3178 (in this case 25 minutes), the size of the message (2.9K), the unique local
3179 identifier for the message, and the message sender, as contained in the
3180 envelope. For bounce messages, the sender address is empty, and appears as
3181 &"<>"&. If the message was submitted locally by an untrusted user who overrode
3182 the default sender address, the user's login name is shown in parentheses
3183 before the sender address.
3184
3185 .cindex "frozen messages" "in queue listing"
3186 If the message is frozen (attempts to deliver it are suspended) then the text
3187 &"*** frozen ***"& is displayed at the end of this line.
3188
3189 The recipients of the message (taken from the envelope, not the headers) are
3190 displayed on subsequent lines. Those addresses to which the message has already
3191 been delivered are marked with the letter D. If an original address gets
3192 expanded into several addresses via an alias or forward file, the original is
3193 displayed with a D only when deliveries for all of its child addresses are
3194 complete.
3195
3196
3197 .vitem &%-bpa%&
3198 .oindex "&%-bpa%&"
3199 This option operates like &%-bp%&, but in addition it shows delivered addresses
3200 that were generated from the original top level address(es) in each message by
3201 alias or forwarding operations. These addresses are flagged with &"+D"& instead
3202 of just &"D"&.
3203
3204
3205 .vitem &%-bpc%&
3206 .oindex "&%-bpc%&"
3207 .cindex "queue" "count of messages on"
3208 This option counts the number of messages on the queue, and writes the total
3209 to the standard output. It is restricted to admin users, unless
3210 &%queue_list_requires_admin%& is set false.
3211
3212
3213 .vitem &%-bpr%&
3214 .oindex "&%-bpr%&"
3215 This option operates like &%-bp%&, but the output is not sorted into
3216 chronological order of message arrival. This can speed it up when there are
3217 lots of messages on the queue, and is particularly useful if the output is
3218 going to be post-processed in a way that doesn't need the sorting.
3219
3220 .vitem &%-bpra%&
3221 .oindex "&%-bpra%&"
3222 This option is a combination of &%-bpr%& and &%-bpa%&.
3223
3224 .vitem &%-bpru%&
3225 .oindex "&%-bpru%&"
3226 This option is a combination of &%-bpr%& and &%-bpu%&.
3227
3228
3229 .vitem &%-bpu%&
3230 .oindex "&%-bpu%&"
3231 This option operates like &%-bp%& but shows only undelivered top-level
3232 addresses for each message displayed. Addresses generated by aliasing or
3233 forwarding are not shown, unless the message was deferred after processing by a
3234 router with the &%one_time%& option set.
3235
3236
3237 .vitem &%-brt%&
3238 .oindex "&%-brt%&"
3239 .cindex "testing" "retry configuration"
3240 .cindex "retry" "configuration testing"
3241 This option is for testing retry rules, and it must be followed by up to three
3242 arguments. It causes Exim to look for a retry rule that matches the values
3243 and to write it to the standard output. For example:
3244 .code
3245 exim -brt bach.comp.mus.example
3246 Retry rule: *.comp.mus.example  F,2h,15m; F,4d,30m;
3247 .endd
3248 See chapter &<<CHAPretry>>& for a description of Exim's retry rules. The first
3249 argument, which is required, can be a complete address in the form
3250 &'local_part@domain'&, or it can be just a domain name. If the second argument
3251 contains a dot, it is interpreted as an optional second domain name; if no
3252 retry rule is found for the first argument, the second is tried. This ties in
3253 with Exim's behaviour when looking for retry rules for remote hosts &-- if no
3254 rule is found that matches the host, one that matches the mail domain is
3255 sought. Finally, an argument that is the name of a specific delivery error, as
3256 used in setting up retry rules, can be given. For example:
3257 .code
3258 exim -brt haydn.comp.mus.example quota_3d
3259 Retry rule: *@haydn.comp.mus.example quota_3d  F,1h,15m
3260 .endd
3261
3262 .vitem &%-brw%&
3263 .oindex "&%-brw%&"
3264 .cindex "testing" "rewriting"
3265 .cindex "rewriting" "testing"
3266 This option is for testing address rewriting rules, and it must be followed by
3267 a single argument, consisting of either a local part without a domain, or a
3268 complete address with a fully qualified domain. Exim outputs how this address
3269 would be rewritten for each possible place it might appear. See chapter
3270 &<<CHAPrewrite>>& for further details.
3271
3272 .vitem &%-bS%&
3273 .oindex "&%-bS%&"
3274 .cindex "SMTP" "batched incoming"
3275 .cindex "batched SMTP input"
3276 This option is used for batched SMTP input, which is an alternative interface
3277 for non-interactive local message submission. A number of messages can be
3278 submitted in a single run. However, despite its name, this is not really SMTP
3279 input. Exim reads each message's envelope from SMTP commands on the standard
3280 input, but generates no responses. If the caller is trusted, or
3281 &%untrusted_set_sender%& is set, the senders in the SMTP MAIL commands are
3282 believed; otherwise the sender is always the caller of Exim.
3283
3284 The message itself is read from the standard input, in SMTP format (leading
3285 dots doubled), terminated by a line containing just a single dot. An error is
3286 provoked if the terminating dot is missing. A further message may then follow.
3287
3288 As for other local message submissions, the contents of incoming batch SMTP
3289 messages can be checked using the non-SMTP ACL (see chapter &<<CHAPACL>>&).
3290 Unqualified addresses are automatically qualified using &%qualify_domain%& and
3291 &%qualify_recipient%&, as appropriate, unless the &%-bnq%& option is used.
3292
3293 Some other SMTP commands are recognized in the input. HELO and EHLO act
3294 as RSET; VRFY, EXPN, ETRN, and HELP act as NOOP;
3295 QUIT quits, ignoring the rest of the standard input.
3296
3297 .cindex "return code" "for &%-bS%&"
3298 If any error is encountered, reports are written to the standard output and
3299 error streams, and Exim gives up immediately. The return code is 0 if no error
3300 was detected; it is 1 if one or more messages were accepted before the error
3301 was detected; otherwise it is 2.
3302
3303 More details of input using batched SMTP are given in section
3304 &<<SECTincomingbatchedSMTP>>&.
3305
3306 .vitem &%-bs%&
3307 .oindex "&%-bs%&"
3308 .cindex "SMTP" "local input"
3309 .cindex "local SMTP input"
3310 This option causes Exim to accept one or more messages by reading SMTP commands
3311 on the standard input, and producing SMTP replies on the standard output. SMTP
3312 policy controls, as defined in ACLs (see chapter &<<CHAPACL>>&) are applied.
3313 Some user agents use this interface as a way of passing locally-generated
3314 messages to the MTA.
3315
3316 In
3317 .cindex "sender" "source of"
3318 this usage, if the caller of Exim is trusted, or &%untrusted_set_sender%& is
3319 set, the senders of messages are taken from the SMTP MAIL commands.
3320 Otherwise the content of these commands is ignored and the sender is set up as
3321 the calling user. Unqualified addresses are automatically qualified using
3322 &%qualify_domain%& and &%qualify_recipient%&, as appropriate, unless the
3323 &%-bnq%& option is used.
3324
3325 .cindex "inetd"
3326 The
3327 &%-bs%& option is also used to run Exim from &'inetd'&, as an alternative to
3328 using a listening daemon. Exim can distinguish the two cases by checking
3329 whether the standard input is a TCP/IP socket. When Exim is called from
3330 &'inetd'&, the source of the mail is assumed to be remote, and the comments
3331 above concerning senders and qualification do not apply. In this situation,
3332 Exim behaves in exactly the same way as it does when receiving a message via
3333 the listening daemon.
3334
3335 .vitem &%-bt%&
3336 .oindex "&%-bt%&"
3337 .cindex "testing" "addresses"
3338 .cindex "address" "testing"
3339 This option runs Exim in address testing mode, in which each argument is taken
3340 as a recipient address to be tested for deliverability. The results are
3341 written to the standard output. If a test fails, and the caller is not an admin
3342 user, no details of the failure are output, because these might contain
3343 sensitive information such as usernames and passwords for database lookups.
3344
3345 If no arguments are given, Exim runs in an interactive manner, prompting with a
3346 right angle bracket for addresses to be tested.
3347
3348 Unlike the &%-be%& test option, you cannot arrange for Exim to use the
3349 &[readline()]& function, because it is running as &'root'& and there are
3350 security issues.
3351
3352 Each address is handled as if it were the recipient address of a message
3353 (compare the &%-bv%& option). It is passed to the routers and the result is
3354 written to the standard output. However, any router that has
3355 &%no_address_test%& set is bypassed. This can make &%-bt%& easier to use for
3356 genuine routing tests if your first router passes everything to a scanner
3357 program.
3358
3359 .cindex "return code" "for &%-bt%&"
3360 The return code is 2 if any address failed outright; it is 1 if no address
3361 failed outright but at least one could not be resolved for some reason. Return
3362 code 0 is given only when all addresses succeed.
3363
3364 .cindex "duplicate addresses"
3365 &*Note*&: When actually delivering a message, Exim removes duplicate recipient
3366 addresses after routing is complete, so that only one delivery takes place.
3367 This does not happen when testing with &%-bt%&; the full results of routing are
3368 always shown.
3369
3370 &*Warning*&: &%-bt%& can only do relatively simple testing. If any of the
3371 routers in the configuration makes any tests on the sender address of a
3372 message,
3373 .oindex "&%-f%&" "for address testing"
3374 you can use the &%-f%& option to set an appropriate sender when running
3375 &%-bt%& tests. Without it, the sender is assumed to be the calling user at the
3376 default qualifying domain. However, if you have set up (for example) routers
3377 whose behaviour depends on the contents of an incoming message, you cannot test
3378 those conditions using &%-bt%&. The &%-N%& option provides a possible way of
3379 doing such tests.
3380
3381 .vitem &%-bV%&
3382 .oindex "&%-bV%&"
3383 .cindex "version number of Exim"
3384 This option causes Exim to write the current version number, compilation
3385 number, and compilation date of the &'exim'& binary to the standard output.
3386 It also lists the DBM library that is being used, the optional modules (such as
3387 specific lookup types), the drivers that are included in the binary, and the
3388 name of the run time configuration file that is in use.
3389
3390 As part of its operation, &%-bV%& causes Exim to read and syntax check its
3391 configuration file. However, this is a static check only. It cannot check
3392 values that are to be expanded. For example, although a misspelt ACL verb is
3393 detected, an error in the verb's arguments is not. You cannot rely on &%-bV%&
3394 alone to discover (for example) all the typos in the configuration; some
3395 realistic testing is needed. The &%-bh%& and &%-N%& options provide more
3396 dynamic testing facilities.
3397
3398 .vitem &%-bv%&
3399 .oindex "&%-bv%&"
3400 .cindex "verifying address" "using &%-bv%&"
3401 .cindex "address" "verification"
3402 This option runs Exim in address verification mode, in which each argument is
3403 taken as a recipient address to be verified by the routers. (This does
3404 not involve any verification callouts). During normal operation, verification
3405 happens mostly as a consequence processing a &%verify%& condition in an ACL
3406 (see chapter &<<CHAPACL>>&). If you want to test an entire ACL, possibly
3407 including callouts, see the &%-bh%& and &%-bhc%& options.
3408
3409 If verification fails, and the caller is not an admin user, no details of the
3410 failure are output, because these might contain sensitive information such as
3411 usernames and passwords for database lookups.
3412
3413 If no arguments are given, Exim runs in an interactive manner, prompting with a
3414 right angle bracket for addresses to be verified.
3415
3416 Unlike the &%-be%& test option, you cannot arrange for Exim to use the
3417 &[readline()]& function, because it is running as &'exim'& and there are
3418 security issues.
3419
3420 Verification differs from address testing (the &%-bt%& option) in that routers
3421 that have &%no_verify%& set are skipped, and if the address is accepted by a
3422 router that has &%fail_verify%& set, verification fails. The address is
3423 verified as a recipient if &%-bv%& is used; to test verification for a sender
3424 address, &%-bvs%& should be used.
3425
3426 If the &%-v%& option is not set, the output consists of a single line for each
3427 address, stating whether it was verified or not, and giving a reason in the
3428 latter case. Without &%-v%&, generating more than one address by redirection
3429 causes verification to end successfully, without considering the generated
3430 addresses. However, if just one address is generated, processing continues,
3431 and the generated address must verify successfully for the overall verification
3432 to succeed.
3433
3434 When &%-v%& is set, more details are given of how the address has been handled,
3435 and in the case of address redirection, all the generated addresses are also
3436 considered. Verification may succeed for some and fail for others.
3437
3438 The
3439 .cindex "return code" "for &%-bv%&"
3440 return code is 2 if any address failed outright; it is 1 if no address
3441 failed outright but at least one could not be resolved for some reason. Return
3442 code 0 is given only when all addresses succeed.
3443
3444 If any of the routers in the configuration makes any tests on the sender
3445 address of a message, you should use the &%-f%& option to set an appropriate
3446 sender when running &%-bv%& tests. Without it, the sender is assumed to be the
3447 calling user at the default qualifying domain.
3448
3449 .vitem &%-bvs%&
3450 .oindex "&%-bvs%&"
3451 This option acts like &%-bv%&, but verifies the address as a sender rather
3452 than a recipient address. This affects any rewriting and qualification that
3453 might happen.
3454
3455 .vitem &%-bw%&
3456 .oindex "&%-bw%&"
3457 .cindex "daemon"
3458 .cindex "inetd"
3459 .cindex "inetd" "wait mode"
3460 This option runs Exim as a daemon, awaiting incoming SMTP connections,
3461 similarly to the &%-bd%& option.  All port specifications on the command-line
3462 and in the configuration file are ignored.  Queue-running may not be specified.
3463
3464 In this mode, Exim expects to be passed a socket as fd 0 (stdin) which is
3465 listening for connections.  This permits the system to start up and have
3466 inetd (or equivalent) listen on the SMTP ports, starting an Exim daemon for
3467 each port only when the first connection is received.
3468
3469 If the option is given as &%-bw%&<&'time'&> then the time is a timeout, after
3470 which the daemon will exit, which should cause inetd to listen once more.
3471
3472 .vitem &%-C%&&~<&'filelist'&>
3473 .oindex "&%-C%&"
3474 .cindex "configuration file" "alternate"
3475 .cindex "CONFIGURE_FILE"
3476 .cindex "alternate configuration file"
3477 This option causes Exim to find the run time configuration file from the given
3478 list instead of from the list specified by the CONFIGURE_FILE
3479 compile-time setting. Usually, the list will consist of just a single file
3480 name, but it can be a colon-separated list of names. In this case, the first
3481 file that exists is used. Failure to open an existing file stops Exim from
3482 proceeding any further along the list, and an error is generated.
3483
3484 When this option is used by a caller other than root, and the list is different
3485 from the compiled-in list, Exim gives up its root privilege immediately, and
3486 runs with the real and effective uid and gid set to those of the caller.
3487 However, if a TRUSTED_CONFIG_LIST file is defined in &_Local/Makefile_&, that
3488 file contains a list of full pathnames, one per line, for configuration files
3489 which are trusted. Root privilege is retained for any configuration file so
3490 listed, as long as the caller is the Exim user (or the user specified in the
3491 CONFIGURE_OWNER option, if any), and as long as the configuration file is
3492 not writeable by inappropriate users or groups.
3493
3494 Leaving TRUSTED_CONFIG_LIST unset precludes the possibility of testing a
3495 configuration using &%-C%& right through message reception and delivery,
3496 even if the caller is root. The reception works, but by that time, Exim is
3497 running as the Exim user, so when it re-executes to regain privilege for the
3498 delivery, the use of &%-C%& causes privilege to be lost. However, root can
3499 test reception and delivery using two separate commands (one to put a message
3500 on the queue, using &%-odq%&, and another to do the delivery, using &%-M%&).
3501
3502 If ALT_CONFIG_PREFIX is defined &_in Local/Makefile_&, it specifies a
3503 prefix string with which any file named in a &%-C%& command line option
3504 must start. In addition, the file name must not contain the sequence &`/../`&.
3505 However, if the value of the &%-C%& option is identical to the value of
3506 CONFIGURE_FILE in &_Local/Makefile_&, Exim ignores &%-C%& and proceeds as
3507 usual. There is no default setting for ALT_CONFIG_PREFIX; when it is
3508 unset, any file name can be used with &%-C%&.
3509
3510 ALT_CONFIG_PREFIX can be used to confine alternative configuration files
3511 to a directory to which only root has access. This prevents someone who has
3512 broken into the Exim account from running a privileged Exim with an arbitrary
3513 configuration file.
3514
3515 The &%-C%& facility is useful for ensuring that configuration files are
3516 syntactically correct, but cannot be used for test deliveries, unless the
3517 caller is privileged, or unless it is an exotic configuration that does not
3518 require privilege. No check is made on the owner or group of the files
3519 specified by this option.
3520
3521
3522 .vitem &%-D%&<&'macro'&>=<&'value'&>
3523 .oindex "&%-D%&"
3524 .cindex "macro" "setting on command line"
3525 This option can be used to override macro definitions in the configuration file
3526 (see section &<<SECTmacrodefs>>&). However, like &%-C%&, if it is used by an
3527 unprivileged caller, it causes Exim to give up its root privilege.
3528 If DISABLE_D_OPTION is defined in &_Local/Makefile_&, the use of &%-D%& is
3529 completely disabled, and its use causes an immediate error exit.
3530
3531 If WHITELIST_D_MACROS is defined in &_Local/Makefile_& then it should be a
3532 colon-separated list of macros which are considered safe and, if &%-D%& only
3533 supplies macros from this list, and the values are acceptable, then Exim will
3534 not give up root privilege if the caller is root, the Exim run-time user, or
3535 the CONFIGURE_OWNER, if set.  This is a transition mechanism and is expected
3536 to be removed in the future.  Acceptable values for the macros satisfy the
3537 regexp: &`^[A-Za-z0-9_/.-]*$`&
3538
3539 The entire option (including equals sign if present) must all be within one
3540 command line item. &%-D%& can be used to set the value of a macro to the empty
3541 string, in which case the equals sign is optional. These two commands are
3542 synonymous:
3543 .code
3544 exim -DABC  ...
3545 exim -DABC= ...
3546 .endd
3547 To include spaces in a macro definition item, quotes must be used. If you use
3548 quotes, spaces are permitted around the macro name and the equals sign. For
3549 example:
3550 .code
3551 exim '-D ABC = something' ...
3552 .endd
3553 &%-D%& may be repeated up to 10 times on a command line.
3554
3555
3556 .vitem &%-d%&<&'debug&~options'&>
3557 .oindex "&%-d%&"
3558 .cindex "debugging" "list of selectors"
3559 .cindex "debugging" "&%-d%& option"
3560 This option causes debugging information to be written to the standard
3561 error stream. It is restricted to admin users because debugging output may show
3562 database queries that contain password information. Also, the details of users'
3563 filter files should be protected. If a non-admin user uses &%-d%&, Exim
3564 writes an error message to the standard error stream and exits with a non-zero
3565 return code.
3566
3567 When &%-d%& is used, &%-v%& is assumed. If &%-d%& is given on its own, a lot of
3568 standard debugging data is output. This can be reduced, or increased to include
3569 some more rarely needed information, by directly following &%-d%& with a string
3570 made up of names preceded by plus or minus characters. These add or remove sets
3571 of debugging data, respectively. For example, &%-d+filter%& adds filter
3572 debugging, whereas &%-d-all+filter%& selects only filter debugging. Note that
3573 no spaces are allowed in the debug setting. The available debugging categories
3574 are:
3575 .display
3576 &`acl            `& ACL interpretation
3577 &`auth           `& authenticators
3578 &`deliver        `& general delivery logic
3579 &`dns            `& DNS lookups (see also resolver)
3580 &`dnsbl          `& DNS black list (aka RBL) code
3581 &`exec           `& arguments for &[execv()]& calls
3582 &`expand         `& detailed debugging for string expansions
3583 &`filter         `& filter handling
3584 &`hints_lookup   `& hints data lookups
3585 &`host_lookup    `& all types of name-to-IP address handling
3586 &`ident          `& ident lookup
3587 &`interface      `& lists of local interfaces
3588 &`lists          `& matching things in lists
3589 &`load           `& system load checks
3590 &`local_scan     `& can be used by &[local_scan()]& (see chapter &&&
3591                     &<<CHAPlocalscan>>&)
3592 &`lookup         `& general lookup code and all lookups
3593 &`memory         `& memory handling
3594 &`pid            `& add pid to debug output lines
3595 &`process_info   `& setting info for the process log
3596 &`queue_run      `& queue runs
3597 &`receive        `& general message reception logic
3598 &`resolver       `& turn on the DNS resolver's debugging output
3599 &`retry          `& retry handling
3600 &`rewrite        `& address rewriting
3601 &`route          `& address routing
3602 &`timestamp      `& add timestamp to debug output lines
3603 &`tls            `& TLS logic
3604 &`transport      `& transports
3605 &`uid            `& changes of uid/gid and looking up uid/gid
3606 &`verify         `& address verification logic
3607 &`all            `& almost all of the above (see below), and also &%-v%&
3608 .endd
3609 The &`all`& option excludes &`memory`& when used as &`+all`&, but includes it
3610 for &`-all`&. The reason for this is that &`+all`& is something that people
3611 tend to use when generating debug output for Exim maintainers. If &`+memory`&
3612 is included, an awful lot of output that is very rarely of interest is
3613 generated, so it now has to be explicitly requested. However, &`-all`& does
3614 turn everything off.
3615
3616 .cindex "resolver, debugging output"
3617 .cindex "DNS resolver, debugging output"
3618 The &`resolver`& option produces output only if the DNS resolver was compiled
3619 with DEBUG enabled. This is not the case in some operating systems. Also,
3620 unfortunately, debugging output from the DNS resolver is written to stdout
3621 rather than stderr.
3622
3623 The default (&%-d%& with no argument) omits &`expand`&, &`filter`&,
3624 &`interface`&, &`load`&, &`memory`&, &`pid`&, &`resolver`&, and &`timestamp`&.
3625 However, the &`pid`& selector is forced when debugging is turned on for a
3626 daemon, which then passes it on to any re-executed Exims. Exim also
3627 automatically adds the pid to debug lines when several remote deliveries are
3628 run in parallel.
3629
3630 The &`timestamp`& selector causes the current time to be inserted at the start
3631 of all debug output lines. This can be useful when trying to track down delays
3632 in processing.
3633
3634 If the &%debug_print%& option is set in any driver, it produces output whenever
3635 any debugging is selected, or if &%-v%& is used.
3636
3637 .vitem &%-dd%&<&'debug&~options'&>
3638 .oindex "&%-dd%&"
3639 This option behaves exactly like &%-d%& except when used on a command that
3640 starts a daemon process. In that case, debugging is turned off for the
3641 subprocesses that the daemon creates. Thus, it is useful for monitoring the
3642 behaviour of the daemon without creating as much output as full debugging does.
3643
3644 .vitem &%-dropcr%&
3645 .oindex "&%-dropcr%&"
3646 This is an obsolete option that is now a no-op. It used to affect the way Exim
3647 handled CR and LF characters in incoming messages. What happens now is
3648 described in section &<<SECTlineendings>>&.
3649
3650 .vitem &%-E%&
3651 .oindex "&%-E%&"
3652 .cindex "bounce message" "generating"
3653 This option specifies that an incoming message is a locally-generated delivery
3654 failure report. It is used internally by Exim when handling delivery failures
3655 and is not intended for external use. Its only effect is to stop Exim
3656 generating certain messages to the postmaster, as otherwise message cascades
3657 could occur in some situations. As part of the same option, a message id may
3658 follow the characters &%-E%&. If it does, the log entry for the receipt of the
3659 new message contains the id, following &"R="&, as a cross-reference.
3660
3661 .vitem &%-e%&&'x'&
3662 .oindex "&%-e%&&'x'&"
3663 There are a number of Sendmail options starting with &%-oe%& which seem to be
3664 called by various programs without the leading &%o%& in the option. For
3665 example, the &%vacation%& program uses &%-eq%&. Exim treats all options of the
3666 form &%-e%&&'x'& as synonymous with the corresponding &%-oe%&&'x'& options.
3667
3668 .vitem &%-F%&&~<&'string'&>
3669 .oindex "&%-F%&"
3670 .cindex "sender" "name"
3671 .cindex "name" "of sender"
3672 This option sets the sender's full name for use when a locally-generated
3673 message is being accepted. In the absence of this option, the user's &'gecos'&
3674 entry from the password data is used. As users are generally permitted to alter
3675 their &'gecos'& entries, no security considerations are involved. White space
3676 between &%-F%& and the <&'string'&> is optional.
3677
3678 .vitem &%-f%&&~<&'address'&>
3679 .oindex "&%-f%&"
3680 .cindex "sender" "address"
3681 .cindex "address" "sender"
3682 .cindex "trusted users"
3683 .cindex "envelope sender"
3684 .cindex "user" "trusted"
3685 This option sets the address of the envelope sender of a locally-generated
3686 message (also known as the return path). The option can normally be used only
3687 by a trusted user, but &%untrusted_set_sender%& can be set to allow untrusted
3688 users to use it.
3689
3690 Processes running as root or the Exim user are always trusted. Other
3691 trusted users are defined by the &%trusted_users%& or &%trusted_groups%&
3692 options. In the absence of &%-f%&, or if the caller is not trusted, the sender
3693 of a local message is set to the caller's login name at the default qualify
3694 domain.
3695
3696 There is one exception to the restriction on the use of &%-f%&: an empty sender
3697 can be specified by any user, trusted or not, to create a message that can
3698 never provoke a bounce. An empty sender can be specified either as an empty
3699 string, or as a pair of angle brackets with nothing between them, as in these
3700 examples of shell commands:
3701 .code
3702 exim -f '<>' user@domain
3703 exim -f "" user@domain
3704 .endd
3705 In addition, the use of &%-f%& is not restricted when testing a filter file
3706 with &%-bf%& or when testing or verifying addresses using the &%-bt%& or
3707 &%-bv%& options.
3708
3709 Allowing untrusted users to change the sender address does not of itself make
3710 it possible to send anonymous mail. Exim still checks that the &'From:'& header
3711 refers to the local user, and if it does not, it adds a &'Sender:'& header,
3712 though this can be overridden by setting &%no_local_from_check%&.
3713
3714 White
3715 .cindex "&""From""& line"
3716 space between &%-f%& and the <&'address'&> is optional (that is, they can be
3717 given as two arguments or one combined argument). The sender of a
3718 locally-generated message can also be set (when permitted) by an initial
3719 &"From&~"& line in the message &-- see the description of &%-bm%& above &-- but
3720 if &%-f%& is also present, it overrides &"From&~"&.
3721
3722 .vitem &%-G%&
3723 .oindex "&%-G%&"
3724 .cindex "submission fixups, suppressing (command-line)"
3725 This option is equivalent to an ACL applying:
3726 .code
3727 control = suppress_local_fixups
3728 .endd
3729 for every message received.  Note that Sendmail will complain about such
3730 bad formatting, where Exim silently just does not fix it up.  This may change
3731 in future.
3732
3733 As this affects audit information, the caller must be a trusted user to use
3734 this option.
3735
3736 .vitem &%-h%&&~<&'number'&>
3737 .oindex "&%-h%&"
3738 .cindex "Sendmail compatibility" "&%-h%& option ignored"
3739 This option is accepted for compatibility with Sendmail, but has no effect. (In
3740 Sendmail it overrides the &"hop count"& obtained by counting &'Received:'&
3741 headers.)
3742
3743 .vitem &%-i%&
3744 .oindex "&%-i%&"
3745 .cindex "Solaris" "&'mail'& command"
3746 .cindex "dot" "in incoming non-SMTP message"
3747 This option, which has the same effect as &%-oi%&, specifies that a dot on a
3748 line by itself should not terminate an incoming, non-SMTP message. I can find
3749 no documentation for this option in Solaris 2.4 Sendmail, but the &'mailx'&
3750 command in Solaris 2.4 uses it. See also &%-ti%&.
3751
3752 .vitem &%-L%&&~<&'tag'&>
3753 .oindex "&%-L%&"
3754 .cindex "syslog" "process name; set with flag"
3755 This option is equivalent to setting &%syslog_processname%& in the config
3756 file and setting &%log_file_path%& to &`syslog`&.
3757 Its use is restricted to administrators.  The configuration file has to be
3758 read and parsed, to determine access rights, before this is set and takes
3759 effect, so early configuration file errors will not honour this flag.
3760
3761 The tag should not be longer than 32 characters.
3762
3763 .vitem &%-M%&&~<&'message&~id'&>&~<&'message&~id'&>&~...
3764 .oindex "&%-M%&"
3765 .cindex "forcing delivery"
3766 .cindex "delivery" "forcing attempt"
3767 .cindex "frozen messages" "forcing delivery"
3768 This option requests Exim to run a delivery attempt on each message in turn. If
3769 any of the messages are frozen, they are automatically thawed before the
3770 delivery attempt. The settings of &%queue_domains%&, &%queue_smtp_domains%&,
3771 and &%hold_domains%& are ignored.
3772
3773 Retry
3774 .cindex "hints database" "overriding retry hints"
3775 hints for any of the addresses are overridden &-- Exim tries to deliver even if
3776 the normal retry time has not yet been reached. This option requires the caller
3777 to be an admin user. However, there is an option called &%prod_requires_admin%&
3778 which can be set false to relax this restriction (and also the same requirement
3779 for the &%-q%&, &%-R%&, and &%-S%& options).
3780
3781 The deliveries happen synchronously, that is, the original Exim process does
3782 not terminate until all the delivery attempts have finished. No output is
3783 produced unless there is a serious error. If you want to see what is happening,
3784 use the &%-v%& option as well, or inspect Exim's main log.
3785
3786 .vitem &%-Mar%&&~<&'message&~id'&>&~<&'address'&>&~<&'address'&>&~...
3787 .oindex "&%-Mar%&"
3788 .cindex "message" "adding recipients"
3789 .cindex "recipient" "adding"
3790 This option requests Exim to add the addresses to the list of recipients of the
3791 message (&"ar"& for &"add recipients"&). The first argument must be a message
3792 id, and the remaining ones must be email addresses. However, if the message is
3793 active (in the middle of a delivery attempt), it is not altered. This option
3794 can be used only by an admin user.
3795
3796 .vitem "&%-MC%&&~<&'transport'&>&~<&'hostname'&>&~<&'sequence&~number'&>&&&
3797         &~<&'message&~id'&>"
3798 .oindex "&%-MC%&"
3799 .cindex "SMTP" "passed connection"
3800 .cindex "SMTP" "multiple deliveries"
3801 .cindex "multiple SMTP deliveries"
3802 This option is not intended for use by external callers. It is used internally
3803 by Exim to invoke another instance of itself to deliver a waiting message using
3804 an existing SMTP connection, which is passed as the standard input. Details are
3805 given in chapter &<<CHAPSMTP>>&. This must be the final option, and the caller
3806 must be root or the Exim user in order to use it.
3807
3808 .vitem &%-MCA%&
3809 .oindex "&%-MCA%&"
3810 This option is not intended for use by external callers. It is used internally
3811 by Exim in conjunction with the &%-MC%& option. It signifies that the
3812 connection to the remote host has been authenticated.
3813
3814 .vitem &%-MCP%&
3815 .oindex "&%-MCP%&"
3816 This option is not intended for use by external callers. It is used internally
3817 by Exim in conjunction with the &%-MC%& option. It signifies that the server to
3818 which Exim is connected supports pipelining.
3819
3820 .vitem &%-MCQ%&&~<&'process&~id'&>&~<&'pipe&~fd'&>
3821 .oindex "&%-MCQ%&"
3822 This option is not intended for use by external callers. It is used internally
3823 by Exim in conjunction with the &%-MC%& option when the original delivery was
3824 started by a queue runner. It passes on the process id of the queue runner,
3825 together with the file descriptor number of an open pipe. Closure of the pipe
3826 signals the final completion of the sequence of processes that are passing
3827 messages through the same SMTP connection.
3828
3829 .vitem &%-MCS%&
3830 .oindex "&%-MCS%&"
3831 This option is not intended for use by external callers. It is used internally
3832 by Exim in conjunction with the &%-MC%& option, and passes on the fact that the
3833 SMTP SIZE option should be used on messages delivered down the existing
3834 connection.
3835
3836 .vitem &%-MCT%&
3837 .oindex "&%-MCT%&"
3838 This option is not intended for use by external callers. It is used internally
3839 by Exim in conjunction with the &%-MC%& option, and passes on the fact that the
3840 host to which Exim is connected supports TLS encryption.
3841
3842 .vitem &%-Mc%&&~<&'message&~id'&>&~<&'message&~id'&>&~...
3843 .oindex "&%-Mc%&"
3844 .cindex "hints database" "not overridden by &%-Mc%&"
3845 .cindex "delivery" "manually started &-- not forced"
3846 This option requests Exim to run a delivery attempt on each message in turn,
3847 but unlike the &%-M%& option, it does check for retry hints, and respects any
3848 that are found. This option is not very useful to external callers. It is
3849 provided mainly for internal use by Exim when it needs to re-invoke itself in
3850 order to regain root privilege for a delivery (see chapter &<<CHAPsecurity>>&).
3851 However, &%-Mc%& can be useful when testing, in order to run a delivery that
3852 respects retry times and other options such as &%hold_domains%& that are
3853 overridden when &%-M%& is used. Such a delivery does not count as a queue run.
3854 If you want to run a specific delivery as if in a queue run, you should use
3855 &%-q%& with a message id argument. A distinction between queue run deliveries
3856 and other deliveries is made in one or two places.
3857
3858 .vitem &%-Mes%&&~<&'message&~id'&>&~<&'address'&>
3859 .oindex "&%-Mes%&"
3860 .cindex "message" "changing sender"
3861 .cindex "sender" "changing"
3862 This option requests Exim to change the sender address in the message to the
3863 given address, which must be a fully qualified address or &"<>"& (&"es"& for
3864 &"edit sender"&). There must be exactly two arguments. The first argument must
3865 be a message id, and the second one an email address. However, if the message
3866 is active (in the middle of a delivery attempt), its status is not altered.
3867 This option can be used only by an admin user.
3868
3869 .vitem &%-Mf%&&~<&'message&~id'&>&~<&'message&~id'&>&~...
3870 .oindex "&%-Mf%&"
3871 .cindex "freezing messages"
3872 .cindex "message" "manually freezing"
3873 This option requests Exim to mark each listed message as &"frozen"&. This
3874 prevents any delivery attempts taking place until the message is &"thawed"&,
3875 either manually or as a result of the &%auto_thaw%& configuration option.
3876 However, if any of the messages are active (in the middle of a delivery
3877 attempt), their status is not altered. This option can be used only by an admin
3878 user.
3879
3880 .vitem &%-Mg%&&~<&'message&~id'&>&~<&'message&~id'&>&~...
3881 .oindex "&%-Mg%&"
3882 .cindex "giving up on messages"
3883 .cindex "message" "abandoning delivery attempts"
3884 .cindex "delivery" "abandoning further attempts"
3885 This option requests Exim to give up trying to deliver the listed messages,
3886 including any that are frozen. However, if any of the messages are active,
3887 their status is not altered. For non-bounce messages, a delivery error message
3888 is sent to the sender, containing the text &"cancelled by administrator"&.
3889 Bounce messages are just discarded. This option can be used only by an admin
3890 user.
3891
3892 .vitem &%-Mmad%&&~<&'message&~id'&>&~<&'message&~id'&>&~...
3893 .oindex "&%-Mmad%&"
3894 .cindex "delivery" "cancelling all"
3895 This option requests Exim to mark all the recipient addresses in the messages
3896 as already delivered (&"mad"& for &"mark all delivered"&). However, if any
3897 message is active (in the middle of a delivery attempt), its status is not
3898 altered. This option can be used only by an admin user.
3899
3900 .vitem &%-Mmd%&&~<&'message&~id'&>&~<&'address'&>&~<&'address'&>&~...
3901 .oindex "&%-Mmd%&"
3902 .cindex "delivery" "cancelling by address"
3903 .cindex "recipient" "removing"
3904 .cindex "removing recipients"
3905 This option requests Exim to mark the given addresses as already delivered
3906 (&"md"& for &"mark delivered"&). The first argument must be a message id, and
3907 the remaining ones must be email addresses. These are matched to recipient
3908 addresses in the message in a case-sensitive manner. If the message is active
3909 (in the middle of a delivery attempt), its status is not altered. This option
3910 can be used only by an admin user.
3911
3912 .vitem &%-Mrm%&&~<&'message&~id'&>&~<&'message&~id'&>&~...
3913 .oindex "&%-Mrm%&"
3914 .cindex "removing messages"
3915 .cindex "abandoning mail"
3916 .cindex "message" "manually discarding"
3917 This option requests Exim to remove the given messages from the queue. No
3918 bounce messages are sent; each message is simply forgotten. However, if any of
3919 the messages are active, their status is not altered. This option can be used
3920 only by an admin user or by the user who originally caused the message to be
3921 placed on the queue.
3922
3923 .vitem &%-Mset%&&~<&'message&~id'&>
3924 .oindex "&%-Mset%&
3925 .cindex "testing" "string expansion"
3926 .cindex "expansion" "testing"
3927 This option is useful only in conjunction with &%-be%& (that is, when testing
3928 string expansions). Exim loads the given message from its spool before doing
3929 the test expansions, thus setting message-specific variables such as
3930 &$message_size$& and the header variables. The &$recipients$& variable is made
3931 available. This feature is provided to make it easier to test expansions that
3932 make use of these variables. However, this option can be used only by an admin
3933 user. See also &%-bem%&.
3934
3935 .vitem &%-Mt%&&~<&'message&~id'&>&~<&'message&~id'&>&~...
3936 .oindex "&%-Mt%&"
3937 .cindex "thawing messages"
3938 .cindex "unfreezing messages"
3939 .cindex "frozen messages" "thawing"
3940 .cindex "message" "thawing frozen"
3941 This option requests Exim to &"thaw"& any of the listed messages that are
3942 &"frozen"&, so that delivery attempts can resume. However, if any of the
3943 messages are active, their status is not altered. This option can be used only
3944 by an admin user.
3945
3946 .vitem &%-Mvb%&&~<&'message&~id'&>
3947 .oindex "&%-Mvb%&"
3948 .cindex "listing" "message body"
3949 .cindex "message" "listing body of"
3950 This option causes the contents of the message body (-D) spool file to be
3951 written to the standard output. This option can be used only by an admin user.
3952
3953 .vitem &%-Mvc%&&~<&'message&~id'&>
3954 .oindex "&%-Mvc%&"
3955 .cindex "message" "listing in RFC 2822 format"
3956 .cindex "listing" "message in RFC 2822 format"
3957 This option causes a copy of the complete message (header lines plus body) to
3958 be written to the standard output in RFC 2822 format. This option can be used
3959 only by an admin user.
3960
3961 .vitem &%-Mvh%&&~<&'message&~id'&>
3962 .oindex "&%-Mvh%&"
3963 .cindex "listing" "message headers"
3964 .cindex "header lines" "listing"
3965 .cindex "message" "listing header lines"
3966 This option causes the contents of the message headers (-H) spool file to be
3967 written to the standard output. This option can be used only by an admin user.
3968
3969 .vitem &%-Mvl%&&~<&'message&~id'&>
3970 .oindex "&%-Mvl%&"
3971 .cindex "listing" "message log"
3972 .cindex "message" "listing message log"
3973 This option causes the contents of the message log spool file to be written to
3974 the standard output. This option can be used only by an admin user.
3975
3976 .vitem &%-m%&
3977 .oindex "&%-m%&"
3978 This is apparently a synonym for &%-om%& that is accepted by Sendmail, so Exim
3979 treats it that way too.
3980
3981 .vitem &%-N%&
3982 .oindex "&%-N%&"
3983 .cindex "debugging" "&%-N%& option"
3984 .cindex "debugging" "suppressing delivery"
3985 This is a debugging option that inhibits delivery of a message at the transport
3986 level. It implies &%-v%&. Exim goes through many of the motions of delivery &--
3987 it just doesn't actually transport the message, but instead behaves as if it
3988 had successfully done so. However, it does not make any updates to the retry
3989 database, and the log entries for deliveries are flagged with &"*>"& rather
3990 than &"=>"&.
3991
3992 Because &%-N%& discards any message to which it applies, only root or the Exim
3993 user are allowed to use it with &%-bd%&, &%-q%&, &%-R%& or &%-M%&. In other
3994 words, an ordinary user can use it only when supplying an incoming message to
3995 which it will apply. Although transportation never fails when &%-N%& is set, an
3996 address may be deferred because of a configuration problem on a transport, or a
3997 routing problem. Once &%-N%& has been used for a delivery attempt, it sticks to
3998 the message, and applies to any subsequent delivery attempts that may happen
3999 for that message.
4000
4001 .vitem &%-n%&
4002 .oindex "&%-n%&"
4003 This option is interpreted by Sendmail to mean &"no aliasing"&.
4004 For normal modes of operation, it is ignored by Exim.
4005 When combined with &%-bP%& it suppresses the name of an option from being output.
4006
4007 .vitem &%-O%&&~<&'data'&>
4008 .oindex "&%-O%&"
4009 This option is interpreted by Sendmail to mean &`set option`&. It is ignored by
4010 Exim.
4011
4012 .vitem &%-oA%&&~<&'file&~name'&>
4013 .oindex "&%-oA%&"
4014 .cindex "Sendmail compatibility" "&%-oA%& option"
4015 This option is used by Sendmail in conjunction with &%-bi%& to specify an
4016 alternative alias file name. Exim handles &%-bi%& differently; see the
4017 description above.
4018
4019 .vitem &%-oB%&&~<&'n'&>
4020 .oindex "&%-oB%&"
4021 .cindex "SMTP" "passed connection"
4022 .cindex "SMTP" "multiple deliveries"
4023 .cindex "multiple SMTP deliveries"
4024 This is a debugging option which limits the maximum number of messages that can
4025 be delivered down one SMTP connection, overriding the value set in any &(smtp)&
4026 transport. If <&'n'&> is omitted, the limit is set to 1.
4027
4028 .vitem &%-odb%&
4029 .oindex "&%-odb%&"
4030 .cindex "background delivery"
4031 .cindex "delivery" "in the background"
4032 This option applies to all modes in which Exim accepts incoming messages,
4033 including the listening daemon. It requests &"background"& delivery of such
4034 messages, which means that the accepting process automatically starts a
4035 delivery process for each message received, but does not wait for the delivery
4036 processes to finish.
4037
4038 When all the messages have been received, the reception process exits,
4039 leaving the delivery processes to finish in their own time. The standard output
4040 and error streams are closed at the start of each delivery process.
4041 This is the default action if none of the &%-od%& options are present.
4042
4043 If one of the queueing options in the configuration file
4044 (&%queue_only%& or &%queue_only_file%&, for example) is in effect, &%-odb%&
4045 overrides it if &%queue_only_override%& is set true, which is the default
4046 setting. If &%queue_only_override%& is set false, &%-odb%& has no effect.
4047
4048 .vitem &%-odf%&
4049 .oindex "&%-odf%&"
4050 .cindex "foreground delivery"
4051 .cindex "delivery" "in the foreground"
4052 This option requests &"foreground"& (synchronous) delivery when Exim has
4053 accepted a locally-generated message. (For the daemon it is exactly the same as
4054 &%-odb%&.) A delivery process is automatically started to deliver the message,
4055 and Exim waits for it to complete before proceeding.
4056
4057 The original Exim reception process does not finish until the delivery
4058 process for the final message has ended. The standard error stream is left open
4059 during deliveries.
4060
4061 However, like &%-odb%&, this option has no effect if &%queue_only_override%& is
4062 false and one of the queueing options in the configuration file is in effect.
4063
4064 If there is a temporary delivery error during foreground delivery, the
4065 message is left on the queue for later delivery, and the original reception
4066 process exits. See chapter &<<CHAPnonqueueing>>& for a way of setting up a
4067 restricted configuration that never queues messages.
4068
4069
4070 .vitem &%-odi%&
4071 .oindex "&%-odi%&"
4072 This option is synonymous with &%-odf%&. It is provided for compatibility with
4073 Sendmail.
4074
4075 .vitem &%-odq%&
4076 .oindex "&%-odq%&"
4077 .cindex "non-immediate delivery"
4078 .cindex "delivery" "suppressing immediate"
4079 .cindex "queueing incoming messages"
4080 This option applies to all modes in which Exim accepts incoming messages,
4081 including the listening daemon. It specifies that the accepting process should
4082 not automatically start a delivery process for each message received. Messages
4083 are placed on the queue, and remain there until a subsequent queue runner
4084 process encounters them. There are several configuration options (such as
4085 &%queue_only%&) that can be used to queue incoming messages under certain
4086 conditions. This option overrides all of them and also &%-odqs%&. It always
4087 forces queueing.
4088
4089 .vitem &%-odqs%&
4090 .oindex "&%-odqs%&"
4091 .cindex "SMTP" "delaying delivery"
4092 This option is a hybrid between &%-odb%&/&%-odi%& and &%-odq%&.
4093 However, like &%-odb%& and &%-odi%&, this option has no effect if
4094 &%queue_only_override%& is false and one of the queueing options in the
4095 configuration file is in effect.
4096
4097 When &%-odqs%& does operate, a delivery process is started for each incoming
4098 message, in the background by default, but in the foreground if &%-odi%& is
4099 also present. The recipient addresses are routed, and local deliveries are done
4100 in the normal way. However, if any SMTP deliveries are required, they are not
4101 done at this time, so the message remains on the queue until a subsequent queue
4102 runner process encounters it. Because routing was done, Exim knows which
4103 messages are waiting for which hosts, and so a number of messages for the same
4104 host can be sent in a single SMTP connection. The &%queue_smtp_domains%&
4105 configuration option has the same effect for specific domains. See also the
4106 &%-qq%& option.
4107
4108 .vitem &%-oee%&
4109 .oindex "&%-oee%&"
4110 .cindex "error" "reporting"
4111 If an error is detected while a non-SMTP message is being received (for
4112 example, a malformed address), the error is reported to the sender in a mail
4113 message.
4114
4115 .cindex "return code" "for &%-oee%&"
4116 Provided
4117 this error message is successfully sent, the Exim receiving process
4118 exits with a return code of zero. If not, the return code is 2 if the problem
4119 is that the original message has no recipients, or 1 for any other error.
4120 This is the default &%-oe%&&'x'& option if Exim is called as &'rmail'&.
4121
4122 .vitem &%-oem%&
4123 .oindex "&%-oem%&"
4124 .cindex "error" "reporting"
4125 .cindex "return code" "for &%-oem%&"
4126 This is the same as &%-oee%&, except that Exim always exits with a non-zero
4127 return code, whether or not the error message was successfully sent.
4128 This is the default &%-oe%&&'x'& option, unless Exim is called as &'rmail'&.
4129
4130 .vitem &%-oep%&
4131 .oindex "&%-oep%&"
4132 .cindex "error" "reporting"
4133 If an error is detected while a non-SMTP message is being received, the
4134 error is reported by writing a message to the standard error file (stderr).
4135 .cindex "return code" "for &%-oep%&"
4136 The return code is 1 for all errors.
4137
4138 .vitem &%-oeq%&
4139 .oindex "&%-oeq%&"
4140 .cindex "error" "reporting"
4141 This option is supported for compatibility with Sendmail, but has the same
4142 effect as &%-oep%&.
4143
4144 .vitem &%-oew%&
4145 .oindex "&%-oew%&"
4146 .cindex "error" "reporting"
4147 This option is supported for compatibility with Sendmail, but has the same
4148 effect as &%-oem%&.
4149
4150 .vitem &%-oi%&
4151 .oindex "&%-oi%&"
4152 .cindex "dot" "in incoming non-SMTP message"
4153 This option, which has the same effect as &%-i%&, specifies that a dot on a
4154 line by itself should not terminate an incoming, non-SMTP message. Otherwise, a
4155 single dot does terminate, though Exim does no special processing for other
4156 lines that start with a dot. This option is set by default if Exim is called as
4157 &'rmail'&. See also &%-ti%&.
4158
4159 .vitem &%-oitrue%&
4160 .oindex "&%-oitrue%&"
4161 This option is treated as synonymous with &%-oi%&.
4162
4163 .vitem &%-oMa%&&~<&'host&~address'&>
4164 .oindex "&%-oMa%&"
4165 .cindex "sender" "host address, specifying for local message"
4166 A number of options starting with &%-oM%& can be used to set values associated
4167 with remote hosts on locally-submitted messages (that is, messages not received
4168 over TCP/IP). These options can be used by any caller in conjunction with the
4169 &%-bh%&, &%-be%&, &%-bf%&, &%-bF%&, &%-bt%&, or &%-bv%& testing options. In
4170 other circumstances, they are ignored unless the caller is trusted.
4171
4172 The &%-oMa%& option sets the sender host address. This may include a port
4173 number at the end, after a full stop (period). For example:
4174 .code
4175 exim -bs -oMa 10.9.8.7.1234
4176 .endd
4177 An alternative syntax is to enclose the IP address in square brackets,
4178 followed by a colon and the port number:
4179 .code
4180 exim -bs -oMa [10.9.8.7]:1234
4181 .endd
4182 The IP address is placed in the &$sender_host_address$& variable, and the
4183 port, if present, in &$sender_host_port$&. If both &%-oMa%& and &%-bh%&
4184 are present on the command line, the sender host IP address is taken from
4185 whichever one is last.
4186
4187 .vitem &%-oMaa%&&~<&'name'&>
4188 .oindex "&%-oMaa%&"
4189 .cindex "authentication" "name, specifying for local message"
4190 See &%-oMa%& above for general remarks about the &%-oM%& options. The &%-oMaa%&
4191 option sets the value of &$sender_host_authenticated$& (the authenticator
4192 name). See chapter &<<CHAPSMTPAUTH>>& for a discussion of SMTP authentication.
4193 This option can be used with &%-bh%& and &%-bs%& to set up an
4194 authenticated SMTP session without actually using the SMTP AUTH command.
4195
4196 .vitem &%-oMai%&&~<&'string'&>
4197 .oindex "&%-oMai%&"
4198 .cindex "authentication" "id, specifying for local message"
4199 See &%-oMa%& above for general remarks about the &%-oM%& options. The &%-oMai%&
4200 option sets the value of &$authenticated_id$& (the id that was authenticated).
4201 This overrides the default value (the caller's login id, except with &%-bh%&,
4202 where there is no default) for messages from local sources. See chapter
4203 &<<CHAPSMTPAUTH>>& for a discussion of authenticated ids.
4204
4205 .vitem &%-oMas%&&~<&'address'&>
4206 .oindex "&%-oMas%&"
4207 .cindex "authentication" "sender, specifying for local message"
4208 See &%-oMa%& above for general remarks about the &%-oM%& options. The &%-oMas%&
4209 option sets the authenticated sender value in &$authenticated_sender$&. It
4210 overrides the sender address that is created from the caller's login id for
4211 messages from local sources, except when &%-bh%& is used, when there is no
4212 default. For both &%-bh%& and &%-bs%&, an authenticated sender that is
4213 specified on a MAIL command overrides this value. See chapter
4214 &<<CHAPSMTPAUTH>>& for a discussion of authenticated senders.
4215
4216 .vitem &%-oMi%&&~<&'interface&~address'&>
4217 .oindex "&%-oMi%&"
4218 .cindex "interface" "address, specifying for local message"
4219 See &%-oMa%& above for general remarks about the &%-oM%& options. The &%-oMi%&
4220 option sets the IP interface address value. A port number may be included,
4221 using the same syntax as for &%-oMa%&. The interface address is placed in
4222 &$received_ip_address$& and the port number, if present, in &$received_port$&.
4223
4224 .vitem &%-oMr%&&~<&'protocol&~name'&>
4225 .oindex "&%-oMr%&"
4226 .cindex "protocol, specifying for local message"
4227 .vindex "&$received_protocol$&"
4228 See &%-oMa%& above for general remarks about the &%-oM%& options. The &%-oMr%&
4229 option sets the received protocol value that is stored in
4230 &$received_protocol$&. However, it does not apply (and is ignored) when &%-bh%&
4231 or &%-bs%& is used. For &%-bh%&, the protocol is forced to one of the standard
4232 SMTP protocol names (see the description of &$received_protocol$& in section
4233 &<<SECTexpvar>>&). For &%-bs%&, the protocol is always &"local-"& followed by
4234 one of those same names. For &%-bS%& (batched SMTP) however, the protocol can
4235 be set by &%-oMr%&.
4236
4237 .vitem &%-oMs%&&~<&'host&~name'&>
4238 .oindex "&%-oMs%&"
4239 .cindex "sender" "host name, specifying for local message"
4240 See &%-oMa%& above for general remarks about the &%-oM%& options. The &%-oMs%&
4241 option sets the sender host name in &$sender_host_name$&. When this option is
4242 present, Exim does not attempt to look up a host name from an IP address; it
4243 uses the name it is given.
4244
4245 .vitem &%-oMt%&&~<&'ident&~string'&>
4246 .oindex "&%-oMt%&"
4247 .cindex "sender" "ident string, specifying for local message"
4248 See &%-oMa%& above for general remarks about the &%-oM%& options. The &%-oMt%&
4249 option sets the sender ident value in &$sender_ident$&. The default setting for
4250 local callers is the login id of the calling process, except when &%-bh%& is
4251 used, when there is no default.
4252
4253 .vitem &%-om%&
4254 .oindex "&%-om%&"
4255 .cindex "Sendmail compatibility" "&%-om%& option ignored"
4256 In Sendmail, this option means &"me too"&, indicating that the sender of a
4257 message should receive a copy of the message if the sender appears in an alias
4258 expansion. Exim always does this, so the option does nothing.
4259
4260 .vitem &%-oo%&
4261 .oindex "&%-oo%&"
4262 .cindex "Sendmail compatibility" "&%-oo%& option ignored"
4263 This option is ignored. In Sendmail it specifies &"old style headers"&,
4264 whatever that means.
4265
4266 .vitem &%-oP%&&~<&'path'&>
4267 .oindex "&%-oP%&"
4268 .cindex "pid (process id)" "of daemon"
4269 .cindex "daemon" "process id (pid)"
4270 This option is useful only in conjunction with &%-bd%& or &%-q%& with a time
4271 value. The option specifies the file to which the process id of the daemon is
4272 written. When &%-oX%& is used with &%-bd%&, or when &%-q%& with a time is used
4273 without &%-bd%&, this is the only way of causing Exim to write a pid file,
4274 because in those cases, the normal pid file is not used.
4275
4276 .vitem &%-or%&&~<&'time'&>
4277 .oindex "&%-or%&"
4278 .cindex "timeout" "for non-SMTP input"
4279 This option sets a timeout value for incoming non-SMTP messages. If it is not
4280 set, Exim will wait forever for the standard input. The value can also be set
4281 by the &%receive_timeout%& option. The format used for specifying times is
4282 described in section &<<SECTtimeformat>>&.
4283
4284 .vitem &%-os%&&~<&'time'&>
4285 .oindex "&%-os%&"
4286 .cindex "timeout" "for SMTP input"
4287 .cindex "SMTP" "input timeout"
4288 This option sets a timeout value for incoming SMTP messages. The timeout
4289 applies to each SMTP command and block of data. The value can also be set by
4290 the &%smtp_receive_timeout%& option; it defaults to 5 minutes. The format used
4291 for specifying times is described in section &<<SECTtimeformat>>&.
4292
4293 .vitem &%-ov%&
4294 .oindex "&%-ov%&"
4295 This option has exactly the same effect as &%-v%&.
4296
4297 .vitem &%-oX%&&~<&'number&~or&~string'&>
4298 .oindex "&%-oX%&"
4299 .cindex "TCP/IP" "setting listening ports"
4300 .cindex "TCP/IP" "setting listening interfaces"
4301 .cindex "port" "receiving TCP/IP"
4302 This option is relevant only when the &%-bd%& (start listening daemon) option
4303 is also given. It controls which ports and interfaces the daemon uses. Details
4304 of the syntax, and how it interacts with configuration file options, are given
4305 in chapter &<<CHAPinterfaces>>&. When &%-oX%& is used to start a daemon, no pid
4306 file is written unless &%-oP%& is also present to specify a pid file name.
4307
4308 .vitem &%-pd%&
4309 .oindex "&%-pd%&"
4310 .cindex "Perl" "starting the interpreter"
4311 This option applies when an embedded Perl interpreter is linked with Exim (see
4312 chapter &<<CHAPperl>>&). It overrides the setting of the &%perl_at_start%&
4313 option, forcing the starting of the interpreter to be delayed until it is
4314 needed.
4315
4316 .vitem &%-ps%&
4317 .oindex "&%-ps%&"
4318 .cindex "Perl" "starting the interpreter"
4319 This option applies when an embedded Perl interpreter is linked with Exim (see
4320 chapter &<<CHAPperl>>&). It overrides the setting of the &%perl_at_start%&
4321 option, forcing the starting of the interpreter to occur as soon as Exim is
4322 started.
4323
4324 .vitem &%-p%&<&'rval'&>:<&'sval'&>
4325 .oindex "&%-p%&"
4326 For compatibility with Sendmail, this option is equivalent to
4327 .display
4328 &`-oMr`& <&'rval'&> &`-oMs`& <&'sval'&>
4329 .endd
4330 It sets the incoming protocol and host name (for trusted callers). The
4331 host name and its colon can be omitted when only the protocol is to be set.
4332 Note the Exim already has two private options, &%-pd%& and &%-ps%&, that refer
4333 to embedded Perl. It is therefore impossible to set a protocol value of &`d`&
4334 or &`s`& using this option (but that does not seem a real limitation).
4335
4336 .vitem &%-q%&
4337 .oindex "&%-q%&"
4338 .cindex "queue runner" "starting manually"
4339 This option is normally restricted to admin users. However, there is a
4340 configuration option called &%prod_requires_admin%& which can be set false to
4341 relax this restriction (and also the same requirement for the &%-M%&, &%-R%&,
4342 and &%-S%& options).
4343
4344 .cindex "queue runner" "description of operation"
4345 The &%-q%& option starts one queue runner process. This scans the queue of
4346 waiting messages, and runs a delivery process for each one in turn. It waits
4347 for each delivery process to finish before starting the next one. A delivery
4348 process may not actually do any deliveries if the retry times for the addresses
4349 have not been reached. Use &%-qf%& (see below) if you want to override this.
4350
4351 If
4352 .cindex "SMTP" "passed connection"
4353 .cindex "SMTP" "multiple deliveries"
4354 .cindex "multiple SMTP deliveries"
4355 the delivery process spawns other processes to deliver other messages down
4356 passed SMTP connections, the queue runner waits for these to finish before
4357 proceeding.
4358
4359 When all the queued messages have been considered, the original queue runner
4360 process terminates. In other words, a single pass is made over the waiting
4361 mail, one message at a time. Use &%-q%& with a time (see below) if you want
4362 this to be repeated periodically.
4363
4364 Exim processes the waiting messages in an unpredictable order. It isn't very
4365 random, but it is likely to be different each time, which is all that matters.
4366 If one particular message screws up a remote MTA, other messages to the same
4367 MTA have a chance of getting through if they get tried first.
4368
4369 It is possible to cause the messages to be processed in lexical message id
4370 order, which is essentially the order in which they arrived, by setting the
4371 &%queue_run_in_order%& option, but this is not recommended for normal use.
4372
4373 .vitem &%-q%&<&'qflags'&>
4374 The &%-q%& option may be followed by one or more flag letters that change its
4375 behaviour. They are all optional, but if more than one is present, they must
4376 appear in the correct order. Each flag is described in a separate item below.
4377
4378 .vitem &%-qq...%&
4379 .oindex "&%-qq%&"
4380 .cindex "queue" "double scanning"
4381 .cindex "queue" "routing"
4382 .cindex "routing" "whole queue before delivery"
4383 An option starting with &%-qq%& requests a two-stage queue run. In the first
4384 stage, the queue is scanned as if the &%queue_smtp_domains%& option matched
4385 every domain. Addresses are routed, local deliveries happen, but no remote
4386 transports are run.
4387
4388 .cindex "hints database" "remembering routing"
4389 The hints database that remembers which messages are waiting for specific hosts
4390 is updated, as if delivery to those hosts had been deferred. After this is
4391 complete, a second, normal queue scan happens, with routing and delivery taking
4392 place as normal. Messages that are routed to the same host should mostly be
4393 delivered down a single SMTP
4394 .cindex "SMTP" "passed connection"
4395 .cindex "SMTP" "multiple deliveries"
4396 .cindex "multiple SMTP deliveries"
4397 connection because of the hints that were set up during the first queue scan.
4398 This option may be useful for hosts that are connected to the Internet
4399 intermittently.
4400
4401 .vitem &%-q[q]i...%&
4402 .oindex "&%-qi%&"
4403 .cindex "queue" "initial delivery"
4404 If the &'i'& flag is present, the queue runner runs delivery processes only for
4405 those messages that haven't previously been tried. (&'i'& stands for &"initial
4406 delivery"&.) This can be helpful if you are putting messages on the queue using
4407 &%-odq%& and want a queue runner just to process the new messages.
4408
4409 .vitem &%-q[q][i]f...%&
4410 .oindex "&%-qf%&"
4411 .cindex "queue" "forcing delivery"
4412 .cindex "delivery" "forcing in queue run"
4413 If one &'f'& flag is present, a delivery attempt is forced for each non-frozen
4414 message, whereas without &'f'& only those non-frozen addresses that have passed
4415 their retry times are tried.
4416
4417 .vitem &%-q[q][i]ff...%&
4418 .oindex "&%-qff%&"
4419 .cindex "frozen messages" "forcing delivery"
4420 If &'ff'& is present, a delivery attempt is forced for every message, whether
4421 frozen or not.
4422
4423 .vitem &%-q[q][i][f[f]]l%&
4424 .oindex "&%-ql%&"
4425 .cindex "queue" "local deliveries only"
4426 The &'l'& (the letter &"ell"&) flag specifies that only local deliveries are to
4427 be done. If a message requires any remote deliveries, it remains on the queue
4428 for later delivery.
4429
4430 .vitem &%-q%&<&'qflags'&>&~<&'start&~id'&>&~<&'end&~id'&>
4431 .cindex "queue" "delivering specific messages"
4432 When scanning the queue, Exim can be made to skip over messages whose ids are
4433 lexically less than a given value by following the &%-q%& option with a
4434 starting message id. For example:
4435 .code
4436 exim -q 0t5C6f-0000c8-00
4437 .endd
4438 Messages that arrived earlier than &`0t5C6f-0000c8-00`& are not inspected. If a
4439 second message id is given, messages whose ids are lexically greater than it
4440 are also skipped. If the same id is given twice, for example,
4441 .code
4442 exim -q 0t5C6f-0000c8-00 0t5C6f-0000c8-00
4443 .endd
4444 just one delivery process is started, for that message. This differs from
4445 &%-M%& in that retry data is respected, and it also differs from &%-Mc%& in
4446 that it counts as a delivery from a queue run. Note that the selection
4447 mechanism does not affect the order in which the messages are scanned. There
4448 are also other ways of selecting specific sets of messages for delivery in a
4449 queue run &-- see &%-R%& and &%-S%&.
4450
4451 .vitem &%-q%&<&'qflags'&><&'time'&>
4452 .cindex "queue runner" "starting periodically"
4453 .cindex "periodic queue running"
4454 When a time value is present, the &%-q%& option causes Exim to run as a daemon,
4455 starting a queue runner process at intervals specified by the given time value
4456 (whose format is described in section &<<SECTtimeformat>>&). This form of the
4457 &%-q%& option is commonly combined with the &%-bd%& option, in which case a
4458 single daemon process handles both functions. A common way of starting up a
4459 combined daemon at system boot time is to use a command such as
4460 .code
4461 /usr/exim/bin/exim -bd -q30m
4462 .endd
4463 Such a daemon listens for incoming SMTP calls, and also starts a queue runner
4464 process every 30 minutes.
4465
4466 When a daemon is started by &%-q%& with a time value, but without &%-bd%&, no
4467 pid file is written unless one is explicitly requested by the &%-oP%& option.
4468
4469 .vitem &%-qR%&<&'rsflags'&>&~<&'string'&>
4470 .oindex "&%-qR%&"
4471 This option is synonymous with &%-R%&. It is provided for Sendmail
4472 compatibility.
4473
4474 .vitem &%-qS%&<&'rsflags'&>&~<&'string'&>
4475 .oindex "&%-qS%&"
4476 This option is synonymous with &%-S%&.
4477
4478 .vitem &%-R%&<&'rsflags'&>&~<&'string'&>
4479 .oindex "&%-R%&"
4480 .cindex "queue runner" "for specific recipients"
4481 .cindex "delivery" "to given domain"
4482 .cindex "domain" "delivery to"
4483 The <&'rsflags'&> may be empty, in which case the white space before the string
4484 is optional, unless the string is &'f'&, &'ff'&, &'r'&, &'rf'&, or &'rff'&,
4485 which are the possible values for <&'rsflags'&>. White space is required if
4486 <&'rsflags'&> is not empty.
4487
4488 This option is similar to &%-q%& with no time value, that is, it causes Exim to
4489 perform a single queue run, except that, when scanning the messages on the
4490 queue, Exim processes only those that have at least one undelivered recipient
4491 address containing the given string, which is checked in a case-independent
4492 way. If the <&'rsflags'&> start with &'r'&, <&'string'&> is interpreted as a
4493 regular expression; otherwise it is a literal string.
4494
4495 If you want to do periodic queue runs for messages with specific recipients,
4496 you can combine &%-R%& with &%-q%& and a time value. For example:
4497 .code
4498 exim -q25m -R @special.domain.example
4499 .endd
4500 This example does a queue run for messages with recipients in the given domain
4501 every 25 minutes. Any additional flags that are specified with &%-q%& are
4502 applied to each queue run.
4503
4504 Once a message is selected for delivery by this mechanism, all its addresses
4505 are processed. For the first selected message, Exim overrides any retry
4506 information and forces a delivery attempt for each undelivered address. This
4507 means that if delivery of any address in the first message is successful, any
4508 existing retry information is deleted, and so delivery attempts for that
4509 address in subsequently selected messages (which are processed without forcing)
4510 will run. However, if delivery of any address does not succeed, the retry
4511 information is updated, and in subsequently selected messages, the failing
4512 address will be skipped.
4513
4514 .cindex "frozen messages" "forcing delivery"
4515 If the <&'rsflags'&> contain &'f'& or &'ff'&, the delivery forcing applies to
4516 all selected messages, not just the first; frozen messages are included when
4517 &'ff'& is present.
4518
4519 The &%-R%& option makes it straightforward to initiate delivery of all messages
4520 to a given domain after a host has been down for some time. When the SMTP
4521 command ETRN is accepted by its ACL (see chapter &<<CHAPACL>>&), its default
4522 effect is to run Exim with the &%-R%& option, but it can be configured to run
4523 an arbitrary command instead.
4524
4525 .vitem &%-r%&
4526 .oindex "&%-r%&"
4527 This is a documented (for Sendmail) obsolete alternative name for &%-f%&.
4528
4529 .vitem &%-S%&<&'rsflags'&>&~<&'string'&>
4530 .oindex "&%-S%&"
4531 .cindex "delivery" "from given sender"
4532 .cindex "queue runner" "for specific senders"
4533 This option acts like &%-R%& except that it checks the string against each
4534 message's sender instead of against the recipients. If &%-R%& is also set, both
4535 conditions must be met for a message to be selected. If either of the options
4536 has &'f'& or &'ff'& in its flags, the associated action is taken.
4537
4538 .vitem &%-Tqt%&&~<&'times'&>
4539 .oindex "&%-Tqt%&"
4540 This is an option that is exclusively for use by the Exim testing suite. It is not
4541 recognized when Exim is run normally. It allows for the setting up of explicit
4542 &"queue times"& so that various warning/retry features can be tested.
4543
4544 .vitem &%-t%&
4545 .oindex "&%-t%&"
4546 .cindex "recipient" "extracting from header lines"
4547 .cindex "&'Bcc:'& header line"
4548 .cindex "&'Cc:'& header line"
4549 .cindex "&'To:'& header line"
4550 When Exim is receiving a locally-generated, non-SMTP message on its standard
4551 input, the &%-t%& option causes the recipients of the message to be obtained
4552 from the &'To:'&, &'Cc:'&, and &'Bcc:'& header lines in the message instead of
4553 from the command arguments. The addresses are extracted before any rewriting
4554 takes place and the &'Bcc:'& header line, if present, is then removed.
4555
4556 .cindex "Sendmail compatibility" "&%-t%& option"
4557 If the command has any arguments, they specify addresses to which the message
4558 is &'not'& to be delivered. That is, the argument addresses are removed from
4559 the recipients list obtained from the headers. This is compatible with Smail 3
4560 and in accordance with the documented behaviour of several versions of
4561 Sendmail, as described in man pages on a number of operating systems (e.g.
4562 Solaris 8, IRIX 6.5, HP-UX 11). However, some versions of Sendmail &'add'&
4563 argument addresses to those obtained from the headers, and the O'Reilly
4564 Sendmail book documents it that way. Exim can be made to add argument addresses
4565 instead of subtracting them by setting the option
4566 &%extract_addresses_remove_arguments%& false.
4567
4568 .cindex "&%Resent-%& header lines" "with &%-t%&"
4569 If there are any &%Resent-%& header lines in the message, Exim extracts
4570 recipients from all &'Resent-To:'&, &'Resent-Cc:'&, and &'Resent-Bcc:'& header
4571 lines instead of from &'To:'&, &'Cc:'&, and &'Bcc:'&. This is for compatibility
4572 with Sendmail and other MTAs. (Prior to release 4.20, Exim gave an error if
4573 &%-t%& was used in conjunction with &%Resent-%& header lines.)
4574
4575 RFC 2822 talks about different sets of &%Resent-%& header lines (for when a
4576 message is resent several times). The RFC also specifies that they should be
4577 added at the front of the message, and separated by &'Received:'& lines. It is
4578 not at all clear how &%-t%& should operate in the present of multiple sets,
4579 nor indeed exactly what constitutes a &"set"&.
4580 In practice, it seems that MUAs do not follow the RFC. The &%Resent-%& lines
4581 are often added at the end of the header, and if a message is resent more than
4582 once, it is common for the original set of &%Resent-%& headers to be renamed as
4583 &%X-Resent-%& when a new set is added. This removes any possible ambiguity.
4584
4585 .vitem &%-ti%&
4586 .oindex "&%-ti%&"
4587 This option is exactly equivalent to &%-t%& &%-i%&. It is provided for
4588 compatibility with Sendmail.
4589
4590 .vitem &%-tls-on-connect%&
4591 .oindex "&%-tls-on-connect%&"
4592 .cindex "TLS" "use without STARTTLS"
4593 .cindex "TLS" "automatic start"
4594 This option is available when Exim is compiled with TLS support. It forces all
4595 incoming SMTP connections to behave as if the incoming port is listed in the
4596 &%tls_on_connect_ports%& option. See section &<<SECTsupobssmt>>& and chapter
4597 &<<CHAPTLS>>& for further details.
4598
4599
4600 .vitem &%-U%&
4601 .oindex "&%-U%&"
4602 .cindex "Sendmail compatibility" "&%-U%& option ignored"
4603 Sendmail uses this option for &"initial message submission"&, and its
4604 documentation states that in future releases, it may complain about
4605 syntactically invalid messages rather than fixing them when this flag is not
4606 set. Exim ignores this option.
4607
4608 .vitem &%-v%&
4609 .oindex "&%-v%&"
4610 This option causes Exim to write information to the standard error stream,
4611 describing what it is doing. In particular, it shows the log lines for
4612 receiving and delivering a message, and if an SMTP connection is made, the SMTP
4613 dialogue is shown. Some of the log lines shown may not actually be written to
4614 the log if the setting of &%log_selector%& discards them. Any relevant
4615 selectors are shown with each log line. If none are shown, the logging is
4616 unconditional.
4617
4618 .vitem &%-x%&
4619 .oindex "&%-x%&"
4620 AIX uses &%-x%& for a private purpose (&"mail from a local mail program has
4621 National Language Support extended characters in the body of the mail item"&).
4622 It sets &%-x%& when calling the MTA from its &%mail%& command. Exim ignores
4623 this option.
4624
4625 .vitem &%-X%&&~<&'logfile'&>
4626 .oindex "&%-X%&"
4627 This option is interpreted by Sendmail to cause debug information to be sent
4628 to the named file.  It is ignored by Exim.
4629 .endlist
4630
4631 .ecindex IIDclo1
4632 .ecindex IIDclo2
4633
4634
4635 . ////////////////////////////////////////////////////////////////////////////
4636 . Insert a stylized DocBook comment here, to identify the end of the command
4637 . line options. This is for the benefit of the Perl script that automatically
4638 . creates a man page for the options.
4639 . ////////////////////////////////////////////////////////////////////////////
4640
4641 .literal xml
4642 <!-- === End of command line options === -->
4643 .literal off
4644
4645
4646
4647
4648
4649 . ////////////////////////////////////////////////////////////////////////////
4650 . ////////////////////////////////////////////////////////////////////////////
4651
4652
4653 .chapter "The Exim run time configuration file" "CHAPconf" &&&
4654          "The runtime configuration file"
4655
4656 .cindex "run time configuration"
4657 .cindex "configuration file" "general description"
4658 .cindex "CONFIGURE_FILE"
4659 .cindex "configuration file" "errors in"
4660 .cindex "error" "in configuration file"
4661 .cindex "return code" "for bad configuration"
4662 Exim uses a single run time configuration file that is read whenever an Exim
4663 binary is executed. Note that in normal operation, this happens frequently,
4664 because Exim is designed to operate in a distributed manner, without central
4665 control.
4666
4667 If a syntax error is detected while reading the configuration file, Exim
4668 writes a message on the standard error, and exits with a non-zero return code.
4669 The message is also written to the panic log. &*Note*&: Only simple syntax
4670 errors can be detected at this time. The values of any expanded options are
4671 not checked until the expansion happens, even when the expansion does not
4672 actually alter the string.
4673
4674 The name of the configuration file is compiled into the binary for security
4675 reasons, and is specified by the CONFIGURE_FILE compilation option. In
4676 most configurations, this specifies a single file. However, it is permitted to
4677 give a colon-separated list of file names, in which case Exim uses the first
4678 existing file in the list.
4679
4680 .cindex "EXIM_USER"
4681 .cindex "EXIM_GROUP"
4682 .cindex "CONFIGURE_OWNER"
4683 .cindex "CONFIGURE_GROUP"
4684 .cindex "configuration file" "ownership"
4685 .cindex "ownership" "configuration file"
4686 The run time configuration file must be owned by root or by the user that is
4687 specified at compile time by the CONFIGURE_OWNER option (if set). The
4688 configuration file must not be world-writeable, or group-writeable unless its
4689 group is the root group or the one specified at compile time by the
4690 CONFIGURE_GROUP option.
4691
4692 &*Warning*&: In a conventional configuration, where the Exim binary is setuid
4693 to root, anybody who is able to edit the run time configuration file has an
4694 easy way to run commands as root. If you specify a user or group in the
4695 CONFIGURE_OWNER or CONFIGURE_GROUP options, then that user and/or any users
4696 who are members of that group will trivially be able to obtain root privileges.
4697
4698 Up to Exim version 4.72, the run time configuration file was also permitted to
4699 be writeable by the Exim user and/or group. That has been changed in Exim 4.73
4700 since it offered a simple privilege escalation for any attacker who managed to
4701 compromise the Exim user account.
4702
4703 A default configuration file, which will work correctly in simple situations,
4704 is provided in the file &_src/configure.default_&. If CONFIGURE_FILE
4705 defines just one file name, the installation process copies the default
4706 configuration to a new file of that name if it did not previously exist. If
4707 CONFIGURE_FILE is a list, no default is automatically installed. Chapter
4708 &<<CHAPdefconfil>>& is a &"walk-through"& discussion of the default
4709 configuration.
4710
4711
4712
4713 .section "Using a different configuration file" "SECID40"
4714 .cindex "configuration file" "alternate"
4715 A one-off alternate configuration can be specified by the &%-C%& command line
4716 option, which may specify a single file or a list of files. However, when
4717 &%-C%& is used, Exim gives up its root privilege, unless called by root (or
4718 unless the argument for &%-C%& is identical to the built-in value from
4719 CONFIGURE_FILE), or is listed in the TRUSTED_CONFIG_LIST file and the caller
4720 is the Exim user or the user specified in the CONFIGURE_OWNER setting. &%-C%&
4721 is useful mainly for checking the syntax of configuration files before
4722 installing them. No owner or group checks are done on a configuration file
4723 specified by &%-C%&, if root privilege has been dropped.
4724
4725 Even the Exim user is not trusted to specify an arbitrary configuration file
4726 with the &%-C%& option to be used with root privileges, unless that file is
4727 listed in the TRUSTED_CONFIG_LIST file. This locks out the possibility of
4728 testing a configuration using &%-C%& right through message reception and
4729 delivery, even if the caller is root. The reception works, but by that time,
4730 Exim is running as the Exim user, so when it re-execs to regain privilege for
4731 the delivery, the use of &%-C%& causes privilege to be lost. However, root
4732 can test reception and delivery using two separate commands (one to put a
4733 message on the queue, using &%-odq%&, and another to do the delivery, using
4734 &%-M%&).
4735
4736 If ALT_CONFIG_PREFIX is defined &_in Local/Makefile_&, it specifies a
4737 prefix string with which any file named in a &%-C%& command line option must
4738 start. In addition, the file name must not contain the sequence &"&`/../`&"&.
4739 There is no default setting for ALT_CONFIG_PREFIX; when it is unset, any file
4740 name can be used with &%-C%&.
4741
4742 One-off changes to a configuration can be specified by the &%-D%& command line
4743 option, which defines and overrides values for macros used inside the
4744 configuration file. However, like &%-C%&, the use of this option by a
4745 non-privileged user causes Exim to discard its root privilege.
4746 If DISABLE_D_OPTION is defined in &_Local/Makefile_&, the use of &%-D%& is
4747 completely disabled, and its use causes an immediate error exit.
4748
4749 The WHITELIST_D_MACROS option in &_Local/Makefile_& permits the binary builder
4750 to declare certain macro names trusted, such that root privilege will not
4751 necessarily be discarded.
4752 WHITELIST_D_MACROS defines a colon-separated list of macros which are
4753 considered safe and, if &%-D%& only supplies macros from this list, and the
4754 values are acceptable, then Exim will not give up root privilege if the caller
4755 is root, the Exim run-time user, or the CONFIGURE_OWNER, if set.  This is a
4756 transition mechanism and is expected to be removed in the future.  Acceptable
4757 values for the macros satisfy the regexp: &`^[A-Za-z0-9_/.-]*$`&
4758
4759 Some sites may wish to use the same Exim binary on different machines that
4760 share a file system, but to use different configuration files on each machine.
4761 If CONFIGURE_FILE_USE_NODE is defined in &_Local/Makefile_&, Exim first
4762 looks for a file whose name is the configuration file name followed by a dot
4763 and the machine's node name, as obtained from the &[uname()]& function. If this
4764 file does not exist, the standard name is tried. This processing occurs for
4765 each file name in the list given by CONFIGURE_FILE or &%-C%&.
4766
4767 In some esoteric situations different versions of Exim may be run under
4768 different effective uids and the CONFIGURE_FILE_USE_EUID is defined to
4769 help with this. See the comments in &_src/EDITME_& for details.
4770
4771
4772
4773 .section "Configuration file format" "SECTconffilfor"
4774 .cindex "configuration file" "format of"
4775 .cindex "format" "configuration file"
4776 Exim's configuration file is divided into a number of different parts. General
4777 option settings must always appear at the start of the file. The other parts
4778 are all optional, and may appear in any order. Each part other than the first
4779 is introduced by the word &"begin"& followed by the name of the part. The
4780 optional parts are:
4781
4782 .ilist
4783 &'ACL'&: Access control lists for controlling incoming SMTP mail (see chapter
4784 &<<CHAPACL>>&).
4785 .next
4786 .cindex "AUTH" "configuration"
4787 &'authenticators'&: Configuration settings for the authenticator drivers. These
4788 are concerned with the SMTP AUTH command (see chapter &<<CHAPSMTPAUTH>>&).
4789 .next
4790 &'routers'&: Configuration settings for the router drivers. Routers process
4791 addresses and determine how the message is to be delivered (see chapters
4792 &<<CHAProutergeneric>>&&--&<<CHAPredirect>>&).
4793 .next
4794 &'transports'&: Configuration settings for the transport drivers. Transports
4795 define mechanisms for copying messages to destinations (see chapters
4796 &<<CHAPtransportgeneric>>&&--&<<CHAPsmtptrans>>&).
4797 .next
4798 &'retry'&: Retry rules, for use when a message cannot be delivered immediately.
4799 If there is no retry section, or if it is empty (that is, no retry rules are
4800 defined), Exim will not retry deliveries. In this situation, temporary errors
4801 are treated the same as permanent errors. Retry rules are discussed in chapter
4802 &<<CHAPretry>>&.
4803 .next
4804 &'rewrite'&: Global address rewriting rules, for use when a message arrives and
4805 when new addresses are generated during delivery. Rewriting is discussed in
4806 chapter &<<CHAPrewrite>>&.
4807 .next
4808 &'local_scan'&: Private options for the &[local_scan()]& function. If you
4809 want to use this feature, you must set
4810 .code
4811 LOCAL_SCAN_HAS_OPTIONS=yes
4812 .endd
4813 in &_Local/Makefile_& before building Exim. Details of the &[local_scan()]&
4814 facility are given in chapter &<<CHAPlocalscan>>&.
4815 .endlist
4816
4817 .cindex "configuration file" "leading white space in"
4818 .cindex "configuration file" "trailing white space in"
4819 .cindex "white space" "in configuration file"
4820 Leading and trailing white space in configuration lines is always ignored.
4821
4822 Blank lines in the file, and lines starting with a # character (ignoring
4823 leading white space) are treated as comments and are ignored. &*Note*&: A
4824 # character other than at the beginning of a line is not treated specially,
4825 and does not introduce a comment.
4826
4827 Any non-comment line can be continued by ending it with a backslash. Note that
4828 the general rule for white space means that trailing white space after the
4829 backslash and leading white space at the start of continuation
4830 lines is ignored. Comment lines beginning with # (but not empty lines) may
4831 appear in the middle of a sequence of continuation lines.
4832
4833 A convenient way to create a configuration file is to start from the
4834 default, which is supplied in &_src/configure.default_&, and add, delete, or
4835 change settings as required.
4836
4837 The ACLs, retry rules, and rewriting rules have their own syntax which is
4838 described in chapters &<<CHAPACL>>&, &<<CHAPretry>>&, and &<<CHAPrewrite>>&,
4839 respectively. The other parts of the configuration file have some syntactic
4840 items in common, and these are described below, from section &<<SECTcos>>&
4841 onwards. Before that, the inclusion, macro, and conditional facilities are
4842 described.
4843
4844
4845
4846 .section "File inclusions in the configuration file" "SECID41"
4847 .cindex "inclusions in configuration file"
4848 .cindex "configuration file" "including other files"
4849 .cindex "&`.include`& in configuration file"
4850 .cindex "&`.include_if_exists`& in configuration file"
4851 You can include other files inside Exim's run time configuration file by
4852 using this syntax:
4853 .display
4854 &`.include`& <&'file name'&>
4855 &`.include_if_exists`& <&'file name'&>
4856 .endd
4857 on a line by itself. Double quotes round the file name are optional. If you use
4858 the first form, a configuration error occurs if the file does not exist; the
4859 second form does nothing for non-existent files. In all cases, an absolute file
4860 name is required.
4861
4862 Includes may be nested to any depth, but remember that Exim reads its
4863 configuration file often, so it is a good idea to keep them to a minimum.
4864 If you change the contents of an included file, you must HUP the daemon,
4865 because an included file is read only when the configuration itself is read.
4866
4867 The processing of inclusions happens early, at a physical line level, so, like
4868 comment lines, an inclusion can be used in the middle of an option setting,
4869 for example:
4870 .code
4871 hosts_lookup = a.b.c \
4872                .include /some/file
4873 .endd
4874 Include processing happens after macro processing (see below). Its effect is to
4875 process the lines of the included file as if they occurred inline where the
4876 inclusion appears.
4877
4878
4879
4880 .section "Macros in the configuration file" "SECTmacrodefs"
4881 .cindex "macro" "description of"
4882 .cindex "configuration file" "macros"
4883 If a line in the main part of the configuration (that is, before the first
4884 &"begin"& line) begins with an upper case letter, it is taken as a macro
4885 definition, and must be of the form
4886 .display
4887 <&'name'&> = <&'rest of line'&>
4888 .endd
4889 The name must consist of letters, digits, and underscores, and need not all be
4890 in upper case, though that is recommended. The rest of the line, including any
4891 continuations, is the replacement text, and has leading and trailing white
4892 space removed. Quotes are not removed. The replacement text can never end with
4893 a backslash character, but this doesn't seem to be a serious limitation.
4894
4895 Macros may also be defined between router, transport, authenticator, or ACL
4896 definitions. They may not, however, be defined within an individual driver or
4897 ACL, or in the &%local_scan%&, retry, or rewrite sections of the configuration.
4898
4899 .section "Macro substitution" "SECID42"
4900 Once a macro is defined, all subsequent lines in the file (and any included
4901 files) are scanned for the macro name; if there are several macros, the line is
4902 scanned for each in turn, in the order in which the macros are defined. The
4903 replacement text is not re-scanned for the current macro, though it is scanned
4904 for subsequently defined macros. For this reason, a macro name may not contain
4905 the name of a previously defined macro as a substring. You could, for example,
4906 define
4907 .display
4908 &`ABCD_XYZ = `&<&'something'&>
4909 &`ABCD = `&<&'something else'&>
4910 .endd
4911 but putting the definitions in the opposite order would provoke a configuration
4912 error. Macro expansion is applied to individual physical lines from the file,
4913 before checking for line continuation or file inclusion (see above). If a line
4914 consists solely of a macro name, and the expansion of the macro is empty, the
4915 line is ignored. A macro at the start of a line may turn the line into a
4916 comment line or a &`.include`& line.
4917
4918
4919 .section "Redefining macros" "SECID43"
4920 Once defined, the value of a macro can be redefined later in the configuration
4921 (or in an included file). Redefinition is specified by using &'=='& instead of
4922 &'='&. For example:
4923 .code
4924 MAC =  initial value
4925 ...
4926 MAC == updated value
4927 .endd
4928 Redefinition does not alter the order in which the macros are applied to the
4929 subsequent lines of the configuration file. It is still the same order in which
4930 the macros were originally defined. All that changes is the macro's value.
4931 Redefinition makes it possible to accumulate values. For example:
4932 .code
4933 MAC =  initial value
4934 ...
4935 MAC == MAC and something added
4936 .endd
4937 This can be helpful in situations where the configuration file is built
4938 from a number of other files.
4939
4940 .section "Overriding macro values" "SECID44"
4941 The values set for macros in the configuration file can be overridden by the
4942 &%-D%& command line option, but Exim gives up its root privilege when &%-D%& is
4943 used, unless called by root or the Exim user. A definition on the command line
4944 using the &%-D%& option causes all definitions and redefinitions within the
4945 file to be ignored.
4946
4947
4948
4949 .section "Example of macro usage" "SECID45"
4950 As an example of macro usage, consider a configuration where aliases are looked
4951 up in a MySQL database. It helps to keep the file less cluttered if long
4952 strings such as SQL statements are defined separately as macros, for example:
4953 .code
4954 ALIAS_QUERY = select mailbox from user where \
4955               login='${quote_mysql:$local_part}';
4956 .endd
4957 This can then be used in a &(redirect)& router setting like this:
4958 .code
4959 data = ${lookup mysql{ALIAS_QUERY}}
4960 .endd
4961 In earlier versions of Exim macros were sometimes used for domain, host, or
4962 address lists. In Exim 4 these are handled better by named lists &-- see
4963 section &<<SECTnamedlists>>&.
4964
4965
4966 .section "Conditional skips in the configuration file" "SECID46"
4967 .cindex "configuration file" "conditional skips"
4968 .cindex "&`.ifdef`&"
4969 You can use the directives &`.ifdef`&, &`.ifndef`&, &`.elifdef`&,
4970 &`.elifndef`&, &`.else`&, and &`.endif`& to dynamically include or exclude
4971 portions of the configuration file. The processing happens whenever the file is
4972 read (that is, when an Exim binary starts to run).
4973
4974 The implementation is very simple. Instances of the first four directives must
4975 be followed by text that includes the names of one or macros. The condition
4976 that is tested is whether or not any macro substitution has taken place in the
4977 line. Thus:
4978 .code
4979 .ifdef AAA
4980 message_size_limit = 50M
4981 .else
4982 message_size_limit = 100M
4983 .endif
4984 .endd
4985 sets a message size limit of 50M if the macro &`AAA`& is defined, and 100M
4986 otherwise. If there is more than one macro named on the line, the condition
4987 is true if any of them are defined. That is, it is an &"or"& condition. To
4988 obtain an &"and"& condition, you need to use nested &`.ifdef`&s.
4989
4990 Although you can use a macro expansion to generate one of these directives,
4991 it is not very useful, because the condition &"there was a macro substitution
4992 in this line"& will always be true.
4993
4994 Text following &`.else`& and &`.endif`& is ignored, and can be used as comment
4995 to clarify complicated nestings.
4996
4997
4998
4999 .section "Common option syntax" "SECTcos"
5000 .cindex "common option syntax"
5001 .cindex "syntax of common options"
5002 .cindex "configuration file" "common option syntax"
5003 For the main set of options, driver options, and &[local_scan()]& options,
5004 each setting is on a line by itself, and starts with a name consisting of
5005 lower-case letters and underscores. Many options require a data value, and in
5006 these cases the name must be followed by an equals sign (with optional white
5007 space) and then the value. For example:
5008 .code
5009 qualify_domain = mydomain.example.com
5010 .endd
5011 .cindex "hiding configuration option values"
5012 .cindex "configuration options" "hiding value of"
5013 .cindex "options" "hiding value of"
5014 Some option settings may contain sensitive data, for example, passwords for
5015 accessing databases. To stop non-admin users from using the &%-bP%& command
5016 line option to read these values, you can precede the option settings with the
5017 word &"hide"&. For example:
5018 .code
5019 hide mysql_servers = localhost/users/admin/secret-password
5020 .endd
5021 For non-admin users, such options are displayed like this:
5022 .code
5023 mysql_servers = <value not displayable>
5024 .endd
5025 If &"hide"& is used on a driver option, it hides the value of that option on
5026 all instances of the same driver.
5027
5028 The following sections describe the syntax used for the different data types
5029 that are found in option settings.
5030
5031
5032 .section "Boolean options" "SECID47"
5033 .cindex "format" "boolean"
5034 .cindex "boolean configuration values"
5035 .oindex "&%no_%&&'xxx'&"
5036 .oindex "&%not_%&&'xxx'&"
5037 Options whose type is given as boolean are on/off switches. There are two
5038 different ways of specifying such options: with and without a data value. If
5039 the option name is specified on its own without data, the switch is turned on;
5040 if it is preceded by &"no_"& or &"not_"& the switch is turned off. However,
5041 boolean options may be followed by an equals sign and one of the words
5042 &"true"&, &"false"&, &"yes"&, or &"no"&, as an alternative syntax. For example,
5043 the following two settings have exactly the same effect:
5044 .code
5045 queue_only
5046 queue_only = true
5047 .endd
5048 The following two lines also have the same (opposite) effect:
5049 .code
5050 no_queue_only
5051 queue_only = false
5052 .endd
5053 You can use whichever syntax you prefer.
5054
5055
5056
5057
5058 .section "Integer values" "SECID48"
5059 .cindex "integer configuration values"
5060 .cindex "format" "integer"
5061 If an option's type is given as &"integer"&, the value can be given in decimal,
5062 hexadecimal, or octal. If it starts with a digit greater than zero, a decimal
5063 number is assumed. Otherwise, it is treated as an octal number unless it starts
5064 with the characters &"0x"&, in which case the remainder is interpreted as a
5065 hexadecimal number.
5066
5067 If an integer value is followed by the letter K, it is multiplied by 1024; if
5068 it is followed by the letter M, it is multiplied by 1024x1024. When the values
5069 of integer option settings are output, values which are an exact multiple of
5070 1024 or 1024x1024 are sometimes, but not always, printed using the letters K
5071 and M. The printing style is independent of the actual input format that was
5072 used.
5073
5074
5075 .section "Octal integer values" "SECID49"
5076 .cindex "integer format"
5077 .cindex "format" "octal integer"
5078 If an option's type is given as &"octal integer"&, its value is always
5079 interpreted as an octal number, whether or not it starts with the digit zero.
5080 Such options are always output in octal.
5081
5082
5083 .section "Fixed point numbers" "SECID50"
5084 .cindex "fixed point configuration values"
5085 .cindex "format" "fixed point"
5086 If an option's type is given as &"fixed-point"&, its value must be a decimal
5087 integer, optionally followed by a decimal point and up to three further digits.
5088
5089
5090
5091 .section "Time intervals" "SECTtimeformat"
5092 .cindex "time interval" "specifying in configuration"
5093 .cindex "format" "time interval"
5094 A time interval is specified as a sequence of numbers, each followed by one of
5095 the following letters, with no intervening white space:
5096
5097 .table2 30pt
5098 .irow &%s%& seconds
5099 .irow &%m%& minutes
5100 .irow &%h%& hours
5101 .irow &%d%& days
5102 .irow &%w%& weeks
5103 .endtable
5104
5105 For example, &"3h50m"& specifies 3 hours and 50 minutes. The values of time
5106 intervals are output in the same format. Exim does not restrict the values; it
5107 is perfectly acceptable, for example, to specify &"90m"& instead of &"1h30m"&.
5108
5109
5110
5111 .section "String values" "SECTstrings"
5112 .cindex "string" "format of configuration values"
5113 .cindex "format" "string"
5114 If an option's type is specified as &"string"&, the value can be specified with
5115 or without double-quotes. If it does not start with a double-quote, the value
5116 consists of the remainder of the line plus any continuation lines, starting at
5117 the first character after any leading white space, with trailing white space
5118 removed, and with no interpretation of the characters in the string. Because
5119 Exim removes comment lines (those beginning with #) at an early stage, they can
5120 appear in the middle of a multi-line string. The following two settings are
5121 therefore equivalent:
5122 .code
5123 trusted_users = uucp:mail
5124 trusted_users = uucp:\
5125                 # This comment line is ignored
5126                 mail
5127 .endd
5128 .cindex "string" "quoted"
5129 .cindex "escape characters in quoted strings"
5130 If a string does start with a double-quote, it must end with a closing
5131 double-quote, and any backslash characters other than those used for line
5132 continuation are interpreted as escape characters, as follows:
5133
5134 .table2 100pt
5135 .irow &`\\`&                     "single backslash"
5136 .irow &`\n`&                     "newline"
5137 .irow &`\r`&                     "carriage return"
5138 .irow &`\t`&                     "tab"
5139 .irow "&`\`&<&'octal digits'&>"  "up to 3 octal digits specify one character"
5140 .irow "&`\x`&<&'hex digits'&>"   "up to 2 hexadecimal digits specify one &&&
5141                                    character"
5142 .endtable
5143
5144 If a backslash is followed by some other character, including a double-quote
5145 character, that character replaces the pair.
5146
5147 Quoting is necessary only if you want to make use of the backslash escapes to
5148 insert special characters, or if you need to specify a value with leading or
5149 trailing spaces. These cases are rare, so quoting is almost never needed in
5150 current versions of Exim. In versions of Exim before 3.14, quoting was required
5151 in order to continue lines, so you may come across older configuration files
5152 and examples that apparently quote unnecessarily.
5153
5154
5155 .section "Expanded strings" "SECID51"
5156 .cindex "expansion" "definition of"
5157 Some strings in the configuration file are subjected to &'string expansion'&,
5158 by which means various parts of the string may be changed according to the
5159 circumstances (see chapter &<<CHAPexpand>>&). The input syntax for such strings
5160 is as just described; in particular, the handling of backslashes in quoted
5161 strings is done as part of the input process, before expansion takes place.
5162 However, backslash is also an escape character for the expander, so any
5163 backslashes that are required for that reason must be doubled if they are
5164 within a quoted configuration string.
5165
5166
5167 .section "User and group names" "SECID52"
5168 .cindex "user name" "format of"
5169 .cindex "format" "user name"
5170 .cindex "groups" "name format"
5171 .cindex "format" "group name"
5172 User and group names are specified as strings, using the syntax described
5173 above, but the strings are interpreted specially. A user or group name must
5174 either consist entirely of digits, or be a name that can be looked up using the
5175 &[getpwnam()]& or &[getgrnam()]& function, as appropriate.
5176
5177
5178 .section "List construction" "SECTlistconstruct"
5179 .cindex "list" "syntax of in configuration"
5180 .cindex "format" "list item in configuration"
5181 .cindex "string" "list, definition of"
5182 The data for some configuration options is a list of items, with colon as the
5183 default separator. Many of these options are shown with type &"string list"& in
5184 the descriptions later in this document. Others are listed as &"domain list"&,
5185 &"host list"&, &"address list"&, or &"local part list"&. Syntactically, they
5186 are all the same; however, those other than &"string list"& are subject to
5187 particular kinds of interpretation, as described in chapter
5188 &<<CHAPdomhosaddlists>>&.
5189
5190 In all these cases, the entire list is treated as a single string as far as the
5191 input syntax is concerned. The &%trusted_users%& setting in section
5192 &<<SECTstrings>>& above is an example. If a colon is actually needed in an item
5193 in a list, it must be entered as two colons. Leading and trailing white space
5194 on each item in a list is ignored. This makes it possible to include items that
5195 start with a colon, and in particular, certain forms of IPv6 address. For
5196 example, the list
5197 .code
5198 local_interfaces = 127.0.0.1 : ::::1
5199 .endd
5200 contains two IP addresses, the IPv4 address 127.0.0.1 and the IPv6 address ::1.
5201
5202 &*Note*&: Although leading and trailing white space is ignored in individual
5203 list items, it is not ignored when parsing the list. The space after the first
5204 colon in the example above is necessary. If it were not there, the list would
5205 be interpreted as the two items 127.0.0.1:: and 1.
5206
5207 .section "Changing list separators" "SECID53"
5208 .cindex "list separator" "changing"
5209 .cindex "IPv6" "addresses in lists"
5210 Doubling colons in IPv6 addresses is an unwelcome chore, so a mechanism was
5211 introduced to allow the separator character to be changed. If a list begins
5212 with a left angle bracket, followed by any punctuation character, that
5213 character is used instead of colon as the list separator. For example, the list
5214 above can be rewritten to use a semicolon separator like this:
5215 .code
5216 local_interfaces = <; 127.0.0.1 ; ::1
5217 .endd
5218 This facility applies to all lists, with the exception of the list in
5219 &%log_file_path%&. It is recommended that the use of non-colon separators be
5220 confined to circumstances where they really are needed.
5221
5222 .cindex "list separator" "newline as"
5223 .cindex "newline" "as list separator"
5224 It is also possible to use newline and other control characters (those with
5225 code values less than 32, plus DEL) as separators in lists. Such separators
5226 must be provided literally at the time the list is processed. For options that
5227 are string-expanded, you can write the separator using a normal escape
5228 sequence. This will be processed by the expander before the string is
5229 interpreted as a list. For example, if a newline-separated list of domains is
5230 generated by a lookup, you can process it directly by a line such as this:
5231 .code
5232 domains = <\n ${lookup mysql{.....}}
5233 .endd
5234 This avoids having to change the list separator in such data. You are unlikely
5235 to want to use a control character as a separator in an option that is not
5236 expanded, because the value is literal text. However, it can be done by giving
5237 the value in quotes. For example:
5238 .code
5239 local_interfaces = "<\n 127.0.0.1 \n ::1"
5240 .endd
5241 Unlike printing character separators, which can be included in list items by
5242 doubling, it is not possible to include a control character as data when it is
5243 set as the separator. Two such characters in succession are interpreted as
5244 enclosing an empty list item.
5245
5246
5247
5248 .section "Empty items in lists" "SECTempitelis"
5249 .cindex "list" "empty item in"
5250 An empty item at the end of a list is always ignored. In other words, trailing
5251 separator characters are ignored. Thus, the list in
5252 .code
5253 senders = user@domain :
5254 .endd
5255 contains only a single item. If you want to include an empty string as one item
5256 in a list, it must not be the last item. For example, this list contains three
5257 items, the second of which is empty:
5258 .code
5259 senders = user1@domain : : user2@domain
5260 .endd
5261 &*Note*&: There must be white space between the two colons, as otherwise they
5262 are interpreted as representing a single colon data character (and the list
5263 would then contain just one item). If you want to specify a list that contains
5264 just one, empty item, you can do it as in this example:
5265 .code
5266 senders = :
5267 .endd
5268 In this case, the first item is empty, and the second is discarded because it
5269 is at the end of the list.
5270
5271
5272
5273
5274 .section "Format of driver configurations" "SECTfordricon"
5275 .cindex "drivers" "configuration format"
5276 There are separate parts in the configuration for defining routers, transports,
5277 and authenticators. In each part, you are defining a number of driver
5278 instances, each with its own set of options. Each driver instance is defined by
5279 a sequence of lines like this:
5280 .display
5281 <&'instance name'&>:
5282   <&'option'&>
5283   ...
5284   <&'option'&>
5285 .endd
5286 In the following example, the instance name is &(localuser)&, and it is
5287 followed by three options settings:
5288 .code
5289 localuser:
5290   driver = accept
5291   check_local_user
5292   transport = local_delivery
5293 .endd
5294 For each driver instance, you specify which Exim code module it uses &-- by the
5295 setting of the &%driver%& option &-- and (optionally) some configuration
5296 settings. For example, in the case of transports, if you want a transport to
5297 deliver with SMTP you would use the &(smtp)& driver; if you want to deliver to
5298 a local file you would use the &(appendfile)& driver. Each of the drivers is
5299 described in detail in its own separate chapter later in this manual.
5300
5301 You can have several routers, transports, or authenticators that are based on
5302 the same underlying driver (each must have a different instance name).
5303
5304 The order in which routers are defined is important, because addresses are
5305 passed to individual routers one by one, in order. The order in which
5306 transports are defined does not matter at all. The order in which
5307 authenticators are defined is used only when Exim, as a client, is searching
5308 them to find one that matches an authentication mechanism offered by the
5309 server.
5310
5311 .cindex "generic options"
5312 .cindex "options" "generic &-- definition of"
5313 Within a driver instance definition, there are two kinds of option: &'generic'&
5314 and &'private'&. The generic options are those that apply to all drivers of the
5315 same type (that is, all routers, all transports or all authenticators). The
5316 &%driver%& option is a generic option that must appear in every definition.
5317 .cindex "private options"
5318 The private options are special for each driver, and none need appear, because
5319 they all have default values.
5320
5321 The options may appear in any order, except that the &%driver%& option must
5322 precede any private options, since these depend on the particular driver. For
5323 this reason, it is recommended that &%driver%& always be the first option.
5324
5325 Driver instance names, which are used for reference in log entries and
5326 elsewhere, can be any sequence of letters, digits, and underscores (starting
5327 with a letter) and must be unique among drivers of the same type. A router and
5328 a transport (for example) can each have the same name, but no two router
5329 instances can have the same name. The name of a driver instance should not be
5330 confused with the name of the underlying driver module. For example, the
5331 configuration lines:
5332 .code
5333 remote_smtp:
5334   driver = smtp
5335 .endd
5336 create an instance of the &(smtp)& transport driver whose name is
5337 &(remote_smtp)&. The same driver code can be used more than once, with
5338 different instance names and different option settings each time. A second
5339 instance of the &(smtp)& transport, with different options, might be defined
5340 thus:
5341 .code
5342 special_smtp:
5343   driver = smtp
5344   port = 1234
5345   command_timeout = 10s
5346 .endd
5347 The names &(remote_smtp)& and &(special_smtp)& would be used to reference
5348 these transport instances from routers, and these names would appear in log
5349 lines.
5350
5351 Comment lines may be present in the middle of driver specifications. The full
5352 list of option settings for any particular driver instance, including all the
5353 defaulted values, can be extracted by making use of the &%-bP%& command line
5354 option.
5355
5356
5357
5358
5359
5360
5361 . ////////////////////////////////////////////////////////////////////////////
5362 . ////////////////////////////////////////////////////////////////////////////
5363
5364 .chapter "The default configuration file" "CHAPdefconfil"
5365 .scindex IIDconfiwal "configuration file" "default &""walk through""&"
5366 .cindex "default" "configuration file &""walk through""&"
5367 The default configuration file supplied with Exim as &_src/configure.default_&
5368 is sufficient for a host with simple mail requirements. As an introduction to
5369 the way Exim is configured, this chapter &"walks through"& the default
5370 configuration, giving brief explanations of the settings. Detailed descriptions
5371 of the options are given in subsequent chapters. The default configuration file
5372 itself contains extensive comments about ways you might want to modify the
5373 initial settings. However, note that there are many options that are not
5374 mentioned at all in the default configuration.
5375
5376
5377
5378 .section "Main configuration settings" "SECTdefconfmain"
5379 The main (global) configuration option settings must always come first in the
5380 file. The first thing you'll see in the file, after some initial comments, is
5381 the line
5382 .code
5383 # primary_hostname =
5384 .endd
5385 This is a commented-out setting of the &%primary_hostname%& option. Exim needs
5386 to know the official, fully qualified name of your host, and this is where you
5387 can specify it. However, in most cases you do not need to set this option. When
5388 it is unset, Exim uses the &[uname()]& system function to obtain the host name.
5389
5390 The first three non-comment configuration lines are as follows:
5391 .code
5392 domainlist local_domains    = @
5393 domainlist relay_to_domains =
5394 hostlist   relay_from_hosts = 127.0.0.1
5395 .endd
5396 These are not, in fact, option settings. They are definitions of two named
5397 domain lists and one named host list. Exim allows you to give names to lists of
5398 domains, hosts, and email addresses, in order to make it easier to manage the
5399 configuration file (see section &<<SECTnamedlists>>&).
5400
5401 The first line defines a domain list called &'local_domains'&; this is used
5402 later in the configuration to identify domains that are to be delivered
5403 on the local host.
5404
5405 .cindex "@ in a domain list"
5406 There is just one item in this list, the string &"@"&. This is a special form
5407 of entry which means &"the name of the local host"&. Thus, if the local host is
5408 called &'a.host.example'&, mail to &'any.user@a.host.example'& is expected to
5409 be delivered locally. Because the local host's name is referenced indirectly,
5410 the same configuration file can be used on different hosts.
5411
5412 The second line defines a domain list called &'relay_to_domains'&, but the
5413 list itself is empty. Later in the configuration we will come to the part that
5414 controls mail relaying through the local host; it allows relaying to any
5415 domains in this list. By default, therefore, no relaying on the basis of a mail
5416 domain is permitted.
5417
5418 The third line defines a host list called &'relay_from_hosts'&. This list is
5419 used later in the configuration to permit relaying from any host or IP address
5420 that matches the list. The default contains just the IP address of the IPv4
5421 loopback interface, which means that processes on the local host are able to
5422 submit mail for relaying by sending it over TCP/IP to that interface. No other
5423 hosts are permitted to submit messages for relaying.
5424
5425 Just to be sure there's no misunderstanding: at this point in the configuration
5426 we aren't actually setting up any controls. We are just defining some domains
5427 and hosts that will be used in the controls that are specified later.
5428
5429 The next two configuration lines are genuine option settings:
5430 .code
5431 acl_smtp_rcpt = acl_check_rcpt
5432 acl_smtp_data = acl_check_data
5433 .endd
5434 These options specify &'Access Control Lists'& (ACLs) that are to be used
5435 during an incoming SMTP session for every recipient of a message (every RCPT
5436 command), and after the contents of the message have been received,
5437 respectively. The names of the lists are &'acl_check_rcpt'& and
5438 &'acl_check_data'&, and we will come to their definitions below, in the ACL
5439 section of the configuration. The RCPT ACL controls which recipients are
5440 accepted for an incoming message &-- if a configuration does not provide an ACL
5441 to check recipients, no SMTP mail can be accepted. The DATA ACL allows the
5442 contents of a message to be checked.
5443
5444 Two commented-out option settings are next:
5445 .code
5446 # av_scanner = clamd:/tmp/clamd
5447 # spamd_address = 127.0.0.1 783
5448 .endd
5449 These are example settings that can be used when Exim is compiled with the
5450 content-scanning extension. The first specifies the interface to the virus
5451 scanner, and the second specifies the interface to SpamAssassin. Further
5452 details are given in chapter &<<CHAPexiscan>>&.
5453
5454 Three more commented-out option settings follow:
5455 .code
5456 # tls_advertise_hosts = *
5457 # tls_certificate = /etc/ssl/exim.crt
5458 # tls_privatekey = /etc/ssl/exim.pem
5459 .endd
5460 These are example settings that can be used when Exim is compiled with
5461 support for TLS (aka SSL) as described in section &<<SECTinctlsssl>>&. The
5462 first one specifies the list of clients that are allowed to use TLS when
5463 connecting to this server; in this case the wildcard means all clients. The
5464 other options specify where Exim should find its TLS certificate and private
5465 key, which together prove the server's identity to any clients that connect.
5466 More details are given in chapter &<<CHAPTLS>>&.
5467
5468 Another two commented-out option settings follow:
5469 .code
5470 # daemon_smtp_ports = 25 : 465 : 587
5471 # tls_on_connect_ports = 465
5472 .endd
5473 .cindex "port" "465 and 587"
5474 .cindex "port" "for message submission"
5475 .cindex "message" "submission, ports for"
5476 .cindex "ssmtp protocol"
5477 .cindex "smtps protocol"
5478 .cindex "SMTP" "ssmtp protocol"
5479 .cindex "SMTP" "smtps protocol"
5480 These options provide better support for roaming users who wish to use this
5481 server for message submission. They are not much use unless you have turned on
5482 TLS (as described in the previous paragraph) and authentication (about which
5483 more in section &<<SECTdefconfauth>>&). The usual SMTP port 25 is often blocked
5484 on end-user networks, so RFC 4409 specifies that message submission should use
5485 port 587 instead. However some software (notably Microsoft Outlook) cannot be
5486 configured to use port 587 correctly, so these settings also enable the
5487 non-standard &"smtps"& (aka &"ssmtp"&) port 465 (see section
5488 &<<SECTsupobssmt>>&).
5489
5490 Two more commented-out options settings follow:
5491 .code
5492 # qualify_domain =
5493 # qualify_recipient =
5494 .endd
5495 The first of these specifies a domain that Exim uses when it constructs a
5496 complete email address from a local login name. This is often needed when Exim
5497 receives a message from a local process. If you do not set &%qualify_domain%&,
5498 the value of &%primary_hostname%& is used. If you set both of these options,
5499 you can have different qualification domains for sender and recipient
5500 addresses. If you set only the first one, its value is used in both cases.
5501
5502 .cindex "domain literal" "recognizing format"
5503 The following line must be uncommented if you want Exim to recognize
5504 addresses of the form &'user@[10.11.12.13]'& that is, with a &"domain literal"&
5505 (an IP address within square brackets) instead of a named domain.
5506 .code
5507 # allow_domain_literals
5508 .endd
5509 The RFCs still require this form, but many people think that in the modern
5510 Internet it makes little sense to permit mail to be sent to specific hosts by
5511 quoting their IP addresses. This ancient format has been used by people who
5512 try to abuse hosts by using them for unwanted relaying. However, some
5513 people believe there are circumstances (for example, messages addressed to
5514 &'postmaster'&) where domain literals are still useful.
5515
5516 The next configuration line is a kind of trigger guard:
5517 .code
5518 never_users = root
5519 .endd
5520 It specifies that no delivery must ever be run as the root user. The normal
5521 convention is to set up &'root'& as an alias for the system administrator. This
5522 setting is a guard against slips in the configuration.
5523 The list of users specified by &%never_users%& is not, however, the complete
5524 list; the build-time configuration in &_Local/Makefile_& has an option called
5525 FIXED_NEVER_USERS specifying a list that cannot be overridden. The
5526 contents of &%never_users%& are added to this list. By default
5527 FIXED_NEVER_USERS also specifies root.
5528
5529 When a remote host connects to Exim in order to send mail, the only information
5530 Exim has about the host's identity is its IP address. The next configuration
5531 line,
5532 .code
5533 host_lookup = *
5534 .endd
5535 specifies that Exim should do a reverse DNS lookup on all incoming connections,
5536 in order to get a host name. This improves the quality of the logging
5537 information, but if you feel it is too expensive, you can remove it entirely,
5538 or restrict the lookup to hosts on &"nearby"& networks.
5539 Note that it is not always possible to find a host name from an IP address,
5540 because not all DNS reverse zones are maintained, and sometimes DNS servers are
5541 unreachable.
5542
5543 The next two lines are concerned with &'ident'& callbacks, as defined by RFC
5544 1413 (hence their names):
5545 .code
5546 rfc1413_hosts = *
5547 rfc1413_query_timeout = 5s
5548 .endd
5549 These settings cause Exim to make ident callbacks for all incoming SMTP calls.
5550 You can limit the hosts to which these calls are made, or change the timeout
5551 that is used. If you set the timeout to zero, all ident calls are disabled.
5552 Although they are cheap and can provide useful information for tracing problem
5553 messages, some hosts and firewalls have problems with ident calls. This can
5554 result in a timeout instead of an immediate refused connection, leading to
5555 delays on starting up an incoming SMTP session.
5556
5557 When Exim receives messages over SMTP connections, it expects all addresses to
5558 be fully qualified with a domain, as required by the SMTP definition. However,
5559 if you are running a server to which simple clients submit messages, you may
5560 find that they send unqualified addresses. The two commented-out options:
5561 .code
5562 # sender_unqualified_hosts =
5563 # recipient_unqualified_hosts =
5564 .endd
5565 show how you can specify hosts that are permitted to send unqualified sender
5566 and recipient addresses, respectively.
5567
5568 The &%percent_hack_domains%& option is also commented out:
5569 .code
5570 # percent_hack_domains =
5571 .endd
5572 It provides a list of domains for which the &"percent hack"& is to operate.
5573 This is an almost obsolete form of explicit email routing. If you do not know
5574 anything about it, you can safely ignore this topic.
5575
5576 The last two settings in the main part of the default configuration are
5577 concerned with messages that have been &"frozen"& on Exim's queue. When a
5578 message is frozen, Exim no longer continues to try to deliver it. Freezing
5579 occurs when a bounce message encounters a permanent failure because the sender
5580 address of the original message that caused the bounce is invalid, so the
5581 bounce cannot be delivered. This is probably the most common case, but there
5582 are also other conditions that cause freezing, and frozen messages are not
5583 always bounce messages.
5584 .code
5585 ignore_bounce_errors_after = 2d
5586 timeout_frozen_after = 7d
5587 .endd
5588 The first of these options specifies that failing bounce messages are to be
5589 discarded after 2 days on the queue. The second specifies that any frozen
5590 message (whether a bounce message or not) is to be timed out (and discarded)
5591 after a week. In this configuration, the first setting ensures that no failing
5592 bounce message ever lasts a week.
5593
5594
5595
5596 .section "ACL configuration" "SECID54"
5597 .cindex "default" "ACLs"
5598 .cindex "&ACL;" "default configuration"
5599 In the default configuration, the ACL section follows the main configuration.
5600 It starts with the line
5601 .code
5602 begin acl
5603 .endd
5604 and it contains the definitions of two ACLs, called &'acl_check_rcpt'& and
5605 &'acl_check_data'&, that were referenced in the settings of &%acl_smtp_rcpt%&
5606 and &%acl_smtp_data%& above.
5607
5608 .cindex "RCPT" "ACL for"
5609 The first ACL is used for every RCPT command in an incoming SMTP message. Each
5610 RCPT command specifies one of the message's recipients. The ACL statements
5611 are considered in order, until the recipient address is either accepted or
5612 rejected. The RCPT command is then accepted or rejected, according to the
5613 result of the ACL processing.
5614 .code
5615 acl_check_rcpt:
5616 .endd
5617 This line, consisting of a name terminated by a colon, marks the start of the
5618 ACL, and names it.
5619 .code
5620 accept  hosts = :
5621 .endd
5622 This ACL statement accepts the recipient if the sending host matches the list.
5623 But what does that strange list mean? It doesn't actually contain any host
5624 names or IP addresses. The presence of the colon puts an empty item in the
5625 list; Exim matches this only if the incoming message did not come from a remote
5626 host, because in that case, the remote hostname is empty. The colon is
5627 important. Without it, the list itself is empty, and can never match anything.
5628
5629 What this statement is doing is to accept unconditionally all recipients in
5630 messages that are submitted by SMTP from local processes using the standard
5631 input and output (that is, not using TCP/IP). A number of MUAs operate in this
5632 manner.
5633 .code
5634 deny    message       = Restricted characters in address
5635         domains       = +local_domains
5636         local_parts   = ^[.] : ^.*[@%!/|]
5637
5638 deny    message       = Restricted characters in address
5639         domains       = !+local_domains
5640         local_parts   = ^[./|] : ^.*[@%!] : ^.*/\\.\\./
5641 .endd
5642 These statements are concerned with local parts that contain any of the
5643 characters &"@"&, &"%"&, &"!"&, &"/"&, &"|"&, or dots in unusual places.
5644 Although these characters are entirely legal in local parts (in the case of
5645 &"@"& and leading dots, only if correctly quoted), they do not commonly occur
5646 in Internet mail addresses.
5647
5648 The first three have in the past been associated with explicitly routed
5649 addresses (percent is still sometimes used &-- see the &%percent_hack_domains%&
5650 option). Addresses containing these characters are regularly tried by spammers
5651 in an attempt to bypass relaying restrictions, and also by open relay testing
5652 programs. Unless you really need them it is safest to reject these characters
5653 at this early stage. This configuration is heavy-handed in rejecting these
5654 characters for all messages it accepts from remote hosts. This is a deliberate
5655 policy of being as safe as possible.
5656
5657 The first rule above is stricter, and is applied to messages that are addressed
5658 to one of the local domains handled by this host. This is implemented by the
5659 first condition, which restricts it to domains that are listed in the
5660 &'local_domains'& domain list. The &"+"& character is used to indicate a
5661 reference to a named list. In this configuration, there is just one domain in
5662 &'local_domains'&, but in general there may be many.
5663
5664 The second condition on the first statement uses two regular expressions to
5665 block local parts that begin with a dot or contain &"@"&, &"%"&, &"!"&, &"/"&,
5666 or &"|"&. If you have local accounts that include these characters, you will
5667 have to modify this rule.
5668
5669 Empty components (two dots in a row) are not valid in RFC 2822, but Exim
5670 allows them because they have been encountered in practice. (Consider the
5671 common convention of local parts constructed as
5672 &"&'first-initial.second-initial.family-name'&"& when applied to someone like
5673 the author of Exim, who has no second initial.) However, a local part starting
5674 with a dot or containing &"/../"& can cause trouble if it is used as part of a
5675 file name (for example, for a mailing list). This is also true for local parts
5676 that contain slashes. A pipe symbol can also be troublesome if the local part
5677 is incorporated unthinkingly into a shell command line.
5678
5679 The second rule above applies to all other domains, and is less strict. This
5680 allows your own users to send outgoing messages to sites that use slashes
5681 and vertical bars in their local parts. It blocks local parts that begin
5682 with a dot, slash, or vertical bar, but allows these characters within the
5683 local part. However, the sequence &"/../"& is barred. The use of &"@"&, &"%"&,
5684 and &"!"& is blocked, as before. The motivation here is to prevent your users
5685 (or your users' viruses) from mounting certain kinds of attack on remote sites.
5686 .code
5687 accept  local_parts   = postmaster
5688         domains       = +local_domains
5689 .endd
5690 This statement, which has two conditions, accepts an incoming address if the
5691 local part is &'postmaster'& and the domain is one of those listed in the
5692 &'local_domains'& domain list. The &"+"& character is used to indicate a
5693 reference to a named list. In this configuration, there is just one domain in
5694 &'local_domains'&, but in general there may be many.
5695
5696 The presence of this statement means that mail to postmaster is never blocked
5697 by any of the subsequent tests. This can be helpful while sorting out problems
5698 in cases where the subsequent tests are incorrectly denying access.
5699 .code
5700 require verify        = sender
5701 .endd
5702 This statement requires the sender address to be verified before any subsequent
5703 ACL statement can be used. If verification fails, the incoming recipient
5704 address is refused. Verification consists of trying to route the address, to
5705 see if a bounce message could be delivered to it. In the case of remote
5706 addresses, basic verification checks only the domain, but &'callouts'& can be
5707 used for more verification if required. Section &<<SECTaddressverification>>&
5708 discusses the details of address verification.
5709 .code
5710 accept  hosts         = +relay_from_hosts
5711         control       = submission
5712 .endd
5713 This statement accepts the address if the message is coming from one of the
5714 hosts that are defined as being allowed to relay through this host. Recipient
5715 verification is omitted here, because in many cases the clients are dumb MUAs
5716 that do not cope well with SMTP error responses. For the same reason, the
5717 second line specifies &"submission mode"& for messages that are accepted. This
5718 is described in detail in section &<<SECTsubmodnon>>&; it causes Exim to fix
5719 messages that are deficient in some way, for example, because they lack a
5720 &'Date:'& header line. If you are actually relaying out from MTAs, you should
5721 probably add recipient verification here, and disable submission mode.
5722 .code
5723 accept  authenticated = *
5724         control       = submission
5725 .endd
5726 This statement accepts the address if the client host has authenticated itself.
5727 Submission mode is again specified, on the grounds that such messages are most
5728 likely to come from MUAs. The default configuration does not define any
5729 authenticators, though it does include some nearly complete commented-out
5730 examples described in &<<SECTdefconfauth>>&. This means that no client can in
5731 fact authenticate until you complete the authenticator definitions.
5732 .code
5733 require message = relay not permitted
5734         domains = +local_domains : +relay_to_domains
5735 .endd
5736 This statement rejects the address if its domain is neither a local domain nor
5737 one of the domains for which this host is a relay.
5738 .code
5739 require verify = recipient
5740 .endd
5741 This statement requires the recipient address to be verified; if verification
5742 fails, the address is rejected.
5743 .code
5744 # deny    message     = rejected because $sender_host_address \
5745 #                       is in a black list at $dnslist_domain\n\
5746 #                       $dnslist_text
5747 #         dnslists    = black.list.example
5748 #
5749 # warn    dnslists    = black.list.example
5750 #         add_header  = X-Warning: $sender_host_address is in \
5751 #                       a black list at $dnslist_domain
5752 #         log_message = found in $dnslist_domain
5753 .endd
5754 These commented-out lines are examples of how you could configure Exim to check
5755 sending hosts against a DNS black list. The first statement rejects messages
5756 from blacklisted hosts, whereas the second just inserts a warning header
5757 line.
5758 .code
5759 # require verify = csa
5760 .endd
5761 This commented-out line is an example of how you could turn on client SMTP
5762 authorization (CSA) checking. Such checks do DNS lookups for special SRV
5763 records.
5764 .code
5765 accept
5766 .endd
5767 The final statement in the first ACL unconditionally accepts any recipient
5768 address that has successfully passed all the previous tests.
5769 .code
5770 acl_check_data:
5771 .endd
5772 This line marks the start of the second ACL, and names it. Most of the contents
5773 of this ACL are commented out:
5774 .code
5775 # deny    malware   = *
5776 #         message   = This message contains a virus \
5777 #                     ($malware_name).
5778 .endd
5779 These lines are examples of how to arrange for messages to be scanned for
5780 viruses when Exim has been compiled with the content-scanning extension, and a
5781 suitable virus scanner is installed. If the message is found to contain a
5782 virus, it is rejected with the given custom error message.
5783 .code
5784 # warn    spam      = nobody
5785 #         message   = X-Spam_score: $spam_score\n\
5786 #                     X-Spam_score_int: $spam_score_int\n\
5787 #                     X-Spam_bar: $spam_bar\n\
5788 #                     X-Spam_report: $spam_report
5789 .endd
5790 These lines are an example of how to arrange for messages to be scanned by
5791 SpamAssassin when Exim has been compiled with the content-scanning extension,
5792 and SpamAssassin has been installed. The SpamAssassin check is run with
5793 &`nobody`& as its user parameter, and the results are added to the message as a
5794 series of extra header line. In this case, the message is not rejected,
5795 whatever the spam score.
5796 .code
5797 accept
5798 .endd
5799 This final line in the DATA ACL accepts the message unconditionally.
5800
5801
5802 .section "Router configuration" "SECID55"
5803 .cindex "default" "routers"
5804 .cindex "routers" "default"
5805 The router configuration comes next in the default configuration, introduced
5806 by the line
5807 .code
5808 begin routers
5809 .endd
5810 Routers are the modules in Exim that make decisions about where to send
5811 messages. An address is passed to each router in turn, until it is either
5812 accepted, or failed. This means that the order in which you define the routers
5813 matters. Each router is fully described in its own chapter later in this
5814 manual. Here we give only brief overviews.
5815 .code
5816 # domain_literal:
5817 #   driver = ipliteral
5818 #   domains = !+local_domains
5819 #   transport = remote_smtp
5820 .endd
5821 .cindex "domain literal" "default router"
5822 This router is commented out because the majority of sites do not want to
5823 support domain literal addresses (those of the form &'user@[10.9.8.7]'&). If
5824 you uncomment this router, you also need to uncomment the setting of
5825 &%allow_domain_literals%& in the main part of the configuration.
5826 .code
5827 dnslookup:
5828   driver = dnslookup
5829   domains = ! +local_domains
5830   transport = remote_smtp
5831   ignore_target_hosts = 0.0.0.0 : 127.0.0.0/8
5832   no_more
5833 .endd
5834 The first uncommented router handles addresses that do not involve any local
5835 domains. This is specified by the line
5836 .code
5837 domains = ! +local_domains
5838 .endd
5839 The &%domains%& option lists the domains to which this router applies, but the
5840 exclamation mark is a negation sign, so the router is used only for domains
5841 that are not in the domain list called &'local_domains'& (which was defined at
5842 the start of the configuration). The plus sign before &'local_domains'&
5843 indicates that it is referring to a named list. Addresses in other domains are
5844 passed on to the following routers.
5845
5846 The name of the router driver is &(dnslookup)&,
5847 and is specified by the &%driver%& option. Do not be confused by the fact that
5848 the name of this router instance is the same as the name of the driver. The
5849 instance name is arbitrary, but the name set in the &%driver%& option must be
5850 one of the driver modules that is in the Exim binary.
5851
5852 The &(dnslookup)& router routes addresses by looking up their domains in the
5853 DNS in order to obtain a list of hosts to which the address is routed. If the
5854 router succeeds, the address is queued for the &(remote_smtp)& transport, as
5855 specified by the &%transport%& option. If the router does not find the domain
5856 in the DNS, no further routers are tried because of the &%no_more%& setting, so
5857 the address fails and is bounced.
5858
5859 The &%ignore_target_hosts%& option specifies a list of IP addresses that are to
5860 be entirely ignored. This option is present because a number of cases have been
5861 encountered where MX records in the DNS point to host names
5862 whose IP addresses are 0.0.0.0 or are in the 127 subnet (typically 127.0.0.1).
5863 Completely ignoring these IP addresses causes Exim to fail to route the
5864 email address, so it bounces. Otherwise, Exim would log a routing problem, and
5865 continue to try to deliver the message periodically until the address timed
5866 out.
5867 .code
5868 system_aliases:
5869   driver = redirect
5870   allow_fail
5871   allow_defer
5872   data = ${lookup{$local_part}lsearch{/etc/aliases}}
5873 # user = exim
5874   file_transport = address_file
5875   pipe_transport = address_pipe
5876 .endd
5877 Control reaches this and subsequent routers only for addresses in the local
5878 domains. This router checks to see whether the local part is defined as an
5879 alias in the &_/etc/aliases_& file, and if so, redirects it according to the
5880 data that it looks up from that file. If no data is found for the local part,
5881 the value of the &%data%& option is empty, causing the address to be passed to
5882 the next router.
5883
5884 &_/etc/aliases_& is a conventional name for the system aliases file that is
5885 often used. That is why it is referenced by from the default configuration
5886 file. However, you can change this by setting SYSTEM_ALIASES_FILE in
5887 &_Local/Makefile_& before building Exim.
5888 .code
5889 userforward:
5890   driver = redirect
5891   check_local_user
5892 # local_part_suffix = +* : -*
5893 # local_part_suffix_optional
5894   file = $home/.forward
5895 # allow_filter
5896   no_verify
5897   no_expn
5898   check_ancestor
5899   file_transport = address_file
5900   pipe_transport = address_pipe
5901   reply_transport = address_reply
5902 .endd
5903 This is the most complicated router in the default configuration. It is another
5904 redirection router, but this time it is looking for forwarding data set up by
5905 individual users. The &%check_local_user%& setting specifies a check that the
5906 local part of the address is the login name of a local user. If it is not, the
5907 router is skipped. The two commented options that follow &%check_local_user%&,
5908 namely:
5909 .code
5910 # local_part_suffix = +* : -*
5911 # local_part_suffix_optional
5912 .endd
5913 .vindex "&$local_part_suffix$&"
5914 show how you can specify the recognition of local part suffixes. If the first
5915 is uncommented, a suffix beginning with either a plus or a minus sign, followed
5916 by any sequence of characters, is removed from the local part and placed in the
5917 variable &$local_part_suffix$&. The second suffix option specifies that the
5918 presence of a suffix in the local part is optional. When a suffix is present,
5919 the check for a local login uses the local part with the suffix removed.
5920
5921 When a local user account is found, the file called &_.forward_& in the user's
5922 home directory is consulted. If it does not exist, or is empty, the router
5923 declines. Otherwise, the contents of &_.forward_& are interpreted as
5924 redirection data (see chapter &<<CHAPredirect>>& for more details).
5925
5926 .cindex "Sieve filter" "enabling in default router"
5927 Traditional &_.forward_& files contain just a list of addresses, pipes, or
5928 files. Exim supports this by default. However, if &%allow_filter%& is set (it
5929 is commented out by default), the contents of the file are interpreted as a set
5930 of Exim or Sieve filtering instructions, provided the file begins with &"#Exim
5931 filter"& or &"#Sieve filter"&, respectively. User filtering is discussed in the
5932 separate document entitled &'Exim's interfaces to mail filtering'&.
5933
5934 The &%no_verify%& and &%no_expn%& options mean that this router is skipped when
5935 verifying addresses, or when running as a consequence of an SMTP EXPN command.
5936 There are two reasons for doing this:
5937
5938 .olist
5939 Whether or not a local user has a &_.forward_& file is not really relevant when
5940 checking an address for validity; it makes sense not to waste resources doing
5941 unnecessary work.
5942 .next
5943 More importantly, when Exim is verifying addresses or handling an EXPN
5944 command during an SMTP session, it is running as the Exim user, not as root.
5945 The group is the Exim group, and no additional groups are set up.
5946 It may therefore not be possible for Exim to read users' &_.forward_& files at
5947 this time.
5948 .endlist
5949
5950 The setting of &%check_ancestor%& prevents the router from generating a new
5951 address that is the same as any previous address that was redirected. (This
5952 works round a problem concerning a bad interaction between aliasing and
5953 forwarding &-- see section &<<SECTredlocmai>>&).
5954
5955 The final three option settings specify the transports that are to be used when
5956 forwarding generates a direct delivery to a file, or to a pipe, or sets up an
5957 auto-reply, respectively. For example, if a &_.forward_& file contains
5958 .code
5959 a.nother@elsewhere.example, /home/spqr/archive
5960 .endd
5961 the delivery to &_/home/spqr/archive_& is done by running the &%address_file%&
5962 transport.
5963 .code
5964 localuser:
5965   driver = accept
5966   check_local_user
5967 # local_part_suffix = +* : -*
5968 # local_part_suffix_optional
5969   transport = local_delivery
5970 .endd
5971 The final router sets up delivery into local mailboxes, provided that the local
5972 part is the name of a local login, by accepting the address and assigning it to
5973 the &(local_delivery)& transport. Otherwise, we have reached the end of the
5974 routers, so the address is bounced. The commented suffix settings fulfil the
5975 same purpose as they do for the &(userforward)& router.
5976
5977
5978 .section "Transport configuration" "SECID56"
5979 .cindex "default" "transports"
5980 .cindex "transports" "default"
5981 Transports define mechanisms for actually delivering messages. They operate
5982 only when referenced from routers, so the order in which they are defined does
5983 not matter. The transports section of the configuration starts with
5984 .code
5985 begin transports
5986 .endd
5987 One remote transport and four local transports are defined.
5988 .code
5989 remote_smtp:
5990   driver = smtp
5991 .endd
5992 This transport is used for delivering messages over SMTP connections. All its
5993 options are defaulted. The list of remote hosts comes from the router.
5994 .code
5995 local_delivery:
5996   driver = appendfile
5997   file = /var/mail/$local_part
5998   delivery_date_add
5999   envelope_to_add
6000   return_path_add
6001 # group = mail
6002 # mode = 0660
6003 .endd
6004 This &(appendfile)& transport is used for local delivery to user mailboxes in
6005 traditional BSD mailbox format. By default it runs under the uid and gid of the
6006 local user, which requires the sticky bit to be set on the &_/var/mail_&
6007 directory. Some systems use the alternative approach of running mail deliveries
6008 under a particular group instead of using the sticky bit. The commented options
6009 show how this can be done.
6010
6011 Exim adds three headers to the message as it delivers it: &'Delivery-date:'&,
6012 &'Envelope-to:'& and &'Return-path:'&. This action is requested by the three
6013 similarly-named options above.
6014 .code
6015 address_pipe:
6016   driver = pipe
6017   return_output
6018 .endd
6019 This transport is used for handling deliveries to pipes that are generated by
6020 redirection (aliasing or users' &_.forward_& files). The &%return_output%&
6021 option specifies that any output generated by the pipe is to be returned to the
6022 sender.
6023 .code
6024 address_file:
6025   driver = appendfile
6026   delivery_date_add
6027   envelope_to_add
6028   return_path_add
6029 .endd
6030 This transport is used for handling deliveries to files that are generated by
6031 redirection. The name of the file is not specified in this instance of
6032 &(appendfile)&, because it comes from the &(redirect)& router.
6033 .code
6034 address_reply:
6035   driver = autoreply
6036 .endd
6037 This transport is used for handling automatic replies generated by users'
6038 filter files.
6039
6040
6041
6042 .section "Default retry rule" "SECID57"
6043 .cindex "retry" "default rule"
6044 .cindex "default" "retry rule"
6045 The retry section of the configuration file contains rules which affect the way
6046 Exim retries deliveries that cannot be completed at the first attempt. It is
6047 introduced by the line
6048 .code
6049 begin retry
6050 .endd
6051 In the default configuration, there is just one rule, which applies to all
6052 errors:
6053 .code
6054 *   *   F,2h,15m; G,16h,1h,1.5; F,4d,6h
6055 .endd
6056 This causes any temporarily failing address to be retried every 15 minutes for
6057 2 hours, then at intervals starting at one hour and increasing by a factor of
6058 1.5 until 16 hours have passed, then every 6 hours up to 4 days. If an address
6059 is not delivered after 4 days of temporary failure, it is bounced.
6060
6061 If the retry section is removed from the configuration, or is empty (that is,
6062 if no retry rules are defined), Exim will not retry deliveries. This turns
6063 temporary errors into permanent errors.
6064
6065
6066 .section "Rewriting configuration" "SECID58"
6067 The rewriting section of the configuration, introduced by
6068 .code
6069 begin rewrite
6070 .endd
6071 contains rules for rewriting addresses in messages as they arrive. There are no
6072 rewriting rules in the default configuration file.
6073
6074
6075
6076 .section "Authenticators configuration" "SECTdefconfauth"
6077 .cindex "AUTH" "configuration"
6078 The authenticators section of the configuration, introduced by
6079 .code
6080 begin authenticators
6081 .endd
6082 defines mechanisms for the use of the SMTP AUTH command. The default
6083 configuration file contains two commented-out example authenticators
6084 which support plaintext username/password authentication using the
6085 standard PLAIN mechanism and the traditional but non-standard LOGIN
6086 mechanism, with Exim acting as the server. PLAIN and LOGIN are enough
6087 to support most MUA software.
6088
6089 The example PLAIN authenticator looks like this:
6090 .code
6091 #PLAIN:
6092 #  driver                  = plaintext
6093 #  server_set_id           = $auth2
6094 #  server_prompts          = :
6095 #  server_condition        = Authentication is not yet configured
6096 #  server_advertise_condition = ${if def:tls_in_cipher }
6097 .endd
6098 And the example LOGIN authenticator looks like this:
6099 .code
6100 #LOGIN:
6101 #  driver                  = plaintext
6102 #  server_set_id           = $auth1
6103 #  server_prompts          = <| Username: | Password:
6104 #  server_condition        = Authentication is not yet configured
6105 #  server_advertise_condition = ${if def:tls_in_cipher }
6106 .endd
6107
6108 The &%server_set_id%& option makes Exim remember the authenticated username
6109 in &$authenticated_id$&, which can be used later in ACLs or routers. The
6110 &%server_prompts%& option configures the &(plaintext)& authenticator so
6111 that it implements the details of the specific authentication mechanism,
6112 i.e. PLAIN or LOGIN. The &%server_advertise_condition%& setting controls
6113 when Exim offers authentication to clients; in the examples, this is only
6114 when TLS or SSL has been started, so to enable the authenticators you also
6115 need to add support for TLS as described in section &<<SECTdefconfmain>>&.
6116
6117 The &%server_condition%& setting defines how to verify that the username and
6118 password are correct. In the examples it just produces an error message.
6119 To make the authenticators work, you can use a string expansion
6120 expression like one of the examples in chapter &<<CHAPplaintext>>&.
6121
6122 Beware that the sequence of the parameters to PLAIN and LOGIN differ; the
6123 usercode and password are in different positions.
6124 Chapter &<<CHAPplaintext>>& covers both.
6125
6126 .ecindex IIDconfiwal
6127
6128
6129
6130 . ////////////////////////////////////////////////////////////////////////////
6131 . ////////////////////////////////////////////////////////////////////////////
6132
6133 .chapter "Regular expressions" "CHAPregexp"
6134
6135 .cindex "regular expressions" "library"
6136 .cindex "PCRE"
6137 Exim supports the use of regular expressions in many of its options. It
6138 uses the PCRE regular expression library; this provides regular expression
6139 matching that is compatible with Perl 5. The syntax and semantics of
6140 regular expressions is discussed in many Perl reference books, and also in
6141 Jeffrey Friedl's &'Mastering Regular Expressions'&, which is published by
6142 O'Reilly (see &url(http://www.oreilly.com/catalog/regex2/)).
6143
6144 The documentation for the syntax and semantics of the regular expressions that
6145 are supported by PCRE is included in the PCRE distribution, and no further
6146 description is included here. The PCRE functions are called from Exim using
6147 the default option settings (that is, with no PCRE options set), except that
6148 the PCRE_CASELESS option is set when the matching is required to be
6149 case-insensitive.
6150
6151 In most cases, when a regular expression is required in an Exim configuration,
6152 it has to start with a circumflex, in order to distinguish it from plain text
6153 or an &"ends with"& wildcard. In this example of a configuration setting, the
6154 second item in the colon-separated list is a regular expression.
6155 .code
6156 domains = a.b.c : ^\\d{3} : *.y.z : ...
6157 .endd
6158 The doubling of the backslash is required because of string expansion that
6159 precedes interpretation &-- see section &<<SECTlittext>>& for more discussion
6160 of this issue, and a way of avoiding the need for doubling backslashes. The
6161 regular expression that is eventually used in this example contains just one
6162 backslash. The circumflex is included in the regular expression, and has the
6163 normal effect of &"anchoring"& it to the start of the string that is being
6164 matched.
6165
6166 There are, however, two cases where a circumflex is not required for the
6167 recognition of a regular expression: these are the &%match%& condition in a
6168 string expansion, and the &%matches%& condition in an Exim filter file. In
6169 these cases, the relevant string is always treated as a regular expression; if
6170 it does not start with a circumflex, the expression is not anchored, and can
6171 match anywhere in the subject string.
6172
6173 In all cases, if you want a regular expression to match at the end of a string,
6174 you must code the $ metacharacter to indicate this. For example:
6175 .code
6176 domains = ^\\d{3}\\.example
6177 .endd
6178 matches the domain &'123.example'&, but it also matches &'123.example.com'&.
6179 You need to use:
6180 .code
6181 domains = ^\\d{3}\\.example\$
6182 .endd
6183 if you want &'example'& to be the top-level domain. The backslash before the
6184 $ is needed because string expansion also interprets dollar characters.
6185
6186
6187
6188 . ////////////////////////////////////////////////////////////////////////////
6189 . ////////////////////////////////////////////////////////////////////////////
6190
6191 .chapter "File and database lookups" "CHAPfdlookup"
6192 .scindex IIDfidalo1 "file" "lookups"
6193 .scindex IIDfidalo2 "database" "lookups"
6194 .cindex "lookup" "description of"
6195 Exim can be configured to look up data in files or databases as it processes
6196 messages. Two different kinds of syntax are used:
6197
6198 .olist
6199 A string that is to be expanded may contain explicit lookup requests. These
6200 cause parts of the string to be replaced by data that is obtained from the
6201 lookup. Lookups of this type are conditional expansion items. Different results
6202 can be defined for the cases of lookup success and failure. See chapter
6203 &<<CHAPexpand>>&, where string expansions are described in detail.
6204 .next
6205 Lists of domains, hosts, and email addresses can contain lookup requests as a
6206 way of avoiding excessively long linear lists. In this case, the data that is
6207 returned by the lookup is often (but not always) discarded; whether the lookup
6208 succeeds or fails is what really counts. These kinds of list are described in
6209 chapter &<<CHAPdomhosaddlists>>&.
6210 .endlist
6211
6212 String expansions, lists, and lookups interact with each other in such a way
6213 that there is no order in which to describe any one of them that does not
6214 involve references to the others. Each of these three chapters makes more sense
6215 if you have read the other two first. If you are reading this for the first
6216 time, be aware that some of it will make a lot more sense after you have read
6217 chapters &<<CHAPdomhosaddlists>>& and &<<CHAPexpand>>&.
6218
6219 .section "Examples of different lookup syntax" "SECID60"
6220 It is easy to confuse the two different kinds of lookup, especially as the
6221 lists that may contain the second kind are always expanded before being
6222 processed as lists. Therefore, they may also contain lookups of the first kind.
6223 Be careful to distinguish between the following two examples:
6224 .code
6225 domains = ${lookup{$sender_host_address}lsearch{/some/file}}
6226 domains = lsearch;/some/file
6227 .endd
6228 The first uses a string expansion, the result of which must be a domain list.
6229 No strings have been specified for a successful or a failing lookup; the
6230 defaults in this case are the looked-up data and an empty string, respectively.
6231 The expansion takes place before the string is processed as a list, and the
6232 file that is searched could contain lines like this:
6233 .code
6234 192.168.3.4: domain1:domain2:...
6235 192.168.1.9: domain3:domain4:...
6236 .endd
6237 When the lookup succeeds, the result of the expansion is a list of domains (and
6238 possibly other types of item that are allowed in domain lists).
6239
6240 In the second example, the lookup is a single item in a domain list. It causes
6241 Exim to use a lookup to see if the domain that is being processed can be found
6242 in the file. The file could contains lines like this:
6243 .code
6244 domain1:
6245 domain2:
6246 .endd
6247 Any data that follows the keys is not relevant when checking that the domain
6248 matches the list item.
6249
6250 It is possible, though no doubt confusing, to use both kinds of lookup at once.
6251 Consider a file containing lines like this:
6252 .code
6253 192.168.5.6: lsearch;/another/file
6254 .endd
6255 If the value of &$sender_host_address$& is 192.168.5.6, expansion of the
6256 first &%domains%& setting above generates the second setting, which therefore
6257 causes a second lookup to occur.
6258
6259 The rest of this chapter describes the different lookup types that are
6260 available. Any of them can be used in any part of the configuration where a
6261 lookup is permitted.
6262
6263
6264 .section "Lookup types" "SECID61"
6265 .cindex "lookup" "types of"
6266 .cindex "single-key lookup" "definition of"
6267 Two different types of data lookup are implemented:
6268
6269 .ilist
6270 The &'single-key'& type requires the specification of a file in which to look,
6271 and a single key to search for. The key must be a non-empty string for the
6272 lookup to succeed. The lookup type determines how the file is searched.
6273 .next
6274 .cindex "query-style lookup" "definition of"
6275 The &'query-style'& type accepts a generalized database query. No particular
6276 key value is assumed by Exim for query-style lookups. You can use whichever
6277 Exim variables you need to construct the database query.
6278 .endlist
6279
6280 The code for each lookup type is in a separate source file that is included in
6281 the binary of Exim only if the corresponding compile-time option is set. The
6282 default settings in &_src/EDITME_& are:
6283 .code
6284 LOOKUP_DBM=yes
6285 LOOKUP_LSEARCH=yes
6286 .endd
6287 which means that only linear searching and DBM lookups are included by default.
6288 For some types of lookup (e.g. SQL databases), you need to install appropriate
6289 libraries and header files before building Exim.
6290
6291
6292
6293
6294 .section "Single-key lookup types" "SECTsinglekeylookups"
6295 .cindex "lookup" "single-key types"
6296 .cindex "single-key lookup" "list of types"
6297 The following single-key lookup types are implemented:
6298
6299 .ilist
6300 .cindex "cdb" "description of"
6301 .cindex "lookup" "cdb"
6302 .cindex "binary zero" "in lookup key"
6303 &(cdb)&: The given file is searched as a Constant DataBase file, using the key
6304 string without a terminating binary zero. The cdb format is designed for
6305 indexed files that are read frequently and never updated, except by total
6306 re-creation. As such, it is particularly suitable for large files containing
6307 aliases or other indexed data referenced by an MTA. Information about cdb can
6308 be found in several places:
6309 .display
6310 &url(http://www.pobox.com/~djb/cdb.html)
6311 &url(ftp://ftp.corpit.ru/pub/tinycdb/)
6312 &url(http://packages.debian.org/stable/utils/freecdb.html)
6313 .endd
6314 A cdb distribution is not needed in order to build Exim with cdb support,
6315 because the code for reading cdb files is included directly in Exim itself.
6316 However, no means of building or testing cdb files is provided with Exim, so
6317 you need to obtain a cdb distribution in order to do this.
6318 .next
6319 .cindex "DBM" "lookup type"
6320 .cindex "lookup" "dbm"
6321 .cindex "binary zero" "in lookup key"
6322 &(dbm)&: Calls to DBM library functions are used to extract data from the given
6323 DBM file by looking up the record with the given key. A terminating binary
6324 zero is included in the key that is passed to the DBM library. See section
6325 &<<SECTdb>>& for a discussion of DBM libraries.
6326
6327 .cindex "Berkeley DB library" "file format"
6328 For all versions of Berkeley DB, Exim uses the DB_HASH style of database
6329 when building DBM files using the &%exim_dbmbuild%& utility. However, when
6330 using Berkeley DB versions 3 or 4, it opens existing databases for reading with
6331 the DB_UNKNOWN option. This enables it to handle any of the types of database
6332 that the library supports, and can be useful for accessing DBM files created by
6333 other applications. (For earlier DB versions, DB_HASH is always used.)
6334 .next
6335 .cindex "lookup" "dbmjz"
6336 .cindex "lookup" "dbm &-- embedded NULs"
6337 .cindex "sasldb2"
6338 .cindex "dbmjz lookup type"
6339 &(dbmjz)&: This is the same as &(dbm)&, except that the lookup key is
6340 interpreted as an Exim list; the elements of the list are joined together with
6341 ASCII NUL characters to form the lookup key.  An example usage would be to
6342 authenticate incoming SMTP calls using the passwords from Cyrus SASL's
6343 &_/etc/sasldb2_& file with the &(gsasl)& authenticator or Exim's own
6344 &(cram_md5)& authenticator.
6345 .next
6346 .cindex "lookup" "dbmnz"
6347 .cindex "lookup" "dbm &-- terminating zero"
6348 .cindex "binary zero" "in lookup key"
6349 .cindex "Courier"
6350 .cindex "&_/etc/userdbshadow.dat_&"
6351 .cindex "dbmnz lookup type"
6352 &(dbmnz)&: This is the same as &(dbm)&, except that a terminating binary zero
6353 is not included in the key that is passed to the DBM library. You may need this
6354 if you want to look up data in files that are created by or shared with some
6355 other application that does not use terminating zeros. For example, you need to
6356 use &(dbmnz)& rather than &(dbm)& if you want to authenticate incoming SMTP
6357 calls using the passwords from Courier's &_/etc/userdbshadow.dat_& file. Exim's
6358 utility program for creating DBM files (&'exim_dbmbuild'&) includes the zeros
6359 by default, but has an option to omit them (see section &<<SECTdbmbuild>>&).
6360 .next
6361 .cindex "lookup" "dsearch"
6362 .cindex "dsearch lookup type"
6363 &(dsearch)&: The given file must be a directory; this is searched for an entry
6364 whose name is the key by calling the &[lstat()]& function. The key may not
6365 contain any forward slash characters. If &[lstat()]& succeeds, the result of
6366 the lookup is the name of the entry, which may be a file, directory,
6367 symbolic link, or any other kind of directory entry. An example of how this
6368 lookup can be used to support virtual domains is given in section
6369 &<<SECTvirtualdomains>>&.
6370 .next
6371 .cindex "lookup" "iplsearch"
6372 .cindex "iplsearch lookup type"
6373 &(iplsearch)&: The given file is a text file containing keys and data. A key is
6374 terminated by a colon or white space or the end of the line. The keys in the
6375 file must be IP addresses, or IP addresses with CIDR masks. Keys that involve
6376 IPv6 addresses must be enclosed in quotes to prevent the first internal colon
6377 being interpreted as a key terminator. For example:
6378 .code
6379 1.2.3.4:           data for 1.2.3.4
6380 192.168.0.0/16:    data for 192.168.0.0/16
6381 "abcd::cdab":      data for abcd::cdab
6382 "abcd:abcd::/32"   data for abcd:abcd::/32
6383 .endd
6384 The key for an &(iplsearch)& lookup must be an IP address (without a mask). The
6385 file is searched linearly, using the CIDR masks where present, until a matching
6386 key is found. The first key that matches is used; there is no attempt to find a
6387 &"best"& match. Apart from the way the keys are matched, the processing for
6388 &(iplsearch)& is the same as for &(lsearch)&.
6389
6390 &*Warning 1*&: Unlike most other single-key lookup types, a file of data for
6391 &(iplsearch)& can &'not'& be turned into a DBM or cdb file, because those
6392 lookup types support only literal keys.
6393
6394 &*Warning 2*&: In a host list, you must always use &(net-iplsearch)& so that
6395 the implicit key is the host's IP address rather than its name (see section
6396 &<<SECThoslispatsikey>>&).
6397 .next
6398 .cindex "linear search"
6399 .cindex "lookup" "lsearch"
6400 .cindex "lsearch lookup type"
6401 .cindex "case sensitivity" "in lsearch lookup"
6402 &(lsearch)&: The given file is a text file that is searched linearly for a
6403 line beginning with the search key, terminated by a colon or white space or the
6404 end of the line. The search is case-insensitive; that is, upper and lower case
6405 letters are treated as the same. The first occurrence of the key that is found
6406 in the file is used.
6407
6408 White space between the key and the colon is permitted. The remainder of the
6409 line, with leading and trailing white space removed, is the data. This can be
6410 continued onto subsequent lines by starting them with any amount of white
6411 space, but only a single space character is included in the data at such a
6412 junction. If the data begins with a colon, the key must be terminated by a
6413 colon, for example:
6414 .code
6415 baduser:  :fail:
6416 .endd
6417 Empty lines and lines beginning with # are ignored, even if they occur in the
6418 middle of an item. This is the traditional textual format of alias files. Note
6419 that the keys in an &(lsearch)& file are literal strings. There is no
6420 wildcarding of any kind.
6421
6422 .cindex "lookup" "lsearch &-- colons in keys"
6423 .cindex "white space" "in lsearch key"
6424 In most &(lsearch)& files, keys are not required to contain colons or #
6425 characters, or white space. However, if you need this feature, it is available.
6426 If a key begins with a doublequote character, it is terminated only by a
6427 matching quote (or end of line), and the normal escaping rules apply to its
6428 contents (see section &<<SECTstrings>>&). An optional colon is permitted after
6429 quoted keys (exactly as for unquoted keys). There is no special handling of
6430 quotes for the data part of an &(lsearch)& line.
6431
6432 .next
6433 .cindex "NIS lookup type"
6434 .cindex "lookup" "NIS"
6435 .cindex "binary zero" "in lookup key"
6436 &(nis)&: The given file is the name of a NIS map, and a NIS lookup is done with
6437 the given key, without a terminating binary zero. There is a variant called
6438 &(nis0)& which does include the terminating binary zero in the key. This is
6439 reportedly needed for Sun-style alias files. Exim does not recognize NIS
6440 aliases; the full map names must be used.
6441
6442 .next
6443 .cindex "wildlsearch lookup type"
6444 .cindex "lookup" "wildlsearch"
6445 .cindex "nwildlsearch lookup type"
6446 .cindex "lookup" "nwildlsearch"
6447 &(wildlsearch)& or &(nwildlsearch)&: These search a file linearly, like
6448 &(lsearch)&, but instead of being interpreted as a literal string, each key in
6449 the file may be wildcarded. The difference between these two lookup types is
6450 that for &(wildlsearch)&, each key in the file is string-expanded before being
6451 used, whereas for &(nwildlsearch)&, no expansion takes place.
6452
6453 .cindex "case sensitivity" "in (n)wildlsearch lookup"
6454 Like &(lsearch)&, the testing is done case-insensitively. However, keys in the
6455 file that are regular expressions can be made case-sensitive by the use of
6456 &`(-i)`& within the pattern. The following forms of wildcard are recognized:
6457
6458 . ==== As this is a nested list, any displays it contains must be indented
6459 . ==== as otherwise they are too far to the left.
6460
6461 .olist
6462 The string may begin with an asterisk to mean &"ends with"&. For example:
6463 .code
6464     *.a.b.c       data for anything.a.b.c
6465     *fish         data for anythingfish
6466 .endd
6467 .next
6468 The string may begin with a circumflex to indicate a regular expression. For
6469 example, for &(wildlsearch)&:
6470 .code
6471     ^\N\d+\.a\.b\N    data for <digits>.a.b
6472 .endd
6473 Note the use of &`\N`& to disable expansion of the contents of the regular
6474 expression. If you are using &(nwildlsearch)&, where the keys are not
6475 string-expanded, the equivalent entry is:
6476 .code
6477     ^\d+\.a\.b        data for <digits>.a.b
6478 .endd
6479 The case-insensitive flag is set at the start of compiling the regular
6480 expression, but it can be turned off by using &`(-i)`& at an appropriate point.
6481 For example, to make the entire pattern case-sensitive:
6482 .code
6483     ^(?-i)\d+\.a\.b        data for <digits>.a.b
6484 .endd
6485
6486 If the regular expression contains white space or colon characters, you must
6487 either quote it (see &(lsearch)& above), or represent these characters in other
6488 ways. For example, &`\s`& can be used for white space and &`\x3A`& for a
6489 colon. This may be easier than quoting, because if you quote, you have to
6490 escape all the backslashes inside the quotes.
6491
6492 &*Note*&: It is not possible to capture substrings in a regular expression
6493 match for later use, because the results of all lookups are cached. If a lookup
6494 is repeated, the result is taken from the cache, and no actual pattern matching
6495 takes place. The values of all the numeric variables are unset after a
6496 &((n)wildlsearch)& match.
6497
6498 .next
6499 Although I cannot see it being of much use, the general matching function that
6500 is used to implement &((n)wildlsearch)& means that the string may begin with a
6501 lookup name terminated by a semicolon, and followed by lookup data. For
6502 example:
6503 .code
6504     cdb;/some/file  data for keys that match the file
6505 .endd
6506 The data that is obtained from the nested lookup is discarded.
6507 .endlist olist
6508
6509 Keys that do not match any of these patterns are interpreted literally. The
6510 continuation rules for the data are the same as for &(lsearch)&, and keys may
6511 be followed by optional colons.
6512
6513 &*Warning*&: Unlike most other single-key lookup types, a file of data for
6514 &((n)wildlsearch)& can &'not'& be turned into a DBM or cdb file, because those
6515 lookup types support only literal keys.
6516 .endlist ilist
6517
6518
6519 .section "Query-style lookup types" "SECID62"
6520 .cindex "lookup" "query-style types"
6521 .cindex "query-style lookup" "list of types"
6522 The supported query-style lookup types are listed below. Further details about
6523 many of them are given in later sections.
6524
6525 .ilist
6526 .cindex "DNS" "as a lookup type"
6527 .cindex "lookup" "DNS"
6528 &(dnsdb)&: This does a DNS search for one or more records whose domain names
6529 are given in the supplied query. The resulting data is the contents of the
6530 records. See section &<<SECTdnsdb>>&.
6531 .next
6532 .cindex "InterBase lookup type"
6533 .cindex "lookup" "InterBase"
6534 &(ibase)&: This does a lookup in an InterBase database.
6535 .next
6536 .cindex "LDAP" "lookup type"
6537 .cindex "lookup" "LDAP"
6538 &(ldap)&: This does an LDAP lookup using a query in the form of a URL, and
6539 returns attributes from a single entry. There is a variant called &(ldapm)&
6540 that permits values from multiple entries to be returned. A third variant
6541 called &(ldapdn)& returns the Distinguished Name of a single entry instead of
6542 any attribute values. See section &<<SECTldap>>&.
6543 .next
6544 .cindex "MySQL" "lookup type"
6545 .cindex "lookup" "MySQL"
6546 &(mysql)&: The format of the query is an SQL statement that is passed to a
6547 MySQL database. See section &<<SECTsql>>&.
6548 .next
6549 .cindex "NIS+ lookup type"
6550 .cindex "lookup" "NIS+"
6551 &(nisplus)&: This does a NIS+ lookup using a query that can specify the name of
6552 the field to be returned. See section &<<SECTnisplus>>&.
6553 .next
6554 .cindex "Oracle" "lookup type"
6555 .cindex "lookup" "Oracle"
6556 &(oracle)&: The format of the query is an SQL statement that is passed to an
6557 Oracle database. See section &<<SECTsql>>&.
6558 .next
6559 .cindex "lookup" "passwd"
6560 .cindex "passwd lookup type"
6561 .cindex "&_/etc/passwd_&"
6562 &(passwd)& is a query-style lookup with queries that are just user names. The
6563 lookup calls &[getpwnam()]& to interrogate the system password data, and on
6564 success, the result string is the same as you would get from an &(lsearch)&
6565 lookup on a traditional &_/etc/passwd file_&, though with &`*`& for the
6566 password value. For example:
6567 .code
6568 *:42:42:King Rat:/home/kr:/bin/bash
6569 .endd
6570 .next
6571 .cindex "PostgreSQL lookup type"
6572 .cindex "lookup" "PostgreSQL"
6573 &(pgsql)&: The format of the query is an SQL statement that is passed to a
6574 PostgreSQL database. See section &<<SECTsql>>&.
6575
6576 .next
6577 .cindex "sqlite lookup type"
6578 .cindex "lookup" "sqlite"
6579 &(sqlite)&: The format of the query is a file name followed by an SQL statement
6580 that is passed to an SQLite database. See section &<<SECTsqlite>>&.
6581
6582 .next
6583 &(testdb)&: This is a lookup type that is used for testing Exim. It is
6584 not likely to be useful in normal operation.
6585 .next
6586 .cindex "whoson lookup type"
6587 .cindex "lookup" "whoson"
6588 &(whoson)&: &'Whoson'& (&url(http://whoson.sourceforge.net)) is a protocol that
6589 allows a server to check whether a particular (dynamically allocated) IP
6590 address is currently allocated to a known (trusted) user and, optionally, to
6591 obtain the identity of the said user. For SMTP servers, &'Whoson'& was popular
6592 at one time for &"POP before SMTP"& authentication, but that approach has been
6593 superseded by SMTP authentication. In Exim, &'Whoson'& can be used to implement
6594 &"POP before SMTP"& checking using ACL statements such as
6595 .code
6596 require condition = \
6597   ${lookup whoson {$sender_host_address}{yes}{no}}
6598 .endd
6599 The query consists of a single IP address. The value returned is the name of
6600 the authenticated user, which is stored in the variable &$value$&. However, in
6601 this example, the data in &$value$& is not used; the result of the lookup is
6602 one of the fixed strings &"yes"& or &"no"&.
6603 .endlist
6604
6605
6606
6607 .section "Temporary errors in lookups" "SECID63"
6608 .cindex "lookup" "temporary error in"
6609 Lookup functions can return temporary error codes if the lookup cannot be
6610 completed. For example, an SQL or LDAP database might be unavailable. For this
6611 reason, it is not advisable to use a lookup that might do this for critical
6612 options such as a list of local domains.
6613
6614 When a lookup cannot be completed in a router or transport, delivery
6615 of the message (to the relevant address) is deferred, as for any other
6616 temporary error. In other circumstances Exim may assume the lookup has failed,
6617 or may give up altogether.
6618
6619
6620
6621 .section "Default values in single-key lookups" "SECTdefaultvaluelookups"
6622 .cindex "wildcard lookups"
6623 .cindex "lookup" "default values"
6624 .cindex "lookup" "wildcard"
6625 .cindex "lookup" "* added to type"
6626 .cindex "default" "in single-key lookups"
6627 In this context, a &"default value"& is a value specified by the administrator
6628 that is to be used if a lookup fails.
6629
6630 &*Note:*& This section applies only to single-key lookups. For query-style
6631 lookups, the facilities of the query language must be used. An attempt to
6632 specify a default for a query-style lookup provokes an error.
6633
6634 If &"*"& is added to a single-key lookup type (for example, &%lsearch*%&)
6635 and the initial lookup fails, the key &"*"& is looked up in the file to
6636 provide a default value. See also the section on partial matching below.
6637
6638 .cindex "*@ with single-key lookup"
6639 .cindex "lookup" "*@ added to type"
6640 .cindex "alias file" "per-domain default"
6641 Alternatively, if &"*@"& is added to a single-key lookup type (for example
6642 &%dbm*@%&) then, if the initial lookup fails and the key contains an @
6643 character, a second lookup is done with everything before the last @ replaced
6644 by *. This makes it possible to provide per-domain defaults in alias files
6645 that include the domains in the keys. If the second lookup fails (or doesn't
6646 take place because there is no @ in the key), &"*"& is looked up.
6647 For example, a &(redirect)& router might contain:
6648 .code
6649 data = ${lookup{$local_part@$domain}lsearch*@{/etc/mix-aliases}}
6650 .endd
6651 Suppose the address that is being processed is &'jane@eyre.example'&. Exim
6652 looks up these keys, in this order:
6653 .code
6654 jane@eyre.example
6655 *@eyre.example
6656 *
6657 .endd
6658 The data is taken from whichever key it finds first. &*Note*&: In an
6659 &(lsearch)& file, this does not mean the first of these keys in the file. A
6660 complete scan is done for each key, and only if it is not found at all does
6661 Exim move on to try the next key.
6662
6663
6664
6665 .section "Partial matching in single-key lookups" "SECTpartiallookup"
6666 .cindex "partial matching"
6667 .cindex "wildcard lookups"
6668 .cindex "lookup" "partial matching"
6669 .cindex "lookup" "wildcard"
6670 .cindex "asterisk" "in search type"
6671 The normal operation of a single-key lookup is to search the file for an exact
6672 match with the given key. However, in a number of situations where domains are
6673 being looked up, it is useful to be able to do partial matching. In this case,
6674 information in the file that has a key starting with &"*."& is matched by any
6675 domain that ends with the components that follow the full stop. For example, if
6676 a key in a DBM file is
6677 .code
6678 *.dates.fict.example
6679 .endd
6680 then when partial matching is enabled this is matched by (amongst others)
6681 &'2001.dates.fict.example'& and &'1984.dates.fict.example'&. It is also matched
6682 by &'dates.fict.example'&, if that does not appear as a separate key in the
6683 file.
6684
6685 &*Note*&: Partial matching is not available for query-style lookups. It is
6686 also not available for any lookup items in address lists (see section
6687 &<<SECTaddresslist>>&).
6688
6689 Partial matching is implemented by doing a series of separate lookups using
6690 keys constructed by modifying the original subject key. This means that it can
6691 be used with any of the single-key lookup types, provided that
6692 partial matching keys
6693 beginning with a special prefix (default &"*."&) are included in the data file.
6694 Keys in the file that do not begin with the prefix are matched only by
6695 unmodified subject keys when partial matching is in use.
6696
6697 Partial matching is requested by adding the string &"partial-"& to the front of
6698 the name of a single-key lookup type, for example, &%partial-dbm%&. When this
6699 is done, the subject key is first looked up unmodified; if that fails, &"*."&
6700 is added at the start of the subject key, and it is looked up again. If that
6701 fails, further lookups are tried with dot-separated components removed from the
6702 start of the subject key, one-by-one, and &"*."& added on the front of what
6703 remains.
6704
6705 A minimum number of two non-* components are required. This can be adjusted
6706 by including a number before the hyphen in the search type. For example,
6707 &%partial3-lsearch%& specifies a minimum of three non-* components in the
6708 modified keys. Omitting the number is equivalent to &"partial2-"&. If the
6709 subject key is &'2250.dates.fict.example'& then the following keys are looked
6710 up when the minimum number of non-* components is two:
6711 .code
6712 2250.dates.fict.example
6713 *.2250.dates.fict.example
6714 *.dates.fict.example
6715 *.fict.example
6716 .endd
6717 As soon as one key in the sequence is successfully looked up, the lookup
6718 finishes.
6719
6720 .cindex "lookup" "partial matching &-- changing prefix"
6721 .cindex "prefix" "for partial matching"
6722 The use of &"*."& as the partial matching prefix is a default that can be
6723 changed. The motivation for this feature is to allow Exim to operate with file
6724 formats that are used by other MTAs. A different prefix can be supplied in
6725 parentheses instead of the hyphen after &"partial"&. For example:
6726 .code
6727 domains = partial(.)lsearch;/some/file
6728 .endd
6729 In this example, if the domain is &'a.b.c'&, the sequence of lookups is
6730 &`a.b.c`&, &`.a.b.c`&, and &`.b.c`& (the default minimum of 2 non-wild
6731 components is unchanged). The prefix may consist of any punctuation characters
6732 other than a closing parenthesis. It may be empty, for example:
6733 .code
6734 domains = partial1()cdb;/some/file
6735 .endd
6736 For this example, if the domain is &'a.b.c'&, the sequence of lookups is
6737 &`a.b.c`&, &`b.c`&, and &`c`&.
6738
6739 If &"partial0"& is specified, what happens at the end (when the lookup with
6740 just one non-wild component has failed, and the original key is shortened right
6741 down to the null string) depends on the prefix:
6742
6743 .ilist
6744 If the prefix has zero length, the whole lookup fails.
6745 .next
6746 If the prefix has length 1, a lookup for just the prefix is done. For
6747 example, the final lookup for &"partial0(.)"& is for &`.`& alone.
6748 .next
6749 Otherwise, if the prefix ends in a dot, the dot is removed, and the
6750 remainder is looked up. With the default prefix, therefore, the final lookup is
6751 for &"*"& on its own.
6752 .next
6753 Otherwise, the whole prefix is looked up.
6754 .endlist
6755
6756
6757 If the search type ends in &"*"& or &"*@"& (see section
6758 &<<SECTdefaultvaluelookups>>& above), the search for an ultimate default that
6759 this implies happens after all partial lookups have failed. If &"partial0"& is
6760 specified, adding &"*"& to the search type has no effect with the default
6761 prefix, because the &"*"& key is already included in the sequence of partial
6762 lookups. However, there might be a use for lookup types such as
6763 &"partial0(.)lsearch*"&.
6764
6765 The use of &"*"& in lookup partial matching differs from its use as a wildcard
6766 in domain lists and the like. Partial matching works only in terms of
6767 dot-separated components; a key such as &`*fict.example`&
6768 in a database file is useless, because the asterisk in a partial matching
6769 subject key is always followed by a dot.
6770
6771
6772
6773
6774 .section "Lookup caching" "SECID64"
6775 .cindex "lookup" "caching"
6776 .cindex "caching" "lookup data"
6777 Exim caches all lookup results in order to avoid needless repetition of
6778 lookups. However, because (apart from the daemon) Exim operates as a collection
6779 of independent, short-lived processes, this caching applies only within a
6780 single Exim process. There is no inter-process lookup caching facility.
6781
6782 For single-key lookups, Exim keeps the relevant files open in case there is
6783 another lookup that needs them. In some types of configuration this can lead to
6784 many files being kept open for messages with many recipients. To avoid hitting
6785 the operating system limit on the number of simultaneously open files, Exim
6786 closes the least recently used file when it needs to open more files than its
6787 own internal limit, which can be changed via the &%lookup_open_max%& option.
6788
6789 The single-key lookup files are closed and the lookup caches are flushed at
6790 strategic points during delivery &-- for example, after all routing is
6791 complete.
6792
6793
6794
6795
6796 .section "Quoting lookup data" "SECID65"
6797 .cindex "lookup" "quoting"
6798 .cindex "quoting" "in lookups"
6799 When data from an incoming message is included in a query-style lookup, there
6800 is the possibility of special characters in the data messing up the syntax of
6801 the query. For example, a NIS+ query that contains
6802 .code
6803 [name=$local_part]
6804 .endd
6805 will be broken if the local part happens to contain a closing square bracket.
6806 For NIS+, data can be enclosed in double quotes like this:
6807 .code
6808 [name="$local_part"]
6809 .endd
6810 but this still leaves the problem of a double quote in the data. The rule for
6811 NIS+ is that double quotes must be doubled. Other lookup types have different
6812 rules, and to cope with the differing requirements, an expansion operator
6813 of the following form is provided:
6814 .code
6815 ${quote_<lookup-type>:<string>}
6816 .endd
6817 For example, the safest way to write the NIS+ query is
6818 .code
6819 [name="${quote_nisplus:$local_part}"]
6820 .endd
6821 See chapter &<<CHAPexpand>>& for full coverage of string expansions. The quote
6822 operator can be used for all lookup types, but has no effect for single-key
6823 lookups, since no quoting is ever needed in their key strings.
6824
6825
6826
6827
6828 .section "More about dnsdb" "SECTdnsdb"
6829 .cindex "dnsdb lookup"
6830 .cindex "lookup" "dnsdb"
6831 .cindex "DNS" "as a lookup type"
6832 The &(dnsdb)& lookup type uses the DNS as its database. A simple query consists
6833 of a record type and a domain name, separated by an equals sign. For example,
6834 an expansion string could contain:
6835 .code
6836 ${lookup dnsdb{mx=a.b.example}{$value}fail}
6837 .endd
6838 If the lookup succeeds, the result is placed in &$value$&, which in this case
6839 is used on its own as the result. If the lookup does not succeed, the
6840 &`fail`& keyword causes a &'forced expansion failure'& &-- see section
6841 &<<SECTforexpfai>>& for an explanation of what this means.
6842
6843 The supported DNS record types are A, CNAME, MX, NS, PTR, SPF, SRV, and TXT,
6844 and, when Exim is compiled with IPv6 support, AAAA (and A6 if that is also
6845 configured). If no type is given, TXT is assumed. When the type is PTR,
6846 the data can be an IP address, written as normal; inversion and the addition of
6847 &%in-addr.arpa%& or &%ip6.arpa%& happens automatically. For example:
6848 .code
6849 ${lookup dnsdb{ptr=192.168.4.5}{$value}fail}
6850 .endd
6851 If the data for a PTR record is not a syntactically valid IP address, it is not
6852 altered and nothing is added.
6853
6854 .cindex "MX record" "in &(dnsdb)& lookup"
6855 .cindex "SRV record" "in &(dnsdb)& lookup"
6856 For an MX lookup, both the preference value and the host name are returned for
6857 each record, separated by a space. For an SRV lookup, the priority, weight,
6858 port, and host name are returned for each record, separated by spaces.
6859
6860 For any record type, if multiple records are found (or, for A6 lookups, if a
6861 single record leads to multiple addresses), the data is returned as a
6862 concatenation, with newline as the default separator. The order, of course,
6863 depends on the DNS resolver. You can specify a different separator character
6864 between multiple records by putting a right angle-bracket followed immediately
6865 by the new separator at the start of the query. For example:
6866 .code
6867 ${lookup dnsdb{>: a=host1.example}}
6868 .endd
6869 It is permitted to specify a space as the separator character. Further
6870 white space is ignored.
6871
6872 .cindex "TXT record" "in &(dnsdb)& lookup"
6873 .cindex "SPF record" "in &(dnsdb)& lookup"
6874 For TXT records with multiple items of data, only the first item is returned,
6875 unless a separator for them is specified using a comma after the separator
6876 character followed immediately by the TXT record item separator. To concatenate
6877 items without a separator, use a semicolon instead. For SPF records the
6878 default behaviour is to concatenate multiple items without using a separator.
6879 .code
6880 ${lookup dnsdb{>\n,: txt=a.b.example}}
6881 ${lookup dnsdb{>\n; txt=a.b.example}}
6882 ${lookup dnsdb{spf=example.org}}
6883 .endd
6884 It is permitted to specify a space as the separator character. Further
6885 white space is ignored.
6886
6887 .section "Pseudo dnsdb record types" "SECID66"
6888 .cindex "MX record" "in &(dnsdb)& lookup"
6889 By default, both the preference value and the host name are returned for
6890 each MX record, separated by a space. If you want only host names, you can use
6891 the pseudo-type MXH:
6892 .code
6893 ${lookup dnsdb{mxh=a.b.example}}
6894 .endd
6895 In this case, the preference values are omitted, and just the host names are
6896 returned.
6897
6898 .cindex "name server for enclosing domain"
6899 Another pseudo-type is ZNS (for &"zone NS"&). It performs a lookup for NS
6900 records on the given domain, but if none are found, it removes the first
6901 component of the domain name, and tries again. This process continues until NS
6902 records are found or there are no more components left (or there is a DNS
6903 error). In other words, it may return the name servers for a top-level domain,
6904 but it never returns the root name servers. If there are no NS records for the
6905 top-level domain, the lookup fails. Consider these examples:
6906 .code
6907 ${lookup dnsdb{zns=xxx.quercite.com}}
6908 ${lookup dnsdb{zns=xxx.edu}}
6909 .endd
6910 Assuming that in each case there are no NS records for the full domain name,
6911 the first returns the name servers for &%quercite.com%&, and the second returns
6912 the name servers for &%edu%&.
6913
6914 You should be careful about how you use this lookup because, unless the
6915 top-level domain does not exist, the lookup always returns some host names. The
6916 sort of use to which this might be put is for seeing if the name servers for a
6917 given domain are on a blacklist. You can probably assume that the name servers
6918 for the high-level domains such as &%com%& or &%co.uk%& are not going to be on
6919 such a list.
6920
6921 .cindex "CSA" "in &(dnsdb)& lookup"
6922 A third pseudo-type is CSA (Client SMTP Authorization). This looks up SRV
6923 records according to the CSA rules, which are described in section
6924 &<<SECTverifyCSA>>&. Although &(dnsdb)& supports SRV lookups directly, this is
6925 not sufficient because of the extra parent domain search behaviour of CSA. The
6926 result of a successful lookup such as:
6927 .code
6928 ${lookup dnsdb {csa=$sender_helo_name}}
6929 .endd
6930 has two space-separated fields: an authorization code and a target host name.
6931 The authorization code can be &"Y"& for yes, &"N"& for no, &"X"& for explicit
6932 authorization required but absent, or &"?"& for unknown.
6933
6934 .cindex "A+" "in &(dnsdb)& lookup"
6935 The pseudo-type A+ performs an A6 lookup (if configured) followed by an AAAA
6936 and then an A lookup.  All results are returned; defer processing
6937 (see below) is handled separately for each lookup.  Example:
6938 .code
6939 ${lookup dnsdb {>; a+=$sender_helo_name}}
6940 .endd
6941
6942
6943 .section "Multiple dnsdb lookups" "SECID67"
6944 In the previous sections, &(dnsdb)& lookups for a single domain are described.
6945 However, you can specify a list of domains or IP addresses in a single
6946 &(dnsdb)& lookup. The list is specified in the normal Exim way, with colon as
6947 the default separator, but with the ability to change this. For example:
6948 .code
6949 ${lookup dnsdb{one.domain.com:two.domain.com}}
6950 ${lookup dnsdb{a=one.host.com:two.host.com}}
6951 ${lookup dnsdb{ptr = <; 1.2.3.4 ; 4.5.6.8}}
6952 .endd
6953 In order to retain backwards compatibility, there is one special case: if
6954 the lookup type is PTR and no change of separator is specified, Exim looks
6955 to see if the rest of the string is precisely one IPv6 address. In this
6956 case, it does not treat it as a list.
6957
6958 The data from each lookup is concatenated, with newline separators by default,
6959 in the same way that multiple DNS records for a single item are handled. A
6960 different separator can be specified, as described above.
6961
6962 The &(dnsdb)& lookup fails only if all the DNS lookups fail. If there is a
6963 temporary DNS error for any of them, the behaviour is controlled by
6964 an optional keyword followed by a comma that may appear before the record
6965 type. The possible keywords are &"defer_strict"&, &"defer_never"&, and
6966 &"defer_lax"&. With &"strict"& behaviour, any temporary DNS error causes the
6967 whole lookup to defer. With &"never"& behaviour, a temporary DNS error is
6968 ignored, and the behaviour is as if the DNS lookup failed to find anything.
6969 With &"lax"& behaviour, all the queries are attempted, but a temporary DNS
6970 error causes the whole lookup to defer only if none of the other lookups
6971 succeed. The default is &"lax"&, so the following lookups are equivalent:
6972 .code
6973 ${lookup dnsdb{defer_lax,a=one.host.com:two.host.com}}
6974 ${lookup dnsdb{a=one.host.com:two.host.com}}
6975 .endd
6976 Thus, in the default case, as long as at least one of the DNS lookups
6977 yields some data, the lookup succeeds.
6978
6979
6980
6981
6982 .section "More about LDAP" "SECTldap"
6983 .cindex "LDAP" "lookup, more about"
6984 .cindex "lookup" "LDAP"
6985 .cindex "Solaris" "LDAP"
6986 The original LDAP implementation came from the University of Michigan; this has
6987 become &"Open LDAP"&, and there are now two different releases. Another
6988 implementation comes from Netscape, and Solaris 7 and subsequent releases
6989 contain inbuilt LDAP support. Unfortunately, though these are all compatible at
6990 the lookup function level, their error handling is different. For this reason
6991 it is necessary to set a compile-time variable when building Exim with LDAP, to
6992 indicate which LDAP library is in use. One of the following should appear in
6993 your &_Local/Makefile_&:
6994 .code
6995 LDAP_LIB_TYPE=UMICHIGAN
6996 LDAP_LIB_TYPE=OPENLDAP1
6997 LDAP_LIB_TYPE=OPENLDAP2
6998 LDAP_LIB_TYPE=NETSCAPE
6999 LDAP_LIB_TYPE=SOLARIS
7000 .endd
7001 If LDAP_LIB_TYPE is not set, Exim assumes &`OPENLDAP1`&, which has the
7002 same interface as the University of Michigan version.
7003
7004 There are three LDAP lookup types in Exim. These behave slightly differently in
7005 the way they handle the results of a query:
7006
7007 .ilist
7008 &(ldap)& requires the result to contain just one entry; if there are more, it
7009 gives an error.
7010 .next
7011 &(ldapdn)& also requires the result to contain just one entry, but it is the
7012 Distinguished Name that is returned rather than any attribute values.
7013 .next
7014 &(ldapm)& permits the result to contain more than one entry; the attributes
7015 from all of them are returned.
7016 .endlist
7017
7018
7019 For &(ldap)& and &(ldapm)&, if a query finds only entries with no attributes,
7020 Exim behaves as if the entry did not exist, and the lookup fails. The format of
7021 the data returned by a successful lookup is described in the next section.
7022 First we explain how LDAP queries are coded.
7023
7024
7025 .section "Format of LDAP queries" "SECTforldaque"
7026 .cindex "LDAP" "query format"
7027 An LDAP query takes the form of a URL as defined in RFC 2255. For example, in
7028 the configuration of a &(redirect)& router one might have this setting:
7029 .code
7030 data = ${lookup ldap \
7031   {ldap:///cn=$local_part,o=University%20of%20Cambridge,\
7032   c=UK?mailbox?base?}}
7033 .endd
7034 .cindex "LDAP" "with TLS"
7035 The URL may begin with &`ldap`& or &`ldaps`& if your LDAP library supports
7036 secure (encrypted) LDAP connections. The second of these ensures that an
7037 encrypted TLS connection is used.
7038
7039 With sufficiently modern LDAP libraries, Exim supports forcing TLS over regular
7040 LDAP connections, rather than the SSL-on-connect &`ldaps`&.
7041 See the &%ldap_start_tls%& option.
7042
7043 .new
7044 Starting with Exim 4.83, the initialization of LDAP with TLS is more tightly
7045 controlled. Every part of the TLS configuration can be configured by settings in
7046 &_exim.conf_&. Depending on the version of the client libraries installed on
7047 your system, some of the initialization may have required setting options in
7048 &_/etc/ldap.conf_& or &_~/.ldaprc_& to get TLS working with self-signed
7049 certificates. This revealed a nuance where the current UID that exim was
7050 running as could affect which config files it read. With Exim 4.83, these
7051 methods become optional, only taking effect if not specifically set in
7052 &_exim.conf_&.
7053 .wen
7054
7055
7056 .section "LDAP quoting" "SECID68"
7057 .cindex "LDAP" "quoting"
7058 Two levels of quoting are required in LDAP queries, the first for LDAP itself
7059 and the second because the LDAP query is represented as a URL. Furthermore,
7060 within an LDAP query, two different kinds of quoting are required. For this
7061 reason, there are two different LDAP-specific quoting operators.
7062
7063 The &%quote_ldap%& operator is designed for use on strings that are part of
7064 filter specifications. Conceptually, it first does the following conversions on
7065 the string:
7066 .code
7067 *   =>   \2A
7068 (   =>   \28
7069 )   =>   \29
7070 \   =>   \5C
7071 .endd
7072 in accordance with RFC 2254. The resulting string is then quoted according
7073 to the rules for URLs, that is, all non-alphanumeric characters except
7074 .code
7075 ! $ ' - . _ ( ) * +
7076 .endd
7077 are converted to their hex values, preceded by a percent sign. For example:
7078 .code
7079 ${quote_ldap: a(bc)*, a<yz>; }
7080 .endd
7081 yields
7082 .code
7083 %20a%5C28bc%5C29%5C2A%2C%20a%3Cyz%3E%3B%20
7084 .endd
7085 Removing the URL quoting, this is (with a leading and a trailing space):
7086 .code
7087 a\28bc\29\2A, a<yz>;
7088 .endd
7089 The &%quote_ldap_dn%& operator is designed for use on strings that are part of
7090 base DN specifications in queries. Conceptually, it first converts the string
7091 by inserting a backslash in front of any of the following characters:
7092 .code
7093 , + " \ < > ;
7094 .endd
7095 It also inserts a backslash before any leading spaces or # characters, and
7096 before any trailing spaces. (These rules are in RFC 2253.) The resulting string
7097 is then quoted according to the rules for URLs. For example:
7098 .code
7099 ${quote_ldap_dn: a(bc)*, a<yz>; }
7100 .endd
7101 yields
7102 .code
7103 %5C%20a(bc)*%5C%2C%20a%5C%3Cyz%5C%3E%5C%3B%5C%20
7104 .endd
7105 Removing the URL quoting, this is (with a trailing space):
7106 .code
7107 \ a(bc)*\, a\<yz\>\;\
7108 .endd
7109 There are some further comments about quoting in the section on LDAP
7110 authentication below.
7111
7112
7113 .section "LDAP connections" "SECID69"
7114 .cindex "LDAP" "connections"
7115 The connection to an LDAP server may either be over TCP/IP, or, when OpenLDAP
7116 is in use, via a Unix domain socket. The example given above does not specify
7117 an LDAP server. A server that is reached by TCP/IP can be specified in a query
7118 by starting it with
7119 .code
7120 ldap://<hostname>:<port>/...
7121 .endd
7122 If the port (and preceding colon) are omitted, the standard LDAP port (389) is
7123 used. When no server is specified in a query, a list of default servers is
7124 taken from the &%ldap_default_servers%& configuration option. This supplies a
7125 colon-separated list of servers which are tried in turn until one successfully
7126 handles a query, or there is a serious error. Successful handling either
7127 returns the requested data, or indicates that it does not exist. Serious errors
7128 are syntactical, or multiple values when only a single value is expected.
7129 Errors which cause the next server to be tried are connection failures, bind
7130 failures, and timeouts.
7131
7132 For each server name in the list, a port number can be given. The standard way
7133 of specifying a host and port is to use a colon separator (RFC 1738). Because
7134 &%ldap_default_servers%& is a colon-separated list, such colons have to be
7135 doubled. For example
7136 .code
7137 ldap_default_servers = ldap1.example.com::145:ldap2.example.com
7138 .endd
7139 If &%ldap_default_servers%& is unset, a URL with no server name is passed
7140 to the LDAP library with no server name, and the library's default (normally
7141 the local host) is used.
7142
7143 If you are using the OpenLDAP library, you can connect to an LDAP server using
7144 a Unix domain socket instead of a TCP/IP connection. This is specified by using
7145 &`ldapi`& instead of &`ldap`& in LDAP queries. What follows here applies only
7146 to OpenLDAP. If Exim is compiled with a different LDAP library, this feature is
7147 not available.
7148
7149 For this type of connection, instead of a host name for the server, a pathname
7150 for the socket is required, and the port number is not relevant. The pathname
7151 can be specified either as an item in &%ldap_default_servers%&, or inline in
7152 the query. In the former case, you can have settings such as
7153 .code
7154 ldap_default_servers = /tmp/ldap.sock : backup.ldap.your.domain
7155 .endd
7156 When the pathname is given in the query, you have to escape the slashes as
7157 &`%2F`& to fit in with the LDAP URL syntax. For example:
7158 .code
7159 ${lookup ldap {ldapi://%2Ftmp%2Fldap.sock/o=...
7160 .endd
7161 When Exim processes an LDAP lookup and finds that the &"hostname"& is really
7162 a pathname, it uses the Unix domain socket code, even if the query actually
7163 specifies &`ldap`& or &`ldaps`&. In particular, no encryption is used for a
7164 socket connection. This behaviour means that you can use a setting of
7165 &%ldap_default_servers%& such as in the example above with traditional &`ldap`&
7166 or &`ldaps`& queries, and it will work. First, Exim tries a connection via
7167 the Unix domain socket; if that fails, it tries a TCP/IP connection to the
7168 backup host.
7169
7170 If an explicit &`ldapi`& type is given in a query when a host name is
7171 specified, an error is diagnosed. However, if there are more items in
7172 &%ldap_default_servers%&, they are tried. In other words:
7173
7174 .ilist
7175 Using a pathname with &`ldap`& or &`ldaps`& forces the use of the Unix domain
7176 interface.
7177 .next
7178 Using &`ldapi`& with a host name causes an error.
7179 .endlist
7180
7181
7182 Using &`ldapi`& with no host or path in the query, and no setting of
7183 &%ldap_default_servers%&, does whatever the library does by default.
7184
7185
7186
7187 .section "LDAP authentication and control information" "SECID70"
7188 .cindex "LDAP" "authentication"
7189 The LDAP URL syntax provides no way of passing authentication and other control
7190 information to the server. To make this possible, the URL in an LDAP query may
7191 be preceded by any number of <&'name'&>=<&'value'&> settings, separated by
7192 spaces. If a value contains spaces it must be enclosed in double quotes, and
7193 when double quotes are used, backslash is interpreted in the usual way inside
7194 them. The following names are recognized:
7195 .display
7196 &`DEREFERENCE`&  set the dereferencing parameter
7197 &`NETTIME    `&  set a timeout for a network operation
7198 &`USER       `&  set the DN, for authenticating the LDAP bind
7199 &`PASS       `&  set the password, likewise
7200 &`REFERRALS  `&  set the referrals parameter
7201 &`SIZE       `&  set the limit for the number of entries returned
7202 &`TIME       `&  set the maximum waiting time for a query
7203 .endd
7204 The value of the DEREFERENCE parameter must be one of the words &"never"&,
7205 &"searching"&, &"finding"&, or &"always"&. The value of the REFERRALS parameter
7206 must be &"follow"& (the default) or &"nofollow"&. The latter stops the LDAP
7207 library from trying to follow referrals issued by the LDAP server.
7208
7209 The name CONNECT is an obsolete name for NETTIME, retained for
7210 backwards compatibility. This timeout (specified as a number of seconds) is
7211 enforced from the client end for operations that can be carried out over a
7212 network. Specifically, it applies to network connections and calls to the
7213 &'ldap_result()'& function. If the value is greater than zero, it is used if
7214 LDAP_OPT_NETWORK_TIMEOUT is defined in the LDAP headers (OpenLDAP), or
7215 if LDAP_X_OPT_CONNECT_TIMEOUT is defined in the LDAP headers (Netscape
7216 SDK 4.1). A value of zero forces an explicit setting of &"no timeout"& for
7217 Netscape SDK; for OpenLDAP no action is taken.
7218
7219 The TIME parameter (also a number of seconds) is passed to the server to
7220 set a server-side limit on the time taken to complete a search.
7221
7222
7223 Here is an example of an LDAP query in an Exim lookup that uses some of these
7224 values. This is a single line, folded to fit on the page:
7225 .code
7226 ${lookup ldap
7227   {user="cn=manager,o=University of Cambridge,c=UK" pass=secret
7228   ldap:///o=University%20of%20Cambridge,c=UK?sn?sub?(cn=foo)}
7229   {$value}fail}
7230 .endd
7231 The encoding of spaces as &`%20`& is a URL thing which should not be done for
7232 any of the auxiliary data. Exim configuration settings that include lookups
7233 which contain password information should be preceded by &"hide"& to prevent
7234 non-admin users from using the &%-bP%& option to see their values.
7235
7236 The auxiliary data items may be given in any order. The default is no
7237 connection timeout (the system timeout is used), no user or password, no limit
7238 on the number of entries returned, and no time limit on queries.
7239
7240 When a DN is quoted in the USER= setting for LDAP authentication, Exim
7241 removes any URL quoting that it may contain before passing it LDAP. Apparently
7242 some libraries do this for themselves, but some do not. Removing the URL
7243 quoting has two advantages:
7244
7245 .ilist
7246 It makes it possible to use the same &%quote_ldap_dn%& expansion for USER=
7247 DNs as with DNs inside actual queries.
7248 .next
7249 It permits spaces inside USER= DNs.
7250 .endlist
7251
7252 For example, a setting such as
7253 .code
7254 USER=cn=${quote_ldap_dn:$1}
7255 .endd
7256 should work even if &$1$& contains spaces.
7257
7258 Expanded data for the PASS= value should be quoted using the &%quote%&
7259 expansion operator, rather than the LDAP quote operators. The only reason this
7260 field needs quoting is to ensure that it conforms to the Exim syntax, which
7261 does not allow unquoted spaces. For example:
7262 .code
7263 PASS=${quote:$3}
7264 .endd
7265 The LDAP authentication mechanism can be used to check passwords as part of
7266 SMTP authentication. See the &%ldapauth%& expansion string condition in chapter
7267 &<<CHAPexpand>>&.
7268
7269
7270
7271 .section "Format of data returned by LDAP" "SECID71"
7272 .cindex "LDAP" "returned data formats"
7273 The &(ldapdn)& lookup type returns the Distinguished Name from a single entry
7274 as a sequence of values, for example
7275 .code
7276 cn=manager, o=University of Cambridge, c=UK
7277 .endd
7278 The &(ldap)& lookup type generates an error if more than one entry matches the
7279 search filter, whereas &(ldapm)& permits this case, and inserts a newline in
7280 the result between the data from different entries. It is possible for multiple
7281 values to be returned for both &(ldap)& and &(ldapm)&, but in the former case
7282 you know that whatever values are returned all came from a single entry in the
7283 directory.
7284
7285 In the common case where you specify a single attribute in your LDAP query, the
7286 result is not quoted, and does not contain the attribute name. If the attribute
7287 has multiple values, they are separated by commas.
7288
7289 If you specify multiple attributes, the result contains space-separated, quoted
7290 strings, each preceded by the attribute name and an equals sign. Within the
7291 quotes, the quote character, backslash, and newline are escaped with
7292 backslashes, and commas are used to separate multiple values for the attribute.
7293 Apart from the escaping, the string within quotes takes the same form as the
7294 output when a single attribute is requested. Specifying no attributes is the
7295 same as specifying all of an entry's attributes.
7296
7297 Here are some examples of the output format. The first line of each pair is an
7298 LDAP query, and the second is the data that is returned. The attribute called
7299 &%attr1%& has two values, whereas &%attr2%& has only one value:
7300 .code
7301 ldap:///o=base?attr1?sub?(uid=fred)
7302 value1.1, value1.2
7303
7304 ldap:///o=base?attr2?sub?(uid=fred)
7305 value two
7306
7307 ldap:///o=base?attr1,attr2?sub?(uid=fred)
7308 attr1="value1.1, value1.2" attr2="value two"
7309
7310 ldap:///o=base??sub?(uid=fred)
7311 objectClass="top" attr1="value1.1, value1.2" attr2="value two"
7312 .endd
7313 The &%extract%& operator in string expansions can be used to pick out
7314 individual fields from data that consists of &'key'&=&'value'& pairs. You can
7315 make use of Exim's &%-be%& option to run expansion tests and thereby check the
7316 results of LDAP lookups.
7317
7318
7319
7320
7321 .section "More about NIS+" "SECTnisplus"
7322 .cindex "NIS+ lookup type"
7323 .cindex "lookup" "NIS+"
7324 NIS+ queries consist of a NIS+ &'indexed name'& followed by an optional colon
7325 and field name. If this is given, the result of a successful query is the
7326 contents of the named field; otherwise the result consists of a concatenation
7327 of &'field-name=field-value'& pairs, separated by spaces. Empty values and
7328 values containing spaces are quoted. For example, the query
7329 .code
7330 [name=mg1456],passwd.org_dir
7331 .endd
7332 might return the string
7333 .code
7334 name=mg1456 passwd="" uid=999 gid=999 gcos="Martin Guerre"
7335 home=/home/mg1456 shell=/bin/bash shadow=""
7336 .endd
7337 (split over two lines here to fit on the page), whereas
7338 .code
7339 [name=mg1456],passwd.org_dir:gcos
7340 .endd
7341 would just return
7342 .code
7343 Martin Guerre
7344 .endd
7345 with no quotes. A NIS+ lookup fails if NIS+ returns more than one table entry
7346 for the given indexed key. The effect of the &%quote_nisplus%& expansion
7347 operator is to double any quote characters within the text.
7348
7349
7350
7351 .section "SQL lookups" "SECTsql"
7352 .cindex "SQL lookup types"
7353 .cindex "MySQL" "lookup type"
7354 .cindex "PostgreSQL lookup type"
7355 .cindex "lookup" "MySQL"
7356 .cindex "lookup" "PostgreSQL"
7357 .cindex "Oracle" "lookup type"
7358 .cindex "lookup" "Oracle"
7359 .cindex "InterBase lookup type"
7360 .cindex "lookup" "InterBase"
7361 Exim can support lookups in InterBase, MySQL, Oracle, PostgreSQL, and SQLite
7362 databases. Queries for these databases contain SQL statements, so an example
7363 might be
7364 .code
7365 ${lookup mysql{select mailbox from users where id='userx'}\
7366   {$value}fail}
7367 .endd
7368 If the result of the query contains more than one field, the data for each
7369 field in the row is returned, preceded by its name, so the result of
7370 .code
7371 ${lookup pgsql{select home,name from users where id='userx'}\
7372   {$value}}
7373 .endd
7374 might be
7375 .code
7376 home=/home/userx name="Mister X"
7377 .endd
7378 Empty values and values containing spaces are double quoted, with embedded
7379 quotes escaped by a backslash. If the result of the query contains just one
7380 field, the value is passed back verbatim, without a field name, for example:
7381 .code
7382 Mister X
7383 .endd
7384 If the result of the query yields more than one row, it is all concatenated,
7385 with a newline between the data for each row.
7386
7387
7388 .section "More about MySQL, PostgreSQL, Oracle, and InterBase" "SECID72"
7389 .cindex "MySQL" "lookup type"
7390 .cindex "PostgreSQL lookup type"
7391 .cindex "lookup" "MySQL"
7392 .cindex "lookup" "PostgreSQL"
7393 .cindex "Oracle" "lookup type"
7394 .cindex "lookup" "Oracle"
7395 .cindex "InterBase lookup type"
7396 .cindex "lookup" "InterBase"
7397 If any MySQL, PostgreSQL, Oracle, or InterBase lookups are used, the
7398 &%mysql_servers%&, &%pgsql_servers%&, &%oracle_servers%&, or &%ibase_servers%&
7399 option (as appropriate) must be set to a colon-separated list of server
7400 information.
7401 (For MySQL and PostgreSQL only, the global option need not be set if all
7402 queries contain their own server information &-- see section
7403 &<<SECTspeserque>>&.) Each item in the list is a slash-separated list of four
7404 items: host name, database name, user name, and password. In the case of
7405 Oracle, the host name field is used for the &"service name"&, and the database
7406 name field is not used and should be empty. For example:
7407 .code
7408 hide oracle_servers = oracle.plc.example//userx/abcdwxyz
7409 .endd
7410 Because password data is sensitive, you should always precede the setting with
7411 &"hide"&, to prevent non-admin users from obtaining the setting via the &%-bP%&
7412 option. Here is an example where two MySQL servers are listed:
7413 .code
7414 hide mysql_servers = localhost/users/root/secret:\
7415                      otherhost/users/root/othersecret
7416 .endd
7417 For MySQL and PostgreSQL, a host may be specified as <&'name'&>:<&'port'&> but
7418 because this is a colon-separated list, the colon has to be doubled. For each
7419 query, these parameter groups are tried in order until a connection is made and
7420 a query is successfully processed. The result of a query may be that no data is
7421 found, but that is still a successful query. In other words, the list of
7422 servers provides a backup facility, not a list of different places to look.
7423
7424 The &%quote_mysql%&, &%quote_pgsql%&, and &%quote_oracle%& expansion operators
7425 convert newline, tab, carriage return, and backspace to \n, \t, \r, and \b
7426 respectively, and the characters single-quote, double-quote, and backslash
7427 itself are escaped with backslashes. The &%quote_pgsql%& expansion operator, in
7428 addition, escapes the percent and underscore characters. This cannot be done
7429 for MySQL because these escapes are not recognized in contexts where these
7430 characters are not special.
7431
7432 .section "Specifying the server in the query" "SECTspeserque"
7433 For MySQL and PostgreSQL lookups (but not currently for Oracle and InterBase),
7434 it is possible to specify a list of servers with an individual query. This is
7435 done by starting the query with
7436 .display
7437 &`servers=`&&'server1:server2:server3:...'&&`;`&
7438 .endd
7439 Each item in the list may take one of two forms:
7440 .olist
7441 If it contains no slashes it is assumed to be just a host name. The appropriate
7442 global option (&%mysql_servers%& or &%pgsql_servers%&) is searched for a host
7443 of the same name, and the remaining parameters (database, user, password) are
7444 taken from there.
7445 .next
7446 If it contains any slashes, it is taken as a complete parameter set.
7447 .endlist
7448 The list of servers is used in exactly the same way as the global list.
7449 Once a connection to a server has happened and a query has been
7450 successfully executed, processing of the lookup ceases.
7451
7452 This feature is intended for use in master/slave situations where updates
7453 are occurring and you want to update the master rather than a slave. If the
7454 master is in the list as a backup for reading, you might have a global setting
7455 like this:
7456 .code
7457 mysql_servers = slave1/db/name/pw:\
7458                 slave2/db/name/pw:\
7459                 master/db/name/pw
7460 .endd
7461 In an updating lookup, you could then write:
7462 .code
7463 ${lookup mysql{servers=master; UPDATE ...} }
7464 .endd
7465 That query would then be sent only to the master server. If, on the other hand,
7466 the master is not to be used for reading, and so is not present in the global
7467 option, you can still update it by a query of this form:
7468 .code
7469 ${lookup pgsql{servers=master/db/name/pw; UPDATE ...} }
7470 .endd
7471
7472
7473 .section "Special MySQL features" "SECID73"
7474 For MySQL, an empty host name or the use of &"localhost"& in &%mysql_servers%&
7475 causes a connection to the server on the local host by means of a Unix domain
7476 socket. An alternate socket can be specified in parentheses. The full syntax of
7477 each item in &%mysql_servers%& is:
7478 .display
7479 <&'hostname'&>::<&'port'&>(<&'socket name'&>)/<&'database'&>/&&&
7480   <&'user'&>/<&'password'&>
7481 .endd
7482 Any of the three sub-parts of the first field can be omitted. For normal use on
7483 the local host it can be left blank or set to just &"localhost"&.
7484
7485 No database need be supplied &-- but if it is absent here, it must be given in
7486 the queries.
7487
7488 If a MySQL query is issued that does not request any data (an insert, update,
7489 or delete command), the result of the lookup is the number of rows affected.
7490
7491 &*Warning*&: This can be misleading. If an update does not actually change
7492 anything (for example, setting a field to the value it already has), the result
7493 is zero because no rows are affected.
7494
7495
7496 .section "Special PostgreSQL features" "SECID74"
7497 PostgreSQL lookups can also use Unix domain socket connections to the database.
7498 This is usually faster and costs less CPU time than a TCP/IP connection.
7499 However it can be used only if the mail server runs on the same machine as the
7500 database server. A configuration line for PostgreSQL via Unix domain sockets
7501 looks like this:
7502 .code
7503 hide pgsql_servers = (/tmp/.s.PGSQL.5432)/db/user/password : ...
7504 .endd
7505 In other words, instead of supplying a host name, a path to the socket is
7506 given. The path name is enclosed in parentheses so that its slashes aren't
7507 visually confused with the delimiters for the other server parameters.
7508
7509 If a PostgreSQL query is issued that does not request any data (an insert,
7510 update, or delete command), the result of the lookup is the number of rows
7511 affected.
7512
7513 .section "More about SQLite" "SECTsqlite"
7514 .cindex "lookup" "SQLite"
7515 .cindex "sqlite lookup type"
7516 SQLite is different to the other SQL lookups because a file name is required in
7517 addition to the SQL query. An SQLite database is a single file, and there is no
7518 daemon as in the other SQL databases. The interface to Exim requires the name
7519 of the file, as an absolute path, to be given at the start of the query. It is
7520 separated from the query by white space. This means that the path name cannot
7521 contain white space. Here is a lookup expansion example:
7522 .code
7523 ${lookup sqlite {/some/thing/sqlitedb \
7524   select name from aliases where id='userx';}}
7525 .endd
7526 In a list, the syntax is similar. For example:
7527 .code
7528 domainlist relay_to_domains = sqlite;/some/thing/sqlitedb \
7529    select * from relays where ip='$sender_host_address';
7530 .endd
7531 The only character affected by the &%quote_sqlite%& operator is a single
7532 quote, which it doubles.
7533
7534 The SQLite library handles multiple simultaneous accesses to the database
7535 internally. Multiple readers are permitted, but only one process can
7536 update at once. Attempts to access the database while it is being updated
7537 are rejected after a timeout period, during which the SQLite library
7538 waits for the lock to be released. In Exim, the default timeout is set
7539 to 5 seconds, but it can be changed by means of the &%sqlite_lock_timeout%&
7540 option.
7541 .ecindex IIDfidalo1
7542 .ecindex IIDfidalo2
7543
7544
7545 . ////////////////////////////////////////////////////////////////////////////
7546 . ////////////////////////////////////////////////////////////////////////////
7547
7548 .chapter "Domain, host, address, and local part lists" &&&
7549          "CHAPdomhosaddlists" &&&
7550          "Domain, host, and address lists"
7551 .scindex IIDdohoadli "lists of domains; hosts; etc."
7552 A number of Exim configuration options contain lists of domains, hosts,
7553 email addresses, or local parts. For example, the &%hold_domains%& option
7554 contains a list of domains whose delivery is currently suspended. These lists
7555 are also used as data in ACL statements (see chapter &<<CHAPACL>>&), and as
7556 arguments to expansion conditions such as &%match_domain%&.
7557
7558 Each item in one of these lists is a pattern to be matched against a domain,
7559 host, email address, or local part, respectively. In the sections below, the
7560 different types of pattern for each case are described, but first we cover some
7561 general facilities that apply to all four kinds of list.
7562
7563
7564
7565 .section "Expansion of lists" "SECID75"
7566 .cindex "expansion" "of lists"
7567 Each list is expanded as a single string before it is used. The result of
7568 expansion must be a list, possibly containing empty items, which is split up
7569 into separate items for matching. By default, colon is the separator character,
7570 but this can be varied if necessary. See sections &<<SECTlistconstruct>>& and
7571 &<<SECTempitelis>>& for details of the list syntax; the second of these
7572 discusses the way to specify empty list items.
7573
7574
7575 If the string expansion is forced to fail, Exim behaves as if the item it is
7576 testing (domain, host, address, or local part) is not in the list. Other
7577 expansion failures cause temporary errors.
7578
7579 If an item in a list is a regular expression, backslashes, dollars and possibly
7580 other special characters in the expression must be protected against
7581 misinterpretation by the string expander. The easiest way to do this is to use
7582 the &`\N`& expansion feature to indicate that the contents of the regular
7583 expression should not be expanded. For example, in an ACL you might have:
7584 .code
7585 deny senders = \N^\d{8}\w@.*\.baddomain\.example$\N : \
7586                ${lookup{$domain}lsearch{/badsenders/bydomain}}
7587 .endd
7588 The first item is a regular expression that is protected from expansion by
7589 &`\N`&, whereas the second uses the expansion to obtain a list of unwanted
7590 senders based on the receiving domain.
7591
7592
7593
7594
7595 .section "Negated items in lists" "SECID76"
7596 .cindex "list" "negation"
7597 .cindex "negation" "in lists"
7598 Items in a list may be positive or negative. Negative items are indicated by a
7599 leading exclamation mark, which may be followed by optional white space. A list
7600 defines a set of items (domains, etc). When Exim processes one of these lists,
7601 it is trying to find out whether a domain, host, address, or local part
7602 (respectively) is in the set that is defined by the list. It works like this:
7603
7604 The list is scanned from left to right. If a positive item is matched, the
7605 subject that is being checked is in the set; if a negative item is matched, the
7606 subject is not in the set. If the end of the list is reached without the
7607 subject having matched any of the patterns, it is in the set if the last item
7608 was a negative one, but not if it was a positive one. For example, the list in
7609 .code
7610 domainlist relay_to_domains = !a.b.c : *.b.c
7611 .endd
7612 matches any domain ending in &'.b.c'& except for &'a.b.c'&. Domains that match
7613 neither &'a.b.c'& nor &'*.b.c'& do not match, because the last item in the
7614 list is positive. However, if the setting were
7615 .code
7616 domainlist relay_to_domains = !a.b.c
7617 .endd
7618 then all domains other than &'a.b.c'& would match because the last item in the
7619 list is negative. In other words, a list that ends with a negative item behaves
7620 as if it had an extra item &`:*`& on the end.
7621
7622 Another way of thinking about positive and negative items in lists is to read
7623 the connector as &"or"& after a positive item and as &"and"& after a negative
7624 item.
7625
7626
7627
7628 .section "File names in lists" "SECTfilnamlis"
7629 .cindex "list" "file name in"
7630 If an item in a domain, host, address, or local part list is an absolute file
7631 name (beginning with a slash character), each line of the file is read and
7632 processed as if it were an independent item in the list, except that further
7633 file names are not allowed,
7634 and no expansion of the data from the file takes place.
7635 Empty lines in the file are ignored, and the file may also contain comment
7636 lines:
7637
7638 .ilist
7639 For domain and host lists, if a # character appears anywhere in a line of the
7640 file, it and all following characters are ignored.
7641 .next
7642 Because local parts may legitimately contain # characters, a comment in an
7643 address list or local part list file is recognized only if # is preceded by
7644 white space or the start of the line. For example:
7645 .code
7646 not#comment@x.y.z   # but this is a comment
7647 .endd
7648 .endlist
7649
7650 Putting a file name in a list has the same effect as inserting each line of the
7651 file as an item in the list (blank lines and comments excepted). However, there
7652 is one important difference: the file is read each time the list is processed,
7653 so if its contents vary over time, Exim's behaviour changes.
7654
7655 If a file name is preceded by an exclamation mark, the sense of any match
7656 within the file is inverted. For example, if
7657 .code
7658 hold_domains = !/etc/nohold-domains
7659 .endd
7660 and the file contains the lines
7661 .code
7662 !a.b.c
7663 *.b.c
7664 .endd
7665 then &'a.b.c'& is in the set of domains defined by &%hold_domains%&, whereas
7666 any domain matching &`*.b.c`& is not.
7667
7668
7669
7670 .section "An lsearch file is not an out-of-line list" "SECID77"
7671 As will be described in the sections that follow, lookups can be used in lists
7672 to provide indexed methods of checking list membership. There has been some
7673 confusion about the way &(lsearch)& lookups work in lists. Because
7674 an &(lsearch)& file contains plain text and is scanned sequentially, it is
7675 sometimes thought that it is allowed to contain wild cards and other kinds of
7676 non-constant pattern. This is not the case. The keys in an &(lsearch)& file are
7677 always fixed strings, just as for any other single-key lookup type.
7678
7679 If you want to use a file to contain wild-card patterns that form part of a
7680 list, just give the file name on its own, without a search type, as described
7681 in the previous section. You could also use the &(wildlsearch)& or
7682 &(nwildlsearch)&, but there is no advantage in doing this.
7683
7684
7685
7686
7687 .section "Named lists" "SECTnamedlists"
7688 .cindex "named lists"
7689 .cindex "list" "named"
7690 A list of domains, hosts, email addresses, or local parts can be given a name
7691 which is then used to refer to the list elsewhere in the configuration. This is
7692 particularly convenient if the same list is required in several different
7693 places. It also allows lists to be given meaningful names, which can improve
7694 the readability of the configuration. For example, it is conventional to define
7695 a domain list called &'local_domains'& for all the domains that are handled
7696 locally on a host, using a configuration line such as
7697 .code
7698 domainlist local_domains = localhost:my.dom.example
7699 .endd
7700 Named lists are referenced by giving their name preceded by a plus sign, so,
7701 for example, a router that is intended to handle local domains would be
7702 configured with the line
7703 .code
7704 domains = +local_domains
7705 .endd
7706 The first router in a configuration is often one that handles all domains
7707 except the local ones, using a configuration with a negated item like this:
7708 .code
7709 dnslookup:
7710   driver = dnslookup
7711   domains = ! +local_domains
7712   transport = remote_smtp
7713   no_more
7714 .endd
7715 The four kinds of named list are created by configuration lines starting with
7716 the words &%domainlist%&, &%hostlist%&, &%addresslist%&, or &%localpartlist%&,
7717 respectively. Then there follows the name that you are defining, followed by an
7718 equals sign and the list itself. For example:
7719 .code
7720 hostlist    relay_from_hosts = 192.168.23.0/24 : my.friend.example
7721 addresslist bad_senders = cdb;/etc/badsenders
7722 .endd
7723 A named list may refer to other named lists:
7724 .code
7725 domainlist  dom1 = first.example : second.example
7726 domainlist  dom2 = +dom1 : third.example
7727 domainlist  dom3 = fourth.example : +dom2 : fifth.example
7728 .endd
7729 &*Warning*&: If the last item in a referenced list is a negative one, the
7730 effect may not be what you intended, because the negation does not propagate
7731 out to the higher level. For example, consider:
7732 .code
7733 domainlist  dom1 = !a.b
7734 domainlist  dom2 = +dom1 : *.b
7735 .endd
7736 The second list specifies &"either in the &%dom1%& list or &'*.b'&"&. The first
7737 list specifies just &"not &'a.b'&"&, so the domain &'x.y'& matches it. That
7738 means it matches the second list as well. The effect is not the same as
7739 .code
7740 domainlist  dom2 = !a.b : *.b
7741 .endd
7742 where &'x.y'& does not match. It's best to avoid negation altogether in
7743 referenced lists if you can.
7744
7745 Named lists may have a performance advantage. When Exim is routing an
7746 address or checking an incoming message, it caches the result of tests on named
7747 lists. So, if you have a setting such as
7748 .code
7749 domains = +local_domains
7750 .endd
7751 on several of your routers
7752 or in several ACL statements,
7753 the actual test is done only for the first one. However, the caching works only
7754 if there are no expansions within the list itself or any sublists that it
7755 references. In other words, caching happens only for lists that are known to be
7756 the same each time they are referenced.
7757
7758 By default, there may be up to 16 named lists of each type. This limit can be
7759 extended by changing a compile-time variable. The use of domain and host lists
7760 is recommended for concepts such as local domains, relay domains, and relay
7761 hosts. The default configuration is set up like this.
7762
7763
7764
7765 .section "Named lists compared with macros" "SECID78"
7766 .cindex "list" "named compared with macro"
7767 .cindex "macro" "compared with named list"
7768 At first sight, named lists might seem to be no different from macros in the
7769 configuration file. However, macros are just textual substitutions. If you
7770 write
7771 .code
7772 ALIST = host1 : host2
7773 auth_advertise_hosts = !ALIST
7774 .endd
7775 it probably won't do what you want, because that is exactly the same as
7776 .code
7777 auth_advertise_hosts = !host1 : host2
7778 .endd
7779 Notice that the second host name is not negated. However, if you use a host
7780 list, and write
7781 .code
7782 hostlist alist = host1 : host2
7783 auth_advertise_hosts = ! +alist
7784 .endd
7785 the negation applies to the whole list, and so that is equivalent to
7786 .code
7787 auth_advertise_hosts = !host1 : !host2
7788 .endd
7789
7790
7791 .section "Named list caching" "SECID79"
7792 .cindex "list" "caching of named"
7793 .cindex "caching" "named lists"
7794 While processing a message, Exim caches the result of checking a named list if
7795 it is sure that the list is the same each time. In practice, this means that
7796 the cache operates only if the list contains no $ characters, which guarantees
7797 that it will not change when it is expanded. Sometimes, however, you may have
7798 an expanded list that you know will be the same each time within a given
7799 message. For example:
7800 .code
7801 domainlist special_domains = \
7802            ${lookup{$sender_host_address}cdb{/some/file}}
7803 .endd
7804 This provides a list of domains that depends only on the sending host's IP
7805 address. If this domain list is referenced a number of times (for example,
7806 in several ACL lines, or in several routers) the result of the check is not
7807 cached by default, because Exim does not know that it is going to be the
7808 same list each time.
7809
7810 By appending &`_cache`& to &`domainlist`& you can tell Exim to go ahead and
7811 cache the result anyway. For example:
7812 .code
7813 domainlist_cache special_domains = ${lookup{...
7814 .endd
7815 If you do this, you should be absolutely sure that caching is going to do
7816 the right thing in all cases. When in doubt, leave it out.
7817
7818
7819
7820 .section "Domain lists" "SECTdomainlist"
7821 .cindex "domain list" "patterns for"
7822 .cindex "list" "domain list"
7823 Domain lists contain patterns that are to be matched against a mail domain.
7824 The following types of item may appear in domain lists:
7825
7826 .ilist
7827 .cindex "primary host name"
7828 .cindex "host name" "matched in domain list"
7829 .oindex "&%primary_hostname%&"
7830 .cindex "domain list" "matching primary host name"
7831 .cindex "@ in a domain list"
7832 If a pattern consists of a single @ character, it matches the local host name,
7833 as set by the &%primary_hostname%& option (or defaulted). This makes it
7834 possible to use the same configuration file on several different hosts that
7835 differ only in their names.
7836 .next
7837 .cindex "@[] in a domain list"
7838 .cindex "domain list" "matching local IP interfaces"
7839 .cindex "domain literal"
7840 If a pattern consists of the string &`@[]`& it matches an IP address enclosed
7841 in square brackets (as in an email address that contains a domain literal), but
7842 only if that IP address is recognized as local for email routing purposes. The
7843 &%local_interfaces%& and &%extra_local_interfaces%& options can be used to
7844 control which of a host's several IP addresses are treated as local.
7845 In today's Internet, the use of domain literals is controversial.
7846 .next
7847 .cindex "@mx_any"
7848 .cindex "@mx_primary"
7849 .cindex "@mx_secondary"
7850 .cindex "domain list" "matching MX pointers to local host"
7851 If a pattern consists of the string &`@mx_any`& it matches any domain that
7852 has an MX record pointing to the local host or to any host that is listed in
7853 .oindex "&%hosts_treat_as_local%&"
7854 &%hosts_treat_as_local%&. The items &`@mx_primary`& and &`@mx_secondary`&
7855 are similar, except that the first matches only when a primary MX target is the
7856 local host, and the second only when no primary MX target is the local host,
7857 but a secondary MX target is. &"Primary"& means an MX record with the lowest
7858 preference value &-- there may of course be more than one of them.
7859
7860 The MX lookup that takes place when matching a pattern of this type is
7861 performed with the resolver options for widening names turned off. Thus, for
7862 example, a single-component domain will &'not'& be expanded by adding the
7863 resolver's default domain. See the &%qualify_single%& and &%search_parents%&
7864 options of the &(dnslookup)& router for a discussion of domain widening.
7865
7866 Sometimes you may want to ignore certain IP addresses when using one of these
7867 patterns. You can specify this by following the pattern with &`/ignore=`&<&'ip
7868 list'&>, where <&'ip list'&> is a list of IP addresses. These addresses are
7869 ignored when processing the pattern (compare the &%ignore_target_hosts%& option
7870 on a router). For example:
7871 .code
7872 domains = @mx_any/ignore=127.0.0.1
7873 .endd
7874 This example matches any domain that has an MX record pointing to one of
7875 the local host's IP addresses other than 127.0.0.1.
7876
7877 The list of IP addresses is in fact processed by the same code that processes
7878 host lists, so it may contain CIDR-coded network specifications and it may also
7879 contain negative items.
7880
7881 Because the list of IP addresses is a sublist within a domain list, you have to
7882 be careful about delimiters if there is more than one address. Like any other
7883 list, the default delimiter can be changed. Thus, you might have:
7884 .code
7885 domains = @mx_any/ignore=<;127.0.0.1;0.0.0.0 : \
7886           an.other.domain : ...
7887 .endd
7888 so that the sublist uses semicolons for delimiters. When IPv6 addresses are
7889 involved, it is easiest to change the delimiter for the main list as well:
7890 .code
7891 domains = <? @mx_any/ignore=<;127.0.0.1;::1 ? \
7892           an.other.domain ? ...
7893 .endd
7894 .next
7895 .cindex "asterisk" "in domain list"
7896 .cindex "domain list" "asterisk in"
7897 .cindex "domain list" "matching &""ends with""&"
7898 If a pattern starts with an asterisk, the remaining characters of the pattern
7899 are compared with the terminating characters of the domain. The use of &"*"& in
7900 domain lists differs from its use in partial matching lookups. In a domain
7901 list, the character following the asterisk need not be a dot, whereas partial
7902 matching works only in terms of dot-separated components. For example, a domain
7903 list item such as &`*key.ex`& matches &'donkey.ex'& as well as
7904 &'cipher.key.ex'&.
7905
7906 .next
7907 .cindex "regular expressions" "in domain list"
7908 .cindex "domain list" "matching regular expression"
7909 If a pattern starts with a circumflex character, it is treated as a regular
7910 expression, and matched against the domain using a regular expression matching
7911 function. The circumflex is treated as part of the regular expression.
7912 Email domains are case-independent, so this regular expression match is by
7913 default case-independent, but you can make it case-dependent by starting it
7914 with &`(?-i)`&. References to descriptions of the syntax of regular expressions
7915 are given in chapter &<<CHAPregexp>>&.
7916
7917 &*Warning*&: Because domain lists are expanded before being processed, you
7918 must escape any backslash and dollar characters in the regular expression, or
7919 use the special &`\N`& sequence (see chapter &<<CHAPexpand>>&) to specify that
7920 it is not to be expanded (unless you really do want to build a regular
7921 expression by expansion, of course).
7922 .next
7923 .cindex "lookup" "in domain list"
7924 .cindex "domain list" "matching by lookup"
7925 If a pattern starts with the name of a single-key lookup type followed by a
7926 semicolon (for example, &"dbm;"& or &"lsearch;"&), the remainder of the pattern
7927 must be a file name in a suitable format for the lookup type. For example, for
7928 &"cdb;"& it must be an absolute path:
7929 .code
7930 domains = cdb;/etc/mail/local_domains.cdb
7931 .endd
7932 The appropriate type of lookup is done on the file using the domain name as the
7933 key. In most cases, the data that is looked up is not used; Exim is interested
7934 only in whether or not the key is present in the file. However, when a lookup
7935 is used for the &%domains%& option on a router
7936 or a &%domains%& condition in an ACL statement, the data is preserved in the
7937 &$domain_data$& variable and can be referred to in other router options or
7938 other statements in the same ACL.
7939
7940 .next
7941 Any of the single-key lookup type names may be preceded by
7942 &`partial`&<&'n'&>&`-`&, where the <&'n'&> is optional, for example,
7943 .code
7944 domains = partial-dbm;/partial/domains
7945 .endd
7946 This causes partial matching logic to be invoked; a description of how this
7947 works is given in section &<<SECTpartiallookup>>&.
7948
7949 .next
7950 .cindex "asterisk" "in lookup type"
7951 Any of the single-key lookup types may be followed by an asterisk. This causes
7952 a default lookup for a key consisting of a single asterisk to be done if the
7953 original lookup fails. This is not a useful feature when using a domain list to
7954 select particular domains (because any domain would match), but it might have
7955 value if the result of the lookup is being used via the &$domain_data$&
7956 expansion variable.
7957 .next
7958 If the pattern starts with the name of a query-style lookup type followed by a
7959 semicolon (for example, &"nisplus;"& or &"ldap;"&), the remainder of the
7960 pattern must be an appropriate query for the lookup type, as described in
7961 chapter &<<CHAPfdlookup>>&. For example:
7962 .code
7963 hold_domains = mysql;select domain from holdlist \
7964   where domain = '${quote_mysql:$domain}';
7965 .endd
7966 In most cases, the data that is looked up is not used (so for an SQL query, for
7967 example, it doesn't matter what field you select). Exim is interested only in
7968 whether or not the query succeeds. However, when a lookup is used for the
7969 &%domains%& option on a router, the data is preserved in the &$domain_data$&
7970 variable and can be referred to in other options.
7971 .next
7972 .cindex "domain list" "matching literal domain name"
7973 If none of the above cases apply, a caseless textual comparison is made
7974 between the pattern and the domain.
7975 .endlist
7976
7977 Here is an example that uses several different kinds of pattern:
7978 .code
7979 domainlist funny_domains = \
7980   @ : \
7981   lib.unseen.edu : \
7982   *.foundation.fict.example : \
7983   \N^[1-2]\d{3}\.fict\.example$\N : \
7984   partial-dbm;/opt/data/penguin/book : \
7985   nis;domains.byname : \
7986   nisplus;[name=$domain,status=local],domains.org_dir
7987 .endd
7988 There are obvious processing trade-offs among the various matching modes. Using
7989 an asterisk is faster than a regular expression, and listing a few names
7990 explicitly probably is too. The use of a file or database lookup is expensive,
7991 but may be the only option if hundreds of names are required. Because the
7992 patterns are tested in order, it makes sense to put the most commonly matched
7993 patterns earlier.
7994
7995
7996
7997 .section "Host lists" "SECThostlist"
7998 .cindex "host list" "patterns in"
7999 .cindex "list" "host list"
8000 Host lists are used to control what remote hosts are allowed to do. For
8001 example, some hosts may be allowed to use the local host as a relay, and some
8002 may be permitted to use the SMTP ETRN command. Hosts can be identified in
8003 two different ways, by name or by IP address. In a host list, some types of
8004 pattern are matched to a host name, and some are matched to an IP address.
8005 You need to be particularly careful with this when single-key lookups are
8006 involved, to ensure that the right value is being used as the key.
8007
8008
8009 .section "Special host list patterns" "SECID80"
8010 .cindex "empty item in hosts list"
8011 .cindex "host list" "empty string in"
8012 If a host list item is the empty string, it matches only when no remote host is
8013 involved. This is the case when a message is being received from a local
8014 process using SMTP on the standard input, that is, when a TCP/IP connection is
8015 not used.
8016
8017 .cindex "asterisk" "in host list"
8018 The special pattern &"*"& in a host list matches any host or no host. Neither
8019 the IP address nor the name is actually inspected.
8020
8021
8022
8023 .section "Host list patterns that match by IP address" "SECThoslispatip"
8024 .cindex "host list" "matching IP addresses"
8025 If an IPv4 host calls an IPv6 host and the call is accepted on an IPv6 socket,
8026 the incoming address actually appears in the IPv6 host as
8027 &`::ffff:`&<&'v4address'&>. When such an address is tested against a host
8028 list, it is converted into a traditional IPv4 address first. (Not all operating
8029 systems accept IPv4 calls on IPv6 sockets, as there have been some security
8030 concerns.)
8031
8032 The following types of pattern in a host list check the remote host by
8033 inspecting its IP address:
8034
8035 .ilist
8036 If the pattern is a plain domain name (not a regular expression, not starting
8037 with *, not a lookup of any kind), Exim calls the operating system function
8038 to find the associated IP address(es). Exim uses the newer
8039 &[getipnodebyname()]& function when available, otherwise &[gethostbyname()]&.
8040 This typically causes a forward DNS lookup of the name. The result is compared
8041 with the IP address of the subject host.
8042
8043 If there is a temporary problem (such as a DNS timeout) with the host name
8044 lookup, a temporary error occurs. For example, if the list is being used in an
8045 ACL condition, the ACL gives a &"defer"& response, usually leading to a
8046 temporary SMTP error code. If no IP address can be found for the host name,
8047 what happens is described in section &<<SECTbehipnot>>& below.
8048
8049 .next
8050 .cindex "@ in a host list"
8051 If the pattern is &"@"&, the primary host name is substituted and used as a
8052 domain name, as just described.
8053
8054 .next
8055 If the pattern is an IP address, it is matched against the IP address of the
8056 subject host. IPv4 addresses are given in the normal &"dotted-quad"& notation.
8057 IPv6 addresses can be given in colon-separated format, but the colons have to
8058 be doubled so as not to be taken as item separators when the default list
8059 separator is used. IPv6 addresses are recognized even when Exim is compiled
8060 without IPv6 support. This means that if they appear in a host list on an
8061 IPv4-only host, Exim will not treat them as host names. They are just addresses
8062 that can never match a client host.
8063
8064 .next
8065 .cindex "@[] in a host list"
8066 If the pattern is &"@[]"&, it matches the IP address of any IP interface on
8067 the local host. For example, if the local host is an IPv4 host with one
8068 interface address 10.45.23.56, these two ACL statements have the same effect:
8069 .code
8070 accept hosts = 127.0.0.1 : 10.45.23.56
8071 accept hosts = @[]
8072 .endd
8073 .next
8074 .cindex "CIDR notation"
8075 If the pattern is an IP address followed by a slash and a mask length (for
8076 example 10.11.42.0/24), it is matched against the IP address of the subject
8077 host under the given mask. This allows, an entire network of hosts to be
8078 included (or excluded) by a single item. The mask uses CIDR notation; it
8079 specifies the number of address bits that must match, starting from the most
8080 significant end of the address.
8081
8082 &*Note*&: The mask is &'not'& a count of addresses, nor is it the high number
8083 of a range of addresses. It is the number of bits in the network portion of the
8084 address. The above example specifies a 24-bit netmask, so it matches all 256
8085 addresses in the 10.11.42.0 network. An item such as
8086 .code
8087 192.168.23.236/31
8088 .endd
8089 matches just two addresses, 192.168.23.236 and 192.168.23.237. A mask value of
8090 32 for an IPv4 address is the same as no mask at all; just a single address
8091 matches.
8092
8093 Here is another example which shows an IPv4 and an IPv6 network:
8094 .code
8095 recipient_unqualified_hosts = 192.168.0.0/16: \
8096                               3ffe::ffff::836f::::/48
8097 .endd
8098 The doubling of list separator characters applies only when these items
8099 appear inline in a host list. It is not required when indirecting via a file.
8100 For example:
8101 .code
8102 recipient_unqualified_hosts = /opt/exim/unqualnets
8103 .endd
8104 could make use of a file containing
8105 .code
8106 172.16.0.0/12
8107 3ffe:ffff:836f::/48
8108 .endd
8109 to have exactly the same effect as the previous example. When listing IPv6
8110 addresses inline, it is usually more convenient to use the facility for
8111 changing separator characters. This list contains the same two networks:
8112 .code
8113 recipient_unqualified_hosts = <; 172.16.0.0/12; \
8114                                  3ffe:ffff:836f::/48
8115 .endd
8116 The separator is changed to semicolon by the leading &"<;"& at the start of the
8117 list.
8118 .endlist
8119
8120
8121
8122 .section "Host list patterns for single-key lookups by host address" &&&
8123          "SECThoslispatsikey"
8124 .cindex "host list" "lookup of IP address"
8125 When a host is to be identified by a single-key lookup of its complete IP
8126 address, the pattern takes this form:
8127 .display
8128 &`net-<`&&'single-key-search-type'&&`>;<`&&'search-data'&&`>`&
8129 .endd
8130 For example:
8131 .code
8132 hosts_lookup = net-cdb;/hosts-by-ip.db
8133 .endd
8134 The text form of the IP address of the subject host is used as the lookup key.
8135 IPv6 addresses are converted to an unabbreviated form, using lower case
8136 letters, with dots as separators because colon is the key terminator in
8137 &(lsearch)& files. [Colons can in fact be used in keys in &(lsearch)& files by
8138 quoting the keys, but this is a facility that was added later.] The data
8139 returned by the lookup is not used.
8140
8141 .cindex "IP address" "masking"
8142 .cindex "host list" "masked IP address"
8143 Single-key lookups can also be performed using masked IP addresses, using
8144 patterns of this form:
8145 .display
8146 &`net<`&&'number'&&`>-<`&&'single-key-search-type'&&`>;<`&&'search-data'&&`>`&
8147 .endd
8148 For example:
8149 .code
8150 net24-dbm;/networks.db
8151 .endd
8152 The IP address of the subject host is masked using <&'number'&> as the mask
8153 length. A textual string is constructed from the masked value, followed by the
8154 mask, and this is used as the lookup key. For example, if the host's IP address
8155 is 192.168.34.6, the key that is looked up for the above example is
8156 &"192.168.34.0/24"&.
8157
8158 When an IPv6 address is converted to a string, dots are normally used instead
8159 of colons, so that keys in &(lsearch)& files need not contain colons (which
8160 terminate &(lsearch)& keys). This was implemented some time before the ability
8161 to quote keys was made available in &(lsearch)& files. However, the more
8162 recently implemented &(iplsearch)& files do require colons in IPv6 keys
8163 (notated using the quoting facility) so as to distinguish them from IPv4 keys.
8164 For this reason, when the lookup type is &(iplsearch)&, IPv6 addresses are
8165 converted using colons and not dots. In all cases, full, unabbreviated IPv6
8166 addresses are always used.
8167
8168 Ideally, it would be nice to tidy up this anomalous situation by changing to
8169 colons in all cases, given that quoting is now available for &(lsearch)&.
8170 However, this would be an incompatible change that might break some existing
8171 configurations.
8172
8173 &*Warning*&: Specifying &%net32-%& (for an IPv4 address) or &%net128-%& (for an
8174 IPv6 address) is not the same as specifying just &%net-%& without a number. In
8175 the former case the key strings include the mask value, whereas in the latter
8176 case the IP address is used on its own.
8177
8178
8179
8180 .section "Host list patterns that match by host name" "SECThoslispatnam"
8181 .cindex "host" "lookup failures"
8182 .cindex "unknown host name"
8183 .cindex "host list" "matching host name"
8184 There are several types of pattern that require Exim to know the name of the
8185 remote host. These are either wildcard patterns or lookups by name. (If a
8186 complete hostname is given without any wildcarding, it is used to find an IP
8187 address to match against, as described in section &<<SECThoslispatip>>&
8188 above.)
8189
8190 If the remote host name is not already known when Exim encounters one of these
8191 patterns, it has to be found from the IP address.
8192 Although many sites on the Internet are conscientious about maintaining reverse
8193 DNS data for their hosts, there are also many that do not do this.
8194 Consequently, a name cannot always be found, and this may lead to unwanted
8195 effects. Take care when configuring host lists with wildcarded name patterns.
8196 Consider what will happen if a name cannot be found.
8197
8198 Because of the problems of determining host names from IP addresses, matching
8199 against host names is not as common as matching against IP addresses.
8200
8201 By default, in order to find a host name, Exim first does a reverse DNS lookup;
8202 if no name is found in the DNS, the system function (&[gethostbyaddr()]& or
8203 &[getipnodebyaddr()]& if available) is tried. The order in which these lookups
8204 are done can be changed by setting the &%host_lookup_order%& option. For
8205 security, once Exim has found one or more names, it looks up the IP addresses
8206 for these names and compares them with the IP address that it started with.
8207 Only those names whose IP addresses match are accepted. Any other names are
8208 discarded. If no names are left, Exim behaves as if the host name cannot be
8209 found. In the most common case there is only one name and one IP address.
8210
8211 There are some options that control what happens if a host name cannot be
8212 found. These are described in section &<<SECTbehipnot>>& below.
8213
8214 .cindex "host" "alias for"
8215 .cindex "alias for host"
8216 As a result of aliasing, hosts may have more than one name. When processing any
8217 of the following types of pattern, all the host's names are checked:
8218
8219 .ilist
8220 .cindex "asterisk" "in host list"
8221 If a pattern starts with &"*"& the remainder of the item must match the end of
8222 the host name. For example, &`*.b.c`& matches all hosts whose names end in
8223 &'.b.c'&. This special simple form is provided because this is a very common
8224 requirement. Other kinds of wildcarding require the use of a regular
8225 expression.
8226 .next
8227 .cindex "regular expressions" "in host list"
8228 .cindex "host list" "regular expression in"
8229 If the item starts with &"^"& it is taken to be a regular expression which is
8230 matched against the host name. Host names are case-independent, so this regular
8231 expression match is by default case-independent, but you can make it
8232 case-dependent by starting it with &`(?-i)`&. References to descriptions of the
8233 syntax of regular expressions are given in chapter &<<CHAPregexp>>&. For
8234 example,
8235 .code
8236 ^(a|b)\.c\.d$
8237 .endd
8238 is a regular expression that matches either of the two hosts &'a.c.d'& or
8239 &'b.c.d'&. When a regular expression is used in a host list, you must take care
8240 that backslash and dollar characters are not misinterpreted as part of the
8241 string expansion. The simplest way to do this is to use &`\N`& to mark that
8242 part of the string as non-expandable. For example:
8243 .code
8244 sender_unqualified_hosts = \N^(a|b)\.c\.d$\N : ....
8245 .endd
8246 &*Warning*&: If you want to match a complete host name, you must include the
8247 &`$`& terminating metacharacter in the regular expression, as in the above
8248 example. Without it, a match at the start of the host name is all that is
8249 required.
8250 .endlist
8251
8252
8253
8254
8255 .section "Behaviour when an IP address or name cannot be found" "SECTbehipnot"
8256 .cindex "host" "lookup failures, permanent"
8257 While processing a host list, Exim may need to look up an IP address from a
8258 name (see section &<<SECThoslispatip>>&), or it may need to look up a host name
8259 from an IP address (see section &<<SECThoslispatnam>>&). In either case, the
8260 behaviour when it fails to find the information it is seeking is the same.
8261
8262 &*Note*&: This section applies to permanent lookup failures. It does &'not'&
8263 apply to temporary DNS errors, whose handling is described in the next section.
8264
8265 .cindex "&`+include_unknown`&"
8266 .cindex "&`+ignore_unknown`&"
8267 Exim parses a host list from left to right. If it encounters a permanent
8268 lookup failure in any item in the host list before it has found a match,
8269 Exim treats it as a failure and the default behavior is as if the host
8270 does not match the list. This may not always be what you want to happen.
8271 To change Exim's behaviour, the special items &`+include_unknown`& or
8272 &`+ignore_unknown`& may appear in the list (at top level &-- they are
8273 not recognized in an indirected file).
8274
8275 .ilist
8276 If any item that follows &`+include_unknown`& requires information that
8277 cannot found, Exim behaves as if the host does match the list. For example,
8278 .code
8279 host_reject_connection = +include_unknown:*.enemy.ex
8280 .endd
8281 rejects connections from any host whose name matches &`*.enemy.ex`&, and also
8282 any hosts whose name it cannot find.
8283
8284 .next
8285 If any item that follows &`+ignore_unknown`& requires information that cannot
8286 be found, Exim ignores that item and proceeds to the rest of the list. For
8287 example:
8288 .code
8289 accept hosts = +ignore_unknown : friend.example : \
8290                192.168.4.5
8291 .endd
8292 accepts from any host whose name is &'friend.example'& and from 192.168.4.5,
8293 whether or not its host name can be found. Without &`+ignore_unknown`&, if no
8294 name can be found for 192.168.4.5, it is rejected.
8295 .endlist
8296
8297 Both &`+include_unknown`& and &`+ignore_unknown`& may appear in the same
8298 list. The effect of each one lasts until the next, or until the end of the
8299 list.
8300
8301 .new
8302 .section "Mixing wildcarded host names and addresses in host lists" &&&
8303          "SECTmixwilhos"
8304 .cindex "host list" "mixing names and addresses in"
8305
8306 This section explains the host/ip processing logic with the same concepts
8307 as the previous section, but specifically addresses what happens when a
8308 wildcarded hostname is one of the items in the hostlist.
8309
8310 .ilist
8311 If you have name lookups or wildcarded host names and
8312 IP addresses in the same host list, you should normally put the IP
8313 addresses first. For example, in an ACL you could have:
8314 .code
8315 accept hosts = 10.9.8.7 : *.friend.example
8316 .endd
8317 The reason you normally would order it this way lies in the
8318 left-to-right way that Exim processes lists.  It can test IP addresses
8319 without doing any DNS lookups, but when it reaches an item that requires
8320 a host name, it fails if it cannot find a host name to compare with the
8321 pattern. If the above list is given in the opposite order, the
8322 &%accept%& statement fails for a host whose name cannot be found, even
8323 if its IP address is 10.9.8.7.
8324
8325 .next
8326 If you really do want to do the name check first, and still recognize the IP
8327 address, you can rewrite the ACL like this:
8328 .code
8329 accept hosts = *.friend.example
8330 accept hosts = 10.9.8.7
8331 .endd
8332 If the first &%accept%& fails, Exim goes on to try the second one. See chapter
8333 &<<CHAPACL>>& for details of ACLs. Alternatively, you can use
8334 &`+ignore_unknown`&, which was discussed in depth in the first example in
8335 this section.
8336 .endlist
8337 .wen
8338
8339
8340 .section "Temporary DNS errors when looking up host information" &&&
8341          "SECTtemdnserr"
8342 .cindex "host" "lookup failures, temporary"
8343 .cindex "&`+include_defer`&"
8344 .cindex "&`+ignore_defer`&"
8345 A temporary DNS lookup failure normally causes a defer action (except when
8346 &%dns_again_means_nonexist%& converts it into a permanent error). However,
8347 host lists can include &`+ignore_defer`& and &`+include_defer`&, analagous to
8348 &`+ignore_unknown`& and &`+include_unknown`&, as described in the previous
8349 section. These options should be used with care, probably only in non-critical
8350 host lists such as whitelists.
8351
8352
8353
8354 .section "Host list patterns for single-key lookups by host name" &&&
8355          "SECThoslispatnamsk"
8356 .cindex "unknown host name"
8357 .cindex "host list" "matching host name"
8358 If a pattern is of the form
8359 .display
8360 <&'single-key-search-type'&>;<&'search-data'&>
8361 .endd
8362 for example
8363 .code
8364 dbm;/host/accept/list
8365 .endd
8366 a single-key lookup is performed, using the host name as its key. If the
8367 lookup succeeds, the host matches the item. The actual data that is looked up
8368 is not used.
8369
8370 &*Reminder*&: With this kind of pattern, you must have host &'names'& as
8371 keys in the file, not IP addresses. If you want to do lookups based on IP
8372 addresses, you must precede the search type with &"net-"& (see section
8373 &<<SECThoslispatsikey>>&). There is, however, no reason why you could not use
8374 two items in the same list, one doing an address lookup and one doing a name
8375 lookup, both using the same file.
8376
8377
8378
8379 .section "Host list patterns for query-style lookups" "SECID81"
8380 If a pattern is of the form
8381 .display
8382 <&'query-style-search-type'&>;<&'query'&>
8383 .endd
8384 the query is obeyed, and if it succeeds, the host matches the item. The actual
8385 data that is looked up is not used. The variables &$sender_host_address$& and
8386 &$sender_host_name$& can be used in the query. For example:
8387 .code
8388 hosts_lookup = pgsql;\
8389   select ip from hostlist where ip='$sender_host_address'
8390 .endd
8391 The value of &$sender_host_address$& for an IPv6 address contains colons. You
8392 can use the &%sg%& expansion item to change this if you need to. If you want to
8393 use masked IP addresses in database queries, you can use the &%mask%& expansion
8394 operator.
8395
8396 If the query contains a reference to &$sender_host_name$&, Exim automatically
8397 looks up the host name if it has not already done so. (See section
8398 &<<SECThoslispatnam>>& for comments on finding host names.)
8399
8400 Historical note: prior to release 4.30, Exim would always attempt to find a
8401 host name before running the query, unless the search type was preceded by
8402 &`net-`&. This is no longer the case. For backwards compatibility, &`net-`& is
8403 still recognized for query-style lookups, but its presence or absence has no
8404 effect. (Of course, for single-key lookups, &`net-`& &'is'& important.
8405 See section &<<SECThoslispatsikey>>&.)
8406
8407
8408
8409
8410
8411 .section "Address lists" "SECTaddresslist"
8412 .cindex "list" "address list"
8413 .cindex "address list" "empty item"
8414 .cindex "address list" "patterns"
8415 Address lists contain patterns that are matched against mail addresses. There
8416 is one special case to be considered: the sender address of a bounce message is
8417 always empty. You can test for this by providing an empty item in an address
8418 list. For example, you can set up a router to process bounce messages by
8419 using this option setting:
8420 .code
8421 senders = :
8422 .endd
8423 The presence of the colon creates an empty item. If you do not provide any
8424 data, the list is empty and matches nothing. The empty sender can also be
8425 detected by a regular expression that matches an empty string,
8426 and by a query-style lookup that succeeds when &$sender_address$& is empty.
8427
8428 Non-empty items in an address list can be straightforward email addresses. For
8429 example:
8430 .code
8431 senders = jbc@askone.example : hs@anacreon.example
8432 .endd
8433 A certain amount of wildcarding is permitted. If a pattern contains an @
8434 character, but is not a regular expression and does not begin with a
8435 semicolon-terminated lookup type (described below), the local part of the
8436 subject address is compared with the local part of the pattern, which may start
8437 with an asterisk. If the local parts match, the domain is checked in exactly
8438 the same way as for a pattern in a domain list. For example, the domain can be
8439 wildcarded, refer to a named list, or be a lookup:
8440 .code
8441 deny senders = *@*.spamming.site:\
8442                *@+hostile_domains:\
8443                bozo@partial-lsearch;/list/of/dodgy/sites:\
8444                *@dbm;/bad/domains.db
8445 .endd
8446 .cindex "local part" "starting with !"
8447 .cindex "address list" "local part starting with !"
8448 If a local part that begins with an exclamation mark is required, it has to be
8449 specified using a regular expression, because otherwise the exclamation mark is
8450 treated as a sign of negation, as is standard in lists.
8451
8452 If a non-empty pattern that is not a regular expression or a lookup does not
8453 contain an @ character, it is matched against the domain part of the subject
8454 address. The only two formats that are recognized this way are a literal
8455 domain, or a domain pattern that starts with *. In both these cases, the effect
8456 is the same as if &`*@`& preceded the pattern. For example:
8457 .code
8458 deny senders = enemy.domain : *.enemy.domain
8459 .endd
8460
8461 The following kinds of more complicated address list pattern can match any
8462 address, including the empty address that is characteristic of bounce message
8463 senders:
8464
8465 .ilist
8466 .cindex "regular expressions" "in address list"
8467 .cindex "address list" "regular expression in"
8468 If (after expansion) a pattern starts with &"^"&, a regular expression match is
8469 done against the complete address, with the pattern as the regular expression.
8470 You must take care that backslash and dollar characters are not misinterpreted
8471 as part of the string expansion. The simplest way to do this is to use &`\N`&
8472 to mark that part of the string as non-expandable. For example:
8473 .code
8474 deny senders = \N^.*this.*@example\.com$\N : \
8475                \N^\d{8}.+@spamhaus.example$\N : ...
8476 .endd
8477 The &`\N`& sequences are removed by the expansion, so these items do indeed
8478 start with &"^"& by the time they are being interpreted as address patterns.
8479
8480 .next
8481 .cindex "address list" "lookup for complete address"
8482 Complete addresses can be looked up by using a pattern that starts with a
8483 lookup type terminated by a semicolon, followed by the data for the lookup. For
8484 example:
8485 .code
8486 deny senders = cdb;/etc/blocked.senders : \
8487   mysql;select address from blocked where \
8488   address='${quote_mysql:$sender_address}'
8489 .endd
8490 Both query-style and single-key lookup types can be used. For a single-key
8491 lookup type, Exim uses the complete address as the key. However, empty keys are
8492 not supported for single-key lookups, so a match against the empty address
8493 always fails. This restriction does not apply to query-style lookups.
8494
8495 Partial matching for single-key lookups (section &<<SECTpartiallookup>>&)
8496 cannot be used, and is ignored if specified, with an entry being written to the
8497 panic log.
8498 .cindex "*@ with single-key lookup"
8499 However, you can configure lookup defaults, as described in section
8500 &<<SECTdefaultvaluelookups>>&, but this is useful only for the &"*@"& type of
8501 default. For example, with this lookup:
8502 .code
8503 accept senders = lsearch*@;/some/file
8504 .endd
8505 the file could contains lines like this:
8506 .code
8507 user1@domain1.example
8508 *@domain2.example
8509 .endd
8510 and for the sender address &'nimrod@jaeger.example'&, the sequence of keys
8511 that are tried is:
8512 .code
8513 nimrod@jaeger.example
8514 *@jaeger.example
8515 *
8516 .endd
8517 &*Warning 1*&: Do not include a line keyed by &"*"& in the file, because that
8518 would mean that every address matches, thus rendering the test useless.
8519
8520 &*Warning 2*&: Do not confuse these two kinds of item:
8521 .code
8522 deny recipients = dbm*@;/some/file
8523 deny recipients = *@dbm;/some/file
8524 .endd
8525 The first does a whole address lookup, with defaulting, as just described,
8526 because it starts with a lookup type. The second matches the local part and
8527 domain independently, as described in a bullet point below.
8528 .endlist
8529
8530
8531 The following kinds of address list pattern can match only non-empty addresses.
8532 If the subject address is empty, a match against any of these pattern types
8533 always fails.
8534
8535
8536 .ilist
8537 .cindex "@@ with single-key lookup"
8538 .cindex "address list" "@@ lookup type"
8539 .cindex "address list" "split local part and domain"
8540 If a pattern starts with &"@@"& followed by a single-key lookup item
8541 (for example, &`@@lsearch;/some/file`&), the address that is being checked is
8542 split into a local part and a domain. The domain is looked up in the file. If
8543 it is not found, there is no match. If it is found, the data that is looked up
8544 from the file is treated as a colon-separated list of local part patterns, each
8545 of which is matched against the subject local part in turn.
8546
8547 .cindex "asterisk" "in address list"
8548 The lookup may be a partial one, and/or one involving a search for a default
8549 keyed by &"*"& (see section &<<SECTdefaultvaluelookups>>&). The local part
8550 patterns that are looked up can be regular expressions or begin with &"*"&, or
8551 even be further lookups. They may also be independently negated. For example,
8552 with
8553 .code
8554 deny senders = @@dbm;/etc/reject-by-domain
8555 .endd
8556 the data from which the DBM file is built could contain lines like
8557 .code
8558 baddomain.com:  !postmaster : *
8559 .endd
8560 to reject all senders except &%postmaster%& from that domain.
8561
8562 .cindex "local part" "starting with !"
8563 If a local part that actually begins with an exclamation mark is required, it
8564 has to be specified using a regular expression. In &(lsearch)& files, an entry
8565 may be split over several lines by indenting the second and subsequent lines,
8566 but the separating colon must still be included at line breaks. White space
8567 surrounding the colons is ignored. For example:
8568 .code
8569 aol.com:  spammer1 : spammer2 : ^[0-9]+$ :
8570   spammer3 : spammer4
8571 .endd
8572 As in all colon-separated lists in Exim, a colon can be included in an item by
8573 doubling.
8574
8575 If the last item in the list starts with a right angle-bracket, the remainder
8576 of the item is taken as a new key to look up in order to obtain a continuation
8577 list of local parts. The new key can be any sequence of characters. Thus one
8578 might have entries like
8579 .code
8580 aol.com: spammer1 : spammer 2 : >*
8581 xyz.com: spammer3 : >*
8582 *:       ^\d{8}$
8583 .endd
8584 in a file that was searched with &%@@dbm*%&, to specify a match for 8-digit
8585 local parts for all domains, in addition to the specific local parts listed for
8586 each domain. Of course, using this feature costs another lookup each time a
8587 chain is followed, but the effort needed to maintain the data is reduced.
8588
8589 .cindex "loop" "in lookups"
8590 It is possible to construct loops using this facility, and in order to catch
8591 them, the chains may be no more than fifty items long.
8592
8593 .next
8594 The @@<&'lookup'&> style of item can also be used with a query-style
8595 lookup, but in this case, the chaining facility is not available. The lookup
8596 can only return a single list of local parts.
8597 .endlist
8598
8599 &*Warning*&: There is an important difference between the address list items
8600 in these two examples:
8601 .code
8602 senders = +my_list
8603 senders = *@+my_list
8604 .endd
8605 In the first one, &`my_list`& is a named address list, whereas in the second
8606 example it is a named domain list.
8607
8608
8609
8610
8611 .section "Case of letters in address lists" "SECTcasletadd"
8612 .cindex "case of local parts"
8613 .cindex "address list" "case forcing"
8614 .cindex "case forcing in address lists"
8615 Domains in email addresses are always handled caselessly, but for local parts
8616 case may be significant on some systems (see &%caseful_local_part%& for how
8617 Exim deals with this when routing addresses). However, RFC 2505 (&'Anti-Spam
8618 Recommendations for SMTP MTAs'&) suggests that matching of addresses to
8619 blocking lists should be done in a case-independent manner. Since most address
8620 lists in Exim are used for this kind of control, Exim attempts to do this by
8621 default.
8622
8623 The domain portion of an address is always lowercased before matching it to an
8624 address list. The local part is lowercased by default, and any string
8625 comparisons that take place are done caselessly. This means that the data in
8626 the address list itself, in files included as plain file names, and in any file
8627 that is looked up using the &"@@"& mechanism, can be in any case. However, the
8628 keys in files that are looked up by a search type other than &(lsearch)& (which
8629 works caselessly) must be in lower case, because these lookups are not
8630 case-independent.
8631
8632 .cindex "&`+caseful`&"
8633 To allow for the possibility of caseful address list matching, if an item in
8634 an address list is the string &"+caseful"&, the original case of the local
8635 part is restored for any comparisons that follow, and string comparisons are no
8636 longer case-independent. This does not affect the domain, which remains in
8637 lower case. However, although independent matches on the domain alone are still
8638 performed caselessly, regular expressions that match against an entire address
8639 become case-sensitive after &"+caseful"& has been seen.
8640
8641
8642
8643 .section "Local part lists" "SECTlocparlis"
8644 .cindex "list" "local part list"
8645 .cindex "local part" "list"
8646 Case-sensitivity in local part lists is handled in the same way as for address
8647 lists, as just described. The &"+caseful"& item can be used if required. In a
8648 setting of the &%local_parts%& option in a router with &%caseful_local_part%&
8649 set false, the subject is lowercased and the matching is initially
8650 case-insensitive. In this case, &"+caseful"& will restore case-sensitive
8651 matching in the local part list, but not elsewhere in the router. If
8652 &%caseful_local_part%& is set true in a router, matching in the &%local_parts%&
8653 option is case-sensitive from the start.
8654
8655 If a local part list is indirected to a file (see section &<<SECTfilnamlis>>&),
8656 comments are handled in the same way as address lists &-- they are recognized
8657 only if the # is preceded by white space or the start of the line.
8658 Otherwise, local part lists are matched in the same way as domain lists, except
8659 that the special items that refer to the local host (&`@`&, &`@[]`&,
8660 &`@mx_any`&, &`@mx_primary`&, and &`@mx_secondary`&) are not recognized.
8661 Refer to section &<<SECTdomainlist>>& for details of the other available item
8662 types.
8663 .ecindex IIDdohoadli
8664
8665
8666
8667
8668 . ////////////////////////////////////////////////////////////////////////////
8669 . ////////////////////////////////////////////////////////////////////////////
8670
8671 .chapter "String expansions" "CHAPexpand"
8672 .scindex IIDstrexp "expansion" "of strings"
8673 Many strings in Exim's run time configuration are expanded before use. Some of
8674 them are expanded every time they are used; others are expanded only once.
8675
8676 When a string is being expanded it is copied verbatim from left to right except
8677 when a dollar or backslash character is encountered. A dollar specifies the
8678 start of a portion of the string that is interpreted and replaced as described
8679 below in section &<<SECTexpansionitems>>& onwards. Backslash is used as an
8680 escape character, as described in the following section.
8681
8682 Whether a string is expanded depends upon the context.  Usually this is solely
8683 dependent upon the option for which a value is sought; in this documentation,
8684 options for which string expansion is performed are marked with &dagger; after
8685 the data type.  ACL rules always expand strings.  A couple of expansion
8686 conditions do not expand some of the brace-delimited branches, for security
8687 reasons.
8688
8689
8690
8691 .section "Literal text in expanded strings" "SECTlittext"
8692 .cindex "expansion" "including literal text"
8693 An uninterpreted dollar can be included in an expanded string by putting a
8694 backslash in front of it. A backslash can be used to prevent any special
8695 character being treated specially in an expansion, including backslash itself.
8696 If the string appears in quotes in the configuration file, two backslashes are
8697 required because the quotes themselves cause interpretation of backslashes when
8698 the string is read in (see section &<<SECTstrings>>&).
8699
8700 .cindex "expansion" "non-expandable substrings"
8701 A portion of the string can specified as non-expandable by placing it between
8702 two occurrences of &`\N`&. This is particularly useful for protecting regular
8703 expressions, which often contain backslashes and dollar signs. For example:
8704 .code
8705 deny senders = \N^\d{8}[a-z]@some\.site\.example$\N
8706 .endd
8707 On encountering the first &`\N`&, the expander copies subsequent characters
8708 without interpretation until it reaches the next &`\N`& or the end of the
8709 string.
8710
8711
8712
8713 .section "Character escape sequences in expanded strings" "SECID82"
8714 .cindex "expansion" "escape sequences"
8715 A backslash followed by one of the letters &"n"&, &"r"&, or &"t"& in an
8716 expanded string is recognized as an escape sequence for the character newline,
8717 carriage return, or tab, respectively. A backslash followed by up to three
8718 octal digits is recognized as an octal encoding for a single character, and a
8719 backslash followed by &"x"& and up to two hexadecimal digits is a hexadecimal
8720 encoding.
8721
8722 These escape sequences are also recognized in quoted strings when they are read
8723 in. Their interpretation in expansions as well is useful for unquoted strings,
8724 and for other cases such as looked-up strings that are then expanded.
8725
8726
8727 .section "Testing string expansions" "SECID83"
8728 .cindex "expansion" "testing"
8729 .cindex "testing" "string expansion"
8730 .oindex "&%-be%&"
8731 Many expansions can be tested by calling Exim with the &%-be%& option. This
8732 takes the command arguments, or lines from the standard input if there are no
8733 arguments, runs them through the string expansion code, and writes the results
8734 to the standard output. Variables based on configuration values are set up, but
8735 since no message is being processed, variables such as &$local_part$& have no
8736 value. Nevertheless the &%-be%& option can be useful for checking out file and
8737 database lookups, and the use of expansion operators such as &%sg%&, &%substr%&
8738 and &%nhash%&.
8739
8740 Exim gives up its root privilege when it is called with the &%-be%& option, and
8741 instead runs under the uid and gid it was called with, to prevent users from
8742 using &%-be%& for reading files to which they do not have access.
8743
8744 .oindex "&%-bem%&"
8745 If you want to test expansions that include variables whose values are taken
8746 from a message, there are two other options that can be used. The &%-bem%&
8747 option is like &%-be%& except that it is followed by a file name. The file is
8748 read as a message before doing the test expansions. For example:
8749 .code
8750 exim -bem /tmp/test.message '$h_subject:'
8751 .endd
8752 The &%-Mset%& option is used in conjunction with &%-be%& and is followed by an
8753 Exim message identifier. For example:
8754 .code
8755 exim -be -Mset 1GrA8W-0004WS-LQ '$recipients'
8756 .endd
8757 This loads the message from Exim's spool before doing the test expansions, and
8758 is therefore restricted to admin users.
8759
8760
8761 .section "Forced expansion failure" "SECTforexpfai"
8762 .cindex "expansion" "forced failure"
8763 A number of expansions that are described in the following section have
8764 alternative &"true"& and &"false"& substrings, enclosed in brace characters
8765 (which are sometimes called &"curly brackets"&). Which of the two strings is
8766 used depends on some condition that is evaluated as part of the expansion. If,
8767 instead of a &"false"& substring, the word &"fail"& is used (not in braces),
8768 the entire string expansion fails in a way that can be detected by the code
8769 that requested the expansion. This is called &"forced expansion failure"&, and
8770 its consequences depend on the circumstances. In some cases it is no different
8771 from any other expansion failure, but in others a different action may be
8772 taken. Such variations are mentioned in the documentation of the option that is
8773 being expanded.
8774
8775
8776
8777
8778 .section "Expansion items" "SECTexpansionitems"
8779 The following items are recognized in expanded strings. White space may be used
8780 between sub-items that are keywords or substrings enclosed in braces inside an
8781 outer set of braces, to improve readability. &*Warning*&: Within braces,
8782 white space is significant.
8783
8784 .vlist
8785 .vitem &*$*&<&'variable&~name'&>&~or&~&*${*&<&'variable&~name'&>&*}*&
8786 .cindex "expansion" "variables"
8787 Substitute the contents of the named variable, for example:
8788 .code
8789 $local_part
8790 ${domain}
8791 .endd
8792 The second form can be used to separate the name from subsequent alphanumeric
8793 characters. This form (using braces) is available only for variables; it does
8794 &'not'& apply to message headers. The names of the variables are given in
8795 section &<<SECTexpvar>>& below. If the name of a non-existent variable is
8796 given, the expansion fails.
8797
8798 .vitem &*${*&<&'op'&>&*:*&<&'string'&>&*}*&
8799 .cindex "expansion" "operators"
8800 The string is first itself expanded, and then the operation specified by
8801 <&'op'&> is applied to it. For example:
8802 .code
8803 ${lc:$local_part}
8804 .endd
8805 The string starts with the first character after the colon, which may be
8806 leading white space. A list of operators is given in section &<<SECTexpop>>&
8807 below. The operator notation is used for simple expansion items that have just
8808 one argument, because it reduces the number of braces and therefore makes the
8809 string easier to understand.
8810
8811 .vitem &*$bheader_*&<&'header&~name'&>&*:*&&~or&~&*$bh_*&<&'header&~name'&>&*:*&
8812 This item inserts &"basic"& header lines. It is described with the &%header%&
8813 expansion item below.
8814
8815
8816 .vitem "&*${acl{*&<&'name'&>&*}{*&<&'arg'&>&*}...}*&"
8817 .cindex "expansion" "calling an acl"
8818 .cindex "&%acl%&" "call from expansion"
8819 The name and zero to nine argument strings are first expanded separately.  The expanded
8820 arguments are assigned to the variables &$acl_arg1$& to &$acl_arg9$& in order.
8821 Any unused are made empty.  The variable &$acl_narg$& is set to the number of
8822 arguments.  The named ACL (see chapter &<<CHAPACL>>&) is called
8823 and may use the variables; if another acl expansion is used the values
8824 are restored after it returns.  If the ACL sets
8825 a value using a "message =" modifier and returns accept or deny, the value becomes
8826 the result of the expansion.
8827 If no message is set and the ACL returns accept or deny
8828 the expansion result is an empty string.
8829 If the ACL returns defer the result is a forced-fail.  Otherwise the expansion fails.
8830
8831
8832 .vitem "&*${dlfunc{*&<&'file'&>&*}{*&<&'function'&>&*}{*&<&'arg'&>&*}&&&
8833        {*&<&'arg'&>&*}...}*&"
8834 .cindex &%dlfunc%&
8835 This expansion dynamically loads and then calls a locally-written C function.
8836 This functionality is available only if Exim is compiled with
8837 .code
8838 EXPAND_DLFUNC=yes
8839 .endd
8840 set in &_Local/Makefile_&. Once loaded, Exim remembers the dynamically loaded
8841 object so that it doesn't reload the same object file in the same Exim process
8842 (but of course Exim does start new processes frequently).
8843
8844 There may be from zero to eight arguments to the function. When compiling
8845 a local function that is to be called in this way, &_local_scan.h_& should be
8846 included. The Exim variables and functions that are defined by that API
8847 are also available for dynamically loaded functions. The function itself
8848 must have the following type:
8849 .code
8850 int dlfunction(uschar **yield, int argc, uschar *argv[])
8851 .endd
8852 Where &`uschar`& is a typedef for &`unsigned char`& in &_local_scan.h_&. The
8853 function should return one of the following values:
8854
8855 &`OK`&: Success. The string that is placed in the variable &'yield'& is put
8856 into the expanded string that is being built.
8857
8858 &`FAIL`&: A non-forced expansion failure occurs, with the error message taken
8859 from &'yield'&, if it is set.
8860
8861 &`FAIL_FORCED`&: A forced expansion failure occurs, with the error message
8862 taken from &'yield'& if it is set.
8863
8864 &`ERROR`&: Same as &`FAIL`&, except that a panic log entry is written.
8865
8866 When compiling a function that is to be used in this way with gcc,
8867 you need to add &%-shared%& to the gcc command. Also, in the Exim build-time
8868 configuration, you must add &%-export-dynamic%& to EXTRALIBS.
8869
8870 .vitem "&*${extract{*&<&'key'&>&*}{*&<&'string1'&>&*}{*&<&'string2'&>&*}&&&
8871        {*&<&'string3'&>&*}}*&"
8872 .cindex "expansion" "extracting substrings by key"
8873 .cindex "&%extract%&" "substrings by key"
8874 The key and <&'string1'&> are first expanded separately. Leading and trailing
8875 white space is removed from the key (but not from any of the strings). The key
8876 must not consist entirely of digits. The expanded <&'string1'&> must be of the
8877 form:
8878 .display
8879 <&'key1'&> = <&'value1'&>  <&'key2'&> = <&'value2'&> ...
8880 .endd
8881 .vindex "&$value$&"
8882 where the equals signs and spaces (but not both) are optional. If any of the
8883 values contain white space, they must be enclosed in double quotes, and any
8884 values that are enclosed in double quotes are subject to escape processing as
8885 described in section &<<SECTstrings>>&. The expanded <&'string1'&> is searched
8886 for the value that corresponds to the key. The search is case-insensitive. If
8887 the key is found, <&'string2'&> is expanded, and replaces the whole item;
8888 otherwise <&'string3'&> is used. During the expansion of <&'string2'&> the
8889 variable &$value$& contains the value that has been extracted. Afterwards, it
8890 is restored to any previous value it might have had.
8891
8892 If {<&'string3'&>} is omitted, the item is replaced by an empty string if the
8893 key is not found. If {<&'string2'&>} is also omitted, the value that was
8894 extracted is used. Thus, for example, these two expansions are identical, and
8895 yield &"2001"&:
8896 .code
8897 ${extract{gid}{uid=1984 gid=2001}}
8898 ${extract{gid}{uid=1984 gid=2001}{$value}}
8899 .endd
8900 Instead of {<&'string3'&>} the word &"fail"& (not in curly brackets) can
8901 appear, for example:
8902 .code
8903 ${extract{Z}{A=... B=...}{$value} fail }
8904 .endd
8905 This forces an expansion failure (see section &<<SECTforexpfai>>&);
8906 {<&'string2'&>} must be present for &"fail"& to be recognized.
8907
8908
8909 .vitem "&*${extract{*&<&'number'&>&*}{*&<&'separators'&>&*}&&&
8910         {*&<&'string1'&>&*}{*&<&'string2'&>&*}{*&<&'string3'&>&*}}*&"
8911 .cindex "expansion" "extracting substrings by number"
8912 .cindex "&%extract%&" "substrings by number"
8913 The <&'number'&> argument must consist entirely of decimal digits,
8914 apart from leading and trailing white space, which is ignored.
8915 This is what distinguishes this form of &%extract%& from the previous kind. It
8916 behaves in the same way, except that, instead of extracting a named field, it
8917 extracts from <&'string1'&> the field whose number is given as the first
8918 argument. You can use &$value$& in <&'string2'&> or &`fail`& instead of
8919 <&'string3'&> as before.
8920
8921 The fields in the string are separated by any one of the characters in the
8922 separator string. These may include space or tab characters.
8923 The first field is numbered one. If the number is negative, the fields are
8924 counted from the end of the string, with the rightmost one numbered -1. If the
8925 number given is zero, the entire string is returned. If the modulus of the
8926 number is greater than the number of fields in the string, the result is the
8927 expansion of <&'string3'&>, or the empty string if <&'string3'&> is not
8928 provided. For example:
8929 .code
8930 ${extract{2}{:}{x:42:99:& Mailer::/bin/bash}}
8931 .endd
8932 yields &"42"&, and
8933 .code
8934 ${extract{-4}{:}{x:42:99:& Mailer::/bin/bash}}
8935 .endd
8936 yields &"99"&. Two successive separators mean that the field between them is
8937 empty (for example, the fifth field above).
8938
8939
8940 .vitem &*${filter{*&<&'string'&>&*}{*&<&'condition'&>&*}}*&
8941 .cindex "list" "selecting by condition"
8942 .cindex "expansion" "selecting from list by condition"
8943 .vindex "&$item$&"
8944 After expansion, <&'string'&> is interpreted as a list, colon-separated by
8945 default, but the separator can be changed in the usual way. For each item
8946 in this list, its value is place in &$item$&, and then the condition is
8947 evaluated. If the condition is true, &$item$& is added to the output as an
8948 item in a new list; if the condition is false, the item is discarded. The
8949 separator used for the output list is the same as the one used for the
8950 input, but a separator setting is not included in the output. For example:
8951 .code
8952 ${filter{a:b:c}{!eq{$item}{b}}
8953 .endd
8954 yields &`a:c`&. At the end of the expansion, the value of &$item$& is restored
8955 to what it was before. See also the &*map*& and &*reduce*& expansion items.
8956
8957
8958 .vitem &*${hash{*&<&'string1'&>&*}{*&<&'string2'&>&*}{*&<&'string3'&>&*}}*&
8959 .cindex "hash function" "textual"
8960 .cindex "expansion" "textual hash"
8961 This is a textual hashing function, and was the first to be implemented in
8962 early versions of Exim. In current releases, there are other hashing functions
8963 (numeric, MD5, and SHA-1), which are described below.
8964
8965 The first two strings, after expansion, must be numbers. Call them <&'m'&> and
8966 <&'n'&>. If you are using fixed values for these numbers, that is, if
8967 <&'string1'&> and <&'string2'&> do not change when they are expanded, you can
8968 use the simpler operator notation that avoids some of the braces:
8969 .code
8970 ${hash_<n>_<m>:<string>}
8971 .endd
8972 The second number is optional (in both notations). If <&'n'&> is greater than
8973 or equal to the length of the string, the expansion item returns the string.
8974 Otherwise it computes a new string of length <&'n'&> by applying a hashing
8975 function to the string. The new string consists of characters taken from the
8976 first <&'m'&> characters of the string
8977 .code
8978 abcdefghijklmnopqrstuvwxyzABCDEFGHIJKLMNOPQWRSTUVWXYZ0123456789
8979 .endd
8980 If <&'m'&> is not present the value 26 is used, so that only lower case
8981 letters appear. For example:
8982 .display
8983 &`$hash{3}{monty}}           `&   yields  &`jmg`&
8984 &`$hash{5}{monty}}           `&   yields  &`monty`&
8985 &`$hash{4}{62}{monty python}}`&   yields  &`fbWx`&
8986 .endd
8987
8988 .vitem "&*$header_*&<&'header&~name'&>&*:*&&~or&~&&&
8989         &*$h_*&<&'header&~name'&>&*:*&" &&&
8990        "&*$bheader_*&<&'header&~name'&>&*:*&&~or&~&&&
8991         &*$bh_*&<&'header&~name'&>&*:*&" &&&
8992        "&*$rheader_*&<&'header&~name'&>&*:*&&~or&~&&&
8993         &*$rh_*&<&'header&~name'&>&*:*&"
8994 .cindex "expansion" "header insertion"
8995 .vindex "&$header_$&"
8996 .vindex "&$bheader_$&"
8997 .vindex "&$rheader_$&"
8998 .cindex "header lines" "in expansion strings"
8999 .cindex "header lines" "character sets"
9000 .cindex "header lines" "decoding"
9001 Substitute the contents of the named message header line, for example
9002 .code
9003 $header_reply-to:
9004 .endd
9005 The newline that terminates a header line is not included in the expansion, but
9006 internal newlines (caused by splitting the header line over several physical
9007 lines) may be present.
9008
9009 The difference between &%rheader%&, &%bheader%&, and &%header%& is in the way
9010 the data in the header line is interpreted.
9011
9012 .ilist
9013 .cindex "white space" "in header lines"
9014 &%rheader%& gives the original &"raw"& content of the header line, with no
9015 processing at all, and without the removal of leading and trailing white space.
9016
9017 .next
9018 .cindex "base64 encoding" "in header lines"
9019 &%bheader%& removes leading and trailing white space, and then decodes base64
9020 or quoted-printable MIME &"words"& within the header text, but does no
9021 character set translation. If decoding of what looks superficially like a MIME
9022 &"word"& fails, the raw string is returned. If decoding
9023 .cindex "binary zero" "in header line"
9024 produces a binary zero character, it is replaced by a question mark &-- this is
9025 what Exim does for binary zeros that are actually received in header lines.
9026
9027 .next
9028 &%header%& tries to translate the string as decoded by &%bheader%& to a
9029 standard character set. This is an attempt to produce the same string as would
9030 be displayed on a user's MUA. If translation fails, the &%bheader%& string is
9031 returned. Translation is attempted only on operating systems that support the
9032 &[iconv()]& function. This is indicated by the compile-time macro HAVE_ICONV in
9033 a system Makefile or in &_Local/Makefile_&.
9034 .endlist ilist
9035
9036 In a filter file, the target character set for &%header%& can be specified by a
9037 command of the following form:
9038 .code
9039 headers charset "UTF-8"
9040 .endd
9041 This command affects all references to &$h_$& (or &$header_$&) expansions in
9042 subsequently obeyed filter commands. In the absence of this command, the target
9043 character set in a filter is taken from the setting of the &%headers_charset%&
9044 option in the runtime configuration. The value of this option defaults to the
9045 value of HEADERS_CHARSET in &_Local/Makefile_&. The ultimate default is
9046 ISO-8859-1.
9047
9048 Header names follow the syntax of RFC 2822, which states that they may contain
9049 any printing characters except space and colon. Consequently, curly brackets
9050 &'do not'& terminate header names, and should not be used to enclose them as
9051 if they were variables. Attempting to do so causes a syntax error.
9052
9053 Only header lines that are common to all copies of a message are visible to
9054 this mechanism. These are the original header lines that are received with the
9055 message, and any that are added by an ACL statement or by a system
9056 filter. Header lines that are added to a particular copy of a message by a
9057 router or transport are not accessible.
9058
9059 For incoming SMTP messages, no header lines are visible in ACLs that are obeyed
9060 before the DATA ACL, because the header structure is not set up until the
9061 message is received. Header lines that are added in a RCPT ACL (for example)
9062 are saved until the message's incoming header lines are available, at which
9063 point they are added. When a DATA ACL is running, however, header lines added
9064 by earlier ACLs are visible.
9065
9066 Upper case and lower case letters are synonymous in header names. If the
9067 following character is white space, the terminating colon may be omitted, but
9068 this is not recommended, because you may then forget it when it is needed. When
9069 white space terminates the header name, it is included in the expanded string.
9070 If the message does not contain the given header, the expansion item is
9071 replaced by an empty string. (See the &%def%& condition in section
9072 &<<SECTexpcond>>& for a means of testing for the existence of a header.)
9073
9074 If there is more than one header with the same name, they are all concatenated
9075 to form the substitution string, up to a maximum length of 64K. Unless
9076 &%rheader%& is being used, leading and trailing white space is removed from
9077 each header before concatenation, and a completely empty header is ignored. A
9078 newline character is then inserted between non-empty headers, but there is no
9079 newline at the very end. For the &%header%& and &%bheader%& expansion, for
9080 those headers that contain lists of addresses, a comma is also inserted at the
9081 junctions between headers. This does not happen for the &%rheader%& expansion.
9082
9083
9084 .vitem &*${hmac{*&<&'hashname'&>&*}{*&<&'secret'&>&*}{*&<&'string'&>&*}}*&
9085 .cindex "expansion" "hmac hashing"
9086 .cindex &%hmac%&
9087 This function uses cryptographic hashing (either MD5 or SHA-1) to convert a
9088 shared secret and some text into a message authentication code, as specified in
9089 RFC 2104. This differs from &`${md5:secret_text...}`& or
9090 &`${sha1:secret_text...}`& in that the hmac step adds a signature to the
9091 cryptographic hash, allowing for authentication that is not possible with MD5
9092 or SHA-1 alone. The hash name must expand to either &`md5`& or &`sha1`& at
9093 present. For example:
9094 .code
9095 ${hmac{md5}{somesecret}{$primary_hostname $tod_log}}
9096 .endd
9097 For the hostname &'mail.example.com'& and time 2002-10-17 11:30:59, this
9098 produces:
9099 .code
9100 dd97e3ba5d1a61b5006108f8c8252953
9101 .endd
9102 As an example of how this might be used, you might put in the main part of
9103 an Exim configuration:
9104 .code
9105 SPAMSCAN_SECRET=cohgheeLei2thahw
9106 .endd
9107 In a router or a transport you could then have:
9108 .code
9109 headers_add = \
9110   X-Spam-Scanned: ${primary_hostname} ${message_exim_id} \
9111   ${hmac{md5}{SPAMSCAN_SECRET}\
9112   {${primary_hostname},${message_exim_id},$h_message-id:}}
9113 .endd
9114 Then given a message, you can check where it was scanned by looking at the
9115 &'X-Spam-Scanned:'& header line. If you know the secret, you can check that
9116 this header line is authentic by recomputing the authentication code from the
9117 host name, message ID and the &'Message-id:'& header line. This can be done
9118 using Exim's &%-be%& option, or by other means, for example by using the
9119 &'hmac_md5_hex()'& function in Perl.
9120
9121
9122 .vitem &*${if&~*&<&'condition'&>&*&~{*&<&'string1'&>&*}{*&<&'string2'&>&*}}*&
9123 .cindex "expansion" "conditional"
9124 .cindex "&%if%&, expansion item"
9125 If <&'condition'&> is true, <&'string1'&> is expanded and replaces the whole
9126 item; otherwise <&'string2'&> is used. The available conditions are described
9127 in section &<<SECTexpcond>>& below. For example:
9128 .code
9129 ${if eq {$local_part}{postmaster} {yes}{no} }
9130 .endd
9131 The second string need not be present; if it is not and the condition is not
9132 true, the item is replaced with nothing. Alternatively, the word &"fail"& may
9133 be present instead of the second string (without any curly brackets). In this
9134 case, the expansion is forced to fail if the condition is not true (see section
9135 &<<SECTforexpfai>>&).
9136
9137 If both strings are omitted, the result is the string &`true`& if the condition
9138 is true, and the empty string if the condition is false. This makes it less
9139 cumbersome to write custom ACL and router conditions. For example, instead of
9140 .code
9141 condition = ${if >{$acl_m4}{3}{true}{false}}
9142 .endd
9143 you can use
9144 .code
9145 condition = ${if >{$acl_m4}{3}}
9146 .endd
9147
9148 .vitem &*${length{*&<&'string1'&>&*}{*&<&'string2'&>&*}}*&
9149 .cindex "expansion" "string truncation"
9150 .cindex "&%length%& expansion item"
9151 The &%length%& item is used to extract the initial portion of a string. Both
9152 strings are expanded, and the first one must yield a number, <&'n'&>, say. If
9153 you are using a fixed value for the number, that is, if <&'string1'&> does not
9154 change when expanded, you can use the simpler operator notation that avoids
9155 some of the braces:
9156 .code
9157 ${length_<n>:<string>}
9158 .endd
9159 The result of this item is either the first <&'n'&> characters or the whole
9160 of <&'string2'&>, whichever is the shorter. Do not confuse &%length%& with
9161 &%strlen%&, which gives the length of a string.
9162
9163
9164 .vitem "&*${listextract{*&<&'number'&>&*}&&&
9165         {*&<&'string1'&>&*}{*&<&'string2'&>&*}{*&<&'string3'&>&*}}*&"
9166 .cindex "expansion" "extracting list elements by number"
9167 .cindex "&%listextract%&" "extract list elements by number"
9168 .cindex "list" "extracting elements by number"
9169 The <&'number'&> argument must consist entirely of decimal digits,
9170 apart from an optional leading minus,
9171 and leading and trailing white space (which is ignored).
9172
9173 After expansion, <&'string1'&> is interpreted as a list, colon-separated by
9174 default, but the separator can be changed in the usual way.
9175
9176 The first field of the list is numbered one.
9177 If the number is negative, the fields are
9178 counted from the end of the list, with the rightmost one numbered -1.
9179 The numbered element of the list is extracted and placed in &$value$&,
9180 then <&'string2'&> is expanded as the result.
9181
9182 If the modulus of the
9183 number is zero or greater than the number of fields in the string,
9184 the result is the expansion of <&'string3'&>.
9185
9186 For example:
9187 .code
9188 ${listextract{2}{x:42:99}}
9189 .endd
9190 yields &"42"&, and
9191 .code
9192 ${listextract{-3}{<, x,42,99,& Mailer,,/bin/bash}{result: $value}}
9193 .endd
9194 yields &"result: 99"&.
9195
9196 If {<&'string3'&>} is omitted, an empty string is used for string3.
9197 If {<&'string2'&>} is also omitted, the value that was
9198 extracted is used.
9199 You can use &`fail`& instead of {<&'string3'&>} as in a string extract.
9200
9201
9202 .vitem "&*${lookup{*&<&'key'&>&*}&~*&<&'search&~type'&>&*&~&&&
9203         {*&<&'file'&>&*}&~{*&<&'string1'&>&*}&~{*&<&'string2'&>&*}}*&"
9204 This is the first of one of two different types of lookup item, which are both
9205 described in the next item.
9206
9207 .vitem "&*${lookup&~*&<&'search&~type'&>&*&~{*&<&'query'&>&*}&~&&&
9208         {*&<&'string1'&>&*}&~{*&<&'string2'&>&*}}*&"
9209 .cindex "expansion" "lookup in"
9210 .cindex "file" "lookups"
9211 .cindex "lookup" "in expanded string"
9212 The two forms of lookup item specify data lookups in files and databases, as
9213 discussed in chapter &<<CHAPfdlookup>>&. The first form is used for single-key
9214 lookups, and the second is used for query-style lookups. The <&'key'&>,
9215 <&'file'&>, and <&'query'&> strings are expanded before use.
9216
9217 If there is any white space in a lookup item which is part of a filter command,
9218 a retry or rewrite rule, a routing rule for the &(manualroute)& router, or any
9219 other place where white space is significant, the lookup item must be enclosed
9220 in double quotes. The use of data lookups in users' filter files may be locked
9221 out by the system administrator.
9222
9223 .vindex "&$value$&"
9224 If the lookup succeeds, <&'string1'&> is expanded and replaces the entire item.
9225 During its expansion, the variable &$value$& contains the data returned by the
9226 lookup. Afterwards it reverts to the value it had previously (at the outer
9227 level it is empty). If the lookup fails, <&'string2'&> is expanded and replaces
9228 the entire item. If {<&'string2'&>} is omitted, the replacement is the empty
9229 string on failure. If <&'string2'&> is provided, it can itself be a nested
9230 lookup, thus providing a mechanism for looking up a default value when the
9231 original lookup fails.
9232
9233 If a nested lookup is used as part of <&'string1'&>, &$value$& contains the
9234 data for the outer lookup while the parameters of the second lookup are
9235 expanded, and also while <&'string2'&> of the second lookup is expanded, should
9236 the second lookup fail. Instead of {<&'string2'&>} the word &"fail"& can
9237 appear, and in this case, if the lookup fails, the entire expansion is forced
9238 to fail (see section &<<SECTforexpfai>>&). If both {<&'string1'&>} and
9239 {<&'string2'&>} are omitted, the result is the looked up value in the case of a
9240 successful lookup, and nothing in the case of failure.
9241
9242 For single-key lookups, the string &"partial"& is permitted to precede the
9243 search type in order to do partial matching, and * or *@ may follow a search
9244 type to request default lookups if the key does not match (see sections
9245 &<<SECTdefaultvaluelookups>>& and &<<SECTpartiallookup>>& for details).
9246
9247 .cindex "numerical variables (&$1$& &$2$& etc)" "in lookup expansion"
9248 If a partial search is used, the variables &$1$& and &$2$& contain the wild
9249 and non-wild parts of the key during the expansion of the replacement text.
9250 They return to their previous values at the end of the lookup item.
9251
9252 This example looks up the postmaster alias in the conventional alias file:
9253 .code
9254 ${lookup {postmaster} lsearch {/etc/aliases} {$value}}
9255 .endd
9256 This example uses NIS+ to look up the full name of the user corresponding to
9257 the local part of an address, forcing the expansion to fail if it is not found:
9258 .code
9259 ${lookup nisplus {[name=$local_part],passwd.org_dir:gcos} \
9260   {$value}fail}
9261 .endd
9262
9263
9264 .vitem &*${map{*&<&'string1'&>&*}{*&<&'string2'&>&*}}*&
9265 .cindex "expansion" "list creation"
9266 .vindex "&$item$&"
9267 After expansion, <&'string1'&> is interpreted as a list, colon-separated by
9268 default, but the separator can be changed in the usual way. For each item
9269 in this list, its value is place in &$item$&, and then <&'string2'&> is
9270 expanded and added to the output as an item in a new list. The separator used
9271 for the output list is the same as the one used for the input, but a separator
9272 setting is not included in the output. For example:
9273 .code
9274 ${map{a:b:c}{[$item]}} ${map{<- x-y-z}{($item)}}
9275 .endd
9276 expands to &`[a]:[b]:[c] (x)-(y)-(z)`&. At the end of the expansion, the
9277 value of &$item$& is restored to what it was before. See also the &*filter*&
9278 and &*reduce*& expansion items.
9279
9280 .vitem &*${nhash{*&<&'string1'&>&*}{*&<&'string2'&>&*}{*&<&'string3'&>&*}}*&
9281 .cindex "expansion" "numeric hash"
9282 .cindex "hash function" "numeric"
9283 The three strings are expanded; the first two must yield numbers. Call them
9284 <&'n'&> and <&'m'&>. If you are using fixed values for these numbers, that is,
9285 if <&'string1'&> and <&'string2'&> do not change when they are expanded, you
9286 can use the simpler operator notation that avoids some of the braces:
9287 .code
9288 ${nhash_<n>_<m>:<string>}
9289 .endd
9290 The second number is optional (in both notations). If there is only one number,
9291 the result is a number in the range 0&--<&'n'&>-1. Otherwise, the string is
9292 processed by a div/mod hash function that returns two numbers, separated by a
9293 slash, in the ranges 0 to <&'n'&>-1 and 0 to <&'m'&>-1, respectively. For
9294 example,
9295 .code
9296 ${nhash{8}{64}{supercalifragilisticexpialidocious}}
9297 .endd
9298 returns the string &"6/33"&.
9299
9300
9301
9302 .vitem &*${perl{*&<&'subroutine'&>&*}{*&<&'arg'&>&*}{*&<&'arg'&>&*}...}*&
9303 .cindex "Perl" "use in expanded string"
9304 .cindex "expansion" "calling Perl from"
9305 This item is available only if Exim has been built to include an embedded Perl
9306 interpreter. The subroutine name and the arguments are first separately
9307 expanded, and then the Perl subroutine is called with those arguments. No
9308 additional arguments need be given; the maximum number permitted, including the
9309 name of the subroutine, is nine.
9310
9311 The return value of the subroutine is inserted into the expanded string, unless
9312 the return value is &%undef%&. In that case, the expansion fails in the same
9313 way as an explicit &"fail"& on a lookup item. The return value is a scalar.
9314 Whatever you return is evaluated in a scalar context. For example, if you
9315 return the name of a Perl vector, the return value is the size of the vector,
9316 not its contents.
9317
9318 If the subroutine exits by calling Perl's &%die%& function, the expansion fails
9319 with the error message that was passed to &%die%&. More details of the embedded
9320 Perl facility are given in chapter &<<CHAPperl>>&.
9321
9322 The &(redirect)& router has an option called &%forbid_filter_perl%& which locks
9323 out the use of this expansion item in filter files.
9324
9325
9326 .vitem &*${prvs{*&<&'address'&>&*}{*&<&'secret'&>&*}{*&<&'keynumber'&>&*}}*&
9327 .cindex "&%prvs%& expansion item"
9328 The first argument is a complete email address and the second is secret
9329 keystring. The third argument, specifying a key number, is optional. If absent,
9330 it defaults to 0. The result of the expansion is a prvs-signed email address,
9331 to be typically used with the &%return_path%& option on an &(smtp)& transport
9332 as part of a bounce address tag validation (BATV) scheme. For more discussion
9333 and an example, see section &<<SECTverifyPRVS>>&.
9334
9335 .vitem "&*${prvscheck{*&<&'address'&>&*}{*&<&'secret'&>&*}&&&
9336         {*&<&'string'&>&*}}*&"
9337 .cindex "&%prvscheck%& expansion item"
9338 This expansion item is the complement of the &%prvs%& item. It is used for
9339 checking prvs-signed addresses. If the expansion of the first argument does not
9340 yield a syntactically valid prvs-signed address, the whole item expands to the
9341 empty string. When the first argument does expand to a syntactically valid
9342 prvs-signed address, the second argument is expanded, with the prvs-decoded
9343 version of the address and the key number extracted from the address in the
9344 variables &$prvscheck_address$& and &$prvscheck_keynum$&, respectively.
9345
9346 These two variables can be used in the expansion of the second argument to
9347 retrieve the secret. The validity of the prvs-signed address is then checked
9348 against the secret. The result is stored in the variable &$prvscheck_result$&,
9349 which is empty for failure or &"1"& for success.
9350
9351 The third argument is optional; if it is missing, it defaults to an empty
9352 string. This argument is now expanded. If the result is an empty string, the
9353 result of the expansion is the decoded version of the address. This is the case
9354 whether or not the signature was valid. Otherwise, the result of the expansion
9355 is the expansion of the third argument.
9356
9357 All three variables can be used in the expansion of the third argument.
9358 However, once the expansion is complete, only &$prvscheck_result$& remains set.
9359 For more discussion and an example, see section &<<SECTverifyPRVS>>&.
9360
9361 .vitem &*${readfile{*&<&'file&~name'&>&*}{*&<&'eol&~string'&>&*}}*&
9362 .cindex "expansion" "inserting an entire file"
9363 .cindex "file" "inserting into expansion"
9364 .cindex "&%readfile%& expansion item"
9365 The file name and end-of-line string are first expanded separately. The file is
9366 then read, and its contents replace the entire item. All newline characters in
9367 the file are replaced by the end-of-line string if it is present. Otherwise,
9368 newlines are left in the string.
9369 String expansion is not applied to the contents of the file. If you want this,
9370 you must wrap the item in an &%expand%& operator. If the file cannot be read,
9371 the string expansion fails.
9372
9373 The &(redirect)& router has an option called &%forbid_filter_readfile%& which
9374 locks out the use of this expansion item in filter files.
9375
9376
9377
9378 .vitem "&*${readsocket{*&<&'name'&>&*}{*&<&'request'&>&*}&&&
9379         {*&<&'timeout'&>&*}{*&<&'eol&~string'&>&*}{*&<&'fail&~string'&>&*}}*&"
9380 .cindex "expansion" "inserting from a socket"
9381 .cindex "socket, use of in expansion"
9382 .cindex "&%readsocket%& expansion item"
9383 This item inserts data from a Unix domain or Internet socket into the expanded
9384 string. The minimal way of using it uses just two arguments, as in these
9385 examples:
9386 .code
9387 ${readsocket{/socket/name}{request string}}
9388 ${readsocket{inet:some.host:1234}{request string}}
9389 .endd
9390 For a Unix domain socket, the first substring must be the path to the socket.
9391 For an Internet socket, the first substring must contain &`inet:`& followed by
9392 a host name or IP address, followed by a colon and a port, which can be a
9393 number or the name of a TCP port in &_/etc/services_&. An IP address may
9394 optionally be enclosed in square brackets. This is best for IPv6 addresses. For
9395 example:
9396 .code
9397 ${readsocket{inet:[::1]:1234}{request string}}
9398 .endd
9399 Only a single host name may be given, but if looking it up yields more than
9400 one IP address, they are each tried in turn until a connection is made. For
9401 both kinds of socket, Exim makes a connection, writes the request string
9402 (unless it is an empty string) and reads from the socket until an end-of-file
9403 is read. A timeout of 5 seconds is applied. Additional, optional arguments
9404 extend what can be done. Firstly, you can vary the timeout. For example:
9405 .code
9406 ${readsocket{/socket/name}{request string}{3s}}
9407 .endd
9408 A fourth argument allows you to change any newlines that are in the data
9409 that is read, in the same way as for &%readfile%& (see above). This example
9410 turns them into spaces:
9411 .code
9412 ${readsocket{inet:127.0.0.1:3294}{request string}{3s}{ }}
9413 .endd
9414 As with all expansions, the substrings are expanded before the processing
9415 happens. Errors in these sub-expansions cause the expansion to fail. In
9416 addition, the following errors can occur:
9417
9418 .ilist
9419 Failure to create a socket file descriptor;
9420 .next
9421 Failure to connect the socket;
9422 .next
9423 Failure to write the request string;
9424 .next
9425 Timeout on reading from the socket.
9426 .endlist
9427
9428 By default, any of these errors causes the expansion to fail. However, if
9429 you supply a fifth substring, it is expanded and used when any of the above
9430 errors occurs. For example:
9431 .code
9432 ${readsocket{/socket/name}{request string}{3s}{\n}\
9433   {socket failure}}
9434 .endd
9435 You can test for the existence of a Unix domain socket by wrapping this
9436 expansion in &`${if exists`&, but there is a race condition between that test
9437 and the actual opening of the socket, so it is safer to use the fifth argument
9438 if you want to be absolutely sure of avoiding an expansion error for a
9439 non-existent Unix domain socket, or a failure to connect to an Internet socket.
9440
9441 The &(redirect)& router has an option called &%forbid_filter_readsocket%& which
9442 locks out the use of this expansion item in filter files.
9443
9444
9445 .vitem &*${reduce{*&<&'string1'&>}{<&'string2'&>&*}{*&<&'string3'&>&*}}*&
9446 .cindex "expansion" "reducing a list to a scalar"
9447 .cindex "list" "reducing to a scalar"
9448 .vindex "&$value$&"
9449 .vindex "&$item$&"
9450 This operation reduces a list to a single, scalar string. After expansion,
9451 <&'string1'&> is interpreted as a list, colon-separated by default, but the
9452 separator can be changed in the usual way. Then <&'string2'&> is expanded and
9453 assigned to the &$value$& variable. After this, each item in the <&'string1'&>
9454 list is assigned to &$item$& in turn, and <&'string3'&> is expanded for each of
9455 them. The result of that expansion is assigned to &$value$& before the next
9456 iteration. When the end of the list is reached, the final value of &$value$& is
9457 added to the expansion output. The &*reduce*& expansion item can be used in a
9458 number of ways. For example, to add up a list of numbers:
9459 .code
9460 ${reduce {<, 1,2,3}{0}{${eval:$value+$item}}}
9461 .endd
9462 The result of that expansion would be &`6`&. The maximum of a list of numbers
9463 can be found:
9464 .code
9465 ${reduce {3:0:9:4:6}{0}{${if >{$item}{$value}{$item}{$value}}}}
9466 .endd
9467 At the end of a &*reduce*& expansion, the values of &$item$& and &$value$& are
9468 restored to what they were before. See also the &*filter*& and &*map*&
9469 expansion items.
9470
9471 .vitem &*$rheader_*&<&'header&~name'&>&*:*&&~or&~&*$rh_*&<&'header&~name'&>&*:*&
9472 This item inserts &"raw"& header lines. It is described with the &%header%&
9473 expansion item above.
9474
9475 .vitem "&*${run{*&<&'command'&>&*&~*&<&'args'&>&*}{*&<&'string1'&>&*}&&&
9476         {*&<&'string2'&>&*}}*&"
9477 .cindex "expansion" "running a command"
9478 .cindex "&%run%& expansion item"
9479 The command and its arguments are first expanded separately, and then the
9480 command is run in a separate process, but under the same uid and gid. As in
9481 other command executions from Exim, a shell is not used by default. If you want
9482 a shell, you must explicitly code it.
9483
9484 The standard input for the command exists, but is empty. The standard output
9485 and standard error are set to the same file descriptor.
9486 .cindex "return code" "from &%run%& expansion"
9487 .vindex "&$value$&"
9488 If the command succeeds (gives a zero return code) <&'string1'&> is expanded
9489 and replaces the entire item; during this expansion, the standard output/error
9490 from the command is in the variable &$value$&. If the command fails,
9491 <&'string2'&>, if present, is expanded and used. Once again, during the
9492 expansion, the standard output/error from the command is in the variable
9493 &$value$&.
9494
9495 If <&'string2'&> is absent, the result is empty. Alternatively, <&'string2'&>
9496 can be the word &"fail"& (not in braces) to force expansion failure if the
9497 command does not succeed. If both strings are omitted, the result is contents
9498 of the standard output/error on success, and nothing on failure.
9499
9500 .vindex "&$run_in_acl$&"
9501 The standard output/error of the command is put in the variable &$value$&.
9502 In this ACL example, the output of a command is logged for the admin to
9503 troubleshoot:
9504 .code
9505 warn  condition    = ${run{/usr/bin/id}{yes}{no}}
9506       log_message  = Output of id: $value
9507 .endd
9508 If the command requires shell idioms, such as the > redirect operator, the
9509 shell must be invoked directly, such as with:
9510 .code
9511 ${run{/bin/bash -c "/usr/bin/id >/tmp/id"}{yes}{yes}}
9512 .endd
9513
9514 .vindex "&$runrc$&"
9515 The return code from the command is put in the variable &$runrc$&, and this
9516 remains set afterwards, so in a filter file you can do things like this:
9517 .code
9518 if "${run{x y z}{}}$runrc" is 1 then ...
9519   elif $runrc is 2 then ...
9520   ...
9521 endif
9522 .endd
9523 If execution of the command fails (for example, the command does not exist),
9524 the return code is 127 &-- the same code that shells use for non-existent
9525 commands.
9526
9527 &*Warning*&: In a router or transport, you cannot assume the order in which
9528 option values are expanded, except for those preconditions whose order of
9529 testing is documented. Therefore, you cannot reliably expect to set &$runrc$&
9530 by the expansion of one option, and use it in another.
9531
9532 The &(redirect)& router has an option called &%forbid_filter_run%& which locks
9533 out the use of this expansion item in filter files.
9534
9535
9536 .vitem &*${sg{*&<&'subject'&>&*}{*&<&'regex'&>&*}{*&<&'replacement'&>&*}}*&
9537 .cindex "expansion" "string substitution"
9538 .cindex "&%sg%& expansion item"
9539 This item works like Perl's substitution operator (s) with the global (/g)
9540 option; hence its name. However, unlike the Perl equivalent, Exim does not
9541 modify the subject string; instead it returns the modified string for insertion
9542 into the overall expansion. The item takes three arguments: the subject string,
9543 a regular expression, and a substitution string. For example:
9544 .code
9545 ${sg{abcdefabcdef}{abc}{xyz}}
9546 .endd
9547 yields &"xyzdefxyzdef"&. Because all three arguments are expanded before use,
9548 if any $ or \ characters are required in the regular expression or in the
9549 substitution string, they have to be escaped. For example:
9550 .code
9551 ${sg{abcdef}{^(...)(...)\$}{\$2\$1}}
9552 .endd
9553 yields &"defabc"&, and
9554 .code
9555 ${sg{1=A 4=D 3=C}{\N(\d+)=\N}{K\$1=}}
9556 .endd
9557 yields &"K1=A K4=D K3=C"&. Note the use of &`\N`& to protect the contents of
9558 the regular expression from string expansion.
9559
9560
9561
9562 .vitem &*${substr{*&<&'string1'&>&*}{*&<&'string2'&>&*}{*&<&'string3'&>&*}}*&
9563 .cindex "&%substr%& expansion item"
9564 .cindex "substring extraction"
9565 .cindex "expansion" "substring extraction"
9566 The three strings are expanded; the first two must yield numbers. Call them
9567 <&'n'&> and <&'m'&>. If you are using fixed values for these numbers, that is,
9568 if <&'string1'&> and <&'string2'&> do not change when they are expanded, you
9569 can use the simpler operator notation that avoids some of the braces:
9570 .code
9571 ${substr_<n>_<m>:<string>}
9572 .endd
9573 The second number is optional (in both notations).
9574 If it is absent in the simpler format, the preceding underscore must also be
9575 omitted.
9576
9577 The &%substr%& item can be used to extract more general substrings than
9578 &%length%&. The first number, <&'n'&>, is a starting offset, and <&'m'&> is the
9579 length required. For example
9580 .code
9581 ${substr{3}{2}{$local_part}}
9582 .endd
9583 If the starting offset is greater than the string length the result is the
9584 null string; if the length plus starting offset is greater than the string
9585 length, the result is the right-hand part of the string, starting from the
9586 given offset. The first character in the string has offset zero.
9587
9588 The &%substr%& expansion item can take negative offset values to count
9589 from the right-hand end of its operand. The last character is offset -1, the
9590 second-last is offset -2, and so on. Thus, for example,
9591 .code
9592 ${substr{-5}{2}{1234567}}
9593 .endd
9594 yields &"34"&. If the absolute value of a negative offset is greater than the
9595 length of the string, the substring starts at the beginning of the string, and
9596 the length is reduced by the amount of overshoot. Thus, for example,
9597 .code
9598 ${substr{-5}{2}{12}}
9599 .endd
9600 yields an empty string, but
9601 .code
9602 ${substr{-3}{2}{12}}
9603 .endd
9604 yields &"1"&.
9605
9606 When the second number is omitted from &%substr%&, the remainder of the string
9607 is taken if the offset is positive. If it is negative, all characters in the
9608 string preceding the offset point are taken. For example, an offset of -1 and
9609 no length, as in these semantically identical examples:
9610 .code
9611 ${substr_-1:abcde}
9612 ${substr{-1}{abcde}}
9613 .endd
9614 yields all but the last character of the string, that is, &"abcd"&.
9615
9616
9617
9618 .vitem "&*${tr{*&<&'subject'&>&*}{*&<&'characters'&>&*}&&&
9619         {*&<&'replacements'&>&*}}*&"
9620 .cindex "expansion" "character translation"
9621 .cindex "&%tr%& expansion item"
9622 This item does single-character translation on its subject string. The second
9623 argument is a list of characters to be translated in the subject string. Each
9624 matching character is replaced by the corresponding character from the
9625 replacement list. For example
9626 .code
9627 ${tr{abcdea}{ac}{13}}
9628 .endd
9629 yields &`1b3de1`&. If there are duplicates in the second character string, the
9630 last occurrence is used. If the third string is shorter than the second, its
9631 last character is replicated. However, if it is empty, no translation takes
9632 place.
9633 .endlist
9634
9635
9636
9637 .section "Expansion operators" "SECTexpop"
9638 .cindex "expansion" "operators"
9639 For expansion items that perform transformations on a single argument string,
9640 the &"operator"& notation is used because it is simpler and uses fewer braces.
9641 The substring is first expanded before the operation is applied to it. The
9642 following operations can be performed:
9643
9644 .vlist
9645 .vitem &*${address:*&<&'string'&>&*}*&
9646 .cindex "expansion" "RFC 2822 address handling"
9647 .cindex "&%address%& expansion item"
9648 The string is interpreted as an RFC 2822 address, as it might appear in a
9649 header line, and the effective address is extracted from it. If the string does
9650 not parse successfully, the result is empty.
9651
9652
9653 .vitem &*${addresses:*&<&'string'&>&*}*&
9654 .cindex "expansion" "RFC 2822 address handling"
9655 .cindex "&%addresses%& expansion item"
9656 The string (after expansion) is interpreted as a list of addresses in RFC
9657 2822 format, such as can be found in a &'To:'& or &'Cc:'& header line. The
9658 operative address (&'local-part@domain'&) is extracted from each item, and the
9659 result of the expansion is a colon-separated list, with appropriate
9660 doubling of colons should any happen to be present in the email addresses.
9661 Syntactically invalid RFC2822 address items are omitted from the output.
9662
9663 It is possible to specify a character other than colon for the output
9664 separator by starting the string with > followed by the new separator
9665 character. For example:
9666 .code
9667 ${addresses:>& Chief <ceo@up.stairs>, sec@base.ment (dogsbody)}
9668 .endd
9669 expands to &`ceo@up.stairs&&sec@base.ment`&. Compare the &*address*& (singular)
9670 expansion item, which extracts the working address from a single RFC2822
9671 address. See the &*filter*&, &*map*&, and &*reduce*& items for ways of
9672 processing lists.
9673
9674 To clarify "list of addresses in RFC 2822 format" mentioned above, Exim follows
9675 a strict interpretation of header line formatting.  Exim parses the bare,
9676 unquoted portion of an email address and if it finds a comma, treats it as an
9677 email address seperator. For the example header line:
9678 .code
9679 From: =?iso-8859-2?Q?Last=2C_First?= <user@example.com>
9680 .endd
9681 The first example below demonstrates that Q-encoded email addresses are parsed
9682 properly if it is given the raw header (in this example, &`$rheader_from:`&).
9683 It does not see the comma because it's still encoded as "=2C".  The second
9684 example below is passed the contents of &`$header_from:`&, meaning it gets
9685 de-mimed. Exim sees the decoded "," so it treats it as &*two*& email addresses.
9686 The third example shows that the presence of a comma is skipped when it is
9687 quoted.
9688 .code
9689 # exim -be '${addresses:From: \
9690 =?iso-8859-2?Q?Last=2C_First?= <user@example.com>}'
9691 user@example.com
9692 # exim -be '${addresses:From: Last, First <user@example.com>}'
9693 Last:user@example.com
9694 # exim -be '${addresses:From: "Last, First" <user@example.com>}'
9695 user@example.com
9696 .endd
9697
9698 .vitem &*${base62:*&<&'digits'&>&*}*&
9699 .cindex "&%base62%& expansion item"
9700 .cindex "expansion" "conversion to base 62"
9701 The string must consist entirely of decimal digits. The number is converted to
9702 base 62 and output as a string of six characters, including leading zeros. In
9703 the few operating environments where Exim uses base 36 instead of base 62 for
9704 its message identifiers (because those systems do not have case-sensitive file
9705 names), base 36 is used by this operator, despite its name. &*Note*&: Just to
9706 be absolutely clear: this is &'not'& base64 encoding.
9707
9708 .vitem &*${base62d:*&<&'base-62&~digits'&>&*}*&
9709 .cindex "&%base62d%& expansion item"
9710 .cindex "expansion" "conversion to base 62"
9711 The string must consist entirely of base-62 digits, or, in operating
9712 environments where Exim uses base 36 instead of base 62 for its message
9713 identifiers, base-36 digits. The number is converted to decimal and output as a
9714 string.
9715
9716
9717 .vitem &*${domain:*&<&'string'&>&*}*&
9718 .cindex "domain" "extraction"
9719 .cindex "expansion" "domain extraction"
9720 The string is interpreted as an RFC 2822 address and the domain is extracted
9721 from it. If the string does not parse successfully, the result is empty.
9722
9723
9724 .vitem &*${escape:*&<&'string'&>&*}*&
9725 .cindex "expansion" "escaping non-printing characters"
9726 .cindex "&%escape%& expansion item"
9727 If the string contains any non-printing characters, they are converted to
9728 escape sequences starting with a backslash. Whether characters with the most
9729 significant bit set (so-called &"8-bit characters"&) count as printing or not
9730 is controlled by the &%print_topbitchars%& option.
9731
9732
9733 .vitem &*${eval:*&<&'string'&>&*}*&&~and&~&*${eval10:*&<&'string'&>&*}*&
9734 .cindex "expansion" "expression evaluation"
9735 .cindex "expansion" "arithmetic expression"
9736 .cindex "&%eval%& expansion item"
9737 These items supports simple arithmetic and bitwise logical operations in
9738 expansion strings. The string (after expansion) must be a conventional
9739 arithmetic expression, but it is limited to basic arithmetic operators, bitwise
9740 logical operators, and parentheses. All operations are carried out using
9741 integer arithmetic. The operator priorities are as follows (the same as in the
9742 C programming language):
9743 .table2 70pt 300pt
9744 .irow &'highest:'& "not (~), negate (-)"
9745 .irow ""   "multiply (*), divide (/), remainder (%)"
9746 .irow ""   "plus (+), minus (-)"
9747 .irow ""   "shift-left (<<), shift-right (>>)"
9748 .irow ""   "and (&&)"
9749 .irow ""   "xor (^)"
9750 .irow &'lowest:'&  "or (|)"
9751 .endtable
9752 Binary operators with the same priority are evaluated from left to right. White
9753 space is permitted before or after operators.
9754
9755 For &%eval%&, numbers may be decimal, octal (starting with &"0"&) or
9756 hexadecimal (starting with &"0x"&). For &%eval10%&, all numbers are taken as
9757 decimal, even if they start with a leading zero; hexadecimal numbers are not
9758 permitted. This can be useful when processing numbers extracted from dates or
9759 times, which often do have leading zeros.
9760
9761 A number may be followed by &"K"&, &"M"& or &"G"& to multiply it by 1024, 1024*1024
9762 or 1024*1024*1024,
9763 respectively. Negative numbers are supported. The result of the computation is
9764 a decimal representation of the answer (without &"K"&, &"M"& or &"G"&). For example:
9765
9766 .display
9767 &`${eval:1+1}            `&  yields 2
9768 &`${eval:1+2*3}          `&  yields 7
9769 &`${eval:(1+2)*3}        `&  yields 9
9770 &`${eval:2+42%5}         `&  yields 4
9771 &`${eval:0xc&amp;5}          `&  yields 4
9772 &`${eval:0xc|5}          `&  yields 13
9773 &`${eval:0xc^5}          `&  yields 9
9774 &`${eval:0xc>>1}         `&  yields 6
9775 &`${eval:0xc<<1}         `&  yields 24
9776 &`${eval:~255&amp;0x1234}    `&  yields 4608
9777 &`${eval:-(~255&amp;0x1234)} `&  yields -4608
9778 .endd
9779
9780 As a more realistic example, in an ACL you might have
9781 .code
9782 deny   message = Too many bad recipients
9783        condition =                    \
9784          ${if and {                   \
9785            {>{$rcpt_count}{10}}       \
9786            {                          \
9787            <                          \
9788              {$recipients_count}      \
9789              {${eval:$rcpt_count/2}}  \
9790            }                          \
9791          }{yes}{no}}
9792 .endd
9793 The condition is true if there have been more than 10 RCPT commands and
9794 fewer than half of them have resulted in a valid recipient.
9795
9796
9797 .vitem &*${expand:*&<&'string'&>&*}*&
9798 .cindex "expansion" "re-expansion of substring"
9799 The &%expand%& operator causes a string to be expanded for a second time. For
9800 example,
9801 .code
9802 ${expand:${lookup{$domain}dbm{/some/file}{$value}}}
9803 .endd
9804 first looks up a string in a file while expanding the operand for &%expand%&,
9805 and then re-expands what it has found.
9806
9807
9808 .vitem &*${from_utf8:*&<&'string'&>&*}*&
9809 .cindex "Unicode"
9810 .cindex "UTF-8" "conversion from"
9811 .cindex "expansion" "UTF-8 conversion"
9812 .cindex "&%from_utf8%& expansion item"
9813 The world is slowly moving towards Unicode, although there are no standards for
9814 email yet. However, other applications (including some databases) are starting
9815 to store data in Unicode, using UTF-8 encoding. This operator converts from a
9816 UTF-8 string to an ISO-8859-1 string. UTF-8 code values greater than 255 are
9817 converted to underscores. The input must be a valid UTF-8 string. If it is not,
9818 the result is an undefined sequence of bytes.
9819
9820 Unicode code points with values less than 256 are compatible with ASCII and
9821 ISO-8859-1 (also known as Latin-1).
9822 For example, character 169 is the copyright symbol in both cases, though the
9823 way it is encoded is different. In UTF-8, more than one byte is needed for
9824 characters with code values greater than 127, whereas ISO-8859-1 is a
9825 single-byte encoding (but thereby limited to 256 characters). This makes
9826 translation from UTF-8 to ISO-8859-1 straightforward.
9827
9828
9829 .vitem &*${hash_*&<&'n'&>&*_*&<&'m'&>&*:*&<&'string'&>&*}*&
9830 .cindex "hash function" "textual"
9831 .cindex "expansion" "textual hash"
9832 The &%hash%& operator is a simpler interface to the hashing function that can
9833 be used when the two parameters are fixed numbers (as opposed to strings that
9834 change when expanded). The effect is the same as
9835 .code
9836 ${hash{<n>}{<m>}{<string>}}
9837 .endd
9838 See the description of the general &%hash%& item above for details. The
9839 abbreviation &%h%& can be used when &%hash%& is used as an operator.
9840
9841
9842
9843 .vitem &*${hex2b64:*&<&'hexstring'&>&*}*&
9844 .cindex "base64 encoding" "conversion from hex"
9845 .cindex "expansion" "hex to base64"
9846 .cindex "&%hex2b64%& expansion item"
9847 This operator converts a hex string into one that is base64 encoded. This can
9848 be useful for processing the output of the MD5 and SHA-1 hashing functions.
9849
9850
9851
9852 .vitem &*${hexquote:*&<&'string'&>&*}*&
9853 .cindex "quoting" "hex-encoded unprintable characters"
9854 .cindex "&%hexquote%& expansion item"
9855 This operator converts non-printable characters in a string into a hex
9856 escape form. Byte values between 33 (!) and 126 (~) inclusive are left
9857 as is, and other byte values are converted to &`\xNN`&, for example a
9858 byte value 127 is converted to &`\x7f`&.
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 .vitem &*${listcount:*&<&'string'&>&*}*&
9887 .cindex "expansion" "list item count"
9888 .cindex "list" "item count"
9889 .cindex "list" "count of items"
9890 .cindex "&%listcount%& expansion item"
9891 The string is interpreted as a list and the number of items is returned.
9892
9893
9894 .vitem &*${listnamed:*&<&'name'&>&*}*&&~and&~&*${listnamed_*&<&'type'&>&*:*&<&'name'&>&*}*&
9895 .cindex "expansion" "named list"
9896 .cindex "&%listnamed%& expansion item"
9897 The name is interpreted as a named list and the content of the list is returned,
9898 expanding any referenced lists, re-quoting as needed for colon-separation.
9899 If the optional type is given it must be one of "a", "d", "h" or "l"
9900 and selects address-, domain-, host- or localpart- lists to search among respectively.
9901 Otherwise all types are searched in an undefined order and the first
9902 matching list is returned.
9903
9904
9905 .vitem &*${local_part:*&<&'string'&>&*}*&
9906 .cindex "expansion" "local part extraction"
9907 .cindex "&%local_part%& expansion item"
9908 The string is interpreted as an RFC 2822 address and the local part is
9909 extracted from it. If the string does not parse successfully, the result is
9910 empty.
9911
9912
9913 .vitem &*${mask:*&<&'IP&~address'&>&*/*&<&'bit&~count'&>&*}*&
9914 .cindex "masked IP address"
9915 .cindex "IP address" "masking"
9916 .cindex "CIDR notation"
9917 .cindex "expansion" "IP address masking"
9918 .cindex "&%mask%& expansion item"
9919 If the form of the string to be operated on is not an IP address followed by a
9920 slash and an integer (that is, a network address in CIDR notation), the
9921 expansion fails. Otherwise, this operator converts the IP address to binary,
9922 masks off the least significant bits according to the bit count, and converts
9923 the result back to text, with mask appended. For example,
9924 .code
9925 ${mask:10.111.131.206/28}
9926 .endd
9927 returns the string &"10.111.131.192/28"&. Since this operation is expected to
9928 be mostly used for looking up masked addresses in files, the result for an IPv6
9929 address uses dots to separate components instead of colons, because colon
9930 terminates a key string in lsearch files. So, for example,
9931 .code
9932 ${mask:3ffe:ffff:836f:0a00:000a:0800:200a:c031/99}
9933 .endd
9934 returns the string
9935 .code
9936 3ffe.ffff.836f.0a00.000a.0800.2000.0000/99
9937 .endd
9938 Letters in IPv6 addresses are always output in lower case.
9939
9940
9941 .vitem &*${md5:*&<&'string'&>&*}*&
9942 .cindex "MD5 hash"
9943 .cindex "expansion" "MD5 hash"
9944 .cindex "&%md5%& expansion item"
9945 The &%md5%& operator computes the MD5 hash value of the string, and returns it
9946 as a 32-digit hexadecimal number, in which any letters are in lower case.
9947
9948
9949 .vitem &*${nhash_*&<&'n'&>&*_*&<&'m'&>&*:*&<&'string'&>&*}*&
9950 .cindex "expansion" "numeric hash"
9951 .cindex "hash function" "numeric"
9952 The &%nhash%& operator is a simpler interface to the numeric hashing function
9953 that can be used when the two parameters are fixed numbers (as opposed to
9954 strings that change when expanded). The effect is the same as
9955 .code
9956 ${nhash{<n>}{<m>}{<string>}}
9957 .endd
9958 See the description of the general &%nhash%& item above for details.
9959
9960
9961 .vitem &*${quote:*&<&'string'&>&*}*&
9962 .cindex "quoting" "in string expansions"
9963 .cindex "expansion" "quoting"
9964 .cindex "&%quote%& expansion item"
9965 The &%quote%& operator puts its argument into double quotes if it
9966 is an empty string or
9967 contains anything other than letters, digits, underscores, dots, and hyphens.
9968 Any occurrences of double quotes and backslashes are escaped with a backslash.
9969 Newlines and carriage returns are converted to &`\n`& and &`\r`&,
9970 respectively For example,
9971 .code
9972 ${quote:ab"*"cd}
9973 .endd
9974 becomes
9975 .code
9976 "ab\"*\"cd"
9977 .endd
9978 The place where this is useful is when the argument is a substitution from a
9979 variable or a message header.
9980
9981 .vitem &*${quote_local_part:*&<&'string'&>&*}*&
9982 .cindex "&%quote_local_part%& expansion item"
9983 This operator is like &%quote%&, except that it quotes the string only if
9984 required to do so by the rules of RFC 2822 for quoting local parts. For
9985 example, a plus sign would not cause quoting (but it would for &%quote%&).
9986 If you are creating a new email address from the contents of &$local_part$&
9987 (or any other unknown data), you should always use this operator.
9988
9989
9990 .vitem &*${quote_*&<&'lookup-type'&>&*:*&<&'string'&>&*}*&
9991 .cindex "quoting" "lookup-specific"
9992 This operator applies lookup-specific quoting rules to the string. Each
9993 query-style lookup type has its own quoting rules which are described with
9994 the lookups in chapter &<<CHAPfdlookup>>&. For example,
9995 .code
9996 ${quote_ldap:two * two}
9997 .endd
9998 returns
9999 .code
10000 two%20%5C2A%20two
10001 .endd
10002 For single-key lookup types, no quoting is ever necessary and this operator
10003 yields an unchanged string.
10004
10005
10006 .vitem &*${randint:*&<&'n'&>&*}*&
10007 .cindex "random number"
10008 This operator returns a somewhat random number which is less than the
10009 supplied number and is at least 0.  The quality of this randomness depends
10010 on how Exim was built; the values are not suitable for keying material.
10011 If Exim is linked against OpenSSL then RAND_pseudo_bytes() is used.
10012 If Exim is linked against GnuTLS then gnutls_rnd(GNUTLS_RND_NONCE) is used,
10013 for versions of GnuTLS with that function.
10014 Otherwise, the implementation may be arc4random(), random() seeded by
10015 srandomdev() or srandom(), or a custom implementation even weaker than
10016 random().
10017
10018
10019 .vitem &*${reverse_ip:*&<&'ipaddr'&>&*}*&
10020 .cindex "expansion" "IP address"
10021 This operator reverses an IP address; for IPv4 addresses, the result is in
10022 dotted-quad decimal form, while for IPv6 addreses the result is in
10023 dotted-nibble hexadecimal form.  In both cases, this is the "natural" form
10024 for DNS.  For example,
10025 .code
10026 ${reverse_ip:192.0.2.4}
10027 ${reverse_ip:2001:0db8:c42:9:1:abcd:192.0.2.127}
10028 .endd
10029 returns
10030 .code
10031 4.2.0.192
10032 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
10033 .endd
10034
10035
10036 .vitem &*${rfc2047:*&<&'string'&>&*}*&
10037 .cindex "expansion" "RFC 2047"
10038 .cindex "RFC 2047" "expansion operator"
10039 .cindex "&%rfc2047%& expansion item"
10040 This operator encodes text according to the rules of RFC 2047. This is an
10041 encoding that is used in header lines to encode non-ASCII characters. It is
10042 assumed that the input string is in the encoding specified by the
10043 &%headers_charset%& option, which defaults to ISO-8859-1. If the string
10044 contains only characters in the range 33&--126, and no instances of the
10045 characters
10046 .code
10047 ? = ( ) < > @ , ; : \ " . [ ] _
10048 .endd
10049 it is not modified. Otherwise, the result is the RFC 2047 encoding of the
10050 string, using as many &"encoded words"& as necessary to encode all the
10051 characters.
10052
10053
10054 .vitem &*${rfc2047d:*&<&'string'&>&*}*&
10055 .cindex "expansion" "RFC 2047"
10056 .cindex "RFC 2047" "decoding"
10057 .cindex "&%rfc2047d%& expansion item"
10058 This operator decodes strings that are encoded as per RFC 2047. Binary zero
10059 bytes are replaced by question marks. Characters are converted into the
10060 character set defined by &%headers_charset%&. Overlong RFC 2047 &"words"& are
10061 not recognized unless &%check_rfc2047_length%& is set false.
10062
10063 &*Note*&: If you use &%$header%&_&'xxx'&&*:*& (or &%$h%&_&'xxx'&&*:*&) to
10064 access a header line, RFC 2047 decoding is done automatically. You do not need
10065 to use this operator as well.
10066
10067
10068
10069 .vitem &*${rxquote:*&<&'string'&>&*}*&
10070 .cindex "quoting" "in regular expressions"
10071 .cindex "regular expressions" "quoting"
10072 .cindex "&%rxquote%& expansion item"
10073 The &%rxquote%& operator inserts a backslash before any non-alphanumeric
10074 characters in its argument. This is useful when substituting the values of
10075 variables or headers inside regular expressions.
10076
10077
10078 .vitem &*${sha1:*&<&'string'&>&*}*&
10079 .cindex "SHA-1 hash"
10080 .cindex "expansion" "SHA-1 hashing"
10081 .cindex "&%sha2%& expansion item"
10082 The &%sha1%& operator computes the SHA-1 hash value of the string, and returns
10083 it as a 40-digit hexadecimal number, in which any letters are in upper case.
10084
10085
10086 .vitem &*${stat:*&<&'string'&>&*}*&
10087 .cindex "expansion" "statting a file"
10088 .cindex "file" "extracting characteristics"
10089 .cindex "&%stat%& expansion item"
10090 The string, after expansion, must be a file path. A call to the &[stat()]&
10091 function is made for this path. If &[stat()]& fails, an error occurs and the
10092 expansion fails. If it succeeds, the data from the stat replaces the item, as a
10093 series of <&'name'&>=<&'value'&> pairs, where the values are all numerical,
10094 except for the value of &"smode"&. The names are: &"mode"& (giving the mode as
10095 a 4-digit octal number), &"smode"& (giving the mode in symbolic format as a
10096 10-character string, as for the &'ls'& command), &"inode"&, &"device"&,
10097 &"links"&, &"uid"&, &"gid"&, &"size"&, &"atime"&, &"mtime"&, and &"ctime"&. You
10098 can extract individual fields using the &%extract%& expansion item.
10099
10100 The use of the &%stat%& expansion in users' filter files can be locked out by
10101 the system administrator. &*Warning*&: The file size may be incorrect on 32-bit
10102 systems for files larger than 2GB.
10103
10104 .vitem &*${str2b64:*&<&'string'&>&*}*&
10105 .cindex "expansion" "base64 encoding"
10106 .cindex "base64 encoding" "in string expansion"
10107 .cindex "&%str2b64%& expansion item"
10108 This operator converts a string into one that is base64 encoded.
10109
10110
10111
10112 .vitem &*${strlen:*&<&'string'&>&*}*&
10113 .cindex "expansion" "string length"
10114 .cindex "string" "length in expansion"
10115 .cindex "&%strlen%& expansion item"
10116 The item is replace by the length of the expanded string, expressed as a
10117 decimal number. &*Note*&: Do not confuse &%strlen%& with &%length%&.
10118
10119
10120 .vitem &*${substr_*&<&'start'&>&*_*&<&'length'&>&*:*&<&'string'&>&*}*&
10121 .cindex "&%substr%& expansion item"
10122 .cindex "substring extraction"
10123 .cindex "expansion" "substring expansion"
10124 The &%substr%& operator is a simpler interface to the &%substr%& function that
10125 can be used when the two parameters are fixed numbers (as opposed to strings
10126 that change when expanded). The effect is the same as
10127 .code
10128 ${substr{<start>}{<length>}{<string>}}
10129 .endd
10130 See the description of the general &%substr%& item above for details. The
10131 abbreviation &%s%& can be used when &%substr%& is used as an operator.
10132
10133 .vitem &*${time_eval:*&<&'string'&>&*}*&
10134 .cindex "&%time_eval%& expansion item"
10135 .cindex "time interval" "decoding"
10136 This item converts an Exim time interval such as &`2d4h5m`& into a number of
10137 seconds.
10138
10139 .vitem &*${time_interval:*&<&'string'&>&*}*&
10140 .cindex "&%time_interval%& expansion item"
10141 .cindex "time interval" "formatting"
10142 The argument (after sub-expansion) must be a sequence of decimal digits that
10143 represents an interval of time as a number of seconds. It is converted into a
10144 number of larger units and output in Exim's normal time format, for example,
10145 &`1w3d4h2m6s`&.
10146
10147 .vitem &*${uc:*&<&'string'&>&*}*&
10148 .cindex "case forcing in strings"
10149 .cindex "string" "case forcing"
10150 .cindex "upper casing"
10151 .cindex "expansion" "case forcing"
10152 .cindex "&%uc%& expansion item"
10153 This forces the letters in the string into upper-case.
10154
10155 .vitem &*${utf8clean:*&<&'string'&>&*}*&
10156 .cindex "correction of invalid utf-8 sequences in strings"
10157 .cindex "utf-8" "utf-8 sequences"
10158 .cindex "incorrect utf-8"
10159 .cindex "expansion" "utf-8 forcing"
10160 .cindex "&%utf8clean%& expansion item"
10161 This replaces any invalid utf-8 sequence in the string by the character &`?`&.
10162 .endlist
10163
10164
10165
10166
10167
10168
10169 .section "Expansion conditions" "SECTexpcond"
10170 .scindex IIDexpcond "expansion" "conditions"
10171 The following conditions are available for testing by the &%${if%& construct
10172 while expanding strings:
10173
10174 .vlist
10175 .vitem &*!*&<&'condition'&>
10176 .cindex "expansion" "negating a condition"
10177 .cindex "negation" "in expansion condition"
10178 Preceding any condition with an exclamation mark negates the result of the
10179 condition.
10180
10181 .vitem <&'symbolic&~operator'&>&~&*{*&<&'string1'&>&*}{*&<&'string2'&>&*}*&
10182 .cindex "numeric comparison"
10183 .cindex "expansion" "numeric comparison"
10184 There are a number of symbolic operators for doing numeric comparisons. They
10185 are:
10186 .display
10187 &`=   `&   equal
10188 &`==  `&   equal
10189 &`>   `&   greater
10190 &`>=  `&   greater or equal
10191 &`<   `&   less
10192 &`<=  `&   less or equal
10193 .endd
10194 For example:
10195 .code
10196 ${if >{$message_size}{10M} ...
10197 .endd
10198 Note that the general negation operator provides for inequality testing. The
10199 two strings must take the form of optionally signed decimal integers,
10200 optionally followed by one of the letters &"K"&, &"M"& or &"G"& (in either upper or
10201 lower case), signifying multiplication by 1024, 1024*1024 or 1024*1024*1024, respectively.
10202 As a special case, the numerical value of an empty string is taken as
10203 zero.
10204
10205 In all cases, a relative comparator OP is testing if <&'string1'&> OP
10206 <&'string2'&>; the above example is checking if &$message_size$& is larger than
10207 10M, not if 10M is larger than &$message_size$&.
10208
10209
10210 .vitem &*acl&~{{*&<&'name'&>&*}{*&<&'arg1'&>&*}&&&
10211         {*&<&'arg2'&>&*}...}*&
10212 .cindex "expansion" "calling an acl"
10213 .cindex "&%acl%&" "expansion condition"
10214 The name and zero to nine argument strings are first expanded separately.  The expanded
10215 arguments are assigned to the variables &$acl_arg1$& to &$acl_arg9$& in order.
10216 Any unused are made empty.  The variable &$acl_narg$& is set to the number of
10217 arguments.  The named ACL (see chapter &<<CHAPACL>>&) is called
10218 and may use the variables; if another acl expansion is used the values
10219 are restored after it returns.  If the ACL sets
10220 a value using a "message =" modifier the variable $value becomes
10221 the result of the expansion, otherwise it is empty.
10222 If the ACL returns accept the condition is true; if deny, false.
10223 If the ACL returns defer the result is a forced-fail.
10224
10225 .vitem &*bool&~{*&<&'string'&>&*}*&
10226 .cindex "expansion" "boolean parsing"
10227 .cindex "&%bool%& expansion condition"
10228 This condition turns a string holding a true or false representation into
10229 a boolean state.  It parses &"true"&, &"false"&, &"yes"& and &"no"&
10230 (case-insensitively); also integer numbers map to true if non-zero,
10231 false if zero.
10232 An empty string is treated as false.
10233 Leading and trailing whitespace is ignored;
10234 thus a string consisting only of whitespace is false.
10235 All other string values will result in expansion failure.
10236
10237 When combined with ACL variables, this expansion condition will let you
10238 make decisions in one place and act on those decisions in another place.
10239 For example:
10240 .code
10241 ${if bool{$acl_m_privileged_sender} ...
10242 .endd
10243
10244
10245 .vitem &*bool_lax&~{*&<&'string'&>&*}*&
10246 .cindex "expansion" "boolean parsing"
10247 .cindex "&%bool_lax%& expansion condition"
10248 Like &%bool%&, this condition turns a string into a boolean state.  But
10249 where &%bool%& accepts a strict set of strings, &%bool_lax%& uses the same
10250 loose definition that the Router &%condition%& option uses.  The empty string
10251 and the values &"false"&, &"no"& and &"0"& map to false, all others map to
10252 true.  Leading and trailing whitespace is ignored.
10253
10254 Note that where &"bool{00}"& is false, &"bool_lax{00}"& is true.
10255
10256 .vitem &*crypteq&~{*&<&'string1'&>&*}{*&<&'string2'&>&*}*&
10257 .cindex "expansion" "encrypted comparison"
10258 .cindex "encrypted strings, comparing"
10259 .cindex "&%crypteq%& expansion condition"
10260 This condition is included in the Exim binary if it is built to support any
10261 authentication mechanisms (see chapter &<<CHAPSMTPAUTH>>&). Otherwise, it is
10262 necessary to define SUPPORT_CRYPTEQ in &_Local/Makefile_& to get &%crypteq%&
10263 included in the binary.
10264
10265 The &%crypteq%& condition has two arguments. The first is encrypted and
10266 compared against the second, which is already encrypted. The second string may
10267 be in the LDAP form for storing encrypted strings, which starts with the
10268 encryption type in curly brackets, followed by the data. If the second string
10269 does not begin with &"{"& it is assumed to be encrypted with &[crypt()]& or
10270 &[crypt16()]& (see below), since such strings cannot begin with &"{"&.
10271 Typically this will be a field from a password file. An example of an encrypted
10272 string in LDAP form is:
10273 .code
10274 {md5}CY9rzUYh03PK3k6DJie09g==
10275 .endd
10276 If such a string appears directly in an expansion, the curly brackets have to
10277 be quoted, because they are part of the expansion syntax. For example:
10278 .code
10279 ${if crypteq {test}{\{md5\}CY9rzUYh03PK3k6DJie09g==}{yes}{no}}
10280 .endd
10281 The following encryption types (whose names are matched case-independently) are
10282 supported:
10283
10284 .ilist
10285 .cindex "MD5 hash"
10286 .cindex "base64 encoding" "in encrypted password"
10287 &%{md5}%& computes the MD5 digest of the first string, and expresses this as
10288 printable characters to compare with the remainder of the second string. If the
10289 length of the comparison string is 24, Exim assumes that it is base64 encoded
10290 (as in the above example). If the length is 32, Exim assumes that it is a
10291 hexadecimal encoding of the MD5 digest. If the length not 24 or 32, the
10292 comparison fails.
10293
10294 .next
10295 .cindex "SHA-1 hash"
10296 &%{sha1}%& computes the SHA-1 digest of the first string, and expresses this as
10297 printable characters to compare with the remainder of the second string. If the
10298 length of the comparison string is 28, Exim assumes that it is base64 encoded.
10299 If the length is 40, Exim assumes that it is a hexadecimal encoding of the
10300 SHA-1 digest. If the length is not 28 or 40, the comparison fails.
10301
10302 .next
10303 .cindex "&[crypt()]&"
10304 &%{crypt}%& calls the &[crypt()]& function, which traditionally used to use
10305 only the first eight characters of the password. However, in modern operating
10306 systems this is no longer true, and in many cases the entire password is used,
10307 whatever its length.
10308
10309 .next
10310 .cindex "&[crypt16()]&"
10311 &%{crypt16}%& calls the &[crypt16()]& function, which was originally created to
10312 use up to 16 characters of the password in some operating systems. Again, in
10313 modern operating systems, more characters may be used.
10314 .endlist
10315 Exim has its own version of &[crypt16()]&, which is just a double call to
10316 &[crypt()]&. For operating systems that have their own version, setting
10317 HAVE_CRYPT16 in &_Local/Makefile_& when building Exim causes it to use the
10318 operating system version instead of its own. This option is set by default in
10319 the OS-dependent &_Makefile_& for those operating systems that are known to
10320 support &[crypt16()]&.
10321
10322 Some years after Exim's &[crypt16()]& was implemented, a user discovered that
10323 it was not using the same algorithm as some operating systems' versions. It
10324 turns out that as well as &[crypt16()]& there is a function called
10325 &[bigcrypt()]& in some operating systems. This may or may not use the same
10326 algorithm, and both of them may be different to Exim's built-in &[crypt16()]&.
10327
10328 However, since there is now a move away from the traditional &[crypt()]&
10329 functions towards using SHA1 and other algorithms, tidying up this area of
10330 Exim is seen as very low priority.
10331
10332 If you do not put a encryption type (in curly brackets) in a &%crypteq%&
10333 comparison, the default is usually either &`{crypt}`& or &`{crypt16}`&, as
10334 determined by the setting of DEFAULT_CRYPT in &_Local/Makefile_&. The default
10335 default is &`{crypt}`&. Whatever the default, you can always use either
10336 function by specifying it explicitly in curly brackets.
10337
10338 .vitem &*def:*&<&'variable&~name'&>
10339 .cindex "expansion" "checking for empty variable"
10340 .cindex "&%def%& expansion condition"
10341 The &%def%& condition must be followed by the name of one of the expansion
10342 variables defined in section &<<SECTexpvar>>&. The condition is true if the
10343 variable does not contain the empty string. For example:
10344 .code
10345 ${if def:sender_ident {from $sender_ident}}
10346 .endd
10347 Note that the variable name is given without a leading &%$%& character. If the
10348 variable does not exist, the expansion fails.
10349
10350 .vitem "&*def:header_*&<&'header&~name'&>&*:*&&~&~or&~&&&
10351         &~&*def:h_*&<&'header&~name'&>&*:*&"
10352 .cindex "expansion" "checking header line existence"
10353 This condition is true if a message is being processed and the named header
10354 exists in the message. For example,
10355 .code
10356 ${if def:header_reply-to:{$h_reply-to:}{$h_from:}}
10357 .endd
10358 &*Note*&: No &%$%& appears before &%header_%& or &%h_%& in the condition, and
10359 the header name must be terminated by a colon if white space does not follow.
10360
10361 .vitem &*eq&~{*&<&'string1'&>&*}{*&<&'string2'&>&*}*& &&&
10362        &*eqi&~{*&<&'string1'&>&*}{*&<&'string2'&>&*}*&
10363 .cindex "string" "comparison"
10364 .cindex "expansion" "string comparison"
10365 .cindex "&%eq%& expansion condition"
10366 .cindex "&%eqi%& expansion condition"
10367 The two substrings are first expanded. The condition is true if the two
10368 resulting strings are identical. For &%eq%& the comparison includes the case of
10369 letters, whereas for &%eqi%& the comparison is case-independent.
10370
10371 .vitem &*exists&~{*&<&'file&~name'&>&*}*&
10372 .cindex "expansion" "file existence test"
10373 .cindex "file" "existence test"
10374 .cindex "&%exists%&, expansion condition"
10375 The substring is first expanded and then interpreted as an absolute path. The
10376 condition is true if the named file (or directory) exists. The existence test
10377 is done by calling the &[stat()]& function. The use of the &%exists%& test in
10378 users' filter files may be locked out by the system administrator.
10379
10380 .vitem &*first_delivery*&
10381 .cindex "delivery" "first"
10382 .cindex "first delivery"
10383 .cindex "expansion" "first delivery test"
10384 .cindex "&%first_delivery%& expansion condition"
10385 This condition, which has no data, is true during a message's first delivery
10386 attempt. It is false during any subsequent delivery attempts.
10387
10388
10389 .vitem "&*forall{*&<&'a list'&>&*}{*&<&'a condition'&>&*}*&" &&&
10390        "&*forany{*&<&'a list'&>&*}{*&<&'a condition'&>&*}*&"
10391 .cindex "list" "iterative conditions"
10392 .cindex "expansion" "&*forall*& condition"
10393 .cindex "expansion" "&*forany*& condition"
10394 .vindex "&$item$&"
10395 These conditions iterate over a list. The first argument is expanded to form
10396 the list. By default, the list separator is a colon, but it can be changed by
10397 the normal method. The second argument is interpreted as a condition that is to
10398 be applied to each item in the list in turn. During the interpretation of the
10399 condition, the current list item is placed in a variable called &$item$&.
10400 .ilist
10401 For &*forany*&, interpretation stops if the condition is true for any item, and
10402 the result of the whole condition is true. If the condition is false for all
10403 items in the list, the overall condition is false.
10404 .next
10405 For &*forall*&, interpretation stops if the condition is false for any item,
10406 and the result of the whole condition is false. If the condition is true for
10407 all items in the list, the overall condition is true.
10408 .endlist
10409 Note that negation of &*forany*& means that the condition must be false for all
10410 items for the overall condition to succeed, and negation of &*forall*& means
10411 that the condition must be false for at least one item. In this example, the
10412 list separator is changed to a comma:
10413 .code
10414 ${if forany{<, $recipients}{match{$item}{^user3@}}{yes}{no}}
10415 .endd
10416 The value of &$item$& is saved and restored while &*forany*& or &*forall*& is
10417 being processed, to enable these expansion items to be nested.
10418
10419 To scan a named list, expand it with the &*listnamed*& operator.
10420
10421
10422 .vitem &*ge&~{*&<&'string1'&>&*}{*&<&'string2'&>&*}*& &&&
10423        &*gei&~{*&<&'string1'&>&*}{*&<&'string2'&>&*}*&
10424 .cindex "string" "comparison"
10425 .cindex "expansion" "string comparison"
10426 .cindex "&%ge%& expansion condition"
10427 .cindex "&%gei%& expansion condition"
10428 The two substrings are first expanded. The condition is true if the first
10429 string is lexically greater than or equal to the second string. For &%ge%& the
10430 comparison includes the case of letters, whereas for &%gei%& the comparison is
10431 case-independent.
10432
10433 .vitem &*gt&~{*&<&'string1'&>&*}{*&<&'string2'&>&*}*& &&&
10434        &*gti&~{*&<&'string1'&>&*}{*&<&'string2'&>&*}*&
10435 .cindex "string" "comparison"
10436 .cindex "expansion" "string comparison"
10437 .cindex "&%gt%& expansion condition"
10438 .cindex "&%gti%& expansion condition"
10439 The two substrings are first expanded. The condition is true if the first
10440 string is lexically greater than the second string. For &%gt%& the comparison
10441 includes the case of letters, whereas for &%gti%& the comparison is
10442 case-independent.
10443
10444 .vitem &*inlist&~{*&<&'string1'&>&*}{*&<&'string2'&>&*}*& &&&
10445        &*inlisti&~{*&<&'string1'&>&*}{*&<&'string2'&>&*}*&
10446 .cindex "string" "comparison"
10447 .cindex "list" "iterative conditions"
10448 Both strings are expanded; the second string is treated as a list of simple
10449 strings; if the first string is a member of the second, then the condition
10450 is true.
10451
10452 These are simpler to use versions of the more powerful &*forany*& condition.
10453 Examples, and the &*forany*& equivalents:
10454 .code
10455 ${if inlist{needle}{foo:needle:bar}}
10456   ${if forany{foo:needle:bar}{eq{$item}{needle}}}
10457 ${if inlisti{Needle}{fOo:NeeDLE:bAr}}
10458   ${if forany{fOo:NeeDLE:bAr}{eqi{$item}{Needle}}}
10459 .endd
10460
10461 .vitem &*isip&~{*&<&'string'&>&*}*&  &&&
10462        &*isip4&~{*&<&'string'&>&*}*& &&&
10463        &*isip6&~{*&<&'string'&>&*}*&
10464 .cindex "IP address" "testing string format"
10465 .cindex "string" "testing for IP address"
10466 .cindex "&%isip%& expansion condition"
10467 .cindex "&%isip4%& expansion condition"
10468 .cindex "&%isip6%& expansion condition"
10469 The substring is first expanded, and then tested to see if it has the form of
10470 an IP address. Both IPv4 and IPv6 addresses are valid for &%isip%&, whereas
10471 &%isip4%& and &%isip6%& test specifically for IPv4 or IPv6 addresses.
10472
10473 For an IPv4 address, the test is for four dot-separated components, each of
10474 which consists of from one to three digits. For an IPv6 address, up to eight
10475 colon-separated components are permitted, each containing from one to four
10476 hexadecimal digits. There may be fewer than eight components if an empty
10477 component (adjacent colons) is present. Only one empty component is permitted.
10478
10479 &*Note*&: The checks are just on the form of the address; actual numerical
10480 values are not considered. Thus, for example, 999.999.999.999 passes the IPv4
10481 check. The main use of these tests is to distinguish between IP addresses and
10482 host names, or between IPv4 and IPv6 addresses. For example, you could use
10483 .code
10484 ${if isip4{$sender_host_address}...
10485 .endd
10486 to test which IP version an incoming SMTP connection is using.
10487
10488 .vitem &*ldapauth&~{*&<&'ldap&~query'&>&*}*&
10489 .cindex "LDAP" "use for authentication"
10490 .cindex "expansion" "LDAP authentication test"
10491 .cindex "&%ldapauth%& expansion condition"
10492 This condition supports user authentication using LDAP. See section
10493 &<<SECTldap>>& for details of how to use LDAP in lookups and the syntax of
10494 queries. For this use, the query must contain a user name and password. The
10495 query itself is not used, and can be empty. The condition is true if the
10496 password is not empty, and the user name and password are accepted by the LDAP
10497 server. An empty password is rejected without calling LDAP because LDAP binds
10498 with an empty password are considered anonymous regardless of the username, and
10499 will succeed in most configurations. See chapter &<<CHAPSMTPAUTH>>& for details
10500 of SMTP authentication, and chapter &<<CHAPplaintext>>& for an example of how
10501 this can be used.
10502
10503
10504 .vitem &*le&~{*&<&'string1'&>&*}{*&<&'string2'&>&*}*& &&&
10505        &*lei&~{*&<&'string1'&>&*}{*&<&'string2'&>&*}*&
10506 .cindex "string" "comparison"
10507 .cindex "expansion" "string comparison"
10508 .cindex "&%le%& expansion condition"
10509 .cindex "&%lei%& expansion condition"
10510 The two substrings are first expanded. The condition is true if the first
10511 string is lexically less than or equal to the second string. For &%le%& the
10512 comparison includes the case of letters, whereas for &%lei%& the comparison is
10513 case-independent.
10514
10515 .vitem &*lt&~{*&<&'string1'&>&*}{*&<&'string2'&>&*}*& &&&
10516        &*lti&~{*&<&'string1'&>&*}{*&<&'string2'&>&*}*&
10517 .cindex "string" "comparison"
10518 .cindex "expansion" "string comparison"
10519 .cindex "&%lt%& expansion condition"
10520 .cindex "&%lti%& expansion condition"
10521 The two substrings are first expanded. The condition is true if the first
10522 string is lexically less than the second string. For &%lt%& the comparison
10523 includes the case of letters, whereas for &%lti%& the comparison is
10524 case-independent.
10525
10526
10527 .vitem &*match&~{*&<&'string1'&>&*}{*&<&'string2'&>&*}*&
10528 .cindex "expansion" "regular expression comparison"
10529 .cindex "regular expressions" "match in expanded string"
10530 .cindex "&%match%& expansion condition"
10531 The two substrings are first expanded. The second is then treated as a regular
10532 expression and applied to the first. Because of the pre-expansion, if the
10533 regular expression contains dollar, or backslash characters, they must be
10534 escaped. Care must also be taken if the regular expression contains braces
10535 (curly brackets). A closing brace must be escaped so that it is not taken as a
10536 premature termination of <&'string2'&>. The easiest approach is to use the
10537 &`\N`& feature to disable expansion of the regular expression.
10538 For example,
10539 .code
10540 ${if match {$local_part}{\N^\d{3}\N} ...
10541 .endd
10542 If the whole expansion string is in double quotes, further escaping of
10543 backslashes is also required.
10544
10545 The condition is true if the regular expression match succeeds.
10546 The regular expression is not required to begin with a circumflex
10547 metacharacter, but if there is no circumflex, the expression is not anchored,
10548 and it may match anywhere in the subject, not just at the start. If you want
10549 the pattern to match at the end of the subject, you must include the &`$`&
10550 metacharacter at an appropriate point.
10551
10552 .cindex "numerical variables (&$1$& &$2$& etc)" "in &%if%& expansion"
10553 At the start of an &%if%& expansion the values of the numeric variable
10554 substitutions &$1$& etc. are remembered. Obeying a &%match%& condition that
10555 succeeds causes them to be reset to the substrings of that condition and they
10556 will have these values during the expansion of the success string. At the end
10557 of the &%if%& expansion, the previous values are restored. After testing a
10558 combination of conditions using &%or%&, the subsequent values of the numeric
10559 variables are those of the condition that succeeded.
10560
10561 .vitem &*match_address&~{*&<&'string1'&>&*}{*&<&'string2'&>&*}*&
10562 .cindex "&%match_address%& expansion condition"
10563 See &*match_local_part*&.
10564
10565 .vitem &*match_domain&~{*&<&'string1'&>&*}{*&<&'string2'&>&*}*&
10566 .cindex "&%match_domain%& expansion condition"
10567 See &*match_local_part*&.
10568
10569 .vitem &*match_ip&~{*&<&'string1'&>&*}{*&<&'string2'&>&*}*&
10570 .cindex "&%match_ip%& expansion condition"
10571 This condition matches an IP address to a list of IP address patterns. It must
10572 be followed by two argument strings. The first (after expansion) must be an IP
10573 address or an empty string. The second (not expanded) is a restricted host
10574 list that can match only an IP address, not a host name. For example:
10575 .code
10576 ${if match_ip{$sender_host_address}{1.2.3.4:5.6.7.8}{...}{...}}
10577 .endd
10578 The specific types of host list item that are permitted in the list are:
10579
10580 .ilist
10581 An IP address, optionally with a CIDR mask.
10582 .next
10583 A single asterisk, which matches any IP address.
10584 .next
10585 An empty item, which matches only if the IP address is empty. This could be
10586 useful for testing for a locally submitted message or one from specific hosts
10587 in a single test such as
10588 . ==== As this is a nested list, any displays it contains must be indented
10589 . ==== as otherwise they are too far to the left. This comment applies to
10590 . ==== the use of xmlto plus fop. There's no problem when formatting with
10591 . ==== sdop, with or without the extra indent.
10592 .code
10593   ${if match_ip{$sender_host_address}{:4.3.2.1:...}{...}{...}}
10594 .endd
10595 where the first item in the list is the empty string.
10596 .next
10597 The item @[] matches any of the local host's interface addresses.
10598 .next
10599 Single-key lookups are assumed to be like &"net-"& style lookups in host lists,
10600 even if &`net-`& is not specified. There is never any attempt to turn the IP
10601 address into a host name. The most common type of linear search for
10602 &*match_ip*& is likely to be &*iplsearch*&, in which the file can contain CIDR
10603 masks. For example:
10604 .code
10605   ${if match_ip{$sender_host_address}{iplsearch;/some/file}...
10606 .endd
10607 It is of course possible to use other kinds of lookup, and in such a case, you
10608 do need to specify the &`net-`& prefix if you want to specify a specific
10609 address mask, for example:
10610 .code
10611   ${if match_ip{$sender_host_address}{net24-dbm;/some/file}...
10612 .endd
10613 However, unless you are combining a &%match_ip%& condition with others, it is
10614 just as easy to use the fact that a lookup is itself a condition, and write:
10615 .code
10616   ${lookup{${mask:$sender_host_address/24}}dbm{/a/file}...
10617 .endd
10618 .endlist ilist
10619
10620 Note that <&'string2'&> is not itself subject to string expansion, unless
10621 Exim was built with the EXPAND_LISTMATCH_RHS option.
10622
10623 Consult section &<<SECThoslispatip>>& for further details of these patterns.
10624
10625 .vitem &*match_local_part&~{*&<&'string1'&>&*}{*&<&'string2'&>&*}*&
10626 .cindex "domain list" "in expansion condition"
10627 .cindex "address list" "in expansion condition"
10628 .cindex "local part" "list, in expansion condition"
10629 .cindex "&%match_local_part%& expansion condition"
10630 This condition, together with &%match_address%& and &%match_domain%&, make it
10631 possible to test domain, address, and local part lists within expansions. Each
10632 condition requires two arguments: an item and a list to match. A trivial
10633 example is:
10634 .code
10635 ${if match_domain{a.b.c}{x.y.z:a.b.c:p.q.r}{yes}{no}}
10636 .endd
10637 In each case, the second argument may contain any of the allowable items for a
10638 list of the appropriate type. Also, because the second argument (after
10639 expansion) is a standard form of list, it is possible to refer to a named list.
10640 Thus, you can use conditions like this:
10641 .code
10642 ${if match_domain{$domain}{+local_domains}{...
10643 .endd
10644 .cindex "&`+caseful`&"
10645 For address lists, the matching starts off caselessly, but the &`+caseful`&
10646 item can be used, as in all address lists, to cause subsequent items to
10647 have their local parts matched casefully. Domains are always matched
10648 caselessly.
10649
10650 Note that <&'string2'&> is not itself subject to string expansion, unless
10651 Exim was built with the EXPAND_LISTMATCH_RHS option.
10652
10653 &*Note*&: Host lists are &'not'& supported in this way. This is because
10654 hosts have two identities: a name and an IP address, and it is not clear
10655 how to specify cleanly how such a test would work. However, IP addresses can be
10656 matched using &%match_ip%&.
10657
10658 .vitem &*pam&~{*&<&'string1'&>&*:*&<&'string2'&>&*:...}*&
10659 .cindex "PAM authentication"
10660 .cindex "AUTH" "with PAM"
10661 .cindex "Solaris" "PAM support"
10662 .cindex "expansion" "PAM authentication test"
10663 .cindex "&%pam%& expansion condition"
10664 &'Pluggable Authentication Modules'&
10665 (&url(http://www.kernel.org/pub/linux/libs/pam/)) are a facility that is
10666 available in the latest releases of Solaris and in some GNU/Linux
10667 distributions. The Exim support, which is intended for use in conjunction with
10668 the SMTP AUTH command, is available only if Exim is compiled with
10669 .code
10670 SUPPORT_PAM=yes
10671 .endd
10672 in &_Local/Makefile_&. You probably need to add &%-lpam%& to EXTRALIBS, and
10673 in some releases of GNU/Linux &%-ldl%& is also needed.
10674
10675 The argument string is first expanded, and the result must be a
10676 colon-separated list of strings. Leading and trailing white space is ignored.
10677 The PAM module is initialized with the service name &"exim"& and the user name
10678 taken from the first item in the colon-separated data string (<&'string1'&>).
10679 The remaining items in the data string are passed over in response to requests
10680 from the authentication function. In the simple case there will only be one
10681 request, for a password, so the data consists of just two strings.
10682
10683 There can be problems if any of the strings are permitted to contain colon
10684 characters. In the usual way, these have to be doubled to avoid being taken as
10685 separators. If the data is being inserted from a variable, the &%sg%& expansion
10686 item can be used to double any existing colons. For example, the configuration
10687 of a LOGIN authenticator might contain this setting:
10688 .code
10689 server_condition = ${if pam{$auth1:${sg{$auth2}{:}{::}}}}
10690 .endd
10691 For a PLAIN authenticator you could use:
10692 .code
10693 server_condition = ${if pam{$auth2:${sg{$auth3}{:}{::}}}}
10694 .endd
10695 In some operating systems, PAM authentication can be done only from a process
10696 running as root. Since Exim is running as the Exim user when receiving
10697 messages, this means that PAM cannot be used directly in those systems.
10698 A patched version of the &'pam_unix'& module that comes with the
10699 Linux PAM package is available from &url(http://www.e-admin.de/pam_exim/).
10700 The patched module allows one special uid/gid combination, in addition to root,
10701 to authenticate. If you build the patched module to allow the Exim user and
10702 group, PAM can then be used from an Exim authenticator.
10703
10704
10705 .vitem &*pwcheck&~{*&<&'string1'&>&*:*&<&'string2'&>&*}*&
10706 .cindex "&'pwcheck'& daemon"
10707 .cindex "Cyrus"
10708 .cindex "expansion" "&'pwcheck'& authentication test"
10709 .cindex "&%pwcheck%& expansion condition"
10710 This condition supports user authentication using the Cyrus &'pwcheck'& daemon.
10711 This is one way of making it possible for passwords to be checked by a process
10712 that is not running as root. &*Note*&: The use of &'pwcheck'& is now
10713 deprecated. Its replacement is &'saslauthd'& (see below).
10714
10715 The pwcheck support is not included in Exim by default. You need to specify
10716 the location of the pwcheck daemon's socket in &_Local/Makefile_& before
10717 building Exim. For example:
10718 .code
10719 CYRUS_PWCHECK_SOCKET=/var/pwcheck/pwcheck
10720 .endd
10721 You do not need to install the full Cyrus software suite in order to use
10722 the pwcheck daemon. You can compile and install just the daemon alone
10723 from the Cyrus SASL library. Ensure that &'exim'& is the only user that has
10724 access to the &_/var/pwcheck_& directory.
10725
10726 The &%pwcheck%& condition takes one argument, which must be the user name and
10727 password, separated by a colon. For example, in a LOGIN authenticator
10728 configuration, you might have this:
10729 .code
10730 server_condition = ${if pwcheck{$auth1:$auth2}}
10731 .endd
10732 Again, for a PLAIN authenticator configuration, this would be:
10733 .code
10734 server_condition = ${if pwcheck{$auth2:$auth3}}
10735 .endd
10736 .vitem &*queue_running*&
10737 .cindex "queue runner" "detecting when delivering from"
10738 .cindex "expansion" "queue runner test"
10739 .cindex "&%queue_running%& expansion condition"
10740 This condition, which has no data, is true during delivery attempts that are
10741 initiated by queue runner processes, and false otherwise.
10742
10743
10744 .vitem &*radius&~{*&<&'authentication&~string'&>&*}*&
10745 .cindex "Radius"
10746 .cindex "expansion" "Radius authentication"
10747 .cindex "&%radius%& expansion condition"
10748 Radius authentication (RFC 2865) is supported in a similar way to PAM. You must
10749 set RADIUS_CONFIG_FILE in &_Local/Makefile_& to specify the location of
10750 the Radius client configuration file in order to build Exim with Radius
10751 support.
10752
10753 With just that one setting, Exim expects to be linked with the &%radiusclient%&
10754 library, using the original API. If you are using release 0.4.0 or later of
10755 this library, you need to set
10756 .code
10757 RADIUS_LIB_TYPE=RADIUSCLIENTNEW
10758 .endd
10759 in &_Local/Makefile_& when building Exim. You can also link Exim with the
10760 &%libradius%& library that comes with FreeBSD. To do this, set
10761 .code
10762 RADIUS_LIB_TYPE=RADLIB
10763 .endd
10764 in &_Local/Makefile_&, in addition to setting RADIUS_CONFIGURE_FILE.
10765 You may also have to supply a suitable setting in EXTRALIBS so that the
10766 Radius library can be found when Exim is linked.
10767
10768 The string specified by RADIUS_CONFIG_FILE is expanded and passed to the
10769 Radius client library, which calls the Radius server. The condition is true if
10770 the authentication is successful. For example:
10771 .code
10772 server_condition = ${if radius{<arguments>}}
10773 .endd
10774
10775
10776 .vitem "&*saslauthd&~{{*&<&'user'&>&*}{*&<&'password'&>&*}&&&
10777         {*&<&'service'&>&*}{*&<&'realm'&>&*}}*&"
10778 .cindex "&'saslauthd'& daemon"
10779 .cindex "Cyrus"
10780 .cindex "expansion" "&'saslauthd'& authentication test"
10781 .cindex "&%saslauthd%& expansion condition"
10782 This condition supports user authentication using the Cyrus &'saslauthd'&
10783 daemon. This replaces the older &'pwcheck'& daemon, which is now deprecated.
10784 Using this daemon is one way of making it possible for passwords to be checked
10785 by a process that is not running as root.
10786
10787 The saslauthd support is not included in Exim by default. You need to specify
10788 the location of the saslauthd daemon's socket in &_Local/Makefile_& before
10789 building Exim. For example:
10790 .code
10791 CYRUS_SASLAUTHD_SOCKET=/var/state/saslauthd/mux
10792 .endd
10793 You do not need to install the full Cyrus software suite in order to use
10794 the saslauthd daemon. You can compile and install just the daemon alone
10795 from the Cyrus SASL library.
10796
10797 Up to four arguments can be supplied to the &%saslauthd%& condition, but only
10798 two are mandatory. For example:
10799 .code
10800 server_condition = ${if saslauthd{{$auth1}{$auth2}}}
10801 .endd
10802 The service and the realm are optional (which is why the arguments are enclosed
10803 in their own set of braces). For details of the meaning of the service and
10804 realm, and how to run the daemon, consult the Cyrus documentation.
10805 .endlist vlist
10806
10807
10808
10809 .section "Combining expansion conditions" "SECID84"
10810 .cindex "expansion" "combining conditions"
10811 Several conditions can be tested at once by combining them using the &%and%&
10812 and &%or%& combination conditions. Note that &%and%& and &%or%& are complete
10813 conditions on their own, and precede their lists of sub-conditions. Each
10814 sub-condition must be enclosed in braces within the overall braces that contain
10815 the list. No repetition of &%if%& is used.
10816
10817
10818 .vlist
10819 .vitem &*or&~{{*&<&'cond1'&>&*}{*&<&'cond2'&>&*}...}*&
10820 .cindex "&""or""& expansion condition"
10821 .cindex "expansion" "&""or""& of conditions"
10822 The sub-conditions are evaluated from left to right. The condition is true if
10823 any one of the sub-conditions is true.
10824 For example,
10825 .code
10826 ${if or {{eq{$local_part}{spqr}}{eq{$domain}{testing.com}}}...
10827 .endd
10828 When a true sub-condition is found, the following ones are parsed but not
10829 evaluated. If there are several &"match"& sub-conditions the values of the
10830 numeric variables afterwards are taken from the first one that succeeds.
10831
10832 .vitem &*and&~{{*&<&'cond1'&>&*}{*&<&'cond2'&>&*}...}*&
10833 .cindex "&""and""& expansion condition"
10834 .cindex "expansion" "&""and""& of conditions"
10835 The sub-conditions are evaluated from left to right. The condition is true if
10836 all of the sub-conditions are true. If there are several &"match"&
10837 sub-conditions, the values of the numeric variables afterwards are taken from
10838 the last one. When a false sub-condition is found, the following ones are
10839 parsed but not evaluated.
10840 .endlist
10841 .ecindex IIDexpcond
10842
10843
10844
10845
10846 .section "Expansion variables" "SECTexpvar"
10847 .cindex "expansion" "variables, list of"
10848 This section contains an alphabetical list of all the expansion variables. Some
10849 of them are available only when Exim is compiled with specific options such as
10850 support for TLS or the content scanning extension.
10851
10852 .vlist
10853 .vitem "&$0$&, &$1$&, etc"
10854 .cindex "numerical variables (&$1$& &$2$& etc)"
10855 When a &%match%& expansion condition succeeds, these variables contain the
10856 captured substrings identified by the regular expression during subsequent
10857 processing of the success string of the containing &%if%& expansion item.
10858 However, they do not retain their values afterwards; in fact, their previous
10859 values are restored at the end of processing an &%if%& item. The numerical
10860 variables may also be set externally by some other matching process which
10861 precedes the expansion of the string. For example, the commands available in
10862 Exim filter files include an &%if%& command with its own regular expression
10863 matching condition.
10864
10865 .vitem "&$acl_c...$&"
10866 Values can be placed in these variables by the &%set%& modifier in an ACL. They
10867 can be given any name that starts with &$acl_c$& and is at least six characters
10868 long, but the sixth character must be either a digit or an underscore. For
10869 example: &$acl_c5$&, &$acl_c_mycount$&. The values of the &$acl_c...$&
10870 variables persist throughout the lifetime of an SMTP connection. They can be
10871 used to pass information between ACLs and between different invocations of the
10872 same ACL. When a message is received, the values of these variables are saved
10873 with the message, and can be accessed by filters, routers, and transports
10874 during subsequent delivery.
10875
10876 .vitem "&$acl_m...$&"
10877 These variables are like the &$acl_c...$& variables, except that their values
10878 are reset after a message has been received. Thus, if several messages are
10879 received in one SMTP connection, &$acl_m...$& values are not passed on from one
10880 message to the next, as &$acl_c...$& values are. The &$acl_m...$& variables are
10881 also reset by MAIL, RSET, EHLO, HELO, and after starting a TLS session. When a
10882 message is received, the values of these variables are saved with the message,
10883 and can be accessed by filters, routers, and transports during subsequent
10884 delivery.
10885
10886 .vitem &$acl_verify_message$&
10887 .vindex "&$acl_verify_message$&"
10888 After an address verification has failed, this variable contains the failure
10889 message. It retains its value for use in subsequent modifiers. The message can
10890 be preserved by coding like this:
10891 .code
10892 warn !verify = sender
10893      set acl_m0 = $acl_verify_message
10894 .endd
10895 You can use &$acl_verify_message$& during the expansion of the &%message%& or
10896 &%log_message%& modifiers, to include information about the verification
10897 failure.
10898
10899 .vitem &$address_data$&
10900 .vindex "&$address_data$&"
10901 This variable is set by means of the &%address_data%& option in routers. The
10902 value then remains with the address while it is processed by subsequent routers
10903 and eventually a transport. If the transport is handling multiple addresses,
10904 the value from the first address is used. See chapter &<<CHAProutergeneric>>&
10905 for more details. &*Note*&: The contents of &$address_data$& are visible in
10906 user filter files.
10907
10908 If &$address_data$& is set when the routers are called from an ACL to verify
10909 a recipient address, the final value is still in the variable for subsequent
10910 conditions and modifiers of the ACL statement. If routing the address caused it
10911 to be redirected to just one address, the child address is also routed as part
10912 of the verification, and in this case the final value of &$address_data$& is
10913 from the child's routing.
10914
10915 If &$address_data$& is set when the routers are called from an ACL to verify a
10916 sender address, the final value is also preserved, but this time in
10917 &$sender_address_data$&, to distinguish it from data from a recipient
10918 address.
10919
10920 In both cases (recipient and sender verification), the value does not persist
10921 after the end of the current ACL statement. If you want to preserve
10922 these values for longer, you can save them in ACL variables.
10923
10924 .vitem &$address_file$&
10925 .vindex "&$address_file$&"
10926 When, as a result of aliasing, forwarding, or filtering, a message is directed
10927 to a specific file, this variable holds the name of the file when the transport
10928 is running. At other times, the variable is empty. For example, using the
10929 default configuration, if user &%r2d2%& has a &_.forward_& file containing
10930 .code
10931 /home/r2d2/savemail
10932 .endd
10933 then when the &(address_file)& transport is running, &$address_file$&
10934 contains the text string &`/home/r2d2/savemail`&.
10935 .cindex "Sieve filter" "value of &$address_file$&"
10936 For Sieve filters, the value may be &"inbox"& or a relative folder name. It is
10937 then up to the transport configuration to generate an appropriate absolute path
10938 to the relevant file.
10939
10940 .vitem &$address_pipe$&
10941 .vindex "&$address_pipe$&"
10942 When, as a result of aliasing or forwarding, a message is directed to a pipe,
10943 this variable holds the pipe command when the transport is running.
10944
10945 .vitem "&$auth1$& &-- &$auth3$&"
10946 .vindex "&$auth1$&, &$auth2$&, etc"
10947 These variables are used in SMTP authenticators (see chapters
10948 &<<CHAPplaintext>>&&--&<<CHAPspa>>&). Elsewhere, they are empty.
10949
10950 .vitem &$authenticated_id$&
10951 .cindex "authentication" "id"
10952 .vindex "&$authenticated_id$&"
10953 When a server successfully authenticates a client it may be configured to
10954 preserve some of the authentication information in the variable
10955 &$authenticated_id$& (see chapter &<<CHAPSMTPAUTH>>&). For example, a
10956 user/password authenticator configuration might preserve the user name for use
10957 in the routers. Note that this is not the same information that is saved in
10958 &$sender_host_authenticated$&.
10959 When a message is submitted locally (that is, not over a TCP connection)
10960 the value of &$authenticated_id$& is normally the login name of the calling
10961 process. However, a trusted user can override this by means of the &%-oMai%&
10962 command line option.
10963
10964 .vitem &$authenticated_fail_id$&
10965 .cindex "authentication" "fail" "id"
10966 .vindex "&$authenticated_fail_id$&"
10967 When an authentication attempt fails, the variable &$authenticated_fail_id$&
10968 will contain the failed authentication id. If more than one authentication
10969 id is attempted, it will contain only the last one. The variable is
10970 available for processing in the ACL's, generally the quit or notquit ACL.
10971 A message to a local recipient could still be accepted without requiring
10972 authentication, which means this variable could also be visible in all of
10973 the ACL's as well.
10974
10975
10976 .vitem &$authenticated_sender$&
10977 .cindex "sender" "authenticated"
10978 .cindex "authentication" "sender"
10979 .cindex "AUTH" "on MAIL command"
10980 .vindex "&$authenticated_sender$&"
10981 When acting as a server, Exim takes note of the AUTH= parameter on an incoming
10982 SMTP MAIL command if it believes the sender is sufficiently trusted, as
10983 described in section &<<SECTauthparamail>>&. Unless the data is the string
10984 &"<>"&, it is set as the authenticated sender of the message, and the value is
10985 available during delivery in the &$authenticated_sender$& variable. If the
10986 sender is not trusted, Exim accepts the syntax of AUTH=, but ignores the data.
10987
10988 .vindex "&$qualify_domain$&"
10989 When a message is submitted locally (that is, not over a TCP connection), the
10990 value of &$authenticated_sender$& is an address constructed from the login
10991 name of the calling process and &$qualify_domain$&, except that a trusted user
10992 can override this by means of the &%-oMas%& command line option.
10993
10994
10995 .vitem &$authentication_failed$&
10996 .cindex "authentication" "failure"
10997 .vindex "&$authentication_failed$&"
10998 This variable is set to &"1"& in an Exim server if a client issues an AUTH
10999 command that does not succeed. Otherwise it is set to &"0"&. This makes it
11000 possible to distinguish between &"did not try to authenticate"&
11001 (&$sender_host_authenticated$& is empty and &$authentication_failed$& is set to
11002 &"0"&) and &"tried to authenticate but failed"& (&$sender_host_authenticated$&
11003 is empty and &$authentication_failed$& is set to &"1"&). Failure includes any
11004 negative response to an AUTH command, including (for example) an attempt to use
11005 an undefined mechanism.
11006
11007 .vitem &$av_failed$&
11008 .cindex "content scanning" "AV scanner failure"
11009 This variable is available when Exim is compiled with the content-scanning
11010 extension. It is set to &"0"& by default, but will be set to &"1"& if any
11011 problem occurs with the virus scanner (specified by &%av_scanner%&) during
11012 the ACL malware condition.
11013
11014 .vitem &$body_linecount$&
11015 .cindex "message body" "line count"
11016 .cindex "body of message" "line count"
11017 .vindex "&$body_linecount$&"
11018 When a message is being received or delivered, this variable contains the
11019 number of lines in the message's body. See also &$message_linecount$&.
11020
11021 .vitem &$body_zerocount$&
11022 .cindex "message body" "binary zero count"
11023 .cindex "body of message" "binary zero count"
11024 .cindex "binary zero" "in message body"
11025 .vindex "&$body_zerocount$&"
11026 When a message is being received or delivered, this variable contains the
11027 number of binary zero bytes (ASCII NULs) in the message's body.
11028
11029 .vitem &$bounce_recipient$&
11030 .vindex "&$bounce_recipient$&"
11031 This is set to the recipient address of a bounce message while Exim is creating
11032 it. It is useful if a customized bounce message text file is in use (see
11033 chapter &<<CHAPemsgcust>>&).
11034
11035 .vitem &$bounce_return_size_limit$&
11036 .vindex "&$bounce_return_size_limit$&"
11037 This contains the value set in the &%bounce_return_size_limit%& option, rounded
11038 up to a multiple of 1000. It is useful when a customized error message text
11039 file is in use (see chapter &<<CHAPemsgcust>>&).
11040
11041 .vitem &$caller_gid$&
11042 .cindex "gid (group id)" "caller"
11043 .vindex "&$caller_gid$&"
11044 The real group id under which the process that called Exim was running. This is
11045 not the same as the group id of the originator of a message (see
11046 &$originator_gid$&). If Exim re-execs itself, this variable in the new
11047 incarnation normally contains the Exim gid.
11048
11049 .vitem &$caller_uid$&
11050 .cindex "uid (user id)" "caller"
11051 .vindex "&$caller_uid$&"
11052 The real user id under which the process that called Exim was running. This is
11053 not the same as the user id of the originator of a message (see
11054 &$originator_uid$&). If Exim re-execs itself, this variable in the new
11055 incarnation normally contains the Exim uid.
11056
11057 .vitem &$compile_date$&
11058 .vindex "&$compile_date$&"
11059 The date on which the Exim binary was compiled.
11060
11061 .vitem &$compile_number$&
11062 .vindex "&$compile_number$&"
11063 The building process for Exim keeps a count of the number
11064 of times it has been compiled. This serves to distinguish different
11065 compilations of the same version of the program.
11066
11067 .vitem &$demime_errorlevel$&
11068 .vindex "&$demime_errorlevel$&"
11069 This variable is available when Exim is compiled with
11070 the content-scanning extension and the obsolete &%demime%& condition. For
11071 details, see section &<<SECTdemimecond>>&.
11072
11073 .vitem &$demime_reason$&
11074 .vindex "&$demime_reason$&"
11075 This variable is available when Exim is compiled with the
11076 content-scanning extension and the obsolete &%demime%& condition. For details,
11077 see section &<<SECTdemimecond>>&.
11078
11079 .vitem &$dnslist_domain$& &&&
11080        &$dnslist_matched$& &&&
11081        &$dnslist_text$& &&&
11082        &$dnslist_value$&
11083 .vindex "&$dnslist_domain$&"
11084 .vindex "&$dnslist_matched$&"
11085 .vindex "&$dnslist_text$&"
11086 .vindex "&$dnslist_value$&"
11087 .cindex "black list (DNS)"
11088 When a DNS (black) list lookup succeeds, these variables are set to contain
11089 the following data from the lookup: the list's domain name, the key that was
11090 looked up, the contents of any associated TXT record, and the value from the
11091 main A record. See section &<<SECID204>>& for more details.
11092
11093 .vitem &$domain$&
11094 .vindex "&$domain$&"
11095 When an address is being routed, or delivered on its own, this variable
11096 contains the domain. Uppercase letters in the domain are converted into lower
11097 case for &$domain$&.
11098
11099 Global address rewriting happens when a message is received, so the value of
11100 &$domain$& during routing and delivery is the value after rewriting. &$domain$&
11101 is set during user filtering, but not during system filtering, because a
11102 message may have many recipients and the system filter is called just once.
11103
11104 When more than one address is being delivered at once (for example, several
11105 RCPT commands in one SMTP delivery), &$domain$& is set only if they all
11106 have the same domain. Transports can be restricted to handling only one domain
11107 at a time if the value of &$domain$& is required at transport time &-- this is
11108 the default for local transports. For further details of the environment in
11109 which local transports are run, see chapter &<<CHAPenvironment>>&.
11110
11111 .oindex "&%delay_warning_condition%&"
11112 At the end of a delivery, if all deferred addresses have the same domain, it is
11113 set in &$domain$& during the expansion of &%delay_warning_condition%&.
11114
11115 The &$domain$& variable is also used in some other circumstances:
11116
11117 .ilist
11118 When an ACL is running for a RCPT command, &$domain$& contains the domain of
11119 the recipient address. The domain of the &'sender'& address is in
11120 &$sender_address_domain$& at both MAIL time and at RCPT time. &$domain$& is not
11121 normally set during the running of the MAIL ACL. However, if the sender address
11122 is verified with a callout during the MAIL ACL, the sender domain is placed in
11123 &$domain$& during the expansions of &%hosts%&, &%interface%&, and &%port%& in
11124 the &(smtp)& transport.
11125
11126 .next
11127 When a rewrite item is being processed (see chapter &<<CHAPrewrite>>&),
11128 &$domain$& contains the domain portion of the address that is being rewritten;
11129 it can be used in the expansion of the replacement address, for example, to
11130 rewrite domains by file lookup.
11131
11132 .next
11133 With one important exception, whenever a domain list is being scanned,
11134 &$domain$& contains the subject domain. &*Exception*&: When a domain list in
11135 a &%sender_domains%& condition in an ACL is being processed, the subject domain
11136 is in &$sender_address_domain$& and not in &$domain$&. It works this way so
11137 that, in a RCPT ACL, the sender domain list can be dependent on the
11138 recipient domain (which is what is in &$domain$& at this time).
11139
11140 .next
11141 .cindex "ETRN" "value of &$domain$&"
11142 .oindex "&%smtp_etrn_command%&"
11143 When the &%smtp_etrn_command%& option is being expanded, &$domain$& contains
11144 the complete argument of the ETRN command (see section &<<SECTETRN>>&).
11145 .endlist
11146
11147
11148 .vitem &$domain_data$&
11149 .vindex "&$domain_data$&"
11150 When the &%domains%& option on a router matches a domain by
11151 means of a lookup, the data read by the lookup is available during the running
11152 of the router as &$domain_data$&. In addition, if the driver routes the
11153 address to a transport, the value is available in that transport. If the
11154 transport is handling multiple addresses, the value from the first address is
11155 used.
11156
11157 &$domain_data$& is also set when the &%domains%& condition in an ACL matches a
11158 domain by means of a lookup. The data read by the lookup is available during
11159 the rest of the ACL statement. In all other situations, this variable expands
11160 to nothing.
11161
11162 .vitem &$exim_gid$&
11163 .vindex "&$exim_gid$&"
11164 This variable contains the numerical value of the Exim group id.
11165
11166 .vitem &$exim_path$&
11167 .vindex "&$exim_path$&"
11168 This variable contains the path to the Exim binary.
11169
11170 .vitem &$exim_uid$&
11171 .vindex "&$exim_uid$&"
11172 This variable contains the numerical value of the Exim user id.
11173
11174 .vitem &$found_extension$&
11175 .vindex "&$found_extension$&"
11176 This variable is available when Exim is compiled with the
11177 content-scanning extension and the obsolete &%demime%& condition. For details,
11178 see section &<<SECTdemimecond>>&.
11179
11180 .vitem &$header_$&<&'name'&>
11181 This is not strictly an expansion variable. It is expansion syntax for
11182 inserting the message header line with the given name. Note that the name must
11183 be terminated by colon or white space, because it may contain a wide variety of
11184 characters. Note also that braces must &'not'& be used.
11185
11186 .vitem &$headers_added$&
11187 .vindex "&$headers_added$&"
11188 Within an ACL this variable contains the headers added so far by
11189 the ACL modifier add_header (section &<<SECTaddheadacl>>&).
11190 The headers are a newline-separated list.
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 .vitem &$router_name$&
11863 .cindex "router" "name"
11864 .cindex "name" "of router"
11865 .vindex "&$router_name$&"
11866 During the running of a router this variable contains its name.
11867
11868 .vitem &$runrc$&
11869 .cindex "return code" "from &%run%& expansion"
11870 .vindex "&$runrc$&"
11871 This variable contains the return code from a command that is run by the
11872 &%${run...}%& expansion item. &*Warning*&: In a router or transport, you cannot
11873 assume the order in which option values are expanded, except for those
11874 preconditions whose order of testing is documented. Therefore, you cannot
11875 reliably expect to set &$runrc$& by the expansion of one option, and use it in
11876 another.
11877
11878 .vitem &$self_hostname$&
11879 .oindex "&%self%&" "value of host name"
11880 .vindex "&$self_hostname$&"
11881 When an address is routed to a supposedly remote host that turns out to be the
11882 local host, what happens is controlled by the &%self%& generic router option.
11883 One of its values causes the address to be passed to another router. When this
11884 happens, &$self_hostname$& is set to the name of the local host that the
11885 original router encountered. In other circumstances its contents are null.
11886
11887 .vitem &$sender_address$&
11888 .vindex "&$sender_address$&"
11889 When a message is being processed, this variable contains the sender's address
11890 that was received in the message's envelope. The case of letters in the address
11891 is retained, in both the local part and the domain. For bounce messages, the
11892 value of this variable is the empty string. See also &$return_path$&.
11893
11894 .vitem &$sender_address_data$&
11895 .vindex "&$address_data$&"
11896 .vindex "&$sender_address_data$&"
11897 If &$address_data$& is set when the routers are called from an ACL to verify a
11898 sender address, the final value is preserved in &$sender_address_data$&, to
11899 distinguish it from data from a recipient address. The value does not persist
11900 after the end of the current ACL statement. If you want to preserve it for
11901 longer, you can save it in an ACL variable.
11902
11903 .vitem &$sender_address_domain$&
11904 .vindex "&$sender_address_domain$&"
11905 The domain portion of &$sender_address$&.
11906
11907 .vitem &$sender_address_local_part$&
11908 .vindex "&$sender_address_local_part$&"
11909 The local part portion of &$sender_address$&.
11910
11911 .vitem &$sender_data$&
11912 .vindex "&$sender_data$&"
11913 This variable is set after a lookup success in an ACL &%senders%& condition or
11914 in a router &%senders%& option. It contains the data from the lookup, and the
11915 value remains set until the next &%senders%& test. Thus, you can do things like
11916 this:
11917 .display
11918 &`require senders      = cdb*@;/some/file`&
11919 &`deny    `&&'some further test involving'& &`$sender_data`&
11920 .endd
11921 &*Warning*&: This variable is set only when a lookup is used as an indexing
11922 method in the address list, using the semicolon syntax as in the example above.
11923 The variable is not set for a lookup that is used as part of the string
11924 expansion that all such lists undergo before being interpreted.
11925
11926 .vitem &$sender_fullhost$&
11927 .vindex "&$sender_fullhost$&"
11928 When a message is received from a remote host, this variable contains the host
11929 name and IP address in a single string. It ends with the IP address in square
11930 brackets, followed by a colon and a port number if the logging of ports is
11931 enabled. The format of the rest of the string depends on whether the host
11932 issued a HELO or EHLO SMTP command, and whether the host name was verified by
11933 looking up its IP address. (Looking up the IP address can be forced by the
11934 &%host_lookup%& option, independent of verification.) A plain host name at the
11935 start of the string is a verified host name; if this is not present,
11936 verification either failed or was not requested. A host name in parentheses is
11937 the argument of a HELO or EHLO command. This is omitted if it is identical to
11938 the verified host name or to the host's IP address in square brackets.
11939
11940 .vitem &$sender_helo_name$&
11941 .vindex "&$sender_helo_name$&"
11942 When a message is received from a remote host that has issued a HELO or EHLO
11943 command, the argument of that command is placed in this variable. It is also
11944 set if HELO or EHLO is used when a message is received using SMTP locally via
11945 the &%-bs%& or &%-bS%& options.
11946
11947 .vitem &$sender_host_address$&
11948 .vindex "&$sender_host_address$&"
11949 When a message is received from a remote host, this variable contains that
11950 host's IP address. For locally submitted messages, it is empty.
11951
11952 .vitem &$sender_host_authenticated$&
11953 .vindex "&$sender_host_authenticated$&"
11954 This variable contains the name (not the public name) of the authenticator
11955 driver that successfully authenticated the client from which the message was
11956 received. It is empty if there was no successful authentication. See also
11957 &$authenticated_id$&.
11958
11959 .vitem &$sender_host_dnssec$&
11960 .vindex "&$sender_host_dnssec$&"
11961 If &$sender_host_name$& has been populated (by reference, &%hosts_lookup%& or
11962 otherwise) then this boolean will have been set true if, and only if, the
11963 resolver library states that the reverse DNS was authenticated data.  At all
11964 other times, this variable is false.
11965
11966 It is likely that you will need to coerce DNSSEC support on in the resolver
11967 library, by setting:
11968 .code
11969 dns_dnssec_ok = 1
11970 .endd
11971
11972 Exim does not perform DNSSEC validation itself, instead leaving that to a
11973 validating resolver (eg, unbound, or bind with suitable configuration).
11974
11975 Exim does not (currently) check to see if the forward DNS was also secured
11976 with DNSSEC, only the reverse DNS.
11977
11978 If you have changed &%host_lookup_order%& so that &`bydns`& is not the first
11979 mechanism in the list, then this variable will be false.
11980
11981
11982 .vitem &$sender_host_name$&
11983 .vindex "&$sender_host_name$&"
11984 When a message is received from a remote host, this variable contains the
11985 host's name as obtained by looking up its IP address. For messages received by
11986 other means, this variable is empty.
11987
11988 .vindex "&$host_lookup_failed$&"
11989 If the host name has not previously been looked up, a reference to
11990 &$sender_host_name$& triggers a lookup (for messages from remote hosts).
11991 A looked up name is accepted only if it leads back to the original IP address
11992 via a forward lookup. If either the reverse or the forward lookup fails to find
11993 any data, or if the forward lookup does not yield the original IP address,
11994 &$sender_host_name$& remains empty, and &$host_lookup_failed$& is set to &"1"&.
11995
11996 .vindex "&$host_lookup_deferred$&"
11997 However, if either of the lookups cannot be completed (for example, there is a
11998 DNS timeout), &$host_lookup_deferred$& is set to &"1"&, and
11999 &$host_lookup_failed$& remains set to &"0"&.
12000
12001 Once &$host_lookup_failed$& is set to &"1"&, Exim does not try to look up the
12002 host name again if there is a subsequent reference to &$sender_host_name$&
12003 in the same Exim process, but it does try again if &$host_lookup_deferred$&
12004 is set to &"1"&.
12005
12006 Exim does not automatically look up every calling host's name. If you want
12007 maximum efficiency, you should arrange your configuration so that it avoids
12008 these lookups altogether. The lookup happens only if one or more of the
12009 following are true:
12010
12011 .ilist
12012 A string containing &$sender_host_name$& is expanded.
12013 .next
12014 The calling host matches the list in &%host_lookup%&. In the default
12015 configuration, this option is set to *, so it must be changed if lookups are
12016 to be avoided. (In the code, the default for &%host_lookup%& is unset.)
12017 .next
12018 Exim needs the host name in order to test an item in a host list. The items
12019 that require this are described in sections &<<SECThoslispatnam>>& and
12020 &<<SECThoslispatnamsk>>&.
12021 .next
12022 The calling host matches &%helo_try_verify_hosts%& or &%helo_verify_hosts%&.
12023 In this case, the host name is required to compare with the name quoted in any
12024 EHLO or HELO commands that the client issues.
12025 .next
12026 The remote host issues a EHLO or HELO command that quotes one of the
12027 domains in &%helo_lookup_domains%&. The default value of this option is
12028 . ==== As this is a nested list, any displays it contains must be indented
12029 . ==== as otherwise they are too far to the left.
12030 .code
12031   helo_lookup_domains = @ : @[]
12032 .endd
12033 which causes a lookup if a remote host (incorrectly) gives the server's name or
12034 IP address in an EHLO or HELO command.
12035 .endlist
12036
12037
12038 .vitem &$sender_host_port$&
12039 .vindex "&$sender_host_port$&"
12040 When a message is received from a remote host, this variable contains the port
12041 number that was used on the remote host.
12042
12043 .vitem &$sender_ident$&
12044 .vindex "&$sender_ident$&"
12045 When a message is received from a remote host, this variable contains the
12046 identification received in response to an RFC 1413 request. When a message has
12047 been received locally, this variable contains the login name of the user that
12048 called Exim.
12049
12050 .vitem &$sender_rate_$&&'xxx'&
12051 A number of variables whose names begin &$sender_rate_$& are set as part of the
12052 &%ratelimit%& ACL condition. Details are given in section
12053 &<<SECTratelimiting>>&.
12054
12055 .vitem &$sender_rcvhost$&
12056 .cindex "DNS" "reverse lookup"
12057 .cindex "reverse DNS lookup"
12058 .vindex "&$sender_rcvhost$&"
12059 This is provided specifically for use in &'Received:'& headers. It starts with
12060 either the verified host name (as obtained from a reverse DNS lookup) or, if
12061 there is no verified host name, the IP address in square brackets. After that
12062 there may be text in parentheses. When the first item is a verified host name,
12063 the first thing in the parentheses is the IP address in square brackets,
12064 followed by a colon and a port number if port logging is enabled. When the
12065 first item is an IP address, the port is recorded as &"port=&'xxxx'&"& inside
12066 the parentheses.
12067
12068 There may also be items of the form &"helo=&'xxxx'&"& if HELO or EHLO
12069 was used and its argument was not identical to the real host name or IP
12070 address, and &"ident=&'xxxx'&"& if an RFC 1413 ident string is available. If
12071 all three items are present in the parentheses, a newline and tab are inserted
12072 into the string, to improve the formatting of the &'Received:'& header.
12073
12074 .vitem &$sender_verify_failure$&
12075 .vindex "&$sender_verify_failure$&"
12076 In an ACL, when a sender verification fails, this variable contains information
12077 about the failure. The details are the same as for
12078 &$recipient_verify_failure$&.
12079
12080 .vitem &$sending_ip_address$&
12081 .vindex "&$sending_ip_address$&"
12082 This variable is set whenever an outgoing SMTP connection to another host has
12083 been set up. It contains the IP address of the local interface that is being
12084 used. This is useful if a host that has more than one IP address wants to take
12085 on different personalities depending on which one is being used. For incoming
12086 connections, see &$received_ip_address$&.
12087
12088 .vitem &$sending_port$&
12089 .vindex "&$sending_port$&"
12090 This variable is set whenever an outgoing SMTP connection to another host has
12091 been set up. It contains the local port that is being used. For incoming
12092 connections, see &$received_port$&.
12093
12094 .vitem &$smtp_active_hostname$&
12095 .vindex "&$smtp_active_hostname$&"
12096 During an incoming SMTP session, this variable contains the value of the active
12097 host name, as specified by the &%smtp_active_hostname%& option. The value of
12098 &$smtp_active_hostname$& is saved with any message that is received, so its
12099 value can be consulted during routing and delivery.
12100
12101 .vitem &$smtp_command$&
12102 .vindex "&$smtp_command$&"
12103 During the processing of an incoming SMTP command, this variable contains the
12104 entire command. This makes it possible to distinguish between HELO and EHLO in
12105 the HELO ACL, and also to distinguish between commands such as these:
12106 .code
12107 MAIL FROM:<>
12108 MAIL FROM: <>
12109 .endd
12110 For a MAIL command, extra parameters such as SIZE can be inspected. For a RCPT
12111 command, the address in &$smtp_command$& is the original address before any
12112 rewriting, whereas the values in &$local_part$& and &$domain$& are taken from
12113 the address after SMTP-time rewriting.
12114
12115 .vitem &$smtp_command_argument$&
12116 .cindex "SMTP" "command, argument for"
12117 .vindex "&$smtp_command_argument$&"
12118 While an ACL is running to check an SMTP command, this variable contains the
12119 argument, that is, the text that follows the command name, with leading white
12120 space removed. Following the introduction of &$smtp_command$&, this variable is
12121 somewhat redundant, but is retained for backwards compatibility.
12122
12123 .vitem &$smtp_count_at_connection_start$&
12124 .vindex "&$smtp_count_at_connection_start$&"
12125 This variable is set greater than zero only in processes spawned by the Exim
12126 daemon for handling incoming SMTP connections. The name is deliberately long,
12127 in order to emphasize what the contents are. When the daemon accepts a new
12128 connection, it increments this variable. A copy of the variable is passed to
12129 the child process that handles the connection, but its value is fixed, and
12130 never changes. It is only an approximation of how many incoming connections
12131 there actually are, because many other connections may come and go while a
12132 single connection is being processed. When a child process terminates, the
12133 daemon decrements its copy of the variable.
12134
12135 .vitem "&$sn0$& &-- &$sn9$&"
12136 These variables are copies of the values of the &$n0$& &-- &$n9$& accumulators
12137 that were current at the end of the system filter file. This allows a system
12138 filter file to set values that can be tested in users' filter files. For
12139 example, a system filter could set a value indicating how likely it is that a
12140 message is junk mail.
12141
12142 .vitem &$spam_$&&'xxx'&
12143 A number of variables whose names start with &$spam$& are available when Exim
12144 is compiled with the content-scanning extension. For details, see section
12145 &<<SECTscanspamass>>&.
12146
12147
12148 .vitem &$spool_directory$&
12149 .vindex "&$spool_directory$&"
12150 The name of Exim's spool directory.
12151
12152 .vitem &$spool_inodes$&
12153 .vindex "&$spool_inodes$&"
12154 The number of free inodes in the disk partition where Exim's spool files are
12155 being written. The value is recalculated whenever the variable is referenced.
12156 If the relevant file system does not have the concept of inodes, the value of
12157 is -1. See also the &%check_spool_inodes%& option.
12158
12159 .vitem &$spool_space$&
12160 .vindex "&$spool_space$&"
12161 The amount of free space (as a number of kilobytes) in the disk partition where
12162 Exim's spool files are being written. The value is recalculated whenever the
12163 variable is referenced. If the operating system does not have the ability to
12164 find the amount of free space (only true for experimental systems), the space
12165 value is -1. For example, to check in an ACL that there is at least 50
12166 megabytes free on the spool, you could write:
12167 .code
12168 condition = ${if > {$spool_space}{50000}}
12169 .endd
12170 See also the &%check_spool_space%& option.
12171
12172
12173 .vitem &$thisaddress$&
12174 .vindex "&$thisaddress$&"
12175 This variable is set only during the processing of the &%foranyaddress%&
12176 command in a filter file. Its use is explained in the description of that
12177 command, which can be found in the separate document entitled &'Exim's
12178 interfaces to mail filtering'&.
12179
12180 .vitem &$tls_in_bits$&
12181 .vindex "&$tls_in_bits$&"
12182 Contains an approximation of the TLS cipher's bit-strength
12183 on the inbound connection; the meaning of
12184 this depends upon the TLS implementation used.
12185 If TLS has not been negotiated, the value will be 0.
12186 The value of this is automatically fed into the Cyrus SASL authenticator
12187 when acting as a server, to specify the "external SSF" (a SASL term).
12188
12189 The deprecated &$tls_bits$& variable refers to the inbound side
12190 except when used in the context of an outbound SMTP delivery, when it refers to
12191 the outbound.
12192
12193 .vitem &$tls_out_bits$&
12194 .vindex "&$tls_out_bits$&"
12195 Contains an approximation of the TLS cipher's bit-strength
12196 on an outbound SMTP connection; the meaning of
12197 this depends upon the TLS implementation used.
12198 If TLS has not been negotiated, the value will be 0.
12199
12200 .vitem &$tls_in_certificate_verified$&
12201 .vindex "&$tls_in_certificate_verified$&"
12202 This variable is set to &"1"& if a TLS certificate was verified when the
12203 message was received, and &"0"& otherwise.
12204
12205 The deprecated &$tls_certificate_verfied$& variable refers to the inbound side
12206 except when used in the context of an outbound SMTP delivery, when it refers to
12207 the outbound.
12208
12209 .vitem &$tls_out_certificate_verified$&
12210 .vindex "&$tls_out_certificate_verified$&"
12211 This variable is set to &"1"& if a TLS certificate was verified when an
12212 outbound SMTP connection was made,
12213 and &"0"& otherwise.
12214
12215 .vitem &$tls_in_cipher$&
12216 .vindex "&$tls_in_cipher$&"
12217 .vindex "&$tls_cipher$&"
12218 When a message is received from a remote host over an encrypted SMTP
12219 connection, this variable is set to the cipher suite that was negotiated, for
12220 example DES-CBC3-SHA. In other circumstances, in particular, for message
12221 received over unencrypted connections, the variable is empty. Testing
12222 &$tls_cipher$& for emptiness is one way of distinguishing between encrypted and
12223 non-encrypted connections during ACL processing.
12224
12225 The deprecated &$tls_cipher$& variable is the same as &$tls_in_cipher$& during message reception,
12226 but in the context of an outward SMTP delivery taking place via the &(smtp)& transport
12227 becomes the same as &$tls_out_cipher$&.
12228
12229 .vitem &$tls_out_cipher$&
12230 .vindex "&$tls_out_cipher$&"
12231 This variable is
12232 cleared before any outgoing SMTP connection is made,
12233 and then set to the outgoing cipher suite if one is negotiated. See chapter
12234 &<<CHAPTLS>>& for details of TLS support and chapter &<<CHAPsmtptrans>>& for
12235 details of the &(smtp)& transport.
12236
12237 .vitem &$tls_in_peerdn$&
12238 .vindex "&$tls_in_peerdn$&"
12239 .vindex "&$tls_peerdn$&"
12240 When a message is received from a remote host over an encrypted SMTP
12241 connection, and Exim is configured to request a certificate from the client,
12242 the value of the Distinguished Name of the certificate is made available in the
12243 &$tls_in_peerdn$& during subsequent processing.
12244
12245 The deprecated &$tls_peerdn$& variable refers to the inbound side
12246 except when used in the context of an outbound SMTP delivery, when it refers to
12247 the outbound.
12248
12249 .vitem &$tls_out_peerdn$&
12250 .vindex "&$tls_out_peerdn$&"
12251 When a message is being delivered to a remote host over an encrypted SMTP
12252 connection, and Exim is configured to request a certificate from the server,
12253 the value of the Distinguished Name of the certificate is made available in the
12254 &$tls_out_peerdn$& during subsequent processing.
12255
12256 .vitem &$tls_in_sni$&
12257 .vindex "&$tls_in_sni$&"
12258 .vindex "&$tls_sni$&"
12259 .cindex "TLS" "Server Name Indication"
12260 When a TLS session is being established, if the client sends the Server
12261 Name Indication extension, the value will be placed in this variable.
12262 If the variable appears in &%tls_certificate%& then this option and
12263 some others, described in &<<SECTtlssni>>&,
12264 will be re-expanded early in the TLS session, to permit
12265 a different certificate to be presented (and optionally a different key to be
12266 used) to the client, based upon the value of the SNI extension.
12267
12268 The deprecated &$tls_sni$& variable refers to the inbound side
12269 except when used in the context of an outbound SMTP delivery, when it refers to
12270 the outbound.
12271
12272 .vitem &$tls_out_sni$&
12273 .vindex "&$tls_out_sni$&"
12274 .cindex "TLS" "Server Name Indication"
12275 During outbound
12276 SMTP deliveries, this variable reflects the value of the &%tls_sni%& option on
12277 the transport.
12278
12279 .vitem &$tod_bsdinbox$&
12280 .vindex "&$tod_bsdinbox$&"
12281 The time of day and the date, in the format required for BSD-style mailbox
12282 files, for example: Thu Oct 17 17:14:09 1995.
12283
12284 .vitem &$tod_epoch$&
12285 .vindex "&$tod_epoch$&"
12286 The time and date as a number of seconds since the start of the Unix epoch.
12287
12288 .vitem &$tod_epoch_l$&
12289 .vindex "&$tod_epoch_l$&"
12290 The time and date as a number of microseconds since the start of the Unix epoch.
12291
12292 .vitem &$tod_full$&
12293 .vindex "&$tod_full$&"
12294 A full version of the time and date, for example: Wed, 16 Oct 1995 09:51:40
12295 +0100. The timezone is always given as a numerical offset from UTC, with
12296 positive values used for timezones that are ahead (east) of UTC, and negative
12297 values for those that are behind (west).
12298
12299 .vitem &$tod_log$&
12300 .vindex "&$tod_log$&"
12301 The time and date in the format used for writing Exim's log files, for example:
12302 1995-10-12 15:32:29, but without a timezone.
12303
12304 .vitem &$tod_logfile$&
12305 .vindex "&$tod_logfile$&"
12306 This variable contains the date in the format yyyymmdd. This is the format that
12307 is used for datestamping log files when &%log_file_path%& contains the &`%D`&
12308 flag.
12309
12310 .vitem &$tod_zone$&
12311 .vindex "&$tod_zone$&"
12312 This variable contains the numerical value of the local timezone, for example:
12313 -0500.
12314
12315 .vitem &$tod_zulu$&
12316 .vindex "&$tod_zulu$&"
12317 This variable contains the UTC date and time in &"Zulu"& format, as specified
12318 by ISO 8601, for example: 20030221154023Z.
12319
12320 .vitem &$transport_name$&
12321 .cindex "transport" "name"
12322 .cindex "name" "of transport"
12323 .vindex "&$transport_name$&"
12324 During the running of a transport, this variable contains its name.
12325
12326 .vitem &$value$&
12327 .vindex "&$value$&"
12328 This variable contains the result of an expansion lookup, extraction operation,
12329 or external command, as described above. It is also used during a
12330 &*reduce*& expansion.
12331
12332 .vitem &$version_number$&
12333 .vindex "&$version_number$&"
12334 The version number of Exim.
12335
12336 .vitem &$warn_message_delay$&
12337 .vindex "&$warn_message_delay$&"
12338 This variable is set only during the creation of a message warning about a
12339 delivery delay. Details of its use are explained in section &<<SECTcustwarn>>&.
12340
12341 .vitem &$warn_message_recipients$&
12342 .vindex "&$warn_message_recipients$&"
12343 This variable is set only during the creation of a message warning about a
12344 delivery delay. Details of its use are explained in section &<<SECTcustwarn>>&.
12345 .endlist
12346 .ecindex IIDstrexp
12347
12348
12349
12350 . ////////////////////////////////////////////////////////////////////////////
12351 . ////////////////////////////////////////////////////////////////////////////
12352
12353 .chapter "Embedded Perl" "CHAPperl"
12354 .scindex IIDperl "Perl" "calling from Exim"
12355 Exim can be built to include an embedded Perl interpreter. When this is done,
12356 Perl subroutines can be called as part of the string expansion process. To make
12357 use of the Perl support, you need version 5.004 or later of Perl installed on
12358 your system. To include the embedded interpreter in the Exim binary, include
12359 the line
12360 .code
12361 EXIM_PERL = perl.o
12362 .endd
12363 in your &_Local/Makefile_& and then build Exim in the normal way.
12364
12365
12366 .section "Setting up so Perl can be used" "SECID85"
12367 .oindex "&%perl_startup%&"
12368 Access to Perl subroutines is via a global configuration option called
12369 &%perl_startup%& and an expansion string operator &%${perl ...}%&. If there is
12370 no &%perl_startup%& option in the Exim configuration file then no Perl
12371 interpreter is started and there is almost no overhead for Exim (since none of
12372 the Perl library will be paged in unless used). If there is a &%perl_startup%&
12373 option then the associated value is taken to be Perl code which is executed in
12374 a newly created Perl interpreter.
12375
12376 The value of &%perl_startup%& is not expanded in the Exim sense, so you do not
12377 need backslashes before any characters to escape special meanings. The option
12378 should usually be something like
12379 .code
12380 perl_startup = do '/etc/exim.pl'
12381 .endd
12382 where &_/etc/exim.pl_& is Perl code which defines any subroutines you want to
12383 use from Exim. Exim can be configured either to start up a Perl interpreter as
12384 soon as it is entered, or to wait until the first time it is needed. Starting
12385 the interpreter at the beginning ensures that it is done while Exim still has
12386 its setuid privilege, but can impose an unnecessary overhead if Perl is not in
12387 fact used in a particular run. Also, note that this does not mean that Exim is
12388 necessarily running as root when Perl is called at a later time. By default,
12389 the interpreter is started only when it is needed, but this can be changed in
12390 two ways:
12391
12392 .ilist
12393 .oindex "&%perl_at_start%&"
12394 Setting &%perl_at_start%& (a boolean option) in the configuration requests
12395 a startup when Exim is entered.
12396 .next
12397 The command line option &%-ps%& also requests a startup when Exim is entered,
12398 overriding the setting of &%perl_at_start%&.
12399 .endlist
12400
12401 There is also a command line option &%-pd%& (for delay) which suppresses the
12402 initial startup, even if &%perl_at_start%& is set.
12403
12404
12405 .section "Calling Perl subroutines" "SECID86"
12406 When the configuration file includes a &%perl_startup%& option you can make use
12407 of the string expansion item to call the Perl subroutines that are defined
12408 by the &%perl_startup%& code. The operator is used in any of the following
12409 forms:
12410 .code
12411 ${perl{foo}}
12412 ${perl{foo}{argument}}
12413 ${perl{foo}{argument1}{argument2} ... }
12414 .endd
12415 which calls the subroutine &%foo%& with the given arguments. A maximum of eight
12416 arguments may be passed. Passing more than this results in an expansion failure
12417 with an error message of the form
12418 .code
12419 Too many arguments passed to Perl subroutine "foo" (max is 8)
12420 .endd
12421 The return value of the Perl subroutine is evaluated in a scalar context before
12422 it is passed back to Exim to be inserted into the expanded string. If the
12423 return value is &'undef'&, the expansion is forced to fail in the same way as
12424 an explicit &"fail"& on an &%if%& or &%lookup%& item. If the subroutine aborts
12425 by obeying Perl's &%die%& function, the expansion fails with the error message
12426 that was passed to &%die%&.
12427
12428
12429 .section "Calling Exim functions from Perl" "SECID87"
12430 Within any Perl code called from Exim, the function &'Exim::expand_string()'&
12431 is available to call back into Exim's string expansion function. For example,
12432 the Perl code
12433 .code
12434 my $lp = Exim::expand_string('$local_part');
12435 .endd
12436 makes the current Exim &$local_part$& available in the Perl variable &$lp$&.
12437 Note those are single quotes and not double quotes to protect against
12438 &$local_part$& being interpolated as a Perl variable.
12439
12440 If the string expansion is forced to fail by a &"fail"& item, the result of
12441 &'Exim::expand_string()'& is &%undef%&. If there is a syntax error in the
12442 expansion string, the Perl call from the original expansion string fails with
12443 an appropriate error message, in the same way as if &%die%& were used.
12444
12445 .cindex "debugging" "from embedded Perl"
12446 .cindex "log" "writing from embedded Perl"
12447 Two other Exim functions are available for use from within Perl code.
12448 &'Exim::debug_write()'& writes a string to the standard error stream if Exim's
12449 debugging is enabled. If you want a newline at the end, you must supply it.
12450 &'Exim::log_write()'& writes a string to Exim's main log, adding a leading
12451 timestamp. In this case, you should not supply a terminating newline.
12452
12453
12454 .section "Use of standard output and error by Perl" "SECID88"
12455 .cindex "Perl" "standard output and error"
12456 You should not write to the standard error or output streams from within your
12457 Perl code, as it is not defined how these are set up. In versions of Exim
12458 before 4.50, it is possible for the standard output or error to refer to the
12459 SMTP connection during message reception via the daemon. Writing to this stream
12460 is certain to cause chaos. From Exim 4.50 onwards, the standard output and
12461 error streams are connected to &_/dev/null_& in the daemon. The chaos is
12462 avoided, but the output is lost.
12463
12464 .cindex "Perl" "use of &%warn%&"
12465 The Perl &%warn%& statement writes to the standard error stream by default.
12466 Calls to &%warn%& may be embedded in Perl modules that you use, but over which
12467 you have no control. When Exim starts up the Perl interpreter, it arranges for
12468 output from the &%warn%& statement to be written to the Exim main log. You can
12469 change this by including appropriate Perl magic somewhere in your Perl code.
12470 For example, to discard &%warn%& output completely, you need this:
12471 .code
12472 $SIG{__WARN__} = sub { };
12473 .endd
12474 Whenever a &%warn%& is obeyed, the anonymous subroutine is called. In this
12475 example, the code for the subroutine is empty, so it does nothing, but you can
12476 include any Perl code that you like. The text of the &%warn%& message is passed
12477 as the first subroutine argument.
12478 .ecindex IIDperl
12479
12480
12481 . ////////////////////////////////////////////////////////////////////////////
12482 . ////////////////////////////////////////////////////////////////////////////
12483
12484 .chapter "Starting the daemon and the use of network interfaces" &&&
12485          "CHAPinterfaces" &&&
12486          "Starting the daemon"
12487 .cindex "daemon" "starting"
12488 .cindex "interface" "listening"
12489 .cindex "network interface"
12490 .cindex "interface" "network"
12491 .cindex "IP address" "for listening"
12492 .cindex "daemon" "listening IP addresses"
12493 .cindex "TCP/IP" "setting listening interfaces"
12494 .cindex "TCP/IP" "setting listening ports"
12495 A host that is connected to a TCP/IP network may have one or more physical
12496 hardware network interfaces. Each of these interfaces may be configured as one
12497 or more &"logical"& interfaces, which are the entities that a program actually
12498 works with. Each of these logical interfaces is associated with an IP address.
12499 In addition, TCP/IP software supports &"loopback"& interfaces (127.0.0.1 in
12500 IPv4 and ::1 in IPv6), which do not use any physical hardware. Exim requires
12501 knowledge about the host's interfaces for use in three different circumstances:
12502
12503 .olist
12504 When a listening daemon is started, Exim needs to know which interfaces
12505 and ports to listen on.
12506 .next
12507 When Exim is routing an address, it needs to know which IP addresses
12508 are associated with local interfaces. This is required for the correct
12509 processing of MX lists by removing the local host and others with the
12510 same or higher priority values. Also, Exim needs to detect cases
12511 when an address is routed to an IP address that in fact belongs to the
12512 local host. Unless the &%self%& router option or the &%allow_localhost%&
12513 option of the smtp transport is set (as appropriate), this is treated
12514 as an error situation.
12515 .next
12516 When Exim connects to a remote host, it may need to know which interface to use
12517 for the outgoing connection.
12518 .endlist
12519
12520
12521 Exim's default behaviour is likely to be appropriate in the vast majority
12522 of cases. If your host has only one interface, and you want all its IP
12523 addresses to be treated in the same way, and you are using only the
12524 standard SMTP port, you should not need to take any special action. The
12525 rest of this chapter does not apply to you.
12526
12527 In a more complicated situation you may want to listen only on certain
12528 interfaces, or on different ports, and for this reason there are a number of
12529 options that can be used to influence Exim's behaviour. The rest of this
12530 chapter describes how they operate.
12531
12532 When a message is received over TCP/IP, the interface and port that were
12533 actually used are set in &$received_ip_address$& and &$received_port$&.
12534
12535
12536
12537 .section "Starting a listening daemon" "SECID89"
12538 When a listening daemon is started (by means of the &%-bd%& command line
12539 option), the interfaces and ports on which it listens are controlled by the
12540 following options:
12541
12542 .ilist
12543 &%daemon_smtp_ports%& contains a list of default ports. (For backward
12544 compatibility, this option can also be specified in the singular.)
12545 .next
12546 &%local_interfaces%& contains list of interface IP addresses on which to
12547 listen. Each item may optionally also specify a port.
12548 .endlist
12549
12550 The default list separator in both cases is a colon, but this can be changed as
12551 described in section &<<SECTlistconstruct>>&. When IPv6 addresses are involved,
12552 it is usually best to change the separator to avoid having to double all the
12553 colons. For example:
12554 .code
12555 local_interfaces = <; 127.0.0.1 ; \
12556                       192.168.23.65 ; \
12557                       ::1 ; \
12558                       3ffe:ffff:836f::fe86:a061
12559 .endd
12560 There are two different formats for specifying a port along with an IP address
12561 in &%local_interfaces%&:
12562
12563 .olist
12564 The port is added onto the address with a dot separator. For example, to listen
12565 on port 1234 on two different IP addresses:
12566 .code
12567 local_interfaces = <; 192.168.23.65.1234 ; \
12568                       3ffe:ffff:836f::fe86:a061.1234
12569 .endd
12570 .next
12571 The IP address is enclosed in square brackets, and the port is added
12572 with a colon separator, for example:
12573 .code
12574 local_interfaces = <; [192.168.23.65]:1234 ; \
12575                       [3ffe:ffff:836f::fe86:a061]:1234
12576 .endd
12577 .endlist
12578
12579 When a port is not specified, the value of &%daemon_smtp_ports%& is used. The
12580 default setting contains just one port:
12581 .code
12582 daemon_smtp_ports = smtp
12583 .endd
12584 If more than one port is listed, each interface that does not have its own port
12585 specified listens on all of them. Ports that are listed in
12586 &%daemon_smtp_ports%& can be identified either by name (defined in
12587 &_/etc/services_&) or by number. However, when ports are given with individual
12588 IP addresses in &%local_interfaces%&, only numbers (not names) can be used.
12589
12590
12591
12592 .section "Special IP listening addresses" "SECID90"
12593 The addresses 0.0.0.0 and ::0 are treated specially. They are interpreted
12594 as &"all IPv4 interfaces"& and &"all IPv6 interfaces"&, respectively. In each
12595 case, Exim tells the TCP/IP stack to &"listen on all IPv&'x'& interfaces"&
12596 instead of setting up separate listening sockets for each interface. The
12597 default value of &%local_interfaces%& is
12598 .code
12599 local_interfaces = 0.0.0.0
12600 .endd
12601 when Exim is built without IPv6 support; otherwise it is:
12602 .code
12603 local_interfaces = <; ::0 ; 0.0.0.0
12604 .endd
12605 Thus, by default, Exim listens on all available interfaces, on the SMTP port.
12606
12607
12608
12609 .section "Overriding local_interfaces and daemon_smtp_ports" "SECID91"
12610 The &%-oX%& command line option can be used to override the values of
12611 &%daemon_smtp_ports%& and/or &%local_interfaces%& for a particular daemon
12612 instance. Another way of doing this would be to use macros and the &%-D%&
12613 option. However, &%-oX%& can be used by any admin user, whereas modification of
12614 the runtime configuration by &%-D%& is allowed only when the caller is root or
12615 exim.
12616
12617 The value of &%-oX%& is a list of items. The default colon separator can be
12618 changed in the usual way if required. If there are any items that do not
12619 contain dots or colons (that is, are not IP addresses), the value of
12620 &%daemon_smtp_ports%& is replaced by the list of those items. If there are any
12621 items that do contain dots or colons, the value of &%local_interfaces%& is
12622 replaced by those items. Thus, for example,
12623 .code
12624 -oX 1225
12625 .endd
12626 overrides &%daemon_smtp_ports%&, but leaves &%local_interfaces%& unchanged,
12627 whereas
12628 .code
12629 -oX 192.168.34.5.1125
12630 .endd
12631 overrides &%local_interfaces%&, leaving &%daemon_smtp_ports%& unchanged.
12632 (However, since &%local_interfaces%& now contains no items without ports, the
12633 value of &%daemon_smtp_ports%& is no longer relevant in this example.)
12634
12635
12636
12637 .section "Support for the obsolete SSMTP (or SMTPS) protocol" "SECTsupobssmt"
12638 .cindex "ssmtp protocol"
12639 .cindex "smtps protocol"
12640 .cindex "SMTP" "ssmtp protocol"
12641 .cindex "SMTP" "smtps protocol"
12642 Exim supports the obsolete SSMTP protocol (also known as SMTPS) that was used
12643 before the STARTTLS command was standardized for SMTP. Some legacy clients
12644 still use this protocol. If the &%tls_on_connect_ports%& option is set to a
12645 list of port numbers, connections to those ports must use SSMTP. The most
12646 common use of this option is expected to be
12647 .code
12648 tls_on_connect_ports = 465
12649 .endd
12650 because 465 is the usual port number used by the legacy clients. There is also
12651 a command line option &%-tls-on-connect%&, which forces all ports to behave in
12652 this way when a daemon is started.
12653
12654 &*Warning*&: Setting &%tls_on_connect_ports%& does not of itself cause the
12655 daemon to listen on those ports. You must still specify them in
12656 &%daemon_smtp_ports%&, &%local_interfaces%&, or the &%-oX%& option. (This is
12657 because &%tls_on_connect_ports%& applies to &%inetd%& connections as well as to
12658 connections via the daemon.)
12659
12660
12661
12662
12663 .section "IPv6 address scopes" "SECID92"
12664 .cindex "IPv6" "address scopes"
12665 IPv6 addresses have &"scopes"&, and a host with multiple hardware interfaces
12666 can, in principle, have the same link-local IPv6 address on different
12667 interfaces. Thus, additional information is needed, over and above the IP
12668 address, to distinguish individual interfaces. A convention of using a
12669 percent sign followed by something (often the interface name) has been
12670 adopted in some cases, leading to addresses like this:
12671 .code
12672 fe80::202:b3ff:fe03:45c1%eth0
12673 .endd
12674 To accommodate this usage, a percent sign followed by an arbitrary string is
12675 allowed at the end of an IPv6 address. By default, Exim calls &[getaddrinfo()]&
12676 to convert a textual IPv6 address for actual use. This function recognizes the
12677 percent convention in operating systems that support it, and it processes the
12678 address appropriately. Unfortunately, some older libraries have problems with
12679 &[getaddrinfo()]&. If
12680 .code
12681 IPV6_USE_INET_PTON=yes
12682 .endd
12683 is set in &_Local/Makefile_& (or an OS-dependent Makefile) when Exim is built,
12684 Exim uses &'inet_pton()'& to convert a textual IPv6 address for actual use,
12685 instead of &[getaddrinfo()]&. (Before version 4.14, it always used this
12686 function.) Of course, this means that the additional functionality of
12687 &[getaddrinfo()]& &-- recognizing scoped addresses &-- is lost.
12688
12689 .section "Disabling IPv6" "SECID93"
12690 .cindex "IPv6" "disabling"
12691 Sometimes it happens that an Exim binary that was compiled with IPv6 support is
12692 run on a host whose kernel does not support IPv6. The binary will fall back to
12693 using IPv4, but it may waste resources looking up AAAA records, and trying to
12694 connect to IPv6 addresses, causing delays to mail delivery. If you set the
12695 .oindex "&%disable_ipv6%&"
12696 &%disable_ipv6%& option true, even if the Exim binary has IPv6 support, no IPv6
12697 activities take place. AAAA records are never looked up, and any IPv6 addresses
12698 that are listed in &%local_interfaces%&, data for the &(manualroute)& router,
12699 etc. are ignored. If IP literals are enabled, the &(ipliteral)& router declines
12700 to handle IPv6 literal addresses.
12701
12702 On the other hand, when IPv6 is in use, there may be times when you want to
12703 disable it for certain hosts or domains. You can use the &%dns_ipv4_lookup%&
12704 option to globally suppress the lookup of AAAA records for specified domains,
12705 and you can use the &%ignore_target_hosts%& generic router option to ignore
12706 IPv6 addresses in an individual router.
12707
12708
12709
12710 .section "Examples of starting a listening daemon" "SECID94"
12711 The default case in an IPv6 environment is
12712 .code
12713 daemon_smtp_ports = smtp
12714 local_interfaces = <; ::0 ; 0.0.0.0
12715 .endd
12716 This specifies listening on the smtp port on all IPv6 and IPv4 interfaces.
12717 Either one or two sockets may be used, depending on the characteristics of
12718 the TCP/IP stack. (This is complicated and messy; for more information,
12719 read the comments in the &_daemon.c_& source file.)
12720
12721 To specify listening on ports 25 and 26 on all interfaces:
12722 .code
12723 daemon_smtp_ports = 25 : 26
12724 .endd
12725 (leaving &%local_interfaces%& at the default setting) or, more explicitly:
12726 .code
12727 local_interfaces = <; ::0.25     ; ::0.26 \
12728                       0.0.0.0.25 ; 0.0.0.0.26
12729 .endd
12730 To listen on the default port on all IPv4 interfaces, and on port 26 on the
12731 IPv4 loopback address only:
12732 .code
12733 local_interfaces = 0.0.0.0 : 127.0.0.1.26
12734 .endd
12735 To specify listening on the default port on specific interfaces only:
12736 .code
12737 local_interfaces = 10.0.0.67 : 192.168.34.67
12738 .endd
12739 &*Warning*&: Such a setting excludes listening on the loopback interfaces.
12740
12741
12742
12743 .section "Recognizing the local host" "SECTreclocipadd"
12744 The &%local_interfaces%& option is also used when Exim needs to determine
12745 whether or not an IP address refers to the local host. That is, the IP
12746 addresses of all the interfaces on which a daemon is listening are always
12747 treated as local.
12748
12749 For this usage, port numbers in &%local_interfaces%& are ignored. If either of
12750 the items 0.0.0.0 or ::0 are encountered, Exim gets a complete list of
12751 available interfaces from the operating system, and extracts the relevant
12752 (that is, IPv4 or IPv6) addresses to use for checking.
12753
12754 Some systems set up large numbers of virtual interfaces in order to provide
12755 many virtual web servers. In this situation, you may want to listen for
12756 email on only a few of the available interfaces, but nevertheless treat all
12757 interfaces as local when routing. You can do this by setting
12758 &%extra_local_interfaces%& to a list of IP addresses, possibly including the
12759 &"all"& wildcard values. These addresses are recognized as local, but are not
12760 used for listening. Consider this example:
12761 .code
12762 local_interfaces = <; 127.0.0.1 ; ::1 ; \
12763                       192.168.53.235 ; \
12764                       3ffe:2101:12:1:a00:20ff:fe86:a061
12765
12766 extra_local_interfaces = <; ::0 ; 0.0.0.0
12767 .endd
12768 The daemon listens on the loopback interfaces and just one IPv4 and one IPv6
12769 address, but all available interface addresses are treated as local when
12770 Exim is routing.
12771
12772 In some environments the local host name may be in an MX list, but with an IP
12773 address that is not assigned to any local interface. In other cases it may be
12774 desirable to treat other host names as if they referred to the local host. Both
12775 these cases can be handled by setting the &%hosts_treat_as_local%& option.
12776 This contains host names rather than IP addresses. When a host is referenced
12777 during routing, either via an MX record or directly, it is treated as the local
12778 host if its name matches &%hosts_treat_as_local%&, or if any of its IP
12779 addresses match &%local_interfaces%& or &%extra_local_interfaces%&.
12780
12781
12782
12783 .section "Delivering to a remote host" "SECID95"
12784 Delivery to a remote host is handled by the smtp transport. By default, it
12785 allows the system's TCP/IP functions to choose which interface to use (if
12786 there is more than one) when connecting to a remote host. However, the
12787 &%interface%& option can be set to specify which interface is used. See the
12788 description of the smtp transport in chapter &<<CHAPsmtptrans>>& for more
12789 details.
12790
12791
12792
12793
12794 . ////////////////////////////////////////////////////////////////////////////
12795 . ////////////////////////////////////////////////////////////////////////////
12796
12797 .chapter "Main configuration" "CHAPmainconfig"
12798 .scindex IIDconfima "configuration file" "main section"
12799 .scindex IIDmaiconf "main configuration"
12800 The first part of the run time configuration file contains three types of item:
12801
12802 .ilist
12803 Macro definitions: These lines start with an upper case letter. See section
12804 &<<SECTmacrodefs>>& for details of macro processing.
12805 .next
12806 Named list definitions: These lines start with one of the words &"domainlist"&,
12807 &"hostlist"&, &"addresslist"&, or &"localpartlist"&. Their use is described in
12808 section &<<SECTnamedlists>>&.
12809 .next
12810 Main configuration settings: Each setting occupies one line of the file
12811 (with possible continuations). If any setting is preceded by the word
12812 &"hide"&, the &%-bP%& command line option displays its value to admin users
12813 only. See section &<<SECTcos>>& for a description of the syntax of these option
12814 settings.
12815 .endlist
12816
12817 This chapter specifies all the main configuration options, along with their
12818 types and default values. For ease of finding a particular option, they appear
12819 in alphabetical order in section &<<SECTalomo>>& below. However, because there
12820 are now so many options, they are first listed briefly in functional groups, as
12821 an aid to finding the name of the option you are looking for. Some options are
12822 listed in more than one group.
12823
12824 .section "Miscellaneous" "SECID96"
12825 .table2
12826 .row &%bi_command%&                  "to run for &%-bi%& command line option"
12827 .row &%disable_ipv6%&                "do no IPv6 processing"
12828 .row &%keep_malformed%&              "for broken files &-- should not happen"
12829 .row &%localhost_number%&            "for unique message ids in clusters"
12830 .row &%message_body_newlines%&       "retain newlines in &$message_body$&"
12831 .row &%message_body_visible%&        "how much to show in &$message_body$&"
12832 .row &%mua_wrapper%&                 "run in &""MUA wrapper""& mode"
12833 .row &%print_topbitchars%&           "top-bit characters are printing"
12834 .row &%timezone%&                    "force time zone"
12835 .endtable
12836
12837
12838 .section "Exim parameters" "SECID97"
12839 .table2
12840 .row &%exim_group%&                  "override compiled-in value"
12841 .row &%exim_path%&                   "override compiled-in value"
12842 .row &%exim_user%&                   "override compiled-in value"
12843 .row &%primary_hostname%&            "default from &[uname()]&"
12844 .row &%split_spool_directory%&       "use multiple directories"
12845 .row &%spool_directory%&             "override compiled-in value"
12846 .endtable
12847
12848
12849
12850 .section "Privilege controls" "SECID98"
12851 .table2
12852 .row &%admin_groups%&                "groups that are Exim admin users"
12853 .row &%deliver_drop_privilege%&      "drop root for delivery processes"
12854 .row &%local_from_check%&            "insert &'Sender:'& if necessary"
12855 .row &%local_from_prefix%&           "for testing &'From:'& for local sender"
12856 .row &%local_from_suffix%&           "for testing &'From:'& for local sender"
12857 .row &%local_sender_retain%&         "keep &'Sender:'& from untrusted user"
12858 .row &%never_users%&                 "do not run deliveries as these"
12859 .row &%prod_requires_admin%&         "forced delivery requires admin user"
12860 .row &%queue_list_requires_admin%&   "queue listing requires admin user"
12861 .row &%trusted_groups%&              "groups that are trusted"
12862 .row &%trusted_users%&               "users that are trusted"
12863 .endtable
12864
12865
12866
12867 .section "Logging" "SECID99"
12868 .table2
12869 .row &%hosts_connection_nolog%&      "exemption from connect logging"
12870 .row &%log_file_path%&               "override compiled-in value"
12871 .row &%log_selector%&                "set/unset optional logging"
12872 .row &%log_timezone%&                "add timezone to log lines"
12873 .row &%message_logs%&                "create per-message logs"
12874 .row &%preserve_message_logs%&       "after message completion"
12875 .row &%process_log_path%&            "for SIGUSR1 and &'exiwhat'&"
12876 .row &%syslog_duplication%&          "controls duplicate log lines on syslog"
12877 .row &%syslog_facility%&             "set syslog &""facility""& field"
12878 .row &%syslog_processname%&          "set syslog &""ident""& field"
12879 .row &%syslog_timestamp%&            "timestamp syslog lines"
12880 .row &%write_rejectlog%&             "control use of message log"
12881 .endtable
12882
12883
12884
12885 .section "Frozen messages" "SECID100"
12886 .table2
12887 .row &%auto_thaw%&                   "sets time for retrying frozen messages"
12888 .row &%freeze_tell%&                 "send message when freezing"
12889 .row &%move_frozen_messages%&        "to another directory"
12890 .row &%timeout_frozen_after%&        "keep frozen messages only so long"
12891 .endtable
12892
12893
12894
12895 .section "Data lookups" "SECID101"
12896 .table2
12897 .row &%ibase_servers%&               "InterBase servers"
12898 .row &%ldap_ca_cert_dir%&            "dir of CA certs to verify LDAP server's"
12899 .row &%ldap_ca_cert_file%&           "file of CA certs to verify LDAP server's"
12900 .row &%ldap_cert_file%&              "client cert file for LDAP"
12901 .row &%ldap_cert_key%&               "client key file for LDAP"
12902 .row &%ldap_cipher_suite%&           "TLS negotiation preference control"
12903 .row &%ldap_default_servers%&        "used if no server in query"
12904 .row &%ldap_require_cert%&           "action to take without LDAP server cert"
12905 .row &%ldap_start_tls%&              "require TLS within LDAP"
12906 .row &%ldap_version%&                "set protocol version"
12907 .row &%lookup_open_max%&             "lookup files held open"
12908 .row &%mysql_servers%&               "default MySQL servers"
12909 .row &%oracle_servers%&              "Oracle servers"
12910 .row &%pgsql_servers%&               "default PostgreSQL servers"
12911 .row &%sqlite_lock_timeout%&         "as it says"
12912 .endtable
12913
12914
12915
12916 .section "Message ids" "SECID102"
12917 .table2
12918 .row &%message_id_header_domain%&    "used to build &'Message-ID:'& header"
12919 .row &%message_id_header_text%&      "ditto"
12920 .endtable
12921
12922
12923
12924 .section "Embedded Perl Startup" "SECID103"
12925 .table2
12926 .row &%perl_at_start%&               "always start the interpreter"
12927 .row &%perl_startup%&                "code to obey when starting Perl"
12928 .endtable
12929
12930
12931
12932 .section "Daemon" "SECID104"
12933 .table2
12934 .row &%daemon_smtp_ports%&           "default ports"
12935 .row &%daemon_startup_retries%&      "number of times to retry"
12936 .row &%daemon_startup_sleep%&        "time to sleep between tries"
12937 .row &%extra_local_interfaces%&      "not necessarily listened on"
12938 .row &%local_interfaces%&            "on which to listen, with optional ports"
12939 .row &%pid_file_path%&               "override compiled-in value"
12940 .row &%queue_run_max%&               "maximum simultaneous queue runners"
12941 .endtable
12942
12943
12944
12945 .section "Resource control" "SECID105"
12946 .table2
12947 .row &%check_log_inodes%&            "before accepting a message"
12948 .row &%check_log_space%&             "before accepting a message"
12949 .row &%check_spool_inodes%&          "before accepting a message"
12950 .row &%check_spool_space%&           "before accepting a message"
12951 .row &%deliver_queue_load_max%&      "no queue deliveries if load high"
12952 .row &%queue_only_load%&             "queue incoming if load high"
12953 .row &%queue_only_load_latch%&       "don't re-evaluate load for each message"
12954 .row &%queue_run_max%&               "maximum simultaneous queue runners"
12955 .row &%remote_max_parallel%&         "parallel SMTP delivery per message"
12956 .row &%smtp_accept_max%&             "simultaneous incoming connections"
12957 .row &%smtp_accept_max_nonmail%&     "non-mail commands"
12958 .row &%smtp_accept_max_nonmail_hosts%& "hosts to which the limit applies"
12959 .row &%smtp_accept_max_per_connection%& "messages per connection"
12960 .row &%smtp_accept_max_per_host%&    "connections from one host"
12961 .row &%smtp_accept_queue%&           "queue mail if more connections"
12962 .row &%smtp_accept_queue_per_connection%& "queue if more messages per &&&
12963                                            connection"
12964 .row &%smtp_accept_reserve%&         "only reserve hosts if more connections"
12965 .row &%smtp_check_spool_space%&      "from SIZE on MAIL command"
12966 .row &%smtp_connect_backlog%&        "passed to TCP/IP stack"
12967 .row &%smtp_load_reserve%&           "SMTP from reserved hosts if load high"
12968 .row &%smtp_reserve_hosts%&          "these are the reserve hosts"
12969 .endtable
12970
12971
12972
12973 .section "Policy controls" "SECID106"
12974 .table2
12975 .row &%acl_not_smtp%&                "ACL for non-SMTP messages"
12976 .row &%acl_not_smtp_mime%&           "ACL for non-SMTP MIME parts"
12977 .row &%acl_not_smtp_start%&          "ACL for start of non-SMTP message"
12978 .row &%acl_smtp_auth%&               "ACL for AUTH"
12979 .row &%acl_smtp_connect%&            "ACL for connection"
12980 .row &%acl_smtp_data%&               "ACL for DATA"
12981 .row &%acl_smtp_dkim%&               "ACL for DKIM verification"
12982 .row &%acl_smtp_etrn%&               "ACL for ETRN"
12983 .row &%acl_smtp_expn%&               "ACL for EXPN"
12984 .row &%acl_smtp_helo%&               "ACL for EHLO or HELO"
12985 .row &%acl_smtp_mail%&               "ACL for MAIL"
12986 .row &%acl_smtp_mailauth%&           "ACL for AUTH on MAIL command"
12987 .row &%acl_smtp_mime%&               "ACL for MIME parts"
12988 .row &%acl_smtp_predata%&            "ACL for start of data"
12989 .row &%acl_smtp_quit%&               "ACL for QUIT"
12990 .row &%acl_smtp_rcpt%&               "ACL for RCPT"
12991 .row &%acl_smtp_starttls%&           "ACL for STARTTLS"
12992 .row &%acl_smtp_vrfy%&               "ACL for VRFY"
12993 .row &%av_scanner%&                  "specify virus scanner"
12994 .row &%check_rfc2047_length%&        "check length of RFC 2047 &""encoded &&&
12995                                       words""&"
12996 .row &%dns_csa_search_limit%&        "control CSA parent search depth"
12997 .row &%dns_csa_use_reverse%&         "en/disable CSA IP reverse search"
12998 .row &%header_maxsize%&              "total size of message header"
12999 .row &%header_line_maxsize%&         "individual header line limit"
13000 .row &%helo_accept_junk_hosts%&      "allow syntactic junk from these hosts"
13001 .row &%helo_allow_chars%&            "allow illegal chars in HELO names"
13002 .row &%helo_lookup_domains%&         "lookup hostname for these HELO names"
13003 .row &%helo_try_verify_hosts%&       "HELO soft-checked for these hosts"
13004 .row &%helo_verify_hosts%&           "HELO hard-checked for these hosts"
13005 .row &%host_lookup%&                 "host name looked up for these hosts"
13006 .row &%host_lookup_order%&           "order of DNS and local name lookups"
13007 .row &%host_reject_connection%&      "reject connection from these hosts"
13008 .row &%hosts_treat_as_local%&        "useful in some cluster configurations"
13009 .row &%local_scan_timeout%&          "timeout for &[local_scan()]&"
13010 .row &%message_size_limit%&          "for all messages"
13011 .row &%percent_hack_domains%&        "recognize %-hack for these domains"
13012 .row &%spamd_address%&               "set interface to SpamAssassin"
13013 .row &%strict_acl_vars%&             "object to unset ACL variables"
13014 .endtable
13015
13016
13017
13018 .section "Callout cache" "SECID107"
13019 .table2
13020 .row &%callout_domain_negative_expire%& "timeout for negative domain cache &&&
13021                                          item"
13022 .row &%callout_domain_positive_expire%& "timeout for positive domain cache &&&
13023                                          item"
13024 .row &%callout_negative_expire%&     "timeout for negative address cache item"
13025 .row &%callout_positive_expire%&     "timeout for positive address cache item"
13026 .row &%callout_random_local_part%&   "string to use for &""random""& testing"
13027 .endtable
13028
13029
13030
13031 .section "TLS" "SECID108"
13032 .table2
13033 .row &%gnutls_compat_mode%&          "use GnuTLS compatibility mode"
13034 .row &%gnutls_allow_auto_pkcs11%&    "allow GnuTLS to autoload PKCS11 modules"
13035 .row &%openssl_options%&             "adjust OpenSSL compatibility options"
13036 .row &%tls_advertise_hosts%&         "advertise TLS to these hosts"
13037 .row &%tls_certificate%&             "location of server certificate"
13038 .row &%tls_crl%&                     "certificate revocation list"
13039 .row &%tls_dh_max_bits%&             "clamp D-H bit count suggestion"
13040 .row &%tls_dhparam%&                 "DH parameters for server"
13041 .row &%tls_on_connect_ports%&        "specify SSMTP (SMTPS) ports"
13042 .row &%tls_privatekey%&              "location of server private key"
13043 .row &%tls_remember_esmtp%&          "don't reset after starting TLS"
13044 .row &%tls_require_ciphers%&         "specify acceptable ciphers"
13045 .row &%tls_try_verify_hosts%&        "try to verify client certificate"
13046 .row &%tls_verify_certificates%&     "expected client certificates"
13047 .row &%tls_verify_hosts%&            "insist on client certificate verify"
13048 .endtable
13049
13050
13051
13052 .section "Local user handling" "SECID109"
13053 .table2
13054 .row &%finduser_retries%&            "useful in NIS environments"
13055 .row &%gecos_name%&                  "used when creating &'Sender:'&"
13056 .row &%gecos_pattern%&               "ditto"
13057 .row &%max_username_length%&         "for systems that truncate"
13058 .row &%unknown_login%&               "used when no login name found"
13059 .row &%unknown_username%&            "ditto"
13060 .row &%uucp_from_pattern%&           "for recognizing &""From ""& lines"
13061 .row &%uucp_from_sender%&            "ditto"
13062 .endtable
13063
13064
13065
13066 .section "All incoming messages (SMTP and non-SMTP)" "SECID110"
13067 .table2
13068 .row &%header_maxsize%&              "total size of message header"
13069 .row &%header_line_maxsize%&         "individual header line limit"
13070 .row &%message_size_limit%&          "applies to all messages"
13071 .row &%percent_hack_domains%&        "recognize %-hack for these domains"
13072 .row &%received_header_text%&        "expanded to make &'Received:'&"
13073 .row &%received_headers_max%&        "for mail loop detection"
13074 .row &%recipients_max%&              "limit per message"
13075 .row &%recipients_max_reject%&       "permanently reject excess recipients"
13076 .endtable
13077
13078
13079
13080
13081 .section "Non-SMTP incoming messages" "SECID111"
13082 .table2
13083 .row &%receive_timeout%&             "for non-SMTP messages"
13084 .endtable
13085
13086
13087
13088
13089
13090 .section "Incoming SMTP messages" "SECID112"
13091 See also the &'Policy controls'& section above.
13092
13093 .table2
13094 .row &%host_lookup%&                 "host name looked up for these hosts"
13095 .row &%host_lookup_order%&           "order of DNS and local name lookups"
13096 .row &%recipient_unqualified_hosts%& "may send unqualified recipients"
13097 .row &%rfc1413_hosts%&               "make ident calls to these hosts"
13098 .row &%rfc1413_query_timeout%&       "zero disables ident calls"
13099 .row &%sender_unqualified_hosts%&    "may send unqualified senders"
13100 .row &%smtp_accept_keepalive%&       "some TCP/IP magic"
13101 .row &%smtp_accept_max%&             "simultaneous incoming connections"
13102 .row &%smtp_accept_max_nonmail%&     "non-mail commands"
13103 .row &%smtp_accept_max_nonmail_hosts%& "hosts to which the limit applies"
13104 .row &%smtp_accept_max_per_connection%& "messages per connection"
13105 .row &%smtp_accept_max_per_host%&    "connections from one host"
13106 .row &%smtp_accept_queue%&           "queue mail if more connections"
13107 .row &%smtp_accept_queue_per_connection%& "queue if more messages per &&&
13108                                            connection"
13109 .row &%smtp_accept_reserve%&         "only reserve hosts if more connections"
13110 .row &%smtp_active_hostname%&        "host name to use in messages"
13111 .row &%smtp_banner%&                 "text for welcome banner"
13112 .row &%smtp_check_spool_space%&      "from SIZE on MAIL command"
13113 .row &%smtp_connect_backlog%&        "passed to TCP/IP stack"
13114 .row &%smtp_enforce_sync%&           "of SMTP command/responses"
13115 .row &%smtp_etrn_command%&           "what to run for ETRN"
13116 .row &%smtp_etrn_serialize%&         "only one at once"
13117 .row &%smtp_load_reserve%&           "only reserve hosts if this load"
13118 .row &%smtp_max_unknown_commands%&   "before dropping connection"
13119 .row &%smtp_ratelimit_hosts%&        "apply ratelimiting to these hosts"
13120 .row &%smtp_ratelimit_mail%&         "ratelimit for MAIL commands"
13121 .row &%smtp_ratelimit_rcpt%&         "ratelimit for RCPT commands"
13122 .row &%smtp_receive_timeout%&        "per command or data line"
13123 .row &%smtp_reserve_hosts%&          "these are the reserve hosts"
13124 .row &%smtp_return_error_details%&   "give detail on rejections"
13125 .endtable
13126
13127
13128
13129 .section "SMTP extensions" "SECID113"
13130 .table2
13131 .row &%accept_8bitmime%&             "advertise 8BITMIME"
13132 .row &%auth_advertise_hosts%&        "advertise AUTH to these hosts"
13133 .row &%ignore_fromline_hosts%&       "allow &""From ""& from these hosts"
13134 .row &%ignore_fromline_local%&       "allow &""From ""& from local SMTP"
13135 .row &%pipelining_advertise_hosts%&  "advertise pipelining to these hosts"
13136 .row &%tls_advertise_hosts%&         "advertise TLS to these hosts"
13137 .endtable
13138
13139
13140
13141 .section "Processing messages" "SECID114"
13142 .table2
13143 .row &%allow_domain_literals%&       "recognize domain literal syntax"
13144 .row &%allow_mx_to_ip%&              "allow MX to point to IP address"
13145 .row &%allow_utf8_domains%&          "in addresses"
13146 .row &%check_rfc2047_length%&        "check length of RFC 2047 &""encoded &&&
13147                                       words""&"
13148 .row &%delivery_date_remove%&        "from incoming messages"
13149 .row &%envelope_to_remove%&          "from incoming messages"
13150 .row &%extract_addresses_remove_arguments%& "affects &%-t%& processing"
13151 .row &%headers_charset%&             "default for translations"
13152 .row &%qualify_domain%&              "default for senders"
13153 .row &%qualify_recipient%&           "default for recipients"
13154 .row &%return_path_remove%&          "from incoming messages"
13155 .row &%strip_excess_angle_brackets%& "in addresses"
13156 .row &%strip_trailing_dot%&          "at end of addresses"
13157 .row &%untrusted_set_sender%&        "untrusted can set envelope sender"
13158 .endtable
13159
13160
13161
13162 .section "System filter" "SECID115"
13163 .table2
13164 .row &%system_filter%&               "locate system filter"
13165 .row &%system_filter_directory_transport%& "transport for delivery to a &&&
13166                                             directory"
13167 .row &%system_filter_file_transport%& "transport for delivery to a file"
13168 .row &%system_filter_group%&         "group for filter running"
13169 .row &%system_filter_pipe_transport%& "transport for delivery to a pipe"
13170 .row &%system_filter_reply_transport%& "transport for autoreply delivery"
13171 .row &%system_filter_user%&          "user for filter running"
13172 .endtable
13173
13174
13175
13176 .section "Routing and delivery" "SECID116"
13177 .table2
13178 .row &%disable_ipv6%&                "do no IPv6 processing"
13179 .row &%dns_again_means_nonexist%&    "for broken domains"
13180 .row &%dns_check_names_pattern%&     "pre-DNS syntax check"
13181 .row &%dns_dnssec_ok%&               "parameter for resolver"
13182 .row &%dns_ipv4_lookup%&             "only v4 lookup for these domains"
13183 .row &%dns_retrans%&                 "parameter for resolver"
13184 .row &%dns_retry%&                   "parameter for resolver"
13185 .row &%dns_use_edns0%&               "parameter for resolver"
13186 .row &%hold_domains%&                "hold delivery for these domains"
13187 .row &%local_interfaces%&            "for routing checks"
13188 .row &%queue_domains%&               "no immediate delivery for these"
13189 .row &%queue_only%&                  "no immediate delivery at all"
13190 .row &%queue_only_file%&             "no immediate delivery if file exists"
13191 .row &%queue_only_load%&             "no immediate delivery if load is high"
13192 .row &%queue_only_load_latch%&       "don't re-evaluate load for each message"
13193 .row &%queue_only_override%&         "allow command line to override"
13194 .row &%queue_run_in_order%&          "order of arrival"
13195 .row &%queue_run_max%&               "of simultaneous queue runners"
13196 .row &%queue_smtp_domains%&          "no immediate SMTP delivery for these"
13197 .row &%remote_max_parallel%&         "parallel SMTP delivery per message"
13198 .row &%remote_sort_domains%&         "order of remote deliveries"
13199 .row &%retry_data_expire%&           "timeout for retry data"
13200 .row &%retry_interval_max%&          "safety net for retry rules"
13201 .endtable
13202
13203
13204
13205 .section "Bounce and warning messages" "SECID117"
13206 .table2
13207 .row &%bounce_message_file%&         "content of bounce"
13208 .row &%bounce_message_text%&         "content of bounce"
13209 .row &%bounce_return_body%&          "include body if returning message"
13210 .row &%bounce_return_message%&       "include original message in bounce"
13211 .row &%bounce_return_size_limit%&    "limit on returned message"
13212 .row &%bounce_sender_authentication%& "send authenticated sender with bounce"
13213 .row &%dsn_from%&                    "set &'From:'& contents in bounces"
13214 .row &%errors_copy%&                 "copy bounce messages"
13215 .row &%errors_reply_to%&             "&'Reply-to:'& in bounces"
13216 .row &%delay_warning%&               "time schedule"
13217 .row &%delay_warning_condition%&     "condition for warning messages"
13218 .row &%ignore_bounce_errors_after%&  "discard undeliverable bounces"
13219 .row &%smtp_return_error_details%&   "give detail on rejections"
13220 .row &%warn_message_file%&           "content of warning message"
13221 .endtable
13222
13223
13224
13225 .section "Alphabetical list of main options" "SECTalomo"
13226 Those options that undergo string expansion before use are marked with
13227 &dagger;.
13228
13229 .option accept_8bitmime main boolean true
13230 .cindex "8BITMIME"
13231 .cindex "8-bit characters"
13232 .cindex "log" "selectors"
13233 .cindex "log" "8BITMIME"
13234 This option causes Exim to send 8BITMIME in its response to an SMTP
13235 EHLO command, and to accept the BODY= parameter on MAIL commands.
13236 However, though Exim is 8-bit clean, it is not a protocol converter, and it
13237 takes no steps to do anything special with messages received by this route.
13238
13239 Historically Exim kept this option off by default, but the maintainers
13240 feel that in today's Internet, this causes more problems than it solves.
13241 It now defaults to true.
13242 A more detailed analysis of the issues is provided by Dan Bernstein:
13243 .display
13244 &url(http://cr.yp.to/smtp/8bitmime.html)
13245 .endd
13246
13247 To log received 8BITMIME status use
13248 .code
13249 log_selector = +8bitmime
13250 .endd
13251
13252 .option acl_not_smtp main string&!! unset
13253 .cindex "&ACL;" "for non-SMTP messages"
13254 .cindex "non-SMTP messages" "ACLs for"
13255 This option defines the ACL that is run when a non-SMTP message has been
13256 read and is on the point of being accepted. See chapter &<<CHAPACL>>& for
13257 further details.
13258
13259 .option acl_not_smtp_mime main string&!! unset
13260 This option defines the ACL that is run for individual MIME parts of non-SMTP
13261 messages. It operates in exactly the same way as &%acl_smtp_mime%& operates for
13262 SMTP messages.
13263
13264 .option acl_not_smtp_start main string&!! unset
13265 .cindex "&ACL;" "at start of non-SMTP message"
13266 .cindex "non-SMTP messages" "ACLs for"
13267 This option defines the ACL that is run before Exim starts reading a
13268 non-SMTP message. See chapter &<<CHAPACL>>& for further details.
13269
13270 .option acl_smtp_auth main string&!! unset
13271 .cindex "&ACL;" "setting up for SMTP commands"
13272 .cindex "AUTH" "ACL for"
13273 This option defines the ACL that is run when an SMTP AUTH command is
13274 received. See chapter &<<CHAPACL>>& for further details.
13275
13276 .option acl_smtp_connect main string&!! unset
13277 .cindex "&ACL;" "on SMTP connection"
13278 This option defines the ACL that is run when an SMTP connection is received.
13279 See chapter &<<CHAPACL>>& for further details.
13280
13281 .option acl_smtp_data main string&!! unset
13282 .cindex "DATA" "ACL for"
13283 This option defines the ACL that is run after an SMTP DATA command has been
13284 processed and the message itself has been received, but before the final
13285 acknowledgment is sent. See chapter &<<CHAPACL>>& for further details.
13286
13287 .option acl_smtp_etrn main string&!! unset
13288 .cindex "ETRN" "ACL for"
13289 This option defines the ACL that is run when an SMTP ETRN command is
13290 received. See chapter &<<CHAPACL>>& for further details.
13291
13292 .option acl_smtp_expn main string&!! unset
13293 .cindex "EXPN" "ACL for"
13294 This option defines the ACL that is run when an SMTP EXPN command is
13295 received. See chapter &<<CHAPACL>>& for further details.
13296
13297 .option acl_smtp_helo main string&!! unset
13298 .cindex "EHLO" "ACL for"
13299 .cindex "HELO" "ACL for"
13300 This option defines the ACL that is run when an SMTP EHLO or HELO
13301 command is received. See chapter &<<CHAPACL>>& for further details.
13302
13303
13304 .option acl_smtp_mail main string&!! unset
13305 .cindex "MAIL" "ACL for"
13306 This option defines the ACL that is run when an SMTP MAIL command is
13307 received. See chapter &<<CHAPACL>>& for further details.
13308
13309 .option acl_smtp_mailauth main string&!! unset
13310 .cindex "AUTH" "on MAIL command"
13311 This option defines the ACL that is run when there is an AUTH parameter on
13312 a MAIL command. See chapter &<<CHAPACL>>& for details of ACLs, and chapter
13313 &<<CHAPSMTPAUTH>>& for details of authentication.
13314
13315 .option acl_smtp_mime main string&!! unset
13316 .cindex "MIME content scanning" "ACL for"
13317 This option is available when Exim is built with the content-scanning
13318 extension. It defines the ACL that is run for each MIME part in a message. See
13319 section &<<SECTscanmimepart>>& for details.
13320
13321 .option acl_smtp_predata main string&!! unset
13322 This option defines the ACL that is run when an SMTP DATA command is
13323 received, before the message itself is received. See chapter &<<CHAPACL>>& for
13324 further details.
13325
13326 .option acl_smtp_quit main string&!! unset
13327 .cindex "QUIT, ACL for"
13328 This option defines the ACL that is run when an SMTP QUIT command is
13329 received. See chapter &<<CHAPACL>>& for further details.
13330
13331 .option acl_smtp_rcpt main string&!! unset
13332 .cindex "RCPT" "ACL for"
13333 This option defines the ACL that is run when an SMTP RCPT command is
13334 received. See chapter &<<CHAPACL>>& for further details.
13335
13336 .option acl_smtp_starttls main string&!! unset
13337 .cindex "STARTTLS, ACL for"
13338 This option defines the ACL that is run when an SMTP STARTTLS command is
13339 received. See chapter &<<CHAPACL>>& for further details.
13340
13341 .option acl_smtp_vrfy main string&!! unset
13342 .cindex "VRFY" "ACL for"
13343 This option defines the ACL that is run when an SMTP VRFY command is
13344 received. See chapter &<<CHAPACL>>& for further details.
13345
13346 .option admin_groups main "string list&!!" unset
13347 .cindex "admin user"
13348 This option is expanded just once, at the start of Exim's processing. If the
13349 current group or any of the supplementary groups of an Exim caller is in this
13350 colon-separated list, the caller has admin privileges. If all your system
13351 programmers are in a specific group, for example, you can give them all Exim
13352 admin privileges by putting that group in &%admin_groups%&. However, this does
13353 not permit them to read Exim's spool files (whose group owner is the Exim gid).
13354 To permit this, you have to add individuals to the Exim group.
13355
13356 .option allow_domain_literals main boolean false
13357 .cindex "domain literal"
13358 If this option is set, the RFC 2822 domain literal format is permitted in
13359 email addresses. The option is not set by default, because the domain literal
13360 format is not normally required these days, and few people know about it. It
13361 has, however, been exploited by mail abusers.
13362
13363 Unfortunately, it seems that some DNS black list maintainers are using this
13364 format to report black listing to postmasters. If you want to accept messages
13365 addressed to your hosts by IP address, you need to set
13366 &%allow_domain_literals%& true, and also to add &`@[]`& to the list of local
13367 domains (defined in the named domain list &%local_domains%& in the default
13368 configuration). This &"magic string"& matches the domain literal form of all
13369 the local host's IP addresses.
13370
13371
13372 .option allow_mx_to_ip main boolean false
13373 .cindex "MX record" "pointing to IP address"
13374 It appears that more and more DNS zone administrators are breaking the rules
13375 and putting domain names that look like IP addresses on the right hand side of
13376 MX records. Exim follows the rules and rejects this, giving an error message
13377 that explains the mis-configuration. However, some other MTAs support this
13378 practice, so to avoid &"Why can't Exim do this?"& complaints,
13379 &%allow_mx_to_ip%& exists, in order to enable this heinous activity. It is not
13380 recommended, except when you have no other choice.
13381
13382 .option allow_utf8_domains main boolean false
13383 .cindex "domain" "UTF-8 characters in"
13384 .cindex "UTF-8" "in domain name"
13385 Lots of discussion is going on about internationalized domain names. One
13386 camp is strongly in favour of just using UTF-8 characters, and it seems
13387 that at least two other MTAs permit this. This option allows Exim users to
13388 experiment if they wish.
13389
13390 If it is set true, Exim's domain parsing function allows valid
13391 UTF-8 multicharacters to appear in domain name components, in addition to
13392 letters, digits, and hyphens. However, just setting this option is not
13393 enough; if you want to look up these domain names in the DNS, you must also
13394 adjust the value of &%dns_check_names_pattern%& to match the extended form. A
13395 suitable setting is:
13396 .code
13397 dns_check_names_pattern = (?i)^(?>(?(1)\.|())[a-z0-9\xc0-\xff]\
13398   (?>[-a-z0-9\x80-\xff]*[a-z0-9\x80-\xbf])?)+$
13399 .endd
13400 Alternatively, you can just disable this feature by setting
13401 .code
13402 dns_check_names_pattern =
13403 .endd
13404 That is, set the option to an empty string so that no check is done.
13405
13406
13407 .option auth_advertise_hosts main "host list&!!" *
13408 .cindex "authentication" "advertising"
13409 .cindex "AUTH" "advertising"
13410 If any server authentication mechanisms are configured, Exim advertises them in
13411 response to an EHLO command only if the calling host matches this list.
13412 Otherwise, Exim does not advertise AUTH.
13413 Exim does not accept AUTH commands from clients to which it has not
13414 advertised the availability of AUTH. The advertising of individual
13415 authentication mechanisms can be controlled by the use of the
13416 &%server_advertise_condition%& generic authenticator option on the individual
13417 authenticators. See chapter &<<CHAPSMTPAUTH>>& for further details.
13418
13419 Certain mail clients (for example, Netscape) require the user to provide a name
13420 and password for authentication if AUTH is advertised, even though it may
13421 not be needed (the host may accept messages from hosts on its local LAN without
13422 authentication, for example). The &%auth_advertise_hosts%& option can be used
13423 to make these clients more friendly by excluding them from the set of hosts to
13424 which Exim advertises AUTH.
13425
13426 .cindex "AUTH" "advertising when encrypted"
13427 If you want to advertise the availability of AUTH only when the connection
13428 is encrypted using TLS, you can make use of the fact that the value of this
13429 option is expanded, with a setting like this:
13430 .code
13431 auth_advertise_hosts = ${if eq{$tls_in_cipher}{}{}{*}}
13432 .endd
13433 .vindex "&$tls_in_cipher$&"
13434 If &$tls_in_cipher$& is empty, the session is not encrypted, and the result of
13435 the expansion is empty, thus matching no hosts. Otherwise, the result of the
13436 expansion is *, which matches all hosts.
13437
13438
13439 .option auto_thaw main time 0s
13440 .cindex "thawing messages"
13441 .cindex "unfreezing messages"
13442 If this option is set to a time greater than zero, a queue runner will try a
13443 new delivery attempt on any frozen message, other than a bounce message, if
13444 this much time has passed since it was frozen. This may result in the message
13445 being re-frozen if nothing has changed since the last attempt. It is a way of
13446 saying &"keep on trying, even though there are big problems"&.
13447
13448 &*Note*&: This is an old option, which predates &%timeout_frozen_after%& and
13449 &%ignore_bounce_errors_after%&. It is retained for compatibility, but it is not
13450 thought to be very useful any more, and its use should probably be avoided.
13451
13452
13453 .option av_scanner main string "see below"
13454 This option is available if Exim is built with the content-scanning extension.
13455 It specifies which anti-virus scanner to use. The default value is:
13456 .code
13457 sophie:/var/run/sophie
13458 .endd
13459 If the value of &%av_scanner%& starts with a dollar character, it is expanded
13460 before use. See section &<<SECTscanvirus>>& for further details.
13461
13462
13463 .option bi_command main string unset
13464 .oindex "&%-bi%&"
13465 This option supplies the name of a command that is run when Exim is called with
13466 the &%-bi%& option (see chapter &<<CHAPcommandline>>&). The string value is
13467 just the command name, it is not a complete command line. If an argument is
13468 required, it must come from the &%-oA%& command line option.
13469
13470
13471 .option bounce_message_file main string unset
13472 .cindex "bounce message" "customizing"
13473 .cindex "customizing" "bounce message"
13474 This option defines a template file containing paragraphs of text to be used
13475 for constructing bounce messages.  Details of the file's contents are given in
13476 chapter &<<CHAPemsgcust>>&. See also &%warn_message_file%&.
13477
13478
13479 .option bounce_message_text main string unset
13480 When this option is set, its contents are included in the default bounce
13481 message immediately after &"This message was created automatically by mail
13482 delivery software."& It is not used if &%bounce_message_file%& is set.
13483
13484 .option bounce_return_body main boolean true
13485 .cindex "bounce message" "including body"
13486 This option controls whether the body of an incoming message is included in a
13487 bounce message when &%bounce_return_message%& is true. The default setting
13488 causes the entire message, both header and body, to be returned (subject to the
13489 value of &%bounce_return_size_limit%&). If this option is false, only the
13490 message header is included. In the case of a non-SMTP message containing an
13491 error that is detected during reception, only those header lines preceding the
13492 point at which the error was detected are returned.
13493 .cindex "bounce message" "including original"
13494
13495 .option bounce_return_message main boolean true
13496 If this option is set false, none of the original message is included in
13497 bounce messages generated by Exim. See also &%bounce_return_size_limit%& and
13498 &%bounce_return_body%&.
13499
13500
13501 .option bounce_return_size_limit main integer 100K
13502 .cindex "size" "of bounce, limit"
13503 .cindex "bounce message" "size limit"
13504 .cindex "limit" "bounce message size"
13505 This option sets a limit in bytes on the size of messages that are returned to
13506 senders as part of bounce messages when &%bounce_return_message%& is true. The
13507 limit should be less than the value of the global &%message_size_limit%& and of
13508 any &%message_size_limit%& settings on transports, to allow for the bounce text
13509 that Exim generates. If this option is set to zero there is no limit.
13510
13511 When the body of any message that is to be included in a bounce message is
13512 greater than the limit, it is truncated, and a comment pointing this out is
13513 added at the top. The actual cutoff may be greater than the value given, owing
13514 to the use of buffering for transferring the message in chunks (typically 8K in
13515 size). The idea is to save bandwidth on those undeliverable 15-megabyte
13516 messages.
13517
13518 .option bounce_sender_authentication main string unset
13519 .cindex "bounce message" "sender authentication"
13520 .cindex "authentication" "bounce message"
13521 .cindex "AUTH" "on bounce message"
13522 This option provides an authenticated sender address that is sent with any
13523 bounce messages generated by Exim that are sent over an authenticated SMTP
13524 connection. A typical setting might be:
13525 .code
13526 bounce_sender_authentication = mailer-daemon@my.domain.example
13527 .endd
13528 which would cause bounce messages to be sent using the SMTP command:
13529 .code
13530 MAIL FROM:<> AUTH=mailer-daemon@my.domain.example
13531 .endd
13532 The value of &%bounce_sender_authentication%& must always be a complete email
13533 address.
13534
13535 .option callout_domain_negative_expire main time 3h
13536 .cindex "caching" "callout timeouts"
13537 .cindex "callout" "caching timeouts"
13538 This option specifies the expiry time for negative callout cache data for a
13539 domain. See section &<<SECTcallver>>& for details of callout verification, and
13540 section &<<SECTcallvercache>>& for details of the caching.
13541
13542
13543 .option callout_domain_positive_expire main time 7d
13544 This option specifies the expiry time for positive callout cache data for a
13545 domain. See section &<<SECTcallver>>& for details of callout verification, and
13546 section &<<SECTcallvercache>>& for details of the caching.
13547
13548
13549 .option callout_negative_expire main time 2h
13550 This option specifies the expiry time for negative callout cache data for an
13551 address. See section &<<SECTcallver>>& for details of callout verification, and
13552 section &<<SECTcallvercache>>& for details of the caching.
13553
13554
13555 .option callout_positive_expire main time 24h
13556 This option specifies the expiry time for positive callout cache data for an
13557 address. See section &<<SECTcallver>>& for details of callout verification, and
13558 section &<<SECTcallvercache>>& for details of the caching.
13559
13560
13561 .option callout_random_local_part main string&!! "see below"
13562 This option defines the &"random"& local part that can be used as part of
13563 callout verification. The default value is
13564 .code
13565 $primary_hostname-$tod_epoch-testing
13566 .endd
13567 See section &<<CALLaddparcall>>& for details of how this value is used.
13568
13569
13570 .option check_log_inodes main integer 0
13571 See &%check_spool_space%& below.
13572
13573
13574 .option check_log_space main integer 0
13575 See &%check_spool_space%& below.
13576
13577 .oindex "&%check_rfc2047_length%&"
13578 .cindex "RFC 2047" "disabling length check"
13579 .option check_rfc2047_length main boolean true
13580 RFC 2047 defines a way of encoding non-ASCII characters in headers using a
13581 system of &"encoded words"&. The RFC specifies a maximum length for an encoded
13582 word; strings to be encoded that exceed this length are supposed to use
13583 multiple encoded words. By default, Exim does not recognize encoded words that
13584 exceed the maximum length. However, it seems that some software, in violation
13585 of the RFC, generates overlong encoded words. If &%check_rfc2047_length%& is
13586 set false, Exim recognizes encoded words of any length.
13587
13588
13589 .option check_spool_inodes main integer 0
13590 See &%check_spool_space%& below.
13591
13592
13593 .option check_spool_space main integer 0
13594 .cindex "checking disk space"
13595 .cindex "disk space, checking"
13596 .cindex "spool directory" "checking space"
13597 The four &%check_...%& options allow for checking of disk resources before a
13598 message is accepted.
13599
13600 .vindex "&$log_inodes$&"
13601 .vindex "&$log_space$&"
13602 .vindex "&$spool_inodes$&"
13603 .vindex "&$spool_space$&"
13604 When any of these options are set, they apply to all incoming messages. If you
13605 want to apply different checks to different kinds of message, you can do so by
13606 testing the variables &$log_inodes$&, &$log_space$&, &$spool_inodes$&, and
13607 &$spool_space$& in an ACL with appropriate additional conditions.
13608
13609
13610 &%check_spool_space%& and &%check_spool_inodes%& check the spool partition if
13611 either value is greater than zero, for example:
13612 .code
13613 check_spool_space = 10M
13614 check_spool_inodes = 100
13615 .endd
13616 The spool partition is the one that contains the directory defined by
13617 SPOOL_DIRECTORY in &_Local/Makefile_&. It is used for holding messages in
13618 transit.
13619
13620 &%check_log_space%& and &%check_log_inodes%&  check the partition in which log
13621 files are written if either is greater than zero. These should be set only if
13622 &%log_file_path%& and &%spool_directory%& refer to different partitions.
13623
13624 If there is less space or fewer inodes than requested, Exim refuses to accept
13625 incoming mail. In the case of SMTP input this is done by giving a 452 temporary
13626 error response to the MAIL command. If ESMTP is in use and there was a
13627 SIZE parameter on the MAIL command, its value is added to the
13628 &%check_spool_space%& value, and the check is performed even if
13629 &%check_spool_space%& is zero, unless &%no_smtp_check_spool_space%& is set.
13630
13631 The values for &%check_spool_space%& and &%check_log_space%& are held as a
13632 number of kilobytes. If a non-multiple of 1024 is specified, it is rounded up.
13633
13634 For non-SMTP input and for batched SMTP input, the test is done at start-up; on
13635 failure a message is written to stderr and Exim exits with a non-zero code, as
13636 it obviously cannot send an error message of any kind.
13637
13638 .option daemon_smtp_ports main string &`smtp`&
13639 .cindex "port" "for daemon"
13640 .cindex "TCP/IP" "setting listening ports"
13641 This option specifies one or more default SMTP ports on which the Exim daemon
13642 listens. See chapter &<<CHAPinterfaces>>& for details of how it is used. For
13643 backward compatibility, &%daemon_smtp_port%& (singular) is a synonym.
13644
13645 .option daemon_startup_retries main integer 9
13646 .cindex "daemon startup, retrying"
13647 This option, along with &%daemon_startup_sleep%&, controls the retrying done by
13648 the daemon at startup when it cannot immediately bind a listening socket
13649 (typically because the socket is already in use): &%daemon_startup_retries%&
13650 defines the number of retries after the first failure, and
13651 &%daemon_startup_sleep%& defines the length of time to wait between retries.
13652
13653 .option daemon_startup_sleep main time 30s
13654 See &%daemon_startup_retries%&.
13655
13656 .option delay_warning main "time list" 24h
13657 .cindex "warning of delay"
13658 .cindex "delay warning, specifying"
13659 When a message is delayed, Exim sends a warning message to the sender at
13660 intervals specified by this option. The data is a colon-separated list of times
13661 after which to send warning messages. If the value of the option is an empty
13662 string or a zero time, no warnings are sent. Up to 10 times may be given. If a
13663 message has been on the queue for longer than the last time, the last interval
13664 between the times is used to compute subsequent warning times. For example,
13665 with
13666 .code
13667 delay_warning = 4h:8h:24h
13668 .endd
13669 the first message is sent after 4 hours, the second after 8 hours, and
13670 the third one after 24 hours. After that, messages are sent every 16 hours,
13671 because that is the interval between the last two times on the list. If you set
13672 just one time, it specifies the repeat interval. For example, with:
13673 .code
13674 delay_warning = 6h
13675 .endd
13676 messages are repeated every six hours. To stop warnings after a given time, set
13677 a very large time at the end of the list. For example:
13678 .code
13679 delay_warning = 2h:12h:99d
13680 .endd
13681 Note that the option is only evaluated at the time a delivery attempt fails,
13682 which depends on retry and queue-runner configuration.
13683 Typically retries will be configured more frequently than warning messages.
13684
13685 .option delay_warning_condition main string&!! "see below"
13686 .vindex "&$domain$&"
13687 The string is expanded at the time a warning message might be sent. If all the
13688 deferred addresses have the same domain, it is set in &$domain$& during the
13689 expansion. Otherwise &$domain$& is empty. If the result of the expansion is a
13690 forced failure, an empty string, or a string matching any of &"0"&, &"no"& or
13691 &"false"& (the comparison being done caselessly) then the warning message is
13692 not sent. The default is:
13693 .code
13694 delay_warning_condition = ${if or {\
13695   { !eq{$h_list-id:$h_list-post:$h_list-subscribe:}{} }\
13696   { match{$h_precedence:}{(?i)bulk|list|junk} }\
13697   { match{$h_auto-submitted:}{(?i)auto-generated|auto-replied} }\
13698   } {no}{yes}}
13699 .endd
13700 This suppresses the sending of warnings for messages that contain &'List-ID:'&,
13701 &'List-Post:'&, or &'List-Subscribe:'& headers, or have &"bulk"&, &"list"& or
13702 &"junk"& in a &'Precedence:'& header, or have &"auto-generated"& or
13703 &"auto-replied"& in an &'Auto-Submitted:'& header.
13704
13705 .option deliver_drop_privilege main boolean false
13706 .cindex "unprivileged delivery"
13707 .cindex "delivery" "unprivileged"
13708 If this option is set true, Exim drops its root privilege at the start of a
13709 delivery process, and runs as the Exim user throughout. This severely restricts
13710 the kinds of local delivery that are possible, but is viable in certain types
13711 of configuration. There is a discussion about the use of root privilege in
13712 chapter &<<CHAPsecurity>>&.
13713
13714 .option deliver_queue_load_max main fixed-point unset
13715 .cindex "load average"
13716 .cindex "queue runner" "abandoning"
13717 When this option is set, a queue run is abandoned if the system load average
13718 becomes greater than the value of the option. The option has no effect on
13719 ancient operating systems on which Exim cannot determine the load average.
13720 See also &%queue_only_load%& and &%smtp_load_reserve%&.
13721
13722
13723 .option delivery_date_remove main boolean true
13724 .cindex "&'Delivery-date:'& header line"
13725 Exim's transports have an option for adding a &'Delivery-date:'& header to a
13726 message when it is delivered, in exactly the same way as &'Return-path:'& is
13727 handled. &'Delivery-date:'& records the actual time of delivery. Such headers
13728 should not be present in incoming messages, and this option causes them to be
13729 removed at the time the message is received, to avoid any problems that might
13730 occur when a delivered message is subsequently sent on to some other recipient.
13731
13732 .option disable_fsync main boolean false
13733 .cindex "&[fsync()]&, disabling"
13734 This option is available only if Exim was built with the compile-time option
13735 ENABLE_DISABLE_FSYNC. When this is not set, a reference to &%disable_fsync%& in
13736 a runtime configuration generates an &"unknown option"& error. You should not
13737 build Exim with ENABLE_DISABLE_FSYNC or set &%disable_fsync%& unless you
13738 really, really, really understand what you are doing. &'No pre-compiled
13739 distributions of Exim should ever make this option available.'&
13740
13741 When &%disable_fsync%& is set true, Exim no longer calls &[fsync()]& to force
13742 updated files' data to be written to disc before continuing. Unexpected events
13743 such as crashes and power outages may cause data to be lost or scrambled.
13744 Here be Dragons. &*Beware.*&
13745
13746
13747 .option disable_ipv6 main boolean false
13748 .cindex "IPv6" "disabling"
13749 If this option is set true, even if the Exim binary has IPv6 support, no IPv6
13750 activities take place. AAAA records are never looked up, and any IPv6 addresses
13751 that are listed in &%local_interfaces%&, data for the &%manualroute%& router,
13752 etc. are ignored. If IP literals are enabled, the &(ipliteral)& router declines
13753 to handle IPv6 literal addresses.
13754
13755
13756 .option dns_again_means_nonexist main "domain list&!!" unset
13757 .cindex "DNS" "&""try again""& response; overriding"
13758 DNS lookups give a &"try again"& response for the DNS errors
13759 &"non-authoritative host not found"& and &"SERVERFAIL"&. This can cause Exim to
13760 keep trying to deliver a message, or to give repeated temporary errors to
13761 incoming mail. Sometimes the effect is caused by a badly set up name server and
13762 may persist for a long time. If a domain which exhibits this problem matches
13763 anything in &%dns_again_means_nonexist%&, it is treated as if it did not exist.
13764 This option should be used with care. You can make it apply to reverse lookups
13765 by a setting such as this:
13766 .code
13767 dns_again_means_nonexist = *.in-addr.arpa
13768 .endd
13769 This option applies to all DNS lookups that Exim does. It also applies when the
13770 &[gethostbyname()]& or &[getipnodebyname()]& functions give temporary errors,
13771 since these are most likely to be caused by DNS lookup problems. The
13772 &(dnslookup)& router has some options of its own for controlling what happens
13773 when lookups for MX or SRV records give temporary errors. These more specific
13774 options are applied after this global option.
13775
13776 .option dns_check_names_pattern main string "see below"
13777 .cindex "DNS" "pre-check of name syntax"
13778 When this option is set to a non-empty string, it causes Exim to check domain
13779 names for characters that are not allowed in host names before handing them to
13780 the DNS resolver, because some resolvers give temporary errors for names that
13781 contain unusual characters. If a domain name contains any unwanted characters,
13782 a &"not found"& result is forced, and the resolver is not called. The check is
13783 done by matching the domain name against a regular expression, which is the
13784 value of this option. The default pattern is
13785 .code
13786 dns_check_names_pattern = \
13787   (?i)^(?>(?(1)\.|())[^\W_](?>[a-z0-9/-]*[^\W_])?)+$
13788 .endd
13789 which permits only letters, digits, slashes, and hyphens in components, but
13790 they must start and end with a letter or digit. Slashes are not, in fact,
13791 permitted in host names, but they are found in certain NS records (which can be
13792 accessed in Exim by using a &%dnsdb%& lookup). If you set
13793 &%allow_utf8_domains%&, you must modify this pattern, or set the option to an
13794 empty string.
13795
13796 .option dns_csa_search_limit main integer 5
13797 This option controls the depth of parental searching for CSA SRV records in the
13798 DNS, as described in more detail in section &<<SECTverifyCSA>>&.
13799
13800 .option dns_csa_use_reverse main boolean true
13801 This option controls whether or not an IP address, given as a CSA domain, is
13802 reversed and looked up in the reverse DNS, as described in more detail in
13803 section &<<SECTverifyCSA>>&.
13804
13805
13806 .option dns_dnssec_ok main integer -1
13807 .cindex "DNS" "resolver options"
13808 .cindex "DNS" "DNSSEC"
13809 If this option is set to a non-negative number then Exim will initialise the
13810 DNS resolver library to either use or not use DNSSEC, overriding the system
13811 default. A value of 0 coerces DNSSEC off, a value of 1 coerces DNSSEC on.
13812
13813 If the resolver library does not support DNSSEC then this option has no effect.
13814
13815
13816 .option dns_ipv4_lookup main "domain list&!!" unset
13817 .cindex "IPv6" "DNS lookup for AAAA records"
13818 .cindex "DNS" "IPv6 lookup for AAAA records"
13819 When Exim is compiled with IPv6 support and &%disable_ipv6%& is not set, it
13820 looks for IPv6 address records (AAAA records) as well as IPv4 address records
13821 (A records) when trying to find IP addresses for hosts, unless the host's
13822 domain matches this list.
13823
13824 This is a fudge to help with name servers that give big delays or otherwise do
13825 not work for the AAAA record type. In due course, when the world's name
13826 servers have all been upgraded, there should be no need for this option.
13827
13828
13829 .option dns_retrans main time 0s
13830 .cindex "DNS" "resolver options"
13831 The options &%dns_retrans%& and &%dns_retry%& can be used to set the
13832 retransmission and retry parameters for DNS lookups. Values of zero (the
13833 defaults) leave the system default settings unchanged. The first value is the
13834 time between retries, and the second is the number of retries. It isn't
13835 totally clear exactly how these settings affect the total time a DNS lookup may
13836 take. I haven't found any documentation about timeouts on DNS lookups; these
13837 parameter values are available in the external resolver interface structure,
13838 but nowhere does it seem to describe how they are used or what you might want
13839 to set in them.
13840
13841
13842 .option dns_retry main integer 0
13843 See &%dns_retrans%& above.
13844
13845
13846 .option dns_use_edns0 main integer -1
13847 .cindex "DNS" "resolver options"
13848 .cindex "DNS" "EDNS0"
13849 If this option is set to a non-negative number then Exim will initialise the
13850 DNS resolver library to either use or not use EDNS0 extensions, overriding
13851 the system default. A value of 0 coerces EDNS0 off, a value of 1 coerces EDNS0
13852 on.
13853
13854 If the resolver library does not support EDNS0 then this option has no effect.
13855
13856
13857 .option drop_cr main boolean false
13858 This is an obsolete option that is now a no-op. It used to affect the way Exim
13859 handled CR and LF characters in incoming messages. What happens now is
13860 described in section &<<SECTlineendings>>&.
13861
13862 .option dsn_from main "string&!!" "see below"
13863 .cindex "&'From:'& header line" "in bounces"
13864 .cindex "bounce messages" "&'From:'& line, specifying"
13865 This option can be used to vary the contents of &'From:'& header lines in
13866 bounces and other automatically generated messages (&"Delivery Status
13867 Notifications"& &-- hence the name of the option). The default setting is:
13868 .code
13869 dsn_from = Mail Delivery System <Mailer-Daemon@$qualify_domain>
13870 .endd
13871 The value is expanded every time it is needed. If the expansion fails, a
13872 panic is logged, and the default value is used.
13873
13874 .option envelope_to_remove main boolean true
13875 .cindex "&'Envelope-to:'& header line"
13876 Exim's transports have an option for adding an &'Envelope-to:'& header to a
13877 message when it is delivered, in exactly the same way as &'Return-path:'& is
13878 handled. &'Envelope-to:'& records the original recipient address from the
13879 messages's envelope that caused the delivery to happen. Such headers should not
13880 be present in incoming messages, and this option causes them to be removed at
13881 the time the message is received, to avoid any problems that might occur when a
13882 delivered message is subsequently sent on to some other recipient.
13883
13884
13885 .option errors_copy main "string list&!!" unset
13886 .cindex "bounce message" "copy to other address"
13887 .cindex "copy of bounce message"
13888 Setting this option causes Exim to send bcc copies of bounce messages that it
13889 generates to other addresses. &*Note*&: This does not apply to bounce messages
13890 coming from elsewhere. The value of the option is a colon-separated list of
13891 items. Each item consists of a pattern, terminated by white space, followed by
13892 a comma-separated list of email addresses. If a pattern contains spaces, it
13893 must be enclosed in double quotes.
13894
13895 Each pattern is processed in the same way as a single item in an address list
13896 (see section &<<SECTaddresslist>>&). When a pattern matches the recipient of
13897 the bounce message, the message is copied to the addresses on the list. The
13898 items are scanned in order, and once a matching one is found, no further items
13899 are examined. For example:
13900 .code
13901 errors_copy = spqr@mydomain   postmaster@mydomain.example :\
13902               rqps@mydomain   hostmaster@mydomain.example,\
13903                               postmaster@mydomain.example
13904 .endd
13905 .vindex "&$domain$&"
13906 .vindex "&$local_part$&"
13907 The address list is expanded before use. The expansion variables &$local_part$&
13908 and &$domain$& are set from the original recipient of the error message, and if
13909 there was any wildcard matching in the pattern, the expansion
13910 .cindex "numerical variables (&$1$& &$2$& etc)" "in &%errors_copy%&"
13911 variables &$0$&, &$1$&, etc. are set in the normal way.
13912
13913
13914 .option errors_reply_to main string unset
13915 .cindex "bounce message" "&'Reply-to:'& in"
13916 By default, Exim's bounce and delivery warning messages contain the header line
13917 .display
13918 &`From: Mail Delivery System <Mailer-Daemon@`&&'qualify-domain'&&`>`&
13919 .endd
13920 .oindex &%quota_warn_message%&
13921 where &'qualify-domain'& is the value of the &%qualify_domain%& option.
13922 A warning message that is generated by the &%quota_warn_message%& option in an
13923 &(appendfile)& transport may contain its own &'From:'& header line that
13924 overrides the default.
13925
13926 Experience shows that people reply to bounce messages. If the
13927 &%errors_reply_to%& option is set, a &'Reply-To:'& header is added to bounce
13928 and warning messages. For example:
13929 .code
13930 errors_reply_to = postmaster@my.domain.example
13931 .endd
13932 The value of the option is not expanded. It must specify a valid RFC 2822
13933 address. However, if a warning message that is generated by the
13934 &%quota_warn_message%& option in an &(appendfile)& transport contain its
13935 own &'Reply-To:'& header line, the value of the &%errors_reply_to%& option is
13936 not used.
13937
13938
13939 .option exim_group main string "compile-time configured"
13940 .cindex "gid (group id)" "Exim's own"
13941 .cindex "Exim group"
13942 This option changes the gid under which Exim runs when it gives up root
13943 privilege. The default value is compiled into the binary. The value of this
13944 option is used only when &%exim_user%& is also set. Unless it consists entirely
13945 of digits, the string is looked up using &[getgrnam()]&, and failure causes a
13946 configuration error. See chapter &<<CHAPsecurity>>& for a discussion of
13947 security issues.
13948
13949
13950 .option exim_path main string "see below"
13951 .cindex "Exim binary, path name"
13952 This option specifies the path name of the Exim binary, which is used when Exim
13953 needs to re-exec itself. The default is set up to point to the file &'exim'& in
13954 the directory configured at compile time by the BIN_DIRECTORY setting. It
13955 is necessary to change &%exim_path%& if, exceptionally, Exim is run from some
13956 other place.
13957 &*Warning*&: Do not use a macro to define the value of this option, because
13958 you will break those Exim utilities that scan the configuration file to find
13959 where the binary is. (They then use the &%-bP%& option to extract option
13960 settings such as the value of &%spool_directory%&.)
13961
13962
13963 .option exim_user main string "compile-time configured"
13964 .cindex "uid (user id)" "Exim's own"
13965 .cindex "Exim user"
13966 This option changes the uid under which Exim runs when it gives up root
13967 privilege. The default value is compiled into the binary. Ownership of the run
13968 time configuration file and the use of the &%-C%& and &%-D%& command line
13969 options is checked against the values in the binary, not what is set here.
13970
13971 Unless it consists entirely of digits, the string is looked up using
13972 &[getpwnam()]&, and failure causes a configuration error. If &%exim_group%& is
13973 not also supplied, the gid is taken from the result of &[getpwnam()]& if it is
13974 used. See chapter &<<CHAPsecurity>>& for a discussion of security issues.
13975
13976
13977 .option extra_local_interfaces main "string list" unset
13978 This option defines network interfaces that are to be considered local when
13979 routing, but which are not used for listening by the daemon. See section
13980 &<<SECTreclocipadd>>& for details.
13981
13982
13983 . Allow this long option name to split; give it unsplit as a fifth argument
13984 . for the automatic .oindex that is generated by .option.
13985
13986 .option "extract_addresses_remove_ &~&~arguments" main boolean true &&&
13987          extract_addresses_remove_arguments
13988 .oindex "&%-t%&"
13989 .cindex "command line" "addresses with &%-t%&"
13990 .cindex "Sendmail compatibility" "&%-t%& option"
13991 According to some Sendmail documentation (Sun, IRIX, HP-UX), if any addresses
13992 are present on the command line when the &%-t%& option is used to build an
13993 envelope from a message's &'To:'&, &'Cc:'& and &'Bcc:'& headers, the command
13994 line addresses are removed from the recipients list. This is also how Smail
13995 behaves. However, other Sendmail documentation (the O'Reilly book) states that
13996 command line addresses are added to those obtained from the header lines. When
13997 &%extract_addresses_remove_arguments%& is true (the default), Exim subtracts
13998 argument headers. If it is set false, Exim adds rather than removes argument
13999 addresses.
14000
14001
14002 .option finduser_retries main integer 0
14003 .cindex "NIS, retrying user lookups"
14004 On systems running NIS or other schemes in which user and group information is
14005 distributed from a remote system, there can be times when &[getpwnam()]& and
14006 related functions fail, even when given valid data, because things time out.
14007 Unfortunately these failures cannot be distinguished from genuine &"not found"&
14008 errors. If &%finduser_retries%& is set greater than zero, Exim will try that
14009 many extra times to find a user or a group, waiting for one second between
14010 retries.
14011
14012 .cindex "&_/etc/passwd_&" "multiple reading of"
14013 You should not set this option greater than zero if your user information is in
14014 a traditional &_/etc/passwd_& file, because it will cause Exim needlessly to
14015 search the file multiple times for non-existent users, and also cause delay.
14016
14017
14018
14019 .option freeze_tell main "string list, comma separated" unset
14020 .cindex "freezing messages" "sending a message when freezing"
14021 On encountering certain errors, or when configured to do so in a system filter,
14022 ACL, or special router, Exim freezes a message. This means that no further
14023 delivery attempts take place until an administrator thaws the message, or the
14024 &%auto_thaw%&, &%ignore_bounce_errors_after%&, or &%timeout_frozen_after%&
14025 feature cause it to be processed. If &%freeze_tell%& is set, Exim generates a
14026 warning message whenever it freezes something, unless the message it is
14027 freezing is a locally-generated bounce message. (Without this exception there
14028 is the possibility of looping.) The warning message is sent to the addresses
14029 supplied as the comma-separated value of this option. If several of the
14030 message's addresses cause freezing, only a single message is sent. If the
14031 freezing was automatic, the reason(s) for freezing can be found in the message
14032 log. If you configure freezing in a filter or ACL, you must arrange for any
14033 logging that you require.
14034
14035
14036 .option gecos_name main string&!! unset
14037 .cindex "HP-UX"
14038 .cindex "&""gecos""& field, parsing"
14039 Some operating systems, notably HP-UX, use the &"gecos"& field in the system
14040 password file to hold other information in addition to users' real names. Exim
14041 looks up this field for use when it is creating &'Sender:'& or &'From:'&
14042 headers. If either &%gecos_pattern%& or &%gecos_name%& are unset, the contents
14043 of the field are used unchanged, except that, if an ampersand is encountered,
14044 it is replaced by the user's login name with the first character forced to
14045 upper case, since this is a convention that is observed on many systems.
14046
14047 When these options are set, &%gecos_pattern%& is treated as a regular
14048 expression that is to be applied to the field (again with && replaced by the
14049 login name), and if it matches, &%gecos_name%& is expanded and used as the
14050 user's name.
14051
14052 .cindex "numerical variables (&$1$& &$2$& etc)" "in &%gecos_name%&"
14053 Numeric variables such as &$1$&, &$2$&, etc. can be used in the expansion to
14054 pick up sub-fields that were matched by the pattern. In HP-UX, where the user's
14055 name terminates at the first comma, the following can be used:
14056 .code
14057 gecos_pattern = ([^,]*)
14058 gecos_name = $1
14059 .endd
14060
14061 .option gecos_pattern main string unset
14062 See &%gecos_name%& above.
14063
14064
14065 .option gnutls_compat_mode main boolean unset
14066 This option controls whether GnuTLS is used in compatibility mode in an Exim
14067 server. This reduces security slightly, but improves interworking with older
14068 implementations of TLS.
14069
14070
14071 option gnutls_allow_auto_pkcs11 main boolean unset
14072 This option will let GnuTLS (2.12.0 or later) autoload PKCS11 modules with
14073 the p11-kit configuration files in &_/etc/pkcs11/modules/_&.
14074
14075 See
14076 &url(http://www.gnutls.org/manual/gnutls.html#Smart-cards-and-HSMs)
14077 for documentation.
14078
14079
14080
14081 .option headers_charset main string "see below"
14082 This option sets a default character set for translating from encoded MIME
14083 &"words"& in header lines, when referenced by an &$h_xxx$& expansion item. The
14084 default is the value of HEADERS_CHARSET in &_Local/Makefile_&. The
14085 ultimate default is ISO-8859-1. For more details see the description of header
14086 insertions in section &<<SECTexpansionitems>>&.
14087
14088
14089
14090 .option header_maxsize main integer "see below"
14091 .cindex "header section" "maximum size of"
14092 .cindex "limit" "size of message header section"
14093 This option controls the overall maximum size of a message's header
14094 section. The default is the value of HEADER_MAXSIZE in
14095 &_Local/Makefile_&; the default for that is 1M. Messages with larger header
14096 sections are rejected.
14097
14098
14099 .option header_line_maxsize main integer 0
14100 .cindex "header lines" "maximum size of"
14101 .cindex "limit" "size of one header line"
14102 This option limits the length of any individual header line in a message, after
14103 all the continuations have been joined together. Messages with individual
14104 header lines that are longer than the limit are rejected. The default value of
14105 zero means &"no limit"&.
14106
14107
14108
14109
14110 .option helo_accept_junk_hosts main "host list&!!" unset
14111 .cindex "HELO" "accepting junk data"
14112 .cindex "EHLO" "accepting junk data"
14113 Exim checks the syntax of HELO and EHLO commands for incoming SMTP
14114 mail, and gives an error response for invalid data. Unfortunately, there are
14115 some SMTP clients that send syntactic junk. They can be accommodated by setting
14116 this option. Note that this is a syntax check only. See &%helo_verify_hosts%&
14117 if you want to do semantic checking.
14118 See also &%helo_allow_chars%& for a way of extending the permitted character
14119 set.
14120
14121
14122 .option helo_allow_chars main string unset
14123 .cindex "HELO" "underscores in"
14124 .cindex "EHLO" "underscores in"
14125 .cindex "underscore in EHLO/HELO"
14126 This option can be set to a string of rogue characters that are permitted in
14127 all EHLO and HELO names in addition to the standard letters, digits,
14128 hyphens, and dots. If you really must allow underscores, you can set
14129 .code
14130 helo_allow_chars = _
14131 .endd
14132 Note that the value is one string, not a list.
14133
14134
14135 .option helo_lookup_domains main "domain list&!!" &`@:@[]`&
14136 .cindex "HELO" "forcing reverse lookup"
14137 .cindex "EHLO" "forcing reverse lookup"
14138 If the domain given by a client in a HELO or EHLO command matches this
14139 list, a reverse lookup is done in order to establish the host's true name. The
14140 default forces a lookup if the client host gives the server's name or any of
14141 its IP addresses (in brackets), something that broken clients have been seen to
14142 do.
14143
14144
14145 .option helo_try_verify_hosts main "host list&!!" unset
14146 .cindex "HELO verifying" "optional"
14147 .cindex "EHLO" "verifying, optional"
14148 By default, Exim just checks the syntax of HELO and EHLO commands (see
14149 &%helo_accept_junk_hosts%& and &%helo_allow_chars%&). However, some sites like
14150 to do more extensive checking of the data supplied by these commands. The ACL
14151 condition &`verify = helo`& is provided to make this possible.
14152 Formerly, it was necessary also to set this option (&%helo_try_verify_hosts%&)
14153 to force the check to occur. From release 4.53 onwards, this is no longer
14154 necessary. If the check has not been done before &`verify = helo`& is
14155 encountered, it is done at that time. Consequently, this option is obsolete.
14156 Its specification is retained here for backwards compatibility.
14157
14158 When an EHLO or HELO command is received, if the calling host matches
14159 &%helo_try_verify_hosts%&, Exim checks that the host name given in the HELO or
14160 EHLO command either:
14161
14162 .ilist
14163 is an IP literal matching the calling address of the host, or
14164 .next
14165 .cindex "DNS" "reverse lookup"
14166 .cindex "reverse DNS lookup"
14167 matches the host name that Exim obtains by doing a reverse lookup of the
14168 calling host address, or
14169 .next
14170 when looked up using &[gethostbyname()]& (or &[getipnodebyname()]& when
14171 available) yields the calling host address.
14172 .endlist
14173
14174 However, the EHLO or HELO command is not rejected if any of the checks
14175 fail. Processing continues, but the result of the check is remembered, and can
14176 be detected later in an ACL by the &`verify = helo`& condition.
14177
14178 .option helo_verify_hosts main "host list&!!" unset
14179 .cindex "HELO verifying" "mandatory"
14180 .cindex "EHLO" "verifying, mandatory"
14181 Like &%helo_try_verify_hosts%&, this option is obsolete, and retained only for
14182 backwards compatibility. For hosts that match this option, Exim checks the host
14183 name given in the HELO or EHLO in the same way as for
14184 &%helo_try_verify_hosts%&. If the check fails, the HELO or EHLO command is
14185 rejected with a 550 error, and entries are written to the main and reject logs.
14186 If a MAIL command is received before EHLO or HELO, it is rejected with a 503
14187 error.
14188
14189 .option hold_domains main "domain list&!!" unset
14190 .cindex "domain" "delaying delivery"
14191 .cindex "delivery" "delaying certain domains"
14192 This option allows mail for particular domains to be held on the queue
14193 manually. The option is overridden if a message delivery is forced with the
14194 &%-M%&, &%-qf%&, &%-Rf%& or &%-Sf%& options, and also while testing or
14195 verifying addresses using &%-bt%& or &%-bv%&. Otherwise, if a domain matches an
14196 item in &%hold_domains%&, no routing or delivery for that address is done, and
14197 it is deferred every time the message is looked at.
14198
14199 This option is intended as a temporary operational measure for delaying the
14200 delivery of mail while some problem is being sorted out, or some new
14201 configuration tested. If you just want to delay the processing of some
14202 domains until a queue run occurs, you should use &%queue_domains%& or
14203 &%queue_smtp_domains%&, not &%hold_domains%&.
14204
14205 A setting of &%hold_domains%& does not override Exim's code for removing
14206 messages from the queue if they have been there longer than the longest retry
14207 time in any retry rule. If you want to hold messages for longer than the normal
14208 retry times, insert a dummy retry rule with a long retry time.
14209
14210
14211 .option host_lookup main "host list&!!" unset
14212 .cindex "host name" "lookup, forcing"
14213 Exim does not look up the name of a calling host from its IP address unless it
14214 is required to compare against some host list, or the host matches
14215 &%helo_try_verify_hosts%& or &%helo_verify_hosts%&, or the host matches this
14216 option (which normally contains IP addresses rather than host names). The
14217 default configuration file contains
14218 .code
14219 host_lookup = *
14220 .endd
14221 which causes a lookup to happen for all hosts. If the expense of these lookups
14222 is felt to be too great, the setting can be changed or removed.
14223
14224 After a successful reverse lookup, Exim does a forward lookup on the name it
14225 has obtained, to verify that it yields the IP address that it started with. If
14226 this check fails, Exim behaves as if the name lookup failed.
14227
14228 .vindex "&$host_lookup_failed$&"
14229 .vindex "&$sender_host_name$&"
14230 After any kind of failure, the host name (in &$sender_host_name$&) remains
14231 unset, and &$host_lookup_failed$& is set to the string &"1"&. See also
14232 &%dns_again_means_nonexist%&, &%helo_lookup_domains%&, and
14233 &`verify = reverse_host_lookup`& in ACLs.
14234
14235
14236 .option host_lookup_order main "string list" &`bydns:byaddr`&
14237 This option specifies the order of different lookup methods when Exim is trying
14238 to find a host name from an IP address. The default is to do a DNS lookup
14239 first, and then to try a local lookup (using &[gethostbyaddr()]& or equivalent)
14240 if that fails. You can change the order of these lookups, or omit one entirely,
14241 if you want.
14242
14243 &*Warning*&: The &"byaddr"& method does not always yield aliases when there are
14244 multiple PTR records in the DNS and the IP address is not listed in
14245 &_/etc/hosts_&. Different operating systems give different results in this
14246 case. That is why the default tries a DNS lookup first.
14247
14248
14249
14250 .option host_reject_connection main "host list&!!" unset
14251 .cindex "host" "rejecting connections from"
14252 If this option is set, incoming SMTP calls from the hosts listed are rejected
14253 as soon as the connection is made.
14254 This option is obsolete, and retained only for backward compatibility, because
14255 nowadays the ACL specified by &%acl_smtp_connect%& can also reject incoming
14256 connections immediately.
14257
14258 The ability to give an immediate rejection (either by this option or using an
14259 ACL) is provided for use in unusual cases. Many hosts will just try again,
14260 sometimes without much delay. Normally, it is better to use an ACL to reject
14261 incoming messages at a later stage, such as after RCPT commands. See
14262 chapter &<<CHAPACL>>&.
14263
14264
14265 .option hosts_connection_nolog main "host list&!!" unset
14266 .cindex "host" "not logging connections from"
14267 This option defines a list of hosts for which connection logging does not
14268 happen, even though the &%smtp_connection%& log selector is set. For example,
14269 you might want not to log SMTP connections from local processes, or from
14270 127.0.0.1, or from your local LAN. This option is consulted in the main loop of
14271 the daemon; you should therefore strive to restrict its value to a short inline
14272 list of IP addresses and networks. To disable logging SMTP connections from
14273 local processes, you must create a host list with an empty item. For example:
14274 .code
14275 hosts_connection_nolog = :
14276 .endd
14277 If the &%smtp_connection%& log selector is not set, this option has no effect.
14278
14279
14280
14281 .option hosts_treat_as_local main "domain list&!!" unset
14282 .cindex "local host" "domains treated as"
14283 .cindex "host" "treated as local"
14284 If this option is set, any host names that match the domain list are treated as
14285 if they were the local host when Exim is scanning host lists obtained from MX
14286 records
14287 or other sources. Note that the value of this option is a domain list, not a
14288 host list, because it is always used to check host names, not IP addresses.
14289
14290 This option also applies when Exim is matching the special items
14291 &`@mx_any`&, &`@mx_primary`&, and &`@mx_secondary`& in a domain list (see
14292 section &<<SECTdomainlist>>&), and when checking the &%hosts%& option in the
14293 &(smtp)& transport for the local host (see the &%allow_localhost%& option in
14294 that transport). See also &%local_interfaces%&, &%extra_local_interfaces%&, and
14295 chapter &<<CHAPinterfaces>>&, which contains a discussion about local network
14296 interfaces and recognizing the local host.
14297
14298
14299 .option ibase_servers main "string list" unset
14300 .cindex "InterBase" "server list"
14301 This option provides a list of InterBase servers and associated connection data,
14302 to be used in conjunction with &(ibase)& lookups (see section &<<SECID72>>&).
14303 The option is available only if Exim has been built with InterBase support.
14304
14305
14306
14307 .option ignore_bounce_errors_after main time 10w
14308 .cindex "bounce message" "discarding"
14309 .cindex "discarding bounce message"
14310 This option affects the processing of bounce messages that cannot be delivered,
14311 that is, those that suffer a permanent delivery failure. (Bounce messages that
14312 suffer temporary delivery failures are of course retried in the usual way.)
14313
14314 After a permanent delivery failure, bounce messages are frozen,
14315 because there is no sender to whom they can be returned. When a frozen bounce
14316 message has been on the queue for more than the given time, it is unfrozen at
14317 the next queue run, and a further delivery is attempted. If delivery fails
14318 again, the bounce message is discarded. This makes it possible to keep failed
14319 bounce messages around for a shorter time than the normal maximum retry time
14320 for frozen messages. For example,
14321 .code
14322 ignore_bounce_errors_after = 12h
14323 .endd
14324 retries failed bounce message deliveries after 12 hours, discarding any further
14325 failures. If the value of this option is set to a zero time period, bounce
14326 failures are discarded immediately. Setting a very long time (as in the default
14327 value) has the effect of disabling this option. For ways of automatically
14328 dealing with other kinds of frozen message, see &%auto_thaw%& and
14329 &%timeout_frozen_after%&.
14330
14331
14332 .option ignore_fromline_hosts main "host list&!!" unset
14333 .cindex "&""From""& line"
14334 .cindex "UUCP" "&""From""& line"
14335 Some broken SMTP clients insist on sending a UUCP-like &"From&~"& line before
14336 the headers of a message. By default this is treated as the start of the
14337 message's body, which means that any following headers are not recognized as
14338 such. Exim can be made to ignore it by setting &%ignore_fromline_hosts%& to
14339 match those hosts that insist on sending it. If the sender is actually a local
14340 process rather than a remote host, and is using &%-bs%& to inject the messages,
14341 &%ignore_fromline_local%& must be set to achieve this effect.
14342
14343
14344 .option ignore_fromline_local main boolean false
14345 See &%ignore_fromline_hosts%& above.
14346
14347
14348 .option keep_malformed main time 4d
14349 This option specifies the length of time to keep messages whose spool files
14350 have been corrupted in some way. This should, of course, never happen. At the
14351 next attempt to deliver such a message, it gets removed. The incident is
14352 logged.
14353
14354
14355 .option ldap_ca_cert_dir main string unset
14356 .cindex "LDAP", "TLS CA certificate directory"
14357 This option indicates which directory contains CA certificates for verifying
14358 a TLS certificate presented by an LDAP server.
14359 While Exim does not provide a default value, your SSL library may.
14360 Analogous to &%tls_verify_certificates%& but as a client-side option for LDAP
14361 and constrained to be a directory.
14362
14363
14364 .option ldap_ca_cert_file main string unset
14365 .cindex "LDAP", "TLS CA certificate file"
14366 This option indicates which file contains CA certificates for verifying
14367 a TLS certificate presented by an LDAP server.
14368 While Exim does not provide a default value, your SSL library may.
14369 Analogous to &%tls_verify_certificates%& but as a client-side option for LDAP
14370 and constrained to be a file.
14371
14372
14373 .option ldap_cert_file main string unset
14374 .cindex "LDAP" "TLS client certificate file"
14375 This option indicates which file contains an TLS client certificate which
14376 Exim should present to the LDAP server during TLS negotiation.
14377 Should be used together with &%ldap_cert_key%&.
14378
14379
14380 .option ldap_cert_key main string unset
14381 .cindex "LDAP" "TLS client key file"
14382 This option indicates which file contains the secret/private key to use
14383 to prove identity to the LDAP server during TLS negotiation.
14384 Should be used together with &%ldap_cert_file%&, which contains the
14385 identity to be proven.
14386
14387
14388 .option ldap_cipher_suite main string unset
14389 .cindex "LDAP" "TLS cipher suite"
14390 This controls the TLS cipher-suite negotiation during TLS negotiation with
14391 the LDAP server.  See &<<SECTreqciphssl>>& for more details of the format of
14392 cipher-suite options with OpenSSL (as used by LDAP client libraries).
14393
14394
14395 .option ldap_default_servers main "string list" unset
14396 .cindex "LDAP" "default servers"
14397 This option provides a list of LDAP servers which are tried in turn when an
14398 LDAP query does not contain a server. See section &<<SECTforldaque>>& for
14399 details of LDAP queries. This option is available only when Exim has been built
14400 with LDAP support.
14401
14402
14403 .option ldap_require_cert main string unset.
14404 .cindex "LDAP" "policy for LDAP server TLS cert presentation"
14405 This should be one of the values "hard", "demand", "allow", "try" or "never".
14406 A value other than one of these is interpreted as "never".
14407 See the entry "TLS_REQCERT" in your system man page for ldap.conf(5).
14408 Although Exim does not set a default, the LDAP library probably defaults
14409 to hard/demand.
14410
14411
14412 .option ldap_start_tls main boolean false
14413 .cindex "LDAP" "whether or not to negotiate TLS"
14414 If set, Exim will attempt to negotiate TLS with the LDAP server when
14415 connecting on a regular LDAP port.  This is the LDAP equivalent of SMTP's
14416 "STARTTLS".  This is distinct from using "ldaps", which is the LDAP form
14417 of SSL-on-connect.
14418 In the event of failure to negotiate TLS, the action taken is controlled
14419 by &%ldap_require_cert%&.
14420
14421
14422 .option ldap_version main integer unset
14423 .cindex "LDAP" "protocol version, forcing"
14424 This option can be used to force Exim to set a specific protocol version for
14425 LDAP. If it option is unset, it is shown by the &%-bP%& command line option as
14426 -1. When this is the case, the default is 3 if LDAP_VERSION3 is defined in
14427 the LDAP headers; otherwise it is 2. This option is available only when Exim
14428 has been built with LDAP support.
14429
14430
14431
14432 .option local_from_check main boolean true
14433 .cindex "&'Sender:'& header line" "disabling addition of"
14434 .cindex "&'From:'& header line" "disabling checking of"
14435 When a message is submitted locally (that is, not over a TCP/IP connection) by
14436 an untrusted user, Exim removes any existing &'Sender:'& header line, and
14437 checks that the &'From:'& header line matches the login of the calling user and
14438 the domain specified by &%qualify_domain%&.
14439
14440 &*Note*&: An unqualified address (no domain) in the &'From:'& header in a
14441 locally submitted message is automatically qualified by Exim, unless the
14442 &%-bnq%& command line option is used.
14443
14444 You can use &%local_from_prefix%& and &%local_from_suffix%& to permit affixes
14445 on the local part. If the &'From:'& header line does not match, Exim adds a
14446 &'Sender:'& header with an address constructed from the calling user's login
14447 and the default qualify domain.
14448
14449 If &%local_from_check%& is set false, the &'From:'& header check is disabled,
14450 and no &'Sender:'& header is ever added. If, in addition, you want to retain
14451 &'Sender:'& header lines supplied by untrusted users, you must also set
14452 &%local_sender_retain%& to be true.
14453
14454 .cindex "envelope sender"
14455 These options affect only the header lines in the message. The envelope sender
14456 is still forced to be the login id at the qualify domain unless
14457 &%untrusted_set_sender%& permits the user to supply an envelope sender.
14458
14459 For messages received over TCP/IP, an ACL can specify &"submission mode"& to
14460 request similar header line checking. See section &<<SECTthesenhea>>&, which
14461 has more details about &'Sender:'& processing.
14462
14463
14464
14465
14466 .option local_from_prefix main string unset
14467 When Exim checks the &'From:'& header line of locally submitted messages for
14468 matching the login id (see &%local_from_check%& above), it can be configured to
14469 ignore certain prefixes and suffixes in the local part of the address. This is
14470 done by setting &%local_from_prefix%& and/or &%local_from_suffix%& to
14471 appropriate lists, in the same form as the &%local_part_prefix%& and
14472 &%local_part_suffix%& router options (see chapter &<<CHAProutergeneric>>&). For
14473 example, if
14474 .code
14475 local_from_prefix = *-
14476 .endd
14477 is set, a &'From:'& line containing
14478 .code
14479 From: anything-user@your.domain.example
14480 .endd
14481 will not cause a &'Sender:'& header to be added if &'user@your.domain.example'&
14482 matches the actual sender address that is constructed from the login name and
14483 qualify domain.
14484
14485
14486 .option local_from_suffix main string unset
14487 See &%local_from_prefix%& above.
14488
14489
14490 .option local_interfaces main "string list" "see below"
14491 This option controls which network interfaces are used by the daemon for
14492 listening; they are also used to identify the local host when routing. Chapter
14493 &<<CHAPinterfaces>>& contains a full description of this option and the related
14494 options &%daemon_smtp_ports%&, &%extra_local_interfaces%&,
14495 &%hosts_treat_as_local%&, and &%tls_on_connect_ports%&. The default value for
14496 &%local_interfaces%& is
14497 .code
14498 local_interfaces = 0.0.0.0
14499 .endd
14500 when Exim is built without IPv6 support; otherwise it is
14501 .code
14502 local_interfaces = <; ::0 ; 0.0.0.0
14503 .endd
14504
14505 .option local_scan_timeout main time 5m
14506 .cindex "timeout" "for &[local_scan()]& function"
14507 .cindex "&[local_scan()]& function" "timeout"
14508 This timeout applies to the &[local_scan()]& function (see chapter
14509 &<<CHAPlocalscan>>&). Zero means &"no timeout"&. If the timeout is exceeded,
14510 the incoming message is rejected with a temporary error if it is an SMTP
14511 message. For a non-SMTP message, the message is dropped and Exim ends with a
14512 non-zero code. The incident is logged on the main and reject logs.
14513
14514
14515
14516 .option local_sender_retain main boolean false
14517 .cindex "&'Sender:'& header line" "retaining from local submission"
14518 When a message is submitted locally (that is, not over a TCP/IP connection) by
14519 an untrusted user, Exim removes any existing &'Sender:'& header line. If you
14520 do not want this to happen, you must set &%local_sender_retain%&, and you must
14521 also set &%local_from_check%& to be false (Exim will complain if you do not).
14522 See also the ACL modifier &`control = suppress_local_fixups`&. Section
14523 &<<SECTthesenhea>>& has more details about &'Sender:'& processing.
14524
14525
14526
14527
14528 .option localhost_number main string&!! unset
14529 .cindex "host" "locally unique number for"
14530 .cindex "message ids" "with multiple hosts"
14531 .vindex "&$localhost_number$&"
14532 Exim's message ids are normally unique only within the local host. If
14533 uniqueness among a set of hosts is required, each host must set a different
14534 value for the &%localhost_number%& option. The string is expanded immediately
14535 after reading the configuration file (so that a number can be computed from the
14536 host name, for example) and the result of the expansion must be a number in the
14537 range 0&--16 (or 0&--10 on operating systems with case-insensitive file
14538 systems). This is available in subsequent string expansions via the variable
14539 &$localhost_number$&. When &%localhost_number is set%&, the final two
14540 characters of the message id, instead of just being a fractional part of the
14541 time, are computed from the time and the local host number as described in
14542 section &<<SECTmessiden>>&.
14543
14544
14545
14546 .option log_file_path main "string list&!!" "set at compile time"
14547 .cindex "log" "file path for"
14548 This option sets the path which is used to determine the names of Exim's log
14549 files, or indicates that logging is to be to syslog, or both. It is expanded
14550 when Exim is entered, so it can, for example, contain a reference to the host
14551 name. If no specific path is set for the log files at compile or run time, they
14552 are written in a sub-directory called &_log_& in Exim's spool directory.
14553 Chapter &<<CHAPlog>>& contains further details about Exim's logging, and
14554 section &<<SECTwhelogwri>>& describes how the contents of &%log_file_path%& are
14555 used. If this string is fixed at your installation (contains no expansion
14556 variables) it is recommended that you do not set this option in the
14557 configuration file, but instead supply the path using LOG_FILE_PATH in
14558 &_Local/Makefile_& so that it is available to Exim for logging errors detected
14559 early on &-- in particular, failure to read the configuration file.
14560
14561
14562 .option log_selector main string unset
14563 .cindex "log" "selectors"
14564 This option can be used to reduce or increase the number of things that Exim
14565 writes to its log files. Its argument is made up of names preceded by plus or
14566 minus characters. For example:
14567 .code
14568 log_selector = +arguments -retry_defer
14569 .endd
14570 A list of possible names and what they control is given in the chapter on
14571 logging, in section &<<SECTlogselector>>&.
14572
14573
14574 .option log_timezone main boolean false
14575 .cindex "log" "timezone for entries"
14576 .vindex "&$tod_log$&"
14577 .vindex "&$tod_zone$&"
14578 By default, the timestamps on log lines are in local time without the
14579 timezone. This means that if your timezone changes twice a year, the timestamps
14580 in log lines are ambiguous for an hour when the clocks go back. One way of
14581 avoiding this problem is to set the timezone to UTC. An alternative is to set
14582 &%log_timezone%& true. This turns on the addition of the timezone offset to
14583 timestamps in log lines. Turning on this option can add quite a lot to the size
14584 of log files because each line is extended by 6 characters. Note that the
14585 &$tod_log$& variable contains the log timestamp without the zone, but there is
14586 another variable called &$tod_zone$& that contains just the timezone offset.
14587
14588
14589 .option lookup_open_max main integer 25
14590 .cindex "too many open files"
14591 .cindex "open files, too many"
14592 .cindex "file" "too many open"
14593 .cindex "lookup" "maximum open files"
14594 .cindex "limit" "open files for lookups"
14595 This option limits the number of simultaneously open files for single-key
14596 lookups that use regular files (that is, &(lsearch)&, &(dbm)&, and &(cdb)&).
14597 Exim normally keeps these files open during routing, because often the same
14598 file is required several times. If the limit is reached, Exim closes the least
14599 recently used file. Note that if you are using the &'ndbm'& library, it
14600 actually opens two files for each logical DBM database, though it still counts
14601 as one for the purposes of &%lookup_open_max%&. If you are getting &"too many
14602 open files"& errors with NDBM, you need to reduce the value of
14603 &%lookup_open_max%&.
14604
14605
14606 .option max_username_length main integer 0
14607 .cindex "length of login name"
14608 .cindex "user name" "maximum length"
14609 .cindex "limit" "user name length"
14610 Some operating systems are broken in that they truncate long arguments to
14611 &[getpwnam()]& to eight characters, instead of returning &"no such user"&. If
14612 this option is set greater than zero, any attempt to call &[getpwnam()]& with
14613 an argument that is longer behaves as if &[getpwnam()]& failed.
14614
14615
14616 .option message_body_newlines main bool false
14617 .cindex "message body" "newlines in variables"
14618 .cindex "newline" "in message body variables"
14619 .vindex "&$message_body$&"
14620 .vindex "&$message_body_end$&"
14621 By default, newlines in the message body are replaced by spaces when setting
14622 the &$message_body$& and &$message_body_end$& expansion variables. If this
14623 option is set true, this no longer happens.
14624
14625
14626 .option message_body_visible main integer 500
14627 .cindex "body of message" "visible size"
14628 .cindex "message body" "visible size"
14629 .vindex "&$message_body$&"
14630 .vindex "&$message_body_end$&"
14631 This option specifies how much of a message's body is to be included in the
14632 &$message_body$& and &$message_body_end$& expansion variables.
14633
14634
14635 .option message_id_header_domain main string&!! unset
14636 .cindex "&'Message-ID:'& header line"
14637 If this option is set, the string is expanded and used as the right hand side
14638 (domain) of the &'Message-ID:'& header that Exim creates if a
14639 locally-originated incoming message does not have one. &"Locally-originated"&
14640 means &"not received over TCP/IP."&
14641 Otherwise, the primary host name is used.
14642 Only letters, digits, dot and hyphen are accepted; any other characters are
14643 replaced by hyphens. If the expansion is forced to fail, or if the result is an
14644 empty string, the option is ignored.
14645
14646
14647 .option message_id_header_text main string&!! unset
14648 If this variable is set, the string is expanded and used to augment the text of
14649 the &'Message-id:'& header that Exim creates if a locally-originated incoming
14650 message does not have one. The text of this header is required by RFC 2822 to
14651 take the form of an address. By default, Exim uses its internal message id as
14652 the local part, and the primary host name as the domain. If this option is set,
14653 it is expanded, and provided the expansion is not forced to fail, and does not
14654 yield an empty string, the result is inserted into the header immediately
14655 before the @, separated from the internal message id by a dot. Any characters
14656 that are illegal in an address are automatically converted into hyphens. This
14657 means that variables such as &$tod_log$& can be used, because the spaces and
14658 colons will become hyphens.
14659
14660
14661 .option message_logs main boolean true
14662 .cindex "message logs" "disabling"
14663 .cindex "log" "message log; disabling"
14664 If this option is turned off, per-message log files are not created in the
14665 &_msglog_& spool sub-directory. This reduces the amount of disk I/O required by
14666 Exim, by reducing the number of files involved in handling a message from a
14667 minimum of four (header spool file, body spool file, delivery journal, and
14668 per-message log) to three. The other major I/O activity is Exim's main log,
14669 which is not affected by this option.
14670
14671
14672 .option message_size_limit main string&!! 50M
14673 .cindex "message" "size limit"
14674 .cindex "limit" "message size"
14675 .cindex "size" "of message, limit"
14676 This option limits the maximum size of message that Exim will process. The
14677 value is expanded for each incoming connection so, for example, it can be made
14678 to depend on the IP address of the remote host for messages arriving via
14679 TCP/IP. After expansion, the value must be a sequence of decimal digits,
14680 optionally followed by K or M.
14681
14682 &*Note*&: This limit cannot be made to depend on a message's sender or any
14683 other properties of an individual message, because it has to be advertised in
14684 the server's response to EHLO. String expansion failure causes a temporary
14685 error. A value of zero means no limit, but its use is not recommended. See also
14686 &%bounce_return_size_limit%&.
14687
14688 Incoming SMTP messages are failed with a 552 error if the limit is
14689 exceeded; locally-generated messages either get a stderr message or a delivery
14690 failure message to the sender, depending on the &%-oe%& setting. Rejection of
14691 an oversized message is logged in both the main and the reject logs. See also
14692 the generic transport option &%message_size_limit%&, which limits the size of
14693 message that an individual transport can process.
14694
14695 If you use a virus-scanner and set this option to to a value larger than the
14696 maximum size that your virus-scanner is configured to support, you may get
14697 failures triggered by large mails.  The right size to configure for the
14698 virus-scanner depends upon what data is passed and the options in use but it's
14699 probably safest to just set it to a little larger than this value.  Eg, with a
14700 default Exim message size of 50M and a default ClamAV StreamMaxLength of 10M,
14701 some problems may result.
14702
14703 A value of 0 will disable size limit checking; Exim will still advertise the
14704 SIZE extension in an EHLO response, but without a limit, so as to permit
14705 SMTP clients to still indicate the message size along with the MAIL verb.
14706
14707
14708 .option move_frozen_messages main boolean false
14709 .cindex "frozen messages" "moving"
14710 This option, which is available only if Exim has been built with the setting
14711 .code
14712 SUPPORT_MOVE_FROZEN_MESSAGES=yes
14713 .endd
14714 in &_Local/Makefile_&, causes frozen messages and their message logs to be
14715 moved from the &_input_& and &_msglog_& directories on the spool to &_Finput_&
14716 and &_Fmsglog_&, respectively. There is currently no support in Exim or the
14717 standard utilities for handling such moved messages, and they do not show up in
14718 lists generated by &%-bp%& or by the Exim monitor.
14719
14720
14721 .option mua_wrapper main boolean false
14722 Setting this option true causes Exim to run in a very restrictive mode in which
14723 it passes messages synchronously to a smart host. Chapter &<<CHAPnonqueueing>>&
14724 contains a full description of this facility.
14725
14726
14727
14728 .option mysql_servers main "string list" unset
14729 .cindex "MySQL" "server list"
14730 This option provides a list of MySQL servers and associated connection data, to
14731 be used in conjunction with &(mysql)& lookups (see section &<<SECID72>>&). The
14732 option is available only if Exim has been built with MySQL support.
14733
14734
14735 .option never_users main "string list&!!" unset
14736 This option is expanded just once, at the start of Exim's processing. Local
14737 message deliveries are normally run in processes that are setuid to the
14738 recipient, and remote deliveries are normally run under Exim's own uid and gid.
14739 It is usually desirable to prevent any deliveries from running as root, as a
14740 safety precaution.
14741
14742 When Exim is built, an option called FIXED_NEVER_USERS can be set to a
14743 list of users that must not be used for local deliveries. This list is fixed in
14744 the binary and cannot be overridden by the configuration file. By default, it
14745 contains just the single user name &"root"&. The &%never_users%& runtime option
14746 can be used to add more users to the fixed list.
14747
14748 If a message is to be delivered as one of the users on the fixed list or the
14749 &%never_users%& list, an error occurs, and delivery is deferred. A common
14750 example is
14751 .code
14752 never_users = root:daemon:bin
14753 .endd
14754 Including root is redundant if it is also on the fixed list, but it does no
14755 harm. This option overrides the &%pipe_as_creator%& option of the &(pipe)&
14756 transport driver.
14757
14758
14759 .option openssl_options main "string list" "+no_sslv2"
14760 .cindex "OpenSSL "compatibility options"
14761 This option allows an administrator to adjust the SSL options applied
14762 by OpenSSL to connections.  It is given as a space-separated list of items,
14763 each one to be +added or -subtracted from the current value.
14764
14765 This option is only available if Exim is built against OpenSSL.  The values
14766 available for this option vary according to the age of your OpenSSL install.
14767 The &"all"& value controls a subset of flags which are available, typically
14768 the bug workaround options.  The &'SSL_CTX_set_options'& man page will
14769 list the values known on your system and Exim should support all the
14770 &"bug workaround"& options and many of the &"modifying"& options.  The Exim
14771 names lose the leading &"SSL_OP_"& and are lower-cased.
14772
14773 Note that adjusting the options can have severe impact upon the security of
14774 SSL as used by Exim.  It is possible to disable safety checks and shoot
14775 yourself in the foot in various unpleasant ways.  This option should not be
14776 adjusted lightly.  An unrecognised item will be detected at startup, by
14777 invoking Exim with the &%-bV%& flag.
14778
14779 Historical note: prior to release 4.80, Exim defaulted this value to
14780 "+dont_insert_empty_fragments", which may still be needed for compatibility
14781 with some clients, but which lowers security by increasing exposure to
14782 some now infamous attacks.
14783
14784 An example:
14785 .code
14786 # Make both old MS and old Eudora happy:
14787 openssl_options = -all +microsoft_big_sslv3_buffer \
14788                        +dont_insert_empty_fragments
14789 .endd
14790
14791 Possible options may include:
14792 .ilist
14793 &`all`&
14794 .next
14795 &`allow_unsafe_legacy_renegotiation`&
14796 .next
14797 &`cipher_server_preference`&
14798 .next
14799 &`dont_insert_empty_fragments`&
14800 .next
14801 &`ephemeral_rsa`&
14802 .next
14803 &`legacy_server_connect`&
14804 .next
14805 &`microsoft_big_sslv3_buffer`&
14806 .next
14807 &`microsoft_sess_id_bug`&
14808 .next
14809 &`msie_sslv2_rsa_padding`&
14810 .next
14811 &`netscape_challenge_bug`&
14812 .next
14813 &`netscape_reuse_cipher_change_bug`&
14814 .next
14815 &`no_compression`&
14816 .next
14817 &`no_session_resumption_on_renegotiation`&
14818 .next
14819 &`no_sslv2`&
14820 .next
14821 &`no_sslv3`&
14822 .next
14823 &`no_ticket`&
14824 .next
14825 &`no_tlsv1`&
14826 .next
14827 &`no_tlsv1_1`&
14828 .next
14829 &`no_tlsv1_2`&
14830 .next
14831 &`safari_ecdhe_ecdsa_bug`&
14832 .next
14833 &`single_dh_use`&
14834 .next
14835 &`single_ecdh_use`&
14836 .next
14837 &`ssleay_080_client_dh_bug`&
14838 .next
14839 &`sslref2_reuse_cert_type_bug`&
14840 .next
14841 &`tls_block_padding_bug`&
14842 .next
14843 &`tls_d5_bug`&
14844 .next
14845 &`tls_rollback_bug`&
14846 .endlist
14847
14848 As an aside, the &`safari_ecdhe_ecdsa_bug`& item is a misnomer and affects
14849 all clients connecting using the MacOS SecureTransport TLS facility prior
14850 to MacOS 10.8.4, including email clients.  If you see old MacOS clients failing
14851 to negotiate TLS then this option value might help, provided that your OpenSSL
14852 release is new enough to contain this work-around.  This may be a situation
14853 where you have to upgrade OpenSSL to get buggy clients working.
14854
14855
14856 .option oracle_servers main "string list" unset
14857 .cindex "Oracle" "server list"
14858 This option provides a list of Oracle servers and associated connection data,
14859 to be used in conjunction with &(oracle)& lookups (see section &<<SECID72>>&).
14860 The option is available only if Exim has been built with Oracle support.
14861
14862
14863 .option percent_hack_domains main "domain list&!!" unset
14864 .cindex "&""percent hack""&"
14865 .cindex "source routing" "in email address"
14866 .cindex "address" "source-routed"
14867 The &"percent hack"& is the convention whereby a local part containing a
14868 percent sign is re-interpreted as a new email address, with the percent
14869 replaced by @. This is sometimes called &"source routing"&, though that term is
14870 also applied to RFC 2822 addresses that begin with an @ character. If this
14871 option is set, Exim implements the percent facility for those domains listed,
14872 but no others. This happens before an incoming SMTP address is tested against
14873 an ACL.
14874
14875 &*Warning*&: The &"percent hack"& has often been abused by people who are
14876 trying to get round relaying restrictions. For this reason, it is best avoided
14877 if at all possible. Unfortunately, a number of less security-conscious MTAs
14878 implement it unconditionally. If you are running Exim on a gateway host, and
14879 routing mail through to internal MTAs without processing the local parts, it is
14880 a good idea to reject recipient addresses with percent characters in their
14881 local parts. Exim's default configuration does this.
14882
14883
14884 .option perl_at_start main boolean false
14885 This option is available only when Exim is built with an embedded Perl
14886 interpreter. See chapter &<<CHAPperl>>& for details of its use.
14887
14888
14889 .option perl_startup main string unset
14890 This option is available only when Exim is built with an embedded Perl
14891 interpreter. See chapter &<<CHAPperl>>& for details of its use.
14892
14893
14894 .option pgsql_servers main "string list" unset
14895 .cindex "PostgreSQL lookup type" "server list"
14896 This option provides a list of PostgreSQL servers and associated connection
14897 data, to be used in conjunction with &(pgsql)& lookups (see section
14898 &<<SECID72>>&). The option is available only if Exim has been built with
14899 PostgreSQL support.
14900
14901
14902 .option pid_file_path main string&!! "set at compile time"
14903 .cindex "daemon" "pid file path"
14904 .cindex "pid file, path for"
14905 This option sets the name of the file to which the Exim daemon writes its
14906 process id. The string is expanded, so it can contain, for example, references
14907 to the host name:
14908 .code
14909 pid_file_path = /var/log/$primary_hostname/exim.pid
14910 .endd
14911 If no path is set, the pid is written to the file &_exim-daemon.pid_& in Exim's
14912 spool directory.
14913 The value set by the option can be overridden by the &%-oP%& command line
14914 option. A pid file is not written if a &"non-standard"& daemon is run by means
14915 of the &%-oX%& option, unless a path is explicitly supplied by &%-oP%&.
14916
14917
14918 .option pipelining_advertise_hosts main "host list&!!" *
14919 .cindex "PIPELINING" "suppressing advertising"
14920 This option can be used to suppress the advertisement of the SMTP
14921 PIPELINING extension to specific hosts. See also the &*no_pipelining*&
14922 control in section &<<SECTcontrols>>&. When PIPELINING is not advertised and
14923 &%smtp_enforce_sync%& is true, an Exim server enforces strict synchronization
14924 for each SMTP command and response. When PIPELINING is advertised, Exim assumes
14925 that clients will use it; &"out of order"& commands that are &"expected"& do
14926 not count as protocol errors (see &%smtp_max_synprot_errors%&).
14927
14928
14929 .option preserve_message_logs main boolean false
14930 .cindex "message logs" "preserving"
14931 If this option is set, message log files are not deleted when messages are
14932 completed. Instead, they are moved to a sub-directory of the spool directory
14933 called &_msglog.OLD_&, where they remain available for statistical or debugging
14934 purposes. This is a dangerous option to set on systems with any appreciable
14935 volume of mail. Use with care!
14936
14937
14938 .option primary_hostname main string "see below"
14939 .cindex "name" "of local host"
14940 .cindex "host" "name of local"
14941 .cindex "local host" "name of"
14942 .vindex "&$primary_hostname$&"
14943 This specifies the name of the current host. It is used in the default EHLO or
14944 HELO command for outgoing SMTP messages (changeable via the &%helo_data%&
14945 option in the &(smtp)& transport), and as the default for &%qualify_domain%&.
14946 The value is also used by default in some SMTP response messages from an Exim
14947 server. This can be changed dynamically by setting &%smtp_active_hostname%&.
14948
14949 If &%primary_hostname%& is not set, Exim calls &[uname()]& to find the host
14950 name. If this fails, Exim panics and dies. If the name returned by &[uname()]&
14951 contains only one component, Exim passes it to &[gethostbyname()]& (or
14952 &[getipnodebyname()]& when available) in order to obtain the fully qualified
14953 version. The variable &$primary_hostname$& contains the host name, whether set
14954 explicitly by this option, or defaulted.
14955
14956
14957 .option print_topbitchars main boolean false
14958 .cindex "printing characters"
14959 .cindex "8-bit characters"
14960 By default, Exim considers only those characters whose codes lie in the range
14961 32&--126 to be printing characters. In a number of circumstances (for example,
14962 when writing log entries) non-printing characters are converted into escape
14963 sequences, primarily to avoid messing up the layout. If &%print_topbitchars%&
14964 is set, code values of 128 and above are also considered to be printing
14965 characters.
14966
14967 This option also affects the header syntax checks performed by the
14968 &(autoreply)& transport, and whether Exim uses RFC 2047 encoding of
14969 the user's full name when constructing From: and Sender: addresses (as
14970 described in section &<<SECTconstr>>&). Setting this option can cause
14971 Exim to generate eight bit message headers that do not conform to the
14972 standards.
14973
14974
14975 .option process_log_path main string unset
14976 .cindex "process log path"
14977 .cindex "log" "process log"
14978 .cindex "&'exiwhat'&"
14979 This option sets the name of the file to which an Exim process writes its
14980 &"process log"& when sent a USR1 signal. This is used by the &'exiwhat'&
14981 utility script. If this option is unset, the file called &_exim-process.info_&
14982 in Exim's spool directory is used. The ability to specify the name explicitly
14983 can be useful in environments where two different Exims are running, using
14984 different spool directories.
14985
14986
14987 .option prod_requires_admin main boolean true
14988 .oindex "&%-M%&"
14989 .oindex "&%-R%&"
14990 .oindex "&%-q%&"
14991 The &%-M%&, &%-R%&, and &%-q%& command-line options require the caller to be an
14992 admin user unless &%prod_requires_admin%& is set false. See also
14993 &%queue_list_requires_admin%&.
14994
14995
14996 .option qualify_domain main string "see below"
14997 .cindex "domain" "for qualifying addresses"
14998 .cindex "address" "qualification"
14999 This option specifies the domain name that is added to any envelope sender
15000 addresses that do not have a domain qualification. It also applies to
15001 recipient addresses if &%qualify_recipient%& is not set. Unqualified addresses
15002 are accepted by default only for locally-generated messages. Qualification is
15003 also applied to addresses in header lines such as &'From:'& and &'To:'& for
15004 locally-generated messages, unless the &%-bnq%& command line option is used.
15005
15006 Messages from external sources must always contain fully qualified addresses,
15007 unless the sending host matches &%sender_unqualified_hosts%& or
15008 &%recipient_unqualified_hosts%& (as appropriate), in which case incoming
15009 addresses are qualified with &%qualify_domain%& or &%qualify_recipient%& as
15010 necessary. Internally, Exim always works with fully qualified envelope
15011 addresses. If &%qualify_domain%& is not set, it defaults to the
15012 &%primary_hostname%& value.
15013
15014
15015 .option qualify_recipient main string "see below"
15016 This option allows you to specify a different domain for qualifying recipient
15017 addresses to the one that is used for senders. See &%qualify_domain%& above.
15018
15019
15020
15021 .option queue_domains main "domain list&!!" unset
15022 .cindex "domain" "specifying non-immediate delivery"
15023 .cindex "queueing incoming messages"
15024 .cindex "message" "queueing certain domains"
15025 This option lists domains for which immediate delivery is not required.
15026 A delivery process is started whenever a message is received, but only those
15027 domains that do not match are processed. All other deliveries wait until the
15028 next queue run. See also &%hold_domains%& and &%queue_smtp_domains%&.
15029
15030
15031 .option queue_list_requires_admin main boolean true
15032 .oindex "&%-bp%&"
15033 The &%-bp%& command-line option, which lists the messages that are on the
15034 queue, requires the caller to be an admin user unless
15035 &%queue_list_requires_admin%& is set false. See also &%prod_requires_admin%&.
15036
15037
15038 .option queue_only main boolean false
15039 .cindex "queueing incoming messages"
15040 .cindex "message" "queueing unconditionally"
15041 If &%queue_only%& is set, a delivery process is not automatically started
15042 whenever a message is received. Instead, the message waits on the queue for the
15043 next queue run. Even if &%queue_only%& is false, incoming messages may not get
15044 delivered immediately when certain conditions (such as heavy load) occur.
15045
15046 The &%-odq%& command line has the same effect as &%queue_only%&. The &%-odb%&
15047 and &%-odi%& command line options override &%queue_only%& unless
15048 &%queue_only_override%& is set false. See also &%queue_only_file%&,
15049 &%queue_only_load%&, and &%smtp_accept_queue%&.
15050
15051
15052 .option queue_only_file main string unset
15053 .cindex "queueing incoming messages"
15054 .cindex "message" "queueing by file existence"
15055 This option can be set to a colon-separated list of absolute path names, each
15056 one optionally preceded by &"smtp"&. When Exim is receiving a message,
15057 it tests for the existence of each listed path using a call to &[stat()]&. For
15058 each path that exists, the corresponding queueing option is set.
15059 For paths with no prefix, &%queue_only%& is set; for paths prefixed by
15060 &"smtp"&, &%queue_smtp_domains%& is set to match all domains. So, for example,
15061 .code
15062 queue_only_file = smtp/some/file
15063 .endd
15064 causes Exim to behave as if &%queue_smtp_domains%& were set to &"*"& whenever
15065 &_/some/file_& exists.
15066
15067
15068 .option queue_only_load main fixed-point unset
15069 .cindex "load average"
15070 .cindex "queueing incoming messages"
15071 .cindex "message" "queueing by load"
15072 If the system load average is higher than this value, incoming messages from
15073 all sources are queued, and no automatic deliveries are started. If this
15074 happens during local or remote SMTP input, all subsequent messages received on
15075 the same SMTP connection are queued by default, whatever happens to the load in
15076 the meantime, but this can be changed by setting &%queue_only_load_latch%&
15077 false.
15078
15079 Deliveries will subsequently be performed by queue runner processes. This
15080 option has no effect on ancient operating systems on which Exim cannot
15081 determine the load average. See also &%deliver_queue_load_max%& and
15082 &%smtp_load_reserve%&.
15083
15084
15085 .option queue_only_load_latch main boolean true
15086 .cindex "load average" "re-evaluating per message"
15087 When this option is true (the default), once one message has been queued
15088 because the load average is higher than the value set by &%queue_only_load%&,
15089 all subsequent messages received on the same SMTP connection are also queued.
15090 This is a deliberate choice; even though the load average may fall below the
15091 threshold, it doesn't seem right to deliver later messages on the same
15092 connection when not delivering earlier ones. However, there are special
15093 circumstances such as very long-lived connections from scanning appliances
15094 where this is not the best strategy. In such cases, &%queue_only_load_latch%&
15095 should be set false. This causes the value of the load average to be
15096 re-evaluated for each message.
15097
15098
15099 .option queue_only_override main boolean true
15100 .cindex "queueing incoming messages"
15101 When this option is true, the &%-od%&&'x'& command line options override the
15102 setting of &%queue_only%& or &%queue_only_file%& in the configuration file. If
15103 &%queue_only_override%& is set false, the &%-od%&&'x'& options cannot be used
15104 to override; they are accepted, but ignored.
15105
15106
15107 .option queue_run_in_order main boolean false
15108 .cindex "queue runner" "processing messages in order"
15109 If this option is set, queue runs happen in order of message arrival instead of
15110 in an arbitrary order. For this to happen, a complete list of the entire queue
15111 must be set up before the deliveries start. When the queue is all held in a
15112 single directory (the default), a single list is created for both the ordered
15113 and the non-ordered cases. However, if &%split_spool_directory%& is set, a
15114 single list is not created when &%queue_run_in_order%& is false. In this case,
15115 the sub-directories are processed one at a time (in a random order), and this
15116 avoids setting up one huge list for the whole queue. Thus, setting
15117 &%queue_run_in_order%& with &%split_spool_directory%& may degrade performance
15118 when the queue is large, because of the extra work in setting up the single,
15119 large list. In most situations, &%queue_run_in_order%& should not be set.
15120
15121
15122
15123 .option queue_run_max main integer 5
15124 .cindex "queue runner" "maximum number of"
15125 This controls the maximum number of queue runner processes that an Exim daemon
15126 can run simultaneously. This does not mean that it starts them all at once,
15127 but rather that if the maximum number are still running when the time comes to
15128 start another one, it refrains from starting another one. This can happen with
15129 very large queues and/or very sluggish deliveries. This option does not,
15130 however, interlock with other processes, so additional queue runners can be
15131 started by other means, or by killing and restarting the daemon.
15132
15133 Setting this option to zero does not suppress queue runs; rather, it disables
15134 the limit, allowing any number of simultaneous queue runner processes to be
15135 run. If you do not want queue runs to occur, omit the &%-q%&&'xx'& setting on
15136 the daemon's command line.
15137
15138 .option queue_smtp_domains main "domain list&!!" unset
15139 .cindex "queueing incoming messages"
15140 .cindex "message" "queueing remote deliveries"
15141 When this option is set, a delivery process is started whenever a message is
15142 received, routing is performed, and local deliveries take place.
15143 However, if any SMTP deliveries are required for domains that match
15144 &%queue_smtp_domains%&, they are not immediately delivered, but instead the
15145 message waits on the queue for the next queue run. Since routing of the message
15146 has taken place, Exim knows to which remote hosts it must be delivered, and so
15147 when the queue run happens, multiple messages for the same host are delivered
15148 over a single SMTP connection. The &%-odqs%& command line option causes all
15149 SMTP deliveries to be queued in this way, and is equivalent to setting
15150 &%queue_smtp_domains%& to &"*"&. See also &%hold_domains%& and
15151 &%queue_domains%&.
15152
15153
15154 .option receive_timeout main time 0s
15155 .cindex "timeout" "for non-SMTP input"
15156 This option sets the timeout for accepting a non-SMTP message, that is, the
15157 maximum time that Exim waits when reading a message on the standard input. If
15158 the value is zero, it will wait for ever. This setting is overridden by the
15159 &%-or%& command line option. The timeout for incoming SMTP messages is
15160 controlled by &%smtp_receive_timeout%&.
15161
15162 .option received_header_text main string&!! "see below"
15163 .cindex "customizing" "&'Received:'& header"
15164 .cindex "&'Received:'& header line" "customizing"
15165 This string defines the contents of the &'Received:'& message header that is
15166 added to each message, except for the timestamp, which is automatically added
15167 on at the end (preceded by a semicolon). The string is expanded each time it is
15168 used. If the expansion yields an empty string, no &'Received:'& header line is
15169 added to the message. Otherwise, the string should start with the text
15170 &"Received:"& and conform to the RFC 2822 specification for &'Received:'&
15171 header lines. The default setting is:
15172
15173 .code
15174 received_header_text = Received: \
15175   ${if def:sender_rcvhost {from $sender_rcvhost\n\t}\
15176   {${if def:sender_ident \
15177   {from ${quote_local_part:$sender_ident} }}\
15178   ${if def:sender_helo_name {(helo=$sender_helo_name)\n\t}}}}\
15179   by $primary_hostname \
15180   ${if def:received_protocol {with $received_protocol}} \
15181   ${if def:tls_in_cipher {($tls_in_cipher)\n\t}}\
15182   (Exim $version_number)\n\t\
15183   ${if def:sender_address \
15184   {(envelope-from <$sender_address>)\n\t}}\
15185   id $message_exim_id\
15186   ${if def:received_for {\n\tfor $received_for}}
15187 .endd
15188
15189 The reference to the TLS cipher is omitted when Exim is built without TLS
15190 support. The use of conditional expansions ensures that this works for both
15191 locally generated messages and messages received from remote hosts, giving
15192 header lines such as the following:
15193 .code
15194 Received: from scrooge.carol.example ([192.168.12.25] ident=root)
15195 by marley.carol.example with esmtp (Exim 4.00)
15196 (envelope-from <bob@carol.example>)
15197 id 16IOWa-00019l-00
15198 for chas@dickens.example; Tue, 25 Dec 2001 14:43:44 +0000
15199 Received: by scrooge.carol.example with local (Exim 4.00)
15200 id 16IOWW-000083-00; Tue, 25 Dec 2001 14:43:41 +0000
15201 .endd
15202 Until the body of the message has been received, the timestamp is the time when
15203 the message started to be received. Once the body has arrived, and all policy
15204 checks have taken place, the timestamp is updated to the time at which the
15205 message was accepted.
15206
15207
15208 .option received_headers_max main integer 30
15209 .cindex "loop" "prevention"
15210 .cindex "mail loop prevention"
15211 .cindex "&'Received:'& header line" "counting"
15212 When a message is to be delivered, the number of &'Received:'& headers is
15213 counted, and if it is greater than this parameter, a mail loop is assumed to
15214 have occurred, the delivery is abandoned, and an error message is generated.
15215 This applies to both local and remote deliveries.
15216
15217
15218 .option recipient_unqualified_hosts main "host list&!!" unset
15219 .cindex "unqualified addresses"
15220 .cindex "host" "unqualified addresses from"
15221 This option lists those hosts from which Exim is prepared to accept unqualified
15222 recipient addresses in message envelopes. The addresses are made fully
15223 qualified by the addition of the &%qualify_recipient%& value. This option also
15224 affects message header lines. Exim does not reject unqualified recipient
15225 addresses in headers, but it qualifies them only if the message came from a
15226 host that matches &%recipient_unqualified_hosts%&,
15227 or if the message was submitted locally (not using TCP/IP), and the &%-bnq%&
15228 option was not set.
15229
15230
15231 .option recipients_max main integer 0
15232 .cindex "limit" "number of recipients"
15233 .cindex "recipient" "maximum number"
15234 If this option is set greater than zero, it specifies the maximum number of
15235 original recipients for any message. Additional recipients that are generated
15236 by aliasing or forwarding do not count. SMTP messages get a 452 response for
15237 all recipients over the limit; earlier recipients are delivered as normal.
15238 Non-SMTP messages with too many recipients are failed, and no deliveries are
15239 done.
15240
15241 .cindex "RCPT" "maximum number of incoming"
15242 &*Note*&: The RFCs specify that an SMTP server should accept at least 100
15243 RCPT commands in a single message.
15244
15245
15246 .option recipients_max_reject main boolean false
15247 If this option is set true, Exim rejects SMTP messages containing too many
15248 recipients by giving 552 errors to the surplus RCPT commands, and a 554
15249 error to the eventual DATA command. Otherwise (the default) it gives a 452
15250 error to the surplus RCPT commands and accepts the message on behalf of the
15251 initial set of recipients. The remote server should then re-send the message
15252 for the remaining recipients at a later time.
15253
15254
15255 .option remote_max_parallel main integer 2
15256 .cindex "delivery" "parallelism for remote"
15257 This option controls parallel delivery of one message to a number of remote
15258 hosts. If the value is less than 2, parallel delivery is disabled, and Exim
15259 does all the remote deliveries for a message one by one. Otherwise, if a single
15260 message has to be delivered to more than one remote host, or if several copies
15261 have to be sent to the same remote host, up to &%remote_max_parallel%&
15262 deliveries are done simultaneously. If more than &%remote_max_parallel%&
15263 deliveries are required, the maximum number of processes are started, and as
15264 each one finishes, another is begun. The order of starting processes is the
15265 same as if sequential delivery were being done, and can be controlled by the
15266 &%remote_sort_domains%& option. If parallel delivery takes place while running
15267 with debugging turned on, the debugging output from each delivery process is
15268 tagged with its process id.
15269
15270 This option controls only the maximum number of parallel deliveries for one
15271 message in one Exim delivery process. Because Exim has no central queue
15272 manager, there is no way of controlling the total number of simultaneous
15273 deliveries if the configuration allows a delivery attempt as soon as a message
15274 is received.
15275
15276 .cindex "number of deliveries"
15277 .cindex "delivery" "maximum number of"
15278 If you want to control the total number of deliveries on the system, you
15279 need to set the &%queue_only%& option. This ensures that all incoming messages
15280 are added to the queue without starting a delivery process. Then set up an Exim
15281 daemon to start queue runner processes at appropriate intervals (probably
15282 fairly often, for example, every minute), and limit the total number of queue
15283 runners by setting the &%queue_run_max%& parameter. Because each queue runner
15284 delivers only one message at a time, the maximum number of deliveries that can
15285 then take place at once is &%queue_run_max%& multiplied by
15286 &%remote_max_parallel%&.
15287
15288 If it is purely remote deliveries you want to control, use
15289 &%queue_smtp_domains%& instead of &%queue_only%&. This has the added benefit of
15290 doing the SMTP routing before queueing, so that several messages for the same
15291 host will eventually get delivered down the same connection.
15292
15293
15294 .option remote_sort_domains main "domain list&!!" unset
15295 .cindex "sorting remote deliveries"
15296 .cindex "delivery" "sorting remote"
15297 When there are a number of remote deliveries for a message, they are sorted by
15298 domain into the order given by this list. For example,
15299 .code
15300 remote_sort_domains = *.cam.ac.uk:*.uk
15301 .endd
15302 would attempt to deliver to all addresses in the &'cam.ac.uk'& domain first,
15303 then to those in the &%uk%& domain, then to any others.
15304
15305
15306 .option retry_data_expire main time 7d
15307 .cindex "hints database" "data expiry"
15308 This option sets a &"use before"& time on retry information in Exim's hints
15309 database. Any older retry data is ignored. This means that, for example, once a
15310 host has not been tried for 7 days, Exim behaves as if it has no knowledge of
15311 past failures.
15312
15313
15314 .option retry_interval_max main time 24h
15315 .cindex "retry" "limit on interval"
15316 .cindex "limit" "on retry interval"
15317 Chapter &<<CHAPretry>>& describes Exim's mechanisms for controlling the
15318 intervals between delivery attempts for messages that cannot be delivered
15319 straight away. This option sets an overall limit to the length of time between
15320 retries. It cannot be set greater than 24 hours; any attempt to do so forces
15321 the default value.
15322
15323
15324 .option return_path_remove main boolean true
15325 .cindex "&'Return-path:'& header line" "removing"
15326 RFC 2821, section 4.4, states that an SMTP server must insert a
15327 &'Return-path:'& header line into a message when it makes a &"final delivery"&.
15328 The &'Return-path:'& header preserves the sender address as received in the
15329 MAIL command. This description implies that this header should not be present
15330 in an incoming message. If &%return_path_remove%& is true, any existing
15331 &'Return-path:'& headers are removed from messages at the time they are
15332 received. Exim's transports have options for adding &'Return-path:'& headers at
15333 the time of delivery. They are normally used only for final local deliveries.
15334
15335
15336 .option return_size_limit main integer 100K
15337 This option is an obsolete synonym for &%bounce_return_size_limit%&.
15338
15339
15340 .option rfc1413_hosts main "host list&!!" *
15341 .cindex "RFC 1413"
15342 .cindex "host" "for RFC 1413 calls"
15343 RFC 1413 identification calls are made to any client host which matches an item
15344 in the list.
15345
15346 .option rfc1413_query_timeout main time 5s
15347 .cindex "RFC 1413" "query timeout"
15348 .cindex "timeout" "for RFC 1413 call"
15349 This sets the timeout on RFC 1413 identification calls. If it is set to zero,
15350 no RFC 1413 calls are ever made.
15351
15352
15353 .option sender_unqualified_hosts main "host list&!!" unset
15354 .cindex "unqualified addresses"
15355 .cindex "host" "unqualified addresses from"
15356 This option lists those hosts from which Exim is prepared to accept unqualified
15357 sender addresses. The addresses are made fully qualified by the addition of
15358 &%qualify_domain%&. This option also affects message header lines. Exim does
15359 not reject unqualified addresses in headers that contain sender addresses, but
15360 it qualifies them only if the message came from a host that matches
15361 &%sender_unqualified_hosts%&, or if the message was submitted locally (not
15362 using TCP/IP), and the &%-bnq%& option was not set.
15363
15364
15365 .option smtp_accept_keepalive main boolean true
15366 .cindex "keepalive" "on incoming connection"
15367 This option controls the setting of the SO_KEEPALIVE option on incoming
15368 TCP/IP socket connections. When set, it causes the kernel to probe idle
15369 connections periodically, by sending packets with &"old"& sequence numbers. The
15370 other end of the connection should send an acknowledgment if the connection is
15371 still okay or a reset if the connection has been aborted. The reason for doing
15372 this is that it has the beneficial effect of freeing up certain types of
15373 connection that can get stuck when the remote host is disconnected without
15374 tidying up the TCP/IP call properly. The keepalive mechanism takes several
15375 hours to detect unreachable hosts.
15376
15377
15378
15379 .option smtp_accept_max main integer 20
15380 .cindex "limit" "incoming SMTP connections"
15381 .cindex "SMTP" "incoming connection count"
15382 .cindex "inetd"
15383 This option specifies the maximum number of simultaneous incoming SMTP calls
15384 that Exim will accept. It applies only to the listening daemon; there is no
15385 control (in Exim) when incoming SMTP is being handled by &'inetd'&. If the
15386 value is set to zero, no limit is applied. However, it is required to be
15387 non-zero if either &%smtp_accept_max_per_host%& or &%smtp_accept_queue%& is
15388 set. See also &%smtp_accept_reserve%& and &%smtp_load_reserve%&.
15389
15390 A new SMTP connection is immediately rejected if the &%smtp_accept_max%& limit
15391 has been reached. If not, Exim first checks &%smtp_accept_max_per_host%&. If
15392 that limit has not been reached for the client host, &%smtp_accept_reserve%&
15393 and &%smtp_load_reserve%& are then checked before accepting the connection.
15394
15395
15396 .option smtp_accept_max_nonmail main integer 10
15397 .cindex "limit" "non-mail SMTP commands"
15398 .cindex "SMTP" "limiting non-mail commands"
15399 Exim counts the number of &"non-mail"& commands in an SMTP session, and drops
15400 the connection if there are too many. This option defines &"too many"&. The
15401 check catches some denial-of-service attacks, repeated failing AUTHs, or a mad
15402 client looping sending EHLO, for example. The check is applied only if the
15403 client host matches &%smtp_accept_max_nonmail_hosts%&.
15404
15405 When a new message is expected, one occurrence of RSET is not counted. This
15406 allows a client to send one RSET between messages (this is not necessary,
15407 but some clients do it). Exim also allows one uncounted occurrence of HELO
15408 or EHLO, and one occurrence of STARTTLS between messages. After
15409 starting up a TLS session, another EHLO is expected, and so it too is not
15410 counted. The first occurrence of AUTH in a connection, or immediately
15411 following STARTTLS is not counted. Otherwise, all commands other than
15412 MAIL, RCPT, DATA, and QUIT are counted.
15413
15414
15415 .option smtp_accept_max_nonmail_hosts main "host list&!!" *
15416 You can control which hosts are subject to the &%smtp_accept_max_nonmail%&
15417 check by setting this option. The default value makes it apply to all hosts. By
15418 changing the value, you can exclude any badly-behaved hosts that you have to
15419 live with.
15420
15421
15422 . Allow this long option name to split; give it unsplit as a fifth argument
15423 . for the automatic .oindex that is generated by .option.
15424 . We insert " &~&~" which is both pretty nasty visually and results in
15425 . non-searchable text.  HowItWorks.txt mentions an option for inserting
15426 . zero-width-space, which would be nicer visually and results in (at least)
15427 . html that Firefox will split on when it's forced to reflow (rather than
15428 . inserting a horizontal scrollbar).  However, the text is still not
15429 . searchable.  NM changed this occurrence for bug 1197 to no longer allow
15430 . the option name to split.
15431
15432 .option "smtp_accept_max_per_connection" main integer 1000 &&&
15433          smtp_accept_max_per_connection
15434 .cindex "SMTP" "limiting incoming message count"
15435 .cindex "limit" "messages per SMTP connection"
15436 The value of this option limits the number of MAIL commands that Exim is
15437 prepared to accept over a single SMTP connection, whether or not each command
15438 results in the transfer of a message. After the limit is reached, a 421
15439 response is given to subsequent MAIL commands. This limit is a safety
15440 precaution against a client that goes mad (incidents of this type have been
15441 seen).
15442
15443
15444 .option smtp_accept_max_per_host main string&!! unset
15445 .cindex "limit" "SMTP connections from one host"
15446 .cindex "host" "limiting SMTP connections from"
15447 This option restricts the number of simultaneous IP connections from a single
15448 host (strictly, from a single IP address) to the Exim daemon. The option is
15449 expanded, to enable different limits to be applied to different hosts by
15450 reference to &$sender_host_address$&. Once the limit is reached, additional
15451 connection attempts from the same host are rejected with error code 421. This
15452 is entirely independent of &%smtp_accept_reserve%&. The option's default value
15453 of zero imposes no limit. If this option is set greater than zero, it is
15454 required that &%smtp_accept_max%& be non-zero.
15455
15456 &*Warning*&: When setting this option you should not use any expansion
15457 constructions that take an appreciable amount of time. The expansion and test
15458 happen in the main daemon loop, in order to reject additional connections
15459 without forking additional processes (otherwise a denial-of-service attack
15460 could cause a vast number or processes to be created). While the daemon is
15461 doing this processing, it cannot accept any other incoming connections.
15462
15463
15464
15465 .option smtp_accept_queue main integer 0
15466 .cindex "SMTP" "incoming connection count"
15467 .cindex "queueing incoming messages"
15468 .cindex "message" "queueing by SMTP connection count"
15469 If the number of simultaneous incoming SMTP connections being handled via the
15470 listening daemon exceeds this value, messages received by SMTP are just placed
15471 on the queue; no delivery processes are started automatically. The count is
15472 fixed at the start of an SMTP connection. It cannot be updated in the
15473 subprocess that receives messages, and so the queueing or not queueing applies
15474 to all messages received in the same connection.
15475
15476 A value of zero implies no limit, and clearly any non-zero value is useful only
15477 if it is less than the &%smtp_accept_max%& value (unless that is zero). See
15478 also &%queue_only%&, &%queue_only_load%&, &%queue_smtp_domains%&, and the
15479 various &%-od%&&'x'& command line options.
15480
15481
15482 . See the comment on smtp_accept_max_per_connection
15483
15484 .option "smtp_accept_queue_per_connection" main integer 10 &&&
15485          smtp_accept_queue_per_connection
15486 .cindex "queueing incoming messages"
15487 .cindex "message" "queueing by message count"
15488 This option limits the number of delivery processes that Exim starts
15489 automatically when receiving messages via SMTP, whether via the daemon or by
15490 the use of &%-bs%& or &%-bS%&. If the value of the option is greater than zero,
15491 and the number of messages received in a single SMTP session exceeds this
15492 number, subsequent messages are placed on the queue, but no delivery processes
15493 are started. This helps to limit the number of Exim processes when a server
15494 restarts after downtime and there is a lot of mail waiting for it on other
15495 systems. On large systems, the default should probably be increased, and on
15496 dial-in client systems it should probably be set to zero (that is, disabled).
15497
15498
15499 .option smtp_accept_reserve main integer 0
15500 .cindex "SMTP" "incoming call count"
15501 .cindex "host" "reserved"
15502 When &%smtp_accept_max%& is set greater than zero, this option specifies a
15503 number of SMTP connections that are reserved for connections from the hosts
15504 that are specified in &%smtp_reserve_hosts%&. The value set in
15505 &%smtp_accept_max%& includes this reserve pool. The specified hosts are not
15506 restricted to this number of connections; the option specifies a minimum number
15507 of connection slots for them, not a maximum. It is a guarantee that this group
15508 of hosts can always get at least &%smtp_accept_reserve%& connections. However,
15509 the limit specified by &%smtp_accept_max_per_host%& is still applied to each
15510 individual host.
15511
15512 For example, if &%smtp_accept_max%& is set to 50 and &%smtp_accept_reserve%& is
15513 set to 5, once there are 45 active connections (from any hosts), new
15514 connections are accepted only from hosts listed in &%smtp_reserve_hosts%&,
15515 provided the other criteria for acceptance are met.
15516
15517
15518 .option smtp_active_hostname main string&!! unset
15519 .cindex "host" "name in SMTP responses"
15520 .cindex "SMTP" "host name in responses"
15521 .vindex "&$primary_hostname$&"
15522 This option is provided for multi-homed servers that want to masquerade as
15523 several different hosts. At the start of an incoming SMTP connection, its value
15524 is expanded and used instead of the value of &$primary_hostname$& in SMTP
15525 responses. For example, it is used as domain name in the response to an
15526 incoming HELO or EHLO command.
15527
15528 .vindex "&$smtp_active_hostname$&"
15529 The active hostname is placed in the &$smtp_active_hostname$& variable, which
15530 is saved with any messages that are received. It is therefore available for use
15531 in routers and transports when the message is later delivered.
15532
15533 If this option is unset, or if its expansion is forced to fail, or if the
15534 expansion results in an empty string, the value of &$primary_hostname$& is
15535 used. Other expansion failures cause a message to be written to the main and
15536 panic logs, and the SMTP command receives a temporary error. Typically, the
15537 value of &%smtp_active_hostname%& depends on the incoming interface address.
15538 For example:
15539 .code
15540 smtp_active_hostname = ${if eq{$received_ip_address}{10.0.0.1}\
15541   {cox.mydomain}{box.mydomain}}
15542 .endd
15543
15544 Although &$smtp_active_hostname$& is primarily concerned with incoming
15545 messages, it is also used as the default for HELO commands in callout
15546 verification if there is no remote transport from which to obtain a
15547 &%helo_data%& value.
15548
15549 .option smtp_banner main string&!! "see below"
15550 .cindex "SMTP" "welcome banner"
15551 .cindex "banner for SMTP"
15552 .cindex "welcome banner for SMTP"
15553 .cindex "customizing" "SMTP banner"
15554 This string, which is expanded every time it is used, is output as the initial
15555 positive response to an SMTP connection. The default setting is:
15556 .code
15557 smtp_banner = $smtp_active_hostname ESMTP Exim \
15558   $version_number $tod_full
15559 .endd
15560 Failure to expand the string causes a panic error. If you want to create a
15561 multiline response to the initial SMTP connection, use &"\n"& in the string at
15562 appropriate points, but not at the end. Note that the 220 code is not included
15563 in this string. Exim adds it automatically (several times in the case of a
15564 multiline response).
15565
15566
15567 .option smtp_check_spool_space main boolean true
15568 .cindex "checking disk space"
15569 .cindex "disk space, checking"
15570 .cindex "spool directory" "checking space"
15571 When this option is set, if an incoming SMTP session encounters the SIZE
15572 option on a MAIL command, it checks that there is enough space in the
15573 spool directory's partition to accept a message of that size, while still
15574 leaving free the amount specified by &%check_spool_space%& (even if that value
15575 is zero). If there isn't enough space, a temporary error code is returned.
15576
15577
15578 .option smtp_connect_backlog main integer 20
15579 .cindex "connection backlog"
15580 .cindex "SMTP" "connection backlog"
15581 .cindex "backlog of connections"
15582 This option specifies a maximum number of waiting SMTP connections. Exim passes
15583 this value to the TCP/IP system when it sets up its listener. Once this number
15584 of connections are waiting for the daemon's attention, subsequent connection
15585 attempts are refused at the TCP/IP level. At least, that is what the manuals
15586 say; in some circumstances such connection attempts have been observed to time
15587 out instead. For large systems it is probably a good idea to increase the
15588 value (to 50, say). It also gives some protection against denial-of-service
15589 attacks by SYN flooding.
15590
15591
15592 .option smtp_enforce_sync main boolean true
15593 .cindex "SMTP" "synchronization checking"
15594 .cindex "synchronization checking in SMTP"
15595 The SMTP protocol specification requires the client to wait for a response from
15596 the server at certain points in the dialogue. Without PIPELINING these
15597 synchronization points are after every command; with PIPELINING they are
15598 fewer, but they still exist.
15599
15600 Some spamming sites send out a complete set of SMTP commands without waiting
15601 for any response. Exim protects against this by rejecting a message if the
15602 client has sent further input when it should not have. The error response &"554
15603 SMTP synchronization error"& is sent, and the connection is dropped. Testing
15604 for this error cannot be perfect because of transmission delays (unexpected
15605 input may be on its way but not yet received when Exim checks). However, it
15606 does detect many instances.
15607
15608 The check can be globally disabled by setting &%smtp_enforce_sync%& false.
15609 If you want to disable the check selectively (for example, only for certain
15610 hosts), you can do so by an appropriate use of a &%control%& modifier in an ACL
15611 (see section &<<SECTcontrols>>&). See also &%pipelining_advertise_hosts%&.
15612
15613
15614
15615 .option smtp_etrn_command main string&!! unset
15616 .cindex "ETRN" "command to be run"
15617 .vindex "&$domain$&"
15618 If this option is set, the given command is run whenever an SMTP ETRN
15619 command is received from a host that is permitted to issue such commands (see
15620 chapter &<<CHAPACL>>&). The string is split up into separate arguments which
15621 are independently expanded. The expansion variable &$domain$& is set to the
15622 argument of the ETRN command, and no syntax checking is done on it. For
15623 example:
15624 .code
15625 smtp_etrn_command = /etc/etrn_command $domain \
15626                     $sender_host_address
15627 .endd
15628 A new process is created to run the command, but Exim does not wait for it to
15629 complete. Consequently, its status cannot be checked. If the command cannot be
15630 run, a line is written to the panic log, but the ETRN caller still receives
15631 a 250 success response. Exim is normally running under its own uid when
15632 receiving SMTP, so it is not possible for it to change the uid before running
15633 the command.
15634
15635
15636 .option smtp_etrn_serialize main boolean true
15637 .cindex "ETRN" "serializing"
15638 When this option is set, it prevents the simultaneous execution of more than
15639 one identical command as a result of ETRN in an SMTP connection. See
15640 section &<<SECTETRN>>& for details.
15641
15642
15643 .option smtp_load_reserve main fixed-point unset
15644 .cindex "load average"
15645 If the system load average ever gets higher than this, incoming SMTP calls are
15646 accepted only from those hosts that match an entry in &%smtp_reserve_hosts%&.
15647 If &%smtp_reserve_hosts%& is not set, no incoming SMTP calls are accepted when
15648 the load is over the limit. The option has no effect on ancient operating
15649 systems on which Exim cannot determine the load average. See also
15650 &%deliver_queue_load_max%& and &%queue_only_load%&.
15651
15652
15653
15654 .option smtp_max_synprot_errors main integer 3
15655 .cindex "SMTP" "limiting syntax and protocol errors"
15656 .cindex "limit" "SMTP syntax and protocol errors"
15657 Exim rejects SMTP commands that contain syntax or protocol errors. In
15658 particular, a syntactically invalid email address, as in this command:
15659 .code
15660 RCPT TO:<abc xyz@a.b.c>
15661 .endd
15662 causes immediate rejection of the command, before any other tests are done.
15663 (The ACL cannot be run if there is no valid address to set up for it.) An
15664 example of a protocol error is receiving RCPT before MAIL. If there are
15665 too many syntax or protocol errors in one SMTP session, the connection is
15666 dropped. The limit is set by this option.
15667
15668 .cindex "PIPELINING" "expected errors"
15669 When the PIPELINING extension to SMTP is in use, some protocol errors are
15670 &"expected"&, for instance, a RCPT command after a rejected MAIL command.
15671 Exim assumes that PIPELINING will be used if it advertises it (see
15672 &%pipelining_advertise_hosts%&), and in this situation, &"expected"& errors do
15673 not count towards the limit.
15674
15675
15676
15677 .option smtp_max_unknown_commands main integer 3
15678 .cindex "SMTP" "limiting unknown commands"
15679 .cindex "limit" "unknown SMTP commands"
15680 If there are too many unrecognized commands in an incoming SMTP session, an
15681 Exim server drops the connection. This is a defence against some kinds of abuse
15682 that subvert web
15683 clients
15684 into making connections to SMTP ports; in these circumstances, a number of
15685 non-SMTP command lines are sent first.
15686
15687
15688
15689 .option smtp_ratelimit_hosts main "host list&!!" unset
15690 .cindex "SMTP" "rate limiting"
15691 .cindex "limit" "rate of message arrival"
15692 .cindex "RCPT" "rate limiting"
15693 Some sites find it helpful to be able to limit the rate at which certain hosts
15694 can send them messages, and the rate at which an individual message can specify
15695 recipients.
15696
15697 Exim has two rate-limiting facilities. This section describes the older
15698 facility, which can limit rates within a single connection. The newer
15699 &%ratelimit%& ACL condition can limit rates across all connections. See section
15700 &<<SECTratelimiting>>& for details of the newer facility.
15701
15702 When a host matches &%smtp_ratelimit_hosts%&, the values of
15703 &%smtp_ratelimit_mail%& and &%smtp_ratelimit_rcpt%& are used to control the
15704 rate of acceptance of MAIL and RCPT commands in a single SMTP session,
15705 respectively. Each option, if set, must contain a set of four comma-separated
15706 values:
15707
15708 .ilist
15709 A threshold, before which there is no rate limiting.
15710 .next
15711 An initial time delay. Unlike other times in Exim, numbers with decimal
15712 fractional parts are allowed here.
15713 .next
15714 A factor by which to increase the delay each time.
15715 .next
15716 A maximum value for the delay. This should normally be less than 5 minutes,
15717 because after that time, the client is liable to timeout the SMTP command.
15718 .endlist
15719
15720 For example, these settings have been used successfully at the site which
15721 first suggested this feature, for controlling mail from their customers:
15722 .code
15723 smtp_ratelimit_mail = 2,0.5s,1.05,4m
15724 smtp_ratelimit_rcpt = 4,0.25s,1.015,4m
15725 .endd
15726 The first setting specifies delays that are applied to MAIL commands after
15727 two have been received over a single connection. The initial delay is 0.5
15728 seconds, increasing by a factor of 1.05 each time. The second setting applies
15729 delays to RCPT commands when more than four occur in a single message.
15730
15731
15732 .option smtp_ratelimit_mail main string unset
15733 See &%smtp_ratelimit_hosts%& above.
15734
15735
15736 .option smtp_ratelimit_rcpt main string unset
15737 See &%smtp_ratelimit_hosts%& above.
15738
15739
15740 .option smtp_receive_timeout main time 5m
15741 .cindex "timeout" "for SMTP input"
15742 .cindex "SMTP" "input timeout"
15743 This sets a timeout value for SMTP reception. It applies to all forms of SMTP
15744 input, including batch SMTP. If a line of input (either an SMTP command or a
15745 data line) is not received within this time, the SMTP connection is dropped and
15746 the message is abandoned.
15747 A line is written to the log containing one of the following messages:
15748 .code
15749 SMTP command timeout on connection from...
15750 SMTP data timeout on connection from...
15751 .endd
15752 The former means that Exim was expecting to read an SMTP command; the latter
15753 means that it was in the DATA phase, reading the contents of a message.
15754
15755
15756 .oindex "&%-os%&"
15757 The value set by this option can be overridden by the
15758 &%-os%& command-line option. A setting of zero time disables the timeout, but
15759 this should never be used for SMTP over TCP/IP. (It can be useful in some cases
15760 of local input using &%-bs%& or &%-bS%&.) For non-SMTP input, the reception
15761 timeout is controlled by &%receive_timeout%& and &%-or%&.
15762
15763
15764 .option smtp_reserve_hosts main "host list&!!" unset
15765 This option defines hosts for which SMTP connections are reserved; see
15766 &%smtp_accept_reserve%& and &%smtp_load_reserve%& above.
15767
15768
15769 .option smtp_return_error_details main boolean false
15770 .cindex "SMTP" "details policy failures"
15771 .cindex "policy control" "rejection, returning details"
15772 In the default state, Exim uses bland messages such as
15773 &"Administrative prohibition"& when it rejects SMTP commands for policy
15774 reasons. Many sysadmins like this because it gives away little information
15775 to spammers. However, some other sysadmins who are applying strict checking
15776 policies want to give out much fuller information about failures. Setting
15777 &%smtp_return_error_details%& true causes Exim to be more forthcoming. For
15778 example, instead of &"Administrative prohibition"&, it might give:
15779 .code
15780 550-Rejected after DATA: '>' missing at end of address:
15781 550 failing address in "From" header is: <user@dom.ain
15782 .endd
15783
15784 .option spamd_address main string "see below"
15785 This option is available when Exim is compiled with the content-scanning
15786 extension. It specifies how Exim connects to SpamAssassin's &%spamd%& daemon.
15787 The default value is
15788 .code
15789 127.0.0.1 783
15790 .endd
15791 See section &<<SECTscanspamass>>& for more details.
15792
15793
15794
15795 .option split_spool_directory main boolean false
15796 .cindex "multiple spool directories"
15797 .cindex "spool directory" "split"
15798 .cindex "directories, multiple"
15799 If this option is set, it causes Exim to split its input directory into 62
15800 subdirectories, each with a single alphanumeric character as its name. The
15801 sixth character of the message id is used to allocate messages to
15802 subdirectories; this is the least significant base-62 digit of the time of
15803 arrival of the message.
15804
15805 Splitting up the spool in this way may provide better performance on systems
15806 where there are long mail queues, by reducing the number of files in any one
15807 directory. The msglog directory is also split up in a similar way to the input
15808 directory; however, if &%preserve_message_logs%& is set, all old msglog files
15809 are still placed in the single directory &_msglog.OLD_&.
15810
15811 It is not necessary to take any special action for existing messages when
15812 changing &%split_spool_directory%&. Exim notices messages that are in the
15813 &"wrong"& place, and continues to process them. If the option is turned off
15814 after a period of being on, the subdirectories will eventually empty and be
15815 automatically deleted.
15816
15817 When &%split_spool_directory%& is set, the behaviour of queue runner processes
15818 changes. Instead of creating a list of all messages in the queue, and then
15819 trying to deliver each one in turn, it constructs a list of those in one
15820 sub-directory and tries to deliver them, before moving on to the next
15821 sub-directory. The sub-directories are processed in a random order. This
15822 spreads out the scanning of the input directories, and uses less memory. It is
15823 particularly beneficial when there are lots of messages on the queue. However,
15824 if &%queue_run_in_order%& is set, none of this new processing happens. The
15825 entire queue has to be scanned and sorted before any deliveries can start.
15826
15827
15828 .option spool_directory main string&!! "set at compile time"
15829 .cindex "spool directory" "path to"
15830 This defines the directory in which Exim keeps its spool, that is, the messages
15831 it is waiting to deliver. The default value is taken from the compile-time
15832 configuration setting, if there is one. If not, this option must be set. The
15833 string is expanded, so it can contain, for example, a reference to
15834 &$primary_hostname$&.
15835
15836 If the spool directory name is fixed on your installation, it is recommended
15837 that you set it at build time rather than from this option, particularly if the
15838 log files are being written to the spool directory (see &%log_file_path%&).
15839 Otherwise log files cannot be used for errors that are detected early on, such
15840 as failures in the configuration file.
15841
15842 By using this option to override the compiled-in path, it is possible to run
15843 tests of Exim without using the standard spool.
15844
15845 .option sqlite_lock_timeout main time 5s
15846 .cindex "sqlite lookup type" "lock timeout"
15847 This option controls the timeout that the &(sqlite)& lookup uses when trying to
15848 access an SQLite database. See section &<<SECTsqlite>>& for more details.
15849
15850 .option strict_acl_vars main boolean false
15851 .cindex "&ACL;" "variables, handling unset"
15852 This option controls what happens if a syntactically valid but undefined ACL
15853 variable is referenced. If it is false (the default), an empty string
15854 is substituted; if it is true, an error is generated. See section
15855 &<<SECTaclvariables>>& for details of ACL variables.
15856
15857 .option strip_excess_angle_brackets main boolean false
15858 .cindex "angle brackets, excess"
15859 If this option is set, redundant pairs of angle brackets round &"route-addr"&
15860 items in addresses are stripped. For example, &'<<xxx@a.b.c.d>>'& is
15861 treated as &'<xxx@a.b.c.d>'&. If this is in the envelope and the message is
15862 passed on to another MTA, the excess angle brackets are not passed on. If this
15863 option is not set, multiple pairs of angle brackets cause a syntax error.
15864
15865
15866 .option strip_trailing_dot main boolean false
15867 .cindex "trailing dot on domain"
15868 .cindex "dot" "trailing on domain"
15869 If this option is set, a trailing dot at the end of a domain in an address is
15870 ignored. If this is in the envelope and the message is passed on to another
15871 MTA, the dot is not passed on. If this option is not set, a dot at the end of a
15872 domain causes a syntax error.
15873 However, addresses in header lines are checked only when an ACL requests header
15874 syntax checking.
15875
15876
15877 .option syslog_duplication main boolean true
15878 .cindex "syslog" "duplicate log lines; suppressing"
15879 When Exim is logging to syslog, it writes the log lines for its three
15880 separate logs at different syslog priorities so that they can in principle
15881 be separated on the logging hosts. Some installations do not require this
15882 separation, and in those cases, the duplication of certain log lines is a
15883 nuisance. If &%syslog_duplication%& is set false, only one copy of any
15884 particular log line is written to syslog. For lines that normally go to
15885 both the main log and the reject log, the reject log version (possibly
15886 containing message header lines) is written, at LOG_NOTICE priority.
15887 Lines that normally go to both the main and the panic log are written at
15888 the LOG_ALERT priority.
15889
15890
15891 .option syslog_facility main string unset
15892 .cindex "syslog" "facility; setting"
15893 This option sets the syslog &"facility"& name, used when Exim is logging to
15894 syslog. The value must be one of the strings &"mail"&, &"user"&, &"news"&,
15895 &"uucp"&, &"daemon"&, or &"local&'x'&"& where &'x'& is a digit between 0 and 7.
15896 If this option is unset, &"mail"& is used. See chapter &<<CHAPlog>>& for
15897 details of Exim's logging.
15898
15899
15900
15901 .option syslog_processname main string &`exim`&
15902 .cindex "syslog" "process name; setting"
15903 This option sets the syslog &"ident"& name, used when Exim is logging to
15904 syslog. The value must be no longer than 32 characters. See chapter
15905 &<<CHAPlog>>& for details of Exim's logging.
15906
15907
15908
15909 .option syslog_timestamp main boolean true
15910 .cindex "syslog" "timestamps"
15911 If &%syslog_timestamp%& is set false, the timestamps on Exim's log lines are
15912 omitted when these lines are sent to syslog. See chapter &<<CHAPlog>>& for
15913 details of Exim's logging.
15914
15915
15916 .option system_filter main string&!! unset
15917 .cindex "filter" "system filter"
15918 .cindex "system filter" "specifying"
15919 .cindex "Sieve filter" "not available for system filter"
15920 This option specifies an Exim filter file that is applied to all messages at
15921 the start of each delivery attempt, before any routing is done. System filters
15922 must be Exim filters; they cannot be Sieve filters. If the system filter
15923 generates any deliveries to files or pipes, or any new mail messages, the
15924 appropriate &%system_filter_..._transport%& option(s) must be set, to define
15925 which transports are to be used. Details of this facility are given in chapter
15926 &<<CHAPsystemfilter>>&.
15927
15928
15929 .option system_filter_directory_transport main string&!! unset
15930 .vindex "&$address_file$&"
15931 This sets the name of the transport driver that is to be used when the
15932 &%save%& command in a system message filter specifies a path ending in &"/"&,
15933 implying delivery of each message into a separate file in some directory.
15934 During the delivery, the variable &$address_file$& contains the path name.
15935
15936
15937 .option system_filter_file_transport main string&!! unset
15938 .cindex "file" "transport for system filter"
15939 This sets the name of the transport driver that is to be used when the &%save%&
15940 command in a system message filter specifies a path not ending in &"/"&. During
15941 the delivery, the variable &$address_file$& contains the path name.
15942
15943 .option system_filter_group main string unset
15944 .cindex "gid (group id)" "system filter"
15945 This option is used only when &%system_filter_user%& is also set. It sets the
15946 gid under which the system filter is run, overriding any gid that is associated
15947 with the user. The value may be numerical or symbolic.
15948
15949 .option system_filter_pipe_transport main string&!! unset
15950 .cindex "&(pipe)& transport" "for system filter"
15951 .vindex "&$address_pipe$&"
15952 This specifies the transport driver that is to be used when a &%pipe%& command
15953 is used in a system filter. During the delivery, the variable &$address_pipe$&
15954 contains the pipe command.
15955
15956
15957 .option system_filter_reply_transport main string&!! unset
15958 .cindex "&(autoreply)& transport" "for system filter"
15959 This specifies the transport driver that is to be used when a &%mail%& command
15960 is used in a system filter.
15961
15962
15963 .option system_filter_user main string unset
15964 .cindex "uid (user id)" "system filter"
15965 If this option is set to root, the system filter is run in the main Exim
15966 delivery process, as root.  Otherwise, the system filter runs in a separate
15967 process, as the given user, defaulting to the Exim run-time user.
15968 Unless the string consists entirely of digits, it
15969 is looked up in the password data. Failure to find the named user causes a
15970 configuration error. The gid is either taken from the password data, or
15971 specified by &%system_filter_group%&. When the uid is specified numerically,
15972 &%system_filter_group%& is required to be set.
15973
15974 If the system filter generates any pipe, file, or reply deliveries, the uid
15975 under which the filter is run is used when transporting them, unless a
15976 transport option overrides.
15977
15978
15979 .option tcp_nodelay main boolean true
15980 .cindex "daemon" "TCP_NODELAY on sockets"
15981 .cindex "Nagle algorithm"
15982 .cindex "TCP_NODELAY on listening sockets"
15983 If this option is set false, it stops the Exim daemon setting the
15984 TCP_NODELAY option on its listening sockets. Setting TCP_NODELAY
15985 turns off the &"Nagle algorithm"&, which is a way of improving network
15986 performance in interactive (character-by-character) situations. Turning it off
15987 should improve Exim's performance a bit, so that is what happens by default.
15988 However, it appears that some broken clients cannot cope, and time out. Hence
15989 this option. It affects only those sockets that are set up for listening by the
15990 daemon. Sockets created by the smtp transport for delivering mail always set
15991 TCP_NODELAY.
15992
15993
15994 .option timeout_frozen_after main time 0s
15995 .cindex "frozen messages" "timing out"
15996 .cindex "timeout" "frozen messages"
15997 If &%timeout_frozen_after%& is set to a time greater than zero, a frozen
15998 message of any kind that has been on the queue for longer than the given time
15999 is automatically cancelled at the next queue run. If the frozen message is a
16000 bounce message, it is just discarded; otherwise, a bounce is sent to the
16001 sender, in a similar manner to cancellation by the &%-Mg%& command line option.
16002 If you want to timeout frozen bounce messages earlier than other kinds of
16003 frozen message, see &%ignore_bounce_errors_after%&.
16004
16005 &*Note:*& the default value of zero means no timeouts; with this setting,
16006 frozen messages remain on the queue forever (except for any frozen bounce
16007 messages that are released by &%ignore_bounce_errors_after%&).
16008
16009
16010 .option timezone main string unset
16011 .cindex "timezone, setting"
16012 The value of &%timezone%& is used to set the environment variable TZ while
16013 running Exim (if it is different on entry). This ensures that all timestamps
16014 created by Exim are in the required timezone. If you want all your timestamps
16015 to be in UTC (aka GMT) you should set
16016 .code
16017 timezone = UTC
16018 .endd
16019 The default value is taken from TIMEZONE_DEFAULT in &_Local/Makefile_&,
16020 or, if that is not set, from the value of the TZ environment variable when Exim
16021 is built. If &%timezone%& is set to the empty string, either at build or run
16022 time, any existing TZ variable is removed from the environment when Exim
16023 runs. This is appropriate behaviour for obtaining wall-clock time on some, but
16024 unfortunately not all, operating systems.
16025
16026
16027 .option tls_advertise_hosts main "host list&!!" unset
16028 .cindex "TLS" "advertising"
16029 .cindex "encryption" "on SMTP connection"
16030 .cindex "SMTP" "encrypted connection"
16031 When Exim is built with support for TLS encrypted connections, the availability
16032 of the STARTTLS command to set up an encrypted session is advertised in
16033 response to EHLO only to those client hosts that match this option. See
16034 chapter &<<CHAPTLS>>& for details of Exim's support for TLS.
16035
16036
16037 .option tls_certificate main string&!! unset
16038 .cindex "TLS" "server certificate; location of"
16039 .cindex "certificate" "server, location of"
16040 The value of this option is expanded, and must then be the absolute path to a
16041 file which contains the server's certificates. The server's private key is also
16042 assumed to be in this file if &%tls_privatekey%& is unset. See chapter
16043 &<<CHAPTLS>>& for further details.
16044
16045 &*Note*&: The certificates defined by this option are used only when Exim is
16046 receiving incoming messages as a server. If you want to supply certificates for
16047 use when sending messages as a client, you must set the &%tls_certificate%&
16048 option in the relevant &(smtp)& transport.
16049
16050 If the option contains &$tls_out_sni$& and Exim is built against OpenSSL, then
16051 if the OpenSSL build supports TLS extensions and the TLS client sends the
16052 Server Name Indication extension, then this option and others documented in
16053 &<<SECTtlssni>>& will be re-expanded.
16054
16055 .option tls_crl main string&!! unset
16056 .cindex "TLS" "server certificate revocation list"
16057 .cindex "certificate" "revocation list for server"
16058 This option specifies a certificate revocation list. The expanded value must
16059 be the name of a file that contains a CRL in PEM format.
16060
16061 See &<<SECTtlssni>>& for discussion of when this option might be re-expanded.
16062
16063
16064 .option tls_dh_max_bits main integer 2236
16065 .cindex "TLS" "D-H bit count"
16066 The number of bits used for Diffie-Hellman key-exchange may be suggested by
16067 the chosen TLS library.  That value might prove to be too high for
16068 interoperability.  This option provides a maximum clamp on the value
16069 suggested, trading off security for interoperability.
16070
16071 The value must be at least 1024.
16072
16073 The value 2236 was chosen because, at time of adding the option, it was the
16074 hard-coded maximum value supported by the NSS cryptographic library, as used
16075 by Thunderbird, while GnuTLS was suggesting 2432 bits as normal.
16076
16077 If you prefer more security and are willing to break some clients, raise this
16078 number.
16079
16080 Note that the value passed to GnuTLS for *generating* a new prime may be a
16081 little less than this figure, because GnuTLS is inexact and may produce a
16082 larger prime than requested.
16083
16084
16085 .option tls_dhparam main string&!! unset
16086 .cindex "TLS" "D-H parameters for server"
16087 The value of this option is expanded and indicates the source of DH parameters
16088 to be used by Exim.
16089
16090 If it is a filename starting with a &`/`&, then it names a file from which DH
16091 parameters should be loaded.  If the file exists, it should hold a PEM-encoded
16092 PKCS#3 representation of the DH prime.  If the file does not exist, for
16093 OpenSSL it is an error.  For GnuTLS, Exim will attempt to create the file and
16094 fill it with a generated DH prime.  For OpenSSL, if the DH bit-count from
16095 loading the file is greater than &%tls_dh_max_bits%& then it will be ignored,
16096 and treated as though the &%tls_dhparam%& were set to "none".
16097
16098 If this option expands to the string "none", then no DH parameters will be
16099 loaded by Exim.
16100
16101 If this option expands to the string "historic" and Exim is using GnuTLS, then
16102 Exim will attempt to load a file from inside the spool directory.  If the file
16103 does not exist, Exim will attempt to create it.
16104 See section &<<SECTgnutlsparam>>& for further details.
16105
16106 If Exim is using OpenSSL and this option is empty or unset, then Exim will load
16107 a default DH prime; the default is the 2048 bit prime described in section
16108 2.2 of RFC 5114, "2048-bit MODP Group with 224-bit Prime Order Subgroup", which
16109 in IKE is assigned number 23.
16110
16111 Otherwise, the option must expand to the name used by Exim for any of a number
16112 of DH primes specified in RFC 2409, RFC 3526 and RFC 5114.  As names, Exim uses
16113 "ike" followed by the number used by IKE, of "default" which corresponds to
16114 "ike23".
16115
16116 The available primes are:
16117 &`ike1`&, &`ike2`&, &`ike5`&,
16118 &`ike14`&, &`ike15`&, &`ike16`&, &`ike17`&, &`ike18`&,
16119 &`ike22`&, &`ike23`& (aka &`default`&) and &`ike24`&.
16120
16121 Some of these will be too small to be accepted by clients.
16122 Some may be too large to be accepted by clients.
16123
16124 The TLS protocol does not negotiate an acceptable size for this; clients tend
16125 to hard-drop connections if what is offered by the server is unacceptable,
16126 whether too large or too small, and there's no provision for the client to
16127 tell the server what these constraints are.  Thus, as a server operator, you
16128 need to make an educated guess as to what is most likely to work for your
16129 userbase.
16130
16131 Some known size constraints suggest that a bit-size in the range 2048 to 2236
16132 is most likely to maximise interoperability.  The upper bound comes from
16133 applications using the Mozilla Network Security Services (NSS) library, which
16134 used to set its &`DH_MAX_P_BITS`& upper-bound to 2236.  This affects many
16135 mail user agents (MUAs). The lower bound comes from Debian installs of Exim4
16136 prior to the 4.80 release, as Debian used to patch Exim to raise the minimum
16137 acceptable bound from 1024 to 2048.
16138
16139
16140 .option tls_on_connect_ports main "string list" unset
16141 This option specifies a list of incoming SSMTP (aka SMTPS) ports that should
16142 operate the obsolete SSMTP (SMTPS) protocol, where a TLS session is immediately
16143 set up without waiting for the client to issue a STARTTLS command. For
16144 further details, see section &<<SECTsupobssmt>>&.
16145
16146
16147
16148 .option tls_privatekey main string&!! unset
16149 .cindex "TLS" "server private key; location of"
16150 The value of this option is expanded, and must then be the absolute path to a
16151 file which contains the server's private key. If this option is unset, or if
16152 the expansion is forced to fail, or the result is an empty string, the private
16153 key is assumed to be in the same file as the server's certificates. See chapter
16154 &<<CHAPTLS>>& for further details.
16155
16156 See &<<SECTtlssni>>& for discussion of when this option might be re-expanded.
16157
16158
16159 .option tls_remember_esmtp main boolean false
16160 .cindex "TLS" "esmtp state; remembering"
16161 .cindex "TLS" "broken clients"
16162 If this option is set true, Exim violates the RFCs by remembering that it is in
16163 &"esmtp"& state after successfully negotiating a TLS session. This provides
16164 support for broken clients that fail to send a new EHLO after starting a
16165 TLS session.
16166
16167
16168 .option tls_require_ciphers main string&!! unset
16169 .cindex "TLS" "requiring specific ciphers"
16170 .cindex "cipher" "requiring specific"
16171 This option controls which ciphers can be used for incoming TLS connections.
16172 The &(smtp)& transport has an option of the same name for controlling outgoing
16173 connections. This option is expanded for each connection, so can be varied for
16174 different clients if required. The value of this option must be a list of
16175 permitted cipher suites. The OpenSSL and GnuTLS libraries handle cipher control
16176 in somewhat different ways. If GnuTLS is being used, the client controls the
16177 preference order of the available ciphers. Details are given in sections
16178 &<<SECTreqciphssl>>& and &<<SECTreqciphgnu>>&.
16179
16180
16181 .option tls_try_verify_hosts main "host list&!!" unset
16182 .cindex "TLS" "client certificate verification"
16183 .cindex "certificate" "verification of client"
16184 See &%tls_verify_hosts%& below.
16185
16186
16187 .option tls_verify_certificates main string&!! unset
16188 .cindex "TLS" "client certificate verification"
16189 .cindex "certificate" "verification of client"
16190 The value of this option is expanded, and must then be the absolute path to
16191 a file containing permitted certificates for clients that
16192 match &%tls_verify_hosts%& or &%tls_try_verify_hosts%&. Alternatively, if you
16193 are using OpenSSL, you can set &%tls_verify_certificates%& to the name of a
16194 directory containing certificate files. This does not work with GnuTLS; the
16195 option must be set to the name of a single file if you are using GnuTLS.
16196
16197 These certificates should be for the certificate authorities trusted, rather
16198 than the public cert of individual clients.  With both OpenSSL and GnuTLS, if
16199 the value is a file then the certificates are sent by Exim as a server to
16200 connecting clients, defining the list of accepted certificate authorities.
16201 Thus the values defined should be considered public data.  To avoid this,
16202 use OpenSSL with a directory.
16203
16204 See &<<SECTtlssni>>& for discussion of when this option might be re-expanded.
16205
16206 A forced expansion failure or setting to an empty string is equivalent to
16207 being unset.
16208
16209
16210 .option tls_verify_hosts main "host list&!!" unset
16211 .cindex "TLS" "client certificate verification"
16212 .cindex "certificate" "verification of client"
16213 This option, along with &%tls_try_verify_hosts%&, controls the checking of
16214 certificates from clients. The expected certificates are defined by
16215 &%tls_verify_certificates%&, which must be set. A configuration error occurs if
16216 either &%tls_verify_hosts%& or &%tls_try_verify_hosts%& is set and
16217 &%tls_verify_certificates%& is not set.
16218
16219 Any client that matches &%tls_verify_hosts%& is constrained by
16220 &%tls_verify_certificates%&. When the client initiates a TLS session, it must
16221 present one of the listed certificates. If it does not, the connection is
16222 aborted. &*Warning*&: Including a host in &%tls_verify_hosts%& does not require
16223 the host to use TLS. It can still send SMTP commands through unencrypted
16224 connections. Forcing a client to use TLS has to be done separately using an
16225 ACL to reject inappropriate commands when the connection is not encrypted.
16226
16227 A weaker form of checking is provided by &%tls_try_verify_hosts%&. If a client
16228 matches this option (but not &%tls_verify_hosts%&), Exim requests a
16229 certificate and checks it against &%tls_verify_certificates%&, but does not
16230 abort the connection if there is no certificate or if it does not match. This
16231 state can be detected in an ACL, which makes it possible to implement policies
16232 such as &"accept for relay only if a verified certificate has been received,
16233 but accept for local delivery if encrypted, even without a verified
16234 certificate"&.
16235
16236 Client hosts that match neither of these lists are not asked to present
16237 certificates.
16238
16239
16240 .option trusted_groups main "string list&!!" unset
16241 .cindex "trusted groups"
16242 .cindex "groups" "trusted"
16243 This option is expanded just once, at the start of Exim's processing. If this
16244 option is set, any process that is running in one of the listed groups, or
16245 which has one of them as a supplementary group, is trusted. The groups can be
16246 specified numerically or by name. See section &<<SECTtrustedadmin>>& for
16247 details of what trusted callers are permitted to do. If neither
16248 &%trusted_groups%& nor &%trusted_users%& is set, only root and the Exim user
16249 are trusted.
16250
16251 .option trusted_users main "string list&!!" unset
16252 .cindex "trusted users"
16253 .cindex "user" "trusted"
16254 This option is expanded just once, at the start of Exim's processing. If this
16255 option is set, any process that is running as one of the listed users is
16256 trusted. The users can be specified numerically or by name. See section
16257 &<<SECTtrustedadmin>>& for details of what trusted callers are permitted to do.
16258 If neither &%trusted_groups%& nor &%trusted_users%& is set, only root and the
16259 Exim user are trusted.
16260
16261 .option unknown_login main string&!! unset
16262 .cindex "uid (user id)" "unknown caller"
16263 .vindex "&$caller_uid$&"
16264 This is a specialized feature for use in unusual configurations. By default, if
16265 the uid of the caller of Exim cannot be looked up using &[getpwuid()]&, Exim
16266 gives up. The &%unknown_login%& option can be used to set a login name to be
16267 used in this circumstance. It is expanded, so values like &%user$caller_uid%&
16268 can be set. When &%unknown_login%& is used, the value of &%unknown_username%&
16269 is used for the user's real name (gecos field), unless this has been set by the
16270 &%-F%& option.
16271
16272 .option unknown_username main string unset
16273 See &%unknown_login%&.
16274
16275 .option untrusted_set_sender main "address list&!!" unset
16276 .cindex "trusted users"
16277 .cindex "sender" "setting by untrusted user"
16278 .cindex "untrusted user setting sender"
16279 .cindex "user" "untrusted setting sender"
16280 .cindex "envelope sender"
16281 When an untrusted user submits a message to Exim using the standard input, Exim
16282 normally creates an envelope sender address from the user's login and the
16283 default qualification domain. Data from the &%-f%& option (for setting envelope
16284 senders on non-SMTP messages) or the SMTP MAIL command (if &%-bs%& or &%-bS%&
16285 is used) is ignored.
16286
16287 However, untrusted users are permitted to set an empty envelope sender address,
16288 to declare that a message should never generate any bounces. For example:
16289 .code
16290 exim -f '<>' user@domain.example
16291 .endd
16292 .vindex "&$sender_ident$&"
16293 The &%untrusted_set_sender%& option allows you to permit untrusted users to set
16294 other envelope sender addresses in a controlled way. When it is set, untrusted
16295 users are allowed to set envelope sender addresses that match any of the
16296 patterns in the list. Like all address lists, the string is expanded. The
16297 identity of the user is in &$sender_ident$&, so you can, for example, restrict
16298 users to setting senders that start with their login ids
16299 followed by a hyphen
16300 by a setting like this:
16301 .code
16302 untrusted_set_sender = ^$sender_ident-
16303 .endd
16304 If you want to allow untrusted users to set envelope sender addresses without
16305 restriction, you can use
16306 .code
16307 untrusted_set_sender = *
16308 .endd
16309 The &%untrusted_set_sender%& option applies to all forms of local input, but
16310 only to the setting of the envelope sender. It does not permit untrusted users
16311 to use the other options which trusted user can use to override message
16312 parameters. Furthermore, it does not stop Exim from removing an existing
16313 &'Sender:'& header in the message, or from adding a &'Sender:'& header if
16314 necessary. See &%local_sender_retain%& and &%local_from_check%& for ways of
16315 overriding these actions. The handling of the &'Sender:'& header is also
16316 described in section &<<SECTthesenhea>>&.
16317
16318 The log line for a message's arrival shows the envelope sender following
16319 &"<="&. For local messages, the user's login always follows, after &"U="&. In
16320 &%-bp%& displays, and in the Exim monitor, if an untrusted user sets an
16321 envelope sender address, the user's login is shown in parentheses after the
16322 sender address.
16323
16324
16325 .option uucp_from_pattern main string "see below"
16326 .cindex "&""From""& line"
16327 .cindex "UUCP" "&""From""& line"
16328 Some applications that pass messages to an MTA via a command line interface use
16329 an initial line starting with &"From&~"& to pass the envelope sender. In
16330 particular, this is used by UUCP software. Exim recognizes such a line by means
16331 of a regular expression that is set in &%uucp_from_pattern%&. When the pattern
16332 matches, the sender address is constructed by expanding the contents of
16333 &%uucp_from_sender%&, provided that the caller of Exim is a trusted user. The
16334 default pattern recognizes lines in the following two forms:
16335 .code
16336 From ph10 Fri Jan  5 12:35 GMT 1996
16337 From ph10 Fri, 7 Jan 97 14:00:00 GMT
16338 .endd
16339 The pattern can be seen by running
16340 .code
16341 exim -bP uucp_from_pattern
16342 .endd
16343 It checks only up to the hours and minutes, and allows for a 2-digit or 4-digit
16344 year in the second case. The first word after &"From&~"& is matched in the
16345 regular expression by a parenthesized subpattern. The default value for
16346 &%uucp_from_sender%& is &"$1"&, which therefore just uses this first word
16347 (&"ph10"& in the example above) as the message's sender. See also
16348 &%ignore_fromline_hosts%&.
16349
16350
16351 .option uucp_from_sender main string&!! &`$1`&
16352 See &%uucp_from_pattern%& above.
16353
16354
16355 .option warn_message_file main string unset
16356 .cindex "warning of delay" "customizing the message"
16357 .cindex "customizing" "warning message"
16358 This option defines a template file containing paragraphs of text to be used
16359 for constructing the warning message which is sent by Exim when a message has
16360 been on the queue for a specified amount of time, as specified by
16361 &%delay_warning%&. Details of the file's contents are given in chapter
16362 &<<CHAPemsgcust>>&. See also &%bounce_message_file%&.
16363
16364
16365 .option write_rejectlog main boolean true
16366 .cindex "reject log" "disabling"
16367 If this option is set false, Exim no longer writes anything to the reject log.
16368 See chapter &<<CHAPlog>>& for details of what Exim writes to its logs.
16369 .ecindex IIDconfima
16370 .ecindex IIDmaiconf
16371
16372
16373
16374
16375 . ////////////////////////////////////////////////////////////////////////////
16376 . ////////////////////////////////////////////////////////////////////////////
16377
16378 .chapter "Generic options for routers" "CHAProutergeneric"
16379 .scindex IIDgenoprou1 "options" "generic; for routers"
16380 .scindex IIDgenoprou2 "generic options" "router"
16381 This chapter describes the generic options that apply to all routers.
16382 Those that are preconditions are marked with &Dagger; in the &"use"& field.
16383
16384 For a general description of how a router operates, see sections
16385 &<<SECTrunindrou>>& and &<<SECTrouprecon>>&. The latter specifies the order in
16386 which the preconditions are tested. The order of expansion of the options that
16387 provide data for a transport is: &%errors_to%&, &%headers_add%&,
16388 &%headers_remove%&, &%transport%&.
16389
16390
16391
16392 .option address_data routers string&!! unset
16393 .cindex "router" "data attached to address"
16394 The string is expanded just before the router is run, that is, after all the
16395 precondition tests have succeeded. If the expansion is forced to fail, the
16396 router declines, the value of &%address_data%& remains unchanged, and the
16397 &%more%& option controls what happens next. Other expansion failures cause
16398 delivery of the address to be deferred.
16399
16400 .vindex "&$address_data$&"
16401 When the expansion succeeds, the value is retained with the address, and can be
16402 accessed using the variable &$address_data$& in the current router, subsequent
16403 routers, and the eventual transport.
16404
16405 &*Warning*&: If the current or any subsequent router is a &(redirect)& router
16406 that runs a user's filter file, the contents of &$address_data$& are accessible
16407 in the filter. This is not normally a problem, because such data is usually
16408 either not confidential or it &"belongs"& to the current user, but if you do
16409 put confidential data into &$address_data$& you need to remember this point.
16410
16411 Even if the router declines or passes, the value of &$address_data$& remains
16412 with the address, though it can be changed by another &%address_data%& setting
16413 on a subsequent router. If a router generates child addresses, the value of
16414 &$address_data$& propagates to them. This also applies to the special kind of
16415 &"child"& that is generated by a router with the &%unseen%& option.
16416
16417 The idea of &%address_data%& is that you can use it to look up a lot of data
16418 for the address once, and then pick out parts of the data later. For example,
16419 you could use a single LDAP lookup to return a string of the form
16420 .code
16421 uid=1234 gid=5678 mailbox=/mail/xyz forward=/home/xyz/.forward
16422 .endd
16423 In the transport you could pick out the mailbox by a setting such as
16424 .code
16425 file = ${extract{mailbox}{$address_data}}
16426 .endd
16427 This makes the configuration file less messy, and also reduces the number of
16428 lookups (though Exim does cache lookups).
16429
16430 .vindex "&$sender_address_data$&"
16431 .vindex "&$address_data$&"
16432 The &%address_data%& facility is also useful as a means of passing information
16433 from one router to another, and from a router to a transport. In addition, if
16434 &$address_data$& is set by a router when verifying a recipient address from an
16435 ACL, it remains available for use in the rest of the ACL statement. After
16436 verifying a sender, the value is transferred to &$sender_address_data$&.
16437
16438
16439
16440 .option address_test routers&!? boolean true
16441 .oindex "&%-bt%&"
16442 .cindex "router" "skipping when address testing"
16443 If this option is set false, the router is skipped when routing is being tested
16444 by means of the &%-bt%& command line option. This can be a convenience when
16445 your first router sends messages to an external scanner, because it saves you
16446 having to set the &"already scanned"& indicator when testing real address
16447 routing.
16448
16449
16450
16451 .option cannot_route_message routers string&!! unset
16452 .cindex "router" "customizing &""cannot route""& message"
16453 .cindex "customizing" "&""cannot route""& message"
16454 This option specifies a text message that is used when an address cannot be
16455 routed because Exim has run out of routers. The default message is
16456 &"Unrouteable address"&. This option is useful only on routers that have
16457 &%more%& set false, or on the very last router in a configuration, because the
16458 value that is used is taken from the last router that is considered. This
16459 includes a router that is skipped because its preconditions are not met, as
16460 well as a router that declines. For example, using the default configuration,
16461 you could put:
16462 .code
16463 cannot_route_message = Remote domain not found in DNS
16464 .endd
16465 on the first router, which is a &(dnslookup)& router with &%more%& set false,
16466 and
16467 .code
16468 cannot_route_message = Unknown local user
16469 .endd
16470 on the final router that checks for local users. If string expansion fails for
16471 this option, the default message is used. Unless the expansion failure was
16472 explicitly forced, a message about the failure is written to the main and panic
16473 logs, in addition to the normal message about the routing failure.
16474
16475
16476 .option caseful_local_part routers boolean false
16477 .cindex "case of local parts"
16478 .cindex "router" "case of local parts"
16479 By default, routers handle the local parts of addresses in a case-insensitive
16480 manner, though the actual case is preserved for transmission with the message.
16481 If you want the case of letters to be significant in a router, you must set
16482 this option true. For individual router options that contain address or local
16483 part lists (for example, &%local_parts%&), case-sensitive matching can be
16484 turned on by &"+caseful"& as a list item. See section &<<SECTcasletadd>>& for
16485 more details.
16486
16487 .vindex "&$local_part$&"
16488 .vindex "&$original_local_part$&"
16489 .vindex "&$parent_local_part$&"
16490 The value of the &$local_part$& variable is forced to lower case while a
16491 router is running unless &%caseful_local_part%& is set. When a router assigns
16492 an address to a transport, the value of &$local_part$& when the transport runs
16493 is the same as it was in the router. Similarly, when a router generates child
16494 addresses by aliasing or forwarding, the values of &$original_local_part$&
16495 and &$parent_local_part$& are those that were used by the redirecting router.
16496
16497 This option applies to the processing of an address by a router. When a
16498 recipient address is being processed in an ACL, there is a separate &%control%&
16499 modifier that can be used to specify case-sensitive processing within the ACL
16500 (see section &<<SECTcontrols>>&).
16501
16502
16503
16504 .option check_local_user routers&!? boolean false
16505 .cindex "local user, checking in router"
16506 .cindex "router" "checking for local user"
16507 .cindex "&_/etc/passwd_&"
16508 .vindex "&$home$&"
16509 When this option is true, Exim checks that the local part of the recipient
16510 address (with affixes removed if relevant) is the name of an account on the
16511 local system. The check is done by calling the &[getpwnam()]& function rather
16512 than trying to read &_/etc/passwd_& directly. This means that other methods of
16513 holding password data (such as NIS) are supported. If the local part is a local
16514 user, &$home$& is set from the password data, and can be tested in other
16515 preconditions that are evaluated after this one (the order of evaluation is
16516 given in section &<<SECTrouprecon>>&). However, the value of &$home$& can be
16517 overridden by &%router_home_directory%&. If the local part is not a local user,
16518 the router is skipped.
16519
16520 If you want to check that the local part is either the name of a local user
16521 or matches something else, you cannot combine &%check_local_user%& with a
16522 setting of &%local_parts%&, because that specifies the logical &'and'& of the
16523 two conditions. However, you can use a &(passwd)& lookup in a &%local_parts%&
16524 setting to achieve this. For example:
16525 .code
16526 local_parts = passwd;$local_part : lsearch;/etc/other/users
16527 .endd
16528 Note, however, that the side effects of &%check_local_user%& (such as setting
16529 up a home directory) do not occur when a &(passwd)& lookup is used in a
16530 &%local_parts%& (or any other) precondition.
16531
16532
16533
16534 .option condition routers&!? string&!! unset
16535 .cindex "router" "customized precondition"
16536 This option specifies a general precondition test that has to succeed for the
16537 router to be called. The &%condition%& option is the last precondition to be
16538 evaluated (see section &<<SECTrouprecon>>&). The string is expanded, and if the
16539 result is a forced failure, or an empty string, or one of the strings &"0"& or
16540 &"no"& or &"false"& (checked without regard to the case of the letters), the
16541 router is skipped, and the address is offered to the next one.
16542
16543 If the result is any other value, the router is run (as this is the last
16544 precondition to be evaluated, all the other preconditions must be true).
16545
16546 This option is unusual in that multiple &%condition%& options may be present.
16547 All &%condition%& options must succeed.
16548
16549 The &%condition%& option provides a means of applying custom conditions to the
16550 running of routers. Note that in the case of a simple conditional expansion,
16551 the default expansion values are exactly what is wanted. For example:
16552 .code
16553 condition = ${if >{$message_age}{600}}
16554 .endd
16555 Because of the default behaviour of the string expansion, this is equivalent to
16556 .code
16557 condition = ${if >{$message_age}{600}{true}{}}
16558 .endd
16559
16560 A multiple condition example, which succeeds:
16561 .code
16562 condition = ${if >{$message_age}{600}}
16563 condition = ${if !eq{${lc:$local_part}}{postmaster}}
16564 condition = foobar
16565 .endd
16566
16567 If the expansion fails (other than forced failure) delivery is deferred. Some
16568 of the other precondition options are common special cases that could in fact
16569 be specified using &%condition%&.
16570
16571
16572 .option debug_print routers string&!! unset
16573 .cindex "testing" "variables in drivers"
16574 If this option is set and debugging is enabled (see the &%-d%& command line
16575 option) or in address-testing mode (see the &%-bt%& command line option),
16576 the string is expanded and included in the debugging output.
16577 If expansion of the string fails, the error message is written to the debugging
16578 output, and Exim carries on processing.
16579 This option is provided to help with checking out the values of variables and
16580 so on when debugging router configurations. For example, if a &%condition%&
16581 option appears not to be working, &%debug_print%& can be used to output the
16582 variables it references. The output happens after checks for &%domains%&,
16583 &%local_parts%&, and &%check_local_user%& but before any other preconditions
16584 are tested. A newline is added to the text if it does not end with one.
16585 The variable &$router_name$& contains the name of the router.
16586
16587
16588
16589 .option disable_logging routers boolean false
16590 If this option is set true, nothing is logged for any routing errors
16591 or for any deliveries caused by this router. You should not set this option
16592 unless you really, really know what you are doing. See also the generic
16593 transport option of the same name.
16594
16595
16596 .option domains routers&!? "domain list&!!" unset
16597 .cindex "router" "restricting to specific domains"
16598 .vindex "&$domain_data$&"
16599 If this option is set, the router is skipped unless the current domain matches
16600 the list. If the match is achieved by means of a file lookup, the data that the
16601 lookup returned for the domain is placed in &$domain_data$& for use in string
16602 expansions of the driver's private options. See section &<<SECTrouprecon>>& for
16603 a list of the order in which preconditions are evaluated.
16604
16605
16606
16607 .option driver routers string unset
16608 This option must always be set. It specifies which of the available routers is
16609 to be used.
16610
16611
16612
16613 .option errors_to routers string&!! unset
16614 .cindex "envelope sender"
16615 .cindex "router" "changing address for errors"
16616 If a router successfully handles an address, it may assign the address to a
16617 transport for delivery or it may generate child addresses. In both cases, if
16618 there is a delivery problem during later processing, the resulting bounce
16619 message is sent to the address that results from expanding this string,
16620 provided that the address verifies successfully. The &%errors_to%& option is
16621 expanded before &%headers_add%&, &%headers_remove%&, and &%transport%&.
16622
16623 The &%errors_to%& setting associated with an address can be overridden if it
16624 subsequently passes through other routers that have their own &%errors_to%&
16625 settings, or if the message is delivered by a transport with a &%return_path%&
16626 setting.
16627
16628 If &%errors_to%& is unset, or the expansion is forced to fail, or the result of
16629 the expansion fails to verify, the errors address associated with the incoming
16630 address is used. At top level, this is the envelope sender. A non-forced
16631 expansion failure causes delivery to be deferred.
16632
16633 If an address for which &%errors_to%& has been set ends up being delivered over
16634 SMTP, the envelope sender for that delivery is the &%errors_to%& value, so that
16635 any bounces that are generated by other MTAs on the delivery route are also
16636 sent there. You can set &%errors_to%& to the empty string by either of these
16637 settings:
16638 .code
16639 errors_to =
16640 errors_to = ""
16641 .endd
16642 An expansion item that yields an empty string has the same effect. If you do
16643 this, a locally detected delivery error for addresses processed by this router
16644 no longer gives rise to a bounce message; the error is discarded. If the
16645 address is delivered to a remote host, the return path is set to &`<>`&, unless
16646 overridden by the &%return_path%& option on the transport.
16647
16648 .vindex "&$address_data$&"
16649 If for some reason you want to discard local errors, but use a non-empty
16650 MAIL command for remote delivery, you can preserve the original return
16651 path in &$address_data$& in the router, and reinstate it in the transport by
16652 setting &%return_path%&.
16653
16654 The most common use of &%errors_to%& is to direct mailing list bounces to the
16655 manager of the list, as described in section &<<SECTmailinglists>>&, or to
16656 implement VERP (Variable Envelope Return Paths) (see section &<<SECTverp>>&).
16657
16658
16659
16660 .option expn routers&!? boolean true
16661 .cindex "address" "testing"
16662 .cindex "testing" "addresses"
16663 .cindex "EXPN" "router skipping"
16664 .cindex "router" "skipping for EXPN"
16665 If this option is turned off, the router is skipped when testing an address
16666 as a result of processing an SMTP EXPN command. You might, for example,
16667 want to turn it off on a router for users' &_.forward_& files, while leaving it
16668 on for the system alias file.
16669 See section &<<SECTrouprecon>>& for a list of the order in which preconditions
16670 are evaluated.
16671
16672 The use of the SMTP EXPN command is controlled by an ACL (see chapter
16673 &<<CHAPACL>>&). When Exim is running an EXPN command, it is similar to testing
16674 an address with &%-bt%&. Compare VRFY, whose counterpart is &%-bv%&.
16675
16676
16677
16678 .option fail_verify routers boolean false
16679 .cindex "router" "forcing verification failure"
16680 Setting this option has the effect of setting both &%fail_verify_sender%& and
16681 &%fail_verify_recipient%& to the same value.
16682
16683
16684
16685 .option fail_verify_recipient routers boolean false
16686 If this option is true and an address is accepted by this router when
16687 verifying a recipient, verification fails.
16688
16689
16690
16691 .option fail_verify_sender routers boolean false
16692 If this option is true and an address is accepted by this router when
16693 verifying a sender, verification fails.
16694
16695
16696
16697 .option fallback_hosts routers "string list" unset
16698 .cindex "router" "fallback hosts"
16699 .cindex "fallback" "hosts specified on router"
16700 String expansion is not applied to this option. The argument must be a
16701 colon-separated list of host names or IP addresses. The list separator can be
16702 changed (see section &<<SECTlistconstruct>>&), and a port can be specified with
16703 each name or address. In fact, the format of each item is exactly the same as
16704 defined for the list of hosts in a &(manualroute)& router (see section
16705 &<<SECTformatonehostitem>>&).
16706
16707 If a router queues an address for a remote transport, this host list is
16708 associated with the address, and used instead of the transport's fallback host
16709 list. If &%hosts_randomize%& is set on the transport, the order of the list is
16710 randomized for each use. See the &%fallback_hosts%& option of the &(smtp)&
16711 transport for further details.
16712
16713
16714 .option group routers string&!! "see below"
16715 .cindex "gid (group id)" "local delivery"
16716 .cindex "local transports" "uid and gid"
16717 .cindex "transport" "local"
16718 .cindex "router" "setting group"
16719 When a router queues an address for a transport, and the transport does not
16720 specify a group, the group given here is used when running the delivery
16721 process.
16722 The group may be specified numerically or by name. If expansion fails, the
16723 error is logged and delivery is deferred.
16724 The default is unset, unless &%check_local_user%& is set, when the default
16725 is taken from the password information. See also &%initgroups%& and &%user%&
16726 and the discussion in chapter &<<CHAPenvironment>>&.
16727
16728
16729
16730 .option headers_add routers string&!! unset
16731 .cindex "header lines" "adding"
16732 .cindex "router" "adding header lines"
16733 This option specifies a string of text that is expanded at routing time, and
16734 associated with any addresses that are accepted by the router. However, this
16735 option has no effect when an address is just being verified. The way in which
16736 the text is used to add header lines at transport time is described in section
16737 &<<SECTheadersaddrem>>&. New header lines are not actually added until the
16738 message is in the process of being transported. This means that references to
16739 header lines in string expansions in the transport's configuration do not
16740 &"see"& the added header lines.
16741
16742 The &%headers_add%& option is expanded after &%errors_to%&, but before
16743 &%headers_remove%& and &%transport%&. If the expanded string is empty, or if
16744 the expansion is forced to fail, the option has no effect. Other expansion
16745 failures are treated as configuration errors.
16746
16747 Unlike most options, &%headers_add%& can be specified multiple times
16748 for a router; all listed headers are added.
16749
16750 &*Warning 1*&: The &%headers_add%& option cannot be used for a &(redirect)&
16751 router that has the &%one_time%& option set.
16752
16753 .cindex "duplicate addresses"
16754 .oindex "&%unseen%&"
16755 &*Warning 2*&: If the &%unseen%& option is set on the router, all header
16756 additions are deleted when the address is passed on to subsequent routers.
16757 For a &%redirect%& router, if a generated address is the same as the incoming
16758 address, this can lead to duplicate addresses with different header
16759 modifications. Exim does not do duplicate deliveries (except, in certain
16760 circumstances, to pipes -- see section &<<SECTdupaddr>>&), but it is undefined
16761 which of the duplicates is discarded, so this ambiguous situation should be
16762 avoided. The &%repeat_use%& option of the &%redirect%& router may be of help.
16763
16764
16765
16766 .option headers_remove routers string&!! unset
16767 .cindex "header lines" "removing"
16768 .cindex "router" "removing header lines"
16769 This option specifies a string of text that is expanded at routing time, and
16770 associated with any addresses that are accepted by the router. However, this
16771 option has no effect when an address is just being verified. The way in which
16772 the text is used to remove header lines at transport time is described in
16773 section &<<SECTheadersaddrem>>&. Header lines are not actually removed until
16774 the message is in the process of being transported. This means that references
16775 to header lines in string expansions in the transport's configuration still
16776 &"see"& the original header lines.
16777
16778 The &%headers_remove%& option is expanded after &%errors_to%& and
16779 &%headers_add%&, but before &%transport%&. If the expansion is forced to fail,
16780 the option has no effect. Other expansion failures are treated as configuration
16781 errors.
16782
16783 Unlike most options, &%headers_remove%& can be specified multiple times
16784 for a router; all listed headers are removed.
16785
16786 &*Warning 1*&: The &%headers_remove%& option cannot be used for a &(redirect)&
16787 router that has the &%one_time%& option set.
16788
16789 &*Warning 2*&: If the &%unseen%& option is set on the router, all header
16790 removal requests are deleted when the address is passed on to subsequent
16791 routers, and this can lead to problems with duplicates -- see the similar
16792 warning for &%headers_add%& above.
16793
16794
16795 .option ignore_target_hosts routers "host list&!!" unset
16796 .cindex "IP address" "discarding"
16797 .cindex "router" "discarding IP addresses"
16798 Although this option is a host list, it should normally contain IP address
16799 entries rather than names. If any host that is looked up by the router has an
16800 IP address that matches an item in this list, Exim behaves as if that IP
16801 address did not exist. This option allows you to cope with rogue DNS entries
16802 like
16803 .code
16804 remote.domain.example.  A  127.0.0.1
16805 .endd
16806 by setting
16807 .code
16808 ignore_target_hosts = 127.0.0.1
16809 .endd
16810 on the relevant router. If all the hosts found by a &(dnslookup)& router are
16811 discarded in this way, the router declines. In a conventional configuration, an
16812 attempt to mail to such a domain would normally provoke the &"unrouteable
16813 domain"& error, and an attempt to verify an address in the domain would fail.
16814 Similarly, if &%ignore_target_hosts%& is set on an &(ipliteral)& router, the
16815 router declines if presented with one of the listed addresses.
16816
16817 You can use this option to disable the use of IPv4 or IPv6 for mail delivery by
16818 means of the first or the second of the following settings, respectively:
16819 .code
16820 ignore_target_hosts = 0.0.0.0/0
16821 ignore_target_hosts = <; 0::0/0
16822 .endd
16823 The pattern in the first line matches all IPv4 addresses, whereas the pattern
16824 in the second line matches all IPv6 addresses.
16825
16826 This option may also be useful for ignoring link-local and site-local IPv6
16827 addresses. Because, like all host lists, the value of &%ignore_target_hosts%&
16828 is expanded before use as a list, it is possible to make it dependent on the
16829 domain that is being routed.
16830
16831 .vindex "&$host_address$&"
16832 During its expansion, &$host_address$& is set to the IP address that is being
16833 checked.
16834
16835 .option initgroups routers boolean false
16836 .cindex "additional groups"
16837 .cindex "groups" "additional"
16838 .cindex "local transports" "uid and gid"
16839 .cindex "transport" "local"
16840 If the router queues an address for a transport, and this option is true, and
16841 the uid supplied by the router is not overridden by the transport, the
16842 &[initgroups()]& function is called when running the transport to ensure that
16843 any additional groups associated with the uid are set up. See also &%group%&
16844 and &%user%& and the discussion in chapter &<<CHAPenvironment>>&.
16845
16846
16847
16848 .option local_part_prefix routers&!? "string list" unset
16849 .cindex "router" "prefix for local part"
16850 .cindex "prefix" "for local part, used in router"
16851 If this option is set, the router is skipped unless the local part starts with
16852 one of the given strings, or &%local_part_prefix_optional%& is true. See
16853 section &<<SECTrouprecon>>& for a list of the order in which preconditions are
16854 evaluated.
16855
16856 The list is scanned from left to right, and the first prefix that matches is
16857 used. A limited form of wildcard is available; if the prefix begins with an
16858 asterisk, it matches the longest possible sequence of arbitrary characters at
16859 the start of the local part. An asterisk should therefore always be followed by
16860 some character that does not occur in normal local parts.
16861 .cindex "multiple mailboxes"
16862 .cindex "mailbox" "multiple"
16863 Wildcarding can be used to set up multiple user mailboxes, as described in
16864 section &<<SECTmulbox>>&.
16865
16866 .vindex "&$local_part$&"
16867 .vindex "&$local_part_prefix$&"
16868 During the testing of the &%local_parts%& option, and while the router is
16869 running, the prefix is removed from the local part, and is available in the
16870 expansion variable &$local_part_prefix$&. When a message is being delivered, if
16871 the router accepts the address, this remains true during subsequent delivery by
16872 a transport. In particular, the local part that is transmitted in the RCPT
16873 command for LMTP, SMTP, and BSMTP deliveries has the prefix removed by default.
16874 This behaviour can be overridden by setting &%rcpt_include_affixes%& true on
16875 the relevant transport.
16876
16877 When an address is being verified, &%local_part_prefix%& affects only the
16878 behaviour of the router. If the callout feature of verification is in use, this
16879 means that the full address, including the prefix, will be used during the
16880 callout.
16881
16882 The prefix facility is commonly used to handle local parts of the form
16883 &%owner-something%&. Another common use is to support local parts of the form
16884 &%real-username%& to bypass a user's &_.forward_& file &-- helpful when trying
16885 to tell a user their forwarding is broken &-- by placing a router like this one
16886 immediately before the router that handles &_.forward_& files:
16887 .code
16888 real_localuser:
16889   driver = accept
16890   local_part_prefix = real-
16891   check_local_user
16892   transport = local_delivery
16893 .endd
16894 For security, it would probably be a good idea to restrict the use of this
16895 router to locally-generated messages, using a condition such as this:
16896 .code
16897   condition = ${if match {$sender_host_address}\
16898                          {\N^(|127\.0\.0\.1)$\N}}
16899 .endd
16900
16901 If both &%local_part_prefix%& and &%local_part_suffix%& are set for a router,
16902 both conditions must be met if not optional. Care must be taken if wildcards
16903 are used in both a prefix and a suffix on the same router. Different
16904 separator characters must be used to avoid ambiguity.
16905
16906
16907 .option local_part_prefix_optional routers boolean false
16908 See &%local_part_prefix%& above.
16909
16910
16911
16912 .option local_part_suffix routers&!? "string list" unset
16913 .cindex "router" "suffix for local part"
16914 .cindex "suffix for local part" "used in router"
16915 This option operates in the same way as &%local_part_prefix%&, except that the
16916 local part must end (rather than start) with the given string, the
16917 &%local_part_suffix_optional%& option determines whether the suffix is
16918 mandatory, and the wildcard * character, if present, must be the last
16919 character of the suffix. This option facility is commonly used to handle local
16920 parts of the form &%something-request%& and multiple user mailboxes of the form
16921 &%username-foo%&.
16922
16923
16924 .option local_part_suffix_optional routers boolean false
16925 See &%local_part_suffix%& above.
16926
16927
16928
16929 .option local_parts routers&!? "local part list&!!" unset
16930 .cindex "router" "restricting to specific local parts"
16931 .cindex "local part" "checking in router"
16932 The router is run only if the local part of the address matches the list.
16933 See section &<<SECTrouprecon>>& for a list of the order in which preconditions
16934 are evaluated, and
16935 section &<<SECTlocparlis>>& for a discussion of local part lists. Because the
16936 string is expanded, it is possible to make it depend on the domain, for
16937 example:
16938 .code
16939 local_parts = dbm;/usr/local/specials/$domain
16940 .endd
16941 .vindex "&$local_part_data$&"
16942 If the match is achieved by a lookup, the data that the lookup returned
16943 for the local part is placed in the variable &$local_part_data$& for use in
16944 expansions of the router's private options. You might use this option, for
16945 example, if you have a large number of local virtual domains, and you want to
16946 send all postmaster mail to the same place without having to set up an alias in
16947 each virtual domain:
16948 .code
16949 postmaster:
16950   driver = redirect
16951   local_parts = postmaster
16952   data = postmaster@real.domain.example
16953 .endd
16954
16955
16956 .option log_as_local routers boolean "see below"
16957 .cindex "log" "delivery line"
16958 .cindex "delivery" "log line format"
16959 Exim has two logging styles for delivery, the idea being to make local
16960 deliveries stand out more visibly from remote ones. In the &"local"& style, the
16961 recipient address is given just as the local part, without a domain. The use of
16962 this style is controlled by this option. It defaults to true for the &(accept)&
16963 router, and false for all the others. This option applies only when a
16964 router assigns an address to a transport. It has no effect on routers that
16965 redirect addresses.
16966
16967
16968
16969 .option more routers boolean&!! true
16970 The result of string expansion for this option must be a valid boolean value,
16971 that is, one of the strings &"yes"&, &"no"&, &"true"&, or &"false"&. Any other
16972 result causes an error, and delivery is deferred. If the expansion is forced to
16973 fail, the default value for the option (true) is used. Other failures cause
16974 delivery to be deferred.
16975
16976 If this option is set false, and the router declines to handle the address, no
16977 further routers are tried, routing fails, and the address is bounced.
16978 .oindex "&%self%&"
16979 However, if the router explicitly passes an address to the following router by
16980 means of the setting
16981 .code
16982 self = pass
16983 .endd
16984 or otherwise, the setting of &%more%& is ignored. Also, the setting of &%more%&
16985 does not affect the behaviour if one of the precondition tests fails. In that
16986 case, the address is always passed to the next router.
16987
16988 Note that &%address_data%& is not considered to be a precondition. If its
16989 expansion is forced to fail, the router declines, and the value of &%more%&
16990 controls what happens next.
16991
16992
16993 .option pass_on_timeout routers boolean false
16994 .cindex "timeout" "of router"
16995 .cindex "router" "timeout"
16996 If a router times out during a host lookup, it normally causes deferral of the
16997 address. If &%pass_on_timeout%& is set, the address is passed on to the next
16998 router, overriding &%no_more%&. This may be helpful for systems that are
16999 intermittently connected to the Internet, or those that want to pass to a smart
17000 host any messages that cannot immediately be delivered.
17001
17002 There are occasional other temporary errors that can occur while doing DNS
17003 lookups. They are treated in the same way as a timeout, and this option
17004 applies to all of them.
17005
17006
17007
17008 .option pass_router routers string unset
17009 .cindex "router" "go to after &""pass""&"
17010 Routers that recognize the generic &%self%& option (&(dnslookup)&,
17011 &(ipliteral)&, and &(manualroute)&) are able to return &"pass"&, forcing
17012 routing to continue, and overriding a false setting of &%more%&. When one of
17013 these routers returns &"pass"&, the address is normally handed on to the next
17014 router in sequence. This can be changed by setting &%pass_router%& to the name
17015 of another router. However (unlike &%redirect_router%&) the named router must
17016 be below the current router, to avoid loops. Note that this option applies only
17017 to the special case of &"pass"&. It does not apply when a router returns
17018 &"decline"& because it cannot handle an address.
17019
17020
17021
17022 .option redirect_router routers string unset
17023 .cindex "router" "start at after redirection"
17024 Sometimes an administrator knows that it is pointless to reprocess addresses
17025 generated from alias or forward files with the same router again. For
17026 example, if an alias file translates real names into login ids there is no
17027 point searching the alias file a second time, especially if it is a large file.
17028
17029 The &%redirect_router%& option can be set to the name of any router instance.
17030 It causes the routing of any generated addresses to start at the named router
17031 instead of at the first router. This option has no effect if the router in
17032 which it is set does not generate new addresses.
17033
17034
17035
17036 .option require_files routers&!? "string list&!!" unset
17037 .cindex "file" "requiring for router"
17038 .cindex "router" "requiring file existence"
17039 This option provides a general mechanism for predicating the running of a
17040 router on the existence or non-existence of certain files or directories.
17041 Before running a router, as one of its precondition tests, Exim works its way
17042 through the &%require_files%& list, expanding each item separately.
17043
17044 Because the list is split before expansion, any colons in expansion items must
17045 be doubled, or the facility for using a different list separator must be used.
17046 If any expansion is forced to fail, the item is ignored. Other expansion
17047 failures cause routing of the address to be deferred.
17048
17049 If any expanded string is empty, it is ignored. Otherwise, except as described
17050 below, each string must be a fully qualified file path, optionally preceded by
17051 &"!"&. The paths are passed to the &[stat()]& function to test for the
17052 existence of the files or directories. The router is skipped if any paths not
17053 preceded by &"!"& do not exist, or if any paths preceded by &"!"& do exist.
17054
17055 .cindex "NFS"
17056 If &[stat()]& cannot determine whether a file exists or not, delivery of
17057 the message is deferred. This can happen when NFS-mounted filesystems are
17058 unavailable.
17059
17060 This option is checked after the &%domains%&, &%local_parts%&, and &%senders%&
17061 options, so you cannot use it to check for the existence of a file in which to
17062 look up a domain, local part, or sender. (See section &<<SECTrouprecon>>& for a
17063 full list of the order in which preconditions are evaluated.) However, as
17064 these options are all expanded, you can use the &%exists%& expansion condition
17065 to make such tests. The &%require_files%& option is intended for checking files
17066 that the router may be going to use internally, or which are needed by a
17067 transport (for example &_.procmailrc_&).
17068
17069 During delivery, the &[stat()]& function is run as root, but there is a
17070 facility for some checking of the accessibility of a file by another user.
17071 This is not a proper permissions check, but just a &"rough"& check that
17072 operates as follows:
17073
17074 If an item in a &%require_files%& list does not contain any forward slash
17075 characters, it is taken to be the user (and optional group, separated by a
17076 comma) to be checked for subsequent files in the list. If no group is specified
17077 but the user is specified symbolically, the gid associated with the uid is
17078 used. For example:
17079 .code
17080 require_files = mail:/some/file
17081 require_files = $local_part:$home/.procmailrc
17082 .endd
17083 If a user or group name in a &%require_files%& list does not exist, the
17084 &%require_files%& condition fails.
17085
17086 Exim performs the check by scanning along the components of the file path, and
17087 checking the access for the given uid and gid. It checks for &"x"& access on
17088 directories, and &"r"& access on the final file. Note that this means that file
17089 access control lists, if the operating system has them, are ignored.
17090
17091 &*Warning 1*&: When the router is being run to verify addresses for an
17092 incoming SMTP message, Exim is not running as root, but under its own uid. This
17093 may affect the result of a &%require_files%& check. In particular, &[stat()]&
17094 may yield the error EACCES (&"Permission denied"&). This means that the Exim
17095 user is not permitted to read one of the directories on the file's path.
17096
17097 &*Warning 2*&: Even when Exim is running as root while delivering a message,
17098 &[stat()]& can yield EACCES for a file in an NFS directory that is mounted
17099 without root access. In this case, if a check for access by a particular user
17100 is requested, Exim creates a subprocess that runs as that user, and tries the
17101 check again in that process.
17102
17103 The default action for handling an unresolved EACCES is to consider it to
17104 be caused by a configuration error, and routing is deferred because the
17105 existence or non-existence of the file cannot be determined. However, in some
17106 circumstances it may be desirable to treat this condition as if the file did
17107 not exist. If the file name (or the exclamation mark that precedes the file
17108 name for non-existence) is preceded by a plus sign, the EACCES error is treated
17109 as if the file did not exist. For example:
17110 .code
17111 require_files = +/some/file
17112 .endd
17113 If the router is not an essential part of verification (for example, it
17114 handles users' &_.forward_& files), another solution is to set the &%verify%&
17115 option false so that the router is skipped when verifying.
17116
17117
17118
17119 .option retry_use_local_part routers boolean "see below"
17120 .cindex "hints database" "retry keys"
17121 .cindex "local part" "in retry keys"
17122 When a delivery suffers a temporary routing failure, a retry record is created
17123 in Exim's hints database. For addresses whose routing depends only on the
17124 domain, the key for the retry record should not involve the local part, but for
17125 other addresses, both the domain and the local part should be included.
17126 Usually, remote routing is of the former kind, and local routing is of the
17127 latter kind.
17128
17129 This option controls whether the local part is used to form the key for retry
17130 hints for addresses that suffer temporary errors while being handled by this
17131 router. The default value is true for any router that has &%check_local_user%&
17132 set, and false otherwise. Note that this option does not apply to hints keys
17133 for transport delays; they are controlled by a generic transport option of the
17134 same name.
17135
17136 The setting of &%retry_use_local_part%& applies only to the router on which it
17137 appears. If the router generates child addresses, they are routed
17138 independently; this setting does not become attached to them.
17139
17140
17141
17142 .option router_home_directory routers string&!! unset
17143 .cindex "router" "home directory for"
17144 .cindex "home directory" "for router"
17145 .vindex "&$home$&"
17146 This option sets a home directory for use while the router is running. (Compare
17147 &%transport_home_directory%&, which sets a home directory for later
17148 transporting.) In particular, if used on a &(redirect)& router, this option
17149 sets a value for &$home$& while a filter is running. The value is expanded;
17150 forced expansion failure causes the option to be ignored &-- other failures
17151 cause the router to defer.
17152
17153 Expansion of &%router_home_directory%& happens immediately after the
17154 &%check_local_user%& test (if configured), before any further expansions take
17155 place.
17156 (See section &<<SECTrouprecon>>& for a list of the order in which preconditions
17157 are evaluated.)
17158 While the router is running, &%router_home_directory%& overrides the value of
17159 &$home$& that came from &%check_local_user%&.
17160
17161 When a router accepts an address and assigns it to a local transport (including
17162 the cases when a &(redirect)& router generates a pipe, file, or autoreply
17163 delivery), the home directory setting for the transport is taken from the first
17164 of these values that is set:
17165
17166 .ilist
17167 The &%home_directory%& option on the transport;
17168 .next
17169 The &%transport_home_directory%& option on the router;
17170 .next
17171 The password data if &%check_local_user%& is set on the router;
17172 .next
17173 The &%router_home_directory%& option on the router.
17174 .endlist
17175
17176 In other words, &%router_home_directory%& overrides the password data for the
17177 router, but not for the transport.
17178
17179
17180
17181 .option self routers string freeze
17182 .cindex "MX record" "pointing to local host"
17183 .cindex "local host" "MX pointing to"
17184 This option applies to those routers that use a recipient address to find a
17185 list of remote hosts. Currently, these are the &(dnslookup)&, &(ipliteral)&,
17186 and &(manualroute)& routers.
17187 Certain configurations of the &(queryprogram)& router can also specify a list
17188 of remote hosts.
17189 Usually such routers are configured to send the message to a remote host via an
17190 &(smtp)& transport. The &%self%& option specifies what happens when the first
17191 host on the list turns out to be the local host.
17192 The way in which Exim checks for the local host is described in section
17193 &<<SECTreclocipadd>>&.
17194
17195 Normally this situation indicates either an error in Exim's configuration (for
17196 example, the router should be configured not to process this domain), or an
17197 error in the DNS (for example, the MX should not point to this host). For this
17198 reason, the default action is to log the incident, defer the address, and
17199 freeze the message. The following alternatives are provided for use in special
17200 cases:
17201
17202 .vlist
17203 .vitem &%defer%&
17204 Delivery of the message is tried again later, but the message is not frozen.
17205
17206 .vitem "&%reroute%&: <&'domain'&>"
17207 The domain is changed to the given domain, and the address is passed back to
17208 be reprocessed by the routers. No rewriting of headers takes place. This
17209 behaviour is essentially a redirection.
17210
17211 .vitem "&%reroute: rewrite:%& <&'domain'&>"
17212 The domain is changed to the given domain, and the address is passed back to be
17213 reprocessed by the routers. Any headers that contain the original domain are
17214 rewritten.
17215
17216 .vitem &%pass%&
17217 .oindex "&%more%&"
17218 .vindex "&$self_hostname$&"
17219 The router passes the address to the next router, or to the router named in the
17220 &%pass_router%& option if it is set. This overrides &%no_more%&. During
17221 subsequent routing and delivery, the variable &$self_hostname$& contains the
17222 name of the local host that the router encountered. This can be used to
17223 distinguish between different cases for hosts with multiple names. The
17224 combination
17225 .code
17226 self = pass
17227 no_more
17228 .endd
17229 ensures that only those addresses that routed to the local host are passed on.
17230 Without &%no_more%&, addresses that were declined for other reasons would also
17231 be passed to the next router.
17232
17233 .vitem &%fail%&
17234 Delivery fails and an error report is generated.
17235
17236 .vitem &%send%&
17237 .cindex "local host" "sending to"
17238 The anomaly is ignored and the address is queued for the transport. This
17239 setting should be used with extreme caution. For an &(smtp)& transport, it
17240 makes sense only in cases where the program that is listening on the SMTP port
17241 is not this version of Exim. That is, it must be some other MTA, or Exim with a
17242 different configuration file that handles the domain in another way.
17243 .endlist
17244
17245
17246
17247 .option senders routers&!? "address list&!!" unset
17248 .cindex "router" "checking senders"
17249 If this option is set, the router is skipped unless the message's sender
17250 address matches something on the list.
17251 See section &<<SECTrouprecon>>& for a list of the order in which preconditions
17252 are evaluated.
17253
17254 There are issues concerning verification when the running of routers is
17255 dependent on the sender. When Exim is verifying the address in an &%errors_to%&
17256 setting, it sets the sender to the null string. When using the &%-bt%& option
17257 to check a configuration file, it is necessary also to use the &%-f%& option to
17258 set an appropriate sender. For incoming mail, the sender is unset when
17259 verifying the sender, but is available when verifying any recipients. If the
17260 SMTP VRFY command is enabled, it must be used after MAIL if the sender address
17261 matters.
17262
17263
17264 .option translate_ip_address routers string&!! unset
17265 .cindex "IP address" "translating"
17266 .cindex "packet radio"
17267 .cindex "router" "IP address translation"
17268 There exist some rare networking situations (for example, packet radio) where
17269 it is helpful to be able to translate IP addresses generated by normal routing
17270 mechanisms into other IP addresses, thus performing a kind of manual IP
17271 routing. This should be done only if the normal IP routing of the TCP/IP stack
17272 is inadequate or broken. Because this is an extremely uncommon requirement, the
17273 code to support this option is not included in the Exim binary unless
17274 SUPPORT_TRANSLATE_IP_ADDRESS=yes is set in &_Local/Makefile_&.
17275
17276 .vindex "&$host_address$&"
17277 The &%translate_ip_address%& string is expanded for every IP address generated
17278 by the router, with the generated address set in &$host_address$&. If the
17279 expansion is forced to fail, no action is taken.
17280 For any other expansion error, delivery of the message is deferred.
17281 If the result of the expansion is an IP address, that replaces the original
17282 address; otherwise the result is assumed to be a host name &-- this is looked
17283 up using &[gethostbyname()]& (or &[getipnodebyname()]& when available) to
17284 produce one or more replacement IP addresses. For example, to subvert all IP
17285 addresses in some specific networks, this could be added to a router:
17286 .code
17287 translate_ip_address = \
17288   ${lookup{${mask:$host_address/26}}lsearch{/some/file}\
17289     {$value}fail}}
17290 .endd
17291 The file would contain lines like
17292 .code
17293 10.2.3.128/26    some.host
17294 10.8.4.34/26     10.44.8.15
17295 .endd
17296 You should not make use of this facility unless you really understand what you
17297 are doing.
17298
17299
17300
17301 .option transport routers string&!! unset
17302 This option specifies the transport to be used when a router accepts an address
17303 and sets it up for delivery. A transport is never needed if a router is used
17304 only for verification. The value of the option is expanded at routing time,
17305 after the expansion of &%errors_to%&, &%headers_add%&, and &%headers_remove%&,
17306 and result must be the name of one of the configured transports. If it is not,
17307 delivery is deferred.
17308
17309 The &%transport%& option is not used by the &(redirect)& router, but it does
17310 have some private options that set up transports for pipe and file deliveries
17311 (see chapter &<<CHAPredirect>>&).
17312
17313
17314
17315 .option transport_current_directory routers string&!! unset
17316 .cindex "current directory for local transport"
17317 This option associates a current directory with any address that is routed
17318 to a local transport. This can happen either because a transport is
17319 explicitly configured for the router, or because it generates a delivery to a
17320 file or a pipe. During the delivery process (that is, at transport time), this
17321 option string is expanded and is set as the current directory, unless
17322 overridden by a setting on the transport.
17323 If the expansion fails for any reason, including forced failure, an error is
17324 logged, and delivery is deferred.
17325 See chapter &<<CHAPenvironment>>& for details of the local delivery
17326 environment.
17327
17328
17329
17330
17331 .option transport_home_directory routers string&!! "see below"
17332 .cindex "home directory" "for local transport"
17333 This option associates a home directory with any address that is routed to a
17334 local transport. This can happen either because a transport is explicitly
17335 configured for the router, or because it generates a delivery to a file or a
17336 pipe. During the delivery process (that is, at transport time), the option
17337 string is expanded and is set as the home directory, unless overridden by a
17338 setting of &%home_directory%& on the transport.
17339 If the expansion fails for any reason, including forced failure, an error is
17340 logged, and delivery is deferred.
17341
17342 If the transport does not specify a home directory, and
17343 &%transport_home_directory%& is not set for the router, the home directory for
17344 the transport is taken from the password data if &%check_local_user%& is set for
17345 the router. Otherwise it is taken from &%router_home_directory%& if that option
17346 is set; if not, no home directory is set for the transport.
17347
17348 See chapter &<<CHAPenvironment>>& for further details of the local delivery
17349 environment.
17350
17351
17352
17353
17354 .option unseen routers boolean&!! false
17355 .cindex "router" "carrying on after success"
17356 The result of string expansion for this option must be a valid boolean value,
17357 that is, one of the strings &"yes"&, &"no"&, &"true"&, or &"false"&. Any other
17358 result causes an error, and delivery is deferred. If the expansion is forced to
17359 fail, the default value for the option (false) is used. Other failures cause
17360 delivery to be deferred.
17361
17362 When this option is set true, routing does not cease if the router accepts the
17363 address. Instead, a copy of the incoming address is passed to the next router,
17364 overriding a false setting of &%more%&. There is little point in setting
17365 &%more%& false if &%unseen%& is always true, but it may be useful in cases when
17366 the value of &%unseen%& contains expansion items (and therefore, presumably, is
17367 sometimes true and sometimes false).
17368
17369 .cindex "copy of message (&%unseen%& option)"
17370 Setting the &%unseen%& option has a similar effect to the &%unseen%& command
17371 qualifier in filter files. It can be used to cause copies of messages to be
17372 delivered to some other destination, while also carrying out a normal delivery.
17373 In effect, the current address is made into a &"parent"& that has two children
17374 &-- one that is delivered as specified by this router, and a clone that goes on
17375 to be routed further. For this reason, &%unseen%& may not be combined with the
17376 &%one_time%& option in a &(redirect)& router.
17377
17378 &*Warning*&: Header lines added to the address (or specified for removal) by
17379 this router or by previous routers affect the &"unseen"& copy of the message
17380 only. The clone that continues to be processed by further routers starts with
17381 no added headers and none specified for removal. For a &%redirect%& router, if
17382 a generated address is the same as the incoming address, this can lead to
17383 duplicate addresses with different header modifications. Exim does not do
17384 duplicate deliveries (except, in certain circumstances, to pipes -- see section
17385 &<<SECTdupaddr>>&), but it is undefined which of the duplicates is discarded,
17386 so this ambiguous situation should be avoided. The &%repeat_use%& option of the
17387 &%redirect%& router may be of help.
17388
17389 Unlike the handling of header modifications, any data that was set by the
17390 &%address_data%& option in the current or previous routers &'is'& passed on to
17391 subsequent routers.
17392
17393
17394 .option user routers string&!! "see below"
17395 .cindex "uid (user id)" "local delivery"
17396 .cindex "local transports" "uid and gid"
17397 .cindex "transport" "local"
17398 .cindex "router" "user for filter processing"
17399 .cindex "filter" "user for processing"
17400 When a router queues an address for a transport, and the transport does not
17401 specify a user, the user given here is used when running the delivery process.
17402 The user may be specified numerically or by name. If expansion fails, the
17403 error is logged and delivery is deferred.
17404 This user is also used by the &(redirect)& router when running a filter file.
17405 The default is unset, except when &%check_local_user%& is set. In this case,
17406 the default is taken from the password information. If the user is specified as
17407 a name, and &%group%& is not set, the group associated with the user is used.
17408 See also &%initgroups%& and &%group%& and the discussion in chapter
17409 &<<CHAPenvironment>>&.
17410
17411
17412
17413 .option verify routers&!? boolean true
17414 Setting this option has the effect of setting &%verify_sender%& and
17415 &%verify_recipient%& to the same value.
17416
17417
17418 .option verify_only routers&!? boolean false
17419 .cindex "EXPN" "with &%verify_only%&"
17420 .oindex "&%-bv%&"
17421 .cindex "router" "used only when verifying"
17422 If this option is set, the router is used only when verifying an address,
17423 delivering in cutthrough mode or
17424 testing with the &%-bv%& option, not when actually doing a delivery, testing
17425 with the &%-bt%& option, or running the SMTP EXPN command. It can be further
17426 restricted to verifying only senders or recipients by means of
17427 &%verify_sender%& and &%verify_recipient%&.
17428
17429 &*Warning*&: When the router is being run to verify addresses for an incoming
17430 SMTP message, Exim is not running as root, but under its own uid. If the router
17431 accesses any files, you need to make sure that they are accessible to the Exim
17432 user or group.
17433
17434
17435 .option verify_recipient routers&!? boolean true
17436 If this option is false, the router is skipped when verifying recipient
17437 addresses,
17438 delivering in cutthrough mode
17439 or testing recipient verification using &%-bv%&.
17440 See section &<<SECTrouprecon>>& for a list of the order in which preconditions
17441 are evaluated.
17442
17443
17444 .option verify_sender routers&!? boolean true
17445 If this option is false, the router is skipped when verifying sender addresses
17446 or testing sender verification using &%-bvs%&.
17447 See section &<<SECTrouprecon>>& for a list of the order in which preconditions
17448 are evaluated.
17449 .ecindex IIDgenoprou1
17450 .ecindex IIDgenoprou2
17451
17452
17453
17454
17455
17456
17457 . ////////////////////////////////////////////////////////////////////////////
17458 . ////////////////////////////////////////////////////////////////////////////
17459
17460 .chapter "The accept router" "CHID4"
17461 .cindex "&(accept)& router"
17462 .cindex "routers" "&(accept)&"
17463 The &(accept)& router has no private options of its own. Unless it is being
17464 used purely for verification (see &%verify_only%&) a transport is required to
17465 be defined by the generic &%transport%& option. If the preconditions that are
17466 specified by generic options are met, the router accepts the address and queues
17467 it for the given transport. The most common use of this router is for setting
17468 up deliveries to local mailboxes. For example:
17469 .code
17470 localusers:
17471   driver = accept
17472   domains = mydomain.example
17473   check_local_user
17474   transport = local_delivery
17475 .endd
17476 The &%domains%& condition in this example checks the domain of the address, and
17477 &%check_local_user%& checks that the local part is the login of a local user.
17478 When both preconditions are met, the &(accept)& router runs, and queues the
17479 address for the &(local_delivery)& transport.
17480
17481
17482
17483
17484
17485
17486 . ////////////////////////////////////////////////////////////////////////////
17487 . ////////////////////////////////////////////////////////////////////////////
17488
17489 .chapter "The dnslookup router" "CHAPdnslookup"
17490 .scindex IIDdnsrou1 "&(dnslookup)& router"
17491 .scindex IIDdnsrou2 "routers" "&(dnslookup)&"
17492 The &(dnslookup)& router looks up the hosts that handle mail for the
17493 recipient's domain in the DNS. A transport must always be set for this router,
17494 unless &%verify_only%& is set.
17495
17496 If SRV support is configured (see &%check_srv%& below), Exim first searches for
17497 SRV records. If none are found, or if SRV support is not configured,
17498 MX records are looked up. If no MX records exist, address records are sought.
17499 However, &%mx_domains%& can be set to disable the direct use of address
17500 records.
17501
17502 MX records of equal priority are sorted by Exim into a random order. Exim then
17503 looks for address records for the host names obtained from MX or SRV records.
17504 When a host has more than one IP address, they are sorted into a random order,
17505 except that IPv6 addresses are always sorted before IPv4 addresses. If all the
17506 IP addresses found are discarded by a setting of the &%ignore_target_hosts%&
17507 generic option, the router declines.
17508
17509 Unless they have the highest priority (lowest MX value), MX records that point
17510 to the local host, or to any host name that matches &%hosts_treat_as_local%&,
17511 are discarded, together with any other MX records of equal or lower priority.
17512
17513 .cindex "MX record" "pointing to local host"
17514 .cindex "local host" "MX pointing to"
17515 .oindex "&%self%&" "in &(dnslookup)& router"
17516 If the host pointed to by the highest priority MX record, or looked up as an
17517 address record, is the local host, or matches &%hosts_treat_as_local%&, what
17518 happens is controlled by the generic &%self%& option.
17519
17520
17521 .section "Problems with DNS lookups" "SECTprowitdnsloo"
17522 There have been problems with DNS servers when SRV records are looked up.
17523 Some mis-behaving servers return a DNS error or timeout when a non-existent
17524 SRV record is sought. Similar problems have in the past been reported for
17525 MX records. The global &%dns_again_means_nonexist%& option can help with this
17526 problem, but it is heavy-handed because it is a global option.
17527
17528 For this reason, there are two options, &%srv_fail_domains%& and
17529 &%mx_fail_domains%&, that control what happens when a DNS lookup in a
17530 &(dnslookup)& router results in a DNS failure or a &"try again"& response. If
17531 an attempt to look up an SRV or MX record causes one of these results, and the
17532 domain matches the relevant list, Exim behaves as if the DNS had responded &"no
17533 such record"&. In the case of an SRV lookup, this means that the router
17534 proceeds to look for MX records; in the case of an MX lookup, it proceeds to
17535 look for A or AAAA records, unless the domain matches &%mx_domains%&, in which
17536 case routing fails.
17537
17538
17539 .section "Declining addresses by dnslookup" "SECTdnslookupdecline"
17540 .cindex "&(dnslookup)& router" "declines"
17541 There are a few cases where a &(dnslookup)& router will decline to accept
17542 an address; if such a router is expected to handle "all remaining non-local
17543 domains", then it is important to set &%no_more%&.
17544
17545 Reasons for a &(dnslookup)& router to decline currently include:
17546 .ilist
17547 The domain does not exist in DNS
17548 .next
17549 The domain exists but the MX record's host part is just "."; this is a common
17550 convention (borrowed from SRV) used to indicate that there is no such service
17551 for this domain and to not fall back to trying A/AAAA records.
17552 .next
17553 Ditto, but for SRV records, when &%check_srv%& is set on this router.
17554 .next
17555 MX record points to a non-existent host.
17556 .next
17557 MX record points to an IP address and the main section option
17558 &%allow_mx_to_ip%& is not set.
17559 .next
17560 MX records exist and point to valid hosts, but all hosts resolve only to
17561 addresses blocked by the &%ignore_target_hosts%& generic option on this router.
17562 .next
17563 The domain is not syntactically valid (see also &%allow_utf8_domains%& and
17564 &%dns_check_names_pattern%& for handling one variant of this)
17565 .next
17566 &%check_secondary_mx%& is set on this router but the local host can
17567 not be found in the MX records (see below)
17568 .endlist
17569
17570
17571
17572
17573 .section "Private options for dnslookup" "SECID118"
17574 .cindex "options" "&(dnslookup)& router"
17575 The private options for the &(dnslookup)& router are as follows:
17576
17577 .option check_secondary_mx dnslookup boolean false
17578 .cindex "MX record" "checking for secondary"
17579 If this option is set, the router declines unless the local host is found in
17580 (and removed from) the list of hosts obtained by MX lookup. This can be used to
17581 process domains for which the local host is a secondary mail exchanger
17582 differently to other domains. The way in which Exim decides whether a host is
17583 the local host is described in section &<<SECTreclocipadd>>&.
17584
17585
17586 .option check_srv dnslookup string&!! unset
17587 .cindex "SRV record" "enabling use of"
17588 The &(dnslookup)& router supports the use of SRV records (see RFC 2782) in
17589 addition to MX and address records. The support is disabled by default. To
17590 enable SRV support, set the &%check_srv%& option to the name of the service
17591 required. For example,
17592 .code
17593 check_srv = smtp
17594 .endd
17595 looks for SRV records that refer to the normal smtp service. The option is
17596 expanded, so the service name can vary from message to message or address
17597 to address. This might be helpful if SRV records are being used for a
17598 submission service. If the expansion is forced to fail, the &%check_srv%&
17599 option is ignored, and the router proceeds to look for MX records in the
17600 normal way.
17601
17602 When the expansion succeeds, the router searches first for SRV records for
17603 the given service (it assumes TCP protocol). A single SRV record with a
17604 host name that consists of just a single dot indicates &"no such service for
17605 this domain"&; if this is encountered, the router declines. If other kinds of
17606 SRV record are found, they are used to construct a host list for delivery
17607 according to the rules of RFC 2782. MX records are not sought in this case.
17608
17609 When no SRV records are found, MX records (and address records) are sought in
17610 the traditional way. In other words, SRV records take precedence over MX
17611 records, just as MX records take precedence over address records. Note that
17612 this behaviour is not sanctioned by RFC 2782, though a previous draft RFC
17613 defined it. It is apparently believed that MX records are sufficient for email
17614 and that SRV records should not be used for this purpose. However, SRV records
17615 have an additional &"weight"& feature which some people might find useful when
17616 trying to split an SMTP load between hosts of different power.
17617
17618 See section &<<SECTprowitdnsloo>>& above for a discussion of Exim's behaviour
17619 when there is a DNS lookup error.
17620
17621
17622
17623 .option mx_domains dnslookup "domain list&!!" unset
17624 .cindex "MX record" "required to exist"
17625 .cindex "SRV record" "required to exist"
17626 A domain that matches &%mx_domains%& is required to have either an MX or an SRV
17627 record in order to be recognized. (The name of this option could be improved.)
17628 For example, if all the mail hosts in &'fict.example'& are known to have MX
17629 records, except for those in &'discworld.fict.example'&, you could use this
17630 setting:
17631 .code
17632 mx_domains = ! *.discworld.fict.example : *.fict.example
17633 .endd
17634 This specifies that messages addressed to a domain that matches the list but
17635 has no MX record should be bounced immediately instead of being routed using
17636 the address record.
17637
17638
17639 .option mx_fail_domains dnslookup "domain list&!!" unset
17640 If the DNS lookup for MX records for one of the domains in this list causes a
17641 DNS lookup error, Exim behaves as if no MX records were found. See section
17642 &<<SECTprowitdnsloo>>& for more discussion.
17643
17644
17645
17646
17647 .option qualify_single dnslookup boolean true
17648 .cindex "DNS" "resolver options"
17649 .cindex "DNS" "qualifying single-component names"
17650 When this option is true, the resolver option RES_DEFNAMES is set for DNS
17651 lookups. Typically, but not standardly, this causes the resolver to qualify
17652 single-component names with the default domain. For example, on a machine
17653 called &'dictionary.ref.example'&, the domain &'thesaurus'& would be changed to
17654 &'thesaurus.ref.example'& inside the resolver. For details of what your
17655 resolver actually does, consult your man pages for &'resolver'& and
17656 &'resolv.conf'&.
17657
17658
17659
17660 .option rewrite_headers dnslookup boolean true
17661 .cindex "rewriting" "header lines"
17662 .cindex "header lines" "rewriting"
17663 If the domain name in the address that is being processed is not fully
17664 qualified, it may be expanded to its full form by a DNS lookup. For example, if
17665 an address is specified as &'dormouse@teaparty'&, the domain might be
17666 expanded to &'teaparty.wonderland.fict.example'&. Domain expansion can also
17667 occur as a result of setting the &%widen_domains%& option. If
17668 &%rewrite_headers%& is true, all occurrences of the abbreviated domain name in
17669 any &'Bcc:'&, &'Cc:'&, &'From:'&, &'Reply-to:'&, &'Sender:'&, and &'To:'&
17670 header lines of the message are rewritten with the full domain name.
17671
17672 This option should be turned off only when it is known that no message is
17673 ever going to be sent outside an environment where the abbreviation makes
17674 sense.
17675
17676 When an MX record is looked up in the DNS and matches a wildcard record, name
17677 servers normally return a record containing the name that has been looked up,
17678 making it impossible to detect whether a wildcard was present or not. However,
17679 some name servers have recently been seen to return the wildcard entry. If the
17680 name returned by a DNS lookup begins with an asterisk, it is not used for
17681 header rewriting.
17682
17683
17684 .option same_domain_copy_routing dnslookup boolean false
17685 .cindex "address" "copying routing"
17686 Addresses with the same domain are normally routed by the &(dnslookup)& router
17687 to the same list of hosts. However, this cannot be presumed, because the router
17688 options and preconditions may refer to the local part of the address. By
17689 default, therefore, Exim routes each address in a message independently. DNS
17690 servers run caches, so repeated DNS lookups are not normally expensive, and in
17691 any case, personal messages rarely have more than a few recipients.
17692
17693 If you are running mailing lists with large numbers of subscribers at the same
17694 domain, and you are using a &(dnslookup)& router which is independent of the
17695 local part, you can set &%same_domain_copy_routing%& to bypass repeated DNS
17696 lookups for identical domains in one message. In this case, when &(dnslookup)&
17697 routes an address to a remote transport, any other unrouted addresses in the
17698 message that have the same domain are automatically given the same routing
17699 without processing them independently,
17700 provided the following conditions are met:
17701
17702 .ilist
17703 No router that processed the address specified &%headers_add%& or
17704 &%headers_remove%&.
17705 .next
17706 The router did not change the address in any way, for example, by &"widening"&
17707 the domain.
17708 .endlist
17709
17710
17711
17712
17713 .option search_parents dnslookup boolean false
17714 .cindex "DNS" "resolver options"
17715 When this option is true, the resolver option RES_DNSRCH is set for DNS
17716 lookups. This is different from the &%qualify_single%& option in that it
17717 applies to domains containing dots. Typically, but not standardly, it causes
17718 the resolver to search for the name in the current domain and in parent
17719 domains. For example, on a machine in the &'fict.example'& domain, if looking
17720 up &'teaparty.wonderland'& failed, the resolver would try
17721 &'teaparty.wonderland.fict.example'&. For details of what your resolver
17722 actually does, consult your man pages for &'resolver'& and &'resolv.conf'&.
17723
17724 Setting this option true can cause problems in domains that have a wildcard MX
17725 record, because any domain that does not have its own MX record matches the
17726 local wildcard.
17727
17728
17729
17730 .option srv_fail_domains dnslookup "domain list&!!" unset
17731 If the DNS lookup for SRV records for one of the domains in this list causes a
17732 DNS lookup error, Exim behaves as if no SRV records were found. See section
17733 &<<SECTprowitdnsloo>>& for more discussion.
17734
17735
17736
17737
17738 .option widen_domains dnslookup "string list" unset
17739 .cindex "domain" "partial; widening"
17740 If a DNS lookup fails and this option is set, each of its strings in turn is
17741 added onto the end of the domain, and the lookup is tried again. For example,
17742 if
17743 .code
17744 widen_domains = fict.example:ref.example
17745 .endd
17746 is set and a lookup of &'klingon.dictionary'& fails,
17747 &'klingon.dictionary.fict.example'& is looked up, and if this fails,
17748 &'klingon.dictionary.ref.example'& is tried. Note that the &%qualify_single%&
17749 and &%search_parents%& options can cause some widening to be undertaken inside
17750 the DNS resolver. &%widen_domains%& is not applied to sender addresses
17751 when verifying, unless &%rewrite_headers%& is false (not the default).
17752
17753
17754 .section "Effect of qualify_single and search_parents" "SECID119"
17755 When a domain from an envelope recipient is changed by the resolver as a result
17756 of the &%qualify_single%& or &%search_parents%& options, Exim rewrites the
17757 corresponding address in the message's header lines unless &%rewrite_headers%&
17758 is set false. Exim then re-routes the address, using the full domain.
17759
17760 These two options affect only the DNS lookup that takes place inside the router
17761 for the domain of the address that is being routed. They do not affect lookups
17762 such as that implied by
17763 .code
17764 domains = @mx_any
17765 .endd
17766 that may happen while processing a router precondition before the router is
17767 entered. No widening ever takes place for these lookups.
17768 .ecindex IIDdnsrou1
17769 .ecindex IIDdnsrou2
17770
17771
17772
17773
17774
17775
17776
17777
17778
17779 . ////////////////////////////////////////////////////////////////////////////
17780 . ////////////////////////////////////////////////////////////////////////////
17781
17782 .chapter "The ipliteral router" "CHID5"
17783 .cindex "&(ipliteral)& router"
17784 .cindex "domain literal" "routing"
17785 .cindex "routers" "&(ipliteral)&"
17786 This router has no private options. Unless it is being used purely for
17787 verification (see &%verify_only%&) a transport is required to be defined by the
17788 generic &%transport%& option. The router accepts the address if its domain part
17789 takes the form of an RFC 2822 domain literal. For example, the &(ipliteral)&
17790 router handles the address
17791 .code
17792 root@[192.168.1.1]
17793 .endd
17794 by setting up delivery to the host with that IP address. IPv4 domain literals
17795 consist of an IPv4 address enclosed in square brackets. IPv6 domain literals
17796 are similar, but the address is preceded by &`ipv6:`&. For example:
17797 .code
17798 postmaster@[ipv6:fe80::a00:20ff:fe86:a061.5678]
17799 .endd
17800 Exim allows &`ipv4:`& before IPv4 addresses, for consistency, and on the
17801 grounds that sooner or later somebody will try it.
17802
17803 .oindex "&%self%&" "in &(ipliteral)& router"
17804 If the IP address matches something in &%ignore_target_hosts%&, the router
17805 declines. If an IP literal turns out to refer to the local host, the generic
17806 &%self%& option determines what happens.
17807
17808 The RFCs require support for domain literals; however, their use is
17809 controversial in today's Internet. If you want to use this router, you must
17810 also set the main configuration option &%allow_domain_literals%&. Otherwise,
17811 Exim will not recognize the domain literal syntax in addresses.
17812
17813
17814
17815 . ////////////////////////////////////////////////////////////////////////////
17816 . ////////////////////////////////////////////////////////////////////////////
17817
17818 .chapter "The iplookup router" "CHID6"
17819 .cindex "&(iplookup)& router"
17820 .cindex "routers" "&(iplookup)&"
17821 The &(iplookup)& router was written to fulfil a specific requirement in
17822 Cambridge University (which in fact no longer exists). For this reason, it is
17823 not included in the binary of Exim by default. If you want to include it, you
17824 must set
17825 .code
17826 ROUTER_IPLOOKUP=yes
17827 .endd
17828 in your &_Local/Makefile_& configuration file.
17829
17830 The &(iplookup)& router routes an address by sending it over a TCP or UDP
17831 connection to one or more specific hosts. The host can then return the same or
17832 a different address &-- in effect rewriting the recipient address in the
17833 message's envelope. The new address is then passed on to subsequent routers. If
17834 this process fails, the address can be passed on to other routers, or delivery
17835 can be deferred. Since &(iplookup)& is just a rewriting router, a transport
17836 must not be specified for it.
17837
17838 .cindex "options" "&(iplookup)& router"
17839 .option hosts iplookup string unset
17840 This option must be supplied. Its value is a colon-separated list of host
17841 names. The hosts are looked up using &[gethostbyname()]&
17842 (or &[getipnodebyname()]& when available)
17843 and are tried in order until one responds to the query. If none respond, what
17844 happens is controlled by &%optional%&.
17845
17846
17847 .option optional iplookup boolean false
17848 If &%optional%& is true, if no response is obtained from any host, the address
17849 is passed to the next router, overriding &%no_more%&. If &%optional%& is false,
17850 delivery to the address is deferred.
17851
17852
17853 .option port iplookup integer 0
17854 .cindex "port" "&(iplookup)& router"
17855 This option must be supplied. It specifies the port number for the TCP or UDP
17856 call.
17857
17858
17859 .option protocol iplookup string udp
17860 This option can be set to &"udp"& or &"tcp"& to specify which of the two
17861 protocols is to be used.
17862
17863
17864 .option query iplookup string&!! "see below"
17865 This defines the content of the query that is sent to the remote hosts. The
17866 default value is:
17867 .code
17868 $local_part@$domain $local_part@$domain
17869 .endd
17870 The repetition serves as a way of checking that a response is to the correct
17871 query in the default case (see &%response_pattern%& below).
17872
17873
17874 .option reroute iplookup string&!! unset
17875 If this option is not set, the rerouted address is precisely the byte string
17876 returned by the remote host, up to the first white space, if any. If set, the
17877 string is expanded to form the rerouted address. It can include parts matched
17878 in the response by &%response_pattern%& by means of numeric variables such as
17879 &$1$&, &$2$&, etc. The variable &$0$& refers to the entire input string,
17880 whether or not a pattern is in use. In all cases, the rerouted address must end
17881 up in the form &'local_part@domain'&.
17882
17883
17884 .option response_pattern iplookup string unset
17885 This option can be set to a regular expression that is applied to the string
17886 returned from the remote host. If the pattern does not match the response, the
17887 router declines. If &%response_pattern%& is not set, no checking of the
17888 response is done, unless the query was defaulted, in which case there is a
17889 check that the text returned after the first white space is the original
17890 address. This checks that the answer that has been received is in response to
17891 the correct question. For example, if the response is just a new domain, the
17892 following could be used:
17893 .code
17894 response_pattern = ^([^@]+)$
17895 reroute = $local_part@$1
17896 .endd
17897
17898 .option timeout iplookup time 5s
17899 This specifies the amount of time to wait for a response from the remote
17900 machine. The same timeout is used for the &[connect()]& function for a TCP
17901 call. It does not apply to UDP.
17902
17903
17904
17905
17906 . ////////////////////////////////////////////////////////////////////////////
17907 . ////////////////////////////////////////////////////////////////////////////
17908
17909 .chapter "The manualroute router" "CHID7"
17910 .scindex IIDmanrou1 "&(manualroute)& router"
17911 .scindex IIDmanrou2 "routers" "&(manualroute)&"
17912 .cindex "domain" "manually routing"
17913 The &(manualroute)& router is so-called because it provides a way of manually
17914 routing an address according to its domain. It is mainly used when you want to
17915 route addresses to remote hosts according to your own rules, bypassing the
17916 normal DNS routing that looks up MX records. However, &(manualroute)& can also
17917 route to local transports, a facility that may be useful if you want to save
17918 messages for dial-in hosts in local files.
17919
17920 The &(manualroute)& router compares a list of domain patterns with the domain
17921 it is trying to route. If there is no match, the router declines. Each pattern
17922 has associated with it a list of hosts and some other optional data, which may
17923 include a transport. The combination of a pattern and its data is called a
17924 &"routing rule"&. For patterns that do not have an associated transport, the
17925 generic &%transport%& option must specify a transport, unless the router is
17926 being used purely for verification (see &%verify_only%&).
17927
17928 .vindex "&$host$&"
17929 In the case of verification, matching the domain pattern is sufficient for the
17930 router to accept the address. When actually routing an address for delivery,
17931 an address that matches a domain pattern is queued for the associated
17932 transport. If the transport is not a local one, a host list must be associated
17933 with the pattern; IP addresses are looked up for the hosts, and these are
17934 passed to the transport along with the mail address. For local transports, a
17935 host list is optional. If it is present, it is passed in &$host$& as a single
17936 text string.
17937
17938 The list of routing rules can be provided as an inline string in
17939 &%route_list%&, or the data can be obtained by looking up the domain in a file
17940 or database by setting &%route_data%&. Only one of these settings may appear in
17941 any one instance of &(manualroute)&. The format of routing rules is described
17942 below, following the list of private options.
17943
17944
17945 .section "Private options for manualroute" "SECTprioptman"
17946
17947 .cindex "options" "&(manualroute)& router"
17948 The private options for the &(manualroute)& router are as follows:
17949
17950 .option host_all_ignored manualroute string defer
17951 See &%host_find_failed%&.
17952
17953 .option host_find_failed manualroute string freeze
17954 This option controls what happens when &(manualroute)& tries to find an IP
17955 address for a host, and the host does not exist. The option can be set to one
17956 of the following values:
17957 .code
17958 decline
17959 defer
17960 fail
17961 freeze
17962 ignore
17963 pass
17964 .endd
17965 The default (&"freeze"&) assumes that this state is a serious configuration
17966 error. The difference between &"pass"& and &"decline"& is that the former
17967 forces the address to be passed to the next router (or the router defined by
17968 &%pass_router%&),
17969 .oindex "&%more%&"
17970 overriding &%no_more%&, whereas the latter passes the address to the next
17971 router only if &%more%& is true.
17972
17973 The value &"ignore"& causes Exim to completely ignore a host whose IP address
17974 cannot be found. If all the hosts in the list are ignored, the behaviour is
17975 controlled by the &%host_all_ignored%& option. This takes the same values
17976 as &%host_find_failed%&, except that it cannot be set to &"ignore"&.
17977
17978 The &%host_find_failed%& option applies only to a definite &"does not exist"&
17979 state; if a host lookup gets a temporary error, delivery is deferred unless the
17980 generic &%pass_on_timeout%& option is set.
17981
17982
17983 .option hosts_randomize manualroute boolean false
17984 .cindex "randomized host list"
17985 .cindex "host" "list of; randomized"
17986 If this option is set, the order of the items in a host list in a routing rule
17987 is randomized each time the list is used, unless an option in the routing rule
17988 overrides (see below). Randomizing the order of a host list can be used to do
17989 crude load sharing. However, if more than one mail address is routed by the
17990 same router to the same host list, the host lists are considered to be the same
17991 (even though they may be randomized into different orders) for the purpose of
17992 deciding whether to batch the deliveries into a single SMTP transaction.
17993
17994 When &%hosts_randomize%& is true, a host list may be split
17995 into groups whose order is separately randomized. This makes it possible to
17996 set up MX-like behaviour. The boundaries between groups are indicated by an
17997 item that is just &`+`& in the host list. For example:
17998 .code
17999 route_list = * host1:host2:host3:+:host4:host5
18000 .endd
18001 The order of the first three hosts and the order of the last two hosts is
18002 randomized for each use, but the first three always end up before the last two.
18003 If &%hosts_randomize%& is not set, a &`+`& item in the list is ignored. If a
18004 randomized host list is passed to an &(smtp)& transport that also has
18005 &%hosts_randomize set%&, the list is not re-randomized.
18006
18007
18008 .option route_data manualroute string&!! unset
18009 If this option is set, it must expand to yield the data part of a routing rule.
18010 Typically, the expansion string includes a lookup based on the domain. For
18011 example:
18012 .code
18013 route_data = ${lookup{$domain}dbm{/etc/routes}}
18014 .endd
18015 If the expansion is forced to fail, or the result is an empty string, the
18016 router declines. Other kinds of expansion failure cause delivery to be
18017 deferred.
18018
18019
18020 .option route_list manualroute "string list" unset
18021 This string is a list of routing rules, in the form defined below. Note that,
18022 unlike most string lists, the items are separated by semicolons. This is so
18023 that they may contain colon-separated host lists.
18024
18025
18026 .option same_domain_copy_routing manualroute boolean false
18027 .cindex "address" "copying routing"
18028 Addresses with the same domain are normally routed by the &(manualroute)&
18029 router to the same list of hosts. However, this cannot be presumed, because the
18030 router options and preconditions may refer to the local part of the address. By
18031 default, therefore, Exim routes each address in a message independently. DNS
18032 servers run caches, so repeated DNS lookups are not normally expensive, and in
18033 any case, personal messages rarely have more than a few recipients.
18034
18035 If you are running mailing lists with large numbers of subscribers at the same
18036 domain, and you are using a &(manualroute)& router which is independent of the
18037 local part, you can set &%same_domain_copy_routing%& to bypass repeated DNS
18038 lookups for identical domains in one message. In this case, when
18039 &(manualroute)& routes an address to a remote transport, any other unrouted
18040 addresses in the message that have the same domain are automatically given the
18041 same routing without processing them independently. However, this is only done
18042 if &%headers_add%& and &%headers_remove%& are unset.
18043
18044
18045
18046
18047 .section "Routing rules in route_list" "SECID120"
18048 The value of &%route_list%& is a string consisting of a sequence of routing
18049 rules, separated by semicolons. If a semicolon is needed in a rule, it can be
18050 entered as two semicolons. Alternatively, the list separator can be changed as
18051 described (for colon-separated lists) in section &<<SECTlistconstruct>>&.
18052 Empty rules are ignored. The format of each rule is
18053 .display
18054 <&'domain pattern'&>  <&'list of hosts'&>  <&'options'&>
18055 .endd
18056 The following example contains two rules, each with a simple domain pattern and
18057 no options:
18058 .code
18059 route_list = \
18060   dict.ref.example  mail-1.ref.example:mail-2.ref.example ; \
18061   thes.ref.example  mail-3.ref.example:mail-4.ref.example
18062 .endd
18063 The three parts of a rule are separated by white space. The pattern and the
18064 list of hosts can be enclosed in quotes if necessary, and if they are, the
18065 usual quoting rules apply. Each rule in a &%route_list%& must start with a
18066 single domain pattern, which is the only mandatory item in the rule. The
18067 pattern is in the same format as one item in a domain list (see section
18068 &<<SECTdomainlist>>&),
18069 except that it may not be the name of an interpolated file.
18070 That is, it may be wildcarded, or a regular expression, or a file or database
18071 lookup (with semicolons doubled, because of the use of semicolon as a separator
18072 in a &%route_list%&).
18073
18074 The rules in &%route_list%& are searched in order until one of the patterns
18075 matches the domain that is being routed. The list of hosts and then options are
18076 then used as described below. If there is no match, the router declines. When
18077 &%route_list%& is set, &%route_data%& must not be set.
18078
18079
18080
18081 .section "Routing rules in route_data" "SECID121"
18082 The use of &%route_list%& is convenient when there are only a small number of
18083 routing rules. For larger numbers, it is easier to use a file or database to
18084 hold the routing information, and use the &%route_data%& option instead.
18085 The value of &%route_data%& is a list of hosts, followed by (optional) options.
18086 Most commonly, &%route_data%& is set as a string that contains an
18087 expansion lookup. For example, suppose we place two routing rules in a file
18088 like this:
18089 .code
18090 dict.ref.example:  mail-1.ref.example:mail-2.ref.example
18091 thes.ref.example:  mail-3.ref.example:mail-4.ref.example
18092 .endd
18093 This data can be accessed by setting
18094 .code
18095 route_data = ${lookup{$domain}lsearch{/the/file/name}}
18096 .endd
18097 Failure of the lookup results in an empty string, causing the router to
18098 decline. However, you do not have to use a lookup in &%route_data%&. The only
18099 requirement is that the result of expanding the string is a list of hosts,
18100 possibly followed by options, separated by white space. The list of hosts must
18101 be enclosed in quotes if it contains white space.
18102
18103
18104
18105
18106 .section "Format of the list of hosts" "SECID122"
18107 A list of hosts, whether obtained via &%route_data%& or &%route_list%&, is
18108 always separately expanded before use. If the expansion fails, the router
18109 declines. The result of the expansion must be a colon-separated list of names
18110 and/or IP addresses, optionally also including ports. The format of each item
18111 in the list is described in the next section. The list separator can be changed
18112 as described in section &<<SECTlistconstruct>>&.
18113
18114 If the list of hosts was obtained from a &%route_list%& item, the following
18115 variables are set during its expansion:
18116
18117 .ilist
18118 .cindex "numerical variables (&$1$& &$2$&  etc)" "in &(manualroute)& router"
18119 If the domain was matched against a regular expression, the numeric variables
18120 &$1$&, &$2$&, etc. may be set. For example:
18121 .code
18122 route_list = ^domain(\d+)   host-$1.text.example
18123 .endd
18124 .next
18125 &$0$& is always set to the entire domain.
18126 .next
18127 &$1$& is also set when partial matching is done in a file lookup.
18128
18129 .next
18130 .vindex "&$value$&"
18131 If the pattern that matched the domain was a lookup item, the data that was
18132 looked up is available in the expansion variable &$value$&. For example:
18133 .code
18134 route_list = lsearch;;/some/file.routes  $value
18135 .endd
18136 .endlist
18137
18138 Note the doubling of the semicolon in the pattern that is necessary because
18139 semicolon is the default route list separator.
18140
18141
18142
18143 .section "Format of one host item" "SECTformatonehostitem"
18144 Each item in the list of hosts is either a host name or an IP address,
18145 optionally with an attached port number. When no port is given, an IP address
18146 is not enclosed in brackets. When a port is specified, it overrides the port
18147 specification on the transport. The port is separated from the name or address
18148 by a colon. This leads to some complications:
18149
18150 .ilist
18151 Because colon is the default separator for the list of hosts, either
18152 the colon that specifies a port must be doubled, or the list separator must
18153 be changed. The following two examples have the same effect:
18154 .code
18155 route_list = * "host1.tld::1225 : host2.tld::1226"
18156 route_list = * "<+ host1.tld:1225 + host2.tld:1226"
18157 .endd
18158 .next
18159 When IPv6 addresses are involved, it gets worse, because they contain
18160 colons of their own. To make this case easier, it is permitted to
18161 enclose an IP address (either v4 or v6) in square brackets if a port
18162 number follows. For example:
18163 .code
18164 route_list = * "</ [10.1.1.1]:1225 / [::1]:1226"
18165 .endd
18166 .endlist
18167
18168 .section "How the list of hosts is used" "SECThostshowused"
18169 When an address is routed to an &(smtp)& transport by &(manualroute)&, each of
18170 the hosts is tried, in the order specified, when carrying out the SMTP
18171 delivery. However, the order can be changed by setting the &%hosts_randomize%&
18172 option, either on the router (see section &<<SECTprioptman>>& above), or on the
18173 transport.
18174
18175 Hosts may be listed by name or by IP address. An unadorned name in the list of
18176 hosts is interpreted as a host name. A name that is followed by &`/MX`& is
18177 interpreted as an indirection to a sublist of hosts obtained by looking up MX
18178 records in the DNS. For example:
18179 .code
18180 route_list = *  x.y.z:p.q.r/MX:e.f.g
18181 .endd
18182 If this feature is used with a port specifier, the port must come last. For
18183 example:
18184 .code
18185 route_list = *  dom1.tld/mx::1225
18186 .endd
18187 If the &%hosts_randomize%& option is set, the order of the items in the list is
18188 randomized before any lookups are done. Exim then scans the list; for any name
18189 that is not followed by &`/MX`& it looks up an IP address. If this turns out to
18190 be an interface on the local host and the item is not the first in the list,
18191 Exim discards it and any subsequent items. If it is the first item, what
18192 happens is controlled by the
18193 .oindex "&%self%&" "in &(manualroute)& router"
18194 &%self%& option of the router.
18195
18196 A name on the list that is followed by &`/MX`& is replaced with the list of
18197 hosts obtained by looking up MX records for the name. This is always a DNS
18198 lookup; the &%bydns%& and &%byname%& options (see section &<<SECThowoptused>>&
18199 below) are not relevant here. The order of these hosts is determined by the
18200 preference values in the MX records, according to the usual rules. Because
18201 randomizing happens before the MX lookup, it does not affect the order that is
18202 defined by MX preferences.
18203
18204 If the local host is present in the sublist obtained from MX records, but is
18205 not the most preferred host in that list, it and any equally or less
18206 preferred hosts are removed before the sublist is inserted into the main list.
18207
18208 If the local host is the most preferred host in the MX list, what happens
18209 depends on where in the original list of hosts the &`/MX`& item appears. If it
18210 is not the first item (that is, there are previous hosts in the main list),
18211 Exim discards this name and any subsequent items in the main list.
18212
18213 If the MX item is first in the list of hosts, and the local host is the
18214 most preferred host, what happens is controlled by the &%self%& option of the
18215 router.
18216
18217 DNS failures when lookup up the MX records are treated in the same way as DNS
18218 failures when looking up IP addresses: &%pass_on_timeout%& and
18219 &%host_find_failed%& are used when relevant.
18220
18221 The generic &%ignore_target_hosts%& option applies to all hosts in the list,
18222 whether obtained from an MX lookup or not.
18223
18224
18225
18226 .section "How the options are used" "SECThowoptused"
18227 The options are a sequence of words; in practice no more than three are ever
18228 present. One of the words can be the name of a transport; this overrides the
18229 &%transport%& option on the router for this particular routing rule only. The
18230 other words (if present) control randomization of the list of hosts on a
18231 per-rule basis, and how the IP addresses of the hosts are to be found when
18232 routing to a remote transport. These options are as follows:
18233
18234 .ilist
18235 &%randomize%&: randomize the order of the hosts in this list, overriding the
18236 setting of &%hosts_randomize%& for this routing rule only.
18237 .next
18238 &%no_randomize%&: do not randomize the order of the hosts in this list,
18239 overriding the setting of &%hosts_randomize%& for this routing rule only.
18240 .next
18241 &%byname%&: use &[getipnodebyname()]& (&[gethostbyname()]& on older systems) to
18242 find IP addresses. This function may ultimately cause a DNS lookup, but it may
18243 also look in &_/etc/hosts_& or other sources of information.
18244 .next
18245 &%bydns%&: look up address records for the hosts directly in the DNS; fail if
18246 no address records are found. If there is a temporary DNS error (such as a
18247 timeout), delivery is deferred.
18248 .endlist
18249
18250 For example:
18251 .code
18252 route_list = domain1  host1:host2:host3  randomize bydns;\
18253              domain2  host4:host5
18254 .endd
18255 If neither &%byname%& nor &%bydns%& is given, Exim behaves as follows: First, a
18256 DNS lookup is done. If this yields anything other than HOST_NOT_FOUND, that
18257 result is used. Otherwise, Exim goes on to try a call to &[getipnodebyname()]&
18258 or &[gethostbyname()]&, and the result of the lookup is the result of that
18259 call.
18260
18261 &*Warning*&: It has been discovered that on some systems, if a DNS lookup
18262 called via &[getipnodebyname()]& times out, HOST_NOT_FOUND is returned
18263 instead of TRY_AGAIN. That is why the default action is to try a DNS
18264 lookup first. Only if that gives a definite &"no such host"& is the local
18265 function called.
18266
18267
18268
18269 If no IP address for a host can be found, what happens is controlled by the
18270 &%host_find_failed%& option.
18271
18272 .vindex "&$host$&"
18273 When an address is routed to a local transport, IP addresses are not looked up.
18274 The host list is passed to the transport in the &$host$& variable.
18275
18276
18277
18278 .section "Manualroute examples" "SECID123"
18279 In some of the examples that follow, the presence of the &%remote_smtp%&
18280 transport, as defined in the default configuration file, is assumed:
18281
18282 .ilist
18283 .cindex "smart host" "example router"
18284 The &(manualroute)& router can be used to forward all external mail to a
18285 &'smart host'&. If you have set up, in the main part of the configuration, a
18286 named domain list that contains your local domains, for example:
18287 .code
18288 domainlist local_domains = my.domain.example
18289 .endd
18290 You can arrange for all other domains to be routed to a smart host by making
18291 your first router something like this:
18292 .code
18293 smart_route:
18294   driver = manualroute
18295   domains = !+local_domains
18296   transport = remote_smtp
18297   route_list = * smarthost.ref.example
18298 .endd
18299 This causes all non-local addresses to be sent to the single host
18300 &'smarthost.ref.example'&. If a colon-separated list of smart hosts is given,
18301 they are tried in order
18302 (but you can use &%hosts_randomize%& to vary the order each time).
18303 Another way of configuring the same thing is this:
18304 .code
18305 smart_route:
18306   driver = manualroute
18307   transport = remote_smtp
18308   route_list = !+local_domains  smarthost.ref.example
18309 .endd
18310 There is no difference in behaviour between these two routers as they stand.
18311 However, they behave differently if &%no_more%& is added to them. In the first
18312 example, the router is skipped if the domain does not match the &%domains%&
18313 precondition; the following router is always tried. If the router runs, it
18314 always matches the domain and so can never decline. Therefore, &%no_more%&
18315 would have no effect. In the second case, the router is never skipped; it
18316 always runs. However, if it doesn't match the domain, it declines. In this case
18317 &%no_more%& would prevent subsequent routers from running.
18318
18319 .next
18320 .cindex "mail hub example"
18321 A &'mail hub'& is a host which receives mail for a number of domains via MX
18322 records in the DNS and delivers it via its own private routing mechanism. Often
18323 the final destinations are behind a firewall, with the mail hub being the one
18324 machine that can connect to machines both inside and outside the firewall. The
18325 &(manualroute)& router is usually used on a mail hub to route incoming messages
18326 to the correct hosts. For a small number of domains, the routing can be inline,
18327 using the &%route_list%& option, but for a larger number a file or database
18328 lookup is easier to manage.
18329
18330 If the domain names are in fact the names of the machines to which the mail is
18331 to be sent by the mail hub, the configuration can be quite simple. For
18332 example:
18333 .code
18334 hub_route:
18335   driver = manualroute
18336   transport = remote_smtp
18337   route_list = *.rhodes.tvs.example  $domain
18338 .endd
18339 This configuration routes domains that match &`*.rhodes.tvs.example`& to hosts
18340 whose names are the same as the mail domains. A similar approach can be taken
18341 if the host name can be obtained from the domain name by a string manipulation
18342 that the expansion facilities can handle. Otherwise, a lookup based on the
18343 domain can be used to find the host:
18344 .code
18345 through_firewall:
18346   driver = manualroute
18347   transport = remote_smtp
18348   route_data = ${lookup {$domain} cdb {/internal/host/routes}}
18349 .endd
18350 The result of the lookup must be the name or IP address of the host (or
18351 hosts) to which the address is to be routed. If the lookup fails, the route
18352 data is empty, causing the router to decline. The address then passes to the
18353 next router.
18354
18355 .next
18356 .cindex "batched SMTP output example"
18357 .cindex "SMTP" "batched outgoing; example"
18358 You can use &(manualroute)& to deliver messages to pipes or files in batched
18359 SMTP format for onward transportation by some other means. This is one way of
18360 storing mail for a dial-up host when it is not connected. The route list entry
18361 can be as simple as a single domain name in a configuration like this:
18362 .code
18363 save_in_file:
18364   driver = manualroute
18365   transport = batchsmtp_appendfile
18366   route_list = saved.domain.example
18367 .endd
18368 though often a pattern is used to pick up more than one domain. If there are
18369 several domains or groups of domains with different transport requirements,
18370 different transports can be listed in the routing information:
18371 .code
18372 save_in_file:
18373   driver = manualroute
18374   route_list = \
18375     *.saved.domain1.example  $domain  batch_appendfile; \
18376     *.saved.domain2.example  \
18377       ${lookup{$domain}dbm{/domain2/hosts}{$value}fail} \
18378       batch_pipe
18379 .endd
18380 .vindex "&$domain$&"
18381 .vindex "&$host$&"
18382 The first of these just passes the domain in the &$host$& variable, which
18383 doesn't achieve much (since it is also in &$domain$&), but the second does a
18384 file lookup to find a value to pass, causing the router to decline to handle
18385 the address if the lookup fails.
18386
18387 .next
18388 .cindex "UUCP" "example of router for"
18389 Routing mail directly to UUCP software is a specific case of the use of
18390 &(manualroute)& in a gateway to another mail environment. This is an example of
18391 one way it can be done:
18392 .code
18393 # Transport
18394 uucp:
18395   driver = pipe
18396   user = nobody
18397   command = /usr/local/bin/uux -r - \
18398     ${substr_-5:$host}!rmail ${local_part}
18399   return_fail_output = true
18400
18401 # Router
18402 uucphost:
18403   transport = uucp
18404   driver = manualroute
18405   route_data = \
18406     ${lookup{$domain}lsearch{/usr/local/exim/uucphosts}}
18407 .endd
18408 The file &_/usr/local/exim/uucphosts_& contains entries like
18409 .code
18410 darksite.ethereal.example:           darksite.UUCP
18411 .endd
18412 It can be set up more simply without adding and removing &".UUCP"& but this way
18413 makes clear the distinction between the domain name
18414 &'darksite.ethereal.example'& and the UUCP host name &'darksite'&.
18415 .endlist
18416 .ecindex IIDmanrou1
18417 .ecindex IIDmanrou2
18418
18419
18420
18421
18422
18423
18424
18425
18426 . ////////////////////////////////////////////////////////////////////////////
18427 . ////////////////////////////////////////////////////////////////////////////
18428
18429 .chapter "The queryprogram router" "CHAPdriverlast"
18430 .scindex IIDquerou1 "&(queryprogram)& router"
18431 .scindex IIDquerou2 "routers" "&(queryprogram)&"
18432 .cindex "routing" "by external program"
18433 The &(queryprogram)& router routes an address by running an external command
18434 and acting on its output. This is an expensive way to route, and is intended
18435 mainly for use in lightly-loaded systems, or for performing experiments.
18436 However, if it is possible to use the precondition options (&%domains%&,
18437 &%local_parts%&, etc) to skip this router for most addresses, it could sensibly
18438 be used in special cases, even on a busy host. There are the following private
18439 options:
18440 .cindex "options" "&(queryprogram)& router"
18441
18442 .option command queryprogram string&!! unset
18443 This option must be set. It specifies the command that is to be run. The
18444 command is split up into a command name and arguments, and then each is
18445 expanded separately (exactly as for a &(pipe)& transport, described in chapter
18446 &<<CHAPpipetransport>>&).
18447
18448
18449 .option command_group queryprogram string unset
18450 .cindex "gid (group id)" "in &(queryprogram)& router"
18451 This option specifies a gid to be set when running the command while routing an
18452 address for deliver. It must be set if &%command_user%& specifies a numerical
18453 uid. If it begins with a digit, it is interpreted as the numerical value of the
18454 gid. Otherwise it is looked up using &[getgrnam()]&.
18455
18456
18457 .option command_user queryprogram string unset
18458 .cindex "uid (user id)" "for &(queryprogram)&"
18459 This option must be set. It specifies the uid which is set when running the
18460 command while routing an address for delivery. If the value begins with a digit,
18461 it is interpreted as the numerical value of the uid. Otherwise, it is looked up
18462 using &[getpwnam()]& to obtain a value for the uid and, if &%command_group%& is
18463 not set, a value for the gid also.
18464
18465 &*Warning:*& Changing uid and gid is possible only when Exim is running as
18466 root, which it does during a normal delivery in a conventional configuration.
18467 However, when an address is being verified during message reception, Exim is
18468 usually running as the Exim user, not as root. If the &(queryprogram)& router
18469 is called from a non-root process, Exim cannot change uid or gid before running
18470 the command. In this circumstance the command runs under the current uid and
18471 gid.
18472
18473
18474 .option current_directory queryprogram string /
18475 This option specifies an absolute path which is made the current directory
18476 before running the command.
18477
18478
18479 .option timeout queryprogram time 1h
18480 If the command does not complete within the timeout period, its process group
18481 is killed and the message is frozen. A value of zero time specifies no
18482 timeout.
18483
18484
18485 The standard output of the command is connected to a pipe, which is read when
18486 the command terminates. It should consist of a single line of output,
18487 containing up to five fields, separated by white space. The maximum length of
18488 the line is 1023 characters. Longer lines are silently truncated. The first
18489 field is one of the following words (case-insensitive):
18490
18491 .ilist
18492 &'Accept'&: routing succeeded; the remaining fields specify what to do (see
18493 below).
18494 .next
18495 &'Decline'&: the router declines; pass the address to the next router, unless
18496 &%no_more%& is set.
18497 .next
18498 &'Fail'&: routing failed; do not pass the address to any more routers. Any
18499 subsequent text on the line is an error message. If the router is run as part
18500 of address verification during an incoming SMTP message, the message is
18501 included in the SMTP response.
18502 .next
18503 &'Defer'&: routing could not be completed at this time; try again later. Any
18504 subsequent text on the line is an error message which is logged. It is not
18505 included in any SMTP response.
18506 .next
18507 &'Freeze'&: the same as &'defer'&, except that the message is frozen.
18508 .next
18509 &'Pass'&: pass the address to the next router (or the router specified by
18510 &%pass_router%&), overriding &%no_more%&.
18511 .next
18512 &'Redirect'&: the message is redirected. The remainder of the line is a list of
18513 new addresses, which are routed independently, starting with the first router,
18514 or the router specified by &%redirect_router%&, if set.
18515 .endlist
18516
18517 When the first word is &'accept'&, the remainder of the line consists of a
18518 number of keyed data values, as follows (split into two lines here, to fit on
18519 the page):
18520 .code
18521 ACCEPT TRANSPORT=<transport> HOSTS=<list of hosts>
18522 LOOKUP=byname|bydns DATA=<text>
18523 .endd
18524 The data items can be given in any order, and all are optional. If no transport
18525 is included, the transport specified by the generic &%transport%& option is
18526 used. The list of hosts and the lookup type are needed only if the transport is
18527 an &(smtp)& transport that does not itself supply a list of hosts.
18528
18529 The format of the list of hosts is the same as for the &(manualroute)& router.
18530 As well as host names and IP addresses with optional port numbers, as described
18531 in section &<<SECTformatonehostitem>>&, it may contain names followed by
18532 &`/MX`& to specify sublists of hosts that are obtained by looking up MX records
18533 (see section &<<SECThostshowused>>&).
18534
18535 If the lookup type is not specified, Exim behaves as follows when trying to
18536 find an IP address for each host: First, a DNS lookup is done. If this yields
18537 anything other than HOST_NOT_FOUND, that result is used. Otherwise, Exim
18538 goes on to try a call to &[getipnodebyname()]& or &[gethostbyname()]&, and the
18539 result of the lookup is the result of that call.
18540
18541 .vindex "&$address_data$&"
18542 If the DATA field is set, its value is placed in the &$address_data$&
18543 variable. For example, this return line
18544 .code
18545 accept hosts=x1.y.example:x2.y.example data="rule1"
18546 .endd
18547 routes the address to the default transport, passing a list of two hosts. When
18548 the transport runs, the string &"rule1"& is in &$address_data$&.
18549 .ecindex IIDquerou1
18550 .ecindex IIDquerou2
18551
18552
18553
18554
18555 . ////////////////////////////////////////////////////////////////////////////
18556 . ////////////////////////////////////////////////////////////////////////////
18557
18558 .chapter "The redirect router" "CHAPredirect"
18559 .scindex IIDredrou1 "&(redirect)& router"
18560 .scindex IIDredrou2 "routers" "&(redirect)&"
18561 .cindex "alias file" "in a &(redirect)& router"
18562 .cindex "address redirection" "&(redirect)& router"
18563 The &(redirect)& router handles several kinds of address redirection. Its most
18564 common uses are for resolving local part aliases from a central alias file
18565 (usually called &_/etc/aliases_&) and for handling users' personal &_.forward_&
18566 files, but it has many other potential uses. The incoming address can be
18567 redirected in several different ways:
18568
18569 .ilist
18570 It can be replaced by one or more new addresses which are themselves routed
18571 independently.
18572 .next
18573 It can be routed to be delivered to a given file or directory.
18574 .next
18575 It can be routed to be delivered to a specified pipe command.
18576 .next
18577 It can cause an automatic reply to be generated.
18578 .next
18579 It can be forced to fail, optionally with a custom error message.
18580 .next
18581 It can be temporarily deferred, optionally with a custom message.
18582 .next
18583 It can be discarded.
18584 .endlist
18585
18586 The generic &%transport%& option must not be set for &(redirect)& routers.
18587 However, there are some private options which define transports for delivery to
18588 files and pipes, and for generating autoreplies. See the &%file_transport%&,
18589 &%pipe_transport%& and &%reply_transport%& descriptions below.
18590
18591
18592
18593 .section "Redirection data" "SECID124"
18594 The router operates by interpreting a text string which it obtains either by
18595 expanding the contents of the &%data%& option, or by reading the entire
18596 contents of a file whose name is given in the &%file%& option. These two
18597 options are mutually exclusive. The first is commonly used for handling system
18598 aliases, in a configuration like this:
18599 .code
18600 system_aliases:
18601   driver = redirect
18602   data = ${lookup{$local_part}lsearch{/etc/aliases}}
18603 .endd
18604 If the lookup fails, the expanded string in this example is empty. When the
18605 expansion of &%data%& results in an empty string, the router declines. A forced
18606 expansion failure also causes the router to decline; other expansion failures
18607 cause delivery to be deferred.
18608
18609 A configuration using &%file%& is commonly used for handling users'
18610 &_.forward_& files, like this:
18611 .code
18612 userforward:
18613   driver = redirect
18614   check_local_user
18615   file = $home/.forward
18616   no_verify
18617 .endd
18618 If the file does not exist, or causes no action to be taken (for example, it is
18619 empty or consists only of comments), the router declines. &*Warning*&: This
18620 is not the case when the file contains syntactically valid items that happen to
18621 yield empty addresses, for example, items containing only RFC 2822 address
18622 comments.
18623
18624
18625
18626 .section "Forward files and address verification" "SECID125"
18627 .cindex "address redirection" "while verifying"
18628 It is usual to set &%no_verify%& on &(redirect)& routers which handle users'
18629 &_.forward_& files, as in the example above. There are two reasons for this:
18630
18631 .ilist
18632 When Exim is receiving an incoming SMTP message from a remote host, it is
18633 running under the Exim uid, not as root. Exim is unable to change uid to read
18634 the file as the user, and it may not be able to read it as the Exim user. So in
18635 practice the router may not be able to operate.
18636 .next
18637 However, even when the router can operate, the existence of a &_.forward_& file
18638 is unimportant when verifying an address. What should be checked is whether the
18639 local part is a valid user name or not. Cutting out the redirection processing
18640 saves some resources.
18641 .endlist
18642
18643
18644
18645
18646
18647
18648 .section "Interpreting redirection data" "SECID126"
18649 .cindex "Sieve filter" "specifying in redirection data"
18650 .cindex "filter" "specifying in redirection data"
18651 The contents of the data string, whether obtained from &%data%& or &%file%&,
18652 can be interpreted in two different ways:
18653
18654 .ilist
18655 If the &%allow_filter%& option is set true, and the data begins with the text
18656 &"#Exim filter"& or &"#Sieve filter"&, it is interpreted as a list of
18657 &'filtering'& instructions in the form of an Exim or Sieve filter file,
18658 respectively. Details of the syntax and semantics of filter files are described
18659 in a separate document entitled &'Exim's interfaces to mail filtering'&; this
18660 document is intended for use by end users.
18661 .next
18662 Otherwise, the data must be a comma-separated list of redirection items, as
18663 described in the next section.
18664 .endlist
18665
18666 When a message is redirected to a file (a &"mail folder"&), the file name given
18667 in a non-filter redirection list must always be an absolute path. A filter may
18668 generate a relative path &-- how this is handled depends on the transport's
18669 configuration. See section &<<SECTfildiropt>>& for a discussion of this issue
18670 for the &(appendfile)& transport.
18671
18672
18673
18674 .section "Items in a non-filter redirection list" "SECTitenonfilred"
18675 .cindex "address redirection" "non-filter list items"
18676 When the redirection data is not an Exim or Sieve filter, for example, if it
18677 comes from a conventional alias or forward file, it consists of a list of
18678 addresses, file names, pipe commands, or certain special items (see section
18679 &<<SECTspecitredli>>& below). The special items can be individually enabled or
18680 disabled by means of options whose names begin with &%allow_%& or &%forbid_%&,
18681 depending on their default values. The items in the list are separated by
18682 commas or newlines.
18683 If a comma is required in an item, the entire item must be enclosed in double
18684 quotes.
18685
18686 Lines starting with a # character are comments, and are ignored, and # may
18687 also appear following a comma, in which case everything between the # and the
18688 next newline character is ignored.
18689
18690 If an item is entirely enclosed in double quotes, these are removed. Otherwise
18691 double quotes are retained because some forms of mail address require their use
18692 (but never to enclose the entire address). In the following description,
18693 &"item"& refers to what remains after any surrounding double quotes have been
18694 removed.
18695
18696 .vindex "&$local_part$&"
18697 &*Warning*&: If you use an Exim expansion to construct a redirection address,
18698 and the expansion contains a reference to &$local_part$&, you should make use
18699 of the &%quote_local_part%& expansion operator, in case the local part contains
18700 special characters. For example, to redirect all mail for the domain
18701 &'obsolete.example'&, retaining the existing local part, you could use this
18702 setting:
18703 .code
18704 data = ${quote_local_part:$local_part}@newdomain.example
18705 .endd
18706
18707
18708 .section "Redirecting to a local mailbox" "SECTredlocmai"
18709 .cindex "routing" "loops in"
18710 .cindex "loop" "while routing, avoidance of"
18711 .cindex "address redirection" "to local mailbox"
18712 A redirection item may safely be the same as the address currently under
18713 consideration. This does not cause a routing loop, because a router is
18714 automatically skipped if any ancestor of the address that is being processed
18715 is the same as the current address and was processed by the current router.
18716 Such an address is therefore passed to the following routers, so it is handled
18717 as if there were no redirection. When making this loop-avoidance test, the
18718 complete local part, including any prefix or suffix, is used.
18719
18720 .cindex "address redirection" "local part without domain"
18721 Specifying the same local part without a domain is a common usage in personal
18722 filter files when the user wants to have messages delivered to the local
18723 mailbox and also forwarded elsewhere. For example, the user whose login is
18724 &'cleo'& might have a &_.forward_& file containing this:
18725 .code
18726 cleo, cleopatra@egypt.example
18727 .endd
18728 .cindex "backslash in alias file"
18729 .cindex "alias file" "backslash in"
18730 For compatibility with other MTAs, such unqualified local parts may be
18731 preceded by &"\"&, but this is not a requirement for loop prevention. However,
18732 it does make a difference if more than one domain is being handled
18733 synonymously.
18734
18735 If an item begins with &"\"& and the rest of the item parses as a valid RFC
18736 2822 address that does not include a domain, the item is qualified using the
18737 domain of the incoming address. In the absence of a leading &"\"&, unqualified
18738 addresses are qualified using the value in &%qualify_recipient%&, but you can
18739 force the incoming domain to be used by setting &%qualify_preserve_domain%&.
18740
18741 Care must be taken if there are alias names for local users.
18742 Consider an MTA handling a single local domain where the system alias file
18743 contains:
18744 .code
18745 Sam.Reman: spqr
18746 .endd
18747 Now suppose that Sam (whose login id is &'spqr'&) wants to save copies of
18748 messages in the local mailbox, and also forward copies elsewhere. He creates
18749 this forward file:
18750 .code
18751 Sam.Reman, spqr@reme.elsewhere.example
18752 .endd
18753 With these settings, an incoming message addressed to &'Sam.Reman'& fails. The
18754 &(redirect)& router for system aliases does not process &'Sam.Reman'& the
18755 second time round, because it has previously routed it,
18756 and the following routers presumably cannot handle the alias. The forward file
18757 should really contain
18758 .code
18759 spqr, spqr@reme.elsewhere.example
18760 .endd
18761 but because this is such a common error, the &%check_ancestor%& option (see
18762 below) exists to provide a way to get round it. This is normally set on a
18763 &(redirect)& router that is handling users' &_.forward_& files.
18764
18765
18766
18767 .section "Special items in redirection lists" "SECTspecitredli"
18768 In addition to addresses, the following types of item may appear in redirection
18769 lists (that is, in non-filter redirection data):
18770
18771 .ilist
18772 .cindex "pipe" "in redirection list"
18773 .cindex "address redirection" "to pipe"
18774 An item is treated as a pipe command if it begins with &"|"& and does not parse
18775 as a valid RFC 2822 address that includes a domain. A transport for running the
18776 command must be specified by the &%pipe_transport%& option.
18777 Normally, either the router or the transport specifies a user and a group under
18778 which to run the delivery. The default is to use the Exim user and group.
18779
18780 Single or double quotes can be used for enclosing the individual arguments of
18781 the pipe command; no interpretation of escapes is done for single quotes. If
18782 the command contains a comma character, it is necessary to put the whole item
18783 in double quotes, for example:
18784 .code
18785 "|/some/command ready,steady,go"
18786 .endd
18787 since items in redirection lists are terminated by commas. Do not, however,
18788 quote just the command. An item such as
18789 .code
18790 |"/some/command ready,steady,go"
18791 .endd
18792 is interpreted as a pipe with a rather strange command name, and no arguments.
18793
18794 Note that the above example assumes that the text comes from a lookup source
18795 of some sort, so that the quotes are part of the data.  If composing a
18796 redirect router with a &%data%& option directly specifying this command, the
18797 quotes will be used by the configuration parser to define the extent of one
18798 string, but will not be passed down into the redirect router itself.  There
18799 are two main approaches to get around this: escape quotes to be part of the
18800 data itself, or avoid using this mechanism and instead create a custom
18801 transport with the &%command%& option set and reference that transport from
18802 an &%accept%& router.
18803
18804 .next
18805 .cindex "file" "in redirection list"
18806 .cindex "address redirection" "to file"
18807 An item is interpreted as a path name if it begins with &"/"& and does not
18808 parse as a valid RFC 2822 address that includes a domain. For example,
18809 .code
18810 /home/world/minbari
18811 .endd
18812 is treated as a file name, but
18813 .code
18814 /s=molari/o=babylon/@x400gate.way
18815 .endd
18816 is treated as an address. For a file name, a transport must be specified using
18817 the &%file_transport%& option. However, if the generated path name ends with a
18818 forward slash character, it is interpreted as a directory name rather than a
18819 file name, and &%directory_transport%& is used instead.
18820
18821 Normally, either the router or the transport specifies a user and a group under
18822 which to run the delivery. The default is to use the Exim user and group.
18823
18824 .cindex "&_/dev/null_&"
18825 However, if a redirection item is the path &_/dev/null_&, delivery to it is
18826 bypassed at a high level, and the log entry shows &"**bypassed**"&
18827 instead of a transport name. In this case the user and group are not used.
18828
18829 .next
18830 .cindex "included address list"
18831 .cindex "address redirection" "included external list"
18832 If an item is of the form
18833 .code
18834 :include:<path name>
18835 .endd
18836 a list of further items is taken from the given file and included at that
18837 point. &*Note*&: Such a file can not be a filter file; it is just an
18838 out-of-line addition to the list. The items in the included list are separated
18839 by commas or newlines and are not subject to expansion. If this is the first
18840 item in an alias list in an &(lsearch)& file, a colon must be used to terminate
18841 the alias name. This example is incorrect:
18842 .code
18843 list1    :include:/opt/lists/list1
18844 .endd
18845 It must be given as
18846 .code
18847 list1:   :include:/opt/lists/list1
18848 .endd
18849 .next
18850 .cindex "address redirection" "to black hole"
18851 Sometimes you want to throw away mail to a particular local part. Making the
18852 &%data%& option expand to an empty string does not work, because that causes
18853 the router to decline. Instead, the alias item
18854 .cindex "black hole"
18855 .cindex "abandoning mail"
18856 &':blackhole:'& can be used. It does what its name implies. No delivery is
18857 done, and no error message is generated. This has the same effect as specifing
18858 &_/dev/null_& as a destination, but it can be independently disabled.
18859
18860 &*Warning*&: If &':blackhole:'& appears anywhere in a redirection list, no
18861 delivery is done for the original local part, even if other redirection items
18862 are present. If you are generating a multi-item list (for example, by reading a
18863 database) and need the ability to provide a no-op item, you must use
18864 &_/dev/null_&.
18865
18866 .next
18867 .cindex "delivery" "forcing failure"
18868 .cindex "delivery" "forcing deferral"
18869 .cindex "failing delivery" "forcing"
18870 .cindex "deferred delivery, forcing"
18871 .cindex "customizing" "failure message"
18872 An attempt to deliver a particular address can be deferred or forced to fail by
18873 redirection items of the form
18874 .code
18875 :defer:
18876 :fail:
18877 .endd
18878 respectively. When a redirection list contains such an item, it applies
18879 to the entire redirection; any other items in the list are ignored. Any
18880 text following &':fail:'& or &':defer:'& is placed in the error text
18881 associated with the failure. For example, an alias file might contain:
18882 .code
18883 X.Employee:  :fail: Gone away, no forwarding address
18884 .endd
18885 In the case of an address that is being verified from an ACL or as the subject
18886 of a
18887 .cindex "VRFY" "error text, display of"
18888 VRFY command, the text is included in the SMTP error response by
18889 default.
18890 .cindex "EXPN" "error text, display of"
18891 The text is not included in the response to an EXPN command. In non-SMTP cases
18892 the text is included in the error message that Exim generates.
18893
18894 .cindex "SMTP" "error codes"
18895 By default, Exim sends a 451 SMTP code for a &':defer:'&, and 550 for
18896 &':fail:'&. However, if the message starts with three digits followed by a
18897 space, optionally followed by an extended code of the form &'n.n.n'&, also
18898 followed by a space, and the very first digit is the same as the default error
18899 code, the code from the message is used instead. If the very first digit is
18900 incorrect, a panic error is logged, and the default code is used. You can
18901 suppress the use of the supplied code in a redirect router by setting the
18902 &%forbid_smtp_code%& option true. In this case, any SMTP code is quietly
18903 ignored.
18904
18905 .vindex "&$acl_verify_message$&"
18906 In an ACL, an explicitly provided message overrides the default, but the
18907 default message is available in the variable &$acl_verify_message$& and can
18908 therefore be included in a custom message if this is desired.
18909
18910 Normally the error text is the rest of the redirection list &-- a comma does
18911 not terminate it &-- but a newline does act as a terminator. Newlines are not
18912 normally present in alias expansions. In &(lsearch)& lookups they are removed
18913 as part of the continuation process, but they may exist in other kinds of
18914 lookup and in &':include:'& files.
18915
18916 During routing for message delivery (as opposed to verification), a redirection
18917 containing &':fail:'& causes an immediate failure of the incoming address,
18918 whereas &':defer:'& causes the message to remain on the queue so that a
18919 subsequent delivery attempt can happen at a later time. If an address is
18920 deferred for too long, it will ultimately fail, because the normal retry
18921 rules still apply.
18922
18923 .next
18924 .cindex "alias file" "exception to default"
18925 Sometimes it is useful to use a single-key search type with a default (see
18926 chapter &<<CHAPfdlookup>>&) to look up aliases. However, there may be a need
18927 for exceptions to the default. These can be handled by aliasing them to
18928 &':unknown:'&. This differs from &':fail:'& in that it causes the &(redirect)&
18929 router to decline, whereas &':fail:'& forces routing to fail. A lookup which
18930 results in an empty redirection list has the same effect.
18931 .endlist
18932
18933
18934 .section "Duplicate addresses" "SECTdupaddr"
18935 .cindex "duplicate addresses"
18936 .cindex "address duplicate, discarding"
18937 .cindex "pipe" "duplicated"
18938 Exim removes duplicate addresses from the list to which it is delivering, so as
18939 to deliver just one copy to each address. This does not apply to deliveries
18940 routed to pipes by different immediate parent addresses, but an indirect
18941 aliasing scheme of the type
18942 .code
18943 pipe:       |/some/command $local_part
18944 localpart1: pipe
18945 localpart2: pipe
18946 .endd
18947 does not work with a message that is addressed to both local parts, because
18948 when the second is aliased to the intermediate local part &"pipe"& it gets
18949 discarded as being the same as a previously handled address. However, a scheme
18950 such as
18951 .code
18952 localpart1: |/some/command $local_part
18953 localpart2: |/some/command $local_part
18954 .endd
18955 does result in two different pipe deliveries, because the immediate parents of
18956 the pipes are distinct.
18957
18958
18959
18960 .section "Repeated redirection expansion" "SECID128"
18961 .cindex "repeated redirection expansion"
18962 .cindex "address redirection" "repeated for each delivery attempt"
18963 When a message cannot be delivered to all of its recipients immediately,
18964 leading to two or more delivery attempts, redirection expansion is carried out
18965 afresh each time for those addresses whose children were not all previously
18966 delivered. If redirection is being used as a mailing list, this can lead to new
18967 members of the list receiving copies of old messages. The &%one_time%& option
18968 can be used to avoid this.
18969
18970
18971 .section "Errors in redirection lists" "SECID129"
18972 .cindex "address redirection" "errors"
18973 If &%skip_syntax_errors%& is set, a malformed address that causes a parsing
18974 error is skipped, and an entry is written to the main log. This may be useful
18975 for mailing lists that are automatically managed. Otherwise, if an error is
18976 detected while generating the list of new addresses, the original address is
18977 deferred. See also &%syntax_errors_to%&.
18978
18979
18980
18981 .section "Private options for the redirect router" "SECID130"
18982
18983 .cindex "options" "&(redirect)& router"
18984 The private options for the &(redirect)& router are as follows:
18985
18986
18987 .option allow_defer redirect boolean false
18988 Setting this option allows the use of &':defer:'& in non-filter redirection
18989 data, or the &%defer%& command in an Exim filter file.
18990
18991
18992 .option allow_fail redirect boolean false
18993 .cindex "failing delivery" "from filter"
18994 If this option is true, the &':fail:'& item can be used in a redirection list,
18995 and the &%fail%& command may be used in an Exim filter file.
18996
18997
18998 .option allow_filter redirect boolean false
18999 .cindex "filter" "enabling use of"
19000 .cindex "Sieve filter" "enabling use of"
19001 Setting this option allows Exim to interpret redirection data that starts with
19002 &"#Exim filter"& or &"#Sieve filter"& as a set of filtering instructions. There
19003 are some features of Exim filter files that some administrators may wish to
19004 lock out; see the &%forbid_filter_%&&'xxx'& options below.
19005
19006 It is also possible to lock out Exim filters or Sieve filters while allowing
19007 the other type; see &%forbid_exim_filter%& and &%forbid_sieve_filter%&.
19008
19009
19010 The filter is run using the uid and gid set by the generic &%user%& and
19011 &%group%& options. These take their defaults from the password data if
19012 &%check_local_user%& is set, so in the normal case of users' personal filter
19013 files, the filter is run as the relevant user. When &%allow_filter%& is set
19014 true, Exim insists that either &%check_local_user%& or &%user%& is set.
19015
19016
19017
19018 .option allow_freeze redirect boolean false
19019 .cindex "freezing messages" "allowing in filter"
19020 Setting this option allows the use of the &%freeze%& command in an Exim filter.
19021 This command is more normally encountered in system filters, and is disabled by
19022 default for redirection filters because it isn't something you usually want to
19023 let ordinary users do.
19024
19025
19026
19027 .option check_ancestor redirect boolean false
19028 This option is concerned with handling generated addresses that are the same
19029 as some address in the list of redirection ancestors of the current address.
19030 Although it is turned off by default in the code, it is set in the default
19031 configuration file for handling users' &_.forward_& files. It is recommended
19032 for this use of the &(redirect)& router.
19033
19034 When &%check_ancestor%& is set, if a generated address (including the domain)
19035 is the same as any ancestor of the current address, it is replaced by a copy of
19036 the current address. This helps in the case where local part A is aliased to B,
19037 and B has a &_.forward_& file pointing back to A. For example, within a single
19038 domain, the local part &"Joe.Bloggs"& is aliased to &"jb"& and
19039 &_&~jb/.forward_& contains:
19040 .code
19041 \Joe.Bloggs, <other item(s)>
19042 .endd
19043 Without the &%check_ancestor%& setting, either local part (&"jb"& or
19044 &"joe.bloggs"&) gets processed once by each router and so ends up as it was
19045 originally. If &"jb"& is the real mailbox name, mail to &"jb"& gets delivered
19046 (having been turned into &"joe.bloggs"& by the &_.forward_& file and back to
19047 &"jb"& by the alias), but mail to &"joe.bloggs"& fails. Setting
19048 &%check_ancestor%& on the &(redirect)& router that handles the &_.forward_&
19049 file prevents it from turning &"jb"& back into &"joe.bloggs"& when that was the
19050 original address. See also the &%repeat_use%& option below.
19051
19052
19053 .option check_group redirect boolean "see below"
19054 When the &%file%& option is used, the group owner of the file is checked only
19055 when this option is set. The permitted groups are those listed in the
19056 &%owngroups%& option, together with the user's default group if
19057 &%check_local_user%& is set. If the file has the wrong group, routing is
19058 deferred. The default setting for this option is true if &%check_local_user%&
19059 is set and the &%modemask%& option permits the group write bit, or if the
19060 &%owngroups%& option is set. Otherwise it is false, and no group check occurs.
19061
19062
19063
19064 .option check_owner redirect boolean "see below"
19065 When the &%file%& option is used, the owner of the file is checked only when
19066 this option is set. If &%check_local_user%& is set, the local user is
19067 permitted; otherwise the owner must be one of those listed in the &%owners%&
19068 option. The default value for this option is true if &%check_local_user%& or
19069 &%owners%& is set. Otherwise the default is false, and no owner check occurs.
19070
19071
19072 .option data redirect string&!! unset
19073 This option is mutually exclusive with &%file%&. One or other of them must be
19074 set, but not both. The contents of &%data%& are expanded, and then used as the
19075 list of forwarding items, or as a set of filtering instructions. If the
19076 expansion is forced to fail, or the result is an empty string or a string that
19077 has no effect (consists entirely of comments), the router declines.
19078
19079 When filtering instructions are used, the string must begin with &"#Exim
19080 filter"&, and all comments in the string, including this initial one, must be
19081 terminated with newline characters. For example:
19082 .code
19083 data = #Exim filter\n\
19084        if $h_to: contains Exim then save $home/mail/exim endif
19085 .endd
19086 If you are reading the data from a database where newlines cannot be included,
19087 you can use the &${sg}$& expansion item to turn the escape string of your
19088 choice into a newline.
19089
19090
19091 .option directory_transport redirect string&!! unset
19092 A &(redirect)& router sets up a direct delivery to a directory when a path name
19093 ending with a slash is specified as a new &"address"&. The transport used is
19094 specified by this option, which, after expansion, must be the name of a
19095 configured transport. This should normally be an &(appendfile)& transport.
19096
19097
19098 .option file redirect string&!! unset
19099 This option specifies the name of a file that contains the redirection data. It
19100 is mutually exclusive with the &%data%& option. The string is expanded before
19101 use; if the expansion is forced to fail, the router declines. Other expansion
19102 failures cause delivery to be deferred. The result of a successful expansion
19103 must be an absolute path. The entire file is read and used as the redirection
19104 data. If the data is an empty string or a string that has no effect (consists
19105 entirely of comments), the router declines.
19106
19107 .cindex "NFS" "checking for file existence"
19108 If the attempt to open the file fails with a &"does not exist"& error, Exim
19109 runs a check on the containing directory,
19110 unless &%ignore_enotdir%& is true (see below).
19111 If the directory does not appear to exist, delivery is deferred. This can
19112 happen when users' &_.forward_& files are in NFS-mounted directories, and there
19113 is a mount problem. If the containing directory does exist, but the file does
19114 not, the router declines.
19115
19116
19117 .option file_transport redirect string&!! unset
19118 .vindex "&$address_file$&"
19119 A &(redirect)& router sets up a direct delivery to a file when a path name not
19120 ending in a slash is specified as a new &"address"&. The transport used is
19121 specified by this option, which, after expansion, must be the name of a
19122 configured transport. This should normally be an &(appendfile)& transport. When
19123 it is running, the file name is in &$address_file$&.
19124
19125
19126 .option filter_prepend_home redirect boolean true
19127 When this option is true, if a &(save)& command in an Exim filter specifies a
19128 relative path, and &$home$& is defined, it is automatically prepended to the
19129 relative path. If this option is set false, this action does not happen. The
19130 relative path is then passed to the transport unmodified.
19131
19132
19133 .option forbid_blackhole redirect boolean false
19134 If this option is true, the &':blackhole:'& item may not appear in a
19135 redirection list.
19136
19137
19138 .option forbid_exim_filter redirect boolean false
19139 If this option is set true, only Sieve filters are permitted when
19140 &%allow_filter%& is true.
19141
19142
19143
19144
19145 .option forbid_file redirect boolean false
19146 .cindex "delivery" "to file; forbidding"
19147 .cindex "Sieve filter" "forbidding delivery to a file"
19148 .cindex "Sieve filter" "&""keep""& facility; disabling"
19149 If this option is true, this router may not generate a new address that
19150 specifies delivery to a local file or directory, either from a filter or from a
19151 conventional forward file. This option is forced to be true if &%one_time%& is
19152 set. It applies to Sieve filters as well as to Exim filters, but if true, it
19153 locks out the Sieve's &"keep"& facility.
19154
19155
19156 .option forbid_filter_dlfunc redirect boolean false
19157 .cindex "filter" "locking out certain features"
19158 If this option is true, string expansions in Exim filters are not allowed to
19159 make use of the &%dlfunc%& expansion facility to run dynamically loaded
19160 functions.
19161
19162 .option forbid_filter_existstest redirect boolean false
19163 .cindex "expansion" "statting a file"
19164 If this option is true, string expansions in Exim filters are not allowed to
19165 make use of the &%exists%& condition or the &%stat%& expansion item.
19166
19167 .option forbid_filter_logwrite redirect boolean false
19168 If this option is true, use of the logging facility in Exim filters is not
19169 permitted. Logging is in any case available only if the filter is being run
19170 under some unprivileged uid (which is normally the case for ordinary users'
19171 &_.forward_& files).
19172
19173
19174 .option forbid_filter_lookup redirect boolean false
19175 If this option is true, string expansions in Exim filter files are not allowed
19176 to make use of &%lookup%& items.
19177
19178
19179 .option forbid_filter_perl redirect boolean false
19180 This option has an effect only if Exim is built with embedded Perl support. If
19181 it is true, string expansions in Exim filter files are not allowed to make use
19182 of the embedded Perl support.
19183
19184
19185 .option forbid_filter_readfile redirect boolean false
19186 If this option is true, string expansions in Exim filter files are not allowed
19187 to make use of &%readfile%& items.
19188
19189
19190 .option forbid_filter_readsocket redirect boolean false
19191 If this option is true, string expansions in Exim filter files are not allowed
19192 to make use of &%readsocket%& items.
19193
19194
19195 .option forbid_filter_reply redirect boolean false
19196 If this option is true, this router may not generate an automatic reply
19197 message. Automatic replies can be generated only from Exim or Sieve filter
19198 files, not from traditional forward files. This option is forced to be true if
19199 &%one_time%& is set.
19200
19201
19202 .option forbid_filter_run redirect boolean false
19203 If this option is true, string expansions in Exim filter files are not allowed
19204 to make use of &%run%& items.
19205
19206
19207 .option forbid_include redirect boolean false
19208 If this option is true, items of the form
19209 .code
19210 :include:<path name>
19211 .endd
19212 are not permitted in non-filter redirection lists.
19213
19214
19215 .option forbid_pipe redirect boolean false
19216 .cindex "delivery" "to pipe; forbidding"
19217 If this option is true, this router may not generate a new address which
19218 specifies delivery to a pipe, either from an Exim filter or from a conventional
19219 forward file. This option is forced to be true if &%one_time%& is set.
19220
19221
19222 .option forbid_sieve_filter redirect boolean false
19223 If this option is set true, only Exim filters are permitted when
19224 &%allow_filter%& is true.
19225
19226
19227 .cindex "SMTP" "error codes"
19228 .option forbid_smtp_code redirect boolean false
19229 If this option is set true, any SMTP error codes that are present at the start
19230 of messages specified for &`:defer:`& or &`:fail:`& are quietly ignored, and
19231 the default codes (451 and 550, respectively) are always used.
19232
19233
19234
19235
19236 .option hide_child_in_errmsg redirect boolean false
19237 .cindex "bounce message" "redirection details; suppressing"
19238 If this option is true, it prevents Exim from quoting a child address if it
19239 generates a bounce or delay message for it. Instead it says &"an address
19240 generated from <&'the top level address'&>"&. Of course, this applies only to
19241 bounces generated locally. If a message is forwarded to another host, &'its'&
19242 bounce may well quote the generated address.
19243
19244
19245 .option ignore_eacces redirect boolean false
19246 .cindex "EACCES"
19247 If this option is set and an attempt to open a redirection file yields the
19248 EACCES error (permission denied), the &(redirect)& router behaves as if the
19249 file did not exist.
19250
19251
19252 .option ignore_enotdir redirect boolean false
19253 .cindex "ENOTDIR"
19254 If this option is set and an attempt to open a redirection file yields the
19255 ENOTDIR error (something on the path is not a directory), the &(redirect)&
19256 router behaves as if the file did not exist.
19257
19258 Setting &%ignore_enotdir%& has another effect as well: When a &(redirect)&
19259 router that has the &%file%& option set discovers that the file does not exist
19260 (the ENOENT error), it tries to &[stat()]& the parent directory, as a check
19261 against unmounted NFS directories. If the parent can not be statted, delivery
19262 is deferred. However, it seems wrong to do this check when &%ignore_enotdir%&
19263 is set, because that option tells Exim to ignore &"something on the path is not
19264 a directory"& (the ENOTDIR error). This is a confusing area, because it seems
19265 that some operating systems give ENOENT where others give ENOTDIR.
19266
19267
19268
19269 .option include_directory redirect string unset
19270 If this option is set, the path names of any &':include:'& items in a
19271 redirection list must start with this directory.
19272
19273
19274 .option modemask redirect "octal integer" 022
19275 This specifies mode bits which must not be set for a file specified by the
19276 &%file%& option. If any of the forbidden bits are set, delivery is deferred.
19277
19278
19279 .option one_time redirect boolean false
19280 .cindex "one-time aliasing/forwarding expansion"
19281 .cindex "alias file" "one-time expansion"
19282 .cindex "forward file" "one-time expansion"
19283 .cindex "mailing lists" "one-time expansion"
19284 .cindex "address redirection" "one-time expansion"
19285 Sometimes the fact that Exim re-evaluates aliases and reprocesses redirection
19286 files each time it tries to deliver a message causes a problem when one or more
19287 of the generated addresses fails be delivered at the first attempt. The problem
19288 is not one of duplicate delivery &-- Exim is clever enough to handle that &--
19289 but of what happens when the redirection list changes during the time that the
19290 message is on Exim's queue. This is particularly true in the case of mailing
19291 lists, where new subscribers might receive copies of messages that were posted
19292 before they subscribed.
19293
19294 If &%one_time%& is set and any addresses generated by the router fail to
19295 deliver at the first attempt, the failing addresses are added to the message as
19296 &"top level"& addresses, and the parent address that generated them is marked
19297 &"delivered"&. Thus, redirection does not happen again at the next delivery
19298 attempt.
19299
19300 &*Warning 1*&: Any header line addition or removal that is specified by this
19301 router would be lost if delivery did not succeed at the first attempt. For this
19302 reason, the &%headers_add%& and &%headers_remove%& generic options are not
19303 permitted when &%one_time%& is set.
19304
19305 &*Warning 2*&: To ensure that the router generates only addresses (as opposed
19306 to pipe or file deliveries or auto-replies) &%forbid_file%&, &%forbid_pipe%&,
19307 and &%forbid_filter_reply%& are forced to be true when &%one_time%& is set.
19308
19309 &*Warning 3*&: The &%unseen%& generic router option may not be set with
19310 &%one_time%&.
19311
19312 The original top-level address is remembered with each of the generated
19313 addresses, and is output in any log messages. However, any intermediate parent
19314 addresses are not recorded. This makes a difference to the log only if
19315 &%all_parents%& log selector is set. It is expected that &%one_time%& will
19316 typically be used for mailing lists, where there is normally just one level of
19317 expansion.
19318
19319
19320 .option owners redirect "string list" unset
19321 .cindex "ownership" "alias file"
19322 .cindex "ownership" "forward file"
19323 .cindex "alias file" "ownership"
19324 .cindex "forward file" "ownership"
19325 This specifies a list of permitted owners for the file specified by &%file%&.
19326 This list is in addition to the local user when &%check_local_user%& is set.
19327 See &%check_owner%& above.
19328
19329
19330 .option owngroups redirect "string list" unset
19331 This specifies a list of permitted groups for the file specified by &%file%&.
19332 The list is in addition to the local user's primary group when
19333 &%check_local_user%& is set. See &%check_group%& above.
19334
19335
19336 .option pipe_transport redirect string&!! unset
19337 .vindex "&$address_pipe$&"
19338 A &(redirect)& router sets up a direct delivery to a pipe when a string
19339 starting with a vertical bar character is specified as a new &"address"&. The
19340 transport used is specified by this option, which, after expansion, must be the
19341 name of a configured transport. This should normally be a &(pipe)& transport.
19342 When the transport is run, the pipe command is in &$address_pipe$&.
19343
19344
19345 .option qualify_domain redirect string&!! unset
19346 .vindex "&$qualify_recipient$&"
19347 If this option is set, and an unqualified address (one without a domain) is
19348 generated, and that address would normally be qualified by the global setting
19349 in &%qualify_recipient%&, it is instead qualified with the domain specified by
19350 expanding this string. If the expansion fails, the router declines. If you want
19351 to revert to the default, you can have the expansion generate
19352 &$qualify_recipient$&.
19353
19354 This option applies to all unqualified addresses generated by Exim filters,
19355 but for traditional &_.forward_& files, it applies only to addresses that are
19356 not preceded by a backslash. Sieve filters cannot generate unqualified
19357 addresses.
19358
19359 .option qualify_preserve_domain redirect boolean false
19360 .cindex "domain" "in redirection; preserving"
19361 .cindex "preserving domain in redirection"
19362 .cindex "address redirection" "domain; preserving"
19363 If this option is set, the router's local &%qualify_domain%& option must not be
19364 set (a configuration error occurs if it is). If an unqualified address (one
19365 without a domain) is generated, it is qualified with the domain of the parent
19366 address (the immediately preceding ancestor) instead of the global
19367 &%qualify_recipient%& value. In the case of a traditional &_.forward_& file,
19368 this applies whether or not the address is preceded by a backslash.
19369
19370
19371 .option repeat_use redirect boolean true
19372 If this option is set false, the router is skipped for a child address that has
19373 any ancestor that was routed by this router. This test happens before any of
19374 the other preconditions are tested. Exim's default anti-looping rules skip
19375 only when the ancestor is the same as the current address. See also
19376 &%check_ancestor%& above and the generic &%redirect_router%& option.
19377
19378
19379 .option reply_transport redirect string&!! unset
19380 A &(redirect)& router sets up an automatic reply when a &%mail%& or
19381 &%vacation%& command is used in a filter file. The transport used is specified
19382 by this option, which, after expansion, must be the name of a configured
19383 transport. This should normally be an &(autoreply)& transport. Other transports
19384 are unlikely to do anything sensible or useful.
19385
19386
19387 .option rewrite redirect boolean true
19388 .cindex "address redirection" "disabling rewriting"
19389 If this option is set false, addresses generated by the router are not
19390 subject to address rewriting. Otherwise, they are treated like new addresses
19391 and are rewritten according to the global rewriting rules.
19392
19393
19394 .option sieve_subaddress redirect string&!! unset
19395 The value of this option is passed to a Sieve filter to specify the
19396 :subaddress part of an address.
19397
19398 .option sieve_useraddress redirect string&!! unset
19399 The value of this option is passed to a Sieve filter to specify the :user part
19400 of an address. However, if it is unset, the entire original local part
19401 (including any prefix or suffix) is used for :user.
19402
19403
19404 .option sieve_vacation_directory redirect string&!! unset
19405 .cindex "Sieve filter" "vacation directory"
19406 To enable the &"vacation"& extension for Sieve filters, you must set
19407 &%sieve_vacation_directory%& to the directory where vacation databases are held
19408 (do not put anything else in that directory), and ensure that the
19409 &%reply_transport%& option refers to an &(autoreply)& transport. Each user
19410 needs their own directory; Exim will create it if necessary.
19411
19412
19413
19414 .option skip_syntax_errors redirect boolean false
19415 .cindex "forward file" "broken"
19416 .cindex "address redirection" "broken files"
19417 .cindex "alias file" "broken"
19418 .cindex "broken alias or forward files"
19419 .cindex "ignoring faulty addresses"
19420 .cindex "skipping faulty addresses"
19421 .cindex "error" "skipping bad syntax"
19422 If &%skip_syntax_errors%& is set, syntactically malformed addresses in
19423 non-filter redirection data are skipped, and each failing address is logged. If
19424 &%syntax_errors_to%& is set, a message is sent to the address it defines,
19425 giving details of the failures. If &%syntax_errors_text%& is set, its contents
19426 are expanded and placed at the head of the error message generated by
19427 &%syntax_errors_to%&. Usually it is appropriate to set &%syntax_errors_to%& to
19428 be the same address as the generic &%errors_to%& option. The
19429 &%skip_syntax_errors%& option is often used when handling mailing lists.
19430
19431 If all the addresses in a redirection list are skipped because of syntax
19432 errors, the router declines to handle the original address, and it is passed to
19433 the following routers.
19434
19435 If &%skip_syntax_errors%& is set when an Exim filter is interpreted, any syntax
19436 error in the filter causes filtering to be abandoned without any action being
19437 taken. The incident is logged, and the router declines to handle the address,
19438 so it is passed to the following routers.
19439
19440 .cindex "Sieve filter" "syntax errors in"
19441 Syntax errors in a Sieve filter file cause the &"keep"& action to occur. This
19442 action is specified by RFC 3028. The values of &%skip_syntax_errors%&,
19443 &%syntax_errors_to%&, and &%syntax_errors_text%& are not used.
19444
19445 &%skip_syntax_errors%& can be used to specify that errors in users' forward
19446 lists or filter files should not prevent delivery. The &%syntax_errors_to%&
19447 option, used with an address that does not get redirected, can be used to
19448 notify users of these errors, by means of a router like this:
19449 .code
19450 userforward:
19451   driver = redirect
19452   allow_filter
19453   check_local_user
19454   file = $home/.forward
19455   file_transport = address_file
19456   pipe_transport = address_pipe
19457   reply_transport = address_reply
19458   no_verify
19459   skip_syntax_errors
19460   syntax_errors_to = real-$local_part@$domain
19461   syntax_errors_text = \
19462    This is an automatically generated message. An error has\n\
19463    been found in your .forward file. Details of the error are\n\
19464    reported below. While this error persists, you will receive\n\
19465    a copy of this message for every message that is addressed\n\
19466    to you. If your .forward file is a filter file, or if it is\n\
19467    a non-filter file containing no valid forwarding addresses,\n\
19468    a copy of each incoming message will be put in your normal\n\
19469    mailbox. If a non-filter file contains at least one valid\n\
19470    forwarding address, forwarding to the valid addresses will\n\
19471    happen, and those will be the only deliveries that occur.
19472 .endd
19473 You also need a router to ensure that local addresses that are prefixed by
19474 &`real-`& are recognized, but not forwarded or filtered. For example, you could
19475 put this immediately before the &(userforward)& router:
19476 .code
19477 real_localuser:
19478   driver = accept
19479   check_local_user
19480   local_part_prefix = real-
19481   transport = local_delivery
19482 .endd
19483 For security, it would probably be a good idea to restrict the use of this
19484 router to locally-generated messages, using a condition such as this:
19485 .code
19486   condition = ${if match {$sender_host_address}\
19487                          {\N^(|127\.0\.0\.1)$\N}}
19488 .endd
19489
19490
19491 .option syntax_errors_text redirect string&!! unset
19492 See &%skip_syntax_errors%& above.
19493
19494
19495 .option syntax_errors_to redirect string unset
19496 See &%skip_syntax_errors%& above.
19497 .ecindex IIDredrou1
19498 .ecindex IIDredrou2
19499
19500
19501
19502
19503
19504
19505 . ////////////////////////////////////////////////////////////////////////////
19506 . ////////////////////////////////////////////////////////////////////////////
19507
19508 .chapter "Environment for running local transports" "CHAPenvironment" &&&
19509          "Environment for local transports"
19510 .scindex IIDenvlotra1 "local transports" "environment for"
19511 .scindex IIDenvlotra2 "environment for local transports"
19512 .scindex IIDenvlotra3 "transport" "local; environment for"
19513 Local transports handle deliveries to files and pipes. (The &(autoreply)&
19514 transport can be thought of as similar to a pipe.) Exim always runs transports
19515 in subprocesses, under specified uids and gids. Typical deliveries to local
19516 mailboxes run under the uid and gid of the local user.
19517
19518 Exim also sets a specific current directory while running the transport; for
19519 some transports a home directory setting is also relevant. The &(pipe)&
19520 transport is the only one that sets up environment variables; see section
19521 &<<SECTpipeenv>>& for details.
19522
19523 The values used for the uid, gid, and the directories may come from several
19524 different places. In many cases, the router that handles the address associates
19525 settings with that address as a result of its &%check_local_user%&, &%group%&,
19526 or &%user%& options. However, values may also be given in the transport's own
19527 configuration, and these override anything that comes from the router.
19528
19529
19530
19531 .section "Concurrent deliveries" "SECID131"
19532 .cindex "concurrent deliveries"
19533 .cindex "simultaneous deliveries"
19534 If two different messages for the same local recipient arrive more or less
19535 simultaneously, the two delivery processes are likely to run concurrently. When
19536 the &(appendfile)& transport is used to write to a file, Exim applies locking
19537 rules to stop concurrent processes from writing to the same file at the same
19538 time.
19539
19540 However, when you use a &(pipe)& transport, it is up to you to arrange any
19541 locking that is needed. Here is a silly example:
19542 .code
19543 my_transport:
19544   driver = pipe
19545   command = /bin/sh -c 'cat >>/some/file'
19546 .endd
19547 This is supposed to write the message at the end of the file. However, if two
19548 messages arrive at the same time, the file will be scrambled. You can use the
19549 &%exim_lock%& utility program (see section &<<SECTmailboxmaint>>&) to lock a
19550 file using the same algorithm that Exim itself uses.
19551
19552
19553
19554
19555 .section "Uids and gids" "SECTenvuidgid"
19556 .cindex "local transports" "uid and gid"
19557 .cindex "transport" "local; uid and gid"
19558 All transports have the options &%group%& and &%user%&. If &%group%& is set, it
19559 overrides any group that the router set in the address, even if &%user%& is not
19560 set for the transport. This makes it possible, for example, to run local mail
19561 delivery under the uid of the recipient (set by the router), but in a special
19562 group (set by the transport). For example:
19563 .code
19564 # Routers ...
19565 # User/group are set by check_local_user in this router
19566 local_users:
19567   driver = accept
19568   check_local_user
19569   transport = group_delivery
19570
19571 # Transports ...
19572 # This transport overrides the group
19573 group_delivery:
19574   driver = appendfile
19575   file = /var/spool/mail/$local_part
19576   group = mail
19577 .endd
19578 If &%user%& is set for a transport, its value overrides what is set in the
19579 address by the router. If &%user%& is non-numeric and &%group%& is not set, the
19580 gid associated with the user is used. If &%user%& is numeric, &%group%& must be
19581 set.
19582
19583 .oindex "&%initgroups%&"
19584 When the uid is taken from the transport's configuration, the &[initgroups()]&
19585 function is called for the groups associated with that uid if the
19586 &%initgroups%& option is set for the transport. When the uid is not specified
19587 by the transport, but is associated with the address by a router, the option
19588 for calling &[initgroups()]& is taken from the router configuration.
19589
19590 .cindex "&(pipe)& transport" "uid for"
19591 The &(pipe)& transport contains the special option &%pipe_as_creator%&. If this
19592 is set and &%user%& is not set, the uid of the process that called Exim to
19593 receive the message is used, and if &%group%& is not set, the corresponding
19594 original gid is also used.
19595
19596 This is the detailed preference order for obtaining a gid; the first of the
19597 following that is set is used:
19598
19599 .ilist
19600 A &%group%& setting of the transport;
19601 .next
19602 A &%group%& setting of the router;
19603 .next
19604 A gid associated with a user setting of the router, either as a result of
19605 &%check_local_user%& or an explicit non-numeric &%user%& setting;
19606 .next
19607 The group associated with a non-numeric &%user%& setting of the transport;
19608 .next
19609 In a &(pipe)& transport, the creator's gid if &%deliver_as_creator%& is set and
19610 the uid is the creator's uid;
19611 .next
19612 The Exim gid if the Exim uid is being used as a default.
19613 .endlist
19614
19615 If, for example, the user is specified numerically on the router and there are
19616 no group settings, no gid is available. In this situation, an error occurs.
19617 This is different for the uid, for which there always is an ultimate default.
19618 The first of the following that is set is used:
19619
19620 .ilist
19621 A &%user%& setting of the transport;
19622 .next
19623 In a &(pipe)& transport, the creator's uid if &%deliver_as_creator%& is set;
19624 .next
19625 A &%user%& setting of the router;
19626 .next
19627 A &%check_local_user%& setting of the router;
19628 .next
19629 The Exim uid.
19630 .endlist
19631
19632 Of course, an error will still occur if the uid that is chosen is on the
19633 &%never_users%& list.
19634
19635
19636
19637
19638
19639 .section "Current and home directories" "SECID132"
19640 .cindex "current directory for local transport"
19641 .cindex "home directory" "for local transport"
19642 .cindex "transport" "local; home directory for"
19643 .cindex "transport" "local; current directory for"
19644 Routers may set current and home directories for local transports by means of
19645 the &%transport_current_directory%& and &%transport_home_directory%& options.
19646 However, if the transport's &%current_directory%& or &%home_directory%& options
19647 are set, they override the router's values. In detail, the home directory
19648 for a local transport is taken from the first of these values that is set:
19649
19650 .ilist
19651 The &%home_directory%& option on the transport;
19652 .next
19653 The &%transport_home_directory%& option on the router;
19654 .next
19655 The password data if &%check_local_user%& is set on the router;
19656 .next
19657 The &%router_home_directory%& option on the router.
19658 .endlist
19659
19660 The current directory is taken from the first of these values that is set:
19661
19662 .ilist
19663 The &%current_directory%& option on the transport;
19664 .next
19665 The &%transport_current_directory%& option on the router.
19666 .endlist
19667
19668
19669 If neither the router nor the transport sets a current directory, Exim uses the
19670 value of the home directory, if it is set. Otherwise it sets the current
19671 directory to &_/_& before running a local transport.
19672
19673
19674
19675 .section "Expansion variables derived from the address" "SECID133"
19676 .vindex "&$domain$&"
19677 .vindex "&$local_part$&"
19678 .vindex "&$original_domain$&"
19679 Normally a local delivery is handling a single address, and in that case the
19680 variables such as &$domain$& and &$local_part$& are set during local
19681 deliveries. However, in some circumstances more than one address may be handled
19682 at once (for example, while writing batch SMTP for onward transmission by some
19683 other means). In this case, the variables associated with the local part are
19684 never set, &$domain$& is set only if all the addresses have the same domain,
19685 and &$original_domain$& is never set.
19686 .ecindex IIDenvlotra1
19687 .ecindex IIDenvlotra2
19688 .ecindex IIDenvlotra3
19689
19690
19691
19692
19693
19694
19695
19696 . ////////////////////////////////////////////////////////////////////////////
19697 . ////////////////////////////////////////////////////////////////////////////
19698
19699 .chapter "Generic options for transports" "CHAPtransportgeneric"
19700 .scindex IIDgenoptra1 "generic options" "transport"
19701 .scindex IIDgenoptra2 "options" "generic; for transports"
19702 .scindex IIDgenoptra3 "transport" "generic options for"
19703 The following generic options apply to all transports:
19704
19705
19706 .option body_only transports boolean false
19707 .cindex "transport" "body only"
19708 .cindex "message" "transporting body only"
19709 .cindex "body of message" "transporting"
19710 If this option is set, the message's headers are not transported. It is
19711 mutually exclusive with &%headers_only%&. If it is used with the &(appendfile)&
19712 or &(pipe)& transports, the settings of &%message_prefix%& and
19713 &%message_suffix%& should be checked, because this option does not
19714 automatically suppress them.
19715
19716
19717 .option current_directory transports string&!! unset
19718 .cindex "transport" "current directory for"
19719 This specifies the current directory that is to be set while running the
19720 transport, overriding any value that may have been set by the router.
19721 If the expansion fails for any reason, including forced failure, an error is
19722 logged, and delivery is deferred.
19723
19724
19725 .option disable_logging transports boolean false
19726 If this option is set true, nothing is logged for any
19727 deliveries by the transport or for any
19728 transport errors. You should not set this option unless you really, really know
19729 what you are doing.
19730
19731
19732 .option debug_print transports string&!! unset
19733 .cindex "testing" "variables in drivers"
19734 If this option is set and debugging is enabled (see the &%-d%& command line
19735 option), the string is expanded and included in the debugging output when the
19736 transport is run.
19737 If expansion of the string fails, the error message is written to the debugging
19738 output, and Exim carries on processing.
19739 This facility is provided to help with checking out the values of variables and
19740 so on when debugging driver configurations. For example, if a &%headers_add%&
19741 option is not working properly, &%debug_print%& could be used to output the
19742 variables it references. A newline is added to the text if it does not end with
19743 one.
19744 The variables &$transport_name$& and &$router_name$& contain the name of the
19745 transport and the router that called it.
19746
19747 .option delivery_date_add transports boolean false
19748 .cindex "&'Delivery-date:'& header line"
19749 If this option is true, a &'Delivery-date:'& header is added to the message.
19750 This gives the actual time the delivery was made. As this is not a standard
19751 header, Exim has a configuration option (&%delivery_date_remove%&) which
19752 requests its removal from incoming messages, so that delivered messages can
19753 safely be resent to other recipients.
19754
19755
19756 .option driver transports string unset
19757 This specifies which of the available transport drivers is to be used.
19758 There is no default, and this option must be set for every transport.
19759
19760
19761 .option envelope_to_add transports boolean false
19762 .cindex "&'Envelope-to:'& header line"
19763 If this option is true, an &'Envelope-to:'& header is added to the message.
19764 This gives the original address(es) in the incoming envelope that caused this
19765 delivery to happen. More than one address may be present if the transport is
19766 configured to handle several addresses at once, or if more than one original
19767 address was redirected to the same final address. As this is not a standard
19768 header, Exim has a configuration option (&%envelope_to_remove%&) which requests
19769 its removal from incoming messages, so that delivered messages can safely be
19770 resent to other recipients.
19771
19772
19773 .option group transports string&!! "Exim group"
19774 .cindex "transport" "group; specifying"
19775 This option specifies a gid for running the transport process, overriding any
19776 value that the router supplies, and also overriding any value associated with
19777 &%user%& (see below).
19778
19779
19780 .option headers_add transports string&!! unset
19781 .cindex "header lines" "adding in transport"
19782 .cindex "transport" "header lines; adding"
19783 This option specifies a string of text that is expanded and added to the header
19784 portion of a message as it is transported, as described in section
19785 &<<SECTheadersaddrem>>&. Additional header lines can also be specified by
19786 routers. If the result of the expansion is an empty string, or if the expansion
19787 is forced to fail, no action is taken. Other expansion failures are treated as
19788 errors and cause the delivery to be deferred.
19789
19790 Unlike most options, &%headers_add%& can be specified multiple times
19791 for a transport; all listed headers are added.
19792
19793
19794 .option headers_only transports boolean false
19795 .cindex "transport" "header lines only"
19796 .cindex "message" "transporting headers only"
19797 .cindex "header lines" "transporting"
19798 If this option is set, the message's body is not transported. It is mutually
19799 exclusive with &%body_only%&. If it is used with the &(appendfile)& or &(pipe)&
19800 transports, the settings of &%message_prefix%& and &%message_suffix%& should be
19801 checked, since this option does not automatically suppress them.
19802
19803
19804 .option headers_remove transports string&!! unset
19805 .cindex "header lines" "removing"
19806 .cindex "transport" "header lines; removing"
19807 This option specifies a string that is expanded into a list of header names;
19808 these headers are omitted from the message as it is transported, as described
19809 in section &<<SECTheadersaddrem>>&. Header removal 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 Unlike most options, &%headers_remove%& can be specified multiple times
19815 for a router; all listed headers are added.
19816
19817
19818
19819 .option headers_rewrite transports string unset
19820 .cindex "transport" "header lines; rewriting"
19821 .cindex "rewriting" "at transport time"
19822 This option allows addresses in header lines to be rewritten at transport time,
19823 that is, as the message is being copied to its destination. The contents of the
19824 option are a colon-separated list of rewriting rules. Each rule is in exactly
19825 the same form as one of the general rewriting rules that are applied when a
19826 message is received. These are described in chapter &<<CHAPrewrite>>&. For
19827 example,
19828 .code
19829 headers_rewrite = a@b c@d f : \
19830                   x@y w@z
19831 .endd
19832 changes &'a@b'& into &'c@d'& in &'From:'& header lines, and &'x@y'& into
19833 &'w@z'& in all address-bearing header lines. The rules are applied to the
19834 header lines just before they are written out at transport time, so they affect
19835 only those copies of the message that pass through the transport. However, only
19836 the message's original header lines, and any that were added by a system
19837 filter, are rewritten. If a router or transport adds header lines, they are not
19838 affected by this option. These rewriting rules are &'not'& applied to the
19839 envelope. You can change the return path using &%return_path%&, but you cannot
19840 change envelope recipients at this time.
19841
19842
19843 .option home_directory transports string&!! unset
19844 .cindex "transport" "home directory for"
19845 .vindex "&$home$&"
19846 This option specifies a home directory setting for a local transport,
19847 overriding any value that may be set by the router. The home directory is
19848 placed in &$home$& while expanding the transport's private options. It is also
19849 used as the current directory if no current directory is set by the
19850 &%current_directory%& option on the transport or the
19851 &%transport_current_directory%& option on the router. If the expansion fails
19852 for any reason, including forced failure, an error is logged, and delivery is
19853 deferred.
19854
19855
19856 .option initgroups transports boolean false
19857 .cindex "additional groups"
19858 .cindex "groups" "additional"
19859 .cindex "transport" "group; additional"
19860 If this option is true and the uid for the delivery process is provided by the
19861 transport, the &[initgroups()]& function is called when running the transport
19862 to ensure that any additional groups associated with the uid are set up.
19863
19864
19865 .option message_size_limit transports string&!! 0
19866 .cindex "limit" "message size per transport"
19867 .cindex "size" "of message, limit"
19868 .cindex "transport" "message size; limiting"
19869 This option controls the size of messages passed through the transport. It is
19870 expanded before use; the result of the expansion must be a sequence of decimal
19871 digits, optionally followed by K or M. If the expansion fails for any reason,
19872 including forced failure, or if the result is not of the required form,
19873 delivery is deferred. If the value is greater than zero and the size of a
19874 message exceeds this limit, the address is failed. If there is any chance that
19875 the resulting bounce message could be routed to the same transport, you should
19876 ensure that &%return_size_limit%& is less than the transport's
19877 &%message_size_limit%&, as otherwise the bounce message will fail to get
19878 delivered.
19879
19880
19881
19882 .option rcpt_include_affixes transports boolean false
19883 .cindex "prefix" "for local part, including in envelope"
19884 .cindex "suffix for local part" "including in envelope"
19885 .cindex "local part" "prefix"
19886 .cindex "local part" "suffix"
19887 When this option is false (the default), and an address that has had any
19888 affixes (prefixes or suffixes) removed from the local part is delivered by any
19889 form of SMTP or LMTP, the affixes are not included. For example, if a router
19890 that contains
19891 .code
19892 local_part_prefix = *-
19893 .endd
19894 routes the address &'abc-xyz@some.domain'& to an SMTP transport, the envelope
19895 is delivered with
19896 .code
19897 RCPT TO:<xyz@some.domain>
19898 .endd
19899 This is also the case when an ACL-time callout is being used to verify a
19900 recipient address. However, if &%rcpt_include_affixes%& is set true, the
19901 whole local part is included in the RCPT command. This option applies to BSMTP
19902 deliveries by the &(appendfile)& and &(pipe)& transports as well as to the
19903 &(lmtp)& and &(smtp)& transports.
19904
19905
19906 .option retry_use_local_part transports boolean "see below"
19907 .cindex "hints database" "retry keys"
19908 When a delivery suffers a temporary failure, a retry record is created
19909 in Exim's hints database. For remote deliveries, the key for the retry record
19910 is based on the name and/or IP address of the failing remote host. For local
19911 deliveries, the key is normally the entire address, including both the local
19912 part and the domain. This is suitable for most common cases of local delivery
19913 temporary failure &-- for example, exceeding a mailbox quota should delay only
19914 deliveries to that mailbox, not to the whole domain.
19915
19916 However, in some special cases you may want to treat a temporary local delivery
19917 as a failure associated with the domain, and not with a particular local part.
19918 (For example, if you are storing all mail for some domain in files.) You can do
19919 this by setting &%retry_use_local_part%& false.
19920
19921 For all the local transports, its default value is true. For remote transports,
19922 the default value is false for tidiness, but changing the value has no effect
19923 on a remote transport in the current implementation.
19924
19925
19926 .option return_path transports string&!! unset
19927 .cindex "envelope sender"
19928 .cindex "transport" "return path; changing"
19929 .cindex "return path" "changing in transport"
19930 If this option is set, the string is expanded at transport time and replaces
19931 the existing return path (envelope sender) value in the copy of the message
19932 that is being delivered. An empty return path is permitted. This feature is
19933 designed for remote deliveries, where the value of this option is used in the
19934 SMTP MAIL command. If you set &%return_path%& for a local transport, the
19935 only effect is to change the address that is placed in the &'Return-path:'&
19936 header line, if one is added to the message (see the next option).
19937
19938 &*Note:*& A changed return path is not logged unless you add
19939 &%return_path_on_delivery%& to the log selector.
19940
19941 .vindex "&$return_path$&"
19942 The expansion can refer to the existing value via &$return_path$&. This is
19943 either the message's envelope sender, or an address set by the
19944 &%errors_to%& option on a router. If the expansion is forced to fail, no
19945 replacement occurs; if it fails for another reason, delivery is deferred. This
19946 option can be used to support VERP (Variable Envelope Return Paths) &-- see
19947 section &<<SECTverp>>&.
19948
19949 &*Note*&: If a delivery error is detected locally, including the case when a
19950 remote server rejects a message at SMTP time, the bounce message is not sent to
19951 the value of this option. It is sent to the previously set errors address.
19952 This defaults to the incoming sender address, but can be changed by setting
19953 &%errors_to%& in a router.
19954
19955
19956
19957 .option return_path_add transports boolean false
19958 .cindex "&'Return-path:'& header line"
19959 If this option is true, a &'Return-path:'& header is added to the message.
19960 Although the return path is normally available in the prefix line of BSD
19961 mailboxes, this is commonly not displayed by MUAs, and so the user does not
19962 have easy access to it.
19963
19964 RFC 2821 states that the &'Return-path:'& header is added to a message &"when
19965 the delivery SMTP server makes the final delivery"&. This implies that this
19966 header should not be present in incoming messages. Exim has a configuration
19967 option, &%return_path_remove%&, which requests removal of this header from
19968 incoming messages, so that delivered messages can safely be resent to other
19969 recipients.
19970
19971
19972 .option shadow_condition transports string&!! unset
19973 See &%shadow_transport%& below.
19974
19975
19976 .option shadow_transport transports string unset
19977 .cindex "shadow transport"
19978 .cindex "transport" "shadow"
19979 A local transport may set the &%shadow_transport%& option to the name of
19980 another local transport. Shadow remote transports are not supported.
19981
19982 Whenever a delivery to the main transport succeeds, and either
19983 &%shadow_condition%& is unset, or its expansion does not result in the empty
19984 string or one of the strings &"0"& or &"no"& or &"false"&, the message is also
19985 passed to the shadow transport, with the same delivery address or addresses. If
19986 expansion fails, no action is taken except that non-forced expansion failures
19987 cause a log line to be written.
19988
19989 The result of the shadow transport is discarded and does not affect the
19990 subsequent processing of the message. Only a single level of shadowing is
19991 provided; the &%shadow_transport%& option is ignored on any transport when it
19992 is running as a shadow. Options concerned with output from pipes are also
19993 ignored. The log line for the successful delivery has an item added on the end,
19994 of the form
19995 .code
19996 ST=<shadow transport name>
19997 .endd
19998 If the shadow transport did not succeed, the error message is put in
19999 parentheses afterwards. Shadow transports can be used for a number of different
20000 purposes, including keeping more detailed log information than Exim normally
20001 provides, and implementing automatic acknowledgment policies based on message
20002 headers that some sites insist on.
20003
20004
20005 .option transport_filter transports string&!! unset
20006 .cindex "transport" "filter"
20007 .cindex "filter" "transport filter"
20008 This option sets up a filtering (in the Unix shell sense) process for messages
20009 at transport time. It should not be confused with mail filtering as set up by
20010 individual users or via a system filter.
20011
20012 When the message is about to be written out, the command specified by
20013 &%transport_filter%& is started up in a separate, parallel process, and
20014 the entire message, including the header lines, is passed to it on its standard
20015 input (this in fact is done from a third process, to avoid deadlock). The
20016 command must be specified as an absolute path.
20017
20018 The lines of the message that are written to the transport filter are
20019 terminated by newline (&"\n"&). The message is passed to the filter before any
20020 SMTP-specific processing, such as turning &"\n"& into &"\r\n"& and escaping
20021 lines beginning with a dot, and also before any processing implied by the
20022 settings of &%check_string%& and &%escape_string%& in the &(appendfile)& or
20023 &(pipe)& transports.
20024
20025 The standard error for the filter process is set to the same destination as its
20026 standard output; this is read and written to the message's ultimate
20027 destination. The process that writes the message to the filter, the
20028 filter itself, and the original process that reads the result and delivers it
20029 are all run in parallel, like a shell pipeline.
20030
20031 The filter can perform any transformations it likes, but of course should take
20032 care not to break RFC 2822 syntax. Exim does not check the result, except to
20033 test for a final newline when SMTP is in use. All messages transmitted over
20034 SMTP must end with a newline, so Exim supplies one if it is missing.
20035
20036 .cindex "content scanning" "per user"
20037 A transport filter can be used to provide content-scanning on a per-user basis
20038 at delivery time if the only required effect of the scan is to modify the
20039 message. For example, a content scan could insert a new header line containing
20040 a spam score. This could be interpreted by a filter in the user's MUA. It is
20041 not possible to discard a message at this stage.
20042
20043 .cindex "SMTP" "SIZE"
20044 A problem might arise if the filter increases the size of a message that is
20045 being sent down an SMTP connection. If the receiving SMTP server has indicated
20046 support for the SIZE parameter, Exim will have sent the size of the message
20047 at the start of the SMTP session. If what is actually sent is substantially
20048 more, the server might reject the message. This can be worked round by setting
20049 the &%size_addition%& option on the &(smtp)& transport, either to allow for
20050 additions to the message, or to disable the use of SIZE altogether.
20051
20052 .vindex "&$pipe_addresses$&"
20053 The value of the &%transport_filter%& option is the command string for starting
20054 the filter, which is run directly from Exim, not under a shell. The string is
20055 parsed by Exim in the same way as a command string for the &(pipe)& transport:
20056 Exim breaks it up into arguments and then expands each argument separately (see
20057 section &<<SECThowcommandrun>>&). Any kind of expansion failure causes delivery
20058 to be deferred. The special argument &$pipe_addresses$& is replaced by a number
20059 of arguments, one for each address that applies to this delivery. (This isn't
20060 an ideal name for this feature here, but as it was already implemented for the
20061 &(pipe)& transport, it seemed sensible not to change it.)
20062
20063 .vindex "&$host$&"
20064 .vindex "&$host_address$&"
20065 The expansion variables &$host$& and &$host_address$& are available when the
20066 transport is a remote one. They contain the name and IP address of the host to
20067 which the message is being sent. For example:
20068 .code
20069 transport_filter = /some/directory/transport-filter.pl \
20070   $host $host_address $sender_address $pipe_addresses
20071 .endd
20072
20073 Two problems arise if you want to use more complicated expansion items to
20074 generate transport filter commands, both of which due to the fact that the
20075 command is split up &'before'& expansion.
20076 .ilist
20077 If an expansion item contains white space, you must quote it, so that it is all
20078 part of the same command item. If the entire option setting is one such
20079 expansion item, you have to take care what kind of quoting you use. For
20080 example:
20081 .code
20082 transport_filter = '/bin/cmd${if eq{$host}{a.b.c}{1}{2}}'
20083 .endd
20084 This runs the command &(/bin/cmd1)& if the host name is &'a.b.c'&, and
20085 &(/bin/cmd2)& otherwise. If double quotes had been used, they would have been
20086 stripped by Exim when it read the option's value. When the value is used, if
20087 the single quotes were missing, the line would be split into two items,
20088 &`/bin/cmd${if`& and &`eq{$host}{a.b.c}{1}{2}`&, and an error would occur when
20089 Exim tried to expand the first one.
20090 .next
20091 Except for the special case of &$pipe_addresses$& that is mentioned above, an
20092 expansion cannot generate multiple arguments, or a command name followed by
20093 arguments. Consider this example:
20094 .code
20095 transport_filter = ${lookup{$host}lsearch{/a/file}\
20096                     {$value}{/bin/cat}}
20097 .endd
20098 The result of the lookup is interpreted as the name of the command, even
20099 if it contains white space. The simplest way round this is to use a shell:
20100 .code
20101 transport_filter = /bin/sh -c ${lookup{$host}lsearch{/a/file}\
20102                                {$value}{/bin/cat}}
20103 .endd
20104 .endlist
20105
20106 The filter process is run under the same uid and gid as the normal delivery.
20107 For remote deliveries this is the Exim uid/gid by default. The command should
20108 normally yield a zero return code. Transport filters are not supposed to fail.
20109 A non-zero code is taken to mean that the transport filter encountered some
20110 serious problem. Delivery of the message is deferred; the message remains on
20111 the queue and is tried again later. It is not possible to cause a message to be
20112 bounced from a transport filter.
20113
20114 If a transport filter is set on an autoreply transport, the original message is
20115 passed through the filter as it is being copied into the newly generated
20116 message, which happens if the &%return_message%& option is set.
20117
20118
20119 .option transport_filter_timeout transports time 5m
20120 .cindex "transport" "filter, timeout"
20121 When Exim is reading the output of a transport filter, it applies a timeout
20122 that can be set by this option. Exceeding the timeout is normally treated as a
20123 temporary delivery failure. However, if a transport filter is used with a
20124 &(pipe)& transport, a timeout in the transport filter is treated in the same
20125 way as a timeout in the pipe command itself. By default, a timeout is a hard
20126 error, but if the &(pipe)& transport's &%timeout_defer%& option is set true, it
20127 becomes a temporary error.
20128
20129
20130 .option user transports string&!! "Exim user"
20131 .cindex "uid (user id)" "local delivery"
20132 .cindex "transport" "user, specifying"
20133 This option specifies the user under whose uid the delivery process is to be
20134 run, overriding any uid that may have been set by the router. If the user is
20135 given as a name, the uid is looked up from the password data, and the
20136 associated group is taken as the value of the gid to be used if the &%group%&
20137 option is not set.
20138
20139 For deliveries that use local transports, a user and group are normally
20140 specified explicitly or implicitly (for example, as a result of
20141 &%check_local_user%&) by the router or transport.
20142
20143 .cindex "hints database" "access by remote transport"
20144 For remote transports, you should leave this option unset unless you really are
20145 sure you know what you are doing. When a remote transport is running, it needs
20146 to be able to access Exim's hints databases, because each host may have its own
20147 retry data.
20148 .ecindex IIDgenoptra1
20149 .ecindex IIDgenoptra2
20150 .ecindex IIDgenoptra3
20151
20152
20153
20154
20155
20156
20157 . ////////////////////////////////////////////////////////////////////////////
20158 . ////////////////////////////////////////////////////////////////////////////
20159
20160 .chapter "Address batching in local transports" "CHAPbatching" &&&
20161          "Address batching"
20162 .cindex "transport" "local; address batching in"
20163 The only remote transport (&(smtp)&) is normally configured to handle more than
20164 one address at a time, so that when several addresses are routed to the same
20165 remote host, just one copy of the message is sent. Local transports, however,
20166 normally handle one address at a time. That is, a separate instance of the
20167 transport is run for each address that is routed to the transport. A separate
20168 copy of the message is delivered each time.
20169
20170 .cindex "batched local delivery"
20171 .oindex "&%batch_max%&"
20172 .oindex "&%batch_id%&"
20173 In special cases, it may be desirable to handle several addresses at once in a
20174 local transport, for example:
20175
20176 .ilist
20177 In an &(appendfile)& transport, when storing messages in files for later
20178 delivery by some other means, a single copy of the message with multiple
20179 recipients saves space.
20180 .next
20181 In an &(lmtp)& transport, when delivering over &"local SMTP"& to some process,
20182 a single copy saves time, and is the normal way LMTP is expected to work.
20183 .next
20184 In a &(pipe)& transport, when passing the message
20185 to a scanner program or
20186 to some other delivery mechanism such as UUCP, multiple recipients may be
20187 acceptable.
20188 .endlist
20189
20190 These three local transports all have the same options for controlling multiple
20191 (&"batched"&) deliveries, namely &%batch_max%& and &%batch_id%&. To save
20192 repeating the information for each transport, these options are described here.
20193
20194 The &%batch_max%& option specifies the maximum number of addresses that can be
20195 delivered together in a single run of the transport. Its default value is one
20196 (no batching). When more than one address is routed to a transport that has a
20197 &%batch_max%& value greater than one, the addresses are delivered in a batch
20198 (that is, in a single run of the transport with multiple recipients), subject
20199 to certain conditions:
20200
20201 .ilist
20202 .vindex "&$local_part$&"
20203 If any of the transport's options contain a reference to &$local_part$&, no
20204 batching is possible.
20205 .next
20206 .vindex "&$domain$&"
20207 If any of the transport's options contain a reference to &$domain$&, only
20208 addresses with the same domain are batched.
20209 .next
20210 .cindex "customizing" "batching condition"
20211 If &%batch_id%& is set, it is expanded for each address, and only those
20212 addresses with the same expanded value are batched. This allows you to specify
20213 customized batching conditions. Failure of the expansion for any reason,
20214 including forced failure, disables batching, but it does not stop the delivery
20215 from taking place.
20216 .next
20217 Batched addresses must also have the same errors address (where to send
20218 delivery errors), the same header additions and removals, the same user and
20219 group for the transport, and if a host list is present, the first host must
20220 be the same.
20221 .endlist
20222
20223 In the case of the &(appendfile)& and &(pipe)& transports, batching applies
20224 both when the file or pipe command is specified in the transport, and when it
20225 is specified by a &(redirect)& router, but all the batched addresses must of
20226 course be routed to the same file or pipe command. These two transports have an
20227 option called &%use_bsmtp%&, which causes them to deliver the message in
20228 &"batched SMTP"& format, with the envelope represented as SMTP commands. The
20229 &%check_string%& and &%escape_string%& options are forced to the values
20230 .code
20231 check_string = "."
20232 escape_string = ".."
20233 .endd
20234 when batched SMTP is in use. A full description of the batch SMTP mechanism is
20235 given in section &<<SECTbatchSMTP>>&. The &(lmtp)& transport does not have a
20236 &%use_bsmtp%& option, because it always delivers using the SMTP protocol.
20237
20238 .cindex "&'Envelope-to:'& header line"
20239 If the generic &%envelope_to_add%& option is set for a batching transport, the
20240 &'Envelope-to:'& header that is added to the message contains all the addresses
20241 that are being processed together. If you are using a batching &(appendfile)&
20242 transport without &%use_bsmtp%&, the only way to preserve the recipient
20243 addresses is to set the &%envelope_to_add%& option.
20244
20245 .cindex "&(pipe)& transport" "with multiple addresses"
20246 .vindex "&$pipe_addresses$&"
20247 If you are using a &(pipe)& transport without BSMTP, and setting the
20248 transport's &%command%& option, you can include &$pipe_addresses$& as part of
20249 the command. This is not a true variable; it is a bit of magic that causes each
20250 of the recipient addresses to be inserted into the command as a separate
20251 argument. This provides a way of accessing all the addresses that are being
20252 delivered in the batch. &*Note:*& This is not possible for pipe commands that
20253 are specified by a &(redirect)& router.
20254
20255
20256
20257
20258 . ////////////////////////////////////////////////////////////////////////////
20259 . ////////////////////////////////////////////////////////////////////////////
20260
20261 .chapter "The appendfile transport" "CHAPappendfile"
20262 .scindex IIDapptra1 "&(appendfile)& transport"
20263 .scindex IIDapptra2 "transports" "&(appendfile)&"
20264 .cindex "directory creation"
20265 .cindex "creating directories"
20266 The &(appendfile)& transport delivers a message by appending it to an existing
20267 file, or by creating an entirely new file in a specified directory. Single
20268 files to which messages are appended can be in the traditional Unix mailbox
20269 format, or optionally in the MBX format supported by the Pine MUA and
20270 University of Washington IMAP daemon, &'inter alia'&. When each message is
20271 being delivered as a separate file, &"maildir"& format can optionally be used
20272 to give added protection against failures that happen part-way through the
20273 delivery. A third form of separate-file delivery known as &"mailstore"& is also
20274 supported. For all file formats, Exim attempts to create as many levels of
20275 directory as necessary, provided that &%create_directory%& is set.
20276
20277 The code for the optional formats is not included in the Exim binary by
20278 default. It is necessary to set SUPPORT_MBX, SUPPORT_MAILDIR and/or
20279 SUPPORT_MAILSTORE in &_Local/Makefile_& to have the appropriate code
20280 included.
20281
20282 .cindex "quota" "system"
20283 Exim recognizes system quota errors, and generates an appropriate message. Exim
20284 also supports its own quota control within the transport, for use when the
20285 system facility is unavailable or cannot be used for some reason.
20286
20287 If there is an error while appending to a file (for example, quota exceeded or
20288 partition filled), Exim attempts to reset the file's length and last
20289 modification time back to what they were before. If there is an error while
20290 creating an entirely new file, the new file is removed.
20291
20292 Before appending to a file, a number of security checks are made, and the
20293 file is locked. A detailed description is given below, after the list of
20294 private options.
20295
20296 The &(appendfile)& transport is most commonly used for local deliveries to
20297 users' mailboxes. However, it can also be used as a pseudo-remote transport for
20298 putting messages into files for remote delivery by some means other than Exim.
20299 &"Batch SMTP"& format is often used in this case (see the &%use_bsmtp%&
20300 option).
20301
20302
20303
20304 .section "The file and directory options" "SECTfildiropt"
20305 The &%file%& option specifies a single file, to which the message is appended;
20306 the &%directory%& option specifies a directory, in which a new file containing
20307 the message is created. Only one of these two options can be set, and for
20308 normal deliveries to mailboxes, one of them &'must'& be set.
20309
20310 .vindex "&$address_file$&"
20311 .vindex "&$local_part$&"
20312 However, &(appendfile)& is also used for delivering messages to files or
20313 directories whose names (or parts of names) are obtained from alias,
20314 forwarding, or filtering operations (for example, a &%save%& command in a
20315 user's Exim filter). When such a transport is running, &$local_part$& contains
20316 the local part that was aliased or forwarded, and &$address_file$& contains the
20317 name (or partial name) of the file or directory generated by the redirection
20318 operation. There are two cases:
20319
20320 .ilist
20321 If neither &%file%& nor &%directory%& is set, the redirection operation
20322 must specify an absolute path (one that begins with &`/`&). This is the most
20323 common case when users with local accounts use filtering to sort mail into
20324 different folders. See for example, the &(address_file)& transport in the
20325 default configuration. If the path ends with a slash, it is assumed to be the
20326 name of a directory. A delivery to a directory can also be forced by setting
20327 &%maildir_format%& or &%mailstore_format%&.
20328 .next
20329 If &%file%& or &%directory%& is set for a delivery from a redirection, it is
20330 used to determine the file or directory name for the delivery. Normally, the
20331 contents of &$address_file$& are used in some way in the string expansion.
20332 .endlist
20333
20334
20335 .cindex "Sieve filter" "configuring &(appendfile)&"
20336 .cindex "Sieve filter" "relative mailbox path handling"
20337 As an example of the second case, consider an environment where users do not
20338 have home directories. They may be permitted to use Exim filter commands of the
20339 form:
20340 .code
20341 save folder23
20342 .endd
20343 or Sieve filter commands of the form:
20344 .code
20345 require "fileinto";
20346 fileinto "folder23";
20347 .endd
20348 In this situation, the expansion of &%file%& or &%directory%& in the transport
20349 must transform the relative path into an appropriate absolute file name. In the
20350 case of Sieve filters, the name &'inbox'& must be handled. It is the name that
20351 is used as a result of a &"keep"& action in the filter. This example shows one
20352 way of handling this requirement:
20353 .code
20354 file = ${if eq{$address_file}{inbox} \
20355             {/var/mail/$local_part} \
20356             {${if eq{${substr_0_1:$address_file}}{/} \
20357                   {$address_file} \
20358                   {$home/mail/$address_file} \
20359             }} \
20360        }
20361 .endd
20362 With this setting of &%file%&, &'inbox'& refers to the standard mailbox
20363 location, absolute paths are used without change, and other folders are in the
20364 &_mail_& directory within the home directory.
20365
20366 &*Note 1*&: While processing an Exim filter, a relative path such as
20367 &_folder23_& is turned into an absolute path if a home directory is known to
20368 the router. In particular, this is the case if &%check_local_user%& is set. If
20369 you want to prevent this happening at routing time, you can set
20370 &%router_home_directory%& empty. This forces the router to pass the relative
20371 path to the transport.
20372
20373 &*Note 2*&: An absolute path in &$address_file$& is not treated specially;
20374 the &%file%& or &%directory%& option is still used if it is set.
20375
20376
20377
20378
20379 .section "Private options for appendfile" "SECID134"
20380 .cindex "options" "&(appendfile)& transport"
20381
20382
20383
20384 .option allow_fifo appendfile boolean false
20385 .cindex "fifo (named pipe)"
20386 .cindex "named pipe (fifo)"
20387 .cindex "pipe" "named (fifo)"
20388 Setting this option permits delivery to named pipes (FIFOs) as well as to
20389 regular files. If no process is reading the named pipe at delivery time, the
20390 delivery is deferred.
20391
20392
20393 .option allow_symlink appendfile boolean false
20394 .cindex "symbolic link" "to mailbox"
20395 .cindex "mailbox" "symbolic link"
20396 By default, &(appendfile)& will not deliver if the path name for the file is
20397 that of a symbolic link. Setting this option relaxes that constraint, but there
20398 are security issues involved in the use of symbolic links. Be sure you know
20399 what you are doing if you set this. Details of exactly what this option affects
20400 are included in the discussion which follows this list of options.
20401
20402
20403 .option batch_id appendfile string&!! unset
20404 See the description of local delivery batching in chapter &<<CHAPbatching>>&.
20405 However, batching is automatically disabled for &(appendfile)& deliveries that
20406 happen as a result of forwarding or aliasing or other redirection directly to a
20407 file.
20408
20409
20410 .option batch_max appendfile integer 1
20411 See the description of local delivery batching in chapter &<<CHAPbatching>>&.
20412
20413
20414 .option check_group appendfile boolean false
20415 When this option is set, the group owner of the file defined by the &%file%&
20416 option is checked to see that it is the same as the group under which the
20417 delivery process is running. The default setting is false because the default
20418 file mode is 0600, which means that the group is irrelevant.
20419
20420
20421 .option check_owner appendfile boolean true
20422 When this option is set, the owner of the file defined by the &%file%& option
20423 is checked to ensure that it is the same as the user under which the delivery
20424 process is running.
20425
20426
20427 .option check_string appendfile string "see below"
20428 .cindex "&""From""& line"
20429 As &(appendfile)& writes the message, the start of each line is tested for
20430 matching &%check_string%&, and if it does, the initial matching characters are
20431 replaced by the contents of &%escape_string%&. The value of &%check_string%& is
20432 a literal string, not a regular expression, and the case of any letters it
20433 contains is significant.
20434
20435 If &%use_bsmtp%& is set the values of &%check_string%& and &%escape_string%&
20436 are forced to &"."& and &".."& respectively, and any settings in the
20437 configuration are ignored. Otherwise, they default to &"From&~"& and
20438 &">From&~"& when the &%file%& option is set, and unset when any of the
20439 &%directory%&, &%maildir%&, or &%mailstore%& options are set.
20440
20441 The default settings, along with &%message_prefix%& and &%message_suffix%&, are
20442 suitable for traditional &"BSD"& mailboxes, where a line beginning with
20443 &"From&~"& indicates the start of a new message. All four options need changing
20444 if another format is used. For example, to deliver to mailboxes in MMDF format:
20445 .cindex "MMDF format mailbox"
20446 .cindex "mailbox" "MMDF format"
20447 .code
20448 check_string = "\1\1\1\1\n"
20449 escape_string = "\1\1\1\1 \n"
20450 message_prefix = "\1\1\1\1\n"
20451 message_suffix = "\1\1\1\1\n"
20452 .endd
20453 .option create_directory appendfile boolean true
20454 .cindex "directory creation"
20455 When this option is true, Exim attempts to create any missing superior
20456 directories for the file that it is about to write. A created directory's mode
20457 is given by the &%directory_mode%& option.
20458
20459 The group ownership of a newly created directory is highly dependent on the
20460 operating system (and possibly the file system) that is being used. For
20461 example, in Solaris, if the parent directory has the setgid bit set, its group
20462 is propagated to the child; if not, the currently set group is used. However,
20463 in FreeBSD, the parent's group is always used.
20464
20465
20466
20467 .option create_file appendfile string anywhere
20468 This option constrains the location of files and directories that are created
20469 by this transport. It applies to files defined by the &%file%& option and
20470 directories defined by the &%directory%& option. In the case of maildir
20471 delivery, it applies to the top level directory, not the maildir directories
20472 beneath.
20473
20474 The option must be set to one of the words &"anywhere"&, &"inhome"&, or
20475 &"belowhome"&. In the second and third cases, a home directory must have been
20476 set for the transport. This option is not useful when an explicit file name is
20477 given for normal mailbox deliveries. It is intended for the case when file
20478 names are generated from users' &_.forward_& files. These are usually handled
20479 by an &(appendfile)& transport called &%address_file%&. See also
20480 &%file_must_exist%&.
20481
20482
20483 .option directory appendfile string&!! unset
20484 This option is mutually exclusive with the &%file%& option, but one of &%file%&
20485 or &%directory%& must be set, unless the delivery is the direct result of a
20486 redirection (see section &<<SECTfildiropt>>&).
20487
20488 When &%directory%& is set, the string is expanded, and the message is delivered
20489 into a new file or files in or below the given directory, instead of being
20490 appended to a single mailbox file. A number of different formats are provided
20491 (see &%maildir_format%& and &%mailstore_format%&), and see section
20492 &<<SECTopdir>>& for further details of this form of delivery.
20493
20494
20495 .option directory_file appendfile string&!! "see below"
20496 .cindex "base62"
20497 .vindex "&$inode$&"
20498 When &%directory%& is set, but neither &%maildir_format%& nor
20499 &%mailstore_format%& is set, &(appendfile)& delivers each message into a file
20500 whose name is obtained by expanding this string. The default value is:
20501 .code
20502 q${base62:$tod_epoch}-$inode
20503 .endd
20504 This generates a unique name from the current time, in base 62 form, and the
20505 inode of the file. The variable &$inode$& is available only when expanding this
20506 option.
20507
20508
20509 .option directory_mode appendfile "octal integer" 0700
20510 If &(appendfile)& creates any directories as a result of the
20511 &%create_directory%& option, their mode is specified by this option.
20512
20513
20514 .option escape_string appendfile string "see description"
20515 See &%check_string%& above.
20516
20517
20518 .option file appendfile string&!! unset
20519 This option is mutually exclusive with the &%directory%& option, but one of
20520 &%file%& or &%directory%& must be set, unless the delivery is the direct result
20521 of a redirection (see section &<<SECTfildiropt>>&). The &%file%& option
20522 specifies a single file, to which the message is appended. One or more of
20523 &%use_fcntl_lock%&, &%use_flock_lock%&, or &%use_lockfile%& must be set with
20524 &%file%&.
20525
20526 .cindex "NFS" "lock file"
20527 .cindex "locking files"
20528 .cindex "lock files"
20529 If you are using more than one host to deliver over NFS into the same
20530 mailboxes, you should always use lock files.
20531
20532 The string value is expanded for each delivery, and must yield an absolute
20533 path. The most common settings of this option are variations on one of these
20534 examples:
20535 .code
20536 file = /var/spool/mail/$local_part
20537 file = /home/$local_part/inbox
20538 file = $home/inbox
20539 .endd
20540 .cindex "&""sticky""& bit"
20541 In the first example, all deliveries are done into the same directory. If Exim
20542 is configured to use lock files (see &%use_lockfile%& below) it must be able to
20543 create a file in the directory, so the &"sticky"& bit must be turned on for
20544 deliveries to be possible, or alternatively the &%group%& option can be used to
20545 run the delivery under a group id which has write access to the directory.
20546
20547
20548
20549 .option file_format appendfile string unset
20550 .cindex "file" "mailbox; checking existing format"
20551 This option requests the transport to check the format of an existing file
20552 before adding to it. The check consists of matching a specific string at the
20553 start of the file. The value of the option consists of an even number of
20554 colon-separated strings. The first of each pair is the test string, and the
20555 second is the name of a transport. If the transport associated with a matched
20556 string is not the current transport, control is passed over to the other
20557 transport. For example, suppose the standard &(local_delivery)& transport has
20558 this added to it:
20559 .code
20560 file_format = "From       : local_delivery :\
20561                \1\1\1\1\n : local_mmdf_delivery"
20562 .endd
20563 Mailboxes that begin with &"From"& are still handled by this transport, but if
20564 a mailbox begins with four binary ones followed by a newline, control is passed
20565 to a transport called &%local_mmdf_delivery%&, which presumably is configured
20566 to do the delivery in MMDF format. If a mailbox does not exist or is empty, it
20567 is assumed to match the current transport. If the start of a mailbox doesn't
20568 match any string, or if the transport named for a given string is not defined,
20569 delivery is deferred.
20570
20571
20572 .option file_must_exist appendfile boolean false
20573 If this option is true, the file specified by the &%file%& option must exist.
20574 A temporary error occurs if it does not, causing delivery to be deferred.
20575 If this option is false, the file is created if it does not exist.
20576
20577
20578 .option lock_fcntl_timeout appendfile time 0s
20579 .cindex "timeout" "mailbox locking"
20580 .cindex "mailbox" "locking, blocking and non-blocking"
20581 .cindex "locking files"
20582 By default, the &(appendfile)& transport uses non-blocking calls to &[fcntl()]&
20583 when locking an open mailbox file. If the call fails, the delivery process
20584 sleeps for &%lock_interval%& and tries again, up to &%lock_retries%& times.
20585 Non-blocking calls are used so that the file is not kept open during the wait
20586 for the lock; the reason for this is to make it as safe as possible for
20587 deliveries over NFS in the case when processes might be accessing an NFS
20588 mailbox without using a lock file. This should not be done, but
20589 misunderstandings and hence misconfigurations are not unknown.
20590
20591 On a busy system, however, the performance of a non-blocking lock approach is
20592 not as good as using a blocking lock with a timeout. In this case, the waiting
20593 is done inside the system call, and Exim's delivery process acquires the lock
20594 and can proceed as soon as the previous lock holder releases it.
20595
20596 If &%lock_fcntl_timeout%& is set to a non-zero time, blocking locks, with that
20597 timeout, are used. There may still be some retrying: the maximum number of
20598 retries is
20599 .code
20600 (lock_retries * lock_interval) / lock_fcntl_timeout
20601 .endd
20602 rounded up to the next whole number. In other words, the total time during
20603 which &(appendfile)& is trying to get a lock is roughly the same, unless
20604 &%lock_fcntl_timeout%& is set very large.
20605
20606 You should consider setting this option if you are getting a lot of delayed
20607 local deliveries because of errors of the form
20608 .code
20609 failed to lock mailbox /some/file (fcntl)
20610 .endd
20611
20612 .option lock_flock_timeout appendfile time 0s
20613 This timeout applies to file locking when using &[flock()]& (see
20614 &%use_flock%&); the timeout operates in a similar manner to
20615 &%lock_fcntl_timeout%&.
20616
20617
20618 .option lock_interval appendfile time 3s
20619 This specifies the time to wait between attempts to lock the file. See below
20620 for details of locking.
20621
20622
20623 .option lock_retries appendfile integer 10
20624 This specifies the maximum number of attempts to lock the file. A value of zero
20625 is treated as 1. See below for details of locking.
20626
20627
20628 .option lockfile_mode appendfile "octal integer" 0600
20629 This specifies the mode of the created lock file, when a lock file is being
20630 used (see &%use_lockfile%& and &%use_mbx_lock%&).
20631
20632
20633 .option lockfile_timeout appendfile time 30m
20634 .cindex "timeout" "mailbox locking"
20635 When a lock file is being used (see &%use_lockfile%&), if a lock file already
20636 exists and is older than this value, it is assumed to have been left behind by
20637 accident, and Exim attempts to remove it.
20638
20639
20640 .option mailbox_filecount appendfile string&!! unset
20641 .cindex "mailbox" "specifying size of"
20642 .cindex "size" "of mailbox"
20643 If this option is set, it is expanded, and the result is taken as the current
20644 number of files in the mailbox. It must be a decimal number, optionally
20645 followed by K or M. This provides a way of obtaining this information from an
20646 external source that maintains the data.
20647
20648
20649 .option mailbox_size appendfile string&!! unset
20650 .cindex "mailbox" "specifying size of"
20651 .cindex "size" "of mailbox"
20652 If this option is set, it is expanded, and the result is taken as the current
20653 size the mailbox. It must be a decimal number, optionally followed by K or M.
20654 This provides a way of obtaining this information from an external source that
20655 maintains the data. This is likely to be helpful for maildir deliveries where
20656 it is computationally expensive to compute the size of a mailbox.
20657
20658
20659
20660 .option maildir_format appendfile boolean false
20661 .cindex "maildir format" "specifying"
20662 If this option is set with the &%directory%& option, the delivery is into a new
20663 file, in the &"maildir"& format that is used by other mail software. When the
20664 transport is activated directly from a &(redirect)& router (for example, the
20665 &(address_file)& transport in the default configuration), setting
20666 &%maildir_format%& causes the path received from the router to be treated as a
20667 directory, whether or not it ends with &`/`&. This option is available only if
20668 SUPPORT_MAILDIR is present in &_Local/Makefile_&. See section
20669 &<<SECTmaildirdelivery>>& below for further details.
20670
20671
20672 .option maildir_quota_directory_regex appendfile string "See below"
20673 .cindex "maildir format" "quota; directories included in"
20674 .cindex "quota" "maildir; directories included in"
20675 This option is relevant only when &%maildir_use_size_file%& is set. It defines
20676 a regular expression for specifying directories, relative to the quota
20677 directory (see &%quota_directory%&), that should be included in the quota
20678 calculation. The default value is:
20679 .code
20680 maildir_quota_directory_regex = ^(?:cur|new|\..*)$
20681 .endd
20682 This includes the &_cur_& and &_new_& directories, and any maildir++ folders
20683 (directories whose names begin with a dot). If you want to exclude the
20684 &_Trash_&
20685 folder from the count (as some sites do), you need to change this setting to
20686 .code
20687 maildir_quota_directory_regex = ^(?:cur|new|\.(?!Trash).*)$
20688 .endd
20689 This uses a negative lookahead in the regular expression to exclude the
20690 directory whose name is &_.Trash_&. When a directory is excluded from quota
20691 calculations, quota processing is bypassed for any messages that are delivered
20692 directly into that directory.
20693
20694
20695 .option maildir_retries appendfile integer 10
20696 This option specifies the number of times to retry when writing a file in
20697 &"maildir"& format. See section &<<SECTmaildirdelivery>>& below.
20698
20699
20700 .option maildir_tag appendfile string&!! unset
20701 This option applies only to deliveries in maildir format, and is described in
20702 section &<<SECTmaildirdelivery>>& below.
20703
20704
20705 .option maildir_use_size_file appendfile&!! boolean false
20706 .cindex "maildir format" "&_maildirsize_& file"
20707 The result of string expansion for this option must be a valid boolean value.
20708 If it is true, it enables support for &_maildirsize_& files. Exim
20709 creates a &_maildirsize_& file in a maildir if one does not exist, taking the
20710 quota from the &%quota%& option of the transport. If &%quota%& is unset, the
20711 value is zero. See &%maildir_quota_directory_regex%& above and section
20712 &<<SECTmaildirdelivery>>& below for further details.
20713
20714 .option maildirfolder_create_regex appendfile string unset
20715 .cindex "maildir format" "&_maildirfolder_& file"
20716 .cindex "&_maildirfolder_&, creating"
20717 The value of this option is a regular expression. If it is unset, it has no
20718 effect. Otherwise, before a maildir delivery takes place, the pattern is
20719 matched against the name of the maildir directory, that is, the directory
20720 containing the &_new_& and &_tmp_& subdirectories that will be used for the
20721 delivery. If there is a match, Exim checks for the existence of a file called
20722 &_maildirfolder_& in the directory, and creates it if it does not exist.
20723 See section &<<SECTmaildirdelivery>>& for more details.
20724
20725
20726 .option mailstore_format appendfile boolean false
20727 .cindex "mailstore format" "specifying"
20728 If this option is set with the &%directory%& option, the delivery is into two
20729 new files in  &"mailstore"& format. The option is available only if
20730 SUPPORT_MAILSTORE is present in &_Local/Makefile_&. See section &<<SECTopdir>>&
20731 below for further details.
20732
20733
20734 .option mailstore_prefix appendfile string&!! unset
20735 This option applies only to deliveries in mailstore format, and is described in
20736 section &<<SECTopdir>>& below.
20737
20738
20739 .option mailstore_suffix appendfile string&!! unset
20740 This option applies only to deliveries in mailstore format, and is described in
20741 section &<<SECTopdir>>& below.
20742
20743
20744 .option mbx_format appendfile boolean false
20745 .cindex "locking files"
20746 .cindex "file" "locking"
20747 .cindex "file" "MBX format"
20748 .cindex "MBX format, specifying"
20749 This option is available only if Exim has been compiled with SUPPORT_MBX
20750 set in &_Local/Makefile_&. If &%mbx_format%& is set with the &%file%& option,
20751 the message is appended to the mailbox file in MBX format instead of
20752 traditional Unix format. This format is supported by Pine4 and its associated
20753 IMAP and POP daemons, by means of the &'c-client'& library that they all use.
20754
20755 &*Note*&: The &%message_prefix%& and &%message_suffix%& options are not
20756 automatically changed by the use of &%mbx_format%&. They should normally be set
20757 empty when using MBX format, so this option almost always appears in this
20758 combination:
20759 .code
20760 mbx_format = true
20761 message_prefix =
20762 message_suffix =
20763 .endd
20764 If none of the locking options are mentioned in the configuration,
20765 &%use_mbx_lock%& is assumed and the other locking options default to false. It
20766 is possible to specify the other kinds of locking with &%mbx_format%&, but
20767 &%use_fcntl_lock%& and &%use_mbx_lock%& are mutually exclusive. MBX locking
20768 interworks with &'c-client'&, providing for shared access to the mailbox. It
20769 should not be used if any program that does not use this form of locking is
20770 going to access the mailbox, nor should it be used if the mailbox file is NFS
20771 mounted, because it works only when the mailbox is accessed from a single host.
20772
20773 If you set &%use_fcntl_lock%& with an MBX-format mailbox, you cannot use
20774 the standard version of &'c-client'&, because as long as it has a mailbox open
20775 (this means for the whole of a Pine or IMAP session), Exim will not be able to
20776 append messages to it.
20777
20778
20779 .option message_prefix appendfile string&!! "see below"
20780 .cindex "&""From""& line"
20781 The string specified here is expanded and output at the start of every message.
20782 The default is unset unless &%file%& is specified and &%use_bsmtp%& is not set,
20783 in which case it is:
20784 .code
20785 message_prefix = "From ${if def:return_path{$return_path}\
20786   {MAILER-DAEMON}} $tod_bsdinbox\n"
20787 .endd
20788 &*Note:*& If you set &%use_crlf%& true, you must change any occurrences of
20789 &`\n`& to &`\r\n`& in &%message_prefix%&.
20790
20791 .option message_suffix appendfile string&!! "see below"
20792 The string specified here is expanded and output at the end of every message.
20793 The default is unset unless &%file%& is specified and &%use_bsmtp%& is not set,
20794 in which case it is a single newline character. The suffix can be suppressed by
20795 setting
20796 .code
20797 message_suffix =
20798 .endd
20799 &*Note:*& If you set &%use_crlf%& true, you must change any occurrences of
20800 &`\n`& to &`\r\n`& in &%message_suffix%&.
20801
20802 .option mode appendfile "octal integer" 0600
20803 If the output file is created, it is given this mode. If it already exists and
20804 has wider permissions, they are reduced to this mode. If it has narrower
20805 permissions, an error occurs unless &%mode_fail_narrower%& is false. However,
20806 if the delivery is the result of a &%save%& command in a filter file specifying
20807 a particular mode, the mode of the output file is always forced to take that
20808 value, and this option is ignored.
20809
20810
20811 .option mode_fail_narrower appendfile boolean true
20812 This option applies in the case when an existing mailbox file has a narrower
20813 mode than that specified by the &%mode%& option. If &%mode_fail_narrower%& is
20814 true, the delivery is deferred (&"mailbox has the wrong mode"&); otherwise Exim
20815 continues with the delivery attempt, using the existing mode of the file.
20816
20817
20818 .option notify_comsat appendfile boolean false
20819 If this option is true, the &'comsat'& daemon is notified after every
20820 successful delivery to a user mailbox. This is the daemon that notifies logged
20821 on users about incoming mail.
20822
20823
20824 .option quota appendfile string&!! unset
20825 .cindex "quota" "imposed by Exim"
20826 This option imposes a limit on the size of the file to which Exim is appending,
20827 or to the total space used in the directory tree when the &%directory%& option
20828 is set. In the latter case, computation of the space used is expensive, because
20829 all the files in the directory (and any sub-directories) have to be
20830 individually inspected and their sizes summed. (See &%quota_size_regex%& and
20831 &%maildir_use_size_file%& for ways to avoid this in environments where users
20832 have no shell access to their mailboxes).
20833
20834 As there is no interlock against two simultaneous deliveries into a
20835 multi-file mailbox, it is possible for the quota to be overrun in this case.
20836 For single-file mailboxes, of course, an interlock is a necessity.
20837
20838 A file's size is taken as its &'used'& value. Because of blocking effects, this
20839 may be a lot less than the actual amount of disk space allocated to the file.
20840 If the sizes of a number of files are being added up, the rounding effect can
20841 become quite noticeable, especially on systems that have large block sizes.
20842 Nevertheless, it seems best to stick to the &'used'& figure, because this is
20843 the obvious value which users understand most easily.
20844
20845 The value of the option is expanded, and must then be a numerical value
20846 (decimal point allowed), optionally followed by one of the letters K, M, or G,
20847 for kilobytes, megabytes, or gigabytes. If Exim is running on a system with
20848 large file support (Linux and FreeBSD have this), mailboxes larger than 2G can
20849 be handled.
20850
20851 &*Note*&: A value of zero is interpreted as &"no quota"&.
20852
20853 The expansion happens while Exim is running as root, before it changes uid for
20854 the delivery. This means that files that are inaccessible to the end user can
20855 be used to hold quota values that are looked up in the expansion. When delivery
20856 fails because this quota is exceeded, the handling of the error is as for
20857 system quota failures.
20858
20859 By default, Exim's quota checking mimics system quotas, and restricts the
20860 mailbox to the specified maximum size, though the value is not accurate to the
20861 last byte, owing to separator lines and additional headers that may get added
20862 during message delivery. When a mailbox is nearly full, large messages may get
20863 refused even though small ones are accepted, because the size of the current
20864 message is added to the quota when the check is made. This behaviour can be
20865 changed by setting &%quota_is_inclusive%& false. When this is done, the check
20866 for exceeding the quota does not include the current message. Thus, deliveries
20867 continue until the quota has been exceeded; thereafter, no further messages are
20868 delivered. See also &%quota_warn_threshold%&.
20869
20870
20871 .option quota_directory appendfile string&!! unset
20872 This option defines the directory to check for quota purposes when delivering
20873 into individual files. The default is the delivery directory, or, if a file
20874 called &_maildirfolder_& exists in a maildir directory, the parent of the
20875 delivery directory.
20876
20877
20878 .option quota_filecount appendfile string&!! 0
20879 This option applies when the &%directory%& option is set. It limits the total
20880 number of files in the directory (compare the inode limit in system quotas). It
20881 can only be used if &%quota%& is also set. The value is expanded; an expansion
20882 failure causes delivery to be deferred. A value of zero is interpreted as
20883 &"no quota"&.
20884
20885
20886 .option quota_is_inclusive appendfile boolean true
20887 See &%quota%& above.
20888
20889
20890 .option quota_size_regex appendfile string unset
20891 This option applies when one of the delivery modes that writes a separate file
20892 for each message is being used. When Exim wants to find the size of one of
20893 these files in order to test the quota, it first checks &%quota_size_regex%&.
20894 If this is set to a regular expression that matches the file name, and it
20895 captures one string, that string is interpreted as a representation of the
20896 file's size. The value of &%quota_size_regex%& is not expanded.
20897
20898 This feature is useful only when users have no shell access to their mailboxes
20899 &-- otherwise they could defeat the quota simply by renaming the files. This
20900 facility can be used with maildir deliveries, by setting &%maildir_tag%& to add
20901 the file length to the file name. For example:
20902 .code
20903 maildir_tag = ,S=$message_size
20904 quota_size_regex = ,S=(\d+)
20905 .endd
20906 An alternative to &$message_size$& is &$message_linecount$&, which contains the
20907 number of lines in the message.
20908
20909 The regular expression should not assume that the length is at the end of the
20910 file name (even though &%maildir_tag%& puts it there) because maildir MUAs
20911 sometimes add other information onto the ends of message file names.
20912
20913 Section &<<SECID136>>& contains further information.
20914
20915
20916 .option quota_warn_message appendfile string&!! "see below"
20917 See below for the use of this option. If it is not set when
20918 &%quota_warn_threshold%& is set, it defaults to
20919 .code
20920 quota_warn_message = "\
20921   To: $local_part@$domain\n\
20922   Subject: Your mailbox\n\n\
20923   This message is automatically created \
20924   by mail delivery software.\n\n\
20925   The size of your mailbox has exceeded \
20926   a warning threshold that is\n\
20927   set by the system administrator.\n"
20928 .endd
20929
20930
20931 .option quota_warn_threshold appendfile string&!! 0
20932 .cindex "quota" "warning threshold"
20933 .cindex "mailbox" "size warning"
20934 .cindex "size" "of mailbox"
20935 This option is expanded in the same way as &%quota%& (see above). If the
20936 resulting value is greater than zero, and delivery of the message causes the
20937 size of the file or total space in the directory tree to cross the given
20938 threshold, a warning message is sent. If &%quota%& is also set, the threshold
20939 may be specified as a percentage of it by following the value with a percent
20940 sign. For example:
20941 .code
20942 quota = 10M
20943 quota_warn_threshold = 75%
20944 .endd
20945 If &%quota%& is not set, a setting of &%quota_warn_threshold%& that ends with a
20946 percent sign is ignored.
20947
20948 The warning message itself is specified by the &%quota_warn_message%& option,
20949 and it must start with a &'To:'& header line containing the recipient(s) of the
20950 warning message. These do not necessarily have to include the recipient(s) of
20951 the original message. A &'Subject:'& line should also normally be supplied. You
20952 can include any other header lines that you want. If you do not include a
20953 &'From:'& line, the default is:
20954 .code
20955 From: Mail Delivery System <mailer-daemon@$qualify_domain_sender>
20956 .endd
20957 .oindex &%errors_reply_to%&
20958 If you supply a &'Reply-To:'& line, it overrides the global &%errors_reply_to%&
20959 option.
20960
20961 The &%quota%& option does not have to be set in order to use this option; they
20962 are independent of one another except when the threshold is specified as a
20963 percentage.
20964
20965
20966 .option use_bsmtp appendfile boolean false
20967 .cindex "envelope sender"
20968 If this option is set true, &(appendfile)& writes messages in &"batch SMTP"&
20969 format, with the envelope sender and recipient(s) included as SMTP commands. If
20970 you want to include a leading HELO command with such messages, you can do
20971 so by setting the &%message_prefix%& option. See section &<<SECTbatchSMTP>>&
20972 for details of batch SMTP.
20973
20974
20975 .option use_crlf appendfile boolean false
20976 .cindex "carriage return"
20977 .cindex "linefeed"
20978 This option causes lines to be terminated with the two-character CRLF sequence
20979 (carriage return, linefeed) instead of just a linefeed character. In the case
20980 of batched SMTP, the byte sequence written to the file is then an exact image
20981 of what would be sent down a real SMTP connection.
20982
20983 &*Note:*& The contents of the &%message_prefix%& and &%message_suffix%& options
20984 (which are used to supply the traditional &"From&~"& and blank line separators
20985 in Berkeley-style mailboxes) are written verbatim, so must contain their own
20986 carriage return characters if these are needed. In cases where these options
20987 have non-empty defaults, the values end with a single linefeed, so they must be
20988 changed to end with &`\r\n`& if &%use_crlf%& is set.
20989
20990
20991 .option use_fcntl_lock appendfile boolean "see below"
20992 This option controls the use of the &[fcntl()]& function to lock a file for
20993 exclusive use when a message is being appended. It is set by default unless
20994 &%use_flock_lock%& is set. Otherwise, it should be turned off only if you know
20995 that all your MUAs use lock file locking. When both &%use_fcntl_lock%& and
20996 &%use_flock_lock%& are unset, &%use_lockfile%& must be set.
20997
20998
20999 .option use_flock_lock appendfile boolean false
21000 This option is provided to support the use of &[flock()]& for file locking, for
21001 the few situations where it is needed. Most modern operating systems support
21002 &[fcntl()]& and &[lockf()]& locking, and these two functions interwork with
21003 each other. Exim uses &[fcntl()]& locking by default.
21004
21005 This option is required only if you are using an operating system where
21006 &[flock()]& is used by programs that access mailboxes (typically MUAs), and
21007 where &[flock()]& does not correctly interwork with &[fcntl()]&. You can use
21008 both &[fcntl()]& and &[flock()]& locking simultaneously if you want.
21009
21010 .cindex "Solaris" "&[flock()]& support"
21011 Not all operating systems provide &[flock()]&. Some versions of Solaris do not
21012 have it (and some, I think, provide a not quite right version built on top of
21013 &[lockf()]&). If the OS does not have &[flock()]&, Exim will be built without
21014 the ability to use it, and any attempt to do so will cause a configuration
21015 error.
21016
21017 &*Warning*&: &[flock()]& locks do not work on NFS files (unless &[flock()]&
21018 is just being mapped onto &[fcntl()]& by the OS).
21019
21020
21021 .option use_lockfile appendfile boolean "see below"
21022 If this option is turned off, Exim does not attempt to create a lock file when
21023 appending to a mailbox file. In this situation, the only locking is by
21024 &[fcntl()]&. You should only turn &%use_lockfile%& off if you are absolutely
21025 sure that every MUA that is ever going to look at your users' mailboxes uses
21026 &[fcntl()]& rather than a lock file, and even then only when you are not
21027 delivering over NFS from more than one host.
21028
21029 .cindex "NFS" "lock file"
21030 In order to append to an NFS file safely from more than one host, it is
21031 necessary to take out a lock &'before'& opening the file, and the lock file
21032 achieves this. Otherwise, even with &[fcntl()]& locking, there is a risk of
21033 file corruption.
21034
21035 The &%use_lockfile%& option is set by default unless &%use_mbx_lock%& is set.
21036 It is not possible to turn both &%use_lockfile%& and &%use_fcntl_lock%& off,
21037 except when &%mbx_format%& is set.
21038
21039
21040 .option use_mbx_lock appendfile boolean "see below"
21041 This option is available only if Exim has been compiled with SUPPORT_MBX
21042 set in &_Local/Makefile_&. Setting the option specifies that special MBX
21043 locking rules be used. It is set by default if &%mbx_format%& is set and none
21044 of the locking options are mentioned in the configuration. The locking rules
21045 are the same as are used by the &'c-client'& library that underlies Pine and
21046 the IMAP4 and POP daemons that come with it (see the discussion below). The
21047 rules allow for shared access to the mailbox. However, this kind of locking
21048 does not work when the mailbox is NFS mounted.
21049
21050 You can set &%use_mbx_lock%& with either (or both) of &%use_fcntl_lock%& and
21051 &%use_flock_lock%& to control what kind of locking is used in implementing the
21052 MBX locking rules. The default is to use &[fcntl()]& if &%use_mbx_lock%& is set
21053 without &%use_fcntl_lock%& or &%use_flock_lock%&.
21054
21055
21056
21057
21058 .section "Operational details for appending" "SECTopappend"
21059 .cindex "appending to a file"
21060 .cindex "file" "appending"
21061 Before appending to a file, the following preparations are made:
21062
21063 .ilist
21064 If the name of the file is &_/dev/null_&, no action is taken, and a success
21065 return is given.
21066
21067 .next
21068 .cindex "directory creation"
21069 If any directories on the file's path are missing, Exim creates them if the
21070 &%create_directory%& option is set. A created directory's mode is given by the
21071 &%directory_mode%& option.
21072
21073 .next
21074 If &%file_format%& is set, the format of an existing file is checked. If this
21075 indicates that a different transport should be used, control is passed to that
21076 transport.
21077
21078 .next
21079 .cindex "file" "locking"
21080 .cindex "locking files"
21081 .cindex "NFS" "lock file"
21082 If &%use_lockfile%& is set, a lock file is built in a way that will work
21083 reliably over NFS, as follows:
21084
21085 .olist
21086 Create a &"hitching post"& file whose name is that of the lock file with the
21087 current time, primary host name, and process id added, by opening for writing
21088 as a new file. If this fails with an access error, delivery is deferred.
21089 .next
21090 Close the hitching post file, and hard link it to the lock file name.
21091 .next
21092 If the call to &[link()]& succeeds, creation of the lock file has succeeded.
21093 Unlink the hitching post name.
21094 .next
21095 Otherwise, use &[stat()]& to get information about the hitching post file, and
21096 then unlink hitching post name. If the number of links is exactly two, creation
21097 of the lock file succeeded but something (for example, an NFS server crash and
21098 restart) caused this fact not to be communicated to the &[link()]& call.
21099 .next
21100 If creation of the lock file failed, wait for &%lock_interval%& and try again,
21101 up to &%lock_retries%& times. However, since any program that writes to a
21102 mailbox should complete its task very quickly, it is reasonable to time out old
21103 lock files that are normally the result of user agent and system crashes. If an
21104 existing lock file is older than &%lockfile_timeout%& Exim attempts to unlink
21105 it before trying again.
21106 .endlist olist
21107
21108 .next
21109 A call is made to &[lstat()]& to discover whether the main file exists, and if
21110 so, what its characteristics are. If &[lstat()]& fails for any reason other
21111 than non-existence, delivery is deferred.
21112
21113 .next
21114 .cindex "symbolic link" "to mailbox"
21115 .cindex "mailbox" "symbolic link"
21116 If the file does exist and is a symbolic link, delivery is deferred, unless the
21117 &%allow_symlink%& option is set, in which case the ownership of the link is
21118 checked, and then &[stat()]& is called to find out about the real file, which
21119 is then subjected to the checks below. The check on the top-level link
21120 ownership prevents one user creating a link for another's mailbox in a sticky
21121 directory, though allowing symbolic links in this case is definitely not a good
21122 idea. If there is a chain of symbolic links, the intermediate ones are not
21123 checked.
21124
21125 .next
21126 If the file already exists but is not a regular file, or if the file's owner
21127 and group (if the group is being checked &-- see &%check_group%& above) are
21128 different from the user and group under which the delivery is running,
21129 delivery is deferred.
21130
21131 .next
21132 If the file's permissions are more generous than specified, they are reduced.
21133 If they are insufficient, delivery is deferred, unless &%mode_fail_narrower%&
21134 is set false, in which case the delivery is tried using the existing
21135 permissions.
21136
21137 .next
21138 The file's inode number is saved, and the file is then opened for appending.
21139 If this fails because the file has vanished, &(appendfile)& behaves as if it
21140 hadn't existed (see below). For any other failures, delivery is deferred.
21141
21142 .next
21143 If the file is opened successfully, check that the inode number hasn't
21144 changed, that it is still a regular file, and that the owner and permissions
21145 have not changed. If anything is wrong, defer delivery and freeze the message.
21146
21147 .next
21148 If the file did not exist originally, defer delivery if the &%file_must_exist%&
21149 option is set. Otherwise, check that the file is being created in a permitted
21150 directory if the &%create_file%& option is set (deferring on failure), and then
21151 open for writing as a new file, with the O_EXCL and O_CREAT options,
21152 except when dealing with a symbolic link (the &%allow_symlink%& option must be
21153 set). In this case, which can happen if the link points to a non-existent file,
21154 the file is opened for writing using O_CREAT but not O_EXCL, because
21155 that prevents link following.
21156
21157 .next
21158 .cindex "loop" "while file testing"
21159 If opening fails because the file exists, obey the tests given above for
21160 existing files. However, to avoid looping in a situation where the file is
21161 being continuously created and destroyed, the exists/not-exists loop is broken
21162 after 10 repetitions, and the message is then frozen.
21163
21164 .next
21165 If opening fails with any other error, defer delivery.
21166
21167 .next
21168 .cindex "file" "locking"
21169 .cindex "locking files"
21170 Once the file is open, unless both &%use_fcntl_lock%& and &%use_flock_lock%&
21171 are false, it is locked using &[fcntl()]& or &[flock()]& or both. If
21172 &%use_mbx_lock%& is false, an exclusive lock is requested in each case.
21173 However, if &%use_mbx_lock%& is true, Exim takes out a shared lock on the open
21174 file, and an exclusive lock on the file whose name is
21175 .code
21176 /tmp/.<device-number>.<inode-number>
21177 .endd
21178 using the device and inode numbers of the open mailbox file, in accordance with
21179 the MBX locking rules. This file is created with a mode that is specified by
21180 the &%lockfile_mode%& option.
21181
21182 If Exim fails to lock the file, there are two possible courses of action,
21183 depending on the value of the locking timeout. This is obtained from
21184 &%lock_fcntl_timeout%& or &%lock_flock_timeout%&, as appropriate.
21185
21186 If the timeout value is zero, the file is closed, Exim waits for
21187 &%lock_interval%&, and then goes back and re-opens the file as above and tries
21188 to lock it again. This happens up to &%lock_retries%& times, after which the
21189 delivery is deferred.
21190
21191 If the timeout has a value greater than zero, blocking calls to &[fcntl()]& or
21192 &[flock()]& are used (with the given timeout), so there has already been some
21193 waiting involved by the time locking fails. Nevertheless, Exim does not give up
21194 immediately. It retries up to
21195 .code
21196 (lock_retries * lock_interval) / <timeout>
21197 .endd
21198 times (rounded up).
21199 .endlist
21200
21201 At the end of delivery, Exim closes the file (which releases the &[fcntl()]&
21202 and/or &[flock()]& locks) and then deletes the lock file if one was created.
21203
21204
21205 .section "Operational details for delivery to a new file" "SECTopdir"
21206 .cindex "delivery" "to single file"
21207 .cindex "&""From""& line"
21208 When the &%directory%& option is set instead of &%file%&, each message is
21209 delivered into a newly-created file or set of files. When &(appendfile)& is
21210 activated directly from a &(redirect)& router, neither &%file%& nor
21211 &%directory%& is normally set, because the path for delivery is supplied by the
21212 router. (See for example, the &(address_file)& transport in the default
21213 configuration.) In this case, delivery is to a new file if either the path name
21214 ends in &`/`&, or the &%maildir_format%& or &%mailstore_format%& option is set.
21215
21216 No locking is required while writing the message to a new file, so the various
21217 locking options of the transport are ignored. The &"From"& line that by default
21218 separates messages in a single file is not normally needed, nor is the escaping
21219 of message lines that start with &"From"&, and there is no need to ensure a
21220 newline at the end of each message. Consequently, the default values for
21221 &%check_string%&, &%message_prefix%&, and &%message_suffix%& are all unset when
21222 any of &%directory%&, &%maildir_format%&, or &%mailstore_format%& is set.
21223
21224 If Exim is required to check a &%quota%& setting, it adds up the sizes of all
21225 the files in the delivery directory by default. However, you can specify a
21226 different directory by setting &%quota_directory%&. Also, for maildir
21227 deliveries (see below) the &_maildirfolder_& convention is honoured.
21228
21229
21230 .cindex "maildir format"
21231 .cindex "mailstore format"
21232 There are three different ways in which delivery to individual files can be
21233 done, controlled by the settings of the &%maildir_format%& and
21234 &%mailstore_format%& options. Note that code to support maildir or mailstore
21235 formats is not included in the binary unless SUPPORT_MAILDIR or
21236 SUPPORT_MAILSTORE, respectively, is set in &_Local/Makefile_&.
21237
21238 .cindex "directory creation"
21239 In all three cases an attempt is made to create the directory and any necessary
21240 sub-directories if they do not exist, provided that the &%create_directory%&
21241 option is set (the default). The location of a created directory can be
21242 constrained by setting &%create_file%&. A created directory's mode is given by
21243 the &%directory_mode%& option. If creation fails, or if the
21244 &%create_directory%& option is not set when creation is required, delivery is
21245 deferred.
21246
21247
21248
21249 .section "Maildir delivery" "SECTmaildirdelivery"
21250 .cindex "maildir format" "description of"
21251 If the &%maildir_format%& option is true, Exim delivers each message by writing
21252 it to a file whose name is &_tmp/<stime>.H<mtime>P<pid>.<host>_& in the
21253 directory that is defined by the &%directory%& option (the &"delivery
21254 directory"&). If the delivery is successful, the file is renamed into the
21255 &_new_& subdirectory.
21256
21257 In the file name, <&'stime'&> is the current time of day in seconds, and
21258 <&'mtime'&> is the microsecond fraction of the time. After a maildir delivery,
21259 Exim checks that the time-of-day clock has moved on by at least one microsecond
21260 before terminating the delivery process. This guarantees uniqueness for the
21261 file name. However, as a precaution, Exim calls &[stat()]& for the file before
21262 opening it. If any response other than ENOENT (does not exist) is given,
21263 Exim waits 2 seconds and tries again, up to &%maildir_retries%& times.
21264
21265 Before Exim carries out a maildir delivery, it ensures that subdirectories
21266 called &_new_&, &_cur_&, and &_tmp_& exist in the delivery directory. If they
21267 do not exist, Exim tries to create them and any superior directories in their
21268 path, subject to the &%create_directory%& and &%create_file%& options. If the
21269 &%maildirfolder_create_regex%& option is set, and the regular expression it
21270 contains matches the delivery directory, Exim also ensures that a file called
21271 &_maildirfolder_& exists in the delivery directory. If a missing directory or
21272 &_maildirfolder_& file cannot be created, delivery is deferred.
21273
21274 These features make it possible to use Exim to create all the necessary files
21275 and directories in a maildir mailbox, including subdirectories for maildir++
21276 folders. Consider this example:
21277 .code
21278 maildir_format = true
21279 directory = /var/mail/$local_part\
21280            ${if eq{$local_part_suffix}{}{}\
21281            {/.${substr_1:$local_part_suffix}}}
21282 maildirfolder_create_regex = /\.[^/]+$
21283 .endd
21284 If &$local_part_suffix$& is empty (there was no suffix for the local part),
21285 delivery is into a toplevel maildir with a name like &_/var/mail/pimbo_& (for
21286 the user called &'pimbo'&). The pattern in &%maildirfolder_create_regex%& does
21287 not match this name, so Exim will not look for or create the file
21288 &_/var/mail/pimbo/maildirfolder_&, though it will create
21289 &_/var/mail/pimbo/{cur,new,tmp}_& if necessary.
21290
21291 However, if &$local_part_suffix$& contains &`-eximusers`& (for example),
21292 delivery is into the maildir++ folder &_/var/mail/pimbo/.eximusers_&, which
21293 does match &%maildirfolder_create_regex%&. In this case, Exim will create
21294 &_/var/mail/pimbo/.eximusers/maildirfolder_& as well as the three maildir
21295 directories &_/var/mail/pimbo/.eximusers/{cur,new,tmp}_&.
21296
21297 &*Warning:*& Take care when setting &%maildirfolder_create_regex%& that it does
21298 not inadvertently match the toplevel maildir directory, because a
21299 &_maildirfolder_& file at top level would completely break quota calculations.
21300
21301 .cindex "quota" "in maildir delivery"
21302 .cindex "maildir++"
21303 If Exim is required to check a &%quota%& setting before a maildir delivery, and
21304 &%quota_directory%& is not set, it looks for a file called &_maildirfolder_& in
21305 the maildir directory (alongside &_new_&, &_cur_&, &_tmp_&). If this exists,
21306 Exim assumes the directory is a maildir++ folder directory, which is one level
21307 down from the user's top level mailbox directory. This causes it to start at
21308 the parent directory instead of the current directory when calculating the
21309 amount of space used.
21310
21311 One problem with delivering into a multi-file mailbox is that it is
21312 computationally expensive to compute the size of the mailbox for quota
21313 checking. Various approaches have been taken to reduce the amount of work
21314 needed. The next two sections describe two of them. A third alternative is to
21315 use some external process for maintaining the size data, and use the expansion
21316 of the &%mailbox_size%& option as a way of importing it into Exim.
21317
21318
21319
21320
21321 .section "Using tags to record message sizes" "SECID135"
21322 If &%maildir_tag%& is set, the string is expanded for each delivery.
21323 When the maildir file is renamed into the &_new_& sub-directory, the
21324 tag is added to its name. However, if adding the tag takes the length of the
21325 name to the point where the test &[stat()]& call fails with ENAMETOOLONG,
21326 the tag is dropped and the maildir file is created with no tag.
21327
21328
21329 .vindex "&$message_size$&"
21330 Tags can be used to encode the size of files in their names; see
21331 &%quota_size_regex%& above for an example. The expansion of &%maildir_tag%&
21332 happens after the message has been written. The value of the &$message_size$&
21333 variable is set to the number of bytes actually written. If the expansion is
21334 forced to fail, the tag is ignored, but a non-forced failure causes delivery to
21335 be deferred. The expanded tag may contain any printing characters except &"/"&.
21336 Non-printing characters in the string are ignored; if the resulting string is
21337 empty, it is ignored. If it starts with an alphanumeric character, a leading
21338 colon is inserted; this default has not proven to be the path that popular
21339 maildir implementations have chosen (but changing it in Exim would break
21340 backwards compatibility).
21341
21342 For one common implementation, you might set:
21343 .code
21344 maildir_tag = ,S=${message_size}
21345 .endd
21346 but you should check the documentation of the other software to be sure.
21347
21348 It is advisable to also set &%quota_size_regex%& when setting &%maildir_tag%&
21349 as this allows Exim to extract the size from your tag, instead of having to
21350 &[stat()]& each message file.
21351
21352
21353 .section "Using a maildirsize file" "SECID136"
21354 .cindex "quota" "in maildir delivery"
21355 .cindex "maildir format" "&_maildirsize_& file"
21356 If &%maildir_use_size_file%& is true, Exim implements the maildir++ rules for
21357 storing quota and message size information in a file called &_maildirsize_&
21358 within the toplevel maildir directory. If this file does not exist, Exim
21359 creates it, setting the quota from the &%quota%& option of the transport. If
21360 the maildir directory itself does not exist, it is created before any attempt
21361 to write a &_maildirsize_& file.
21362
21363 The &_maildirsize_& file is used to hold information about the sizes of
21364 messages in the maildir, thus speeding up quota calculations. The quota value
21365 in the file is just a cache; if the quota is changed in the transport, the new
21366 value overrides the cached value when the next message is delivered. The cache
21367 is maintained for the benefit of other programs that access the maildir and
21368 need to know the quota.
21369
21370 If the &%quota%& option in the transport is unset or zero, the &_maildirsize_&
21371 file is maintained (with a zero quota setting), but no quota is imposed.
21372
21373 A regular expression is available for controlling which directories in the
21374 maildir participate in quota calculations when a &_maildirsizefile_& is in use.
21375 See the description of the &%maildir_quota_directory_regex%& option above for
21376 details.
21377
21378
21379 .section "Mailstore delivery" "SECID137"
21380 .cindex "mailstore format" "description of"
21381 If the &%mailstore_format%& option is true, each message is written as two
21382 files in the given directory. A unique base name is constructed from the
21383 message id and the current delivery process, and the files that are written use
21384 this base name plus the suffixes &_.env_& and &_.msg_&. The &_.env_& file
21385 contains the message's envelope, and the &_.msg_& file contains the message
21386 itself. The base name is placed in the variable &$mailstore_basename$&.
21387
21388 During delivery, the envelope is first written to a file with the suffix
21389 &_.tmp_&. The &_.msg_& file is then written, and when it is complete, the
21390 &_.tmp_& file is renamed as the &_.env_& file. Programs that access messages in
21391 mailstore format should wait for the presence of both a &_.msg_& and a &_.env_&
21392 file before accessing either of them. An alternative approach is to wait for
21393 the absence of a &_.tmp_& file.
21394
21395 The envelope file starts with any text defined by the &%mailstore_prefix%&
21396 option, expanded and terminated by a newline if there isn't one. Then follows
21397 the sender address on one line, then all the recipient addresses, one per line.
21398 There can be more than one recipient only if the &%batch_max%& option is set
21399 greater than one. Finally, &%mailstore_suffix%& is expanded and the result
21400 appended to the file, followed by a newline if it does not end with one.
21401
21402 If expansion of &%mailstore_prefix%& or &%mailstore_suffix%& ends with a forced
21403 failure, it is ignored. Other expansion errors are treated as serious
21404 configuration errors, and delivery is deferred. The variable
21405 &$mailstore_basename$& is available for use during these expansions.
21406
21407
21408 .section "Non-special new file delivery" "SECID138"
21409 If neither &%maildir_format%& nor &%mailstore_format%& is set, a single new
21410 file is created directly in the named directory. For example, when delivering
21411 messages into files in batched SMTP format for later delivery to some host (see
21412 section &<<SECTbatchSMTP>>&), a setting such as
21413 .code
21414 directory = /var/bsmtp/$host
21415 .endd
21416 might be used. A message is written to a file with a temporary name, which is
21417 then renamed when the delivery is complete. The final name is obtained by
21418 expanding the contents of the &%directory_file%& option.
21419 .ecindex IIDapptra1
21420 .ecindex IIDapptra2
21421
21422
21423
21424
21425
21426
21427 . ////////////////////////////////////////////////////////////////////////////
21428 . ////////////////////////////////////////////////////////////////////////////
21429
21430 .chapter "The autoreply transport" "CHID8"
21431 .scindex IIDauttra1 "transports" "&(autoreply)&"
21432 .scindex IIDauttra2 "&(autoreply)& transport"
21433 The &(autoreply)& transport is not a true transport in that it does not cause
21434 the message to be transmitted. Instead, it generates a new mail message as an
21435 automatic reply to the incoming message. &'References:'& and
21436 &'Auto-Submitted:'& header lines are included. These are constructed according
21437 to the rules in RFCs 2822 and 3834, respectively.
21438
21439 If the router that passes the message to this transport does not have the
21440 &%unseen%& option set, the original message (for the current recipient) is not
21441 delivered anywhere. However, when the &%unseen%& option is set on the router
21442 that passes the message to this transport, routing of the address continues, so
21443 another router can set up a normal message delivery.
21444
21445
21446 The &(autoreply)& transport is usually run as the result of mail filtering, a
21447 &"vacation"& message being the standard example. However, it can also be run
21448 directly from a router like any other transport. To reduce the possibility of
21449 message cascades, messages created by the &(autoreply)& transport always have
21450 empty envelope sender addresses, like bounce messages.
21451
21452 The parameters of the message to be sent can be specified in the configuration
21453 by options described below. However, these are used only when the address
21454 passed to the transport does not contain its own reply information. When the
21455 transport is run as a consequence of a
21456 &%mail%&
21457 or &%vacation%& command in a filter file, the parameters of the message are
21458 supplied by the filter, and passed with the address. The transport's options
21459 that define the message are then ignored (so they are not usually set in this
21460 case). The message is specified entirely by the filter or by the transport; it
21461 is never built from a mixture of options. However, the &%file_optional%&,
21462 &%mode%&, and &%return_message%& options apply in all cases.
21463
21464 &(Autoreply)& is implemented as a local transport. When used as a result of a
21465 command in a user's filter file, &(autoreply)& normally runs under the uid and
21466 gid of the user, and with appropriate current and home directories (see chapter
21467 &<<CHAPenvironment>>&).
21468
21469 There is a subtle difference between routing a message to a &(pipe)& transport
21470 that generates some text to be returned to the sender, and routing it to an
21471 &(autoreply)& transport. This difference is noticeable only if more than one
21472 address from the same message is so handled. In the case of a pipe, the
21473 separate outputs from the different addresses are gathered up and returned to
21474 the sender in a single message, whereas if &(autoreply)& is used, a separate
21475 message is generated for each address that is passed to it.
21476
21477 Non-printing characters are not permitted in the header lines generated for the
21478 message that &(autoreply)& creates, with the exception of newlines that are
21479 immediately followed by white space. If any non-printing characters are found,
21480 the transport defers.
21481 Whether characters with the top bit set count as printing characters or not is
21482 controlled by the &%print_topbitchars%& global option.
21483
21484 If any of the generic options for manipulating headers (for example,
21485 &%headers_add%&) are set on an &(autoreply)& transport, they apply to the copy
21486 of the original message that is included in the generated message when
21487 &%return_message%& is set. They do not apply to the generated message itself.
21488
21489 .vindex "&$sender_address$&"
21490 If the &(autoreply)& transport receives return code 2 from Exim when it submits
21491 the message, indicating that there were no recipients, it does not treat this
21492 as an error. This means that autoreplies sent to &$sender_address$& when this
21493 is empty (because the incoming message is a bounce message) do not cause
21494 problems. They are just discarded.
21495
21496
21497
21498 .section "Private options for autoreply" "SECID139"
21499 .cindex "options" "&(autoreply)& transport"
21500
21501 .option bcc autoreply string&!! unset
21502 This specifies the addresses that are to receive &"blind carbon copies"& of the
21503 message when the message is specified by the transport.
21504
21505
21506 .option cc autoreply string&!! unset
21507 This specifies recipients of the message and the contents of the &'Cc:'& header
21508 when the message is specified by the transport.
21509
21510
21511 .option file autoreply string&!! unset
21512 The contents of the file are sent as the body of the message when the message
21513 is specified by the transport. If both &%file%& and &%text%& are set, the text
21514 string comes first.
21515
21516
21517 .option file_expand autoreply boolean false
21518 If this is set, the contents of the file named by the &%file%& option are
21519 subjected to string expansion as they are added to the message.
21520
21521
21522 .option file_optional autoreply boolean false
21523 If this option is true, no error is generated if the file named by the &%file%&
21524 option or passed with the address does not exist or cannot be read.
21525
21526
21527 .option from autoreply string&!! unset
21528 This specifies the contents of the &'From:'& header when the message is
21529 specified by the transport.
21530
21531
21532 .option headers autoreply string&!! unset
21533 This specifies additional RFC 2822 headers that are to be added to the message
21534 when the message is specified by the transport. Several can be given by using
21535 &"\n"& to separate them. There is no check on the format.
21536
21537
21538 .option log autoreply string&!! unset
21539 This option names a file in which a record of every message sent is logged when
21540 the message is specified by the transport.
21541
21542
21543 .option mode autoreply "octal integer" 0600
21544 If either the log file or the &"once"& file has to be created, this mode is
21545 used.
21546
21547
21548 .option never_mail autoreply "address list&!!" unset
21549 If any run of the transport creates a message with a recipient that matches any
21550 item in the list, that recipient is quietly discarded. If all recipients are
21551 discarded, no message is created. This applies both when the recipients are
21552 generated by a filter and when they are specified in the transport.
21553
21554
21555
21556 .option once autoreply string&!! unset
21557 This option names a file or DBM database in which a record of each &'To:'&
21558 recipient is kept when the message is specified by the transport. &*Note*&:
21559 This does not apply to &'Cc:'& or &'Bcc:'& recipients.
21560
21561 If &%once%& is unset, or is set to an empty string, the message is always sent.
21562 By default, if &%once%& is set to a non-empty file name, the message
21563 is not sent if a potential recipient is already listed in the database.
21564 However, if the &%once_repeat%& option specifies a time greater than zero, the
21565 message is sent if that much time has elapsed since a message was last sent to
21566 this recipient. A setting of zero time for &%once_repeat%& (the default)
21567 prevents a message from being sent a second time &-- in this case, zero means
21568 infinity.
21569
21570 If &%once_file_size%& is zero, a DBM database is used to remember recipients,
21571 and it is allowed to grow as large as necessary. If &%once_file_size%& is set
21572 greater than zero, it changes the way Exim implements the &%once%& option.
21573 Instead of using a DBM file to record every recipient it sends to, it uses a
21574 regular file, whose size will never get larger than the given value.
21575
21576 In the file, Exim keeps a linear list of recipient addresses and the times at
21577 which they were sent messages. If the file is full when a new address needs to
21578 be added, the oldest address is dropped. If &%once_repeat%& is not set, this
21579 means that a given recipient may receive multiple messages, but at
21580 unpredictable intervals that depend on the rate of turnover of addresses in the
21581 file. If &%once_repeat%& is set, it specifies a maximum time between repeats.
21582
21583
21584 .option once_file_size autoreply integer 0
21585 See &%once%& above.
21586
21587
21588 .option once_repeat autoreply time&!! 0s
21589 See &%once%& above.
21590 After expansion, the value of this option must be a valid time value.
21591
21592
21593 .option reply_to autoreply string&!! unset
21594 This specifies the contents of the &'Reply-To:'& header when the message is
21595 specified by the transport.
21596
21597
21598 .option return_message autoreply boolean false
21599 If this is set, a copy of the original message is returned with the new
21600 message, subject to the maximum size set in the &%return_size_limit%& global
21601 configuration option.
21602
21603
21604 .option subject autoreply string&!! unset
21605 This specifies the contents of the &'Subject:'& header when the message is
21606 specified by the transport. It is tempting to quote the original subject in
21607 automatic responses. For example:
21608 .code
21609 subject = Re: $h_subject:
21610 .endd
21611 There is a danger in doing this, however. It may allow a third party to
21612 subscribe your users to an opt-in mailing list, provided that the list accepts
21613 bounce messages as subscription confirmations. Well-managed lists require a
21614 non-bounce message to confirm a subscription, so the danger is relatively
21615 small.
21616
21617
21618
21619 .option text autoreply string&!! unset
21620 This specifies a single string to be used as the body of the message when the
21621 message is specified by the transport. If both &%text%& and &%file%& are set,
21622 the text comes first.
21623
21624
21625 .option to autoreply string&!! unset
21626 This specifies recipients of the message and the contents of the &'To:'& header
21627 when the message is specified by the transport.
21628 .ecindex IIDauttra1
21629 .ecindex IIDauttra2
21630
21631
21632
21633
21634 . ////////////////////////////////////////////////////////////////////////////
21635 . ////////////////////////////////////////////////////////////////////////////
21636
21637 .chapter "The lmtp transport" "CHAPLMTP"
21638 .cindex "transports" "&(lmtp)&"
21639 .cindex "&(lmtp)& transport"
21640 .cindex "LMTP" "over a pipe"
21641 .cindex "LMTP" "over a socket"
21642 The &(lmtp)& transport runs the LMTP protocol (RFC 2033) over a pipe to a
21643 specified command
21644 or by interacting with a Unix domain socket.
21645 This transport is something of a cross between the &(pipe)& and &(smtp)&
21646 transports. Exim also has support for using LMTP over TCP/IP; this is
21647 implemented as an option for the &(smtp)& transport. Because LMTP is expected
21648 to be of minority interest, the default build-time configure in &_src/EDITME_&
21649 has it commented out. You need to ensure that
21650 .code
21651 TRANSPORT_LMTP=yes
21652 .endd
21653 .cindex "options" "&(lmtp)& transport"
21654 is present in your &_Local/Makefile_& in order to have the &(lmtp)& transport
21655 included in the Exim binary. The private options of the &(lmtp)& transport are
21656 as follows:
21657
21658 .option batch_id lmtp string&!! unset
21659 See the description of local delivery batching in chapter &<<CHAPbatching>>&.
21660
21661
21662 .option batch_max lmtp integer 1
21663 This limits the number of addresses that can be handled in a single delivery.
21664 Most LMTP servers can handle several addresses at once, so it is normally a
21665 good idea to increase this value. See the description of local delivery
21666 batching in chapter &<<CHAPbatching>>&.
21667
21668
21669 .option command lmtp string&!! unset
21670 This option must be set if &%socket%& is not set. The string is a command which
21671 is run in a separate process. It is split up into a command name and list of
21672 arguments, each of which is separately expanded (so expansion cannot change the
21673 number of arguments). The command is run directly, not via a shell. The message
21674 is passed to the new process using the standard input and output to operate the
21675 LMTP protocol.
21676
21677 .option ignore_quota lmtp boolean false
21678 .cindex "LMTP" "ignoring quota errors"
21679 If this option is set true, the string &`IGNOREQUOTA`& is added to RCPT
21680 commands, provided that the LMTP server has advertised support for IGNOREQUOTA
21681 in its response to the LHLO command.
21682
21683 .option socket lmtp string&!! unset
21684 This option must be set if &%command%& is not set. The result of expansion must
21685 be the name of a Unix domain socket. The transport connects to the socket and
21686 delivers the message to it using the LMTP protocol.
21687
21688
21689 .option timeout lmtp time 5m
21690 The transport is aborted if the created process or Unix domain socket does not
21691 respond to LMTP commands or message input within this timeout. Delivery
21692 is deferred, and will be tried again later. Here is an example of a typical
21693 LMTP transport:
21694 .code
21695 lmtp:
21696   driver = lmtp
21697   command = /some/local/lmtp/delivery/program
21698   batch_max = 20
21699   user = exim
21700 .endd
21701 This delivers up to 20 addresses at a time, in a mixture of domains if
21702 necessary, running as the user &'exim'&.
21703
21704
21705
21706 . ////////////////////////////////////////////////////////////////////////////
21707 . ////////////////////////////////////////////////////////////////////////////
21708
21709 .chapter "The pipe transport" "CHAPpipetransport"
21710 .scindex IIDpiptra1 "transports" "&(pipe)&"
21711 .scindex IIDpiptra2 "&(pipe)& transport"
21712 The &(pipe)& transport is used to deliver messages via a pipe to a command
21713 running in another process. One example is the use of &(pipe)& as a
21714 pseudo-remote transport for passing messages to some other delivery mechanism
21715 (such as UUCP). Another is the use by individual users to automatically process
21716 their incoming messages. The &(pipe)& transport can be used in one of the
21717 following ways:
21718
21719 .ilist
21720 .vindex "&$local_part$&"
21721 A router routes one address to a transport in the normal way, and the
21722 transport is configured as a &(pipe)& transport. In this case, &$local_part$&
21723 contains the local part of the address (as usual), and the command that is run
21724 is specified by the &%command%& option on the transport.
21725 .next
21726 .vindex "&$pipe_addresses$&"
21727 If the &%batch_max%& option is set greater than 1 (the default is 1), the
21728 transport can handle more than one address in a single run. In this case, when
21729 more than one address is routed to the transport, &$local_part$& is not set
21730 (because it is not unique). However, the pseudo-variable &$pipe_addresses$&
21731 (described in section &<<SECThowcommandrun>>& below) contains all the addresses
21732 that are routed to the transport.
21733 .next
21734 .vindex "&$address_pipe$&"
21735 A router redirects an address directly to a pipe command (for example, from an
21736 alias or forward file). In this case, &$address_pipe$& contains the text of the
21737 pipe command, and the &%command%& option on the transport is ignored unless
21738 &%force_command%& is set. If only one address is being transported
21739 (&%batch_max%& is not greater than one, or only one address was redirected to
21740 this pipe command), &$local_part$& contains the local part that was redirected.
21741 .endlist
21742
21743
21744 The &(pipe)& transport is a non-interactive delivery method. Exim can also
21745 deliver messages over pipes using the LMTP interactive protocol. This is
21746 implemented by the &(lmtp)& transport.
21747
21748 In the case when &(pipe)& is run as a consequence of an entry in a local user's
21749 &_.forward_& file, the command runs under the uid and gid of that user. In
21750 other cases, the uid and gid have to be specified explicitly, either on the
21751 transport or on the router that handles the address. Current and &"home"&
21752 directories are also controllable. See chapter &<<CHAPenvironment>>& for
21753 details of the local delivery environment and chapter &<<CHAPbatching>>&
21754 for a discussion of local delivery batching.
21755
21756
21757 .section "Concurrent delivery" "SECID140"
21758 If two messages arrive at almost the same time, and both are routed to a pipe
21759 delivery, the two pipe transports may be run concurrently. You must ensure that
21760 any pipe commands you set up are robust against this happening. If the commands
21761 write to a file, the &%exim_lock%& utility might be of use.
21762
21763
21764
21765
21766 .section "Returned status and data" "SECID141"
21767 .cindex "&(pipe)& transport" "returned data"
21768 If the command exits with a non-zero return code, the delivery is deemed to
21769 have failed, unless either the &%ignore_status%& option is set (in which case
21770 the return code is treated as zero), or the return code is one of those listed
21771 in the &%temp_errors%& option, which are interpreted as meaning &"try again
21772 later"&. In this case, delivery is deferred. Details of a permanent failure are
21773 logged, but are not included in the bounce message, which merely contains
21774 &"local delivery failed"&.
21775
21776 If the command exits on a signal and the &%freeze_signal%& option is set then
21777 the message will be frozen in the queue. If that option is not set, a bounce
21778 will be sent as normal.
21779
21780 If the return code is greater than 128 and the command being run is a shell
21781 script, it normally means that the script was terminated by a signal whose
21782 value is the return code minus 128. The &%freeze_signal%& option does not
21783 apply in this case.
21784
21785 If Exim is unable to run the command (that is, if &[execve()]& fails), the
21786 return code is set to 127. This is the value that a shell returns if it is
21787 asked to run a non-existent command. The wording for the log line suggests that
21788 a non-existent command may be the problem.
21789
21790 The &%return_output%& option can affect the result of a pipe delivery. If it is
21791 set and the command produces any output on its standard output or standard
21792 error streams, the command is considered to have failed, even if it gave a zero
21793 return code or if &%ignore_status%& is set. The output from the command is
21794 included as part of the bounce message. The &%return_fail_output%& option is
21795 similar, except that output is returned only when the command exits with a
21796 failure return code, that is, a value other than zero or a code that matches
21797 &%temp_errors%&.
21798
21799
21800
21801 .section "How the command is run" "SECThowcommandrun"
21802 .cindex "&(pipe)& transport" "path for command"
21803 The command line is (by default) broken down into a command name and arguments
21804 by the &(pipe)& transport itself. The &%allow_commands%& and
21805 &%restrict_to_path%& options can be used to restrict the commands that may be
21806 run.
21807
21808 .cindex "quoting" "in pipe command"
21809 Unquoted arguments are delimited by white space. If an argument appears in
21810 double quotes, backslash is interpreted as an escape character in the usual
21811 way. If an argument appears in single quotes, no escaping is done.
21812
21813 String expansion is applied to the command line except when it comes from a
21814 traditional &_.forward_& file (commands from a filter file are expanded). The
21815 expansion is applied to each argument in turn rather than to the whole line.
21816 For this reason, any string expansion item that contains white space must be
21817 quoted so as to be contained within a single argument. A setting such as
21818 .code
21819 command = /some/path ${if eq{$local_part}{postmaster}{xx}{yy}}
21820 .endd
21821 will not work, because the expansion item gets split between several
21822 arguments. You have to write
21823 .code
21824 command = /some/path "${if eq{$local_part}{postmaster}{xx}{yy}}"
21825 .endd
21826 to ensure that it is all in one argument. The expansion is done in this way,
21827 argument by argument, so that the number of arguments cannot be changed as a
21828 result of expansion, and quotes or backslashes in inserted variables do not
21829 interact with external quoting. However, this leads to problems if you want to
21830 generate multiple arguments (or the command name plus arguments) from a single
21831 expansion. In this situation, the simplest solution is to use a shell. For
21832 example:
21833 .code
21834 command = /bin/sh -c ${lookup{$local_part}lsearch{/some/file}}
21835 .endd
21836
21837 .cindex "transport" "filter"
21838 .cindex "filter" "transport filter"
21839 .vindex "&$pipe_addresses$&"
21840 Special handling takes place when an argument consists of precisely the text
21841 &`$pipe_addresses`&. This is not a general expansion variable; the only
21842 place this string is recognized is when it appears as an argument for a pipe or
21843 transport filter command. It causes each address that is being handled to be
21844 inserted in the argument list at that point &'as a separate argument'&. This
21845 avoids any problems with spaces or shell metacharacters, and is of use when a
21846 &(pipe)& transport is handling groups of addresses in a batch.
21847
21848 If &%force_command%& is enabled on the transport, Special handling takes place
21849 for an argument that consists of precisely the text &`$address_pipe`&.  It
21850 is handled similarly to &$pipe_addresses$& above.  It is expanded and each
21851 argument is inserted in the argument list at that point
21852 &'as a separate argument'&.  The &`$address_pipe`& item does not need to be
21853 the only item in the argument; in fact, if it were then &%force_command%&
21854 should behave as a no-op.  Rather, it should be used to adjust the command
21855 run while preserving the argument vector separation.
21856
21857 After splitting up into arguments and expansion, the resulting command is run
21858 in a subprocess directly from the transport, &'not'& under a shell. The
21859 message that is being delivered is supplied on the standard input, and the
21860 standard output and standard error are both connected to a single pipe that is
21861 read by Exim. The &%max_output%& option controls how much output the command
21862 may produce, and the &%return_output%& and &%return_fail_output%& options
21863 control what is done with it.
21864
21865 Not running the command under a shell (by default) lessens the security risks
21866 in cases when a command from a user's filter file is built out of data that was
21867 taken from an incoming message. If a shell is required, it can of course be
21868 explicitly specified as the command to be run. However, there are circumstances
21869 where existing commands (for example, in &_.forward_& files) expect to be run
21870 under a shell and cannot easily be modified. To allow for these cases, there is
21871 an option called &%use_shell%&, which changes the way the &(pipe)& transport
21872 works. Instead of breaking up the command line as just described, it expands it
21873 as a single string and passes the result to &_/bin/sh_&. The
21874 &%restrict_to_path%& option and the &$pipe_addresses$& facility cannot be used
21875 with &%use_shell%&, and the whole mechanism is inherently less secure.
21876
21877
21878
21879 .section "Environment variables" "SECTpipeenv"
21880 .cindex "&(pipe)& transport" "environment for command"
21881 .cindex "environment for pipe transport"
21882 The environment variables listed below are set up when the command is invoked.
21883 This list is a compromise for maximum compatibility with other MTAs. Note that
21884 the &%environment%& option can be used to add additional variables to this
21885 environment.
21886 .display
21887 &`DOMAIN            `&   the domain of the address
21888 &`HOME              `&   the home directory, if set
21889 &`HOST              `&   the host name when called from a router (see below)
21890 &`LOCAL_PART        `&   see below
21891 &`LOCAL_PART_PREFIX `&   see below
21892 &`LOCAL_PART_SUFFIX `&   see below
21893 &`LOGNAME           `&   see below
21894 &`MESSAGE_ID        `&   Exim's local ID for the message
21895 &`PATH              `&   as specified by the &%path%& option below
21896 &`QUALIFY_DOMAIN    `&   the sender qualification domain
21897 &`RECIPIENT         `&   the complete recipient address
21898 &`SENDER            `&   the sender of the message (empty if a bounce)
21899 &`SHELL             `&   &`/bin/sh`&
21900 &`TZ                `&   the value of the &%timezone%& option, if set
21901 &`USER              `&   see below
21902 .endd
21903 When a &(pipe)& transport is called directly from (for example) an &(accept)&
21904 router, LOCAL_PART is set to the local part of the address. When it is
21905 called as a result of a forward or alias expansion, LOCAL_PART is set to
21906 the local part of the address that was expanded. In both cases, any affixes are
21907 removed from the local part, and made available in LOCAL_PART_PREFIX and
21908 LOCAL_PART_SUFFIX, respectively. LOGNAME and USER are set to the
21909 same value as LOCAL_PART for compatibility with other MTAs.
21910
21911 .cindex "HOST"
21912 HOST is set only when a &(pipe)& transport is called from a router that
21913 associates hosts with an address, typically when using &(pipe)& as a
21914 pseudo-remote transport. HOST is set to the first host name specified by
21915 the router.
21916
21917 .cindex "HOME"
21918 If the transport's generic &%home_directory%& option is set, its value is used
21919 for the HOME environment variable. Otherwise, a home directory may be set
21920 by the router's &%transport_home_directory%& option, which defaults to the
21921 user's home directory if &%check_local_user%& is set.
21922
21923
21924 .section "Private options for pipe" "SECID142"
21925 .cindex "options" "&(pipe)& transport"
21926
21927
21928
21929 .option allow_commands pipe "string list&!!" unset
21930 .cindex "&(pipe)& transport" "permitted commands"
21931 The string is expanded, and is then interpreted as a colon-separated list of
21932 permitted commands. If &%restrict_to_path%& is not set, the only commands
21933 permitted are those in the &%allow_commands%& list. They need not be absolute
21934 paths; the &%path%& option is still used for relative paths. If
21935 &%restrict_to_path%& is set with &%allow_commands%&, the command must either be
21936 in the &%allow_commands%& list, or a name without any slashes that is found on
21937 the path. In other words, if neither &%allow_commands%& nor
21938 &%restrict_to_path%& is set, there is no restriction on the command, but
21939 otherwise only commands that are permitted by one or the other are allowed. For
21940 example, if
21941 .code
21942 allow_commands = /usr/bin/vacation
21943 .endd
21944 and &%restrict_to_path%& is not set, the only permitted command is
21945 &_/usr/bin/vacation_&. The &%allow_commands%& option may not be set if
21946 &%use_shell%& is set.
21947
21948
21949 .option batch_id pipe string&!! unset
21950 See the description of local delivery batching in chapter &<<CHAPbatching>>&.
21951
21952
21953 .option batch_max pipe integer 1
21954 This limits the number of addresses that can be handled in a single delivery.
21955 See the description of local delivery batching in chapter &<<CHAPbatching>>&.
21956
21957
21958 .option check_string pipe string unset
21959 As &(pipe)& writes the message, the start of each line is tested for matching
21960 &%check_string%&, and if it does, the initial matching characters are replaced
21961 by the contents of &%escape_string%&, provided both are set. The value of
21962 &%check_string%& is a literal string, not a regular expression, and the case of
21963 any letters it contains is significant. When &%use_bsmtp%& is set, the contents
21964 of &%check_string%& and &%escape_string%& are forced to values that implement
21965 the SMTP escaping protocol. Any settings made in the configuration file are
21966 ignored.
21967
21968
21969 .option command pipe string&!! unset
21970 This option need not be set when &(pipe)& is being used to deliver to pipes
21971 obtained directly from address redirections. In other cases, the option must be
21972 set, to provide a command to be run. It need not yield an absolute path (see
21973 the &%path%& option below). The command is split up into separate arguments by
21974 Exim, and each argument is separately expanded, as described in section
21975 &<<SECThowcommandrun>>& above.
21976
21977
21978 .option environment pipe string&!! unset
21979 .cindex "&(pipe)& transport" "environment for command"
21980 .cindex "environment for &(pipe)& transport"
21981 This option is used to add additional variables to the environment in which the
21982 command runs (see section &<<SECTpipeenv>>& for the default list). Its value is
21983 a string which is expanded, and then interpreted as a colon-separated list of
21984 environment settings of the form <&'name'&>=<&'value'&>.
21985
21986
21987 .option escape_string pipe string unset
21988 See &%check_string%& above.
21989
21990
21991 .option freeze_exec_fail pipe boolean false
21992 .cindex "exec failure"
21993 .cindex "failure of exec"
21994 .cindex "&(pipe)& transport" "failure of exec"
21995 Failure to exec the command in a pipe transport is by default treated like
21996 any other failure while running the command. However, if &%freeze_exec_fail%&
21997 is set, failure to exec is treated specially, and causes the message to be
21998 frozen, whatever the setting of &%ignore_status%&.
21999
22000
22001 .option freeze_signal pipe boolean false
22002 .cindex "signal exit"
22003 .cindex "&(pipe)& transport", "signal exit"
22004 Normally if the process run by a command in a pipe transport exits on a signal,
22005 a bounce message is sent. If &%freeze_signal%& is set, the message will be
22006 frozen in Exim's queue instead.
22007
22008
22009 .option force_command pipe boolean false
22010 .cindex "force command"
22011 .cindex "&(pipe)& transport", "force command"
22012 Normally when a router redirects an address directly to a pipe command
22013 the &%command%& option on the transport is ignored.  If &%force_command%&
22014 is set, the &%command%& option will used. This is especially
22015 useful for forcing a wrapper or additional argument to be added to the
22016 command. For example:
22017 .code
22018 command = /usr/bin/remote_exec myhost -- $address_pipe
22019 force_command
22020 .endd
22021
22022 Note that &$address_pipe$& is handled specially in &%command%& when
22023 &%force_command%& is set, expanding out to the original argument vector as
22024 separate items, similarly to a Unix shell &`"$@"`& construct.
22025
22026 .option ignore_status pipe boolean false
22027 If this option is true, the status returned by the subprocess that is set up to
22028 run the command is ignored, and Exim behaves as if zero had been returned.
22029 Otherwise, a non-zero status or termination by signal causes an error return
22030 from the transport unless the status value is one of those listed in
22031 &%temp_errors%&; these cause the delivery to be deferred and tried again later.
22032
22033 &*Note*&: This option does not apply to timeouts, which do not return a status.
22034 See the &%timeout_defer%& option for how timeouts are handled.
22035
22036 .option log_defer_output pipe boolean false
22037 .cindex "&(pipe)& transport" "logging output"
22038 If this option is set, and the status returned by the command is
22039 one of the codes listed in &%temp_errors%& (that is, delivery was deferred),
22040 and any output was produced, the first line of it is written to the main log.
22041
22042
22043 .option log_fail_output pipe boolean false
22044 If this option is set, and the command returns any output, and also ends with a
22045 return code that is neither zero nor one of the return codes listed in
22046 &%temp_errors%& (that is, the delivery failed), the first line of output is
22047 written to the main log. This option and &%log_output%& are mutually exclusive.
22048 Only one of them may be set.
22049
22050
22051
22052 .option log_output pipe boolean false
22053 If this option is set and the command returns any output, the first line of
22054 output is written to the main log, whatever the return code. This option and
22055 &%log_fail_output%& are mutually exclusive. Only one of them may be set.
22056
22057
22058
22059 .option max_output pipe integer 20K
22060 This specifies the maximum amount of output that the command may produce on its
22061 standard output and standard error file combined. If the limit is exceeded, the
22062 process running the command is killed. This is intended as a safety measure to
22063 catch runaway processes. The limit is applied independently of the settings of
22064 the options that control what is done with such output (for example,
22065 &%return_output%&). Because of buffering effects, the amount of output may
22066 exceed the limit by a small amount before Exim notices.
22067
22068
22069 .option message_prefix pipe string&!! "see below"
22070 The string specified here is expanded and output at the start of every message.
22071 The default is unset if &%use_bsmtp%& is set. Otherwise it is
22072 .code
22073 message_prefix = \
22074   From ${if def:return_path{$return_path}{MAILER-DAEMON}}\
22075   ${tod_bsdinbox}\n
22076 .endd
22077 .cindex "Cyrus"
22078 .cindex "&%tmail%&"
22079 .cindex "&""From""& line"
22080 This is required by the commonly used &_/usr/bin/vacation_& program.
22081 However, it must &'not'& be present if delivery is to the Cyrus IMAP server,
22082 or to the &%tmail%& local delivery agent. The prefix can be suppressed by
22083 setting
22084 .code
22085 message_prefix =
22086 .endd
22087 &*Note:*& If you set &%use_crlf%& true, you must change any occurrences of
22088 &`\n`& to &`\r\n`& in &%message_prefix%&.
22089
22090
22091 .option message_suffix pipe string&!! "see below"
22092 The string specified here is expanded and output at the end of every message.
22093 The default is unset if &%use_bsmtp%& is set. Otherwise it is a single newline.
22094 The suffix can be suppressed by setting
22095 .code
22096 message_suffix =
22097 .endd
22098 &*Note:*& If you set &%use_crlf%& true, you must change any occurrences of
22099 &`\n`& to &`\r\n`& in &%message_suffix%&.
22100
22101
22102 .option path pipe string "see below"
22103 This option specifies the string that is set up in the PATH environment
22104 variable of the subprocess. The default is:
22105 .code
22106 /bin:/usr/bin
22107 .endd
22108 If the &%command%& option does not yield an absolute path name, the command is
22109 sought in the PATH directories, in the usual way. &*Warning*&: This does not
22110 apply to a command specified as a transport filter.
22111
22112
22113 .option permit_coredump pipe boolean false
22114 Normally Exim inhibits core-dumps during delivery.  If you have a need to get
22115 a core-dump of a pipe command, enable this command.  This enables core-dumps
22116 during delivery and affects both the Exim binary and the pipe command run.
22117 It is recommended that this option remain off unless and until you have a need
22118 for it and that this only be enabled when needed, as the risk of excessive
22119 resource consumption can be quite high.  Note also that Exim is typically
22120 installed as a setuid binary and most operating systems will inhibit coredumps
22121 of these by default, so further OS-specific action may be required.
22122
22123
22124 .option pipe_as_creator pipe boolean false
22125 .cindex "uid (user id)" "local delivery"
22126 If the generic &%user%& option is not set and this option is true, the delivery
22127 process is run under the uid that was in force when Exim was originally called
22128 to accept the message. If the group id is not otherwise set (via the generic
22129 &%group%& option), the gid that was in force when Exim was originally called to
22130 accept the message is used.
22131
22132
22133 .option restrict_to_path pipe boolean false
22134 When this option is set, any command name not listed in &%allow_commands%& must
22135 contain no slashes. The command is searched for only in the directories listed
22136 in the &%path%& option. This option is intended for use in the case when a pipe
22137 command has been generated from a user's &_.forward_& file. This is usually
22138 handled by a &(pipe)& transport called &%address_pipe%&.
22139
22140
22141 .option return_fail_output pipe boolean false
22142 If this option is true, and the command produced any output and ended with a
22143 return code other than zero or one of the codes listed in &%temp_errors%& (that
22144 is, the delivery failed), the output is returned in the bounce message.
22145 However, if the message has a null sender (that is, it is itself a bounce
22146 message), output from the command is discarded. This option and
22147 &%return_output%& are mutually exclusive. Only one of them may be set.
22148
22149
22150
22151 .option return_output pipe boolean false
22152 If this option is true, and the command produced any output, the delivery is
22153 deemed to have failed whatever the return code from the command, and the output
22154 is returned in the bounce message. Otherwise, the output is just discarded.
22155 However, if the message has a null sender (that is, it is a bounce message),
22156 output from the command is always discarded, whatever the setting of this
22157 option. This option and &%return_fail_output%& are mutually exclusive. Only one
22158 of them may be set.
22159
22160
22161
22162 .option temp_errors pipe "string list" "see below"
22163 .cindex "&(pipe)& transport" "temporary failure"
22164 This option contains either a colon-separated list of numbers, or a single
22165 asterisk. If &%ignore_status%& is false
22166 and &%return_output%& is not set,
22167 and the command exits with a non-zero return code, the failure is treated as
22168 temporary and the delivery is deferred if the return code matches one of the
22169 numbers, or if the setting is a single asterisk. Otherwise, non-zero return
22170 codes are treated as permanent errors. The default setting contains the codes
22171 defined by EX_TEMPFAIL and EX_CANTCREAT in &_sysexits.h_&. If Exim is
22172 compiled on a system that does not define these macros, it assumes values of 75
22173 and 73, respectively.
22174
22175
22176 .option timeout pipe time 1h
22177 If the command fails to complete within this time, it is killed. This normally
22178 causes the delivery to fail (but see &%timeout_defer%&). A zero time interval
22179 specifies no timeout. In order to ensure that any subprocesses created by the
22180 command are also killed, Exim makes the initial process a process group leader,
22181 and kills the whole process group on a timeout. However, this can be defeated
22182 if one of the processes starts a new process group.
22183
22184 .option timeout_defer pipe boolean false
22185 A timeout in a &(pipe)& transport, either in the command that the transport
22186 runs, or in a transport filter that is associated with it, is by default
22187 treated as a hard error, and the delivery fails. However, if &%timeout_defer%&
22188 is set true, both kinds of timeout become temporary errors, causing the
22189 delivery to be deferred.
22190
22191 .option umask pipe "octal integer" 022
22192 This specifies the umask setting for the subprocess that runs the command.
22193
22194
22195 .option use_bsmtp pipe boolean false
22196 .cindex "envelope sender"
22197 If this option is set true, the &(pipe)& transport writes messages in &"batch
22198 SMTP"& format, with the envelope sender and recipient(s) included as SMTP
22199 commands. If you want to include a leading HELO command with such messages,
22200 you can do so by setting the &%message_prefix%& option. See section
22201 &<<SECTbatchSMTP>>& for details of batch SMTP.
22202
22203 .option use_classresources pipe boolean false
22204 .cindex "class resources (BSD)"
22205 This option is available only when Exim is running on FreeBSD, NetBSD, or
22206 BSD/OS. If it is set true, the &[setclassresources()]& function is used to set
22207 resource limits when a &(pipe)& transport is run to perform a delivery. The
22208 limits for the uid under which the pipe is to run are obtained from the login
22209 class database.
22210
22211
22212 .option use_crlf pipe boolean false
22213 .cindex "carriage return"
22214 .cindex "linefeed"
22215 This option causes lines to be terminated with the two-character CRLF sequence
22216 (carriage return, linefeed) instead of just a linefeed character. In the case
22217 of batched SMTP, the byte sequence written to the pipe is then an exact image
22218 of what would be sent down a real SMTP connection.
22219
22220 The contents of the &%message_prefix%& and &%message_suffix%& options are
22221 written verbatim, so must contain their own carriage return characters if these
22222 are needed. When &%use_bsmtp%& is not set, the default values for both
22223 &%message_prefix%& and &%message_suffix%& end with a single linefeed, so their
22224 values must be changed to end with &`\r\n`& if &%use_crlf%& is set.
22225
22226
22227 .option use_shell pipe boolean false
22228 .vindex "&$pipe_addresses$&"
22229 If this option is set, it causes the command to be passed to &_/bin/sh_&
22230 instead of being run directly from the transport, as described in section
22231 &<<SECThowcommandrun>>&. This is less secure, but is needed in some situations
22232 where the command is expected to be run under a shell and cannot easily be
22233 modified. The &%allow_commands%& and &%restrict_to_path%& options, and the
22234 &`$pipe_addresses`& facility are incompatible with &%use_shell%&. The
22235 command is expanded as a single string, and handed to &_/bin/sh_& as data for
22236 its &%-c%& option.
22237
22238
22239
22240 .section "Using an external local delivery agent" "SECID143"
22241 .cindex "local delivery" "using an external agent"
22242 .cindex "&'procmail'&"
22243 .cindex "external local delivery"
22244 .cindex "delivery" "&'procmail'&"
22245 .cindex "delivery" "by external agent"
22246 The &(pipe)& transport can be used to pass all messages that require local
22247 delivery to a separate local delivery agent such as &%procmail%&. When doing
22248 this, care must be taken to ensure that the pipe is run under an appropriate
22249 uid and gid. In some configurations one wants this to be a uid that is trusted
22250 by the delivery agent to supply the correct sender of the message. It may be
22251 necessary to recompile or reconfigure the delivery agent so that it trusts an
22252 appropriate user. The following is an example transport and router
22253 configuration for &%procmail%&:
22254 .code
22255 # transport
22256 procmail_pipe:
22257   driver = pipe
22258   command = /usr/local/bin/procmail -d $local_part
22259   return_path_add
22260   delivery_date_add
22261   envelope_to_add
22262   check_string = "From "
22263   escape_string = ">From "
22264   umask = 077
22265   user = $local_part
22266   group = mail
22267
22268 # router
22269 procmail:
22270   driver = accept
22271   check_local_user
22272   transport = procmail_pipe
22273 .endd
22274 In this example, the pipe is run as the local user, but with the group set to
22275 &'mail'&. An alternative is to run the pipe as a specific user such as &'mail'&
22276 or &'exim'&, but in this case you must arrange for &%procmail%& to trust that
22277 user to supply a correct sender address. If you do not specify either a
22278 &%group%& or a &%user%& option, the pipe command is run as the local user. The
22279 home directory is the user's home directory by default.
22280
22281 &*Note*&: The command that the pipe transport runs does &'not'& begin with
22282 .code
22283 IFS=" "
22284 .endd
22285 as shown in some &%procmail%& documentation, because Exim does not by default
22286 use a shell to run pipe commands.
22287
22288 .cindex "Cyrus"
22289 The next example shows a transport and a router for a system where local
22290 deliveries are handled by the Cyrus IMAP server.
22291 .code
22292 # transport
22293 local_delivery_cyrus:
22294   driver = pipe
22295   command = /usr/cyrus/bin/deliver \
22296             -m ${substr_1:$local_part_suffix} -- $local_part
22297   user = cyrus
22298   group = mail
22299   return_output
22300   log_output
22301   message_prefix =
22302   message_suffix =
22303
22304 # router
22305 local_user_cyrus:
22306   driver = accept
22307   check_local_user
22308   local_part_suffix = .*
22309   transport = local_delivery_cyrus
22310 .endd
22311 Note the unsetting of &%message_prefix%& and &%message_suffix%&, and the use of
22312 &%return_output%& to cause any text written by Cyrus to be returned to the
22313 sender.
22314 .ecindex IIDpiptra1
22315 .ecindex IIDpiptra2
22316
22317
22318 . ////////////////////////////////////////////////////////////////////////////
22319 . ////////////////////////////////////////////////////////////////////////////
22320
22321 .chapter "The smtp transport" "CHAPsmtptrans"
22322 .scindex IIDsmttra1 "transports" "&(smtp)&"
22323 .scindex IIDsmttra2 "&(smtp)& transport"
22324 The &(smtp)& transport delivers messages over TCP/IP connections using the SMTP
22325 or LMTP protocol. The list of hosts to try can either be taken from the address
22326 that is being processed (having been set up by the router), or specified
22327 explicitly for the transport. Timeout and retry processing (see chapter
22328 &<<CHAPretry>>&) is applied to each IP address independently.
22329
22330
22331 .section "Multiple messages on a single connection" "SECID144"
22332 The sending of multiple messages over a single TCP/IP connection can arise in
22333 two ways:
22334
22335 .ilist
22336 If a message contains more than &%max_rcpt%& (see below) addresses that are
22337 routed to the same host, more than one copy of the message has to be sent to
22338 that host. In this situation, multiple copies may be sent in a single run of
22339 the &(smtp)& transport over a single TCP/IP connection. (What Exim actually
22340 does when it has too many addresses to send in one message also depends on the
22341 value of the global &%remote_max_parallel%& option. Details are given in
22342 section &<<SECToutSMTPTCP>>&.)
22343 .next
22344 .cindex "hints database" "remembering routing"
22345 When a message has been successfully delivered over a TCP/IP connection, Exim
22346 looks in its hints database to see if there are any other messages awaiting a
22347 connection to the same host. If there are, a new delivery process is started
22348 for one of them, and the current TCP/IP connection is passed on to it. The new
22349 process may in turn send multiple copies and possibly create yet another
22350 process.
22351 .endlist
22352
22353
22354 For each copy sent over the same TCP/IP connection, a sequence counter is
22355 incremented, and if it ever gets to the value of &%connection_max_messages%&,
22356 no further messages are sent over that connection.
22357
22358
22359
22360 .section "Use of the $host and $host_address variables" "SECID145"
22361 .vindex "&$host$&"
22362 .vindex "&$host_address$&"
22363 At the start of a run of the &(smtp)& transport, the values of &$host$& and
22364 &$host_address$& are the name and IP address of the first host on the host list
22365 passed by the router. However, when the transport is about to connect to a
22366 specific host, and while it is connected to that host, &$host$& and
22367 &$host_address$& are set to the values for that host. These are the values
22368 that are in force when the &%helo_data%&, &%hosts_try_auth%&, &%interface%&,
22369 &%serialize_hosts%&, and the various TLS options are expanded.
22370
22371
22372 .section "Use of $tls_cipher and $tls_peerdn" "usecippeer"
22373 .vindex &$tls_bits$&
22374 .vindex &$tls_cipher$&
22375 .vindex &$tls_peerdn$&
22376 .vindex &$tls_sni$&
22377 At the start of a run of the &(smtp)& transport, the values of &$tls_bits$&,
22378 &$tls_cipher$&, &$tls_peerdn$& and &$tls_sni$&
22379 are the values that were set when the message was received.
22380 These are the values that are used for options that are expanded before any
22381 SMTP connections are made. Just before each connection is made, these four
22382 variables are emptied. If TLS is subsequently started, they are set to the
22383 appropriate values for the outgoing connection, and these are the values that
22384 are in force when any authenticators are run and when the
22385 &%authenticated_sender%& option is expanded.
22386
22387 These variables are deprecated in favour of &$tls_in_cipher$& et. al.
22388 and will be removed in a future release.
22389
22390
22391 .section "Private options for smtp" "SECID146"
22392 .cindex "options" "&(smtp)& transport"
22393 The private options of the &(smtp)& transport are as follows:
22394
22395
22396 .option address_retry_include_sender smtp boolean true
22397 .cindex "4&'xx'& responses" "retrying after"
22398 When an address is delayed because of a 4&'xx'& response to a RCPT command, it
22399 is the combination of sender and recipient that is delayed in subsequent queue
22400 runs until the retry time is reached. You can delay the recipient without
22401 reference to the sender (which is what earlier versions of Exim did), by
22402 setting &%address_retry_include_sender%& false. However, this can lead to
22403 problems with servers that regularly issue 4&'xx'& responses to RCPT commands.
22404
22405 .option allow_localhost smtp boolean false
22406 .cindex "local host" "sending to"
22407 .cindex "fallback" "hosts specified on transport"
22408 When a host specified in &%hosts%& or &%fallback_hosts%& (see below) turns out
22409 to be the local host, or is listed in &%hosts_treat_as_local%&, delivery is
22410 deferred by default. However, if &%allow_localhost%& is set, Exim goes on to do
22411 the delivery anyway. This should be used only in special cases when the
22412 configuration ensures that no looping will result (for example, a differently
22413 configured Exim is listening on the port to which the message is sent).
22414
22415
22416 .option authenticated_sender smtp string&!! unset
22417 .cindex "Cyrus"
22418 When Exim has authenticated as a client, or if &%authenticated_sender_force%&
22419 is true, this option sets a value for the AUTH= item on outgoing MAIL commands,
22420 overriding any existing authenticated sender value. If the string expansion is
22421 forced to fail, the option is ignored. Other expansion failures cause delivery
22422 to be deferred. If the result of expansion is an empty string, that is also
22423 ignored.
22424
22425 The expansion happens after the outgoing connection has been made and TLS
22426 started, if required. This means that the &$host$&, &$host_address$&,
22427 &$tls_out_cipher$&, and &$tls_out_peerdn$& variables are set according to the
22428 particular connection.
22429
22430 If the SMTP session is not authenticated, the expansion of
22431 &%authenticated_sender%& still happens (and can cause the delivery to be
22432 deferred if it fails), but no AUTH= item is added to MAIL commands
22433 unless &%authenticated_sender_force%& is true.
22434
22435 This option allows you to use the &(smtp)& transport in LMTP mode to
22436 deliver mail to Cyrus IMAP and provide the proper local part as the
22437 &"authenticated sender"&, via a setting such as:
22438 .code
22439 authenticated_sender = $local_part
22440 .endd
22441 This removes the need for IMAP subfolders to be assigned special ACLs to
22442 allow direct delivery to those subfolders.
22443
22444 Because of expected uses such as that just described for Cyrus (when no
22445 domain is involved), there is no checking on the syntax of the provided
22446 value.
22447
22448
22449 .option authenticated_sender_force smtp boolean false
22450 If this option is set true, the &%authenticated_sender%& option's value
22451 is used for the AUTH= item on outgoing MAIL commands, even if Exim has not
22452 authenticated as a client.
22453
22454
22455 .option command_timeout smtp time 5m
22456 This sets a timeout for receiving a response to an SMTP command that has been
22457 sent out. It is also used when waiting for the initial banner line from the
22458 remote host. Its value must not be zero.
22459
22460
22461 .option connect_timeout smtp time 5m
22462 This sets a timeout for the &[connect()]& function, which sets up a TCP/IP call
22463 to a remote host. A setting of zero allows the system timeout (typically
22464 several minutes) to act. To have any effect, the value of this option must be
22465 less than the system timeout. However, it has been observed that on some
22466 systems there is no system timeout, which is why the default value for this
22467 option is 5 minutes, a value recommended by RFC 1123.
22468
22469
22470 .option connection_max_messages smtp integer 500
22471 .cindex "SMTP" "passed connection"
22472 .cindex "SMTP" "multiple deliveries"
22473 .cindex "multiple SMTP deliveries"
22474 This controls the maximum number of separate message deliveries that are sent
22475 over a single TCP/IP connection. If the value is zero, there is no limit.
22476 For testing purposes, this value can be overridden by the &%-oB%& command line
22477 option.
22478
22479
22480 .option data_timeout smtp time 5m
22481 This sets a timeout for the transmission of each block in the data portion of
22482 the message. As a result, the overall timeout for a message depends on the size
22483 of the message. Its value must not be zero. See also &%final_timeout%&.
22484
22485
22486 .option delay_after_cutoff smtp boolean true
22487 This option controls what happens when all remote IP addresses for a given
22488 domain have been inaccessible for so long that they have passed their retry
22489 cutoff times.
22490
22491 In the default state, if the next retry time has not been reached for any of
22492 them, the address is bounced without trying any deliveries. In other words,
22493 Exim delays retrying an IP address after the final cutoff time until a new
22494 retry time is reached, and can therefore bounce an address without ever trying
22495 a delivery, when machines have been down for a long time. Some people are
22496 unhappy at this prospect, so...
22497
22498 If &%delay_after_cutoff%& is set false, Exim behaves differently. If all IP
22499 addresses are past their final cutoff time, Exim tries to deliver to those
22500 IP addresses that have not been tried since the message arrived. If there are
22501 none, of if they all fail, the address is bounced. In other words, it does not
22502 delay when a new message arrives, but immediately tries those expired IP
22503 addresses that haven't been tried since the message arrived. If there is a
22504 continuous stream of messages for the dead hosts, unsetting
22505 &%delay_after_cutoff%& means that there will be many more attempts to deliver
22506 to them.
22507
22508
22509 .option dns_qualify_single smtp boolean true
22510 If the &%hosts%& or &%fallback_hosts%& option is being used,
22511 and the &%gethostbyname%& option is false,
22512 the RES_DEFNAMES resolver option is set. See the &%qualify_single%& option
22513 in chapter &<<CHAPdnslookup>>& for more details.
22514
22515
22516 .option dns_search_parents smtp boolean false
22517 If the &%hosts%& or &%fallback_hosts%& option is being used, and the
22518 &%gethostbyname%& option is false, the RES_DNSRCH resolver option is set.
22519 See the &%search_parents%& option in chapter &<<CHAPdnslookup>>& for more
22520 details.
22521
22522
22523 .option dscp smtp string&!! unset
22524 .cindex "DCSP" "outbound"
22525 This option causes the DSCP value associated with a socket to be set to one
22526 of a number of fixed strings or to numeric value.
22527 The &%-bI:dscp%& option may be used to ask Exim which names it knows of.
22528 Common values include &`throughput`&, &`mincost`&, and on newer systems
22529 &`ef`&, &`af41`&, etc.  Numeric values may be in the range 0 to 0x3F.
22530
22531 The outbound packets from Exim will be marked with this value in the header
22532 (for IPv4, the TOS field; for IPv6, the TCLASS field); there is no guarantee
22533 that these values will have any effect, not be stripped by networking
22534 equipment, or do much of anything without cooperation with your Network
22535 Engineer and those of all network operators between the source and destination.
22536
22537
22538 .option fallback_hosts smtp "string list" unset
22539 .cindex "fallback" "hosts specified on transport"
22540 String expansion is not applied to this option. The argument must be a
22541 colon-separated list of host names or IP addresses, optionally also including
22542 port numbers, though the separator can be changed, as described in section
22543 &<<SECTlistconstruct>>&. Each individual item in the list is the same as an
22544 item in a &%route_list%& setting for the &(manualroute)& router, as described
22545 in section &<<SECTformatonehostitem>>&.
22546
22547 Fallback hosts can also be specified on routers, which associate them with the
22548 addresses they process. As for the &%hosts%& option without &%hosts_override%&,
22549 &%fallback_hosts%& specified on the transport is used only if the address does
22550 not have its own associated fallback host list. Unlike &%hosts%&, a setting of
22551 &%fallback_hosts%& on an address is not overridden by &%hosts_override%&.
22552 However, &%hosts_randomize%& does apply to fallback host lists.
22553
22554 If Exim is unable to deliver to any of the hosts for a particular address, and
22555 the errors are not permanent rejections, the address is put on a separate
22556 transport queue with its host list replaced by the fallback hosts, unless the
22557 address was routed via MX records and the current host was in the original MX
22558 list. In that situation, the fallback host list is not used.
22559
22560 Once normal deliveries are complete, the fallback queue is delivered by
22561 re-running the same transports with the new host lists. If several failing
22562 addresses have the same fallback hosts (and &%max_rcpt%& permits it), a single
22563 copy of the message is sent.
22564
22565 The resolution of the host names on the fallback list is controlled by the
22566 &%gethostbyname%& option, as for the &%hosts%& option. Fallback hosts apply
22567 both to cases when the host list comes with the address and when it is taken
22568 from &%hosts%&. This option provides a &"use a smart host only if delivery
22569 fails"& facility.
22570
22571
22572 .option final_timeout smtp time 10m
22573 This is the timeout that applies while waiting for the response to the final
22574 line containing just &"."& that terminates a message. Its value must not be
22575 zero.
22576
22577 .option gethostbyname smtp boolean false
22578 If this option is true when the &%hosts%& and/or &%fallback_hosts%& options are
22579 being used, names are looked up using &[gethostbyname()]&
22580 (or &[getipnodebyname()]& when available)
22581 instead of using the DNS. Of course, that function may in fact use the DNS, but
22582 it may also consult other sources of information such as &_/etc/hosts_&.
22583
22584 .option gnutls_compat_mode smtp boolean unset
22585 This option controls whether GnuTLS is used in compatibility mode in an Exim
22586 server. This reduces security slightly, but improves interworking with older
22587 implementations of TLS.
22588
22589 .option helo_data smtp string&!! "see below"
22590 .cindex "HELO" "argument, setting"
22591 .cindex "EHLO" "argument, setting"
22592 .cindex "LHLO argument setting"
22593 The value of this option is expanded after a connection to a another host has
22594 been set up. The result is used as the argument for the EHLO, HELO, or LHLO
22595 command that starts the outgoing SMTP or LMTP session. The default value of the
22596 option is:
22597 .code
22598 $primary_hostname
22599 .endd
22600 During the expansion, the variables &$host$& and &$host_address$& are set to
22601 the identity of the remote host, and the variables &$sending_ip_address$& and
22602 &$sending_port$& are set to the local IP address and port number that are being
22603 used. These variables can be used to generate different values for different
22604 servers or different local IP addresses. For example, if you want the string
22605 that is used for &%helo_data%& to be obtained by a DNS lookup of the outgoing
22606 interface address, you could use this:
22607 .code
22608 helo_data = ${lookup dnsdb{ptr=$sending_ip_address}{$value}\
22609   {$primary_hostname}}
22610 .endd
22611 The use of &%helo_data%& applies both to sending messages and when doing
22612 callouts.
22613
22614 .option hosts smtp "string list&!!" unset
22615 Hosts are associated with an address by a router such as &(dnslookup)&, which
22616 finds the hosts by looking up the address domain in the DNS, or by
22617 &(manualroute)&, which has lists of hosts in its configuration. However,
22618 email addresses can be passed to the &(smtp)& transport by any router, and not
22619 all of them can provide an associated list of hosts.
22620
22621 The &%hosts%& option specifies a list of hosts to be used if the address being
22622 processed does not have any hosts associated with it. The hosts specified by
22623 &%hosts%& are also used, whether or not the address has its own hosts, if
22624 &%hosts_override%& is set.
22625
22626 The string is first expanded, before being interpreted as a colon-separated
22627 list of host names or IP addresses, possibly including port numbers. The
22628 separator may be changed to something other than colon, as described in section
22629 &<<SECTlistconstruct>>&. Each individual item in the list is the same as an
22630 item in a &%route_list%& setting for the &(manualroute)& router, as described
22631 in section &<<SECTformatonehostitem>>&. However, note that the &`/MX`& facility
22632 of the &(manualroute)& router is not available here.
22633
22634 If the expansion fails, delivery is deferred. Unless the failure was caused by
22635 the inability to complete a lookup, the error is logged to the panic log as
22636 well as the main log. Host names are looked up either by searching directly for
22637 address records in the DNS or by calling &[gethostbyname()]& (or
22638 &[getipnodebyname()]& when available), depending on the setting of the
22639 &%gethostbyname%& option. When Exim is compiled with IPv6 support, if a host
22640 that is looked up in the DNS has both IPv4 and IPv6 addresses, both types of
22641 address are used.
22642
22643 During delivery, the hosts are tried in order, subject to their retry status,
22644 unless &%hosts_randomize%& is set.
22645
22646
22647 .option hosts_avoid_esmtp smtp "host list&!!" unset
22648 .cindex "ESMTP, avoiding use of"
22649 .cindex "HELO" "forcing use of"
22650 .cindex "EHLO" "avoiding use of"
22651 .cindex "PIPELINING" "avoiding the use of"
22652 This option is for use with broken hosts that announce ESMTP facilities (for
22653 example, PIPELINING) and then fail to implement them properly. When a host
22654 matches &%hosts_avoid_esmtp%&, Exim sends HELO rather than EHLO at the
22655 start of the SMTP session. This means that it cannot use any of the ESMTP
22656 facilities such as AUTH, PIPELINING, SIZE, and STARTTLS.
22657
22658
22659 .option hosts_avoid_pipelining smtp "host list&!!" unset
22660 .cindex "PIPELINING" "avoiding the use of"
22661 Exim will not use the SMTP PIPELINING extension when delivering to any host
22662 that matches this list, even if the server host advertises PIPELINING support.
22663
22664
22665 .option hosts_avoid_tls smtp "host list&!!" unset
22666 .cindex "TLS" "avoiding for certain hosts"
22667 Exim will not try to start a TLS session when delivering to any host that
22668 matches this list. See chapter &<<CHAPTLS>>& for details of TLS.
22669
22670 .option hosts_verify_avoid_tls smtp "host list&!!" *
22671 .cindex "TLS" "avoiding for certain hosts"
22672 Exim will not try to start a TLS session for a verify callout,
22673 or when delivering in cutthrough mode,
22674 to any host that matches this list.
22675 Note that the default is to not use TLS.
22676
22677
22678 .option hosts_max_try smtp integer 5
22679 .cindex "host" "maximum number to try"
22680 .cindex "limit" "number of hosts tried"
22681 .cindex "limit" "number of MX tried"
22682 .cindex "MX record" "maximum tried"
22683 This option limits the number of IP addresses that are tried for any one
22684 delivery in cases where there are temporary delivery errors. Section
22685 &<<SECTvalhosmax>>& describes in detail how the value of this option is used.
22686
22687
22688 .option hosts_max_try_hardlimit smtp integer 50
22689 This is an additional check on the maximum number of IP addresses that Exim
22690 tries for any one delivery. Section &<<SECTvalhosmax>>& describes its use and
22691 why it exists.
22692
22693
22694
22695 .option hosts_nopass_tls smtp "host list&!!" unset
22696 .cindex "TLS" "passing connection"
22697 .cindex "multiple SMTP deliveries"
22698 .cindex "TLS" "multiple message deliveries"
22699 For any host that matches this list, a connection on which a TLS session has
22700 been started will not be passed to a new delivery process for sending another
22701 message on the same connection. See section &<<SECTmulmessam>>& for an
22702 explanation of when this might be needed.
22703
22704
22705 .option hosts_override smtp boolean false
22706 If this option is set and the &%hosts%& option is also set, any hosts that are
22707 attached to the address are ignored, and instead the hosts specified by the
22708 &%hosts%& option are always used. This option does not apply to
22709 &%fallback_hosts%&.
22710
22711
22712 .option hosts_randomize smtp boolean false
22713 .cindex "randomized host list"
22714 .cindex "host" "list of; randomized"
22715 .cindex "fallback" "randomized hosts"
22716 If this option is set, and either the list of hosts is taken from the
22717 &%hosts%& or the &%fallback_hosts%& option, or the hosts supplied by the router
22718 were not obtained from MX records (this includes fallback hosts from the
22719 router), and were not randomized by the router, the order of trying the hosts
22720 is randomized each time the transport runs. Randomizing the order of a host
22721 list can be used to do crude load sharing.
22722
22723 When &%hosts_randomize%& is true, a host list may be split into groups whose
22724 order is separately randomized. This makes it possible to set up MX-like
22725 behaviour. The boundaries between groups are indicated by an item that is just
22726 &`+`& in the host list. For example:
22727 .code
22728 hosts = host1:host2:host3:+:host4:host5
22729 .endd
22730 The order of the first three hosts and the order of the last two hosts is
22731 randomized for each use, but the first three always end up before the last two.
22732 If &%hosts_randomize%& is not set, a &`+`& item in the list is ignored.
22733
22734 .option hosts_require_auth smtp "host list&!!" unset
22735 .cindex "authentication" "required by client"
22736 This option provides a list of servers for which authentication must succeed
22737 before Exim will try to transfer a message. If authentication fails for
22738 servers which are not in this list, Exim tries to send unauthenticated. If
22739 authentication fails for one of these servers, delivery is deferred. This
22740 temporary error is detectable in the retry rules, so it can be turned into a
22741 hard failure if required. See also &%hosts_try_auth%&, and chapter
22742 &<<CHAPSMTPAUTH>>& for details of authentication.
22743
22744
22745 .option hosts_require_tls smtp "host list&!!" unset
22746 .cindex "TLS" "requiring for certain servers"
22747 Exim will insist on using a TLS session when delivering to any host that
22748 matches this list. See chapter &<<CHAPTLS>>& for details of TLS.
22749 &*Note*&: This option affects outgoing mail only. To insist on TLS for
22750 incoming messages, use an appropriate ACL.
22751
22752 .option hosts_try_auth smtp "host list&!!" unset
22753 .cindex "authentication" "optional in client"
22754 This option provides a list of servers to which, provided they announce
22755 authentication support, Exim will attempt to authenticate as a client when it
22756 connects. If authentication fails, Exim will try to transfer the message
22757 unauthenticated. See also &%hosts_require_auth%&, and chapter
22758 &<<CHAPSMTPAUTH>>& for details of authentication.
22759
22760 .option interface smtp "string list&!!" unset
22761 .cindex "bind IP address"
22762 .cindex "IP address" "binding"
22763 .vindex "&$host$&"
22764 .vindex "&$host_address$&"
22765 This option specifies which interface to bind to when making an outgoing SMTP
22766 call. The value is an IP address, not an interface name such as
22767 &`eth0`&. Do not confuse this with the interface address that was used when a
22768 message was received, which is in &$received_ip_address$&, formerly known as
22769 &$interface_address$&. The name was changed to minimize confusion with the
22770 outgoing interface address. There is no variable that contains an outgoing
22771 interface address because, unless it is set by this option, its value is
22772 unknown.
22773
22774 During the expansion of the &%interface%& option the variables &$host$& and
22775 &$host_address$& refer to the host to which a connection is about to be made
22776 during the expansion of the string. Forced expansion failure, or an empty
22777 string result causes the option to be ignored. Otherwise, after expansion, the
22778 string must be a list of IP addresses, colon-separated by default, but the
22779 separator can be changed in the usual way. For example:
22780 .code
22781 interface = <; 192.168.123.123 ; 3ffe:ffff:836f::fe86:a061
22782 .endd
22783 The first interface of the correct type (IPv4 or IPv6) is used for the outgoing
22784 connection. If none of them are the correct type, the option is ignored. If
22785 &%interface%& is not set, or is ignored, the system's IP functions choose which
22786 interface to use if the host has more than one.
22787
22788
22789 .option keepalive smtp boolean true
22790 .cindex "keepalive" "on outgoing connection"
22791 This option controls the setting of SO_KEEPALIVE on outgoing TCP/IP socket
22792 connections. When set, it causes the kernel to probe idle connections
22793 periodically, by sending packets with &"old"& sequence numbers. The other end
22794 of the connection should send a acknowledgment if the connection is still okay
22795 or a reset if the connection has been aborted. The reason for doing this is
22796 that it has the beneficial effect of freeing up certain types of connection
22797 that can get stuck when the remote host is disconnected without tidying up the
22798 TCP/IP call properly. The keepalive mechanism takes several hours to detect
22799 unreachable hosts.
22800
22801
22802 .option lmtp_ignore_quota smtp boolean false
22803 .cindex "LMTP" "ignoring quota errors"
22804 If this option is set true when the &%protocol%& option is set to &"lmtp"&, the
22805 string &`IGNOREQUOTA`& is added to RCPT commands, provided that the LMTP server
22806 has advertised support for IGNOREQUOTA in its response to the LHLO command.
22807
22808 .option max_rcpt smtp integer 100
22809 .cindex "RCPT" "maximum number of outgoing"
22810 This option limits the number of RCPT commands that are sent in a single
22811 SMTP message transaction. Each set of addresses is treated independently, and
22812 so can cause parallel connections to the same host if &%remote_max_parallel%&
22813 permits this.
22814
22815
22816 .option multi_domain smtp boolean true
22817 .vindex "&$domain$&"
22818 When this option is set, the &(smtp)& transport can handle a number of
22819 addresses containing a mixture of different domains provided they all resolve
22820 to the same list of hosts. Turning the option off restricts the transport to
22821 handling only one domain at a time. This is useful if you want to use
22822 &$domain$& in an expansion for the transport, because it is set only when there
22823 is a single domain involved in a remote delivery.
22824
22825
22826 .option port smtp string&!! "see below"
22827 .cindex "port" "sending TCP/IP"
22828 .cindex "TCP/IP" "setting outgoing port"
22829 This option specifies the TCP/IP port on the server to which Exim connects.
22830 &*Note:*& Do not confuse this with the port that was used when a message was
22831 received, which is in &$received_port$&, formerly known as &$interface_port$&.
22832 The name was changed to minimize confusion with the outgoing port. There is no
22833 variable that contains an outgoing port.
22834
22835 If the value of this option begins with a digit it is taken as a port number;
22836 otherwise it is looked up using &[getservbyname()]&. The default value is
22837 normally &"smtp"&, but if &%protocol%& is set to &"lmtp"&, the default is
22838 &"lmtp"&. If the expansion fails, or if a port number cannot be found, delivery
22839 is deferred.
22840
22841
22842
22843 .option protocol smtp string smtp
22844 .cindex "LMTP" "over TCP/IP"
22845 .cindex "ssmtp protocol" "outbound"
22846 .cindex "TLS" "SSL-on-connect outbound"
22847 .vindex "&$port$&"
22848 If this option is set to &"lmtp"& instead of &"smtp"&, the default value for
22849 the &%port%& option changes to &"lmtp"&, and the transport operates the LMTP
22850 protocol (RFC 2033) instead of SMTP. This protocol is sometimes used for local
22851 deliveries into closed message stores. Exim also has support for running LMTP
22852 over a pipe to a local process &-- see chapter &<<CHAPLMTP>>&.
22853
22854 If this option is set to &"smtps"&, the default vaule for the &%port%& option
22855 changes to &"smtps"&, and the transport initiates TLS immediately after
22856 connecting, as an outbound SSL-on-connect, instead of using STARTTLS to upgrade.
22857 The Internet standards bodies strongly discourage use of this mode.
22858
22859
22860 .option retry_include_ip_address smtp boolean true
22861 Exim normally includes both the host name and the IP address in the key it
22862 constructs for indexing retry data after a temporary delivery failure. This
22863 means that when one of several IP addresses for a host is failing, it gets
22864 tried periodically (controlled by the retry rules), but use of the other IP
22865 addresses is not affected.
22866
22867 However, in some dialup environments hosts are assigned a different IP address
22868 each time they connect. In this situation the use of the IP address as part of
22869 the retry key leads to undesirable behaviour. Setting this option false causes
22870 Exim to use only the host name. This should normally be done on a separate
22871 instance of the &(smtp)& transport, set up specially to handle the dialup
22872 hosts.
22873
22874
22875 .option serialize_hosts smtp "host list&!!" unset
22876 .cindex "serializing connections"
22877 .cindex "host" "serializing connections"
22878 Because Exim operates in a distributed manner, if several messages for the same
22879 host arrive at around the same time, more than one simultaneous connection to
22880 the remote host can occur. This is not usually a problem except when there is a
22881 slow link between the hosts. In that situation it may be helpful to restrict
22882 Exim to one connection at a time. This can be done by setting
22883 &%serialize_hosts%& to match the relevant hosts.
22884
22885 .cindex "hints database" "serializing deliveries to a host"
22886 Exim implements serialization by means of a hints database in which a record is
22887 written whenever a process connects to one of the restricted hosts. The record
22888 is deleted when the connection is completed. Obviously there is scope for
22889 records to get left lying around if there is a system or program crash. To
22890 guard against this, Exim ignores any records that are more than six hours old.
22891
22892 If you set up this kind of serialization, you should also arrange to delete the
22893 relevant hints database whenever your system reboots. The names of the files
22894 start with &_misc_& and they are kept in the &_spool/db_& directory. There
22895 may be one or two files, depending on the type of DBM in use. The same files
22896 are used for ETRN serialization.
22897
22898
22899 .option size_addition smtp integer 1024
22900 .cindex "SMTP" "SIZE"
22901 .cindex "message" "size issue for transport filter"
22902 .cindex "size" "of message"
22903 .cindex "transport" "filter"
22904 .cindex "filter" "transport filter"
22905 If a remote SMTP server indicates that it supports the SIZE option of the
22906 MAIL command, Exim uses this to pass over the message size at the start of
22907 an SMTP transaction. It adds the value of &%size_addition%& to the value it
22908 sends, to allow for headers and other text that may be added during delivery by
22909 configuration options or in a transport filter. It may be necessary to increase
22910 this if a lot of text is added to messages.
22911
22912 Alternatively, if the value of &%size_addition%& is set negative, it disables
22913 the use of the SIZE option altogether.
22914
22915
22916 .option tls_certificate smtp string&!! unset
22917 .cindex "TLS" "client certificate, location of"
22918 .cindex "certificate" "client, location of"
22919 .vindex "&$host$&"
22920 .vindex "&$host_address$&"
22921 The value of this option must be the absolute path to a file which contains the
22922 client's certificate, for possible use when sending a message over an encrypted
22923 connection. The values of &$host$& and &$host_address$& are set to the name and
22924 address of the server during the expansion. See chapter &<<CHAPTLS>>& for
22925 details of TLS.
22926
22927 &*Note*&: This option must be set if you want Exim to be able to use a TLS
22928 certificate when sending messages as a client. The global option of the same
22929 name specifies the certificate for Exim as a server; it is not automatically
22930 assumed that the same certificate should be used when Exim is operating as a
22931 client.
22932
22933
22934 .option tls_crl smtp string&!! unset
22935 .cindex "TLS" "client certificate revocation list"
22936 .cindex "certificate" "revocation list for client"
22937 This option specifies a certificate revocation list. The expanded value must
22938 be the name of a file that contains a CRL in PEM format.
22939
22940
22941 .option tls_dh_min_bits smtp integer 1024
22942 .cindex "TLS" "Diffie-Hellman minimum acceptable size"
22943 When establishing a TLS session, if a ciphersuite which uses Diffie-Hellman
22944 key agreement is negotiated, the server will provide a large prime number
22945 for use.  This option establishes the minimum acceptable size of that number.
22946 If the parameter offered by the server is too small, then the TLS handshake
22947 will fail.
22948
22949 Only supported when using GnuTLS.
22950
22951
22952 .option tls_privatekey smtp string&!! unset
22953 .cindex "TLS" "client private key, location of"
22954 .vindex "&$host$&"
22955 .vindex "&$host_address$&"
22956 The value of this option must be the absolute path to a file which contains the
22957 client's private key. This is used when sending a message over an encrypted
22958 connection using a client certificate. The values of &$host$& and
22959 &$host_address$& are set to the name and address of the server during the
22960 expansion. If this option is unset, or the expansion is forced to fail, or the
22961 result is an empty string, the private key is assumed to be in the same file as
22962 the certificate. See chapter &<<CHAPTLS>>& for details of TLS.
22963
22964
22965 .option tls_require_ciphers smtp string&!! unset
22966 .cindex "TLS" "requiring specific ciphers"
22967 .cindex "cipher" "requiring specific"
22968 .vindex "&$host$&"
22969 .vindex "&$host_address$&"
22970 The value of this option must be a list of permitted cipher suites, for use
22971 when setting up an outgoing encrypted connection. (There is a global option of
22972 the same name for controlling incoming connections.) The values of &$host$& and
22973 &$host_address$& are set to the name and address of the server during the
22974 expansion. See chapter &<<CHAPTLS>>& for details of TLS; note that this option
22975 is used in different ways by OpenSSL and GnuTLS (see sections
22976 &<<SECTreqciphssl>>& and &<<SECTreqciphgnu>>&). For GnuTLS, the order of the
22977 ciphers is a preference order.
22978
22979
22980
22981 .option tls_sni smtp string&!! unset
22982 .cindex "TLS" "Server Name Indication"
22983 .vindex "&$tls_sni$&"
22984 If this option is set then it sets the $tls_out_sni variable and causes any
22985 TLS session to pass this value as the Server Name Indication extension to
22986 the remote side, which can be used by the remote side to select an appropriate
22987 certificate and private key for the session.
22988
22989 See &<<SECTtlssni>>& for more information.
22990
22991 Note that for OpenSSL, this feature requires a build of OpenSSL that supports
22992 TLS extensions.
22993
22994
22995
22996
22997 .option tls_tempfail_tryclear smtp boolean true
22998 .cindex "4&'xx'& responses" "to STARTTLS"
22999 When the server host is not in &%hosts_require_tls%&, and there is a problem in
23000 setting up a TLS session, this option determines whether or not Exim should try
23001 to deliver the message unencrypted. If it is set false, delivery to the
23002 current host is deferred; if there are other hosts, they are tried. If this
23003 option is set true, Exim attempts to deliver unencrypted after a 4&'xx'&
23004 response to STARTTLS. Also, if STARTTLS is accepted, but the subsequent
23005 TLS negotiation fails, Exim closes the current connection (because it is in an
23006 unknown state), opens a new one to the same host, and then tries the delivery
23007 in clear.
23008
23009
23010 .option tls_try_verify_hosts smtp "host list&!! unset
23011 .cindex "TLS" "server certificate verification"
23012 .cindex "certificate" "verification of server"
23013 This option gives a list of hosts for which, on encrypted connections,
23014 certificate verification will be tried but need not succeed.
23015 The &%tls_verify_certificates%& option must also be set.
23016
23017
23018 .option tls_verify_certificates smtp string&!! unset
23019 .cindex "TLS" "server certificate verification"
23020 .cindex "certificate" "verification of server"
23021 .vindex "&$host$&"
23022 .vindex "&$host_address$&"
23023 The value of this option must be the absolute path to a file containing
23024 permitted server certificates, for use when setting up an encrypted connection.
23025 Alternatively, if you are using OpenSSL, you can set
23026 &%tls_verify_certificates%& to the name of a directory containing certificate
23027 files. This does not work with GnuTLS; the option must be set to the name of a
23028 single file if you are using GnuTLS. The values of &$host$& and
23029 &$host_address$& are set to the name and address of the server during the
23030 expansion of this option. See chapter &<<CHAPTLS>>& for details of TLS.
23031
23032 For back-compatability,
23033 if neither tls_verify_hosts nor tls_try_verify_hosts are set
23034 and certificate verification fails the TLS connection is closed.
23035
23036
23037 .option tls_verify_hosts smtp "host list&!! unset
23038 .cindex "TLS" "server certificate verification"
23039 .cindex "certificate" "verification of server"
23040 This option gives a list of hosts for which. on encrypted connections,
23041 certificate verification must succeed.
23042 The &%tls_verify_certificates%& option must also be set.
23043 If both this option and &%tls_try_verify_hosts%& are unset
23044 operation is as if this option selected all hosts.
23045
23046
23047
23048
23049 .section "How the limits for the number of hosts to try are used" &&&
23050          "SECTvalhosmax"
23051 .cindex "host" "maximum number to try"
23052 .cindex "limit" "hosts; maximum number tried"
23053 There are two options that are concerned with the number of hosts that are
23054 tried when an SMTP delivery takes place. They are &%hosts_max_try%& and
23055 &%hosts_max_try_hardlimit%&.
23056
23057
23058 The &%hosts_max_try%& option limits the number of hosts that are tried
23059 for a single delivery. However, despite the term &"host"& in its name, the
23060 option actually applies to each IP address independently. In other words, a
23061 multihomed host is treated as several independent hosts, just as it is for
23062 retrying.
23063
23064 Many of the larger ISPs have multiple MX records which often point to
23065 multihomed hosts. As a result, a list of a dozen or more IP addresses may be
23066 created as a result of routing one of these domains.
23067
23068 Trying every single IP address on such a long list does not seem sensible; if
23069 several at the top of the list fail, it is reasonable to assume there is some
23070 problem that is likely to affect all of them. Roughly speaking, the value of
23071 &%hosts_max_try%& is the maximum number that are tried before deferring the
23072 delivery. However, the logic cannot be quite that simple.
23073
23074 Firstly, IP addresses that are skipped because their retry times have not
23075 arrived do not count, and in addition, addresses that are past their retry
23076 limits are also not counted, even when they are tried. This means that when
23077 some IP addresses are past their retry limits, more than the value of
23078 &%hosts_max_retry%& may be tried. The reason for this behaviour is to ensure
23079 that all IP addresses are considered before timing out an email address (but
23080 see below for an exception).
23081
23082 Secondly, when the &%hosts_max_try%& limit is reached, Exim looks down the host
23083 list to see if there is a subsequent host with a different (higher valued) MX.
23084 If there is, that host is considered next, and the current IP address is used
23085 but not counted. This behaviour helps in the case of a domain with a retry rule
23086 that hardly ever delays any hosts, as is now explained:
23087
23088 Consider the case of a long list of hosts with one MX value, and a few with a
23089 higher MX value. If &%hosts_max_try%& is small (the default is 5) only a few
23090 hosts at the top of the list are tried at first. With the default retry rule,
23091 which specifies increasing retry times, the higher MX hosts are eventually
23092 tried when those at the top of the list are skipped because they have not
23093 reached their retry times.
23094
23095 However, it is common practice to put a fixed short retry time on domains for
23096 large ISPs, on the grounds that their servers are rarely down for very long.
23097 Unfortunately, these are exactly the domains that tend to resolve to long lists
23098 of hosts. The short retry time means that the lowest MX hosts are tried every
23099 time. The attempts may be in a different order because of random sorting, but
23100 without the special MX check, the higher MX hosts would never be tried until
23101 all the lower MX hosts had timed out (which might be several days), because
23102 there are always some lower MX hosts that have reached their retry times. With
23103 the special check, Exim considers at least one IP address from each MX value at
23104 every delivery attempt, even if the &%hosts_max_try%& limit has already been
23105 reached.
23106
23107 The above logic means that &%hosts_max_try%& is not a hard limit, and in
23108 particular, Exim normally eventually tries all the IP addresses before timing
23109 out an email address. When &%hosts_max_try%& was implemented, this seemed a
23110 reasonable thing to do. Recently, however, some lunatic DNS configurations have
23111 been set up with hundreds of IP addresses for some domains. It can
23112 take a very long time indeed for an address to time out in these cases.
23113
23114 The &%hosts_max_try_hardlimit%& option was added to help with this problem.
23115 Exim never tries more than this number of IP addresses; if it hits this limit
23116 and they are all timed out, the email address is bounced, even though not all
23117 possible IP addresses have been tried.
23118 .ecindex IIDsmttra1
23119 .ecindex IIDsmttra2
23120
23121
23122
23123
23124
23125 . ////////////////////////////////////////////////////////////////////////////
23126 . ////////////////////////////////////////////////////////////////////////////
23127
23128 .chapter "Address rewriting" "CHAPrewrite"
23129 .scindex IIDaddrew "rewriting" "addresses"
23130 There are some circumstances in which Exim automatically rewrites domains in
23131 addresses. The two most common are when an address is given without a domain
23132 (referred to as an &"unqualified address"&) or when an address contains an
23133 abbreviated domain that is expanded by DNS lookup.
23134
23135 Unqualified envelope addresses are accepted only for locally submitted
23136 messages, or for messages that are received from hosts matching
23137 &%sender_unqualified_hosts%& or &%recipient_unqualified_hosts%&, as
23138 appropriate. Unqualified addresses in header lines are qualified if they are in
23139 locally submitted messages, or messages from hosts that are permitted to send
23140 unqualified envelope addresses. Otherwise, unqualified addresses in header
23141 lines are neither qualified nor rewritten.
23142
23143 One situation in which Exim does &'not'& automatically rewrite a domain is
23144 when it is the name of a CNAME record in the DNS. The older RFCs suggest that
23145 such a domain should be rewritten using the &"canonical"& name, and some MTAs
23146 do this. The new RFCs do not contain this suggestion.
23147
23148
23149 .section "Explicitly configured address rewriting" "SECID147"
23150 This chapter describes the rewriting rules that can be used in the
23151 main rewrite section of the configuration file, and also in the generic
23152 &%headers_rewrite%& option that can be set on any transport.
23153
23154 Some people believe that configured address rewriting is a Mortal Sin.
23155 Others believe that life is not possible without it. Exim provides the
23156 facility; you do not have to use it.
23157
23158 The main rewriting rules that appear in the &"rewrite"& section of the
23159 configuration file are applied to addresses in incoming messages, both envelope
23160 addresses and addresses in header lines. Each rule specifies the types of
23161 address to which it applies.
23162
23163 Whether or not addresses in header lines are rewritten depends on the origin of
23164 the headers and the type of rewriting. Global rewriting, that is, rewriting
23165 rules from the rewrite section of the configuration file, is applied only to
23166 those headers that were received with the message. Header lines that are added
23167 by ACLs or by a system filter or by individual routers or transports (which
23168 are specific to individual recipient addresses) are not rewritten by the global
23169 rules.
23170
23171 Rewriting at transport time, by means of the &%headers_rewrite%& option,
23172 applies all headers except those added by routers and transports. That is, as
23173 well as the headers that were received with the message, it also applies to
23174 headers that were added by an ACL or a system filter.
23175
23176
23177 In general, rewriting addresses from your own system or domain has some
23178 legitimacy. Rewriting other addresses should be done only with great care and
23179 in special circumstances. The author of Exim believes that rewriting should be
23180 used sparingly, and mainly for &"regularizing"& addresses in your own domains.
23181 Although it can sometimes be used as a routing tool, this is very strongly
23182 discouraged.
23183
23184 There are two commonly encountered circumstances where rewriting is used, as
23185 illustrated by these examples:
23186
23187 .ilist
23188 The company whose domain is &'hitch.fict.example'& has a number of hosts that
23189 exchange mail with each other behind a firewall, but there is only a single
23190 gateway to the outer world. The gateway rewrites &'*.hitch.fict.example'& as
23191 &'hitch.fict.example'& when sending mail off-site.
23192 .next
23193 A host rewrites the local parts of its own users so that, for example,
23194 &'fp42@hitch.fict.example'& becomes &'Ford.Prefect@hitch.fict.example'&.
23195 .endlist
23196
23197
23198
23199 .section "When does rewriting happen?" "SECID148"
23200 .cindex "rewriting" "timing of"
23201 .cindex "&ACL;" "rewriting addresses in"
23202 Configured address rewriting can take place at several different stages of a
23203 message's processing.
23204
23205 .vindex "&$sender_address$&"
23206 At the start of an ACL for MAIL, the sender address may have been rewritten
23207 by a special SMTP-time rewrite rule (see section &<<SECTrewriteS>>&), but no
23208 ordinary rewrite rules have yet been applied. If, however, the sender address
23209 is verified in the ACL, it is rewritten before verification, and remains
23210 rewritten thereafter. The subsequent value of &$sender_address$& is the
23211 rewritten address. This also applies if sender verification happens in a
23212 RCPT ACL. Otherwise, when the sender address is not verified, it is
23213 rewritten as soon as a message's header lines have been received.
23214
23215 .vindex "&$domain$&"
23216 .vindex "&$local_part$&"
23217 Similarly, at the start of an ACL for RCPT, the current recipient's address
23218 may have been rewritten by a special SMTP-time rewrite rule, but no ordinary
23219 rewrite rules have yet been applied to it. However, the behaviour is different
23220 from the sender address when a recipient is verified. The address is rewritten
23221 for the verification, but the rewriting is not remembered at this stage. The
23222 value of &$local_part$& and &$domain$& after verification are always the same
23223 as they were before (that is, they contain the unrewritten &-- except for
23224 SMTP-time rewriting &-- address).
23225
23226 As soon as a message's header lines have been received, all the envelope
23227 recipient addresses are permanently rewritten, and rewriting is also applied to
23228 the addresses in the header lines (if configured). This happens before adding
23229 any header lines that were specified in MAIL or RCPT ACLs, and
23230 .cindex "&[local_scan()]& function" "address rewriting; timing of"
23231 before the DATA ACL and &[local_scan()]& functions are run.
23232
23233 When an address is being routed, either for delivery or for verification,
23234 rewriting is applied immediately to child addresses that are generated by
23235 redirection, unless &%no_rewrite%& is set on the router.
23236
23237 .cindex "envelope sender" "rewriting at transport time"
23238 .cindex "rewriting" "at transport time"
23239 .cindex "header lines" "rewriting at transport time"
23240 At transport time, additional rewriting of addresses in header lines can be
23241 specified by setting the generic &%headers_rewrite%& option on a transport.
23242 This option contains rules that are identical in form to those in the rewrite
23243 section of the configuration file. They are applied to the original message
23244 header lines and any that were added by ACLs or a system filter. They are not
23245 applied to header lines that are added by routers or the transport.
23246
23247 The outgoing envelope sender can be rewritten by means of the &%return_path%&
23248 transport option. However, it is not possible to rewrite envelope recipients at
23249 transport time.
23250
23251
23252
23253
23254 .section "Testing the rewriting rules that apply on input" "SECID149"
23255 .cindex "rewriting" "testing"
23256 .cindex "testing" "rewriting"
23257 Exim's input rewriting configuration appears in a part of the run time
23258 configuration file headed by &"begin rewrite"&. It can be tested by the
23259 &%-brw%& command line option. This takes an address (which can be a full RFC
23260 2822 address) as its argument. The output is a list of how the address would be
23261 transformed by the rewriting rules for each of the different places it might
23262 appear in an incoming message, that is, for each different header and for the
23263 envelope sender and recipient fields. For example,
23264 .code
23265 exim -brw ph10@exim.workshop.example
23266 .endd
23267 might produce the output
23268 .code
23269 sender: Philip.Hazel@exim.workshop.example
23270 from: Philip.Hazel@exim.workshop.example
23271 to: ph10@exim.workshop.example
23272 cc: ph10@exim.workshop.example
23273 bcc: ph10@exim.workshop.example
23274 reply-to: Philip.Hazel@exim.workshop.example
23275 env-from: Philip.Hazel@exim.workshop.example
23276 env-to: ph10@exim.workshop.example
23277 .endd
23278 which shows that rewriting has been set up for that address when used in any of
23279 the source fields, but not when it appears as a recipient address. At the
23280 present time, there is no equivalent way of testing rewriting rules that are
23281 set for a particular transport.
23282
23283
23284 .section "Rewriting rules" "SECID150"
23285 .cindex "rewriting" "rules"
23286 The rewrite section of the configuration file consists of lines of rewriting
23287 rules in the form
23288 .display
23289 <&'source pattern'&>  <&'replacement'&>  <&'flags'&>
23290 .endd
23291 Rewriting rules that are specified for the &%headers_rewrite%& generic
23292 transport option are given as a colon-separated list. Each item in the list
23293 takes the same form as a line in the main rewriting configuration (except that
23294 any colons must be doubled, of course).
23295
23296 The formats of source patterns and replacement strings are described below.
23297 Each is terminated by white space, unless enclosed in double quotes, in which
23298 case normal quoting conventions apply inside the quotes. The flags are single
23299 characters which may appear in any order. Spaces and tabs between them are
23300 ignored.
23301
23302 For each address that could potentially be rewritten, the rules are scanned in
23303 order, and replacements for the address from earlier rules can themselves be
23304 replaced by later rules (but see the &"q"& and &"R"& flags).
23305
23306 The order in which addresses are rewritten is undefined, may change between
23307 releases, and must not be relied on, with one exception: when a message is
23308 received, the envelope sender is always rewritten first, before any header
23309 lines are rewritten. For example, the replacement string for a rewrite of an
23310 address in &'To:'& must not assume that the message's address in &'From:'& has
23311 (or has not) already been rewritten. However, a rewrite of &'From:'& may assume
23312 that the envelope sender has already been rewritten.
23313
23314 .vindex "&$domain$&"
23315 .vindex "&$local_part$&"
23316 The variables &$local_part$& and &$domain$& can be used in the replacement
23317 string to refer to the address that is being rewritten. Note that lookup-driven
23318 rewriting can be done by a rule of the form
23319 .code
23320 *@*   ${lookup ...
23321 .endd
23322 where the lookup key uses &$1$& and &$2$& or &$local_part$& and &$domain$& to
23323 refer to the address that is being rewritten.
23324
23325
23326 .section "Rewriting patterns" "SECID151"
23327 .cindex "rewriting" "patterns"
23328 .cindex "address list" "in a rewriting pattern"
23329 The source pattern in a rewriting rule is any item which may appear in an
23330 address list (see section &<<SECTaddresslist>>&). It is in fact processed as a
23331 single-item address list, which means that it is expanded before being tested
23332 against the address. As always, if you use a regular expression as a pattern,
23333 you must take care to escape dollar and backslash characters, or use the &`\N`&
23334 facility to suppress string expansion within the regular expression.
23335
23336 Domains in patterns should be given in lower case. Local parts in patterns are
23337 case-sensitive. If you want to do case-insensitive matching of local parts, you
23338 can use a regular expression that starts with &`^(?i)`&.
23339
23340 .cindex "numerical variables (&$1$& &$2$& etc)" "in rewriting rules"
23341 After matching, the numerical variables &$1$&, &$2$&, etc. may be set,
23342 depending on the type of match which occurred. These can be used in the
23343 replacement string to insert portions of the incoming address. &$0$& always
23344 refers to the complete incoming address. When a regular expression is used, the
23345 numerical variables are set from its capturing subexpressions. For other types
23346 of pattern they are set as follows:
23347
23348 .ilist
23349 If a local part or domain starts with an asterisk, the numerical variables
23350 refer to the character strings matched by asterisks, with &$1$& associated with
23351 the first asterisk, and &$2$& with the second, if present. For example, if the
23352 pattern
23353 .code
23354 *queen@*.fict.example
23355 .endd
23356 is matched against the address &'hearts-queen@wonderland.fict.example'& then
23357 .code
23358 $0 = hearts-queen@wonderland.fict.example
23359 $1 = hearts-
23360 $2 = wonderland
23361 .endd
23362 Note that if the local part does not start with an asterisk, but the domain
23363 does, it is &$1$& that contains the wild part of the domain.
23364
23365 .next
23366 If the domain part of the pattern is a partial lookup, the wild and fixed parts
23367 of the domain are placed in the next available numerical variables. Suppose,
23368 for example, that the address &'foo@bar.baz.example'& is processed by a
23369 rewriting rule of the form
23370 .display
23371 &`*@partial-dbm;/some/dbm/file`&    <&'replacement string'&>
23372 .endd
23373 and the key in the file that matches the domain is &`*.baz.example`&. Then
23374 .code
23375 $1 = foo
23376 $2 = bar
23377 $3 = baz.example
23378 .endd
23379 If the address &'foo@baz.example'& is looked up, this matches the same
23380 wildcard file entry, and in this case &$2$& is set to the empty string, but
23381 &$3$& is still set to &'baz.example'&. If a non-wild key is matched in a
23382 partial lookup, &$2$& is again set to the empty string and &$3$& is set to the
23383 whole domain. For non-partial domain lookups, no numerical variables are set.
23384 .endlist
23385
23386
23387 .section "Rewriting replacements" "SECID152"
23388 .cindex "rewriting" "replacements"
23389 If the replacement string for a rule is a single asterisk, addresses that
23390 match the pattern and the flags are &'not'& rewritten, and no subsequent
23391 rewriting rules are scanned. For example,
23392 .code
23393 hatta@lookingglass.fict.example  *  f
23394 .endd
23395 specifies that &'hatta@lookingglass.fict.example'& is never to be rewritten in
23396 &'From:'& headers.
23397
23398 .vindex "&$domain$&"
23399 .vindex "&$local_part$&"
23400 If the replacement string is not a single asterisk, it is expanded, and must
23401 yield a fully qualified address. Within the expansion, the variables
23402 &$local_part$& and &$domain$& refer to the address that is being rewritten.
23403 Any letters they contain retain their original case &-- they are not lower
23404 cased. The numerical variables are set up according to the type of pattern that
23405 matched the address, as described above. If the expansion is forced to fail by
23406 the presence of &"fail"& in a conditional or lookup item, rewriting by the
23407 current rule is abandoned, but subsequent rules may take effect. Any other
23408 expansion failure causes the entire rewriting operation to be abandoned, and an
23409 entry written to the panic log.
23410
23411
23412
23413 .section "Rewriting flags" "SECID153"
23414 There are three different kinds of flag that may appear on rewriting rules:
23415
23416 .ilist
23417 Flags that specify which headers and envelope addresses to rewrite: E, F, T, b,
23418 c, f, h, r, s, t.
23419 .next
23420 A flag that specifies rewriting at SMTP time: S.
23421 .next
23422 Flags that control the rewriting process: Q, q, R, w.
23423 .endlist
23424
23425 For rules that are part of the &%headers_rewrite%& generic transport option,
23426 E, F, T, and S are not permitted.
23427
23428
23429
23430 .section "Flags specifying which headers and envelope addresses to rewrite" &&&
23431          "SECID154"
23432 .cindex "rewriting" "flags"
23433 If none of the following flag letters, nor the &"S"& flag (see section
23434 &<<SECTrewriteS>>&) are present, a main rewriting rule applies to all headers
23435 and to both the sender and recipient fields of the envelope, whereas a
23436 transport-time rewriting rule just applies to all headers. Otherwise, the
23437 rewriting rule is skipped unless the relevant addresses are being processed.
23438 .display
23439 &`E`&       rewrite all envelope fields
23440 &`F`&       rewrite the envelope From field
23441 &`T`&       rewrite the envelope To field
23442 &`b`&       rewrite the &'Bcc:'& header
23443 &`c`&       rewrite the &'Cc:'& header
23444 &`f`&       rewrite the &'From:'& header
23445 &`h`&       rewrite all headers
23446 &`r`&       rewrite the &'Reply-To:'& header
23447 &`s`&       rewrite the &'Sender:'& header
23448 &`t`&       rewrite the &'To:'& header
23449 .endd
23450 "All headers" means all of the headers listed above that can be selected
23451 individually, plus their &'Resent-'& versions. It does not include
23452 other headers such as &'Subject:'& etc.
23453
23454 You should be particularly careful about rewriting &'Sender:'& headers, and
23455 restrict this to special known cases in your own domains.
23456
23457
23458 .section "The SMTP-time rewriting flag" "SECTrewriteS"
23459 .cindex "SMTP" "rewriting malformed addresses"
23460 .cindex "RCPT" "rewriting argument of"
23461 .cindex "MAIL" "rewriting argument of"
23462 The rewrite flag &"S"& specifies a rewrite of incoming envelope addresses at
23463 SMTP time, as soon as an address is received in a MAIL or RCPT command, and
23464 before any other processing; even before syntax checking. The pattern is
23465 required to be a regular expression, and it is matched against the whole of the
23466 data for the command, including any surrounding angle brackets.
23467
23468 .vindex "&$domain$&"
23469 .vindex "&$local_part$&"
23470 This form of rewrite rule allows for the handling of addresses that are not
23471 compliant with RFCs 2821 and 2822 (for example, &"bang paths"& in batched SMTP
23472 input). Because the input is not required to be a syntactically valid address,
23473 the variables &$local_part$& and &$domain$& are not available during the
23474 expansion of the replacement string. The result of rewriting replaces the
23475 original address in the MAIL or RCPT command.
23476
23477
23478 .section "Flags controlling the rewriting process" "SECID155"
23479 There are four flags which control the way the rewriting process works. These
23480 take effect only when a rule is invoked, that is, when the address is of the
23481 correct type (matches the flags) and matches the pattern:
23482
23483 .ilist
23484 If the &"Q"& flag is set on a rule, the rewritten address is permitted to be an
23485 unqualified local part. It is qualified with &%qualify_recipient%&. In the
23486 absence of &"Q"& the rewritten address must always include a domain.
23487 .next
23488 If the &"q"& flag is set on a rule, no further rewriting rules are considered,
23489 even if no rewriting actually takes place because of a &"fail"& in the
23490 expansion. The &"q"& flag is not effective if the address is of the wrong type
23491 (does not match the flags) or does not match the pattern.
23492 .next
23493 The &"R"& flag causes a successful rewriting rule to be re-applied to the new
23494 address, up to ten times. It can be combined with the &"q"& flag, to stop
23495 rewriting once it fails to match (after at least one successful rewrite).
23496 .next
23497 .cindex "rewriting" "whole addresses"
23498 When an address in a header is rewritten, the rewriting normally applies only
23499 to the working part of the address, with any comments and RFC 2822 &"phrase"&
23500 left unchanged. For example, rewriting might change
23501 .code
23502 From: Ford Prefect <fp42@restaurant.hitch.fict.example>
23503 .endd
23504 into
23505 .code
23506 From: Ford Prefect <prefectf@hitch.fict.example>
23507 .endd
23508 .cindex "RFC 2047"
23509 Sometimes there is a need to replace the whole address item, and this can be
23510 done by adding the flag letter &"w"& to a rule. If this is set on a rule that
23511 causes an address in a header line to be rewritten, the entire address is
23512 replaced, not just the working part. The replacement must be a complete RFC
23513 2822 address, including the angle brackets if necessary. If text outside angle
23514 brackets contains a character whose value is greater than 126 or less than 32
23515 (except for tab), the text is encoded according to RFC 2047. The character set
23516 is taken from &%headers_charset%&, which defaults to ISO-8859-1.
23517
23518 When the &"w"& flag is set on a rule that causes an envelope address to be
23519 rewritten, all but the working part of the replacement address is discarded.
23520 .endlist
23521
23522
23523 .section "Rewriting examples" "SECID156"
23524 Here is an example of the two common rewriting paradigms:
23525 .code
23526 *@*.hitch.fict.example  $1@hitch.fict.example
23527 *@hitch.fict.example    ${lookup{$1}dbm{/etc/realnames}\
23528                      {$value}fail}@hitch.fict.example bctfrF
23529 .endd
23530 Note the use of &"fail"& in the lookup expansion in the second rule, forcing
23531 the string expansion to fail if the lookup does not succeed. In this context it
23532 has the effect of leaving the original address unchanged, but Exim goes on to
23533 consider subsequent rewriting rules, if any, because the &"q"& flag is not
23534 present in that rule. An alternative to &"fail"& would be to supply &$1$&
23535 explicitly, which would cause the rewritten address to be the same as before,
23536 at the cost of a small bit of processing. Not supplying either of these is an
23537 error, since the rewritten address would then contain no local part.
23538
23539 The first example above replaces the domain with a superior, more general
23540 domain. This may not be desirable for certain local parts. If the rule
23541 .code
23542 root@*.hitch.fict.example  *
23543 .endd
23544 were inserted before the first rule, rewriting would be suppressed for the
23545 local part &'root'& at any domain ending in &'hitch.fict.example'&.
23546
23547 Rewriting can be made conditional on a number of tests, by making use of
23548 &${if$& in the expansion item. For example, to apply a rewriting rule only to
23549 messages that originate outside the local host:
23550 .code
23551 *@*.hitch.fict.example  "${if !eq {$sender_host_address}{}\
23552                          {$1@hitch.fict.example}fail}"
23553 .endd
23554 The replacement string is quoted in this example because it contains white
23555 space.
23556
23557 .cindex "rewriting" "bang paths"
23558 .cindex "bang paths" "rewriting"
23559 Exim does not handle addresses in the form of &"bang paths"&. If it sees such
23560 an address it treats it as an unqualified local part which it qualifies with
23561 the local qualification domain (if the source of the message is local or if the
23562 remote host is permitted to send unqualified addresses). Rewriting can
23563 sometimes be used to handle simple bang paths with a fixed number of
23564 components. For example, the rule
23565 .code
23566 \N^([^!]+)!(.*)@your.domain.example$\N   $2@$1
23567 .endd
23568 rewrites a two-component bang path &'host.name!user'& as the domain address
23569 &'user@host.name'&. However, there is a security implication in using this as
23570 a global rewriting rule for envelope addresses. It can provide a backdoor
23571 method for using your system as a relay, because the incoming addresses appear
23572 to be local. If the bang path addresses are received via SMTP, it is safer to
23573 use the &"S"& flag to rewrite them as they are received, so that relay checking
23574 can be done on the rewritten addresses.
23575 .ecindex IIDaddrew
23576
23577
23578
23579
23580
23581 . ////////////////////////////////////////////////////////////////////////////
23582 . ////////////////////////////////////////////////////////////////////////////
23583
23584 .chapter "Retry configuration" "CHAPretry"
23585 .scindex IIDretconf1 "retry" "configuration, description of"
23586 .scindex IIDregconf2 "configuration file" "retry section"
23587 The &"retry"& section of the runtime configuration file contains a list of
23588 retry rules that control how often Exim tries to deliver messages that cannot
23589 be delivered at the first attempt. If there are no retry rules (the section is
23590 empty or not present), there are no retries. In this situation, temporary
23591 errors are treated as permanent. The default configuration contains a single,
23592 general-purpose retry rule (see section &<<SECID57>>&). The &%-brt%& command
23593 line option can be used to test which retry rule will be used for a given
23594 address, domain and error.
23595
23596 The most common cause of retries is temporary failure to deliver to a remote
23597 host because the host is down, or inaccessible because of a network problem.
23598 Exim's retry processing in this case is applied on a per-host (strictly, per IP
23599 address) basis, not on a per-message basis. Thus, if one message has recently
23600 been delayed, delivery of a new message to the same host is not immediately
23601 tried, but waits for the host's retry time to arrive. If the &%retry_defer%&
23602 log selector is set, the message
23603 .cindex "retry" "time not reached"
23604 &"retry time not reached"& is written to the main log whenever a delivery is
23605 skipped for this reason. Section &<<SECToutSMTPerr>>& contains more details of
23606 the handling of errors during remote deliveries.
23607
23608 Retry processing applies to routing as well as to delivering, except as covered
23609 in the next paragraph. The retry rules do not distinguish between these
23610 actions. It is not possible, for example, to specify different behaviour for
23611 failures to route the domain &'snark.fict.example'& and failures to deliver to
23612 the host &'snark.fict.example'&. I didn't think anyone would ever need this
23613 added complication, so did not implement it. However, although they share the
23614 same retry rule, the actual retry times for routing and transporting a given
23615 domain are maintained independently.
23616
23617 When a delivery is not part of a queue run (typically an immediate delivery on
23618 receipt of a message), the routers are always run, and local deliveries are
23619 always attempted, even if retry times are set for them. This makes for better
23620 behaviour if one particular message is causing problems (for example, causing
23621 quota overflow, or provoking an error in a filter file). If such a delivery
23622 suffers a temporary failure, the retry data is updated as normal, and
23623 subsequent delivery attempts from queue runs occur only when the retry time for
23624 the local address is reached.
23625
23626 .section "Changing retry rules" "SECID157"
23627 If you change the retry rules in your configuration, you should consider
23628 whether or not to delete the retry data that is stored in Exim's spool area in
23629 files with names like &_db/retry_&. Deleting any of Exim's hints files is
23630 always safe; that is why they are called &"hints"&.
23631
23632 The hints retry data contains suggested retry times based on the previous
23633 rules. In the case of a long-running problem with a remote host, it might
23634 record the fact that the host has timed out. If your new rules increase the
23635 timeout time for such a host, you should definitely remove the old retry data
23636 and let Exim recreate it, based on the new rules. Otherwise Exim might bounce
23637 messages that it should now be retaining.
23638
23639
23640
23641 .section "Format of retry rules" "SECID158"
23642 .cindex "retry" "rules"
23643 Each retry rule occupies one line and consists of three or four parts,
23644 separated by white space: a pattern, an error name, an optional list of sender
23645 addresses, and a list of retry parameters. The pattern and sender lists must be
23646 enclosed in double quotes if they contain white space. The rules are searched
23647 in order until one is found where the pattern, error name, and sender list (if
23648 present) match the failing host or address, the error that occurred, and the
23649 message's sender, respectively.
23650
23651
23652 The pattern is any single item that may appear in an address list (see section
23653 &<<SECTaddresslist>>&). It is in fact processed as a one-item address list,
23654 which means that it is expanded before being tested against the address that
23655 has been delayed. A negated address list item is permitted. Address
23656 list processing treats a plain domain name as if it were preceded by &"*@"&,
23657 which makes it possible for many retry rules to start with just a domain. For
23658 example,
23659 .code
23660 lookingglass.fict.example        *  F,24h,30m;
23661 .endd
23662 provides a rule for any address in the &'lookingglass.fict.example'& domain,
23663 whereas
23664 .code
23665 alice@lookingglass.fict.example  *  F,24h,30m;
23666 .endd
23667 applies only to temporary failures involving the local part &%alice%&.
23668 In practice, almost all rules start with a domain name pattern without a local
23669 part.
23670
23671 .cindex "regular expressions" "in retry rules"
23672 &*Warning*&: If you use a regular expression in a retry rule pattern, it
23673 must match a complete address, not just a domain, because that is how regular
23674 expressions work in address lists.
23675 .display
23676 &`^\Nxyz\d+\.abc\.example$\N        *  G,1h,10m,2`&     &%Wrong%&
23677 &`^\N[^@]+@xyz\d+\.abc\.example$\N  *  G,1h,10m,2`&     &%Right%&
23678 .endd
23679
23680
23681 .section "Choosing which retry rule to use for address errors" "SECID159"
23682 When Exim is looking for a retry rule after a routing attempt has failed (for
23683 example, after a DNS timeout), each line in the retry configuration is tested
23684 against the complete address only if &%retry_use_local_part%& is set for the
23685 router. Otherwise, only the domain is used, except when matching against a
23686 regular expression, when the local part of the address is replaced with &"*"&.
23687 A domain on its own can match a domain pattern, or a pattern that starts with
23688 &"*@"&. By default, &%retry_use_local_part%& is true for routers where
23689 &%check_local_user%& is true, and false for other routers.
23690
23691 Similarly, when Exim is looking for a retry rule after a local delivery has
23692 failed (for example, after a mailbox full error), each line in the retry
23693 configuration is tested against the complete address only if
23694 &%retry_use_local_part%& is set for the transport (it defaults true for all
23695 local transports).
23696
23697 .cindex "4&'xx'& responses" "retry rules for"
23698 However, when Exim is looking for a retry rule after a remote delivery attempt
23699 suffers an address error (a 4&'xx'& SMTP response for a recipient address), the
23700 whole address is always used as the key when searching the retry rules. The
23701 rule that is found is used to create a retry time for the combination of the
23702 failing address and the message's sender. It is the combination of sender and
23703 recipient that is delayed in subsequent queue runs until its retry time is
23704 reached. You can delay the recipient without regard to the sender by setting
23705 &%address_retry_include_sender%& false in the &(smtp)& transport but this can
23706 lead to problems with servers that regularly issue 4&'xx'& responses to RCPT
23707 commands.
23708
23709
23710
23711 .section "Choosing which retry rule to use for host and message errors" &&&
23712          "SECID160"
23713 For a temporary error that is not related to an individual address (for
23714 example, a connection timeout), each line in the retry configuration is checked
23715 twice. First, the name of the remote host is used as a domain name (preceded by
23716 &"*@"& when matching a regular expression). If this does not match the line,
23717 the domain from the email address is tried in a similar fashion. For example,
23718 suppose the MX records for &'a.b.c.example'& are
23719 .code
23720 a.b.c.example  MX  5  x.y.z.example
23721                MX  6  p.q.r.example
23722                MX  7  m.n.o.example
23723 .endd
23724 and the retry rules are
23725 .code
23726 p.q.r.example    *      F,24h,30m;
23727 a.b.c.example    *      F,4d,45m;
23728 .endd
23729 and a delivery to the host &'x.y.z.example'& suffers a connection failure. The
23730 first rule matches neither the host nor the domain, so Exim looks at the second
23731 rule. This does not match the host, but it does match the domain, so it is used
23732 to calculate the retry time for the host &'x.y.z.example'&. Meanwhile, Exim
23733 tries to deliver to &'p.q.r.example'&. If this also suffers a host error, the
23734 first retry rule is used, because it matches the host.
23735
23736 In other words, temporary failures to deliver to host &'p.q.r.example'& use the
23737 first rule to determine retry times, but for all the other hosts for the domain
23738 &'a.b.c.example'&, the second rule is used. The second rule is also used if
23739 routing to &'a.b.c.example'& suffers a temporary failure.
23740
23741 &*Note*&: The host name is used when matching the patterns, not its IP address.
23742 However, if a message is routed directly to an IP address without the use of a
23743 host name, for example, if a &(manualroute)& router contains a setting such as:
23744 .code
23745 route_list = *.a.example  192.168.34.23
23746 .endd
23747 then the &"host name"& that is used when searching for a retry rule is the
23748 textual form of the IP address.
23749
23750 .section "Retry rules for specific errors" "SECID161"
23751 .cindex "retry" "specific errors; specifying"
23752 The second field in a retry rule is the name of a particular error, or an
23753 asterisk, which matches any error. The errors that can be tested for are:
23754
23755 .vlist
23756 .vitem &%auth_failed%&
23757 Authentication failed when trying to send to a host in the
23758 &%hosts_require_auth%& list in an &(smtp)& transport.
23759
23760 .vitem &%data_4xx%&
23761 A 4&'xx'& error was received for an outgoing DATA command, either immediately
23762 after the command, or after sending the message's data.
23763
23764 .vitem &%mail_4xx%&
23765 A 4&'xx'& error was received for an outgoing MAIL command.
23766
23767 .vitem &%rcpt_4xx%&
23768 A 4&'xx'& error was received for an outgoing RCPT command.
23769 .endlist
23770
23771 For the three 4&'xx'& errors, either the first or both of the x's can be given
23772 as specific digits, for example: &`mail_45x`& or &`rcpt_436`&. For example, to
23773 recognize 452 errors given to RCPT commands for addresses in a certain domain,
23774 and have retries every ten minutes with a one-hour timeout, you could set up a
23775 retry rule of this form:
23776 .code
23777 the.domain.name  rcpt_452   F,1h,10m
23778 .endd
23779 These errors apply to both outgoing SMTP (the &(smtp)& transport) and outgoing
23780 LMTP (either the &(lmtp)& transport, or the &(smtp)& transport in LMTP mode).
23781
23782 .vlist
23783 .vitem &%lost_connection%&
23784 A server unexpectedly closed the SMTP connection. There may, of course,
23785 legitimate reasons for this (host died, network died), but if it repeats a lot
23786 for the same host, it indicates something odd.
23787
23788 .vitem &%refused_MX%&
23789 A connection to a host obtained from an MX record was refused.
23790
23791 .vitem &%refused_A%&
23792 A connection to a host not obtained from an MX record was refused.
23793
23794 .vitem &%refused%&
23795 A connection was refused.
23796
23797 .vitem &%timeout_connect_MX%&
23798 A connection attempt to a host obtained from an MX record timed out.
23799
23800 .vitem &%timeout_connect_A%&
23801 A connection attempt to a host not obtained from an MX record timed out.
23802
23803 .vitem &%timeout_connect%&
23804 A connection attempt timed out.
23805
23806 .vitem &%timeout_MX%&
23807 There was a timeout while connecting or during an SMTP session with a host
23808 obtained from an MX record.
23809
23810 .vitem &%timeout_A%&
23811 There was a timeout while connecting or during an SMTP session with a host not
23812 obtained from an MX record.
23813
23814 .vitem &%timeout%&
23815 There was a timeout while connecting or during an SMTP session.
23816
23817 .vitem &%tls_required%&
23818 The server was required to use TLS (it matched &%hosts_require_tls%& in the
23819 &(smtp)& transport), but either did not offer TLS, or it responded with 4&'xx'&
23820 to STARTTLS, or there was a problem setting up the TLS connection.
23821
23822 .vitem &%quota%&
23823 A mailbox quota was exceeded in a local delivery by the &(appendfile)&
23824 transport.
23825
23826 .vitem &%quota_%&<&'time'&>
23827 .cindex "quota" "error testing in retry rule"
23828 .cindex "retry" "quota error testing"
23829 A mailbox quota was exceeded in a local delivery by the &(appendfile)&
23830 transport, and the mailbox has not been accessed for <&'time'&>. For example,
23831 &'quota_4d'& applies to a quota error when the mailbox has not been accessed
23832 for four days.
23833 .endlist
23834
23835 .cindex "mailbox" "time of last read"
23836 The idea of &%quota_%&<&'time'&> is to make it possible to have shorter
23837 timeouts when the mailbox is full and is not being read by its owner. Ideally,
23838 it should be based on the last time that the user accessed the mailbox.
23839 However, it is not always possible to determine this. Exim uses the following
23840 heuristic rules:
23841
23842 .ilist
23843 If the mailbox is a single file, the time of last access (the &"atime"&) is
23844 used. As no new messages are being delivered (because the mailbox is over
23845 quota), Exim does not access the file, so this is the time of last user access.
23846 .next
23847 .cindex "maildir format" "time of last read"
23848 For a maildir delivery, the time of last modification of the &_new_&
23849 subdirectory is used. As the mailbox is over quota, no new files are created in
23850 the &_new_& subdirectory, because no new messages are being delivered. Any
23851 change to the &_new_& subdirectory is therefore assumed to be the result of an
23852 MUA moving a new message to the &_cur_& directory when it is first read. The
23853 time that is used is therefore the last time that the user read a new message.
23854 .next
23855 For other kinds of multi-file mailbox, the time of last access cannot be
23856 obtained, so a retry rule that uses this type of error field is never matched.
23857 .endlist
23858
23859 The quota errors apply both to system-enforced quotas and to Exim's own quota
23860 mechanism in the &(appendfile)& transport. The &'quota'& error also applies
23861 when a local delivery is deferred because a partition is full (the ENOSPC
23862 error).
23863
23864
23865
23866 .section "Retry rules for specified senders" "SECID162"
23867 .cindex "retry" "rules; sender-specific"
23868 You can specify retry rules that apply only when the failing message has a
23869 specific sender. In particular, this can be used to define retry rules that
23870 apply only to bounce messages. The third item in a retry rule can be of this
23871 form:
23872 .display
23873 &`senders=`&<&'address list'&>
23874 .endd
23875 The retry timings themselves are then the fourth item. For example:
23876 .code
23877 *   rcpt_4xx   senders=:   F,1h,30m
23878 .endd
23879 matches recipient 4&'xx'& errors for bounce messages sent to any address at any
23880 host. If the address list contains white space, it must be enclosed in quotes.
23881 For example:
23882 .code
23883 a.domain  rcpt_452  senders="xb.dom : yc.dom"  G,8h,10m,1.5
23884 .endd
23885 &*Warning*&: This facility can be unhelpful if it is used for host errors
23886 (which do not depend on the recipient). The reason is that the sender is used
23887 only to match the retry rule. Once the rule has been found for a host error,
23888 its contents are used to set a retry time for the host, and this will apply to
23889 all messages, not just those with specific senders.
23890
23891 When testing retry rules using &%-brt%&, you can supply a sender using the
23892 &%-f%& command line option, like this:
23893 .code
23894 exim -f "" -brt user@dom.ain
23895 .endd
23896 If you do not set &%-f%& with &%-brt%&, a retry rule that contains a senders
23897 list is never matched.
23898
23899
23900
23901
23902
23903 .section "Retry parameters" "SECID163"
23904 .cindex "retry" "parameters in rules"
23905 The third (or fourth, if a senders list is present) field in a retry rule is a
23906 sequence of retry parameter sets, separated by semicolons. Each set consists of
23907 .display
23908 <&'letter'&>,<&'cutoff time'&>,<&'arguments'&>
23909 .endd
23910 The letter identifies the algorithm for computing a new retry time; the cutoff
23911 time is the time beyond which this algorithm no longer applies, and the
23912 arguments vary the algorithm's action. The cutoff time is measured from the
23913 time that the first failure for the domain (combined with the local part if
23914 relevant) was detected, not from the time the message was received.
23915
23916 .cindex "retry" "algorithms"
23917 .cindex "retry" "fixed intervals"
23918 .cindex "retry" "increasing intervals"
23919 .cindex "retry" "random intervals"
23920 The available algorithms are:
23921
23922 .ilist
23923 &'F'&: retry at fixed intervals. There is a single time parameter specifying
23924 the interval.
23925 .next
23926 &'G'&: retry at geometrically increasing intervals. The first argument
23927 specifies a starting value for the interval, and the second a multiplier, which
23928 is used to increase the size of the interval at each retry.
23929 .next
23930 &'H'&: retry at randomized intervals. The arguments are as for &'G'&. For each
23931 retry, the previous interval is multiplied by the factor in order to get a
23932 maximum for the next interval. The minimum interval is the first argument of
23933 the parameter, and an actual interval is chosen randomly between them. Such a
23934 rule has been found to be helpful in cluster configurations when all the
23935 members of the cluster restart at once, and may therefore synchronize their
23936 queue processing times.
23937 .endlist
23938
23939 When computing the next retry time, the algorithm definitions are scanned in
23940 order until one whose cutoff time has not yet passed is reached. This is then
23941 used to compute a new retry time that is later than the current time. In the
23942 case of fixed interval retries, this simply means adding the interval to the
23943 current time. For geometrically increasing intervals, retry intervals are
23944 computed from the rule's parameters until one that is greater than the previous
23945 interval is found. The main configuration variable
23946 .cindex "limit" "retry interval"
23947 .cindex "retry" "interval, maximum"
23948 .oindex "&%retry_interval_max%&"
23949 &%retry_interval_max%& limits the maximum interval between retries. It
23950 cannot be set greater than &`24h`&, which is its default value.
23951
23952 A single remote domain may have a number of hosts associated with it, and each
23953 host may have more than one IP address. Retry algorithms are selected on the
23954 basis of the domain name, but are applied to each IP address independently. If,
23955 for example, a host has two IP addresses and one is unusable, Exim will
23956 generate retry times for it and will not try to use it until its next retry
23957 time comes. Thus the good IP address is likely to be tried first most of the
23958 time.
23959
23960 .cindex "hints database" "use for retrying"
23961 Retry times are hints rather than promises. Exim does not make any attempt to
23962 run deliveries exactly at the computed times. Instead, a queue runner process
23963 starts delivery processes for delayed messages periodically, and these attempt
23964 new deliveries only for those addresses that have passed their next retry time.
23965 If a new message arrives for a deferred address, an immediate delivery attempt
23966 occurs only if the address has passed its retry time. In the absence of new
23967 messages, the minimum time between retries is the interval between queue runner
23968 processes. There is not much point in setting retry times of five minutes if
23969 your queue runners happen only once an hour, unless there are a significant
23970 number of incoming messages (which might be the case on a system that is
23971 sending everything to a smart host, for example).
23972
23973 The data in the retry hints database can be inspected by using the
23974 &'exim_dumpdb'& or &'exim_fixdb'& utility programs (see chapter
23975 &<<CHAPutils>>&). The latter utility can also be used to change the data. The
23976 &'exinext'& utility script can be used to find out what the next retry times
23977 are for the hosts associated with a particular mail domain, and also for local
23978 deliveries that have been deferred.
23979
23980
23981 .section "Retry rule examples" "SECID164"
23982 Here are some example retry rules:
23983 .code
23984 alice@wonderland.fict.example quota_5d  F,7d,3h
23985 wonderland.fict.example       quota_5d
23986 wonderland.fict.example       *         F,1h,15m; G,2d,1h,2;
23987 lookingglass.fict.example     *         F,24h,30m;
23988 *                 refused_A   F,2h,20m;
23989 *                 *           F,2h,15m; G,16h,1h,1.5; F,5d,8h
23990 .endd
23991 The first rule sets up special handling for mail to
23992 &'alice@wonderland.fict.example'& when there is an over-quota error and the
23993 mailbox has not been read for at least 5 days. Retries continue every three
23994 hours for 7 days. The second rule handles over-quota errors for all other local
23995 parts at &'wonderland.fict.example'&; the absence of a local part has the same
23996 effect as supplying &"*@"&. As no retry algorithms are supplied, messages that
23997 fail are bounced immediately if the mailbox has not been read for at least 5
23998 days.
23999
24000 The third rule handles all other errors at &'wonderland.fict.example'&; retries
24001 happen every 15 minutes for an hour, then with geometrically increasing
24002 intervals until two days have passed since a delivery first failed. After the
24003 first hour there is a delay of one hour, then two hours, then four hours, and
24004 so on (this is a rather extreme example).
24005
24006 The fourth rule controls retries for the domain &'lookingglass.fict.example'&.
24007 They happen every 30 minutes for 24 hours only. The remaining two rules handle
24008 all other domains, with special action for connection refusal from hosts that
24009 were not obtained from an MX record.
24010
24011 The final rule in a retry configuration should always have asterisks in the
24012 first two fields so as to provide a general catch-all for any addresses that do
24013 not have their own special handling. This example tries every 15 minutes for 2
24014 hours, then with intervals starting at one hour and increasing by a factor of
24015 1.5 up to 16 hours, then every 8 hours up to 5 days.
24016
24017
24018
24019 .section "Timeout of retry data" "SECID165"
24020 .cindex "timeout" "of retry data"
24021 .oindex "&%retry_data_expire%&"
24022 .cindex "hints database" "data expiry"
24023 .cindex "retry" "timeout of data"
24024 Exim timestamps the data that it writes to its retry hints database. When it
24025 consults the data during a delivery it ignores any that is older than the value
24026 set in &%retry_data_expire%& (default 7 days). If, for example, a host hasn't
24027 been tried for 7 days, Exim will try to deliver to it immediately a message
24028 arrives, and if that fails, it will calculate a retry time as if it were
24029 failing for the first time.
24030
24031 This improves the behaviour for messages routed to rarely-used hosts such as MX
24032 backups. If such a host was down at one time, and happens to be down again when
24033 Exim tries a month later, using the old retry data would imply that it had been
24034 down all the time, which is not a justified assumption.
24035
24036 If a host really is permanently dead, this behaviour causes a burst of retries
24037 every now and again, but only if messages routed to it are rare. If there is a
24038 message at least once every 7 days the retry data never expires.
24039
24040
24041
24042
24043 .section "Long-term failures" "SECID166"
24044 .cindex "delivery failure, long-term"
24045 .cindex "retry" "after long-term failure"
24046 Special processing happens when an email address has been failing for so long
24047 that the cutoff time for the last algorithm is reached. For example, using the
24048 default retry rule:
24049 .code
24050 * * F,2h,15m; G,16h,1h,1.5; F,4d,6h
24051 .endd
24052 the cutoff time is four days. Reaching the retry cutoff is independent of how
24053 long any specific message has been failing; it is the length of continuous
24054 failure for the recipient address that counts.
24055
24056 When the cutoff time is reached for a local delivery, or for all the IP
24057 addresses associated with a remote delivery, a subsequent delivery failure
24058 causes Exim to give up on the address, and a bounce message is generated.
24059 In order to cater for new messages that use the failing address, a next retry
24060 time is still computed from the final algorithm, and is used as follows:
24061
24062 For local deliveries, one delivery attempt is always made for any subsequent
24063 messages. If this delivery fails, the address fails immediately. The
24064 post-cutoff retry time is not used.
24065
24066 If the delivery is remote, there are two possibilities, controlled by the
24067 .oindex "&%delay_after_cutoff%&"
24068 &%delay_after_cutoff%& option of the &(smtp)& transport. The option is true by
24069 default. Until the post-cutoff retry time for one of the IP addresses is
24070 reached, the failing email address is bounced immediately, without a delivery
24071 attempt taking place. After that time, one new delivery attempt is made to
24072 those IP addresses that are past their retry times, and if that still fails,
24073 the address is bounced and new retry times are computed.
24074
24075 In other words, when all the hosts for a given email address have been failing
24076 for a long time, Exim bounces rather then defers until one of the hosts' retry
24077 times is reached. Then it tries once, and bounces if that attempt fails. This
24078 behaviour ensures that few resources are wasted in repeatedly trying to deliver
24079 to a broken destination, but if the host does recover, Exim will eventually
24080 notice.
24081
24082 If &%delay_after_cutoff%& is set false, Exim behaves differently. If all IP
24083 addresses are past their final cutoff time, Exim tries to deliver to those IP
24084 addresses that have not been tried since the message arrived. If there are
24085 no suitable IP addresses, or if they all fail, the address is bounced. In other
24086 words, it does not delay when a new message arrives, but tries the expired
24087 addresses immediately, unless they have been tried since the message arrived.
24088 If there is a continuous stream of messages for the failing domains, setting
24089 &%delay_after_cutoff%& false means that there will be many more attempts to
24090 deliver to permanently failing IP addresses than when &%delay_after_cutoff%& is
24091 true.
24092
24093 .section "Deliveries that work intermittently" "SECID167"
24094 .cindex "retry" "intermittently working deliveries"
24095 Some additional logic is needed to cope with cases where a host is
24096 intermittently available, or when a message has some attribute that prevents
24097 its delivery when others to the same address get through. In this situation,
24098 because some messages are successfully delivered, the &"retry clock"& for the
24099 host or address keeps getting reset by the successful deliveries, and so
24100 failing messages remain on the queue for ever because the cutoff time is never
24101 reached.
24102
24103 Two exceptional actions are applied to prevent this happening. The first
24104 applies to errors that are related to a message rather than a remote host.
24105 Section &<<SECToutSMTPerr>>& has a discussion of the different kinds of error;
24106 examples of message-related errors are 4&'xx'& responses to MAIL or DATA
24107 commands, and quota failures. For this type of error, if a message's arrival
24108 time is earlier than the &"first failed"& time for the error, the earlier time
24109 is used when scanning the retry rules to decide when to try next and when to
24110 time out the address.
24111
24112 The exceptional second action applies in all cases. If a message has been on
24113 the queue for longer than the cutoff time of any applicable retry rule for a
24114 given address, a delivery is attempted for that address, even if it is not yet
24115 time, and if this delivery fails, the address is timed out. A new retry time is
24116 not computed in this case, so that other messages for the same address are
24117 considered immediately.
24118 .ecindex IIDretconf1
24119 .ecindex IIDregconf2
24120
24121
24122
24123
24124
24125
24126 . ////////////////////////////////////////////////////////////////////////////
24127 . ////////////////////////////////////////////////////////////////////////////
24128
24129 .chapter "SMTP authentication" "CHAPSMTPAUTH"
24130 .scindex IIDauthconf1 "SMTP" "authentication configuration"
24131 .scindex IIDauthconf2 "authentication"
24132 The &"authenticators"& section of Exim's run time configuration is concerned
24133 with SMTP authentication. This facility is an extension to the SMTP protocol,
24134 described in RFC 2554, which allows a client SMTP host to authenticate itself
24135 to a server. This is a common way for a server to recognize clients that are
24136 permitted to use it as a relay. SMTP authentication is not of relevance to the
24137 transfer of mail between servers that have no managerial connection with each
24138 other.
24139
24140 .cindex "AUTH" "description of"
24141 Very briefly, the way SMTP authentication works is as follows:
24142
24143 .ilist
24144 The server advertises a number of authentication &'mechanisms'& in response to
24145 the client's EHLO command.
24146 .next
24147 The client issues an AUTH command, naming a specific mechanism. The command
24148 may, optionally, contain some authentication data.
24149 .next
24150 The server may issue one or more &'challenges'&, to which the client must send
24151 appropriate responses. In simple authentication mechanisms, the challenges are
24152 just prompts for user names and passwords. The server does not have to issue
24153 any challenges &-- in some mechanisms the relevant data may all be transmitted
24154 with the AUTH command.
24155 .next
24156 The server either accepts or denies authentication.
24157 .next
24158 If authentication succeeds, the client may optionally make use of the AUTH
24159 option on the MAIL command to pass an authenticated sender in subsequent
24160 mail transactions. Authentication lasts for the remainder of the SMTP
24161 connection.
24162 .next
24163 If authentication fails, the client may give up, or it may try a different
24164 authentication mechanism, or it may try transferring mail over the
24165 unauthenticated connection.
24166 .endlist
24167
24168 If you are setting up a client, and want to know which authentication
24169 mechanisms the server supports, you can use Telnet to connect to port 25 (the
24170 SMTP port) on the server, and issue an EHLO command. The response to this
24171 includes the list of supported mechanisms. For example:
24172 .display
24173 &`$ `&&*&`telnet server.example 25`&*&
24174 &`Trying 192.168.34.25...`&
24175 &`Connected to server.example.`&
24176 &`Escape character is &#x0027;^]&#x0027;.`&
24177 &`220 server.example ESMTP Exim 4.20 ...`&
24178 &*&`ehlo client.example`&*&
24179 &`250-server.example Hello client.example [10.8.4.5]`&
24180 &`250-SIZE 52428800`&
24181 &`250-PIPELINING`&
24182 &`250-AUTH PLAIN`&
24183 &`250 HELP`&
24184 .endd
24185 The second-last line of this example output shows that the server supports
24186 authentication using the PLAIN mechanism. In Exim, the different authentication
24187 mechanisms are configured by specifying &'authenticator'& drivers. Like the
24188 routers and transports, which authenticators are included in the binary is
24189 controlled by build-time definitions. The following are currently available,
24190 included by setting
24191 .code
24192 AUTH_CRAM_MD5=yes
24193 AUTH_CYRUS_SASL=yes
24194 AUTH_DOVECOT=yes
24195 AUTH_GSASL=yes
24196 AUTH_HEIMDAL_GSSAPI=yes
24197 AUTH_PLAINTEXT=yes
24198 AUTH_SPA=yes
24199 .endd
24200 in &_Local/Makefile_&, respectively. The first of these supports the CRAM-MD5
24201 authentication mechanism (RFC 2195), and the second provides an interface to
24202 the Cyrus SASL authentication library.
24203 The third is an interface to Dovecot's authentication system, delegating the
24204 work via a socket interface.
24205 The fourth provides an interface to the GNU SASL authentication library, which
24206 provides mechanisms but typically not data sources.
24207 The fifth provides direct access to Heimdal GSSAPI, geared for Kerberos, but
24208 supporting setting a server keytab.
24209 The sixth can be configured to support
24210 the PLAIN authentication mechanism (RFC 2595) or the LOGIN mechanism, which is
24211 not formally documented, but used by several MUAs. The seventh authenticator
24212 supports Microsoft's &'Secure Password Authentication'& mechanism.
24213
24214 The authenticators are configured using the same syntax as other drivers (see
24215 section &<<SECTfordricon>>&). If no authenticators are required, no
24216 authentication section need be present in the configuration file. Each
24217 authenticator can in principle have both server and client functions. When Exim
24218 is receiving SMTP mail, it is acting as a server; when it is sending out
24219 messages over SMTP, it is acting as a client. Authenticator configuration
24220 options are provided for use in both these circumstances.
24221
24222 To make it clear which options apply to which situation, the prefixes
24223 &%server_%& and &%client_%& are used on option names that are specific to
24224 either the server or the client function, respectively. Server and client
24225 functions are disabled if none of their options are set. If an authenticator is
24226 to be used for both server and client functions, a single definition, using
24227 both sets of options, is required. For example:
24228 .code
24229 cram:
24230   driver = cram_md5
24231   public_name = CRAM-MD5
24232   server_secret = ${if eq{$auth1}{ph10}{secret1}fail}
24233   client_name = ph10
24234   client_secret = secret2
24235 .endd
24236 The &%server_%& option is used when Exim is acting as a server, and the
24237 &%client_%& options when it is acting as a client.
24238
24239 Descriptions of the individual authenticators are given in subsequent chapters.
24240 The remainder of this chapter covers the generic options for the
24241 authenticators, followed by general discussion of the way authentication works
24242 in Exim.
24243
24244 &*Beware:*& the meaning of &$auth1$&, &$auth2$&, ... varies on a per-driver and
24245 per-mechanism basis.  Please read carefully to determine which variables hold
24246 account labels such as usercodes and which hold passwords or other
24247 authenticating data.
24248
24249 Note that some mechanisms support two different identifiers for accounts: the
24250 &'authentication id'& and the &'authorization id'&.  The contractions &'authn'&
24251 and &'authz'& are commonly encountered.  The American spelling is standard here.
24252 Conceptually, authentication data such as passwords are tied to the identifier
24253 used to authenticate; servers may have rules to permit one user to act as a
24254 second user, so that after login the session is treated as though that second
24255 user had logged in.  That second user is the &'authorization id'&.  A robust
24256 configuration might confirm that the &'authz'& field is empty or matches the
24257 &'authn'& field.  Often this is just ignored.  The &'authn'& can be considered
24258 as verified data, the &'authz'& as an unverified request which the server might
24259 choose to honour.
24260
24261 A &'realm'& is a text string, typically a domain name, presented by a server
24262 to a client to help it select an account and credentials to use.  In some
24263 mechanisms, the client and server provably agree on the realm, but clients
24264 typically can not treat the realm as secure data to be blindly trusted.
24265
24266
24267
24268 .section "Generic options for authenticators" "SECID168"
24269 .cindex "authentication" "generic options"
24270 .cindex "options" "generic; for authenticators"
24271
24272 .option client_condition authenticators string&!! unset
24273 When Exim is authenticating as a client, it skips any authenticator whose
24274 &%client_condition%& expansion yields &"0"&, &"no"&, or &"false"&. This can be
24275 used, for example, to skip plain text authenticators when the connection is not
24276 encrypted by a setting such as:
24277 .code
24278 client_condition = ${if !eq{$tls_out_cipher}{}}
24279 .endd
24280
24281
24282 .option client_set_id authenticators string&!! unset
24283 When client authentication succeeds, this condition is expanded; the
24284 result is used in the log lines for outbound messasges.
24285 Typically it will be the user name used for authentication.
24286
24287
24288 .option driver authenticators string unset
24289 This option must always be set. It specifies which of the available
24290 authenticators is to be used.
24291
24292
24293 .option public_name authenticators string unset
24294 This option specifies the name of the authentication mechanism that the driver
24295 implements, and by which it is known to the outside world. These names should
24296 contain only upper case letters, digits, underscores, and hyphens (RFC 2222),
24297 but Exim in fact matches them caselessly. If &%public_name%& is not set, it
24298 defaults to the driver's instance name.
24299
24300
24301 .option server_advertise_condition authenticators string&!! unset
24302 When a server is about to advertise an authentication mechanism, the condition
24303 is expanded. If it yields the empty string, &"0"&, &"no"&, or &"false"&, the
24304 mechanism is not advertised.
24305 If the expansion fails, the mechanism is not advertised. If the failure was not
24306 forced, and was not caused by a lookup defer, the incident is logged.
24307 See section &<<SECTauthexiser>>& below for further discussion.
24308
24309
24310 .option server_condition authenticators string&!! unset
24311 This option must be set for a &%plaintext%& server authenticator, where it
24312 is used directly to control authentication. See section &<<SECTplainserver>>&
24313 for details.
24314
24315 For the &(gsasl)& authenticator, this option is required for various
24316 mechanisms; see chapter &<<CHAPgsasl>>& for details.
24317
24318 For the other authenticators, &%server_condition%& can be used as an additional
24319 authentication or authorization mechanism that is applied after the other
24320 authenticator conditions succeed. If it is set, it is expanded when the
24321 authenticator would otherwise return a success code. If the expansion is forced
24322 to fail, authentication fails. Any other expansion failure causes a temporary
24323 error code to be returned. If the result of a successful expansion is an empty
24324 string, &"0"&, &"no"&, or &"false"&, authentication fails. If the result of the
24325 expansion is &"1"&, &"yes"&, or &"true"&, authentication succeeds. For any
24326 other result, a temporary error code is returned, with the expanded string as
24327 the error text.
24328
24329
24330 .option server_debug_print authenticators string&!! unset
24331 If this option is set and authentication debugging is enabled (see the &%-d%&
24332 command line option), the string is expanded and included in the debugging
24333 output when the authenticator is run as a server. This can help with checking
24334 out the values of variables.
24335 If expansion of the string fails, the error message is written to the debugging
24336 output, and Exim carries on processing.
24337
24338
24339 .option server_set_id authenticators string&!! unset
24340 .vindex "&$authenticated_id$&"
24341 When an Exim server successfully authenticates a client, this string is
24342 expanded using data from the authentication, and preserved for any incoming
24343 messages in the variable &$authenticated_id$&. It is also included in the log
24344 lines for incoming messages. For example, a user/password authenticator
24345 configuration might preserve the user name that was used to authenticate, and
24346 refer to it subsequently during delivery of the message.
24347 If expansion fails, the option is ignored.
24348
24349
24350 .option server_mail_auth_condition authenticators string&!! unset
24351 This option allows a server to discard authenticated sender addresses supplied
24352 as part of MAIL commands in SMTP connections that are authenticated by the
24353 driver on which &%server_mail_auth_condition%& is set. The option is not used
24354 as part of the authentication process; instead its (unexpanded) value is
24355 remembered for later use.
24356 How it is used is described in the following section.
24357
24358
24359
24360
24361
24362 .section "The AUTH parameter on MAIL commands" "SECTauthparamail"
24363 .cindex "authentication" "sender; authenticated"
24364 .cindex "AUTH" "on MAIL command"
24365 When a client supplied an AUTH= item on a MAIL command, Exim applies
24366 the following checks before accepting it as the authenticated sender of the
24367 message:
24368
24369 .ilist
24370 If the connection is not using extended SMTP (that is, HELO was used rather
24371 than EHLO), the use of AUTH= is a syntax error.
24372 .next
24373 If the value of the AUTH= parameter is &"<>"&, it is ignored.
24374 .next
24375 .vindex "&$authenticated_sender$&"
24376 If &%acl_smtp_mailauth%& is defined, the ACL it specifies is run. While it is
24377 running, the value of &$authenticated_sender$& is set to the value obtained
24378 from the AUTH= parameter. If the ACL does not yield &"accept"&, the value of
24379 &$authenticated_sender$& is deleted. The &%acl_smtp_mailauth%& ACL may not
24380 return &"drop"& or &"discard"&. If it defers, a temporary error code (451) is
24381 given for the MAIL command.
24382 .next
24383 If &%acl_smtp_mailauth%& is not defined, the value of the AUTH= parameter
24384 is accepted and placed in &$authenticated_sender$& only if the client has
24385 authenticated.
24386 .next
24387 If the AUTH= value was accepted by either of the two previous rules, and
24388 the client has authenticated, and the authenticator has a setting for the
24389 &%server_mail_auth_condition%&, the condition is checked at this point. The
24390 valued that was saved from the authenticator is expanded. If the expansion
24391 fails, or yields an empty string, &"0"&, &"no"&, or &"false"&, the value of
24392 &$authenticated_sender$& is deleted. If the expansion yields any other value,
24393 the value of &$authenticated_sender$& is retained and passed on with the
24394 message.
24395 .endlist
24396
24397
24398 When &$authenticated_sender$& is set for a message, it is passed on to other
24399 hosts to which Exim authenticates as a client. Do not confuse this value with
24400 &$authenticated_id$&, which is a string obtained from the authentication
24401 process, and which is not usually a complete email address.
24402
24403 .vindex "&$sender_address$&"
24404 Whenever an AUTH= value is ignored, the incident is logged. The ACL for
24405 MAIL, if defined, is run after AUTH= is accepted or ignored. It can
24406 therefore make use of &$authenticated_sender$&. The converse is not true: the
24407 value of &$sender_address$& is not yet set up when the &%acl_smtp_mailauth%&
24408 ACL is run.
24409
24410
24411
24412 .section "Authentication on an Exim server" "SECTauthexiser"
24413 .cindex "authentication" "on an Exim server"
24414 When Exim receives an EHLO command, it advertises the public names of those
24415 authenticators that are configured as servers, subject to the following
24416 conditions:
24417
24418 .ilist
24419 The client host must match &%auth_advertise_hosts%& (default *).
24420 .next
24421 It the &%server_advertise_condition%& option is set, its expansion must not
24422 yield the empty string, &"0"&, &"no"&, or &"false"&.
24423 .endlist
24424
24425 The order in which the authenticators are defined controls the order in which
24426 the mechanisms are advertised.
24427
24428 Some mail clients (for example, some versions of Netscape) require the user to
24429 provide a name and password for authentication whenever AUTH is advertised,
24430 even though authentication may not in fact be needed (for example, Exim may be
24431 set up to allow unconditional relaying from the client by an IP address check).
24432 You can make such clients more friendly by not advertising AUTH to them.
24433 For example, if clients on the 10.9.8.0/24 network are permitted (by the ACL
24434 that runs for RCPT) to relay without authentication, you should set
24435 .code
24436 auth_advertise_hosts = ! 10.9.8.0/24
24437 .endd
24438 so that no authentication mechanisms are advertised to them.
24439
24440 The &%server_advertise_condition%& controls the advertisement of individual
24441 authentication mechanisms. For example, it can be used to restrict the
24442 advertisement of a particular mechanism to encrypted connections, by a setting
24443 such as:
24444 .code
24445 server_advertise_condition = ${if eq{$tls_in_cipher}{}{no}{yes}}
24446 .endd
24447 .vindex "&$tls_in_cipher$&"
24448 If the session is encrypted, &$tls_in_cipher$& is not empty, and so the expansion
24449 yields &"yes"&, which allows the advertisement to happen.
24450
24451 When an Exim server receives an AUTH command from a client, it rejects it
24452 immediately if AUTH was not advertised in response to an earlier EHLO
24453 command. This is the case if
24454
24455 .ilist
24456 The client host does not match &%auth_advertise_hosts%&; or
24457 .next
24458 No authenticators are configured with server options; or
24459 .next
24460 Expansion of &%server_advertise_condition%& blocked the advertising of all the
24461 server authenticators.
24462 .endlist
24463
24464
24465 Otherwise, Exim runs the ACL specified by &%acl_smtp_auth%& in order
24466 to decide whether to accept the command. If &%acl_smtp_auth%& is not set,
24467 AUTH is accepted from any client host.
24468
24469 If AUTH is not rejected by the ACL, Exim searches its configuration for a
24470 server authentication mechanism that was advertised in response to EHLO and
24471 that matches the one named in the AUTH command. If it finds one, it runs
24472 the appropriate authentication protocol, and authentication either succeeds or
24473 fails. If there is no matching advertised mechanism, the AUTH command is
24474 rejected with a 504 error.
24475
24476 .vindex "&$received_protocol$&"
24477 .vindex "&$sender_host_authenticated$&"
24478 When a message is received from an authenticated host, the value of
24479 &$received_protocol$& is set to &"esmtpa"& or &"esmtpsa"& instead of &"esmtp"&
24480 or &"esmtps"&, and &$sender_host_authenticated$& contains the name (not the
24481 public name) of the authenticator driver that successfully authenticated the
24482 client from which the message was received. This variable is empty if there was
24483 no successful authentication.
24484
24485
24486
24487
24488 .section "Testing server authentication" "SECID169"
24489 .cindex "authentication" "testing a server"
24490 .cindex "AUTH" "testing a server"
24491 .cindex "base64 encoding" "creating authentication test data"
24492 Exim's &%-bh%& option can be useful for testing server authentication
24493 configurations. The data for the AUTH command has to be sent using base64
24494 encoding. A quick way to produce such data for testing is the following Perl
24495 script:
24496 .code
24497 use MIME::Base64;
24498 printf ("%s", encode_base64(eval "\"$ARGV[0]\""));
24499 .endd
24500 .cindex "binary zero" "in authentication data"
24501 This interprets its argument as a Perl string, and then encodes it. The
24502 interpretation as a Perl string allows binary zeros, which are required for
24503 some kinds of authentication, to be included in the data. For example, a
24504 command line to run this script on such data might be
24505 .code
24506 encode '\0user\0password'
24507 .endd
24508 Note the use of single quotes to prevent the shell interpreting the
24509 backslashes, so that they can be interpreted by Perl to specify characters
24510 whose code value is zero.
24511
24512 &*Warning 1*&: If either of the user or password strings starts with an octal
24513 digit, you must use three zeros instead of one after the leading backslash. If
24514 you do not, the octal digit that starts your string will be incorrectly
24515 interpreted as part of the code for the first character.
24516
24517 &*Warning 2*&: If there are characters in the strings that Perl interprets
24518 specially, you must use a Perl escape to prevent them being misinterpreted. For
24519 example, a command such as
24520 .code
24521 encode '\0user@domain.com\0pas$$word'
24522 .endd
24523 gives an incorrect answer because of the unescaped &"@"& and &"$"& characters.
24524
24525 If you have the &%mimencode%& command installed, another way to do produce
24526 base64-encoded strings is to run the command
24527 .code
24528 echo -e -n `\0user\0password' | mimencode
24529 .endd
24530 The &%-e%& option of &%echo%& enables the interpretation of backslash escapes
24531 in the argument, and the &%-n%& option specifies no newline at the end of its
24532 output. However, not all versions of &%echo%& recognize these options, so you
24533 should check your version before relying on this suggestion.
24534
24535
24536
24537 .section "Authentication by an Exim client" "SECID170"
24538 .cindex "authentication" "on an Exim client"
24539 The &(smtp)& transport has two options called &%hosts_require_auth%& and
24540 &%hosts_try_auth%&. When the &(smtp)& transport connects to a server that
24541 announces support for authentication, and the host matches an entry in either
24542 of these options, Exim (as a client) tries to authenticate as follows:
24543
24544 .ilist
24545 For each authenticator that is configured as a client, in the order in which
24546 they are defined in the configuration, it searches the authentication
24547 mechanisms announced by the server for one whose name matches the public name
24548 of the authenticator.
24549 .next
24550 .vindex "&$host$&"
24551 .vindex "&$host_address$&"
24552 When it finds one that matches, it runs the authenticator's client code. The
24553 variables &$host$& and &$host_address$& are available for any string expansions
24554 that the client might do. They are set to the server's name and IP address. If
24555 any expansion is forced to fail, the authentication attempt is abandoned, and
24556 Exim moves on to the next authenticator. Otherwise an expansion failure causes
24557 delivery to be deferred.
24558 .next
24559 If the result of the authentication attempt is a temporary error or a timeout,
24560 Exim abandons trying to send the message to the host for the moment. It will
24561 try again later. If there are any backup hosts available, they are tried in the
24562 usual way.
24563 .next
24564 If the response to authentication is a permanent error (5&'xx'& code), Exim
24565 carries on searching the list of authenticators and tries another one if
24566 possible. If all authentication attempts give permanent errors, or if there are
24567 no attempts because no mechanisms match (or option expansions force failure),
24568 what happens depends on whether the host matches &%hosts_require_auth%& or
24569 &%hosts_try_auth%&. In the first case, a temporary error is generated, and
24570 delivery is deferred. The error can be detected in the retry rules, and thereby
24571 turned into a permanent error if you wish. In the second case, Exim tries to
24572 deliver the message unauthenticated.
24573 .endlist
24574
24575 .cindex "AUTH" "on MAIL command"
24576 When Exim has authenticated itself to a remote server, it adds the AUTH
24577 parameter to the MAIL commands it sends, if it has an authenticated sender for
24578 the message. If the message came from a remote host, the authenticated sender
24579 is the one that was receiving on an incoming MAIL command, provided that the
24580 incoming connection was authenticated and the &%server_mail_auth%& condition
24581 allowed the authenticated sender to be retained. If a local process calls Exim
24582 to send a message, the sender address that is built from the login name and
24583 &%qualify_domain%& is treated as authenticated. However, if the
24584 &%authenticated_sender%& option is set on the &(smtp)& transport, it overrides
24585 the authenticated sender that was received with the message.
24586 .ecindex IIDauthconf1
24587 .ecindex IIDauthconf2
24588
24589
24590
24591
24592
24593
24594 . ////////////////////////////////////////////////////////////////////////////
24595 . ////////////////////////////////////////////////////////////////////////////
24596
24597 .chapter "The plaintext authenticator" "CHAPplaintext"
24598 .scindex IIDplaiauth1 "&(plaintext)& authenticator"
24599 .scindex IIDplaiauth2 "authenticators" "&(plaintext)&"
24600 The &(plaintext)& authenticator can be configured to support the PLAIN and
24601 LOGIN authentication mechanisms, both of which transfer authentication data as
24602 plain (unencrypted) text (though base64 encoded). The use of plain text is a
24603 security risk; you are strongly advised to insist on the use of SMTP encryption
24604 (see chapter &<<CHAPTLS>>&) if you use the PLAIN or LOGIN mechanisms. If you do
24605 use unencrypted plain text, you should not use the same passwords for SMTP
24606 connections as you do for login accounts.
24607
24608 .section "Plaintext options" "SECID171"
24609 .cindex "options" "&(plaintext)& authenticator (server)"
24610 When configured as a server, &(plaintext)& uses the following options:
24611
24612 .option server_condition authenticators string&!! unset
24613 This is actually a global authentication option, but it must be set in order to
24614 configure the &(plaintext)& driver as a server. Its use is described below.
24615
24616 .option server_prompts plaintext string&!! unset
24617 The contents of this option, after expansion, must be a colon-separated list of
24618 prompt strings. If expansion fails, a temporary authentication rejection is
24619 given.
24620
24621 .section "Using plaintext in a server" "SECTplainserver"
24622 .cindex "AUTH" "in &(plaintext)& authenticator"
24623 .cindex "binary zero" "in &(plaintext)& authenticator"
24624 .cindex "numerical variables (&$1$& &$2$& etc)" &&&
24625         "in &(plaintext)& authenticator"
24626 .vindex "&$auth1$&, &$auth2$&, etc"
24627 .cindex "base64 encoding" "in &(plaintext)& authenticator"
24628
24629 When running as a server, &(plaintext)& performs the authentication test by
24630 expanding a string. The data sent by the client with the AUTH command, or in
24631 response to subsequent prompts, is base64 encoded, and so may contain any byte
24632 values when decoded. If any data is supplied with the command, it is treated as
24633 a list of strings, separated by NULs (binary zeros), the first three of which
24634 are placed in the expansion variables &$auth1$&, &$auth2$&, and &$auth3$&
24635 (neither LOGIN nor PLAIN uses more than three strings).
24636
24637 For compatibility with previous releases of Exim, the values are also placed in
24638 the expansion variables &$1$&, &$2$&, and &$3$&. However, the use of these
24639 variables for this purpose is now deprecated, as it can lead to confusion in
24640 string expansions that also use them for other things.
24641
24642 If there are more strings in &%server_prompts%& than the number of strings
24643 supplied with the AUTH command, the remaining prompts are used to obtain more
24644 data. Each response from the client may be a list of NUL-separated strings.
24645
24646 .vindex "&$authenticated_id$&"
24647 Once a sufficient number of data strings have been received,
24648 &%server_condition%& is expanded. If the expansion is forced to fail,
24649 authentication fails. Any other expansion failure causes a temporary error code
24650 to be returned. If the result of a successful expansion is an empty string,
24651 &"0"&, &"no"&, or &"false"&, authentication fails. If the result of the
24652 expansion is &"1"&, &"yes"&, or &"true"&, authentication succeeds and the
24653 generic &%server_set_id%& option is expanded and saved in &$authenticated_id$&.
24654 For any other result, a temporary error code is returned, with the expanded
24655 string as the error text
24656
24657 &*Warning*&: If you use a lookup in the expansion to find the user's
24658 password, be sure to make the authentication fail if the user is unknown.
24659 There are good and bad examples at the end of the next section.
24660
24661
24662
24663 .section "The PLAIN authentication mechanism" "SECID172"
24664 .cindex "PLAIN authentication mechanism"
24665 .cindex "authentication" "PLAIN mechanism"
24666 .cindex "binary zero" "in &(plaintext)& authenticator"
24667 The PLAIN authentication mechanism (RFC 2595) specifies that three strings be
24668 sent as one item of data (that is, one combined string containing two NUL
24669 separators). The data is sent either as part of the AUTH command, or
24670 subsequently in response to an empty prompt from the server.
24671
24672 The second and third strings are a user name and a corresponding password.
24673 Using a single fixed user name and password as an example, this could be
24674 configured as follows:
24675 .code
24676 fixed_plain:
24677   driver = plaintext
24678   public_name = PLAIN
24679   server_prompts = :
24680   server_condition = \
24681     ${if and {{eq{$auth2}{username}}{eq{$auth3}{mysecret}}}}
24682   server_set_id = $auth2
24683 .endd
24684 Note that the default result strings from &%if%& (&"true"& or an empty string)
24685 are exactly what we want here, so they need not be specified. Obviously, if the
24686 password contains expansion-significant characters such as dollar, backslash,
24687 or closing brace, they have to be escaped.
24688
24689 The &%server_prompts%& setting specifies a single, empty prompt (empty items at
24690 the end of a string list are ignored). If all the data comes as part of the
24691 AUTH command, as is commonly the case, the prompt is not used. This
24692 authenticator is advertised in the response to EHLO as
24693 .code
24694 250-AUTH PLAIN
24695 .endd
24696 and a client host can authenticate itself by sending the command
24697 .code
24698 AUTH PLAIN AHVzZXJuYW1lAG15c2VjcmV0
24699 .endd
24700 As this contains three strings (more than the number of prompts), no further
24701 data is required from the client. Alternatively, the client may just send
24702 .code
24703 AUTH PLAIN
24704 .endd
24705 to initiate authentication, in which case the server replies with an empty
24706 prompt. The client must respond with the combined data string.
24707
24708 The data string is base64 encoded, as required by the RFC. This example,
24709 when decoded, is <&'NUL'&>&`username`&<&'NUL'&>&`mysecret`&, where <&'NUL'&>
24710 represents a zero byte. This is split up into three strings, the first of which
24711 is empty. The &%server_condition%& option in the authenticator checks that the
24712 second two are &`username`& and &`mysecret`& respectively.
24713
24714 Having just one fixed user name and password, as in this example, is not very
24715 realistic, though for a small organization with only a handful of
24716 authenticating clients it could make sense.
24717
24718 A more sophisticated instance of this authenticator could use the user name in
24719 &$auth2$& to look up a password in a file or database, and maybe do an encrypted
24720 comparison (see &%crypteq%& in chapter &<<CHAPexpand>>&). Here is a example of
24721 this approach, where the passwords are looked up in a DBM file. &*Warning*&:
24722 This is an incorrect example:
24723 .code
24724 server_condition = \
24725   ${if eq{$auth3}{${lookup{$auth2}dbm{/etc/authpwd}}}}
24726 .endd
24727 The expansion uses the user name (&$auth2$&) as the key to look up a password,
24728 which it then compares to the supplied password (&$auth3$&). Why is this example
24729 incorrect? It works fine for existing users, but consider what happens if a
24730 non-existent user name is given. The lookup fails, but as no success/failure
24731 strings are given for the lookup, it yields an empty string. Thus, to defeat
24732 the authentication, all a client has to do is to supply a non-existent user
24733 name and an empty password. The correct way of writing this test is:
24734 .code
24735 server_condition = ${lookup{$auth2}dbm{/etc/authpwd}\
24736   {${if eq{$value}{$auth3}}} {false}}
24737 .endd
24738 In this case, if the lookup succeeds, the result is checked; if the lookup
24739 fails, &"false"& is returned and authentication fails. If &%crypteq%& is being
24740 used instead of &%eq%&, the first example is in fact safe, because &%crypteq%&
24741 always fails if its second argument is empty. However, the second way of
24742 writing the test makes the logic clearer.
24743
24744
24745 .section "The LOGIN authentication mechanism" "SECID173"
24746 .cindex "LOGIN authentication mechanism"
24747 .cindex "authentication" "LOGIN mechanism"
24748 The LOGIN authentication mechanism is not documented in any RFC, but is in use
24749 in a number of programs. No data is sent with the AUTH command. Instead, a
24750 user name and password are supplied separately, in response to prompts. The
24751 plaintext authenticator can be configured to support this as in this example:
24752 .code
24753 fixed_login:
24754   driver = plaintext
24755   public_name = LOGIN
24756   server_prompts = User Name : Password
24757   server_condition = \
24758     ${if and {{eq{$auth1}{username}}{eq{$auth2}{mysecret}}}}
24759   server_set_id = $auth1
24760 .endd
24761 Because of the way plaintext operates, this authenticator accepts data supplied
24762 with the AUTH command (in contravention of the specification of LOGIN), but
24763 if the client does not supply it (as is the case for LOGIN clients), the prompt
24764 strings are used to obtain two data items.
24765
24766 Some clients are very particular about the precise text of the prompts. For
24767 example, Outlook Express is reported to recognize only &"Username:"& and
24768 &"Password:"&. Here is an example of a LOGIN authenticator that uses those
24769 strings. It uses the &%ldapauth%& expansion condition to check the user
24770 name and password by binding to an LDAP server:
24771 .code
24772 login:
24773   driver = plaintext
24774   public_name = LOGIN
24775   server_prompts = Username:: : Password::
24776   server_condition = ${if and{{ \
24777     !eq{}{$auth1} }{ \
24778     ldapauth{\
24779       user="uid=${quote_ldap_dn:$auth1},ou=people,o=example.org" \
24780       pass=${quote:$auth2} \
24781       ldap://ldap.example.org/} }} }
24782   server_set_id = uid=$auth1,ou=people,o=example.org
24783 .endd
24784 We have to check that the username is not empty before using it, because LDAP
24785 does not permit empty DN components. We must also use the &%quote_ldap_dn%&
24786 operator to correctly quote the DN for authentication. However, the basic
24787 &%quote%& operator, rather than any of the LDAP quoting operators, is the
24788 correct one to use for the password, because quoting is needed only to make
24789 the password conform to the Exim syntax. At the LDAP level, the password is an
24790 uninterpreted string.
24791
24792
24793 .section "Support for different kinds of authentication" "SECID174"
24794 A number of string expansion features are provided for the purpose of
24795 interfacing to different ways of user authentication. These include checking
24796 traditionally encrypted passwords from &_/etc/passwd_& (or equivalent), PAM,
24797 Radius, &%ldapauth%&, &'pwcheck'&, and &'saslauthd'&. For details see section
24798 &<<SECTexpcond>>&.
24799
24800
24801
24802
24803 .section "Using plaintext in a client" "SECID175"
24804 .cindex "options" "&(plaintext)& authenticator (client)"
24805 The &(plaintext)& authenticator has two client options:
24806
24807 .option client_ignore_invalid_base64 plaintext boolean false
24808 If the client receives a server prompt that is not a valid base64 string,
24809 authentication is abandoned by default. However, if this option is set true,
24810 the error in the challenge is ignored and the client sends the response as
24811 usual.
24812
24813 .option client_send plaintext string&!! unset
24814 The string is a colon-separated list of authentication data strings. Each
24815 string is independently expanded before being sent to the server. The first
24816 string is sent with the AUTH command; any more strings are sent in response
24817 to prompts from the server. Before each string is expanded, the value of the
24818 most recent prompt is placed in the next &$auth$&<&'n'&> variable, starting
24819 with &$auth1$& for the first prompt. Up to three prompts are stored in this
24820 way. Thus, the prompt that is received in response to sending the first string
24821 (with the AUTH command) can be used in the expansion of the second string, and
24822 so on. If an invalid base64 string is received when
24823 &%client_ignore_invalid_base64%& is set, an empty string is put in the
24824 &$auth$&<&'n'&> variable.
24825
24826 &*Note*&: You cannot use expansion to create multiple strings, because
24827 splitting takes priority and happens first.
24828
24829 Because the PLAIN authentication mechanism requires NUL (binary zero) bytes in
24830 the data, further processing is applied to each string before it is sent. If
24831 there are any single circumflex characters in the string, they are converted to
24832 NULs. Should an actual circumflex be required as data, it must be doubled in
24833 the string.
24834
24835 This is an example of a client configuration that implements the PLAIN
24836 authentication mechanism with a fixed user name and password:
24837 .code
24838 fixed_plain:
24839   driver = plaintext
24840   public_name = PLAIN
24841   client_send = ^username^mysecret
24842 .endd
24843 The lack of colons means that the entire text is sent with the AUTH
24844 command, with the circumflex characters converted to NULs. A similar example
24845 that uses the LOGIN mechanism is:
24846 .code
24847 fixed_login:
24848   driver = plaintext
24849   public_name = LOGIN
24850   client_send = : username : mysecret
24851 .endd
24852 The initial colon means that the first string is empty, so no data is sent with
24853 the AUTH command itself. The remaining strings are sent in response to
24854 prompts.
24855 .ecindex IIDplaiauth1
24856 .ecindex IIDplaiauth2
24857
24858
24859
24860
24861 . ////////////////////////////////////////////////////////////////////////////
24862 . ////////////////////////////////////////////////////////////////////////////
24863
24864 .chapter "The cram_md5 authenticator" "CHID9"
24865 .scindex IIDcramauth1 "&(cram_md5)& authenticator"
24866 .scindex IIDcramauth2 "authenticators" "&(cram_md5)&"
24867 .cindex "CRAM-MD5 authentication mechanism"
24868 .cindex "authentication" "CRAM-MD5 mechanism"
24869 The CRAM-MD5 authentication mechanism is described in RFC 2195. The server
24870 sends a challenge string to the client, and the response consists of a user
24871 name and the CRAM-MD5 digest of the challenge string combined with a secret
24872 string (password) which is known to both server and client. Thus, the secret
24873 is not sent over the network as plain text, which makes this authenticator more
24874 secure than &(plaintext)&. However, the downside is that the secret has to be
24875 available in plain text at either end.
24876
24877
24878 .section "Using cram_md5 as a server" "SECID176"
24879 .cindex "options" "&(cram_md5)& authenticator (server)"
24880 This authenticator has one server option, which must be set to configure the
24881 authenticator as a server:
24882
24883 .option server_secret cram_md5 string&!! unset
24884 .cindex "numerical variables (&$1$& &$2$& etc)" "in &(cram_md5)& authenticator"
24885 When the server receives the client's response, the user name is placed in
24886 the expansion variable &$auth1$&, and &%server_secret%& is expanded to
24887 obtain the password for that user. The server then computes the CRAM-MD5 digest
24888 that the client should have sent, and checks that it received the correct
24889 string. If the expansion of &%server_secret%& is forced to fail, authentication
24890 fails. If the expansion fails for some other reason, a temporary error code is
24891 returned to the client.
24892
24893 For compatibility with previous releases of Exim, the user name is also placed
24894 in &$1$&. However, the use of this variables for this purpose is now
24895 deprecated, as it can lead to confusion in string expansions that also use
24896 numeric variables for other things.
24897
24898 For example, the following authenticator checks that the user name given by the
24899 client is &"ph10"&, and if so, uses &"secret"& as the password. For any other
24900 user name, authentication fails.
24901 .code
24902 fixed_cram:
24903   driver = cram_md5
24904   public_name = CRAM-MD5
24905   server_secret = ${if eq{$auth1}{ph10}{secret}fail}
24906   server_set_id = $auth1
24907 .endd
24908 .vindex "&$authenticated_id$&"
24909 If authentication succeeds, the setting of &%server_set_id%& preserves the user
24910 name in &$authenticated_id$&. A more typical configuration might look up the
24911 secret string in a file, using the user name as the key. For example:
24912 .code
24913 lookup_cram:
24914   driver = cram_md5
24915   public_name = CRAM-MD5
24916   server_secret = ${lookup{$auth1}lsearch{/etc/authpwd}\
24917                   {$value}fail}
24918   server_set_id = $auth1
24919 .endd
24920 Note that this expansion explicitly forces failure if the lookup fails
24921 because &$auth1$& contains an unknown user name.
24922
24923 As another example, if you wish to re-use a Cyrus SASL sasldb2 file without
24924 using the relevant libraries, you need to know the realm to specify in the
24925 lookup and then ask for the &"userPassword"& attribute for that user in that
24926 realm, with:
24927 .code
24928 cyrusless_crammd5:
24929   driver = cram_md5
24930   public_name = CRAM-MD5
24931   server_secret = ${lookup{$auth1:mail.example.org:userPassword}\
24932                   dbmjz{/etc/sasldb2}}
24933   server_set_id = $auth1
24934 .endd
24935
24936 .section "Using cram_md5 as a client" "SECID177"
24937 .cindex "options" "&(cram_md5)& authenticator (client)"
24938 When used as a client, the &(cram_md5)& authenticator has two options:
24939
24940
24941
24942 .option client_name cram_md5 string&!! "the primary host name"
24943 This string is expanded, and the result used as the user name data when
24944 computing the response to the server's challenge.
24945
24946
24947 .option client_secret cram_md5 string&!! unset
24948 This option must be set for the authenticator to work as a client. Its value is
24949 expanded and the result used as the secret string when computing the response.
24950
24951
24952 .vindex "&$host$&"
24953 .vindex "&$host_address$&"
24954 Different user names and secrets can be used for different servers by referring
24955 to &$host$& or &$host_address$& in the options. Forced failure of either
24956 expansion string is treated as an indication that this authenticator is not
24957 prepared to handle this case. Exim moves on to the next configured client
24958 authenticator. Any other expansion failure causes Exim to give up trying to
24959 send the message to the current server.
24960
24961 A simple example configuration of a &(cram_md5)& authenticator, using fixed
24962 strings, is:
24963 .code
24964 fixed_cram:
24965   driver = cram_md5
24966   public_name = CRAM-MD5
24967   client_name = ph10
24968   client_secret = secret
24969 .endd
24970 .ecindex IIDcramauth1
24971 .ecindex IIDcramauth2
24972
24973
24974
24975 . ////////////////////////////////////////////////////////////////////////////
24976 . ////////////////////////////////////////////////////////////////////////////
24977
24978 .chapter "The cyrus_sasl authenticator" "CHID10"
24979 .scindex IIDcyrauth1 "&(cyrus_sasl)& authenticator"
24980 .scindex IIDcyrauth2 "authenticators" "&(cyrus_sasl)&"
24981 .cindex "Cyrus" "SASL library"
24982 .cindex "Kerberos"
24983 The code for this authenticator was provided by Matthew Byng-Maddick of A L
24984 Digital Ltd (&url(http://www.aldigital.co.uk)).
24985
24986 The &(cyrus_sasl)& authenticator provides server support for the Cyrus SASL
24987 library implementation of the RFC 2222 (&"Simple Authentication and Security
24988 Layer"&). This library supports a number of authentication mechanisms,
24989 including PLAIN and LOGIN, but also several others that Exim does not support
24990 directly. In particular, there is support for Kerberos authentication.
24991
24992 The &(cyrus_sasl)& authenticator provides a gatewaying mechanism directly to
24993 the Cyrus interface, so if your Cyrus library can do, for example, CRAM-MD5,
24994 then so can the &(cyrus_sasl)& authenticator. By default it uses the public
24995 name of the driver to determine which mechanism to support.
24996
24997 Where access to some kind of secret file is required, for example in GSSAPI
24998 or CRAM-MD5, it is worth noting that the authenticator runs as the Exim
24999 user, and that the Cyrus SASL library has no way of escalating privileges
25000 by default. You may also find you need to set environment variables,
25001 depending on the driver you are using.
25002
25003 The application name provided by Exim is &"exim"&, so various SASL options may
25004 be set in &_exim.conf_& in your SASL directory. If you are using GSSAPI for
25005 Kerberos, note that because of limitations in the GSSAPI interface,
25006 changing the server keytab might need to be communicated down to the Kerberos
25007 layer independently. The mechanism for doing so is dependent upon the Kerberos
25008 implementation.
25009
25010 For example, for older releases of Heimdal, the environment variable KRB5_KTNAME
25011 may be set to point to an alternative keytab file. Exim will pass this
25012 variable through from its own inherited environment when started as root or the
25013 Exim user. The keytab file needs to be readable by the Exim user.
25014 With newer releases of Heimdal, a setuid Exim may cause Heimdal to discard the
25015 environment variable.  In practice, for those releases, the Cyrus authenticator
25016 is not a suitable interface for GSSAPI (Kerberos) support.  Instead, consider
25017 the &(heimdal_gssapi)& authenticator, described in chapter &<<CHAPheimdalgss>>&
25018
25019
25020 .section "Using cyrus_sasl as a server" "SECID178"
25021 The &(cyrus_sasl)& authenticator has four private options. It puts the username
25022 (on a successful authentication) into &$auth1$&. For compatibility with
25023 previous releases of Exim, the username is also placed in &$1$&. However, the
25024 use of this variable for this purpose is now deprecated, as it can lead to
25025 confusion in string expansions that also use numeric variables for other
25026 things.
25027
25028
25029 .option server_hostname cyrus_sasl string&!! "see below"
25030 This option selects the hostname that is used when communicating with the
25031 library. The default value is &`$primary_hostname`&. It is up to the underlying
25032 SASL plug-in what it does with this data.
25033
25034
25035 .option server_mech cyrus_sasl string "see below"
25036 This option selects the authentication mechanism this driver should use. The
25037 default is the value of the generic &%public_name%& option. This option allows
25038 you to use a different underlying mechanism from the advertised name. For
25039 example:
25040 .code
25041 sasl:
25042   driver = cyrus_sasl
25043   public_name = X-ANYTHING
25044   server_mech = CRAM-MD5
25045   server_set_id = $auth1
25046 .endd
25047
25048 .option server_realm cyrus_sasl string&!! unset
25049 This specifies the SASL realm that the server claims to be in.
25050
25051
25052 .option server_service cyrus_sasl string &`smtp`&
25053 This is the SASL service that the server claims to implement.
25054
25055
25056 For straightforward cases, you do not need to set any of the authenticator's
25057 private options. All you need to do is to specify an appropriate mechanism as
25058 the public name. Thus, if you have a SASL library that supports CRAM-MD5 and
25059 PLAIN, you could have two authenticators as follows:
25060 .code
25061 sasl_cram_md5:
25062   driver = cyrus_sasl
25063   public_name = CRAM-MD5
25064   server_set_id = $auth1
25065
25066 sasl_plain:
25067   driver = cyrus_sasl
25068   public_name = PLAIN
25069   server_set_id = $auth2
25070 .endd
25071 Cyrus SASL does implement the LOGIN authentication method, even though it is
25072 not a standard method. It is disabled by default in the source distribution,
25073 but it is present in many binary distributions.
25074 .ecindex IIDcyrauth1
25075 .ecindex IIDcyrauth2
25076
25077
25078
25079
25080 . ////////////////////////////////////////////////////////////////////////////
25081 . ////////////////////////////////////////////////////////////////////////////
25082 .chapter "The dovecot authenticator" "CHAPdovecot"
25083 .scindex IIDdcotauth1 "&(dovecot)& authenticator"
25084 .scindex IIDdcotauth2 "authenticators" "&(dovecot)&"
25085 This authenticator is an interface to the authentication facility of the
25086 Dovecot POP/IMAP server, which can support a number of authentication methods.
25087 If you are using Dovecot to authenticate POP/IMAP clients, it might be helpful
25088 to use the same mechanisms for SMTP authentication. This is a server
25089 authenticator only. There is only one option:
25090
25091 .option server_socket dovecot string unset
25092
25093 This option must specify the socket that is the interface to Dovecot
25094 authentication. The &%public_name%& option must specify an authentication
25095 mechanism that Dovecot is configured to support. You can have several
25096 authenticators for different mechanisms. For example:
25097 .code
25098 dovecot_plain:
25099   driver = dovecot
25100   public_name = PLAIN
25101   server_socket = /var/run/dovecot/auth-client
25102   server_set_id = $auth2
25103
25104 dovecot_ntlm:
25105   driver = dovecot
25106   public_name = NTLM
25107   server_socket = /var/run/dovecot/auth-client
25108   server_set_id = $auth1
25109 .endd
25110 If the SMTP connection is encrypted, or if &$sender_host_address$& is equal to
25111 &$received_ip_address$& (that is, the connection is local), the &"secured"&
25112 option is passed in the Dovecot authentication command. If, for a TLS
25113 connection, a client certificate has been verified, the &"valid-client-cert"&
25114 option is passed. When authentication succeeds, the identity of the user
25115 who authenticated is placed in &$auth1$&.
25116 .ecindex IIDdcotauth1
25117 .ecindex IIDdcotauth2
25118
25119
25120 . ////////////////////////////////////////////////////////////////////////////
25121 . ////////////////////////////////////////////////////////////////////////////
25122 .chapter "The gsasl authenticator" "CHAPgsasl"
25123 .scindex IIDgsaslauth1 "&(gsasl)& authenticator"
25124 .scindex IIDgsaslauth2 "authenticators" "&(gsasl)&"
25125 .cindex "authentication" "GNU SASL"
25126 .cindex "authentication" "SASL"
25127 .cindex "authentication" "EXTERNAL"
25128 .cindex "authentication" "ANONYMOUS"
25129 .cindex "authentication" "PLAIN"
25130 .cindex "authentication" "LOGIN"
25131 .cindex "authentication" "DIGEST-MD5"
25132 .cindex "authentication" "CRAM-MD5"
25133 .cindex "authentication" "SCRAM-SHA-1"
25134 The &(gsasl)& authenticator provides server integration for the GNU SASL
25135 library and the mechanisms it provides.  This is new as of the 4.80 release
25136 and there are a few areas where the library does not let Exim smoothly
25137 scale to handle future authentication mechanisms, so no guarantee can be
25138 made that any particular new authentication mechanism will be supported
25139 without code changes in Exim.
25140
25141
25142 .option server_channelbinding gsasl boolean false
25143 Some authentication mechanisms are able to use external context at both ends
25144 of the session to bind the authentication to that context, and fail the
25145 authentication process if that context differs.  Specifically, some TLS
25146 ciphersuites can provide identifying information about the cryptographic
25147 context.
25148
25149 This means that certificate identity and verification becomes a non-issue,
25150 as a man-in-the-middle attack will cause the correct client and server to
25151 see different identifiers and authentication will fail.
25152
25153 This is currently only supported when using the GnuTLS library.  This is
25154 only usable by mechanisms which support "channel binding"; at time of
25155 writing, that's the SCRAM family.
25156
25157 This defaults off to ensure smooth upgrade across Exim releases, in case
25158 this option causes some clients to start failing.  Some future release
25159 of Exim may switch the default to be true.
25160
25161
25162 .option server_hostname gsasl string&!! "see below"
25163 This option selects the hostname that is used when communicating with the
25164 library. The default value is &`$primary_hostname`&.
25165 Some mechanisms will use this data.
25166
25167
25168 .option server_mech gsasl string "see below"
25169 This option selects the authentication mechanism this driver should use. The
25170 default is the value of the generic &%public_name%& option. This option allows
25171 you to use a different underlying mechanism from the advertised name. For
25172 example:
25173 .code
25174 sasl:
25175   driver = gsasl
25176   public_name = X-ANYTHING
25177   server_mech = CRAM-MD5
25178   server_set_id = $auth1
25179 .endd
25180
25181
25182 .option server_password gsasl string&!! unset
25183 Various mechanisms need access to the cleartext password on the server, so
25184 that proof-of-possession can be demonstrated on the wire, without sending
25185 the password itself.
25186
25187 The data available for lookup varies per mechanism.
25188 In all cases, &$auth1$& is set to the &'authentication id'&.
25189 The &$auth2$& variable will always be the &'authorization id'& (&'authz'&)
25190 if available, else the empty string.
25191 The &$auth3$& variable will always be the &'realm'& if available,
25192 else the empty string.
25193
25194 A forced failure will cause authentication to defer.
25195
25196 If using this option, it may make sense to set the &%server_condition%&
25197 option to be simply "true".
25198
25199
25200 .option server_realm gsasl string&!! unset
25201 This specifies the SASL realm that the server claims to be in.
25202 Some mechanisms will use this data.
25203
25204
25205 .option server_scram_iter gsasl string&!! unset
25206 This option provides data for the SCRAM family of mechanisms.
25207 &$auth1$& is not available at evaluation time.
25208 (This may change, as we receive feedback on use)
25209
25210
25211 .option server_scram_salt gsasl string&!! unset
25212 This option provides data for the SCRAM family of mechanisms.
25213 &$auth1$& is not available at evaluation time.
25214 (This may change, as we receive feedback on use)
25215
25216
25217 .option server_service gsasl string &`smtp`&
25218 This is the SASL service that the server claims to implement.
25219 Some mechanisms will use this data.
25220
25221
25222 .section "&(gsasl)& auth variables" "SECTgsaslauthvar"
25223 .vindex "&$auth1$&, &$auth2$&, etc"
25224 These may be set when evaluating specific options, as detailed above.
25225 They will also be set when evaluating &%server_condition%&.
25226
25227 Unless otherwise stated below, the &(gsasl)& integration will use the following
25228 meanings for these variables:
25229
25230 .ilist
25231 .vindex "&$auth1$&"
25232 &$auth1$&: the &'authentication id'&
25233 .next
25234 .vindex "&$auth2$&"
25235 &$auth2$&: the &'authorization id'&
25236 .next
25237 .vindex "&$auth3$&"
25238 &$auth3$&: the &'realm'&
25239 .endlist
25240
25241 On a per-mechanism basis:
25242
25243 .ilist
25244 .cindex "authentication" "EXTERNAL"
25245 EXTERNAL: only &$auth1$& is set, to the possibly empty &'authorization id'&;
25246 the &%server_condition%& option must be present.
25247 .next
25248 .cindex "authentication" "ANONYMOUS"
25249 ANONYMOUS: only &$auth1$& is set, to the possibly empty &'anonymous token'&;
25250 the &%server_condition%& option must be present.
25251 .next
25252 .cindex "authentication" "GSSAPI"
25253 GSSAPI: &$auth1$& will be set to the &'GSSAPI Display Name'&;
25254 &$auth2$& will be set to the &'authorization id'&,
25255 the &%server_condition%& option must be present.
25256 .endlist
25257
25258 An &'anonymous token'& is something passed along as an unauthenticated
25259 identifier; this is analogous to FTP anonymous authentication passing an
25260 email address, or software-identifier@, as the "password".
25261
25262
25263 An example showing the password having the realm specified in the callback
25264 and demonstrating a Cyrus SASL to GSASL migration approach is:
25265 .code
25266 gsasl_cyrusless_crammd5:
25267   driver = gsasl
25268   public_name = CRAM-MD5
25269   server_realm = imap.example.org
25270   server_password = ${lookup{$auth1:$auth3:userPassword}\
25271                     dbmjz{/etc/sasldb2}{$value}fail}
25272   server_set_id = ${quote:$auth1}
25273   server_condition = yes
25274 .endd
25275
25276
25277 . ////////////////////////////////////////////////////////////////////////////
25278 . ////////////////////////////////////////////////////////////////////////////
25279
25280 .chapter "The heimdal_gssapi authenticator" "CHAPheimdalgss"
25281 .scindex IIDheimdalgssauth1 "&(heimdal_gssapi)& authenticator"
25282 .scindex IIDheimdalgssauth2 "authenticators" "&(heimdal_gssapi)&"
25283 .cindex "authentication" "GSSAPI"
25284 .cindex "authentication" "Kerberos"
25285 The &(heimdal_gssapi)& authenticator provides server integration for the
25286 Heimdal GSSAPI/Kerberos library, permitting Exim to set a keytab pathname
25287 reliably.
25288
25289 .option server_hostname heimdal_gssapi string&!! "see below"
25290 This option selects the hostname that is used, with &%server_service%&,
25291 for constructing the GSS server name, as a &'GSS_C_NT_HOSTBASED_SERVICE'&
25292 identifier.  The default value is &`$primary_hostname`&.
25293
25294 .option server_keytab heimdal_gssapi string&!! unset
25295 If set, then Heimdal will not use the system default keytab (typically
25296 &_/etc/krb5.keytab_&) but instead the pathname given in this option.
25297 The value should be a pathname, with no &"file:"& prefix.
25298
25299 .option server_service heimdal_gssapi string&!! "smtp"
25300 This option specifies the service identifier used, in conjunction with
25301 &%server_hostname%&, for building the identifer for finding credentials
25302 from the keytab.
25303
25304
25305 .section "&(heimdal_gssapi)& auth variables" "SECTheimdalgssauthvar"
25306 Beware that these variables will typically include a realm, thus will appear
25307 to be roughly like an email address already.  The &'authzid'& in &$auth2$& is
25308 not verified, so a malicious client can set it to anything.
25309
25310 The &$auth1$& field should be safely trustable as a value from the Key
25311 Distribution Center.  Note that these are not quite email addresses.
25312 Each identifier is for a role, and so the left-hand-side may include a
25313 role suffix.  For instance, &"joe/admin@EXAMPLE.ORG"&.
25314
25315 .vindex "&$auth1$&, &$auth2$&, etc"
25316 .ilist
25317 .vindex "&$auth1$&"
25318 &$auth1$&: the &'authentication id'&, set to the GSS Display Name.
25319 .next
25320 .vindex "&$auth2$&"
25321 &$auth2$&: the &'authorization id'&, sent within SASL encapsulation after
25322 authentication.  If that was empty, this will also be set to the
25323 GSS Display Name.
25324 .endlist
25325
25326
25327 . ////////////////////////////////////////////////////////////////////////////
25328 . ////////////////////////////////////////////////////////////////////////////
25329
25330 .chapter "The spa authenticator" "CHAPspa"
25331 .scindex IIDspaauth1 "&(spa)& authenticator"
25332 .scindex IIDspaauth2 "authenticators" "&(spa)&"
25333 .cindex "authentication" "Microsoft Secure Password"
25334 .cindex "authentication" "NTLM"
25335 .cindex "Microsoft Secure Password Authentication"
25336 .cindex "NTLM authentication"
25337 The &(spa)& authenticator provides client support for Microsoft's &'Secure
25338 Password Authentication'& mechanism,
25339 which is also sometimes known as NTLM (NT LanMan). The code for client side of
25340 this authenticator was contributed by Marc Prud'hommeaux, and much of it is
25341 taken from the Samba project (&url(http://www.samba.org)). The code for the
25342 server side was subsequently contributed by Tom Kistner. The mechanism works as
25343 follows:
25344
25345 .ilist
25346 After the AUTH command has been accepted, the client sends an SPA
25347 authentication request based on the user name and optional domain.
25348 .next
25349 The server sends back a challenge.
25350 .next
25351 The client builds a challenge response which makes use of the user's password
25352 and sends it to the server, which then accepts or rejects it.
25353 .endlist
25354
25355 Encryption is used to protect the password in transit.
25356
25357
25358
25359 .section "Using spa as a server" "SECID179"
25360 .cindex "options" "&(spa)& authenticator (server)"
25361 The &(spa)& authenticator has just one server option:
25362
25363 .option server_password spa string&!! unset
25364 .cindex "numerical variables (&$1$& &$2$& etc)" "in &(spa)& authenticator"
25365 This option is expanded, and the result must be the cleartext password for the
25366 authenticating user, whose name is at this point in &$auth1$&. For
25367 compatibility with previous releases of Exim, the user name is also placed in
25368 &$1$&. However, the use of this variable for this purpose is now deprecated, as
25369 it can lead to confusion in string expansions that also use numeric variables
25370 for other things. For example:
25371 .code
25372 spa:
25373   driver = spa
25374   public_name = NTLM
25375   server_password = \
25376     ${lookup{$auth1}lsearch{/etc/exim/spa_clearpass}{$value}fail}
25377 .endd
25378 If the expansion is forced to fail, authentication fails. Any other expansion
25379 failure causes a temporary error code to be returned.
25380
25381
25382
25383
25384
25385 .section "Using spa as a client" "SECID180"
25386 .cindex "options" "&(spa)& authenticator (client)"
25387 The &(spa)& authenticator has the following client options:
25388
25389
25390
25391 .option client_domain spa string&!! unset
25392 This option specifies an optional domain for the authentication.
25393
25394
25395 .option client_password spa string&!! unset
25396 This option specifies the user's password, and must be set.
25397
25398
25399 .option client_username spa string&!! unset
25400 This option specifies the user name, and must be set. Here is an example of a
25401 configuration of this authenticator for use with the mail servers at
25402 &'msn.com'&:
25403 .code
25404 msn:
25405   driver = spa
25406   public_name = MSN
25407   client_username = msn/msn_username
25408   client_password = msn_plaintext_password
25409   client_domain = DOMAIN_OR_UNSET
25410 .endd
25411 .ecindex IIDspaauth1
25412 .ecindex IIDspaauth2
25413
25414
25415
25416
25417
25418 . ////////////////////////////////////////////////////////////////////////////
25419 . ////////////////////////////////////////////////////////////////////////////
25420
25421 .chapter "Encrypted SMTP connections using TLS/SSL" "CHAPTLS" &&&
25422          "Encrypted SMTP connections"
25423 .scindex IIDencsmtp1 "encryption" "on SMTP connection"
25424 .scindex IIDencsmtp2 "SMTP" "encryption"
25425 .cindex "TLS" "on SMTP connection"
25426 .cindex "OpenSSL"
25427 .cindex "GnuTLS"
25428 Support for TLS (Transport Layer Security), formerly known as SSL (Secure
25429 Sockets Layer), is implemented by making use of the OpenSSL library or the
25430 GnuTLS library (Exim requires GnuTLS release 1.0 or later). There is no
25431 cryptographic code in the Exim distribution itself for implementing TLS. In
25432 order to use this feature you must install OpenSSL or GnuTLS, and then build a
25433 version of Exim that includes TLS support (see section &<<SECTinctlsssl>>&).
25434 You also need to understand the basic concepts of encryption at a managerial
25435 level, and in particular, the way that public keys, private keys, and
25436 certificates are used.
25437
25438 RFC 3207 defines how SMTP connections can make use of encryption. Once a
25439 connection is established, the client issues a STARTTLS command. If the
25440 server accepts this, the client and the server negotiate an encryption
25441 mechanism. If the negotiation succeeds, the data that subsequently passes
25442 between them is encrypted.
25443
25444 Exim's ACLs can detect whether the current SMTP session is encrypted or not,
25445 and if so, what cipher suite is in use, whether the client supplied a
25446 certificate, and whether or not that certificate was verified. This makes it
25447 possible for an Exim server to deny or accept certain commands based on the
25448 encryption state.
25449
25450 &*Warning*&: Certain types of firewall and certain anti-virus products can
25451 disrupt TLS connections. You need to turn off SMTP scanning for these products
25452 in order to get TLS to work.
25453
25454
25455
25456 .section "Support for the legacy &""ssmtp""& (aka &""smtps""&) protocol" &&&
25457          "SECID284"
25458 .cindex "ssmtp protocol"
25459 .cindex "smtps protocol"
25460 .cindex "SMTP" "ssmtp protocol"
25461 .cindex "SMTP" "smtps protocol"
25462 Early implementations of encrypted SMTP used a different TCP port from normal
25463 SMTP, and expected an encryption negotiation to start immediately, instead of
25464 waiting for a STARTTLS command from the client using the standard SMTP
25465 port. The protocol was called &"ssmtp"& or &"smtps"&, and port 465 was
25466 allocated for this purpose.
25467
25468 This approach was abandoned when encrypted SMTP was standardized, but there are
25469 still some legacy clients that use it. Exim supports these clients by means of
25470 the &%tls_on_connect_ports%& global option. Its value must be a list of port
25471 numbers; the most common use is expected to be:
25472 .code
25473 tls_on_connect_ports = 465
25474 .endd
25475 The port numbers specified by this option apply to all SMTP connections, both
25476 via the daemon and via &'inetd'&. You still need to specify all the ports that
25477 the daemon uses (by setting &%daemon_smtp_ports%& or &%local_interfaces%& or
25478 the &%-oX%& command line option) because &%tls_on_connect_ports%& does not add
25479 an extra port &-- rather, it specifies different behaviour on a port that is
25480 defined elsewhere.
25481
25482 There is also a &%-tls-on-connect%& command line option. This overrides
25483 &%tls_on_connect_ports%&; it forces the legacy behaviour for all ports.
25484
25485
25486
25487
25488
25489
25490 .section "OpenSSL vs GnuTLS" "SECTopenvsgnu"
25491 .cindex "TLS" "OpenSSL &'vs'& GnuTLS"
25492 The first TLS support in Exim was implemented using OpenSSL. Support for GnuTLS
25493 followed later, when the first versions of GnuTLS were released. To build Exim
25494 to use GnuTLS, you need to set
25495 .code
25496 USE_GNUTLS=yes
25497 .endd
25498 in Local/Makefile, in addition to
25499 .code
25500 SUPPORT_TLS=yes
25501 .endd
25502 You must also set TLS_LIBS and TLS_INCLUDE appropriately, so that the
25503 include files and libraries for GnuTLS can be found.
25504
25505 There are some differences in usage when using GnuTLS instead of OpenSSL:
25506
25507 .ilist
25508 The &%tls_verify_certificates%& option must contain the name of a file, not the
25509 name of a directory (for OpenSSL it can be either).
25510 .next
25511 The default value for &%tls_dhparam%& differs for historical reasons.
25512 .next
25513 .vindex "&$tls_in_peerdn$&"
25514 .vindex "&$tls_out_peerdn$&"
25515 Distinguished Name (DN) strings reported by the OpenSSL library use a slash for
25516 separating fields; GnuTLS uses commas, in accordance with RFC 2253. This
25517 affects the value of the &$tls_in_peerdn$& and &$tls_out_peerdn$& variables.
25518 .next
25519 OpenSSL identifies cipher suites using hyphens as separators, for example:
25520 DES-CBC3-SHA. GnuTLS historically used underscores, for example:
25521 RSA_ARCFOUR_SHA. What is more, OpenSSL complains if underscores are present
25522 in a cipher list. To make life simpler, Exim changes underscores to hyphens
25523 for OpenSSL and passes the string unchanged to GnuTLS (expecting the library
25524 to handle its own older variants) when processing lists of cipher suites in the
25525 &%tls_require_ciphers%& options (the global option and the &(smtp)& transport
25526 option).
25527 .next
25528 The &%tls_require_ciphers%& options operate differently, as described in the
25529 sections &<<SECTreqciphssl>>& and &<<SECTreqciphgnu>>&.
25530 .next
25531 The &%tls_dh_min_bits%& SMTP transport option is only honoured by GnuTLS.
25532 When using OpenSSL, this option is ignored.
25533 (If an API is found to let OpenSSL be configured in this way,
25534 let the Exim Maintainers know and we'll likely use it).
25535 .next
25536 Some other recently added features may only be available in one or the other.
25537 This should be documented with the feature.  If the documentation does not
25538 explicitly state that the feature is infeasible in the other TLS
25539 implementation, then patches are welcome.
25540 .endlist
25541
25542
25543 .section "GnuTLS parameter computation" "SECTgnutlsparam"
25544 This section only applies if &%tls_dhparam%& is set to &`historic`& or to
25545 an explicit path; if the latter, then the text about generation still applies,
25546 but not the chosen filename.
25547 By default, as of Exim 4.80 a hard-coded D-H prime is used.
25548 See the documentation of &%tls_dhparam%& for more information.
25549
25550 GnuTLS uses D-H parameters that may take a substantial amount of time
25551 to compute. It is unreasonable to re-compute them for every TLS session.
25552 Therefore, Exim keeps this data in a file in its spool directory, called
25553 &_gnutls-params-NNNN_& for some value of NNNN, corresponding to the number
25554 of bits requested.
25555 The file is owned by the Exim user and is readable only by
25556 its owner. Every Exim process that start up GnuTLS reads the D-H
25557 parameters from this file. If the file does not exist, the first Exim process
25558 that needs it computes the data and writes it to a temporary file which is
25559 renamed once it is complete. It does not matter if several Exim processes do
25560 this simultaneously (apart from wasting a few resources). Once a file is in
25561 place, new Exim processes immediately start using it.
25562
25563 For maximum security, the parameters that are stored in this file should be
25564 recalculated periodically, the frequency depending on your paranoia level.
25565 If you are avoiding using the fixed D-H primes published in RFCs, then you
25566 are concerned about some advanced attacks and will wish to do this; if you do
25567 not regenerate then you might as well stick to the standard primes.
25568
25569 Arranging this is easy in principle; just delete the file when you want new
25570 values to be computed. However, there may be a problem. The calculation of new
25571 parameters needs random numbers, and these are obtained from &_/dev/random_&.
25572 If the system is not very active, &_/dev/random_& may delay returning data
25573 until enough randomness (entropy) is available. This may cause Exim to hang for
25574 a substantial amount of time, causing timeouts on incoming connections.
25575
25576 The solution is to generate the parameters externally to Exim. They are stored
25577 in &_gnutls-params-N_& in PEM format, which means that they can be
25578 generated externally using the &(certtool)& command that is part of GnuTLS.
25579
25580 To replace the parameters with new ones, instead of deleting the file
25581 and letting Exim re-create it, you can generate new parameters using
25582 &(certtool)& and, when this has been done, replace Exim's cache file by
25583 renaming. The relevant commands are something like this:
25584 .code
25585 # ls
25586 [ look for file; assume gnutls-params-2236 is the most recent ]
25587 # rm -f new-params
25588 # touch new-params
25589 # chown exim:exim new-params
25590 # chmod 0600 new-params
25591 # certtool --generate-dh-params --bits 2236 >>new-params
25592 # openssl dhparam -noout -text -in new-params | head
25593 [ check the first line, make sure it's not more than 2236;
25594   if it is, then go back to the start ("rm") and repeat
25595   until the size generated is at most the size requested ]
25596 # chmod 0400 new-params
25597 # mv new-params gnutls-params-2236
25598 .endd
25599 If Exim never has to generate the parameters itself, the possibility of
25600 stalling is removed.
25601
25602 The filename changed in Exim 4.80, to gain the -bits suffix.  The value which
25603 Exim will choose depends upon the version of GnuTLS in use.  For older GnuTLS,
25604 the value remains hard-coded in Exim as 1024.  As of GnuTLS 2.12.x, there is
25605 a way for Exim to ask for the "normal" number of bits for D-H public-key usage,
25606 and Exim does so.  This attempt to remove Exim from TLS policy decisions
25607 failed, as GnuTLS 2.12 returns a value higher than the current hard-coded limit
25608 of the NSS library.  Thus Exim gains the &%tls_dh_max_bits%& global option,
25609 which applies to all D-H usage, client or server.  If the value returned by
25610 GnuTLS is greater than &%tls_dh_max_bits%& then the value will be clamped down
25611 to &%tls_dh_max_bits%&.  The default value has been set at the current NSS
25612 limit, which is still much higher than Exim historically used.
25613
25614 The filename and bits used will change as the GnuTLS maintainers change the
25615 value for their parameter &`GNUTLS_SEC_PARAM_NORMAL`&, as clamped by
25616 &%tls_dh_max_bits%&.  At the time of writing (mid 2012), GnuTLS 2.12 recommends
25617 2432 bits, while NSS is limited to 2236 bits.
25618
25619 In fact, the requested value will be *lower* than &%tls_dh_max_bits%&, to
25620 increase the chance of the generated prime actually being within acceptable
25621 bounds, as GnuTLS has been observed to overshoot.  Note the check step in the
25622 procedure above.  There is no sane procedure available to Exim to double-check
25623 the size of the generated prime, so it might still be too large.
25624
25625
25626 .section "Requiring specific ciphers in OpenSSL" "SECTreqciphssl"
25627 .cindex "TLS" "requiring specific ciphers (OpenSSL)"
25628 .oindex "&%tls_require_ciphers%&" "OpenSSL"
25629 There is a function in the OpenSSL library that can be passed a list of cipher
25630 suites before the cipher negotiation takes place. This specifies which ciphers
25631 are acceptable. The list is colon separated and may contain names like
25632 DES-CBC3-SHA. Exim passes the expanded value of &%tls_require_ciphers%&
25633 directly to this function call.
25634 Many systems will install the OpenSSL manual-pages, so you may have
25635 &'ciphers(1)'& available to you.
25636 The following quotation from the OpenSSL
25637 documentation specifies what forms of item are allowed in the cipher string:
25638
25639 .ilist
25640 It can consist of a single cipher suite such as RC4-SHA.
25641 .next
25642 It can represent a list of cipher suites containing a certain algorithm,
25643 or cipher suites of a certain type. For example SHA1 represents all
25644 ciphers suites using the digest algorithm SHA1 and SSLv3 represents all
25645 SSL v3 algorithms.
25646 .next
25647 Lists of cipher suites can be combined in a single cipher string using
25648 the + character. This is used as a logical and operation. For example
25649 SHA1+DES represents all cipher suites containing the SHA1 and the DES
25650 algorithms.
25651 .endlist
25652
25653 Each cipher string can be optionally preceded by one of the characters &`!`&,
25654 &`-`& or &`+`&.
25655 .ilist
25656 If &`!`& is used, the ciphers are permanently deleted from the list. The
25657 ciphers deleted can never reappear in the list even if they are explicitly
25658 stated.
25659 .next
25660 If &`-`& is used, the ciphers are deleted from the list, but some or all
25661 of the ciphers can be added again by later options.
25662 .next
25663 If &`+`& is used, the ciphers are moved to the end of the list. This
25664 option does not add any new ciphers; it just moves matching existing ones.
25665 .endlist
25666
25667 If none of these characters is present, the string is interpreted as
25668 a list of ciphers to be appended to the current preference list. If the list
25669 includes any ciphers already present they will be ignored: that is, they will
25670 not be moved to the end of the list.
25671 .endlist
25672
25673 The OpenSSL &'ciphers(1)'& command may be used to test the results of a given
25674 string:
25675 .code
25676 # note single-quotes to get ! past any shell history expansion
25677 $ openssl ciphers 'HIGH:!MD5:!SHA1'
25678 .endd
25679
25680 This example will let the library defaults be permitted on the MX port, where
25681 there's probably no identity verification anyway, but ups the ante on the
25682 submission ports where the administrator might have some influence on the
25683 choice of clients used:
25684 .code
25685 # OpenSSL variant; see man ciphers(1)
25686 tls_require_ciphers = ${if =={$received_port}{25}\
25687                            {DEFAULT}\
25688                            {HIGH:!MD5:!SHA1}}
25689 .endd
25690
25691
25692
25693 .section "Requiring specific ciphers or other parameters in GnuTLS" &&&
25694          "SECTreqciphgnu"
25695 .cindex "GnuTLS" "specifying parameters for"
25696 .cindex "TLS" "specifying ciphers (GnuTLS)"
25697 .cindex "TLS" "specifying key exchange methods (GnuTLS)"
25698 .cindex "TLS" "specifying MAC algorithms (GnuTLS)"
25699 .cindex "TLS" "specifying protocols (GnuTLS)"
25700 .cindex "TLS" "specifying priority string (GnuTLS)"
25701 .oindex "&%tls_require_ciphers%&" "GnuTLS"
25702 The GnuTLS library allows the caller to provide a "priority string", documented
25703 as part of the &[gnutls_priority_init]& function.  This is very similar to the
25704 ciphersuite specification in OpenSSL.
25705
25706 The &%tls_require_ciphers%& option is treated as the GnuTLS priority string.
25707
25708 The &%tls_require_ciphers%& option is available both as an global option,
25709 controlling how Exim behaves as a server, and also as an option of the
25710 &(smtp)& transport, controlling how Exim behaves as a client.  In both cases
25711 the value is string expanded.  The resulting string is not an Exim list and
25712 the string is given to the GnuTLS library, so that Exim does not need to be
25713 aware of future feature enhancements of GnuTLS.
25714
25715 Documentation of the strings accepted may be found in the GnuTLS manual, under
25716 "Priority strings".  This is online as
25717 &url(http://www.gnutls.org/manual/html_node/Priority-Strings.html),
25718 but beware that this relates to GnuTLS 3, which may be newer than the version
25719 installed on your system.  If you are using GnuTLS 3,
25720 &url(http://www.gnutls.org/manual/gnutls.html#Listing-the-ciphersuites-in-a-priority-string, then the example code)
25721 on that site can be used to test a given string.
25722
25723 Prior to Exim 4.80, an older API of GnuTLS was used, and Exim supported three
25724 additional options, "&%gnutls_require_kx%&", "&%gnutls_require_mac%&" and
25725 "&%gnutls_require_protocols%&".  &%tls_require_ciphers%& was an Exim list.
25726
25727 This example will let the library defaults be permitted on the MX port, where
25728 there's probably no identity verification anyway, and lowers security further
25729 by increasing compatibility; but this ups the ante on the submission ports
25730 where the administrator might have some influence on the choice of clients
25731 used:
25732 .code
25733 # GnuTLS variant
25734 tls_require_ciphers = ${if =={$received_port}{25}\
25735                            {NORMAL:%COMPAT}\
25736                            {SECURE128}}
25737 .endd
25738
25739
25740 .section "Configuring an Exim server to use TLS" "SECID182"
25741 .cindex "TLS" "configuring an Exim server"
25742 When Exim has been built with TLS support, it advertises the availability of
25743 the STARTTLS command to client hosts that match &%tls_advertise_hosts%&,
25744 but not to any others. The default value of this option is unset, which means
25745 that STARTTLS is not advertised at all. This default is chosen because you
25746 need to set some other options in order to make TLS available, and also it is
25747 sensible for systems that want to use TLS only as a client.
25748
25749 If a client issues a STARTTLS command and there is some configuration
25750 problem in the server, the command is rejected with a 454 error. If the client
25751 persists in trying to issue SMTP commands, all except QUIT are rejected
25752 with the error
25753 .code
25754 554 Security failure
25755 .endd
25756 If a STARTTLS command is issued within an existing TLS session, it is
25757 rejected with a 554 error code.
25758
25759 To enable TLS operations on a server, you must set &%tls_advertise_hosts%& to
25760 match some hosts. You can, of course, set it to * to match all hosts.
25761 However, this is not all you need to do. TLS sessions to a server won't work
25762 without some further configuration at the server end.
25763
25764 It is rumoured that all existing clients that support TLS/SSL use RSA
25765 encryption. To make this work you need to set, in the server,
25766 .code
25767 tls_certificate = /some/file/name
25768 tls_privatekey = /some/file/name
25769 .endd
25770 These options are, in fact, expanded strings, so you can make them depend on
25771 the identity of the client that is connected if you wish. The first file
25772 contains the server's X509 certificate, and the second contains the private key
25773 that goes with it. These files need to be readable by the Exim user, and must
25774 always be given as full path names. They can be the same file if both the
25775 certificate and the key are contained within it. If &%tls_privatekey%& is not
25776 set, or if its expansion is forced to fail or results in an empty string, this
25777 is assumed to be the case. The certificate file may also contain intermediate
25778 certificates that need to be sent to the client to enable it to authenticate
25779 the server's certificate.
25780
25781 If you do not understand about certificates and keys, please try to find a
25782 source of this background information, which is not Exim-specific. (There are a
25783 few comments below in section &<<SECTcerandall>>&.)
25784
25785 &*Note*&: These options do not apply when Exim is operating as a client &--
25786 they apply only in the case of a server. If you need to use a certificate in an
25787 Exim client, you must set the options of the same names in an &(smtp)&
25788 transport.
25789
25790 With just these options, an Exim server will be able to use TLS. It does not
25791 require the client to have a certificate (but see below for how to insist on
25792 this). There is one other option that may be needed in other situations. If
25793 .code
25794 tls_dhparam = /some/file/name
25795 .endd
25796 is set, the SSL library is initialized for the use of Diffie-Hellman ciphers
25797 with the parameters contained in the file.
25798 Set this to &`none`& to disable use of DH entirely, by making no prime
25799 available:
25800 .code
25801 tls_dhparam = none
25802 .endd
25803 This may also be set to a string identifying a standard prime to be used for
25804 DH; if it is set to &`default`& or, for OpenSSL, is unset, then the prime
25805 used is &`ike23`&.  There are a few standard primes available, see the
25806 documentation for &%tls_dhparam%& for the complete list.
25807
25808 See the command
25809 .code
25810 openssl dhparam
25811 .endd
25812 for a way of generating file data.
25813
25814 The strings supplied for these three options are expanded every time a client
25815 host connects. It is therefore possible to use different certificates and keys
25816 for different hosts, if you so wish, by making use of the client's IP address
25817 in &$sender_host_address$& to control the expansion. If a string expansion is
25818 forced to fail, Exim behaves as if the option is not set.
25819
25820 .cindex "cipher" "logging"
25821 .cindex "log" "TLS cipher"
25822 .vindex "&$tls_in_cipher$&"
25823 The variable &$tls_in_cipher$& is set to the cipher suite that was negotiated for
25824 an incoming TLS connection. It is included in the &'Received:'& header of an
25825 incoming message (by default &-- you can, of course, change this), and it is
25826 also included in the log line that records a message's arrival, keyed by
25827 &"X="&, unless the &%tls_cipher%& log selector is turned off. The &%encrypted%&
25828 condition can be used to test for specific cipher suites in ACLs.
25829
25830 Once TLS has been established, the ACLs that run for subsequent SMTP commands
25831 can check the name of the cipher suite and vary their actions accordingly. The
25832 cipher suite names vary, depending on which TLS library is being used. For
25833 example, OpenSSL uses the name DES-CBC3-SHA for the cipher suite which in other
25834 contexts is known as TLS_RSA_WITH_3DES_EDE_CBC_SHA. Check the OpenSSL or GnuTLS
25835 documentation for more details.
25836
25837 For outgoing SMTP deliveries, &$tls_out_cipher$& is used and logged
25838 (again depending on the &%tls_cipher%& log selector).
25839
25840
25841 .section "Requesting and verifying client certificates" "SECID183"
25842 .cindex "certificate" "verification of client"
25843 .cindex "TLS" "client certificate verification"
25844 If you want an Exim server to request a certificate when negotiating a TLS
25845 session with a client, you must set either &%tls_verify_hosts%& or
25846 &%tls_try_verify_hosts%&. You can, of course, set either of them to * to
25847 apply to all TLS connections. For any host that matches one of these options,
25848 Exim requests a certificate as part of the setup of the TLS session. The
25849 contents of the certificate are verified by comparing it with a list of
25850 expected certificates. These must be available in a file or,
25851 for OpenSSL only (not GnuTLS), a directory, identified by
25852 &%tls_verify_certificates%&.
25853
25854 A file can contain multiple certificates, concatenated end to end. If a
25855 directory is used
25856 (OpenSSL only),
25857 each certificate must be in a separate file, with a name (or a symbolic link)
25858 of the form <&'hash'&>.0, where <&'hash'&> is a hash value constructed from the
25859 certificate. You can compute the relevant hash by running the command
25860 .code
25861 openssl x509 -hash -noout -in /cert/file
25862 .endd
25863 where &_/cert/file_& contains a single certificate.
25864
25865 The difference between &%tls_verify_hosts%& and &%tls_try_verify_hosts%& is
25866 what happens if the client does not supply a certificate, or if the certificate
25867 does not match any of the certificates in the collection named by
25868 &%tls_verify_certificates%&. If the client matches &%tls_verify_hosts%&, the
25869 attempt to set up a TLS session is aborted, and the incoming connection is
25870 dropped. If the client matches &%tls_try_verify_hosts%&, the (encrypted) SMTP
25871 session continues. ACLs that run for subsequent SMTP commands can detect the
25872 fact that no certificate was verified, and vary their actions accordingly. For
25873 example, you can insist on a certificate before accepting a message for
25874 relaying, but not when the message is destined for local delivery.
25875
25876 .vindex "&$tls_in_peerdn$&"
25877 When a client supplies a certificate (whether it verifies or not), the value of
25878 the Distinguished Name of the certificate is made available in the variable
25879 &$tls_in_peerdn$& during subsequent processing of the message.
25880
25881 .cindex "log" "distinguished name"
25882 Because it is often a long text string, it is not included in the log line or
25883 &'Received:'& header by default. You can arrange for it to be logged, keyed by
25884 &"DN="&, by setting the &%tls_peerdn%& log selector, and you can use
25885 &%received_header_text%& to change the &'Received:'& header. When no
25886 certificate is supplied, &$tls_in_peerdn$& is empty.
25887
25888
25889 .section "Revoked certificates" "SECID184"
25890 .cindex "TLS" "revoked certificates"
25891 .cindex "revocation list"
25892 .cindex "certificate" "revocation list"
25893 Certificate issuing authorities issue Certificate Revocation Lists (CRLs) when
25894 certificates are revoked. If you have such a list, you can pass it to an Exim
25895 server using the global option called &%tls_crl%& and to an Exim client using
25896 an identically named option for the &(smtp)& transport. In each case, the value
25897 of the option is expanded and must then be the name of a file that contains a
25898 CRL in PEM format.
25899
25900
25901 .section "Configuring an Exim client to use TLS" "SECID185"
25902 .cindex "cipher" "logging"
25903 .cindex "log" "TLS cipher"
25904 .cindex "log" "distinguished name"
25905 .cindex "TLS" "configuring an Exim client"
25906 The &%tls_cipher%& and &%tls_peerdn%& log selectors apply to outgoing SMTP
25907 deliveries as well as to incoming, the latter one causing logging of the
25908 server certificate's DN. The remaining client configuration for TLS is all
25909 within the &(smtp)& transport.
25910
25911 It is not necessary to set any options to have TLS work in the &(smtp)&
25912 transport. If Exim is built with TLS support, and TLS is advertised by a
25913 server, the &(smtp)& transport always tries to start a TLS session. However,
25914 this can be prevented by setting &%hosts_avoid_tls%& (an option of the
25915 transport) to a list of server hosts for which TLS should not be used.
25916
25917 If you do not want Exim to attempt to send messages unencrypted when an attempt
25918 to set up an encrypted connection fails in any way, you can set
25919 &%hosts_require_tls%& to a list of hosts for which encryption is mandatory. For
25920 those hosts, delivery is always deferred if an encrypted connection cannot be
25921 set up. If there are any other hosts for the address, they are tried in the
25922 usual way.
25923
25924 When the server host is not in &%hosts_require_tls%&, Exim may try to deliver
25925 the message unencrypted. It always does this if the response to STARTTLS is
25926 a 5&'xx'& code. For a temporary error code, or for a failure to negotiate a TLS
25927 session after a success response code, what happens is controlled by the
25928 &%tls_tempfail_tryclear%& option of the &(smtp)& transport. If it is false,
25929 delivery to this host is deferred, and other hosts (if available) are tried. If
25930 it is true, Exim attempts to deliver unencrypted after a 4&'xx'& response to
25931 STARTTLS, and if STARTTLS is accepted, but the subsequent TLS
25932 negotiation fails, Exim closes the current connection (because it is in an
25933 unknown state), opens a new one to the same host, and then tries the delivery
25934 unencrypted.
25935
25936 The &%tls_certificate%& and &%tls_privatekey%& options of the &(smtp)&
25937 transport provide the client with a certificate, which is passed to the server
25938 if it requests it. If the server is Exim, it will request a certificate only if
25939 &%tls_verify_hosts%& or &%tls_try_verify_hosts%& matches the client.
25940
25941 If the &%tls_verify_certificates%& option is set on the &(smtp)& transport, it
25942 must name a file or,
25943 for OpenSSL only (not GnuTLS), a directory, that contains a collection of
25944 expected server certificates. The client verifies the server's certificate
25945 against this collection, taking into account any revoked certificates that are
25946 in the list defined by &%tls_crl%&.
25947 Failure to verify fails the TLS connection unless either of the
25948 &%tls_verify_hosts%& or &%tls_try_verify_hosts%& options are set.
25949
25950 The &%tls_verify_hosts%& and &%tls_try_verify_hosts%& options restrict
25951 certificate verification to the listed servers.  Verification either must
25952 or need not succeed respectively.
25953
25954 If
25955 &%tls_require_ciphers%& is set on the &(smtp)& transport, it must contain a
25956 list of permitted cipher suites. If either of these checks fails, delivery to
25957 the current host is abandoned, and the &(smtp)& transport tries to deliver to
25958 alternative hosts, if any.
25959
25960  &*Note*&:
25961 These options must be set in the &(smtp)& transport for Exim to use TLS when it
25962 is operating as a client. Exim does not assume that a server certificate (set
25963 by the global options of the same name) should also be used when operating as a
25964 client.
25965
25966 .vindex "&$host$&"
25967 .vindex "&$host_address$&"
25968 All the TLS options in the &(smtp)& transport are expanded before use, with
25969 &$host$& and &$host_address$& containing the name and address of the server to
25970 which the client is connected. Forced failure of an expansion causes Exim to
25971 behave as if the relevant option were unset.
25972
25973 .vindex &$tls_out_bits$&
25974 .vindex &$tls_out_cipher$&
25975 .vindex &$tls_out_peerdn$&
25976 .vindex &$tls_out_sni$&
25977 Before an SMTP connection is established, the
25978 &$tls_out_bits$&, &$tls_out_cipher$&, &$tls_out_peerdn$& and &$tls_out_sni$&
25979 variables are emptied. (Until the first connection, they contain the values
25980 that were set when the message was received.) If STARTTLS is subsequently
25981 successfully obeyed, these variables are set to the relevant values for the
25982 outgoing connection.
25983
25984
25985
25986 .section "Use of TLS Server Name Indication" "SECTtlssni"
25987 .cindex "TLS" "Server Name Indication"
25988 .vindex "&$tls_in_sni$&"
25989 .oindex "&%tls_in_sni%&"
25990 With TLS1.0 or above, there is an extension mechanism by which extra
25991 information can be included at various points in the protocol.  One of these
25992 extensions, documented in RFC 6066 (and before that RFC 4366) is
25993 &"Server Name Indication"&, commonly &"SNI"&.  This extension is sent by the
25994 client in the initial handshake, so that the server can examine the servername
25995 within and possibly choose to use different certificates and keys (and more)
25996 for this session.
25997
25998 This is analagous to HTTP's &"Host:"& header, and is the main mechanism by
25999 which HTTPS-enabled web-sites can be virtual-hosted, many sites to one IP
26000 address.
26001
26002 With SMTP to MX, there are the same problems here as in choosing the identity
26003 against which to validate a certificate: you can't rely on insecure DNS to
26004 provide the identity which you then cryptographically verify.  So this will
26005 be of limited use in that environment.
26006
26007 With SMTP to Submission, there is a well-defined hostname which clients are
26008 connecting to and can validate certificates against.  Thus clients &*can*&
26009 choose to include this information in the TLS negotiation.  If this becomes
26010 wide-spread, then hosters can choose to present different certificates to
26011 different clients.  Or even negotiate different cipher suites.
26012
26013 The &%tls_sni%& option on an SMTP transport is an expanded string; the result,
26014 if not empty, will be sent on a TLS session as part of the handshake.  There's
26015 nothing more to it.  Choosing a sensible value not derived insecurely is the
26016 only point of caution.  The &$tls_out_sni$& variable will be set to this string
26017 for the lifetime of the client connection (including during authentication).
26018
26019 Except during SMTP client sessions, if &$tls_in_sni$& is set then it is a string
26020 received from a client.
26021 It can be logged with the &%log_selector%& item &`+tls_sni`&.
26022
26023 If the string &`tls_in_sni`& appears in the main section's &%tls_certificate%&
26024 option (prior to expansion) then the following options will be re-expanded
26025 during TLS session handshake, to permit alternative values to be chosen:
26026
26027 .ilist
26028 .vindex "&%tls_certificate%&"
26029 &%tls_certificate%&
26030 .next
26031 .vindex "&%tls_crl%&"
26032 &%tls_crl%&
26033 .next
26034 .vindex "&%tls_privatekey%&"
26035 &%tls_privatekey%&
26036 .next
26037 .vindex "&%tls_verify_certificates%&"
26038 &%tls_verify_certificates%&
26039 .endlist
26040
26041 Great care should be taken to deal with matters of case, various injection
26042 attacks in the string (&`../`& or SQL), and ensuring that a valid filename
26043 can always be referenced; it is important to remember that &$tls_sni$& is
26044 arbitrary unverified data provided prior to authentication.
26045
26046 The Exim developers are proceeding cautiously and so far no other TLS options
26047 are re-expanded.
26048
26049 When Exim is built againt OpenSSL, OpenSSL must have been built with support
26050 for TLS Extensions.  This holds true for OpenSSL 1.0.0+ and 0.9.8+ with
26051 enable-tlsext in EXTRACONFIGURE.  If you invoke &(openssl s_client -h)& and
26052 see &`-servername`& in the output, then OpenSSL has support.
26053
26054 When Exim is built against GnuTLS, SNI support is available as of GnuTLS
26055 0.5.10.  (Its presence predates the current API which Exim uses, so if Exim
26056 built, then you have SNI support).
26057
26058
26059
26060 .section "Multiple messages on the same encrypted TCP/IP connection" &&&
26061          "SECTmulmessam"
26062 .cindex "multiple SMTP deliveries with TLS"
26063 .cindex "TLS" "multiple message deliveries"
26064 Exim sends multiple messages down the same TCP/IP connection by starting up
26065 an entirely new delivery process for each message, passing the socket from
26066 one process to the next. This implementation does not fit well with the use
26067 of TLS, because there is quite a lot of state information associated with a TLS
26068 connection, not just a socket identification. Passing all the state information
26069 to a new process is not feasible. Consequently, Exim shuts down an existing TLS
26070 session before passing the socket to a new process. The new process may then
26071 try to start a new TLS session, and if successful, may try to re-authenticate
26072 if AUTH is in use, before sending the next message.
26073
26074 The RFC is not clear as to whether or not an SMTP session continues in clear
26075 after TLS has been shut down, or whether TLS may be restarted again later, as
26076 just described. However, if the server is Exim, this shutdown and
26077 reinitialization works. It is not known which (if any) other servers operate
26078 successfully if the client closes a TLS session and continues with unencrypted
26079 SMTP, but there are certainly some that do not work. For such servers, Exim
26080 should not pass the socket to another process, because the failure of the
26081 subsequent attempt to use it would cause Exim to record a temporary host error,
26082 and delay other deliveries to that host.
26083
26084 To test for this case, Exim sends an EHLO command to the server after
26085 closing down the TLS session. If this fails in any way, the connection is
26086 closed instead of being passed to a new delivery process, but no retry
26087 information is recorded.
26088
26089 There is also a manual override; you can set &%hosts_nopass_tls%& on the
26090 &(smtp)& transport to match those hosts for which Exim should not pass
26091 connections to new processes if TLS has been used.
26092
26093
26094
26095
26096 .section "Certificates and all that" "SECTcerandall"
26097 .cindex "certificate" "references to discussion"
26098 In order to understand fully how TLS works, you need to know about
26099 certificates, certificate signing, and certificate authorities. This is not the
26100 place to give a tutorial, especially as I do not know very much about it
26101 myself. Some helpful introduction can be found in the FAQ for the SSL addition
26102 to Apache, currently at
26103 .display
26104 &url(http://www.modssl.org/docs/2.7/ssl_faq.html#ToC24)
26105 .endd
26106 Other parts of the &'modssl'& documentation are also helpful, and have
26107 links to further files.
26108 Eric Rescorla's book, &'SSL and TLS'&, published by Addison-Wesley (ISBN
26109 0-201-61598-3), contains both introductory and more in-depth descriptions.
26110 Some sample programs taken from the book are available from
26111 .display
26112 &url(http://www.rtfm.com/openssl-examples/)
26113 .endd
26114
26115
26116 .section "Certificate chains" "SECID186"
26117 The file named by &%tls_certificate%& may contain more than one
26118 certificate. This is useful in the case where the certificate that is being
26119 sent is validated by an intermediate certificate which the other end does
26120 not have. Multiple certificates must be in the correct order in the file.
26121 First the host's certificate itself, then the first intermediate
26122 certificate to validate the issuer of the host certificate, then the next
26123 intermediate certificate to validate the issuer of the first intermediate
26124 certificate, and so on, until finally (optionally) the root certificate.
26125 The root certificate must already be trusted by the recipient for
26126 validation to succeed, of course, but if it's not preinstalled, sending the
26127 root certificate along with the rest makes it available for the user to
26128 install if the receiving end is a client MUA that can interact with a user.
26129
26130 Note that certificates using MD5 are unlikely to work on today's Internet;
26131 even if your libraries allow loading them for use in Exim when acting as a
26132 server, increasingly clients will not accept such certificates.  The error
26133 diagnostics in such a case can be frustratingly vague.
26134
26135
26136
26137 .section "Self-signed certificates" "SECID187"
26138 .cindex "certificate" "self-signed"
26139 You can create a self-signed certificate using the &'req'& command provided
26140 with OpenSSL, like this:
26141 . ==== Do not shorten the duration here without reading and considering
26142 . ==== the text below.  Please leave it at 9999 days.
26143 .code
26144 openssl req -x509 -newkey rsa:1024 -keyout file1 -out file2 \
26145             -days 9999 -nodes
26146 .endd
26147 &_file1_& and &_file2_& can be the same file; the key and the certificate are
26148 delimited and so can be identified independently. The &%-days%& option
26149 specifies a period for which the certificate is valid. The &%-nodes%& option is
26150 important: if you do not set it, the key is encrypted with a passphrase
26151 that you are prompted for, and any use that is made of the key causes more
26152 prompting for the passphrase. This is not helpful if you are going to use
26153 this certificate and key in an MTA, where prompting is not possible.
26154
26155 . ==== I expect to still be working 26 years from now.  The less technical
26156 . ==== debt I create, in terms of storing up trouble for my later years, the
26157 . ==== happier I will be then.  We really have reached the point where we
26158 . ==== should start, at the very least, provoking thought and making folks
26159 . ==== pause before proceeding, instead of leaving all the fixes until two
26160 . ==== years before 2^31 seconds after the 1970 Unix epoch.
26161 . ==== -pdp, 2012
26162 NB: we are now past the point where 9999 days takes us past the 32-bit Unix
26163 epoch.  If your system uses unsigned time_t (most do) and is 32-bit, then
26164 the above command might produce a date in the past.  Think carefully about
26165 the lifetime of the systems you're deploying, and either reduce the duration
26166 of the certificate or reconsider your platform deployment.  (At time of
26167 writing, reducing the duration is the most likely choice, but the inexorable
26168 progression of time takes us steadily towards an era where this will not
26169 be a sensible resolution).
26170
26171 A self-signed certificate made in this way is sufficient for testing, and
26172 may be adequate for all your requirements if you are mainly interested in
26173 encrypting transfers, and not in secure identification.
26174
26175 However, many clients require that the certificate presented by the server be a
26176 user (also called &"leaf"& or &"site"&) certificate, and not a self-signed
26177 certificate. In this situation, the self-signed certificate described above
26178 must be installed on the client host as a trusted root &'certification
26179 authority'& (CA), and the certificate used by Exim must be a user certificate
26180 signed with that self-signed certificate.
26181
26182 For information on creating self-signed CA certificates and using them to sign
26183 user certificates, see the &'General implementation overview'& chapter of the
26184 Open-source PKI book, available online at
26185 &url(http://ospkibook.sourceforge.net/).
26186 .ecindex IIDencsmtp1
26187 .ecindex IIDencsmtp2
26188
26189
26190
26191 . ////////////////////////////////////////////////////////////////////////////
26192 . ////////////////////////////////////////////////////////////////////////////
26193
26194 .chapter "Access control lists" "CHAPACL"
26195 .scindex IIDacl "&ACL;" "description"
26196 .cindex "control of incoming mail"
26197 .cindex "message" "controlling incoming"
26198 .cindex "policy control" "access control lists"
26199 Access Control Lists (ACLs) are defined in a separate section of the run time
26200 configuration file, headed by &"begin acl"&. Each ACL definition starts with a
26201 name, terminated by a colon. Here is a complete ACL section that contains just
26202 one very small ACL:
26203 .code
26204 begin acl
26205 small_acl:
26206   accept   hosts = one.host.only
26207 .endd
26208 You can have as many lists as you like in the ACL section, and the order in
26209 which they appear does not matter. The lists are self-terminating.
26210
26211 The majority of ACLs are used to control Exim's behaviour when it receives
26212 certain SMTP commands. This applies both to incoming TCP/IP connections, and
26213 when a local process submits a message using SMTP by specifying the &%-bs%&
26214 option. The most common use is for controlling which recipients are accepted
26215 in incoming messages. In addition, you can define an ACL that is used to check
26216 local non-SMTP messages. The default configuration file contains an example of
26217 a realistic ACL for checking RCPT commands. This is discussed in chapter
26218 &<<CHAPdefconfil>>&.
26219
26220
26221 .section "Testing ACLs" "SECID188"
26222 The &%-bh%& command line option provides a way of testing your ACL
26223 configuration locally by running a fake SMTP session with which you interact.
26224 The host &'relay-test.mail-abuse.org'& provides a service for checking your
26225 relaying configuration (see section &<<SECTcheralcon>>& for more details).
26226
26227
26228
26229 .section "Specifying when ACLs are used" "SECID189"
26230 .cindex "&ACL;" "options for specifying"
26231 In order to cause an ACL to be used, you have to name it in one of the relevant
26232 options in the main part of the configuration. These options are:
26233 .cindex "AUTH" "ACL for"
26234 .cindex "DATA" "ACLs for"
26235 .cindex "ETRN" "ACL for"
26236 .cindex "EXPN" "ACL for"
26237 .cindex "HELO" "ACL for"
26238 .cindex "EHLO" "ACL for"
26239 .cindex "MAIL" "ACL for"
26240 .cindex "QUIT, ACL for"
26241 .cindex "RCPT" "ACL for"
26242 .cindex "STARTTLS, ACL for"
26243 .cindex "VRFY" "ACL for"
26244 .cindex "SMTP" "connection, ACL for"
26245 .cindex "non-SMTP messages" "ACLs for"
26246 .cindex "MIME content scanning" "ACL for"
26247
26248 .table2 140pt
26249 .irow &%acl_not_smtp%&         "ACL for non-SMTP messages"
26250 .irow &%acl_not_smtp_mime%&    "ACL for non-SMTP MIME parts"
26251 .irow &%acl_not_smtp_start%&   "ACL at start of non-SMTP message"
26252 .irow &%acl_smtp_auth%&        "ACL for AUTH"
26253 .irow &%acl_smtp_connect%&     "ACL for start of SMTP connection"
26254 .irow &%acl_smtp_data%&        "ACL after DATA is complete"
26255 .irow &%acl_smtp_etrn%&        "ACL for ETRN"
26256 .irow &%acl_smtp_expn%&        "ACL for EXPN"
26257 .irow &%acl_smtp_helo%&        "ACL for HELO or EHLO"
26258 .irow &%acl_smtp_mail%&        "ACL for MAIL"
26259 .irow &%acl_smtp_mailauth%&    "ACL for the AUTH parameter of MAIL"
26260 .irow &%acl_smtp_mime%&        "ACL for content-scanning MIME parts"
26261 .irow &%acl_smtp_notquit%&     "ACL for non-QUIT terminations"
26262 .irow &%acl_smtp_predata%&     "ACL at start of DATA command"
26263 .irow &%acl_smtp_quit%&        "ACL for QUIT"
26264 .irow &%acl_smtp_rcpt%&        "ACL for RCPT"
26265 .irow &%acl_smtp_starttls%&    "ACL for STARTTLS"
26266 .irow &%acl_smtp_vrfy%&        "ACL for VRFY"
26267 .endtable
26268
26269 For example, if you set
26270 .code
26271 acl_smtp_rcpt = small_acl
26272 .endd
26273 the little ACL defined above is used whenever Exim receives a RCPT command
26274 in an SMTP dialogue. The majority of policy tests on incoming messages can be
26275 done when RCPT commands arrive. A rejection of RCPT should cause the
26276 sending MTA to give up on the recipient address contained in the RCPT
26277 command, whereas rejection at other times may cause the client MTA to keep on
26278 trying to deliver the message. It is therefore recommended that you do as much
26279 testing as possible at RCPT time.
26280
26281
26282 .section "The non-SMTP ACLs" "SECID190"
26283 .cindex "non-SMTP messages" "ACLs for"
26284 The non-SMTP ACLs apply to all non-interactive incoming messages, that is, they
26285 apply to batched SMTP as well as to non-SMTP messages. (Batched SMTP is not
26286 really SMTP.) Many of the ACL conditions (for example, host tests, and tests on
26287 the state of the SMTP connection such as encryption and authentication) are not
26288 relevant and are forbidden in these ACLs. However, the sender and recipients
26289 are known, so the &%senders%& and &%sender_domains%& conditions and the
26290 &$sender_address$& and &$recipients$& variables can be used. Variables such as
26291 &$authenticated_sender$& are also available. You can specify added header lines
26292 in any of these ACLs.
26293
26294 The &%acl_not_smtp_start%& ACL is run right at the start of receiving a
26295 non-SMTP message, before any of the message has been read. (This is the
26296 analogue of the &%acl_smtp_predata%& ACL for SMTP input.) In the case of
26297 batched SMTP input, it runs after the DATA command has been reached. The
26298 result of this ACL is ignored; it cannot be used to reject a message. If you
26299 really need to, you could set a value in an ACL variable here and reject based
26300 on that in the &%acl_not_smtp%& ACL. However, this ACL can be used to set
26301 controls, and in particular, it can be used to set
26302 .code
26303 control = suppress_local_fixups
26304 .endd
26305 This cannot be used in the other non-SMTP ACLs because by the time they are
26306 run, it is too late.
26307
26308 The &%acl_not_smtp_mime%& ACL is available only when Exim is compiled with the
26309 content-scanning extension. For details, see chapter &<<CHAPexiscan>>&.
26310
26311 The &%acl_not_smtp%& ACL is run just before the &[local_scan()]& function. Any
26312 kind of rejection is treated as permanent, because there is no way of sending a
26313 temporary error for these kinds of message.
26314
26315
26316 .section "The SMTP connect ACL" "SECID191"
26317 .cindex "SMTP" "connection, ACL for"
26318 .oindex &%smtp_banner%&
26319 The ACL test specified by &%acl_smtp_connect%& happens at the start of an SMTP
26320 session, after the test specified by &%host_reject_connection%& (which is now
26321 an anomaly) and any TCP Wrappers testing (if configured). If the connection is
26322 accepted by an &%accept%& verb that has a &%message%& modifier, the contents of
26323 the message override the banner message that is otherwise specified by the
26324 &%smtp_banner%& option.
26325
26326
26327 .section "The EHLO/HELO ACL" "SECID192"
26328 .cindex "EHLO" "ACL for"
26329 .cindex "HELO" "ACL for"
26330 The ACL test specified by &%acl_smtp_helo%& happens when the client issues an
26331 EHLO or HELO command, after the tests specified by &%helo_accept_junk_hosts%&,
26332 &%helo_allow_chars%&, &%helo_verify_hosts%&, and &%helo_try_verify_hosts%&.
26333 Note that a client may issue more than one EHLO or HELO command in an SMTP
26334 session, and indeed is required to issue a new EHLO or HELO after successfully
26335 setting up encryption following a STARTTLS command.
26336
26337 If the command is accepted by an &%accept%& verb that has a &%message%&
26338 modifier, the message may not contain more than one line (it will be truncated
26339 at the first newline and a panic logged if it does). Such a message cannot
26340 affect the EHLO options that are listed on the second and subsequent lines of
26341 an EHLO response.
26342
26343
26344 .section "The DATA ACLs" "SECID193"
26345 .cindex "DATA" "ACLs for"
26346 Two ACLs are associated with the DATA command, because it is two-stage
26347 command, with two responses being sent to the client.
26348 When the DATA command is received, the ACL defined by &%acl_smtp_predata%&
26349 is obeyed. This gives you control after all the RCPT commands, but before
26350 the message itself is received. It offers the opportunity to give a negative
26351 response to the DATA command before the data is transmitted. Header lines
26352 added by MAIL or RCPT ACLs are not visible at this time, but any that
26353 are defined here are visible when the &%acl_smtp_data%& ACL is run.
26354
26355 You cannot test the contents of the message, for example, to verify addresses
26356 in the headers, at RCPT time or when the DATA command is received. Such
26357 tests have to appear in the ACL that is run after the message itself has been
26358 received, before the final response to the DATA command is sent. This is
26359 the ACL specified by &%acl_smtp_data%&, which is the second ACL that is
26360 associated with the DATA command.
26361
26362 For both of these ACLs, it is not possible to reject individual recipients. An
26363 error response rejects the entire message. Unfortunately, it is known that some
26364 MTAs do not treat hard (5&'xx'&) responses to the DATA command (either
26365 before or after the data) correctly &-- they keep the message on their queues
26366 and try again later, but that is their problem, though it does waste some of
26367 your resources.
26368
26369 The &%acl_smtp_data%& ACL is run after both the &%acl_smtp_dkim%& and
26370 the &%acl_smtp_mime%& ACLs.
26371
26372 .section "The SMTP DKIM ACL" "SECTDKIMACL"
26373 The &%acl_smtp_dkim%& ACL is available only when Exim is compiled with DKIM support
26374 enabled (which is the default).
26375
26376 The ACL test specified by &%acl_smtp_dkim%& happens after a message has been
26377 received, and is executed for each DKIM signature found in a message.  If not
26378 otherwise specified, the default action is to accept.
26379
26380 This ACL is evaluated before &%acl_smtp_mime%& and &%acl_smtp_data%&.
26381
26382 For details on the operation of DKIM, see chapter &<<CHAPdkim>>&.
26383
26384
26385 .section "The SMTP MIME ACL" "SECID194"
26386 The &%acl_smtp_mime%& option is available only when Exim is compiled with the
26387 content-scanning extension. For details, see chapter &<<CHAPexiscan>>&.
26388
26389 This ACL is evaluated after &%acl_smtp_dkim%& but before &%acl_smtp_data%&.
26390
26391
26392 .section "The QUIT ACL" "SECTQUITACL"
26393 .cindex "QUIT, ACL for"
26394 The ACL for the SMTP QUIT command is anomalous, in that the outcome of the ACL
26395 does not affect the response code to QUIT, which is always 221. Thus, the ACL
26396 does not in fact control any access. For this reason, the only verbs that are
26397 permitted are &%accept%& and &%warn%&.
26398
26399 This ACL can be used for tasks such as custom logging at the end of an SMTP
26400 session. For example, you can use ACL variables in other ACLs to count
26401 messages, recipients, etc., and log the totals at QUIT time using one or
26402 more &%logwrite%& modifiers on a &%warn%& verb.
26403
26404 &*Warning*&: Only the &$acl_c$&&'x'& variables can be used for this, because
26405 the &$acl_m$&&'x'& variables are reset at the end of each incoming message.
26406
26407 You do not need to have a final &%accept%&, but if you do, you can use a
26408 &%message%& modifier to specify custom text that is sent as part of the 221
26409 response to QUIT.
26410
26411 This ACL is run only for a &"normal"& QUIT. For certain kinds of disastrous
26412 failure (for example, failure to open a log file, or when Exim is bombing out
26413 because it has detected an unrecoverable error), all SMTP commands from the
26414 client are given temporary error responses until QUIT is received or the
26415 connection is closed. In these special cases, the QUIT ACL does not run.
26416
26417
26418 .section "The not-QUIT ACL" "SECTNOTQUITACL"
26419 .vindex &$acl_smtp_notquit$&
26420 The not-QUIT ACL, specified by &%acl_smtp_notquit%&, is run in most cases when
26421 an SMTP session ends without sending QUIT. However, when Exim itself is in bad
26422 trouble, such as being unable to write to its log files, this ACL is not run,
26423 because it might try to do things (such as write to log files) that make the
26424 situation even worse.
26425
26426 Like the QUIT ACL, this ACL is provided to make it possible to do customized
26427 logging or to gather statistics, and its outcome is ignored. The &%delay%&
26428 modifier is forbidden in this ACL, and the only permitted verbs are &%accept%&
26429 and &%warn%&.
26430
26431 .vindex &$smtp_notquit_reason$&
26432 When the not-QUIT ACL is running, the variable &$smtp_notquit_reason$& is set
26433 to a string that indicates the reason for the termination of the SMTP
26434 connection. The possible values are:
26435 .table2
26436 .irow &`acl-drop`&                 "Another ACL issued a &%drop%& command"
26437 .irow &`bad-commands`&             "Too many unknown or non-mail commands"
26438 .irow &`command-timeout`&          "Timeout while reading SMTP commands"
26439 .irow &`connection-lost`&          "The SMTP connection has been lost"
26440 .irow &`data-timeout`&             "Timeout while reading message data"
26441 .irow &`local-scan-error`&         "The &[local_scan()]& function crashed"
26442 .irow &`local-scan-timeout`&       "The &[local_scan()]& function timed out"
26443 .irow &`signal-exit`&              "SIGTERM or SIGINT"
26444 .irow &`synchronization-error`&    "SMTP synchronization error"
26445 .irow &`tls-failed`&               "TLS failed to start"
26446 .endtable
26447 In most cases when an SMTP connection is closed without having received QUIT,
26448 Exim sends an SMTP response message before actually closing the connection.
26449 With the exception of the &`acl-drop`& case, the default message can be
26450 overridden by the &%message%& modifier in the not-QUIT ACL. In the case of a
26451 &%drop%& verb in another ACL, it is the message from the other ACL that is
26452 used.
26453
26454
26455 .section "Finding an ACL to use" "SECID195"
26456 .cindex "&ACL;" "finding which to use"
26457 The value of an &%acl_smtp_%&&'xxx'& option is expanded before use, so
26458 you can use different ACLs in different circumstances. For example,
26459 .code
26460 acl_smtp_rcpt = ${if ={25}{$interface_port} \
26461                      {acl_check_rcpt} {acl_check_rcpt_submit} }
26462 .endd
26463 In the default configuration file there are some example settings for
26464 providing an RFC 4409 message submission service on port 587 and a
26465 non-standard &"smtps"& service on port 465. You can use a string
26466 expansion like this to choose an ACL for MUAs on these ports which is
26467 more appropriate for this purpose than the default ACL on port 25.
26468
26469 The expanded string does not have to be the name of an ACL in the
26470 configuration file; there are other possibilities. Having expanded the
26471 string, Exim searches for an ACL as follows:
26472
26473 .ilist
26474 If the string begins with a slash, Exim uses it as a file name, and reads its
26475 contents as an ACL. The lines are processed in the same way as lines in the
26476 Exim configuration file. In particular, continuation lines are supported, blank
26477 lines are ignored, as are lines whose first non-whitespace character is &"#"&.
26478 If the file does not exist or cannot be read, an error occurs (typically
26479 causing a temporary failure of whatever caused the ACL to be run). For example:
26480 .code
26481 acl_smtp_data = /etc/acls/\
26482   ${lookup{$sender_host_address}lsearch\
26483   {/etc/acllist}{$value}{default}}
26484 .endd
26485 This looks up an ACL file to use on the basis of the host's IP address, falling
26486 back to a default if the lookup fails. If an ACL is successfully read from a
26487 file, it is retained in memory for the duration of the Exim process, so that it
26488 can be re-used without having to re-read the file.
26489 .next
26490 If the string does not start with a slash, and does not contain any spaces,
26491 Exim searches the ACL section of the configuration for an ACL whose name
26492 matches the string.
26493 .next
26494 If no named ACL is found, or if the string contains spaces, Exim parses
26495 the string as an inline ACL. This can save typing in cases where you just
26496 want to have something like
26497 .code
26498 acl_smtp_vrfy = accept
26499 .endd
26500 in order to allow free use of the VRFY command. Such a string may contain
26501 newlines; it is processed in the same way as an ACL that is read from a file.
26502 .endlist
26503
26504
26505
26506
26507 .section "ACL return codes" "SECID196"
26508 .cindex "&ACL;" "return codes"
26509 Except for the QUIT ACL, which does not affect the SMTP return code (see
26510 section &<<SECTQUITACL>>& above), the result of running an ACL is either
26511 &"accept"& or &"deny"&, or, if some test cannot be completed (for example, if a
26512 database is down), &"defer"&. These results cause 2&'xx'&, 5&'xx'&, and 4&'xx'&
26513 return codes, respectively, to be used in the SMTP dialogue. A fourth return,
26514 &"error"&, occurs when there is an error such as invalid syntax in the ACL.
26515 This also causes a 4&'xx'& return code.
26516
26517 For the non-SMTP ACL, &"defer"& and &"error"& are treated in the same way as
26518 &"deny"&, because there is no mechanism for passing temporary errors to the
26519 submitters of non-SMTP messages.
26520
26521
26522 ACLs that are relevant to message reception may also return &"discard"&. This
26523 has the effect of &"accept"&, but causes either the entire message or an
26524 individual recipient address to be discarded. In other words, it is a
26525 blackholing facility. Use it with care.
26526
26527 If the ACL for MAIL returns &"discard"&, all recipients are discarded, and no
26528 ACL is run for subsequent RCPT commands. The effect of &"discard"& in a
26529 RCPT ACL is to discard just the one recipient address. If there are no
26530 recipients left when the message's data is received, the DATA ACL is not
26531 run. A &"discard"& return from the DATA or the non-SMTP ACL discards all the
26532 remaining recipients. The &"discard"& return is not permitted for the
26533 &%acl_smtp_predata%& ACL.
26534
26535
26536 .cindex "&[local_scan()]& function" "when all recipients discarded"
26537 The &[local_scan()]& function is always run, even if there are no remaining
26538 recipients; it may create new recipients.
26539
26540
26541
26542 .section "Unset ACL options" "SECID197"
26543 .cindex "&ACL;" "unset options"
26544 The default actions when any of the &%acl_%&&'xxx'& options are unset are not
26545 all the same. &*Note*&: These defaults apply only when the relevant ACL is
26546 not defined at all. For any defined ACL, the default action when control
26547 reaches the end of the ACL statements is &"deny"&.
26548
26549 For &%acl_smtp_quit%& and &%acl_not_smtp_start%& there is no default because
26550 these two are ACLs that are used only for their side effects. They cannot be
26551 used to accept or reject anything.
26552
26553 For &%acl_not_smtp%&, &%acl_smtp_auth%&, &%acl_smtp_connect%&,
26554 &%acl_smtp_data%&, &%acl_smtp_helo%&, &%acl_smtp_mail%&, &%acl_smtp_mailauth%&,
26555 &%acl_smtp_mime%&, &%acl_smtp_predata%&, and &%acl_smtp_starttls%&, the action
26556 when the ACL is not defined is &"accept"&.
26557
26558 For the others (&%acl_smtp_etrn%&, &%acl_smtp_expn%&, &%acl_smtp_rcpt%&, and
26559 &%acl_smtp_vrfy%&), the action when the ACL is not defined is &"deny"&.
26560 This means that &%acl_smtp_rcpt%& must be defined in order to receive any
26561 messages over an SMTP connection. For an example, see the ACL in the default
26562 configuration file.
26563
26564
26565
26566
26567 .section "Data for message ACLs" "SECID198"
26568 .cindex "&ACL;" "data for message ACL"
26569 .vindex &$domain$&
26570 .vindex &$local_part$&
26571 .vindex &$sender_address$&
26572 .vindex &$sender_host_address$&
26573 .vindex &$smtp_command$&
26574 When a MAIL or RCPT ACL, or either of the DATA ACLs, is running, the variables
26575 that contain information about the host and the message's sender (for example,
26576 &$sender_host_address$& and &$sender_address$&) are set, and can be used in ACL
26577 statements. In the case of RCPT (but not MAIL or DATA), &$domain$& and
26578 &$local_part$& are set from the argument address. The entire SMTP command
26579 is available in &$smtp_command$&.
26580
26581 When an ACL for the AUTH parameter of MAIL is running, the variables that
26582 contain information about the host are set, but &$sender_address$& is not yet
26583 set. Section &<<SECTauthparamail>>& contains a discussion of this parameter and
26584 how it is used.
26585
26586 .vindex "&$message_size$&"
26587 The &$message_size$& variable is set to the value of the SIZE parameter on
26588 the MAIL command at MAIL, RCPT and pre-data time, or to -1 if
26589 that parameter is not given. The value is updated to the true message size by
26590 the time the final DATA ACL is run (after the message data has been
26591 received).
26592
26593 .vindex "&$rcpt_count$&"
26594 .vindex "&$recipients_count$&"
26595 The &$rcpt_count$& variable increases by one for each RCPT command received.
26596 The &$recipients_count$& variable increases by one each time a RCPT command is
26597 accepted, so while an ACL for RCPT is being processed, it contains the number
26598 of previously accepted recipients. At DATA time (for both the DATA ACLs),
26599 &$rcpt_count$& contains the total number of RCPT commands, and
26600 &$recipients_count$& contains the total number of accepted recipients.
26601
26602
26603
26604
26605
26606 .section "Data for non-message ACLs" "SECTdatfornon"
26607 .cindex "&ACL;" "data for non-message ACL"
26608 .vindex &$smtp_command_argument$&
26609 .vindex &$smtp_command$&
26610 When an ACL is being run for AUTH, EHLO, ETRN, EXPN, HELO, STARTTLS, or VRFY,
26611 the remainder of the SMTP command line is placed in &$smtp_command_argument$&,
26612 and the entire SMTP command is available in &$smtp_command$&.
26613 These variables can be tested using a &%condition%& condition. For example,
26614 here is an ACL for use with AUTH, which insists that either the session is
26615 encrypted, or the CRAM-MD5 authentication method is used. In other words, it
26616 does not permit authentication methods that use cleartext passwords on
26617 unencrypted connections.
26618 .code
26619 acl_check_auth:
26620   accept encrypted = *
26621   accept condition = ${if eq{${uc:$smtp_command_argument}}\
26622                      {CRAM-MD5}}
26623   deny   message   = TLS encryption or CRAM-MD5 required
26624 .endd
26625 (Another way of applying this restriction is to arrange for the authenticators
26626 that use cleartext passwords not to be advertised when the connection is not
26627 encrypted. You can use the generic &%server_advertise_condition%& authenticator
26628 option to do this.)
26629
26630
26631
26632 .section "Format of an ACL" "SECID199"
26633 .cindex "&ACL;" "format of"
26634 .cindex "&ACL;" "verbs, definition of"
26635 An individual ACL consists of a number of statements. Each statement starts
26636 with a verb, optionally followed by a number of conditions and &"modifiers"&.
26637 Modifiers can change the way the verb operates, define error and log messages,
26638 set variables, insert delays, and vary the processing of accepted messages.
26639
26640 If all the conditions are met, the verb is obeyed. The same condition may be
26641 used (with different arguments) more than once in the same statement. This
26642 provides a means of specifying an &"and"& conjunction between conditions. For
26643 example:
26644 .code
26645 deny  dnslists = list1.example
26646 dnslists = list2.example
26647 .endd
26648 If there are no conditions, the verb is always obeyed. Exim stops evaluating
26649 the conditions and modifiers when it reaches a condition that fails. What
26650 happens then depends on the verb (and in one case, on a special modifier). Not
26651 all the conditions make sense at every testing point. For example, you cannot
26652 test a sender address in the ACL that is run for a VRFY command.
26653
26654
26655 .section "ACL verbs" "SECID200"
26656 The ACL verbs are as follows:
26657
26658 .ilist
26659 .cindex "&%accept%& ACL verb"
26660 &%accept%&: If all the conditions are met, the ACL returns &"accept"&. If any
26661 of the conditions are not met, what happens depends on whether &%endpass%&
26662 appears among the conditions (for syntax see below). If the failing condition
26663 is before &%endpass%&, control is passed to the next ACL statement; if it is
26664 after &%endpass%&, the ACL returns &"deny"&. Consider this statement, used to
26665 check a RCPT command:
26666 .code
26667 accept domains = +local_domains
26668 endpass
26669 verify = recipient
26670 .endd
26671 If the recipient domain does not match the &%domains%& condition, control
26672 passes to the next statement. If it does match, the recipient is verified, and
26673 the command is accepted if verification succeeds. However, if verification
26674 fails, the ACL yields &"deny"&, because the failing condition is after
26675 &%endpass%&.
26676
26677 The &%endpass%& feature has turned out to be confusing to many people, so its
26678 use is not recommended nowadays. It is always possible to rewrite an ACL so
26679 that &%endpass%& is not needed, and it is no longer used in the default
26680 configuration.
26681
26682 .cindex "&%message%& ACL modifier" "with &%accept%&"
26683 If a &%message%& modifier appears on an &%accept%& statement, its action
26684 depends on whether or not &%endpass%& is present. In the absence of &%endpass%&
26685 (when an &%accept%& verb either accepts or passes control to the next
26686 statement), &%message%& can be used to vary the message that is sent when an
26687 SMTP command is accepted. For example, in a RCPT ACL you could have:
26688 .display
26689 &`accept  `&<&'some conditions'&>
26690 &`        message = OK, I will allow you through today`&
26691 .endd
26692 You can specify an SMTP response code, optionally followed by an &"extended
26693 response code"& at the start of the message, but the first digit must be the
26694 same as would be sent by default, which is 2 for an &%accept%& verb.
26695
26696 If &%endpass%& is present in an &%accept%& statement, &%message%& specifies
26697 an error message that is used when access is denied. This behaviour is retained
26698 for backward compatibility, but current &"best practice"& is to avoid the use
26699 of &%endpass%&.
26700
26701
26702 .next
26703 .cindex "&%defer%& ACL verb"
26704 &%defer%&: If all the conditions are true, the ACL returns &"defer"& which, in
26705 an SMTP session, causes a 4&'xx'& response to be given. For a non-SMTP ACL,
26706 &%defer%& is the same as &%deny%&, because there is no way of sending a
26707 temporary error. For a RCPT command, &%defer%& is much the same as using a
26708 &(redirect)& router and &`:defer:`& while verifying, but the &%defer%& verb can
26709 be used in any ACL, and even for a recipient it might be a simpler approach.
26710
26711
26712 .next
26713 .cindex "&%deny%& ACL verb"
26714 &%deny%&: If all the conditions are met, the ACL returns &"deny"&. If any of
26715 the conditions are not met, control is passed to the next ACL statement. For
26716 example,
26717 .code
26718 deny dnslists = blackholes.mail-abuse.org
26719 .endd
26720 rejects commands from hosts that are on a DNS black list.
26721
26722
26723 .next
26724 .cindex "&%discard%& ACL verb"
26725 &%discard%&: This verb behaves like &%accept%&, except that it returns
26726 &"discard"& from the ACL instead of &"accept"&. It is permitted only on ACLs
26727 that are concerned with receiving messages. When all the conditions are true,
26728 the sending entity receives a &"success"& response. However, &%discard%& causes
26729 recipients to be discarded. If it is used in an ACL for RCPT, just the one
26730 recipient is discarded; if used for MAIL, DATA or in the non-SMTP ACL, all the
26731 message's recipients are discarded. Recipients that are discarded before DATA
26732 do not appear in the log line when the &%received_recipients%& log selector is set.
26733
26734 If the &%log_message%& modifier is set when &%discard%& operates,
26735 its contents are added to the line that is automatically written to the log.
26736 The &%message%& modifier operates exactly as it does for &%accept%&.
26737
26738
26739 .next
26740 .cindex "&%drop%& ACL verb"
26741 &%drop%&: This verb behaves like &%deny%&, except that an SMTP connection is
26742 forcibly closed after the 5&'xx'& error message has been sent. For example:
26743 .code
26744 drop   message   = I don't take more than 20 RCPTs
26745        condition = ${if > {$rcpt_count}{20}}
26746 .endd
26747 There is no difference between &%deny%& and &%drop%& for the connect-time ACL.
26748 The connection is always dropped after sending a 550 response.
26749
26750 .next
26751 .cindex "&%require%& ACL verb"
26752 &%require%&: If all the conditions are met, control is passed to the next ACL
26753 statement. If any of the conditions are not met, the ACL returns &"deny"&. For
26754 example, when checking a RCPT command,
26755 .code
26756 require message = Sender did not verify
26757         verify  = sender
26758 .endd
26759 passes control to subsequent statements only if the message's sender can be
26760 verified. Otherwise, it rejects the command. Note the positioning of the
26761 &%message%& modifier, before the &%verify%& condition. The reason for this is
26762 discussed in section &<<SECTcondmodproc>>&.
26763
26764 .next
26765 .cindex "&%warn%& ACL verb"
26766 &%warn%&: If all the conditions are true, a line specified by the
26767 &%log_message%& modifier is written to Exim's main log. Control always passes
26768 to the next ACL statement. If any condition is false, the log line is not
26769 written. If an identical log line is requested several times in the same
26770 message, only one copy is actually written to the log. If you want to force
26771 duplicates to be written, use the &%logwrite%& modifier instead.
26772
26773 If &%log_message%& is not present, a &%warn%& verb just checks its conditions
26774 and obeys any &"immediate"& modifiers (such as &%control%&, &%set%&,
26775 &%logwrite%&, &%add_header%&, and &%remove_header%&) that appear before the
26776 first failing condition. There is more about adding header lines in section
26777 &<<SECTaddheadacl>>&.
26778
26779 If any condition on a &%warn%& statement cannot be completed (that is, there is
26780 some sort of defer), the log line specified by &%log_message%& is not written.
26781 This does not include the case of a forced failure from a lookup, which
26782 is considered to be a successful completion. After a defer, no further
26783 conditions or modifiers in the &%warn%& statement are processed. The incident
26784 is logged, and the ACL continues to be processed, from the next statement
26785 onwards.
26786
26787
26788 .vindex "&$acl_verify_message$&"
26789 When one of the &%warn%& conditions is an address verification that fails, the
26790 text of the verification failure message is in &$acl_verify_message$&. If you
26791 want this logged, you must set it up explicitly. For example:
26792 .code
26793 warn   !verify = sender
26794        log_message = sender verify failed: $acl_verify_message
26795 .endd
26796 .endlist
26797
26798 At the end of each ACL there is an implicit unconditional &%deny%&.
26799
26800 As you can see from the examples above, the conditions and modifiers are
26801 written one to a line, with the first one on the same line as the verb, and
26802 subsequent ones on following lines. If you have a very long condition, you can
26803 continue it onto several physical lines by the usual backslash continuation
26804 mechanism. It is conventional to align the conditions vertically.
26805
26806
26807
26808 .section "ACL variables" "SECTaclvariables"
26809 .cindex "&ACL;" "variables"
26810 There are some special variables that can be set during ACL processing. They
26811 can be used to pass information between different ACLs, different invocations
26812 of the same ACL in the same SMTP connection, and between ACLs and the routers,
26813 transports, and filters that are used to deliver a message. The names of these
26814 variables must begin with &$acl_c$& or &$acl_m$&, followed either by a digit or
26815 an underscore, but the remainder of the name can be any sequence of
26816 alphanumeric characters and underscores that you choose. There is no limit on
26817 the number of ACL variables. The two sets act as follows:
26818 .ilist
26819 The values of those variables whose names begin with &$acl_c$& persist
26820 throughout an SMTP connection. They are never reset. Thus, a value that is set
26821 while receiving one message is still available when receiving the next message
26822 on the same SMTP connection.
26823 .next
26824 The values of those variables whose names begin with &$acl_m$& persist only
26825 while a message is being received. They are reset afterwards. They are also
26826 reset by MAIL, RSET, EHLO, HELO, and after starting up a TLS session.
26827 .endlist
26828
26829 When a message is accepted, the current values of all the ACL variables are
26830 preserved with the message and are subsequently made available at delivery
26831 time. The ACL variables are set by a modifier called &%set%&. For example:
26832 .code
26833 accept hosts = whatever
26834        set acl_m4 = some value
26835 accept authenticated = *
26836        set acl_c_auth = yes
26837 .endd
26838 &*Note*&: A leading dollar sign is not used when naming a variable that is to
26839 be set. If you want to set a variable without taking any action, you can use a
26840 &%warn%& verb without any other modifiers or conditions.
26841
26842 .oindex &%strict_acl_vars%&
26843 What happens if a syntactically valid but undefined ACL variable is
26844 referenced depends on the setting of the &%strict_acl_vars%& option. If it is
26845 false (the default), an empty string is substituted; if it is true, an
26846 error is generated.
26847
26848 Versions of Exim before 4.64 have a limited set of numbered variables, but
26849 their names are compatible, so there is no problem with upgrading.
26850
26851
26852 .section "Condition and modifier processing" "SECTcondmodproc"
26853 .cindex "&ACL;" "conditions; processing"
26854 .cindex "&ACL;" "modifiers; processing"
26855 An exclamation mark preceding a condition negates its result. For example:
26856 .code
26857 deny   domains = *.dom.example
26858       !verify  = recipient
26859 .endd
26860 causes the ACL to return &"deny"& if the recipient domain ends in
26861 &'dom.example'& and the recipient address cannot be verified. Sometimes
26862 negation can be used on the right-hand side of a condition. For example, these
26863 two statements are equivalent:
26864 .code
26865 deny  hosts = !192.168.3.4
26866 deny !hosts =  192.168.3.4
26867 .endd
26868 However, for many conditions (&%verify%& being a good example), only left-hand
26869 side negation of the whole condition is possible.
26870
26871 The arguments of conditions and modifiers are expanded. A forced failure
26872 of an expansion causes a condition to be ignored, that is, it behaves as if the
26873 condition is true. Consider these two statements:
26874 .code
26875 accept  senders = ${lookup{$host_name}lsearch\
26876                   {/some/file}{$value}fail}
26877 accept  senders = ${lookup{$host_name}lsearch\
26878                   {/some/file}{$value}{}}
26879 .endd
26880 Each attempts to look up a list of acceptable senders. If the lookup succeeds,
26881 the returned list is searched, but if the lookup fails the behaviour is
26882 different in the two cases. The &%fail%& in the first statement causes the
26883 condition to be ignored, leaving no further conditions. The &%accept%& verb
26884 therefore succeeds. The second statement, however, generates an empty list when
26885 the lookup fails. No sender can match an empty list, so the condition fails,
26886 and therefore the &%accept%& also fails.
26887
26888 ACL modifiers appear mixed in with conditions in ACL statements. Some of them
26889 specify actions that are taken as the conditions for a statement are checked;
26890 others specify text for messages that are used when access is denied or a
26891 warning is generated. The &%control%& modifier affects the way an incoming
26892 message is handled.
26893
26894 The positioning of the modifiers in an ACL statement is important, because the
26895 processing of a verb ceases as soon as its outcome is known. Only those
26896 modifiers that have already been encountered will take effect. For example,
26897 consider this use of the &%message%& modifier:
26898 .code
26899 require message = Can't verify sender
26900         verify  = sender
26901         message = Can't verify recipient
26902         verify  = recipient
26903         message = This message cannot be used
26904 .endd
26905 If sender verification fails, Exim knows that the result of the statement is
26906 &"deny"&, so it goes no further. The first &%message%& modifier has been seen,
26907 so its text is used as the error message. If sender verification succeeds, but
26908 recipient verification fails, the second message is used. If recipient
26909 verification succeeds, the third message becomes &"current"&, but is never used
26910 because there are no more conditions to cause failure.
26911
26912 For the &%deny%& verb, on the other hand, it is always the last &%message%&
26913 modifier that is used, because all the conditions must be true for rejection to
26914 happen. Specifying more than one &%message%& modifier does not make sense, and
26915 the message can even be specified after all the conditions. For example:
26916 .code
26917 deny   hosts = ...
26918       !senders = *@my.domain.example
26919        message = Invalid sender from client host
26920 .endd
26921 The &"deny"& result does not happen until the end of the statement is reached,
26922 by which time Exim has set up the message.
26923
26924
26925
26926 .section "ACL modifiers" "SECTACLmodi"
26927 .cindex "&ACL;" "modifiers; list of"
26928 The ACL modifiers are as follows:
26929
26930 .vlist
26931 .vitem &*add_header*&&~=&~<&'text'&>
26932 This modifier specifies one or more header lines that are to be added to an
26933 incoming message, assuming, of course, that the message is ultimately
26934 accepted. For details, see section &<<SECTaddheadacl>>&.
26935
26936 .vitem &*continue*&&~=&~<&'text'&>
26937 .cindex "&%continue%& ACL modifier"
26938 .cindex "database" "updating in ACL"
26939 This modifier does nothing of itself, and processing of the ACL always
26940 continues with the next condition or modifier. The value of &%continue%& is in
26941 the side effects of expanding its argument. Typically this could be used to
26942 update a database. It is really just a syntactic tidiness, to avoid having to
26943 write rather ugly lines like this:
26944 .display
26945 &`condition = ${if eq{0}{`&<&'some expansion'&>&`}{true}{true}}`&
26946 .endd
26947 Instead, all you need is
26948 .display
26949 &`continue = `&<&'some expansion'&>
26950 .endd
26951
26952 .vitem &*control*&&~=&~<&'text'&>
26953 .cindex "&%control%& ACL modifier"
26954 This modifier affects the subsequent processing of the SMTP connection or of an
26955 incoming message that is accepted. The effect of the first type of control
26956 lasts for the duration of the connection, whereas the effect of the second type
26957 lasts only until the current message has been received. The message-specific
26958 controls always apply to the whole message, not to individual recipients,
26959 even if the &%control%& modifier appears in a RCPT ACL.
26960
26961 As there are now quite a few controls that can be applied, they are described
26962 separately in section &<<SECTcontrols>>&. The &%control%& modifier can be used
26963 in several different ways. For example:
26964
26965 . ==== As this is a nested list, any displays it contains must be indented
26966 . ==== as otherwise they are too far to the left. That comment applies only
26967 . ==== when xmlto and fop are used; formatting with sdop gets it right either
26968 . ==== way.
26969
26970 .ilist
26971 It can be at the end of an &%accept%& statement:
26972 .code
26973     accept  ...some conditions
26974             control = queue_only
26975 .endd
26976 In this case, the control is applied when this statement yields &"accept"&, in
26977 other words, when the conditions are all true.
26978
26979 .next
26980 It can be in the middle of an &%accept%& statement:
26981 .code
26982     accept  ...some conditions...
26983             control = queue_only
26984             ...some more conditions...
26985 .endd
26986 If the first set of conditions are true, the control is applied, even if the
26987 statement does not accept because one of the second set of conditions is false.
26988 In this case, some subsequent statement must yield &"accept"& for the control
26989 to be relevant.
26990
26991 .next
26992 It can be used with &%warn%& to apply the control, leaving the
26993 decision about accepting or denying to a subsequent verb. For
26994 example:
26995 .code
26996     warn    ...some conditions...
26997             control = freeze
26998     accept  ...
26999 .endd
27000 This example of &%warn%& does not contain &%message%&, &%log_message%&, or
27001 &%logwrite%&, so it does not add anything to the message and does not write a
27002 log entry.
27003
27004 .next
27005 If you want to apply a control unconditionally, you can use it with a
27006 &%require%& verb. For example:
27007 .code
27008     require  control = no_multiline_responses
27009 .endd
27010 .endlist
27011
27012 .vitem &*delay*&&~=&~<&'time'&>
27013 .cindex "&%delay%& ACL modifier"
27014 .oindex "&%-bh%&"
27015 This modifier may appear in any ACL except notquit. It causes Exim to wait for
27016 the time interval before proceeding. However, when testing Exim using the
27017 &%-bh%& option, the delay is not actually imposed (an appropriate message is
27018 output instead). The time is given in the usual Exim notation, and the delay
27019 happens as soon as the modifier is processed. In an SMTP session, pending
27020 output is flushed before the delay is imposed.
27021
27022 Like &%control%&, &%delay%& can be used with &%accept%& or &%deny%&, for
27023 example:
27024 .code
27025 deny    ...some conditions...
27026         delay = 30s
27027 .endd
27028 The delay happens if all the conditions are true, before the statement returns
27029 &"deny"&. Compare this with:
27030 .code
27031 deny    delay = 30s
27032         ...some conditions...
27033 .endd
27034 which waits for 30s before processing the conditions. The &%delay%& modifier
27035 can also be used with &%warn%& and together with &%control%&:
27036 .code
27037 warn    ...some conditions...
27038         delay = 2m
27039         control = freeze
27040 accept  ...
27041 .endd
27042
27043 If &%delay%& is encountered when the SMTP PIPELINING extension is in use,
27044 responses to several commands are no longer buffered and sent in one packet (as
27045 they would normally be) because all output is flushed before imposing the
27046 delay. This optimization is disabled so that a number of small delays do not
27047 appear to the client as one large aggregated delay that might provoke an
27048 unwanted timeout. You can, however, disable output flushing for &%delay%& by
27049 using a &%control%& modifier to set &%no_delay_flush%&.
27050
27051
27052 .vitem &*endpass*&
27053 .cindex "&%endpass%& ACL modifier"
27054 This modifier, which has no argument, is recognized only in &%accept%& and
27055 &%discard%& statements. It marks the boundary between the conditions whose
27056 failure causes control to pass to the next statement, and the conditions whose
27057 failure causes the ACL to return &"deny"&. This concept has proved to be
27058 confusing to some people, so the use of &%endpass%& is no longer recommended as
27059 &"best practice"&. See the description of &%accept%& above for more details.
27060
27061
27062 .vitem &*log_message*&&~=&~<&'text'&>
27063 .cindex "&%log_message%& ACL modifier"
27064 This modifier sets up a message that is used as part of the log message if the
27065 ACL denies access or a &%warn%& statement's conditions are true. For example:
27066 .code
27067 require log_message = wrong cipher suite $tls_in_cipher
27068         encrypted   = DES-CBC3-SHA
27069 .endd
27070 &%log_message%& is also used when recipients are discarded by &%discard%&. For
27071 example:
27072 .display
27073 &`discard `&<&'some conditions'&>
27074 &`        log_message = Discarded $local_part@$domain because...`&
27075 .endd
27076 When access is denied, &%log_message%& adds to any underlying error message
27077 that may exist because of a condition failure. For example, while verifying a
27078 recipient address, a &':fail:'& redirection might have already set up a
27079 message.
27080
27081 The message may be defined before the conditions to which it applies, because
27082 the string expansion does not happen until Exim decides that access is to be
27083 denied. This means that any variables that are set by the condition are
27084 available for inclusion in the message. For example, the &$dnslist_$&<&'xxx'&>
27085 variables are set after a DNS black list lookup succeeds. If the expansion of
27086 &%log_message%& fails, or if the result is an empty string, the modifier is
27087 ignored.
27088
27089 .vindex "&$acl_verify_message$&"
27090 If you want to use a &%warn%& statement to log the result of an address
27091 verification, you can use &$acl_verify_message$& to include the verification
27092 error message.
27093
27094 If &%log_message%& is used with a &%warn%& statement, &"Warning:"& is added to
27095 the start of the logged message. If the same warning log message is requested
27096 more than once while receiving  a single email message, only one copy is
27097 actually logged. If you want to log multiple copies, use &%logwrite%& instead
27098 of &%log_message%&. In the absence of &%log_message%& and &%logwrite%&, nothing
27099 is logged for a successful &%warn%& statement.
27100
27101 If &%log_message%& is not present and there is no underlying error message (for
27102 example, from the failure of address verification), but &%message%& is present,
27103 the &%message%& text is used for logging rejections. However, if any text for
27104 logging contains newlines, only the first line is logged. In the absence of
27105 both &%log_message%& and &%message%&, a default built-in message is used for
27106 logging rejections.
27107
27108
27109 .vitem "&*log_reject_target*&&~=&~<&'log name list'&>"
27110 .cindex "&%log_reject_target%& ACL modifier"
27111 .cindex "logging in ACL" "specifying which log"
27112 This modifier makes it possible to specify which logs are used for messages
27113 about ACL rejections. Its argument is a colon-separated list of words that can
27114 be &"main"&, &"reject"&, or &"panic"&. The default is &`main:reject`&. The list
27115 may be empty, in which case a rejection is not logged at all. For example, this
27116 ACL fragment writes no logging information when access is denied:
27117 .display
27118 &`deny `&<&'some conditions'&>
27119 &`     log_reject_target =`&
27120 .endd
27121 This modifier can be used in SMTP and non-SMTP ACLs. It applies to both
27122 permanent and temporary rejections. Its effect lasts for the rest of the
27123 current ACL.
27124
27125
27126 .vitem &*logwrite*&&~=&~<&'text'&>
27127 .cindex "&%logwrite%& ACL modifier"
27128 .cindex "logging in ACL" "immediate"
27129 This modifier writes a message to a log file as soon as it is encountered when
27130 processing an ACL. (Compare &%log_message%&, which, except in the case of
27131 &%warn%& and &%discard%&, is used only if the ACL statement denies
27132 access.) The &%logwrite%& modifier can be used to log special incidents in
27133 ACLs. For example:
27134 .display
27135 &`accept `&<&'some special conditions'&>
27136 &`       control  = freeze`&
27137 &`       logwrite = froze message because ...`&
27138 .endd
27139 By default, the message is written to the main log. However, it may begin
27140 with a colon, followed by a comma-separated list of log names, and then
27141 another colon, to specify exactly which logs are to be written. For
27142 example:
27143 .code
27144 logwrite = :main,reject: text for main and reject logs
27145 logwrite = :panic: text for panic log only
27146 .endd
27147
27148
27149 .vitem &*message*&&~=&~<&'text'&>
27150 .cindex "&%message%& ACL modifier"
27151 This modifier sets up a text string that is expanded and used as a response
27152 message when an ACL statement terminates the ACL with an &"accept"&, &"deny"&,
27153 or &"defer"& response. (In the case of the &%accept%& and &%discard%& verbs,
27154 there is some complication if &%endpass%& is involved; see the description of
27155 &%accept%& for details.)
27156
27157 The expansion of the message happens at the time Exim decides that the ACL is
27158 to end, not at the time it processes &%message%&. If the expansion fails, or
27159 generates an empty string, the modifier is ignored. Here is an example where
27160 &%message%& must be specified first, because the ACL ends with a rejection if
27161 the &%hosts%& condition fails:
27162 .code
27163 require  message = Host not recognized
27164          hosts = 10.0.0.0/8
27165 .endd
27166 (Once a condition has failed, no further conditions or modifiers are
27167 processed.)
27168
27169 .cindex "SMTP" "error codes"
27170 .oindex "&%smtp_banner%&
27171 For ACLs that are triggered by SMTP commands, the message is returned as part
27172 of the SMTP response. The use of &%message%& with &%accept%& (or &%discard%&)
27173 is meaningful only for SMTP, as no message is returned when a non-SMTP message
27174 is accepted. In the case of the connect ACL, accepting with a message modifier
27175 overrides the value of &%smtp_banner%&. For the EHLO/HELO ACL, a customized
27176 accept message may not contain more than one line (otherwise it will be
27177 truncated at the first newline and a panic logged), and it cannot affect the
27178 EHLO options.
27179
27180 When SMTP is involved, the message may begin with an overriding response code,
27181 consisting of three digits optionally followed by an &"extended response code"&
27182 of the form &'n.n.n'&, each code being followed by a space. For example:
27183 .code
27184 deny  message = 599 1.2.3 Host not welcome
27185       hosts = 192.168.34.0/24
27186 .endd
27187 The first digit of the supplied response code must be the same as would be sent
27188 by default. A panic occurs if it is not. Exim uses a 550 code when it denies
27189 access, but for the predata ACL, note that the default success code is 354, not
27190 2&'xx'&.
27191
27192 Notwithstanding the previous paragraph, for the QUIT ACL, unlike the others,
27193 the message modifier cannot override the 221 response code.
27194
27195 The text in a &%message%& modifier is literal; any quotes are taken as
27196 literals, but because the string is expanded, backslash escapes are processed
27197 anyway. If the message contains newlines, this gives rise to a multi-line SMTP
27198 response.
27199
27200 .vindex "&$acl_verify_message$&"
27201 If &%message%& is used on a statement that verifies an address, the message
27202 specified overrides any message that is generated by the verification process.
27203 However, the original message is available in the variable
27204 &$acl_verify_message$&, so you can incorporate it into your message if you
27205 wish. In particular, if you want the text from &%:fail:%& items in &(redirect)&
27206 routers to be passed back as part of the SMTP response, you should either not
27207 use a &%message%& modifier, or make use of &$acl_verify_message$&.
27208
27209 For compatibility with previous releases of Exim, a &%message%& modifier that
27210 is used with a &%warn%& verb behaves in a similar way to the &%add_header%&
27211 modifier, but this usage is now deprecated. However, &%message%& acts only when
27212 all the conditions are true, wherever it appears in an ACL command, whereas
27213 &%add_header%& acts as soon as it is encountered. If &%message%& is used with
27214 &%warn%& in an ACL that is not concerned with receiving a message, it has no
27215 effect.
27216
27217
27218 .vitem &*remove_header*&&~=&~<&'text'&>
27219 This modifier specifies one or more header names in a colon-separated list
27220  that are to be removed from an incoming message, assuming, of course, that
27221 the message is ultimately accepted. For details, see section &<<SECTremoveheadacl>>&.
27222
27223
27224 .vitem &*set*&&~<&'acl_name'&>&~=&~<&'value'&>
27225 .cindex "&%set%& ACL modifier"
27226 This modifier puts a value into one of the ACL variables (see section
27227 &<<SECTaclvariables>>&).
27228
27229
27230 .vitem &*udpsend*&&~=&~<&'parameters'&>
27231 This modifier sends a UDP packet, for purposes such as statistics
27232 collection or behaviour monitoring. The parameters are expanded, and
27233 the result of the expansion must be a colon-separated list consisting
27234 of a destination server, port number, and the packet contents. The
27235 server can be specified as a host name or IPv4 or IPv6 address. The
27236 separator can be changed with the usual angle bracket syntax. For
27237 example, you might want to collect information on which hosts connect
27238 when:
27239 .code
27240 udpsend = <; 2001:dB8::dead:beef ; 1234 ;\
27241              $tod_zulu $sender_host_address
27242 .endd
27243 .endlist
27244
27245
27246
27247
27248 .section "Use of the control modifier" "SECTcontrols"
27249 .cindex "&%control%& ACL modifier"
27250 The &%control%& modifier supports the following settings:
27251
27252 .vlist
27253 .vitem &*control&~=&~allow_auth_unadvertised*&
27254 This modifier allows a client host to use the SMTP AUTH command even when it
27255 has not been advertised in response to EHLO. Furthermore, because there are
27256 apparently some really broken clients that do this, Exim will accept AUTH after
27257 HELO (rather than EHLO) when this control is set. It should be used only if you
27258 really need it, and you should limit its use to those broken clients that do
27259 not work without it. For example:
27260 .code
27261 warn hosts   = 192.168.34.25
27262      control = allow_auth_unadvertised
27263 .endd
27264 Normally, when an Exim server receives an AUTH command, it checks the name of
27265 the authentication mechanism that is given in the command to ensure that it
27266 matches an advertised mechanism. When this control is set, the check that a
27267 mechanism has been advertised is bypassed. Any configured mechanism can be used
27268 by the client. This control is permitted only in the connection and HELO ACLs.
27269
27270
27271 .vitem &*control&~=&~caseful_local_part*& &&&
27272        &*control&~=&~caselower_local_part*&
27273 .cindex "&ACL;" "case of local part in"
27274 .cindex "case of local parts"
27275 .vindex "&$local_part$&"
27276 These two controls are permitted only in the ACL specified by &%acl_smtp_rcpt%&
27277 (that is, during RCPT processing). By default, the contents of &$local_part$&
27278 are lower cased before ACL processing. If &"caseful_local_part"& is specified,
27279 any uppercase letters in the original local part are restored in &$local_part$&
27280 for the rest of the ACL, or until a control that sets &"caselower_local_part"&
27281 is encountered.
27282
27283 These controls affect only the current recipient. Moreover, they apply only to
27284 local part handling that takes place directly in the ACL (for example, as a key
27285 in lookups). If a test to verify the recipient is obeyed, the case-related
27286 handling of the local part during the verification is controlled by the router
27287 configuration (see the &%caseful_local_part%& generic router option).
27288
27289 This facility could be used, for example, to add a spam score to local parts
27290 containing upper case letters. For example, using &$acl_m4$& to accumulate the
27291 spam score:
27292 .code
27293 warn  control = caseful_local_part
27294       set acl_m4 = ${eval:\
27295                      $acl_m4 + \
27296                      ${if match{$local_part}{[A-Z]}{1}{0}}\
27297                     }
27298       control = caselower_local_part
27299 .endd
27300 Notice that we put back the lower cased version afterwards, assuming that
27301 is what is wanted for subsequent tests.
27302
27303
27304 .vitem &*control&~=&~cutthrough_delivery*&
27305 .cindex "&ACL;" "cutthrough routing"
27306 .cindex "cutthrough" "requesting"
27307 This option requests delivery be attempted while the item is being received.
27308 It is usable in the RCPT ACL and valid only for single-recipient mails forwarded
27309 from one SMTP connection to another.  If a recipient-verify callout connection is
27310 requested in the same ACL it is held open and used for the data, otherwise one is made
27311 after the ACL completes.
27312
27313 Note that routers are used in verify mode,
27314 and cannot depend on content of received headers.
27315 Note also that headers cannot be
27316 modified by any of the post-data ACLs (DATA, MIME and DKIM).
27317 Headers may be modified by routers (subject to the above) and transports.
27318
27319 Cutthrough delivery is not supported via transport-filters or when DKIM signing
27320 of outgoing messages is done, because it sends data to the ultimate destination
27321 before the entire message has been received from the source.
27322
27323 Should the ultimate destination system positively accept or reject the mail,
27324 a corresponding indication is given to the source system and nothing is queued.
27325 If there is a temporary error the item is queued for later delivery in the
27326 usual fashion. If the item is successfully delivered in cutthrough mode the log line
27327 is tagged with ">>" rather than "=>" and appears before the acceptance "<="
27328 line.
27329
27330 Delivery in this mode avoids the generation of a bounce mail to a (possibly faked)
27331 sender when the destination system is doing content-scan based rejection.
27332
27333
27334 .vitem &*control&~=&~debug/*&<&'options'&>
27335 .cindex "&ACL;" "enabling debug logging"
27336 .cindex "debugging" "enabling from an ACL"
27337 This control turns on debug logging, almost as though Exim had been invoked
27338 with &`-d`&, with the output going to a new logfile, by default called
27339 &'debuglog'&.  The filename can be adjusted with the &'tag'& option, which
27340 may access any variables already defined.  The logging may be adjusted with
27341 the &'opts'& option, which takes the same values as the &`-d`& command-line
27342 option.  Some examples (which depend on variables that don't exist in all
27343 contexts):
27344 .code
27345       control = debug
27346       control = debug/tag=.$sender_host_address
27347       control = debug/opts=+expand+acl
27348       control = debug/tag=.$message_exim_id/opts=+expand
27349 .endd
27350
27351
27352 .vitem &*control&~=&~dkim_disable_verify*&
27353 .cindex "disable DKIM verify"
27354 .cindex "DKIM" "disable verify"
27355 This control turns off DKIM verification processing entirely.  For details on
27356 the operation and configuration of DKIM, see chapter &<<CHAPdkim>>&.
27357
27358
27359 .vitem &*control&~=&~dscp/*&<&'value'&>
27360 .cindex "&ACL;" "setting DSCP value"
27361 .cindex "DSCP" "inbound"
27362 This option causes the DSCP value associated with the socket for the inbound
27363 connection to be adjusted to a given value, given as one of a number of fixed
27364 strings or to numeric value.
27365 The &%-bI:dscp%& option may be used to ask Exim which names it knows of.
27366 Common values include &`throughput`&, &`mincost`&, and on newer systems
27367 &`ef`&, &`af41`&, etc.  Numeric values may be in the range 0 to 0x3F.
27368
27369 The outbound packets from Exim will be marked with this value in the header
27370 (for IPv4, the TOS field; for IPv6, the TCLASS field); there is no guarantee
27371 that these values will have any effect, not be stripped by networking
27372 equipment, or do much of anything without cooperation with your Network
27373 Engineer and those of all network operators between the source and destination.
27374
27375
27376 .vitem &*control&~=&~enforce_sync*& &&&
27377        &*control&~=&~no_enforce_sync*&
27378 .cindex "SMTP" "synchronization checking"
27379 .cindex "synchronization checking in SMTP"
27380 These controls make it possible to be selective about when SMTP synchronization
27381 is enforced. The global option &%smtp_enforce_sync%& specifies the initial
27382 state of the switch (it is true by default). See the description of this option
27383 in chapter &<<CHAPmainconfig>>& for details of SMTP synchronization checking.
27384
27385 The effect of these two controls lasts for the remainder of the SMTP
27386 connection. They can appear in any ACL except the one for the non-SMTP
27387 messages. The most straightforward place to put them is in the ACL defined by
27388 &%acl_smtp_connect%&, which is run at the start of an incoming SMTP connection,
27389 before the first synchronization check. The expected use is to turn off the
27390 synchronization checks for badly-behaved hosts that you nevertheless need to
27391 work with.
27392
27393
27394 .vitem &*control&~=&~fakedefer/*&<&'message'&>
27395 .cindex "fake defer"
27396 .cindex "defer, fake"
27397 This control works in exactly the same way as &%fakereject%& (described below)
27398 except that it causes an SMTP 450 response after the message data instead of a
27399 550 response. You must take care when using &%fakedefer%& because it causes the
27400 messages to be duplicated when the sender retries. Therefore, you should not
27401 use &%fakedefer%& if the message is to be delivered normally.
27402
27403 .vitem &*control&~=&~fakereject/*&<&'message'&>
27404 .cindex "fake rejection"
27405 .cindex "rejection, fake"
27406 This control is permitted only for the MAIL, RCPT, and DATA ACLs, in other
27407 words, only when an SMTP message is being received. If Exim accepts the
27408 message, instead the final 250 response, a 550 rejection message is sent.
27409 However, Exim proceeds to deliver the message as normal. The control applies
27410 only to the current message, not to any subsequent ones that may be received in
27411 the same SMTP connection.
27412
27413 The text for the 550 response is taken from the &%control%& modifier. If no
27414 message is supplied, the following is used:
27415 .code
27416 550-Your message has been rejected but is being
27417 550-kept for evaluation.
27418 550-If it was a legitimate message, it may still be
27419 550 delivered to the target recipient(s).
27420 .endd
27421 This facility should be used with extreme caution.
27422
27423 .vitem &*control&~=&~freeze*&
27424 .cindex "frozen messages" "forcing in ACL"
27425 This control is permitted only for the MAIL, RCPT, DATA, and non-SMTP ACLs, in
27426 other words, only when a message is being received. If the message is accepted,
27427 it is placed on Exim's queue and frozen. The control applies only to the
27428 current message, not to any subsequent ones that may be received in the same
27429 SMTP connection.
27430
27431 This modifier can optionally be followed by &`/no_tell`&. If the global option
27432 &%freeze_tell%& is set, it is ignored for the current message (that is, nobody
27433 is told about the freezing), provided all the &*control=freeze*& modifiers that
27434 are obeyed for the current message have the &`/no_tell`& option.
27435
27436 .vitem &*control&~=&~no_delay_flush*&
27437 .cindex "SMTP" "output flushing, disabling for delay"
27438 Exim normally flushes SMTP output before implementing a delay in an ACL, to
27439 avoid unexpected timeouts in clients when the SMTP PIPELINING extension is in
27440 use. This control, as long as it is encountered before the &%delay%& modifier,
27441 disables such output flushing.
27442
27443 .vitem &*control&~=&~no_callout_flush*&
27444 .cindex "SMTP" "output flushing, disabling for callout"
27445 Exim normally flushes SMTP output before performing a callout in an ACL, to
27446 avoid unexpected timeouts in clients when the SMTP PIPELINING extension is in
27447 use. This control, as long as it is encountered before the &%verify%& condition
27448 that causes the callout, disables such output flushing.
27449
27450 .vitem &*control&~=&~no_mbox_unspool*&
27451 This control is available when Exim is compiled with the content scanning
27452 extension. Content scanning may require a copy of the current message, or parts
27453 of it, to be written in &"mbox format"& to a spool file, for passing to a virus
27454 or spam scanner. Normally, such copies are deleted when they are no longer
27455 needed. If this control is set, the copies are not deleted. The control applies
27456 only to the current message, not to any subsequent ones that may be received in
27457 the same SMTP connection. It is provided for debugging purposes and is unlikely
27458 to be useful in production.
27459
27460 .vitem &*control&~=&~no_multiline_responses*&
27461 .cindex "multiline responses, suppressing"
27462 This control is permitted for any ACL except the one for non-SMTP messages.
27463 It seems that there are broken clients in use that cannot handle multiline
27464 SMTP responses, despite the fact that RFC 821 defined them over 20 years ago.
27465
27466 If this control is set, multiline SMTP responses from ACL rejections are
27467 suppressed. One way of doing this would have been to put out these responses as
27468 one long line. However, RFC 2821 specifies a maximum of 512 bytes per response
27469 (&"use multiline responses for more"& it says &-- ha!), and some of the
27470 responses might get close to that. So this facility, which is after all only a
27471 sop to broken clients, is implemented by doing two very easy things:
27472
27473 .ilist
27474 Extra information that is normally output as part of a rejection caused by
27475 sender verification failure is omitted. Only the final line (typically &"sender
27476 verification failed"&) is sent.
27477 .next
27478 If a &%message%& modifier supplies a multiline response, only the first
27479 line is output.
27480 .endlist
27481
27482 The setting of the switch can, of course, be made conditional on the
27483 calling host. Its effect lasts until the end of the SMTP connection.
27484
27485 .vitem &*control&~=&~no_pipelining*&
27486 .cindex "PIPELINING" "suppressing advertising"
27487 This control turns off the advertising of the PIPELINING extension to SMTP in
27488 the current session. To be useful, it must be obeyed before Exim sends its
27489 response to an EHLO command. Therefore, it should normally appear in an ACL
27490 controlled by &%acl_smtp_connect%& or &%acl_smtp_helo%&. See also
27491 &%pipelining_advertise_hosts%&.
27492
27493 .vitem &*control&~=&~queue_only*&
27494 .oindex "&%queue_only%&"
27495 .cindex "queueing incoming messages"
27496 This control is permitted only for the MAIL, RCPT, DATA, and non-SMTP ACLs, in
27497 other words, only when a message is being received. If the message is accepted,
27498 it is placed on Exim's queue and left there for delivery by a subsequent queue
27499 runner. No immediate delivery process is started. In other words, it has the
27500 effect as the &%queue_only%& global option. However, the control applies only
27501 to the current message, not to any subsequent ones that may be received in the
27502 same SMTP connection.
27503
27504 .vitem &*control&~=&~submission/*&<&'options'&>
27505 .cindex "message" "submission"
27506 .cindex "submission mode"
27507 This control is permitted only for the MAIL, RCPT, and start of data ACLs (the
27508 latter is the one defined by &%acl_smtp_predata%&). Setting it tells Exim that
27509 the current message is a submission from a local MUA. In this case, Exim
27510 operates in &"submission mode"&, and applies certain fixups to the message if
27511 necessary. For example, it adds a &'Date:'& header line if one is not present.
27512 This control is not permitted in the &%acl_smtp_data%& ACL, because that is too
27513 late (the message has already been created).
27514
27515 Chapter &<<CHAPmsgproc>>& describes the processing that Exim applies to
27516 messages. Section &<<SECTsubmodnon>>& covers the processing that happens in
27517 submission mode; the available options for this control are described there.
27518 The control applies only to the current message, not to any subsequent ones
27519 that may be received in the same SMTP connection.
27520
27521 .vitem &*control&~=&~suppress_local_fixups*&
27522 .cindex "submission fixups, suppressing"
27523 This control applies to locally submitted (non TCP/IP) messages, and is the
27524 complement of &`control = submission`&. It disables the fixups that are
27525 normally applied to locally-submitted messages. Specifically:
27526
27527 .ilist
27528 Any &'Sender:'& header line is left alone (in this respect, it is a
27529 dynamic version of &%local_sender_retain%&).
27530 .next
27531 No &'Message-ID:'&, &'From:'&, or &'Date:'& header lines are added.
27532 .next
27533 There is no check that &'From:'& corresponds to the actual sender.
27534 .endlist ilist
27535
27536 This control may be useful when a remotely-originated message is accepted,
27537 passed to some scanning program, and then re-submitted for delivery. It can be
27538 used only in the &%acl_smtp_mail%&, &%acl_smtp_rcpt%&, &%acl_smtp_predata%&,
27539 and &%acl_not_smtp_start%& ACLs, because it has to be set before the message's
27540 data is read.
27541
27542 &*Note:*& This control applies only to the current message, not to any others
27543 that are being submitted at the same time using &%-bs%& or &%-bS%&.
27544 .endlist vlist
27545
27546
27547 .section "Summary of message fixup control" "SECTsummesfix"
27548 All four possibilities for message fixups can be specified:
27549
27550 .ilist
27551 Locally submitted, fixups applied: the default.
27552 .next
27553 Locally submitted, no fixups applied: use
27554 &`control = suppress_local_fixups`&.
27555 .next
27556 Remotely submitted, no fixups applied: the default.
27557 .next
27558 Remotely submitted, fixups applied: use &`control = submission`&.
27559 .endlist
27560
27561
27562
27563 .section "Adding header lines in ACLs" "SECTaddheadacl"
27564 .cindex "header lines" "adding in an ACL"
27565 .cindex "header lines" "position of added lines"
27566 .cindex "&%add_header%& ACL modifier"
27567 The &%add_header%& modifier can be used to add one or more extra header lines
27568 to an incoming message, as in this example:
27569 .code
27570 warn dnslists = sbl.spamhaus.org : \
27571                 dialup.mail-abuse.org
27572      add_header = X-blacklisted-at: $dnslist_domain
27573 .endd
27574 The &%add_header%& modifier is permitted in the MAIL, RCPT, PREDATA, DATA,
27575 MIME, DKIM, and non-SMTP ACLs (in other words, those that are concerned with
27576 receiving a message). The message must ultimately be accepted for
27577 &%add_header%& to have any significant effect. You can use &%add_header%& with
27578 any ACL verb, including &%deny%& (though this is potentially useful only in a
27579 RCPT ACL).
27580
27581 Headers will not be added to the message if the modifier is used in
27582 DATA, MIME or DKIM ACLs for messages delivered by cutthrough routing.
27583
27584 Leading and trailing newlines are removed from
27585 the data for the &%add_header%& modifier; if it then
27586 contains one or more newlines that
27587 are not followed by a space or a tab, it is assumed to contain multiple header
27588 lines. Each one is checked for valid syntax; &`X-ACL-Warn:`& is added to the
27589 front of any line that is not a valid header line.
27590
27591 Added header lines are accumulated during the MAIL, RCPT, and predata ACLs.
27592 They are added to the message before processing the DATA and MIME ACLs.
27593 However, if an identical header line is requested more than once, only one copy
27594 is actually added to the message. Further header lines may be accumulated
27595 during the DATA and MIME ACLs, after which they are added to the message, again
27596 with duplicates suppressed. Thus, it is possible to add two identical header
27597 lines to an SMTP message, but only if one is added before DATA and one after.
27598 In the case of non-SMTP messages, new headers are accumulated during the
27599 non-SMTP ACLs, and are added to the message after all the ACLs have run. If a
27600 message is rejected after DATA or by the non-SMTP ACL, all added header lines
27601 are included in the entry that is written to the reject log.
27602
27603 .cindex "header lines" "added; visibility of"
27604 Header lines are not visible in string expansions
27605 of message headers
27606 until they are added to the
27607 message. It follows that header lines defined in the MAIL, RCPT, and predata
27608 ACLs are not visible until the DATA ACL and MIME ACLs are run. Similarly,
27609 header lines that are added by the DATA or MIME ACLs are not visible in those
27610 ACLs. Because of this restriction, you cannot use header lines as a way of
27611 passing data between (for example) the MAIL and RCPT ACLs. If you want to do
27612 this, you can use ACL variables, as described in section
27613 &<<SECTaclvariables>>&.
27614
27615 The list of headers yet to be added is given by the &%$headers_added%& variable.
27616
27617 The &%add_header%& modifier acts immediately as it is encountered during the
27618 processing of an ACL. Notice the difference between these two cases:
27619 .display
27620 &`accept add_header = ADDED: some text`&
27621 &`       `&<&'some condition'&>
27622
27623 &`accept `&<&'some condition'&>
27624 &`       add_header = ADDED: some text`&
27625 .endd
27626 In the first case, the header line is always added, whether or not the
27627 condition is true. In the second case, the header line is added only if the
27628 condition is true. Multiple occurrences of &%add_header%& may occur in the same
27629 ACL statement. All those that are encountered before a condition fails are
27630 honoured.
27631
27632 .cindex "&%warn%& ACL verb"
27633 For compatibility with previous versions of Exim, a &%message%& modifier for a
27634 &%warn%& verb acts in the same way as &%add_header%&, except that it takes
27635 effect only if all the conditions are true, even if it appears before some of
27636 them. Furthermore, only the last occurrence of &%message%& is honoured. This
27637 usage of &%message%& is now deprecated. If both &%add_header%& and &%message%&
27638 are present on a &%warn%& verb, both are processed according to their
27639 specifications.
27640
27641 By default, new header lines are added to a message at the end of the existing
27642 header lines. However, you can specify that any particular header line should
27643 be added right at the start (before all the &'Received:'& lines), immediately
27644 after the first block of &'Received:'& lines, or immediately before any line
27645 that is not a &'Received:'& or &'Resent-something:'& header.
27646
27647 This is done by specifying &":at_start:"&, &":after_received:"&, or
27648 &":at_start_rfc:"& (or, for completeness, &":at_end:"&) before the text of the
27649 header line, respectively. (Header text cannot start with a colon, as there has
27650 to be a header name first.) For example:
27651 .code
27652 warn add_header = \
27653        :after_received:X-My-Header: something or other...
27654 .endd
27655 If more than one header line is supplied in a single &%add_header%& modifier,
27656 each one is treated independently and can therefore be placed differently. If
27657 you add more than one line at the start, or after the Received: block, they end
27658 up in reverse order.
27659
27660 &*Warning*&: This facility currently applies only to header lines that are
27661 added in an ACL. It does NOT work for header lines that are added in a
27662 system filter or in a router or transport.
27663
27664
27665
27666 .section "Removing header lines in ACLs" "SECTremoveheadacl"
27667 .cindex "header lines" "removing in an ACL"
27668 .cindex "header lines" "position of removed lines"
27669 .cindex "&%remove_header%& ACL modifier"
27670 The &%remove_header%& modifier can be used to remove one or more header lines
27671 from an incoming message, as in this example:
27672 .code
27673 warn   message        = Remove internal headers
27674        remove_header  = x-route-mail1 : x-route-mail2
27675 .endd
27676 The &%remove_header%& modifier is permitted in the MAIL, RCPT, PREDATA, DATA,
27677 MIME, DKIM, and non-SMTP ACLs (in other words, those that are concerned with
27678 receiving a message). The message must ultimately be accepted for
27679 &%remove_header%& to have any significant effect. You can use &%remove_header%&
27680 with any ACL verb, including &%deny%&, though this is really not useful for
27681 any verb that doesn't result in a delivered message.
27682
27683 Headers will not be removed to the message if the modifier is used in
27684 DATA, MIME or DKIM ACLs for messages delivered by cutthrough routing.
27685
27686 More than one header can be removed at the same time by using a colon separated
27687 list of header names. The header matching is case insensitive. Wildcards are
27688 not permitted, nor is list expansion performed, so you cannot use hostlists to
27689 create a list of headers, however both connection and message variable expansion
27690 are performed (&%$acl_c_*%& and &%$acl_m_*%&), illustrated in this example:
27691 .code
27692 warn   hosts           = +internal_hosts
27693        set acl_c_ihdrs = x-route-mail1 : x-route-mail2
27694 warn   message         = Remove internal headers
27695        remove_header   = $acl_c_ihdrs
27696 .endd
27697 Removed header lines are accumulated during the MAIL, RCPT, and predata ACLs.
27698 They are removed from the message before processing the DATA and MIME ACLs.
27699 There is no harm in attempting to remove the same header twice nor is removing
27700 a non-existent header. Further header lines to be removed may be accumulated
27701 during the DATA and MIME ACLs, after which they are removed from the message,
27702 if present. In the case of non-SMTP messages, headers to be removed are
27703 accumulated during the non-SMTP ACLs, and are removed from the message after
27704 all the ACLs have run. If a message is rejected after DATA or by the non-SMTP
27705 ACL, there really is no effect because there is no logging of what headers
27706 would have been removed.
27707
27708 .cindex "header lines" "removed; visibility of"
27709 Header lines are not visible in string expansions until the DATA phase when it
27710 is received. Any header lines removed in the MAIL, RCPT, and predata ACLs are
27711 not visible in the DATA ACL and MIME ACLs. Similarly, header lines that are
27712 removed by the DATA or MIME ACLs are still visible in those ACLs. Because of
27713 this restriction, you cannot use header lines as a way of controlling data
27714 passed between (for example) the MAIL and RCPT ACLs. If you want to do this,
27715 you should instead use ACL variables, as described in section
27716 &<<SECTaclvariables>>&.
27717
27718 The &%remove_header%& modifier acts immediately as it is encountered during the
27719 processing of an ACL. Notice the difference between these two cases:
27720 .display
27721 &`accept remove_header = X-Internal`&
27722 &`       `&<&'some condition'&>
27723
27724 &`accept `&<&'some condition'&>
27725 &`       remove_header = X-Internal`&
27726 .endd
27727 In the first case, the header line is always removed, whether or not the
27728 condition is true. In the second case, the header line is removed only if the
27729 condition is true. Multiple occurrences of &%remove_header%& may occur in the
27730 same ACL statement. All those that are encountered before a condition fails
27731 are honoured.
27732
27733 &*Warning*&: This facility currently applies only to header lines that are
27734 present during ACL processing. It does NOT remove header lines that are added
27735 in a system filter or in a router or transport.
27736
27737
27738
27739
27740 .section "ACL conditions" "SECTaclconditions"
27741 .cindex "&ACL;" "conditions; list of"
27742 Some of the conditions listed in this section are available only when Exim is
27743 compiled with the content-scanning extension. They are included here briefly
27744 for completeness. More detailed descriptions can be found in the discussion on
27745 content scanning in chapter &<<CHAPexiscan>>&.
27746
27747 Not all conditions are relevant in all circumstances. For example, testing
27748 senders and recipients does not make sense in an ACL that is being run as the
27749 result of the arrival of an ETRN command, and checks on message headers can be
27750 done only in the ACLs specified by &%acl_smtp_data%& and &%acl_not_smtp%&. You
27751 can use the same condition (with different parameters) more than once in the
27752 same ACL statement. This provides a way of specifying an &"and"& conjunction.
27753 The conditions are as follows:
27754
27755
27756 .vlist
27757 .vitem &*acl&~=&~*&<&'name&~of&~acl&~or&~ACL&~string&~or&~file&~name&~'&>
27758 .cindex "&ACL;" "nested"
27759 .cindex "&ACL;" "indirect"
27760 .cindex "&ACL;" "arguments"
27761 .cindex "&%acl%& ACL condition"
27762 The possible values of the argument are the same as for the
27763 &%acl_smtp_%&&'xxx'& options. The named or inline ACL is run. If it returns
27764 &"accept"& the condition is true; if it returns &"deny"& the condition is
27765 false. If it returns &"defer"&, the current ACL returns &"defer"& unless the
27766 condition is on a &%warn%& verb. In that case, a &"defer"& return makes the
27767 condition false. This means that further processing of the &%warn%& verb
27768 ceases, but processing of the ACL continues.
27769
27770 If the argument is a named ACL, up to nine space-separated optional values
27771 can be appended; they appear within the called ACL in $acl_arg1 to $acl_arg9,
27772 and $acl_narg is set to the count of values.
27773 Previous values of these variables are restored after the call returns.
27774 The name and values are expanded separately.
27775
27776 If the nested &%acl%& returns &"drop"& and the outer condition denies access,
27777 the connection is dropped. If it returns &"discard"&, the verb must be
27778 &%accept%& or &%discard%&, and the action is taken immediately &-- no further
27779 conditions are tested.
27780
27781 ACLs may be nested up to 20 deep; the limit exists purely to catch runaway
27782 loops. This condition allows you to use different ACLs in different
27783 circumstances. For example, different ACLs can be used to handle RCPT commands
27784 for different local users or different local domains.
27785
27786 .vitem &*authenticated&~=&~*&<&'string&~list'&>
27787 .cindex "&%authenticated%& ACL condition"
27788 .cindex "authentication" "ACL checking"
27789 .cindex "&ACL;" "testing for authentication"
27790 If the SMTP connection is not authenticated, the condition is false. Otherwise,
27791 the name of the authenticator is tested against the list. To test for
27792 authentication by any authenticator, you can set
27793 .code
27794 authenticated = *
27795 .endd
27796
27797 .vitem &*condition&~=&~*&<&'string'&>
27798 .cindex "&%condition%& ACL condition"
27799 .cindex "customizing" "ACL condition"
27800 .cindex "&ACL;" "customized test"
27801 .cindex "&ACL;" "testing, customized"
27802 This feature allows you to make up custom conditions. If the result of
27803 expanding the string is an empty string, the number zero, or one of the strings
27804 &"no"& or &"false"&, the condition is false. If the result is any non-zero
27805 number, or one of the strings &"yes"& or &"true"&, the condition is true. For
27806 any other value, some error is assumed to have occurred, and the ACL returns
27807 &"defer"&. However, if the expansion is forced to fail, the condition is
27808 ignored. The effect is to treat it as true, whether it is positive or
27809 negative.
27810
27811 .vitem &*decode&~=&~*&<&'location'&>
27812 .cindex "&%decode%& ACL condition"
27813 This condition is available only when Exim is compiled with the
27814 content-scanning extension, and it is allowed only in the ACL defined by
27815 &%acl_smtp_mime%&. It causes the current MIME part to be decoded into a file.
27816 If all goes well, the condition is true. It is false only if there are
27817 problems such as a syntax error or a memory shortage. For more details, see
27818 chapter &<<CHAPexiscan>>&.
27819
27820 .vitem &*demime&~=&~*&<&'extension&~list'&>
27821 .cindex "&%demime%& ACL condition"
27822 This condition is available only when Exim is compiled with the
27823 content-scanning extension. Its use is described in section
27824 &<<SECTdemimecond>>&.
27825
27826 .vitem &*dnslists&~=&~*&<&'list&~of&~domain&~names&~and&~other&~data'&>
27827 .cindex "&%dnslists%& ACL condition"
27828 .cindex "DNS list" "in ACL"
27829 .cindex "black list (DNS)"
27830 .cindex "&ACL;" "testing a DNS list"
27831 This condition checks for entries in DNS black lists. These are also known as
27832 &"RBL lists"&, after the original Realtime Blackhole List, but note that the
27833 use of the lists at &'mail-abuse.org'& now carries a charge. There are too many
27834 different variants of this condition to describe briefly here. See sections
27835 &<<SECTmorednslists>>&&--&<<SECTmorednslistslast>>& for details.
27836
27837 .vitem &*domains&~=&~*&<&'domain&~list'&>
27838 .cindex "&%domains%& ACL condition"
27839 .cindex "domain" "ACL checking"
27840 .cindex "&ACL;" "testing a recipient domain"
27841 .vindex "&$domain_data$&"
27842 This condition is relevant only after a RCPT command. It checks that the domain
27843 of the recipient address is in the domain list. If percent-hack processing is
27844 enabled, it is done before this test is done. If the check succeeds with a
27845 lookup, the result of the lookup is placed in &$domain_data$& until the next
27846 &%domains%& test.
27847
27848 &*Note carefully*& (because many people seem to fall foul of this): you cannot
27849 use &%domains%& in a DATA ACL.
27850
27851
27852 .vitem &*encrypted&~=&~*&<&'string&~list'&>
27853 .cindex "&%encrypted%& ACL condition"
27854 .cindex "encryption" "checking in an ACL"
27855 .cindex "&ACL;" "testing for encryption"
27856 If the SMTP connection is not encrypted, the condition is false. Otherwise, the
27857 name of the cipher suite in use is tested against the list. To test for
27858 encryption without testing for any specific cipher suite(s), set
27859 .code
27860 encrypted = *
27861 .endd
27862
27863
27864 .vitem &*hosts&~=&~*&<&'host&~list'&>
27865 .cindex "&%hosts%& ACL condition"
27866 .cindex "host" "ACL checking"
27867 .cindex "&ACL;" "testing the client host"
27868 This condition tests that the calling host matches the host list. If you have
27869 name lookups or wildcarded host names and IP addresses in the same host list,
27870 you should normally put the IP addresses first. For example, you could have:
27871 .code
27872 accept hosts = 10.9.8.7 : dbm;/etc/friendly/hosts
27873 .endd
27874 The lookup in this example uses the host name for its key. This is implied by
27875 the lookup type &"dbm"&. (For a host address lookup you would use &"net-dbm"&
27876 and it wouldn't matter which way round you had these two items.)
27877
27878 The reason for the problem with host names lies in the left-to-right way that
27879 Exim processes lists. It can test IP addresses without doing any DNS lookups,
27880 but when it reaches an item that requires a host name, it fails if it cannot
27881 find a host name to compare with the pattern. If the above list is given in the
27882 opposite order, the &%accept%& statement fails for a host whose name cannot be
27883 found, even if its IP address is 10.9.8.7.
27884
27885 If you really do want to do the name check first, and still recognize the IP
27886 address even if the name lookup fails, you can rewrite the ACL like this:
27887 .code
27888 accept hosts = dbm;/etc/friendly/hosts
27889 accept hosts = 10.9.8.7
27890 .endd
27891 The default action on failing to find the host name is to assume that the host
27892 is not in the list, so the first &%accept%& statement fails. The second
27893 statement can then check the IP address.
27894
27895 .vindex "&$host_data$&"
27896 If a &%hosts%& condition is satisfied by means of a lookup, the result
27897 of the lookup is made available in the &$host_data$& variable. This
27898 allows you, for example, to set up a statement like this:
27899 .code
27900 deny  hosts = net-lsearch;/some/file
27901 message = $host_data
27902 .endd
27903 which gives a custom error message for each denied host.
27904
27905 .vitem &*local_parts&~=&~*&<&'local&~part&~list'&>
27906 .cindex "&%local_parts%& ACL condition"
27907 .cindex "local part" "ACL checking"
27908 .cindex "&ACL;" "testing a local part"
27909 .vindex "&$local_part_data$&"
27910 This condition is relevant only after a RCPT command. It checks that the local
27911 part of the recipient address is in the list. If percent-hack processing is
27912 enabled, it is done before this test. If the check succeeds with a lookup, the
27913 result of the lookup is placed in &$local_part_data$&, which remains set until
27914 the next &%local_parts%& test.
27915
27916 .vitem &*malware&~=&~*&<&'option'&>
27917 .cindex "&%malware%& ACL condition"
27918 .cindex "&ACL;" "virus scanning"
27919 .cindex "&ACL;" "scanning for viruses"
27920 This condition is available only when Exim is compiled with the
27921 content-scanning extension. It causes the incoming message to be scanned for
27922 viruses. For details, see chapter &<<CHAPexiscan>>&.
27923
27924 .vitem &*mime_regex&~=&~*&<&'list&~of&~regular&~expressions'&>
27925 .cindex "&%mime_regex%& ACL condition"
27926 .cindex "&ACL;" "testing by regex matching"
27927 This condition is available only when Exim is compiled with the
27928 content-scanning extension, and it is allowed only in the ACL defined by
27929 &%acl_smtp_mime%&. It causes the current MIME part to be scanned for a match
27930 with any of the regular expressions. For details, see chapter
27931 &<<CHAPexiscan>>&.
27932
27933 .vitem &*ratelimit&~=&~*&<&'parameters'&>
27934 .cindex "rate limiting"
27935 This condition can be used to limit the rate at which a user or host submits
27936 messages. Details are given in section &<<SECTratelimiting>>&.
27937
27938 .vitem &*recipients&~=&~*&<&'address&~list'&>
27939 .cindex "&%recipients%& ACL condition"
27940 .cindex "recipient" "ACL checking"
27941 .cindex "&ACL;" "testing a recipient"
27942 This condition is relevant only after a RCPT command. It checks the entire
27943 recipient address against a list of recipients.
27944
27945 .vitem &*regex&~=&~*&<&'list&~of&~regular&~expressions'&>
27946 .cindex "&%regex%& ACL condition"
27947 .cindex "&ACL;" "testing by regex matching"
27948 This condition is available only when Exim is compiled with the
27949 content-scanning extension, and is available only in the DATA, MIME, and
27950 non-SMTP ACLs. It causes the incoming message to be scanned for a match with
27951 any of the regular expressions. For details, see chapter &<<CHAPexiscan>>&.
27952
27953 .vitem &*sender_domains&~=&~*&<&'domain&~list'&>
27954 .cindex "&%sender_domains%& ACL condition"
27955 .cindex "sender" "ACL checking"
27956 .cindex "&ACL;" "testing a sender domain"
27957 .vindex "&$domain$&"
27958 .vindex "&$sender_address_domain$&"
27959 This condition tests the domain of the sender of the message against the given
27960 domain list. &*Note*&: The domain of the sender address is in
27961 &$sender_address_domain$&. It is &'not'& put in &$domain$& during the testing
27962 of this condition. This is an exception to the general rule for testing domain
27963 lists. It is done this way so that, if this condition is used in an ACL for a
27964 RCPT command, the recipient's domain (which is in &$domain$&) can be used to
27965 influence the sender checking.
27966
27967 &*Warning*&: It is a bad idea to use this condition on its own as a control on
27968 relaying, because sender addresses are easily, and commonly, forged.
27969
27970 .vitem &*senders&~=&~*&<&'address&~list'&>
27971 .cindex "&%senders%& ACL condition"
27972 .cindex "sender" "ACL checking"
27973 .cindex "&ACL;" "testing a sender"
27974 This condition tests the sender of the message against the given list. To test
27975 for a bounce message, which has an empty sender, set
27976 .code
27977 senders = :
27978 .endd
27979 &*Warning*&: It is a bad idea to use this condition on its own as a control on
27980 relaying, because sender addresses are easily, and commonly, forged.
27981
27982 .vitem &*spam&~=&~*&<&'username'&>
27983 .cindex "&%spam%& ACL condition"
27984 .cindex "&ACL;" "scanning for spam"
27985 This condition is available only when Exim is compiled with the
27986 content-scanning extension. It causes the incoming message to be scanned by
27987 SpamAssassin. For details, see chapter &<<CHAPexiscan>>&.
27988
27989 .vitem &*verify&~=&~certificate*&
27990 .cindex "&%verify%& ACL condition"
27991 .cindex "TLS" "client certificate verification"
27992 .cindex "certificate" "verification of client"
27993 .cindex "&ACL;" "certificate verification"
27994 .cindex "&ACL;" "testing a TLS certificate"
27995 This condition is true in an SMTP session if the session is encrypted, and a
27996 certificate was received from the client, and the certificate was verified. The
27997 server requests a certificate only if the client matches &%tls_verify_hosts%&
27998 or &%tls_try_verify_hosts%& (see chapter &<<CHAPTLS>>&).
27999
28000 .vitem &*verify&~=&~csa*&
28001 .cindex "CSA verification"
28002 This condition checks whether the sending host (the client) is authorized to
28003 send email. Details of how this works are given in section
28004 &<<SECTverifyCSA>>&.
28005
28006 .new
28007 .vitem &*verify&~=&~header_names_ascii*&
28008 .cindex "&%verify%& ACL condition"
28009 .cindex "&ACL;" "verifying header names only ASCII"
28010 .cindex "header lines" "verifying header names only ASCII"
28011 .cindex "verifying" "header names only ASCII"
28012 This condition is relevant only in an ACL that is run after a message has been
28013 received, that is, in an ACL specified by &%acl_smtp_data%& or
28014 &%acl_not_smtp%&.  It checks all header names (not the content) to make sure
28015 there are no non-ASCII characters, also excluding control characters.  The
28016 allowable characters are decimal ASCII values 33 through 126.
28017
28018 Exim itself will handle headers with non-ASCII characters, but it can cause
28019 problems for downstream applications, so this option will allow their
28020 detection and rejection in the DATA ACL's.
28021 .wen
28022
28023 .vitem &*verify&~=&~header_sender/*&<&'options'&>
28024 .cindex "&%verify%& ACL condition"
28025 .cindex "&ACL;" "verifying sender in the header"
28026 .cindex "header lines" "verifying the sender in"
28027 .cindex "sender" "verifying in header"
28028 .cindex "verifying" "sender in header"
28029 This condition is relevant only in an ACL that is run after a message has been
28030 received, that is, in an ACL specified by &%acl_smtp_data%& or
28031 &%acl_not_smtp%&. It checks that there is a verifiable address in at least one
28032 of the &'Sender:'&, &'Reply-To:'&, or &'From:'& header lines. Such an address
28033 is loosely thought of as a &"sender"& address (hence the name of the test).
28034 However, an address that appears in one of these headers need not be an address
28035 that accepts bounce messages; only sender addresses in envelopes are required
28036 to accept bounces. Therefore, if you use the callout option on this check, you
28037 might want to arrange for a non-empty address in the MAIL command.
28038
28039 Details of address verification and the options are given later, starting at
28040 section &<<SECTaddressverification>>& (callouts are described in section
28041 &<<SECTcallver>>&). You can combine this condition with the &%senders%&
28042 condition to restrict it to bounce messages only:
28043 .code
28044 deny    senders = :
28045         message = A valid sender header is required for bounces
28046        !verify  = header_sender
28047 .endd
28048
28049 .vitem &*verify&~=&~header_syntax*&
28050 .cindex "&%verify%& ACL condition"
28051 .cindex "&ACL;" "verifying header syntax"
28052 .cindex "header lines" "verifying syntax"
28053 .cindex "verifying" "header syntax"
28054 This condition is relevant only in an ACL that is run after a message has been
28055 received, that is, in an ACL specified by &%acl_smtp_data%& or
28056 &%acl_not_smtp%&. It checks the syntax of all header lines that can contain
28057 lists of addresses (&'Sender:'&, &'From:'&, &'Reply-To:'&, &'To:'&, &'Cc:'&,
28058 and &'Bcc:'&). Unqualified addresses (local parts without domains) are
28059 permitted only in locally generated messages and from hosts that match
28060 &%sender_unqualified_hosts%& or &%recipient_unqualified_hosts%&, as
28061 appropriate.
28062
28063 Note that this condition is a syntax check only. However, a common spamming
28064 ploy used to be to send syntactically invalid headers such as
28065 .code
28066 To: @
28067 .endd
28068 and this condition can be used to reject such messages, though they are not as
28069 common as they used to be.
28070
28071 .vitem &*verify&~=&~helo*&
28072 .cindex "&%verify%& ACL condition"
28073 .cindex "&ACL;" "verifying HELO/EHLO"
28074 .cindex "HELO" "verifying"
28075 .cindex "EHLO" "verifying"
28076 .cindex "verifying" "EHLO"
28077 .cindex "verifying" "HELO"
28078 This condition is true if a HELO or EHLO command has been received from the
28079 client host, and its contents have been verified. If there has been no previous
28080 attempt to verify the HELO/EHLO contents, it is carried out when this
28081 condition is encountered. See the description of the &%helo_verify_hosts%& and
28082 &%helo_try_verify_hosts%& options for details of how to request verification
28083 independently of this condition.
28084
28085 For SMTP input that does not come over TCP/IP (the &%-bs%& command line
28086 option), this condition is always true.
28087
28088
28089 .vitem &*verify&~=&~not_blind*&
28090 .cindex "verifying" "not blind"
28091 .cindex "bcc recipients, verifying none"
28092 This condition checks that there are no blind (bcc) recipients in the message.
28093 Every envelope recipient must appear either in a &'To:'& header line or in a
28094 &'Cc:'& header line for this condition to be true. Local parts are checked
28095 case-sensitively; domains are checked case-insensitively. If &'Resent-To:'& or
28096 &'Resent-Cc:'& header lines exist, they are also checked. This condition can be
28097 used only in a DATA or non-SMTP ACL.
28098
28099 There are, of course, many legitimate messages that make use of blind (bcc)
28100 recipients. This check should not be used on its own for blocking messages.
28101
28102
28103 .vitem &*verify&~=&~recipient/*&<&'options'&>
28104 .cindex "&%verify%& ACL condition"
28105 .cindex "&ACL;" "verifying recipient"
28106 .cindex "recipient" "verifying"
28107 .cindex "verifying" "recipient"
28108 .vindex "&$address_data$&"
28109 This condition is relevant only after a RCPT command. It verifies the current
28110 recipient. Details of address verification are given later, starting at section
28111 &<<SECTaddressverification>>&. After a recipient has been verified, the value
28112 of &$address_data$& is the last value that was set while routing the address.
28113 This applies even if the verification fails. When an address that is being
28114 verified is redirected to a single address, verification continues with the new
28115 address, and in that case, the subsequent value of &$address_data$& is the
28116 value for the child address.
28117
28118 .vitem &*verify&~=&~reverse_host_lookup*&
28119 .cindex "&%verify%& ACL condition"
28120 .cindex "&ACL;" "verifying host reverse lookup"
28121 .cindex "host" "verifying reverse lookup"
28122 This condition ensures that a verified host name has been looked up from the IP
28123 address of the client host. (This may have happened already if the host name
28124 was needed for checking a host list, or if the host matched &%host_lookup%&.)
28125 Verification ensures that the host name obtained from a reverse DNS lookup, or
28126 one of its aliases, does, when it is itself looked up in the DNS, yield the
28127 original IP address.
28128
28129 If this condition is used for a locally generated message (that is, when there
28130 is no client host involved), it always succeeds.
28131
28132 .vitem &*verify&~=&~sender/*&<&'options'&>
28133 .cindex "&%verify%& ACL condition"
28134 .cindex "&ACL;" "verifying sender"
28135 .cindex "sender" "verifying"
28136 .cindex "verifying" "sender"
28137 This condition is relevant only after a MAIL or RCPT command, or after a
28138 message has been received (the &%acl_smtp_data%& or &%acl_not_smtp%& ACLs). If
28139 the message's sender is empty (that is, this is a bounce message), the
28140 condition is true. Otherwise, the sender address is verified.
28141
28142 .vindex "&$address_data$&"
28143 .vindex "&$sender_address_data$&"
28144 If there is data in the &$address_data$& variable at the end of routing, its
28145 value is placed in &$sender_address_data$& at the end of verification. This
28146 value can be used in subsequent conditions and modifiers in the same ACL
28147 statement. It does not persist after the end of the current statement. If you
28148 want to preserve the value for longer, you can save it in an ACL variable.
28149
28150 Details of verification are given later, starting at section
28151 &<<SECTaddressverification>>&. Exim caches the result of sender verification,
28152 to avoid doing it more than once per message.
28153
28154 .vitem &*verify&~=&~sender=*&<&'address'&>&*/*&<&'options'&>
28155 .cindex "&%verify%& ACL condition"
28156 This is a variation of the previous option, in which a modified address is
28157 verified as a sender.
28158 .endlist
28159
28160
28161
28162 .section "Using DNS lists" "SECTmorednslists"
28163 .cindex "DNS list" "in ACL"
28164 .cindex "black list (DNS)"
28165 .cindex "&ACL;" "testing a DNS list"
28166 In its simplest form, the &%dnslists%& condition tests whether the calling host
28167 is on at least one of a number of DNS lists by looking up the inverted IP
28168 address in one or more DNS domains. (Note that DNS list domains are not mail
28169 domains, so the &`+`& syntax for named lists doesn't work - it is used for
28170 special options instead.) For example, if the calling host's IP
28171 address is 192.168.62.43, and the ACL statement is
28172 .code
28173 deny dnslists = blackholes.mail-abuse.org : \
28174                 dialups.mail-abuse.org
28175 .endd
28176 the following records are looked up:
28177 .code
28178 43.62.168.192.blackholes.mail-abuse.org
28179 43.62.168.192.dialups.mail-abuse.org
28180 .endd
28181 As soon as Exim finds an existing DNS record, processing of the list stops.
28182 Thus, multiple entries on the list provide an &"or"& conjunction. If you want
28183 to test that a host is on more than one list (an &"and"& conjunction), you can
28184 use two separate conditions:
28185 .code
28186 deny dnslists = blackholes.mail-abuse.org
28187      dnslists = dialups.mail-abuse.org
28188 .endd
28189 If a DNS lookup times out or otherwise fails to give a decisive answer, Exim
28190 behaves as if the host does not match the list item, that is, as if the DNS
28191 record does not exist. If there are further items in the DNS list, they are
28192 processed.
28193
28194 This is usually the required action when &%dnslists%& is used with &%deny%&
28195 (which is the most common usage), because it prevents a DNS failure from
28196 blocking mail. However, you can change this behaviour by putting one of the
28197 following special items in the list:
28198 .display
28199 &`+include_unknown `&   behave as if the item is on the list
28200 &`+exclude_unknown `&   behave as if the item is not on the list (default)
28201 &`+defer_unknown   `&   give a temporary error
28202 .endd
28203 .cindex "&`+include_unknown`&"
28204 .cindex "&`+exclude_unknown`&"
28205 .cindex "&`+defer_unknown`&"
28206 Each of these applies to any subsequent items on the list. For example:
28207 .code
28208 deny dnslists = +defer_unknown : foo.bar.example
28209 .endd
28210 Testing the list of domains stops as soon as a match is found. If you want to
28211 warn for one list and block for another, you can use two different statements:
28212 .code
28213 deny  dnslists = blackholes.mail-abuse.org
28214 warn  message  = X-Warn: sending host is on dialups list
28215       dnslists = dialups.mail-abuse.org
28216 .endd
28217 DNS list lookups are cached by Exim for the duration of the SMTP session,
28218 so a lookup based on the IP address is done at most once for any incoming
28219 connection. Exim does not share information between multiple incoming
28220 connections (but your local name server cache should be active).
28221
28222
28223
28224 .section "Specifying the IP address for a DNS list lookup" "SECID201"
28225 .cindex "DNS list" "keyed by explicit IP address"
28226 By default, the IP address that is used in a DNS list lookup is the IP address
28227 of the calling host. However, you can specify another IP address by listing it
28228 after the domain name, introduced by a slash. For example:
28229 .code
28230 deny dnslists = black.list.tld/192.168.1.2
28231 .endd
28232 This feature is not very helpful with explicit IP addresses; it is intended for
28233 use with IP addresses that are looked up, for example, the IP addresses of the
28234 MX hosts or nameservers of an email sender address. For an example, see section
28235 &<<SECTmulkeyfor>>& below.
28236
28237
28238
28239
28240 .section "DNS lists keyed on domain names" "SECID202"
28241 .cindex "DNS list" "keyed by domain name"
28242 There are some lists that are keyed on domain names rather than inverted IP
28243 addresses (see for example the &'domain based zones'& link at
28244 &url(http://www.rfc-ignorant.org/)). No reversing of components is used
28245 with these lists. You can change the name that is looked up in a DNS list by
28246 listing it after the domain name, introduced by a slash. For example,
28247 .code
28248 deny  message  = Sender's domain is listed at $dnslist_domain
28249       dnslists = dsn.rfc-ignorant.org/$sender_address_domain
28250 .endd
28251 This particular example is useful only in ACLs that are obeyed after the
28252 RCPT or DATA commands, when a sender address is available. If (for
28253 example) the message's sender is &'user@tld.example'& the name that is looked
28254 up by this example is
28255 .code
28256 tld.example.dsn.rfc-ignorant.org
28257 .endd
28258 A single &%dnslists%& condition can contain entries for both names and IP
28259 addresses. For example:
28260 .code
28261 deny dnslists = sbl.spamhaus.org : \
28262                 dsn.rfc-ignorant.org/$sender_address_domain
28263 .endd
28264 The first item checks the sending host's IP address; the second checks a domain
28265 name. The whole condition is true if either of the DNS lookups succeeds.
28266
28267
28268
28269
28270 .section "Multiple explicit keys for a DNS list" "SECTmulkeyfor"
28271 .cindex "DNS list" "multiple keys for"
28272 The syntax described above for looking up explicitly-defined values (either
28273 names or IP addresses) in a DNS blacklist is a simplification. After the domain
28274 name for the DNS list, what follows the slash can in fact be a list of items.
28275 As with all lists in Exim, the default separator is a colon. However, because
28276 this is a sublist within the list of DNS blacklist domains, it is necessary
28277 either to double the separators like this:
28278 .code
28279 dnslists = black.list.tld/name.1::name.2
28280 .endd
28281 or to change the separator character, like this:
28282 .code
28283 dnslists = black.list.tld/<;name.1;name.2
28284 .endd
28285 If an item in the list is an IP address, it is inverted before the DNS
28286 blacklist domain is appended. If it is not an IP address, no inversion
28287 occurs. Consider this condition:
28288 .code
28289 dnslists = black.list.tld/<;192.168.1.2;a.domain
28290 .endd
28291 The DNS lookups that occur are:
28292 .code
28293 2.1.168.192.black.list.tld
28294 a.domain.black.list.tld
28295 .endd
28296 Once a DNS record has been found (that matches a specific IP return
28297 address, if specified &-- see section &<<SECTaddmatcon>>&), no further lookups
28298 are done. If there is a temporary DNS error, the rest of the sublist of domains
28299 or IP addresses is tried. A temporary error for the whole dnslists item occurs
28300 only if no other DNS lookup in this sublist succeeds. In other words, a
28301 successful lookup for any of the items in the sublist overrides a temporary
28302 error for a previous item.
28303
28304 The ability to supply a list of items after the slash is in some sense just a
28305 syntactic convenience. These two examples have the same effect:
28306 .code
28307 dnslists = black.list.tld/a.domain : black.list.tld/b.domain
28308 dnslists = black.list.tld/a.domain::b.domain
28309 .endd
28310 However, when the data for the list is obtained from a lookup, the second form
28311 is usually much more convenient. Consider this example:
28312 .code
28313 deny message  = The mail servers for the domain \
28314                 $sender_address_domain \
28315                 are listed at $dnslist_domain ($dnslist_value); \
28316                 see $dnslist_text.
28317      dnslists = sbl.spamhaus.org/<|${lookup dnsdb {>|a=<|\
28318                                    ${lookup dnsdb {>|mxh=\
28319                                    $sender_address_domain} }} }
28320 .endd
28321 Note the use of &`>|`& in the dnsdb lookup to specify the separator for
28322 multiple DNS records. The inner dnsdb lookup produces a list of MX hosts
28323 and the outer dnsdb lookup finds the IP addresses for these hosts. The result
28324 of expanding the condition might be something like this:
28325 .code
28326 dnslists = sbl.spahmaus.org/<|192.168.2.3|192.168.5.6|...
28327 .endd
28328 Thus, this example checks whether or not the IP addresses of the sender
28329 domain's mail servers are on the Spamhaus black list.
28330
28331 The key that was used for a successful DNS list lookup is put into the variable
28332 &$dnslist_matched$& (see section &<<SECID204>>&).
28333
28334
28335
28336
28337 .section "Data returned by DNS lists" "SECID203"
28338 .cindex "DNS list" "data returned from"
28339 DNS lists are constructed using address records in the DNS. The original RBL
28340 just used the address 127.0.0.1 on the right hand side of each record, but the
28341 RBL+ list and some other lists use a number of values with different meanings.
28342 The values used on the RBL+ list are:
28343 .display
28344 127.1.0.1  RBL
28345 127.1.0.2  DUL
28346 127.1.0.3  DUL and RBL
28347 127.1.0.4  RSS
28348 127.1.0.5  RSS and RBL
28349 127.1.0.6  RSS and DUL
28350 127.1.0.7  RSS and DUL and RBL
28351 .endd
28352 Section &<<SECTaddmatcon>>& below describes how you can distinguish between
28353 different values. Some DNS lists may return more than one address record;
28354 see section &<<SECThanmuldnsrec>>& for details of how they are checked.
28355
28356
28357 .section "Variables set from DNS lists" "SECID204"
28358 .cindex "expansion" "variables, set from DNS list"
28359 .cindex "DNS list" "variables set from"
28360 .vindex "&$dnslist_domain$&"
28361 .vindex "&$dnslist_matched$&"
28362 .vindex "&$dnslist_text$&"
28363 .vindex "&$dnslist_value$&"
28364 When an entry is found in a DNS list, the variable &$dnslist_domain$& contains
28365 the name of the overall domain that matched (for example,
28366 &`spamhaus.example`&), &$dnslist_matched$& contains the key within that domain
28367 (for example, &`192.168.5.3`&), and &$dnslist_value$& contains the data from
28368 the DNS record. When the key is an IP address, it is not reversed in
28369 &$dnslist_matched$& (though it is, of course, in the actual lookup). In simple
28370 cases, for example:
28371 .code
28372 deny dnslists = spamhaus.example
28373 .endd
28374 the key is also available in another variable (in this case,
28375 &$sender_host_address$&). In more complicated cases, however, this is not true.
28376 For example, using a data lookup (as described in section &<<SECTmulkeyfor>>&)
28377 might generate a dnslists lookup like this:
28378 .code
28379 deny dnslists = spamhaus.example/<|192.168.1.2|192.168.6.7|...
28380 .endd
28381 If this condition succeeds, the value in &$dnslist_matched$& might be
28382 &`192.168.6.7`& (for example).
28383
28384 If more than one address record is returned by the DNS lookup, all the IP
28385 addresses are included in &$dnslist_value$&, separated by commas and spaces.
28386 The variable &$dnslist_text$& contains the contents of any associated TXT
28387 record. For lists such as RBL+ the TXT record for a merged entry is often not
28388 very meaningful. See section &<<SECTmordetinf>>& for a way of obtaining more
28389 information.
28390
28391 You can use the DNS list variables in &%message%& or &%log_message%& modifiers
28392 &-- although these appear before the condition in the ACL, they are not
28393 expanded until after it has failed. For example:
28394 .code
28395 deny    hosts = !+local_networks
28396         message = $sender_host_address is listed \
28397                   at $dnslist_domain
28398         dnslists = rbl-plus.mail-abuse.example
28399 .endd
28400
28401
28402
28403 .section "Additional matching conditions for DNS lists" "SECTaddmatcon"
28404 .cindex "DNS list" "matching specific returned data"
28405 You can add an equals sign and an IP address after a &%dnslists%& domain name
28406 in order to restrict its action to DNS records with a matching right hand side.
28407 For example,
28408 .code
28409 deny dnslists = rblplus.mail-abuse.org=127.0.0.2
28410 .endd
28411 rejects only those hosts that yield 127.0.0.2. Without this additional data,
28412 any address record is considered to be a match. For the moment, we assume
28413 that the DNS lookup returns just one record. Section &<<SECThanmuldnsrec>>&
28414 describes how multiple records are handled.
28415
28416 More than one IP address may be given for checking, using a comma as a
28417 separator. These are alternatives &-- if any one of them matches, the
28418 &%dnslists%& condition is true. For example:
28419 .code
28420 deny  dnslists = a.b.c=127.0.0.2,127.0.0.3
28421 .endd
28422 If you want to specify a constraining address list and also specify names or IP
28423 addresses to be looked up, the constraining address list must be specified
28424 first. For example:
28425 .code
28426 deny dnslists = dsn.rfc-ignorant.org\
28427                 =127.0.0.2/$sender_address_domain
28428 .endd
28429
28430 If the character &`&&`& is used instead of &`=`&, the comparison for each
28431 listed IP address is done by a bitwise &"and"& instead of by an equality test.
28432 In other words, the listed addresses are used as bit masks. The comparison is
28433 true if all the bits in the mask are present in the address that is being
28434 tested. For example:
28435 .code
28436 dnslists = a.b.c&0.0.0.3
28437 .endd
28438 matches if the address is &'x.x.x.'&3, &'x.x.x.'&7, &'x.x.x.'&11, etc. If you
28439 want to test whether one bit or another bit is present (as opposed to both
28440 being present), you must use multiple values. For example:
28441 .code
28442 dnslists = a.b.c&0.0.0.1,0.0.0.2
28443 .endd
28444 matches if the final component of the address is an odd number or two times
28445 an odd number.
28446
28447
28448
28449 .section "Negated DNS matching conditions" "SECID205"
28450 You can supply a negative list of IP addresses as part of a &%dnslists%&
28451 condition. Whereas
28452 .code
28453 deny  dnslists = a.b.c=127.0.0.2,127.0.0.3
28454 .endd
28455 means &"deny if the host is in the black list at the domain &'a.b.c'& and the
28456 IP address yielded by the list is either 127.0.0.2 or 127.0.0.3"&,
28457 .code
28458 deny  dnslists = a.b.c!=127.0.0.2,127.0.0.3
28459 .endd
28460 means &"deny if the host is in the black list at the domain &'a.b.c'& and the
28461 IP address yielded by the list is not 127.0.0.2 and not 127.0.0.3"&. In other
28462 words, the result of the test is inverted if an exclamation mark appears before
28463 the &`=`& (or the &`&&`&) sign.
28464
28465 &*Note*&: This kind of negation is not the same as negation in a domain,
28466 host, or address list (which is why the syntax is different).
28467
28468 If you are using just one list, the negation syntax does not gain you much. The
28469 previous example is precisely equivalent to
28470 .code
28471 deny  dnslists = a.b.c
28472      !dnslists = a.b.c=127.0.0.2,127.0.0.3
28473 .endd
28474 However, if you are using multiple lists, the negation syntax is clearer.
28475 Consider this example:
28476 .code
28477 deny  dnslists = sbl.spamhaus.org : \
28478                  list.dsbl.org : \
28479                  dnsbl.njabl.org!=127.0.0.3 : \
28480                  relays.ordb.org
28481 .endd
28482 Using only positive lists, this would have to be:
28483 .code
28484 deny  dnslists = sbl.spamhaus.org : \
28485                  list.dsbl.org
28486 deny  dnslists = dnsbl.njabl.org
28487      !dnslists = dnsbl.njabl.org=127.0.0.3
28488 deny  dnslists = relays.ordb.org
28489 .endd
28490 which is less clear, and harder to maintain.
28491
28492
28493
28494
28495 .section "Handling multiple DNS records from a DNS list" "SECThanmuldnsrec"
28496 A DNS lookup for a &%dnslists%& condition may return more than one DNS record,
28497 thereby providing more than one IP address. When an item in a &%dnslists%& list
28498 is followed by &`=`& or &`&&`& and a list of IP addresses, in order to restrict
28499 the match to specific results from the DNS lookup, there are two ways in which
28500 the checking can be handled. For example, consider the condition:
28501 .code
28502 dnslists = a.b.c=127.0.0.1
28503 .endd
28504 What happens if the DNS lookup for the incoming IP address yields both
28505 127.0.0.1 and 127.0.0.2 by means of two separate DNS records? Is the
28506 condition true because at least one given value was found, or is it false
28507 because at least one of the found values was not listed? And how does this
28508 affect negated conditions? Both possibilities are provided for with the help of
28509 additional separators &`==`& and &`=&&`&.
28510
28511 .ilist
28512 If &`=`& or &`&&`& is used, the condition is true if any one of the looked up
28513 IP addresses matches one of the listed addresses. For the example above, the
28514 condition is true because 127.0.0.1 matches.
28515 .next
28516 If &`==`& or &`=&&`& is used, the condition is true only if every one of the
28517 looked up IP addresses matches one of the listed addresses. If the condition is
28518 changed to:
28519 .code
28520 dnslists = a.b.c==127.0.0.1
28521 .endd
28522 and the DNS lookup yields both 127.0.0.1 and 127.0.0.2, the condition is
28523 false because 127.0.0.2 is not listed. You would need to have:
28524 .code
28525 dnslists = a.b.c==127.0.0.1,127.0.0.2
28526 .endd
28527 for the condition to be true.
28528 .endlist
28529
28530 When &`!`& is used to negate IP address matching, it inverts the result, giving
28531 the precise opposite of the behaviour above. Thus:
28532 .ilist
28533 If &`!=`& or &`!&&`& is used, the condition is true if none of the looked up IP
28534 addresses matches one of the listed addresses. Consider:
28535 .code
28536 dnslists = a.b.c!&0.0.0.1
28537 .endd
28538 If the DNS lookup yields both 127.0.0.1 and 127.0.0.2, the condition is
28539 false because 127.0.0.1 matches.
28540 .next
28541 If &`!==`& or &`!=&&`& is used, the condition is true if there is at least one
28542 looked up IP address that does not match. Consider:
28543 .code
28544 dnslists = a.b.c!=&0.0.0.1
28545 .endd
28546 If the DNS lookup yields both 127.0.0.1 and 127.0.0.2, the condition is
28547 true, because 127.0.0.2 does not match. You would need to have:
28548 .code
28549 dnslists = a.b.c!=&0.0.0.1,0.0.0.2
28550 .endd
28551 for the condition to be false.
28552 .endlist
28553 When the DNS lookup yields only a single IP address, there is no difference
28554 between &`=`& and &`==`& and between &`&&`& and &`=&&`&.
28555
28556
28557
28558
28559 .section "Detailed information from merged DNS lists" "SECTmordetinf"
28560 .cindex "DNS list" "information from merged"
28561 When the facility for restricting the matching IP values in a DNS list is used,
28562 the text from the TXT record that is set in &$dnslist_text$& may not reflect
28563 the true reason for rejection. This happens when lists are merged and the IP
28564 address in the A record is used to distinguish them; unfortunately there is
28565 only one TXT record. One way round this is not to use merged lists, but that
28566 can be inefficient because it requires multiple DNS lookups where one would do
28567 in the vast majority of cases when the host of interest is not on any of the
28568 lists.
28569
28570 A less inefficient way of solving this problem is available. If
28571 two domain names, comma-separated, are given, the second is used first to
28572 do an initial check, making use of any IP value restrictions that are set.
28573 If there is a match, the first domain is used, without any IP value
28574 restrictions, to get the TXT record. As a byproduct of this, there is also
28575 a check that the IP being tested is indeed on the first list. The first
28576 domain is the one that is put in &$dnslist_domain$&. For example:
28577 .code
28578 reject message  = \
28579          rejected because $sender_host_address is blacklisted \
28580          at $dnslist_domain\n$dnslist_text
28581        dnslists = \
28582          sbl.spamhaus.org,sbl-xbl.spamhaus.org=127.0.0.2 : \
28583          dul.dnsbl.sorbs.net,dnsbl.sorbs.net=127.0.0.10
28584 .endd
28585 For the first blacklist item, this starts by doing a lookup in
28586 &'sbl-xbl.spamhaus.org'& and testing for a 127.0.0.2 return. If there is a
28587 match, it then looks in &'sbl.spamhaus.org'&, without checking the return
28588 value, and as long as something is found, it looks for the corresponding TXT
28589 record. If there is no match in &'sbl-xbl.spamhaus.org'&, nothing more is done.
28590 The second blacklist item is processed similarly.
28591
28592 If you are interested in more than one merged list, the same list must be
28593 given several times, but because the results of the DNS lookups are cached,
28594 the DNS calls themselves are not repeated. For example:
28595 .code
28596 reject dnslists = \
28597          http.dnsbl.sorbs.net,dnsbl.sorbs.net=127.0.0.2 : \
28598          socks.dnsbl.sorbs.net,dnsbl.sorbs.net=127.0.0.3 : \
28599          misc.dnsbl.sorbs.net,dnsbl.sorbs.net=127.0.0.4 : \
28600          dul.dnsbl.sorbs.net,dnsbl.sorbs.net=127.0.0.10
28601 .endd
28602 In this case there is one lookup in &'dnsbl.sorbs.net'&, and if none of the IP
28603 values matches (or if no record is found), this is the only lookup that is
28604 done. Only if there is a match is one of the more specific lists consulted.
28605
28606
28607
28608 .section "DNS lists and IPv6" "SECTmorednslistslast"
28609 .cindex "IPv6" "DNS black lists"
28610 .cindex "DNS list" "IPv6 usage"
28611 If Exim is asked to do a dnslist lookup for an IPv6 address, it inverts it
28612 nibble by nibble. For example, if the calling host's IP address is
28613 3ffe:ffff:836f:0a00:000a:0800:200a:c031, Exim might look up
28614 .code
28615 1.3.0.c.a.0.0.2.0.0.8.0.a.0.0.0.0.0.a.0.f.6.3.8.
28616   f.f.f.f.e.f.f.3.blackholes.mail-abuse.org
28617 .endd
28618 (split over two lines here to fit on the page). Unfortunately, some of the DNS
28619 lists contain wildcard records, intended for IPv4, that interact badly with
28620 IPv6. For example, the DNS entry
28621 .code
28622 *.3.some.list.example.    A    127.0.0.1
28623 .endd
28624 is probably intended to put the entire 3.0.0.0/8 IPv4 network on the list.
28625 Unfortunately, it also matches the entire 3::/4 IPv6 network.
28626
28627 You can exclude IPv6 addresses from DNS lookups by making use of a suitable
28628 &%condition%& condition, as in this example:
28629 .code
28630 deny   condition = ${if isip4{$sender_host_address}}
28631        dnslists  = some.list.example
28632 .endd
28633
28634 If an explicit key is being used for a DNS lookup and it may be an IPv6
28635 address you should specify alternate list separators for both the outer
28636 (DNS list name) list and inner (lookup keys) list:
28637 .code
28638        dnslists = <; dnsbl.example.com/<|$acl_m_addrslist
28639 .endd
28640
28641 .section "Rate limiting incoming messages" "SECTratelimiting"
28642 .cindex "rate limiting" "client sending"
28643 .cindex "limiting client sending rates"
28644 .oindex "&%smtp_ratelimit_*%&"
28645 The &%ratelimit%& ACL condition can be used to measure and control the rate at
28646 which clients can send email. This is more powerful than the
28647 &%smtp_ratelimit_*%& options, because those options control the rate of
28648 commands in a single SMTP session only, whereas the &%ratelimit%& condition
28649 works across all connections (concurrent and sequential) from the same client
28650 host. The syntax of the &%ratelimit%& condition is:
28651 .display
28652 &`ratelimit =`& <&'m'&> &`/`& <&'p'&> &`/`& <&'options'&> &`/`& <&'key'&>
28653 .endd
28654 If the average client sending rate is less than &'m'& messages per time
28655 period &'p'& then the condition is false; otherwise it is true.
28656
28657 As a side-effect, the &%ratelimit%& condition sets the expansion variable
28658 &$sender_rate$& to the client's computed rate, &$sender_rate_limit$& to the
28659 configured value of &'m'&, and &$sender_rate_period$& to the configured value
28660 of &'p'&.
28661
28662 The parameter &'p'& is the smoothing time constant, in the form of an Exim
28663 time interval, for example, &`8h`& for eight hours. A larger time constant
28664 means that it takes Exim longer to forget a client's past behaviour. The
28665 parameter &'m'& is the maximum number of messages that a client is permitted to
28666 send in each time interval. It also specifies the number of messages permitted
28667 in a fast burst. By increasing both &'m'& and &'p'& but keeping &'m/p'&
28668 constant, you can allow a client to send more messages in a burst without
28669 changing its long-term sending rate limit. Conversely, if &'m'& and &'p'& are
28670 both small, messages must be sent at an even rate.
28671
28672 There is a script in &_util/ratelimit.pl_& which extracts sending rates from
28673 log files, to assist with choosing appropriate settings for &'m'& and &'p'&
28674 when deploying the &%ratelimit%& ACL condition. The script prints usage
28675 instructions when it is run with no arguments.
28676
28677 The key is used to look up the data for calculating the client's average
28678 sending rate. This data is stored in Exim's spool directory, alongside the
28679 retry and other hints databases. The default key is &$sender_host_address$&,
28680 which means Exim computes the sending rate of each client host IP address.
28681 By changing the key you can change how Exim identifies clients for the purpose
28682 of ratelimiting. For example, to limit the sending rate of each authenticated
28683 user, independent of the computer they are sending from, set the key to
28684 &$authenticated_id$&. You must ensure that the lookup key is meaningful; for
28685 example, &$authenticated_id$& is only meaningful if the client has
28686 authenticated (which you can check with the &%authenticated%& ACL condition).
28687
28688 The lookup key does not have to identify clients: If you want to limit the
28689 rate at which a recipient receives messages, you can use the key
28690 &`$local_part@$domain`& with the &%per_rcpt%& option (see below) in a RCPT
28691 ACL.
28692
28693 Each &%ratelimit%& condition can have up to four options. A &%per_*%& option
28694 specifies what Exim measures the rate of, for example messages or recipients
28695 or bytes. You can adjust the measurement using the &%unique=%& and/or
28696 &%count=%& options. You can also control when Exim updates the recorded rate
28697 using a &%strict%&, &%leaky%&, or &%readonly%& option. The options are
28698 separated by a slash, like the other parameters. They may appear in any order.
28699
28700 Internally, Exim appends the smoothing constant &'p'& onto the lookup key with
28701 any options that alter the meaning of the stored data. The limit &'m'& is not
28702 stored, so you can alter the configured maximum rate and Exim will still
28703 remember clients' past behaviour. If you change the &%per_*%& mode or add or
28704 remove the &%unique=%& option, the lookup key changes so Exim will forget past
28705 behaviour. The lookup key is not affected by changes to the update mode and
28706 the &%count=%& option.
28707
28708
28709 .section "Ratelimit options for what is being measured" "ratoptmea"
28710 .cindex "rate limiting" "per_* options"
28711 The &%per_conn%& option limits the client's connection rate. It is not
28712 normally used in the &%acl_not_smtp%&, &%acl_not_smtp_mime%&, or
28713 &%acl_not_smtp_start%& ACLs.
28714
28715 The &%per_mail%& option limits the client's rate of sending messages. This is
28716 the default if none of the &%per_*%& options is specified. It can be used in
28717 &%acl_smtp_mail%&, &%acl_smtp_rcpt%&, &%acl_smtp_predata%&, &%acl_smtp_mime%&,
28718 &%acl_smtp_data%&, or &%acl_not_smtp%&.
28719
28720 The &%per_byte%& option limits the sender's email bandwidth. It can be used in
28721 the same ACLs as the &%per_mail%& option, though it is best to use this option
28722 in the &%acl_smtp_mime%&, &%acl_smtp_data%& or &%acl_not_smtp%& ACLs; if it is
28723 used in an earlier ACL, Exim relies on the SIZE parameter given by the client
28724 in its MAIL command, which may be inaccurate or completely missing. You can
28725 follow the limit &'m'& in the configuration with K, M, or G to specify limits
28726 in kilobytes, megabytes, or gigabytes, respectively.
28727
28728 The &%per_rcpt%& option causes Exim to limit the rate at which recipients are
28729 accepted. It can be used in the &%acl_smtp_rcpt%&, &%acl_smtp_predata%&,
28730 &%acl_smtp_mime%&, &%acl_smtp_data%&, or &%acl_smtp_rcpt%& ACLs. In
28731 &%acl_smtp_rcpt%& the rate is updated one recipient at a time; in the other
28732 ACLs the rate is updated with the total recipient count in one go. Note that
28733 in either case the rate limiting engine will see a message with many
28734 recipients as a large high-speed burst.
28735
28736 The &%per_addr%& option is like the &%per_rcpt%& option, except it counts the
28737 number of different recipients that the client has sent messages to in the
28738 last time period. That is, if the client repeatedly sends messages to the same
28739 recipient, its measured rate is not increased. This option can only be used in
28740 &%acl_smtp_rcpt%&.
28741
28742 The &%per_cmd%& option causes Exim to recompute the rate every time the
28743 condition is processed. This can be used to limit the rate of any SMTP
28744 command. If it is used in multiple ACLs it can limit the aggregate rate of
28745 multiple different commands.
28746
28747 The &%count=%& option can be used to alter how much Exim adds to the client's
28748 measured rate. For example, the &%per_byte%& option is equivalent to
28749 &`per_mail/count=$message_size`&. If there is no &%count=%& option, Exim
28750 increases the measured rate by one (except for the &%per_rcpt%& option in ACLs
28751 other than &%acl_smtp_rcpt%&). The count does not have to be an integer.
28752
28753 The &%unique=%& option is described in section &<<ratoptuniq>>& below.
28754
28755
28756 .section "Ratelimit update modes" "ratoptupd"
28757 .cindex "rate limiting" "reading data without updating"
28758 You can specify one of three options with the &%ratelimit%& condition to
28759 control when its database is updated. This section describes the &%readonly%&
28760 mode, and the next section describes the &%strict%& and &%leaky%& modes.
28761
28762 If the &%ratelimit%& condition is used in &%readonly%& mode, Exim looks up a
28763 previously-computed rate to check against the limit.
28764
28765 For example, you can test the client's sending rate and deny it access (when
28766 it is too fast) in the connect ACL. If the client passes this check then it
28767 can go on to send a message, in which case its recorded rate will be updated
28768 in the MAIL ACL. Subsequent connections from the same client will check this
28769 new rate.
28770 .code
28771 acl_check_connect:
28772  deny ratelimit = 100 / 5m / readonly
28773     log_message = RATE CHECK: $sender_rate/$sender_rate_period \
28774                   (max $sender_rate_limit)
28775 # ...
28776 acl_check_mail:
28777  warn ratelimit = 100 / 5m / strict
28778     log_message = RATE UPDATE: $sender_rate/$sender_rate_period \
28779                   (max $sender_rate_limit)
28780 .endd
28781
28782 If Exim encounters multiple &%ratelimit%& conditions with the same key when
28783 processing a message then it may increase the client's measured rate more than
28784 it should. For example, this will happen if you check the &%per_rcpt%& option
28785 in both &%acl_smtp_rcpt%& and &%acl_smtp_data%&. However it's OK to check the
28786 same &%ratelimit%& condition multiple times in the same ACL. You can avoid any
28787 multiple update problems by using the &%readonly%& option on later ratelimit
28788 checks.
28789
28790 The &%per_*%& options described above do not make sense in some ACLs. If you
28791 use a &%per_*%& option in an ACL where it is not normally permitted then the
28792 update mode defaults to &%readonly%& and you cannot specify the &%strict%& or
28793 &%leaky%& modes. In other ACLs the default update mode is &%leaky%& (see the
28794 next section) so you must specify the &%readonly%& option explicitly.
28795
28796
28797 .section "Ratelimit options for handling fast clients" "ratoptfast"
28798 .cindex "rate limiting" "strict and leaky modes"
28799 If a client's average rate is greater than the maximum, the rate limiting
28800 engine can react in two possible ways, depending on the presence of the
28801 &%strict%& or &%leaky%& update modes. This is independent of the other
28802 counter-measures (such as rejecting the message) that may be specified by the
28803 rest of the ACL.
28804
28805 The &%leaky%& (default) option means that the client's recorded rate is not
28806 updated if it is above the limit. The effect of this is that Exim measures the
28807 client's average rate of successfully sent email, which cannot be greater than
28808 the maximum allowed. If the client is over the limit it may suffer some
28809 counter-measures (as specified in the ACL), but it will still be able to send
28810 email at the configured maximum rate, whatever the rate of its attempts. This
28811 is generally the better choice if you have clients that retry automatically.
28812 For example, it does not prevent a sender with an over-aggressive retry rate
28813 from getting any email through.
28814
28815 The &%strict%& option means that the client's recorded rate is always
28816 updated. The effect of this is that Exim measures the client's average rate
28817 of attempts to send email, which can be much higher than the maximum it is
28818 actually allowed. If the client is over the limit it may be subjected to
28819 counter-measures by the ACL. It must slow down and allow sufficient time to
28820 pass that its computed rate falls below the maximum before it can send email
28821 again. The time (the number of smoothing periods) it must wait and not
28822 attempt to send mail can be calculated with this formula:
28823 .code
28824         ln(peakrate/maxrate)
28825 .endd
28826
28827
28828 .section "Limiting the rate of different events" "ratoptuniq"
28829 .cindex "rate limiting" "counting unique events"
28830 The &%ratelimit%& &%unique=%& option controls a mechanism for counting the
28831 rate of different events. For example, the &%per_addr%& option uses this
28832 mechanism to count the number of different recipients that the client has
28833 sent messages to in the last time period; it is equivalent to
28834 &`per_rcpt/unique=$local_part@$domain`&. You could use this feature to
28835 measure the rate that a client uses different sender addresses with the
28836 options &`per_mail/unique=$sender_address`&.
28837
28838 For each &%ratelimit%& key Exim stores the set of &%unique=%& values that it
28839 has seen for that key. The whole set is thrown away when it is older than the
28840 rate smoothing period &'p'&, so each different event is counted at most once
28841 per period. In the &%leaky%& update mode, an event that causes the client to
28842 go over the limit is not added to the set, in the same way that the client's
28843 recorded rate is not updated in the same situation.
28844
28845 When you combine the &%unique=%& and &%readonly%& options, the specific
28846 &%unique=%& value is ignored, and Exim just retrieves the client's stored
28847 rate.
28848
28849 The &%unique=%& mechanism needs more space in the ratelimit database than the
28850 other &%ratelimit%& options in order to store the event set. The number of
28851 unique values is potentially as large as the rate limit, so the extra space
28852 required increases with larger limits.
28853
28854 The uniqueification is not perfect: there is a small probability that Exim
28855 will think a new event has happened before. If the sender's rate is less than
28856 the limit, Exim should be more than 99.9% correct. However in &%strict%& mode
28857 the measured rate can go above the limit, in which case Exim may under-count
28858 events by a significant margin. Fortunately, if the rate is high enough (2.7
28859 times the limit) that the false positive rate goes above 9%, then Exim will
28860 throw away the over-full event set before the measured rate falls below the
28861 limit. Therefore the only harm should be that exceptionally high sending rates
28862 are logged incorrectly; any countermeasures you configure will be as effective
28863 as intended.
28864
28865
28866 .section "Using rate limiting" "useratlim"
28867 Exim's other ACL facilities are used to define what counter-measures are taken
28868 when the rate limit is exceeded. This might be anything from logging a warning
28869 (for example, while measuring existing sending rates in order to define
28870 policy), through time delays to slow down fast senders, up to rejecting the
28871 message. For example:
28872 .code
28873 # Log all senders' rates
28874 warn ratelimit = 0 / 1h / strict
28875      log_message = Sender rate $sender_rate / $sender_rate_period
28876
28877 # Slow down fast senders; note the need to truncate $sender_rate
28878 # at the decimal point.
28879 warn ratelimit = 100 / 1h / per_rcpt / strict
28880      delay     = ${eval: ${sg{$sender_rate}{[.].*}{}} - \
28881                    $sender_rate_limit }s
28882
28883 # Keep authenticated users under control
28884 deny authenticated = *
28885      ratelimit = 100 / 1d / strict / $authenticated_id
28886
28887 # System-wide rate limit
28888 defer message = Sorry, too busy. Try again later.
28889      ratelimit = 10 / 1s / $primary_hostname
28890
28891 # Restrict incoming rate from each host, with a default
28892 # set using a macro and special cases looked up in a table.
28893 defer message = Sender rate exceeds $sender_rate_limit \
28894                messages per $sender_rate_period
28895      ratelimit = ${lookup {$sender_host_address} \
28896                    cdb {DB/ratelimits.cdb} \
28897                    {$value} {RATELIMIT} }
28898 .endd
28899 &*Warning*&: If you have a busy server with a lot of &%ratelimit%& tests,
28900 especially with the &%per_rcpt%& option, you may suffer from a performance
28901 bottleneck caused by locking on the ratelimit hints database. Apart from
28902 making your ACLs less complicated, you can reduce the problem by using a
28903 RAM disk for Exim's hints directory (usually &_/var/spool/exim/db/_&). However
28904 this means that Exim will lose its hints data after a reboot (including retry
28905 hints, the callout cache, and ratelimit data).
28906
28907
28908
28909 .section "Address verification" "SECTaddressverification"
28910 .cindex "verifying address" "options for"
28911 .cindex "policy control" "address verification"
28912 Several of the &%verify%& conditions described in section
28913 &<<SECTaclconditions>>& cause addresses to be verified. Section
28914 &<<SECTsenaddver>>& discusses the reporting of sender verification failures.
28915 The verification conditions can be followed by options that modify the
28916 verification process. The options are separated from the keyword and from each
28917 other by slashes, and some of them contain parameters. For example:
28918 .code
28919 verify = sender/callout
28920 verify = recipient/defer_ok/callout=10s,defer_ok
28921 .endd
28922 The first stage of address verification, which always happens, is to run the
28923 address through the routers, in &"verify mode"&. Routers can detect the
28924 difference between verification and routing for delivery, and their actions can
28925 be varied by a number of generic options such as &%verify%& and &%verify_only%&
28926 (see chapter &<<CHAProutergeneric>>&). If routing fails, verification fails.
28927 The available options are as follows:
28928
28929 .ilist
28930 If the &%callout%& option is specified, successful routing to one or more
28931 remote hosts is followed by a &"callout"& to those hosts as an additional
28932 check. Callouts and their sub-options are discussed in the next section.
28933 .next
28934 If there is a defer error while doing verification routing, the ACL
28935 normally returns &"defer"&. However, if you include &%defer_ok%& in the
28936 options, the condition is forced to be true instead. Note that this is a main
28937 verification option as well as a suboption for callouts.
28938 .next
28939 The &%no_details%& option is covered in section &<<SECTsenaddver>>&, which
28940 discusses the reporting of sender address verification failures.
28941 .next
28942 The &%success_on_redirect%& option causes verification always to succeed
28943 immediately after a successful redirection. By default, if a redirection
28944 generates just one address, that address is also verified. See further
28945 discussion in section &<<SECTredirwhilveri>>&.
28946 .endlist
28947
28948 .cindex "verifying address" "differentiating failures"
28949 .vindex "&$recipient_verify_failure$&"
28950 .vindex "&$sender_verify_failure$&"
28951 .vindex "&$acl_verify_message$&"
28952 After an address verification failure, &$acl_verify_message$& contains the
28953 error message that is associated with the failure. It can be preserved by
28954 coding like this:
28955 .code
28956 warn  !verify = sender
28957        set acl_m0 = $acl_verify_message
28958 .endd
28959 If you are writing your own custom rejection message or log message when
28960 denying access, you can use this variable to include information about the
28961 verification failure.
28962
28963 In addition, &$sender_verify_failure$& or &$recipient_verify_failure$& (as
28964 appropriate) contains one of the following words:
28965
28966 .ilist
28967 &%qualify%&: The address was unqualified (no domain), and the message
28968 was neither local nor came from an exempted host.
28969 .next
28970 &%route%&: Routing failed.
28971 .next
28972 &%mail%&: Routing succeeded, and a callout was attempted; rejection
28973 occurred at or before the MAIL command (that is, on initial
28974 connection, HELO, or MAIL).
28975 .next
28976 &%recipient%&: The RCPT command in a callout was rejected.
28977 .next
28978 &%postmaster%&: The postmaster check in a callout was rejected.
28979 .endlist
28980
28981 The main use of these variables is expected to be to distinguish between
28982 rejections of MAIL and rejections of RCPT in callouts.
28983
28984
28985
28986
28987 .section "Callout verification" "SECTcallver"
28988 .cindex "verifying address" "by callout"
28989 .cindex "callout" "verification"
28990 .cindex "SMTP" "callout verification"
28991 For non-local addresses, routing verifies the domain, but is unable to do any
28992 checking of the local part. There are situations where some means of verifying
28993 the local part is desirable. One way this can be done is to make an SMTP
28994 &'callback'& to a delivery host for the sender address or a &'callforward'& to
28995 a subsequent host for a recipient address, to see if the host accepts the
28996 address. We use the term &'callout'& to cover both cases. Note that for a
28997 sender address, the callback is not to the client host that is trying to
28998 deliver the message, but to one of the hosts that accepts incoming mail for the
28999 sender's domain.
29000
29001 Exim does not do callouts by default. If you want them to happen, you must
29002 request them by setting appropriate options on the &%verify%& condition, as
29003 described below. This facility should be used with care, because it can add a
29004 lot of resource usage to the cost of verifying an address. However, Exim does
29005 cache the results of callouts, which helps to reduce the cost. Details of
29006 caching are in section &<<SECTcallvercache>>&.
29007
29008 Recipient callouts are usually used only between hosts that are controlled by
29009 the same administration. For example, a corporate gateway host could use
29010 callouts to check for valid recipients on an internal mailserver. A successful
29011 callout does not guarantee that a real delivery to the address would succeed;
29012 on the other hand, a failing callout does guarantee that a delivery would fail.
29013
29014 If the &%callout%& option is present on a condition that verifies an address, a
29015 second stage of verification occurs if the address is successfully routed to
29016 one or more remote hosts. The usual case is routing by a &(dnslookup)& or a
29017 &(manualroute)& router, where the router specifies the hosts. However, if a
29018 router that does not set up hosts routes to an &(smtp)& transport with a
29019 &%hosts%& setting, the transport's hosts are used. If an &(smtp)& transport has
29020 &%hosts_override%& set, its hosts are always used, whether or not the router
29021 supplies a host list.
29022 Callouts are only supported on &(smtp)& transports.
29023
29024 The port that is used is taken from the transport, if it is specified and is a
29025 remote transport. (For routers that do verification only, no transport need be
29026 specified.) Otherwise, the default SMTP port is used. If a remote transport
29027 specifies an outgoing interface, this is used; otherwise the interface is not
29028 specified. Likewise, the text that is used for the HELO command is taken from
29029 the transport's &%helo_data%& option; if there is no transport, the value of
29030 &$smtp_active_hostname$& is used.
29031
29032 For a sender callout check, Exim makes SMTP connections to the remote hosts, to
29033 test whether a bounce message could be delivered to the sender address. The
29034 following SMTP commands are sent:
29035 .display
29036 &`HELO `&<&'local host name'&>
29037 &`MAIL FROM:<>`&
29038 &`RCPT TO:`&<&'the address to be tested'&>
29039 &`QUIT`&
29040 .endd
29041 LHLO is used instead of HELO if the transport's &%protocol%& option is
29042 set to &"lmtp"&.
29043
29044 The callout may use EHLO, AUTH and/or STARTTLS given appropriate option
29045 settings.
29046
29047 A recipient callout check is similar. By default, it also uses an empty address
29048 for the sender. This default is chosen because most hosts do not make use of
29049 the sender address when verifying a recipient. Using the same address means
29050 that a single cache entry can be used for each recipient. Some sites, however,
29051 do make use of the sender address when verifying. These are catered for by the
29052 &%use_sender%& and &%use_postmaster%& options, described in the next section.
29053
29054 If the response to the RCPT command is a 2&'xx'& code, the verification
29055 succeeds. If it is 5&'xx'&, the verification fails. For any other condition,
29056 Exim tries the next host, if any. If there is a problem with all the remote
29057 hosts, the ACL yields &"defer"&, unless the &%defer_ok%& parameter of the
29058 &%callout%& option is given, in which case the condition is forced to succeed.
29059
29060 .cindex "SMTP" "output flushing, disabling for callout"
29061 A callout may take a little time. For this reason, Exim normally flushes SMTP
29062 output before performing a callout in an ACL, to avoid unexpected timeouts in
29063 clients when the SMTP PIPELINING extension is in use. The flushing can be
29064 disabled by using a &%control%& modifier to set &%no_callout_flush%&.
29065
29066
29067
29068
29069 .section "Additional parameters for callouts" "CALLaddparcall"
29070 .cindex "callout" "additional parameters for"
29071 The &%callout%& option can be followed by an equals sign and a number of
29072 optional parameters, separated by commas. For example:
29073 .code
29074 verify = recipient/callout=10s,defer_ok
29075 .endd
29076 The old syntax, which had &%callout_defer_ok%& and &%check_postmaster%& as
29077 separate verify options, is retained for backwards compatibility, but is now
29078 deprecated. The additional parameters for &%callout%& are as follows:
29079
29080
29081 .vlist
29082 .vitem <&'a&~time&~interval'&>
29083 .cindex "callout" "timeout, specifying"
29084 This specifies the timeout that applies for the callout attempt to each host.
29085 For example:
29086 .code
29087 verify = sender/callout=5s
29088 .endd
29089 The default is 30 seconds. The timeout is used for each response from the
29090 remote host. It is also used for the initial connection, unless overridden by
29091 the &%connect%& parameter.
29092
29093
29094 .vitem &*connect&~=&~*&<&'time&~interval'&>
29095 .cindex "callout" "connection timeout, specifying"
29096 This parameter makes it possible to set a different (usually smaller) timeout
29097 for making the SMTP connection. For example:
29098 .code
29099 verify = sender/callout=5s,connect=1s
29100 .endd
29101 If not specified, this timeout defaults to the general timeout value.
29102
29103 .vitem &*defer_ok*&
29104 .cindex "callout" "defer, action on"
29105 When this parameter is present, failure to contact any host, or any other kind
29106 of temporary error, is treated as success by the ACL. However, the cache is not
29107 updated in this circumstance.
29108
29109 .vitem &*fullpostmaster*&
29110 .cindex "callout" "full postmaster check"
29111 This operates like the &%postmaster%& option (see below), but if the check for
29112 &'postmaster@domain'& fails, it tries just &'postmaster'&, without a domain, in
29113 accordance with the specification in RFC 2821. The RFC states that the
29114 unqualified address &'postmaster'& should be accepted.
29115
29116
29117 .vitem &*mailfrom&~=&~*&<&'email&~address'&>
29118 .cindex "callout" "sender when verifying header"
29119 When verifying addresses in header lines using the &%header_sender%&
29120 verification option, Exim behaves by default as if the addresses are envelope
29121 sender addresses from a message. Callout verification therefore tests to see
29122 whether a bounce message could be delivered, by using an empty address in the
29123 MAIL command. However, it is arguable that these addresses might never be used
29124 as envelope senders, and could therefore justifiably reject bounce messages
29125 (empty senders). The &%mailfrom%& callout parameter allows you to specify what
29126 address to use in the MAIL command. For example:
29127 .code
29128 require  verify = header_sender/callout=mailfrom=abcd@x.y.z
29129 .endd
29130 This parameter is available only for the &%header_sender%& verification option.
29131
29132
29133 .vitem &*maxwait&~=&~*&<&'time&~interval'&>
29134 .cindex "callout" "overall timeout, specifying"
29135 This parameter sets an overall timeout for performing a callout verification.
29136 For example:
29137 .code
29138 verify = sender/callout=5s,maxwait=30s
29139 .endd
29140 This timeout defaults to four times the callout timeout for individual SMTP
29141 commands. The overall timeout applies when there is more than one host that can
29142 be tried. The timeout is checked before trying the next host. This prevents
29143 very long delays if there are a large number of hosts and all are timing out
29144 (for example, when network connections are timing out).
29145
29146
29147 .vitem &*no_cache*&
29148 .cindex "callout" "cache, suppressing"
29149 .cindex "caching callout, suppressing"
29150 When this parameter is given, the callout cache is neither read nor updated.
29151
29152 .vitem &*postmaster*&
29153 .cindex "callout" "postmaster; checking"
29154 When this parameter is set, a successful callout check is followed by a similar
29155 check for the local part &'postmaster'& at the same domain. If this address is
29156 rejected, the callout fails (but see &%fullpostmaster%& above). The result of
29157 the postmaster check is recorded in a cache record; if it is a failure, this is
29158 used to fail subsequent callouts for the domain without a connection being
29159 made, until the cache record expires.
29160
29161 .vitem &*postmaster_mailfrom&~=&~*&<&'email&~address'&>
29162 The postmaster check uses an empty sender in the MAIL command by default.
29163 You can use this parameter to do a postmaster check using a different address.
29164 For example:
29165 .code
29166 require  verify = sender/callout=postmaster_mailfrom=abc@x.y.z
29167 .endd
29168 If both &%postmaster%& and &%postmaster_mailfrom%& are present, the rightmost
29169 one overrides. The &%postmaster%& parameter is equivalent to this example:
29170 .code
29171 require  verify = sender/callout=postmaster_mailfrom=
29172 .endd
29173 &*Warning*&: The caching arrangements for postmaster checking do not take
29174 account of the sender address. It is assumed that either the empty address or
29175 a fixed non-empty address will be used. All that Exim remembers is that the
29176 postmaster check for the domain succeeded or failed.
29177
29178
29179 .vitem &*random*&
29180 .cindex "callout" "&""random""& check"
29181 When this parameter is set, before doing the normal callout check, Exim does a
29182 check for a &"random"& local part at the same domain. The local part is not
29183 really random &-- it is defined by the expansion of the option
29184 &%callout_random_local_part%&, which defaults to
29185 .code
29186 $primary_hostname-$tod_epoch-testing
29187 .endd
29188 The idea here is to try to determine whether the remote host accepts all local
29189 parts without checking. If it does, there is no point in doing callouts for
29190 specific local parts. If the &"random"& check succeeds, the result is saved in
29191 a cache record, and used to force the current and subsequent callout checks to
29192 succeed without a connection being made, until the cache record expires.
29193
29194 .vitem &*use_postmaster*&
29195 .cindex "callout" "sender for recipient check"
29196 This parameter applies to recipient callouts only. For example:
29197 .code
29198 deny  !verify = recipient/callout=use_postmaster
29199 .endd
29200 .vindex "&$qualify_domain$&"
29201 It causes a non-empty postmaster address to be used in the MAIL command when
29202 performing the callout for the recipient, and also for a &"random"& check if
29203 that is configured. The local part of the address is &`postmaster`& and the
29204 domain is the contents of &$qualify_domain$&.
29205
29206 .vitem &*use_sender*&
29207 This option applies to recipient callouts only. For example:
29208 .code
29209 require  verify = recipient/callout=use_sender
29210 .endd
29211 It causes the message's actual sender address to be used in the MAIL
29212 command when performing the callout, instead of an empty address. There is no
29213 need to use this option unless you know that the called hosts make use of the
29214 sender when checking recipients. If used indiscriminately, it reduces the
29215 usefulness of callout caching.
29216 .endlist
29217
29218 If you use any of the parameters that set a non-empty sender for the MAIL
29219 command (&%mailfrom%&, &%postmaster_mailfrom%&, &%use_postmaster%&, or
29220 &%use_sender%&), you should think about possible loops. Recipient checking is
29221 usually done between two hosts that are under the same management, and the host
29222 that receives the callouts is not normally configured to do callouts itself.
29223 Therefore, it is normally safe to use &%use_postmaster%& or &%use_sender%& in
29224 these circumstances.
29225
29226 However, if you use a non-empty sender address for a callout to an arbitrary
29227 host, there is the likelihood that the remote host will itself initiate a
29228 callout check back to your host. As it is checking what appears to be a message
29229 sender, it is likely to use an empty address in MAIL, thus avoiding a
29230 callout loop. However, to be on the safe side it would be best to set up your
29231 own ACLs so that they do not do sender verification checks when the recipient
29232 is the address you use for header sender or postmaster callout checking.
29233
29234 Another issue to think about when using non-empty senders for callouts is
29235 caching. When you set &%mailfrom%& or &%use_sender%&, the cache record is keyed
29236 by the sender/recipient combination; thus, for any given recipient, many more
29237 actual callouts are performed than when an empty sender or postmaster is used.
29238
29239
29240
29241
29242 .section "Callout caching" "SECTcallvercache"
29243 .cindex "hints database" "callout cache"
29244 .cindex "callout" "cache, description of"
29245 .cindex "caching" "callout"
29246 Exim caches the results of callouts in order to reduce the amount of resources
29247 used, unless you specify the &%no_cache%& parameter with the &%callout%&
29248 option. A hints database called &"callout"& is used for the cache. Two
29249 different record types are used: one records the result of a callout check for
29250 a specific address, and the other records information that applies to the
29251 entire domain (for example, that it accepts the local part &'postmaster'&).
29252
29253 When an original callout fails, a detailed SMTP error message is given about
29254 the failure. However, for subsequent failures use the cache data, this message
29255 is not available.
29256
29257 The expiry times for negative and positive address cache records are
29258 independent, and can be set by the global options &%callout_negative_expire%&
29259 (default 2h) and &%callout_positive_expire%& (default 24h), respectively.
29260
29261 If a host gives a negative response to an SMTP connection, or rejects any
29262 commands up to and including
29263 .code
29264 MAIL FROM:<>
29265 .endd
29266 (but not including the MAIL command with a non-empty address),
29267 any callout attempt is bound to fail. Exim remembers such failures in a
29268 domain cache record, which it uses to fail callouts for the domain without
29269 making new connections, until the domain record times out. There are two
29270 separate expiry times for domain cache records:
29271 &%callout_domain_negative_expire%& (default 3h) and
29272 &%callout_domain_positive_expire%& (default 7d).
29273
29274 Domain records expire when the negative expiry time is reached if callouts
29275 cannot be made for the domain, or if the postmaster check failed.
29276 Otherwise, they expire when the positive expiry time is reached. This
29277 ensures that, for example, a host that stops accepting &"random"& local parts
29278 will eventually be noticed.
29279
29280 The callout caching mechanism is based on the domain of the address that is
29281 being tested. If the domain routes to several hosts, it is assumed that their
29282 behaviour will be the same.
29283
29284
29285
29286 .section "Sender address verification reporting" "SECTsenaddver"
29287 .cindex "verifying" "suppressing error details"
29288 See section &<<SECTaddressverification>>& for a general discussion of
29289 verification. When sender verification fails in an ACL, the details of the
29290 failure are given as additional output lines before the 550 response to the
29291 relevant SMTP command (RCPT or DATA). For example, if sender callout is in use,
29292 you might see:
29293 .code
29294 MAIL FROM:<xyz@abc.example>
29295 250 OK
29296 RCPT TO:<pqr@def.example>
29297 550-Verification failed for <xyz@abc.example>
29298 550-Called:   192.168.34.43
29299 550-Sent:     RCPT TO:<xyz@abc.example>
29300 550-Response: 550 Unknown local part xyz in <xyz@abc.example>
29301 550 Sender verification failed
29302 .endd
29303 If more than one RCPT command fails in the same way, the details are given
29304 only for the first of them. However, some administrators do not want to send
29305 out this much information. You can suppress the details by adding
29306 &`/no_details`& to the ACL statement that requests sender verification. For
29307 example:
29308 .code
29309 verify = sender/no_details
29310 .endd
29311
29312 .section "Redirection while verifying" "SECTredirwhilveri"
29313 .cindex "verifying" "redirection while"
29314 .cindex "address redirection" "while verifying"
29315 A dilemma arises when a local address is redirected by aliasing or forwarding
29316 during verification: should the generated addresses themselves be verified,
29317 or should the successful expansion of the original address be enough to verify
29318 it? By default, Exim takes the following pragmatic approach:
29319
29320 .ilist
29321 When an incoming address is redirected to just one child address, verification
29322 continues with the child address, and if that fails to verify, the original
29323 verification also fails.
29324 .next
29325 When an incoming address is redirected to more than one child address,
29326 verification does not continue. A success result is returned.
29327 .endlist
29328
29329 This seems the most reasonable behaviour for the common use of aliasing as a
29330 way of redirecting different local parts to the same mailbox. It means, for
29331 example, that a pair of alias entries of the form
29332 .code
29333 A.Wol:   aw123
29334 aw123:   :fail: Gone away, no forwarding address
29335 .endd
29336 work as expected, with both local parts causing verification failure. When a
29337 redirection generates more than one address, the behaviour is more like a
29338 mailing list, where the existence of the alias itself is sufficient for
29339 verification to succeed.
29340
29341 It is possible, however, to change the default behaviour so that all successful
29342 redirections count as successful verifications, however many new addresses are
29343 generated. This is specified by the &%success_on_redirect%& verification
29344 option. For example:
29345 .code
29346 require verify = recipient/success_on_redirect/callout=10s
29347 .endd
29348 In this example, verification succeeds if a router generates a new address, and
29349 the callout does not occur, because no address was routed to a remote host.
29350
29351 When verification is being tested via the &%-bv%& option, the treatment of
29352 redirections is as just described, unless the &%-v%& or any debugging option is
29353 also specified. In that case, full verification is done for every generated
29354 address and a report is output for each of them.
29355
29356
29357
29358 .section "Client SMTP authorization (CSA)" "SECTverifyCSA"
29359 .cindex "CSA" "verifying"
29360 Client SMTP Authorization is a system that allows a site to advertise
29361 which machines are and are not permitted to send email. This is done by placing
29362 special SRV records in the DNS; these are looked up using the client's HELO
29363 domain. At the time of writing, CSA is still an Internet Draft. Client SMTP
29364 Authorization checks in Exim are performed by the ACL condition:
29365 .code
29366 verify = csa
29367 .endd
29368 This fails if the client is not authorized. If there is a DNS problem, or if no
29369 valid CSA SRV record is found, or if the client is authorized, the condition
29370 succeeds. These three cases can be distinguished using the expansion variable
29371 &$csa_status$&, which can take one of the values &"fail"&, &"defer"&,
29372 &"unknown"&, or &"ok"&. The condition does not itself defer because that would
29373 be likely to cause problems for legitimate email.
29374
29375 The error messages produced by the CSA code include slightly more
29376 detail. If &$csa_status$& is &"defer"&, this may be because of problems
29377 looking up the CSA SRV record, or problems looking up the CSA target
29378 address record. There are four reasons for &$csa_status$& being &"fail"&:
29379
29380 .ilist
29381 The client's host name is explicitly not authorized.
29382 .next
29383 The client's IP address does not match any of the CSA target IP addresses.
29384 .next
29385 The client's host name is authorized but it has no valid target IP addresses
29386 (for example, the target's addresses are IPv6 and the client is using IPv4).
29387 .next
29388 The client's host name has no CSA SRV record but a parent domain has asserted
29389 that all subdomains must be explicitly authorized.
29390 .endlist
29391
29392 The &%csa%& verification condition can take an argument which is the domain to
29393 use for the DNS query. The default is:
29394 .code
29395 verify = csa/$sender_helo_name
29396 .endd
29397 This implementation includes an extension to CSA. If the query domain
29398 is an address literal such as [192.0.2.95], or if it is a bare IP
29399 address, Exim searches for CSA SRV records in the reverse DNS as if
29400 the HELO domain was (for example) &'95.2.0.192.in-addr.arpa'&. Therefore it is
29401 meaningful to say:
29402 .code
29403 verify = csa/$sender_host_address
29404 .endd
29405 In fact, this is the check that Exim performs if the client does not say HELO.
29406 This extension can be turned off by setting the main configuration option
29407 &%dns_csa_use_reverse%& to be false.
29408
29409 If a CSA SRV record is not found for the domain itself, a search
29410 is performed through its parent domains for a record which might be
29411 making assertions about subdomains. The maximum depth of this search is limited
29412 using the main configuration option &%dns_csa_search_limit%&, which is 5 by
29413 default. Exim does not look for CSA SRV records in a top level domain, so the
29414 default settings handle HELO domains as long as seven
29415 (&'hostname.five.four.three.two.one.com'&). This encompasses the vast majority
29416 of legitimate HELO domains.
29417
29418 The &'dnsdb'& lookup also has support for CSA. Although &'dnsdb'& also supports
29419 direct SRV lookups, this is not sufficient because of the extra parent domain
29420 search behaviour of CSA, and (as with PTR lookups) &'dnsdb'& also turns IP
29421 addresses into lookups in the reverse DNS space. The result of a successful
29422 lookup such as:
29423 .code
29424 ${lookup dnsdb {csa=$sender_helo_name}}
29425 .endd
29426 has two space-separated fields: an authorization code and a target host name.
29427 The authorization code can be &"Y"& for yes, &"N"& for no, &"X"& for explicit
29428 authorization required but absent, or &"?"& for unknown.
29429
29430
29431
29432
29433 .section "Bounce address tag validation" "SECTverifyPRVS"
29434 .cindex "BATV, verifying"
29435 Bounce address tag validation (BATV) is a scheme whereby the envelope senders
29436 of outgoing messages have a cryptographic, timestamped &"tag"& added to them.
29437 Genuine incoming bounce messages should therefore always be addressed to
29438 recipients that have a valid tag. This scheme is a way of detecting unwanted
29439 bounce messages caused by sender address forgeries (often called &"collateral
29440 spam"&), because the recipients of such messages do not include valid tags.
29441
29442 There are two expansion items to help with the implementation of the BATV
29443 &"prvs"& (private signature) scheme in an Exim configuration. This scheme signs
29444 the original envelope sender address by using a simple key to add a hash of the
29445 address and some time-based randomizing information. The &%prvs%& expansion
29446 item creates a signed address, and the &%prvscheck%& expansion item checks one.
29447 The syntax of these expansion items is described in section
29448 &<<SECTexpansionitems>>&.
29449
29450 As an example, suppose the secret per-address keys are stored in an MySQL
29451 database. A query to look up the key for an address could be defined as a macro
29452 like this:
29453 .code
29454 PRVSCHECK_SQL = ${lookup mysql{SELECT secret FROM batv_prvs \
29455                 WHERE sender='${quote_mysql:$prvscheck_address}'\
29456                 }{$value}}
29457 .endd
29458 Suppose also that the senders who make use of BATV are defined by an address
29459 list called &%batv_senders%&. Then, in the ACL for RCPT commands, you could
29460 use this:
29461 .code
29462 # Bounces: drop unsigned addresses for BATV senders
29463 deny message = This address does not send an unsigned reverse path
29464      senders = :
29465      recipients = +batv_senders
29466
29467 # Bounces: In case of prvs-signed address, check signature.
29468 deny message = Invalid reverse path signature.
29469      senders = :
29470      condition  = ${prvscheck {$local_part@$domain}\
29471                   {PRVSCHECK_SQL}{1}}
29472      !condition = $prvscheck_result
29473 .endd
29474 The first statement rejects recipients for bounce messages that are addressed
29475 to plain BATV sender addresses, because it is known that BATV senders do not
29476 send out messages with plain sender addresses. The second statement rejects
29477 recipients that are prvs-signed, but with invalid signatures (either because
29478 the key is wrong, or the signature has timed out).
29479
29480 A non-prvs-signed address is not rejected by the second statement, because the
29481 &%prvscheck%& expansion yields an empty string if its first argument is not a
29482 prvs-signed address, thus causing the &%condition%& condition to be false. If
29483 the first argument is a syntactically valid prvs-signed address, the yield is
29484 the third string (in this case &"1"&), whether or not the cryptographic and
29485 timeout checks succeed. The &$prvscheck_result$& variable contains the result
29486 of the checks (empty for failure, &"1"& for success).
29487
29488 There is one more issue you must consider when implementing prvs-signing:
29489 you have to ensure that the routers accept prvs-signed addresses and
29490 deliver them correctly. The easiest way to handle this is to use a &(redirect)&
29491 router to remove the signature with a configuration along these lines:
29492 .code
29493 batv_redirect:
29494   driver = redirect
29495   data = ${prvscheck {$local_part@$domain}{PRVSCHECK_SQL}}
29496 .endd
29497 This works because, if the third argument of &%prvscheck%& is empty, the result
29498 of the expansion of a prvs-signed address is the decoded value of the original
29499 address. This router should probably be the first of your routers that handles
29500 local addresses.
29501
29502 To create BATV-signed addresses in the first place, a transport of this form
29503 can be used:
29504 .code
29505 external_smtp_batv:
29506   driver = smtp
29507   return_path = ${prvs {$return_path} \
29508                        {${lookup mysql{SELECT \
29509                        secret FROM batv_prvs WHERE \
29510                        sender='${quote_mysql:$sender_address}'} \
29511                        {$value}fail}}}
29512 .endd
29513 If no key can be found for the existing return path, no signing takes place.
29514
29515
29516
29517 .section "Using an ACL to control relaying" "SECTrelaycontrol"
29518 .cindex "&ACL;" "relay control"
29519 .cindex "relaying" "control by ACL"
29520 .cindex "policy control" "relay control"
29521 An MTA is said to &'relay'& a message if it receives it from some host and
29522 delivers it directly to another host as a result of a remote address contained
29523 within it. Redirecting a local address via an alias or forward file and then
29524 passing the message on to another host is not relaying,
29525 .cindex "&""percent hack""&"
29526 but a redirection as a result of the &"percent hack"& is.
29527
29528 Two kinds of relaying exist, which are termed &"incoming"& and &"outgoing"&.
29529 A host which is acting as a gateway or an MX backup is concerned with incoming
29530 relaying from arbitrary hosts to a specific set of domains. On the other hand,
29531 a host which is acting as a smart host for a number of clients is concerned
29532 with outgoing relaying from those clients to the Internet at large. Often the
29533 same host is fulfilling both functions,
29534 . ///
29535 . as illustrated in the diagram below,
29536 . ///
29537 but in principle these two kinds of relaying are entirely independent. What is
29538 not wanted is the transmission of mail from arbitrary remote hosts through your
29539 system to arbitrary domains.
29540
29541
29542 You can implement relay control by means of suitable statements in the ACL that
29543 runs for each RCPT command. For convenience, it is often easiest to use
29544 Exim's named list facility to define the domains and hosts involved. For
29545 example, suppose you want to do the following:
29546
29547 .ilist
29548 Deliver a number of domains to mailboxes on the local host (or process them
29549 locally in some other way). Let's say these are &'my.dom1.example'& and
29550 &'my.dom2.example'&.
29551 .next
29552 Relay mail for a number of other domains for which you are the secondary MX.
29553 These might be &'friend1.example'& and &'friend2.example'&.
29554 .next
29555 Relay mail from the hosts on your local LAN, to whatever domains are involved.
29556 Suppose your LAN is 192.168.45.0/24.
29557 .endlist
29558
29559
29560 In the main part of the configuration, you put the following definitions:
29561 .code
29562 domainlist local_domains    = my.dom1.example : my.dom2.example
29563 domainlist relay_to_domains = friend1.example : friend2.example
29564 hostlist   relay_from_hosts = 192.168.45.0/24
29565 .endd
29566 Now you can use these definitions in the ACL that is run for every RCPT
29567 command:
29568 .code
29569 acl_check_rcpt:
29570   accept domains = +local_domains : +relay_to_domains
29571   accept hosts   = +relay_from_hosts
29572 .endd
29573 The first statement accepts any RCPT command that contains an address in
29574 the local or relay domains. For any other domain, control passes to the second
29575 statement, which accepts the command only if it comes from one of the relay
29576 hosts. In practice, you will probably want to make your ACL more sophisticated
29577 than this, for example, by including sender and recipient verification. The
29578 default configuration includes a more comprehensive example, which is described
29579 in chapter &<<CHAPdefconfil>>&.
29580
29581
29582
29583 .section "Checking a relay configuration" "SECTcheralcon"
29584 .cindex "relaying" "checking control of"
29585 You can check the relay characteristics of your configuration in the same way
29586 that you can test any ACL behaviour for an incoming SMTP connection, by using
29587 the &%-bh%& option to run a fake SMTP session with which you interact.
29588
29589 For specifically testing for unwanted relaying, the host
29590 &'relay-test.mail-abuse.org'& provides a useful service. If you telnet to this
29591 host from the host on which Exim is running, using the normal telnet port, you
29592 will see a normal telnet connection message and then quite a long delay. Be
29593 patient. The remote host is making an SMTP connection back to your host, and
29594 trying a number of common probes to test for open relay vulnerability. The
29595 results of the tests will eventually appear on your terminal.
29596 .ecindex IIDacl
29597
29598
29599
29600 . ////////////////////////////////////////////////////////////////////////////
29601 . ////////////////////////////////////////////////////////////////////////////
29602
29603 .chapter "Content scanning at ACL time" "CHAPexiscan"
29604 .scindex IIDcosca "content scanning" "at ACL time"
29605 The extension of Exim to include content scanning at ACL time, formerly known
29606 as &"exiscan"&, was originally implemented as a patch by Tom Kistner. The code
29607 was integrated into the main source for Exim release 4.50, and Tom continues to
29608 maintain it. Most of the wording of this chapter is taken from Tom's
29609 specification.
29610
29611 It is also possible to scan the content of messages at other times. The
29612 &[local_scan()]& function (see chapter &<<CHAPlocalscan>>&) allows for content
29613 scanning after all the ACLs have run. A transport filter can be used to scan
29614 messages at delivery time (see the &%transport_filter%& option, described in
29615 chapter &<<CHAPtransportgeneric>>&).
29616
29617 If you want to include the ACL-time content-scanning features when you compile
29618 Exim, you need to arrange for WITH_CONTENT_SCAN to be defined in your
29619 &_Local/Makefile_&. When you do that, the Exim binary is built with:
29620
29621 .ilist
29622 Two additional ACLs (&%acl_smtp_mime%& and &%acl_not_smtp_mime%&) that are run
29623 for all MIME parts for SMTP and non-SMTP messages, respectively.
29624 .next
29625 Additional ACL conditions and modifiers: &%decode%&, &%malware%&,
29626 &%mime_regex%&, &%regex%&, and &%spam%&. These can be used in the ACL that is
29627 run at the end of message reception (the &%acl_smtp_data%& ACL).
29628 .next
29629 An additional control feature (&"no_mbox_unspool"&) that saves spooled copies
29630 of messages, or parts of messages, for debugging purposes.
29631 .next
29632 Additional expansion variables that are set in the new ACL and by the new
29633 conditions.
29634 .next
29635 Two new main configuration options: &%av_scanner%& and &%spamd_address%&.
29636 .endlist
29637
29638 There is another content-scanning configuration option for &_Local/Makefile_&,
29639 called WITH_OLD_DEMIME. If this is set, the old, deprecated &%demime%& ACL
29640 condition is compiled, in addition to all the other content-scanning features.
29641
29642 Content-scanning is continually evolving, and new features are still being
29643 added. While such features are still unstable and liable to incompatible
29644 changes, they are made available in Exim by setting options whose names begin
29645 EXPERIMENTAL_ in &_Local/Makefile_&. Such features are not documented in
29646 this manual. You can find out about them by reading the file called
29647 &_doc/experimental.txt_&.
29648
29649 All the content-scanning facilities work on a MBOX copy of the message that is
29650 temporarily created in a file called:
29651 .display
29652 <&'spool_directory'&>&`/scan/`&<&'message_id'&>/<&'message_id'&>&`.eml`&
29653 .endd
29654 The &_.eml_& extension is a friendly hint to virus scanners that they can
29655 expect an MBOX-like structure inside that file. The file is created when the
29656 first content scanning facility is called. Subsequent calls to content
29657 scanning conditions open the same file again. The directory is recursively
29658 removed when the &%acl_smtp_data%& ACL has finished running, unless
29659 .code
29660 control = no_mbox_unspool
29661 .endd
29662 has been encountered. When the MIME ACL decodes files, they are put into the
29663 same directory by default.
29664
29665
29666
29667 .section "Scanning for viruses" "SECTscanvirus"
29668 .cindex "virus scanning"
29669 .cindex "content scanning" "for viruses"
29670 .cindex "content scanning" "the &%malware%& condition"
29671 The &%malware%& ACL condition lets you connect virus scanner software to Exim.
29672 It supports a &"generic"& interface to scanners called via the shell, and
29673 specialized interfaces for &"daemon"& type virus scanners, which are resident
29674 in memory and thus are much faster.
29675
29676
29677 .oindex "&%av_scanner%&"
29678 You can set the &%av_scanner%& option in first part of the Exim configuration
29679 file to specify which scanner to use, together with any additional options that
29680 are needed. The basic syntax is as follows:
29681 .display
29682 &`av_scanner = <`&&'scanner-type'&&`>:<`&&'option1'&&`>:<`&&'option2'&&`>:[...]`&
29683 .endd
29684 If you do not set &%av_scanner%&, it defaults to
29685 .code
29686 av_scanner = sophie:/var/run/sophie
29687 .endd
29688 If the value of &%av_scanner%& starts with a dollar character, it is expanded
29689 before use.
29690 The usual list-parsing of the content (see &<<SECTlistconstruct>>&) applies.
29691 The following scanner types are supported in this release:
29692
29693 .vlist
29694 .vitem &%aveserver%&
29695 .cindex "virus scanners" "Kaspersky"
29696 This is the scanner daemon of Kaspersky Version 5. You can get a trial version
29697 at &url(http://www.kaspersky.com). This scanner type takes one option,
29698 which is the path to the daemon's UNIX socket. The default is shown in this
29699 example:
29700 .code
29701 av_scanner = aveserver:/var/run/aveserver
29702 .endd
29703
29704
29705 .vitem &%clamd%&
29706 .cindex "virus scanners" "clamd"
29707 This daemon-type scanner is GPL and free. You can get it at
29708 &url(http://www.clamav.net/). Some older versions of clamd do not seem to
29709 unpack MIME containers, so it used to be recommended to unpack MIME attachments
29710 in the MIME ACL. This no longer believed to be necessary. One option is
29711 required: either the path and name of a UNIX socket file, or a hostname or IP
29712 number, and a port, separated by space, as in the second of these examples:
29713 .code
29714 av_scanner = clamd:/opt/clamd/socket
29715 av_scanner = clamd:192.0.2.3 1234
29716 av_scanner = clamd:192.0.2.3 1234:local
29717 av_scanner = clamd:192.0.2.3 1234 : 192.0.2.4 1234
29718 .endd
29719 If the value of av_scanner points to a UNIX socket file or contains the local
29720 keyword, then the ClamAV interface will pass a filename containing the data
29721 to be scanned, which will should normally result in less I/O happening and be
29722 more efficient.  Normally in the TCP case, the data is streamed to ClamAV as
29723 Exim does not assume that there is a common filesystem with the remote host.
29724 There is an option WITH_OLD_CLAMAV_STREAM in &_src/EDITME_& available, should
29725 you be running a version of ClamAV prior to 0.95.
29726
29727 The final example shows that multiple TCP targets can be specified.  Exim will
29728 randomly use one for each incoming email (i.e. it load balances them).  Note
29729 that only TCP targets may be used if specifying a list of scanners; a UNIX
29730 socket cannot be mixed in with TCP targets.  If one of the servers becomes
29731 unavailable, Exim will try the remaining one(s) until it finds one that works.
29732 When a clamd server becomes unreachable, Exim will log a message.  Exim does
29733 not keep track of scanner state between multiple messages, and the scanner
29734 selection is random, so the message will get logged in the mainlog for each
29735 email that the down scanner gets chosen first (message wrapped to be readable):
29736 .code
29737 2013-10-09 14:30:39 1VTumd-0000Y8-BQ malware acl condition:
29738    clamd: connection to localhost, port 3310 failed
29739    (Connection refused)
29740 .endd
29741
29742 If the option is unset, the default is &_/tmp/clamd_&. Thanks to David Saez for
29743 contributing the code for this scanner.
29744
29745 .vitem &%cmdline%&
29746 .cindex "virus scanners" "command line interface"
29747 This is the keyword for the generic command line scanner interface. It can be
29748 used to attach virus scanners that are invoked from the shell. This scanner
29749 type takes 3 mandatory options:
29750
29751 .olist
29752 The full path and name of the scanner binary, with all command line options,
29753 and a placeholder (&`%s`&) for the directory to scan.
29754
29755 .next
29756 A regular expression to match against the STDOUT and STDERR output of the
29757 virus scanner. If the expression matches, a virus was found. You must make
29758 absolutely sure that this expression matches on &"virus found"&. This is called
29759 the &"trigger"& expression.
29760
29761 .next
29762 Another regular expression, containing exactly one pair of parentheses, to
29763 match the name of the virus found in the scanners output. This is called the
29764 &"name"& expression.
29765 .endlist olist
29766
29767 For example, Sophos Sweep reports a virus on a line like this:
29768 .code
29769 Virus 'W32/Magistr-B' found in file ./those.bat
29770 .endd
29771 For the trigger expression, we can match the phrase &"found in file"&. For the
29772 name expression, we want to extract the W32/Magistr-B string, so we can match
29773 for the single quotes left and right of it. Altogether, this makes the
29774 configuration setting:
29775 .code
29776 av_scanner = cmdline:\
29777              /path/to/sweep -ss -all -rec -archive %s:\
29778              found in file:'(.+)'
29779 .endd
29780 .vitem &%drweb%&
29781 .cindex "virus scanners" "DrWeb"
29782 The DrWeb daemon scanner (&url(http://www.sald.com/)) interface takes one
29783 argument, either a full path to a UNIX socket, or an IP address and port
29784 separated by white space, as in these examples:
29785 .code
29786 av_scanner = drweb:/var/run/drwebd.sock
29787 av_scanner = drweb:192.168.2.20 31337
29788 .endd
29789 If you omit the argument, the default path &_/usr/local/drweb/run/drwebd.sock_&
29790 is used. Thanks to Alex Miller for contributing the code for this scanner.
29791
29792 .vitem &%fsecure%&
29793 .cindex "virus scanners" "F-Secure"
29794 The F-Secure daemon scanner (&url(http://www.f-secure.com)) takes one
29795 argument which is the path to a UNIX socket. For example:
29796 .code
29797 av_scanner = fsecure:/path/to/.fsav
29798 .endd
29799 If no argument is given, the default is &_/var/run/.fsav_&. Thanks to Johan
29800 Thelmen for contributing the code for this scanner.
29801
29802 .vitem &%kavdaemon%&
29803 .cindex "virus scanners" "Kaspersky"
29804 This is the scanner daemon of Kaspersky Version 4. This version of the
29805 Kaspersky scanner is outdated. Please upgrade (see &%aveserver%& above). This
29806 scanner type takes one option, which is the path to the daemon's UNIX socket.
29807 For example:
29808 .code
29809 av_scanner = kavdaemon:/opt/AVP/AvpCtl
29810 .endd
29811 The default path is &_/var/run/AvpCtl_&.
29812
29813 .vitem &%mksd%&
29814 .cindex "virus scanners" "mksd"
29815 This is a daemon type scanner that is aimed mainly at Polish users, though some
29816 parts of documentation are now available in English. You can get it at
29817 &url(http://linux.mks.com.pl/). The only option for this scanner type is
29818 the maximum number of processes used simultaneously to scan the attachments,
29819 provided that the demime facility is employed and also provided that mksd has
29820 been run with at least the same number of child processes. For example:
29821 .code
29822 av_scanner = mksd:2
29823 .endd
29824 You can safely omit this option (the default value is 1).
29825
29826 .vitem &%sock%&
29827 .cindex "virus scanners" "simple socket-connected"
29828 This is a general-purpose way of talking to simple scanner daemons
29829 running on the local machine.
29830 There are four options:
29831 an address (which may be an IP addres and port, or the path of a Unix socket),
29832 a commandline to send (may include a single %s which will be replaced with
29833 the path to the mail file to be scanned),
29834 an RE to trigger on from the returned data,
29835 an RE to extract malware_name from the returned data.
29836 For example:
29837 .code
29838 av_scanner = sock:127.0.0.1 6001:%s:(SPAM|VIRUS):(.*)\$
29839 .endd
29840 Default for the socket specifier is &_/tmp/malware.sock_&.
29841 Default for the commandline is &_%s\n_&.
29842 Both regular-expressions are required.
29843
29844 .vitem &%sophie%&
29845 .cindex "virus scanners" "Sophos and Sophie"
29846 Sophie is a daemon that uses Sophos' &%libsavi%& library to scan for viruses.
29847 You can get Sophie at &url(http://www.clanfield.info/sophie/). The only option
29848 for this scanner type is the path to the UNIX socket that Sophie uses for
29849 client communication. For example:
29850 .code
29851 av_scanner = sophie:/tmp/sophie
29852 .endd
29853 The default path is &_/var/run/sophie_&, so if you are using this, you can omit
29854 the option.
29855 .endlist
29856
29857 When &%av_scanner%& is correctly set, you can use the &%malware%& condition in
29858 the DATA ACL. &*Note*&: You cannot use the &%malware%& condition in the MIME
29859 ACL.
29860
29861 The &%av_scanner%& option is expanded each time &%malware%& is called. This
29862 makes it possible to use different scanners. See further below for an example.
29863 The &%malware%& condition caches its results, so when you use it multiple times
29864 for the same message, the actual scanning process is only carried out once.
29865 However, using expandable items in &%av_scanner%& disables this caching, in
29866 which case each use of the &%malware%& condition causes a new scan of the
29867 message.
29868
29869 The &%malware%& condition takes a right-hand argument that is expanded before
29870 use. It can then be one of
29871
29872 .ilist
29873 &"true"&, &"*"&, or &"1"&, in which case the message is scanned for viruses.
29874 The condition succeeds if a virus was found, and fail otherwise. This is the
29875 recommended usage.
29876 .next
29877 &"false"& or &"0"& or an empty string, in which case no scanning is done and
29878 the condition fails immediately.
29879 .next
29880 A regular expression, in which case the message is scanned for viruses. The
29881 condition succeeds if a virus is found and its name matches the regular
29882 expression. This allows you to take special actions on certain types of virus.
29883 .endlist
29884
29885 You can append &`/defer_ok`& to the &%malware%& condition to accept messages
29886 even if there is a problem with the virus scanner. Otherwise, such a problem
29887 causes the ACL to defer.
29888
29889 .vindex "&$malware_name$&"
29890 When a virus is found, the condition sets up an expansion variable called
29891 &$malware_name$& that contains the name of the virus. You can use it in a
29892 &%message%& modifier that specifies the error returned to the sender, and/or in
29893 logging data.
29894
29895 If your virus scanner cannot unpack MIME and TNEF containers itself, you should
29896 use the &%demime%& condition (see section &<<SECTdemimecond>>&) before the
29897 &%malware%& condition.
29898
29899 Beware the interaction of Exim's &%message_size_limit%& with any size limits
29900 imposed by your anti-virus scanner.
29901
29902 Here is a very simple scanning example:
29903 .code
29904 deny message = This message contains malware ($malware_name)
29905      demime = *
29906      malware = *
29907 .endd
29908 The next example accepts messages when there is a problem with the scanner:
29909 .code
29910 deny message = This message contains malware ($malware_name)
29911      demime = *
29912      malware = */defer_ok
29913 .endd
29914 The next example shows how to use an ACL variable to scan with both sophie and
29915 aveserver. It assumes you have set:
29916 .code
29917 av_scanner = $acl_m0
29918 .endd
29919 in the main Exim configuration.
29920 .code
29921 deny message = This message contains malware ($malware_name)
29922      set acl_m0 = sophie
29923      malware = *
29924
29925 deny message = This message contains malware ($malware_name)
29926      set acl_m0 = aveserver
29927      malware = *
29928 .endd
29929
29930
29931 .section "Scanning with SpamAssassin" "SECTscanspamass"
29932 .cindex "content scanning" "for spam"
29933 .cindex "spam scanning"
29934 .cindex "SpamAssassin"
29935 The &%spam%& ACL condition calls SpamAssassin's &%spamd%& daemon to get a spam
29936 score and a report for the message. You can get SpamAssassin at
29937 &url(http://www.spamassassin.org), or, if you have a working Perl
29938 installation, you can use CPAN by running:
29939 .code
29940 perl -MCPAN -e 'install Mail::SpamAssassin'
29941 .endd
29942 SpamAssassin has its own set of configuration files. Please review its
29943 documentation to see how you can tweak it. The default installation should work
29944 nicely, however.
29945
29946 .oindex "&%spamd_address%&"
29947 After having installed and configured SpamAssassin, start the &%spamd%& daemon.
29948 By default, it listens on 127.0.0.1, TCP port 783. If you use another host or
29949 port for &%spamd%&, you must set the &%spamd_address%& option in the global
29950 part of the Exim configuration as follows (example):
29951 .code
29952 spamd_address = 192.168.99.45 387
29953 .endd
29954 You do not need to set this option if you use the default. As of version 2.60,
29955 &%spamd%& also supports communication over UNIX sockets. If you want to use
29956 these, supply &%spamd_address%& with an absolute file name instead of a
29957 address/port pair:
29958 .code
29959 spamd_address = /var/run/spamd_socket
29960 .endd
29961 You can have multiple &%spamd%& servers to improve scalability. These can
29962 reside on other hardware reachable over the network. To specify multiple
29963 &%spamd%& servers, put multiple address/port pairs in the &%spamd_address%&
29964 option, separated with colons:
29965 .code
29966 spamd_address = 192.168.2.10 783 : \
29967                 192.168.2.11 783 : \
29968                 192.168.2.12 783
29969 .endd
29970 Up to 32 &%spamd%& servers are supported. The servers are queried in a random
29971 fashion. When a server fails to respond to the connection attempt, all other
29972 servers are tried until one succeeds. If no server responds, the &%spam%&
29973 condition defers.
29974
29975 &*Warning*&: It is not possible to use the UNIX socket connection method with
29976 multiple &%spamd%& servers.
29977
29978 The &%spamd_address%& variable is expanded before use if it starts with
29979 a dollar sign. In this case, the expansion may return a string that is
29980 used as the list so that multiple spamd servers can be the result of an
29981 expansion.
29982
29983 .section "Calling SpamAssassin from an Exim ACL" "SECID206"
29984 Here is a simple example of the use of the &%spam%& condition in a DATA ACL:
29985 .code
29986 deny message = This message was classified as SPAM
29987      spam = joe
29988 .endd
29989 The right-hand side of the &%spam%& condition specifies a name. This is
29990 relevant if you have set up multiple SpamAssassin profiles. If you do not want
29991 to scan using a specific profile, but rather use the SpamAssassin system-wide
29992 default profile, you can scan for an unknown name, or simply use &"nobody"&.
29993 However, you must put something on the right-hand side.
29994
29995 The name allows you to use per-domain or per-user antispam profiles in
29996 principle, but this is not straightforward in practice, because a message may
29997 have multiple recipients, not necessarily all in the same domain. Because the
29998 &%spam%& condition has to be called from a DATA ACL in order to be able to
29999 read the contents of the message, the variables &$local_part$& and &$domain$&
30000 are not set.
30001
30002 The right-hand side of the &%spam%& condition is expanded before being used, so
30003 you can put lookups or conditions there. When the right-hand side evaluates to
30004 &"0"& or &"false"&, no scanning is done and the condition fails immediately.
30005
30006
30007 Scanning with SpamAssassin uses a lot of resources. If you scan every message,
30008 large ones may cause significant performance degradation. As most spam messages
30009 are quite small, it is recommended that you do not scan the big ones. For
30010 example:
30011 .code
30012 deny message = This message was classified as SPAM
30013      condition = ${if < {$message_size}{10K}}
30014      spam = nobody
30015 .endd
30016
30017 The &%spam%& condition returns true if the threshold specified in the user's
30018 SpamAssassin profile has been matched or exceeded. If you want to use the
30019 &%spam%& condition for its side effects (see the variables below), you can make
30020 it always return &"true"& by appending &`:true`& to the username.
30021
30022 .cindex "spam scanning" "returned variables"
30023 When the &%spam%& condition is run, it sets up a number of expansion
30024 variables. These variables are saved with the received message, thus they are
30025 available for use at delivery time.
30026
30027 .vlist
30028 .vitem &$spam_score$&
30029 The spam score of the message, for example &"3.4"& or &"30.5"&. This is useful
30030 for inclusion in log or reject messages.
30031
30032 .vitem &$spam_score_int$&
30033 The spam score of the message, multiplied by ten, as an integer value. For
30034 example &"34"& or &"305"&. It may appear to disagree with &$spam_score$&
30035 because &$spam_score$& is rounded and &$spam_score_int$& is truncated.
30036 The integer value is useful for numeric comparisons in conditions.
30037
30038 .vitem &$spam_bar$&
30039 A string consisting of a number of &"+"& or &"-"& characters, representing the
30040 integer part of the spam score value. A spam score of 4.4 would have a
30041 &$spam_bar$& value of &"++++"&. This is useful for inclusion in warning
30042 headers, since MUAs can match on such strings.
30043
30044 .vitem &$spam_report$&
30045 A multiline text table, containing the full SpamAssassin report for the
30046 message. Useful for inclusion in headers or reject messages.
30047 .endlist
30048
30049 The &%spam%& condition caches its results unless expansion in
30050 spamd_address was used. If you call it again with the same user name, it
30051 does not scan again, but rather returns the same values as before.
30052
30053 The &%spam%& condition returns DEFER if there is any error while running
30054 the message through SpamAssassin or if the expansion of spamd_address
30055 failed. If you want to treat DEFER as FAIL (to pass on to the next ACL
30056 statement block), append &`/defer_ok`& to the right-hand side of the
30057 spam condition, like this:
30058 .code
30059 deny message = This message was classified as SPAM
30060      spam    = joe/defer_ok
30061 .endd
30062 This causes messages to be accepted even if there is a problem with &%spamd%&.
30063
30064 Here is a longer, commented example of the use of the &%spam%&
30065 condition:
30066 .code
30067 # put headers in all messages (no matter if spam or not)
30068 warn  spam = nobody:true
30069       add_header = X-Spam-Score: $spam_score ($spam_bar)
30070       add_header = X-Spam-Report: $spam_report
30071
30072 # add second subject line with *SPAM* marker when message
30073 # is over threshold
30074 warn  spam = nobody
30075       add_header = Subject: *SPAM* $h_Subject:
30076
30077 # reject spam at high scores (> 12)
30078 deny  message = This message scored $spam_score spam points.
30079       spam = nobody:true
30080       condition = ${if >{$spam_score_int}{120}{1}{0}}
30081 .endd
30082
30083
30084
30085 .section "Scanning MIME parts" "SECTscanmimepart"
30086 .cindex "content scanning" "MIME parts"
30087 .cindex "MIME content scanning"
30088 .oindex "&%acl_smtp_mime%&"
30089 .oindex "&%acl_not_smtp_mime%&"
30090 The &%acl_smtp_mime%& global option specifies an ACL that is called once for
30091 each MIME part of an SMTP message, including multipart types, in the sequence
30092 of their position in the message. Similarly, the &%acl_not_smtp_mime%& option
30093 specifies an ACL that is used for the MIME parts of non-SMTP messages. These
30094 options may both refer to the same ACL if you want the same processing in both
30095 cases.
30096
30097 These ACLs are called (possibly many times) just before the &%acl_smtp_data%&
30098 ACL in the case of an SMTP message, or just before the &%acl_not_smtp%& ACL in
30099 the case of a non-SMTP message. However, a MIME ACL is called only if the
30100 message contains a &'Content-Type:'& header line. When a call to a MIME
30101 ACL does not yield &"accept"&, ACL processing is aborted and the appropriate
30102 result code is sent to the client. In the case of an SMTP message, the
30103 &%acl_smtp_data%& ACL is not called when this happens.
30104
30105 You cannot use the &%malware%& or &%spam%& conditions in a MIME ACL; these can
30106 only be used in the DATA or non-SMTP ACLs. However, you can use the &%regex%&
30107 condition to match against the raw MIME part. You can also use the
30108 &%mime_regex%& condition to match against the decoded MIME part (see section
30109 &<<SECTscanregex>>&).
30110
30111 At the start of a MIME ACL, a number of variables are set from the header
30112 information for the relevant MIME part. These are described below. The contents
30113 of the MIME part are not by default decoded into a disk file except for MIME
30114 parts whose content-type is &"message/rfc822"&. If you want to decode a MIME
30115 part into a disk file, you can use the &%decode%& condition. The general
30116 syntax is:
30117 .display
30118 &`decode = [/`&<&'path'&>&`/]`&<&'filename'&>
30119 .endd
30120 The right hand side is expanded before use. After expansion,
30121 the value can be:
30122
30123 .olist
30124 &"0"& or &"false"&, in which case no decoding is done.
30125 .next
30126 The string &"default"&. In that case, the file is put in the temporary
30127 &"default"& directory <&'spool_directory'&>&_/scan/_&<&'message_id'&>&_/_& with
30128 a sequential file name consisting of the message id and a sequence number. The
30129 full path and name is available in &$mime_decoded_filename$& after decoding.
30130 .next
30131 A full path name starting with a slash. If the full name is an existing
30132 directory, it is used as a replacement for the default directory. The filename
30133 is then sequentially assigned. If the path does not exist, it is used as
30134 the full path and file name.
30135 .next
30136 If the string does not start with a slash, it is used as the
30137 filename, and the default path is then used.
30138 .endlist
30139 The &%decode%& condition normally succeeds. It is only false for syntax
30140 errors or unusual circumstances such as memory shortages. You can easily decode
30141 a file with its original, proposed filename using
30142 .code
30143 decode = $mime_filename
30144 .endd
30145 However, you should keep in mind that &$mime_filename$& might contain
30146 anything. If you place files outside of the default path, they are not
30147 automatically unlinked.
30148
30149 For RFC822 attachments (these are messages attached to messages, with a
30150 content-type of &"message/rfc822"&), the ACL is called again in the same manner
30151 as for the primary message, only that the &$mime_is_rfc822$& expansion
30152 variable is set (see below). Attached messages are always decoded to disk
30153 before being checked, and the files are unlinked once the check is done.
30154
30155 The MIME ACL supports the &%regex%& and &%mime_regex%& conditions. These can be
30156 used to match regular expressions against raw and decoded MIME parts,
30157 respectively. They are described in section &<<SECTscanregex>>&.
30158
30159 .cindex "MIME content scanning" "returned variables"
30160 The following list describes all expansion variables that are
30161 available in the MIME ACL:
30162
30163 .vlist
30164 .vitem &$mime_boundary$&
30165 If the current part is a multipart (see &$mime_is_multipart$&) below, it should
30166 have a boundary string, which is stored in this variable. If the current part
30167 has no boundary parameter in the &'Content-Type:'& header, this variable
30168 contains the empty string.
30169
30170 .vitem &$mime_charset$&
30171 This variable contains the character set identifier, if one was found in the
30172 &'Content-Type:'& header. Examples for charset identifiers are:
30173 .code
30174 us-ascii
30175 gb2312 (Chinese)
30176 iso-8859-1
30177 .endd
30178 Please note that this value is not normalized, so you should do matches
30179 case-insensitively.
30180
30181 .vitem &$mime_content_description$&
30182 This variable contains the normalized content of the &'Content-Description:'&
30183 header. It can contain a human-readable description of the parts content. Some
30184 implementations repeat the filename for attachments here, but they are usually
30185 only used for display purposes.
30186
30187 .vitem &$mime_content_disposition$&
30188 This variable contains the normalized content of the &'Content-Disposition:'&
30189 header. You can expect strings like &"attachment"& or &"inline"& here.
30190
30191 .vitem &$mime_content_id$&
30192 This variable contains the normalized content of the &'Content-ID:'& header.
30193 This is a unique ID that can be used to reference a part from another part.
30194
30195 .vitem &$mime_content_size$&
30196 This variable is set only after the &%decode%& modifier (see above) has been
30197 successfully run. It contains the size of the decoded part in kilobytes. The
30198 size is always rounded up to full kilobytes, so only a completely empty part
30199 has a &$mime_content_size$& of zero.
30200
30201 .vitem &$mime_content_transfer_encoding$&
30202 This variable contains the normalized content of the
30203 &'Content-transfer-encoding:'& header. This is a symbolic name for an encoding
30204 type. Typical values are &"base64"& and &"quoted-printable"&.
30205
30206 .vitem &$mime_content_type$&
30207 If the MIME part has a &'Content-Type:'& header, this variable contains its
30208 value, lowercased, and without any options (like &"name"& or &"charset"&). Here
30209 are some examples of popular MIME types, as they may appear in this variable:
30210 .code
30211 text/plain
30212 text/html
30213 application/octet-stream
30214 image/jpeg
30215 audio/midi
30216 .endd
30217 If the MIME part has no &'Content-Type:'& header, this variable contains the
30218 empty string.
30219
30220 .vitem &$mime_decoded_filename$&
30221 This variable is set only after the &%decode%& modifier (see above) has been
30222 successfully run. It contains the full path and file name of the file
30223 containing the decoded data.
30224 .endlist
30225
30226 .cindex "RFC 2047"
30227 .vlist
30228 .vitem &$mime_filename$&
30229 This is perhaps the most important of the MIME variables. It contains a
30230 proposed filename for an attachment, if one was found in either the
30231 &'Content-Type:'& or &'Content-Disposition:'& headers. The filename will be
30232 RFC2047 decoded, but no additional sanity checks are done. If no filename was
30233 found, this variable contains the empty string.
30234
30235 .vitem &$mime_is_coverletter$&
30236 This variable attempts to differentiate the &"cover letter"& of an e-mail from
30237 attached data. It can be used to clamp down on flashy or unnecessarily encoded
30238 content in the cover letter, while not restricting attachments at all.
30239
30240 The variable contains 1 (true) for a MIME part believed to be part of the
30241 cover letter, and 0 (false) for an attachment. At present, the algorithm is as
30242 follows:
30243
30244 .olist
30245 The outermost MIME part of a message is always a cover letter.
30246
30247 .next
30248 If a multipart/alternative or multipart/related MIME part is a cover letter,
30249 so are all MIME subparts within that multipart.
30250
30251 .next
30252 If any other multipart is a cover letter, the first subpart is a cover letter,
30253 and the rest are attachments.
30254
30255 .next
30256 All parts contained within an attachment multipart are attachments.
30257 .endlist olist
30258
30259 As an example, the following will ban &"HTML mail"& (including that sent with
30260 alternative plain text), while allowing HTML files to be attached. HTML
30261 coverletter mail attached to non-HMTL coverletter mail will also be allowed:
30262 .code
30263 deny message = HTML mail is not accepted here
30264 !condition = $mime_is_rfc822
30265 condition = $mime_is_coverletter
30266 condition = ${if eq{$mime_content_type}{text/html}{1}{0}}
30267 .endd
30268 .vitem &$mime_is_multipart$&
30269 This variable has the value 1 (true) when the current part has the main type
30270 &"multipart"&, for example &"multipart/alternative"& or &"multipart/mixed"&.
30271 Since multipart entities only serve as containers for other parts, you may not
30272 want to carry out specific actions on them.
30273
30274 .vitem &$mime_is_rfc822$&
30275 This variable has the value 1 (true) if the current part is not a part of the
30276 checked message itself, but part of an attached message. Attached message
30277 decoding is fully recursive.
30278
30279 .vitem &$mime_part_count$&
30280 This variable is a counter that is raised for each processed MIME part. It
30281 starts at zero for the very first part (which is usually a multipart). The
30282 counter is per-message, so it is reset when processing RFC822 attachments (see
30283 &$mime_is_rfc822$&). The counter stays set after &%acl_smtp_mime%& is
30284 complete, so you can use it in the DATA ACL to determine the number of MIME
30285 parts of a message. For non-MIME messages, this variable contains the value -1.
30286 .endlist
30287
30288
30289
30290 .section "Scanning with regular expressions" "SECTscanregex"
30291 .cindex "content scanning" "with regular expressions"
30292 .cindex "regular expressions" "content scanning with"
30293 You can specify your own custom regular expression matches on the full body of
30294 the message, or on individual MIME parts.
30295
30296 The &%regex%& condition takes one or more regular expressions as arguments and
30297 matches them against the full message (when called in the DATA ACL) or a raw
30298 MIME part (when called in the MIME ACL). The &%regex%& condition matches
30299 linewise, with a maximum line length of 32K characters. That means you cannot
30300 have multiline matches with the &%regex%& condition.
30301
30302 The &%mime_regex%& condition can be called only in the MIME ACL. It matches up
30303 to 32K of decoded content (the whole content at once, not linewise). If the
30304 part has not been decoded with the &%decode%& modifier earlier in the ACL, it
30305 is decoded automatically when &%mime_regex%& is executed (using default path
30306 and filename values). If the decoded data is larger than  32K, only the first
30307 32K characters are checked.
30308
30309 The regular expressions are passed as a colon-separated list. To include a
30310 literal colon, you must double it. Since the whole right-hand side string is
30311 expanded before being used, you must also escape dollar signs and backslashes
30312 with more backslashes, or use the &`\N`& facility to disable expansion.
30313 Here is a simple example that contains two regular expressions:
30314 .code
30315 deny message = contains blacklisted regex ($regex_match_string)
30316      regex = [Mm]ortgage : URGENT BUSINESS PROPOSAL
30317 .endd
30318 The conditions returns true if any one of the regular expressions matches. The
30319 &$regex_match_string$& expansion variable is then set up and contains the
30320 matching regular expression.
30321
30322 &*Warning*&: With large messages, these conditions can be fairly
30323 CPU-intensive.
30324
30325
30326
30327
30328 .section "The demime condition" "SECTdemimecond"
30329 .cindex "content scanning" "MIME checking"
30330 .cindex "MIME content scanning"
30331 The &%demime%& ACL condition provides MIME unpacking, sanity checking and file
30332 extension blocking. It is usable only in the DATA and non-SMTP ACLs. The
30333 &%demime%& condition uses a simpler interface to MIME decoding than the MIME
30334 ACL functionality, but provides no additional facilities. Please note that this
30335 condition is deprecated and kept only for backward compatibility. You must set
30336 the WITH_OLD_DEMIME option in &_Local/Makefile_& at build time to be able to
30337 use the &%demime%& condition.
30338
30339 The &%demime%& condition unpacks MIME containers in the message. It detects
30340 errors in MIME containers and can match file extensions found in the message
30341 against a list. Using this facility produces files containing the unpacked MIME
30342 parts of the message in the temporary scan directory. If you do antivirus
30343 scanning, it is recommended that you use the &%demime%& condition before the
30344 antivirus (&%malware%&) condition.
30345
30346 On the right-hand side of the &%demime%& condition you can pass a
30347 colon-separated list of file extensions that it should match against. For
30348 example:
30349 .code
30350 deny message = Found blacklisted file attachment
30351      demime  = vbs:com:bat:pif:prf:lnk
30352 .endd
30353 If one of the file extensions is found, the condition is true, otherwise it is
30354 false. If there is a temporary error while demimeing (for example, &"disk
30355 full"&), the condition defers, and the message is temporarily rejected (unless
30356 the condition is on a &%warn%& verb).
30357
30358 The right-hand side is expanded before being treated as a list, so you can have
30359 conditions and lookups there. If it expands to an empty string, &"false"&, or
30360 zero (&"0"&), no demimeing is done and the condition is false.
30361
30362 The &%demime%& condition set the following variables:
30363
30364 .vlist
30365 .vitem &$demime_errorlevel$&
30366 .vindex "&$demime_errorlevel$&"
30367 When an error is detected in a MIME container, this variable contains the
30368 severity of the error, as an integer number. The higher the value, the more
30369 severe the error (the current maximum value is 3). If this variable is unset or
30370 zero, no error occurred.
30371
30372 .vitem &$demime_reason$&
30373 .vindex "&$demime_reason$&"
30374 When &$demime_errorlevel$& is greater than zero, this variable contains a
30375 human-readable text string describing the MIME error that occurred.
30376 .endlist
30377
30378 .vlist
30379 .vitem &$found_extension$&
30380 .vindex "&$found_extension$&"
30381 When the &%demime%& condition is true, this variable contains the file
30382 extension it found.
30383 .endlist
30384
30385 Both &$demime_errorlevel$& and &$demime_reason$& are set by the first call of
30386 the &%demime%& condition, and are not changed on subsequent calls.
30387
30388 If you do not want to check for file extensions, but rather use the &%demime%&
30389 condition for unpacking or error checking purposes, pass &"*"& as the
30390 right-hand side value. Here is a more elaborate example of how to use this
30391 facility:
30392 .code
30393 # Reject messages with serious MIME container errors
30394 deny  message = Found MIME error ($demime_reason).
30395       demime = *
30396       condition = ${if >{$demime_errorlevel}{2}{1}{0}}
30397
30398 # Reject known virus spreading file extensions.
30399 # Accepting these is pretty much braindead.
30400 deny  message = contains $found_extension file (blacklisted).
30401       demime  = com:vbs:bat:pif:scr
30402
30403 # Freeze .exe and .doc files. Postmaster can
30404 # examine them and eventually thaw them.
30405 deny  log_message = Another $found_extension file.
30406       demime = exe:doc
30407       control = freeze
30408 .endd
30409 .ecindex IIDcosca
30410
30411
30412
30413
30414 . ////////////////////////////////////////////////////////////////////////////
30415 . ////////////////////////////////////////////////////////////////////////////
30416
30417 .chapter "Adding a local scan function to Exim" "CHAPlocalscan" &&&
30418          "Local scan function"
30419 .scindex IIDlosca "&[local_scan()]& function" "description of"
30420 .cindex "customizing" "input scan using C function"
30421 .cindex "policy control" "by local scan function"
30422 In these days of email worms, viruses, and ever-increasing spam, some sites
30423 want to apply a lot of checking to messages before accepting them.
30424
30425 The content scanning extension (chapter &<<CHAPexiscan>>&) has facilities for
30426 passing messages to external virus and spam scanning software. You can also do
30427 a certain amount in Exim itself through string expansions and the &%condition%&
30428 condition in the ACL that runs after the SMTP DATA command or the ACL for
30429 non-SMTP messages (see chapter &<<CHAPACL>>&), but this has its limitations.
30430
30431 To allow for further customization to a site's own requirements, there is the
30432 possibility of linking Exim with a private message scanning function, written
30433 in C. If you want to run code that is written in something other than C, you
30434 can of course use a little C stub to call it.
30435
30436 The local scan function is run once for every incoming message, at the point
30437 when Exim is just about to accept the message.
30438 It can therefore be used to control non-SMTP messages from local processes as
30439 well as messages arriving via SMTP.
30440
30441 Exim applies a timeout to calls of the local scan function, and there is an
30442 option called &%local_scan_timeout%& for setting it. The default is 5 minutes.
30443 Zero means &"no timeout"&.
30444 Exim also sets up signal handlers for SIGSEGV, SIGILL, SIGFPE, and SIGBUS
30445 before calling the local scan function, so that the most common types of crash
30446 are caught. If the timeout is exceeded or one of those signals is caught, the
30447 incoming message is rejected with a temporary error if it is an SMTP message.
30448 For a non-SMTP message, the message is dropped and Exim ends with a non-zero
30449 code. The incident is logged on the main and reject logs.
30450
30451
30452
30453 .section "Building Exim to use a local scan function" "SECID207"
30454 .cindex "&[local_scan()]& function" "building Exim to use"
30455 To make use of the local scan function feature, you must tell Exim where your
30456 function is before building Exim, by setting LOCAL_SCAN_SOURCE in your
30457 &_Local/Makefile_&. A recommended place to put it is in the &_Local_&
30458 directory, so you might set
30459 .code
30460 LOCAL_SCAN_SOURCE=Local/local_scan.c
30461 .endd
30462 for example. The function must be called &[local_scan()]&. It is called by
30463 Exim after it has received a message, when the success return code is about to
30464 be sent. This is after all the ACLs have been run. The return code from your
30465 function controls whether the message is actually accepted or not. There is a
30466 commented template function (that just accepts the message) in the file
30467 _src/local_scan.c_.
30468
30469 If you want to make use of Exim's run time configuration file to set options
30470 for your &[local_scan()]& function, you must also set
30471 .code
30472 LOCAL_SCAN_HAS_OPTIONS=yes
30473 .endd
30474 in &_Local/Makefile_& (see section &<<SECTconoptloc>>& below).
30475
30476
30477
30478
30479 .section "API for local_scan()" "SECTapiforloc"
30480 .cindex "&[local_scan()]& function" "API description"
30481 You must include this line near the start of your code:
30482 .code
30483 #include "local_scan.h"
30484 .endd
30485 This header file defines a number of variables and other values, and the
30486 prototype for the function itself. Exim is coded to use unsigned char values
30487 almost exclusively, and one of the things this header defines is a shorthand
30488 for &`unsigned char`& called &`uschar`&.
30489 It also contains the following macro definitions, to simplify casting character
30490 strings and pointers to character strings:
30491 .code
30492 #define CS   (char *)
30493 #define CCS  (const char *)
30494 #define CSS  (char **)
30495 #define US   (unsigned char *)
30496 #define CUS  (const unsigned char *)
30497 #define USS  (unsigned char **)
30498 .endd
30499 The function prototype for &[local_scan()]& is:
30500 .code
30501 extern int local_scan(int fd, uschar **return_text);
30502 .endd
30503 The arguments are as follows:
30504
30505 .ilist
30506 &%fd%& is a file descriptor for the file that contains the body of the message
30507 (the -D file). The file is open for reading and writing, but updating it is not
30508 recommended. &*Warning*&: You must &'not'& close this file descriptor.
30509
30510 The descriptor is positioned at character 19 of the file, which is the first
30511 character of the body itself, because the first 19 characters are the message
30512 id followed by &`-D`& and a newline. If you rewind the file, you should use the
30513 macro SPOOL_DATA_START_OFFSET to reset to the start of the data, just in
30514 case this changes in some future version.
30515 .next
30516 &%return_text%& is an address which you can use to return a pointer to a text
30517 string at the end of the function. The value it points to on entry is NULL.
30518 .endlist
30519
30520 The function must return an &%int%& value which is one of the following macros:
30521
30522 .vlist
30523 .vitem &`LOCAL_SCAN_ACCEPT`&
30524 .vindex "&$local_scan_data$&"
30525 The message is accepted. If you pass back a string of text, it is saved with
30526 the message, and made available in the variable &$local_scan_data$&. No
30527 newlines are permitted (if there are any, they are turned into spaces) and the
30528 maximum length of text is 1000 characters.
30529
30530 .vitem &`LOCAL_SCAN_ACCEPT_FREEZE`&
30531 This behaves as LOCAL_SCAN_ACCEPT, except that the accepted message is
30532 queued without immediate delivery, and is frozen.
30533
30534 .vitem &`LOCAL_SCAN_ACCEPT_QUEUE`&
30535 This behaves as LOCAL_SCAN_ACCEPT, except that the accepted message is
30536 queued without immediate delivery.
30537
30538 .vitem &`LOCAL_SCAN_REJECT`&
30539 The message is rejected; the returned text is used as an error message which is
30540 passed back to the sender and which is also logged. Newlines are permitted &--
30541 they cause a multiline response for SMTP rejections, but are converted to
30542 &`\n`& in log lines. If no message is given, &"Administrative prohibition"& is
30543 used.
30544
30545 .vitem &`LOCAL_SCAN_TEMPREJECT`&
30546 The message is temporarily rejected; the returned text is used as an error
30547 message as for LOCAL_SCAN_REJECT. If no message is given, &"Temporary local
30548 problem"& is used.
30549
30550 .vitem &`LOCAL_SCAN_REJECT_NOLOGHDR`&
30551 This behaves as LOCAL_SCAN_REJECT, except that the header of the rejected
30552 message is not written to the reject log. It has the effect of unsetting the
30553 &%rejected_header%& log selector for just this rejection. If
30554 &%rejected_header%& is already unset (see the discussion of the
30555 &%log_selection%& option in section &<<SECTlogselector>>&), this code is the
30556 same as LOCAL_SCAN_REJECT.
30557
30558 .vitem &`LOCAL_SCAN_TEMPREJECT_NOLOGHDR`&
30559 This code is a variation of LOCAL_SCAN_TEMPREJECT in the same way that
30560 LOCAL_SCAN_REJECT_NOLOGHDR is a variation of LOCAL_SCAN_REJECT.
30561 .endlist
30562
30563 If the message is not being received by interactive SMTP, rejections are
30564 reported by writing to &%stderr%& or by sending an email, as configured by the
30565 &%-oe%& command line options.
30566
30567
30568
30569 .section "Configuration options for local_scan()" "SECTconoptloc"
30570 .cindex "&[local_scan()]& function" "configuration options"
30571 It is possible to have option settings in the main configuration file
30572 that set values in static variables in the &[local_scan()]& module. If you
30573 want to do this, you must have the line
30574 .code
30575 LOCAL_SCAN_HAS_OPTIONS=yes
30576 .endd
30577 in your &_Local/Makefile_& when you build Exim. (This line is in
30578 &_OS/Makefile-Default_&, commented out). Then, in the &[local_scan()]& source
30579 file, you must define static variables to hold the option values, and a table
30580 to define them.
30581
30582 The table must be a vector called &%local_scan_options%&, of type
30583 &`optionlist`&. Each entry is a triplet, consisting of a name, an option type,
30584 and a pointer to the variable that holds the value. The entries must appear in
30585 alphabetical order. Following &%local_scan_options%& you must also define a
30586 variable called &%local_scan_options_count%& that contains the number of
30587 entries in the table. Here is a short example, showing two kinds of option:
30588 .code
30589 static int my_integer_option = 42;
30590 static uschar *my_string_option = US"a default string";
30591
30592 optionlist local_scan_options[] = {
30593   { "my_integer", opt_int,       &my_integer_option },
30594   { "my_string",  opt_stringptr, &my_string_option }
30595 };
30596
30597 int local_scan_options_count =
30598   sizeof(local_scan_options)/sizeof(optionlist);
30599 .endd
30600 The values of the variables can now be changed from Exim's runtime
30601 configuration file by including a local scan section as in this example:
30602 .code
30603 begin local_scan
30604 my_integer = 99
30605 my_string = some string of text...
30606 .endd
30607 The available types of option data are as follows:
30608
30609 .vlist
30610 .vitem &*opt_bool*&
30611 This specifies a boolean (true/false) option. The address should point to a
30612 variable of type &`BOOL`&, which will be set to TRUE or FALSE, which are macros
30613 that are defined as &"1"& and &"0"&, respectively. If you want to detect
30614 whether such a variable has been set at all, you can initialize it to
30615 TRUE_UNSET. (BOOL variables are integers underneath, so can hold more than two
30616 values.)
30617
30618 .vitem &*opt_fixed*&
30619 This specifies a fixed point number, such as is used for load averages.
30620 The address should point to a variable of type &`int`&. The value is stored
30621 multiplied by 1000, so, for example, 1.4142 is truncated and stored as 1414.
30622
30623 .vitem &*opt_int*&
30624 This specifies an integer; the address should point to a variable of type
30625 &`int`&. The value may be specified in any of the integer formats accepted by
30626 Exim.
30627
30628 .vitem &*opt_mkint*&
30629 This is the same as &%opt_int%&, except that when such a value is output in a
30630 &%-bP%& listing, if it is an exact number of kilobytes or megabytes, it is
30631 printed with the suffix K or M.
30632
30633 .vitem &*opt_octint*&
30634 This also specifies an integer, but the value is always interpreted as an
30635 octal integer, whether or not it starts with the digit zero, and it is
30636 always output in octal.
30637
30638 .vitem &*opt_stringptr*&
30639 This specifies a string value; the address must be a pointer to a
30640 variable that points to a string (for example, of type &`uschar *`&).
30641
30642 .vitem &*opt_time*&
30643 This specifies a time interval value. The address must point to a variable of
30644 type &`int`&. The value that is placed there is a number of seconds.
30645 .endlist
30646
30647 If the &%-bP%& command line option is followed by &`local_scan`&, Exim prints
30648 out the values of all the &[local_scan()]& options.
30649
30650
30651
30652 .section "Available Exim variables" "SECID208"
30653 .cindex "&[local_scan()]& function" "available Exim variables"
30654 The header &_local_scan.h_& gives you access to a number of C variables. These
30655 are the only ones that are guaranteed to be maintained from release to release.
30656 Note, however, that you can obtain the value of any Exim expansion variable,
30657 including &$recipients$&, by calling &'expand_string()'&. The exported
30658 C variables are as follows:
30659
30660 .vlist
30661 .vitem &*int&~body_linecount*&
30662 This variable contains the number of lines in the message's body.
30663
30664 .vitem &*int&~body_zerocount*&
30665 This variable contains the number of binary zero bytes in the message's body.
30666
30667 .vitem &*unsigned&~int&~debug_selector*&
30668 This variable is set to zero when no debugging is taking place. Otherwise, it
30669 is a bitmap of debugging selectors. Two bits are identified for use in
30670 &[local_scan()]&; they are defined as macros:
30671
30672 .ilist
30673 The &`D_v`& bit is set when &%-v%& was present on the command line. This is a
30674 testing option that is not privileged &-- any caller may set it. All the
30675 other selector bits can be set only by admin users.
30676
30677 .next
30678 The &`D_local_scan`& bit is provided for use by &[local_scan()]&; it is set
30679 by the &`+local_scan`& debug selector. It is not included in the default set
30680 of debugging bits.
30681 .endlist ilist
30682
30683 Thus, to write to the debugging output only when &`+local_scan`& has been
30684 selected, you should use code like this:
30685 .code
30686 if ((debug_selector & D_local_scan) != 0)
30687   debug_printf("xxx", ...);
30688 .endd
30689 .vitem &*uschar&~*expand_string_message*&
30690 After a failing call to &'expand_string()'& (returned value NULL), the
30691 variable &%expand_string_message%& contains the error message, zero-terminated.
30692
30693 .vitem &*header_line&~*header_list*&
30694 A pointer to a chain of header lines. The &%header_line%& structure is
30695 discussed below.
30696
30697 .vitem &*header_line&~*header_last*&
30698 A pointer to the last of the header lines.
30699
30700 .vitem &*uschar&~*headers_charset*&
30701 The value of the &%headers_charset%& configuration option.
30702
30703 .vitem &*BOOL&~host_checking*&
30704 This variable is TRUE during a host checking session that is initiated by the
30705 &%-bh%& command line option.
30706
30707 .vitem &*uschar&~*interface_address*&
30708 The IP address of the interface that received the message, as a string. This
30709 is NULL for locally submitted messages.
30710
30711 .vitem &*int&~interface_port*&
30712 The port on which this message was received. When testing with the &%-bh%&
30713 command line option, the value of this variable is -1 unless a port has been
30714 specified via the &%-oMi%& option.
30715
30716 .vitem &*uschar&~*message_id*&
30717 This variable contains Exim's message id for the incoming message (the value of
30718 &$message_exim_id$&) as a zero-terminated string.
30719
30720 .vitem &*uschar&~*received_protocol*&
30721 The name of the protocol by which the message was received.
30722
30723 .vitem &*int&~recipients_count*&
30724 The number of accepted recipients.
30725
30726 .vitem &*recipient_item&~*recipients_list*&
30727 .cindex "recipient" "adding in local scan"
30728 .cindex "recipient" "removing in local scan"
30729 The list of accepted recipients, held in a vector of length
30730 &%recipients_count%&. The &%recipient_item%& structure is discussed below. You
30731 can add additional recipients by calling &'receive_add_recipient()'& (see
30732 below). You can delete recipients by removing them from the vector and
30733 adjusting the value in &%recipients_count%&. In particular, by setting
30734 &%recipients_count%& to zero you remove all recipients. If you then return the
30735 value &`LOCAL_SCAN_ACCEPT`&, the message is accepted, but immediately
30736 blackholed. To replace the recipients, you can set &%recipients_count%& to zero
30737 and then call &'receive_add_recipient()'& as often as needed.
30738
30739 .vitem &*uschar&~*sender_address*&
30740 The envelope sender address. For bounce messages this is the empty string.
30741
30742 .vitem &*uschar&~*sender_host_address*&
30743 The IP address of the sending host, as a string. This is NULL for
30744 locally-submitted messages.
30745
30746 .vitem &*uschar&~*sender_host_authenticated*&
30747 The name of the authentication mechanism that was used, or NULL if the message
30748 was not received over an authenticated SMTP connection.
30749
30750 .vitem &*uschar&~*sender_host_name*&
30751 The name of the sending host, if known.
30752
30753 .vitem &*int&~sender_host_port*&
30754 The port on the sending host.
30755
30756 .vitem &*BOOL&~smtp_input*&
30757 This variable is TRUE for all SMTP input, including BSMTP.
30758
30759 .vitem &*BOOL&~smtp_batched_input*&
30760 This variable is TRUE for BSMTP input.
30761
30762 .vitem &*int&~store_pool*&
30763 The contents of this variable control which pool of memory is used for new
30764 requests. See section &<<SECTmemhanloc>>& for details.
30765 .endlist
30766
30767
30768 .section "Structure of header lines" "SECID209"
30769 The &%header_line%& structure contains the members listed below.
30770 You can add additional header lines by calling the &'header_add()'& function
30771 (see below). You can cause header lines to be ignored (deleted) by setting
30772 their type to *.
30773
30774
30775 .vlist
30776 .vitem &*struct&~header_line&~*next*&
30777 A pointer to the next header line, or NULL for the last line.
30778
30779 .vitem &*int&~type*&
30780 A code identifying certain headers that Exim recognizes. The codes are printing
30781 characters, and are documented in chapter &<<CHAPspool>>& of this manual.
30782 Notice in particular that any header line whose type is * is not transmitted
30783 with the message. This flagging is used for header lines that have been
30784 rewritten, or are to be removed (for example, &'Envelope-sender:'& header
30785 lines.) Effectively, * means &"deleted"&.
30786
30787 .vitem &*int&~slen*&
30788 The number of characters in the header line, including the terminating and any
30789 internal newlines.
30790
30791 .vitem &*uschar&~*text*&
30792 A pointer to the text of the header. It always ends with a newline, followed by
30793 a zero byte. Internal newlines are preserved.
30794 .endlist
30795
30796
30797
30798 .section "Structure of recipient items" "SECID210"
30799 The &%recipient_item%& structure contains these members:
30800
30801 .vlist
30802 .vitem &*uschar&~*address*&
30803 This is a pointer to the recipient address as it was received.
30804
30805 .vitem &*int&~pno*&
30806 This is used in later Exim processing when top level addresses are created by
30807 the &%one_time%& option. It is not relevant at the time &[local_scan()]& is run
30808 and must always contain -1 at this stage.
30809
30810 .vitem &*uschar&~*errors_to*&
30811 If this value is not NULL, bounce messages caused by failing to deliver to the
30812 recipient are sent to the address it contains. In other words, it overrides the
30813 envelope sender for this one recipient. (Compare the &%errors_to%& generic
30814 router option.) If a &[local_scan()]& function sets an &%errors_to%& field to
30815 an unqualified address, Exim qualifies it using the domain from
30816 &%qualify_recipient%&. When &[local_scan()]& is called, the &%errors_to%& field
30817 is NULL for all recipients.
30818 .endlist
30819
30820
30821
30822 .section "Available Exim functions" "SECID211"
30823 .cindex "&[local_scan()]& function" "available Exim functions"
30824 The header &_local_scan.h_& gives you access to a number of Exim functions.
30825 These are the only ones that are guaranteed to be maintained from release to
30826 release:
30827
30828 .vlist
30829 .vitem "&*pid_t&~child_open(uschar&~**argv,&~uschar&~**envp,&~int&~newumask,&&&
30830        &~int&~*infdptr,&~int&~*outfdptr, &~&~BOOL&~make_leader)*&"
30831
30832 This function creates a child process that runs the command specified by
30833 &%argv%&. The environment for the process is specified by &%envp%&, which can
30834 be NULL if no environment variables are to be passed. A new umask is supplied
30835 for the process in &%newumask%&.
30836
30837 Pipes to the standard input and output of the new process are set up
30838 and returned to the caller via the &%infdptr%& and &%outfdptr%& arguments. The
30839 standard error is cloned to the standard output. If there are any file
30840 descriptors &"in the way"& in the new process, they are closed. If the final
30841 argument is TRUE, the new process is made into a process group leader.
30842
30843 The function returns the pid of the new process, or -1 if things go wrong.
30844
30845 .vitem &*int&~child_close(pid_t&~pid,&~int&~timeout)*&
30846 This function waits for a child process to terminate, or for a timeout (in
30847 seconds) to expire. A timeout value of zero means wait as long as it takes. The
30848 return value is as follows:
30849
30850 .ilist
30851 >= 0
30852
30853 The process terminated by a normal exit and the value is the process
30854 ending status.
30855
30856 .next
30857 < 0 and > &--256
30858
30859 The process was terminated by a signal and the value is the negation of the
30860 signal number.
30861
30862 .next
30863 &--256
30864
30865 The process timed out.
30866 .next
30867 &--257
30868
30869 The was some other error in wait(); &%errno%& is still set.
30870 .endlist
30871
30872 .vitem &*pid_t&~child_open_exim(int&~*fd)*&
30873 This function provide you with a means of submitting a new message to
30874 Exim. (Of course, you can also call &_/usr/sbin/sendmail_& yourself if you
30875 want, but this packages it all up for you.) The function creates a pipe,
30876 forks a subprocess that is running
30877 .code
30878 exim -t -oem -oi -f <>
30879 .endd
30880 and returns to you (via the &`int *`& argument) a file descriptor for the pipe
30881 that is connected to the standard input. The yield of the function is the PID
30882 of the subprocess. You can then write a message to the file descriptor, with
30883 recipients in &'To:'&, &'Cc:'&, and/or &'Bcc:'& header lines.
30884
30885 When you have finished, call &'child_close()'& to wait for the process to
30886 finish and to collect its ending status. A timeout value of zero is usually
30887 fine in this circumstance. Unless you have made a mistake with the recipient
30888 addresses, you should get a return code of zero.
30889
30890
30891 .vitem &*pid_t&~child_open_exim2(int&~*fd,&~uschar&~*sender,&~uschar&~&&&
30892        *sender_authentication)*&
30893 This function is a more sophisticated version of &'child_open()'&. The command
30894 that it runs is:
30895 .display
30896 &`exim -t -oem -oi -f `&&'sender'&&` -oMas `&&'sender_authentication'&
30897 .endd
30898 The third argument may be NULL, in which case the &%-oMas%& option is omitted.
30899
30900
30901 .vitem &*void&~debug_printf(char&~*,&~...)*&
30902 This is Exim's debugging function, with arguments as for &'(printf()'&. The
30903 output is written to the standard error stream. If no debugging is selected,
30904 calls to &'debug_printf()'& have no effect. Normally, you should make calls
30905 conditional on the &`local_scan`& debug selector by coding like this:
30906 .code
30907 if ((debug_selector & D_local_scan) != 0)
30908   debug_printf("xxx", ...);
30909 .endd
30910
30911 .vitem &*uschar&~*expand_string(uschar&~*string)*&
30912 This is an interface to Exim's string expansion code. The return value is the
30913 expanded string, or NULL if there was an expansion failure.
30914 The C variable &%expand_string_message%& contains an error message after an
30915 expansion failure. If expansion does not change the string, the return value is
30916 the pointer to the input string. Otherwise, the return value points to a new
30917 block of memory that was obtained by a call to &'store_get()'&. See section
30918 &<<SECTmemhanloc>>& below for a discussion of memory handling.
30919
30920 .vitem &*void&~header_add(int&~type,&~char&~*format,&~...)*&
30921 This function allows you to an add additional header line at the end of the
30922 existing ones. The first argument is the type, and should normally be a space
30923 character. The second argument is a format string and any number of
30924 substitution arguments as for &[sprintf()]&. You may include internal newlines
30925 if you want, and you must ensure that the string ends with a newline.
30926
30927 .vitem "&*void&~header_add_at_position(BOOL&~after,&~uschar&~*name,&~&&&
30928         BOOL&~topnot,&~int&~type,&~char&~*format, &~&~...)*&"
30929 This function adds a new header line at a specified point in the header
30930 chain. The header itself is specified as for &'header_add()'&.
30931
30932 If &%name%& is NULL, the new header is added at the end of the chain if
30933 &%after%& is true, or at the start if &%after%& is false. If &%name%& is not
30934 NULL, the header lines are searched for the first non-deleted header that
30935 matches the name. If one is found, the new header is added before it if
30936 &%after%& is false. If &%after%& is true, the new header is added after the
30937 found header and any adjacent subsequent ones with the same name (even if
30938 marked &"deleted"&). If no matching non-deleted header is found, the &%topnot%&
30939 option controls where the header is added. If it is true, addition is at the
30940 top; otherwise at the bottom. Thus, to add a header after all the &'Received:'&
30941 headers, or at the top if there are no &'Received:'& headers, you could use
30942 .code
30943 header_add_at_position(TRUE, US"Received", TRUE,
30944   ' ', "X-xxx: ...");
30945 .endd
30946 Normally, there is always at least one non-deleted &'Received:'& header, but
30947 there may not be if &%received_header_text%& expands to an empty string.
30948
30949
30950 .vitem &*void&~header_remove(int&~occurrence,&~uschar&~*name)*&
30951 This function removes header lines. If &%occurrence%& is zero or negative, all
30952 occurrences of the header are removed. If occurrence is greater than zero, that
30953 particular instance of the header is removed. If no header(s) can be found that
30954 match the specification, the function does nothing.
30955
30956
30957 .vitem "&*BOOL&~header_testname(header_line&~*hdr,&~uschar&~*name,&~&&&
30958         int&~length,&~BOOL&~notdel)*&"
30959 This function tests whether the given header has the given name. It is not just
30960 a string comparison, because white space is permitted between the name and the
30961 colon. If the &%notdel%& argument is true, a false return is forced for all
30962 &"deleted"& headers; otherwise they are not treated specially. For example:
30963 .code
30964 if (header_testname(h, US"X-Spam", 6, TRUE)) ...
30965 .endd
30966 .vitem &*uschar&~*lss_b64encode(uschar&~*cleartext,&~int&~length)*&
30967 .cindex "base64 encoding" "functions for &[local_scan()]& use"
30968 This function base64-encodes a string, which is passed by address and length.
30969 The text may contain bytes of any value, including zero. The result is passed
30970 back in dynamic memory that is obtained by calling &'store_get()'&. It is
30971 zero-terminated.
30972
30973 .vitem &*int&~lss_b64decode(uschar&~*codetext,&~uschar&~**cleartext)*&
30974 This function decodes a base64-encoded string. Its arguments are a
30975 zero-terminated base64-encoded string and the address of a variable that is set
30976 to point to the result, which is in dynamic memory. The length of the decoded
30977 string is the yield of the function. If the input is invalid base64 data, the
30978 yield is -1. A zero byte is added to the end of the output string to make it
30979 easy to interpret as a C string (assuming it contains no zeros of its own). The
30980 added zero byte is not included in the returned count.
30981
30982 .vitem &*int&~lss_match_domain(uschar&~*domain,&~uschar&~*list)*&
30983 This function checks for a match in a domain list. Domains are always
30984 matched caselessly. The return value is one of the following:
30985 .display
30986 &`OK     `& match succeeded
30987 &`FAIL   `& match failed
30988 &`DEFER  `& match deferred
30989 .endd
30990 DEFER is usually caused by some kind of lookup defer, such as the
30991 inability to contact a database.
30992
30993 .vitem "&*int&~lss_match_local_part(uschar&~*localpart,&~uschar&~*list,&~&&&
30994         BOOL&~caseless)*&"
30995 This function checks for a match in a local part list. The third argument
30996 controls case-sensitivity. The return values are as for
30997 &'lss_match_domain()'&.
30998
30999 .vitem "&*int&~lss_match_address(uschar&~*address,&~uschar&~*list,&~&&&
31000         BOOL&~caseless)*&"
31001 This function checks for a match in an address list. The third argument
31002 controls the case-sensitivity of the local part match. The domain is always
31003 matched caselessly. The return values are as for &'lss_match_domain()'&.
31004
31005 .vitem "&*int&~lss_match_host(uschar&~*host_name,&~uschar&~*host_address,&~&&&
31006         uschar&~*list)*&"
31007 This function checks for a match in a host list. The most common usage is
31008 expected to be
31009 .code
31010 lss_match_host(sender_host_name, sender_host_address, ...)
31011 .endd
31012 .vindex "&$sender_host_address$&"
31013 An empty address field matches an empty item in the host list. If the host name
31014 is NULL, the name corresponding to &$sender_host_address$& is automatically
31015 looked up if a host name is required to match an item in the list. The return
31016 values are as for &'lss_match_domain()'&, but in addition, &'lss_match_host()'&
31017 returns ERROR in the case when it had to look up a host name, but the lookup
31018 failed.
31019
31020 .vitem "&*void&~log_write(unsigned&~int&~selector,&~int&~which,&~char&~&&&
31021         *format,&~...)*&"
31022 This function writes to Exim's log files. The first argument should be zero (it
31023 is concerned with &%log_selector%&). The second argument can be &`LOG_MAIN`& or
31024 &`LOG_REJECT`& or &`LOG_PANIC`& or the inclusive &"or"& of any combination of
31025 them. It specifies to which log or logs the message is written. The remaining
31026 arguments are a format and relevant insertion arguments. The string should not
31027 contain any newlines, not even at the end.
31028
31029
31030 .vitem &*void&~receive_add_recipient(uschar&~*address,&~int&~pno)*&
31031 This function adds an additional recipient to the message. The first argument
31032 is the recipient address. If it is unqualified (has no domain), it is qualified
31033 with the &%qualify_recipient%& domain. The second argument must always be -1.
31034
31035 This function does not allow you to specify a private &%errors_to%& address (as
31036 described with the structure of &%recipient_item%& above), because it pre-dates
31037 the addition of that field to the structure. However, it is easy to add such a
31038 value afterwards. For example:
31039 .code
31040  receive_add_recipient(US"monitor@mydom.example", -1);
31041  recipients_list[recipients_count-1].errors_to =
31042    US"postmaster@mydom.example";
31043 .endd
31044
31045 .vitem &*BOOL&~receive_remove_recipient(uschar&~*recipient)*&
31046 This is a convenience function to remove a named recipient from the list of
31047 recipients. It returns true if a recipient was removed, and false if no
31048 matching recipient could be found. The argument must be a complete email
31049 address.
31050 .endlist
31051
31052
31053 .cindex "RFC 2047"
31054 .vlist
31055 .vitem "&*uschar&~rfc2047_decode(uschar&~*string,&~BOOL&~lencheck,&&&
31056   &~uschar&~*target,&~int&~zeroval,&~int&~*lenptr, &~&~uschar&~**error)*&"
31057 This function decodes strings that are encoded according to RFC 2047. Typically
31058 these are the contents of header lines. First, each &"encoded word"& is decoded
31059 from the Q or B encoding into a byte-string. Then, if provided with the name of
31060 a charset encoding, and if the &[iconv()]& function is available, an attempt is
31061 made  to translate the result to the named character set. If this fails, the
31062 binary string is returned with an error message.
31063
31064 The first argument is the string to be decoded. If &%lencheck%& is TRUE, the
31065 maximum MIME word length is enforced. The third argument is the target
31066 encoding, or NULL if no translation is wanted.
31067
31068 .cindex "binary zero" "in RFC 2047 decoding"
31069 .cindex "RFC 2047" "binary zero in"
31070 If a binary zero is encountered in the decoded string, it is replaced by the
31071 contents of the &%zeroval%& argument. For use with Exim headers, the value must
31072 not be 0 because header lines are handled as zero-terminated strings.
31073
31074 The function returns the result of processing the string, zero-terminated; if
31075 &%lenptr%& is not NULL, the length of the result is set in the variable to
31076 which it points. When &%zeroval%& is 0, &%lenptr%& should not be NULL.
31077
31078 If an error is encountered, the function returns NULL and uses the &%error%&
31079 argument to return an error message. The variable pointed to by &%error%& is
31080 set to NULL if there is no error; it may be set non-NULL even when the function
31081 returns a non-NULL value if decoding was successful, but there was a problem
31082 with translation.
31083
31084
31085 .vitem &*int&~smtp_fflush(void)*&
31086 This function is used in conjunction with &'smtp_printf()'&, as described
31087 below.
31088
31089 .vitem &*void&~smtp_printf(char&~*,&~...)*&
31090 The arguments of this function are like &[printf()]&; it writes to the SMTP
31091 output stream. You should use this function only when there is an SMTP output
31092 stream, that is, when the incoming message is being received via interactive
31093 SMTP. This is the case when &%smtp_input%& is TRUE and &%smtp_batched_input%&
31094 is FALSE. If you want to test for an incoming message from another host (as
31095 opposed to a local process that used the &%-bs%& command line option), you can
31096 test the value of &%sender_host_address%&, which is non-NULL when a remote host
31097 is involved.
31098
31099 If an SMTP TLS connection is established, &'smtp_printf()'& uses the TLS
31100 output function, so it can be used for all forms of SMTP connection.
31101
31102 Strings that are written by &'smtp_printf()'& from within &[local_scan()]&
31103 must start with an appropriate response code: 550 if you are going to return
31104 LOCAL_SCAN_REJECT, 451 if you are going to return
31105 LOCAL_SCAN_TEMPREJECT, and 250 otherwise. Because you are writing the
31106 initial lines of a multi-line response, the code must be followed by a hyphen
31107 to indicate that the line is not the final response line. You must also ensure
31108 that the lines you write terminate with CRLF. For example:
31109 .code
31110 smtp_printf("550-this is some extra info\r\n");
31111 return LOCAL_SCAN_REJECT;
31112 .endd
31113 Note that you can also create multi-line responses by including newlines in
31114 the data returned via the &%return_text%& argument. The added value of using
31115 &'smtp_printf()'& is that, for instance, you could introduce delays between
31116 multiple output lines.
31117
31118 The &'smtp_printf()'& function does not return any error indication, because it
31119 does not automatically flush pending output, and therefore does not test
31120 the state of the stream. (In the main code of Exim, flushing and error
31121 detection is done when Exim is ready for the next SMTP input command.) If
31122 you want to flush the output and check for an error (for example, the
31123 dropping of a TCP/IP connection), you can call &'smtp_fflush()'&, which has no
31124 arguments. It flushes the output stream, and returns a non-zero value if there
31125 is an error.
31126
31127 .vitem &*void&~*store_get(int)*&
31128 This function accesses Exim's internal store (memory) manager. It gets a new
31129 chunk of memory whose size is given by the argument. Exim bombs out if it ever
31130 runs out of memory. See the next section for a discussion of memory handling.
31131
31132 .vitem &*void&~*store_get_perm(int)*&
31133 This function is like &'store_get()'&, but it always gets memory from the
31134 permanent pool. See the next section for a discussion of memory handling.
31135
31136 .vitem &*uschar&~*string_copy(uschar&~*string)*&
31137 See below.
31138
31139 .vitem &*uschar&~*string_copyn(uschar&~*string,&~int&~length)*&
31140 See below.
31141
31142 .vitem &*uschar&~*string_sprintf(char&~*format,&~...)*&
31143 These three functions create strings using Exim's dynamic memory facilities.
31144 The first makes a copy of an entire string. The second copies up to a maximum
31145 number of characters, indicated by the second argument. The third uses a format
31146 and insertion arguments to create a new string. In each case, the result is a
31147 pointer to a new string in the current memory pool. See the next section for
31148 more discussion.
31149 .endlist
31150
31151
31152
31153 .section "More about Exim's memory handling" "SECTmemhanloc"
31154 .cindex "&[local_scan()]& function" "memory handling"
31155 No function is provided for freeing memory, because that is never needed.
31156 The dynamic memory that Exim uses when receiving a message is automatically
31157 recycled if another message is received by the same process (this applies only
31158 to incoming SMTP connections &-- other input methods can supply only one
31159 message at a time). After receiving the last message, a reception process
31160 terminates.
31161
31162 Because it is recycled, the normal dynamic memory cannot be used for holding
31163 data that must be preserved over a number of incoming messages on the same SMTP
31164 connection. However, Exim in fact uses two pools of dynamic memory; the second
31165 one is not recycled, and can be used for this purpose.
31166
31167 If you want to allocate memory that remains available for subsequent messages
31168 in the same SMTP connection, you should set
31169 .code
31170 store_pool = POOL_PERM
31171 .endd
31172 before calling the function that does the allocation. There is no need to
31173 restore the value if you do not need to; however, if you do want to revert to
31174 the normal pool, you can either restore the previous value of &%store_pool%& or
31175 set it explicitly to POOL_MAIN.
31176
31177 The pool setting applies to all functions that get dynamic memory, including
31178 &'expand_string()'&, &'store_get()'&, and the &'string_xxx()'& functions.
31179 There is also a convenience function called &'store_get_perm()'& that gets a
31180 block of memory from the permanent pool while preserving the value of
31181 &%store_pool%&.
31182 .ecindex IIDlosca
31183
31184
31185
31186
31187 . ////////////////////////////////////////////////////////////////////////////
31188 . ////////////////////////////////////////////////////////////////////////////
31189
31190 .chapter "System-wide message filtering" "CHAPsystemfilter"
31191 .scindex IIDsysfil1 "filter" "system filter"
31192 .scindex IIDsysfil2 "filtering all mail"
31193 .scindex IIDsysfil3 "system filter"
31194 The previous chapters (on ACLs and the local scan function) describe checks
31195 that can be applied to messages before they are accepted by a host. There is
31196 also a mechanism for checking messages once they have been received, but before
31197 they are delivered. This is called the &'system filter'&.
31198
31199 The system filter operates in a similar manner to users' filter files, but it
31200 is run just once per message (however many recipients the message has).
31201 It should not normally be used as a substitute for routing, because &%deliver%&
31202 commands in a system router provide new envelope recipient addresses.
31203 The system filter must be an Exim filter. It cannot be a Sieve filter.
31204
31205 The system filter is run at the start of a delivery attempt, before any routing
31206 is done. If a message fails to be completely delivered at the first attempt,
31207 the system filter is run again at the start of every retry.
31208 If you want your filter to do something only once per message, you can make use
31209 of the &%first_delivery%& condition in an &%if%& command in the filter to
31210 prevent it happening on retries.
31211
31212 .vindex "&$domain$&"
31213 .vindex "&$local_part$&"
31214 &*Warning*&: Because the system filter runs just once, variables that are
31215 specific to individual recipient addresses, such as &$local_part$& and
31216 &$domain$&, are not set, and the &"personal"& condition is not meaningful. If
31217 you want to run a centrally-specified filter for each recipient address
31218 independently, you can do so by setting up a suitable &(redirect)& router, as
31219 described in section &<<SECTperaddfil>>& below.
31220
31221
31222 .section "Specifying a system filter" "SECID212"
31223 .cindex "uid (user id)" "system filter"
31224 .cindex "gid (group id)" "system filter"
31225 The name of the file that contains the system filter must be specified by
31226 setting &%system_filter%&. If you want the filter to run under a uid and gid
31227 other than root, you must also set &%system_filter_user%& and
31228 &%system_filter_group%& as appropriate. For example:
31229 .code
31230 system_filter = /etc/mail/exim.filter
31231 system_filter_user = exim
31232 .endd
31233 If a system filter generates any deliveries directly to files or pipes (via the
31234 &%save%& or &%pipe%& commands), transports to handle these deliveries must be
31235 specified by setting &%system_filter_file_transport%& and
31236 &%system_filter_pipe_transport%&, respectively. Similarly,
31237 &%system_filter_reply_transport%& must be set to handle any messages generated
31238 by the &%reply%& command.
31239
31240
31241 .section "Testing a system filter" "SECID213"
31242 You can run simple tests of a system filter in the same way as for a user
31243 filter, but you should use &%-bF%& rather than &%-bf%&, so that features that
31244 are permitted only in system filters are recognized.
31245
31246 If you want to test the combined effect of a system filter and a user filter,
31247 you can use both &%-bF%& and &%-bf%& on the same command line.
31248
31249
31250
31251 .section "Contents of a system filter" "SECID214"
31252 The language used to specify system filters is the same as for users' filter
31253 files. It is described in the separate end-user document &'Exim's interface to
31254 mail filtering'&. However, there are some additional features that are
31255 available only in system filters; these are described in subsequent sections.
31256 If they are encountered in a user's filter file or when testing with &%-bf%&,
31257 they cause errors.
31258
31259 .cindex "frozen messages" "manual thaw; testing in filter"
31260 There are two special conditions which, though available in users' filter
31261 files, are designed for use in system filters. The condition &%first_delivery%&
31262 is true only for the first attempt at delivering a message, and
31263 &%manually_thawed%& is true only if the message has been frozen, and
31264 subsequently thawed by an admin user. An explicit forced delivery counts as a
31265 manual thaw, but thawing as a result of the &%auto_thaw%& setting does not.
31266
31267 &*Warning*&: If a system filter uses the &%first_delivery%& condition to
31268 specify an &"unseen"& (non-significant) delivery, and that delivery does not
31269 succeed, it will not be tried again.
31270 If you want Exim to retry an unseen delivery until it succeeds, you should
31271 arrange to set it up every time the filter runs.
31272
31273 When a system filter finishes running, the values of the variables &$n0$& &--
31274 &$n9$& are copied into &$sn0$& &-- &$sn9$& and are thereby made available to
31275 users' filter files. Thus a system filter can, for example, set up &"scores"&
31276 to which users' filter files can refer.
31277
31278
31279
31280 .section "Additional variable for system filters" "SECID215"
31281 .vindex "&$recipients$&"
31282 The expansion variable &$recipients$&, containing a list of all the recipients
31283 of the message (separated by commas and white space), is available in system
31284 filters. It is not available in users' filters for privacy reasons.
31285
31286
31287
31288 .section "Defer, freeze, and fail commands for system filters" "SECID216"
31289 .cindex "freezing messages"
31290 .cindex "message" "freezing"
31291 .cindex "message" "forced failure"
31292 .cindex "&%fail%&" "in system filter"
31293 .cindex "&%freeze%& in system filter"
31294 .cindex "&%defer%& in system filter"
31295 There are three extra commands (&%defer%&, &%freeze%& and &%fail%&) which are
31296 always available in system filters, but are not normally enabled in users'
31297 filters. (See the &%allow_defer%&, &%allow_freeze%& and &%allow_fail%& options
31298 for the &(redirect)& router.) These commands can optionally be followed by the
31299 word &%text%& and a string containing an error message, for example:
31300 .code
31301 fail text "this message looks like spam to me"
31302 .endd
31303 The keyword &%text%& is optional if the next character is a double quote.
31304
31305 The &%defer%& command defers delivery of the original recipients of the
31306 message. The &%fail%& command causes all the original recipients to be failed,
31307 and a bounce message to be created. The &%freeze%& command suspends all
31308 delivery attempts for the original recipients. In all cases, any new deliveries
31309 that are specified by the filter are attempted as normal after the filter has
31310 run.
31311
31312 The &%freeze%& command is ignored if the message has been manually unfrozen and
31313 not manually frozen since. This means that automatic freezing by a system
31314 filter can be used as a way of checking out suspicious messages. If a message
31315 is found to be all right, manually unfreezing it allows it to be delivered.
31316
31317 .cindex "log" "&%fail%& command log line"
31318 .cindex "&%fail%&" "log line; reducing"
31319 The text given with a fail command is used as part of the bounce message as
31320 well as being written to the log. If the message is quite long, this can fill
31321 up a lot of log space when such failures are common. To reduce the size of the
31322 log message, Exim interprets the text in a special way if it starts with the
31323 two characters &`<<`& and contains &`>>`& later. The text between these two
31324 strings is written to the log, and the rest of the text is used in the bounce
31325 message. For example:
31326 .code
31327 fail "<<filter test 1>>Your message is rejected \
31328      because it contains attachments that we are \
31329      not prepared to receive."
31330 .endd
31331
31332 .cindex "loop" "caused by &%fail%&"
31333 Take great care with the &%fail%& command when basing the decision to fail on
31334 the contents of the message, because the bounce message will of course include
31335 the contents of the original message and will therefore trigger the &%fail%&
31336 command again (causing a mail loop) unless steps are taken to prevent this.
31337 Testing the &%error_message%& condition is one way to prevent this. You could
31338 use, for example
31339 .code
31340 if $message_body contains "this is spam" and not error_message
31341 then fail text "spam is not wanted here" endif
31342 .endd
31343 though of course that might let through unwanted bounce messages. The
31344 alternative is clever checking of the body and/or headers to detect bounces
31345 generated by the filter.
31346
31347 The interpretation of a system filter file ceases after a
31348 &%defer%&,
31349 &%freeze%&, or &%fail%& command is obeyed. However, any deliveries that were
31350 set up earlier in the filter file are honoured, so you can use a sequence such
31351 as
31352 .code
31353 mail ...
31354 freeze
31355 .endd
31356 to send a specified message when the system filter is freezing (or deferring or
31357 failing) a message. The normal deliveries for the message do not, of course,
31358 take place.
31359
31360
31361
31362 .section "Adding and removing headers in a system filter" "SECTaddremheasys"
31363 .cindex "header lines" "adding; in system filter"
31364 .cindex "header lines" "removing; in system filter"
31365 .cindex "filter" "header lines; adding/removing"
31366 Two filter commands that are available only in system filters are:
31367 .code
31368 headers add <string>
31369 headers remove <string>
31370 .endd
31371 The argument for the &%headers add%& is a string that is expanded and then
31372 added to the end of the message's headers. It is the responsibility of the
31373 filter maintainer to make sure it conforms to RFC 2822 syntax. Leading white
31374 space is ignored, and if the string is otherwise empty, or if the expansion is
31375 forced to fail, the command has no effect.
31376
31377 You can use &"\n"& within the string, followed by white space, to specify
31378 continued header lines. More than one header may be added in one command by
31379 including &"\n"& within the string without any following white space. For
31380 example:
31381 .code
31382 headers add "X-header-1: ....\n  \
31383              continuation of X-header-1 ...\n\
31384              X-header-2: ...."
31385 .endd
31386 Note that the header line continuation white space after the first newline must
31387 be placed before the backslash that continues the input string, because white
31388 space after input continuations is ignored.
31389
31390 The argument for &%headers remove%& is a colon-separated list of header names.
31391 This command applies only to those headers that are stored with the message;
31392 those that are added at delivery time (such as &'Envelope-To:'& and
31393 &'Return-Path:'&) cannot be removed by this means. If there is more than one
31394 header with the same name, they are all removed.
31395
31396 The &%headers%& command in a system filter makes an immediate change to the set
31397 of header lines that was received with the message (with possible additions
31398 from ACL processing). Subsequent commands in the system filter operate on the
31399 modified set, which also forms the basis for subsequent message delivery.
31400 Unless further modified during routing or transporting, this set of headers is
31401 used for all recipients of the message.
31402
31403 During routing and transporting, the variables that refer to the contents of
31404 header lines refer only to those lines that are in this set. Thus, header lines
31405 that are added by a system filter are visible to users' filter files and to all
31406 routers and transports. This contrasts with the manipulation of header lines by
31407 routers and transports, which is not immediate, but which instead is saved up
31408 until the message is actually being written (see section
31409 &<<SECTheadersaddrem>>&).
31410
31411 If the message is not delivered at the first attempt, header lines that were
31412 added by the system filter are stored with the message, and so are still
31413 present at the next delivery attempt. Header lines that were removed are still
31414 present, but marked &"deleted"& so that they are not transported with the
31415 message. For this reason, it is usual to make the &%headers%& command
31416 conditional on &%first_delivery%& so that the set of header lines is not
31417 modified more than once.
31418
31419 Because header modification in a system filter acts immediately, you have to
31420 use an indirect approach if you want to modify the contents of a header line.
31421 For example:
31422 .code
31423 headers add "Old-Subject: $h_subject:"
31424 headers remove "Subject"
31425 headers add "Subject: new subject (was: $h_old-subject:)"
31426 headers remove "Old-Subject"
31427 .endd
31428
31429
31430
31431 .section "Setting an errors address in a system filter" "SECID217"
31432 .cindex "envelope sender"
31433 In a system filter, if a &%deliver%& command is followed by
31434 .code
31435 errors_to <some address>
31436 .endd
31437 in order to change the envelope sender (and hence the error reporting) for that
31438 delivery, any address may be specified. (In a user filter, only the current
31439 user's address can be set.) For example, if some mail is being monitored, you
31440 might use
31441 .code
31442 unseen deliver monitor@spying.example errors_to root@local.example
31443 .endd
31444 to take a copy which would not be sent back to the normal error reporting
31445 address if its delivery failed.
31446
31447
31448
31449 .section "Per-address filtering" "SECTperaddfil"
31450 .vindex "&$domain$&"
31451 .vindex "&$local_part$&"
31452 In contrast to the system filter, which is run just once per message for each
31453 delivery attempt, it is also possible to set up a system-wide filtering
31454 operation that runs once for each recipient address. In this case, variables
31455 such as &$local_part$& and &$domain$& can be used, and indeed, the choice of
31456 filter file could be made dependent on them. This is an example of a router
31457 which implements such a filter:
31458 .code
31459 central_filter:
31460   check_local_user
31461   driver = redirect
31462   domains = +local_domains
31463   file = /central/filters/$local_part
31464   no_verify
31465   allow_filter
31466   allow_freeze
31467 .endd
31468 The filter is run in a separate process under its own uid. Therefore, either
31469 &%check_local_user%& must be set (as above), in which case the filter is run as
31470 the local user, or the &%user%& option must be used to specify which user to
31471 use. If both are set, &%user%& overrides.
31472
31473 Care should be taken to ensure that none of the commands in the filter file
31474 specify a significant delivery if the message is to go on to be delivered to
31475 its intended recipient. The router will not then claim to have dealt with the
31476 address, so it will be passed on to subsequent routers to be delivered in the
31477 normal way.
31478 .ecindex IIDsysfil1
31479 .ecindex IIDsysfil2
31480 .ecindex IIDsysfil3
31481
31482
31483
31484
31485
31486
31487 . ////////////////////////////////////////////////////////////////////////////
31488 . ////////////////////////////////////////////////////////////////////////////
31489
31490 .chapter "Message processing" "CHAPmsgproc"
31491 .scindex IIDmesproc "message" "general processing"
31492 Exim performs various transformations on the sender and recipient addresses of
31493 all messages that it handles, and also on the messages' header lines. Some of
31494 these are optional and configurable, while others always take place. All of
31495 this processing, except rewriting as a result of routing, and the addition or
31496 removal of header lines while delivering, happens when a message is received,
31497 before it is placed on Exim's queue.
31498
31499 Some of the automatic processing takes place by default only for
31500 &"locally-originated"& messages. This adjective is used to describe messages
31501 that are not received over TCP/IP, but instead are passed to an Exim process on
31502 its standard input. This includes the interactive &"local SMTP"& case that is
31503 set up by the &%-bs%& command line option.
31504
31505 &*Note*&: Messages received over TCP/IP on the loopback interface (127.0.0.1
31506 or ::1) are not considered to be locally-originated. Exim does not treat the
31507 loopback interface specially in any way.
31508
31509 If you want the loopback interface to be treated specially, you must ensure
31510 that there are appropriate entries in your ACLs.
31511
31512
31513
31514
31515 .section "Submission mode for non-local messages" "SECTsubmodnon"
31516 .cindex "message" "submission"
31517 .cindex "submission mode"
31518 Processing that happens automatically for locally-originated messages (unless
31519 &%suppress_local_fixups%& is set) can also be requested for messages that are
31520 received over TCP/IP. The term &"submission mode"& is used to describe this
31521 state. Submission mode is set by the modifier
31522 .code
31523 control = submission
31524 .endd
31525 in a MAIL, RCPT, or pre-data ACL for an incoming message (see sections
31526 &<<SECTACLmodi>>& and &<<SECTcontrols>>&). This makes Exim treat the message as
31527 a local submission, and is normally used when the source of the message is
31528 known to be an MUA running on a client host (as opposed to an MTA). For
31529 example, to set submission mode for messages originating on the IPv4 loopback
31530 interface, you could include the following in the MAIL ACL:
31531 .code
31532 warn  hosts = 127.0.0.1
31533       control = submission
31534 .endd
31535 .cindex "&%sender_retain%& submission option"
31536 There are some options that can be used when setting submission mode. A slash
31537 is used to separate options. For example:
31538 .code
31539 control = submission/sender_retain
31540 .endd
31541 Specifying &%sender_retain%& has the effect of setting &%local_sender_retain%&
31542 true and &%local_from_check%& false for the current incoming message. The first
31543 of these allows an existing &'Sender:'& header in the message to remain, and
31544 the second suppresses the check to ensure that &'From:'& matches the
31545 authenticated sender. With this setting, Exim still fixes up messages by adding
31546 &'Date:'& and &'Message-ID:'& header lines if they are missing, but makes no
31547 attempt to check sender authenticity in header lines.
31548
31549 When &%sender_retain%& is not set, a submission mode setting may specify a
31550 domain to be used when generating a &'From:'& or &'Sender:'& header line. For
31551 example:
31552 .code
31553 control = submission/domain=some.domain
31554 .endd
31555 The domain may be empty. How this value is used is described in sections
31556 &<<SECTthefrohea>>& and &<<SECTthesenhea>>&. There is also a &%name%& option
31557 that allows you to specify the user's full name for inclusion in a created
31558 &'Sender:'& or &'From:'& header line. For example:
31559 .code
31560 accept authenticated = *
31561        control = submission/domain=wonderland.example/\
31562                             name=${lookup {$authenticated_id} \
31563                                    lsearch {/etc/exim/namelist}}
31564 .endd
31565 Because the name may contain any characters, including slashes, the &%name%&
31566 option must be given last. The remainder of the string is used as the name. For
31567 the example above, if &_/etc/exim/namelist_& contains:
31568 .code
31569 bigegg:  Humpty Dumpty
31570 .endd
31571 then when the sender has authenticated as &'bigegg'&, the generated &'Sender:'&
31572 line would be:
31573 .code
31574 Sender: Humpty Dumpty <bigegg@wonderland.example>
31575 .endd
31576 .cindex "return path" "in submission mode"
31577 By default, submission mode forces the return path to the same address as is
31578 used to create the &'Sender:'& header. However, if &%sender_retain%& is
31579 specified, the return path is also left unchanged.
31580
31581 &*Note*&: The changes caused by submission mode take effect after the predata
31582 ACL. This means that any sender checks performed before the fix-ups use the
31583 untrusted sender address specified by the user, not the trusted sender address
31584 specified by submission mode. Although this might be slightly unexpected, it
31585 does mean that you can configure ACL checks to spot that a user is trying to
31586 spoof another's address.
31587
31588 .section "Line endings" "SECTlineendings"
31589 .cindex "line endings"
31590 .cindex "carriage return"
31591 .cindex "linefeed"
31592 RFC 2821 specifies that CRLF (two characters: carriage-return, followed by
31593 linefeed) is the line ending for messages transmitted over the Internet using
31594 SMTP over TCP/IP. However, within individual operating systems, different
31595 conventions are used. For example, Unix-like systems use just LF, but others
31596 use CRLF or just CR.
31597
31598 Exim was designed for Unix-like systems, and internally, it stores messages
31599 using the system's convention of a single LF as a line terminator. When
31600 receiving a message, all line endings are translated to this standard format.
31601 Originally, it was thought that programs that passed messages directly to an
31602 MTA within an operating system would use that system's convention. Experience
31603 has shown that this is not the case; for example, there are Unix applications
31604 that use CRLF in this circumstance. For this reason, and for compatibility with
31605 other MTAs, the way Exim handles line endings for all messages is now as
31606 follows:
31607
31608 .ilist
31609 LF not preceded by CR is treated as a line ending.
31610 .next
31611 CR is treated as a line ending; if it is immediately followed by LF, the LF
31612 is ignored.
31613 .next
31614 The sequence &"CR, dot, CR"& does not terminate an incoming SMTP message,
31615 nor a local message in the state where a line containing only a dot is a
31616 terminator.
31617 .next
31618 If a bare CR is encountered within a header line, an extra space is added after
31619 the line terminator so as not to end the header line. The reasoning behind this
31620 is that bare CRs in header lines are most likely either to be mistakes, or
31621 people trying to play silly games.
31622 .next
31623 If the first header line received in a message ends with CRLF, a subsequent
31624 bare LF in a header line is treated in the same way as a bare CR in a header
31625 line.
31626 .endlist
31627
31628
31629
31630
31631
31632 .section "Unqualified addresses" "SECID218"
31633 .cindex "unqualified addresses"
31634 .cindex "address" "qualification"
31635 By default, Exim expects every envelope address it receives from an external
31636 host to be fully qualified. Unqualified addresses cause negative responses to
31637 SMTP commands. However, because SMTP is used as a means of transporting
31638 messages from MUAs running on personal workstations, there is sometimes a
31639 requirement to accept unqualified addresses from specific hosts or IP networks.
31640
31641 Exim has two options that separately control which hosts may send unqualified
31642 sender or recipient addresses in SMTP commands, namely
31643 &%sender_unqualified_hosts%& and &%recipient_unqualified_hosts%&. In both
31644 cases, if an unqualified address is accepted, it is qualified by adding the
31645 value of &%qualify_domain%& or &%qualify_recipient%&, as appropriate.
31646
31647 .oindex "&%qualify_domain%&"
31648 .oindex "&%qualify_recipient%&"
31649 Unqualified addresses in header lines are automatically qualified for messages
31650 that are locally originated, unless the &%-bnq%& option is given on the command
31651 line. For messages received over SMTP, unqualified addresses in header lines
31652 are qualified only if unqualified addresses are permitted in SMTP commands. In
31653 other words, such qualification is also controlled by
31654 &%sender_unqualified_hosts%& and &%recipient_unqualified_hosts%&,
31655
31656
31657
31658
31659 .section "The UUCP From line" "SECID219"
31660 .cindex "&""From""& line"
31661 .cindex "UUCP" "&""From""& line"
31662 .cindex "sender" "address"
31663 .oindex "&%uucp_from_pattern%&"
31664 .oindex "&%uucp_from_sender%&"
31665 .cindex "envelope sender"
31666 .cindex "Sendmail compatibility" "&""From""& line"
31667 Messages that have come from UUCP (and some other applications) often begin
31668 with a line containing the envelope sender and a timestamp, following the word
31669 &"From"&. Examples of two common formats are:
31670 .code
31671 From a.oakley@berlin.mus Fri Jan  5 12:35 GMT 1996
31672 From f.butler@berlin.mus Fri, 7 Jan 97 14:00:00 GMT
31673 .endd
31674 This line precedes the RFC 2822 header lines. For compatibility with Sendmail,
31675 Exim recognizes such lines at the start of messages that are submitted to it
31676 via the command line (that is, on the standard input). It does not recognize
31677 such lines in incoming SMTP messages, unless the sending host matches
31678 &%ignore_fromline_hosts%& or the &%-bs%& option was used for a local message
31679 and &%ignore_fromline_local%& is set. The recognition is controlled by a
31680 regular expression that is defined by the &%uucp_from_pattern%& option, whose
31681 default value matches the two common cases shown above and puts the address
31682 that follows &"From"& into &$1$&.
31683
31684 .cindex "numerical variables (&$1$& &$2$& etc)" "in &""From ""& line handling"
31685 When the caller of Exim for a non-SMTP message that contains a &"From"& line is
31686 a trusted user, the message's sender address is constructed by expanding the
31687 contents of &%uucp_sender_address%&, whose default value is &"$1"&. This is
31688 then parsed as an RFC 2822 address. If there is no domain, the local part is
31689 qualified with &%qualify_domain%& unless it is the empty string. However, if
31690 the command line &%-f%& option is used, it overrides the &"From"& line.
31691
31692 If the caller of Exim is not trusted, the &"From"& line is recognized, but the
31693 sender address is not changed. This is also the case for incoming SMTP messages
31694 that are permitted to contain &"From"& lines.
31695
31696 Only one &"From"& line is recognized. If there is more than one, the second is
31697 treated as a data line that starts the body of the message, as it is not valid
31698 as a header line. This also happens if a &"From"& line is present in an
31699 incoming SMTP message from a source that is not permitted to send them.
31700
31701
31702
31703 .section "Resent- header lines" "SECID220"
31704 .cindex "&%Resent-%& header lines"
31705 RFC 2822 makes provision for sets of header lines starting with the string
31706 &`Resent-`& to be added to a message when it is resent by the original
31707 recipient to somebody else. These headers are &'Resent-Date:'&,
31708 &'Resent-From:'&, &'Resent-Sender:'&, &'Resent-To:'&, &'Resent-Cc:'&,
31709 &'Resent-Bcc:'& and &'Resent-Message-ID:'&. The RFC says:
31710
31711 .blockquote
31712 &'Resent fields are strictly informational. They MUST NOT be used in the normal
31713 processing of replies or other such automatic actions on messages.'&
31714 .endblockquote
31715
31716 This leaves things a bit vague as far as other processing actions such as
31717 address rewriting are concerned. Exim treats &%Resent-%& header lines as
31718 follows:
31719
31720 .ilist
31721 A &'Resent-From:'& line that just contains the login id of the submitting user
31722 is automatically rewritten in the same way as &'From:'& (see below).
31723 .next
31724 If there's a rewriting rule for a particular header line, it is also applied to
31725 &%Resent-%& header lines of the same type. For example, a rule that rewrites
31726 &'From:'& also rewrites &'Resent-From:'&.
31727 .next
31728 For local messages, if &'Sender:'& is removed on input, &'Resent-Sender:'& is
31729 also removed.
31730 .next
31731 For a locally-submitted message,
31732 if there are any &%Resent-%& header lines but no &'Resent-Date:'&,
31733 &'Resent-From:'&, or &'Resent-Message-Id:'&, they are added as necessary. It is
31734 the contents of &'Resent-Message-Id:'& (rather than &'Message-Id:'&) which are
31735 included in log lines in this case.
31736 .next
31737 The logic for adding &'Sender:'& is duplicated for &'Resent-Sender:'& when any
31738 &%Resent-%& header lines are present.
31739 .endlist
31740
31741
31742
31743
31744 .section "The Auto-Submitted: header line" "SECID221"
31745 Whenever Exim generates an autoreply, a bounce, or a delay warning message, it
31746 includes the header line:
31747 .code
31748 Auto-Submitted: auto-replied
31749 .endd
31750
31751 .section "The Bcc: header line" "SECID222"
31752 .cindex "&'Bcc:'& header line"
31753 If Exim is called with the &%-t%& option, to take recipient addresses from a
31754 message's header, it removes any &'Bcc:'& header line that may exist (after
31755 extracting its addresses). If &%-t%& is not present on the command line, any
31756 existing &'Bcc:'& is not removed.
31757
31758
31759 .section "The Date: header line" "SECID223"
31760 .cindex "&'Date:'& header line"
31761 If a locally-generated or submission-mode message has no &'Date:'& header line,
31762 Exim adds one, using the current date and time, unless the
31763 &%suppress_local_fixups%& control has been specified.
31764
31765 .section "The Delivery-date: header line" "SECID224"
31766 .cindex "&'Delivery-date:'& header line"
31767 .oindex "&%delivery_date_remove%&"
31768 &'Delivery-date:'& header lines are not part of the standard RFC 2822 header
31769 set. Exim can be configured to add them to the final delivery of messages. (See
31770 the generic &%delivery_date_add%& transport option.) They should not be present
31771 in messages in transit. If the &%delivery_date_remove%& configuration option is
31772 set (the default), Exim removes &'Delivery-date:'& header lines from incoming
31773 messages.
31774
31775
31776 .section "The Envelope-to: header line" "SECID225"
31777 .cindex "&'Envelope-to:'& header line"
31778 .oindex "&%envelope_to_remove%&"
31779 &'Envelope-to:'& header lines are not part of the standard RFC 2822 header set.
31780 Exim can be configured to add them to the final delivery of messages. (See the
31781 generic &%envelope_to_add%& transport option.) They should not be present in
31782 messages in transit. If the &%envelope_to_remove%& configuration option is set
31783 (the default), Exim removes &'Envelope-to:'& header lines from incoming
31784 messages.
31785
31786
31787 .section "The From: header line" "SECTthefrohea"
31788 .cindex "&'From:'& header line"
31789 .cindex "Sendmail compatibility" "&""From""& line"
31790 .cindex "message" "submission"
31791 .cindex "submission mode"
31792 If a submission-mode message does not contain a &'From:'& header line, Exim
31793 adds one if either of the following conditions is true:
31794
31795 .ilist
31796 The envelope sender address is not empty (that is, this is not a bounce
31797 message). The added header line copies the envelope sender address.
31798 .next
31799 .vindex "&$authenticated_id$&"
31800 The SMTP session is authenticated and &$authenticated_id$& is not empty.
31801 .olist
31802 .vindex "&$qualify_domain$&"
31803 If no domain is specified by the submission control, the local part is
31804 &$authenticated_id$& and the domain is &$qualify_domain$&.
31805 .next
31806 If a non-empty domain is specified by the submission control, the local
31807 part is &$authenticated_id$&, and the domain is the specified domain.
31808 .next
31809 If an empty domain is specified by the submission control,
31810 &$authenticated_id$& is assumed to be the complete address.
31811 .endlist
31812 .endlist
31813
31814 A non-empty envelope sender takes precedence.
31815
31816 If a locally-generated incoming message does not contain a &'From:'& header
31817 line, and the &%suppress_local_fixups%& control is not set, Exim adds one
31818 containing the sender's address. The calling user's login name and full name
31819 are used to construct the address, as described in section &<<SECTconstr>>&.
31820 They are obtained from the password data by calling &[getpwuid()]& (but see the
31821 &%unknown_login%& configuration option). The address is qualified with
31822 &%qualify_domain%&.
31823
31824 For compatibility with Sendmail, if an incoming, non-SMTP message has a
31825 &'From:'& header line containing just the unqualified login name of the calling
31826 user, this is replaced by an address containing the user's login name and full
31827 name as described in section &<<SECTconstr>>&.
31828
31829
31830 .section "The Message-ID: header line" "SECID226"
31831 .cindex "&'Message-ID:'& header line"
31832 .cindex "message" "submission"
31833 .oindex "&%message_id_header_text%&"
31834 If a locally-generated or submission-mode incoming message does not contain a
31835 &'Message-ID:'& or &'Resent-Message-ID:'& header line, and the
31836 &%suppress_local_fixups%& control is not set, Exim adds a suitable header line
31837 to the message. If there are any &'Resent-:'& headers in the message, it
31838 creates &'Resent-Message-ID:'&. The id is constructed from Exim's internal
31839 message id, preceded by the letter E to ensure it starts with a letter, and
31840 followed by @ and the primary host name. Additional information can be included
31841 in this header line by setting the &%message_id_header_text%& and/or
31842 &%message_id_header_domain%& options.
31843
31844
31845 .section "The Received: header line" "SECID227"
31846 .cindex "&'Received:'& header line"
31847 A &'Received:'& header line is added at the start of every message. The
31848 contents are defined by the &%received_header_text%& configuration option, and
31849 Exim automatically adds a semicolon and a timestamp to the configured string.
31850
31851 The &'Received:'& header is generated as soon as the message's header lines
31852 have been received. At this stage, the timestamp in the &'Received:'& header
31853 line is the time that the message started to be received. This is the value
31854 that is seen by the DATA ACL and by the &[local_scan()]& function.
31855
31856 Once a message is accepted, the timestamp in the &'Received:'& header line is
31857 changed to the time of acceptance, which is (apart from a small delay while the
31858 -H spool file is written) the earliest time at which delivery could start.
31859
31860
31861 .section "The References: header line" "SECID228"
31862 .cindex "&'References:'& header line"
31863 Messages created by the &(autoreply)& transport include a &'References:'&
31864 header line. This is constructed according to the rules that are described in
31865 section 3.64 of RFC 2822 (which states that replies should contain such a
31866 header line), and section 3.14 of RFC 3834 (which states that automatic
31867 responses are not different in this respect). However, because some mail
31868 processing software does not cope well with very long header lines, no more
31869 than 12 message IDs are copied from the &'References:'& header line in the
31870 incoming message. If there are more than 12, the first one and then the final
31871 11 are copied, before adding the message ID of the incoming message.
31872
31873
31874
31875 .section "The Return-path: header line" "SECID229"
31876 .cindex "&'Return-path:'& header line"
31877 .oindex "&%return_path_remove%&"
31878 &'Return-path:'& header lines are defined as something an MTA may insert when
31879 it does the final delivery of messages. (See the generic &%return_path_add%&
31880 transport option.) Therefore, they should not be present in messages in
31881 transit. If the &%return_path_remove%& configuration option is set (the
31882 default), Exim removes &'Return-path:'& header lines from incoming messages.
31883
31884
31885
31886 .section "The Sender: header line" "SECTthesenhea"
31887 .cindex "&'Sender:'& header line"
31888 .cindex "message" "submission"
31889 For a locally-originated message from an untrusted user, Exim may remove an
31890 existing &'Sender:'& header line, and it may add a new one. You can modify
31891 these actions by setting the &%local_sender_retain%& option true, the
31892 &%local_from_check%& option false, or by using the &%suppress_local_fixups%&
31893 control setting.
31894
31895 When a local message is received from an untrusted user and
31896 &%local_from_check%& is true (the default), and the &%suppress_local_fixups%&
31897 control has not been set, a check is made to see if the address given in the
31898 &'From:'& header line is the correct (local) sender of the message. The address
31899 that is expected has the login name as the local part and the value of
31900 &%qualify_domain%& as the domain. Prefixes and suffixes for the local part can
31901 be permitted by setting &%local_from_prefix%& and &%local_from_suffix%&
31902 appropriately. If &'From:'& does not contain the correct sender, a &'Sender:'&
31903 line is added to the message.
31904
31905 If you set &%local_from_check%& false, this checking does not occur. However,
31906 the removal of an existing &'Sender:'& line still happens, unless you also set
31907 &%local_sender_retain%& to be true. It is not possible to set both of these
31908 options true at the same time.
31909
31910 .cindex "submission mode"
31911 By default, no processing of &'Sender:'& header lines is done for messages
31912 received over TCP/IP or for messages submitted by trusted users. However, when
31913 a message is received over TCP/IP in submission mode, and &%sender_retain%& is
31914 not specified on the submission control, the following processing takes place:
31915
31916 .vindex "&$authenticated_id$&"
31917 First, any existing &'Sender:'& lines are removed. Then, if the SMTP session is
31918 authenticated, and &$authenticated_id$& is not empty, a sender address is
31919 created as follows:
31920
31921 .ilist
31922 .vindex "&$qualify_domain$&"
31923 If no domain is specified by the submission control, the local part is
31924 &$authenticated_id$& and the domain is &$qualify_domain$&.
31925 .next
31926 If a non-empty domain is specified by the submission control, the local part
31927 is &$authenticated_id$&, and the domain is the specified domain.
31928 .next
31929 If an empty domain is specified by the submission control,
31930 &$authenticated_id$& is assumed to be the complete address.
31931 .endlist
31932
31933 This address is compared with the address in the &'From:'& header line. If they
31934 are different, a &'Sender:'& header line containing the created address is
31935 added. Prefixes and suffixes for the local part in &'From:'& can be permitted
31936 by setting &%local_from_prefix%& and &%local_from_suffix%& appropriately.
31937
31938 .cindex "return path" "created from &'Sender:'&"
31939 &*Note*&: Whenever a &'Sender:'& header line is created, the return path for
31940 the message (the envelope sender address) is changed to be the same address,
31941 except in the case of submission mode when &%sender_retain%& is specified.
31942
31943
31944
31945 .section "Adding and removing header lines in routers and transports" &&&
31946          "SECTheadersaddrem"
31947 .cindex "header lines" "adding; in router or transport"
31948 .cindex "header lines" "removing; in router or transport"
31949 When a message is delivered, the addition and removal of header lines can be
31950 specified in a system filter, or on any of the routers and transports that
31951 process the message. Section &<<SECTaddremheasys>>& contains details about
31952 modifying headers in a system filter. Header lines can also be added in an ACL
31953 as a message is received (see section &<<SECTaddheadacl>>&).
31954
31955 In contrast to what happens in a system filter, header modifications that are
31956 specified on routers and transports apply only to the particular recipient
31957 addresses that are being processed by those routers and transports. These
31958 changes do not actually take place until a copy of the message is being
31959 transported. Therefore, they do not affect the basic set of header lines, and
31960 they do not affect the values of the variables that refer to header lines.
31961
31962 &*Note*&: In particular, this means that any expansions in the configuration of
31963 the transport cannot refer to the modified header lines, because such
31964 expansions all occur before the message is actually transported.
31965
31966 For both routers and transports, the result of expanding a &%headers_add%&
31967 option must be in the form of one or more RFC 2822 header lines, separated by
31968 newlines (coded as &"\n"&). For example:
31969 .code
31970 headers_add = X-added-header: added by $primary_hostname\n\
31971               X-added-second: another added header line
31972 .endd
31973 Exim does not check the syntax of these added header lines.
31974
31975 Multiple &%headers_add%& options for a single router or transport can be
31976 specified; the values will be concatenated (with a separating newline
31977 added) before expansion.
31978
31979 The result of expanding &%headers_remove%& must consist of a colon-separated
31980 list of header names. This is confusing, because header names themselves are
31981 often terminated by colons. In this case, the colons are the list separators,
31982 not part of the names. For example:
31983 .code
31984 headers_remove = return-receipt-to:acknowledge-to
31985 .endd
31986
31987 Multiple &%headers_remove%& options for a single router or transport can be
31988 specified; the values will be concatenated (with a separating colon
31989 added) before expansion.
31990
31991 When &%headers_add%& or &%headers_remove%& is specified on a router, its value
31992 is expanded at routing time, and then associated with all addresses that are
31993 accepted by that router, and also with any new addresses that it generates. If
31994 an address passes through several routers as a result of aliasing or
31995 forwarding, the changes are cumulative.
31996
31997 .oindex "&%unseen%&"
31998 However, this does not apply to multiple routers that result from the use of
31999 the &%unseen%& option. Any header modifications that were specified by the
32000 &"unseen"& router or its predecessors apply only to the &"unseen"& delivery.
32001
32002 Addresses that end up with different &%headers_add%& or &%headers_remove%&
32003 settings cannot be delivered together in a batch, so a transport is always
32004 dealing with a set of addresses that have the same header-processing
32005 requirements.
32006
32007 The transport starts by writing the original set of header lines that arrived
32008 with the message, possibly modified by the system filter. As it writes out
32009 these lines, it consults the list of header names that were attached to the
32010 recipient address(es) by &%headers_remove%& options in routers, and it also
32011 consults the transport's own &%headers_remove%& option. Header lines whose
32012 names are on either of these lists are not written out. If there are multiple
32013 instances of any listed header, they are all skipped.
32014
32015 After the remaining original header lines have been written, new header
32016 lines that were specified by routers' &%headers_add%& options are written, in
32017 the order in which they were attached to the address. These are followed by any
32018 header lines specified by the transport's &%headers_add%& option.
32019
32020 This way of handling header line modifications in routers and transports has
32021 the following consequences:
32022
32023 .ilist
32024 The original set of header lines, possibly modified by the system filter,
32025 remains &"visible"&, in the sense that the &$header_$&&'xxx'& variables refer
32026 to it, at all times.
32027 .next
32028 Header lines that are added by a router's
32029 &%headers_add%& option are not accessible by means of the &$header_$&&'xxx'&
32030 expansion syntax in subsequent routers or the transport.
32031 .next
32032 Conversely, header lines that are specified for removal by &%headers_remove%&
32033 in a router remain visible to subsequent routers and the transport.
32034 .next
32035 Headers added to an address by &%headers_add%& in a router cannot be removed by
32036 a later router or by a transport.
32037 .next
32038 An added header can refer to the contents of an original header that is to be
32039 removed, even it has the same name as the added header. For example:
32040 .code
32041 headers_remove = subject
32042 headers_add = Subject: new subject (was: $h_subject:)
32043 .endd
32044 .endlist
32045
32046 &*Warning*&: The &%headers_add%& and &%headers_remove%& options cannot be used
32047 for a &(redirect)& router that has the &%one_time%& option set.
32048
32049
32050
32051
32052
32053 .section "Constructed addresses" "SECTconstr"
32054 .cindex "address" "constructed"
32055 .cindex "constructed address"
32056 When Exim constructs a sender address for a locally-generated message, it uses
32057 the form
32058 .display
32059 <&'user name'&>&~&~<&'login'&&`@`&&'qualify_domain'&>
32060 .endd
32061 For example:
32062 .code
32063 Zaphod Beeblebrox <zaphod@end.univ.example>
32064 .endd
32065 The user name is obtained from the &%-F%& command line option if set, or
32066 otherwise by looking up the calling user by &[getpwuid()]& and extracting the
32067 &"gecos"& field from the password entry. If the &"gecos"& field contains an
32068 ampersand character, this is replaced by the login name with the first letter
32069 upper cased, as is conventional in a number of operating systems. See the
32070 &%gecos_name%& option for a way to tailor the handling of the &"gecos"& field.
32071 The &%unknown_username%& option can be used to specify user names in cases when
32072 there is no password file entry.
32073
32074 .cindex "RFC 2047"
32075 In all cases, the user name is made to conform to RFC 2822 by quoting all or
32076 parts of it if necessary. In addition, if it contains any non-printing
32077 characters, it is encoded as described in RFC 2047, which defines a way of
32078 including non-ASCII characters in header lines. The value of the
32079 &%headers_charset%& option specifies the name of the encoding that is used (the
32080 characters are assumed to be in this encoding). The setting of
32081 &%print_topbitchars%& controls whether characters with the top bit set (that
32082 is, with codes greater than 127) count as printing characters or not.
32083
32084
32085
32086 .section "Case of local parts" "SECID230"
32087 .cindex "case of local parts"
32088 .cindex "local part" "case of"
32089 RFC 2822 states that the case of letters in the local parts of addresses cannot
32090 be assumed to be non-significant. Exim preserves the case of local parts of
32091 addresses, but by default it uses a lower-cased form when it is routing,
32092 because on most Unix systems, usernames are in lower case and case-insensitive
32093 routing is required. However, any particular router can be made to use the
32094 original case for local parts by setting the &%caseful_local_part%& generic
32095 router option.
32096
32097 .cindex "mixed-case login names"
32098 If you must have mixed-case user names on your system, the best way to proceed,
32099 assuming you want case-independent handling of incoming email, is to set up
32100 your first router to convert incoming local parts in your domains to the
32101 correct case by means of a file lookup. For example:
32102 .code
32103 correct_case:
32104   driver = redirect
32105   domains = +local_domains
32106   data = ${lookup{$local_part}cdb\
32107               {/etc/usercased.cdb}{$value}fail}\
32108               @$domain
32109 .endd
32110 For this router, the local part is forced to lower case by the default action
32111 (&%caseful_local_part%& is not set). The lower-cased local part is used to look
32112 up a new local part in the correct case. If you then set &%caseful_local_part%&
32113 on any subsequent routers which process your domains, they will operate on
32114 local parts with the correct case in a case-sensitive manner.
32115
32116
32117
32118 .section "Dots in local parts" "SECID231"
32119 .cindex "dot" "in local part"
32120 .cindex "local part" "dots in"
32121 RFC 2822 forbids empty components in local parts. That is, an unquoted local
32122 part may not begin or end with a dot, nor have two consecutive dots in the
32123 middle. However, it seems that many MTAs do not enforce this, so Exim permits
32124 empty components for compatibility.
32125
32126
32127
32128 .section "Rewriting addresses" "SECID232"
32129 .cindex "rewriting" "addresses"
32130 Rewriting of sender and recipient addresses, and addresses in headers, can
32131 happen automatically, or as the result of configuration options, as described
32132 in chapter &<<CHAPrewrite>>&. The headers that may be affected by this are
32133 &'Bcc:'&, &'Cc:'&, &'From:'&, &'Reply-To:'&, &'Sender:'&, and &'To:'&.
32134
32135 Automatic rewriting includes qualification, as mentioned above. The other case
32136 in which it can happen is when an incomplete non-local domain is given. The
32137 routing process may cause this to be expanded into the full domain name. For
32138 example, a header such as
32139 .code
32140 To: hare@teaparty
32141 .endd
32142 might get rewritten as
32143 .code
32144 To: hare@teaparty.wonderland.fict.example
32145 .endd
32146 Rewriting as a result of routing is the one kind of message processing that
32147 does not happen at input time, as it cannot be done until the address has
32148 been routed.
32149
32150 Strictly, one should not do &'any'& deliveries of a message until all its
32151 addresses have been routed, in case any of the headers get changed as a
32152 result of routing. However, doing this in practice would hold up many
32153 deliveries for unreasonable amounts of time, just because one address could not
32154 immediately be routed. Exim therefore does not delay other deliveries when
32155 routing of one or more addresses is deferred.
32156 .ecindex IIDmesproc
32157
32158
32159
32160 . ////////////////////////////////////////////////////////////////////////////
32161 . ////////////////////////////////////////////////////////////////////////////
32162
32163 .chapter "SMTP processing" "CHAPSMTP"
32164 .scindex IIDsmtpproc1 "SMTP" "processing details"
32165 .scindex IIDsmtpproc2 "LMTP" "processing details"
32166 Exim supports a number of different ways of using the SMTP protocol, and its
32167 LMTP variant, which is an interactive protocol for transferring messages into a
32168 closed mail store application. This chapter contains details of how SMTP is
32169 processed. For incoming mail, the following are available:
32170
32171 .ilist
32172 SMTP over TCP/IP (Exim daemon or &'inetd'&);
32173 .next
32174 SMTP over the standard input and output (the &%-bs%& option);
32175 .next
32176 Batched SMTP on the standard input (the &%-bS%& option).
32177 .endlist
32178
32179 For mail delivery, the following are available:
32180
32181 .ilist
32182 SMTP over TCP/IP (the &(smtp)& transport);
32183 .next
32184 LMTP over TCP/IP (the &(smtp)& transport with the &%protocol%& option set to
32185 &"lmtp"&);
32186 .next
32187 LMTP over a pipe to a process running in the local host (the &(lmtp)&
32188 transport);
32189 .next
32190 Batched SMTP to a file or pipe (the &(appendfile)& and &(pipe)& transports with
32191 the &%use_bsmtp%& option set).
32192 .endlist
32193
32194 &'Batched SMTP'& is the name for a process in which batches of messages are
32195 stored in or read from files (or pipes), in a format in which SMTP commands are
32196 used to contain the envelope information.
32197
32198
32199
32200 .section "Outgoing SMTP and LMTP over TCP/IP" "SECToutSMTPTCP"
32201 .cindex "SMTP" "outgoing over TCP/IP"
32202 .cindex "outgoing SMTP over TCP/IP"
32203 .cindex "LMTP" "over TCP/IP"
32204 .cindex "outgoing LMTP over TCP/IP"
32205 .cindex "EHLO"
32206 .cindex "HELO"
32207 .cindex "SIZE option on MAIL command"
32208 Outgoing SMTP and LMTP over TCP/IP is implemented by the &(smtp)& transport.
32209 The &%protocol%& option selects which protocol is to be used, but the actual
32210 processing is the same in both cases.
32211
32212 If, in response to its EHLO command, Exim is told that the SIZE
32213 parameter is supported, it adds SIZE=<&'n'&> to each subsequent MAIL
32214 command. The value of <&'n'&> is the message size plus the value of the
32215 &%size_addition%& option (default 1024) to allow for additions to the message
32216 such as per-transport header lines, or changes made in a
32217 .cindex "transport" "filter"
32218 .cindex "filter" "transport filter"
32219 transport filter. If &%size_addition%& is set negative, the use of SIZE is
32220 suppressed.
32221
32222 If the remote server advertises support for PIPELINING, Exim uses the
32223 pipelining extension to SMTP (RFC 2197) to reduce the number of TCP/IP packets
32224 required for the transaction.
32225
32226 If the remote server advertises support for the STARTTLS command, and Exim
32227 was built to support TLS encryption, it tries to start a TLS session unless the
32228 server matches &%hosts_avoid_tls%&. See chapter &<<CHAPTLS>>& for more details.
32229 Either a match in that or &%hosts_verify_avoid_tls%& apply when the transport
32230 is called for verification.
32231
32232 If the remote server advertises support for the AUTH command, Exim scans
32233 the authenticators configuration for any suitable client settings, as described
32234 in chapter &<<CHAPSMTPAUTH>>&.
32235
32236 .cindex "carriage return"
32237 .cindex "linefeed"
32238 Responses from the remote host are supposed to be terminated by CR followed by
32239 LF. However, there are known to be hosts that do not send CR characters, so in
32240 order to be able to interwork with such hosts, Exim treats LF on its own as a
32241 line terminator.
32242
32243 If a message contains a number of different addresses, all those with the same
32244 characteristics (for example, the same envelope sender) that resolve to the
32245 same set of hosts, in the same order, are sent in a single SMTP transaction,
32246 even if they are for different domains, unless there are more than the setting
32247 of the &%max_rcpt%&s option in the &(smtp)& transport allows, in which case
32248 they are split into groups containing no more than &%max_rcpt%&s addresses
32249 each. If &%remote_max_parallel%& is greater than one, such groups may be sent
32250 in parallel sessions. The order of hosts with identical MX values is not
32251 significant when checking whether addresses can be batched in this way.
32252
32253 When the &(smtp)& transport suffers a temporary failure that is not
32254 message-related, Exim updates its transport-specific database, which contains
32255 records indexed by host name that remember which messages are waiting for each
32256 particular host. It also updates the retry database with new retry times.
32257
32258 .cindex "hints database" "retry keys"
32259 Exim's retry hints are based on host name plus IP address, so if one address of
32260 a multi-homed host is broken, it will soon be skipped most of the time.
32261 See the next section for more detail about error handling.
32262
32263 .cindex "SMTP" "passed connection"
32264 .cindex "SMTP" "batching over TCP/IP"
32265 When a message is successfully delivered over a TCP/IP SMTP connection, Exim
32266 looks in the hints database for the transport to see if there are any queued
32267 messages waiting for the host to which it is connected. If it finds one, it
32268 creates a new Exim process using the &%-MC%& option (which can only be used by
32269 a process running as root or the Exim user) and passes the TCP/IP socket to it
32270 so that it can deliver another message using the same socket. The new process
32271 does only those deliveries that are routed to the connected host, and may in
32272 turn pass the socket on to a third process, and so on.
32273
32274 The &%connection_max_messages%& option of the &(smtp)& transport can be used to
32275 limit the number of messages sent down a single TCP/IP connection.
32276
32277 .cindex "asterisk" "after IP address"
32278 The second and subsequent messages delivered down an existing connection are
32279 identified in the main log by the addition of an asterisk after the closing
32280 square bracket of the IP address.
32281
32282
32283
32284
32285 .section "Errors in outgoing SMTP" "SECToutSMTPerr"
32286 .cindex "error" "in outgoing SMTP"
32287 .cindex "SMTP" "errors in outgoing"
32288 .cindex "host" "error"
32289 Three different kinds of error are recognized for outgoing SMTP: host errors,
32290 message errors, and recipient errors.
32291
32292 .vlist
32293 .vitem "&*Host errors*&"
32294 A host error is not associated with a particular message or with a
32295 particular recipient of a message. The host errors are:
32296
32297 .ilist
32298 Connection refused or timed out,
32299 .next
32300 Any error response code on connection,
32301 .next
32302 Any error response code to EHLO or HELO,
32303 .next
32304 Loss of connection at any time, except after &"."&,
32305 .next
32306 I/O errors at any time,
32307 .next
32308 Timeouts during the session, other than in response to MAIL, RCPT or
32309 the &"."& at the end of the data.
32310 .endlist ilist
32311
32312 For a host error, a permanent error response on connection, or in response to
32313 EHLO, causes all addresses routed to the host to be failed. Any other host
32314 error causes all addresses to be deferred, and retry data to be created for the
32315 host. It is not tried again, for any message, until its retry time arrives. If
32316 the current set of addresses are not all delivered in this run (to some
32317 alternative host), the message is added to the list of those waiting for this
32318 host, so if it is still undelivered when a subsequent successful delivery is
32319 made to the host, it will be sent down the same SMTP connection.
32320
32321 .vitem "&*Message errors*&"
32322 .cindex "message" "error"
32323 A message error is associated with a particular message when sent to a
32324 particular host, but not with a particular recipient of the message. The
32325 message errors are:
32326
32327 .ilist
32328 Any error response code to MAIL, DATA, or the &"."& that terminates
32329 the data,
32330 .next
32331 Timeout after MAIL,
32332 .next
32333 Timeout or loss of connection after the &"."& that terminates the data. A
32334 timeout after the DATA command itself is treated as a host error, as is loss of
32335 connection at any other time.
32336 .endlist ilist
32337
32338 For a message error, a permanent error response (5&'xx'&) causes all addresses
32339 to be failed, and a delivery error report to be returned to the sender. A
32340 temporary error response (4&'xx'&), or one of the timeouts, causes all
32341 addresses to be deferred. Retry data is not created for the host, but instead,
32342 a retry record for the combination of host plus message id is created. The
32343 message is not added to the list of those waiting for this host. This ensures
32344 that the failing message will not be sent to this host again until the retry
32345 time arrives. However, other messages that are routed to the host are not
32346 affected, so if it is some property of the message that is causing the error,
32347 it will not stop the delivery of other mail.
32348
32349 If the remote host specified support for the SIZE parameter in its response
32350 to EHLO, Exim adds SIZE=&'nnn'& to the MAIL command, so an
32351 over-large message will cause a message error because the error arrives as a
32352 response to MAIL.
32353
32354 .vitem "&*Recipient errors*&"
32355 .cindex "recipient" "error"
32356 A recipient error is associated with a particular recipient of a message. The
32357 recipient errors are:
32358
32359 .ilist
32360 Any error response to RCPT,
32361 .next
32362 Timeout after RCPT.
32363 .endlist
32364
32365 For a recipient error, a permanent error response (5&'xx'&) causes the
32366 recipient address to be failed, and a bounce message to be returned to the
32367 sender. A temporary error response (4&'xx'&) or a timeout causes the failing
32368 address to be deferred, and routing retry data to be created for it. This is
32369 used to delay processing of the address in subsequent queue runs, until its
32370 routing retry time arrives. This applies to all messages, but because it
32371 operates only in queue runs, one attempt will be made to deliver a new message
32372 to the failing address before the delay starts to operate. This ensures that,
32373 if the failure is really related to the message rather than the recipient
32374 (&"message too big for this recipient"& is a possible example), other messages
32375 have a chance of getting delivered. If a delivery to the address does succeed,
32376 the retry information gets cleared, so all stuck messages get tried again, and
32377 the retry clock is reset.
32378
32379 The message is not added to the list of those waiting for this host. Use of the
32380 host for other messages is unaffected, and except in the case of a timeout,
32381 other recipients are processed independently, and may be successfully delivered
32382 in the current SMTP session. After a timeout it is of course impossible to
32383 proceed with the session, so all addresses get deferred. However, those other
32384 than the one that failed do not suffer any subsequent retry delays. Therefore,
32385 if one recipient is causing trouble, the others have a chance of getting
32386 through when a subsequent delivery attempt occurs before the failing
32387 recipient's retry time.
32388 .endlist
32389
32390 In all cases, if there are other hosts (or IP addresses) available for the
32391 current set of addresses (for example, from multiple MX records), they are
32392 tried in this run for any undelivered addresses, subject of course to their
32393 own retry data. In other words, recipient error retry data does not take effect
32394 until the next delivery attempt.
32395
32396 Some hosts have been observed to give temporary error responses to every
32397 MAIL command at certain times (&"insufficient space"& has been seen). It
32398 would be nice if such circumstances could be recognized, and defer data for the
32399 host itself created, but this is not possible within the current Exim design.
32400 What actually happens is that retry data for every (host, message) combination
32401 is created.
32402
32403 The reason that timeouts after MAIL and RCPT are treated specially is that
32404 these can sometimes arise as a result of the remote host's verification
32405 procedures. Exim makes this assumption, and treats them as if a temporary error
32406 response had been received. A timeout after &"."& is treated specially because
32407 it is known that some broken implementations fail to recognize the end of the
32408 message if the last character of the last line is a binary zero. Thus, it is
32409 helpful to treat this case as a message error.
32410
32411 Timeouts at other times are treated as host errors, assuming a problem with the
32412 host, or the connection to it. If a timeout after MAIL, RCPT,
32413 or &"."& is really a connection problem, the assumption is that at the next try
32414 the timeout is likely to occur at some other point in the dialogue, causing it
32415 then to be treated as a host error.
32416
32417 There is experimental evidence that some MTAs drop the connection after the
32418 terminating &"."& if they do not like the contents of the message for some
32419 reason, in contravention of the RFC, which indicates that a 5&'xx'& response
32420 should be given. That is why Exim treats this case as a message rather than a
32421 host error, in order not to delay other messages to the same host.
32422
32423
32424
32425
32426 .section "Incoming SMTP messages over TCP/IP" "SECID233"
32427 .cindex "SMTP" "incoming over TCP/IP"
32428 .cindex "incoming SMTP over TCP/IP"
32429 .cindex "inetd"
32430 .cindex "daemon"
32431 Incoming SMTP messages can be accepted in one of two ways: by running a
32432 listening daemon, or by using &'inetd'&. In the latter case, the entry in
32433 &_/etc/inetd.conf_& should be like this:
32434 .code
32435 smtp stream tcp nowait exim /opt/exim/bin/exim in.exim -bs
32436 .endd
32437 Exim distinguishes between this case and the case of a locally running user
32438 agent using the &%-bs%& option by checking whether or not the standard input is
32439 a socket. When it is, either the port must be privileged (less than 1024), or
32440 the caller must be root or the Exim user. If any other user passes a socket
32441 with an unprivileged port number, Exim prints a message on the standard error
32442 stream and exits with an error code.
32443
32444 By default, Exim does not make a log entry when a remote host connects or
32445 disconnects (either via the daemon or &'inetd'&), unless the disconnection is
32446 unexpected. It can be made to write such log entries by setting the
32447 &%smtp_connection%& log selector.
32448
32449 .cindex "carriage return"
32450 .cindex "linefeed"
32451 Commands from the remote host are supposed to be terminated by CR followed by
32452 LF. However, there are known to be hosts that do not send CR characters. In
32453 order to be able to interwork with such hosts, Exim treats LF on its own as a
32454 line terminator.
32455 Furthermore, because common code is used for receiving messages from all
32456 sources, a CR on its own is also interpreted as a line terminator. However, the
32457 sequence &"CR, dot, CR"& does not terminate incoming SMTP data.
32458
32459 .cindex "EHLO" "invalid data"
32460 .cindex "HELO" "invalid data"
32461 One area that sometimes gives rise to problems concerns the EHLO or
32462 HELO commands. Some clients send syntactically invalid versions of these
32463 commands, which Exim rejects by default. (This is nothing to do with verifying
32464 the data that is sent, so &%helo_verify_hosts%& is not relevant.) You can tell
32465 Exim not to apply a syntax check by setting &%helo_accept_junk_hosts%& to
32466 match the broken hosts that send invalid commands.
32467
32468 .cindex "SIZE option on MAIL command"
32469 .cindex "MAIL" "SIZE option"
32470 The amount of disk space available is checked whenever SIZE is received on
32471 a MAIL command, independently of whether &%message_size_limit%& or
32472 &%check_spool_space%& is configured, unless &%smtp_check_spool_space%& is set
32473 false. A temporary error is given if there is not enough space. If
32474 &%check_spool_space%& is set, the check is for that amount of space plus the
32475 value given with SIZE, that is, it checks that the addition of the incoming
32476 message will not reduce the space below the threshold.
32477
32478 When a message is successfully received, Exim includes the local message id in
32479 its response to the final &"."& that terminates the data. If the remote host
32480 logs this text it can help with tracing what has happened to a message.
32481
32482 The Exim daemon can limit the number of simultaneous incoming connections it is
32483 prepared to handle (see the &%smtp_accept_max%& option). It can also limit the
32484 number of simultaneous incoming connections from a single remote host (see the
32485 &%smtp_accept_max_per_host%& option). Additional connection attempts are
32486 rejected using the SMTP temporary error code 421.
32487
32488 The Exim daemon does not rely on the SIGCHLD signal to detect when a
32489 subprocess has finished, as this can get lost at busy times. Instead, it looks
32490 for completed subprocesses every time it wakes up. Provided there are other
32491 things happening (new incoming calls, starts of queue runs), completed
32492 processes will be noticed and tidied away. On very quiet systems you may
32493 sometimes see a &"defunct"& Exim process hanging about. This is not a problem;
32494 it will be noticed when the daemon next wakes up.
32495
32496 When running as a daemon, Exim can reserve some SMTP slots for specific hosts,
32497 and can also be set up to reject SMTP calls from non-reserved hosts at times of
32498 high system load &-- for details see the &%smtp_accept_reserve%&,
32499 &%smtp_load_reserve%&, and &%smtp_reserve_hosts%& options. The load check
32500 applies in both the daemon and &'inetd'& cases.
32501
32502 Exim normally starts a delivery process for each message received, though this
32503 can be varied by means of the &%-odq%& command line option and the
32504 &%queue_only%&, &%queue_only_file%&, and &%queue_only_load%& options. The
32505 number of simultaneously running delivery processes started in this way from
32506 SMTP input can be limited by the &%smtp_accept_queue%& and
32507 &%smtp_accept_queue_per_connection%& options. When either limit is reached,
32508 subsequently received messages are just put on the input queue without starting
32509 a delivery process.
32510
32511 The controls that involve counts of incoming SMTP calls (&%smtp_accept_max%&,
32512 &%smtp_accept_queue%&, &%smtp_accept_reserve%&) are not available when Exim is
32513 started up from the &'inetd'& daemon, because in that case each connection is
32514 handled by an entirely independent Exim process. Control by load average is,
32515 however, available with &'inetd'&.
32516
32517 Exim can be configured to verify addresses in incoming SMTP commands as they
32518 are received. See chapter &<<CHAPACL>>& for details. It can also be configured
32519 to rewrite addresses at this time &-- before any syntax checking is done. See
32520 section &<<SECTrewriteS>>&.
32521
32522 Exim can also be configured to limit the rate at which a client host submits
32523 MAIL and RCPT commands in a single SMTP session. See the
32524 &%smtp_ratelimit_hosts%& option.
32525
32526
32527
32528 .section "Unrecognized SMTP commands" "SECID234"
32529 .cindex "SMTP" "unrecognized commands"
32530 If Exim receives more than &%smtp_max_unknown_commands%& unrecognized SMTP
32531 commands during a single SMTP connection, it drops the connection after sending
32532 the error response to the last command. The default value for
32533 &%smtp_max_unknown_commands%& is 3. This is a defence against some kinds of
32534 abuse that subvert web servers into making connections to SMTP ports; in these
32535 circumstances, a number of non-SMTP lines are sent first.
32536
32537
32538 .section "Syntax and protocol errors in SMTP commands" "SECID235"
32539 .cindex "SMTP" "syntax errors"
32540 .cindex "SMTP" "protocol errors"
32541 A syntax error is detected if an SMTP command is recognized, but there is
32542 something syntactically wrong with its data, for example, a malformed email
32543 address in a RCPT command. Protocol errors include invalid command
32544 sequencing such as RCPT before MAIL. If Exim receives more than
32545 &%smtp_max_synprot_errors%& such commands during a single SMTP connection, it
32546 drops the connection after sending the error response to the last command. The
32547 default value for &%smtp_max_synprot_errors%& is 3. This is a defence against
32548 broken clients that loop sending bad commands (yes, it has been seen).
32549
32550
32551
32552 .section "Use of non-mail SMTP commands" "SECID236"
32553 .cindex "SMTP" "non-mail commands"
32554 The &"non-mail"& SMTP commands are those other than MAIL, RCPT, and
32555 DATA. Exim counts such commands, and drops the connection if there are too
32556 many of them in a single SMTP session. This action catches some
32557 denial-of-service attempts and things like repeated failing AUTHs, or a mad
32558 client looping sending EHLO. The global option &%smtp_accept_max_nonmail%&
32559 defines what &"too many"& means. Its default value is 10.
32560
32561 When a new message is expected, one occurrence of RSET is not counted. This
32562 allows a client to send one RSET between messages (this is not necessary,
32563 but some clients do it). Exim also allows one uncounted occurrence of HELO
32564 or EHLO, and one occurrence of STARTTLS between messages. After
32565 starting up a TLS session, another EHLO is expected, and so it too is not
32566 counted.
32567
32568 The first occurrence of AUTH in a connection, or immediately following
32569 STARTTLS is also not counted. Otherwise, all commands other than MAIL,
32570 RCPT, DATA, and QUIT are counted.
32571
32572 You can control which hosts are subject to the limit set by
32573 &%smtp_accept_max_nonmail%& by setting
32574 &%smtp_accept_max_nonmail_hosts%&. The default value is &`*`&, which makes
32575 the limit apply to all hosts. This option means that you can exclude any
32576 specific badly-behaved hosts that you have to live with.
32577
32578
32579
32580
32581 .section "The VRFY and EXPN commands" "SECID237"
32582 When Exim receives a VRFY or EXPN command on a TCP/IP connection, it
32583 runs the ACL specified by &%acl_smtp_vrfy%& or &%acl_smtp_expn%& (as
32584 appropriate) in order to decide whether the command should be accepted or not.
32585 If no ACL is defined, the command is rejected.
32586
32587 .cindex "VRFY" "processing"
32588 When VRFY is accepted, it runs exactly the same code as when Exim is
32589 called with the &%-bv%& option.
32590
32591 .cindex "EXPN" "processing"
32592 When EXPN is accepted, a single-level expansion of the address is done.
32593 EXPN is treated as an &"address test"& (similar to the &%-bt%& option) rather
32594 than a verification (the &%-bv%& option). If an unqualified local part is given
32595 as the argument to EXPN, it is qualified with &%qualify_domain%&. Rejections
32596 of VRFY and EXPN commands are logged on the main and reject logs, and
32597 VRFY verification failures are logged on the main log for consistency with
32598 RCPT failures.
32599
32600
32601
32602 .section "The ETRN command" "SECTETRN"
32603 .cindex "ETRN" "processing"
32604 RFC 1985 describes an SMTP command called ETRN that is designed to
32605 overcome the security problems of the TURN command (which has fallen into
32606 disuse). When Exim receives an ETRN command on a TCP/IP connection, it runs
32607 the ACL specified by &%acl_smtp_etrn%& in order to decide whether the command
32608 should be accepted or not. If no ACL is defined, the command is rejected.
32609
32610 The ETRN command is concerned with &"releasing"& messages that are awaiting
32611 delivery to certain hosts. As Exim does not organize its message queue by host,
32612 the only form of ETRN that is supported by default is the one where the
32613 text starts with the &"#"& prefix, in which case the remainder of the text is
32614 specific to the SMTP server. A valid ETRN command causes a run of Exim with
32615 the &%-R%& option to happen, with the remainder of the ETRN text as its
32616 argument. For example,
32617 .code
32618 ETRN #brigadoon
32619 .endd
32620 runs the command
32621 .code
32622 exim -R brigadoon
32623 .endd
32624 which causes a delivery attempt on all messages with undelivered addresses
32625 containing the text &"brigadoon"&. When &%smtp_etrn_serialize%& is set (the
32626 default), Exim prevents the simultaneous execution of more than one queue run
32627 for the same argument string as a result of an ETRN command. This stops
32628 a misbehaving client from starting more than one queue runner at once.
32629
32630 .cindex "hints database" "ETRN serialization"
32631 Exim implements the serialization by means of a hints database in which a
32632 record is written whenever a process is started by ETRN, and deleted when
32633 the process completes. However, Exim does not keep the SMTP session waiting for
32634 the ETRN process to complete. Once ETRN is accepted, the client is sent
32635 a &"success"& return code. Obviously there is scope for hints records to get
32636 left lying around if there is a system or program crash. To guard against this,
32637 Exim ignores any records that are more than six hours old.
32638
32639 .oindex "&%smtp_etrn_command%&"
32640 For more control over what ETRN does, the &%smtp_etrn_command%& option can
32641 used. This specifies a command that is run whenever ETRN is received,
32642 whatever the form of its argument. For
32643 example:
32644 .code
32645 smtp_etrn_command = /etc/etrn_command $domain \
32646                     $sender_host_address
32647 .endd
32648 .vindex "&$domain$&"
32649 The string is split up into arguments which are independently expanded. The
32650 expansion variable &$domain$& is set to the argument of the ETRN command,
32651 and no syntax checking is done on the contents of this argument. Exim does not
32652 wait for the command to complete, so its status code is not checked. Exim runs
32653 under its own uid and gid when receiving incoming SMTP, so it is not possible
32654 for it to change them before running the command.
32655
32656
32657
32658 .section "Incoming local SMTP" "SECID238"
32659 .cindex "SMTP" "local incoming"
32660 Some user agents use SMTP to pass messages to their local MTA using the
32661 standard input and output, as opposed to passing the envelope on the command
32662 line and writing the message to the standard input. This is supported by the
32663 &%-bs%& option. This form of SMTP is handled in the same way as incoming
32664 messages over TCP/IP (including the use of ACLs), except that the envelope
32665 sender given in a MAIL command is ignored unless the caller is trusted. In
32666 an ACL you can detect this form of SMTP input by testing for an empty host
32667 identification. It is common to have this as the first line in the ACL that
32668 runs for RCPT commands:
32669 .code
32670 accept hosts = :
32671 .endd
32672 This accepts SMTP messages from local processes without doing any other tests.
32673
32674
32675
32676 .section "Outgoing batched SMTP" "SECTbatchSMTP"
32677 .cindex "SMTP" "batched outgoing"
32678 .cindex "batched SMTP output"
32679 Both the &(appendfile)& and &(pipe)& transports can be used for handling
32680 batched SMTP. Each has an option called &%use_bsmtp%& which causes messages to
32681 be output in BSMTP format. No SMTP responses are possible for this form of
32682 delivery. All it is doing is using SMTP commands as a way of transmitting the
32683 envelope along with the message.
32684
32685 The message is written to the file or pipe preceded by the SMTP commands
32686 MAIL and RCPT, and followed by a line containing a single dot. Lines in
32687 the message that start with a dot have an extra dot added. The SMTP command
32688 HELO is not normally used. If it is required, the &%message_prefix%& option
32689 can be used to specify it.
32690
32691 Because &(appendfile)& and &(pipe)& are both local transports, they accept only
32692 one recipient address at a time by default. However, you can arrange for them
32693 to handle several addresses at once by setting the &%batch_max%& option. When
32694 this is done for BSMTP, messages may contain multiple RCPT commands. See
32695 chapter &<<CHAPbatching>>& for more details.
32696
32697 .vindex "&$host$&"
32698 When one or more addresses are routed to a BSMTP transport by a router that
32699 sets up a host list, the name of the first host on the list is available to the
32700 transport in the variable &$host$&. Here is an example of such a transport and
32701 router:
32702 .code
32703 begin routers
32704 route_append:
32705   driver = manualroute
32706   transport = smtp_appendfile
32707   route_list = domain.example  batch.host.example
32708
32709 begin transports
32710 smtp_appendfile:
32711   driver = appendfile
32712   directory = /var/bsmtp/$host
32713   batch_max = 1000
32714   use_bsmtp
32715   user = exim
32716 .endd
32717 This causes messages addressed to &'domain.example'& to be written in BSMTP
32718 format to &_/var/bsmtp/batch.host.example_&, with only a single copy of each
32719 message (unless there are more than 1000 recipients).
32720
32721
32722
32723 .section "Incoming batched SMTP" "SECTincomingbatchedSMTP"
32724 .cindex "SMTP" "batched incoming"
32725 .cindex "batched SMTP input"
32726 The &%-bS%& command line option causes Exim to accept one or more messages by
32727 reading SMTP on the standard input, but to generate no responses. If the caller
32728 is trusted, the senders in the MAIL commands are believed; otherwise the
32729 sender is always the caller of Exim. Unqualified senders and receivers are not
32730 rejected (there seems little point) but instead just get qualified. HELO
32731 and EHLO act as RSET; VRFY, EXPN, ETRN and  HELP, act
32732 as NOOP; QUIT quits.
32733
32734 Minimal policy checking is done for BSMTP input. Only the non-SMTP
32735 ACL is run in the same way as for non-SMTP local input.
32736
32737 If an error is detected while reading a message, including a missing &"."& at
32738 the end, Exim gives up immediately. It writes details of the error to the
32739 standard output in a stylized way that the calling program should be able to
32740 make some use of automatically, for example:
32741 .code
32742 554 Unexpected end of file
32743 Transaction started in line 10
32744 Error detected in line 14
32745 .endd
32746 It writes a more verbose version, for human consumption, to the standard error
32747 file, for example:
32748 .code
32749 An error was detected while processing a file of BSMTP input.
32750 The error message was:
32751
32752 501 '>' missing at end of address
32753
32754 The SMTP transaction started in line 10.
32755 The error was detected in line 12.
32756 The SMTP command at fault was:
32757
32758 rcpt to:<malformed@in.com.plete
32759
32760 1 previous message was successfully processed.
32761 The rest of the batch was abandoned.
32762 .endd
32763 The return code from Exim is zero only if there were no errors. It is 1 if some
32764 messages were accepted before an error was detected, and 2 if no messages were
32765 accepted.
32766 .ecindex IIDsmtpproc1
32767 .ecindex IIDsmtpproc2
32768
32769
32770
32771 . ////////////////////////////////////////////////////////////////////////////
32772 . ////////////////////////////////////////////////////////////////////////////
32773
32774 .chapter "Customizing bounce and warning messages" "CHAPemsgcust" &&&
32775          "Customizing messages"
32776 When a message fails to be delivered, or remains on the queue for more than a
32777 configured amount of time, Exim sends a message to the original sender, or
32778 to an alternative configured address. The text of these messages is built into
32779 the code of Exim, but it is possible to change it, either by adding a single
32780 string, or by replacing each of the paragraphs by text supplied in a file.
32781
32782 The &'From:'& and &'To:'& header lines are automatically generated; you can
32783 cause a &'Reply-To:'& line to be added by setting the &%errors_reply_to%&
32784 option. Exim also adds the line
32785 .code
32786 Auto-Submitted: auto-generated
32787 .endd
32788 to all warning and bounce messages,
32789
32790
32791 .section "Customizing bounce messages" "SECID239"
32792 .cindex "customizing" "bounce message"
32793 .cindex "bounce message" "customizing"
32794 If &%bounce_message_text%& is set, its contents are included in the default
32795 message immediately after &"This message was created automatically by mail
32796 delivery software."& The string is not expanded. It is not used if
32797 &%bounce_message_file%& is set.
32798
32799 When &%bounce_message_file%& is set, it must point to a template file for
32800 constructing error messages. The file consists of a series of text items,
32801 separated by lines consisting of exactly four asterisks. If the file cannot be
32802 opened, default text is used and a message is written to the main and panic
32803 logs. If any text item in the file is empty, default text is used for that
32804 item.
32805
32806 .vindex "&$bounce_recipient$&"
32807 .vindex "&$bounce_return_size_limit$&"
32808 Each item of text that is read from the file is expanded, and there are two
32809 expansion variables which can be of use here: &$bounce_recipient$& is set to
32810 the recipient of an error message while it is being created, and
32811 &$bounce_return_size_limit$& contains the value of the &%return_size_limit%&
32812 option, rounded to a whole number.
32813
32814 The items must appear in the file in the following order:
32815
32816 .ilist
32817 The first item is included in the headers, and should include at least a
32818 &'Subject:'& header. Exim does not check the syntax of these headers.
32819 .next
32820 The second item forms the start of the error message. After it, Exim lists the
32821 failing addresses with their error messages.
32822 .next
32823 The third item is used to introduce any text from pipe transports that is to be
32824 returned to the sender. It is omitted if there is no such text.
32825 .next
32826 The fourth item is used to introduce the copy of the message that is returned
32827 as part of the error report.
32828 .next
32829 The fifth item is added after the fourth one if the returned message is
32830 truncated because it is bigger than &%return_size_limit%&.
32831 .next
32832 The sixth item is added after the copy of the original message.
32833 .endlist
32834
32835 The default state (&%bounce_message_file%& unset) is equivalent to the
32836 following file, in which the sixth item is empty. The &'Subject:'& and some
32837 other lines have been split in order to fit them on the page:
32838 .code
32839 Subject: Mail delivery failed
32840   ${if eq{$sender_address}{$bounce_recipient}
32841   {: returning message to sender}}
32842 ****
32843 This message was created automatically by mail delivery software.
32844
32845 A message ${if eq{$sender_address}{$bounce_recipient}
32846   {that you sent }{sent by
32847
32848 <$sender_address>
32849
32850 }}could not be delivered to all of its recipients.
32851 This is a permanent error. The following address(es) failed:
32852 ****
32853 The following text was generated during the delivery attempt(s):
32854 ****
32855 ------ This is a copy of the message, including all the headers.
32856   ------
32857 ****
32858 ------ The body of the message is $message_size characters long;
32859   only the first
32860 ------ $bounce_return_size_limit or so are included here.
32861 ****
32862 .endd
32863 .section "Customizing warning messages" "SECTcustwarn"
32864 .cindex "customizing" "warning message"
32865 .cindex "warning of delay" "customizing the message"
32866 The option &%warn_message_file%& can be pointed at a template file for use when
32867 warnings about message delays are created. In this case there are only three
32868 text sections:
32869
32870 .ilist
32871 The first item is included in the headers, and should include at least a
32872 &'Subject:'& header. Exim does not check the syntax of these headers.
32873 .next
32874 The second item forms the start of the warning message. After it, Exim lists
32875 the delayed addresses.
32876 .next
32877 The third item then ends the message.
32878 .endlist
32879
32880 The default state is equivalent to the following file, except that some lines
32881 have been split here, in order to fit them on the page:
32882 .code
32883 Subject: Warning: message $message_exim_id delayed
32884   $warn_message_delay
32885 ****
32886 This message was created automatically by mail delivery software.
32887
32888 A message ${if eq{$sender_address}{$warn_message_recipients}
32889 {that you sent }{sent by
32890
32891 <$sender_address>
32892
32893 }}has not been delivered to all of its recipients after
32894 more than $warn_message_delay on the queue on $primary_hostname.
32895
32896 The message identifier is:     $message_exim_id
32897 The subject of the message is: $h_subject
32898 The date of the message is:    $h_date
32899
32900 The following address(es) have not yet been delivered:
32901 ****
32902 No action is required on your part. Delivery attempts will
32903 continue for some time, and this warning may be repeated at
32904 intervals if the message remains undelivered. Eventually the
32905 mail delivery software will give up, and when that happens,
32906 the message will be returned to you.
32907 .endd
32908 .vindex "&$warn_message_delay$&"
32909 .vindex "&$warn_message_recipients$&"
32910 However, in the default state the subject and date lines are omitted if no
32911 appropriate headers exist. During the expansion of this file,
32912 &$warn_message_delay$& is set to the delay time in one of the forms &"<&'n'&>
32913 minutes"& or &"<&'n'&> hours"&, and &$warn_message_recipients$& contains a list
32914 of recipients for the warning message. There may be more than one if there are
32915 multiple addresses with different &%errors_to%& settings on the routers that
32916 handled them.
32917
32918
32919
32920
32921 . ////////////////////////////////////////////////////////////////////////////
32922 . ////////////////////////////////////////////////////////////////////////////
32923
32924 .chapter "Some common configuration settings" "CHAPcomconreq"
32925 This chapter discusses some configuration settings that seem to be fairly
32926 common. More examples and discussion can be found in the Exim book.
32927
32928
32929
32930 .section "Sending mail to a smart host" "SECID240"
32931 .cindex "smart host" "example router"
32932 If you want to send all mail for non-local domains to a &"smart host"&, you
32933 should replace the default &(dnslookup)& router with a router which does the
32934 routing explicitly:
32935 .code
32936 send_to_smart_host:
32937   driver = manualroute
32938   route_list = !+local_domains smart.host.name
32939   transport = remote_smtp
32940 .endd
32941 You can use the smart host's IP address instead of the name if you wish.
32942 If you are using Exim only to submit messages to a smart host, and not for
32943 receiving incoming messages, you can arrange for it to do the submission
32944 synchronously by setting the &%mua_wrapper%& option (see chapter
32945 &<<CHAPnonqueueing>>&).
32946
32947
32948
32949
32950 .section "Using Exim to handle mailing lists" "SECTmailinglists"
32951 .cindex "mailing lists"
32952 Exim can be used to run simple mailing lists, but for large and/or complicated
32953 requirements, the use of additional specialized mailing list software such as
32954 Majordomo or Mailman is recommended.
32955
32956 The &(redirect)& router can be used to handle mailing lists where each list
32957 is maintained in a separate file, which can therefore be managed by an
32958 independent manager. The &%domains%& router option can be used to run these
32959 lists in a separate domain from normal mail. For example:
32960 .code
32961 lists:
32962   driver = redirect
32963   domains = lists.example
32964   file = /usr/lists/$local_part
32965   forbid_pipe
32966   forbid_file
32967   errors_to = $local_part-request@lists.example
32968   no_more
32969 .endd
32970 This router is skipped for domains other than &'lists.example'&. For addresses
32971 in that domain, it looks for a file that matches the local part. If there is no
32972 such file, the router declines, but because &%no_more%& is set, no subsequent
32973 routers are tried, and so the whole delivery fails.
32974
32975 The &%forbid_pipe%& and &%forbid_file%& options prevent a local part from being
32976 expanded into a file name or a pipe delivery, which is usually inappropriate in
32977 a mailing list.
32978
32979 .oindex "&%errors_to%&"
32980 The &%errors_to%& option specifies that any delivery errors caused by addresses
32981 taken from a mailing list are to be sent to the given address rather than the
32982 original sender of the message. However, before acting on this, Exim verifies
32983 the error address, and ignores it if verification fails.
32984
32985 For example, using the configuration above, mail sent to
32986 &'dicts@lists.example'& is passed on to those addresses contained in
32987 &_/usr/lists/dicts_&, with error reports directed to
32988 &'dicts-request@lists.example'&, provided that this address can be verified.
32989 There could be a file called &_/usr/lists/dicts-request_& containing
32990 the address(es) of this particular list's manager(s), but other approaches,
32991 such as setting up an earlier router (possibly using the &%local_part_prefix%&
32992 or &%local_part_suffix%& options) to handle addresses of the form
32993 &%owner-%&&'xxx'& or &%xxx-%&&'request'&, are also possible.
32994
32995
32996
32997 .section "Syntax errors in mailing lists" "SECID241"
32998 .cindex "mailing lists" "syntax errors in"
32999 If an entry in redirection data contains a syntax error, Exim normally defers
33000 delivery of the original address. That means that a syntax error in a mailing
33001 list holds up all deliveries to the list. This may not be appropriate when a
33002 list is being maintained automatically from data supplied by users, and the
33003 addresses are not rigorously checked.
33004
33005 If the &%skip_syntax_errors%& option is set, the &(redirect)& router just skips
33006 entries that fail to parse, noting the incident in the log. If in addition
33007 &%syntax_errors_to%& is set to a verifiable address, a message is sent to it
33008 whenever a broken address is skipped. It is usually appropriate to set
33009 &%syntax_errors_to%& to the same address as &%errors_to%&.
33010
33011
33012
33013 .section "Re-expansion of mailing lists" "SECID242"
33014 .cindex "mailing lists" "re-expansion of"
33015 Exim remembers every individual address to which a message has been delivered,
33016 in order to avoid duplication, but it normally stores only the original
33017 recipient addresses with a message. If all the deliveries to a mailing list
33018 cannot be done at the first attempt, the mailing list is re-expanded when the
33019 delivery is next tried. This means that alterations to the list are taken into
33020 account at each delivery attempt, so addresses that have been added to
33021 the list since the message arrived will therefore receive a copy of the
33022 message, even though it pre-dates their subscription.
33023
33024 If this behaviour is felt to be undesirable, the &%one_time%& option can be set
33025 on the &(redirect)& router. If this is done, any addresses generated by the
33026 router that fail to deliver at the first attempt are added to the message as
33027 &"top level"& addresses, and the parent address that generated them is marked
33028 &"delivered"&. Thus, expansion of the mailing list does not happen again at the
33029 subsequent delivery attempts. The disadvantage of this is that if any of the
33030 failing addresses are incorrect, correcting them in the file has no effect on
33031 pre-existing messages.
33032
33033 The original top-level address is remembered with each of the generated
33034 addresses, and is output in any log messages. However, any intermediate parent
33035 addresses are not recorded. This makes a difference to the log only if the
33036 &%all_parents%& selector is set, but for mailing lists there is normally only
33037 one level of expansion anyway.
33038
33039
33040
33041 .section "Closed mailing lists" "SECID243"
33042 .cindex "mailing lists" "closed"
33043 The examples so far have assumed open mailing lists, to which anybody may
33044 send mail. It is also possible to set up closed lists, where mail is accepted
33045 from specified senders only. This is done by making use of the generic
33046 &%senders%& option to restrict the router that handles the list.
33047
33048 The following example uses the same file as a list of recipients and as a list
33049 of permitted senders. It requires three routers:
33050 .code
33051 lists_request:
33052   driver = redirect
33053   domains = lists.example
33054   local_part_suffix = -request
33055   file = /usr/lists/$local_part$local_part_suffix
33056   no_more
33057
33058 lists_post:
33059   driver = redirect
33060   domains = lists.example
33061   senders = ${if exists {/usr/lists/$local_part}\
33062              {lsearch;/usr/lists/$local_part}{*}}
33063   file = /usr/lists/$local_part
33064   forbid_pipe
33065   forbid_file
33066   errors_to = $local_part-request@lists.example
33067   no_more
33068
33069 lists_closed:
33070   driver = redirect
33071   domains = lists.example
33072   allow_fail
33073   data = :fail: $local_part@lists.example is a closed mailing list
33074 .endd
33075 All three routers have the same &%domains%& setting, so for any other domains,
33076 they are all skipped. The first router runs only if the local part ends in
33077 &%-request%&. It handles messages to the list manager(s) by means of an open
33078 mailing list.
33079
33080 The second router runs only if the &%senders%& precondition is satisfied. It
33081 checks for the existence of a list that corresponds to the local part, and then
33082 checks that the sender is on the list by means of a linear search. It is
33083 necessary to check for the existence of the file before trying to search it,
33084 because otherwise Exim thinks there is a configuration error. If the file does
33085 not exist, the expansion of &%senders%& is *, which matches all senders. This
33086 means that the router runs, but because there is no list, declines, and
33087 &%no_more%& ensures that no further routers are run. The address fails with an
33088 &"unrouteable address"& error.
33089
33090 The third router runs only if the second router is skipped, which happens when
33091 a mailing list exists, but the sender is not on it. This router forcibly fails
33092 the address, giving a suitable error message.
33093
33094
33095
33096
33097 .section "Variable Envelope Return Paths (VERP)" "SECTverp"
33098 .cindex "VERP"
33099 .cindex "Variable Envelope Return Paths"
33100 .cindex "envelope sender"
33101 Variable Envelope Return Paths &-- see &url(http://cr.yp.to/proto/verp.txt) &--
33102 are a way of helping mailing list administrators discover which subscription
33103 address is the cause of a particular delivery failure. The idea is to encode
33104 the original recipient address in the outgoing envelope sender address, so that
33105 if the message is forwarded by another host and then subsequently bounces, the
33106 original recipient can be extracted from the recipient address of the bounce.
33107
33108 .oindex &%errors_to%&
33109 .oindex &%return_path%&
33110 Envelope sender addresses can be modified by Exim using two different
33111 facilities: the &%errors_to%& option on a router (as shown in previous mailing
33112 list examples), or the &%return_path%& option on a transport. The second of
33113 these is effective only if the message is successfully delivered to another
33114 host; it is not used for errors detected on the local host (see the description
33115 of &%return_path%& in chapter &<<CHAPtransportgeneric>>&). Here is an example
33116 of the use of &%return_path%& to implement VERP on an &(smtp)& transport:
33117 .code
33118 verp_smtp:
33119   driver = smtp
33120   max_rcpt = 1
33121   return_path = \
33122     ${if match {$return_path}{^(.+?)-request@your.dom.example\$}\
33123       {$1-request+$local_part=$domain@your.dom.example}fail}
33124 .endd
33125 This has the effect of rewriting the return path (envelope sender) on outgoing
33126 SMTP messages, if the local part of the original return path ends in
33127 &"-request"&, and the domain is &'your.dom.example'&. The rewriting inserts the
33128 local part and domain of the recipient into the return path. Suppose, for
33129 example, that a message whose return path has been set to
33130 &'somelist-request@your.dom.example'& is sent to
33131 &'subscriber@other.dom.example'&. In the transport, the return path is
33132 rewritten as
33133 .code
33134 somelist-request+subscriber=other.dom.example@your.dom.example
33135 .endd
33136 .vindex "&$local_part$&"
33137 For this to work, you must tell Exim to send multiple copies of messages that
33138 have more than one recipient, so that each copy has just one recipient. This is
33139 achieved by setting &%max_rcpt%& to 1. Without this, a single copy of a message
33140 might be sent to several different recipients in the same domain, in which case
33141 &$local_part$& is not available in the transport, because it is not unique.
33142
33143 Unless your host is doing nothing but mailing list deliveries, you should
33144 probably use a separate transport for the VERP deliveries, so as not to use
33145 extra resources in making one-per-recipient copies for other deliveries. This
33146 can easily be done by expanding the &%transport%& option in the router:
33147 .code
33148 dnslookup:
33149   driver = dnslookup
33150   domains = ! +local_domains
33151   transport = \
33152     ${if match {$return_path}{^(.+?)-request@your.dom.example\$}\
33153       {verp_smtp}{remote_smtp}}
33154   no_more
33155 .endd
33156 If you want to change the return path using &%errors_to%& in a router instead
33157 of using &%return_path%& in the transport, you need to set &%errors_to%& on all
33158 routers that handle mailing list addresses. This will ensure that all delivery
33159 errors, including those detected on the local host, are sent to the VERP
33160 address.
33161
33162 On a host that does no local deliveries and has no manual routing, only the
33163 &(dnslookup)& router needs to be changed. A special transport is not needed for
33164 SMTP deliveries. Every mailing list recipient has its own return path value,
33165 and so Exim must hand them to the transport one at a time. Here is an example
33166 of a &(dnslookup)& router that implements VERP:
33167 .code
33168 verp_dnslookup:
33169   driver = dnslookup
33170   domains = ! +local_domains
33171   transport = remote_smtp
33172   errors_to = \
33173     ${if match {$return_path}{^(.+?)-request@your.dom.example\$}}
33174      {$1-request+$local_part=$domain@your.dom.example}fail}
33175   no_more
33176 .endd
33177 Before you start sending out messages with VERPed return paths, you must also
33178 configure Exim to accept the bounce messages that come back to those paths.
33179 Typically this is done by setting a &%local_part_suffix%& option for a
33180 router, and using this to route the messages to wherever you want to handle
33181 them.
33182
33183 The overhead incurred in using VERP depends very much on the size of the
33184 message, the number of recipient addresses that resolve to the same remote
33185 host, and the speed of the connection over which the message is being sent. If
33186 a lot of addresses resolve to the same host and the connection is slow, sending
33187 a separate copy of the message for each address may take substantially longer
33188 than sending a single copy with many recipients (for which VERP cannot be
33189 used).
33190
33191
33192
33193
33194
33195
33196 .section "Virtual domains" "SECTvirtualdomains"
33197 .cindex "virtual domains"
33198 .cindex "domain" "virtual"
33199 The phrase &'virtual domain'& is unfortunately used with two rather different
33200 meanings:
33201
33202 .ilist
33203 A domain for which there are no real mailboxes; all valid local parts are
33204 aliases for other email addresses. Common examples are organizational
33205 top-level domains and &"vanity"& domains.
33206 .next
33207 One of a number of independent domains that are all handled by the same host,
33208 with mailboxes on that host, but where the mailbox owners do not necessarily
33209 have login accounts on that host.
33210 .endlist
33211
33212 The first usage is probably more common, and does seem more &"virtual"& than
33213 the second. This kind of domain can be handled in Exim with a straightforward
33214 aliasing router. One approach is to create a separate alias file for each
33215 virtual domain. Exim can test for the existence of the alias file to determine
33216 whether the domain exists. The &(dsearch)& lookup type is useful here, leading
33217 to a router of this form:
33218 .code
33219 virtual:
33220   driver = redirect
33221   domains = dsearch;/etc/mail/virtual
33222   data = ${lookup{$local_part}lsearch{/etc/mail/virtual/$domain}}
33223   no_more
33224 .endd
33225 The &%domains%& option specifies that the router is to be skipped, unless there
33226 is a file in the &_/etc/mail/virtual_& directory whose name is the same as the
33227 domain that is being processed. When the router runs, it looks up the local
33228 part in the file to find a new address (or list of addresses). The &%no_more%&
33229 setting ensures that if the lookup fails (leading to &%data%& being an empty
33230 string), Exim gives up on the address without trying any subsequent routers.
33231
33232 This one router can handle all the virtual domains because the alias file names
33233 follow a fixed pattern. Permissions can be arranged so that appropriate people
33234 can edit the different alias files. A successful aliasing operation results in
33235 a new envelope recipient address, which is then routed from scratch.
33236
33237 The other kind of &"virtual"& domain can also be handled in a straightforward
33238 way. One approach is to create a file for each domain containing a list of
33239 valid local parts, and use it in a router like this:
33240 .code
33241 my_domains:
33242   driver = accept
33243   domains = dsearch;/etc/mail/domains
33244   local_parts = lsearch;/etc/mail/domains/$domain
33245   transport = my_mailboxes
33246 .endd
33247 The address is accepted if there is a file for the domain, and the local part
33248 can be found in the file. The &%domains%& option is used to check for the
33249 file's existence because &%domains%& is tested before the &%local_parts%&
33250 option (see section &<<SECTrouprecon>>&). You cannot use &%require_files%&,
33251 because that option is tested after &%local_parts%&. The transport is as
33252 follows:
33253 .code
33254 my_mailboxes:
33255   driver = appendfile
33256   file = /var/mail/$domain/$local_part
33257   user = mail
33258 .endd
33259 This uses a directory of mailboxes for each domain. The &%user%& setting is
33260 required, to specify which uid is to be used for writing to the mailboxes.
33261
33262 The configuration shown here is just one example of how you might support this
33263 requirement. There are many other ways this kind of configuration can be set
33264 up, for example, by using a database instead of separate files to hold all the
33265 information about the domains.
33266
33267
33268
33269 .section "Multiple user mailboxes" "SECTmulbox"
33270 .cindex "multiple mailboxes"
33271 .cindex "mailbox" "multiple"
33272 .cindex "local part" "prefix"
33273 .cindex "local part" "suffix"
33274 Heavy email users often want to operate with multiple mailboxes, into which
33275 incoming mail is automatically sorted. A popular way of handling this is to
33276 allow users to use multiple sender addresses, so that replies can easily be
33277 identified. Users are permitted to add prefixes or suffixes to their local
33278 parts for this purpose. The wildcard facility of the generic router options
33279 &%local_part_prefix%& and &%local_part_suffix%& can be used for this. For
33280 example, consider this router:
33281 .code
33282 userforward:
33283   driver = redirect
33284   check_local_user
33285   file = $home/.forward
33286   local_part_suffix = -*
33287   local_part_suffix_optional
33288   allow_filter
33289 .endd
33290 .vindex "&$local_part_suffix$&"
33291 It runs a user's &_.forward_& file for all local parts of the form
33292 &'username-*'&. Within the filter file the user can distinguish different
33293 cases by testing the variable &$local_part_suffix$&. For example:
33294 .code
33295 if $local_part_suffix contains -special then
33296 save /home/$local_part/Mail/special
33297 endif
33298 .endd
33299 If the filter file does not exist, or does not deal with such addresses, they
33300 fall through to subsequent routers, and, assuming no subsequent use of the
33301 &%local_part_suffix%& option is made, they presumably fail. Thus, users have
33302 control over which suffixes are valid.
33303
33304 Alternatively, a suffix can be used to trigger the use of a different
33305 &_.forward_& file &-- which is the way a similar facility is implemented in
33306 another MTA:
33307 .code
33308 userforward:
33309   driver = redirect
33310   check_local_user
33311   file = $home/.forward$local_part_suffix
33312   local_part_suffix = -*
33313   local_part_suffix_optional
33314   allow_filter
33315 .endd
33316 If there is no suffix, &_.forward_& is used; if the suffix is &'-special'&, for
33317 example, &_.forward-special_& is used. Once again, if the appropriate file
33318 does not exist, or does not deal with the address, it is passed on to
33319 subsequent routers, which could, if required, look for an unqualified
33320 &_.forward_& file to use as a default.
33321
33322
33323
33324 .section "Simplified vacation processing" "SECID244"
33325 .cindex "vacation processing"
33326 The traditional way of running the &'vacation'& program is for a user to set up
33327 a pipe command in a &_.forward_& file
33328 (see section &<<SECTspecitredli>>& for syntax details).
33329 This is prone to error by inexperienced users. There are two features of Exim
33330 that can be used to make this process simpler for users:
33331
33332 .ilist
33333 A local part prefix such as &"vacation-"& can be specified on a router which
33334 can cause the message to be delivered directly to the &'vacation'& program, or
33335 alternatively can use Exim's &(autoreply)& transport. The contents of a user's
33336 &_.forward_& file are then much simpler. For example:
33337 .code
33338 spqr, vacation-spqr
33339 .endd
33340 .next
33341 The &%require_files%& generic router option can be used to trigger a
33342 vacation delivery by checking for the existence of a certain file in the
33343 user's home directory. The &%unseen%& generic option should also be used, to
33344 ensure that the original delivery also proceeds. In this case, all the user has
33345 to do is to create a file called, say, &_.vacation_&, containing a vacation
33346 message.
33347 .endlist
33348
33349 Another advantage of both these methods is that they both work even when the
33350 use of arbitrary pipes by users is locked out.
33351
33352
33353
33354 .section "Taking copies of mail" "SECID245"
33355 .cindex "message" "copying every"
33356 Some installations have policies that require archive copies of all messages to
33357 be made. A single copy of each message can easily be taken by an appropriate
33358 command in a system filter, which could, for example, use a different file for
33359 each day's messages.
33360
33361 There is also a shadow transport mechanism that can be used to take copies of
33362 messages that are successfully delivered by local transports, one copy per
33363 delivery. This could be used, &'inter alia'&, to implement automatic
33364 notification of delivery by sites that insist on doing such things.
33365
33366
33367
33368 .section "Intermittently connected hosts" "SECID246"
33369 .cindex "intermittently connected hosts"
33370 It has become quite common (because it is cheaper) for hosts to connect to the
33371 Internet periodically rather than remain connected all the time. The normal
33372 arrangement is that mail for such hosts accumulates on a system that is
33373 permanently connected.
33374
33375 Exim was designed for use on permanently connected hosts, and so it is not
33376 particularly well-suited to use in an intermittently connected environment.
33377 Nevertheless there are some features that can be used.
33378
33379
33380 .section "Exim on the upstream server host" "SECID247"
33381 It is tempting to arrange for incoming mail for the intermittently connected
33382 host to remain on Exim's queue until the client connects. However, this
33383 approach does not scale very well. Two different kinds of waiting message are
33384 being mixed up in the same queue &-- those that cannot be delivered because of
33385 some temporary problem, and those that are waiting for their destination host
33386 to connect. This makes it hard to manage the queue, as well as wasting
33387 resources, because each queue runner scans the entire queue.
33388
33389 A better approach is to separate off those messages that are waiting for an
33390 intermittently connected host. This can be done by delivering these messages
33391 into local files in batch SMTP, &"mailstore"&, or other envelope-preserving
33392 format, from where they are transmitted by other software when their
33393 destination connects. This makes it easy to collect all the mail for one host
33394 in a single directory, and to apply local timeout rules on a per-message basis
33395 if required.
33396
33397 On a very small scale, leaving the mail on Exim's queue can be made to work. If
33398 you are doing this, you should configure Exim with a long retry period for the
33399 intermittent host. For example:
33400 .code
33401 cheshire.wonderland.fict.example    *   F,5d,24h
33402 .endd
33403 This stops a lot of failed delivery attempts from occurring, but Exim remembers
33404 which messages it has queued up for that host. Once the intermittent host comes
33405 online, forcing delivery of one message (either by using the &%-M%& or &%-R%&
33406 options, or by using the ETRN SMTP command (see section &<<SECTETRN>>&)
33407 causes all the queued up messages to be delivered, often down a single SMTP
33408 connection. While the host remains connected, any new messages get delivered
33409 immediately.
33410
33411 If the connecting hosts do not have fixed IP addresses, that is, if a host is
33412 issued with a different IP address each time it connects, Exim's retry
33413 mechanisms on the holding host get confused, because the IP address is normally
33414 used as part of the key string for holding retry information. This can be
33415 avoided by unsetting &%retry_include_ip_address%& on the &(smtp)& transport.
33416 Since this has disadvantages for permanently connected hosts, it is best to
33417 arrange a separate transport for the intermittently connected ones.
33418
33419
33420
33421 .section "Exim on the intermittently connected client host" "SECID248"
33422 The value of &%smtp_accept_queue_per_connection%& should probably be
33423 increased, or even set to zero (that is, disabled) on the intermittently
33424 connected host, so that all incoming messages down a single connection get
33425 delivered immediately.
33426
33427 .cindex "SMTP" "passed connection"
33428 .cindex "SMTP" "multiple deliveries"
33429 .cindex "multiple SMTP deliveries"
33430 Mail waiting to be sent from an intermittently connected host will probably
33431 not have been routed, because without a connection DNS lookups are not
33432 possible. This means that if a normal queue run is done at connection time,
33433 each message is likely to be sent in a separate SMTP session. This can be
33434 avoided by starting the queue run with a command line option beginning with
33435 &%-qq%& instead of &%-q%&. In this case, the queue is scanned twice. In the
33436 first pass, routing is done but no deliveries take place. The second pass is a
33437 normal queue run; since all the messages have been previously routed, those
33438 destined for the same host are likely to get sent as multiple deliveries in a
33439 single SMTP connection.
33440
33441
33442
33443 . ////////////////////////////////////////////////////////////////////////////
33444 . ////////////////////////////////////////////////////////////////////////////
33445
33446 .chapter "Using Exim as a non-queueing client" "CHAPnonqueueing" &&&
33447          "Exim as a non-queueing client"
33448 .cindex "client, non-queueing"
33449 .cindex "smart host" "suppressing queueing"
33450 On a personal computer, it is a common requirement for all
33451 email to be sent to a &"smart host"&. There are plenty of MUAs that can be
33452 configured to operate that way, for all the popular operating systems.
33453 However, there are some MUAs for Unix-like systems that cannot be so
33454 configured: they submit messages using the command line interface of
33455 &_/usr/sbin/sendmail_&. Furthermore, utility programs such as &'cron'& submit
33456 messages this way.
33457
33458 If the personal computer runs continuously, there is no problem, because it can
33459 run a conventional MTA that handles delivery to the smart host, and deal with
33460 any delays via its queueing mechanism. However, if the computer does not run
33461 continuously or runs different operating systems at different times, queueing
33462 email is not desirable.
33463
33464 There is therefore a requirement for something that can provide the
33465 &_/usr/sbin/sendmail_& interface but deliver messages to a smart host without
33466 any queueing or retrying facilities. Furthermore, the delivery to the smart
33467 host should be synchronous, so that if it fails, the sending MUA is immediately
33468 informed. In other words, we want something that extends an MUA that submits
33469 to a local MTA via the command line so that it behaves like one that submits
33470 to a remote smart host using TCP/SMTP.
33471
33472 There are a number of applications (for example, there is one called &'ssmtp'&)
33473 that do this job. However, people have found them to be lacking in various
33474 ways. For instance, you might want to allow aliasing and forwarding to be done
33475 before sending a message to the smart host.
33476
33477 Exim already had the necessary infrastructure for doing this job. Just a few
33478 tweaks were needed to make it behave as required, though it is somewhat of an
33479 overkill to use a fully-featured MTA for this purpose.
33480
33481 .oindex "&%mua_wrapper%&"
33482 There is a Boolean global option called &%mua_wrapper%&, defaulting false.
33483 Setting &%mua_wrapper%& true causes Exim to run in a special mode where it
33484 assumes that it is being used to &"wrap"& a command-line MUA in the manner
33485 just described. As well as setting &%mua_wrapper%&, you also need to provide a
33486 compatible router and transport configuration. Typically there will be just one
33487 router and one transport, sending everything to a smart host.
33488
33489 When run in MUA wrapping mode, the behaviour of Exim changes in the
33490 following ways:
33491
33492 .ilist
33493 A daemon cannot be run, nor will Exim accept incoming messages from &'inetd'&.
33494 In other words, the only way to submit messages is via the command line.
33495 .next
33496 Each message is synchronously delivered as soon as it is received (&%-odi%& is
33497 assumed). All queueing options (&%queue_only%&, &%queue_smtp_domains%&,
33498 &%control%& in an ACL, etc.) are quietly ignored. The Exim reception process
33499 does not finish until the delivery attempt is complete. If the delivery is
33500 successful, a zero return code is given.
33501 .next
33502 Address redirection is permitted, but the final routing for all addresses must
33503 be to the same remote transport, and to the same list of hosts. Furthermore,
33504 the return address (envelope sender) must be the same for all recipients, as
33505 must any added or deleted header lines. In other words, it must be possible to
33506 deliver the message in a single SMTP transaction, however many recipients there
33507 are.
33508 .next
33509 If these conditions are not met, or if routing any address results in a
33510 failure or defer status, or if Exim is unable to deliver all the recipients
33511 successfully to one of the smart hosts, delivery of the entire message fails.
33512 .next
33513 Because no queueing is allowed, all failures are treated as permanent; there
33514 is no distinction between 4&'xx'& and 5&'xx'& SMTP response codes from the
33515 smart host. Furthermore, because only a single yes/no response can be given to
33516 the caller, it is not possible to deliver to some recipients and not others. If
33517 there is an error (temporary or permanent) for any recipient, all are failed.
33518 .next
33519 If more than one smart host is listed, Exim will try another host after a
33520 connection failure or a timeout, in the normal way. However, if this kind of
33521 failure happens for all the hosts, the delivery fails.
33522 .next
33523 When delivery fails, an error message is written to the standard error stream
33524 (as well as to Exim's log), and Exim exits to the caller with a return code
33525 value 1. The message is expunged from Exim's spool files. No bounce messages
33526 are ever generated.
33527 .next
33528 No retry data is maintained, and any retry rules are ignored.
33529 .next
33530 A number of Exim options are overridden: &%deliver_drop_privilege%& is forced
33531 true, &%max_rcpt%& in the &(smtp)& transport is forced to &"unlimited"&,
33532 &%remote_max_parallel%& is forced to one, and fallback hosts are ignored.
33533 .endlist
33534
33535 The overall effect is that Exim makes a single synchronous attempt to deliver
33536 the message, failing if there is any kind of problem. Because no local
33537 deliveries are done and no daemon can be run, Exim does not need root
33538 privilege. It should be possible to run it setuid to &'exim'& instead of setuid
33539 to &'root'&. See section &<<SECTrunexiwitpri>>& for a general discussion about
33540 the advantages and disadvantages of running without root privilege.
33541
33542
33543
33544
33545 . ////////////////////////////////////////////////////////////////////////////
33546 . ////////////////////////////////////////////////////////////////////////////
33547
33548 .chapter "Log files" "CHAPlog"
33549 .scindex IIDloggen "log" "general description"
33550 .cindex "log" "types of"
33551 Exim writes three different logs, referred to as the main log, the reject log,
33552 and the panic log:
33553
33554 .ilist
33555 .cindex "main log"
33556 The main log records the arrival of each message and each delivery in a single
33557 line in each case. The format is as compact as possible, in an attempt to keep
33558 down the size of log files. Two-character flag sequences make it easy to pick
33559 out these lines. A number of other events are recorded in the main log. Some of
33560 them are optional, in which case the &%log_selector%& option controls whether
33561 they are included or not. A Perl script called &'eximstats'&, which does simple
33562 analysis of main log files, is provided in the Exim distribution (see section
33563 &<<SECTmailstat>>&).
33564 .next
33565 .cindex "reject log"
33566 The reject log records information from messages that are rejected as a result
33567 of a configuration option (that is, for policy reasons).
33568 The first line of each rejection is a copy of the line that is also written to
33569 the main log. Then, if the message's header has been read at the time the log
33570 is written, its contents are written to this log. Only the original header
33571 lines are available; header lines added by ACLs are not logged. You can use the
33572 reject log to check that your policy controls are working correctly; on a busy
33573 host this may be easier than scanning the main log for rejection messages. You
33574 can suppress the writing of the reject log by setting &%write_rejectlog%&
33575 false.
33576 .next
33577 .cindex "panic log"
33578 .cindex "system log"
33579 When certain serious errors occur, Exim writes entries to its panic log. If the
33580 error is sufficiently disastrous, Exim bombs out afterwards. Panic log entries
33581 are usually written to the main log as well, but can get lost amid the mass of
33582 other entries. The panic log should be empty under normal circumstances. It is
33583 therefore a good idea to check it (or to have a &'cron'& script check it)
33584 regularly, in order to become aware of any problems. When Exim cannot open its
33585 panic log, it tries as a last resort to write to the system log (syslog). This
33586 is opened with LOG_PID+LOG_CONS and the facility code of LOG_MAIL. The
33587 message itself is written at priority LOG_CRIT.
33588 .endlist
33589
33590 Every log line starts with a timestamp, in the format shown in the following
33591 example. Note that many of the examples shown in this chapter are line-wrapped.
33592 In the log file, this would be all on one line:
33593 .code
33594 2001-09-16 16:09:47 SMTP connection from [127.0.0.1] closed
33595   by QUIT
33596 .endd
33597 By default, the timestamps are in the local timezone. There are two
33598 ways of changing this:
33599
33600 .ilist
33601 You can set the &%timezone%& option to a different time zone; in particular, if
33602 you set
33603 .code
33604 timezone = UTC
33605 .endd
33606 the timestamps will be in UTC (aka GMT).
33607 .next
33608 If you set &%log_timezone%& true, the time zone is added to the timestamp, for
33609 example:
33610 .code
33611 2003-04-25 11:17:07 +0100 Start queue run: pid=12762
33612 .endd
33613 .endlist
33614
33615 .cindex "log" "process ids in"
33616 .cindex "pid (process id)" "in log lines"
33617 Exim does not include its process id in log lines by default, but you can
33618 request that it does so by specifying the &`pid`& log selector (see section
33619 &<<SECTlogselector>>&). When this is set, the process id is output, in square
33620 brackets, immediately after the time and date.
33621
33622
33623
33624
33625 .section "Where the logs are written" "SECTwhelogwri"
33626 .cindex "log" "destination"
33627 .cindex "log" "to file"
33628 .cindex "log" "to syslog"
33629 .cindex "syslog"
33630 The logs may be written to local files, or to syslog, or both. However, it
33631 should be noted that many syslog implementations use UDP as a transport, and
33632 are therefore unreliable in the sense that messages are not guaranteed to
33633 arrive at the loghost, nor is the ordering of messages necessarily maintained.
33634 It has also been reported that on large log files (tens of megabytes) you may
33635 need to tweak syslog to prevent it syncing the file with each write &-- on
33636 Linux this has been seen to make syslog take 90% plus of CPU time.
33637
33638 The destination for Exim's logs is configured by setting LOG_FILE_PATH in
33639 &_Local/Makefile_& or by setting &%log_file_path%& in the run time
33640 configuration. This latter string is expanded, so it can contain, for example,
33641 references to the host name:
33642 .code
33643 log_file_path = /var/log/$primary_hostname/exim_%slog
33644 .endd
33645 It is generally advisable, however, to set the string in &_Local/Makefile_&
33646 rather than at run time, because then the setting is available right from the
33647 start of Exim's execution. Otherwise, if there's something it wants to log
33648 before it has read the configuration file (for example, an error in the
33649 configuration file) it will not use the path you want, and may not be able to
33650 log at all.
33651
33652 The value of LOG_FILE_PATH or &%log_file_path%& is a colon-separated
33653 list, currently limited to at most two items. This is one option where the
33654 facility for changing a list separator may not be used. The list must always be
33655 colon-separated. If an item in the list is &"syslog"& then syslog is used;
33656 otherwise the item must either be an absolute path, containing &`%s`& at the
33657 point where &"main"&, &"reject"&, or &"panic"& is to be inserted, or be empty,
33658 implying the use of a default path.
33659
33660 When Exim encounters an empty item in the list, it searches the list defined by
33661 LOG_FILE_PATH, and uses the first item it finds that is neither empty nor
33662 &"syslog"&. This means that an empty item in &%log_file_path%& can be used to
33663 mean &"use the path specified at build time"&. It no such item exists, log
33664 files are written in the &_log_& subdirectory of the spool directory. This is
33665 equivalent to the setting:
33666 .code
33667 log_file_path = $spool_directory/log/%slog
33668 .endd
33669 If you do not specify anything at build time or run time, that is where the
33670 logs are written.
33671
33672 A log file path may also contain &`%D`& or &`%M`& if datestamped log file names
33673 are in use &-- see section &<<SECTdatlogfil>>& below.
33674
33675 Here are some examples of possible settings:
33676 .display
33677 &`LOG_FILE_PATH=syslog                    `& syslog only
33678 &`LOG_FILE_PATH=:syslog                   `& syslog and default path
33679 &`LOG_FILE_PATH=syslog : /usr/log/exim_%s `& syslog and specified path
33680 &`LOG_FILE_PATH=/usr/log/exim_%s          `& specified path only
33681 .endd
33682 If there are more than two paths in the list, the first is used and a panic
33683 error is logged.
33684
33685
33686
33687 .section "Logging to local files that are periodically &""cycled""&" "SECID285"
33688 .cindex "log" "cycling local files"
33689 .cindex "cycling logs"
33690 .cindex "&'exicyclog'&"
33691 .cindex "log" "local files; writing to"
33692 Some operating systems provide centralized and standardized methods for cycling
33693 log files. For those that do not, a utility script called &'exicyclog'& is
33694 provided (see section &<<SECTcyclogfil>>&). This renames and compresses the
33695 main and reject logs each time it is called. The maximum number of old logs to
33696 keep can be set. It is suggested this script is run as a daily &'cron'& job.
33697
33698 An Exim delivery process opens the main log when it first needs to write to it,
33699 and it keeps the file open in case subsequent entries are required &-- for
33700 example, if a number of different deliveries are being done for the same
33701 message. However, remote SMTP deliveries can take a long time, and this means
33702 that the file may be kept open long after it is renamed if &'exicyclog'& or
33703 something similar is being used to rename log files on a regular basis. To
33704 ensure that a switch of log files is noticed as soon as possible, Exim calls
33705 &[stat()]& on the main log's name before reusing an open file, and if the file
33706 does not exist, or its inode has changed, the old file is closed and Exim
33707 tries to open the main log from scratch. Thus, an old log file may remain open
33708 for quite some time, but no Exim processes should write to it once it has been
33709 renamed.
33710
33711
33712
33713 .section "Datestamped log files" "SECTdatlogfil"
33714 .cindex "log" "datestamped files"
33715 Instead of cycling the main and reject log files by renaming them
33716 periodically, some sites like to use files whose names contain a datestamp,
33717 for example, &_mainlog-20031225_&. The datestamp is in the form &_yyyymmdd_& or
33718 &_yyyymm_&. Exim has support for this way of working. It is enabled by setting
33719 the &%log_file_path%& option to a path that includes &`%D`& or &`%M`& at the
33720 point where the datestamp is required. For example:
33721 .code
33722 log_file_path = /var/spool/exim/log/%slog-%D
33723 log_file_path = /var/log/exim-%s-%D.log
33724 log_file_path = /var/spool/exim/log/%D-%slog
33725 log_file_path = /var/log/exim/%s.%M
33726 .endd
33727 As before, &`%s`& is replaced by &"main"& or &"reject"&; the following are
33728 examples of names generated by the above examples:
33729 .code
33730 /var/spool/exim/log/mainlog-20021225
33731 /var/log/exim-reject-20021225.log
33732 /var/spool/exim/log/20021225-mainlog
33733 /var/log/exim/main.200212
33734 .endd
33735 When this form of log file is specified, Exim automatically switches to new
33736 files at midnight. It does not make any attempt to compress old logs; you
33737 will need to write your own script if you require this. You should not
33738 run &'exicyclog'& with this form of logging.
33739
33740 The location of the panic log is also determined by &%log_file_path%&, but it
33741 is not datestamped, because rotation of the panic log does not make sense.
33742 When generating the name of the panic log, &`%D`& or &`%M`& are removed from
33743 the string. In addition, if it immediately follows a slash, a following
33744 non-alphanumeric character is removed; otherwise a preceding non-alphanumeric
33745 character is removed. Thus, the four examples above would give these panic
33746 log names:
33747 .code
33748 /var/spool/exim/log/paniclog
33749 /var/log/exim-panic.log
33750 /var/spool/exim/log/paniclog
33751 /var/log/exim/panic
33752 .endd
33753
33754
33755 .section "Logging to syslog" "SECID249"
33756 .cindex "log" "syslog; writing to"
33757 The use of syslog does not change what Exim logs or the format of its messages,
33758 except in one respect. If &%syslog_timestamp%& is set false, the timestamps on
33759 Exim's log lines are omitted when these lines are sent to syslog. Apart from
33760 that, the same strings are written to syslog as to log files. The syslog
33761 &"facility"& is set to LOG_MAIL, and the program name to &"exim"&
33762 by default, but you can change these by setting the &%syslog_facility%& and
33763 &%syslog_processname%& options, respectively. If Exim was compiled with
33764 SYSLOG_LOG_PID set in &_Local/Makefile_& (this is the default in
33765 &_src/EDITME_&), then, on systems that permit it (all except ULTRIX), the
33766 LOG_PID flag is set so that the &[syslog()]& call adds the pid as well as
33767 the time and host name to each line.
33768 The three log streams are mapped onto syslog priorities as follows:
33769
33770 .ilist
33771 &'mainlog'& is mapped to LOG_INFO
33772 .next
33773 &'rejectlog'& is mapped to LOG_NOTICE
33774 .next
33775 &'paniclog'& is mapped to LOG_ALERT
33776 .endlist
33777
33778 Many log lines are written to both &'mainlog'& and &'rejectlog'&, and some are
33779 written to both &'mainlog'& and &'paniclog'&, so there will be duplicates if
33780 these are routed by syslog to the same place. You can suppress this duplication
33781 by setting &%syslog_duplication%& false.
33782
33783 Exim's log lines can sometimes be very long, and some of its &'rejectlog'&
33784 entries contain multiple lines when headers are included. To cope with both
33785 these cases, entries written to syslog are split into separate &[syslog()]&
33786 calls at each internal newline, and also after a maximum of
33787 870 data characters. (This allows for a total syslog line length of 1024, when
33788 additions such as timestamps are added.) If you are running a syslog
33789 replacement that can handle lines longer than the 1024 characters allowed by
33790 RFC 3164, you should set
33791 .code
33792 SYSLOG_LONG_LINES=yes
33793 .endd
33794 in &_Local/Makefile_& before building Exim. That stops Exim from splitting long
33795 lines, but it still splits at internal newlines in &'reject'& log entries.
33796
33797 To make it easy to re-assemble split lines later, each component of a split
33798 entry starts with a string of the form [<&'n'&>/<&'m'&>] or [<&'n'&>\<&'m'&>]
33799 where <&'n'&> is the component number and <&'m'&> is the total number of
33800 components in the entry. The / delimiter is used when the line was split
33801 because it was too long; if it was split because of an internal newline, the \
33802 delimiter is used. For example, supposing the length limit to be 50 instead of
33803 870, the following would be the result of a typical rejection message to
33804 &'mainlog'& (LOG_INFO), each line in addition being preceded by the time, host
33805 name, and pid as added by syslog:
33806 .code
33807 [1/5] 2002-09-16 16:09:43 16RdAL-0006pc-00 rejected from
33808 [2/5]  [127.0.0.1] (ph10): syntax error in 'From' header
33809 [3/5]  when scanning for sender: missing or malformed lo
33810 [4/5] cal part in "<>" (envelope sender is <ph10@cam.exa
33811 [5/5] mple>)
33812 .endd
33813 The same error might cause the following lines to be written to &"rejectlog"&
33814 (LOG_NOTICE):
33815 .code
33816 [1/18] 2002-09-16 16:09:43 16RdAL-0006pc-00 rejected fro
33817 [2/18] m [127.0.0.1] (ph10): syntax error in 'From' head
33818 [3/18] er when scanning for sender: missing or malformed
33819 [4/18]  local part in "<>" (envelope sender is <ph10@cam
33820 [5\18] .example>)
33821 [6\18] Recipients: ph10@some.domain.cam.example
33822 [7\18] P Received: from [127.0.0.1] (ident=ph10)
33823 [8\18]        by xxxxx.cam.example with smtp (Exim 4.00)
33824 [9\18]        id 16RdAL-0006pc-00
33825 [10/18]        for ph10@cam.example; Mon, 16 Sep 2002 16:
33826 [11\18] 09:43 +0100
33827 [12\18] F From: <>
33828 [13\18]   Subject: this is a test header
33829 [18\18]   X-something: this is another header
33830 [15/18] I Message-Id: <E16RdAL-0006pc-00@xxxxx.cam.examp
33831 [16\18] le>
33832 [17\18] B Bcc:
33833 [18/18]   Date: Mon, 16 Sep 2002 16:09:43 +0100
33834 .endd
33835 Log lines that are neither too long nor contain newlines are written to syslog
33836 without modification.
33837
33838 If only syslog is being used, the Exim monitor is unable to provide a log tail
33839 display, unless syslog is routing &'mainlog'& to a file on the local host and
33840 the environment variable EXIMON_LOG_FILE_PATH is set to tell the monitor
33841 where it is.
33842
33843
33844
33845 .section "Log line flags" "SECID250"
33846 One line is written to the main log for each message received, and for each
33847 successful, unsuccessful, and delayed delivery. These lines can readily be
33848 picked out by the distinctive two-character flags that immediately follow the
33849 timestamp. The flags are:
33850 .display
33851 &`<=`&     message arrival
33852 &`=>`&     normal message delivery
33853 &`->`&     additional address in same delivery
33854 &`>>`&     cutthrough message delivery
33855 &`*>`&     delivery suppressed by &%-N%&
33856 &`**`&     delivery failed; address bounced
33857 &`==`&     delivery deferred; temporary problem
33858 .endd
33859
33860
33861 .section "Logging message reception" "SECID251"
33862 .cindex "log" "reception line"
33863 The format of the single-line entry in the main log that is written for every
33864 message received is shown in the basic example below, which is split over
33865 several lines in order to fit it on the page:
33866 .code
33867 2002-10-31 08:57:53 16ZCW1-0005MB-00 <= kryten@dwarf.fict.example
33868   H=mailer.fict.example [192.168.123.123] U=exim
33869   P=smtp S=5678 id=<incoming message id>
33870 .endd
33871 The address immediately following &"<="& is the envelope sender address. A
33872 bounce message is shown with the sender address &"<>"&, and if it is locally
33873 generated, this is followed by an item of the form
33874 .code
33875 R=<message id>
33876 .endd
33877 which is a reference to the message that caused the bounce to be sent.
33878
33879 .cindex "HELO"
33880 .cindex "EHLO"
33881 For messages from other hosts, the H and U fields identify the remote host and
33882 record the RFC 1413 identity of the user that sent the message, if one was
33883 received. The number given in square brackets is the IP address of the sending
33884 host. If there is a single, unparenthesized  host name in the H field, as
33885 above, it has been verified to correspond to the IP address (see the
33886 &%host_lookup%& option). If the name is in parentheses, it was the name quoted
33887 by the remote host in the SMTP HELO or EHLO command, and has not been
33888 verified. If verification yields a different name to that given for HELO or
33889 EHLO, the verified name appears first, followed by the HELO or EHLO
33890 name in parentheses.
33891
33892 Misconfigured hosts (and mail forgers) sometimes put an IP address, with or
33893 without brackets, in the HELO or EHLO command, leading to entries in
33894 the log containing text like these examples:
33895 .code
33896 H=(10.21.32.43) [192.168.8.34]
33897 H=([10.21.32.43]) [192.168.8.34]
33898 .endd
33899 This can be confusing. Only the final address in square brackets can be relied
33900 on.
33901
33902 For locally generated messages (that is, messages not received over TCP/IP),
33903 the H field is omitted, and the U field contains the login name of the caller
33904 of Exim.
33905
33906 .cindex "authentication" "logging"
33907 .cindex "AUTH" "logging"
33908 For all messages, the P field specifies the protocol used to receive the
33909 message. This is the value that is stored in &$received_protocol$&. In the case
33910 of incoming SMTP messages, the value indicates whether or not any SMTP
33911 extensions (ESMTP), encryption, or authentication were used. If the SMTP
33912 session was encrypted, there is an additional X field that records the cipher
33913 suite that was used.
33914
33915 The protocol is set to &"esmtpsa"& or &"esmtpa"& for messages received from
33916 hosts that have authenticated themselves using the SMTP AUTH command. The first
33917 value is used when the SMTP connection was encrypted (&"secure"&). In this case
33918 there is an additional item A= followed by the name of the authenticator that
33919 was used. If an authenticated identification was set up by the authenticator's
33920 &%server_set_id%& option, this is logged too, separated by a colon from the
33921 authenticator name.
33922
33923 .cindex "size" "of message"
33924 The id field records the existing message id, if present. The size of the
33925 received message is given by the S field. When the message is delivered,
33926 headers may be removed or added, so that the size of delivered copies of the
33927 message may not correspond with this value (and indeed may be different to each
33928 other).
33929
33930 The &%log_selector%& option can be used to request the logging of additional
33931 data when a message is received. See section &<<SECTlogselector>>& below.
33932
33933
33934
33935 .section "Logging deliveries" "SECID252"
33936 .cindex "log" "delivery line"
33937 The format of the single-line entry in the main log that is written for every
33938 delivery is shown in one of the examples below, for local and remote
33939 deliveries, respectively. Each example has been split into two lines in order
33940 to fit it on the page:
33941 .code
33942 2002-10-31 08:59:13 16ZCW1-0005MB-00 => marv
33943   <marv@hitch.fict.example> R=localuser T=local_delivery
33944 2002-10-31 09:00:10 16ZCW1-0005MB-00 =>
33945   monk@holistic.fict.example R=dnslookup T=remote_smtp
33946   H=holistic.fict.example [192.168.234.234]
33947 .endd
33948 For ordinary local deliveries, the original address is given in angle brackets
33949 after the final delivery address, which might be a pipe or a file. If
33950 intermediate address(es) exist between the original and the final address, the
33951 last of these is given in parentheses after the final address. The R and T
33952 fields record the router and transport that were used to process the address.
33953
33954 If SMTP AUTH was used for the delivery there is an additional item A=
33955 followed by the name of the authenticator that was used.
33956 If an authenticated identification was set up by the authenticator's &%client_set_id%&
33957 option, this is logged too, separated by a colon from the authenticator name.
33958
33959 If a shadow transport was run after a successful local delivery, the log line
33960 for the successful delivery has an item added on the end, of the form
33961 .display
33962 &`ST=<`&&'shadow transport name'&&`>`&
33963 .endd
33964 If the shadow transport did not succeed, the error message is put in
33965 parentheses afterwards.
33966
33967 .cindex "asterisk" "after IP address"
33968 When more than one address is included in a single delivery (for example, two
33969 SMTP RCPT commands in one transaction) the second and subsequent addresses are
33970 flagged with &`->`& instead of &`=>`&. When two or more messages are delivered
33971 down a single SMTP connection, an asterisk follows the IP address in the log
33972 lines for the second and subsequent messages.
33973
33974 .cindex "delivery" "cutthrough; logging"
33975 .cindex "cutthrough" "logging"
33976 When delivery is done in cutthrough mode it is flagged with &`>>`& and the log
33977 line precedes the reception line, since cutthrough waits for a possible
33978 rejection from the destination in case it can reject the sourced item.
33979
33980 The generation of a reply message by a filter file gets logged as a
33981 &"delivery"& to the addressee, preceded by &">"&.
33982
33983 The &%log_selector%& option can be used to request the logging of additional
33984 data when a message is delivered. See section &<<SECTlogselector>>& below.
33985
33986
33987 .section "Discarded deliveries" "SECID253"
33988 .cindex "discarded messages"
33989 .cindex "message" "discarded"
33990 .cindex "delivery" "discarded; logging"
33991 When a message is discarded as a result of the command &"seen finish"& being
33992 obeyed in a filter file which generates no deliveries, a log entry of the form
33993 .code
33994 2002-12-10 00:50:49 16auJc-0001UB-00 => discarded
33995   <low.club@bridge.example> R=userforward
33996 .endd
33997 is written, to record why no deliveries are logged. When a message is discarded
33998 because it is aliased to &":blackhole:"& the log line is like this:
33999 .code
34000 1999-03-02 09:44:33 10HmaX-0005vi-00 => :blackhole:
34001   <hole@nowhere.example> R=blackhole_router
34002 .endd
34003
34004
34005 .section "Deferred deliveries" "SECID254"
34006 When a delivery is deferred, a line of the following form is logged:
34007 .code
34008 2002-12-19 16:20:23 16aiQz-0002Q5-00 == marvin@endrest.example
34009   R=dnslookup T=smtp defer (146): Connection refused
34010 .endd
34011 In the case of remote deliveries, the error is the one that was given for the
34012 last IP address that was tried. Details of individual SMTP failures are also
34013 written to the log, so the above line would be preceded by something like
34014 .code
34015 2002-12-19 16:20:23 16aiQz-0002Q5-00 Failed to connect to
34016   mail1.endrest.example [192.168.239.239]: Connection refused
34017 .endd
34018 When a deferred address is skipped because its retry time has not been reached,
34019 a message is written to the log, but this can be suppressed by setting an
34020 appropriate value in &%log_selector%&.
34021
34022
34023
34024 .section "Delivery failures" "SECID255"
34025 .cindex "delivery" "failure; logging"
34026 If a delivery fails because an address cannot be routed, a line of the
34027 following form is logged:
34028 .code
34029 1995-12-19 16:20:23 0tRiQz-0002Q5-00 ** jim@trek99.example
34030   <jim@trek99.example>: unknown mail domain
34031 .endd
34032 If a delivery fails at transport time, the router and transport are shown, and
34033 the response from the remote host is included, as in this example:
34034 .code
34035 2002-07-11 07:14:17 17SXDU-000189-00 ** ace400@pb.example
34036   R=dnslookup T=remote_smtp: SMTP error from remote mailer
34037   after pipelined RCPT TO:<ace400@pb.example>: host
34038   pbmail3.py.example [192.168.63.111]: 553 5.3.0
34039   <ace400@pb.example>...Addressee unknown
34040 .endd
34041 The word &"pipelined"& indicates that the SMTP PIPELINING extension was being
34042 used. See &%hosts_avoid_esmtp%& in the &(smtp)& transport for a way of
34043 disabling PIPELINING. The log lines for all forms of delivery failure are
34044 flagged with &`**`&.
34045
34046
34047
34048 .section "Fake deliveries" "SECID256"
34049 .cindex "delivery" "fake; logging"
34050 If a delivery does not actually take place because the &%-N%& option has been
34051 used to suppress it, a normal delivery line is written to the log, except that
34052 &"=>"& is replaced by &"*>"&.
34053
34054
34055
34056 .section "Completion" "SECID257"
34057 A line of the form
34058 .code
34059 2002-10-31 09:00:11 16ZCW1-0005MB-00 Completed
34060 .endd
34061 is written to the main log when a message is about to be removed from the spool
34062 at the end of its processing.
34063
34064
34065
34066
34067 .section "Summary of Fields in Log Lines" "SECID258"
34068 .cindex "log" "summary of fields"
34069 A summary of the field identifiers that are used in log lines is shown in
34070 the following table:
34071 .display
34072 &`A   `&        authenticator name (and optional id and sender)
34073 &`C   `&        SMTP confirmation on delivery
34074 &`    `&        command list for &"no mail in SMTP session"&
34075 &`CV  `&        certificate verification status
34076 &`D   `&        duration of &"no mail in SMTP session"&
34077 &`DN  `&        distinguished name from peer certificate
34078 &`DT  `&        on &`=>`& lines: time taken for a delivery
34079 &`F   `&        sender address (on delivery lines)
34080 &`H   `&        host name and IP address
34081 &`I   `&        local interface used
34082 &`id  `&        message id for incoming message
34083 &`P   `&        on &`<=`& lines: protocol used
34084 &`    `&        on &`=>`& and &`**`& lines: return path
34085 &`QT  `&        on &`=>`& lines: time spent on queue so far
34086 &`    `&        on &"Completed"& lines: time spent on queue
34087 &`R   `&        on &`<=`& lines: reference for local bounce
34088 &`    `&        on &`=>`&  &`**`& and &`==`& lines: router name
34089 &`S   `&        size of message
34090 &`SNI `&        server name indication from TLS client hello
34091 &`ST  `&        shadow transport name
34092 &`T   `&        on &`<=`& lines: message subject (topic)
34093 &`    `&        on &`=>`& &`**`& and &`==`& lines: transport name
34094 &`U   `&        local user or RFC 1413 identity
34095 &`X   `&        TLS cipher suite
34096 .endd
34097
34098
34099 .section "Other log entries" "SECID259"
34100 Various other types of log entry are written from time to time. Most should be
34101 self-explanatory. Among the more common are:
34102
34103 .ilist
34104 .cindex "retry" "time not reached"
34105 &'retry time not reached'&&~&~An address previously suffered a temporary error
34106 during routing or local delivery, and the time to retry has not yet arrived.
34107 This message is not written to an individual message log file unless it happens
34108 during the first delivery attempt.
34109 .next
34110 &'retry time not reached for any host'&&~&~An address previously suffered
34111 temporary errors during remote delivery, and the retry time has not yet arrived
34112 for any of the hosts to which it is routed.
34113 .next
34114 .cindex "spool directory" "file locked"
34115 &'spool file locked'&&~&~An attempt to deliver a message cannot proceed because
34116 some other Exim process is already working on the message. This can be quite
34117 common if queue running processes are started at frequent intervals. The
34118 &'exiwhat'& utility script can be used to find out what Exim processes are
34119 doing.
34120 .next
34121 .cindex "error" "ignored"
34122 &'error ignored'&&~&~There are several circumstances that give rise to this
34123 message:
34124 .olist
34125 Exim failed to deliver a bounce message whose age was greater than
34126 &%ignore_bounce_errors_after%&. The bounce was discarded.
34127 .next
34128 A filter file set up a delivery using the &"noerror"& option, and the delivery
34129 failed. The delivery was discarded.
34130 .next
34131 A delivery set up by a router configured with
34132 . ==== As this is a nested list, any displays it contains must be indented
34133 . ==== as otherwise they are too far to the left.
34134 .code
34135     errors_to = <>
34136 .endd
34137 failed. The delivery was discarded.
34138 .endlist olist
34139 .endlist ilist
34140
34141
34142
34143
34144
34145 .section "Reducing or increasing what is logged" "SECTlogselector"
34146 .cindex "log" "selectors"
34147 By setting the &%log_selector%& global option, you can disable some of Exim's
34148 default logging, or you can request additional logging. The value of
34149 &%log_selector%& is made up of names preceded by plus or minus characters. For
34150 example:
34151 .code
34152 log_selector = +arguments -retry_defer
34153 .endd
34154 The list of optional log items is in the following table, with the default
34155 selection marked by asterisks:
34156 .display
34157 &` 8bitmime                   `&  received 8BITMIME status
34158 &`*acl_warn_skipped           `&  skipped &%warn%& statement in ACL
34159 &` address_rewrite            `&  address rewriting
34160 &` all_parents                `&  all parents in => lines
34161 &` arguments                  `&  command line arguments
34162 &`*connection_reject          `&  connection rejections
34163 &`*delay_delivery             `&  immediate delivery delayed
34164 &` deliver_time               `&  time taken to perform delivery
34165 &` delivery_size              `&  add &`S=`&&'nnn'& to => lines
34166 &`*dnslist_defer              `&  defers of DNS list (aka RBL) lookups
34167 &`*etrn                       `&  ETRN commands
34168 &`*host_lookup_failed         `&  as it says
34169 &` ident_timeout              `&  timeout for ident connection
34170 &` incoming_interface         `&  incoming interface on <= lines
34171 &` incoming_port              `&  incoming port on <= lines
34172 &`*lost_incoming_connection   `&  as it says (includes timeouts)
34173 &` outgoing_port              `&  add remote port to => lines
34174 &`*queue_run                  `&  start and end queue runs
34175 &` queue_time                 `&  time on queue for one recipient
34176 &` queue_time_overall         `&  time on queue for whole message
34177 &` pid                        `&  Exim process id
34178 &` received_recipients        `&  recipients on <= lines
34179 &` received_sender            `&  sender on <= lines
34180 &`*rejected_header            `&  header contents on reject log
34181 &`*retry_defer                `&  &"retry time not reached"&
34182 &` return_path_on_delivery    `&  put return path on => and ** lines
34183 &` sender_on_delivery         `&  add sender to => lines
34184 &`*sender_verify_fail         `&  sender verification failures
34185 &`*size_reject                `&  rejection because too big
34186 &`*skip_delivery              `&  delivery skipped in a queue run
34187 &`*smtp_confirmation          `&  SMTP confirmation on => lines
34188 &` smtp_connection            `&  SMTP connections
34189 &` smtp_incomplete_transaction`&  incomplete SMTP transactions
34190 &` smtp_mailauth              `&  AUTH argument to MAIL commands
34191 &` smtp_no_mail               `&  session with no MAIL commands
34192 &` smtp_protocol_error        `&  SMTP protocol errors
34193 &` smtp_syntax_error          `&  SMTP syntax errors
34194 &` subject                    `&  contents of &'Subject:'& on <= lines
34195 &` tls_certificate_verified   `&  certificate verification status
34196 &`*tls_cipher                 `&  TLS cipher suite on <= and => lines
34197 &` tls_peerdn                 `&  TLS peer DN on <= and => lines
34198 &` tls_sni                    `&  TLS SNI on <= lines
34199 &` unknown_in_list            `&  DNS lookup failed in list match
34200
34201 &` all                        `&  all of the above
34202 .endd
34203 More details on each of these items follows:
34204
34205 .ilist
34206 .cindex "8BITMIME"
34207 .cindex "log" "8BITMIME"
34208 &%8bitmime%&: This causes Exim to log any 8BITMIME status of received messages,
34209 which may help in tracking down interoperability issues with ancient MTAs
34210 that are not 8bit clean.  This is added to the &"<="& line, tagged with
34211 &`M8S=`& and a value of &`0`&, &`7`& or &`8`&, corresponding to "not given",
34212 &`7BIT`& and &`8BITMIME`& respectively.
34213 .next
34214 .cindex "&%warn%& ACL verb" "log when skipping"
34215 &%acl_warn_skipped%&: When an ACL &%warn%& statement is skipped because one of
34216 its conditions cannot be evaluated, a log line to this effect is written if
34217 this log selector is set.
34218 .next
34219 .cindex "log" "rewriting"
34220 .cindex "rewriting" "logging"
34221 &%address_rewrite%&: This applies both to global rewrites and per-transport
34222 rewrites, but not to rewrites in filters run as an unprivileged user (because
34223 such users cannot access the log).
34224 .next
34225 .cindex "log" "full parentage"
34226 &%all_parents%&: Normally only the original and final addresses are logged on
34227 delivery lines; with this selector, intermediate parents are given in
34228 parentheses between them.
34229 .next
34230 .cindex "log" "Exim arguments"
34231 .cindex "Exim arguments, logging"
34232 &%arguments%&: This causes Exim to write the arguments with which it was called
34233 to the main log, preceded by the current working directory. This is a debugging
34234 feature, added to make it easier to find out how certain MUAs call
34235 &_/usr/sbin/sendmail_&. The logging does not happen if Exim has given up root
34236 privilege because it was called with the &%-C%& or &%-D%& options. Arguments
34237 that are empty or that contain white space are quoted. Non-printing characters
34238 are shown as escape sequences. This facility cannot log unrecognized arguments,
34239 because the arguments are checked before the configuration file is read. The
34240 only way to log such cases is to interpose a script such as &_util/logargs.sh_&
34241 between the caller and Exim.
34242 .next
34243 .cindex "log" "connection rejections"
34244 &%connection_reject%&: A log entry is written whenever an incoming SMTP
34245 connection is rejected, for whatever reason.
34246 .next
34247 .cindex "log" "delayed delivery"
34248 .cindex "delayed delivery, logging"
34249 &%delay_delivery%&: A log entry is written whenever a delivery process is not
34250 started for an incoming message because the load is too high or too many
34251 messages were received on one connection. Logging does not occur if no delivery
34252 process is started because &%queue_only%& is set or &%-odq%& was used.
34253 .next
34254 .cindex "log" "delivery duration"
34255 &%deliver_time%&: For each delivery, the amount of real time it has taken to
34256 perform the actual delivery is logged as DT=<&'time'&>, for example, &`DT=1s`&.
34257 .next
34258 .cindex "log" "message size on delivery"
34259 .cindex "size" "of message"
34260 &%delivery_size%&: For each delivery, the size of message delivered is added to
34261 the &"=>"& line, tagged with S=.
34262 .next
34263 .cindex "log" "dnslist defer"
34264 .cindex "DNS list" "logging defer"
34265 .cindex "black list (DNS)"
34266 &%dnslist_defer%&: A log entry is written if an attempt to look up a host in a
34267 DNS black list suffers a temporary error.
34268 .next
34269 .cindex "log" "ETRN commands"
34270 .cindex "ETRN" "logging"
34271 &%etrn%&: Every valid ETRN command that is received is logged, before the ACL
34272 is run to determine whether or not it is actually accepted. An invalid ETRN
34273 command, or one received within a message transaction is not logged by this
34274 selector (see &%smtp_syntax_error%& and &%smtp_protocol_error%&).
34275 .next
34276 .cindex "log" "host lookup failure"
34277 &%host_lookup_failed%&: When a lookup of a host's IP addresses fails to find
34278 any addresses, or when a lookup of an IP address fails to find a host name, a
34279 log line is written. This logging does not apply to direct DNS lookups when
34280 routing email addresses, but it does apply to &"byname"& lookups.
34281 .next
34282 .cindex "log" "ident timeout"
34283 .cindex "RFC 1413" "logging timeout"
34284 &%ident_timeout%&: A log line is written whenever an attempt to connect to a
34285 client's ident port times out.
34286 .next
34287 .cindex "log" "incoming interface"
34288 .cindex "interface" "logging"
34289 &%incoming_interface%&: The interface on which a message was received is added
34290 to the &"<="& line as an IP address in square brackets, tagged by I= and
34291 followed by a colon and the port number. The local interface and port are also
34292 added to other SMTP log lines, for example &"SMTP connection from"&, and to
34293 rejection lines.
34294 .next
34295 .cindex "log" "incoming remote port"
34296 .cindex "port" "logging remote"
34297 .cindex "TCP/IP" "logging incoming remote port"
34298 .vindex "&$sender_fullhost$&"
34299 .vindex "&$sender_rcvhost$&"
34300 &%incoming_port%&: The remote port number from which a message was received is
34301 added to log entries and &'Received:'& header lines, following the IP address
34302 in square brackets, and separated from it by a colon. This is implemented by
34303 changing the value that is put in the &$sender_fullhost$& and
34304 &$sender_rcvhost$& variables. Recording the remote port number has become more
34305 important with the widening use of NAT (see RFC 2505).
34306 .next
34307 .cindex "log" "dropped connection"
34308 &%lost_incoming_connection%&: A log line is written when an incoming SMTP
34309 connection is unexpectedly dropped.
34310 .next
34311 .cindex "log" "outgoing remote port"
34312 .cindex "port" "logging outgoint remote"
34313 .cindex "TCP/IP" "logging ougtoing remote port"
34314 &%outgoing_port%&: The remote port number is added to delivery log lines (those
34315 containing => tags) following the IP address. This option is not included in
34316 the default setting, because for most ordinary configurations, the remote port
34317 number is always 25 (the SMTP port).
34318 .next
34319 .cindex "log" "process ids in"
34320 .cindex "pid (process id)" "in log lines"
34321 &%pid%&: The current process id is added to every log line, in square brackets,
34322 immediately after the time and date.
34323 .next
34324 .cindex "log" "queue run"
34325 .cindex "queue runner" "logging"
34326 &%queue_run%&: The start and end of every queue run are logged.
34327 .next
34328 .cindex "log" "queue time"
34329 &%queue_time%&: The amount of time the message has been in the queue on the
34330 local host is logged as QT=<&'time'&> on delivery (&`=>`&) lines, for example,
34331 &`QT=3m45s`&. The clock starts when Exim starts to receive the message, so it
34332 includes reception time as well as the delivery time for the current address.
34333 This means that it may be longer than the difference between the arrival and
34334 delivery log line times, because the arrival log line is not written until the
34335 message has been successfully received.
34336 .next
34337 &%queue_time_overall%&: The amount of time the message has been in the queue on
34338 the local host is logged as QT=<&'time'&> on &"Completed"& lines, for
34339 example, &`QT=3m45s`&. The clock starts when Exim starts to receive the
34340 message, so it includes reception time as well as the total delivery time.
34341 .next
34342 .cindex "log" "recipients"
34343 &%received_recipients%&: The recipients of a message are listed in the main log
34344 as soon as the message is received. The list appears at the end of the log line
34345 that is written when a message is received, preceded by the word &"for"&. The
34346 addresses are listed after they have been qualified, but before any rewriting
34347 has taken place.
34348 Recipients that were discarded by an ACL for MAIL or RCPT do not appear
34349 in the list.
34350 .next
34351 .cindex "log" "sender reception"
34352 &%received_sender%&: The unrewritten original sender of a message is added to
34353 the end of the log line that records the message's arrival, after the word
34354 &"from"& (before the recipients if &%received_recipients%& is also set).
34355 .next
34356 .cindex "log" "header lines for rejection"
34357 &%rejected_header%&: If a message's header has been received at the time a
34358 rejection is written to the reject log, the complete header is added to the
34359 log. Header logging can be turned off individually for messages that are
34360 rejected by the &[local_scan()]& function (see section &<<SECTapiforloc>>&).
34361 .next
34362 .cindex "log" "retry defer"
34363 &%retry_defer%&: A log line is written if a delivery is deferred because a
34364 retry time has not yet been reached. However, this &"retry time not reached"&
34365 message is always omitted from individual message logs after the first delivery
34366 attempt.
34367 .next
34368 .cindex "log" "return path"
34369 &%return_path_on_delivery%&: The return path that is being transmitted with
34370 the message is included in delivery and bounce lines, using the tag P=.
34371 This is omitted if no delivery actually happens, for example, if routing fails,
34372 or if delivery is to &_/dev/null_& or to &`:blackhole:`&.
34373 .next
34374 .cindex "log" "sender on delivery"
34375 &%sender_on_delivery%&: The message's sender address is added to every delivery
34376 and bounce line, tagged by F= (for &"from"&).
34377 This is the original sender that was received with the message; it is not
34378 necessarily the same as the outgoing return path.
34379 .next
34380 .cindex "log" "sender verify failure"
34381 &%sender_verify_fail%&: If this selector is unset, the separate log line that
34382 gives details of a sender verification failure is not written. Log lines for
34383 the rejection of SMTP commands contain just &"sender verify failed"&, so some
34384 detail is lost.
34385 .next
34386 .cindex "log" "size rejection"
34387 &%size_reject%&: A log line is written whenever a message is rejected because
34388 it is too big.
34389 .next
34390 .cindex "log" "frozen messages; skipped"
34391 .cindex "frozen messages" "logging skipping"
34392 &%skip_delivery%&: A log line is written whenever a message is skipped during a
34393 queue run because it is frozen or because another process is already delivering
34394 it.
34395 .cindex "&""spool file is locked""&"
34396 The message that is written is &"spool file is locked"&.
34397 .next
34398 .cindex "log" "smtp confirmation"
34399 .cindex "SMTP" "logging confirmation"
34400 .cindex "LMTP" "logging confirmation"
34401 &%smtp_confirmation%&: The response to the final &"."& in the SMTP or LMTP dialogue for
34402 outgoing messages is added to delivery log lines in the form &`C=`&<&'text'&>.
34403 A number of MTAs (including Exim) return an identifying string in this
34404 response.
34405 .next
34406 .cindex "log" "SMTP connections"
34407 .cindex "SMTP" "logging connections"
34408 &%smtp_connection%&: A log line is written whenever an SMTP connection is
34409 established or closed, unless the connection is from a host that matches
34410 &%hosts_connection_nolog%&. (In contrast, &%lost_incoming_connection%& applies
34411 only when the closure is unexpected.) This applies to connections from local
34412 processes that use &%-bs%& as well as to TCP/IP connections. If a connection is
34413 dropped in the middle of a message, a log line is always written, whether or
34414 not this selector is set, but otherwise nothing is written at the start and end
34415 of connections unless this selector is enabled.
34416
34417 For TCP/IP connections to an Exim daemon, the current number of connections is
34418 included in the log message for each new connection, but note that the count is
34419 reset if the daemon is restarted.
34420 Also, because connections are closed (and the closure is logged) in
34421 subprocesses, the count may not include connections that have been closed but
34422 whose termination the daemon has not yet noticed. Thus, while it is possible to
34423 match up the opening and closing of connections in the log, the value of the
34424 logged counts may not be entirely accurate.
34425 .next
34426 .cindex "log" "SMTP transaction; incomplete"
34427 .cindex "SMTP" "logging incomplete transactions"
34428 &%smtp_incomplete_transaction%&: When a mail transaction is aborted by
34429 RSET, QUIT, loss of connection, or otherwise, the incident is logged,
34430 and the message sender plus any accepted recipients are included in the log
34431 line. This can provide evidence of dictionary attacks.
34432 .next
34433 .cindex "log" "non-MAIL SMTP sessions"
34434 .cindex "MAIL" "logging session without"
34435 &%smtp_no_mail%&: A line is written to the main log whenever an accepted SMTP
34436 connection terminates without having issued a MAIL command. This includes both
34437 the case when the connection is dropped, and the case when QUIT is used. It
34438 does not include cases where the connection is rejected right at the start (by
34439 an ACL, or because there are too many connections, or whatever). These cases
34440 already have their own log lines.
34441
34442 The log line that is written contains the identity of the client in the usual
34443 way, followed by D= and a time, which records the duration of the connection.
34444 If the connection was authenticated, this fact is logged exactly as it is for
34445 an incoming message, with an A= item. If the connection was encrypted, CV=,
34446 DN=, and X= items may appear as they do for an incoming message, controlled by
34447 the same logging options.
34448
34449 Finally, if any SMTP commands were issued during the connection, a C= item
34450 is added to the line, listing the commands that were used. For example,
34451 .code
34452 C=EHLO,QUIT
34453 .endd
34454 shows that the client issued QUIT straight after EHLO. If there were fewer
34455 than 20 commands, they are all listed. If there were more than 20 commands,
34456 the last 20 are listed, preceded by &"..."&. However, with the default
34457 setting of 10 for &%smtp_accep_max_nonmail%&, the connection will in any case
34458 have been aborted before 20 non-mail commands are processed.
34459 .next
34460 &%smtp_mailauth%&: A third subfield with the authenticated sender,
34461 colon-separated, is appended to the A= item for a message arrival or delivery
34462 log line, if an AUTH argument to the SMTP MAIL command (see &<<SECTauthparamail>>&)
34463 was accepted or used.
34464 .next
34465 .cindex "log" "SMTP protocol error"
34466 .cindex "SMTP" "logging protocol error"
34467 &%smtp_protocol_error%&: A log line is written for every SMTP protocol error
34468 encountered. Exim does not have perfect detection of all protocol errors
34469 because of transmission delays and the use of pipelining. If PIPELINING has
34470 been advertised to a client, an Exim server assumes that the client will use
34471 it, and therefore it does not count &"expected"& errors (for example, RCPT
34472 received after rejecting MAIL) as protocol errors.
34473 .next
34474 .cindex "SMTP" "logging syntax errors"
34475 .cindex "SMTP" "syntax errors; logging"
34476 .cindex "SMTP" "unknown command; logging"
34477 .cindex "log" "unknown SMTP command"
34478 .cindex "log" "SMTP syntax error"
34479 &%smtp_syntax_error%&: A log line is written for every SMTP syntax error
34480 encountered. An unrecognized command is treated as a syntax error. For an
34481 external connection, the host identity is given; for an internal connection
34482 using &%-bs%& the sender identification (normally the calling user) is given.
34483 .next
34484 .cindex "log" "subject"
34485 .cindex "subject, logging"
34486 &%subject%&: The subject of the message is added to the arrival log line,
34487 preceded by &"T="& (T for &"topic"&, since S is already used for &"size"&).
34488 Any MIME &"words"& in the subject are decoded. The &%print_topbitchars%& option
34489 specifies whether characters with values greater than 127 should be logged
34490 unchanged, or whether they should be rendered as escape sequences.
34491 .next
34492 .cindex "log" "certificate verification"
34493 &%tls_certificate_verified%&: An extra item is added to <= and => log lines
34494 when TLS is in use. The item is &`CV=yes`& if the peer's certificate was
34495 verified, and &`CV=no`& if not.
34496 .next
34497 .cindex "log" "TLS cipher"
34498 .cindex "TLS" "logging cipher"
34499 &%tls_cipher%&: When a message is sent or received over an encrypted
34500 connection, the cipher suite used is added to the log line, preceded by X=.
34501 .next
34502 .cindex "log" "TLS peer DN"
34503 .cindex "TLS" "logging peer DN"
34504 &%tls_peerdn%&: When a message is sent or received over an encrypted
34505 connection, and a certificate is supplied by the remote host, the peer DN is
34506 added to the log line, preceded by DN=.
34507 .next
34508 .cindex "log" "TLS SNI"
34509 .cindex "TLS" "logging SNI"
34510 &%tls_sni%&: When a message is received over an encrypted connection, and
34511 the remote host provided the Server Name Indication extension, the SNI is
34512 added to the log line, preceded by SNI=.
34513 .next
34514 .cindex "log" "DNS failure in list"
34515 &%unknown_in_list%&: This setting causes a log entry to be written when the
34516 result of a list match is failure because a DNS lookup failed.
34517 .endlist
34518
34519
34520 .section "Message log" "SECID260"
34521 .cindex "message" "log file for"
34522 .cindex "log" "message log; description of"
34523 .cindex "&_msglog_& directory"
34524 .oindex "&%preserve_message_logs%&"
34525 In addition to the general log files, Exim writes a log file for each message
34526 that it handles. The names of these per-message logs are the message ids, and
34527 they are kept in the &_msglog_& sub-directory of the spool directory. Each
34528 message log contains copies of the log lines that apply to the message. This
34529 makes it easier to inspect the status of an individual message without having
34530 to search the main log. A message log is deleted when processing of the message
34531 is complete, unless &%preserve_message_logs%& is set, but this should be used
34532 only with great care because they can fill up your disk very quickly.
34533
34534 On a heavily loaded system, it may be desirable to disable the use of
34535 per-message logs, in order to reduce disk I/O. This can be done by setting the
34536 &%message_logs%& option false.
34537 .ecindex IIDloggen
34538
34539
34540
34541
34542 . ////////////////////////////////////////////////////////////////////////////
34543 . ////////////////////////////////////////////////////////////////////////////
34544
34545 .chapter "Exim utilities" "CHAPutils"
34546 .scindex IIDutils "utilities"
34547 A number of utility scripts and programs are supplied with Exim and are
34548 described in this chapter. There is also the Exim Monitor, which is covered in
34549 the next chapter. The utilities described here are:
34550
34551 .itable none 0 0 3  7* left  15* left  40* left
34552 .irow &<<SECTfinoutwha>>&     &'exiwhat'&       &&&
34553   "list what Exim processes are doing"
34554 .irow &<<SECTgreptheque>>&    &'exiqgrep'&      "grep the queue"
34555 .irow &<<SECTsumtheque>>&     &'exiqsumm'&      "summarize the queue"
34556 .irow &<<SECTextspeinf>>&     &'exigrep'&       "search the main log"
34557 .irow &<<SECTexipick>>&       &'exipick'&       "select messages on &&&
34558                                                 various criteria"
34559 .irow &<<SECTcyclogfil>>&     &'exicyclog'&     "cycle (rotate) log files"
34560 .irow &<<SECTmailstat>>&      &'eximstats'&     &&&
34561   "extract statistics from the log"
34562 .irow &<<SECTcheckaccess>>&   &'exim_checkaccess'& &&&
34563   "check address acceptance from given IP"
34564 .irow &<<SECTdbmbuild>>&      &'exim_dbmbuild'& "build a DBM file"
34565 .irow &<<SECTfinindret>>&     &'exinext'&       "extract retry information"
34566 .irow &<<SECThindatmai>>&     &'exim_dumpdb'&   "dump a hints database"
34567 .irow &<<SECThindatmai>>&     &'exim_tidydb'&   "clean up a hints database"
34568 .irow &<<SECThindatmai>>&     &'exim_fixdb'&    "patch a hints database"
34569 .irow &<<SECTmailboxmaint>>&  &'exim_lock'&     "lock a mailbox file"
34570 .endtable
34571
34572 Another utility that might be of use to sites with many MTAs is Tom Kistner's
34573 &'exilog'&. It provides log visualizations across multiple Exim servers. See
34574 &url(http://duncanthrax.net/exilog/) for details.
34575
34576
34577
34578
34579 .section "Finding out what Exim processes are doing (exiwhat)" "SECTfinoutwha"
34580 .cindex "&'exiwhat'&"
34581 .cindex "process, querying"
34582 .cindex "SIGUSR1"
34583 On operating systems that can restart a system call after receiving a signal
34584 (most modern OS), an Exim process responds to the SIGUSR1 signal by writing
34585 a line describing what it is doing to the file &_exim-process.info_& in the
34586 Exim spool directory. The &'exiwhat'& script sends the signal to all Exim
34587 processes it can find, having first emptied the file. It then waits for one
34588 second to allow the Exim processes to react before displaying the results. In
34589 order to run &'exiwhat'& successfully you have to have sufficient privilege to
34590 send the signal to the Exim processes, so it is normally run as root.
34591
34592 &*Warning*&: This is not an efficient process. It is intended for occasional
34593 use by system administrators. It is not sensible, for example, to set up a
34594 script that sends SIGUSR1 signals to Exim processes at short intervals.
34595
34596
34597 Unfortunately, the &'ps'& command that &'exiwhat'& uses to find Exim processes
34598 varies in different operating systems. Not only are different options used,
34599 but the format of the output is different. For this reason, there are some
34600 system configuration options that configure exactly how &'exiwhat'& works. If
34601 it doesn't seem to be working for you, check the following compile-time
34602 options:
34603 .display
34604 &`EXIWHAT_PS_CMD    `& the command for running &'ps'&
34605 &`EXIWHAT_PS_ARG    `& the argument for &'ps'&
34606 &`EXIWHAT_EGREP_ARG `& the argument for &'egrep'& to select from &'ps'& output
34607 &`EXIWHAT_KILL_ARG  `& the argument for the &'kill'& command
34608 .endd
34609 An example of typical output from &'exiwhat'& is
34610 .code
34611 164 daemon: -q1h, listening on port 25
34612 10483 running queue: waiting for 0tAycK-0002ij-00 (10492)
34613 10492 delivering 0tAycK-0002ij-00 to mail.ref.example
34614   [10.19.42.42] (editor@ref.example)
34615 10592 handling incoming call from [192.168.243.242]
34616 10628 accepting a local non-SMTP message
34617 .endd
34618 The first number in the output line is the process number. The third line has
34619 been split here, in order to fit it on the page.
34620
34621
34622
34623 .section "Selective queue listing (exiqgrep)" "SECTgreptheque"
34624 .cindex "&'exiqgrep'&"
34625 .cindex "queue" "grepping"
34626 This utility is a Perl script contributed by Matt Hubbard. It runs
34627 .code
34628 exim -bpu
34629 .endd
34630 to obtain a queue listing with undelivered recipients only, and then greps the
34631 output to select messages that match given criteria. The following selection
34632 options are available:
34633
34634 .vlist
34635 .vitem &*-f*&&~<&'regex'&>
34636 Match the sender address using a case-insensitive search. The field that is
34637 tested is enclosed in angle brackets, so you can test for bounce messages with
34638 .code
34639 exiqgrep -f '^<>$'
34640 .endd
34641 .vitem &*-r*&&~<&'regex'&>
34642 Match a recipient address using a case-insensitve search. The field that is
34643 tested is not enclosed in angle brackets.
34644
34645 .vitem &*-s*&&~<&'regex'&>
34646 Match against the size field.
34647
34648 .vitem &*-y*&&~<&'seconds'&>
34649 Match messages that are younger than the given time.
34650
34651 .vitem &*-o*&&~<&'seconds'&>
34652 Match messages that are older than the given time.
34653
34654 .vitem &*-z*&
34655 Match only frozen messages.
34656
34657 .vitem &*-x*&
34658 Match only non-frozen messages.
34659 .endlist
34660
34661 The following options control the format of the output:
34662
34663 .vlist
34664 .vitem &*-c*&
34665 Display only the count of matching messages.
34666
34667 .vitem &*-l*&
34668 Long format &-- display the full message information as output by Exim. This is
34669 the default.
34670
34671 .vitem &*-i*&
34672 Display message ids only.
34673
34674 .vitem &*-b*&
34675 Brief format &-- one line per message.
34676
34677 .vitem &*-R*&
34678 Display messages in reverse order.
34679 .endlist
34680
34681 There is one more option, &%-h%&, which outputs a list of options.
34682
34683
34684
34685 .section "Summarizing the queue (exiqsumm)" "SECTsumtheque"
34686 .cindex "&'exiqsumm'&"
34687 .cindex "queue" "summary"
34688 The &'exiqsumm'& utility is a Perl script which reads the output of &`exim
34689 -bp`& and produces a summary of the messages on the queue. Thus, you use it by
34690 running a command such as
34691 .code
34692 exim -bp | exiqsumm
34693 .endd
34694 The output consists of one line for each domain that has messages waiting for
34695 it, as in the following example:
34696 .code
34697 3   2322   74m   66m  msn.com.example
34698 .endd
34699 Each line lists the number of pending deliveries for a domain, their total
34700 volume, and the length of time that the oldest and the newest messages have
34701 been waiting. Note that the number of pending deliveries is greater than the
34702 number of messages when messages have more than one recipient.
34703
34704 A summary line is output at the end. By default the output is sorted on the
34705 domain name, but &'exiqsumm'& has the options &%-a%& and &%-c%&, which cause
34706 the output to be sorted by oldest message and by count of messages,
34707 respectively. There are also three options that split the messages for each
34708 domain into two or more subcounts: &%-b%& separates bounce messages, &%-f%&
34709 separates frozen messages, and &%-s%& separates messages according to their
34710 sender.
34711
34712 The output of &'exim -bp'& contains the original addresses in the message, so
34713 this also applies to the output from &'exiqsumm'&. No domains from addresses
34714 generated by aliasing or forwarding are included (unless the &%one_time%&
34715 option of the &(redirect)& router has been used to convert them into &"top
34716 level"& addresses).
34717
34718
34719
34720
34721 .section "Extracting specific information from the log (exigrep)" &&&
34722          "SECTextspeinf"
34723 .cindex "&'exigrep'&"
34724 .cindex "log" "extracts; grepping for"
34725 The &'exigrep'& utility is a Perl script that searches one or more main log
34726 files for entries that match a given pattern. When it finds a match, it
34727 extracts all the log entries for the relevant message, not just those that
34728 match the pattern. Thus, &'exigrep'& can extract complete log entries for a
34729 given message, or all mail for a given user, or for a given host, for example.
34730 The input files can be in Exim log format or syslog format.
34731 If a matching log line is not associated with a specific message, it is
34732 included in &'exigrep'&'s output without any additional lines. The usage is:
34733 .display
34734 &`exigrep [-t<`&&'n'&&`>] [-I] [-l] [-v] <`&&'pattern'&&`> [<`&&'log file'&&`>] ...`&
34735 .endd
34736 If no log file names are given on the command line, the standard input is read.
34737
34738 The &%-t%& argument specifies a number of seconds. It adds an additional
34739 condition for message selection. Messages that are complete are shown only if
34740 they spent more than <&'n'&> seconds on the queue.
34741
34742 By default, &'exigrep'& does case-insensitive matching. The &%-I%& option
34743 makes it case-sensitive. This may give a performance improvement when searching
34744 large log files. Without &%-I%&, the Perl pattern matches use Perl's &`/i`&
34745 option; with &%-I%& they do not. In both cases it is possible to change the
34746 case sensitivity within the pattern by using &`(?i)`& or &`(?-i)`&.
34747
34748 The &%-l%& option means &"literal"&, that is, treat all characters in the
34749 pattern as standing for themselves. Otherwise the pattern must be a Perl
34750 regular expression.
34751
34752 The &%-v%& option inverts the matching condition. That is, a line is selected
34753 if it does &'not'& match the pattern.
34754
34755 If the location of a &'zcat'& command is known from the definition of
34756 ZCAT_COMMAND in &_Local/Makefile_&, &'exigrep'& automatically passes any file
34757 whose name ends in COMPRESS_SUFFIX through &'zcat'& as it searches it.
34758
34759
34760 .section "Selecting messages by various criteria (exipick)" "SECTexipick"
34761 .cindex "&'exipick'&"
34762 John Jetmore's &'exipick'& utility is included in the Exim distribution. It
34763 lists messages from the queue according to a variety of criteria. For details
34764 of &'exipick'&'s facilities, visit the web page at
34765 &url(http://www.exim.org/eximwiki/ToolExipickManPage) or run &'exipick'& with
34766 the &%--help%& option.
34767
34768
34769 .section "Cycling log files (exicyclog)" "SECTcyclogfil"
34770 .cindex "log" "cycling local files"
34771 .cindex "cycling logs"
34772 .cindex "&'exicyclog'&"
34773 The &'exicyclog'& script can be used to cycle (rotate) &'mainlog'& and
34774 &'rejectlog'& files. This is not necessary if only syslog is being used, or if
34775 you are using log files with datestamps in their names (see section
34776 &<<SECTdatlogfil>>&). Some operating systems have their own standard mechanisms
34777 for log cycling, and these can be used instead of &'exicyclog'& if preferred.
34778 There are two command line options for &'exicyclog'&:
34779 .ilist
34780 &%-k%& <&'count'&> specifies the number of log files to keep, overriding the
34781 default that is set when Exim is built. The default default is 10.
34782 .next
34783 &%-l%& <&'path'&> specifies the log file path, in the same format as Exim's
34784 &%log_file_path%& option (for example, &`/var/log/exim_%slog`&), again
34785 overriding the script's default, which is to find the setting from Exim's
34786 configuration.
34787 .endlist
34788
34789 Each time &'exicyclog'& is run the file names get &"shuffled down"& by one. If
34790 the main log file name is &_mainlog_& (the default) then when &'exicyclog'& is
34791 run &_mainlog_& becomes &_mainlog.01_&, the previous &_mainlog.01_& becomes
34792 &_mainlog.02_& and so on, up to the limit that is set in the script or by the
34793 &%-k%& option. Log files whose numbers exceed the limit are discarded. Reject
34794 logs are handled similarly.
34795
34796 If the limit is greater than 99, the script uses 3-digit numbers such as
34797 &_mainlog.001_&, &_mainlog.002_&, etc. If you change from a number less than 99
34798 to one that is greater, or &'vice versa'&, you will have to fix the names of
34799 any existing log files.
34800
34801 If no &_mainlog_& file exists, the script does nothing. Files that &"drop off"&
34802 the end are deleted. All files with numbers greater than 01 are compressed,
34803 using a compression command which is configured by the COMPRESS_COMMAND
34804 setting in &_Local/Makefile_&. It is usual to run &'exicyclog'& daily from a
34805 root &%crontab%& entry of the form
34806 .code
34807 1 0 * * * su exim -c /usr/exim/bin/exicyclog
34808 .endd
34809 assuming you have used the name &"exim"& for the Exim user. You can run
34810 &'exicyclog'& as root if you wish, but there is no need.
34811
34812
34813
34814 .section "Mail statistics (eximstats)" "SECTmailstat"
34815 .cindex "statistics"
34816 .cindex "&'eximstats'&"
34817 A Perl script called &'eximstats'& is provided for extracting statistical
34818 information from log files. The output is either plain text, or HTML.
34819 Exim log files are also supported by the &'Lire'& system produced by the
34820 LogReport Foundation &url(http://www.logreport.org).
34821
34822 The &'eximstats'& script has been hacked about quite a bit over time. The
34823 latest version is the result of some extensive revision by Steve Campbell. A
34824 lot of information is given by default, but there are options for suppressing
34825 various parts of it. Following any options, the arguments to the script are a
34826 list of files, which should be main log files. For example:
34827 .code
34828 eximstats -nr /var/spool/exim/log/mainlog.01
34829 .endd
34830 By default, &'eximstats'& extracts information about the number and volume of
34831 messages received from or delivered to various hosts. The information is sorted
34832 both by message count and by volume, and the top fifty hosts in each category
34833 are listed on the standard output. Similar information, based on email
34834 addresses or domains instead of hosts can be requested by means of various
34835 options. For messages delivered and received locally, similar statistics are
34836 also produced per user.
34837
34838 The output also includes total counts and statistics about delivery errors, and
34839 histograms showing the number of messages received and deliveries made in each
34840 hour of the day. A delivery with more than one address in its envelope (for
34841 example, an SMTP transaction with more than one RCPT command) is counted
34842 as a single delivery by &'eximstats'&.
34843
34844 Though normally more deliveries than receipts are reported (as messages may
34845 have multiple recipients), it is possible for &'eximstats'& to report more
34846 messages received than delivered, even though the queue is empty at the start
34847 and end of the period in question. If an incoming message contains no valid
34848 recipients, no deliveries are recorded for it. A bounce message is handled as
34849 an entirely separate message.
34850
34851 &'eximstats'& always outputs a grand total summary giving the volume and number
34852 of messages received and deliveries made, and the number of hosts involved in
34853 each case. It also outputs the number of messages that were delayed (that is,
34854 not completely delivered at the first attempt), and the number that had at
34855 least one address that failed.
34856
34857 The remainder of the output is in sections that can be independently disabled
34858 or modified by various options. It consists of a summary of deliveries by
34859 transport, histograms of messages received and delivered per time interval
34860 (default per hour), information about the time messages spent on the queue,
34861 a list of relayed messages, lists of the top fifty sending hosts, local
34862 senders, destination hosts, and destination local users by count and by volume,
34863 and a list of delivery errors that occurred.
34864
34865 The relay information lists messages that were actually relayed, that is, they
34866 came from a remote host and were directly delivered to some other remote host,
34867 without being processed (for example, for aliasing or forwarding) locally.
34868
34869 There are quite a few options for &'eximstats'& to control exactly what it
34870 outputs. These are documented in the Perl script itself, and can be extracted
34871 by running the command &(perldoc)& on the script. For example:
34872 .code
34873 perldoc /usr/exim/bin/eximstats
34874 .endd
34875
34876 .section "Checking access policy (exim_checkaccess)" "SECTcheckaccess"
34877 .cindex "&'exim_checkaccess'&"
34878 .cindex "policy control" "checking access"
34879 .cindex "checking access"
34880 The &%-bh%& command line argument allows you to run a fake SMTP session with
34881 debugging output, in order to check what Exim is doing when it is applying
34882 policy controls to incoming SMTP mail. However, not everybody is sufficiently
34883 familiar with the SMTP protocol to be able to make full use of &%-bh%&, and
34884 sometimes you just want to answer the question &"Does this address have
34885 access?"& without bothering with any further details.
34886
34887 The &'exim_checkaccess'& utility is a &"packaged"& version of &%-bh%&. It takes
34888 two arguments, an IP address and an email address:
34889 .code
34890 exim_checkaccess 10.9.8.7 A.User@a.domain.example
34891 .endd
34892 The utility runs a call to Exim with the &%-bh%& option, to test whether the
34893 given email address would be accepted in a RCPT command in a TCP/IP
34894 connection from the host with the given IP address. The output of the utility
34895 is either the word &"accepted"&, or the SMTP error response, for example:
34896 .code
34897 Rejected:
34898 550 Relay not permitted
34899 .endd
34900 When running this test, the utility uses &`<>`& as the envelope sender address
34901 for the MAIL command, but you can change this by providing additional
34902 options. These are passed directly to the Exim command. For example, to specify
34903 that the test is to be run with the sender address &'himself@there.example'&
34904 you can use:
34905 .code
34906 exim_checkaccess 10.9.8.7 A.User@a.domain.example \
34907                  -f himself@there.example
34908 .endd
34909 Note that these additional Exim command line items must be given after the two
34910 mandatory arguments.
34911
34912 Because the &%exim_checkaccess%& uses &%-bh%&, it does not perform callouts
34913 while running its checks. You can run checks that include callouts by using
34914 &%-bhc%&, but this is not yet available in a &"packaged"& form.
34915
34916
34917
34918 .section "Making DBM files (exim_dbmbuild)" "SECTdbmbuild"
34919 .cindex "DBM" "building dbm files"
34920 .cindex "building DBM files"
34921 .cindex "&'exim_dbmbuild'&"
34922 .cindex "lower casing"
34923 .cindex "binary zero" "in lookup key"
34924 The &'exim_dbmbuild'& program reads an input file containing keys and data in
34925 the format used by the &(lsearch)& lookup (see section
34926 &<<SECTsinglekeylookups>>&). It writes a DBM file using the lower-cased alias
34927 names as keys and the remainder of the information as data. The lower-casing
34928 can be prevented by calling the program with the &%-nolc%& option.
34929
34930 A terminating zero is included as part of the key string. This is expected by
34931 the &(dbm)& lookup type. However, if the option &%-nozero%& is given,
34932 &'exim_dbmbuild'& creates files without terminating zeroes in either the key
34933 strings or the data strings. The &(dbmnz)& lookup type can be used with such
34934 files.
34935
34936 The program requires two arguments: the name of the input file (which can be a
34937 single hyphen to indicate the standard input), and the name of the output file.
34938 It creates the output under a temporary name, and then renames it if all went
34939 well.
34940
34941 .cindex "USE_DB"
34942 If the native DB interface is in use (USE_DB is set in a compile-time
34943 configuration file &-- this is common in free versions of Unix) the two file
34944 names must be different, because in this mode the Berkeley DB functions create
34945 a single output file using exactly the name given. For example,
34946 .code
34947 exim_dbmbuild /etc/aliases /etc/aliases.db
34948 .endd
34949 reads the system alias file and creates a DBM version of it in
34950 &_/etc/aliases.db_&.
34951
34952 In systems that use the &'ndbm'& routines (mostly proprietary versions of
34953 Unix), two files are used, with the suffixes &_.dir_& and &_.pag_&. In this
34954 environment, the suffixes are added to the second argument of
34955 &'exim_dbmbuild'&, so it can be the same as the first. This is also the case
34956 when the Berkeley functions are used in compatibility mode (though this is not
34957 recommended), because in that case it adds a &_.db_& suffix to the file name.
34958
34959 If a duplicate key is encountered, the program outputs a warning, and when it
34960 finishes, its return code is 1 rather than zero, unless the &%-noduperr%&
34961 option is used. By default, only the first of a set of duplicates is used &--
34962 this makes it compatible with &(lsearch)& lookups. There is an option
34963 &%-lastdup%& which causes it to use the data for the last duplicate instead.
34964 There is also an option &%-nowarn%&, which stops it listing duplicate keys to
34965 &%stderr%&. For other errors, where it doesn't actually make a new file, the
34966 return code is 2.
34967
34968
34969
34970
34971 .section "Finding individual retry times (exinext)" "SECTfinindret"
34972 .cindex "retry" "times"
34973 .cindex "&'exinext'&"
34974 A utility called &'exinext'& (mostly a Perl script) provides the ability to
34975 fish specific information out of the retry database. Given a mail domain (or a
34976 complete address), it looks up the hosts for that domain, and outputs any retry
34977 information for the hosts or for the domain. At present, the retry information
34978 is obtained by running &'exim_dumpdb'& (see below) and post-processing the
34979 output. For example:
34980 .code
34981 $ exinext piglet@milne.fict.example
34982 kanga.milne.example:192.168.8.1 error 146: Connection refused
34983   first failed: 21-Feb-1996 14:57:34
34984   last tried:   21-Feb-1996 14:57:34
34985   next try at:  21-Feb-1996 15:02:34
34986 roo.milne.example:192.168.8.3 error 146: Connection refused
34987   first failed: 20-Jan-1996 13:12:08
34988   last tried:   21-Feb-1996 11:42:03
34989   next try at:  21-Feb-1996 19:42:03
34990   past final cutoff time
34991 .endd
34992 You can also give &'exinext'& a local part, without a domain, and it
34993 will give any retry information for that local part in your default domain.
34994 A message id can be used to obtain retry information pertaining to a specific
34995 message. This exists only when an attempt to deliver a message to a remote host
34996 suffers a message-specific error (see section &<<SECToutSMTPerr>>&).
34997 &'exinext'& is not particularly efficient, but then it is not expected to be
34998 run very often.
34999
35000 The &'exinext'& utility calls Exim to find out information such as the location
35001 of the spool directory. The utility has &%-C%& and &%-D%& options, which are
35002 passed on to the &'exim'& commands. The first specifies an alternate Exim
35003 configuration file, and the second sets macros for use within the configuration
35004 file. These features are mainly to help in testing, but might also be useful in
35005 environments where more than one configuration file is in use.
35006
35007
35008
35009 .section "Hints database maintenance" "SECThindatmai"
35010 .cindex "hints database" "maintenance"
35011 .cindex "maintaining Exim's hints database"
35012 Three utility programs are provided for maintaining the DBM files that Exim
35013 uses to contain its delivery hint information. Each program requires two
35014 arguments. The first specifies the name of Exim's spool directory, and the
35015 second is the name of the database it is to operate on. These are as follows:
35016
35017 .ilist
35018 &'retry'&: the database of retry information
35019 .next
35020 &'wait-'&<&'transport name'&>: databases of information about messages waiting
35021 for remote hosts
35022 .next
35023 &'callout'&: the callout cache
35024 .next
35025 &'ratelimit'&: the data for implementing the ratelimit ACL condition
35026 .next
35027 &'misc'&: other hints data
35028 .endlist
35029
35030 The &'misc'& database is used for
35031
35032 .ilist
35033 Serializing ETRN runs (when &%smtp_etrn_serialize%& is set)
35034 .next
35035 Serializing delivery to a specific host (when &%serialize_hosts%& is set in an
35036 &(smtp)& transport)
35037 .endlist
35038
35039
35040
35041 .section "exim_dumpdb" "SECID261"
35042 .cindex "&'exim_dumpdb'&"
35043 The entire contents of a database are written to the standard output by the
35044 &'exim_dumpdb'& program, which has no options or arguments other than the
35045 spool and database names. For example, to dump the retry database:
35046 .code
35047 exim_dumpdb /var/spool/exim retry
35048 .endd
35049 Two lines of output are produced for each entry:
35050 .code
35051 T:mail.ref.example:192.168.242.242 146 77 Connection refused
35052 31-Oct-1995 12:00:12 02-Nov-1995 12:21:39 02-Nov-1995 20:21:39 *
35053 .endd
35054 The first item on the first line is the key of the record. It starts with one
35055 of the letters R, or T, depending on whether it refers to a routing or
35056 transport retry. For a local delivery, the next part is the local address; for
35057 a remote delivery it is the name of the remote host, followed by its failing IP
35058 address (unless &%retry_include_ip_address%& is set false on the &(smtp)&
35059 transport). If the remote port is not the standard one (port 25), it is added
35060 to the IP address. Then there follows an error code, an additional error code,
35061 and a textual description of the error.
35062
35063 The three times on the second line are the time of first failure, the time of
35064 the last delivery attempt, and the computed time for the next attempt. The line
35065 ends with an asterisk if the cutoff time for the last retry rule has been
35066 exceeded.
35067
35068 Each output line from &'exim_dumpdb'& for the &'wait-xxx'& databases
35069 consists of a host name followed by a list of ids for messages that are or were
35070 waiting to be delivered to that host. If there are a very large number for any
35071 one host, continuation records, with a sequence number added to the host name,
35072 may be seen. The data in these records is often out of date, because a message
35073 may be routed to several alternative hosts, and Exim makes no effort to keep
35074 cross-references.
35075
35076
35077
35078 .section "exim_tidydb" "SECID262"
35079 .cindex "&'exim_tidydb'&"
35080 The &'exim_tidydb'& utility program is used to tidy up the contents of a hints
35081 database. If run with no options, it removes all records that are more than 30
35082 days old. The age is calculated from the date and time that the record was last
35083 updated. Note that, in the case of the retry database, it is &'not'& the time
35084 since the first delivery failure. Information about a host that has been down
35085 for more than 30 days will remain in the database, provided that the record is
35086 updated sufficiently often.
35087
35088 The cutoff date can be altered by means of the &%-t%& option, which must be
35089 followed by a time. For example, to remove all records older than a week from
35090 the retry database:
35091 .code
35092 exim_tidydb -t 7d /var/spool/exim retry
35093 .endd
35094 Both the &'wait-xxx'& and &'retry'& databases contain items that involve
35095 message ids. In the former these appear as data in records keyed by host &--
35096 they were messages that were waiting for that host &-- and in the latter they
35097 are the keys for retry information for messages that have suffered certain
35098 types of error. When &'exim_tidydb'& is run, a check is made to ensure that
35099 message ids in database records are those of messages that are still on the
35100 queue. Message ids for messages that no longer exist are removed from
35101 &'wait-xxx'& records, and if this leaves any records empty, they are deleted.
35102 For the &'retry'& database, records whose keys are non-existent message ids are
35103 removed. The &'exim_tidydb'& utility outputs comments on the standard output
35104 whenever it removes information from the database.
35105
35106 Certain records are automatically removed by Exim when they are no longer
35107 needed, but others are not. For example, if all the MX hosts for a domain are
35108 down, a retry record is created for each one. If the primary MX host comes back
35109 first, its record is removed when Exim successfully delivers to it, but the
35110 records for the others remain because Exim has not tried to use those hosts.
35111
35112 It is important, therefore, to run &'exim_tidydb'& periodically on all the
35113 hints databases. You should do this at a quiet time of day, because it requires
35114 a database to be locked (and therefore inaccessible to Exim) while it does its
35115 work. Removing records from a DBM file does not normally make the file smaller,
35116 but all the common DBM libraries are able to re-use the space that is released.
35117 After an initial phase of increasing in size, the databases normally reach a
35118 point at which they no longer get any bigger, as long as they are regularly
35119 tidied.
35120
35121 &*Warning*&: If you never run &'exim_tidydb'&, the space used by the hints
35122 databases is likely to keep on increasing.
35123
35124
35125
35126
35127 .section "exim_fixdb" "SECID263"
35128 .cindex "&'exim_fixdb'&"
35129 The &'exim_fixdb'& program is a utility for interactively modifying databases.
35130 Its main use is for testing Exim, but it might also be occasionally useful for
35131 getting round problems in a live system. It has no options, and its interface
35132 is somewhat crude. On entry, it prompts for input with a right angle-bracket. A
35133 key of a database record can then be entered, and the data for that record is
35134 displayed.
35135
35136 If &"d"& is typed at the next prompt, the entire record is deleted. For all
35137 except the &'retry'& database, that is the only operation that can be carried
35138 out. For the &'retry'& database, each field is output preceded by a number, and
35139 data for individual fields can be changed by typing the field number followed
35140 by new data, for example:
35141 .code
35142 > 4 951102:1000
35143 .endd
35144 resets the time of the next delivery attempt. Time values are given as a
35145 sequence of digit pairs for year, month, day, hour, and minute. Colons can be
35146 used as optional separators.
35147
35148
35149
35150
35151 .section "Mailbox maintenance (exim_lock)" "SECTmailboxmaint"
35152 .cindex "mailbox" "maintenance"
35153 .cindex "&'exim_lock'&"
35154 .cindex "locking mailboxes"
35155 The &'exim_lock'& utility locks a mailbox file using the same algorithm as
35156 Exim. For a discussion of locking issues, see section &<<SECTopappend>>&.
35157 &'Exim_lock'& can be used to prevent any modification of a mailbox by Exim or
35158 a user agent while investigating a problem. The utility requires the name of
35159 the file as its first argument. If the locking is successful, the second
35160 argument is run as a command (using C's &[system()]& function); if there is no
35161 second argument, the value of the SHELL environment variable is used; if this
35162 is unset or empty, &_/bin/sh_& is run. When the command finishes, the mailbox
35163 is unlocked and the utility ends. The following options are available:
35164
35165 .vlist
35166 .vitem &%-fcntl%&
35167 Use &[fcntl()]& locking on the open mailbox.
35168
35169 .vitem &%-flock%&
35170 Use &[flock()]& locking on the open mailbox, provided the operating system
35171 supports it.
35172
35173 .vitem &%-interval%&
35174 This must be followed by a number, which is a number of seconds; it sets the
35175 interval to sleep between retries (default 3).
35176
35177 .vitem &%-lockfile%&
35178 Create a lock file before opening the mailbox.
35179
35180 .vitem &%-mbx%&
35181 Lock the mailbox using MBX rules.
35182
35183 .vitem &%-q%&
35184 Suppress verification output.
35185
35186 .vitem &%-retries%&
35187 This must be followed by a number; it sets the number of times to try to get
35188 the lock (default 10).
35189
35190 .vitem &%-restore_time%&
35191 This option causes &%exim_lock%& to restore the modified and read times to the
35192 locked file before exiting. This allows you to access a locked mailbox (for
35193 example, to take a backup copy) without disturbing the times that the user
35194 subsequently sees.
35195
35196 .vitem &%-timeout%&
35197 This must be followed by a number, which is a number of seconds; it sets a
35198 timeout to be used with a blocking &[fcntl()]& lock. If it is not set (the
35199 default), a non-blocking call is used.
35200
35201 .vitem &%-v%&
35202 Generate verbose output.
35203 .endlist
35204
35205 If none of &%-fcntl%&, &%-flock%&, &%-lockfile%& or &%-mbx%& are given, the
35206 default is to create a lock file and also to use &[fcntl()]& locking on the
35207 mailbox, which is the same as Exim's default. The use of &%-flock%& or
35208 &%-fcntl%& requires that the file be writeable; the use of &%-lockfile%&
35209 requires that the directory containing the file be writeable. Locking by lock
35210 file does not last for ever; Exim assumes that a lock file is expired if it is
35211 more than 30 minutes old.
35212
35213 The &%-mbx%& option can be used with either or both of &%-fcntl%& or
35214 &%-flock%&. It assumes &%-fcntl%& by default. MBX locking causes a shared lock
35215 to be taken out on the open mailbox, and an exclusive lock on the file
35216 &_/tmp/.n.m_& where &'n'& and &'m'& are the device number and inode
35217 number of the mailbox file. When the locking is released, if an exclusive lock
35218 can be obtained for the mailbox, the file in &_/tmp_& is deleted.
35219
35220 The default output contains verification of the locking that takes place. The
35221 &%-v%& option causes some additional information to be given. The &%-q%& option
35222 suppresses all output except error messages.
35223
35224 A command such as
35225 .code
35226 exim_lock /var/spool/mail/spqr
35227 .endd
35228 runs an interactive shell while the file is locked, whereas
35229 .display
35230 &`exim_lock -q /var/spool/mail/spqr <<End`&
35231 <&'some commands'&>
35232 &`End`&
35233 .endd
35234 runs a specific non-interactive sequence of commands while the file is locked,
35235 suppressing all verification output. A single command can be run by a command
35236 such as
35237 .code
35238 exim_lock -q /var/spool/mail/spqr \
35239   "cp /var/spool/mail/spqr /some/where"
35240 .endd
35241 Note that if a command is supplied, it must be entirely contained within the
35242 second argument &-- hence the quotes.
35243 .ecindex IIDutils
35244
35245
35246 . ////////////////////////////////////////////////////////////////////////////
35247 . ////////////////////////////////////////////////////////////////////////////
35248
35249 .chapter "The Exim monitor" "CHAPeximon"
35250 .scindex IIDeximon "Exim monitor" "description"
35251 .cindex "X-windows"
35252 .cindex "&'eximon'&"
35253 .cindex "Local/eximon.conf"
35254 .cindex "&_exim_monitor/EDITME_&"
35255 The Exim monitor is an application which displays in an X window information
35256 about the state of Exim's queue and what Exim is doing. An admin user can
35257 perform certain operations on messages from this GUI interface; however all
35258 such facilities are also available from the command line, and indeed, the
35259 monitor itself makes use of the command line to perform any actions requested.
35260
35261
35262
35263 .section "Running the monitor" "SECID264"
35264 The monitor is started by running the script called &'eximon'&. This is a shell
35265 script that sets up a number of environment variables, and then runs the
35266 binary called &_eximon.bin_&. The default appearance of the monitor window can
35267 be changed by editing the &_Local/eximon.conf_& file created by editing
35268 &_exim_monitor/EDITME_&. Comments in that file describe what the various
35269 parameters are for.
35270
35271 The parameters that get built into the &'eximon'& script can be overridden for
35272 a particular invocation by setting up environment variables of the same names,
35273 preceded by &`EXIMON_`&. For example, a shell command such as
35274 .code
35275 EXIMON_LOG_DEPTH=400 eximon
35276 .endd
35277 (in a Bourne-compatible shell) runs &'eximon'& with an overriding setting of
35278 the LOG_DEPTH parameter. If EXIMON_LOG_FILE_PATH is set in the environment, it
35279 overrides the Exim log file configuration. This makes it possible to have
35280 &'eximon'& tailing log data that is written to syslog, provided that MAIL.INFO
35281 syslog messages are routed to a file on the local host.
35282
35283 X resources can be used to change the appearance of the window in the normal
35284 way. For example, a resource setting of the form
35285 .code
35286 Eximon*background: gray94
35287 .endd
35288 changes the colour of the background to light grey rather than white. The
35289 stripcharts are drawn with both the data lines and the reference lines in
35290 black. This means that the reference lines are not visible when on top of the
35291 data. However, their colour can be changed by setting a resource called
35292 &"highlight"& (an odd name, but that's what the Athena stripchart widget uses).
35293 For example, if your X server is running Unix, you could set up lighter
35294 reference lines in the stripcharts by obeying
35295 .code
35296 xrdb -merge <<End
35297 Eximon*highlight: gray
35298 End
35299 .endd
35300 .cindex "admin user"
35301 In order to see the contents of messages on the queue, and to operate on them,
35302 &'eximon'& must either be run as root or by an admin user.
35303
35304 The command-line parameters of &'eximon'& are passed to &_eximon.bin_& and may
35305 contain X11 resource parameters interpreted by the X11 library.  In addition,
35306 if the first parameter starts with the string "gdb" then it is removed and the
35307 binary is invoked under gdb (the parameter is used as the gdb command-name, so
35308 versioned variants of gdb can be invoked).
35309
35310 The monitor's window is divided into three parts. The first contains one or
35311 more stripcharts and two action buttons, the second contains a &"tail"& of the
35312 main log file, and the third is a display of the queue of messages awaiting
35313 delivery, with two more action buttons. The following sections describe these
35314 different parts of the display.
35315
35316
35317
35318
35319 .section "The stripcharts" "SECID265"
35320 .cindex "stripchart"
35321 The first stripchart is always a count of messages on the queue. Its name can
35322 be configured by setting QUEUE_STRIPCHART_NAME in the
35323 &_Local/eximon.conf_& file. The remaining stripcharts are defined in the
35324 configuration script by regular expression matches on log file entries, making
35325 it possible to display, for example, counts of messages delivered to certain
35326 hosts or using certain transports. The supplied defaults display counts of
35327 received and delivered messages, and of local and SMTP deliveries. The default
35328 period between stripchart updates is one minute; this can be adjusted by a
35329 parameter in the &_Local/eximon.conf_& file.
35330
35331 The stripchart displays rescale themselves automatically as the value they are
35332 displaying changes. There are always 10 horizontal lines in each chart; the
35333 title string indicates the value of each division when it is greater than one.
35334 For example, &"x2"& means that each division represents a value of 2.
35335
35336 It is also possible to have a stripchart which shows the percentage fullness of
35337 a particular disk partition, which is useful when local deliveries are confined
35338 to a single partition.
35339
35340 .cindex "&%statvfs%& function"
35341 This relies on the availability of the &[statvfs()]& function or equivalent in
35342 the operating system. Most, but not all versions of Unix that support Exim have
35343 this. For this particular stripchart, the top of the chart always represents
35344 100%, and the scale is given as &"x10%"&. This chart is configured by setting
35345 SIZE_STRIPCHART and (optionally) SIZE_STRIPCHART_NAME in the
35346 &_Local/eximon.conf_& file.
35347
35348
35349
35350
35351 .section "Main action buttons" "SECID266"
35352 .cindex "size" "of monitor window"
35353 .cindex "Exim monitor" "window size"
35354 .cindex "window size"
35355 Below the stripcharts there is an action button for quitting the monitor. Next
35356 to this is another button marked &"Size"&. They are placed here so that
35357 shrinking the window to its default minimum size leaves just the queue count
35358 stripchart and these two buttons visible. Pressing the &"Size"& button causes
35359 the window to expand to its maximum size, unless it is already at the maximum,
35360 in which case it is reduced to its minimum.
35361
35362 When expanding to the maximum, if the window cannot be fully seen where it
35363 currently is, it is moved back to where it was the last time it was at full
35364 size. When it is expanding from its minimum size, the old position is
35365 remembered, and next time it is reduced to the minimum it is moved back there.
35366
35367 The idea is that you can keep a reduced window just showing one or two
35368 stripcharts at a convenient place on your screen, easily expand it to show
35369 the full window when required, and just as easily put it back to what it was.
35370 The idea is copied from what the &'twm'& window manager does for its
35371 &'f.fullzoom'& action. The minimum size of the window can be changed by setting
35372 the MIN_HEIGHT and MIN_WIDTH values in &_Local/eximon.conf_&.
35373
35374 Normally, the monitor starts up with the window at its full size, but it can be
35375 built so that it starts up with the window at its smallest size, by setting
35376 START_SMALL=yes in &_Local/eximon.conf_&.
35377
35378
35379
35380 .section "The log display" "SECID267"
35381 .cindex "log" "tail of; in monitor"
35382 The second section of the window is an area in which a display of the tail of
35383 the main log is maintained.
35384 To save space on the screen, the timestamp on each log line is shortened by
35385 removing the date and, if &%log_timezone%& is set, the timezone.
35386 The log tail is not available when the only destination for logging data is
35387 syslog, unless the syslog lines are routed to a local file whose name is passed
35388 to &'eximon'& via the EXIMON_LOG_FILE_PATH environment variable.
35389
35390 The log sub-window has a scroll bar at its lefthand side which can be used to
35391 move back to look at earlier text, and the up and down arrow keys also have a
35392 scrolling effect. The amount of log that is kept depends on the setting of
35393 LOG_BUFFER in &_Local/eximon.conf_&, which specifies the amount of memory
35394 to use. When this is full, the earlier 50% of data is discarded &-- this is
35395 much more efficient than throwing it away line by line. The sub-window also has
35396 a horizontal scroll bar for accessing the ends of long log lines. This is the
35397 only means of horizontal scrolling; the right and left arrow keys are not
35398 available. Text can be cut from this part of the window using the mouse in the
35399 normal way. The size of this subwindow is controlled by parameters in the
35400 configuration file &_Local/eximon.conf_&.
35401
35402 Searches of the text in the log window can be carried out by means of the ^R
35403 and ^S keystrokes, which default to a reverse and a forward search,
35404 respectively. The search covers only the text that is displayed in the window.
35405 It cannot go further back up the log.
35406
35407 The point from which the search starts is indicated by a caret marker. This is
35408 normally at the end of the text in the window, but can be positioned explicitly
35409 by pointing and clicking with the left mouse button, and is moved automatically
35410 by a successful search. If new text arrives in the window when it is scrolled
35411 back, the caret remains where it is, but if the window is not scrolled back,
35412 the caret is moved to the end of the new text.
35413
35414 Pressing ^R or ^S pops up a window into which the search text can be typed.
35415 There are buttons for selecting forward or reverse searching, for carrying out
35416 the search, and for cancelling. If the &"Search"& button is pressed, the search
35417 happens and the window remains so that further searches can be done. If the
35418 &"Return"& key is pressed, a single search is done and the window is closed. If
35419 ^C is typed the search is cancelled.
35420
35421 The searching facility is implemented using the facilities of the Athena text
35422 widget. By default this pops up a window containing both &"search"& and
35423 &"replace"& options. In order to suppress the unwanted &"replace"& portion for
35424 eximon, a modified version of the &%TextPop%& widget is distributed with Exim.
35425 However, the linkers in BSDI and HP-UX seem unable to handle an externally
35426 provided version of &%TextPop%& when the remaining parts of the text widget
35427 come from the standard libraries. The compile-time option EXIMON_TEXTPOP can be
35428 unset to cut out the modified &%TextPop%&, making it possible to build Eximon
35429 on these systems, at the expense of having unwanted items in the search popup
35430 window.
35431
35432
35433
35434 .section "The queue display" "SECID268"
35435 .cindex "queue" "display in monitor"
35436 The bottom section of the monitor window contains a list of all messages that
35437 are on the queue, which includes those currently being received or delivered,
35438 as well as those awaiting delivery. The size of this subwindow is controlled by
35439 parameters in the configuration file &_Local/eximon.conf_&, and the frequency
35440 at which it is updated is controlled by another parameter in the same file &--
35441 the default is 5 minutes, since queue scans can be quite expensive. However,
35442 there is an &"Update"& action button just above the display which can be used
35443 to force an update of the queue display at any time.
35444
35445 When a host is down for some time, a lot of pending mail can build up for it,
35446 and this can make it hard to deal with other messages on the queue. To help
35447 with this situation there is a button next to &"Update"& called &"Hide"&. If
35448 pressed, a dialogue box called &"Hide addresses ending with"& is put up. If you
35449 type anything in here and press &"Return"&, the text is added to a chain of
35450 such texts, and if every undelivered address in a message matches at least one
35451 of the texts, the message is not displayed.
35452
35453 If there is an address that does not match any of the texts, all the addresses
35454 are displayed as normal. The matching happens on the ends of addresses so, for
35455 example, &'cam.ac.uk'& specifies all addresses in Cambridge, while
35456 &'xxx@foo.com.example'& specifies just one specific address. When any hiding
35457 has been set up, a button called &"Unhide"& is displayed. If pressed, it
35458 cancels all hiding. Also, to ensure that hidden messages do not get forgotten,
35459 a hide request is automatically cancelled after one hour.
35460
35461 While the dialogue box is displayed, you can't press any buttons or do anything
35462 else to the monitor window. For this reason, if you want to cut text from the
35463 queue display to use in the dialogue box, you have to do the cutting before
35464 pressing the &"Hide"& button.
35465
35466 The queue display contains, for each unhidden queued message, the length of
35467 time it has been on the queue, the size of the message, the message id, the
35468 message sender, and the first undelivered recipient, all on one line. If it is
35469 a bounce message, the sender is shown as &"<>"&. If there is more than one
35470 recipient to which the message has not yet been delivered, subsequent ones are
35471 listed on additional lines, up to a maximum configured number, following which
35472 an ellipsis is displayed. Recipients that have already received the message are
35473 not shown.
35474
35475 .cindex "frozen messages" "display"
35476 If a message is frozen, an asterisk is displayed at the left-hand side.
35477
35478 The queue display has a vertical scroll bar, and can also be scrolled by means
35479 of the arrow keys. Text can be cut from it using the mouse in the normal way.
35480 The text searching facilities, as described above for the log window, are also
35481 available, but the caret is always moved to the end of the text when the queue
35482 display is updated.
35483
35484
35485
35486 .section "The queue menu" "SECID269"
35487 .cindex "queue" "menu in monitor"
35488 If the &%shift%& key is held down and the left button is clicked when the mouse
35489 pointer is over the text for any message, an action menu pops up, and the first
35490 line of the queue display for the message is highlighted. This does not affect
35491 any selected text.
35492
35493 If you want to use some other event for popping up the menu, you can set the
35494 MENU_EVENT parameter in &_Local/eximon.conf_& to change the default, or
35495 set EXIMON_MENU_EVENT in the environment before starting the monitor. The
35496 value set in this parameter is a standard X event description. For example, to
35497 run eximon using &%ctrl%& rather than &%shift%& you could use
35498 .code
35499 EXIMON_MENU_EVENT='Ctrl<Btn1Down>' eximon
35500 .endd
35501 The title of the menu is the message id, and it contains entries which act as
35502 follows:
35503
35504 .ilist
35505 &'message log'&: The contents of the message log for the message are displayed
35506 in a new text window.
35507 .next
35508 &'headers'&: Information from the spool file that contains the envelope
35509 information and headers is displayed in a new text window. See chapter
35510 &<<CHAPspool>>& for a description of the format of spool files.
35511 .next
35512 &'body'&: The contents of the spool file containing the body of the message are
35513 displayed in a new text window. There is a default limit of 20,000 bytes to the
35514 amount of data displayed. This can be changed by setting the BODY_MAX
35515 option at compile time, or the EXIMON_BODY_MAX option at run time.
35516 .next
35517 &'deliver message'&: A call to Exim is made using the &%-M%& option to request
35518 delivery of the message. This causes an automatic thaw if the message is
35519 frozen. The &%-v%& option is also set, and the output from Exim is displayed in
35520 a new text window. The delivery is run in a separate process, to avoid holding
35521 up the monitor while the delivery proceeds.
35522 .next
35523 &'freeze message'&: A call to Exim is made using the &%-Mf%& option to request
35524 that the message be frozen.
35525 .next
35526 .cindex "thawing messages"
35527 .cindex "unfreezing messages"
35528 .cindex "frozen messages" "thawing"
35529 &'thaw message'&: A call to Exim is made using the &%-Mt%& option to request
35530 that the message be thawed.
35531 .next
35532 .cindex "delivery" "forcing failure"
35533 &'give up on msg'&: A call to Exim is made using the &%-Mg%& option to request
35534 that Exim gives up trying to deliver the message. A bounce message is generated
35535 for any remaining undelivered addresses.
35536 .next
35537 &'remove message'&: A call to Exim is made using the &%-Mrm%& option to request
35538 that the message be deleted from the system without generating a bounce
35539 message.
35540 .next
35541 &'add recipient'&: A dialog box is displayed into which a recipient address can
35542 be typed. If the address is not qualified and the QUALIFY_DOMAIN parameter
35543 is set in &_Local/eximon.conf_&, the address is qualified with that domain.
35544 Otherwise it must be entered as a fully qualified address. Pressing RETURN
35545 causes a call to Exim to be made using the &%-Mar%& option to request that an
35546 additional recipient be added to the message, unless the entry box is empty, in
35547 which case no action is taken.
35548 .next
35549 &'mark delivered'&: A dialog box is displayed into which a recipient address
35550 can be typed. If the address is not qualified and the QUALIFY_DOMAIN parameter
35551 is set in &_Local/eximon.conf_&, the address is qualified with that domain.
35552 Otherwise it must be entered as a fully qualified address. Pressing RETURN
35553 causes a call to Exim to be made using the &%-Mmd%& option to mark the given
35554 recipient address as already delivered, unless the entry box is empty, in which
35555 case no action is taken.
35556 .next
35557 &'mark all delivered'&: A call to Exim is made using the &%-Mmad%& option to
35558 mark all recipient addresses as already delivered.
35559 .next
35560 &'edit sender'&: A dialog box is displayed initialized with the current
35561 sender's address. Pressing RETURN causes a call to Exim to be made using the
35562 &%-Mes%& option to replace the sender address, unless the entry box is empty,
35563 in which case no action is taken. If you want to set an empty sender (as in
35564 bounce messages), you must specify it as &"<>"&. Otherwise, if the address is
35565 not qualified and the QUALIFY_DOMAIN parameter is set in &_Local/eximon.conf_&,
35566 the address is qualified with that domain.
35567 .endlist
35568
35569 When a delivery is forced, a window showing the &%-v%& output is displayed. In
35570 other cases when a call to Exim is made, if there is any output from Exim (in
35571 particular, if the command fails) a window containing the command and the
35572 output is displayed. Otherwise, the results of the action are normally apparent
35573 from the log and queue displays. However, if you set ACTION_OUTPUT=yes in
35574 &_Local/eximon.conf_&, a window showing the Exim command is always opened, even
35575 if no output is generated.
35576
35577 The queue display is automatically updated for actions such as freezing and
35578 thawing, unless ACTION_QUEUE_UPDATE=no has been set in
35579 &_Local/eximon.conf_&. In this case the &"Update"& button has to be used to
35580 force an update of the display after one of these actions.
35581
35582 In any text window that is displayed as result of a menu action, the normal
35583 cut-and-paste facility is available, and searching can be carried out using ^R
35584 and ^S, as described above for the log tail window.
35585 .ecindex IIDeximon
35586
35587
35588
35589
35590
35591 . ////////////////////////////////////////////////////////////////////////////
35592 . ////////////////////////////////////////////////////////////////////////////
35593
35594 .chapter "Security considerations" "CHAPsecurity"
35595 .scindex IIDsecurcon "security" "discussion of"
35596 This chapter discusses a number of issues concerned with security, some of
35597 which are also covered in other parts of this manual.
35598
35599 For reasons that this author does not understand, some people have promoted
35600 Exim as a &"particularly secure"& mailer. Perhaps it is because of the
35601 existence of this chapter in the documentation. However, the intent of the
35602 chapter is simply to describe the way Exim works in relation to certain
35603 security concerns, not to make any specific claims about the effectiveness of
35604 its security as compared with other MTAs.
35605
35606 What follows is a description of the way Exim is supposed to be. Best efforts
35607 have been made to try to ensure that the code agrees with the theory, but an
35608 absence of bugs can never be guaranteed. Any that are reported will get fixed
35609 as soon as possible.
35610
35611
35612 .section "Building a more &""hardened""& Exim" "SECID286"
35613 .cindex "security" "build-time features"
35614 There are a number of build-time options that can be set in &_Local/Makefile_&
35615 to create Exim binaries that are &"harder"& to attack, in particular by a rogue
35616 Exim administrator who does not have the root password, or by someone who has
35617 penetrated the Exim (but not the root) account. These options are as follows:
35618
35619 .ilist
35620 ALT_CONFIG_PREFIX can be set to a string that is required to match the
35621 start of any file names used with the &%-C%& option. When it is set, these file
35622 names are also not allowed to contain the sequence &"/../"&. (However, if the
35623 value of the &%-C%& option is identical to the value of CONFIGURE_FILE in
35624 &_Local/Makefile_&, Exim ignores &%-C%& and proceeds as usual.) There is no
35625 default setting for &%ALT_CONFIG_PREFIX%&.
35626
35627 If the permitted configuration files are confined to a directory to
35628 which only root has access, this guards against someone who has broken
35629 into the Exim account from running a privileged Exim with an arbitrary
35630 configuration file, and using it to break into other accounts.
35631 .next
35632
35633 If a non-trusted configuration file (i.e. not the default configuration file
35634 or one which is trusted by virtue of being listed in the TRUSTED_CONFIG_LIST
35635 file) is specified with &%-C%&, or if macros are given with &%-D%& (but see
35636 the next item), then root privilege is retained only if the caller of Exim is
35637 root. This locks out the possibility of testing a configuration using &%-C%&
35638 right through message reception and delivery, even if the caller is root. The
35639 reception works, but by that time, Exim is running as the Exim user, so when
35640 it re-execs to regain privilege for the delivery, the use of &%-C%& causes
35641 privilege to be lost. However, root can test reception and delivery using two
35642 separate commands.
35643
35644 .next
35645 The WHITELIST_D_MACROS build option declares some macros to be safe to override
35646 with &%-D%& if the real uid is one of root, the Exim run-time user or the
35647 CONFIGURE_OWNER, if defined.  The potential impact of this option is limited by
35648 requiring the run-time value supplied to &%-D%& to match a regex that errs on
35649 the restrictive side.  Requiring build-time selection of safe macros is onerous
35650 but this option is intended solely as a transition mechanism to permit
35651 previously-working configurations to continue to work after release 4.73.
35652 .next
35653 If DISABLE_D_OPTION is defined, the use of the &%-D%& command line option
35654 is disabled.
35655 .next
35656 FIXED_NEVER_USERS can be set to a colon-separated list of users that are
35657 never to be used for any deliveries. This is like the &%never_users%& runtime
35658 option, but it cannot be overridden; the runtime option adds additional users
35659 to the list. The default setting is &"root"&; this prevents a non-root user who
35660 is permitted to modify the runtime file from using Exim as a way to get root.
35661 .endlist
35662
35663
35664
35665 .section "Root privilege" "SECID270"
35666 .cindex "setuid"
35667 .cindex "root privilege"
35668 The Exim binary is normally setuid to root, which means that it gains root
35669 privilege (runs as root) when it starts execution. In some special cases (for
35670 example, when the daemon is not in use and there are no local deliveries), it
35671 may be possible to run Exim setuid to some user other than root. This is
35672 discussed in the next section. However, in most installations, root privilege
35673 is required for two things:
35674
35675 .ilist
35676 To set up a socket connected to the standard SMTP port (25) when initialising
35677 the listening daemon. If Exim is run from &'inetd'&, this privileged action is
35678 not required.
35679 .next
35680 To be able to change uid and gid in order to read users' &_.forward_& files and
35681 perform local deliveries as the receiving user or as specified in the
35682 configuration.
35683 .endlist
35684
35685 It is not necessary to be root to do any of the other things Exim does, such as
35686 receiving messages and delivering them externally over SMTP, and it is
35687 obviously more secure if Exim does not run as root except when necessary.
35688 For this reason, a user and group for Exim to use must be defined in
35689 &_Local/Makefile_&. These are known as &"the Exim user"& and &"the Exim
35690 group"&. Their values can be changed by the run time configuration, though this
35691 is not recommended. Often a user called &'exim'& is used, but some sites use
35692 &'mail'& or another user name altogether.
35693
35694 Exim uses &[setuid()]& whenever it gives up root privilege. This is a permanent
35695 abdication; the process cannot regain root afterwards. Prior to release 4.00,
35696 &[seteuid()]& was used in some circumstances, but this is no longer the case.
35697
35698 After a new Exim process has interpreted its command line options, it changes
35699 uid and gid in the following cases:
35700
35701 .ilist
35702 .oindex "&%-C%&"
35703 .oindex "&%-D%&"
35704 If the &%-C%& option is used to specify an alternate configuration file, or if
35705 the &%-D%& option is used to define macro values for the configuration, and the
35706 calling process is not running as root, the uid and gid are changed to those of
35707 the calling process.
35708 However, if DISABLE_D_OPTION is defined in &_Local/Makefile_&, the &%-D%&
35709 option may not be used at all.
35710 If WHITELIST_D_MACROS is defined in &_Local/Makefile_&, then some macro values
35711 can be supplied if the calling process is running as root, the Exim run-time
35712 user or CONFIGURE_OWNER, if defined.
35713 .next
35714 .oindex "&%-be%&"
35715 .oindex "&%-bf%&"
35716 .oindex "&%-bF%&"
35717 If the expansion test option (&%-be%&) or one of the filter testing options
35718 (&%-bf%& or &%-bF%&) are used, the uid and gid are changed to those of the
35719 calling process.
35720 .next
35721 If the process is not a daemon process or a queue runner process or a delivery
35722 process or a process for testing address routing (started with &%-bt%&), the
35723 uid and gid are changed to the Exim user and group. This means that Exim always
35724 runs under its own uid and gid when receiving messages. This also applies when
35725 testing address verification
35726 .oindex "&%-bv%&"
35727 .oindex "&%-bh%&"
35728 (the &%-bv%& option) and testing incoming message policy controls (the &%-bh%&
35729 option).
35730 .next
35731 For a daemon, queue runner, delivery, or address testing process, the uid
35732 remains as root at this stage, but the gid is changed to the Exim group.
35733 .endlist
35734
35735 The processes that initially retain root privilege behave as follows:
35736
35737 .ilist
35738 A daemon process changes the gid to the Exim group and the uid to the Exim
35739 user after setting up one or more listening sockets. The &[initgroups()]&
35740 function is called, so that if the Exim user is in any additional groups, they
35741 will be used during message reception.
35742 .next
35743 A queue runner process retains root privilege throughout its execution. Its
35744 job is to fork a controlled sequence of delivery processes.
35745 .next
35746 A delivery process retains root privilege throughout most of its execution,
35747 but any actual deliveries (that is, the transports themselves) are run in
35748 subprocesses which always change to a non-root uid and gid. For local
35749 deliveries this is typically the uid and gid of the owner of the mailbox; for
35750 remote deliveries, the Exim uid and gid are used. Once all the delivery
35751 subprocesses have been run, a delivery process changes to the Exim uid and gid
35752 while doing post-delivery tidying up such as updating the retry database and
35753 generating bounce and warning messages.
35754
35755 While the recipient addresses in a message are being routed, the delivery
35756 process runs as root. However, if a user's filter file has to be processed,
35757 this is done in a subprocess that runs under the individual user's uid and
35758 gid. A system filter is run as root unless &%system_filter_user%& is set.
35759 .next
35760 A process that is testing addresses (the &%-bt%& option) runs as root so that
35761 the routing is done in the same environment as a message delivery.
35762 .endlist
35763
35764
35765
35766
35767 .section "Running Exim without privilege" "SECTrunexiwitpri"
35768 .cindex "privilege, running without"
35769 .cindex "unprivileged running"
35770 .cindex "root privilege" "running without"
35771 Some installations like to run Exim in an unprivileged state for more of its
35772 operation, for added security. Support for this mode of operation is provided
35773 by the global option &%deliver_drop_privilege%&. When this is set, the uid and
35774 gid are changed to the Exim user and group at the start of a delivery process
35775 (and also queue runner and address testing processes). This means that address
35776 routing is no longer run as root, and the deliveries themselves cannot change
35777 to any other uid.
35778
35779 .cindex SIGHUP
35780 .cindex "daemon" "restarting"
35781 Leaving the binary setuid to root, but setting &%deliver_drop_privilege%& means
35782 that the daemon can still be started in the usual way, and it can respond
35783 correctly to SIGHUP because the re-invocation regains root privilege.
35784
35785 An alternative approach is to make Exim setuid to the Exim user and also setgid
35786 to the Exim group. If you do this, the daemon must be started from a root
35787 process. (Calling Exim from a root process makes it behave in the way it does
35788 when it is setuid root.) However, the daemon cannot restart itself after a
35789 SIGHUP signal because it cannot regain privilege.
35790
35791 It is still useful to set &%deliver_drop_privilege%& in this case, because it
35792 stops Exim from trying to re-invoke itself to do a delivery after a message has
35793 been received. Such a re-invocation is a waste of resources because it has no
35794 effect.
35795
35796 If restarting the daemon is not an issue (for example, if &%mua_wrapper%& is
35797 set, or &'inetd'& is being used instead of a daemon), having the binary setuid
35798 to the Exim user seems a clean approach, but there is one complication:
35799
35800 In this style of operation, Exim is running with the real uid and gid set to
35801 those of the calling process, and the effective uid/gid set to Exim's values.
35802 Ideally, any association with the calling process' uid/gid should be dropped,
35803 that is, the real uid/gid should be reset to the effective values so as to
35804 discard any privileges that the caller may have. While some operating systems
35805 have a function that permits this action for a non-root effective uid, quite a
35806 number of them do not. Because of this lack of standardization, Exim does not
35807 address this problem at this time.
35808
35809 For this reason, the recommended approach for &"mostly unprivileged"& running
35810 is to keep the Exim binary setuid to root, and to set
35811 &%deliver_drop_privilege%&. This also has the advantage of allowing a daemon to
35812 be used in the most straightforward way.
35813
35814 If you configure Exim not to run delivery processes as root, there are a
35815 number of restrictions on what you can do:
35816
35817 .ilist
35818 You can deliver only as the Exim user/group. You should  explicitly use the
35819 &%user%& and &%group%& options to override routers or local transports that
35820 normally deliver as the recipient. This makes sure that configurations that
35821 work in this mode function the same way in normal mode. Any implicit or
35822 explicit specification of another user causes an error.
35823 .next
35824 Use of &_.forward_& files is severely restricted, such that it is usually
35825 not worthwhile to include them in the configuration.
35826 .next
35827 Users who wish to use &_.forward_& would have to make their home directory and
35828 the file itself accessible to the Exim user. Pipe and append-to-file entries,
35829 and their equivalents in Exim filters, cannot be used. While they could be
35830 enabled in the Exim user's name, that would be insecure and not very useful.
35831 .next
35832 Unless the local user mailboxes are all owned by the Exim user (possible in
35833 some POP3 or IMAP-only environments):
35834
35835 .olist
35836 They must be owned by the Exim group and be writeable by that group. This
35837 implies you must set &%mode%& in the appendfile configuration, as well as the
35838 mode of the mailbox files themselves.
35839 .next
35840 You must set &%no_check_owner%&, since most or all of the files will not be
35841 owned by the Exim user.
35842 .next
35843 You must set &%file_must_exist%&, because Exim cannot set the owner correctly
35844 on a newly created mailbox when unprivileged. This also implies that new
35845 mailboxes need to be created manually.
35846 .endlist olist
35847 .endlist ilist
35848
35849
35850 These restrictions severely restrict what can be done in local deliveries.
35851 However, there are no restrictions on remote deliveries. If you are running a
35852 gateway host that does no local deliveries, setting &%deliver_drop_privilege%&
35853 gives more security at essentially no cost.
35854
35855 If you are using the &%mua_wrapper%& facility (see chapter
35856 &<<CHAPnonqueueing>>&), &%deliver_drop_privilege%& is forced to be true.
35857
35858
35859
35860
35861 .section "Delivering to local files" "SECID271"
35862 Full details of the checks applied by &(appendfile)& before it writes to a file
35863 are given in chapter &<<CHAPappendfile>>&.
35864
35865
35866
35867 .section "Running local commands" "SECTsecconslocalcmds"
35868 .cindex "security" "local commands"
35869 .cindex "security" "command injection attacks"
35870 There are a number of ways in which an administrator can configure Exim to run
35871 commands based upon received, untrustworthy, data. Further, in some
35872 configurations a user who can control a &_.forward_& file can also arrange to
35873 run commands. Configuration to check includes, but is not limited to:
35874
35875 .ilist
35876 Use of &%use_shell%& in the pipe transport: various forms of shell command
35877 injection may be possible with this option present. It is dangerous and should
35878 be used only with considerable caution. Consider constraints which whitelist
35879 allowed characters in a variable which is to be used in a pipe transport that
35880 has &%use_shell%& enabled.
35881 .next
35882 A number of options such as &%forbid_filter_run%&, &%forbid_filter_perl%&,
35883 &%forbid_filter_dlfunc%& and so forth which restrict facilities available to
35884 &_.forward_& files in a redirect router. If Exim is running on a central mail
35885 hub to which ordinary users do not have shell access, but home directories are
35886 NFS mounted (for instance) then administrators should review the list of these
35887 forbid options available, and should bear in mind that the options that may
35888 need forbidding can change as new features are added between releases.
35889 .next
35890 The &%${run...}%& expansion item does not use a shell by default, but
35891 administrators can configure use of &_/bin/sh_& as part of the command.
35892 Such invocations should be viewed with prejudicial suspicion.
35893 .next
35894 Administrators who use embedded Perl are advised to explore how Perl's
35895 taint checking might apply to their usage.
35896 .next
35897 Use of &%${expand...}%& is somewhat analagous to shell's eval builtin and
35898 administrators are well advised to view its use with suspicion, in case (for
35899 instance) it allows a local-part to contain embedded Exim directives.
35900 .next
35901 Use of &%${match_local_part...}%& and friends becomes more dangerous if
35902 Exim was built with EXPAND_LISTMATCH_RHS defined: the second string in
35903 each can reference arbitrary lists and files, rather than just being a list
35904 of opaque strings.
35905 The EXPAND_LISTMATCH_RHS option was added and set false by default because of
35906 real-world security vulnerabilities caused by its use with untrustworthy data
35907 injected in, for SQL injection attacks.
35908 Consider the use of the &%inlisti%& expansion condition instead.
35909 .endlist
35910
35911
35912
35913
35914 .section "Trust in configuration data" "SECTsecconfdata"
35915 .cindex "security" "data sources"
35916 .cindex "security" "regular expressions"
35917 .cindex "regular expressions" "security"
35918 .cindex "PCRE" "security"
35919 If configuration data for Exim can come from untrustworthy sources, there
35920 are some issues to be aware of:
35921
35922 .ilist
35923 Use of &%${expand...}%& may provide a path for shell injection attacks.
35924 .next
35925 Letting untrusted data provide a regular expression is unwise.
35926 .next
35927 Using &%${match...}%& to apply a fixed regular expression against untrusted
35928 data may result in pathological behaviour within PCRE.  Be aware of what
35929 "backtracking" means and consider options for being more strict with a regular
35930 expression. Avenues to explore include limiting what can match (avoiding &`.`&
35931 when &`[a-z0-9]`& or other character class will do), use of atomic grouping and
35932 possessive quantifiers or just not using regular expressions against untrusted
35933 data.
35934 .next
35935 It can be important to correctly use &%${quote:...}%&,
35936 &%${quote_local_part:...}%& and &%${quote_%&<&'lookup-type'&>&%:...}%& expansion
35937 items to ensure that data is correctly constructed.
35938 .next
35939 Some lookups might return multiple results, even though normal usage is only
35940 expected to yield one result.
35941 .endlist
35942
35943
35944
35945
35946 .section "IPv4 source routing" "SECID272"
35947 .cindex "source routing" "in IP packets"
35948 .cindex "IP source routing"
35949 Many operating systems suppress IP source-routed packets in the kernel, but
35950 some cannot be made to do this, so Exim does its own check. It logs incoming
35951 IPv4 source-routed TCP calls, and then drops them. Things are all different in
35952 IPv6. No special checking is currently done.
35953
35954
35955
35956 .section "The VRFY, EXPN, and ETRN commands in SMTP" "SECID273"
35957 Support for these SMTP commands is disabled by default. If required, they can
35958 be enabled by defining suitable ACLs.
35959
35960
35961
35962
35963 .section "Privileged users" "SECID274"
35964 .cindex "trusted users"
35965 .cindex "admin user"
35966 .cindex "privileged user"
35967 .cindex "user" "trusted"
35968 .cindex "user" "admin"
35969 Exim recognizes two sets of users with special privileges. Trusted users are
35970 able to submit new messages to Exim locally, but supply their own sender
35971 addresses and information about a sending host. For other users submitting
35972 local messages, Exim sets up the sender address from the uid, and doesn't
35973 permit a remote host to be specified.
35974
35975 .oindex "&%-f%&"
35976 However, an untrusted user is permitted to use the &%-f%& command line option
35977 in the special form &%-f <>%& to indicate that a delivery failure for the
35978 message should not cause an error report. This affects the message's envelope,
35979 but it does not affect the &'Sender:'& header. Untrusted users may also be
35980 permitted to use specific forms of address with the &%-f%& option by setting
35981 the &%untrusted_set_sender%& option.
35982
35983 Trusted users are used to run processes that receive mail messages from some
35984 other mail domain and pass them on to Exim for delivery either locally, or over
35985 the Internet. Exim trusts a caller that is running as root, as the Exim user,
35986 as any user listed in the &%trusted_users%& configuration option, or under any
35987 group listed in the &%trusted_groups%& option.
35988
35989 Admin users are permitted to do things to the messages on Exim's queue. They
35990 can freeze or thaw messages, cause them to be returned to their senders, remove
35991 them entirely, or modify them in various ways. In addition, admin users can run
35992 the Exim monitor and see all the information it is capable of providing, which
35993 includes the contents of files on the spool.
35994
35995 .oindex "&%-M%&"
35996 .oindex "&%-q%&"
35997 By default, the use of the &%-M%& and &%-q%& options to cause Exim to attempt
35998 delivery of messages on its queue is restricted to admin users. This
35999 restriction can be relaxed by setting the &%no_prod_requires_admin%& option.
36000 Similarly, the use of &%-bp%& (and its variants) to list the contents of the
36001 queue is also restricted to admin users. This restriction can be relaxed by
36002 setting &%no_queue_list_requires_admin%&.
36003
36004 Exim recognizes an admin user if the calling process is running as root or as
36005 the Exim user or if any of the groups associated with the calling process is
36006 the Exim group. It is not necessary actually to be running under the Exim
36007 group. However, if admin users who are not root or the Exim user are to access
36008 the contents of files on the spool via the Exim monitor (which runs
36009 unprivileged), Exim must be built to allow group read access to its spool
36010 files.
36011
36012
36013
36014 .section "Spool files" "SECID275"
36015 .cindex "spool directory" "files"
36016 Exim's spool directory and everything it contains is owned by the Exim user and
36017 set to the Exim group. The mode for spool files is defined in the
36018 &_Local/Makefile_& configuration file, and defaults to 0640. This means that
36019 any user who is a member of the Exim group can access these files.
36020
36021
36022
36023 .section "Use of argv[0]" "SECID276"
36024 Exim examines the last component of &%argv[0]%&, and if it matches one of a set
36025 of specific strings, Exim assumes certain options. For example, calling Exim
36026 with the last component of &%argv[0]%& set to &"rsmtp"& is exactly equivalent
36027 to calling it with the option &%-bS%&. There are no security implications in
36028 this.
36029
36030
36031
36032 .section "Use of %f formatting" "SECID277"
36033 The only use made of &"%f"& by Exim is in formatting load average values. These
36034 are actually stored in integer variables as 1000 times the load average.
36035 Consequently, their range is limited and so therefore is the length of the
36036 converted output.
36037
36038
36039
36040 .section "Embedded Exim path" "SECID278"
36041 Exim uses its own path name, which is embedded in the code, only when it needs
36042 to re-exec in order to regain root privilege. Therefore, it is not root when it
36043 does so. If some bug allowed the path to get overwritten, it would lead to an
36044 arbitrary program's being run as exim, not as root.
36045
36046
36047
36048 .section "Dynamic module directory" "SECTdynmoddir"
36049 Any dynamically loadable modules must be installed into the directory
36050 defined in &`LOOKUP_MODULE_DIR`& in &_Local/Makefile_& for Exim to permit
36051 loading it.
36052
36053
36054 .section "Use of sprintf()" "SECID279"
36055 .cindex "&[sprintf()]&"
36056 A large number of occurrences of &"sprintf"& in the code are actually calls to
36057 &'string_sprintf()'&, a function that returns the result in malloc'd store.
36058 The intermediate formatting is done into a large fixed buffer by a function
36059 that runs through the format string itself, and checks the length of each
36060 conversion before performing it, thus preventing buffer overruns.
36061
36062 The remaining uses of &[sprintf()]& happen in controlled circumstances where
36063 the output buffer is known to be sufficiently long to contain the converted
36064 string.
36065
36066
36067
36068 .section "Use of debug_printf() and log_write()" "SECID280"
36069 Arbitrary strings are passed to both these functions, but they do their
36070 formatting by calling the function &'string_vformat()'&, which runs through
36071 the format string itself, and checks the length of each conversion.
36072
36073
36074
36075 .section "Use of strcat() and strcpy()" "SECID281"
36076 These are used only in cases where the output buffer is known to be large
36077 enough to hold the result.
36078 .ecindex IIDsecurcon
36079
36080
36081
36082
36083 . ////////////////////////////////////////////////////////////////////////////
36084 . ////////////////////////////////////////////////////////////////////////////
36085
36086 .chapter "Format of spool files" "CHAPspool"
36087 .scindex IIDforspo1 "format" "spool files"
36088 .scindex IIDforspo2 "spool directory" "format of files"
36089 .scindex IIDforspo3 "spool files" "format of"
36090 .cindex "spool files" "editing"
36091 A message on Exim's queue consists of two files, whose names are the message id
36092 followed by -D and -H, respectively. The data portion of the message is kept in
36093 the -D file on its own. The message's envelope, status, and headers are all
36094 kept in the -H file, whose format is described in this chapter. Each of these
36095 two files contains the final component of its own name as its first line. This
36096 is insurance against disk crashes where the directory is lost but the files
36097 themselves are recoverable.
36098
36099 Some people are tempted into editing -D files in order to modify messages. You
36100 need to be extremely careful if you do this; it is not recommended and you are
36101 on your own if you do it. Here are some of the pitfalls:
36102
36103 .ilist
36104 You must ensure that Exim does not try to deliver the message while you are
36105 fiddling with it. The safest way is to take out a write lock on the -D file,
36106 which is what Exim itself does, using &[fcntl()]&. If you update the file in
36107 place, the lock will be retained. If you write a new file and rename it, the
36108 lock will be lost at the instant of rename.
36109 .next
36110 .vindex "&$body_linecount$&"
36111 If you change the number of lines in the file, the value of
36112 &$body_linecount$&, which is stored in the -H file, will be incorrect. At
36113 present, this value is not used by Exim, but there is no guarantee that this
36114 will always be the case.
36115 .next
36116 If the message is in MIME format, you must take care not to break it.
36117 .next
36118 If the message is cryptographically signed, any change will invalidate the
36119 signature.
36120 .endlist
36121 All in all, modifying -D files is fraught with danger.
36122
36123 Files whose names end with -J may also be seen in the &_input_& directory (or
36124 its subdirectories when &%split_spool_directory%& is set). These are journal
36125 files, used to record addresses to which the message has been delivered during
36126 the course of a delivery attempt. If there are still undelivered recipients at
36127 the end, the -H file is updated, and the -J file is deleted. If, however, there
36128 is some kind of crash (for example, a power outage) before this happens, the -J
36129 file remains in existence. When Exim next processes the message, it notices the
36130 -J file and uses it to update the -H file before starting the next delivery
36131 attempt.
36132
36133 .section "Format of the -H file" "SECID282"
36134 .cindex "uid (user id)" "in spool file"
36135 .cindex "gid (group id)" "in spool file"
36136 The second line of the -H file contains the login name for the uid of the
36137 process that called Exim to read the message, followed by the numerical uid and
36138 gid. For a locally generated message, this is normally the user who sent the
36139 message. For a message received over TCP/IP via the daemon, it is
36140 normally the Exim user.
36141
36142 The third line of the file contains the address of the message's sender as
36143 transmitted in the envelope, contained in angle brackets. The sender address is
36144 empty for bounce messages. For incoming SMTP mail, the sender address is given
36145 in the MAIL command. For locally generated mail, the sender address is
36146 created by Exim from the login name of the current user and the configured
36147 &%qualify_domain%&. However, this can be overridden by the &%-f%& option or a
36148 leading &"From&~"& line if the caller is trusted, or if the supplied address is
36149 &"<>"& or an address that matches &%untrusted_set_senders%&.
36150
36151 The fourth line contains two numbers. The first is the time that the message
36152 was received, in the conventional Unix form &-- the number of seconds since the
36153 start of the epoch. The second number is a count of the number of messages
36154 warning of delayed delivery that have been sent to the sender.
36155
36156 There follow a number of lines starting with a hyphen. These can appear in any
36157 order, and are omitted when not relevant:
36158
36159 .vlist
36160 .vitem "&%-acl%&&~<&'number'&>&~<&'length'&>"
36161 This item is obsolete, and is not generated from Exim release 4.61 onwards;
36162 &%-aclc%& and &%-aclm%& are used instead. However, &%-acl%& is still
36163 recognized, to provide backward compatibility. In the old format, a line of
36164 this form is present for every ACL variable that is not empty. The number
36165 identifies the variable; the &%acl_c%&&*x*& variables are numbered 0&--9 and
36166 the &%acl_m%&&*x*& variables are numbered 10&--19. The length is the length of
36167 the data string for the variable. The string itself starts at the beginning of
36168 the next line, and is followed by a newline character. It may contain internal
36169 newlines.
36170
36171 .vitem "&%-aclc%&&~<&'rest-of-name'&>&~<&'length'&>"
36172 A line of this form is present for every ACL connection variable that is
36173 defined. Note that there is a space between &%-aclc%& and the rest of the name.
36174 The length is the length of the data string for the variable. The string itself
36175 starts at the beginning of the next line, and is followed by a newline
36176 character. It may contain internal newlines.
36177
36178 .vitem "&%-aclm%&&~<&'rest-of-name'&>&~<&'length'&>"
36179 A line of this form is present for every ACL message variable that is defined.
36180 Note that there is a space between &%-aclm%& and the rest of the name. The
36181 length is the length of the data string for the variable. The string itself
36182 starts at the beginning of the next line, and is followed by a newline
36183 character. It may contain internal newlines.
36184
36185 .vitem "&%-active_hostname%&&~<&'hostname'&>"
36186 This is present if, when the message was received over SMTP, the value of
36187 &$smtp_active_hostname$& was different to the value of &$primary_hostname$&.
36188
36189 .vitem &%-allow_unqualified_recipient%&
36190 This is present if unqualified recipient addresses are permitted in header
36191 lines (to stop such addresses from being qualified if rewriting occurs at
36192 transport time). Local messages that were input using &%-bnq%& and remote
36193 messages from hosts that match &%recipient_unqualified_hosts%& set this flag.
36194
36195 .vitem &%-allow_unqualified_sender%&
36196 This is present if unqualified sender addresses are permitted in header lines
36197 (to stop such addresses from being qualified if rewriting occurs at transport
36198 time). Local messages that were input using &%-bnq%& and remote messages from
36199 hosts that match &%sender_unqualified_hosts%& set this flag.
36200
36201 .vitem "&%-auth_id%&&~<&'text'&>"
36202 The id information for a message received on an authenticated SMTP connection
36203 &-- the value of the &$authenticated_id$& variable.
36204
36205 .vitem "&%-auth_sender%&&~<&'address'&>"
36206 The address of an authenticated sender &-- the value of the
36207 &$authenticated_sender$& variable.
36208
36209 .vitem "&%-body_linecount%&&~<&'number'&>"
36210 This records the number of lines in the body of the message, and is always
36211 present.
36212
36213 .vitem "&%-body_zerocount%&&~<&'number'&>"
36214 This records the number of binary zero bytes in the body of the message, and is
36215 present if the number is greater than zero.
36216
36217 .vitem &%-deliver_firsttime%&
36218 This is written when a new message is first added to the spool. When the spool
36219 file is updated after a deferral, it is omitted.
36220
36221 .vitem "&%-frozen%&&~<&'time'&>"
36222 .cindex "frozen messages" "spool data"
36223 The message is frozen, and the freezing happened at <&'time'&>.
36224
36225 .vitem "&%-helo_name%&&~<&'text'&>"
36226 This records the host name as specified by a remote host in a HELO or EHLO
36227 command.
36228
36229 .vitem "&%-host_address%&&~<&'address'&>.<&'port'&>"
36230 This records the IP address of the host from which the message was received and
36231 the remote port number that was used. It is omitted for locally generated
36232 messages.
36233
36234 .vitem "&%-host_auth%&&~<&'text'&>"
36235 If the message was received on an authenticated SMTP connection, this records
36236 the name of the authenticator &-- the value of the
36237 &$sender_host_authenticated$& variable.
36238
36239 .vitem &%-host_lookup_failed%&
36240 This is present if an attempt to look up the sending host's name from its IP
36241 address failed. It corresponds to the &$host_lookup_failed$& variable.
36242
36243 .vitem "&%-host_name%&&~<&'text'&>"
36244 .cindex "reverse DNS lookup"
36245 .cindex "DNS" "reverse lookup"
36246 This records the name of the remote host from which the message was received,
36247 if the host name was looked up from the IP address when the message was being
36248 received. It is not present if no reverse lookup was done.
36249
36250 .vitem "&%-ident%&&~<&'text'&>"
36251 For locally submitted messages, this records the login of the originating user,
36252 unless it was a trusted user and the &%-oMt%& option was used to specify an
36253 ident value. For messages received over TCP/IP, this records the ident string
36254 supplied by the remote host, if any.
36255
36256 .vitem "&%-interface_address%&&~<&'address'&>.<&'port'&>"
36257 This records the IP address of the local interface and the port number through
36258 which a message was received from a remote host. It is omitted for locally
36259 generated messages.
36260
36261 .vitem &%-local%&
36262 The message is from a local sender.
36263
36264 .vitem &%-localerror%&
36265 The message is a locally-generated bounce message.
36266
36267 .vitem "&%-local_scan%&&~<&'string'&>"
36268 This records the data string that was returned by the &[local_scan()]& function
36269 when the message was received &-- the value of the &$local_scan_data$&
36270 variable. It is omitted if no data was returned.
36271
36272 .vitem &%-manual_thaw%&
36273 The message was frozen but has been thawed manually, that is, by an explicit
36274 Exim command rather than via the auto-thaw process.
36275
36276 .vitem &%-N%&
36277 A testing delivery process was started using the &%-N%& option to suppress any
36278 actual deliveries, but delivery was deferred. At any further delivery attempts,
36279 &%-N%& is assumed.
36280
36281 .vitem &%-received_protocol%&
36282 This records the value of the &$received_protocol$& variable, which contains
36283 the name of the protocol by which the message was received.
36284
36285 .vitem &%-sender_set_untrusted%&
36286 The envelope sender of this message was set by an untrusted local caller (used
36287 to ensure that the caller is displayed in queue listings).
36288
36289 .vitem "&%-spam_score_int%&&~<&'number'&>"
36290 If a message was scanned by SpamAssassin, this is present. It records the value
36291 of &$spam_score_int$&.
36292
36293 .vitem &%-tls_certificate_verified%&
36294 A TLS certificate was received from the client that sent this message, and the
36295 certificate was verified by the server.
36296
36297 .vitem "&%-tls_cipher%&&~<&'cipher name'&>"
36298 When the message was received over an encrypted connection, this records the
36299 name of the cipher suite that was used.
36300
36301 .vitem "&%-tls_peerdn%&&~<&'peer DN'&>"
36302 When the message was received over an encrypted connection, and a certificate
36303 was received from the client, this records the Distinguished Name from that
36304 certificate.
36305 .endlist
36306
36307 Following the options there is a list of those addresses to which the message
36308 is not to be delivered. This set of addresses is initialized from the command
36309 line when the &%-t%& option is used and &%extract_addresses_remove_arguments%&
36310 is set; otherwise it starts out empty. Whenever a successful delivery is made,
36311 the address is added to this set. The addresses are kept internally as a
36312 balanced binary tree, and it is a representation of that tree which is written
36313 to the spool file. If an address is expanded via an alias or forward file, the
36314 original address is added to the tree when deliveries to all its child
36315 addresses are complete.
36316
36317 If the tree is empty, there is a single line in the spool file containing just
36318 the text &"XX"&. Otherwise, each line consists of two letters, which are either
36319 Y or N, followed by an address. The address is the value for the node of the
36320 tree, and the letters indicate whether the node has a left branch and/or a
36321 right branch attached to it, respectively. If branches exist, they immediately
36322 follow. Here is an example of a three-node tree:
36323 .code
36324 YY darcy@austen.fict.example
36325 NN alice@wonderland.fict.example
36326 NN editor@thesaurus.ref.example
36327 .endd
36328 After the non-recipients tree, there is a list of the message's recipients.
36329 This is a simple list, preceded by a count. It includes all the original
36330 recipients of the message, including those to whom the message has already been
36331 delivered. In the simplest case, the list contains one address per line. For
36332 example:
36333 .code
36334 4
36335 editor@thesaurus.ref.example
36336 darcy@austen.fict.example
36337 rdo@foundation
36338 alice@wonderland.fict.example
36339 .endd
36340 However, when a child address has been added to the top-level addresses as a
36341 result of the use of the &%one_time%& option on a &(redirect)& router, each
36342 line is of the following form:
36343 .display
36344 <&'top-level address'&> <&'errors_to address'&> &&&
36345   <&'length'&>,<&'parent number'&>#<&'flag bits'&>
36346 .endd
36347 The 01 flag bit indicates the presence of the three other fields that follow
36348 the top-level address. Other bits may be used in future to support additional
36349 fields. The <&'parent number'&> is the offset in the recipients list of the
36350 original parent of the &"one time"& address. The first two fields are the
36351 envelope sender that is associated with this address and its length. If the
36352 length is zero, there is no special envelope sender (there are then two space
36353 characters in the line). A non-empty field can arise from a &(redirect)& router
36354 that has an &%errors_to%& setting.
36355
36356
36357 A blank line separates the envelope and status information from the headers
36358 which follow. A header may occupy several lines of the file, and to save effort
36359 when reading it in, each header is preceded by a number and an identifying
36360 character. The number is the number of characters in the header, including any
36361 embedded newlines and the terminating newline. The character is one of the
36362 following:
36363
36364 .table2 50pt
36365 .row <&'blank'&>         "header in which Exim has no special interest"
36366 .row &`B`&               "&'Bcc:'& header"
36367 .row &`C`&               "&'Cc:'& header"
36368 .row &`F`&               "&'From:'& header"
36369 .row &`I`&               "&'Message-id:'& header"
36370 .row &`P`&               "&'Received:'& header &-- P for &""postmark""&"
36371 .row &`R`&               "&'Reply-To:'& header"
36372 .row &`S`&               "&'Sender:'& header"
36373 .row &`T`&               "&'To:'& header"
36374 .row &`*`&               "replaced or deleted header"
36375 .endtable
36376
36377 Deleted or replaced (rewritten) headers remain in the spool file for debugging
36378 purposes. They are not transmitted when the message is delivered. Here is a
36379 typical set of headers:
36380 .code
36381 111P Received: by hobbit.fict.example with local (Exim 4.00)
36382 id 14y9EI-00026G-00; Fri, 11 May 2001 10:28:59 +0100
36383 049  Message-Id: <E14y9EI-00026G-00@hobbit.fict.example>
36384 038* X-rewrote-sender: bb@hobbit.fict.example
36385 042* From: Bilbo Baggins <bb@hobbit.fict.example>
36386 049F From: Bilbo Baggins <B.Baggins@hobbit.fict.example>
36387 099* To: alice@wonderland.fict.example, rdo@foundation,
36388 darcy@austen.fict.example, editor@thesaurus.ref.example
36389 104T To: alice@wonderland.fict.example, rdo@foundation.example,
36390 darcy@austen.fict.example, editor@thesaurus.ref.example
36391 038  Date: Fri, 11 May 2001 10:28:59 +0100
36392 .endd
36393 The asterisked headers indicate that the envelope sender, &'From:'& header, and
36394 &'To:'& header have been rewritten, the last one because routing expanded the
36395 unqualified domain &'foundation'&.
36396 .ecindex IIDforspo1
36397 .ecindex IIDforspo2
36398 .ecindex IIDforspo3
36399
36400 . ////////////////////////////////////////////////////////////////////////////
36401 . ////////////////////////////////////////////////////////////////////////////
36402
36403 .chapter "Support for DKIM (DomainKeys Identified Mail)" "CHAPdkim" &&&
36404          "DKIM Support"
36405 .cindex "DKIM"
36406
36407 DKIM is a mechanism by which messages sent by some entity can be provably
36408 linked to a domain which that entity controls.  It permits reputation to
36409 be tracked on a per-domain basis, rather than merely upon source IP address.
36410 DKIM is documented in RFC 4871.
36411
36412 Since version 4.70, DKIM support is compiled into Exim by default. It can be
36413 disabled by setting DISABLE_DKIM=yes in Local/Makefile.
36414
36415 Exim's DKIM implementation allows to
36416 .olist
36417 Sign outgoing messages: This function is implemented in the SMTP transport.
36418 It can co-exist with all other Exim features
36419 (including transport filters)
36420 except cutthrough delivery.
36421 .next
36422 Verify signatures in incoming messages: This is implemented by an additional
36423 ACL (acl_smtp_dkim), which can be called several times per message, with
36424 different signature contexts.
36425 .endlist
36426
36427 In typical Exim style, the verification implementation does not include any
36428 default "policy". Instead it enables you to build your own policy using
36429 Exim's standard controls.
36430
36431 Please note that verification of DKIM signatures in incoming mail is turned
36432 on by default for logging purposes. For each signature in incoming email,
36433 exim will log a line displaying the most important signature details, and the
36434 signature status. Here is an example (with line-breaks added for clarity):
36435 .code
36436 2009-09-09 10:22:28 1MlIRf-0003LU-U3 DKIM:
36437     d=facebookmail.com s=q1-2009b
36438     c=relaxed/relaxed a=rsa-sha1
36439     i=@facebookmail.com t=1252484542 [verification succeeded]
36440 .endd
36441 You might want to turn off DKIM verification processing entirely for internal
36442 or relay mail sources. To do that, set the &%dkim_disable_verify%& ACL
36443 control modifier. This should typically be done in the RCPT ACL, at points
36444 where you accept mail from relay sources (internal hosts or authenticated
36445 senders).
36446
36447
36448 .section "Signing outgoing messages" "SECID513"
36449 .cindex "DKIM" "signing"
36450
36451 Signing is implemented by setting private options on the SMTP transport.
36452 These options take (expandable) strings as arguments.
36453
36454 .option dkim_domain smtp string&!! unset
36455 MANDATORY:
36456 The domain you want to sign with. The result of this expanded
36457 option is put into the &%$dkim_domain%& expansion variable.
36458
36459 .option dkim_selector smtp string&!! unset
36460 MANDATORY:
36461 This sets the key selector string. You can use the &%$dkim_domain%& expansion
36462 variable to look up a matching selector. The result is put in the expansion
36463 variable &%$dkim_selector%& which should be used in the &%dkim_private_key%&
36464 option along with &%$dkim_domain%&.
36465
36466 .option dkim_private_key smtp string&!! unset
36467 MANDATORY:
36468 This sets the private key to use. You can use the &%$dkim_domain%& and
36469 &%$dkim_selector%& expansion variables to determine the private key to use.
36470 The result can either
36471 .ilist
36472 be a valid RSA private key in ASCII armor, including line breaks.
36473 .next
36474 start with a slash, in which case it is treated as a file that contains
36475 the private key.
36476 .next
36477 be "0", "false" or the empty string, in which case the message will not
36478 be signed. This case will not result in an error, even if &%dkim_strict%&
36479 is set.
36480 .endlist
36481
36482 .option dkim_canon smtp string&!! unset
36483 OPTIONAL:
36484 This option sets the canonicalization method used when signing a message.
36485 The DKIM RFC currently supports two methods: "simple" and "relaxed".
36486 The option defaults to "relaxed" when unset. Note: the current implementation
36487 only supports using the same canonicalization method for both headers and body.
36488
36489 .option dkim_strict smtp string&!! unset
36490 OPTIONAL:
36491 This  option  defines  how  Exim  behaves  when  signing a message that
36492 should be signed fails for some reason.  When the expansion evaluates to
36493 either "1" or "true", Exim will defer. Otherwise Exim will send the message
36494 unsigned. You can use the &%$dkim_domain%& and &%$dkim_selector%& expansion
36495 variables here.
36496
36497 .option dkim_sign_headers smtp string&!! unset
36498 OPTIONAL:
36499 When set, this option must expand to (or be specified as) a colon-separated
36500 list of header names. Headers with these names will be included in the message
36501 signature. When unspecified, the header names recommended in RFC4871 will be
36502 used.
36503
36504
36505 .section "Verifying DKIM signatures in incoming mail" "SECID514"
36506 .cindex "DKIM" "verification"
36507
36508 Verification of DKIM signatures in incoming email is implemented via the
36509 &%acl_smtp_dkim%& ACL. By default, this ACL is called once for each
36510 syntactically(!) correct signature in the incoming message.
36511 A missing ACL definition defaults to accept.
36512 If any ACL call does not acccept, the message is not accepted.
36513 If a cutthrough delivery was in progress for the message it is
36514 summarily dropped (having wasted the transmission effort).
36515
36516 To evaluate the signature in the ACL a large number of expansion variables
36517 containing the signature status and its details are set up during the
36518 runtime of the ACL.
36519
36520 Calling the ACL only for existing signatures is not sufficient to build
36521 more advanced policies. For that reason, the global option
36522 &%dkim_verify_signers%&, and a global expansion variable
36523 &%$dkim_signers%& exist.
36524
36525 The global option &%dkim_verify_signers%& can be set to a colon-separated
36526 list of DKIM domains or identities for which the ACL &%acl_smtp_dkim%& is
36527 called. It is expanded when the message has been received. At this point,
36528 the expansion variable &%$dkim_signers%& already contains a colon-separated
36529 list of signer domains and identities for the message. When
36530 &%dkim_verify_signers%& is not specified in the main configuration,
36531 it defaults as:
36532 .code
36533 dkim_verify_signers = $dkim_signers
36534 .endd
36535 This leads to the default behaviour of calling &%acl_smtp_dkim%& for each
36536 DKIM signature in the message. Current DKIM verifiers may want to explicitly
36537 call the ACL for known domains or identities. This would be achieved as follows:
36538 .code
36539 dkim_verify_signers = paypal.com:ebay.com:$dkim_signers
36540 .endd
36541 This would result in &%acl_smtp_dkim%& always being called for "paypal.com"
36542 and "ebay.com", plus all domains and identities that have signatures in the message.
36543 You can also be more creative in constructing your policy. For example:
36544 .code
36545 dkim_verify_signers = $sender_address_domain:$dkim_signers
36546 .endd
36547
36548 If a domain or identity is listed several times in the (expanded) value of
36549 &%dkim_verify_signers%&, the ACL is only called once for that domain or identity.
36550
36551
36552 Inside the &%acl_smtp_dkim%&, the following expansion variables are
36553 available (from most to least important):
36554
36555
36556 .vlist
36557 .vitem &%$dkim_cur_signer%&
36558 The signer that is being evaluated in this ACL run. This can be a domain or
36559 an identity. This is one of the list items from the expanded main option
36560 &%dkim_verify_signers%& (see above).
36561 .vitem &%$dkim_verify_status%&
36562 A string describing the general status of the signature. One of
36563 .ilist
36564 &%none%&: There is no signature in the message for the current domain or
36565 identity (as reflected by &%$dkim_cur_signer%&).
36566 .next
36567 &%invalid%&: The signature could not be verified due to a processing error.
36568 More detail is available in &%$dkim_verify_reason%&.
36569 .next
36570 &%fail%&: Verification of the signature failed.  More detail is
36571 available in &%$dkim_verify_reason%&.
36572 .next
36573 &%pass%&: The signature passed verification. It is valid.
36574 .endlist
36575 .vitem &%$dkim_verify_reason%&
36576 A string giving a litte bit more detail when &%$dkim_verify_status%& is either
36577 "fail" or "invalid". One of
36578 .ilist
36579 &%pubkey_unavailable%& (when &%$dkim_verify_status%&="invalid"): The public
36580 key for the domain could not be retrieved. This may be a temporary problem.
36581 .next
36582 &%pubkey_syntax%& (when &%$dkim_verify_status%&="invalid"): The public key
36583 record for the domain is syntactically invalid.
36584 .next
36585 &%bodyhash_mismatch%& (when &%$dkim_verify_status%&="fail"): The calculated
36586 body hash does not match the one specified in the signature header. This
36587 means that the message body was modified in transit.
36588 .next
36589 &%signature_incorrect%& (when &%$dkim_verify_status%&="fail"): The signature
36590 could not be verified. This may mean that headers were modified,
36591 re-written or otherwise changed in a way which is incompatible with
36592 DKIM verification. It may of course also mean that the signature is forged.
36593 .endlist
36594 .vitem &%$dkim_domain%&
36595 The signing domain. IMPORTANT: This variable is only populated if there is
36596 an actual signature in the message for the current domain or identity (as
36597 reflected by &%$dkim_cur_signer%&).
36598 .vitem &%$dkim_identity%&
36599 The signing identity, if present. IMPORTANT: This variable is only populated
36600 if there is an actual signature in the message for the current domain or
36601 identity (as reflected by &%$dkim_cur_signer%&).
36602 .vitem &%$dkim_selector%&
36603 The key record selector string.
36604 .vitem &%$dkim_algo%&
36605 The algorithm used. One of 'rsa-sha1' or 'rsa-sha256'.
36606 .vitem &%$dkim_canon_body%&
36607 The body canonicalization method. One of 'relaxed' or 'simple'.
36608 .vitem &%dkim_canon_headers%&
36609 The header canonicalization method. One of 'relaxed' or 'simple'.
36610 .vitem &%$dkim_copiedheaders%&
36611 A transcript of headers and their values which are included in the signature
36612 (copied from the 'z=' tag of the signature).
36613 .vitem &%$dkim_bodylength%&
36614 The number of signed body bytes. If zero ("0"), the body is unsigned. If no
36615 limit was set by the signer, "9999999999999" is returned. This makes sure
36616 that this variable always expands to an integer value.
36617 .vitem &%$dkim_created%&
36618 UNIX timestamp reflecting the date and time when the signature was created.
36619 When this was not specified by the signer, "0" is returned.
36620 .vitem &%$dkim_expires%&
36621 UNIX timestamp reflecting the date and time when the signer wants the
36622 signature to be treated as "expired". When this was not specified by the
36623 signer, "9999999999999" is returned. This makes it possible to do useful
36624 integer size comparisons against this value.
36625 .vitem &%$dkim_headernames%&
36626 A colon-separated list of names of headers included in the signature.
36627 .vitem &%$dkim_key_testing%&
36628 "1" if the key record has the "testing" flag set, "0" if not.
36629 .vitem &%$dkim_key_nosubdomains%&
36630 "1" if the key record forbids subdomaining, "0" otherwise.
36631 .vitem &%$dkim_key_srvtype%&
36632 Service type (tag s=) from the key record. Defaults to "*" if not specified
36633 in the key record.
36634 .vitem &%$dkim_key_granularity%&
36635 Key granularity (tag g=) from the key record. Defaults to "*" if not specified
36636 in the key record.
36637 .vitem &%$dkim_key_notes%&
36638 Notes from the key record (tag n=).
36639 .endlist
36640
36641 In addition, two ACL conditions are provided:
36642
36643 .vlist
36644 .vitem &%dkim_signers%&
36645 ACL condition that checks a colon-separated list of domains or identities
36646 for a match against the domain or identity that the ACL is currently verifying
36647 (reflected by &%$dkim_cur_signer%&). This is typically used to restrict an ACL
36648 verb to a group of domains or identities. For example:
36649
36650 .code
36651 # Warn when Mail purportedly from GMail has no signature at all
36652 warn log_message = GMail sender without DKIM signature
36653      sender_domains = gmail.com
36654      dkim_signers = gmail.com
36655      dkim_status = none
36656 .endd
36657
36658 .vitem &%dkim_status%&
36659 ACL condition that checks a colon-separated list of possible DKIM verification
36660 results against the actual result of verification. This is typically used
36661 to restrict an ACL verb to a list of verification outcomes, for example:
36662
36663 .code
36664 deny message = Mail from Paypal with invalid/missing signature
36665      sender_domains = paypal.com:paypal.de
36666      dkim_signers = paypal.com:paypal.de
36667      dkim_status = none:invalid:fail
36668 .endd
36669
36670 The possible status keywords are: 'none','invalid','fail' and 'pass'. Please
36671 see the documentation of the &%$dkim_verify_status%& expansion variable above
36672 for more information of what they mean.
36673 .endlist
36674
36675 . ////////////////////////////////////////////////////////////////////////////
36676 . ////////////////////////////////////////////////////////////////////////////
36677
36678 .chapter "Adding new drivers or lookup types" "CHID13" &&&
36679          "Adding drivers or lookups"
36680 .cindex "adding drivers"
36681 .cindex "new drivers, adding"
36682 .cindex "drivers" "adding new"
36683 The following actions have to be taken in order to add a new router, transport,
36684 authenticator, or lookup type to Exim:
36685
36686 .olist
36687 Choose a name for the driver or lookup type that does not conflict with any
36688 existing name; I will use &"newdriver"& in what follows.
36689 .next
36690 Add to &_src/EDITME_& the line:
36691 .display
36692 <&'type'&>&`_NEWDRIVER=yes`&
36693 .endd
36694 where <&'type'&> is ROUTER, TRANSPORT, AUTH, or LOOKUP. If the
36695 code is not to be included in the binary by default, comment this line out. You
36696 should also add any relevant comments about the driver or lookup type.
36697 .next
36698 Add to &_src/config.h.defaults_& the line:
36699 .code
36700 #define <type>_NEWDRIVER
36701 .endd
36702 .next
36703 Edit &_src/drtables.c_&, adding conditional code to pull in the private header
36704 and create a table entry as is done for all the other drivers and lookup types.
36705 .next
36706 Edit &_scripts/lookups-Makefile_& if this is a new lookup; there is a for-loop
36707 near the bottom, ranging the &`name_mod`& variable over a list of all lookups.
36708 Add your &`NEWDRIVER`& to that list.
36709 As long as the dynamic module would be named &_newdriver.so_&, you can use the
36710 simple form that most lookups have.
36711 .next
36712 Edit &_Makefile_& in the appropriate sub-directory (&_src/routers_&,
36713 &_src/transports_&, &_src/auths_&, or &_src/lookups_&); add a line for the new
36714 driver or lookup type and add it to the definition of OBJ.
36715 .next
36716 Create &_newdriver.h_& and &_newdriver.c_& in the appropriate sub-directory of
36717 &_src_&.
36718 .next
36719 Edit &_scripts/MakeLinks_& and add commands to link the &_.h_& and &_.c_& files
36720 as for other drivers and lookups.
36721 .endlist
36722
36723 Then all you need to do is write the code! A good way to start is to make a
36724 proforma by copying an existing module of the same type, globally changing all
36725 occurrences of the name, and cutting out most of the code. Note that any
36726 options you create must be listed in alphabetical order, because the tables are
36727 searched using a binary chop procedure.
36728
36729 There is a &_README_& file in each of the sub-directories of &_src_& describing
36730 the interface that is expected.
36731
36732
36733
36734
36735 . ////////////////////////////////////////////////////////////////////////////
36736 . ////////////////////////////////////////////////////////////////////////////
36737
36738 . /////////////////////////////////////////////////////////////////////////////
36739 . These lines are processing instructions for the Simple DocBook Processor that
36740 . Philip Hazel has developed as a less cumbersome way of making PostScript and
36741 . PDFs than using xmlto and fop. They will be ignored by all other XML
36742 . processors.
36743 . /////////////////////////////////////////////////////////////////////////////
36744
36745 .literal xml
36746 <?sdop
36747   format="newpage"
36748   foot_right_recto="&chaptertitle;"
36749   foot_right_verso="&chaptertitle;"
36750 ?>
36751 .literal off
36752
36753 .makeindex "Options index"   "option"
36754 .makeindex "Variables index" "variable"
36755 .makeindex "Concept index"   "concept"
36756
36757
36758 . /////////////////////////////////////////////////////////////////////////////
36759 . /////////////////////////////////////////////////////////////////////////////