29214e3e19832434a123a4430a2159b1163f82e7
[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 2012
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   <revnumber>
183 .version
184   </revnumber>
185   <date>
186 .fulldate
187   </date>
188   <authorinitials>EM</authorinitials>
189 </revision></revhistory>
190 <copyright><year>
191 .copyyear
192            </year><holder>University of Cambridge</holder></copyright>
193 </bookinfo>
194 .literal off
195
196
197 . /////////////////////////////////////////////////////////////////////////////
198 . This chunk of literal XML implements index entries of the form "x, see y" and
199 . "x, see also y". However, the DocBook DTD doesn't allow <indexterm> entries
200 . at the top level, so we have to put the .chapter directive first.
201 . /////////////////////////////////////////////////////////////////////////////
202
203 .chapter "Introduction" "CHID1"
204 .literal xml
205
206 <indexterm role="variable">
207   <primary>$1, $2, etc.</primary>
208   <see><emphasis>numerical variables</emphasis></see>
209 </indexterm>
210 <indexterm role="concept">
211   <primary>address</primary>
212   <secondary>rewriting</secondary>
213   <see><emphasis>rewriting</emphasis></see>
214 </indexterm>
215 <indexterm role="concept">
216   <primary>Bounce Address Tag Validation</primary>
217   <see><emphasis>BATV</emphasis></see>
218 </indexterm>
219 <indexterm role="concept">
220   <primary>Client SMTP Authorization</primary>
221   <see><emphasis>CSA</emphasis></see>
222 </indexterm>
223 <indexterm role="concept">
224   <primary>CR character</primary>
225   <see><emphasis>carriage return</emphasis></see>
226 </indexterm>
227 <indexterm role="concept">
228   <primary>CRL</primary>
229   <see><emphasis>certificate revocation list</emphasis></see>
230 </indexterm>
231 <indexterm role="concept">
232   <primary>delivery</primary>
233   <secondary>failure report</secondary>
234   <see><emphasis>bounce message</emphasis></see>
235 </indexterm>
236 <indexterm role="concept">
237   <primary>dialup</primary>
238   <see><emphasis>intermittently connected hosts</emphasis></see>
239 </indexterm>
240 <indexterm role="concept">
241   <primary>exiscan</primary>
242   <see><emphasis>content scanning</emphasis></see>
243 </indexterm>
244 <indexterm role="concept">
245   <primary>failover</primary>
246   <see><emphasis>fallback</emphasis></see>
247 </indexterm>
248 <indexterm role="concept">
249   <primary>fallover</primary>
250   <see><emphasis>fallback</emphasis></see>
251 </indexterm>
252 <indexterm role="concept">
253   <primary>filter</primary>
254   <secondary>Sieve</secondary>
255   <see><emphasis>Sieve filter</emphasis></see>
256 </indexterm>
257 <indexterm role="concept">
258   <primary>ident</primary>
259   <see><emphasis>RFC 1413</emphasis></see>
260 </indexterm>
261 <indexterm role="concept">
262   <primary>LF character</primary>
263   <see><emphasis>linefeed</emphasis></see>
264 </indexterm>
265 <indexterm role="concept">
266   <primary>maximum</primary>
267   <seealso><emphasis>limit</emphasis></seealso>
268 </indexterm>
269 <indexterm role="concept">
270   <primary>monitor</primary>
271   <see><emphasis>Exim monitor</emphasis></see>
272 </indexterm>
273 <indexterm role="concept">
274   <primary>no_<emphasis>xxx</emphasis></primary>
275   <see>entry for xxx</see>
276 </indexterm>
277 <indexterm role="concept">
278   <primary>NUL</primary>
279   <see><emphasis>binary zero</emphasis></see>
280 </indexterm>
281 <indexterm role="concept">
282   <primary>passwd file</primary>
283   <see><emphasis>/etc/passwd</emphasis></see>
284 </indexterm>
285 <indexterm role="concept">
286   <primary>process id</primary>
287   <see><emphasis>pid</emphasis></see>
288 </indexterm>
289 <indexterm role="concept">
290   <primary>RBL</primary>
291   <see><emphasis>DNS list</emphasis></see>
292 </indexterm>
293 <indexterm role="concept">
294   <primary>redirection</primary>
295   <see><emphasis>address redirection</emphasis></see>
296 </indexterm>
297 <indexterm role="concept">
298   <primary>return path</primary>
299   <seealso><emphasis>envelope sender</emphasis></seealso>
300 </indexterm>
301 <indexterm role="concept">
302   <primary>scanning</primary>
303   <see><emphasis>content scanning</emphasis></see>
304 </indexterm>
305 <indexterm role="concept">
306   <primary>SSL</primary>
307   <see><emphasis>TLS</emphasis></see>
308 </indexterm>
309 <indexterm role="concept">
310   <primary>string</primary>
311   <secondary>expansion</secondary>
312   <see><emphasis>expansion</emphasis></see>
313 </indexterm>
314 <indexterm role="concept">
315   <primary>top bit</primary>
316   <see><emphasis>8-bit characters</emphasis></see>
317 </indexterm>
318 <indexterm role="concept">
319   <primary>variables</primary>
320   <see><emphasis>expansion, variables</emphasis></see>
321 </indexterm>
322 <indexterm role="concept">
323   <primary>zero, binary</primary>
324   <see><emphasis>binary zero</emphasis></see>
325 </indexterm>
326
327 .literal off
328
329
330 . /////////////////////////////////////////////////////////////////////////////
331 . This is the real start of the first chapter. See the comment above as to why
332 . we can't have the .chapter line here.
333 . chapter "Introduction"
334 . /////////////////////////////////////////////////////////////////////////////
335
336 Exim is a mail transfer agent (MTA) for hosts that are running Unix or
337 Unix-like operating systems. It was designed on the assumption that it would be
338 run on hosts that are permanently connected to the Internet. However, it can be
339 used on intermittently connected hosts with suitable configuration adjustments.
340
341 Configuration files currently exist for the following operating systems: AIX,
342 BSD/OS (aka BSDI), Darwin (Mac OS X), DGUX, Dragonfly, FreeBSD, GNU/Hurd,
343 GNU/Linux, HI-OSF (Hitachi), HI-UX, HP-UX, IRIX, MIPS RISCOS, NetBSD, OpenBSD,
344 OpenUNIX, QNX, SCO, SCO SVR4.2 (aka UNIX-SV), Solaris (aka SunOS5), SunOS4,
345 Tru64-Unix (formerly Digital UNIX, formerly DEC-OSF1), Ultrix, and Unixware.
346 Some of these operating systems are no longer current and cannot easily be
347 tested, so the configuration files may no longer work in practice.
348
349 There are also configuration files for compiling Exim in the Cygwin environment
350 that can be installed on systems running Windows. However, this document does
351 not contain any information about running Exim in the Cygwin environment.
352
353 The terms and conditions for the use and distribution of Exim are contained in
354 the file &_NOTICE_&. Exim is distributed under the terms of the GNU General
355 Public Licence, a copy of which may be found in the file &_LICENCE_&.
356
357 The use, supply or promotion of Exim for the purpose of sending bulk,
358 unsolicited electronic mail is incompatible with the basic aims of the program,
359 which revolve around the free provision of a service that enhances the quality
360 of personal communications. The author of Exim regards indiscriminate
361 mass-mailing as an antisocial, irresponsible abuse of the Internet.
362
363 Exim owes a great deal to Smail 3 and its author, Ron Karr. Without the
364 experience of running and working on the Smail 3 code, I could never have
365 contemplated starting to write a new MTA. Many of the ideas and user interfaces
366 were originally taken from Smail 3, though the actual code of Exim is entirely
367 new, and has developed far beyond the initial concept.
368
369 Many people, both in Cambridge and around the world, have contributed to the
370 development and the testing of Exim, and to porting it to various operating
371 systems. I am grateful to them all. The distribution now contains a file called
372 &_ACKNOWLEDGMENTS_&, in which I have started recording the names of
373 contributors.
374
375
376 .section "Exim documentation" "SECID1"
377 . Keep this example change bar when updating the documentation!
378
379 .new
380 .cindex "documentation"
381 This edition of the Exim specification applies to version &version() of Exim.
382 Substantive changes from the &previousversion; edition are marked in some
383 renditions of the document; this paragraph is so marked if the rendition is
384 capable of showing a change indicator.
385 .wen
386
387 This document is very much a reference manual; it is not a tutorial. The reader
388 is expected to have some familiarity with the SMTP mail transfer protocol and
389 with general Unix system administration. Although there are some discussions
390 and examples in places, the information is mostly organized in a way that makes
391 it easy to look up, rather than in a natural order for sequential reading.
392 Furthermore, the manual aims to cover every aspect of Exim in detail, including
393 a number of rarely-used, special-purpose features that are unlikely to be of
394 very wide interest.
395
396 .cindex "books about Exim"
397 An &"easier"& discussion of Exim which provides more in-depth explanatory,
398 introductory, and tutorial material can be found in a book entitled &'The Exim
399 SMTP Mail Server'& (second edition, 2007), published by UIT Cambridge
400 (&url(http://www.uit.co.uk/exim-book/)).
401
402 This book also contains a chapter that gives a general introduction to SMTP and
403 Internet mail. Inevitably, however, the book is unlikely to be fully up-to-date
404 with the latest release of Exim. (Note that the earlier book about Exim,
405 published by O'Reilly, covers Exim 3, and many things have changed in Exim 4.)
406
407 .cindex "Debian" "information sources"
408 If you are using a Debian distribution of Exim, you will find information about
409 Debian-specific features in the file
410 &_/usr/share/doc/exim4-base/README.Debian_&.
411 The command &(man update-exim.conf)& is another source of Debian-specific
412 information.
413
414 .cindex "&_doc/NewStuff_&"
415 .cindex "&_doc/ChangeLog_&"
416 .cindex "change log"
417 As the program develops, there may be features in newer versions that have not
418 yet made it into this document, which is updated only when the most significant
419 digit of the fractional part of the version number changes. Specifications of
420 new features that are not yet in this manual are placed in the file
421 &_doc/NewStuff_& in the Exim distribution.
422
423 Some features may be classified as &"experimental"&. These may change
424 incompatibly while they are developing, or even be withdrawn. For this reason,
425 they are not documented in this manual. Information about experimental features
426 can be found in the file &_doc/experimental.txt_&.
427
428 All changes to the program (whether new features, bug fixes, or other kinds of
429 change) are noted briefly in the file called &_doc/ChangeLog_&.
430
431 .cindex "&_doc/spec.txt_&"
432 This specification itself is available as an ASCII file in &_doc/spec.txt_& so
433 that it can easily be searched with a text editor. Other files in the &_doc_&
434 directory are:
435
436 .table2 100pt
437 .row &_OptionLists.txt_&     "list of all options in alphabetical order"
438 .row &_dbm.discuss.txt_&     "discussion about DBM libraries"
439 .row &_exim.8_&              "a man page of Exim's command line options"
440 .row &_experimental.txt_&    "documentation of experimental features"
441 .row &_filter.txt_&          "specification of the filter language"
442 .row &_Exim3.upgrade_&       "upgrade notes from release 2 to release 3"
443 .row &_Exim4.upgrade_&       "upgrade notes from release 3 to release 4"
444 .endtable
445
446 The main specification and the specification of the filtering language are also
447 available in other formats (HTML, PostScript, PDF, and Texinfo). Section
448 &<<SECTavail>>& below tells you how to get hold of these.
449
450
451
452 .section "FTP and web sites" "SECID2"
453 .cindex "web site"
454 .cindex "FTP site"
455 The primary site for Exim source distributions is currently the University of
456 Cambridge's FTP site, whose contents are described in &'Where to find the Exim
457 distribution'& below. In addition, there is a web site and an FTP site at
458 &%exim.org%&. These are now also hosted at the University of Cambridge. The
459 &%exim.org%& site was previously hosted for a number of years by Energis
460 Squared, formerly Planet Online Ltd, whose support I gratefully acknowledge.
461
462 .cindex "wiki"
463 .cindex "FAQ"
464 As well as Exim distribution tar files, the Exim web site contains a number of
465 differently formatted versions of the documentation. A recent addition to the
466 online information is the Exim wiki (&url(http://wiki.exim.org)),
467 which contains what used to be a separate FAQ, as well as various other
468 examples, tips, and know-how that have been contributed by Exim users.
469
470 .cindex Bugzilla
471 An Exim Bugzilla exists at &url(http://bugs.exim.org). You can use
472 this to report bugs, and also to add items to the wish list. Please search
473 first to check that you are not duplicating a previous entry.
474
475
476
477 .section "Mailing lists" "SECID3"
478 .cindex "mailing lists" "for Exim users"
479 The following Exim mailing lists exist:
480
481 .table2 140pt
482 .row &'exim-announce@exim.org'&   "Moderated, low volume announcements list"
483 .row &'exim-users@exim.org'&      "General discussion list"
484 .row &'exim-dev@exim.org'&        "Discussion of bugs, enhancements, etc."
485 .row &'exim-cvs@exim.org'&        "Automated commit messages from the VCS"
486 .endtable
487
488 You can subscribe to these lists, change your existing subscriptions, and view
489 or search the archives via the mailing lists link on the Exim home page.
490 .cindex "Debian" "mailing list for"
491 If you are using a Debian distribution of Exim, you may wish to subscribe to
492 the Debian-specific mailing list &'pkg-exim4-users@lists.alioth.debian.org'&
493 via this web page:
494 .display
495 &url(http://lists.alioth.debian.org/mailman/listinfo/pkg-exim4-users)
496 .endd
497 Please ask Debian-specific questions on this list and not on the general Exim
498 lists.
499
500 .section "Exim training" "SECID4"
501 .cindex "training courses"
502 Training courses in Cambridge (UK) used to be run annually by the author of
503 Exim, before he retired. At the time of writing, there are no plans to run
504 further Exim courses in Cambridge. However, if that changes, relevant
505 information will be posted at &url(http://www-tus.csx.cam.ac.uk/courses/exim/).
506
507 .section "Bug reports" "SECID5"
508 .cindex "bug reports"
509 .cindex "reporting bugs"
510 Reports of obvious bugs can be emailed to &'bugs@exim.org'& or reported
511 via the Bugzilla (&url(http://bugs.exim.org)). However, if you are unsure
512 whether some behaviour is a bug or not, the best thing to do is to post a
513 message to the &'exim-dev'& mailing list and have it discussed.
514
515
516
517 .section "Where to find the Exim distribution" "SECTavail"
518 .cindex "FTP site"
519 .cindex "distribution" "ftp site"
520 The master ftp site for the Exim distribution is
521 .display
522 &*ftp://ftp.csx.cam.ac.uk/pub/software/email/exim*&
523 .endd
524 This is mirrored by
525 .display
526 &*ftp://ftp.exim.org/pub/exim*&
527 .endd
528 The file references that follow are relative to the &_exim_& directories at
529 these sites. There are now quite a number of independent mirror sites around
530 the world. Those that I know about are listed in the file called &_Mirrors_&.
531
532 Within the &_exim_& directory there are subdirectories called &_exim3_& (for
533 previous Exim 3 distributions), &_exim4_& (for the latest Exim 4
534 distributions), and &_Testing_& for testing versions. In the &_exim4_&
535 subdirectory, the current release can always be found in files called
536 .display
537 &_exim-n.nn.tar.gz_&
538 &_exim-n.nn.tar.bz2_&
539 .endd
540 where &'n.nn'& is the highest such version number in the directory. The two
541 files contain identical data; the only difference is the type of compression.
542 The &_.bz2_& file is usually a lot smaller than the &_.gz_& file.
543
544 .cindex "distribution" "signing details"
545 .cindex "distribution" "public key"
546 .cindex "public key for signed distribution"
547 .new
548 The distributions will be PGP signed by an individual key of the Release
549 Coordinator.  This key will have a uid containing an email address in the
550 &'exim.org'& domain and will have signatures from other people, including
551 other Exim maintainers.  We expect that the key will be in the "strong set" of
552 PGP keys.  There should be a trust path to that key from Nigel Metheringham's
553 PGP key, a version of which can be found in the release directory in the file
554 &_nigel-pubkey.asc_&.  All keys used will be available in public keyserver pools,
555 such as &'pool.sks-keyservers.net'&.
556
557 At time of last update, releases were being made by Phil Pennock and signed with
558 key &'0x403043153903637F'&, although that key is expected to be replaced in 2013.
559 A trust path from Nigel's key to Phil's can be observed at
560 &url(https://www.security.spodhuis.org/exim-trustpath).
561 .wen
562
563 The signatures for the tar bundles are in:
564 .display
565 &_exim-n.nn.tar.gz.asc_&
566 &_exim-n.nn.tar.bz2.asc_&
567 .endd
568 For each released version, the log of changes is made separately available in a
569 separate file in the directory &_ChangeLogs_& so that it is possible to
570 find out what has changed without having to download the entire distribution.
571
572 .cindex "documentation" "available formats"
573 The main distribution contains ASCII versions of this specification and other
574 documentation; other formats of the documents are available in separate files
575 inside the &_exim4_& directory of the FTP site:
576 .display
577 &_exim-html-n.nn.tar.gz_&
578 &_exim-pdf-n.nn.tar.gz_&
579 &_exim-postscript-n.nn.tar.gz_&
580 &_exim-texinfo-n.nn.tar.gz_&
581 .endd
582 These tar files contain only the &_doc_& directory, not the complete
583 distribution, and are also available in &_.bz2_& as well as &_.gz_& forms.
584
585
586 .section "Limitations" "SECID6"
587 .ilist
588 .cindex "limitations of Exim"
589 .cindex "bang paths" "not handled by Exim"
590 Exim is designed for use as an Internet MTA, and therefore handles addresses in
591 RFC 2822 domain format only. It cannot handle UUCP &"bang paths"&, though
592 simple two-component bang paths can be converted by a straightforward rewriting
593 configuration. This restriction does not prevent Exim from being interfaced to
594 UUCP as a transport mechanism, provided that domain addresses are used.
595 .next
596 .cindex "domainless addresses"
597 .cindex "address" "without domain"
598 Exim insists that every address it handles has a domain attached. For incoming
599 local messages, domainless addresses are automatically qualified with a
600 configured domain value. Configuration options specify from which remote
601 systems unqualified addresses are acceptable. These are then qualified on
602 arrival.
603 .next
604 .cindex "transport" "external"
605 .cindex "external transports"
606 The only external transport mechanisms that are currently implemented are SMTP
607 and LMTP over a TCP/IP network (including support for IPv6). However, a pipe
608 transport is available, and there are facilities for writing messages to files
609 and pipes, optionally in &'batched SMTP'& format; these facilities can be used
610 to send messages to other transport mechanisms such as UUCP, provided they can
611 handle domain-style addresses. Batched SMTP input is also catered for.
612 .next
613 Exim is not designed for storing mail for dial-in hosts. When the volumes of
614 such mail are large, it is better to get the messages &"delivered"& into files
615 (that is, off Exim's queue) and subsequently passed on to the dial-in hosts by
616 other means.
617 .next
618 Although Exim does have basic facilities for scanning incoming messages, these
619 are not comprehensive enough to do full virus or spam scanning. Such operations
620 are best carried out using additional specialized software packages. If you
621 compile Exim with the content-scanning extension, straightforward interfaces to
622 a number of common scanners are provided.
623 .endlist
624
625
626 .section "Run time configuration" "SECID7"
627 Exim's run time configuration is held in a single text file that is divided
628 into a number of sections. The entries in this file consist of keywords and
629 values, in the style of Smail 3 configuration files. A default configuration
630 file which is suitable for simple online installations is provided in the
631 distribution, and is described in chapter &<<CHAPdefconfil>>& below.
632
633
634 .section "Calling interface" "SECID8"
635 .cindex "Sendmail compatibility" "command line interface"
636 Like many MTAs, Exim has adopted the Sendmail command line interface so that it
637 can be a straight replacement for &_/usr/lib/sendmail_& or
638 &_/usr/sbin/sendmail_& when sending mail, but you do not need to know anything
639 about Sendmail in order to run Exim. For actions other than sending messages,
640 Sendmail-compatible options also exist, but those that produce output (for
641 example, &%-bp%&, which lists the messages on the queue) do so in Exim's own
642 format. There are also some additional options that are compatible with Smail
643 3, and some further options that are new to Exim. Chapter &<<CHAPcommandline>>&
644 documents all Exim's command line options. This information is automatically
645 made into the man page that forms part of the Exim distribution.
646
647 Control of messages on the queue can be done via certain privileged command
648 line options. There is also an optional monitor program called &'eximon'&,
649 which displays current information in an X window, and which contains a menu
650 interface to Exim's command line administration options.
651
652
653
654 .section "Terminology" "SECID9"
655 .cindex "terminology definitions"
656 .cindex "body of message" "definition of"
657 The &'body'& of a message is the actual data that the sender wants to transmit.
658 It is the last part of a message, and is separated from the &'header'& (see
659 below) by a blank line.
660
661 .cindex "bounce message" "definition of"
662 When a message cannot be delivered, it is normally returned to the sender in a
663 delivery failure message or a &"non-delivery report"& (NDR). The term
664 &'bounce'& is commonly used for this action, and the error reports are often
665 called &'bounce messages'&. This is a convenient shorthand for &"delivery
666 failure error report"&. Such messages have an empty sender address in the
667 message's &'envelope'& (see below) to ensure that they cannot themselves give
668 rise to further bounce messages.
669
670 The term &'default'& appears frequently in this manual. It is used to qualify a
671 value which is used in the absence of any setting in the configuration. It may
672 also qualify an action which is taken unless a configuration setting specifies
673 otherwise.
674
675 The term &'defer'& is used when the delivery of a message to a specific
676 destination cannot immediately take place for some reason (a remote host may be
677 down, or a user's local mailbox may be full). Such deliveries are &'deferred'&
678 until a later time.
679
680 The word &'domain'& is sometimes used to mean all but the first component of a
681 host's name. It is &'not'& used in that sense here, where it normally refers to
682 the part of an email address following the @ sign.
683
684 .cindex "envelope, definition of"
685 .cindex "sender" "definition of"
686 A message in transit has an associated &'envelope'&, as well as a header and a
687 body. The envelope contains a sender address (to which bounce messages should
688 be delivered), and any number of recipient addresses. References to the
689 sender or the recipients of a message usually mean the addresses in the
690 envelope. An MTA uses these addresses for delivery, and for returning bounce
691 messages, not the addresses that appear in the header lines.
692
693 .cindex "message" "header, definition of"
694 .cindex "header section" "definition of"
695 The &'header'& of a message is the first part of a message's text, consisting
696 of a number of lines, each of which has a name such as &'From:'&, &'To:'&,
697 &'Subject:'&, etc. Long header lines can be split over several text lines by
698 indenting the continuations. The header is separated from the body by a blank
699 line.
700
701 .cindex "local part" "definition of"
702 .cindex "domain" "definition of"
703 The term &'local part'&, which is taken from RFC 2822, is used to refer to that
704 part of an email address that precedes the @ sign. The part that follows the
705 @ sign is called the &'domain'& or &'mail domain'&.
706
707 .cindex "local delivery" "definition of"
708 .cindex "remote delivery, definition of"
709 The terms &'local delivery'& and &'remote delivery'& are used to distinguish
710 delivery to a file or a pipe on the local host from delivery by SMTP over
711 TCP/IP to another host. As far as Exim is concerned, all hosts other than the
712 host it is running on are &'remote'&.
713
714 .cindex "return path" "definition of"
715 &'Return path'& is another name that is used for the sender address in a
716 message's envelope.
717
718 .cindex "queue" "definition of"
719 The term &'queue'& is used to refer to the set of messages awaiting delivery,
720 because this term is in widespread use in the context of MTAs. However, in
721 Exim's case the reality is more like a pool than a queue, because there is
722 normally no ordering of waiting messages.
723
724 .cindex "queue runner" "definition of"
725 The term &'queue runner'& is used to describe a process that scans the queue
726 and attempts to deliver those messages whose retry times have come. This term
727 is used by other MTAs, and also relates to the command &%runq%&, but in Exim
728 the waiting messages are normally processed in an unpredictable order.
729
730 .cindex "spool directory" "definition of"
731 The term &'spool directory'& is used for a directory in which Exim keeps the
732 messages on its queue &-- that is, those that it is in the process of
733 delivering. This should not be confused with the directory in which local
734 mailboxes are stored, which is called a &"spool directory"& by some people. In
735 the Exim documentation, &"spool"& is always used in the first sense.
736
737
738
739
740
741
742 . ////////////////////////////////////////////////////////////////////////////
743 . ////////////////////////////////////////////////////////////////////////////
744
745 .chapter "Incorporated code" "CHID2"
746 .cindex "incorporated code"
747 .cindex "regular expressions" "library"
748 .cindex "PCRE"
749 .cindex "OpenDMARC"
750 A number of pieces of external code are included in the Exim distribution.
751
752 .ilist
753 Regular expressions are supported in the main Exim program and in the
754 Exim monitor using the freely-distributable PCRE library, copyright
755 &copy; University of Cambridge. The source to PCRE is no longer shipped with
756 Exim, so you will need to use the version of PCRE shipped with your system,
757 or obtain and install the full version of the library from
758 &url(ftp://ftp.csx.cam.ac.uk/pub/software/programming/pcre).
759 .next
760 .cindex "cdb" "acknowledgment"
761 Support for the cdb (Constant DataBase) lookup method is provided by code
762 contributed by Nigel Metheringham of (at the time he contributed it) Planet
763 Online Ltd. The implementation is completely contained within the code of Exim.
764 It does not link against an external cdb library. The code contains the
765 following statements:
766
767 .blockquote
768 Copyright &copy; 1998 Nigel Metheringham, Planet Online Ltd
769
770 This program is free software; you can redistribute it and/or modify it under
771 the terms of the GNU General Public License as published by the Free Software
772 Foundation; either version 2 of the License, or (at your option) any later
773 version.
774 This code implements Dan Bernstein's Constant DataBase (cdb) spec. Information,
775 the spec and sample code for cdb can be obtained from
776 &url(http://www.pobox.com/~djb/cdb.html). This implementation borrows
777 some code from Dan Bernstein's implementation (which has no license
778 restrictions applied to it).
779 .endblockquote
780 .next
781 .cindex "SPA authentication"
782 .cindex "Samba project"
783 .cindex "Microsoft Secure Password Authentication"
784 Client support for Microsoft's &'Secure Password Authentication'& is provided
785 by code contributed by Marc Prud'hommeaux. Server support was contributed by
786 Tom Kistner. This includes code taken from the Samba project, which is released
787 under the Gnu GPL.
788 .next
789 .cindex "Cyrus"
790 .cindex "&'pwcheck'& daemon"
791 .cindex "&'pwauthd'& daemon"
792 Support for calling the Cyrus &'pwcheck'& and &'saslauthd'& daemons is provided
793 by code taken from the Cyrus-SASL library and adapted by Alexander S.
794 Sabourenkov. The permission notice appears below, in accordance with the
795 conditions expressed therein.
796
797 .blockquote
798 Copyright &copy; 2001 Carnegie Mellon University.  All rights reserved.
799
800 Redistribution and use in source and binary forms, with or without
801 modification, are permitted provided that the following conditions
802 are met:
803
804 .olist
805 Redistributions of source code must retain the above copyright
806 notice, this list of conditions and the following disclaimer.
807 .next
808 Redistributions in binary form must reproduce the above copyright
809 notice, this list of conditions and the following disclaimer in
810 the documentation and/or other materials provided with the
811 distribution.
812 .next
813 The name &"Carnegie Mellon University"& must not be used to
814 endorse or promote products derived from this software without
815 prior written permission. For permission or any other legal
816 details, please contact
817 .display
818               Office of Technology Transfer
819               Carnegie Mellon University
820               5000 Forbes Avenue
821               Pittsburgh, PA  15213-3890
822               (412) 268-4387, fax: (412) 268-7395
823               tech-transfer@andrew.cmu.edu
824 .endd
825 .next
826 Redistributions of any form whatsoever must retain the following
827 acknowledgment:
828
829 &"This product includes software developed by Computing Services
830 at Carnegie Mellon University (&url(http://www.cmu.edu/computing/)."&
831
832 CARNEGIE MELLON UNIVERSITY DISCLAIMS ALL WARRANTIES WITH REGARD TO
833 THIS SOFTWARE, INCLUDING ALL IMPLIED WARRANTIES OF MERCHANTABILITY
834 AND FITNESS, IN NO EVENT SHALL CARNEGIE MELLON UNIVERSITY BE LIABLE
835 FOR ANY SPECIAL, INDIRECT OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES
836 WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS, WHETHER IN
837 AN ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING
838 OUT OF OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE.
839 .endlist
840 .endblockquote
841
842 .next
843 .cindex "Exim monitor" "acknowledgment"
844 .cindex "X-windows"
845 .cindex "Athena"
846 The Exim Monitor program, which is an X-Window application, includes
847 modified versions of the Athena StripChart and TextPop widgets.
848 This code is copyright by DEC and MIT, and their permission notice appears
849 below, in accordance with the conditions expressed therein.
850
851 .blockquote
852 Copyright 1987, 1988 by Digital Equipment Corporation, Maynard, Massachusetts,
853 and the Massachusetts Institute of Technology, Cambridge, Massachusetts.
854
855 All Rights Reserved
856
857 Permission to use, copy, modify, and distribute this software and its
858 documentation for any purpose and without fee is hereby granted,
859 provided that the above copyright notice appear in all copies and that
860 both that copyright notice and this permission notice appear in
861 supporting documentation, and that the names of Digital or MIT not be
862 used in advertising or publicity pertaining to distribution of the
863 software without specific, written prior permission.
864
865 DIGITAL DISCLAIMS ALL WARRANTIES WITH REGARD TO THIS SOFTWARE, INCLUDING
866 ALL IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS, IN NO EVENT SHALL
867 DIGITAL BE LIABLE FOR ANY SPECIAL, INDIRECT OR CONSEQUENTIAL DAMAGES OR
868 ANY DAMAGES WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS,
869 WHETHER IN AN ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION,
870 ARISING OUT OF OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS
871 SOFTWARE.
872 .endblockquote
873
874 .next
875 .cindex "opendmarc" "acknowledgment"
876 The DMARC implementation uses the OpenDMARC library which is Copyrighted by
877 The Trusted Domain Project. Portions of Exim source which use OpenDMARC
878 derived code are indicated in the respective source files. The full OpenDMARC
879 license is provided in the LICENSE.opendmarc file contained in the distributed
880 source code.
881
882 .next
883 Many people have contributed code fragments, some large, some small, that were
884 not covered by any specific licence requirements. It is assumed that the
885 contributors are happy to see their code incorporated into Exim under the GPL.
886 .endlist
887
888
889
890
891
892 . ////////////////////////////////////////////////////////////////////////////
893 . ////////////////////////////////////////////////////////////////////////////
894
895 .chapter "How Exim receives and delivers mail" "CHID11" &&&
896          "Receiving and delivering mail"
897
898
899 .section "Overall philosophy" "SECID10"
900 .cindex "design philosophy"
901 Exim is designed to work efficiently on systems that are permanently connected
902 to the Internet and are handling a general mix of mail. In such circumstances,
903 most messages can be delivered immediately. Consequently, Exim does not
904 maintain independent queues of messages for specific domains or hosts, though
905 it does try to send several messages in a single SMTP connection after a host
906 has been down, and it also maintains per-host retry information.
907
908
909 .section "Policy control" "SECID11"
910 .cindex "policy control" "overview"
911 Policy controls are now an important feature of MTAs that are connected to the
912 Internet. Perhaps their most important job is to stop MTAs being abused as
913 &"open relays"& by misguided individuals who send out vast amounts of
914 unsolicited junk, and want to disguise its source. Exim provides flexible
915 facilities for specifying policy controls on incoming mail:
916
917 .ilist
918 .cindex "&ACL;" "introduction"
919 Exim 4 (unlike previous versions of Exim) implements policy controls on
920 incoming mail by means of &'Access Control Lists'& (ACLs). Each list is a
921 series of statements that may either grant or deny access. ACLs can be used at
922 several places in the SMTP dialogue while receiving a message from a remote
923 host. However, the most common places are after each RCPT command, and at the
924 very end of the message. The sysadmin can specify conditions for accepting or
925 rejecting individual recipients or the entire message, respectively, at these
926 two points (see chapter &<<CHAPACL>>&). Denial of access results in an SMTP
927 error code.
928 .next
929 An ACL is also available for locally generated, non-SMTP messages. In this
930 case, the only available actions are to accept or deny the entire message.
931 .next
932 When Exim is compiled with the content-scanning extension, facilities are
933 provided in the ACL mechanism for passing the message to external virus and/or
934 spam scanning software. The result of such a scan is passed back to the ACL,
935 which can then use it to decide what to do with the message.
936 .next
937 When a message has been received, either from a remote host or from the local
938 host, but before the final acknowledgment has been sent, a locally supplied C
939 function called &[local_scan()]& can be run to inspect the message and decide
940 whether to accept it or not (see chapter &<<CHAPlocalscan>>&). If the message
941 is accepted, the list of recipients can be modified by the function.
942 .next
943 Using the &[local_scan()]& mechanism is another way of calling external scanner
944 software. The &%SA-Exim%& add-on package works this way. It does not require
945 Exim to be compiled with the content-scanning extension.
946 .next
947 After a message has been accepted, a further checking mechanism is available in
948 the form of the &'system filter'& (see chapter &<<CHAPsystemfilter>>&). This
949 runs at the start of every delivery process.
950 .endlist
951
952
953
954 .section "User filters" "SECID12"
955 .cindex "filter" "introduction"
956 .cindex "Sieve filter"
957 In a conventional Exim configuration, users are able to run private filters by
958 setting up appropriate &_.forward_& files in their home directories. See
959 chapter &<<CHAPredirect>>& (about the &(redirect)& router) for the
960 configuration needed to support this, and the separate document entitled
961 &'Exim's interfaces to mail filtering'& for user details. Two different kinds
962 of filtering are available:
963
964 .ilist
965 Sieve filters are written in the standard filtering language that is defined
966 by RFC 3028.
967 .next
968 Exim filters are written in a syntax that is unique to Exim, but which is more
969 powerful than Sieve, which it pre-dates.
970 .endlist
971
972 User filters are run as part of the routing process, described below.
973
974
975
976 .section "Message identification" "SECTmessiden"
977 .cindex "message ids" "details of format"
978 .cindex "format" "of message id"
979 .cindex "id of message"
980 .cindex "base62"
981 .cindex "base36"
982 .cindex "Darwin"
983 .cindex "Cygwin"
984 Every message handled by Exim is given a &'message id'& which is sixteen
985 characters long. It is divided into three parts, separated by hyphens, for
986 example &`16VDhn-0001bo-D3`&. Each part is a sequence of letters and digits,
987 normally encoding numbers in base 62. However, in the Darwin operating
988 system (Mac OS X) and when Exim is compiled to run under Cygwin, base 36
989 (avoiding the use of lower case letters) is used instead, because the message
990 id is used to construct file names, and the names of files in those systems are
991 not always case-sensitive.
992
993 .cindex "pid (process id)" "re-use of"
994 The detail of the contents of the message id have changed as Exim has evolved.
995 Earlier versions relied on the operating system not re-using a process id (pid)
996 within one second. On modern operating systems, this assumption can no longer
997 be made, so the algorithm had to be changed. To retain backward compatibility,
998 the format of the message id was retained, which is why the following rules are
999 somewhat eccentric:
1000
1001 .ilist
1002 The first six characters of the message id are the time at which the message
1003 started to be received, to a granularity of one second. That is, this field
1004 contains the number of seconds since the start of the epoch (the normal Unix
1005 way of representing the date and time of day).
1006 .next
1007 After the first hyphen, the next six characters are the id of the process that
1008 received the message.
1009 .next
1010 There are two different possibilities for the final two characters:
1011 .olist
1012 .oindex "&%localhost_number%&"
1013 If &%localhost_number%& is not set, this value is the fractional part of the
1014 time of reception, normally in units of 1/2000 of a second, but for systems
1015 that must use base 36 instead of base 62 (because of case-insensitive file
1016 systems), the units are 1/1000 of a second.
1017 .next
1018 If &%localhost_number%& is set, it is multiplied by 200 (100) and added to
1019 the fractional part of the time, which in this case is in units of 1/200
1020 (1/100) of a second.
1021 .endlist
1022 .endlist
1023
1024 After a message has been received, Exim waits for the clock to tick at the
1025 appropriate resolution before proceeding, so that if another message is
1026 received by the same process, or by another process with the same (re-used)
1027 pid, it is guaranteed that the time will be different. In most cases, the clock
1028 will already have ticked while the message was being received.
1029
1030
1031 .section "Receiving mail" "SECID13"
1032 .cindex "receiving mail"
1033 .cindex "message" "reception"
1034 The only way Exim can receive mail from another host is using SMTP over
1035 TCP/IP, in which case the sender and recipient addresses are transferred using
1036 SMTP commands. However, from a locally running process (such as a user's MUA),
1037 there are several possibilities:
1038
1039 .ilist
1040 If the process runs Exim with the &%-bm%& option, the message is read
1041 non-interactively (usually via a pipe), with the recipients taken from the
1042 command line, or from the body of the message if &%-t%& is also used.
1043 .next
1044 If the process runs Exim with the &%-bS%& option, the message is also read
1045 non-interactively, but in this case the recipients are listed at the start of
1046 the message in a series of SMTP RCPT commands, terminated by a DATA
1047 command. This is so-called &"batch SMTP"& format,
1048 but it isn't really SMTP. The SMTP commands are just another way of passing
1049 envelope addresses in a non-interactive submission.
1050 .next
1051 If the process runs Exim with the &%-bs%& option, the message is read
1052 interactively, using the SMTP protocol. A two-way pipe is normally used for
1053 passing data between the local process and the Exim process.
1054 This is &"real"& SMTP and is handled in the same way as SMTP over TCP/IP. For
1055 example, the ACLs for SMTP commands are used for this form of submission.
1056 .next
1057 A local process may also make a TCP/IP call to the host's loopback address
1058 (127.0.0.1) or any other of its IP addresses. When receiving messages, Exim
1059 does not treat the loopback address specially. It treats all such connections
1060 in the same way as connections from other hosts.
1061 .endlist
1062
1063
1064 .cindex "message sender, constructed by Exim"
1065 .cindex "sender" "constructed by Exim"
1066 In the three cases that do not involve TCP/IP, the sender address is
1067 constructed from the login name of the user that called Exim and a default
1068 qualification domain (which can be set by the &%qualify_domain%& configuration
1069 option). For local or batch SMTP, a sender address that is passed using the
1070 SMTP MAIL command is ignored. However, the system administrator may allow
1071 certain users (&"trusted users"&) to specify a different sender address
1072 unconditionally, or all users to specify certain forms of different sender
1073 address. The &%-f%& option or the SMTP MAIL command is used to specify these
1074 different addresses. See section &<<SECTtrustedadmin>>& for details of trusted
1075 users, and the &%untrusted_set_sender%& option for a way of allowing untrusted
1076 users to change sender addresses.
1077
1078 Messages received by either of the non-interactive mechanisms are subject to
1079 checking by the non-SMTP ACL, if one is defined. Messages received using SMTP
1080 (either over TCP/IP, or interacting with a local process) can be checked by a
1081 number of ACLs that operate at different times during the SMTP session. Either
1082 individual recipients, or the entire message, can be rejected if local policy
1083 requirements are not met. The &[local_scan()]& function (see chapter
1084 &<<CHAPlocalscan>>&) is run for all incoming messages.
1085
1086 Exim can be configured not to start a delivery process when a message is
1087 received; this can be unconditional, or depend on the number of incoming SMTP
1088 connections or the system load. In these situations, new messages wait on the
1089 queue until a queue runner process picks them up. However, in standard
1090 configurations under normal conditions, delivery is started as soon as a
1091 message is received.
1092
1093
1094
1095
1096
1097 .section "Handling an incoming message" "SECID14"
1098 .cindex "spool directory" "files that hold a message"
1099 .cindex "file" "how a message is held"
1100 When Exim accepts a message, it writes two files in its spool directory. The
1101 first contains the envelope information, the current status of the message, and
1102 the header lines, and the second contains the body of the message. The names of
1103 the two spool files consist of the message id, followed by &`-H`& for the
1104 file containing the envelope and header, and &`-D`& for the data file.
1105
1106 .cindex "spool directory" "&_input_& sub-directory"
1107 By default all these message files are held in a single directory called
1108 &_input_& inside the general Exim spool directory. Some operating systems do
1109 not perform very well if the number of files in a directory gets large; to
1110 improve performance in such cases, the &%split_spool_directory%& option can be
1111 used. This causes Exim to split up the input files into 62 sub-directories
1112 whose names are single letters or digits. When this is done, the queue is
1113 processed one sub-directory at a time instead of all at once, which can improve
1114 overall performance even when there are not enough files in each directory to
1115 affect file system performance.
1116
1117 The envelope information consists of the address of the message's sender and
1118 the addresses of the recipients. This information is entirely separate from
1119 any addresses contained in the header lines. The status of the message includes
1120 a list of recipients who have already received the message. The format of the
1121 first spool file is described in chapter &<<CHAPspool>>&.
1122
1123 .cindex "rewriting" "addresses"
1124 Address rewriting that is specified in the rewrite section of the configuration
1125 (see chapter &<<CHAPrewrite>>&) is done once and for all on incoming addresses,
1126 both in the header lines and the envelope, at the time the message is accepted.
1127 If during the course of delivery additional addresses are generated (for
1128 example, via aliasing), these new addresses are rewritten as soon as they are
1129 generated. At the time a message is actually delivered (transported) further
1130 rewriting can take place; because this is a transport option, it can be
1131 different for different forms of delivery. It is also possible to specify the
1132 addition or removal of certain header lines at the time the message is
1133 delivered (see chapters &<<CHAProutergeneric>>& and
1134 &<<CHAPtransportgeneric>>&).
1135
1136
1137
1138 .section "Life of a message" "SECID15"
1139 .cindex "message" "life of"
1140 .cindex "message" "frozen"
1141 A message remains in the spool directory until it is completely delivered to
1142 its recipients or to an error address, or until it is deleted by an
1143 administrator or by the user who originally created it. In cases when delivery
1144 cannot proceed &-- for example, when a message can neither be delivered to its
1145 recipients nor returned to its sender, the message is marked &"frozen"& on the
1146 spool, and no more deliveries are attempted.
1147
1148 .cindex "frozen messages" "thawing"
1149 .cindex "message" "thawing frozen"
1150 An administrator can &"thaw"& such messages when the problem has been
1151 corrected, and can also freeze individual messages by hand if necessary. In
1152 addition, an administrator can force a delivery error, causing a bounce message
1153 to be sent.
1154
1155 .oindex "&%timeout_frozen_after%&"
1156 .oindex "&%ignore_bounce_errors_after%&"
1157 There are options called &%ignore_bounce_errors_after%& and
1158 &%timeout_frozen_after%&, which discard frozen messages after a certain time.
1159 The first applies only to frozen bounces, the second to any frozen messages.
1160
1161 .cindex "message" "log file for"
1162 .cindex "log" "file for each message"
1163 While Exim is working on a message, it writes information about each delivery
1164 attempt to its main log file. This includes successful, unsuccessful, and
1165 delayed deliveries for each recipient (see chapter &<<CHAPlog>>&). The log
1166 lines are also written to a separate &'message log'& file for each message.
1167 These logs are solely for the benefit of the administrator, and are normally
1168 deleted along with the spool files when processing of a message is complete.
1169 The use of individual message logs can be disabled by setting
1170 &%no_message_logs%&; this might give an improvement in performance on very busy
1171 systems.
1172
1173 .cindex "journal file"
1174 .cindex "file" "journal"
1175 All the information Exim itself needs to set up a delivery is kept in the first
1176 spool file, along with the header lines. When a successful delivery occurs, the
1177 address is immediately written at the end of a journal file, whose name is the
1178 message id followed by &`-J`&. At the end of a delivery run, if there are some
1179 addresses left to be tried again later, the first spool file (the &`-H`& file)
1180 is updated to indicate which these are, and the journal file is then deleted.
1181 Updating the spool file is done by writing a new file and renaming it, to
1182 minimize the possibility of data loss.
1183
1184 Should the system or the program crash after a successful delivery but before
1185 the spool file has been updated, the journal is left lying around. The next
1186 time Exim attempts to deliver the message, it reads the journal file and
1187 updates the spool file before proceeding. This minimizes the chances of double
1188 deliveries caused by crashes.
1189
1190
1191
1192 .section "Processing an address for delivery" "SECTprocaddress"
1193 .cindex "drivers" "definition of"
1194 .cindex "router" "definition of"
1195 .cindex "transport" "definition of"
1196 The main delivery processing elements of Exim are called &'routers'& and
1197 &'transports'&, and collectively these are known as &'drivers'&. Code for a
1198 number of them is provided in the source distribution, and compile-time options
1199 specify which ones are included in the binary. Run time options specify which
1200 ones are actually used for delivering messages.
1201
1202 .cindex "drivers" "instance definition"
1203 Each driver that is specified in the run time configuration is an &'instance'&
1204 of that particular driver type. Multiple instances are allowed; for example,
1205 you can set up several different &(smtp)& transports, each with different
1206 option values that might specify different ports or different timeouts. Each
1207 instance has its own identifying name. In what follows we will normally use the
1208 instance name when discussing one particular instance (that is, one specific
1209 configuration of the driver), and the generic driver name when discussing
1210 the driver's features in general.
1211
1212 A &'router'& is a driver that operates on an address, either determining how
1213 its delivery should happen, by assigning it to a specific transport, or
1214 converting the address into one or more new addresses (for example, via an
1215 alias file). A router may also explicitly choose to fail an address, causing it
1216 to be bounced.
1217
1218 A &'transport'& is a driver that transmits a copy of the message from Exim's
1219 spool to some destination. There are two kinds of transport: for a &'local'&
1220 transport, the destination is a file or a pipe on the local host, whereas for a
1221 &'remote'& transport the destination is some other host. A message is passed
1222 to a specific transport as a result of successful routing. If a message has
1223 several recipients, it may be passed to a number of different transports.
1224
1225 .cindex "preconditions" "definition of"
1226 An address is processed by passing it to each configured router instance in
1227 turn, subject to certain preconditions, until a router accepts the address or
1228 specifies that it should be bounced. We will describe this process in more
1229 detail shortly. First, as a simple example, we consider how each recipient
1230 address in a message is processed in a small configuration of three routers.
1231
1232 To make this a more concrete example, it is described in terms of some actual
1233 routers, but remember, this is only an example. You can configure Exim's
1234 routers in many different ways, and there may be any number of routers in a
1235 configuration.
1236
1237 The first router that is specified in a configuration is often one that handles
1238 addresses in domains that are not recognized specially by the local host. These
1239 are typically addresses for arbitrary domains on the Internet. A precondition
1240 is set up which looks for the special domains known to the host (for example,
1241 its own domain name), and the router is run for addresses that do &'not'&
1242 match. Typically, this is a router that looks up domains in the DNS in order to
1243 find the hosts to which this address routes. If it succeeds, the address is
1244 assigned to a suitable SMTP transport; if it does not succeed, the router is
1245 configured to fail the address.
1246
1247 The second router is reached only when the domain is recognized as one that
1248 &"belongs"& to the local host. This router does redirection &-- also known as
1249 aliasing and forwarding. When it generates one or more new addresses from the
1250 original, each of them is routed independently from the start. Otherwise, the
1251 router may cause an address to fail, or it may simply decline to handle the
1252 address, in which case the address is passed to the next router.
1253
1254 The final router in many configurations is one that checks to see if the
1255 address belongs to a local mailbox. The precondition may involve a check to
1256 see if the local part is the name of a login account, or it may look up the
1257 local part in a file or a database. If its preconditions are not met, or if
1258 the router declines, we have reached the end of the routers. When this happens,
1259 the address is bounced.
1260
1261
1262
1263 .section "Processing an address for verification" "SECID16"
1264 .cindex "router" "for verification"
1265 .cindex "verifying address" "overview"
1266 As well as being used to decide how to deliver to an address, Exim's routers
1267 are also used for &'address verification'&. Verification can be requested as
1268 one of the checks to be performed in an ACL for incoming messages, on both
1269 sender and recipient addresses, and it can be tested using the &%-bv%& and
1270 &%-bvs%& command line options.
1271
1272 When an address is being verified, the routers are run in &"verify mode"&. This
1273 does not affect the way the routers work, but it is a state that can be
1274 detected. By this means, a router can be skipped or made to behave differently
1275 when verifying. A common example is a configuration in which the first router
1276 sends all messages to a message-scanning program, unless they have been
1277 previously scanned. Thus, the first router accepts all addresses without any
1278 checking, making it useless for verifying. Normally, the &%no_verify%& option
1279 would be set for such a router, causing it to be skipped in verify mode.
1280
1281
1282
1283
1284 .section "Running an individual router" "SECTrunindrou"
1285 .cindex "router" "running details"
1286 .cindex "preconditions" "checking"
1287 .cindex "router" "result of running"
1288 As explained in the example above, a number of preconditions are checked before
1289 running a router. If any are not met, the router is skipped, and the address is
1290 passed to the next router. When all the preconditions on a router &'are'& met,
1291 the router is run. What happens next depends on the outcome, which is one of
1292 the following:
1293
1294 .ilist
1295 &'accept'&: The router accepts the address, and either assigns it to a
1296 transport, or generates one or more &"child"& addresses. Processing the
1297 original address ceases,
1298 .oindex "&%unseen%&"
1299 unless the &%unseen%& option is set on the router. This option
1300 can be used to set up multiple deliveries with different routing (for example,
1301 for keeping archive copies of messages). When &%unseen%& is set, the address is
1302 passed to the next router. Normally, however, an &'accept'& return marks the
1303 end of routing.
1304
1305 Any child addresses generated by the router are processed independently,
1306 starting with the first router by default. It is possible to change this by
1307 setting the &%redirect_router%& option to specify which router to start at for
1308 child addresses. Unlike &%pass_router%& (see below) the router specified by
1309 &%redirect_router%& may be anywhere in the router configuration.
1310 .next
1311 &'pass'&: The router recognizes the address, but cannot handle it itself. It
1312 requests that the address be passed to another router. By default the address
1313 is passed to the next router, but this can be changed by setting the
1314 &%pass_router%& option. However, (unlike &%redirect_router%&) the named router
1315 must be below the current router (to avoid loops).
1316 .next
1317 &'decline'&: The router declines to accept the address because it does not
1318 recognize it at all. By default, the address is passed to the next router, but
1319 this can be prevented by setting the &%no_more%& option. When &%no_more%& is
1320 set, all the remaining routers are skipped. In effect, &%no_more%& converts
1321 &'decline'& into &'fail'&.
1322 .next
1323 &'fail'&: The router determines that the address should fail, and queues it for
1324 the generation of a bounce message. There is no further processing of the
1325 original address unless &%unseen%& is set on the router.
1326 .next
1327 &'defer'&: The router cannot handle the address at the present time. (A
1328 database may be offline, or a DNS lookup may have timed out.) No further
1329 processing of the address happens in this delivery attempt. It is tried again
1330 next time the message is considered for delivery.
1331 .next
1332 &'error'&: There is some error in the router (for example, a syntax error in
1333 its configuration). The action is as for defer.
1334 .endlist
1335
1336 If an address reaches the end of the routers without having been accepted by
1337 any of them, it is bounced as unrouteable. The default error message in this
1338 situation is &"unrouteable address"&, but you can set your own message by
1339 making use of the &%cannot_route_message%& option. This can be set for any
1340 router; the value from the last router that &"saw"& the address is used.
1341
1342 Sometimes while routing you want to fail a delivery when some conditions are
1343 met but others are not, instead of passing the address on for further routing.
1344 You can do this by having a second router that explicitly fails the delivery
1345 when the relevant conditions are met. The &(redirect)& router has a &"fail"&
1346 facility for this purpose.
1347
1348
1349 .section "Duplicate addresses" "SECID17"
1350 .cindex "case of local parts"
1351 .cindex "address duplicate, discarding"
1352 .cindex "duplicate addresses"
1353 Once routing is complete, Exim scans the addresses that are assigned to local
1354 and remote transports, and discards any duplicates that it finds. During this
1355 check, local parts are treated as case-sensitive. This happens only when
1356 actually delivering a message; when testing routers with &%-bt%&, all the
1357 routed addresses are shown.
1358
1359
1360
1361 .section "Router preconditions" "SECTrouprecon"
1362 .cindex "router" "preconditions, order of processing"
1363 .cindex "preconditions" "order of processing"
1364 The preconditions that are tested for each router are listed below, in the
1365 order in which they are tested. The individual configuration options are
1366 described in more detail in chapter &<<CHAProutergeneric>>&.
1367
1368 .ilist
1369 The &%local_part_prefix%& and &%local_part_suffix%& options can specify that
1370 the local parts handled by the router may or must have certain prefixes and/or
1371 suffixes. If a mandatory affix (prefix or suffix) is not present, the router is
1372 skipped. These conditions are tested first. When an affix is present, it is
1373 removed from the local part before further processing, including the evaluation
1374 of any other conditions.
1375 .next
1376 Routers can be designated for use only when not verifying an address, that is,
1377 only when routing it for delivery (or testing its delivery routing). If the
1378 &%verify%& option is set false, the router is skipped when Exim is verifying an
1379 address.
1380 Setting the &%verify%& option actually sets two options, &%verify_sender%& and
1381 &%verify_recipient%&, which independently control the use of the router for
1382 sender and recipient verification. You can set these options directly if
1383 you want a router to be used for only one type of verification.
1384 Note that cutthrough delivery is classed as a recipient verification
1385 for this purpose.
1386 .next
1387 If the &%address_test%& option is set false, the router is skipped when Exim is
1388 run with the &%-bt%& option to test an address routing. This can be helpful
1389 when the first router sends all new messages to a scanner of some sort; it
1390 makes it possible to use &%-bt%& to test subsequent delivery routing without
1391 having to simulate the effect of the scanner.
1392 .next
1393 Routers can be designated for use only when verifying an address, as
1394 opposed to routing it for delivery. The &%verify_only%& option controls this.
1395 Again, cutthrough delibery counts as a verification.
1396 .next
1397 Individual routers can be explicitly skipped when running the routers to
1398 check an address given in the SMTP EXPN command (see the &%expn%& option).
1399 .next
1400 If the &%domains%& option is set, the domain of the address must be in the set
1401 of domains that it defines.
1402 .next
1403 .vindex "&$local_part_prefix$&"
1404 .vindex "&$local_part$&"
1405 .vindex "&$local_part_suffix$&"
1406 If the &%local_parts%& option is set, the local part of the address must be in
1407 the set of local parts that it defines. If &%local_part_prefix%& or
1408 &%local_part_suffix%& is in use, the prefix or suffix is removed from the local
1409 part before this check. If you want to do precondition tests on local parts
1410 that include affixes, you can do so by using a &%condition%& option (see below)
1411 that uses the variables &$local_part$&, &$local_part_prefix$&, and
1412 &$local_part_suffix$& as necessary.
1413 .next
1414 .vindex "&$local_user_uid$&"
1415 .vindex "&$local_user_gid$&"
1416 .vindex "&$home$&"
1417 If the &%check_local_user%& option is set, the local part must be the name of
1418 an account on the local host. If this check succeeds, the uid and gid of the
1419 local user are placed in &$local_user_uid$& and &$local_user_gid$& and the
1420 user's home directory is placed in &$home$&; these values can be used in the
1421 remaining preconditions.
1422 .next
1423 If the &%router_home_directory%& option is set, it is expanded at this point,
1424 because it overrides the value of &$home$&. If this expansion were left till
1425 later, the value of &$home$& as set by &%check_local_user%& would be used in
1426 subsequent tests. Having two different values of &$home$& in the same router
1427 could lead to confusion.
1428 .next
1429 If the &%senders%& option is set, the envelope sender address must be in the
1430 set of addresses that it defines.
1431 .next
1432 If the &%require_files%& option is set, the existence or non-existence of
1433 specified files is tested.
1434 .next
1435 .cindex "customizing" "precondition"
1436 If the &%condition%& option is set, it is evaluated and tested. This option
1437 uses an expanded string to allow you to set up your own custom preconditions.
1438 Expanded strings are described in chapter &<<CHAPexpand>>&.
1439 .endlist
1440
1441
1442 Note that &%require_files%& comes near the end of the list, so you cannot use
1443 it to check for the existence of a file in which to lookup up a domain, local
1444 part, or sender. However, as these options are all expanded, you can use the
1445 &%exists%& expansion condition to make such tests within each condition. The
1446 &%require_files%& option is intended for checking files that the router may be
1447 going to use internally, or which are needed by a specific transport (for
1448 example, &_.procmailrc_&).
1449
1450
1451
1452 .section "Delivery in detail" "SECID18"
1453 .cindex "delivery" "in detail"
1454 When a message is to be delivered, the sequence of events is as follows:
1455
1456 .ilist
1457 If a system-wide filter file is specified, the message is passed to it. The
1458 filter may add recipients to the message, replace the recipients, discard the
1459 message, cause a new message to be generated, or cause the message delivery to
1460 fail. The format of the system filter file is the same as for Exim user filter
1461 files, described in the separate document entitled &'Exim's interfaces to mail
1462 filtering'&.
1463 .cindex "Sieve filter" "not available for system filter"
1464 (&*Note*&: Sieve cannot be used for system filter files.)
1465
1466 Some additional features are available in system filters &-- see chapter
1467 &<<CHAPsystemfilter>>& for details. Note that a message is passed to the system
1468 filter only once per delivery attempt, however many recipients it has. However,
1469 if there are several delivery attempts because one or more addresses could not
1470 be immediately delivered, the system filter is run each time. The filter
1471 condition &%first_delivery%& can be used to detect the first run of the system
1472 filter.
1473 .next
1474 Each recipient address is offered to each configured router in turn, subject to
1475 its preconditions, until one is able to handle it. If no router can handle the
1476 address, that is, if they all decline, the address is failed. Because routers
1477 can be targeted at particular domains, several locally handled domains can be
1478 processed entirely independently of each other.
1479 .next
1480 .cindex "routing" "loops in"
1481 .cindex "loop" "while routing"
1482 A router that accepts an address may assign it to a local or a remote
1483 transport. However, the transport is not run at this time. Instead, the address
1484 is placed on a list for the particular transport, which will be run later.
1485 Alternatively, the router may generate one or more new addresses (typically
1486 from alias, forward, or filter files). New addresses are fed back into this
1487 process from the top, but in order to avoid loops, a router ignores any address
1488 which has an identically-named ancestor that was processed by itself.
1489 .next
1490 When all the routing has been done, addresses that have been successfully
1491 handled are passed to their assigned transports. When local transports are
1492 doing real local deliveries, they handle only one address at a time, but if a
1493 local transport is being used as a pseudo-remote transport (for example, to
1494 collect batched SMTP messages for transmission by some other means) multiple
1495 addresses can be handled. Remote transports can always handle more than one
1496 address at a time, but can be configured not to do so, or to restrict multiple
1497 addresses to the same domain.
1498 .next
1499 Each local delivery to a file or a pipe runs in a separate process under a
1500 non-privileged uid, and these deliveries are run one at a time. Remote
1501 deliveries also run in separate processes, normally under a uid that is private
1502 to Exim (&"the Exim user"&), but in this case, several remote deliveries can be
1503 run in parallel. The maximum number of simultaneous remote deliveries for any
1504 one message is set by the &%remote_max_parallel%& option.
1505 The order in which deliveries are done is not defined, except that all local
1506 deliveries happen before any remote deliveries.
1507 .next
1508 .cindex "queue runner"
1509 When it encounters a local delivery during a queue run, Exim checks its retry
1510 database to see if there has been a previous temporary delivery failure for the
1511 address before running the local transport. If there was a previous failure,
1512 Exim does not attempt a new delivery until the retry time for the address is
1513 reached. However, this happens only for delivery attempts that are part of a
1514 queue run. Local deliveries are always attempted when delivery immediately
1515 follows message reception, even if retry times are set for them. This makes for
1516 better behaviour if one particular message is causing problems (for example,
1517 causing quota overflow, or provoking an error in a filter file).
1518 .next
1519 .cindex "delivery" "retry in remote transports"
1520 Remote transports do their own retry handling, since an address may be
1521 deliverable to one of a number of hosts, each of which may have a different
1522 retry time. If there have been previous temporary failures and no host has
1523 reached its retry time, no delivery is attempted, whether in a queue run or
1524 not. See chapter &<<CHAPretry>>& for details of retry strategies.
1525 .next
1526 If there were any permanent errors, a bounce message is returned to an
1527 appropriate address (the sender in the common case), with details of the error
1528 for each failing address. Exim can be configured to send copies of bounce
1529 messages to other addresses.
1530 .next
1531 .cindex "delivery" "deferral"
1532 If one or more addresses suffered a temporary failure, the message is left on
1533 the queue, to be tried again later. Delivery of these addresses is said to be
1534 &'deferred'&.
1535 .next
1536 When all the recipient addresses have either been delivered or bounced,
1537 handling of the message is complete. The spool files and message log are
1538 deleted, though the message log can optionally be preserved if required.
1539 .endlist
1540
1541
1542
1543
1544 .section "Retry mechanism" "SECID19"
1545 .cindex "delivery" "retry mechanism"
1546 .cindex "retry" "description of mechanism"
1547 .cindex "queue runner"
1548 Exim's mechanism for retrying messages that fail to get delivered at the first
1549 attempt is the queue runner process. You must either run an Exim daemon that
1550 uses the &%-q%& option with a time interval to start queue runners at regular
1551 intervals, or use some other means (such as &'cron'&) to start them. If you do
1552 not arrange for queue runners to be run, messages that fail temporarily at the
1553 first attempt will remain on your queue for ever. A queue runner process works
1554 its way through the queue, one message at a time, trying each delivery that has
1555 passed its retry time.
1556 You can run several queue runners at once.
1557
1558 Exim uses a set of configured rules to determine when next to retry the failing
1559 address (see chapter &<<CHAPretry>>&). These rules also specify when Exim
1560 should give up trying to deliver to the address, at which point it generates a
1561 bounce message. If no retry rules are set for a particular host, address, and
1562 error combination, no retries are attempted, and temporary errors are treated
1563 as permanent.
1564
1565
1566
1567 .section "Temporary delivery failure" "SECID20"
1568 .cindex "delivery" "temporary failure"
1569 There are many reasons why a message may not be immediately deliverable to a
1570 particular address. Failure to connect to a remote machine (because it, or the
1571 connection to it, is down) is one of the most common. Temporary failures may be
1572 detected during routing as well as during the transport stage of delivery.
1573 Local deliveries may be delayed if NFS files are unavailable, or if a mailbox
1574 is on a file system where the user is over quota. Exim can be configured to
1575 impose its own quotas on local mailboxes; where system quotas are set they will
1576 also apply.
1577
1578 If a host is unreachable for a period of time, a number of messages may be
1579 waiting for it by the time it recovers, and sending them in a single SMTP
1580 connection is clearly beneficial. Whenever a delivery to a remote host is
1581 deferred,
1582 .cindex "hints database"
1583 Exim makes a note in its hints database, and whenever a successful
1584 SMTP delivery has happened, it looks to see if any other messages are waiting
1585 for the same host. If any are found, they are sent over the same SMTP
1586 connection, subject to a configuration limit as to the maximum number in any
1587 one connection.
1588
1589
1590
1591 .section "Permanent delivery failure" "SECID21"
1592 .cindex "delivery" "permanent failure"
1593 .cindex "bounce message" "when generated"
1594 When a message cannot be delivered to some or all of its intended recipients, a
1595 bounce message is generated. Temporary delivery failures turn into permanent
1596 errors when their timeout expires. All the addresses that fail in a given
1597 delivery attempt are listed in a single message. If the original message has
1598 many recipients, it is possible for some addresses to fail in one delivery
1599 attempt and others to fail subsequently, giving rise to more than one bounce
1600 message. The wording of bounce messages can be customized by the administrator.
1601 See chapter &<<CHAPemsgcust>>& for details.
1602
1603 .cindex "&'X-Failed-Recipients:'& header line"
1604 Bounce messages contain an &'X-Failed-Recipients:'& header line that lists the
1605 failed addresses, for the benefit of programs that try to analyse such messages
1606 automatically.
1607
1608 .cindex "bounce message" "recipient of"
1609 A bounce message is normally sent to the sender of the original message, as
1610 obtained from the message's envelope. For incoming SMTP messages, this is the
1611 address given in the MAIL command. However, when an address is expanded via a
1612 forward or alias file, an alternative address can be specified for delivery
1613 failures of the generated addresses. For a mailing list expansion (see section
1614 &<<SECTmailinglists>>&) it is common to direct bounce messages to the manager
1615 of the list.
1616
1617
1618
1619 .section "Failures to deliver bounce messages" "SECID22"
1620 .cindex "bounce message" "failure to deliver"
1621 If a bounce message (either locally generated or received from a remote host)
1622 itself suffers a permanent delivery failure, the message is left on the queue,
1623 but it is frozen, awaiting the attention of an administrator. There are options
1624 that can be used to make Exim discard such failed messages, or to keep them
1625 for only a short time (see &%timeout_frozen_after%& and
1626 &%ignore_bounce_errors_after%&).
1627
1628
1629
1630
1631
1632 . ////////////////////////////////////////////////////////////////////////////
1633 . ////////////////////////////////////////////////////////////////////////////
1634
1635 .chapter "Building and installing Exim" "CHID3"
1636 .scindex IIDbuex "building Exim"
1637
1638 .section "Unpacking" "SECID23"
1639 Exim is distributed as a gzipped or bzipped tar file which, when unpacked,
1640 creates a directory with the name of the current release (for example,
1641 &_exim-&version()_&) into which the following files are placed:
1642
1643 .table2 140pt
1644 .irow &_ACKNOWLEDGMENTS_& "contains some acknowledgments"
1645 .irow &_CHANGES_&         "contains a reference to where changes are &&&
1646   documented"
1647 .irow &_LICENCE_&         "the GNU General Public Licence"
1648 .irow &_Makefile_&        "top-level make file"
1649 .irow &_NOTICE_&          "conditions for the use of Exim"
1650 .irow &_README_&          "list of files, directories and simple build &&&
1651   instructions"
1652 .endtable
1653
1654 Other files whose names begin with &_README_& may also be present. The
1655 following subdirectories are created:
1656
1657 .table2 140pt
1658 .irow &_Local_&           "an empty directory for local configuration files"
1659 .irow &_OS_&              "OS-specific files"
1660 .irow &_doc_&             "documentation files"
1661 .irow &_exim_monitor_&    "source files for the Exim monitor"
1662 .irow &_scripts_&         "scripts used in the build process"
1663 .irow &_src_&             "remaining source files"
1664 .irow &_util_&            "independent utilities"
1665 .endtable
1666
1667 The main utility programs are contained in the &_src_& directory, and are built
1668 with the Exim binary. The &_util_& directory contains a few optional scripts
1669 that may be useful to some sites.
1670
1671
1672 .section "Multiple machine architectures and operating systems" "SECID24"
1673 .cindex "building Exim" "multiple OS/architectures"
1674 The building process for Exim is arranged to make it easy to build binaries for
1675 a number of different architectures and operating systems from the same set of
1676 source files. Compilation does not take place in the &_src_& directory.
1677 Instead, a &'build directory'& is created for each architecture and operating
1678 system.
1679 .cindex "symbolic link" "to build directory"
1680 Symbolic links to the sources are installed in this directory, which is where
1681 the actual building takes place. In most cases, Exim can discover the machine
1682 architecture and operating system for itself, but the defaults can be
1683 overridden if necessary.
1684
1685
1686 .section "PCRE library" "SECTpcre"
1687 .cindex "PCRE library"
1688 Exim no longer has an embedded PCRE library as the vast majority of
1689 modern systems include PCRE as a system library, although you may need
1690 to install the PCRE or PCRE development package for your operating
1691 system. If your system has a normal PCRE installation the Exim build
1692 process will need no further configuration. If the library or the
1693 headers are in an unusual location you will need to either set the PCRE_LIBS
1694 and INCLUDE directives appropriately,
1695 or set PCRE_CONFIG=yes to use the installed &(pcre-config)& command.
1696 If your operating system has no
1697 PCRE support then you will need to obtain and build the current PCRE
1698 from &url(ftp://ftp.csx.cam.ac.uk/pub/software/programming/pcre/).
1699 More information on PCRE is available at &url(http://www.pcre.org/).
1700
1701 .section "DBM libraries" "SECTdb"
1702 .cindex "DBM libraries" "discussion of"
1703 .cindex "hints database" "DBM files used for"
1704 Even if you do not use any DBM files in your configuration, Exim still needs a
1705 DBM library in order to operate, because it uses indexed files for its hints
1706 databases. Unfortunately, there are a number of DBM libraries in existence, and
1707 different operating systems often have different ones installed.
1708
1709 .cindex "Solaris" "DBM library for"
1710 .cindex "IRIX, DBM library for"
1711 .cindex "BSD, DBM library for"
1712 .cindex "Linux, DBM library for"
1713 If you are using Solaris, IRIX, one of the modern BSD systems, or a modern
1714 Linux distribution, the DBM configuration should happen automatically, and you
1715 may be able to ignore this section. Otherwise, you may have to learn more than
1716 you would like about DBM libraries from what follows.
1717
1718 .cindex "&'ndbm'& DBM library"
1719 Licensed versions of Unix normally contain a library of DBM functions operating
1720 via the &'ndbm'& interface, and this is what Exim expects by default. Free
1721 versions of Unix seem to vary in what they contain as standard. In particular,
1722 some early versions of Linux have no default DBM library, and different
1723 distributors have chosen to bundle different libraries with their packaged
1724 versions. However, the more recent releases seem to have standardized on the
1725 Berkeley DB library.
1726
1727 Different DBM libraries have different conventions for naming the files they
1728 use. When a program opens a file called &_dbmfile_&, there are several
1729 possibilities:
1730
1731 .olist
1732 A traditional &'ndbm'& implementation, such as that supplied as part of
1733 Solaris, operates on two files called &_dbmfile.dir_& and &_dbmfile.pag_&.
1734 .next
1735 .cindex "&'gdbm'& DBM library"
1736 The GNU library, &'gdbm'&, operates on a single file. If used via its &'ndbm'&
1737 compatibility interface it makes two different hard links to it with names
1738 &_dbmfile.dir_& and &_dbmfile.pag_&, but if used via its native interface, the
1739 file name is used unmodified.
1740 .next
1741 .cindex "Berkeley DB library"
1742 The Berkeley DB package, if called via its &'ndbm'& compatibility interface,
1743 operates on a single file called &_dbmfile.db_&, but otherwise looks to the
1744 programmer exactly the same as the traditional &'ndbm'& implementation.
1745 .next
1746 If the Berkeley package is used in its native mode, it operates on a single
1747 file called &_dbmfile_&; the programmer's interface is somewhat different to
1748 the traditional &'ndbm'& interface.
1749 .next
1750 To complicate things further, there are several very different versions of the
1751 Berkeley DB package. Version 1.85 was stable for a very long time, releases
1752 2.&'x'& and 3.&'x'& were current for a while, but the latest versions are now
1753 numbered 4.&'x'&. Maintenance of some of the earlier releases has ceased. All
1754 versions of Berkeley DB can be obtained from
1755 &url(http://www.sleepycat.com/).
1756 .next
1757 .cindex "&'tdb'& DBM library"
1758 Yet another DBM library, called &'tdb'&, is available from
1759 &url(http://download.sourceforge.net/tdb). It has its own interface, and also
1760 operates on a single file.
1761 .endlist
1762
1763 .cindex "USE_DB"
1764 .cindex "DBM libraries" "configuration for building"
1765 Exim and its utilities can be compiled to use any of these interfaces. In order
1766 to use any version of the Berkeley DB package in native mode, you must set
1767 USE_DB in an appropriate configuration file (typically
1768 &_Local/Makefile_&). For example:
1769 .code
1770 USE_DB=yes
1771 .endd
1772 Similarly, for gdbm you set USE_GDBM, and for tdb you set USE_TDB. An
1773 error is diagnosed if you set more than one of these.
1774
1775 At the lowest level, the build-time configuration sets none of these options,
1776 thereby assuming an interface of type (1). However, some operating system
1777 configuration files (for example, those for the BSD operating systems and
1778 Linux) assume type (4) by setting USE_DB as their default, and the
1779 configuration files for Cygwin set USE_GDBM. Anything you set in
1780 &_Local/Makefile_&, however, overrides these system defaults.
1781
1782 As well as setting USE_DB, USE_GDBM, or USE_TDB, it may also be
1783 necessary to set DBMLIB, to cause inclusion of the appropriate library, as
1784 in one of these lines:
1785 .code
1786 DBMLIB = -ldb
1787 DBMLIB = -ltdb
1788 .endd
1789 Settings like that will work if the DBM library is installed in the standard
1790 place. Sometimes it is not, and the library's header file may also not be in
1791 the default path. You may need to set INCLUDE to specify where the header
1792 file is, and to specify the path to the library more fully in DBMLIB, as in
1793 this example:
1794 .code
1795 INCLUDE=-I/usr/local/include/db-4.1
1796 DBMLIB=/usr/local/lib/db-4.1/libdb.a
1797 .endd
1798 There is further detailed discussion about the various DBM libraries in the
1799 file &_doc/dbm.discuss.txt_& in the Exim distribution.
1800
1801
1802
1803 .section "Pre-building configuration" "SECID25"
1804 .cindex "building Exim" "pre-building configuration"
1805 .cindex "configuration for building Exim"
1806 .cindex "&_Local/Makefile_&"
1807 .cindex "&_src/EDITME_&"
1808 Before building Exim, a local configuration file that specifies options
1809 independent of any operating system has to be created with the name
1810 &_Local/Makefile_&. A template for this file is supplied as the file
1811 &_src/EDITME_&, and it contains full descriptions of all the option settings
1812 therein. These descriptions are therefore not repeated here. If you are
1813 building Exim for the first time, the simplest thing to do is to copy
1814 &_src/EDITME_& to &_Local/Makefile_&, then read it and edit it appropriately.
1815
1816 There are three settings that you must supply, because Exim will not build
1817 without them. They are the location of the run time configuration file
1818 (CONFIGURE_FILE), the directory in which Exim binaries will be installed
1819 (BIN_DIRECTORY), and the identity of the Exim user (EXIM_USER and
1820 maybe EXIM_GROUP as well). The value of CONFIGURE_FILE can in fact be
1821 a colon-separated list of file names; Exim uses the first of them that exists.
1822
1823 There are a few other parameters that can be specified either at build time or
1824 at run time, to enable the same binary to be used on a number of different
1825 machines. However, if the locations of Exim's spool directory and log file
1826 directory (if not within the spool directory) are fixed, it is recommended that
1827 you specify them in &_Local/Makefile_& instead of at run time, so that errors
1828 detected early in Exim's execution (such as a malformed configuration file) can
1829 be logged.
1830
1831 .cindex "content scanning" "specifying at build time"
1832 Exim's interfaces for calling virus and spam scanning software directly from
1833 access control lists are not compiled by default. If you want to include these
1834 facilities, you need to set
1835 .code
1836 WITH_CONTENT_SCAN=yes
1837 .endd
1838 in your &_Local/Makefile_&. For details of the facilities themselves, see
1839 chapter &<<CHAPexiscan>>&.
1840
1841
1842 .cindex "&_Local/eximon.conf_&"
1843 .cindex "&_exim_monitor/EDITME_&"
1844 If you are going to build the Exim monitor, a similar configuration process is
1845 required. The file &_exim_monitor/EDITME_& must be edited appropriately for
1846 your installation and saved under the name &_Local/eximon.conf_&. If you are
1847 happy with the default settings described in &_exim_monitor/EDITME_&,
1848 &_Local/eximon.conf_& can be empty, but it must exist.
1849
1850 This is all the configuration that is needed in straightforward cases for known
1851 operating systems. However, the building process is set up so that it is easy
1852 to override options that are set by default or by operating-system-specific
1853 configuration files, for example to change the name of the C compiler, which
1854 defaults to &%gcc%&. See section &<<SECToverride>>& below for details of how to
1855 do this.
1856
1857
1858
1859 .section "Support for iconv()" "SECID26"
1860 .cindex "&[iconv()]& support"
1861 .cindex "RFC 2047"
1862 The contents of header lines in messages may be encoded according to the rules
1863 described RFC 2047. This makes it possible to transmit characters that are not
1864 in the ASCII character set, and to label them as being in a particular
1865 character set. When Exim is inspecting header lines by means of the &%$h_%&
1866 mechanism, it decodes them, and translates them into a specified character set
1867 (default ISO-8859-1). The translation is possible only if the operating system
1868 supports the &[iconv()]& function.
1869
1870 However, some of the operating systems that supply &[iconv()]& do not support
1871 very many conversions. The GNU &%libiconv%& library (available from
1872 &url(http://www.gnu.org/software/libiconv/)) can be installed on such
1873 systems to remedy this deficiency, as well as on systems that do not supply
1874 &[iconv()]& at all. After installing &%libiconv%&, you should add
1875 .code
1876 HAVE_ICONV=yes
1877 .endd
1878 to your &_Local/Makefile_& and rebuild Exim.
1879
1880
1881
1882 .section "Including TLS/SSL encryption support" "SECTinctlsssl"
1883 .cindex "TLS" "including support for TLS"
1884 .cindex "encryption" "including support for"
1885 .cindex "SUPPORT_TLS"
1886 .cindex "OpenSSL" "building Exim with"
1887 .cindex "GnuTLS" "building Exim with"
1888 Exim can be built to support encrypted SMTP connections, using the STARTTLS
1889 command as per RFC 2487. It can also support legacy clients that expect to
1890 start a TLS session immediately on connection to a non-standard port (see the
1891 &%tls_on_connect_ports%& runtime option and the &%-tls-on-connect%& command
1892 line option).
1893
1894 If you want to build Exim with TLS support, you must first install either the
1895 OpenSSL or GnuTLS library. There is no cryptographic code in Exim itself for
1896 implementing SSL.
1897
1898 If OpenSSL is installed, you should set
1899 .code
1900 SUPPORT_TLS=yes
1901 TLS_LIBS=-lssl -lcrypto
1902 .endd
1903 in &_Local/Makefile_&. You may also need to specify the locations of the
1904 OpenSSL library and include files. For example:
1905 .code
1906 SUPPORT_TLS=yes
1907 TLS_LIBS=-L/usr/local/openssl/lib -lssl -lcrypto
1908 TLS_INCLUDE=-I/usr/local/openssl/include/
1909 .endd
1910 .cindex "pkg-config" "OpenSSL"
1911 If you have &'pkg-config'& available, then instead you can just use:
1912 .code
1913 SUPPORT_TLS=yes
1914 USE_OPENSSL_PC=openssl
1915 .endd
1916 .cindex "USE_GNUTLS"
1917 If GnuTLS is installed, you should set
1918 .code
1919 SUPPORT_TLS=yes
1920 USE_GNUTLS=yes
1921 TLS_LIBS=-lgnutls -ltasn1 -lgcrypt
1922 .endd
1923 in &_Local/Makefile_&, and again you may need to specify the locations of the
1924 library and include files. For example:
1925 .code
1926 SUPPORT_TLS=yes
1927 USE_GNUTLS=yes
1928 TLS_LIBS=-L/usr/gnu/lib -lgnutls -ltasn1 -lgcrypt
1929 TLS_INCLUDE=-I/usr/gnu/include
1930 .endd
1931 .cindex "pkg-config" "GnuTLS"
1932 If you have &'pkg-config'& available, then instead you can just use:
1933 .code
1934 SUPPORT_TLS=yes
1935 USE_GNUTLS=yes
1936 USE_GNUTLS_PC=gnutls
1937 .endd
1938
1939 You do not need to set TLS_INCLUDE if the relevant directory is already
1940 specified in INCLUDE. Details of how to configure Exim to make use of TLS are
1941 given in chapter &<<CHAPTLS>>&.
1942
1943
1944
1945
1946 .section "Use of tcpwrappers" "SECID27"
1947
1948 .cindex "tcpwrappers, building Exim to support"
1949 .cindex "USE_TCP_WRAPPERS"
1950 .cindex "TCP_WRAPPERS_DAEMON_NAME"
1951 .cindex "tcp_wrappers_daemon_name"
1952 Exim can be linked with the &'tcpwrappers'& library in order to check incoming
1953 SMTP calls using the &'tcpwrappers'& control files. This may be a convenient
1954 alternative to Exim's own checking facilities for installations that are
1955 already making use of &'tcpwrappers'& for other purposes. To do this, you
1956 should set USE_TCP_WRAPPERS in &_Local/Makefile_&, arrange for the file
1957 &_tcpd.h_& to be available at compile time, and also ensure that the library
1958 &_libwrap.a_& is available at link time, typically by including &%-lwrap%& in
1959 EXTRALIBS_EXIM. For example, if &'tcpwrappers'& is installed in &_/usr/local_&,
1960 you might have
1961 .code
1962 USE_TCP_WRAPPERS=yes
1963 CFLAGS=-O -I/usr/local/include
1964 EXTRALIBS_EXIM=-L/usr/local/lib -lwrap
1965 .endd
1966 in &_Local/Makefile_&. The daemon name to use in the &'tcpwrappers'& control
1967 files is &"exim"&. For example, the line
1968 .code
1969 exim : LOCAL  192.168.1.  .friendly.domain.example
1970 .endd
1971 in your &_/etc/hosts.allow_& file allows connections from the local host, from
1972 the subnet 192.168.1.0/24, and from all hosts in &'friendly.domain.example'&.
1973 All other connections are denied. The daemon name used by &'tcpwrappers'&
1974 can be changed at build time by setting TCP_WRAPPERS_DAEMON_NAME in
1975 &_Local/Makefile_&, or by setting tcp_wrappers_daemon_name in the
1976 configure file. Consult the &'tcpwrappers'& documentation for
1977 further details.
1978
1979
1980 .section "Including support for IPv6" "SECID28"
1981 .cindex "IPv6" "including support for"
1982 Exim contains code for use on systems that have IPv6 support. Setting
1983 &`HAVE_IPV6=YES`& in &_Local/Makefile_& causes the IPv6 code to be included;
1984 it may also be necessary to set IPV6_INCLUDE and IPV6_LIBS on systems
1985 where the IPv6 support is not fully integrated into the normal include and
1986 library files.
1987
1988 Two different types of DNS record for handling IPv6 addresses have been
1989 defined. AAAA records (analogous to A records for IPv4) are in use, and are
1990 currently seen as the mainstream. Another record type called A6 was proposed
1991 as better than AAAA because it had more flexibility. However, it was felt to be
1992 over-complex, and its status was reduced to &"experimental"&. It is not known
1993 if anyone is actually using A6 records. Exim has support for A6 records, but
1994 this is included only if you set &`SUPPORT_A6=YES`& in &_Local/Makefile_&. The
1995 support has not been tested for some time.
1996
1997
1998
1999 .section "Dynamically loaded lookup module support" "SECTdynamicmodules"
2000 .cindex "lookup modules"
2001 .cindex "dynamic modules"
2002 .cindex ".so building"
2003 On some platforms, Exim supports not compiling all lookup types directly into
2004 the main binary, instead putting some into external modules which can be loaded
2005 on demand.
2006 This permits packagers to build Exim with support for lookups with extensive
2007 library dependencies without requiring all users to install all of those
2008 dependencies.
2009 Most, but not all, lookup types can be built this way.
2010
2011 Set &`LOOKUP_MODULE_DIR`& to the directory into which the modules will be
2012 installed; Exim will only load modules from that directory, as a security
2013 measure.  You will need to set &`CFLAGS_DYNAMIC`& if not already defined
2014 for your OS; see &_OS/Makefile-Linux_& for an example.
2015 Some other requirements for adjusting &`EXTRALIBS`& may also be necessary,
2016 see &_src/EDITME_& for details.
2017
2018 Then, for each module to be loaded dynamically, define the relevant
2019 &`LOOKUP_`&<&'lookup_type'&> flags to have the value "2" instead of "yes".
2020 For example, this will build in lsearch but load sqlite and mysql support
2021 on demand:
2022 .code
2023 LOOKUP_LSEARCH=yes
2024 LOOKUP_SQLITE=2
2025 LOOKUP_MYSQL=2
2026 .endd
2027
2028
2029 .section "The building process" "SECID29"
2030 .cindex "build directory"
2031 Once &_Local/Makefile_& (and &_Local/eximon.conf_&, if required) have been
2032 created, run &'make'& at the top level. It determines the architecture and
2033 operating system types, and creates a build directory if one does not exist.
2034 For example, on a Sun system running Solaris 8, the directory
2035 &_build-SunOS5-5.8-sparc_& is created.
2036 .cindex "symbolic link" "to source files"
2037 Symbolic links to relevant source files are installed in the build directory.
2038
2039 &*Warning*&: The &%-j%& (parallel) flag must not be used with &'make'&; the
2040 building process fails if it is set.
2041
2042 If this is the first time &'make'& has been run, it calls a script that builds
2043 a make file inside the build directory, using the configuration files from the
2044 &_Local_& directory. The new make file is then passed to another instance of
2045 &'make'&. This does the real work, building a number of utility scripts, and
2046 then compiling and linking the binaries for the Exim monitor (if configured), a
2047 number of utility programs, and finally Exim itself. The command &`make
2048 makefile`& can be used to force a rebuild of the make file in the build
2049 directory, should this ever be necessary.
2050
2051 If you have problems building Exim, check for any comments there may be in the
2052 &_README_& file concerning your operating system, and also take a look at the
2053 FAQ, where some common problems are covered.
2054
2055
2056
2057 .section 'Output from &"make"&' "SECID283"
2058 The output produced by the &'make'& process for compile lines is often very
2059 unreadable, because these lines can be very long. For this reason, the normal
2060 output is suppressed by default, and instead output similar to that which
2061 appears when compiling the 2.6 Linux kernel is generated: just a short line for
2062 each module that is being compiled or linked. However, it is still possible to
2063 get the full output, by calling &'make'& like this:
2064 .code
2065 FULLECHO='' make -e
2066 .endd
2067 The value of FULLECHO defaults to &"@"&, the flag character that suppresses
2068 command reflection in &'make'&. When you ask for the full output, it is
2069 given in addition to the short output.
2070
2071
2072
2073 .section "Overriding build-time options for Exim" "SECToverride"
2074 .cindex "build-time options, overriding"
2075 The main make file that is created at the beginning of the building process
2076 consists of the concatenation of a number of files which set configuration
2077 values, followed by a fixed set of &'make'& instructions. If a value is set
2078 more than once, the last setting overrides any previous ones. This provides a
2079 convenient way of overriding defaults. The files that are concatenated are, in
2080 order:
2081 .display
2082 &_OS/Makefile-Default_&
2083 &_OS/Makefile-_&<&'ostype'&>
2084 &_Local/Makefile_&
2085 &_Local/Makefile-_&<&'ostype'&>
2086 &_Local/Makefile-_&<&'archtype'&>
2087 &_Local/Makefile-_&<&'ostype'&>-<&'archtype'&>
2088 &_OS/Makefile-Base_&
2089 .endd
2090 .cindex "&_Local/Makefile_&"
2091 .cindex "building Exim" "operating system type"
2092 .cindex "building Exim" "architecture type"
2093 where <&'ostype'&> is the operating system type and <&'archtype'&> is the
2094 architecture type. &_Local/Makefile_& is required to exist, and the building
2095 process fails if it is absent. The other three &_Local_& files are optional,
2096 and are often not needed.
2097
2098 The values used for <&'ostype'&> and <&'archtype'&> are obtained from scripts
2099 called &_scripts/os-type_& and &_scripts/arch-type_& respectively. If either of
2100 the environment variables EXIM_OSTYPE or EXIM_ARCHTYPE is set, their
2101 values are used, thereby providing a means of forcing particular settings.
2102 Otherwise, the scripts try to get values from the &%uname%& command. If this
2103 fails, the shell variables OSTYPE and ARCHTYPE are inspected. A number
2104 of &'ad hoc'& transformations are then applied, to produce the standard names
2105 that Exim expects. You can run these scripts directly from the shell in order
2106 to find out what values are being used on your system.
2107
2108
2109 &_OS/Makefile-Default_& contains comments about the variables that are set
2110 therein. Some (but not all) are mentioned below. If there is something that
2111 needs changing, review the contents of this file and the contents of the make
2112 file for your operating system (&_OS/Makefile-<ostype>_&) to see what the
2113 default values are.
2114
2115
2116 .cindex "building Exim" "overriding default settings"
2117 If you need to change any of the values that are set in &_OS/Makefile-Default_&
2118 or in &_OS/Makefile-<ostype>_&, or to add any new definitions, you do not
2119 need to change the original files. Instead, you should make the changes by
2120 putting the new values in an appropriate &_Local_& file. For example,
2121 .cindex "Tru64-Unix build-time settings"
2122 when building Exim in many releases of the Tru64-Unix (formerly Digital UNIX,
2123 formerly DEC-OSF1) operating system, it is necessary to specify that the C
2124 compiler is called &'cc'& rather than &'gcc'&. Also, the compiler must be
2125 called with the option &%-std1%&, to make it recognize some of the features of
2126 Standard C that Exim uses. (Most other compilers recognize Standard C by
2127 default.) To do this, you should create a file called &_Local/Makefile-OSF1_&
2128 containing the lines
2129 .code
2130 CC=cc
2131 CFLAGS=-std1
2132 .endd
2133 If you are compiling for just one operating system, it may be easier to put
2134 these lines directly into &_Local/Makefile_&.
2135
2136 Keeping all your local configuration settings separate from the distributed
2137 files makes it easy to transfer them to new versions of Exim simply by copying
2138 the contents of the &_Local_& directory.
2139
2140
2141 .cindex "NIS lookup type" "including support for"
2142 .cindex "NIS+ lookup type" "including support for"
2143 .cindex "LDAP" "including support for"
2144 .cindex "lookup" "inclusion in binary"
2145 Exim contains support for doing LDAP, NIS, NIS+, and other kinds of file
2146 lookup, but not all systems have these components installed, so the default is
2147 not to include the relevant code in the binary. All the different kinds of file
2148 and database lookup that Exim supports are implemented as separate code modules
2149 which are included only if the relevant compile-time options are set. In the
2150 case of LDAP, NIS, and NIS+, the settings for &_Local/Makefile_& are:
2151 .code
2152 LOOKUP_LDAP=yes
2153 LOOKUP_NIS=yes
2154 LOOKUP_NISPLUS=yes
2155 .endd
2156 and similar settings apply to the other lookup types. They are all listed in
2157 &_src/EDITME_&. In many cases the relevant include files and interface
2158 libraries need to be installed before compiling Exim.
2159 .cindex "cdb" "including support for"
2160 However, there are some optional lookup types (such as cdb) for which
2161 the code is entirely contained within Exim, and no external include
2162 files or libraries are required. When a lookup type is not included in the
2163 binary, attempts to configure Exim to use it cause run time configuration
2164 errors.
2165
2166 .cindex "pkg-config" "lookups"
2167 .cindex "pkg-config" "authenticators"
2168 Many systems now use a tool called &'pkg-config'& to encapsulate information
2169 about how to compile against a library; Exim has some initial support for
2170 being able to use pkg-config for lookups and authenticators.  For any given
2171 makefile variable which starts &`LOOKUP_`& or &`AUTH_`&, you can add a new
2172 variable with the &`_PC`& suffix in the name and assign as the value the
2173 name of the package to be queried.  The results of querying via the
2174 &'pkg-config'& command will be added to the appropriate Makefile variables
2175 with &`+=`& directives, so your version of &'make'& will need to support that
2176 syntax.  For instance:
2177 .code
2178 LOOKUP_SQLITE=yes
2179 LOOKUP_SQLITE_PC=sqlite3
2180 AUTH_GSASL=yes
2181 AUTH_GSASL_PC=libgsasl
2182 AUTH_HEIMDAL_GSSAPI=yes
2183 AUTH_HEIMDAL_GSSAPI_PC=heimdal-gssapi
2184 .endd
2185
2186 .cindex "Perl" "including support for"
2187 Exim can be linked with an embedded Perl interpreter, allowing Perl
2188 subroutines to be called during string expansion. To enable this facility,
2189 .code
2190 EXIM_PERL=perl.o
2191 .endd
2192 must be defined in &_Local/Makefile_&. Details of this facility are given in
2193 chapter &<<CHAPperl>>&.
2194
2195 .cindex "X11 libraries, location of"
2196 The location of the X11 libraries is something that varies a lot between
2197 operating systems, and there may be different versions of X11 to cope
2198 with. Exim itself makes no use of X11, but if you are compiling the Exim
2199 monitor, the X11 libraries must be available.
2200 The following three variables are set in &_OS/Makefile-Default_&:
2201 .code
2202 X11=/usr/X11R6
2203 XINCLUDE=-I$(X11)/include
2204 XLFLAGS=-L$(X11)/lib
2205 .endd
2206 These are overridden in some of the operating-system configuration files. For
2207 example, in &_OS/Makefile-SunOS5_& there is
2208 .code
2209 X11=/usr/openwin
2210 XINCLUDE=-I$(X11)/include
2211 XLFLAGS=-L$(X11)/lib -R$(X11)/lib
2212 .endd
2213 If you need to override the default setting for your operating system, place a
2214 definition of all three of these variables into your
2215 &_Local/Makefile-<ostype>_& file.
2216
2217 .cindex "EXTRALIBS"
2218 If you need to add any extra libraries to the link steps, these can be put in a
2219 variable called EXTRALIBS, which appears in all the link commands, but by
2220 default is not defined. In contrast, EXTRALIBS_EXIM is used only on the
2221 command for linking the main Exim binary, and not for any associated utilities.
2222
2223 .cindex "DBM libraries" "configuration for building"
2224 There is also DBMLIB, which appears in the link commands for binaries that
2225 use DBM functions (see also section &<<SECTdb>>&). Finally, there is
2226 EXTRALIBS_EXIMON, which appears only in the link step for the Exim monitor
2227 binary, and which can be used, for example, to include additional X11
2228 libraries.
2229
2230 .cindex "configuration file" "editing"
2231 The make file copes with rebuilding Exim correctly if any of the configuration
2232 files are edited. However, if an optional configuration file is deleted, it is
2233 necessary to touch the associated non-optional file (that is,
2234 &_Local/Makefile_& or &_Local/eximon.conf_&) before rebuilding.
2235
2236
2237 .section "OS-specific header files" "SECID30"
2238 .cindex "&_os.h_&"
2239 .cindex "building Exim" "OS-specific C header files"
2240 The &_OS_& directory contains a number of files with names of the form
2241 &_os.h-<ostype>_&. These are system-specific C header files that should not
2242 normally need to be changed. There is a list of macro settings that are
2243 recognized in the file &_OS/os.configuring_&, which should be consulted if you
2244 are porting Exim to a new operating system.
2245
2246
2247
2248 .section "Overriding build-time options for the monitor" "SECID31"
2249 .cindex "building Eximon"
2250 A similar process is used for overriding things when building the Exim monitor,
2251 where the files that are involved are
2252 .display
2253 &_OS/eximon.conf-Default_&
2254 &_OS/eximon.conf-_&<&'ostype'&>
2255 &_Local/eximon.conf_&
2256 &_Local/eximon.conf-_&<&'ostype'&>
2257 &_Local/eximon.conf-_&<&'archtype'&>
2258 &_Local/eximon.conf-_&<&'ostype'&>-<&'archtype'&>
2259 .endd
2260 .cindex "&_Local/eximon.conf_&"
2261 As with Exim itself, the final three files need not exist, and in this case the
2262 &_OS/eximon.conf-<ostype>_& file is also optional. The default values in
2263 &_OS/eximon.conf-Default_& can be overridden dynamically by setting environment
2264 variables of the same name, preceded by EXIMON_. For example, setting
2265 EXIMON_LOG_DEPTH in the environment overrides the value of
2266 LOG_DEPTH at run time.
2267 .ecindex IIDbuex
2268
2269
2270 .section "Installing Exim binaries and scripts" "SECID32"
2271 .cindex "installing Exim"
2272 .cindex "BIN_DIRECTORY"
2273 The command &`make install`& runs the &(exim_install)& script with no
2274 arguments. The script copies binaries and utility scripts into the directory
2275 whose name is specified by the BIN_DIRECTORY setting in &_Local/Makefile_&.
2276 .cindex "setuid" "installing Exim with"
2277 The install script copies files only if they are newer than the files they are
2278 going to replace. The Exim binary is required to be owned by root and have the
2279 &'setuid'& bit set, for normal configurations. Therefore, you must run &`make
2280 install`& as root so that it can set up the Exim binary in this way. However, in
2281 some special situations (for example, if a host is doing no local deliveries)
2282 it may be possible to run Exim without making the binary setuid root (see
2283 chapter &<<CHAPsecurity>>& for details).
2284
2285 .cindex "CONFIGURE_FILE"
2286 Exim's run time configuration file is named by the CONFIGURE_FILE setting
2287 in &_Local/Makefile_&. If this names a single file, and the file does not
2288 exist, the default configuration file &_src/configure.default_& is copied there
2289 by the installation script. If a run time configuration file already exists, it
2290 is left alone. If CONFIGURE_FILE is a colon-separated list, naming several
2291 alternative files, no default is installed.
2292
2293 .cindex "system aliases file"
2294 .cindex "&_/etc/aliases_&"
2295 One change is made to the default configuration file when it is installed: the
2296 default configuration contains a router that references a system aliases file.
2297 The path to this file is set to the value specified by
2298 SYSTEM_ALIASES_FILE in &_Local/Makefile_& (&_/etc/aliases_& by default).
2299 If the system aliases file does not exist, the installation script creates it,
2300 and outputs a comment to the user.
2301
2302 The created file contains no aliases, but it does contain comments about the
2303 aliases a site should normally have. Mail aliases have traditionally been
2304 kept in &_/etc/aliases_&. However, some operating systems are now using
2305 &_/etc/mail/aliases_&. You should check if yours is one of these, and change
2306 Exim's configuration if necessary.
2307
2308 The default configuration uses the local host's name as the only local domain,
2309 and is set up to do local deliveries into the shared directory &_/var/mail_&,
2310 running as the local user. System aliases and &_.forward_& files in users' home
2311 directories are supported, but no NIS or NIS+ support is configured. Domains
2312 other than the name of the local host are routed using the DNS, with delivery
2313 over SMTP.
2314
2315 It is possible to install Exim for special purposes (such as building a binary
2316 distribution) in a private part of the file system. You can do this by a
2317 command such as
2318 .code
2319 make DESTDIR=/some/directory/ install
2320 .endd
2321 This has the effect of pre-pending the specified directory to all the file
2322 paths, except the name of the system aliases file that appears in the default
2323 configuration. (If a default alias file is created, its name &'is'& modified.)
2324 For backwards compatibility, ROOT is used if DESTDIR is not set,
2325 but this usage is deprecated.
2326
2327 .cindex "installing Exim" "what is not installed"
2328 Running &'make install'& does not copy the Exim 4 conversion script
2329 &'convert4r4'&. You will probably run this only once if you are
2330 upgrading from Exim 3. None of the documentation files in the &_doc_&
2331 directory are copied, except for the info files when you have set
2332 INFO_DIRECTORY, as described in section &<<SECTinsinfdoc>>& below.
2333
2334 For the utility programs, old versions are renamed by adding the suffix &_.O_&
2335 to their names. The Exim binary itself, however, is handled differently. It is
2336 installed under a name that includes the version number and the compile number,
2337 for example &_exim-&version()-1_&. The script then arranges for a symbolic link
2338 called &_exim_& to point to the binary. If you are updating a previous version
2339 of Exim, the script takes care to ensure that the name &_exim_& is never absent
2340 from the directory (as seen by other processes).
2341
2342 .cindex "installing Exim" "testing the script"
2343 If you want to see what the &'make install'& will do before running it for
2344 real, you can pass the &%-n%& option to the installation script by this
2345 command:
2346 .code
2347 make INSTALL_ARG=-n install
2348 .endd
2349 The contents of the variable INSTALL_ARG are passed to the installation
2350 script. You do not need to be root to run this test. Alternatively, you can run
2351 the installation script directly, but this must be from within the build
2352 directory. For example, from the top-level Exim directory you could use this
2353 command:
2354 .code
2355 (cd build-SunOS5-5.5.1-sparc; ../scripts/exim_install -n)
2356 .endd
2357 .cindex "installing Exim" "install script options"
2358 There are two other options that can be supplied to the installation script.
2359
2360 .ilist
2361 &%-no_chown%& bypasses the call to change the owner of the installed binary
2362 to root, and the call to make it a setuid binary.
2363 .next
2364 &%-no_symlink%& bypasses the setting up of the symbolic link &_exim_& to the
2365 installed binary.
2366 .endlist
2367
2368 INSTALL_ARG can be used to pass these options to the script. For example:
2369 .code
2370 make INSTALL_ARG=-no_symlink install
2371 .endd
2372 The installation script can also be given arguments specifying which files are
2373 to be copied. For example, to install just the Exim binary, and nothing else,
2374 without creating the symbolic link, you could use:
2375 .code
2376 make INSTALL_ARG='-no_symlink exim' install
2377 .endd
2378
2379
2380
2381 .section "Installing info documentation" "SECTinsinfdoc"
2382 .cindex "installing Exim" "&'info'& documentation"
2383 Not all systems use the GNU &'info'& system for documentation, and for this
2384 reason, the Texinfo source of Exim's documentation is not included in the main
2385 distribution. Instead it is available separately from the ftp site (see section
2386 &<<SECTavail>>&).
2387
2388 If you have defined INFO_DIRECTORY in &_Local/Makefile_& and the Texinfo
2389 source of the documentation is found in the source tree, running &`make
2390 install`& automatically builds the info files and installs them.
2391
2392
2393
2394 .section "Setting up the spool directory" "SECID33"
2395 .cindex "spool directory" "creating"
2396 When it starts up, Exim tries to create its spool directory if it does not
2397 exist. The Exim uid and gid are used for the owner and group of the spool
2398 directory. Sub-directories are automatically created in the spool directory as
2399 necessary.
2400
2401
2402
2403
2404 .section "Testing" "SECID34"
2405 .cindex "testing" "installation"
2406 Having installed Exim, you can check that the run time configuration file is
2407 syntactically valid by running the following command, which assumes that the
2408 Exim binary directory is within your PATH environment variable:
2409 .code
2410 exim -bV
2411 .endd
2412 If there are any errors in the configuration file, Exim outputs error messages.
2413 Otherwise it outputs the version number and build date,
2414 the DBM library that is being used, and information about which drivers and
2415 other optional code modules are included in the binary.
2416 Some simple routing tests can be done by using the address testing option. For
2417 example,
2418 .display
2419 &`exim -bt`& <&'local username'&>
2420 .endd
2421 should verify that it recognizes a local mailbox, and
2422 .display
2423 &`exim -bt`& <&'remote address'&>
2424 .endd
2425 a remote one. Then try getting it to deliver mail, both locally and remotely.
2426 This can be done by passing messages directly to Exim, without going through a
2427 user agent. For example:
2428 .code
2429 exim -v postmaster@your.domain.example
2430 From: user@your.domain.example
2431 To: postmaster@your.domain.example
2432 Subject: Testing Exim
2433
2434 This is a test message.
2435 ^D
2436 .endd
2437 The &%-v%& option causes Exim to output some verification of what it is doing.
2438 In this case you should see copies of three log lines, one for the message's
2439 arrival, one for its delivery, and one containing &"Completed"&.
2440
2441 .cindex "delivery" "problems with"
2442 If you encounter problems, look at Exim's log files (&'mainlog'& and
2443 &'paniclog'&) to see if there is any relevant information there. Another source
2444 of information is running Exim with debugging turned on, by specifying the
2445 &%-d%& option. If a message is stuck on Exim's spool, you can force a delivery
2446 with debugging turned on by a command of the form
2447 .display
2448 &`exim -d -M`& <&'exim-message-id'&>
2449 .endd
2450 You must be root or an &"admin user"& in order to do this. The &%-d%& option
2451 produces rather a lot of output, but you can cut this down to specific areas.
2452 For example, if you use &%-d-all+route%& only the debugging information
2453 relevant to routing is included. (See the &%-d%& option in chapter
2454 &<<CHAPcommandline>>& for more details.)
2455
2456 .cindex '&"sticky"& bit'
2457 .cindex "lock files"
2458 One specific problem that has shown up on some sites is the inability to do
2459 local deliveries into a shared mailbox directory, because it does not have the
2460 &"sticky bit"& set on it. By default, Exim tries to create a lock file before
2461 writing to a mailbox file, and if it cannot create the lock file, the delivery
2462 is deferred. You can get round this either by setting the &"sticky bit"& on the
2463 directory, or by setting a specific group for local deliveries and allowing
2464 that group to create files in the directory (see the comments above the
2465 &(local_delivery)& transport in the default configuration file). Another
2466 approach is to configure Exim not to use lock files, but just to rely on
2467 &[fcntl()]& locking instead. However, you should do this only if all user
2468 agents also use &[fcntl()]& locking. For further discussion of locking issues,
2469 see chapter &<<CHAPappendfile>>&.
2470
2471 One thing that cannot be tested on a system that is already running an MTA is
2472 the receipt of incoming SMTP mail on the standard SMTP port. However, the
2473 &%-oX%& option can be used to run an Exim daemon that listens on some other
2474 port, or &'inetd'& can be used to do this. The &%-bh%& option and the
2475 &'exim_checkaccess'& utility can be used to check out policy controls on
2476 incoming SMTP mail.
2477
2478 Testing a new version on a system that is already running Exim can most easily
2479 be done by building a binary with a different CONFIGURE_FILE setting. From
2480 within the run time configuration, all other file and directory names
2481 that Exim uses can be altered, in order to keep it entirely clear of the
2482 production version.
2483
2484
2485 .section "Replacing another MTA with Exim" "SECID35"
2486 .cindex "replacing another MTA"
2487 Building and installing Exim for the first time does not of itself put it in
2488 general use. The name by which the system's MTA is called by mail user agents
2489 is either &_/usr/sbin/sendmail_&, or &_/usr/lib/sendmail_& (depending on the
2490 operating system), and it is necessary to make this name point to the &'exim'&
2491 binary in order to get the user agents to pass messages to Exim. This is
2492 normally done by renaming any existing file and making &_/usr/sbin/sendmail_&
2493 or &_/usr/lib/sendmail_&
2494 .cindex "symbolic link" "to &'exim'& binary"
2495 a symbolic link to the &'exim'& binary. It is a good idea to remove any setuid
2496 privilege and executable status from the old MTA. It is then necessary to stop
2497 and restart the mailer daemon, if one is running.
2498
2499 .cindex "FreeBSD, MTA indirection"
2500 .cindex "&_/etc/mail/mailer.conf_&"
2501 Some operating systems have introduced alternative ways of switching MTAs. For
2502 example, if you are running FreeBSD, you need to edit the file
2503 &_/etc/mail/mailer.conf_& instead of setting up a symbolic link as just
2504 described. A typical example of the contents of this file for running Exim is
2505 as follows:
2506 .code
2507 sendmail            /usr/exim/bin/exim
2508 send-mail           /usr/exim/bin/exim
2509 mailq               /usr/exim/bin/exim -bp
2510 newaliases          /usr/bin/true
2511 .endd
2512 Once you have set up the symbolic link, or edited &_/etc/mail/mailer.conf_&,
2513 your Exim installation is &"live"&. Check it by sending a message from your
2514 favourite user agent.
2515
2516 You should consider what to tell your users about the change of MTA. Exim may
2517 have different capabilities to what was previously running, and there are
2518 various operational differences such as the text of messages produced by
2519 command line options and in bounce messages. If you allow your users to make
2520 use of Exim's filtering capabilities, you should make the document entitled
2521 &'Exim's interface to mail filtering'& available to them.
2522
2523
2524
2525 .section "Upgrading Exim" "SECID36"
2526 .cindex "upgrading Exim"
2527 If you are already running Exim on your host, building and installing a new
2528 version automatically makes it available to MUAs, or any other programs that
2529 call the MTA directly. However, if you are running an Exim daemon, you do need
2530 to send it a HUP signal, to make it re-execute itself, and thereby pick up the
2531 new binary. You do not need to stop processing mail in order to install a new
2532 version of Exim. The install script does not modify an existing runtime
2533 configuration file.
2534
2535
2536
2537
2538 .section "Stopping the Exim daemon on Solaris" "SECID37"
2539 .cindex "Solaris" "stopping Exim on"
2540 The standard command for stopping the mailer daemon on Solaris is
2541 .code
2542 /etc/init.d/sendmail stop
2543 .endd
2544 If &_/usr/lib/sendmail_& has been turned into a symbolic link, this script
2545 fails to stop Exim because it uses the command &'ps -e'& and greps the output
2546 for the text &"sendmail"&; this is not present because the actual program name
2547 (that is, &"exim"&) is given by the &'ps'& command with these options. A
2548 solution is to replace the line that finds the process id with something like
2549 .code
2550 pid=`cat /var/spool/exim/exim-daemon.pid`
2551 .endd
2552 to obtain the daemon's pid directly from the file that Exim saves it in.
2553
2554 Note, however, that stopping the daemon does not &"stop Exim"&. Messages can
2555 still be received from local processes, and if automatic delivery is configured
2556 (the normal case), deliveries will still occur.
2557
2558
2559
2560
2561 . ////////////////////////////////////////////////////////////////////////////
2562 . ////////////////////////////////////////////////////////////////////////////
2563
2564 .chapter "The Exim command line" "CHAPcommandline"
2565 .scindex IIDclo1 "command line" "options"
2566 .scindex IIDclo2 "options" "command line"
2567 Exim's command line takes the standard Unix form of a sequence of options,
2568 each starting with a hyphen character, followed by a number of arguments. The
2569 options are compatible with the main options of Sendmail, and there are also
2570 some additional options, some of which are compatible with Smail 3. Certain
2571 combinations of options do not make sense, and provoke an error if used.
2572 The form of the arguments depends on which options are set.
2573
2574
2575 .section "Setting options by program name" "SECID38"
2576 .cindex "&'mailq'&"
2577 If Exim is called under the name &'mailq'&, it behaves as if the option &%-bp%&
2578 were present before any other options.
2579 The &%-bp%& option requests a listing of the contents of the mail queue on the
2580 standard output.
2581 This feature is for compatibility with some systems that contain a command of
2582 that name in one of the standard libraries, symbolically linked to
2583 &_/usr/sbin/sendmail_& or &_/usr/lib/sendmail_&.
2584
2585 .cindex "&'rsmtp'&"
2586 If Exim is called under the name &'rsmtp'& it behaves as if the option &%-bS%&
2587 were present before any other options, for compatibility with Smail. The
2588 &%-bS%& option is used for reading in a number of messages in batched SMTP
2589 format.
2590
2591 .cindex "&'rmail'&"
2592 If Exim is called under the name &'rmail'& it behaves as if the &%-i%& and
2593 &%-oee%& options were present before any other options, for compatibility with
2594 Smail. The name &'rmail'& is used as an interface by some UUCP systems.
2595
2596 .cindex "&'runq'&"
2597 .cindex "queue runner"
2598 If Exim is called under the name &'runq'& it behaves as if the option &%-q%&
2599 were present before any other options, for compatibility with Smail. The &%-q%&
2600 option causes a single queue runner process to be started.
2601
2602 .cindex "&'newaliases'&"
2603 .cindex "alias file" "building"
2604 .cindex "Sendmail compatibility" "calling Exim as &'newaliases'&"
2605 If Exim is called under the name &'newaliases'& it behaves as if the option
2606 &%-bi%& were present before any other options, for compatibility with Sendmail.
2607 This option is used for rebuilding Sendmail's alias file. Exim does not have
2608 the concept of a single alias file, but can be configured to run a given
2609 command if called with the &%-bi%& option.
2610
2611
2612 .section "Trusted and admin users" "SECTtrustedadmin"
2613 Some Exim options are available only to &'trusted users'& and others are
2614 available only to &'admin users'&. In the description below, the phrases &"Exim
2615 user"& and &"Exim group"& mean the user and group defined by EXIM_USER and
2616 EXIM_GROUP in &_Local/Makefile_& or set by the &%exim_user%& and
2617 &%exim_group%& options. These do not necessarily have to use the name &"exim"&.
2618
2619 .ilist
2620 .cindex "trusted users" "definition of"
2621 .cindex "user" "trusted definition of"
2622 The trusted users are root, the Exim user, any user listed in the
2623 &%trusted_users%& configuration option, and any user whose current group or any
2624 supplementary group is one of those listed in the &%trusted_groups%&
2625 configuration option. Note that the Exim group is not automatically trusted.
2626
2627 .cindex '&"From"& line'
2628 .cindex "envelope sender"
2629 Trusted users are always permitted to use the &%-f%& option or a leading
2630 &"From&~"& line to specify the envelope sender of a message that is passed to
2631 Exim through the local interface (see the &%-bm%& and &%-f%& options below).
2632 See the &%untrusted_set_sender%& option for a way of permitting non-trusted
2633 users to set envelope senders.
2634
2635 .cindex "&'From:'& header line"
2636 .cindex "&'Sender:'& header line"
2637 For a trusted user, there is never any check on the contents of the &'From:'&
2638 header line, and a &'Sender:'& line is never added. Furthermore, any existing
2639 &'Sender:'& line in incoming local (non-TCP/IP) messages is not removed.
2640
2641 Trusted users may also specify a host name, host address, interface address,
2642 protocol name, ident value, and authentication data when submitting a message
2643 locally. Thus, they are able to insert messages into Exim's queue locally that
2644 have the characteristics of messages received from a remote host. Untrusted
2645 users may in some circumstances use &%-f%&, but can never set the other values
2646 that are available to trusted users.
2647 .next
2648 .cindex "user" "admin definition of"
2649 .cindex "admin user" "definition of"
2650 The admin users are root, the Exim user, and any user that is a member of the
2651 Exim group or of any group listed in the &%admin_groups%& configuration option.
2652 The current group does not have to be one of these groups.
2653
2654 Admin users are permitted to list the queue, and to carry out certain
2655 operations on messages, for example, to force delivery failures. It is also
2656 necessary to be an admin user in order to see the full information provided by
2657 the Exim monitor, and full debugging output.
2658
2659 By default, the use of the &%-M%&, &%-q%&, &%-R%&, and &%-S%& options to cause
2660 Exim to attempt delivery of messages on its queue is restricted to admin users.
2661 However, this restriction can be relaxed by setting the &%prod_requires_admin%&
2662 option false (that is, specifying &%no_prod_requires_admin%&).
2663
2664 Similarly, the use of the &%-bp%& option to list all the messages in the queue
2665 is restricted to admin users unless &%queue_list_requires_admin%& is set
2666 false.
2667 .endlist
2668
2669
2670 &*Warning*&: If you configure your system so that admin users are able to
2671 edit Exim's configuration file, you are giving those users an easy way of
2672 getting root. There is further discussion of this issue at the start of chapter
2673 &<<CHAPconf>>&.
2674
2675
2676
2677
2678 .section "Command line options" "SECID39"
2679 Exim's command line options are described in alphabetical order below. If none
2680 of the options that specifies a specific action (such as starting the daemon or
2681 a queue runner, or testing an address, or receiving a message in a specific
2682 format, or listing the queue) are present, and there is at least one argument
2683 on the command line, &%-bm%& (accept a local message on the standard input,
2684 with the arguments specifying the recipients) is assumed. Otherwise, Exim
2685 outputs a brief message about itself and exits.
2686
2687 . ////////////////////////////////////////////////////////////////////////////
2688 . Insert a stylized XML comment here, to identify the start of the command line
2689 . options. This is for the benefit of the Perl script that automatically
2690 . creates a man page for the options.
2691 . ////////////////////////////////////////////////////////////////////////////
2692
2693 .literal xml
2694 <!-- === Start of command line options === -->
2695 .literal off
2696
2697
2698 .vlist
2699 .vitem &%--%&
2700 .oindex "--"
2701 .cindex "options" "command line; terminating"
2702 This is a pseudo-option whose only purpose is to terminate the options and
2703 therefore to cause subsequent command line items to be treated as arguments
2704 rather than options, even if they begin with hyphens.
2705
2706 .vitem &%--help%&
2707 .oindex "&%--help%&"
2708 This option causes Exim to output a few sentences stating what it is.
2709 The same output is generated if the Exim binary is called with no options and
2710 no arguments.
2711
2712 .vitem &%--version%&
2713 .oindex "&%--version%&"
2714 This option is an alias for &%-bV%& and causes version information to be
2715 displayed.
2716
2717 .new
2718 .vitem &%-Ac%& &&&
2719        &%-Am%&
2720 .oindex "&%-Ac%&"
2721 .oindex "&%-Am%&"
2722 These options are used by Sendmail for selecting configuration files and are
2723 ignored by Exim.
2724 .wen
2725
2726 .vitem &%-B%&<&'type'&>
2727 .oindex "&%-B%&"
2728 .cindex "8-bit characters"
2729 .cindex "Sendmail compatibility" "8-bit characters"
2730 This is a Sendmail option for selecting 7 or 8 bit processing. Exim is 8-bit
2731 clean; it ignores this option.
2732
2733 .vitem &%-bd%&
2734 .oindex "&%-bd%&"
2735 .cindex "daemon"
2736 .cindex "SMTP" "listener"
2737 .cindex "queue runner"
2738 This option runs Exim as a daemon, awaiting incoming SMTP connections. Usually
2739 the &%-bd%& option is combined with the &%-q%&<&'time'&> option, to specify
2740 that the daemon should also initiate periodic queue runs.
2741
2742 The &%-bd%& option can be used only by an admin user. If either of the &%-d%&
2743 (debugging) or &%-v%& (verifying) options are set, the daemon does not
2744 disconnect from the controlling terminal. When running this way, it can be
2745 stopped by pressing ctrl-C.
2746
2747 By default, Exim listens for incoming connections to the standard SMTP port on
2748 all the host's running interfaces. However, it is possible to listen on other
2749 ports, on multiple ports, and only on specific interfaces. Chapter
2750 &<<CHAPinterfaces>>& contains a description of the options that control this.
2751
2752 When a listening daemon
2753 .cindex "daemon" "process id (pid)"
2754 .cindex "pid (process id)" "of daemon"
2755 is started without the use of &%-oX%& (that is, without overriding the normal
2756 configuration), it writes its process id to a file called &_exim-daemon.pid_&
2757 in Exim's spool directory. This location can be overridden by setting
2758 PID_FILE_PATH in &_Local/Makefile_&. The file is written while Exim is still
2759 running as root.
2760
2761 When &%-oX%& is used on the command line to start a listening daemon, the
2762 process id is not written to the normal pid file path. However, &%-oP%& can be
2763 used to specify a path on the command line if a pid file is required.
2764
2765 The SIGHUP signal
2766 .cindex "SIGHUP"
2767 .cindex "daemon" "restarting"
2768 can be used to cause the daemon to re-execute itself. This should be done
2769 whenever Exim's configuration file, or any file that is incorporated into it by
2770 means of the &%.include%& facility, is changed, and also whenever a new version
2771 of Exim is installed. It is not necessary to do this when other files that are
2772 referenced from the configuration (for example, alias files) are changed,
2773 because these are reread each time they are used.
2774
2775 .vitem &%-bdf%&
2776 .oindex "&%-bdf%&"
2777 This option has the same effect as &%-bd%& except that it never disconnects
2778 from the controlling terminal, even when no debugging is specified.
2779
2780 .vitem &%-be%&
2781 .oindex "&%-be%&"
2782 .cindex "testing" "string expansion"
2783 .cindex "expansion" "testing"
2784 Run Exim in expansion testing mode. Exim discards its root privilege, to
2785 prevent ordinary users from using this mode to read otherwise inaccessible
2786 files. If no arguments are given, Exim runs interactively, prompting for lines
2787 of data. Otherwise, it processes each argument in turn.
2788
2789 If Exim was built with USE_READLINE=yes in &_Local/Makefile_&, it tries
2790 to load the &%libreadline%& library dynamically whenever the &%-be%& option is
2791 used without command line arguments. If successful, it uses the &[readline()]&
2792 function, which provides extensive line-editing facilities, for reading the
2793 test data. A line history is supported.
2794
2795 Long expansion expressions can be split over several lines by using backslash
2796 continuations. As in Exim's run time configuration, white space at the start of
2797 continuation lines is ignored. Each argument or data line is passed through the
2798 string expansion mechanism, and the result is output. Variable values from the
2799 configuration file (for example, &$qualify_domain$&) are available, but no
2800 message-specific values (such as &$sender_domain$&) are set, because no message
2801 is being processed (but see &%-bem%& and &%-Mset%&).
2802
2803 &*Note*&: If you use this mechanism to test lookups, and you change the data
2804 files or databases you are using, you must exit and restart Exim before trying
2805 the same lookup again. Otherwise, because each Exim process caches the results
2806 of lookups, you will just get the same result as before.
2807
2808 .vitem &%-bem%&&~<&'filename'&>
2809 .oindex "&%-bem%&"
2810 .cindex "testing" "string expansion"
2811 .cindex "expansion" "testing"
2812 This option operates like &%-be%& except that it must be followed by the name
2813 of a file. For example:
2814 .code
2815 exim -bem /tmp/testmessage
2816 .endd
2817 The file is read as a message (as if receiving a locally-submitted non-SMTP
2818 message) before any of the test expansions are done. Thus, message-specific
2819 variables such as &$message_size$& and &$header_from:$& are available. However,
2820 no &'Received:'& header is added to the message. If the &%-t%& option is set,
2821 recipients are read from the headers in the normal way, and are shown in the
2822 &$recipients$& variable. Note that recipients cannot be given on the command
2823 line, because further arguments are taken as strings to expand (just like
2824 &%-be%&).
2825
2826 .vitem &%-bF%&&~<&'filename'&>
2827 .oindex "&%-bF%&"
2828 .cindex "system filter" "testing"
2829 .cindex "testing" "system filter"
2830 This option is the same as &%-bf%& except that it assumes that the filter being
2831 tested is a system filter. The additional commands that are available only in
2832 system filters are recognized.
2833
2834 .vitem &%-bf%&&~<&'filename'&>
2835 .oindex "&%-bf%&"
2836 .cindex "filter" "testing"
2837 .cindex "testing" "filter file"
2838 .cindex "forward file" "testing"
2839 .cindex "testing" "forward file"
2840 .cindex "Sieve filter" "testing"
2841 This option runs Exim in user filter testing mode; the file is the filter file
2842 to be tested, and a test message must be supplied on the standard input. If
2843 there are no message-dependent tests in the filter, an empty file can be
2844 supplied.
2845
2846 If you want to test a system filter file, use &%-bF%& instead of &%-bf%&. You
2847 can use both &%-bF%& and &%-bf%& on the same command, in order to test a system
2848 filter and a user filter in the same run. For example:
2849 .code
2850 exim -bF /system/filter -bf /user/filter </test/message
2851 .endd
2852 This is helpful when the system filter adds header lines or sets filter
2853 variables that are used by the user filter.
2854
2855 If the test filter file does not begin with one of the special lines
2856 .code
2857 # Exim filter
2858 # Sieve filter
2859 .endd
2860 it is taken to be a normal &_.forward_& file, and is tested for validity under
2861 that interpretation. See sections &<<SECTitenonfilred>>& to
2862 &<<SECTspecitredli>>& for a description of the possible contents of non-filter
2863 redirection lists.
2864
2865 The result of an Exim command that uses &%-bf%&, provided no errors are
2866 detected, is a list of the actions that Exim would try to take if presented
2867 with the message for real. More details of filter testing are given in the
2868 separate document entitled &'Exim's interfaces to mail filtering'&.
2869
2870 When testing a filter file,
2871 .cindex "&""From""& line"
2872 .cindex "envelope sender"
2873 .oindex "&%-f%&" "for filter testing"
2874 the envelope sender can be set by the &%-f%& option,
2875 or by a &"From&~"& line at the start of the test message. Various parameters
2876 that would normally be taken from the envelope recipient address of the message
2877 can be set by means of additional command line options (see the next four
2878 options).
2879
2880 .vitem &%-bfd%&&~<&'domain'&>
2881 .oindex "&%-bfd%&"
2882 .vindex "&$qualify_domain$&"
2883 This sets the domain of the recipient address when a filter file is being
2884 tested by means of the &%-bf%& option. The default is the value of
2885 &$qualify_domain$&.
2886
2887 .vitem &%-bfl%&&~<&'local&~part'&>
2888 .oindex "&%-bfl%&"
2889 This sets the local part of the recipient address when a filter file is being
2890 tested by means of the &%-bf%& option. The default is the username of the
2891 process that calls Exim. A local part should be specified with any prefix or
2892 suffix stripped, because that is how it appears to the filter when a message is
2893 actually being delivered.
2894
2895 .vitem &%-bfp%&&~<&'prefix'&>
2896 .oindex "&%-bfp%&"
2897 This sets the prefix of the local part of the recipient address when a filter
2898 file is being tested by means of the &%-bf%& option. The default is an empty
2899 prefix.
2900
2901 .vitem &%-bfs%&&~<&'suffix'&>
2902 .oindex "&%-bfs%&"
2903 This sets the suffix of the local part of the recipient address when a filter
2904 file is being tested by means of the &%-bf%& option. The default is an empty
2905 suffix.
2906
2907 .vitem &%-bh%&&~<&'IP&~address'&>
2908 .oindex "&%-bh%&"
2909 .cindex "testing" "incoming SMTP"
2910 .cindex "SMTP" "testing incoming"
2911 .cindex "testing" "relay control"
2912 .cindex "relaying" "testing configuration"
2913 .cindex "policy control" "testing"
2914 .cindex "debugging" "&%-bh%& option"
2915 This option runs a fake SMTP session as if from the given IP address, using the
2916 standard input and output. The IP address may include a port number at the end,
2917 after a full stop. For example:
2918 .code
2919 exim -bh 10.9.8.7.1234
2920 exim -bh fe80::a00:20ff:fe86:a061.5678
2921 .endd
2922 When an IPv6 address is given, it is converted into canonical form. In the case
2923 of the second example above, the value of &$sender_host_address$& after
2924 conversion to the canonical form is
2925 &`fe80:0000:0000:0a00:20ff:fe86:a061.5678`&.
2926
2927 Comments as to what is going on are written to the standard error file. These
2928 include lines beginning with &"LOG"& for anything that would have been logged.
2929 This facility is provided for testing configuration options for incoming
2930 messages, to make sure they implement the required policy. For example, you can
2931 test your relay controls using &%-bh%&.
2932
2933 &*Warning 1*&:
2934 .cindex "RFC 1413"
2935 You can test features of the configuration that rely on ident (RFC 1413)
2936 information by using the &%-oMt%& option. However, Exim cannot actually perform
2937 an ident callout when testing using &%-bh%& because there is no incoming SMTP
2938 connection.
2939
2940 &*Warning 2*&: Address verification callouts (see section &<<SECTcallver>>&)
2941 are also skipped when testing using &%-bh%&. If you want these callouts to
2942 occur, use &%-bhc%& instead.
2943
2944 Messages supplied during the testing session are discarded, and nothing is
2945 written to any of the real log files. There may be pauses when DNS (and other)
2946 lookups are taking place, and of course these may time out. The &%-oMi%& option
2947 can be used to specify a specific IP interface and port if this is important,
2948 and &%-oMaa%& and &%-oMai%& can be used to set parameters as if the SMTP
2949 session were authenticated.
2950
2951 The &'exim_checkaccess'& utility is a &"packaged"& version of &%-bh%& whose
2952 output just states whether a given recipient address from a given host is
2953 acceptable or not. See section &<<SECTcheckaccess>>&.
2954
2955 Features such as authentication and encryption, where the client input is not
2956 plain text, cannot easily be tested with &%-bh%&. Instead, you should use a
2957 specialized SMTP test program such as
2958 &url(http://jetmore.org/john/code/#swaks,swaks).
2959
2960 .vitem &%-bhc%&&~<&'IP&~address'&>
2961 .oindex "&%-bhc%&"
2962 This option operates in the same way as &%-bh%&, except that address
2963 verification callouts are performed if required. This includes consulting and
2964 updating the callout cache database.
2965
2966 .vitem &%-bi%&
2967 .oindex "&%-bi%&"
2968 .cindex "alias file" "building"
2969 .cindex "building alias file"
2970 .cindex "Sendmail compatibility" "&%-bi%& option"
2971 Sendmail interprets the &%-bi%& option as a request to rebuild its alias file.
2972 Exim does not have the concept of a single alias file, and so it cannot mimic
2973 this behaviour. However, calls to &_/usr/lib/sendmail_& with the &%-bi%& option
2974 tend to appear in various scripts such as NIS make files, so the option must be
2975 recognized.
2976
2977 If &%-bi%& is encountered, the command specified by the &%bi_command%&
2978 configuration option is run, under the uid and gid of the caller of Exim. If
2979 the &%-oA%& option is used, its value is passed to the command as an argument.
2980 The command set by &%bi_command%& may not contain arguments. The command can
2981 use the &'exim_dbmbuild'& utility, or some other means, to rebuild alias files
2982 if this is required. If the &%bi_command%& option is not set, calling Exim with
2983 &%-bi%& is a no-op.
2984
2985 .new
2986 . // Keep :help first, then the rest in alphabetical order
2987 .vitem &%-bI:help%&
2988 .oindex "&%-bI:help%&"
2989 .cindex "querying exim information"
2990 We shall provide various options starting &`-bI:`& for querying Exim for
2991 information.  The output of many of these will be intended for machine
2992 consumption.  This one is not.  The &%-bI:help%& option asks Exim for a
2993 synopsis of supported options beginning &`-bI:`&.  Use of any of these
2994 options shall cause Exim to exit after producing the requested output.
2995
2996 .vitem &%-bI:dscp%&
2997 .oindex "&%-bI:dscp%&"
2998 .cindex "DSCP" "values"
2999 This option causes Exim to emit an alphabetically sorted list of all
3000 recognised DSCP names.
3001
3002 .vitem &%-bI:sieve%&
3003 .oindex "&%-bI:sieve%&"
3004 .cindex "Sieve filter" "capabilities"
3005 This option causes Exim to emit an alphabetically sorted list of all supported
3006 Sieve protocol extensions on stdout, one per line.  This is anticipated to be
3007 useful for ManageSieve (RFC 5804) implementations, in providing that protocol's
3008 &`SIEVE`& capability response line.  As the precise list may depend upon
3009 compile-time build options, which this option will adapt to, this is the only
3010 way to guarantee a correct response.
3011 .wen
3012
3013 .vitem &%-bm%&
3014 .oindex "&%-bm%&"
3015 .cindex "local message reception"
3016 This option runs an Exim receiving process that accepts an incoming,
3017 locally-generated message on the standard input. The recipients are given as the
3018 command arguments (except when &%-t%& is also present &-- see below). Each
3019 argument can be a comma-separated list of RFC 2822 addresses. This is the
3020 default option for selecting the overall action of an Exim call; it is assumed
3021 if no other conflicting option is present.
3022
3023 If any addresses in the message are unqualified (have no domain), they are
3024 qualified by the values of the &%qualify_domain%& or &%qualify_recipient%&
3025 options, as appropriate. The &%-bnq%& option (see below) provides a way of
3026 suppressing this for special cases.
3027
3028 Policy checks on the contents of local messages can be enforced by means of
3029 the non-SMTP ACL. See chapter &<<CHAPACL>>& for details.
3030
3031 .cindex "return code" "for &%-bm%&"
3032 The return code is zero if the message is successfully accepted. Otherwise, the
3033 action is controlled by the &%-oe%&&'x'& option setting &-- see below.
3034
3035 The format
3036 .cindex "message" "format"
3037 .cindex "format" "message"
3038 .cindex "&""From""& line"
3039 .cindex "UUCP" "&""From""& line"
3040 .cindex "Sendmail compatibility" "&""From""& line"
3041 of the message must be as defined in RFC 2822, except that, for
3042 compatibility with Sendmail and Smail, a line in one of the forms
3043 .code
3044 From sender Fri Jan  5 12:55 GMT 1997
3045 From sender Fri, 5 Jan 97 12:55:01
3046 .endd
3047 (with the weekday optional, and possibly with additional text after the date)
3048 is permitted to appear at the start of the message. There appears to be no
3049 authoritative specification of the format of this line. Exim recognizes it by
3050 matching against the regular expression defined by the &%uucp_from_pattern%&
3051 option, which can be changed if necessary.
3052
3053 .oindex "&%-f%&" "overriding &""From""& line"
3054 The specified sender is treated as if it were given as the argument to the
3055 &%-f%& option, but if a &%-f%& option is also present, its argument is used in
3056 preference to the address taken from the message. The caller of Exim must be a
3057 trusted user for the sender of a message to be set in this way.
3058
3059 .vitem &%-bmalware%&&~<&'filename'&>
3060 .oindex "&%-bmalware%&"
3061 .cindex "testing", "malware"
3062 .cindex "malware scan test"
3063 This debugging option causes Exim to scan the given file,
3064 using the malware scanning framework.  The option of &%av_scanner%& influences
3065 this option, so if &%av_scanner%&'s value is dependent upon an expansion then
3066 the expansion should have defaults which apply to this invocation.  ACLs are
3067 not invoked, so if &%av_scanner%& references an ACL variable then that variable
3068 will never be populated and &%-bmalware%& will fail.
3069
3070 Exim will have changed working directory before resolving the filename, so
3071 using fully qualified pathnames is advisable.  Exim will be running as the Exim
3072 user when it tries to open the file, rather than as the invoking user.
3073 This option requires admin privileges.
3074
3075 The &%-bmalware%& option will not be extended to be more generally useful,
3076 there are better tools for file-scanning.  This option exists to help
3077 administrators verify their Exim and AV scanner configuration.
3078
3079 .vitem &%-bnq%&
3080 .oindex "&%-bnq%&"
3081 .cindex "address qualification, suppressing"
3082 By default, Exim automatically qualifies unqualified addresses (those
3083 without domains) that appear in messages that are submitted locally (that
3084 is, not over TCP/IP). This qualification applies both to addresses in
3085 envelopes, and addresses in header lines. Sender addresses are qualified using
3086 &%qualify_domain%&, and recipient addresses using &%qualify_recipient%& (which
3087 defaults to the value of &%qualify_domain%&).
3088
3089 Sometimes, qualification is not wanted. For example, if &%-bS%& (batch SMTP) is
3090 being used to re-submit messages that originally came from remote hosts after
3091 content scanning, you probably do not want to qualify unqualified addresses in
3092 header lines. (Such lines will be present only if you have not enabled a header
3093 syntax check in the appropriate ACL.)
3094
3095 The &%-bnq%& option suppresses all qualification of unqualified addresses in
3096 messages that originate on the local host. When this is used, unqualified
3097 addresses in the envelope provoke errors (causing message rejection) and
3098 unqualified addresses in header lines are left alone.
3099
3100
3101 .vitem &%-bP%&
3102 .oindex "&%-bP%&"
3103 .cindex "configuration options" "extracting"
3104 .cindex "options" "configuration &-- extracting"
3105 If this option is given with no arguments, it causes the values of all Exim's
3106 main configuration options to be written to the standard output. The values
3107 of one or more specific options can be requested by giving their names as
3108 arguments, for example:
3109 .code
3110 exim -bP qualify_domain hold_domains
3111 .endd
3112 .cindex "hiding configuration option values"
3113 .cindex "configuration options" "hiding value of"
3114 .cindex "options" "hiding value of"
3115 However, any option setting that is preceded by the word &"hide"& in the
3116 configuration file is not shown in full, except to an admin user. For other
3117 users, the output is as in this example:
3118 .code
3119 mysql_servers = <value not displayable>
3120 .endd
3121 If &%configure_file%& is given as an argument, the name of the run time
3122 configuration file is output.
3123 If a list of configuration files was supplied, the value that is output here
3124 is the name of the file that was actually used.
3125
3126 .new
3127 .cindex "options" "hiding name of"
3128 If the &%-n%& flag is given, then for most modes of &%-bP%& operation the
3129 name will not be output.
3130 .wen
3131
3132 .cindex "daemon" "process id (pid)"
3133 .cindex "pid (process id)" "of daemon"
3134 If &%log_file_path%& or &%pid_file_path%& are given, the names of the
3135 directories where log files and daemon pid files are written are output,
3136 respectively. If these values are unset, log files are written in a
3137 sub-directory of the spool directory called &%log%&, and the pid file is
3138 written directly into the spool directory.
3139
3140 If &%-bP%& is followed by a name preceded by &`+`&, for example,
3141 .code
3142 exim -bP +local_domains
3143 .endd
3144 it searches for a matching named list of any type (domain, host, address, or
3145 local part) and outputs what it finds.
3146
3147 .cindex "options" "router &-- extracting"
3148 .cindex "options" "transport &-- extracting"
3149 .cindex "options" "authenticator &-- extracting"
3150 If one of the words &%router%&, &%transport%&, or &%authenticator%& is given,
3151 followed by the name of an appropriate driver instance, the option settings for
3152 that driver are output. For example:
3153 .code
3154 exim -bP transport local_delivery
3155 .endd
3156 The generic driver options are output first, followed by the driver's private
3157 options. A list of the names of drivers of a particular type can be obtained by
3158 using one of the words &%router_list%&, &%transport_list%&, or
3159 &%authenticator_list%&, and a complete list of all drivers with their option
3160 settings can be obtained by using &%routers%&, &%transports%&, or
3161 &%authenticators%&.
3162
3163 .cindex "options" "macro &-- extracting"
3164 If invoked by an admin user, then &%macro%&, &%macro_list%& and &%macros%&
3165 are available, similarly to the drivers.  Because macros are sometimes used
3166 for storing passwords, this option is restricted.
3167 The output format is one item per line.
3168
3169 .vitem &%-bp%&
3170 .oindex "&%-bp%&"
3171 .cindex "queue" "listing messages on"
3172 .cindex "listing" "messages on the queue"
3173 This option requests a listing of the contents of the mail queue on the
3174 standard output. If the &%-bp%& option is followed by a list of message ids,
3175 just those messages are listed. By default, this option can be used only by an
3176 admin user. However, the &%queue_list_requires_admin%& option can be set false
3177 to allow any user to see the queue.
3178
3179 Each message on the queue is displayed as in the following example:
3180 .code
3181 25m  2.9K 0t5C6f-0000c8-00 <alice@wonderland.fict.example>
3182           red.king@looking-glass.fict.example
3183           <other addresses>
3184 .endd
3185 .cindex "message" "size in queue listing"
3186 .cindex "size" "of message"
3187 The first line contains the length of time the message has been on the queue
3188 (in this case 25 minutes), the size of the message (2.9K), the unique local
3189 identifier for the message, and the message sender, as contained in the
3190 envelope. For bounce messages, the sender address is empty, and appears as
3191 &"<>"&. If the message was submitted locally by an untrusted user who overrode
3192 the default sender address, the user's login name is shown in parentheses
3193 before the sender address.
3194
3195 .cindex "frozen messages" "in queue listing"
3196 If the message is frozen (attempts to deliver it are suspended) then the text
3197 &"*** frozen ***"& is displayed at the end of this line.
3198
3199 The recipients of the message (taken from the envelope, not the headers) are
3200 displayed on subsequent lines. Those addresses to which the message has already
3201 been delivered are marked with the letter D. If an original address gets
3202 expanded into several addresses via an alias or forward file, the original is
3203 displayed with a D only when deliveries for all of its child addresses are
3204 complete.
3205
3206
3207 .vitem &%-bpa%&
3208 .oindex "&%-bpa%&"
3209 This option operates like &%-bp%&, but in addition it shows delivered addresses
3210 that were generated from the original top level address(es) in each message by
3211 alias or forwarding operations. These addresses are flagged with &"+D"& instead
3212 of just &"D"&.
3213
3214
3215 .vitem &%-bpc%&
3216 .oindex "&%-bpc%&"
3217 .cindex "queue" "count of messages on"
3218 This option counts the number of messages on the queue, and writes the total
3219 to the standard output. It is restricted to admin users, unless
3220 &%queue_list_requires_admin%& is set false.
3221
3222
3223 .vitem &%-bpr%&
3224 .oindex "&%-bpr%&"
3225 This option operates like &%-bp%&, but the output is not sorted into
3226 chronological order of message arrival. This can speed it up when there are
3227 lots of messages on the queue, and is particularly useful if the output is
3228 going to be post-processed in a way that doesn't need the sorting.
3229
3230 .vitem &%-bpra%&
3231 .oindex "&%-bpra%&"
3232 This option is a combination of &%-bpr%& and &%-bpa%&.
3233
3234 .vitem &%-bpru%&
3235 .oindex "&%-bpru%&"
3236 This option is a combination of &%-bpr%& and &%-bpu%&.
3237
3238
3239 .vitem &%-bpu%&
3240 .oindex "&%-bpu%&"
3241 This option operates like &%-bp%& but shows only undelivered top-level
3242 addresses for each message displayed. Addresses generated by aliasing or
3243 forwarding are not shown, unless the message was deferred after processing by a
3244 router with the &%one_time%& option set.
3245
3246
3247 .vitem &%-brt%&
3248 .oindex "&%-brt%&"
3249 .cindex "testing" "retry configuration"
3250 .cindex "retry" "configuration testing"
3251 This option is for testing retry rules, and it must be followed by up to three
3252 arguments. It causes Exim to look for a retry rule that matches the values
3253 and to write it to the standard output. For example:
3254 .code
3255 exim -brt bach.comp.mus.example
3256 Retry rule: *.comp.mus.example  F,2h,15m; F,4d,30m;
3257 .endd
3258 See chapter &<<CHAPretry>>& for a description of Exim's retry rules. The first
3259 argument, which is required, can be a complete address in the form
3260 &'local_part@domain'&, or it can be just a domain name. If the second argument
3261 contains a dot, it is interpreted as an optional second domain name; if no
3262 retry rule is found for the first argument, the second is tried. This ties in
3263 with Exim's behaviour when looking for retry rules for remote hosts &-- if no
3264 rule is found that matches the host, one that matches the mail domain is
3265 sought. Finally, an argument that is the name of a specific delivery error, as
3266 used in setting up retry rules, can be given. For example:
3267 .code
3268 exim -brt haydn.comp.mus.example quota_3d
3269 Retry rule: *@haydn.comp.mus.example quota_3d  F,1h,15m
3270 .endd
3271
3272 .vitem &%-brw%&
3273 .oindex "&%-brw%&"
3274 .cindex "testing" "rewriting"
3275 .cindex "rewriting" "testing"
3276 This option is for testing address rewriting rules, and it must be followed by
3277 a single argument, consisting of either a local part without a domain, or a
3278 complete address with a fully qualified domain. Exim outputs how this address
3279 would be rewritten for each possible place it might appear. See chapter
3280 &<<CHAPrewrite>>& for further details.
3281
3282 .vitem &%-bS%&
3283 .oindex "&%-bS%&"
3284 .cindex "SMTP" "batched incoming"
3285 .cindex "batched SMTP input"
3286 This option is used for batched SMTP input, which is an alternative interface
3287 for non-interactive local message submission. A number of messages can be
3288 submitted in a single run. However, despite its name, this is not really SMTP
3289 input. Exim reads each message's envelope from SMTP commands on the standard
3290 input, but generates no responses. If the caller is trusted, or
3291 &%untrusted_set_sender%& is set, the senders in the SMTP MAIL commands are
3292 believed; otherwise the sender is always the caller of Exim.
3293
3294 The message itself is read from the standard input, in SMTP format (leading
3295 dots doubled), terminated by a line containing just a single dot. An error is
3296 provoked if the terminating dot is missing. A further message may then follow.
3297
3298 As for other local message submissions, the contents of incoming batch SMTP
3299 messages can be checked using the non-SMTP ACL (see chapter &<<CHAPACL>>&).
3300 Unqualified addresses are automatically qualified using &%qualify_domain%& and
3301 &%qualify_recipient%&, as appropriate, unless the &%-bnq%& option is used.
3302
3303 Some other SMTP commands are recognized in the input. HELO and EHLO act
3304 as RSET; VRFY, EXPN, ETRN, and HELP act as NOOP;
3305 QUIT quits, ignoring the rest of the standard input.
3306
3307 .cindex "return code" "for &%-bS%&"
3308 If any error is encountered, reports are written to the standard output and
3309 error streams, and Exim gives up immediately. The return code is 0 if no error
3310 was detected; it is 1 if one or more messages were accepted before the error
3311 was detected; otherwise it is 2.
3312
3313 More details of input using batched SMTP are given in section
3314 &<<SECTincomingbatchedSMTP>>&.
3315
3316 .vitem &%-bs%&
3317 .oindex "&%-bs%&"
3318 .cindex "SMTP" "local input"
3319 .cindex "local SMTP input"
3320 This option causes Exim to accept one or more messages by reading SMTP commands
3321 on the standard input, and producing SMTP replies on the standard output. SMTP
3322 policy controls, as defined in ACLs (see chapter &<<CHAPACL>>&) are applied.
3323 Some user agents use this interface as a way of passing locally-generated
3324 messages to the MTA.
3325
3326 In
3327 .cindex "sender" "source of"
3328 this usage, if the caller of Exim is trusted, or &%untrusted_set_sender%& is
3329 set, the senders of messages are taken from the SMTP MAIL commands.
3330 Otherwise the content of these commands is ignored and the sender is set up as
3331 the calling user. Unqualified addresses are automatically qualified using
3332 &%qualify_domain%& and &%qualify_recipient%&, as appropriate, unless the
3333 &%-bnq%& option is used.
3334
3335 .cindex "inetd"
3336 The
3337 &%-bs%& option is also used to run Exim from &'inetd'&, as an alternative to
3338 using a listening daemon. Exim can distinguish the two cases by checking
3339 whether the standard input is a TCP/IP socket. When Exim is called from
3340 &'inetd'&, the source of the mail is assumed to be remote, and the comments
3341 above concerning senders and qualification do not apply. In this situation,
3342 Exim behaves in exactly the same way as it does when receiving a message via
3343 the listening daemon.
3344
3345 .vitem &%-bt%&
3346 .oindex "&%-bt%&"
3347 .cindex "testing" "addresses"
3348 .cindex "address" "testing"
3349 This option runs Exim in address testing mode, in which each argument is taken
3350 as a recipient address to be tested for deliverability. The results are
3351 written to the standard output. If a test fails, and the caller is not an admin
3352 user, no details of the failure are output, because these might contain
3353 sensitive information such as usernames and passwords for database lookups.
3354
3355 If no arguments are given, Exim runs in an interactive manner, prompting with a
3356 right angle bracket for addresses to be tested.
3357
3358 Unlike the &%-be%& test option, you cannot arrange for Exim to use the
3359 &[readline()]& function, because it is running as &'root'& and there are
3360 security issues.
3361
3362 Each address is handled as if it were the recipient address of a message
3363 (compare the &%-bv%& option). It is passed to the routers and the result is
3364 written to the standard output. However, any router that has
3365 &%no_address_test%& set is bypassed. This can make &%-bt%& easier to use for
3366 genuine routing tests if your first router passes everything to a scanner
3367 program.
3368
3369 .cindex "return code" "for &%-bt%&"
3370 The return code is 2 if any address failed outright; it is 1 if no address
3371 failed outright but at least one could not be resolved for some reason. Return
3372 code 0 is given only when all addresses succeed.
3373
3374 .cindex "duplicate addresses"
3375 &*Note*&: When actually delivering a message, Exim removes duplicate recipient
3376 addresses after routing is complete, so that only one delivery takes place.
3377 This does not happen when testing with &%-bt%&; the full results of routing are
3378 always shown.
3379
3380 &*Warning*&: &%-bt%& can only do relatively simple testing. If any of the
3381 routers in the configuration makes any tests on the sender address of a
3382 message,
3383 .oindex "&%-f%&" "for address testing"
3384 you can use the &%-f%& option to set an appropriate sender when running
3385 &%-bt%& tests. Without it, the sender is assumed to be the calling user at the
3386 default qualifying domain. However, if you have set up (for example) routers
3387 whose behaviour depends on the contents of an incoming message, you cannot test
3388 those conditions using &%-bt%&. The &%-N%& option provides a possible way of
3389 doing such tests.
3390
3391 .vitem &%-bV%&
3392 .oindex "&%-bV%&"
3393 .cindex "version number of Exim"
3394 This option causes Exim to write the current version number, compilation
3395 number, and compilation date of the &'exim'& binary to the standard output.
3396 It also lists the DBM library that is being used, the optional modules (such as
3397 specific lookup types), the drivers that are included in the binary, and the
3398 name of the run time configuration file that is in use.
3399
3400 As part of its operation, &%-bV%& causes Exim to read and syntax check its
3401 configuration file. However, this is a static check only. It cannot check
3402 values that are to be expanded. For example, although a misspelt ACL verb is
3403 detected, an error in the verb's arguments is not. You cannot rely on &%-bV%&
3404 alone to discover (for example) all the typos in the configuration; some
3405 realistic testing is needed. The &%-bh%& and &%-N%& options provide more
3406 dynamic testing facilities.
3407
3408 .vitem &%-bv%&
3409 .oindex "&%-bv%&"
3410 .cindex "verifying address" "using &%-bv%&"
3411 .cindex "address" "verification"
3412 This option runs Exim in address verification mode, in which each argument is
3413 taken as a recipient address to be verified by the routers. (This does
3414 not involve any verification callouts). During normal operation, verification
3415 happens mostly as a consequence processing a &%verify%& condition in an ACL
3416 (see chapter &<<CHAPACL>>&). If you want to test an entire ACL, possibly
3417 including callouts, see the &%-bh%& and &%-bhc%& options.
3418
3419 If verification fails, and the caller is not an admin user, no details of the
3420 failure are output, because these might contain sensitive information such as
3421 usernames and passwords for database lookups.
3422
3423 If no arguments are given, Exim runs in an interactive manner, prompting with a
3424 right angle bracket for addresses to be verified.
3425
3426 Unlike the &%-be%& test option, you cannot arrange for Exim to use the
3427 &[readline()]& function, because it is running as &'exim'& and there are
3428 security issues.
3429
3430 Verification differs from address testing (the &%-bt%& option) in that routers
3431 that have &%no_verify%& set are skipped, and if the address is accepted by a
3432 router that has &%fail_verify%& set, verification fails. The address is
3433 verified as a recipient if &%-bv%& is used; to test verification for a sender
3434 address, &%-bvs%& should be used.
3435
3436 If the &%-v%& option is not set, the output consists of a single line for each
3437 address, stating whether it was verified or not, and giving a reason in the
3438 latter case. Without &%-v%&, generating more than one address by redirection
3439 causes verification to end successfully, without considering the generated
3440 addresses. However, if just one address is generated, processing continues,
3441 and the generated address must verify successfully for the overall verification
3442 to succeed.
3443
3444 When &%-v%& is set, more details are given of how the address has been handled,
3445 and in the case of address redirection, all the generated addresses are also
3446 considered. Verification may succeed for some and fail for others.
3447
3448 The
3449 .cindex "return code" "for &%-bv%&"
3450 return code is 2 if any address failed outright; it is 1 if no address
3451 failed outright but at least one could not be resolved for some reason. Return
3452 code 0 is given only when all addresses succeed.
3453
3454 If any of the routers in the configuration makes any tests on the sender
3455 address of a message, you should use the &%-f%& option to set an appropriate
3456 sender when running &%-bv%& tests. Without it, the sender is assumed to be the
3457 calling user at the default qualifying domain.
3458
3459 .vitem &%-bvs%&
3460 .oindex "&%-bvs%&"
3461 This option acts like &%-bv%&, but verifies the address as a sender rather
3462 than a recipient address. This affects any rewriting and qualification that
3463 might happen.
3464
3465 .vitem &%-bw%&
3466 .oindex "&%-bw%&"
3467 .cindex "daemon"
3468 .cindex "inetd"
3469 .cindex "inetd" "wait mode"
3470 This option runs Exim as a daemon, awaiting incoming SMTP connections,
3471 similarly to the &%-bd%& option.  All port specifications on the command-line
3472 and in the configuration file are ignored.  Queue-running may not be specified.
3473
3474 In this mode, Exim expects to be passed a socket as fd 0 (stdin) which is
3475 listening for connections.  This permits the system to start up and have
3476 inetd (or equivalent) listen on the SMTP ports, starting an Exim daemon for
3477 each port only when the first connection is received.
3478
3479 If the option is given as &%-bw%&<&'time'&> then the time is a timeout, after
3480 which the daemon will exit, which should cause inetd to listen once more.
3481
3482 .vitem &%-C%&&~<&'filelist'&>
3483 .oindex "&%-C%&"
3484 .cindex "configuration file" "alternate"
3485 .cindex "CONFIGURE_FILE"
3486 .cindex "alternate configuration file"
3487 This option causes Exim to find the run time configuration file from the given
3488 list instead of from the list specified by the CONFIGURE_FILE
3489 compile-time setting. Usually, the list will consist of just a single file
3490 name, but it can be a colon-separated list of names. In this case, the first
3491 file that exists is used. Failure to open an existing file stops Exim from
3492 proceeding any further along the list, and an error is generated.
3493
3494 When this option is used by a caller other than root, and the list is different
3495 from the compiled-in list, Exim gives up its root privilege immediately, and
3496 runs with the real and effective uid and gid set to those of the caller.
3497 However, if a TRUSTED_CONFIG_LIST file is defined in &_Local/Makefile_&, that
3498 file contains a list of full pathnames, one per line, for configuration files
3499 which are trusted. Root privilege is retained for any configuration file so
3500 listed, as long as the caller is the Exim user (or the user specified in the
3501 CONFIGURE_OWNER option, if any), and as long as the configuration file is
3502 not writeable by inappropriate users or groups.
3503
3504 Leaving TRUSTED_CONFIG_LIST unset precludes the possibility of testing a
3505 configuration using &%-C%& right through message reception and delivery,
3506 even if the caller is root. The reception works, but by that time, Exim is
3507 running as the Exim user, so when it re-executes to regain privilege for the
3508 delivery, the use of &%-C%& causes privilege to be lost. However, root can
3509 test reception and delivery using two separate commands (one to put a message
3510 on the queue, using &%-odq%&, and another to do the delivery, using &%-M%&).
3511
3512 If ALT_CONFIG_PREFIX is defined &_in Local/Makefile_&, it specifies a
3513 prefix string with which any file named in a &%-C%& command line option
3514 must start. In addition, the file name must not contain the sequence &`/../`&.
3515 However, if the value of the &%-C%& option is identical to the value of
3516 CONFIGURE_FILE in &_Local/Makefile_&, Exim ignores &%-C%& and proceeds as
3517 usual. There is no default setting for ALT_CONFIG_PREFIX; when it is
3518 unset, any file name can be used with &%-C%&.
3519
3520 ALT_CONFIG_PREFIX can be used to confine alternative configuration files
3521 to a directory to which only root has access. This prevents someone who has
3522 broken into the Exim account from running a privileged Exim with an arbitrary
3523 configuration file.
3524
3525 The &%-C%& facility is useful for ensuring that configuration files are
3526 syntactically correct, but cannot be used for test deliveries, unless the
3527 caller is privileged, or unless it is an exotic configuration that does not
3528 require privilege. No check is made on the owner or group of the files
3529 specified by this option.
3530
3531
3532 .vitem &%-D%&<&'macro'&>=<&'value'&>
3533 .oindex "&%-D%&"
3534 .cindex "macro" "setting on command line"
3535 This option can be used to override macro definitions in the configuration file
3536 (see section &<<SECTmacrodefs>>&). However, like &%-C%&, if it is used by an
3537 unprivileged caller, it causes Exim to give up its root privilege.
3538 If DISABLE_D_OPTION is defined in &_Local/Makefile_&, the use of &%-D%& is
3539 completely disabled, and its use causes an immediate error exit.
3540
3541 If WHITELIST_D_MACROS is defined in &_Local/Makefile_& then it should be a
3542 colon-separated list of macros which are considered safe and, if &%-D%& only
3543 supplies macros from this list, and the values are acceptable, then Exim will
3544 not give up root privilege if the caller is root, the Exim run-time user, or
3545 the CONFIGURE_OWNER, if set.  This is a transition mechanism and is expected
3546 to be removed in the future.  Acceptable values for the macros satisfy the
3547 regexp: &`^[A-Za-z0-9_/.-]*$`&
3548
3549 The entire option (including equals sign if present) must all be within one
3550 command line item. &%-D%& can be used to set the value of a macro to the empty
3551 string, in which case the equals sign is optional. These two commands are
3552 synonymous:
3553 .code
3554 exim -DABC  ...
3555 exim -DABC= ...
3556 .endd
3557 To include spaces in a macro definition item, quotes must be used. If you use
3558 quotes, spaces are permitted around the macro name and the equals sign. For
3559 example:
3560 .code
3561 exim '-D ABC = something' ...
3562 .endd
3563 &%-D%& may be repeated up to 10 times on a command line.
3564
3565
3566 .vitem &%-d%&<&'debug&~options'&>
3567 .oindex "&%-d%&"
3568 .cindex "debugging" "list of selectors"
3569 .cindex "debugging" "&%-d%& option"
3570 This option causes debugging information to be written to the standard
3571 error stream. It is restricted to admin users because debugging output may show
3572 database queries that contain password information. Also, the details of users'
3573 filter files should be protected. If a non-admin user uses &%-d%&, Exim
3574 writes an error message to the standard error stream and exits with a non-zero
3575 return code.
3576
3577 When &%-d%& is used, &%-v%& is assumed. If &%-d%& is given on its own, a lot of
3578 standard debugging data is output. This can be reduced, or increased to include
3579 some more rarely needed information, by directly following &%-d%& with a string
3580 made up of names preceded by plus or minus characters. These add or remove sets
3581 of debugging data, respectively. For example, &%-d+filter%& adds filter
3582 debugging, whereas &%-d-all+filter%& selects only filter debugging. Note that
3583 no spaces are allowed in the debug setting. The available debugging categories
3584 are:
3585 .display
3586 &`acl            `& ACL interpretation
3587 &`auth           `& authenticators
3588 &`deliver        `& general delivery logic
3589 &`dns            `& DNS lookups (see also resolver)
3590 &`dnsbl          `& DNS black list (aka RBL) code
3591 &`exec           `& arguments for &[execv()]& calls
3592 &`expand         `& detailed debugging for string expansions
3593 &`filter         `& filter handling
3594 &`hints_lookup   `& hints data lookups
3595 &`host_lookup    `& all types of name-to-IP address handling
3596 &`ident          `& ident lookup
3597 &`interface      `& lists of local interfaces
3598 &`lists          `& matching things in lists
3599 &`load           `& system load checks
3600 &`local_scan     `& can be used by &[local_scan()]& (see chapter &&&
3601                     &<<CHAPlocalscan>>&)
3602 &`lookup         `& general lookup code and all lookups
3603 &`memory         `& memory handling
3604 &`pid            `& add pid to debug output lines
3605 &`process_info   `& setting info for the process log
3606 &`queue_run      `& queue runs
3607 &`receive        `& general message reception logic
3608 &`resolver       `& turn on the DNS resolver's debugging output
3609 &`retry          `& retry handling
3610 &`rewrite        `& address rewriting
3611 &`route          `& address routing
3612 &`timestamp      `& add timestamp to debug output lines
3613 &`tls            `& TLS logic
3614 &`transport      `& transports
3615 &`uid            `& changes of uid/gid and looking up uid/gid
3616 &`verify         `& address verification logic
3617 &`all            `& almost all of the above (see below), and also &%-v%&
3618 .endd
3619 The &`all`& option excludes &`memory`& when used as &`+all`&, but includes it
3620 for &`-all`&. The reason for this is that &`+all`& is something that people
3621 tend to use when generating debug output for Exim maintainers. If &`+memory`&
3622 is included, an awful lot of output that is very rarely of interest is
3623 generated, so it now has to be explicitly requested. However, &`-all`& does
3624 turn everything off.
3625
3626 .cindex "resolver, debugging output"
3627 .cindex "DNS resolver, debugging output"
3628 The &`resolver`& option produces output only if the DNS resolver was compiled
3629 with DEBUG enabled. This is not the case in some operating systems. Also,
3630 unfortunately, debugging output from the DNS resolver is written to stdout
3631 rather than stderr.
3632
3633 The default (&%-d%& with no argument) omits &`expand`&, &`filter`&,
3634 &`interface`&, &`load`&, &`memory`&, &`pid`&, &`resolver`&, and &`timestamp`&.
3635 However, the &`pid`& selector is forced when debugging is turned on for a
3636 daemon, which then passes it on to any re-executed Exims. Exim also
3637 automatically adds the pid to debug lines when several remote deliveries are
3638 run in parallel.
3639
3640 The &`timestamp`& selector causes the current time to be inserted at the start
3641 of all debug output lines. This can be useful when trying to track down delays
3642 in processing.
3643
3644 If the &%debug_print%& option is set in any driver, it produces output whenever
3645 any debugging is selected, or if &%-v%& is used.
3646
3647 .vitem &%-dd%&<&'debug&~options'&>
3648 .oindex "&%-dd%&"
3649 This option behaves exactly like &%-d%& except when used on a command that
3650 starts a daemon process. In that case, debugging is turned off for the
3651 subprocesses that the daemon creates. Thus, it is useful for monitoring the
3652 behaviour of the daemon without creating as much output as full debugging does.
3653
3654 .vitem &%-dropcr%&
3655 .oindex "&%-dropcr%&"
3656 This is an obsolete option that is now a no-op. It used to affect the way Exim
3657 handled CR and LF characters in incoming messages. What happens now is
3658 described in section &<<SECTlineendings>>&.
3659
3660 .vitem &%-E%&
3661 .oindex "&%-E%&"
3662 .cindex "bounce message" "generating"
3663 This option specifies that an incoming message is a locally-generated delivery
3664 failure report. It is used internally by Exim when handling delivery failures
3665 and is not intended for external use. Its only effect is to stop Exim
3666 generating certain messages to the postmaster, as otherwise message cascades
3667 could occur in some situations. As part of the same option, a message id may
3668 follow the characters &%-E%&. If it does, the log entry for the receipt of the
3669 new message contains the id, following &"R="&, as a cross-reference.
3670
3671 .vitem &%-e%&&'x'&
3672 .oindex "&%-e%&&'x'&"
3673 There are a number of Sendmail options starting with &%-oe%& which seem to be
3674 called by various programs without the leading &%o%& in the option. For
3675 example, the &%vacation%& program uses &%-eq%&. Exim treats all options of the
3676 form &%-e%&&'x'& as synonymous with the corresponding &%-oe%&&'x'& options.
3677
3678 .vitem &%-F%&&~<&'string'&>
3679 .oindex "&%-F%&"
3680 .cindex "sender" "name"
3681 .cindex "name" "of sender"
3682 This option sets the sender's full name for use when a locally-generated
3683 message is being accepted. In the absence of this option, the user's &'gecos'&
3684 entry from the password data is used. As users are generally permitted to alter
3685 their &'gecos'& entries, no security considerations are involved. White space
3686 between &%-F%& and the <&'string'&> is optional.
3687
3688 .vitem &%-f%&&~<&'address'&>
3689 .oindex "&%-f%&"
3690 .cindex "sender" "address"
3691 .cindex "address" "sender"
3692 .cindex "trusted users"
3693 .cindex "envelope sender"
3694 .cindex "user" "trusted"
3695 This option sets the address of the envelope sender of a locally-generated
3696 message (also known as the return path). The option can normally be used only
3697 by a trusted user, but &%untrusted_set_sender%& can be set to allow untrusted
3698 users to use it.
3699
3700 Processes running as root or the Exim user are always trusted. Other
3701 trusted users are defined by the &%trusted_users%& or &%trusted_groups%&
3702 options. In the absence of &%-f%&, or if the caller is not trusted, the sender
3703 of a local message is set to the caller's login name at the default qualify
3704 domain.
3705
3706 There is one exception to the restriction on the use of &%-f%&: an empty sender
3707 can be specified by any user, trusted or not, to create a message that can
3708 never provoke a bounce. An empty sender can be specified either as an empty
3709 string, or as a pair of angle brackets with nothing between them, as in these
3710 examples of shell commands:
3711 .code
3712 exim -f '<>' user@domain
3713 exim -f "" user@domain
3714 .endd
3715 In addition, the use of &%-f%& is not restricted when testing a filter file
3716 with &%-bf%& or when testing or verifying addresses using the &%-bt%& or
3717 &%-bv%& options.
3718
3719 Allowing untrusted users to change the sender address does not of itself make
3720 it possible to send anonymous mail. Exim still checks that the &'From:'& header
3721 refers to the local user, and if it does not, it adds a &'Sender:'& header,
3722 though this can be overridden by setting &%no_local_from_check%&.
3723
3724 White
3725 .cindex "&""From""& line"
3726 space between &%-f%& and the <&'address'&> is optional (that is, they can be
3727 given as two arguments or one combined argument). The sender of a
3728 locally-generated message can also be set (when permitted) by an initial
3729 &"From&~"& line in the message &-- see the description of &%-bm%& above &-- but
3730 if &%-f%& is also present, it overrides &"From&~"&.
3731
3732 .vitem &%-G%&
3733 .oindex "&%-G%&"
3734 .cindex "submission fixups, suppressing (command-line)"
3735 .new
3736 This option is equivalent to an ACL applying:
3737 .code
3738 control = suppress_local_fixups
3739 .endd
3740 for every message received.  Note that Sendmail will complain about such
3741 bad formatting, where Exim silently just does not fix it up.  This may change
3742 in future.
3743
3744 As this affects audit information, the caller must be a trusted user to use
3745 this option.
3746 .wen
3747
3748 .vitem &%-h%&&~<&'number'&>
3749 .oindex "&%-h%&"
3750 .cindex "Sendmail compatibility" "&%-h%& option ignored"
3751 This option is accepted for compatibility with Sendmail, but has no effect. (In
3752 Sendmail it overrides the &"hop count"& obtained by counting &'Received:'&
3753 headers.)
3754
3755 .vitem &%-i%&
3756 .oindex "&%-i%&"
3757 .cindex "Solaris" "&'mail'& command"
3758 .cindex "dot" "in incoming non-SMTP message"
3759 This option, which has the same effect as &%-oi%&, specifies that a dot on a
3760 line by itself should not terminate an incoming, non-SMTP message. I can find
3761 no documentation for this option in Solaris 2.4 Sendmail, but the &'mailx'&
3762 command in Solaris 2.4 uses it. See also &%-ti%&.
3763
3764 .new
3765 .vitem &%-L%&&~<&'tag'&>
3766 .oindex "&%-L%&"
3767 .cindex "syslog" "process name; set with flag"
3768 This option is equivalent to setting &%syslog_processname%& in the config
3769 file and setting &%log_file_path%& to &`syslog`&.
3770 Its use is restricted to administrators.  The configuration file has to be
3771 read and parsed, to determine access rights, before this is set and takes
3772 effect, so early configuration file errors will not honour this flag.
3773
3774 The tag should not be longer than 32 characters.
3775 .wen
3776
3777 .vitem &%-M%&&~<&'message&~id'&>&~<&'message&~id'&>&~...
3778 .oindex "&%-M%&"
3779 .cindex "forcing delivery"
3780 .cindex "delivery" "forcing attempt"
3781 .cindex "frozen messages" "forcing delivery"
3782 This option requests Exim to run a delivery attempt on each message in turn. If
3783 any of the messages are frozen, they are automatically thawed before the
3784 delivery attempt. The settings of &%queue_domains%&, &%queue_smtp_domains%&,
3785 and &%hold_domains%& are ignored.
3786
3787 Retry
3788 .cindex "hints database" "overriding retry hints"
3789 hints for any of the addresses are overridden &-- Exim tries to deliver even if
3790 the normal retry time has not yet been reached. This option requires the caller
3791 to be an admin user. However, there is an option called &%prod_requires_admin%&
3792 which can be set false to relax this restriction (and also the same requirement
3793 for the &%-q%&, &%-R%&, and &%-S%& options).
3794
3795 The deliveries happen synchronously, that is, the original Exim process does
3796 not terminate until all the delivery attempts have finished. No output is
3797 produced unless there is a serious error. If you want to see what is happening,
3798 use the &%-v%& option as well, or inspect Exim's main log.
3799
3800 .vitem &%-Mar%&&~<&'message&~id'&>&~<&'address'&>&~<&'address'&>&~...
3801 .oindex "&%-Mar%&"
3802 .cindex "message" "adding recipients"
3803 .cindex "recipient" "adding"
3804 This option requests Exim to add the addresses to the list of recipients of the
3805 message (&"ar"& for &"add recipients"&). The first argument must be a message
3806 id, and the remaining ones must be email addresses. However, if the message is
3807 active (in the middle of a delivery attempt), it is not altered. This option
3808 can be used only by an admin user.
3809
3810 .vitem "&%-MC%&&~<&'transport'&>&~<&'hostname'&>&~<&'sequence&~number'&>&&&
3811         &~<&'message&~id'&>"
3812 .oindex "&%-MC%&"
3813 .cindex "SMTP" "passed connection"
3814 .cindex "SMTP" "multiple deliveries"
3815 .cindex "multiple SMTP deliveries"
3816 This option is not intended for use by external callers. It is used internally
3817 by Exim to invoke another instance of itself to deliver a waiting message using
3818 an existing SMTP connection, which is passed as the standard input. Details are
3819 given in chapter &<<CHAPSMTP>>&. This must be the final option, and the caller
3820 must be root or the Exim user in order to use it.
3821
3822 .vitem &%-MCA%&
3823 .oindex "&%-MCA%&"
3824 This option is not intended for use by external callers. It is used internally
3825 by Exim in conjunction with the &%-MC%& option. It signifies that the
3826 connection to the remote host has been authenticated.
3827
3828 .vitem &%-MCP%&
3829 .oindex "&%-MCP%&"
3830 This option is not intended for use by external callers. It is used internally
3831 by Exim in conjunction with the &%-MC%& option. It signifies that the server to
3832 which Exim is connected supports pipelining.
3833
3834 .vitem &%-MCQ%&&~<&'process&~id'&>&~<&'pipe&~fd'&>
3835 .oindex "&%-MCQ%&"
3836 This option is not intended for use by external callers. It is used internally
3837 by Exim in conjunction with the &%-MC%& option when the original delivery was
3838 started by a queue runner. It passes on the process id of the queue runner,
3839 together with the file descriptor number of an open pipe. Closure of the pipe
3840 signals the final completion of the sequence of processes that are passing
3841 messages through the same SMTP connection.
3842
3843 .vitem &%-MCS%&
3844 .oindex "&%-MCS%&"
3845 This option is not intended for use by external callers. It is used internally
3846 by Exim in conjunction with the &%-MC%& option, and passes on the fact that the
3847 SMTP SIZE option should be used on messages delivered down the existing
3848 connection.
3849
3850 .vitem &%-MCT%&
3851 .oindex "&%-MCT%&"
3852 This option is not intended for use by external callers. It is used internally
3853 by Exim in conjunction with the &%-MC%& option, and passes on the fact that the
3854 host to which Exim is connected supports TLS encryption.
3855
3856 .vitem &%-Mc%&&~<&'message&~id'&>&~<&'message&~id'&>&~...
3857 .oindex "&%-Mc%&"
3858 .cindex "hints database" "not overridden by &%-Mc%&"
3859 .cindex "delivery" "manually started &-- not forced"
3860 This option requests Exim to run a delivery attempt on each message in turn,
3861 but unlike the &%-M%& option, it does check for retry hints, and respects any
3862 that are found. This option is not very useful to external callers. It is
3863 provided mainly for internal use by Exim when it needs to re-invoke itself in
3864 order to regain root privilege for a delivery (see chapter &<<CHAPsecurity>>&).
3865 However, &%-Mc%& can be useful when testing, in order to run a delivery that
3866 respects retry times and other options such as &%hold_domains%& that are
3867 overridden when &%-M%& is used. Such a delivery does not count as a queue run.
3868 If you want to run a specific delivery as if in a queue run, you should use
3869 &%-q%& with a message id argument. A distinction between queue run deliveries
3870 and other deliveries is made in one or two places.
3871
3872 .vitem &%-Mes%&&~<&'message&~id'&>&~<&'address'&>
3873 .oindex "&%-Mes%&"
3874 .cindex "message" "changing sender"
3875 .cindex "sender" "changing"
3876 This option requests Exim to change the sender address in the message to the
3877 given address, which must be a fully qualified address or &"<>"& (&"es"& for
3878 &"edit sender"&). There must be exactly two arguments. The first argument must
3879 be a message id, and the second one an email address. However, if the message
3880 is active (in the middle of a delivery attempt), its status is not altered.
3881 This option can be used only by an admin user.
3882
3883 .vitem &%-Mf%&&~<&'message&~id'&>&~<&'message&~id'&>&~...
3884 .oindex "&%-Mf%&"
3885 .cindex "freezing messages"
3886 .cindex "message" "manually freezing"
3887 This option requests Exim to mark each listed message as &"frozen"&. This
3888 prevents any delivery attempts taking place until the message is &"thawed"&,
3889 either manually or as a result of the &%auto_thaw%& configuration option.
3890 However, if any of the messages are active (in the middle of a delivery
3891 attempt), their status is not altered. This option can be used only by an admin
3892 user.
3893
3894 .vitem &%-Mg%&&~<&'message&~id'&>&~<&'message&~id'&>&~...
3895 .oindex "&%-Mg%&"
3896 .cindex "giving up on messages"
3897 .cindex "message" "abandoning delivery attempts"
3898 .cindex "delivery" "abandoning further attempts"
3899 This option requests Exim to give up trying to deliver the listed messages,
3900 including any that are frozen. However, if any of the messages are active,
3901 their status is not altered. For non-bounce messages, a delivery error message
3902 is sent to the sender, containing the text &"cancelled by administrator"&.
3903 Bounce messages are just discarded. This option can be used only by an admin
3904 user.
3905
3906 .vitem &%-Mmad%&&~<&'message&~id'&>&~<&'message&~id'&>&~...
3907 .oindex "&%-Mmad%&"
3908 .cindex "delivery" "cancelling all"
3909 This option requests Exim to mark all the recipient addresses in the messages
3910 as already delivered (&"mad"& for &"mark all delivered"&). However, if any
3911 message is active (in the middle of a delivery attempt), its status is not
3912 altered. This option can be used only by an admin user.
3913
3914 .vitem &%-Mmd%&&~<&'message&~id'&>&~<&'address'&>&~<&'address'&>&~...
3915 .oindex "&%-Mmd%&"
3916 .cindex "delivery" "cancelling by address"
3917 .cindex "recipient" "removing"
3918 .cindex "removing recipients"
3919 This option requests Exim to mark the given addresses as already delivered
3920 (&"md"& for &"mark delivered"&). The first argument must be a message id, and
3921 the remaining ones must be email addresses. These are matched to recipient
3922 addresses in the message in a case-sensitive manner. If the message is active
3923 (in the middle of a delivery attempt), its status is not altered. This option
3924 can be used only by an admin user.
3925
3926 .vitem &%-Mrm%&&~<&'message&~id'&>&~<&'message&~id'&>&~...
3927 .oindex "&%-Mrm%&"
3928 .cindex "removing messages"
3929 .cindex "abandoning mail"
3930 .cindex "message" "manually discarding"
3931 This option requests Exim to remove the given messages from the queue. No
3932 bounce messages are sent; each message is simply forgotten. However, if any of
3933 the messages are active, their status is not altered. This option can be used
3934 only by an admin user or by the user who originally caused the message to be
3935 placed on the queue.
3936
3937 .vitem &%-Mset%&&~<&'message&~id'&>
3938 .oindex "&%-Mset%&
3939 .cindex "testing" "string expansion"
3940 .cindex "expansion" "testing"
3941 This option is useful only in conjunction with &%-be%& (that is, when testing
3942 string expansions). Exim loads the given message from its spool before doing
3943 the test expansions, thus setting message-specific variables such as
3944 &$message_size$& and the header variables. The &$recipients$& variable is made
3945 available. This feature is provided to make it easier to test expansions that
3946 make use of these variables. However, this option can be used only by an admin
3947 user. See also &%-bem%&.
3948
3949 .vitem &%-Mt%&&~<&'message&~id'&>&~<&'message&~id'&>&~...
3950 .oindex "&%-Mt%&"
3951 .cindex "thawing messages"
3952 .cindex "unfreezing messages"
3953 .cindex "frozen messages" "thawing"
3954 .cindex "message" "thawing frozen"
3955 This option requests Exim to &"thaw"& any of the listed messages that are
3956 &"frozen"&, so that delivery attempts can resume. However, if any of the
3957 messages are active, their status is not altered. This option can be used only
3958 by an admin user.
3959
3960 .vitem &%-Mvb%&&~<&'message&~id'&>
3961 .oindex "&%-Mvb%&"
3962 .cindex "listing" "message body"
3963 .cindex "message" "listing body of"
3964 This option causes the contents of the message body (-D) spool file to be
3965 written to the standard output. This option can be used only by an admin user.
3966
3967 .vitem &%-Mvc%&&~<&'message&~id'&>
3968 .oindex "&%-Mvc%&"
3969 .cindex "message" "listing in RFC 2822 format"
3970 .cindex "listing" "message in RFC 2822 format"
3971 This option causes a copy of the complete message (header lines plus body) to
3972 be written to the standard output in RFC 2822 format. This option can be used
3973 only by an admin user.
3974
3975 .vitem &%-Mvh%&&~<&'message&~id'&>
3976 .oindex "&%-Mvh%&"
3977 .cindex "listing" "message headers"
3978 .cindex "header lines" "listing"
3979 .cindex "message" "listing header lines"
3980 This option causes the contents of the message headers (-H) spool file to be
3981 written to the standard output. This option can be used only by an admin user.
3982
3983 .vitem &%-Mvl%&&~<&'message&~id'&>
3984 .oindex "&%-Mvl%&"
3985 .cindex "listing" "message log"
3986 .cindex "message" "listing message log"
3987 This option causes the contents of the message log spool file to be written to
3988 the standard output. This option can be used only by an admin user.
3989
3990 .vitem &%-m%&
3991 .oindex "&%-m%&"
3992 This is apparently a synonym for &%-om%& that is accepted by Sendmail, so Exim
3993 treats it that way too.
3994
3995 .vitem &%-N%&
3996 .oindex "&%-N%&"
3997 .cindex "debugging" "&%-N%& option"
3998 .cindex "debugging" "suppressing delivery"
3999 This is a debugging option that inhibits delivery of a message at the transport
4000 level. It implies &%-v%&. Exim goes through many of the motions of delivery &--
4001 it just doesn't actually transport the message, but instead behaves as if it
4002 had successfully done so. However, it does not make any updates to the retry
4003 database, and the log entries for deliveries are flagged with &"*>"& rather
4004 than &"=>"&.
4005
4006 Because &%-N%& discards any message to which it applies, only root or the Exim
4007 user are allowed to use it with &%-bd%&, &%-q%&, &%-R%& or &%-M%&. In other
4008 words, an ordinary user can use it only when supplying an incoming message to
4009 which it will apply. Although transportation never fails when &%-N%& is set, an
4010 address may be deferred because of a configuration problem on a transport, or a
4011 routing problem. Once &%-N%& has been used for a delivery attempt, it sticks to
4012 the message, and applies to any subsequent delivery attempts that may happen
4013 for that message.
4014
4015 .vitem &%-n%&
4016 .oindex "&%-n%&"
4017 This option is interpreted by Sendmail to mean &"no aliasing"&.
4018 For normal modes of operation, it is ignored by Exim.
4019 When combined with &%-bP%& it suppresses the name of an option from being output.
4020
4021 .vitem &%-O%&&~<&'data'&>
4022 .oindex "&%-O%&"
4023 This option is interpreted by Sendmail to mean &`set option`&. It is ignored by
4024 Exim.
4025
4026 .vitem &%-oA%&&~<&'file&~name'&>
4027 .oindex "&%-oA%&"
4028 .cindex "Sendmail compatibility" "&%-oA%& option"
4029 This option is used by Sendmail in conjunction with &%-bi%& to specify an
4030 alternative alias file name. Exim handles &%-bi%& differently; see the
4031 description above.
4032
4033 .vitem &%-oB%&&~<&'n'&>
4034 .oindex "&%-oB%&"
4035 .cindex "SMTP" "passed connection"
4036 .cindex "SMTP" "multiple deliveries"
4037 .cindex "multiple SMTP deliveries"
4038 This is a debugging option which limits the maximum number of messages that can
4039 be delivered down one SMTP connection, overriding the value set in any &(smtp)&
4040 transport. If <&'n'&> is omitted, the limit is set to 1.
4041
4042 .vitem &%-odb%&
4043 .oindex "&%-odb%&"
4044 .cindex "background delivery"
4045 .cindex "delivery" "in the background"
4046 This option applies to all modes in which Exim accepts incoming messages,
4047 including the listening daemon. It requests &"background"& delivery of such
4048 messages, which means that the accepting process automatically starts a
4049 delivery process for each message received, but does not wait for the delivery
4050 processes to finish.
4051
4052 When all the messages have been received, the reception process exits,
4053 leaving the delivery processes to finish in their own time. The standard output
4054 and error streams are closed at the start of each delivery process.
4055 This is the default action if none of the &%-od%& options are present.
4056
4057 If one of the queueing options in the configuration file
4058 (&%queue_only%& or &%queue_only_file%&, for example) is in effect, &%-odb%&
4059 overrides it if &%queue_only_override%& is set true, which is the default
4060 setting. If &%queue_only_override%& is set false, &%-odb%& has no effect.
4061
4062 .vitem &%-odf%&
4063 .oindex "&%-odf%&"
4064 .cindex "foreground delivery"
4065 .cindex "delivery" "in the foreground"
4066 This option requests &"foreground"& (synchronous) delivery when Exim has
4067 accepted a locally-generated message. (For the daemon it is exactly the same as
4068 &%-odb%&.) A delivery process is automatically started to deliver the message,
4069 and Exim waits for it to complete before proceeding.
4070
4071 The original Exim reception process does not finish until the delivery
4072 process for the final message has ended. The standard error stream is left open
4073 during deliveries.
4074
4075 However, like &%-odb%&, this option has no effect if &%queue_only_override%& is
4076 false and one of the queueing options in the configuration file is in effect.
4077
4078 If there is a temporary delivery error during foreground delivery, the
4079 message is left on the queue for later delivery, and the original reception
4080 process exits. See chapter &<<CHAPnonqueueing>>& for a way of setting up a
4081 restricted configuration that never queues messages.
4082
4083
4084 .vitem &%-odi%&
4085 .oindex "&%-odi%&"
4086 This option is synonymous with &%-odf%&. It is provided for compatibility with
4087 Sendmail.
4088
4089 .vitem &%-odq%&
4090 .oindex "&%-odq%&"
4091 .cindex "non-immediate delivery"
4092 .cindex "delivery" "suppressing immediate"
4093 .cindex "queueing incoming messages"
4094 This option applies to all modes in which Exim accepts incoming messages,
4095 including the listening daemon. It specifies that the accepting process should
4096 not automatically start a delivery process for each message received. Messages
4097 are placed on the queue, and remain there until a subsequent queue runner
4098 process encounters them. There are several configuration options (such as
4099 &%queue_only%&) that can be used to queue incoming messages under certain
4100 conditions. This option overrides all of them and also &%-odqs%&. It always
4101 forces queueing.
4102
4103 .vitem &%-odqs%&
4104 .oindex "&%-odqs%&"
4105 .cindex "SMTP" "delaying delivery"
4106 This option is a hybrid between &%-odb%&/&%-odi%& and &%-odq%&.
4107 However, like &%-odb%& and &%-odi%&, this option has no effect if
4108 &%queue_only_override%& is false and one of the queueing options in the
4109 configuration file is in effect.
4110
4111 When &%-odqs%& does operate, a delivery process is started for each incoming
4112 message, in the background by default, but in the foreground if &%-odi%& is
4113 also present. The recipient addresses are routed, and local deliveries are done
4114 in the normal way. However, if any SMTP deliveries are required, they are not
4115 done at this time, so the message remains on the queue until a subsequent queue
4116 runner process encounters it. Because routing was done, Exim knows which
4117 messages are waiting for which hosts, and so a number of messages for the same
4118 host can be sent in a single SMTP connection. The &%queue_smtp_domains%&
4119 configuration option has the same effect for specific domains. See also the
4120 &%-qq%& option.
4121
4122 .vitem &%-oee%&
4123 .oindex "&%-oee%&"
4124 .cindex "error" "reporting"
4125 If an error is detected while a non-SMTP message is being received (for
4126 example, a malformed address), the error is reported to the sender in a mail
4127 message.
4128
4129 .cindex "return code" "for &%-oee%&"
4130 Provided
4131 this error message is successfully sent, the Exim receiving process
4132 exits with a return code of zero. If not, the return code is 2 if the problem
4133 is that the original message has no recipients, or 1 for any other error.
4134 This is the default &%-oe%&&'x'& option if Exim is called as &'rmail'&.
4135
4136 .vitem &%-oem%&
4137 .oindex "&%-oem%&"
4138 .cindex "error" "reporting"
4139 .cindex "return code" "for &%-oem%&"
4140 This is the same as &%-oee%&, except that Exim always exits with a non-zero
4141 return code, whether or not the error message was successfully sent.
4142 This is the default &%-oe%&&'x'& option, unless Exim is called as &'rmail'&.
4143
4144 .vitem &%-oep%&
4145 .oindex "&%-oep%&"
4146 .cindex "error" "reporting"
4147 If an error is detected while a non-SMTP message is being received, the
4148 error is reported by writing a message to the standard error file (stderr).
4149 .cindex "return code" "for &%-oep%&"
4150 The return code is 1 for all errors.
4151
4152 .vitem &%-oeq%&
4153 .oindex "&%-oeq%&"
4154 .cindex "error" "reporting"
4155 This option is supported for compatibility with Sendmail, but has the same
4156 effect as &%-oep%&.
4157
4158 .vitem &%-oew%&
4159 .oindex "&%-oew%&"
4160 .cindex "error" "reporting"
4161 This option is supported for compatibility with Sendmail, but has the same
4162 effect as &%-oem%&.
4163
4164 .vitem &%-oi%&
4165 .oindex "&%-oi%&"
4166 .cindex "dot" "in incoming non-SMTP message"
4167 This option, which has the same effect as &%-i%&, specifies that a dot on a
4168 line by itself should not terminate an incoming, non-SMTP message. Otherwise, a
4169 single dot does terminate, though Exim does no special processing for other
4170 lines that start with a dot. This option is set by default if Exim is called as
4171 &'rmail'&. See also &%-ti%&.
4172
4173 .vitem &%-oitrue%&
4174 .oindex "&%-oitrue%&"
4175 This option is treated as synonymous with &%-oi%&.
4176
4177 .vitem &%-oMa%&&~<&'host&~address'&>
4178 .oindex "&%-oMa%&"
4179 .cindex "sender" "host address, specifying for local message"
4180 A number of options starting with &%-oM%& can be used to set values associated
4181 with remote hosts on locally-submitted messages (that is, messages not received
4182 over TCP/IP). These options can be used by any caller in conjunction with the
4183 &%-bh%&, &%-be%&, &%-bf%&, &%-bF%&, &%-bt%&, or &%-bv%& testing options. In
4184 other circumstances, they are ignored unless the caller is trusted.
4185
4186 The &%-oMa%& option sets the sender host address. This may include a port
4187 number at the end, after a full stop (period). For example:
4188 .code
4189 exim -bs -oMa 10.9.8.7.1234
4190 .endd
4191 An alternative syntax is to enclose the IP address in square brackets,
4192 followed by a colon and the port number:
4193 .code
4194 exim -bs -oMa [10.9.8.7]:1234
4195 .endd
4196 The IP address is placed in the &$sender_host_address$& variable, and the
4197 port, if present, in &$sender_host_port$&. If both &%-oMa%& and &%-bh%&
4198 are present on the command line, the sender host IP address is taken from
4199 whichever one is last.
4200
4201 .vitem &%-oMaa%&&~<&'name'&>
4202 .oindex "&%-oMaa%&"
4203 .cindex "authentication" "name, specifying for local message"
4204 See &%-oMa%& above for general remarks about the &%-oM%& options. The &%-oMaa%&
4205 option sets the value of &$sender_host_authenticated$& (the authenticator
4206 name). See chapter &<<CHAPSMTPAUTH>>& for a discussion of SMTP authentication.
4207 This option can be used with &%-bh%& and &%-bs%& to set up an
4208 authenticated SMTP session without actually using the SMTP AUTH command.
4209
4210 .vitem &%-oMai%&&~<&'string'&>
4211 .oindex "&%-oMai%&"
4212 .cindex "authentication" "id, specifying for local message"
4213 See &%-oMa%& above for general remarks about the &%-oM%& options. The &%-oMai%&
4214 option sets the value of &$authenticated_id$& (the id that was authenticated).
4215 This overrides the default value (the caller's login id, except with &%-bh%&,
4216 where there is no default) for messages from local sources. See chapter
4217 &<<CHAPSMTPAUTH>>& for a discussion of authenticated ids.
4218
4219 .vitem &%-oMas%&&~<&'address'&>
4220 .oindex "&%-oMas%&"
4221 .cindex "authentication" "sender, specifying for local message"
4222 See &%-oMa%& above for general remarks about the &%-oM%& options. The &%-oMas%&
4223 option sets the authenticated sender value in &$authenticated_sender$&. It
4224 overrides the sender address that is created from the caller's login id for
4225 messages from local sources, except when &%-bh%& is used, when there is no
4226 default. For both &%-bh%& and &%-bs%&, an authenticated sender that is
4227 specified on a MAIL command overrides this value. See chapter
4228 &<<CHAPSMTPAUTH>>& for a discussion of authenticated senders.
4229
4230 .vitem &%-oMi%&&~<&'interface&~address'&>
4231 .oindex "&%-oMi%&"
4232 .cindex "interface" "address, specifying for local message"
4233 See &%-oMa%& above for general remarks about the &%-oM%& options. The &%-oMi%&
4234 option sets the IP interface address value. A port number may be included,
4235 using the same syntax as for &%-oMa%&. The interface address is placed in
4236 &$received_ip_address$& and the port number, if present, in &$received_port$&.
4237
4238 .vitem &%-oMr%&&~<&'protocol&~name'&>
4239 .oindex "&%-oMr%&"
4240 .cindex "protocol, specifying for local message"
4241 .vindex "&$received_protocol$&"
4242 See &%-oMa%& above for general remarks about the &%-oM%& options. The &%-oMr%&
4243 option sets the received protocol value that is stored in
4244 &$received_protocol$&. However, it does not apply (and is ignored) when &%-bh%&
4245 or &%-bs%& is used. For &%-bh%&, the protocol is forced to one of the standard
4246 SMTP protocol names (see the description of &$received_protocol$& in section
4247 &<<SECTexpvar>>&). For &%-bs%&, the protocol is always &"local-"& followed by
4248 one of those same names. For &%-bS%& (batched SMTP) however, the protocol can
4249 be set by &%-oMr%&.
4250
4251 .vitem &%-oMs%&&~<&'host&~name'&>
4252 .oindex "&%-oMs%&"
4253 .cindex "sender" "host name, specifying for local message"
4254 See &%-oMa%& above for general remarks about the &%-oM%& options. The &%-oMs%&
4255 option sets the sender host name in &$sender_host_name$&. When this option is
4256 present, Exim does not attempt to look up a host name from an IP address; it
4257 uses the name it is given.
4258
4259 .vitem &%-oMt%&&~<&'ident&~string'&>
4260 .oindex "&%-oMt%&"
4261 .cindex "sender" "ident string, specifying for local message"
4262 See &%-oMa%& above for general remarks about the &%-oM%& options. The &%-oMt%&
4263 option sets the sender ident value in &$sender_ident$&. The default setting for
4264 local callers is the login id of the calling process, except when &%-bh%& is
4265 used, when there is no default.
4266
4267 .vitem &%-om%&
4268 .oindex "&%-om%&"
4269 .cindex "Sendmail compatibility" "&%-om%& option ignored"
4270 In Sendmail, this option means &"me too"&, indicating that the sender of a
4271 message should receive a copy of the message if the sender appears in an alias
4272 expansion. Exim always does this, so the option does nothing.
4273
4274 .vitem &%-oo%&
4275 .oindex "&%-oo%&"
4276 .cindex "Sendmail compatibility" "&%-oo%& option ignored"
4277 This option is ignored. In Sendmail it specifies &"old style headers"&,
4278 whatever that means.
4279
4280 .vitem &%-oP%&&~<&'path'&>
4281 .oindex "&%-oP%&"
4282 .cindex "pid (process id)" "of daemon"
4283 .cindex "daemon" "process id (pid)"
4284 This option is useful only in conjunction with &%-bd%& or &%-q%& with a time
4285 value. The option specifies the file to which the process id of the daemon is
4286 written. When &%-oX%& is used with &%-bd%&, or when &%-q%& with a time is used
4287 without &%-bd%&, this is the only way of causing Exim to write a pid file,
4288 because in those cases, the normal pid file is not used.
4289
4290 .vitem &%-or%&&~<&'time'&>
4291 .oindex "&%-or%&"
4292 .cindex "timeout" "for non-SMTP input"
4293 This option sets a timeout value for incoming non-SMTP messages. If it is not
4294 set, Exim will wait forever for the standard input. The value can also be set
4295 by the &%receive_timeout%& option. The format used for specifying times is
4296 described in section &<<SECTtimeformat>>&.
4297
4298 .vitem &%-os%&&~<&'time'&>
4299 .oindex "&%-os%&"
4300 .cindex "timeout" "for SMTP input"
4301 .cindex "SMTP" "input timeout"
4302 This option sets a timeout value for incoming SMTP messages. The timeout
4303 applies to each SMTP command and block of data. The value can also be set by
4304 the &%smtp_receive_timeout%& option; it defaults to 5 minutes. The format used
4305 for specifying times is described in section &<<SECTtimeformat>>&.
4306
4307 .vitem &%-ov%&
4308 .oindex "&%-ov%&"
4309 This option has exactly the same effect as &%-v%&.
4310
4311 .vitem &%-oX%&&~<&'number&~or&~string'&>
4312 .oindex "&%-oX%&"
4313 .cindex "TCP/IP" "setting listening ports"
4314 .cindex "TCP/IP" "setting listening interfaces"
4315 .cindex "port" "receiving TCP/IP"
4316 This option is relevant only when the &%-bd%& (start listening daemon) option
4317 is also given. It controls which ports and interfaces the daemon uses. Details
4318 of the syntax, and how it interacts with configuration file options, are given
4319 in chapter &<<CHAPinterfaces>>&. When &%-oX%& is used to start a daemon, no pid
4320 file is written unless &%-oP%& is also present to specify a pid file name.
4321
4322 .vitem &%-pd%&
4323 .oindex "&%-pd%&"
4324 .cindex "Perl" "starting the interpreter"
4325 This option applies when an embedded Perl interpreter is linked with Exim (see
4326 chapter &<<CHAPperl>>&). It overrides the setting of the &%perl_at_start%&
4327 option, forcing the starting of the interpreter to be delayed until it is
4328 needed.
4329
4330 .vitem &%-ps%&
4331 .oindex "&%-ps%&"
4332 .cindex "Perl" "starting the interpreter"
4333 This option applies when an embedded Perl interpreter is linked with Exim (see
4334 chapter &<<CHAPperl>>&). It overrides the setting of the &%perl_at_start%&
4335 option, forcing the starting of the interpreter to occur as soon as Exim is
4336 started.
4337
4338 .vitem &%-p%&<&'rval'&>:<&'sval'&>
4339 .oindex "&%-p%&"
4340 For compatibility with Sendmail, this option is equivalent to
4341 .display
4342 &`-oMr`& <&'rval'&> &`-oMs`& <&'sval'&>
4343 .endd
4344 It sets the incoming protocol and host name (for trusted callers). The
4345 host name and its colon can be omitted when only the protocol is to be set.
4346 Note the Exim already has two private options, &%-pd%& and &%-ps%&, that refer
4347 to embedded Perl. It is therefore impossible to set a protocol value of &`d`&
4348 or &`s`& using this option (but that does not seem a real limitation).
4349
4350 .vitem &%-q%&
4351 .oindex "&%-q%&"
4352 .cindex "queue runner" "starting manually"
4353 This option is normally restricted to admin users. However, there is a
4354 configuration option called &%prod_requires_admin%& which can be set false to
4355 relax this restriction (and also the same requirement for the &%-M%&, &%-R%&,
4356 and &%-S%& options).
4357
4358 .cindex "queue runner" "description of operation"
4359 The &%-q%& option starts one queue runner process. This scans the queue of
4360 waiting messages, and runs a delivery process for each one in turn. It waits
4361 for each delivery process to finish before starting the next one. A delivery
4362 process may not actually do any deliveries if the retry times for the addresses
4363 have not been reached. Use &%-qf%& (see below) if you want to override this.
4364
4365 If
4366 .cindex "SMTP" "passed connection"
4367 .cindex "SMTP" "multiple deliveries"
4368 .cindex "multiple SMTP deliveries"
4369 the delivery process spawns other processes to deliver other messages down
4370 passed SMTP connections, the queue runner waits for these to finish before
4371 proceeding.
4372
4373 When all the queued messages have been considered, the original queue runner
4374 process terminates. In other words, a single pass is made over the waiting
4375 mail, one message at a time. Use &%-q%& with a time (see below) if you want
4376 this to be repeated periodically.
4377
4378 Exim processes the waiting messages in an unpredictable order. It isn't very
4379 random, but it is likely to be different each time, which is all that matters.
4380 If one particular message screws up a remote MTA, other messages to the same
4381 MTA have a chance of getting through if they get tried first.
4382
4383 It is possible to cause the messages to be processed in lexical message id
4384 order, which is essentially the order in which they arrived, by setting the
4385 &%queue_run_in_order%& option, but this is not recommended for normal use.
4386
4387 .vitem &%-q%&<&'qflags'&>
4388 The &%-q%& option may be followed by one or more flag letters that change its
4389 behaviour. They are all optional, but if more than one is present, they must
4390 appear in the correct order. Each flag is described in a separate item below.
4391
4392 .vitem &%-qq...%&
4393 .oindex "&%-qq%&"
4394 .cindex "queue" "double scanning"
4395 .cindex "queue" "routing"
4396 .cindex "routing" "whole queue before delivery"
4397 An option starting with &%-qq%& requests a two-stage queue run. In the first
4398 stage, the queue is scanned as if the &%queue_smtp_domains%& option matched
4399 every domain. Addresses are routed, local deliveries happen, but no remote
4400 transports are run.
4401
4402 .cindex "hints database" "remembering routing"
4403 The hints database that remembers which messages are waiting for specific hosts
4404 is updated, as if delivery to those hosts had been deferred. After this is
4405 complete, a second, normal queue scan happens, with routing and delivery taking
4406 place as normal. Messages that are routed to the same host should mostly be
4407 delivered down a single SMTP
4408 .cindex "SMTP" "passed connection"
4409 .cindex "SMTP" "multiple deliveries"
4410 .cindex "multiple SMTP deliveries"
4411 connection because of the hints that were set up during the first queue scan.
4412 This option may be useful for hosts that are connected to the Internet
4413 intermittently.
4414
4415 .vitem &%-q[q]i...%&
4416 .oindex "&%-qi%&"
4417 .cindex "queue" "initial delivery"
4418 If the &'i'& flag is present, the queue runner runs delivery processes only for
4419 those messages that haven't previously been tried. (&'i'& stands for &"initial
4420 delivery"&.) This can be helpful if you are putting messages on the queue using
4421 &%-odq%& and want a queue runner just to process the new messages.
4422
4423 .vitem &%-q[q][i]f...%&
4424 .oindex "&%-qf%&"
4425 .cindex "queue" "forcing delivery"
4426 .cindex "delivery" "forcing in queue run"
4427 If one &'f'& flag is present, a delivery attempt is forced for each non-frozen
4428 message, whereas without &'f'& only those non-frozen addresses that have passed
4429 their retry times are tried.
4430
4431 .vitem &%-q[q][i]ff...%&
4432 .oindex "&%-qff%&"
4433 .cindex "frozen messages" "forcing delivery"
4434 If &'ff'& is present, a delivery attempt is forced for every message, whether
4435 frozen or not.
4436
4437 .vitem &%-q[q][i][f[f]]l%&
4438 .oindex "&%-ql%&"
4439 .cindex "queue" "local deliveries only"
4440 The &'l'& (the letter &"ell"&) flag specifies that only local deliveries are to
4441 be done. If a message requires any remote deliveries, it remains on the queue
4442 for later delivery.
4443
4444 .vitem &%-q%&<&'qflags'&>&~<&'start&~id'&>&~<&'end&~id'&>
4445 .cindex "queue" "delivering specific messages"
4446 When scanning the queue, Exim can be made to skip over messages whose ids are
4447 lexically less than a given value by following the &%-q%& option with a
4448 starting message id. For example:
4449 .code
4450 exim -q 0t5C6f-0000c8-00
4451 .endd
4452 Messages that arrived earlier than &`0t5C6f-0000c8-00`& are not inspected. If a
4453 second message id is given, messages whose ids are lexically greater than it
4454 are also skipped. If the same id is given twice, for example,
4455 .code
4456 exim -q 0t5C6f-0000c8-00 0t5C6f-0000c8-00
4457 .endd
4458 just one delivery process is started, for that message. This differs from
4459 &%-M%& in that retry data is respected, and it also differs from &%-Mc%& in
4460 that it counts as a delivery from a queue run. Note that the selection
4461 mechanism does not affect the order in which the messages are scanned. There
4462 are also other ways of selecting specific sets of messages for delivery in a
4463 queue run &-- see &%-R%& and &%-S%&.
4464
4465 .vitem &%-q%&<&'qflags'&><&'time'&>
4466 .cindex "queue runner" "starting periodically"
4467 .cindex "periodic queue running"
4468 When a time value is present, the &%-q%& option causes Exim to run as a daemon,
4469 starting a queue runner process at intervals specified by the given time value
4470 (whose format is described in section &<<SECTtimeformat>>&). This form of the
4471 &%-q%& option is commonly combined with the &%-bd%& option, in which case a
4472 single daemon process handles both functions. A common way of starting up a
4473 combined daemon at system boot time is to use a command such as
4474 .code
4475 /usr/exim/bin/exim -bd -q30m
4476 .endd
4477 Such a daemon listens for incoming SMTP calls, and also starts a queue runner
4478 process every 30 minutes.
4479
4480 When a daemon is started by &%-q%& with a time value, but without &%-bd%&, no
4481 pid file is written unless one is explicitly requested by the &%-oP%& option.
4482
4483 .vitem &%-qR%&<&'rsflags'&>&~<&'string'&>
4484 .oindex "&%-qR%&"
4485 This option is synonymous with &%-R%&. It is provided for Sendmail
4486 compatibility.
4487
4488 .vitem &%-qS%&<&'rsflags'&>&~<&'string'&>
4489 .oindex "&%-qS%&"
4490 This option is synonymous with &%-S%&.
4491
4492 .vitem &%-R%&<&'rsflags'&>&~<&'string'&>
4493 .oindex "&%-R%&"
4494 .cindex "queue runner" "for specific recipients"
4495 .cindex "delivery" "to given domain"
4496 .cindex "domain" "delivery to"
4497 The <&'rsflags'&> may be empty, in which case the white space before the string
4498 is optional, unless the string is &'f'&, &'ff'&, &'r'&, &'rf'&, or &'rff'&,
4499 which are the possible values for <&'rsflags'&>. White space is required if
4500 <&'rsflags'&> is not empty.
4501
4502 This option is similar to &%-q%& with no time value, that is, it causes Exim to
4503 perform a single queue run, except that, when scanning the messages on the
4504 queue, Exim processes only those that have at least one undelivered recipient
4505 address containing the given string, which is checked in a case-independent
4506 way. If the <&'rsflags'&> start with &'r'&, <&'string'&> is interpreted as a
4507 regular expression; otherwise it is a literal string.
4508
4509 If you want to do periodic queue runs for messages with specific recipients,
4510 you can combine &%-R%& with &%-q%& and a time value. For example:
4511 .code
4512 exim -q25m -R @special.domain.example
4513 .endd
4514 This example does a queue run for messages with recipients in the given domain
4515 every 25 minutes. Any additional flags that are specified with &%-q%& are
4516 applied to each queue run.
4517
4518 Once a message is selected for delivery by this mechanism, all its addresses
4519 are processed. For the first selected message, Exim overrides any retry
4520 information and forces a delivery attempt for each undelivered address. This
4521 means that if delivery of any address in the first message is successful, any
4522 existing retry information is deleted, and so delivery attempts for that
4523 address in subsequently selected messages (which are processed without forcing)
4524 will run. However, if delivery of any address does not succeed, the retry
4525 information is updated, and in subsequently selected messages, the failing
4526 address will be skipped.
4527
4528 .cindex "frozen messages" "forcing delivery"
4529 If the <&'rsflags'&> contain &'f'& or &'ff'&, the delivery forcing applies to
4530 all selected messages, not just the first; frozen messages are included when
4531 &'ff'& is present.
4532
4533 The &%-R%& option makes it straightforward to initiate delivery of all messages
4534 to a given domain after a host has been down for some time. When the SMTP
4535 command ETRN is accepted by its ACL (see chapter &<<CHAPACL>>&), its default
4536 effect is to run Exim with the &%-R%& option, but it can be configured to run
4537 an arbitrary command instead.
4538
4539 .vitem &%-r%&
4540 .oindex "&%-r%&"
4541 This is a documented (for Sendmail) obsolete alternative name for &%-f%&.
4542
4543 .vitem &%-S%&<&'rsflags'&>&~<&'string'&>
4544 .oindex "&%-S%&"
4545 .cindex "delivery" "from given sender"
4546 .cindex "queue runner" "for specific senders"
4547 This option acts like &%-R%& except that it checks the string against each
4548 message's sender instead of against the recipients. If &%-R%& is also set, both
4549 conditions must be met for a message to be selected. If either of the options
4550 has &'f'& or &'ff'& in its flags, the associated action is taken.
4551
4552 .vitem &%-Tqt%&&~<&'times'&>
4553 .oindex "&%-Tqt%&"
4554 This is an option that is exclusively for use by the Exim testing suite. It is not
4555 recognized when Exim is run normally. It allows for the setting up of explicit
4556 &"queue times"& so that various warning/retry features can be tested.
4557
4558 .vitem &%-t%&
4559 .oindex "&%-t%&"
4560 .cindex "recipient" "extracting from header lines"
4561 .cindex "&'Bcc:'& header line"
4562 .cindex "&'Cc:'& header line"
4563 .cindex "&'To:'& header line"
4564 When Exim is receiving a locally-generated, non-SMTP message on its standard
4565 input, the &%-t%& option causes the recipients of the message to be obtained
4566 from the &'To:'&, &'Cc:'&, and &'Bcc:'& header lines in the message instead of
4567 from the command arguments. The addresses are extracted before any rewriting
4568 takes place and the &'Bcc:'& header line, if present, is then removed.
4569
4570 .cindex "Sendmail compatibility" "&%-t%& option"
4571 If the command has any arguments, they specify addresses to which the message
4572 is &'not'& to be delivered. That is, the argument addresses are removed from
4573 the recipients list obtained from the headers. This is compatible with Smail 3
4574 and in accordance with the documented behaviour of several versions of
4575 Sendmail, as described in man pages on a number of operating systems (e.g.
4576 Solaris 8, IRIX 6.5, HP-UX 11). However, some versions of Sendmail &'add'&
4577 argument addresses to those obtained from the headers, and the O'Reilly
4578 Sendmail book documents it that way. Exim can be made to add argument addresses
4579 instead of subtracting them by setting the option
4580 &%extract_addresses_remove_arguments%& false.
4581
4582 .cindex "&%Resent-%& header lines" "with &%-t%&"
4583 If there are any &%Resent-%& header lines in the message, Exim extracts
4584 recipients from all &'Resent-To:'&, &'Resent-Cc:'&, and &'Resent-Bcc:'& header
4585 lines instead of from &'To:'&, &'Cc:'&, and &'Bcc:'&. This is for compatibility
4586 with Sendmail and other MTAs. (Prior to release 4.20, Exim gave an error if
4587 &%-t%& was used in conjunction with &%Resent-%& header lines.)
4588
4589 RFC 2822 talks about different sets of &%Resent-%& header lines (for when a
4590 message is resent several times). The RFC also specifies that they should be
4591 added at the front of the message, and separated by &'Received:'& lines. It is
4592 not at all clear how &%-t%& should operate in the present of multiple sets,
4593 nor indeed exactly what constitutes a &"set"&.
4594 In practice, it seems that MUAs do not follow the RFC. The &%Resent-%& lines
4595 are often added at the end of the header, and if a message is resent more than
4596 once, it is common for the original set of &%Resent-%& headers to be renamed as
4597 &%X-Resent-%& when a new set is added. This removes any possible ambiguity.
4598
4599 .vitem &%-ti%&
4600 .oindex "&%-ti%&"
4601 This option is exactly equivalent to &%-t%& &%-i%&. It is provided for
4602 compatibility with Sendmail.
4603
4604 .vitem &%-tls-on-connect%&
4605 .oindex "&%-tls-on-connect%&"
4606 .cindex "TLS" "use without STARTTLS"
4607 .cindex "TLS" "automatic start"
4608 This option is available when Exim is compiled with TLS support. It forces all
4609 incoming SMTP connections to behave as if the incoming port is listed in the
4610 &%tls_on_connect_ports%& option. See section &<<SECTsupobssmt>>& and chapter
4611 &<<CHAPTLS>>& for further details.
4612
4613
4614 .vitem &%-U%&
4615 .oindex "&%-U%&"
4616 .cindex "Sendmail compatibility" "&%-U%& option ignored"
4617 Sendmail uses this option for &"initial message submission"&, and its
4618 documentation states that in future releases, it may complain about
4619 syntactically invalid messages rather than fixing them when this flag is not
4620 set. Exim ignores this option.
4621
4622 .vitem &%-v%&
4623 .oindex "&%-v%&"
4624 This option causes Exim to write information to the standard error stream,
4625 describing what it is doing. In particular, it shows the log lines for
4626 receiving and delivering a message, and if an SMTP connection is made, the SMTP
4627 dialogue is shown. Some of the log lines shown may not actually be written to
4628 the log if the setting of &%log_selector%& discards them. Any relevant
4629 selectors are shown with each log line. If none are shown, the logging is
4630 unconditional.
4631
4632 .vitem &%-x%&
4633 .oindex "&%-x%&"
4634 AIX uses &%-x%& for a private purpose (&"mail from a local mail program has
4635 National Language Support extended characters in the body of the mail item"&).
4636 It sets &%-x%& when calling the MTA from its &%mail%& command. Exim ignores
4637 this option.
4638
4639 .new
4640 .vitem &%-X%&&~<&'logfile'&>
4641 .oindex "&%-X%&"
4642 This option is interpreted by Sendmail to cause debug information to be sent
4643 to the named file.  It is ignored by Exim.
4644 .wen
4645 .endlist
4646
4647 .ecindex IIDclo1
4648 .ecindex IIDclo2
4649
4650
4651 . ////////////////////////////////////////////////////////////////////////////
4652 . Insert a stylized DocBook comment here, to identify the end of the command
4653 . line options. This is for the benefit of the Perl script that automatically
4654 . creates a man page for the options.
4655 . ////////////////////////////////////////////////////////////////////////////
4656
4657 .literal xml
4658 <!-- === End of command line options === -->
4659 .literal off
4660
4661
4662
4663
4664
4665 . ////////////////////////////////////////////////////////////////////////////
4666 . ////////////////////////////////////////////////////////////////////////////
4667
4668
4669 .chapter "The Exim run time configuration file" "CHAPconf" &&&
4670          "The runtime configuration file"
4671
4672 .cindex "run time configuration"
4673 .cindex "configuration file" "general description"
4674 .cindex "CONFIGURE_FILE"
4675 .cindex "configuration file" "errors in"
4676 .cindex "error" "in configuration file"
4677 .cindex "return code" "for bad configuration"
4678 Exim uses a single run time configuration file that is read whenever an Exim
4679 binary is executed. Note that in normal operation, this happens frequently,
4680 because Exim is designed to operate in a distributed manner, without central
4681 control.
4682
4683 If a syntax error is detected while reading the configuration file, Exim
4684 writes a message on the standard error, and exits with a non-zero return code.
4685 The message is also written to the panic log. &*Note*&: Only simple syntax
4686 errors can be detected at this time. The values of any expanded options are
4687 not checked until the expansion happens, even when the expansion does not
4688 actually alter the string.
4689
4690 The name of the configuration file is compiled into the binary for security
4691 reasons, and is specified by the CONFIGURE_FILE compilation option. In
4692 most configurations, this specifies a single file. However, it is permitted to
4693 give a colon-separated list of file names, in which case Exim uses the first
4694 existing file in the list.
4695
4696 .cindex "EXIM_USER"
4697 .cindex "EXIM_GROUP"
4698 .cindex "CONFIGURE_OWNER"
4699 .cindex "CONFIGURE_GROUP"
4700 .cindex "configuration file" "ownership"
4701 .cindex "ownership" "configuration file"
4702 The run time configuration file must be owned by root or by the user that is
4703 specified at compile time by the CONFIGURE_OWNER option (if set). The
4704 configuration file must not be world-writeable, or group-writeable unless its
4705 group is the root group or the one specified at compile time by the
4706 CONFIGURE_GROUP option.
4707
4708 &*Warning*&: In a conventional configuration, where the Exim binary is setuid
4709 to root, anybody who is able to edit the run time configuration file has an
4710 easy way to run commands as root. If you specify a user or group in the
4711 CONFIGURE_OWNER or CONFIGURE_GROUP options, then that user and/or any users
4712 who are members of that group will trivially be able to obtain root privileges.
4713
4714 Up to Exim version 4.72, the run time configuration file was also permitted to
4715 be writeable by the Exim user and/or group. That has been changed in Exim 4.73
4716 since it offered a simple privilege escalation for any attacker who managed to
4717 compromise the Exim user account.
4718
4719 A default configuration file, which will work correctly in simple situations,
4720 is provided in the file &_src/configure.default_&. If CONFIGURE_FILE
4721 defines just one file name, the installation process copies the default
4722 configuration to a new file of that name if it did not previously exist. If
4723 CONFIGURE_FILE is a list, no default is automatically installed. Chapter
4724 &<<CHAPdefconfil>>& is a &"walk-through"& discussion of the default
4725 configuration.
4726
4727
4728
4729 .section "Using a different configuration file" "SECID40"
4730 .cindex "configuration file" "alternate"
4731 A one-off alternate configuration can be specified by the &%-C%& command line
4732 option, which may specify a single file or a list of files. However, when
4733 &%-C%& is used, Exim gives up its root privilege, unless called by root (or
4734 unless the argument for &%-C%& is identical to the built-in value from
4735 CONFIGURE_FILE), or is listed in the TRUSTED_CONFIG_LIST file and the caller
4736 is the Exim user or the user specified in the CONFIGURE_OWNER setting. &%-C%&
4737 is useful mainly for checking the syntax of configuration files before
4738 installing them. No owner or group checks are done on a configuration file
4739 specified by &%-C%&, if root privilege has been dropped.
4740
4741 Even the Exim user is not trusted to specify an arbitrary configuration file
4742 with the &%-C%& option to be used with root privileges, unless that file is
4743 listed in the TRUSTED_CONFIG_LIST file. This locks out the possibility of
4744 testing a configuration using &%-C%& right through message reception and
4745 delivery, even if the caller is root. The reception works, but by that time,
4746 Exim is running as the Exim user, so when it re-execs to regain privilege for
4747 the delivery, the use of &%-C%& causes privilege to be lost. However, root
4748 can test reception and delivery using two separate commands (one to put a
4749 message on the queue, using &%-odq%&, and another to do the delivery, using
4750 &%-M%&).
4751
4752 If ALT_CONFIG_PREFIX is defined &_in Local/Makefile_&, it specifies a
4753 prefix string with which any file named in a &%-C%& command line option must
4754 start. In addition, the file name must not contain the sequence &"&`/../`&"&.
4755 There is no default setting for ALT_CONFIG_PREFIX; when it is unset, any file
4756 name can be used with &%-C%&.
4757
4758 One-off changes to a configuration can be specified by the &%-D%& command line
4759 option, which defines and overrides values for macros used inside the
4760 configuration file. However, like &%-C%&, the use of this option by a
4761 non-privileged user causes Exim to discard its root privilege.
4762 If DISABLE_D_OPTION is defined in &_Local/Makefile_&, the use of &%-D%& is
4763 completely disabled, and its use causes an immediate error exit.
4764
4765 The WHITELIST_D_MACROS option in &_Local/Makefile_& permits the binary builder
4766 to declare certain macro names trusted, such that root privilege will not
4767 necessarily be discarded.
4768 WHITELIST_D_MACROS defines a colon-separated list of macros which are
4769 considered safe and, if &%-D%& only supplies macros from this list, and the
4770 values are acceptable, then Exim will not give up root privilege if the caller
4771 is root, the Exim run-time user, or the CONFIGURE_OWNER, if set.  This is a
4772 transition mechanism and is expected to be removed in the future.  Acceptable
4773 values for the macros satisfy the regexp: &`^[A-Za-z0-9_/.-]*$`&
4774
4775 Some sites may wish to use the same Exim binary on different machines that
4776 share a file system, but to use different configuration files on each machine.
4777 If CONFIGURE_FILE_USE_NODE is defined in &_Local/Makefile_&, Exim first
4778 looks for a file whose name is the configuration file name followed by a dot
4779 and the machine's node name, as obtained from the &[uname()]& function. If this
4780 file does not exist, the standard name is tried. This processing occurs for
4781 each file name in the list given by CONFIGURE_FILE or &%-C%&.
4782
4783 In some esoteric situations different versions of Exim may be run under
4784 different effective uids and the CONFIGURE_FILE_USE_EUID is defined to
4785 help with this. See the comments in &_src/EDITME_& for details.
4786
4787
4788
4789 .section "Configuration file format" "SECTconffilfor"
4790 .cindex "configuration file" "format of"
4791 .cindex "format" "configuration file"
4792 Exim's configuration file is divided into a number of different parts. General
4793 option settings must always appear at the start of the file. The other parts
4794 are all optional, and may appear in any order. Each part other than the first
4795 is introduced by the word &"begin"& followed by the name of the part. The
4796 optional parts are:
4797
4798 .ilist
4799 &'ACL'&: Access control lists for controlling incoming SMTP mail (see chapter
4800 &<<CHAPACL>>&).
4801 .next
4802 .cindex "AUTH" "configuration"
4803 &'authenticators'&: Configuration settings for the authenticator drivers. These
4804 are concerned with the SMTP AUTH command (see chapter &<<CHAPSMTPAUTH>>&).
4805 .next
4806 &'routers'&: Configuration settings for the router drivers. Routers process
4807 addresses and determine how the message is to be delivered (see chapters
4808 &<<CHAProutergeneric>>&&--&<<CHAPredirect>>&).
4809 .next
4810 &'transports'&: Configuration settings for the transport drivers. Transports
4811 define mechanisms for copying messages to destinations (see chapters
4812 &<<CHAPtransportgeneric>>&&--&<<CHAPsmtptrans>>&).
4813 .next
4814 &'retry'&: Retry rules, for use when a message cannot be delivered immediately.
4815 If there is no retry section, or if it is empty (that is, no retry rules are
4816 defined), Exim will not retry deliveries. In this situation, temporary errors
4817 are treated the same as permanent errors. Retry rules are discussed in chapter
4818 &<<CHAPretry>>&.
4819 .next
4820 &'rewrite'&: Global address rewriting rules, for use when a message arrives and
4821 when new addresses are generated during delivery. Rewriting is discussed in
4822 chapter &<<CHAPrewrite>>&.
4823 .next
4824 &'local_scan'&: Private options for the &[local_scan()]& function. If you
4825 want to use this feature, you must set
4826 .code
4827 LOCAL_SCAN_HAS_OPTIONS=yes
4828 .endd
4829 in &_Local/Makefile_& before building Exim. Details of the &[local_scan()]&
4830 facility are given in chapter &<<CHAPlocalscan>>&.
4831 .endlist
4832
4833 .cindex "configuration file" "leading white space in"
4834 .cindex "configuration file" "trailing white space in"
4835 .cindex "white space" "in configuration file"
4836 Leading and trailing white space in configuration lines is always ignored.
4837
4838 Blank lines in the file, and lines starting with a # character (ignoring
4839 leading white space) are treated as comments and are ignored. &*Note*&: A
4840 # character other than at the beginning of a line is not treated specially,
4841 and does not introduce a comment.
4842
4843 Any non-comment line can be continued by ending it with a backslash. Note that
4844 the general rule for white space means that trailing white space after the
4845 backslash and leading white space at the start of continuation
4846 lines is ignored. Comment lines beginning with # (but not empty lines) may
4847 appear in the middle of a sequence of continuation lines.
4848
4849 A convenient way to create a configuration file is to start from the
4850 default, which is supplied in &_src/configure.default_&, and add, delete, or
4851 change settings as required.
4852
4853 The ACLs, retry rules, and rewriting rules have their own syntax which is
4854 described in chapters &<<CHAPACL>>&, &<<CHAPretry>>&, and &<<CHAPrewrite>>&,
4855 respectively. The other parts of the configuration file have some syntactic
4856 items in common, and these are described below, from section &<<SECTcos>>&
4857 onwards. Before that, the inclusion, macro, and conditional facilities are
4858 described.
4859
4860
4861
4862 .section "File inclusions in the configuration file" "SECID41"
4863 .cindex "inclusions in configuration file"
4864 .cindex "configuration file" "including other files"
4865 .cindex "&`.include`& in configuration file"
4866 .cindex "&`.include_if_exists`& in configuration file"
4867 You can include other files inside Exim's run time configuration file by
4868 using this syntax:
4869 .display
4870 &`.include`& <&'file name'&>
4871 &`.include_if_exists`& <&'file name'&>
4872 .endd
4873 on a line by itself. Double quotes round the file name are optional. If you use
4874 the first form, a configuration error occurs if the file does not exist; the
4875 second form does nothing for non-existent files. In all cases, an absolute file
4876 name is required.
4877
4878 Includes may be nested to any depth, but remember that Exim reads its
4879 configuration file often, so it is a good idea to keep them to a minimum.
4880 If you change the contents of an included file, you must HUP the daemon,
4881 because an included file is read only when the configuration itself is read.
4882
4883 The processing of inclusions happens early, at a physical line level, so, like
4884 comment lines, an inclusion can be used in the middle of an option setting,
4885 for example:
4886 .code
4887 hosts_lookup = a.b.c \
4888                .include /some/file
4889 .endd
4890 Include processing happens after macro processing (see below). Its effect is to
4891 process the lines of the included file as if they occurred inline where the
4892 inclusion appears.
4893
4894
4895
4896 .section "Macros in the configuration file" "SECTmacrodefs"
4897 .cindex "macro" "description of"
4898 .cindex "configuration file" "macros"
4899 If a line in the main part of the configuration (that is, before the first
4900 &"begin"& line) begins with an upper case letter, it is taken as a macro
4901 definition, and must be of the form
4902 .display
4903 <&'name'&> = <&'rest of line'&>
4904 .endd
4905 The name must consist of letters, digits, and underscores, and need not all be
4906 in upper case, though that is recommended. The rest of the line, including any
4907 continuations, is the replacement text, and has leading and trailing white
4908 space removed. Quotes are not removed. The replacement text can never end with
4909 a backslash character, but this doesn't seem to be a serious limitation.
4910
4911 Macros may also be defined between router, transport, authenticator, or ACL
4912 definitions. They may not, however, be defined within an individual driver or
4913 ACL, or in the &%local_scan%&, retry, or rewrite sections of the configuration.
4914
4915 .section "Macro substitution" "SECID42"
4916 Once a macro is defined, all subsequent lines in the file (and any included
4917 files) are scanned for the macro name; if there are several macros, the line is
4918 scanned for each in turn, in the order in which the macros are defined. The
4919 replacement text is not re-scanned for the current macro, though it is scanned
4920 for subsequently defined macros. For this reason, a macro name may not contain
4921 the name of a previously defined macro as a substring. You could, for example,
4922 define
4923 .display
4924 &`ABCD_XYZ = `&<&'something'&>
4925 &`ABCD = `&<&'something else'&>
4926 .endd
4927 but putting the definitions in the opposite order would provoke a configuration
4928 error. Macro expansion is applied to individual physical lines from the file,
4929 before checking for line continuation or file inclusion (see above). If a line
4930 consists solely of a macro name, and the expansion of the macro is empty, the
4931 line is ignored. A macro at the start of a line may turn the line into a
4932 comment line or a &`.include`& line.
4933
4934
4935 .section "Redefining macros" "SECID43"
4936 Once defined, the value of a macro can be redefined later in the configuration
4937 (or in an included file). Redefinition is specified by using &'=='& instead of
4938 &'='&. For example:
4939 .code
4940 MAC =  initial value
4941 ...
4942 MAC == updated value
4943 .endd
4944 Redefinition does not alter the order in which the macros are applied to the
4945 subsequent lines of the configuration file. It is still the same order in which
4946 the macros were originally defined. All that changes is the macro's value.
4947 Redefinition makes it possible to accumulate values. For example:
4948 .code
4949 MAC =  initial value
4950 ...
4951 MAC == MAC and something added
4952 .endd
4953 This can be helpful in situations where the configuration file is built
4954 from a number of other files.
4955
4956 .section "Overriding macro values" "SECID44"
4957 The values set for macros in the configuration file can be overridden by the
4958 &%-D%& command line option, but Exim gives up its root privilege when &%-D%& is
4959 used, unless called by root or the Exim user. A definition on the command line
4960 using the &%-D%& option causes all definitions and redefinitions within the
4961 file to be ignored.
4962
4963
4964
4965 .section "Example of macro usage" "SECID45"
4966 As an example of macro usage, consider a configuration where aliases are looked
4967 up in a MySQL database. It helps to keep the file less cluttered if long
4968 strings such as SQL statements are defined separately as macros, for example:
4969 .code
4970 ALIAS_QUERY = select mailbox from user where \
4971               login='${quote_mysql:$local_part}';
4972 .endd
4973 This can then be used in a &(redirect)& router setting like this:
4974 .code
4975 data = ${lookup mysql{ALIAS_QUERY}}
4976 .endd
4977 In earlier versions of Exim macros were sometimes used for domain, host, or
4978 address lists. In Exim 4 these are handled better by named lists &-- see
4979 section &<<SECTnamedlists>>&.
4980
4981
4982 .section "Conditional skips in the configuration file" "SECID46"
4983 .cindex "configuration file" "conditional skips"
4984 .cindex "&`.ifdef`&"
4985 You can use the directives &`.ifdef`&, &`.ifndef`&, &`.elifdef`&,
4986 &`.elifndef`&, &`.else`&, and &`.endif`& to dynamically include or exclude
4987 portions of the configuration file. The processing happens whenever the file is
4988 read (that is, when an Exim binary starts to run).
4989
4990 The implementation is very simple. Instances of the first four directives must
4991 be followed by text that includes the names of one or macros. The condition
4992 that is tested is whether or not any macro substitution has taken place in the
4993 line. Thus:
4994 .code
4995 .ifdef AAA
4996 message_size_limit = 50M
4997 .else
4998 message_size_limit = 100M
4999 .endif
5000 .endd
5001 sets a message size limit of 50M if the macro &`AAA`& is defined, and 100M
5002 otherwise. If there is more than one macro named on the line, the condition
5003 is true if any of them are defined. That is, it is an &"or"& condition. To
5004 obtain an &"and"& condition, you need to use nested &`.ifdef`&s.
5005
5006 Although you can use a macro expansion to generate one of these directives,
5007 it is not very useful, because the condition &"there was a macro substitution
5008 in this line"& will always be true.
5009
5010 Text following &`.else`& and &`.endif`& is ignored, and can be used as comment
5011 to clarify complicated nestings.
5012
5013
5014
5015 .section "Common option syntax" "SECTcos"
5016 .cindex "common option syntax"
5017 .cindex "syntax of common options"
5018 .cindex "configuration file" "common option syntax"
5019 For the main set of options, driver options, and &[local_scan()]& options,
5020 each setting is on a line by itself, and starts with a name consisting of
5021 lower-case letters and underscores. Many options require a data value, and in
5022 these cases the name must be followed by an equals sign (with optional white
5023 space) and then the value. For example:
5024 .code
5025 qualify_domain = mydomain.example.com
5026 .endd
5027 .cindex "hiding configuration option values"
5028 .cindex "configuration options" "hiding value of"
5029 .cindex "options" "hiding value of"
5030 Some option settings may contain sensitive data, for example, passwords for
5031 accessing databases. To stop non-admin users from using the &%-bP%& command
5032 line option to read these values, you can precede the option settings with the
5033 word &"hide"&. For example:
5034 .code
5035 hide mysql_servers = localhost/users/admin/secret-password
5036 .endd
5037 For non-admin users, such options are displayed like this:
5038 .code
5039 mysql_servers = <value not displayable>
5040 .endd
5041 If &"hide"& is used on a driver option, it hides the value of that option on
5042 all instances of the same driver.
5043
5044 The following sections describe the syntax used for the different data types
5045 that are found in option settings.
5046
5047
5048 .section "Boolean options" "SECID47"
5049 .cindex "format" "boolean"
5050 .cindex "boolean configuration values"
5051 .oindex "&%no_%&&'xxx'&"
5052 .oindex "&%not_%&&'xxx'&"
5053 Options whose type is given as boolean are on/off switches. There are two
5054 different ways of specifying such options: with and without a data value. If
5055 the option name is specified on its own without data, the switch is turned on;
5056 if it is preceded by &"no_"& or &"not_"& the switch is turned off. However,
5057 boolean options may be followed by an equals sign and one of the words
5058 &"true"&, &"false"&, &"yes"&, or &"no"&, as an alternative syntax. For example,
5059 the following two settings have exactly the same effect:
5060 .code
5061 queue_only
5062 queue_only = true
5063 .endd
5064 The following two lines also have the same (opposite) effect:
5065 .code
5066 no_queue_only
5067 queue_only = false
5068 .endd
5069 You can use whichever syntax you prefer.
5070
5071
5072
5073
5074 .section "Integer values" "SECID48"
5075 .cindex "integer configuration values"
5076 .cindex "format" "integer"
5077 If an option's type is given as &"integer"&, the value can be given in decimal,
5078 hexadecimal, or octal. If it starts with a digit greater than zero, a decimal
5079 number is assumed. Otherwise, it is treated as an octal number unless it starts
5080 with the characters &"0x"&, in which case the remainder is interpreted as a
5081 hexadecimal number.
5082
5083 If an integer value is followed by the letter K, it is multiplied by 1024; if
5084 it is followed by the letter M, it is multiplied by 1024x1024. When the values
5085 of integer option settings are output, values which are an exact multiple of
5086 1024 or 1024x1024 are sometimes, but not always, printed using the letters K
5087 and M. The printing style is independent of the actual input format that was
5088 used.
5089
5090
5091 .section "Octal integer values" "SECID49"
5092 .cindex "integer format"
5093 .cindex "format" "octal integer"
5094 If an option's type is given as &"octal integer"&, its value is always
5095 interpreted as an octal number, whether or not it starts with the digit zero.
5096 Such options are always output in octal.
5097
5098
5099 .section "Fixed point numbers" "SECID50"
5100 .cindex "fixed point configuration values"
5101 .cindex "format" "fixed point"
5102 If an option's type is given as &"fixed-point"&, its value must be a decimal
5103 integer, optionally followed by a decimal point and up to three further digits.
5104
5105
5106
5107 .section "Time intervals" "SECTtimeformat"
5108 .cindex "time interval" "specifying in configuration"
5109 .cindex "format" "time interval"
5110 A time interval is specified as a sequence of numbers, each followed by one of
5111 the following letters, with no intervening white space:
5112
5113 .table2 30pt
5114 .irow &%s%& seconds
5115 .irow &%m%& minutes
5116 .irow &%h%& hours
5117 .irow &%d%& days
5118 .irow &%w%& weeks
5119 .endtable
5120
5121 For example, &"3h50m"& specifies 3 hours and 50 minutes. The values of time
5122 intervals are output in the same format. Exim does not restrict the values; it
5123 is perfectly acceptable, for example, to specify &"90m"& instead of &"1h30m"&.
5124
5125
5126
5127 .section "String values" "SECTstrings"
5128 .cindex "string" "format of configuration values"
5129 .cindex "format" "string"
5130 If an option's type is specified as &"string"&, the value can be specified with
5131 or without double-quotes. If it does not start with a double-quote, the value
5132 consists of the remainder of the line plus any continuation lines, starting at
5133 the first character after any leading white space, with trailing white space
5134 removed, and with no interpretation of the characters in the string. Because
5135 Exim removes comment lines (those beginning with #) at an early stage, they can
5136 appear in the middle of a multi-line string. The following two settings are
5137 therefore equivalent:
5138 .code
5139 trusted_users = uucp:mail
5140 trusted_users = uucp:\
5141                 # This comment line is ignored
5142                 mail
5143 .endd
5144 .cindex "string" "quoted"
5145 .cindex "escape characters in quoted strings"
5146 If a string does start with a double-quote, it must end with a closing
5147 double-quote, and any backslash characters other than those used for line
5148 continuation are interpreted as escape characters, as follows:
5149
5150 .table2 100pt
5151 .irow &`\\`&                     "single backslash"
5152 .irow &`\n`&                     "newline"
5153 .irow &`\r`&                     "carriage return"
5154 .irow &`\t`&                     "tab"
5155 .irow "&`\`&<&'octal digits'&>"  "up to 3 octal digits specify one character"
5156 .irow "&`\x`&<&'hex digits'&>"   "up to 2 hexadecimal digits specify one &&&
5157                                    character"
5158 .endtable
5159
5160 If a backslash is followed by some other character, including a double-quote
5161 character, that character replaces the pair.
5162
5163 Quoting is necessary only if you want to make use of the backslash escapes to
5164 insert special characters, or if you need to specify a value with leading or
5165 trailing spaces. These cases are rare, so quoting is almost never needed in
5166 current versions of Exim. In versions of Exim before 3.14, quoting was required
5167 in order to continue lines, so you may come across older configuration files
5168 and examples that apparently quote unnecessarily.
5169
5170
5171 .section "Expanded strings" "SECID51"
5172 .cindex "expansion" "definition of"
5173 Some strings in the configuration file are subjected to &'string expansion'&,
5174 by which means various parts of the string may be changed according to the
5175 circumstances (see chapter &<<CHAPexpand>>&). The input syntax for such strings
5176 is as just described; in particular, the handling of backslashes in quoted
5177 strings is done as part of the input process, before expansion takes place.
5178 However, backslash is also an escape character for the expander, so any
5179 backslashes that are required for that reason must be doubled if they are
5180 within a quoted configuration string.
5181
5182
5183 .section "User and group names" "SECID52"
5184 .cindex "user name" "format of"
5185 .cindex "format" "user name"
5186 .cindex "groups" "name format"
5187 .cindex "format" "group name"
5188 User and group names are specified as strings, using the syntax described
5189 above, but the strings are interpreted specially. A user or group name must
5190 either consist entirely of digits, or be a name that can be looked up using the
5191 &[getpwnam()]& or &[getgrnam()]& function, as appropriate.
5192
5193
5194 .section "List construction" "SECTlistconstruct"
5195 .cindex "list" "syntax of in configuration"
5196 .cindex "format" "list item in configuration"
5197 .cindex "string" "list, definition of"
5198 The data for some configuration options is a list of items, with colon as the
5199 default separator. Many of these options are shown with type &"string list"& in
5200 the descriptions later in this document. Others are listed as &"domain list"&,
5201 &"host list"&, &"address list"&, or &"local part list"&. Syntactically, they
5202 are all the same; however, those other than &"string list"& are subject to
5203 particular kinds of interpretation, as described in chapter
5204 &<<CHAPdomhosaddlists>>&.
5205
5206 In all these cases, the entire list is treated as a single string as far as the
5207 input syntax is concerned. The &%trusted_users%& setting in section
5208 &<<SECTstrings>>& above is an example. If a colon is actually needed in an item
5209 in a list, it must be entered as two colons. Leading and trailing white space
5210 on each item in a list is ignored. This makes it possible to include items that
5211 start with a colon, and in particular, certain forms of IPv6 address. For
5212 example, the list
5213 .code
5214 local_interfaces = 127.0.0.1 : ::::1
5215 .endd
5216 contains two IP addresses, the IPv4 address 127.0.0.1 and the IPv6 address ::1.
5217
5218 &*Note*&: Although leading and trailing white space is ignored in individual
5219 list items, it is not ignored when parsing the list. The space after the first
5220 colon in the example above is necessary. If it were not there, the list would
5221 be interpreted as the two items 127.0.0.1:: and 1.
5222
5223 .section "Changing list separators" "SECID53"
5224 .cindex "list separator" "changing"
5225 .cindex "IPv6" "addresses in lists"
5226 Doubling colons in IPv6 addresses is an unwelcome chore, so a mechanism was
5227 introduced to allow the separator character to be changed. If a list begins
5228 with a left angle bracket, followed by any punctuation character, that
5229 character is used instead of colon as the list separator. For example, the list
5230 above can be rewritten to use a semicolon separator like this:
5231 .code
5232 local_interfaces = <; 127.0.0.1 ; ::1
5233 .endd
5234 This facility applies to all lists, with the exception of the list in
5235 &%log_file_path%&. It is recommended that the use of non-colon separators be
5236 confined to circumstances where they really are needed.
5237
5238 .cindex "list separator" "newline as"
5239 .cindex "newline" "as list separator"
5240 It is also possible to use newline and other control characters (those with
5241 code values less than 32, plus DEL) as separators in lists. Such separators
5242 must be provided literally at the time the list is processed. For options that
5243 are string-expanded, you can write the separator using a normal escape
5244 sequence. This will be processed by the expander before the string is
5245 interpreted as a list. For example, if a newline-separated list of domains is
5246 generated by a lookup, you can process it directly by a line such as this:
5247 .code
5248 domains = <\n ${lookup mysql{.....}}
5249 .endd
5250 This avoids having to change the list separator in such data. You are unlikely
5251 to want to use a control character as a separator in an option that is not
5252 expanded, because the value is literal text. However, it can be done by giving
5253 the value in quotes. For example:
5254 .code
5255 local_interfaces = "<\n 127.0.0.1 \n ::1"
5256 .endd
5257 Unlike printing character separators, which can be included in list items by
5258 doubling, it is not possible to include a control character as data when it is
5259 set as the separator. Two such characters in succession are interpreted as
5260 enclosing an empty list item.
5261
5262
5263
5264 .section "Empty items in lists" "SECTempitelis"
5265 .cindex "list" "empty item in"
5266 An empty item at the end of a list is always ignored. In other words, trailing
5267 separator characters are ignored. Thus, the list in
5268 .code
5269 senders = user@domain :
5270 .endd
5271 contains only a single item. If you want to include an empty string as one item
5272 in a list, it must not be the last item. For example, this list contains three
5273 items, the second of which is empty:
5274 .code
5275 senders = user1@domain : : user2@domain
5276 .endd
5277 &*Note*&: There must be white space between the two colons, as otherwise they
5278 are interpreted as representing a single colon data character (and the list
5279 would then contain just one item). If you want to specify a list that contains
5280 just one, empty item, you can do it as in this example:
5281 .code
5282 senders = :
5283 .endd
5284 In this case, the first item is empty, and the second is discarded because it
5285 is at the end of the list.
5286
5287
5288
5289
5290 .section "Format of driver configurations" "SECTfordricon"
5291 .cindex "drivers" "configuration format"
5292 There are separate parts in the configuration for defining routers, transports,
5293 and authenticators. In each part, you are defining a number of driver
5294 instances, each with its own set of options. Each driver instance is defined by
5295 a sequence of lines like this:
5296 .display
5297 <&'instance name'&>:
5298   <&'option'&>
5299   ...
5300   <&'option'&>
5301 .endd
5302 In the following example, the instance name is &(localuser)&, and it is
5303 followed by three options settings:
5304 .code
5305 localuser:
5306   driver = accept
5307   check_local_user
5308   transport = local_delivery
5309 .endd
5310 For each driver instance, you specify which Exim code module it uses &-- by the
5311 setting of the &%driver%& option &-- and (optionally) some configuration
5312 settings. For example, in the case of transports, if you want a transport to
5313 deliver with SMTP you would use the &(smtp)& driver; if you want to deliver to
5314 a local file you would use the &(appendfile)& driver. Each of the drivers is
5315 described in detail in its own separate chapter later in this manual.
5316
5317 You can have several routers, transports, or authenticators that are based on
5318 the same underlying driver (each must have a different instance name).
5319
5320 The order in which routers are defined is important, because addresses are
5321 passed to individual routers one by one, in order. The order in which
5322 transports are defined does not matter at all. The order in which
5323 authenticators are defined is used only when Exim, as a client, is searching
5324 them to find one that matches an authentication mechanism offered by the
5325 server.
5326
5327 .cindex "generic options"
5328 .cindex "options" "generic &-- definition of"
5329 Within a driver instance definition, there are two kinds of option: &'generic'&
5330 and &'private'&. The generic options are those that apply to all drivers of the
5331 same type (that is, all routers, all transports or all authenticators). The
5332 &%driver%& option is a generic option that must appear in every definition.
5333 .cindex "private options"
5334 The private options are special for each driver, and none need appear, because
5335 they all have default values.
5336
5337 The options may appear in any order, except that the &%driver%& option must
5338 precede any private options, since these depend on the particular driver. For
5339 this reason, it is recommended that &%driver%& always be the first option.
5340
5341 Driver instance names, which are used for reference in log entries and
5342 elsewhere, can be any sequence of letters, digits, and underscores (starting
5343 with a letter) and must be unique among drivers of the same type. A router and
5344 a transport (for example) can each have the same name, but no two router
5345 instances can have the same name. The name of a driver instance should not be
5346 confused with the name of the underlying driver module. For example, the
5347 configuration lines:
5348 .code
5349 remote_smtp:
5350   driver = smtp
5351 .endd
5352 create an instance of the &(smtp)& transport driver whose name is
5353 &(remote_smtp)&. The same driver code can be used more than once, with
5354 different instance names and different option settings each time. A second
5355 instance of the &(smtp)& transport, with different options, might be defined
5356 thus:
5357 .code
5358 special_smtp:
5359   driver = smtp
5360   port = 1234
5361   command_timeout = 10s
5362 .endd
5363 The names &(remote_smtp)& and &(special_smtp)& would be used to reference
5364 these transport instances from routers, and these names would appear in log
5365 lines.
5366
5367 Comment lines may be present in the middle of driver specifications. The full
5368 list of option settings for any particular driver instance, including all the
5369 defaulted values, can be extracted by making use of the &%-bP%& command line
5370 option.
5371
5372
5373
5374
5375
5376
5377 . ////////////////////////////////////////////////////////////////////////////
5378 . ////////////////////////////////////////////////////////////////////////////
5379
5380 .chapter "The default configuration file" "CHAPdefconfil"
5381 .scindex IIDconfiwal "configuration file" "default &""walk through""&"
5382 .cindex "default" "configuration file &""walk through""&"
5383 The default configuration file supplied with Exim as &_src/configure.default_&
5384 is sufficient for a host with simple mail requirements. As an introduction to
5385 the way Exim is configured, this chapter &"walks through"& the default
5386 configuration, giving brief explanations of the settings. Detailed descriptions
5387 of the options are given in subsequent chapters. The default configuration file
5388 itself contains extensive comments about ways you might want to modify the
5389 initial settings. However, note that there are many options that are not
5390 mentioned at all in the default configuration.
5391
5392
5393
5394 .section "Main configuration settings" "SECTdefconfmain"
5395 The main (global) configuration option settings must always come first in the
5396 file. The first thing you'll see in the file, after some initial comments, is
5397 the line
5398 .code
5399 # primary_hostname =
5400 .endd
5401 This is a commented-out setting of the &%primary_hostname%& option. Exim needs
5402 to know the official, fully qualified name of your host, and this is where you
5403 can specify it. However, in most cases you do not need to set this option. When
5404 it is unset, Exim uses the &[uname()]& system function to obtain the host name.
5405
5406 The first three non-comment configuration lines are as follows:
5407 .code
5408 domainlist local_domains    = @
5409 domainlist relay_to_domains =
5410 hostlist   relay_from_hosts = 127.0.0.1
5411 .endd
5412 These are not, in fact, option settings. They are definitions of two named
5413 domain lists and one named host list. Exim allows you to give names to lists of
5414 domains, hosts, and email addresses, in order to make it easier to manage the
5415 configuration file (see section &<<SECTnamedlists>>&).
5416
5417 The first line defines a domain list called &'local_domains'&; this is used
5418 later in the configuration to identify domains that are to be delivered
5419 on the local host.
5420
5421 .cindex "@ in a domain list"
5422 There is just one item in this list, the string &"@"&. This is a special form
5423 of entry which means &"the name of the local host"&. Thus, if the local host is
5424 called &'a.host.example'&, mail to &'any.user@a.host.example'& is expected to
5425 be delivered locally. Because the local host's name is referenced indirectly,
5426 the same configuration file can be used on different hosts.
5427
5428 The second line defines a domain list called &'relay_to_domains'&, but the
5429 list itself is empty. Later in the configuration we will come to the part that
5430 controls mail relaying through the local host; it allows relaying to any
5431 domains in this list. By default, therefore, no relaying on the basis of a mail
5432 domain is permitted.
5433
5434 The third line defines a host list called &'relay_from_hosts'&. This list is
5435 used later in the configuration to permit relaying from any host or IP address
5436 that matches the list. The default contains just the IP address of the IPv4
5437 loopback interface, which means that processes on the local host are able to
5438 submit mail for relaying by sending it over TCP/IP to that interface. No other
5439 hosts are permitted to submit messages for relaying.
5440
5441 Just to be sure there's no misunderstanding: at this point in the configuration
5442 we aren't actually setting up any controls. We are just defining some domains
5443 and hosts that will be used in the controls that are specified later.
5444
5445 The next two configuration lines are genuine option settings:
5446 .code
5447 acl_smtp_rcpt = acl_check_rcpt
5448 acl_smtp_data = acl_check_data
5449 .endd
5450 These options specify &'Access Control Lists'& (ACLs) that are to be used
5451 during an incoming SMTP session for every recipient of a message (every RCPT
5452 command), and after the contents of the message have been received,
5453 respectively. The names of the lists are &'acl_check_rcpt'& and
5454 &'acl_check_data'&, and we will come to their definitions below, in the ACL
5455 section of the configuration. The RCPT ACL controls which recipients are
5456 accepted for an incoming message &-- if a configuration does not provide an ACL
5457 to check recipients, no SMTP mail can be accepted. The DATA ACL allows the
5458 contents of a message to be checked.
5459
5460 Two commented-out option settings are next:
5461 .code
5462 # av_scanner = clamd:/tmp/clamd
5463 # spamd_address = 127.0.0.1 783
5464 .endd
5465 These are example settings that can be used when Exim is compiled with the
5466 content-scanning extension. The first specifies the interface to the virus
5467 scanner, and the second specifies the interface to SpamAssassin. Further
5468 details are given in chapter &<<CHAPexiscan>>&.
5469
5470 Three more commented-out option settings follow:
5471 .code
5472 # tls_advertise_hosts = *
5473 # tls_certificate = /etc/ssl/exim.crt
5474 # tls_privatekey = /etc/ssl/exim.pem
5475 .endd
5476 These are example settings that can be used when Exim is compiled with
5477 support for TLS (aka SSL) as described in section &<<SECTinctlsssl>>&. The
5478 first one specifies the list of clients that are allowed to use TLS when
5479 connecting to this server; in this case the wildcard means all clients. The
5480 other options specify where Exim should find its TLS certificate and private
5481 key, which together prove the server's identity to any clients that connect.
5482 More details are given in chapter &<<CHAPTLS>>&.
5483
5484 Another two commented-out option settings follow:
5485 .code
5486 # daemon_smtp_ports = 25 : 465 : 587
5487 # tls_on_connect_ports = 465
5488 .endd
5489 .cindex "port" "465 and 587"
5490 .cindex "port" "for message submission"
5491 .cindex "message" "submission, ports for"
5492 .cindex "ssmtp protocol"
5493 .cindex "smtps protocol"
5494 .cindex "SMTP" "ssmtp protocol"
5495 .cindex "SMTP" "smtps protocol"
5496 These options provide better support for roaming users who wish to use this
5497 server for message submission. They are not much use unless you have turned on
5498 TLS (as described in the previous paragraph) and authentication (about which
5499 more in section &<<SECTdefconfauth>>&). The usual SMTP port 25 is often blocked
5500 on end-user networks, so RFC 4409 specifies that message submission should use
5501 port 587 instead. However some software (notably Microsoft Outlook) cannot be
5502 configured to use port 587 correctly, so these settings also enable the
5503 non-standard &"smtps"& (aka &"ssmtp"&) port 465 (see section
5504 &<<SECTsupobssmt>>&).
5505
5506 Two more commented-out options settings follow:
5507 .code
5508 # qualify_domain =
5509 # qualify_recipient =
5510 .endd
5511 The first of these specifies a domain that Exim uses when it constructs a
5512 complete email address from a local login name. This is often needed when Exim
5513 receives a message from a local process. If you do not set &%qualify_domain%&,
5514 the value of &%primary_hostname%& is used. If you set both of these options,
5515 you can have different qualification domains for sender and recipient
5516 addresses. If you set only the first one, its value is used in both cases.
5517
5518 .cindex "domain literal" "recognizing format"
5519 The following line must be uncommented if you want Exim to recognize
5520 addresses of the form &'user@[10.11.12.13]'& that is, with a &"domain literal"&
5521 (an IP address within square brackets) instead of a named domain.
5522 .code
5523 # allow_domain_literals
5524 .endd
5525 The RFCs still require this form, but many people think that in the modern
5526 Internet it makes little sense to permit mail to be sent to specific hosts by
5527 quoting their IP addresses. This ancient format has been used by people who
5528 try to abuse hosts by using them for unwanted relaying. However, some
5529 people believe there are circumstances (for example, messages addressed to
5530 &'postmaster'&) where domain literals are still useful.
5531
5532 The next configuration line is a kind of trigger guard:
5533 .code
5534 never_users = root
5535 .endd
5536 It specifies that no delivery must ever be run as the root user. The normal
5537 convention is to set up &'root'& as an alias for the system administrator. This
5538 setting is a guard against slips in the configuration.
5539 The list of users specified by &%never_users%& is not, however, the complete
5540 list; the build-time configuration in &_Local/Makefile_& has an option called
5541 FIXED_NEVER_USERS specifying a list that cannot be overridden. The
5542 contents of &%never_users%& are added to this list. By default
5543 FIXED_NEVER_USERS also specifies root.
5544
5545 When a remote host connects to Exim in order to send mail, the only information
5546 Exim has about the host's identity is its IP address. The next configuration
5547 line,
5548 .code
5549 host_lookup = *
5550 .endd
5551 specifies that Exim should do a reverse DNS lookup on all incoming connections,
5552 in order to get a host name. This improves the quality of the logging
5553 information, but if you feel it is too expensive, you can remove it entirely,
5554 or restrict the lookup to hosts on &"nearby"& networks.
5555 Note that it is not always possible to find a host name from an IP address,
5556 because not all DNS reverse zones are maintained, and sometimes DNS servers are
5557 unreachable.
5558
5559 The next two lines are concerned with &'ident'& callbacks, as defined by RFC
5560 1413 (hence their names):
5561 .code
5562 rfc1413_hosts = *
5563 rfc1413_query_timeout = 5s
5564 .endd
5565 These settings cause Exim to make ident callbacks for all incoming SMTP calls.
5566 You can limit the hosts to which these calls are made, or change the timeout
5567 that is used. If you set the timeout to zero, all ident calls are disabled.
5568 Although they are cheap and can provide useful information for tracing problem
5569 messages, some hosts and firewalls have problems with ident calls. This can
5570 result in a timeout instead of an immediate refused connection, leading to
5571 delays on starting up an incoming SMTP session.
5572
5573 When Exim receives messages over SMTP connections, it expects all addresses to
5574 be fully qualified with a domain, as required by the SMTP definition. However,
5575 if you are running a server to which simple clients submit messages, you may
5576 find that they send unqualified addresses. The two commented-out options:
5577 .code
5578 # sender_unqualified_hosts =
5579 # recipient_unqualified_hosts =
5580 .endd
5581 show how you can specify hosts that are permitted to send unqualified sender
5582 and recipient addresses, respectively.
5583
5584 The &%percent_hack_domains%& option is also commented out:
5585 .code
5586 # percent_hack_domains =
5587 .endd
5588 It provides a list of domains for which the &"percent hack"& is to operate.
5589 This is an almost obsolete form of explicit email routing. If you do not know
5590 anything about it, you can safely ignore this topic.
5591
5592 The last two settings in the main part of the default configuration are
5593 concerned with messages that have been &"frozen"& on Exim's queue. When a
5594 message is frozen, Exim no longer continues to try to deliver it. Freezing
5595 occurs when a bounce message encounters a permanent failure because the sender
5596 address of the original message that caused the bounce is invalid, so the
5597 bounce cannot be delivered. This is probably the most common case, but there
5598 are also other conditions that cause freezing, and frozen messages are not
5599 always bounce messages.
5600 .code
5601 ignore_bounce_errors_after = 2d
5602 timeout_frozen_after = 7d
5603 .endd
5604 The first of these options specifies that failing bounce messages are to be
5605 discarded after 2 days on the queue. The second specifies that any frozen
5606 message (whether a bounce message or not) is to be timed out (and discarded)
5607 after a week. In this configuration, the first setting ensures that no failing
5608 bounce message ever lasts a week.
5609
5610
5611
5612 .section "ACL configuration" "SECID54"
5613 .cindex "default" "ACLs"
5614 .cindex "&ACL;" "default configuration"
5615 In the default configuration, the ACL section follows the main configuration.
5616 It starts with the line
5617 .code
5618 begin acl
5619 .endd
5620 and it contains the definitions of two ACLs, called &'acl_check_rcpt'& and
5621 &'acl_check_data'&, that were referenced in the settings of &%acl_smtp_rcpt%&
5622 and &%acl_smtp_data%& above.
5623
5624 .cindex "RCPT" "ACL for"
5625 The first ACL is used for every RCPT command in an incoming SMTP message. Each
5626 RCPT command specifies one of the message's recipients. The ACL statements
5627 are considered in order, until the recipient address is either accepted or
5628 rejected. The RCPT command is then accepted or rejected, according to the
5629 result of the ACL processing.
5630 .code
5631 acl_check_rcpt:
5632 .endd
5633 This line, consisting of a name terminated by a colon, marks the start of the
5634 ACL, and names it.
5635 .code
5636 accept  hosts = :
5637 .endd
5638 This ACL statement accepts the recipient if the sending host matches the list.
5639 But what does that strange list mean? It doesn't actually contain any host
5640 names or IP addresses. The presence of the colon puts an empty item in the
5641 list; Exim matches this only if the incoming message did not come from a remote
5642 host, because in that case, the remote hostname is empty. The colon is
5643 important. Without it, the list itself is empty, and can never match anything.
5644
5645 What this statement is doing is to accept unconditionally all recipients in
5646 messages that are submitted by SMTP from local processes using the standard
5647 input and output (that is, not using TCP/IP). A number of MUAs operate in this
5648 manner.
5649 .code
5650 deny    message       = Restricted characters in address
5651         domains       = +local_domains
5652         local_parts   = ^[.] : ^.*[@%!/|]
5653
5654 deny    message       = Restricted characters in address
5655         domains       = !+local_domains
5656         local_parts   = ^[./|] : ^.*[@%!] : ^.*/\\.\\./
5657 .endd
5658 These statements are concerned with local parts that contain any of the
5659 characters &"@"&, &"%"&, &"!"&, &"/"&, &"|"&, or dots in unusual places.
5660 Although these characters are entirely legal in local parts (in the case of
5661 &"@"& and leading dots, only if correctly quoted), they do not commonly occur
5662 in Internet mail addresses.
5663
5664 The first three have in the past been associated with explicitly routed
5665 addresses (percent is still sometimes used &-- see the &%percent_hack_domains%&
5666 option). Addresses containing these characters are regularly tried by spammers
5667 in an attempt to bypass relaying restrictions, and also by open relay testing
5668 programs. Unless you really need them it is safest to reject these characters
5669 at this early stage. This configuration is heavy-handed in rejecting these
5670 characters for all messages it accepts from remote hosts. This is a deliberate
5671 policy of being as safe as possible.
5672
5673 The first rule above is stricter, and is applied to messages that are addressed
5674 to one of the local domains handled by this host. This is implemented by the
5675 first condition, which restricts it to domains that are listed in the
5676 &'local_domains'& domain list. The &"+"& character is used to indicate a
5677 reference to a named list. In this configuration, there is just one domain in
5678 &'local_domains'&, but in general there may be many.
5679
5680 The second condition on the first statement uses two regular expressions to
5681 block local parts that begin with a dot or contain &"@"&, &"%"&, &"!"&, &"/"&,
5682 or &"|"&. If you have local accounts that include these characters, you will
5683 have to modify this rule.
5684
5685 Empty components (two dots in a row) are not valid in RFC 2822, but Exim
5686 allows them because they have been encountered in practice. (Consider the
5687 common convention of local parts constructed as
5688 &"&'first-initial.second-initial.family-name'&"& when applied to someone like
5689 the author of Exim, who has no second initial.) However, a local part starting
5690 with a dot or containing &"/../"& can cause trouble if it is used as part of a
5691 file name (for example, for a mailing list). This is also true for local parts
5692 that contain slashes. A pipe symbol can also be troublesome if the local part
5693 is incorporated unthinkingly into a shell command line.
5694
5695 The second rule above applies to all other domains, and is less strict. This
5696 allows your own users to send outgoing messages to sites that use slashes
5697 and vertical bars in their local parts. It blocks local parts that begin
5698 with a dot, slash, or vertical bar, but allows these characters within the
5699 local part. However, the sequence &"/../"& is barred. The use of &"@"&, &"%"&,
5700 and &"!"& is blocked, as before. The motivation here is to prevent your users
5701 (or your users' viruses) from mounting certain kinds of attack on remote sites.
5702 .code
5703 accept  local_parts   = postmaster
5704         domains       = +local_domains
5705 .endd
5706 This statement, which has two conditions, accepts an incoming address if the
5707 local part is &'postmaster'& and the domain is one of those listed in the
5708 &'local_domains'& domain list. The &"+"& character is used to indicate a
5709 reference to a named list. In this configuration, there is just one domain in
5710 &'local_domains'&, but in general there may be many.
5711
5712 The presence of this statement means that mail to postmaster is never blocked
5713 by any of the subsequent tests. This can be helpful while sorting out problems
5714 in cases where the subsequent tests are incorrectly denying access.
5715 .code
5716 require verify        = sender
5717 .endd
5718 This statement requires the sender address to be verified before any subsequent
5719 ACL statement can be used. If verification fails, the incoming recipient
5720 address is refused. Verification consists of trying to route the address, to
5721 see if a bounce message could be delivered to it. In the case of remote
5722 addresses, basic verification checks only the domain, but &'callouts'& can be
5723 used for more verification if required. Section &<<SECTaddressverification>>&
5724 discusses the details of address verification.
5725 .code
5726 accept  hosts         = +relay_from_hosts
5727         control       = submission
5728 .endd
5729 This statement accepts the address if the message is coming from one of the
5730 hosts that are defined as being allowed to relay through this host. Recipient
5731 verification is omitted here, because in many cases the clients are dumb MUAs
5732 that do not cope well with SMTP error responses. For the same reason, the
5733 second line specifies &"submission mode"& for messages that are accepted. This
5734 is described in detail in section &<<SECTsubmodnon>>&; it causes Exim to fix
5735 messages that are deficient in some way, for example, because they lack a
5736 &'Date:'& header line. If you are actually relaying out from MTAs, you should
5737 probably add recipient verification here, and disable submission mode.
5738 .code
5739 accept  authenticated = *
5740         control       = submission
5741 .endd
5742 This statement accepts the address if the client host has authenticated itself.
5743 Submission mode is again specified, on the grounds that such messages are most
5744 likely to come from MUAs. The default configuration does not define any
5745 authenticators, though it does include some nearly complete commented-out
5746 examples described in &<<SECTdefconfauth>>&. This means that no client can in
5747 fact authenticate until you complete the authenticator definitions.
5748 .code
5749 require message = relay not permitted
5750         domains = +local_domains : +relay_to_domains
5751 .endd
5752 This statement rejects the address if its domain is neither a local domain nor
5753 one of the domains for which this host is a relay.
5754 .code
5755 require verify = recipient
5756 .endd
5757 This statement requires the recipient address to be verified; if verification
5758 fails, the address is rejected.
5759 .code
5760 # deny    message     = rejected because $sender_host_address \
5761 #                       is in a black list at $dnslist_domain\n\
5762 #                       $dnslist_text
5763 #         dnslists    = black.list.example
5764 #
5765 # warn    dnslists    = black.list.example
5766 #         add_header  = X-Warning: $sender_host_address is in \
5767 #                       a black list at $dnslist_domain
5768 #         log_message = found in $dnslist_domain
5769 .endd
5770 These commented-out lines are examples of how you could configure Exim to check
5771 sending hosts against a DNS black list. The first statement rejects messages
5772 from blacklisted hosts, whereas the second just inserts a warning header
5773 line.
5774 .code
5775 # require verify = csa
5776 .endd
5777 This commented-out line is an example of how you could turn on client SMTP
5778 authorization (CSA) checking. Such checks do DNS lookups for special SRV
5779 records.
5780 .code
5781 accept
5782 .endd
5783 The final statement in the first ACL unconditionally accepts any recipient
5784 address that has successfully passed all the previous tests.
5785 .code
5786 acl_check_data:
5787 .endd
5788 This line marks the start of the second ACL, and names it. Most of the contents
5789 of this ACL are commented out:
5790 .code
5791 # deny    malware   = *
5792 #         message   = This message contains a virus \
5793 #                     ($malware_name).
5794 .endd
5795 These lines are examples of how to arrange for messages to be scanned for
5796 viruses when Exim has been compiled with the content-scanning extension, and a
5797 suitable virus scanner is installed. If the message is found to contain a
5798 virus, it is rejected with the given custom error message.
5799 .code
5800 # warn    spam      = nobody
5801 #         message   = X-Spam_score: $spam_score\n\
5802 #                     X-Spam_score_int: $spam_score_int\n\
5803 #                     X-Spam_bar: $spam_bar\n\
5804 #                     X-Spam_report: $spam_report
5805 .endd
5806 These lines are an example of how to arrange for messages to be scanned by
5807 SpamAssassin when Exim has been compiled with the content-scanning extension,
5808 and SpamAssassin has been installed. The SpamAssassin check is run with
5809 &`nobody`& as its user parameter, and the results are added to the message as a
5810 series of extra header line. In this case, the message is not rejected,
5811 whatever the spam score.
5812 .code
5813 accept
5814 .endd
5815 This final line in the DATA ACL accepts the message unconditionally.
5816
5817
5818 .section "Router configuration" "SECID55"
5819 .cindex "default" "routers"
5820 .cindex "routers" "default"
5821 The router configuration comes next in the default configuration, introduced
5822 by the line
5823 .code
5824 begin routers
5825 .endd
5826 Routers are the modules in Exim that make decisions about where to send
5827 messages. An address is passed to each router in turn, until it is either
5828 accepted, or failed. This means that the order in which you define the routers
5829 matters. Each router is fully described in its own chapter later in this
5830 manual. Here we give only brief overviews.
5831 .code
5832 # domain_literal:
5833 #   driver = ipliteral
5834 #   domains = !+local_domains
5835 #   transport = remote_smtp
5836 .endd
5837 .cindex "domain literal" "default router"
5838 This router is commented out because the majority of sites do not want to
5839 support domain literal addresses (those of the form &'user@[10.9.8.7]'&). If
5840 you uncomment this router, you also need to uncomment the setting of
5841 &%allow_domain_literals%& in the main part of the configuration.
5842 .code
5843 dnslookup:
5844   driver = dnslookup
5845   domains = ! +local_domains
5846   transport = remote_smtp
5847   ignore_target_hosts = 0.0.0.0 : 127.0.0.0/8
5848   no_more
5849 .endd
5850 The first uncommented router handles addresses that do not involve any local
5851 domains. This is specified by the line
5852 .code
5853 domains = ! +local_domains
5854 .endd
5855 The &%domains%& option lists the domains to which this router applies, but the
5856 exclamation mark is a negation sign, so the router is used only for domains
5857 that are not in the domain list called &'local_domains'& (which was defined at
5858 the start of the configuration). The plus sign before &'local_domains'&
5859 indicates that it is referring to a named list. Addresses in other domains are
5860 passed on to the following routers.
5861
5862 The name of the router driver is &(dnslookup)&,
5863 and is specified by the &%driver%& option. Do not be confused by the fact that
5864 the name of this router instance is the same as the name of the driver. The
5865 instance name is arbitrary, but the name set in the &%driver%& option must be
5866 one of the driver modules that is in the Exim binary.
5867
5868 The &(dnslookup)& router routes addresses by looking up their domains in the
5869 DNS in order to obtain a list of hosts to which the address is routed. If the
5870 router succeeds, the address is queued for the &(remote_smtp)& transport, as
5871 specified by the &%transport%& option. If the router does not find the domain
5872 in the DNS, no further routers are tried because of the &%no_more%& setting, so
5873 the address fails and is bounced.
5874
5875 The &%ignore_target_hosts%& option specifies a list of IP addresses that are to
5876 be entirely ignored. This option is present because a number of cases have been
5877 encountered where MX records in the DNS point to host names
5878 whose IP addresses are 0.0.0.0 or are in the 127 subnet (typically 127.0.0.1).
5879 Completely ignoring these IP addresses causes Exim to fail to route the
5880 email address, so it bounces. Otherwise, Exim would log a routing problem, and
5881 continue to try to deliver the message periodically until the address timed
5882 out.
5883 .code
5884 system_aliases:
5885   driver = redirect
5886   allow_fail
5887   allow_defer
5888   data = ${lookup{$local_part}lsearch{/etc/aliases}}
5889 # user = exim
5890   file_transport = address_file
5891   pipe_transport = address_pipe
5892 .endd
5893 Control reaches this and subsequent routers only for addresses in the local
5894 domains. This router checks to see whether the local part is defined as an
5895 alias in the &_/etc/aliases_& file, and if so, redirects it according to the
5896 data that it looks up from that file. If no data is found for the local part,
5897 the value of the &%data%& option is empty, causing the address to be passed to
5898 the next router.
5899
5900 &_/etc/aliases_& is a conventional name for the system aliases file that is
5901 often used. That is why it is referenced by from the default configuration
5902 file. However, you can change this by setting SYSTEM_ALIASES_FILE in
5903 &_Local/Makefile_& before building Exim.
5904 .code
5905 userforward:
5906   driver = redirect
5907   check_local_user
5908 # local_part_suffix = +* : -*
5909 # local_part_suffix_optional
5910   file = $home/.forward
5911 # allow_filter
5912   no_verify
5913   no_expn
5914   check_ancestor
5915   file_transport = address_file
5916   pipe_transport = address_pipe
5917   reply_transport = address_reply
5918 .endd
5919 This is the most complicated router in the default configuration. It is another
5920 redirection router, but this time it is looking for forwarding data set up by
5921 individual users. The &%check_local_user%& setting specifies a check that the
5922 local part of the address is the login name of a local user. If it is not, the
5923 router is skipped. The two commented options that follow &%check_local_user%&,
5924 namely:
5925 .code
5926 # local_part_suffix = +* : -*
5927 # local_part_suffix_optional
5928 .endd
5929 .vindex "&$local_part_suffix$&"
5930 show how you can specify the recognition of local part suffixes. If the first
5931 is uncommented, a suffix beginning with either a plus or a minus sign, followed
5932 by any sequence of characters, is removed from the local part and placed in the
5933 variable &$local_part_suffix$&. The second suffix option specifies that the
5934 presence of a suffix in the local part is optional. When a suffix is present,
5935 the check for a local login uses the local part with the suffix removed.
5936
5937 When a local user account is found, the file called &_.forward_& in the user's
5938 home directory is consulted. If it does not exist, or is empty, the router
5939 declines. Otherwise, the contents of &_.forward_& are interpreted as
5940 redirection data (see chapter &<<CHAPredirect>>& for more details).
5941
5942 .cindex "Sieve filter" "enabling in default router"
5943 Traditional &_.forward_& files contain just a list of addresses, pipes, or
5944 files. Exim supports this by default. However, if &%allow_filter%& is set (it
5945 is commented out by default), the contents of the file are interpreted as a set
5946 of Exim or Sieve filtering instructions, provided the file begins with &"#Exim
5947 filter"& or &"#Sieve filter"&, respectively. User filtering is discussed in the
5948 separate document entitled &'Exim's interfaces to mail filtering'&.
5949
5950 The &%no_verify%& and &%no_expn%& options mean that this router is skipped when
5951 verifying addresses, or when running as a consequence of an SMTP EXPN command.
5952 There are two reasons for doing this:
5953
5954 .olist
5955 Whether or not a local user has a &_.forward_& file is not really relevant when
5956 checking an address for validity; it makes sense not to waste resources doing
5957 unnecessary work.
5958 .next
5959 More importantly, when Exim is verifying addresses or handling an EXPN
5960 command during an SMTP session, it is running as the Exim user, not as root.
5961 The group is the Exim group, and no additional groups are set up.
5962 It may therefore not be possible for Exim to read users' &_.forward_& files at
5963 this time.
5964 .endlist
5965
5966 The setting of &%check_ancestor%& prevents the router from generating a new
5967 address that is the same as any previous address that was redirected. (This
5968 works round a problem concerning a bad interaction between aliasing and
5969 forwarding &-- see section &<<SECTredlocmai>>&).
5970
5971 The final three option settings specify the transports that are to be used when
5972 forwarding generates a direct delivery to a file, or to a pipe, or sets up an
5973 auto-reply, respectively. For example, if a &_.forward_& file contains
5974 .code
5975 a.nother@elsewhere.example, /home/spqr/archive
5976 .endd
5977 the delivery to &_/home/spqr/archive_& is done by running the &%address_file%&
5978 transport.
5979 .code
5980 localuser:
5981   driver = accept
5982   check_local_user
5983 # local_part_suffix = +* : -*
5984 # local_part_suffix_optional
5985   transport = local_delivery
5986 .endd
5987 The final router sets up delivery into local mailboxes, provided that the local
5988 part is the name of a local login, by accepting the address and assigning it to
5989 the &(local_delivery)& transport. Otherwise, we have reached the end of the
5990 routers, so the address is bounced. The commented suffix settings fulfil the
5991 same purpose as they do for the &(userforward)& router.
5992
5993
5994 .section "Transport configuration" "SECID56"
5995 .cindex "default" "transports"
5996 .cindex "transports" "default"
5997 Transports define mechanisms for actually delivering messages. They operate
5998 only when referenced from routers, so the order in which they are defined does
5999 not matter. The transports section of the configuration starts with
6000 .code
6001 begin transports
6002 .endd
6003 One remote transport and four local transports are defined.
6004 .code
6005 remote_smtp:
6006   driver = smtp
6007 .endd
6008 This transport is used for delivering messages over SMTP connections. All its
6009 options are defaulted. The list of remote hosts comes from the router.
6010 .code
6011 local_delivery:
6012   driver = appendfile
6013   file = /var/mail/$local_part
6014   delivery_date_add
6015   envelope_to_add
6016   return_path_add
6017 # group = mail
6018 # mode = 0660
6019 .endd
6020 This &(appendfile)& transport is used for local delivery to user mailboxes in
6021 traditional BSD mailbox format. By default it runs under the uid and gid of the
6022 local user, which requires the sticky bit to be set on the &_/var/mail_&
6023 directory. Some systems use the alternative approach of running mail deliveries
6024 under a particular group instead of using the sticky bit. The commented options
6025 show how this can be done.
6026
6027 Exim adds three headers to the message as it delivers it: &'Delivery-date:'&,
6028 &'Envelope-to:'& and &'Return-path:'&. This action is requested by the three
6029 similarly-named options above.
6030 .code
6031 address_pipe:
6032   driver = pipe
6033   return_output
6034 .endd
6035 This transport is used for handling deliveries to pipes that are generated by
6036 redirection (aliasing or users' &_.forward_& files). The &%return_output%&
6037 option specifies that any output generated by the pipe is to be returned to the
6038 sender.
6039 .code
6040 address_file:
6041   driver = appendfile
6042   delivery_date_add
6043   envelope_to_add
6044   return_path_add
6045 .endd
6046 This transport is used for handling deliveries to files that are generated by
6047 redirection. The name of the file is not specified in this instance of
6048 &(appendfile)&, because it comes from the &(redirect)& router.
6049 .code
6050 address_reply:
6051   driver = autoreply
6052 .endd
6053 This transport is used for handling automatic replies generated by users'
6054 filter files.
6055
6056
6057
6058 .section "Default retry rule" "SECID57"
6059 .cindex "retry" "default rule"
6060 .cindex "default" "retry rule"
6061 The retry section of the configuration file contains rules which affect the way
6062 Exim retries deliveries that cannot be completed at the first attempt. It is
6063 introduced by the line
6064 .code
6065 begin retry
6066 .endd
6067 In the default configuration, there is just one rule, which applies to all
6068 errors:
6069 .code
6070 *   *   F,2h,15m; G,16h,1h,1.5; F,4d,6h
6071 .endd
6072 This causes any temporarily failing address to be retried every 15 minutes for
6073 2 hours, then at intervals starting at one hour and increasing by a factor of
6074 1.5 until 16 hours have passed, then every 6 hours up to 4 days. If an address
6075 is not delivered after 4 days of temporary failure, it is bounced.
6076
6077 If the retry section is removed from the configuration, or is empty (that is,
6078 if no retry rules are defined), Exim will not retry deliveries. This turns
6079 temporary errors into permanent errors.
6080
6081
6082 .section "Rewriting configuration" "SECID58"
6083 The rewriting section of the configuration, introduced by
6084 .code
6085 begin rewrite
6086 .endd
6087 contains rules for rewriting addresses in messages as they arrive. There are no
6088 rewriting rules in the default configuration file.
6089
6090
6091
6092 .section "Authenticators configuration" "SECTdefconfauth"
6093 .cindex "AUTH" "configuration"
6094 The authenticators section of the configuration, introduced by
6095 .code
6096 begin authenticators
6097 .endd
6098 defines mechanisms for the use of the SMTP AUTH command. The default
6099 configuration file contains two commented-out example authenticators
6100 which support plaintext username/password authentication using the
6101 standard PLAIN mechanism and the traditional but non-standard LOGIN
6102 mechanism, with Exim acting as the server. PLAIN and LOGIN are enough
6103 to support most MUA software.
6104
6105 The example PLAIN authenticator looks like this:
6106 .code
6107 #PLAIN:
6108 #  driver                  = plaintext
6109 #  server_set_id           = $auth2
6110 #  server_prompts          = :
6111 #  server_condition        = Authentication is not yet configured
6112 #  server_advertise_condition = ${if def:tls_in_cipher }
6113 .endd
6114 And the example LOGIN authenticator looks like this:
6115 .code
6116 #LOGIN:
6117 #  driver                  = plaintext
6118 #  server_set_id           = $auth1
6119 #  server_prompts          = <| Username: | Password:
6120 #  server_condition        = Authentication is not yet configured
6121 #  server_advertise_condition = ${if def:tls_in_cipher }
6122 .endd
6123
6124 The &%server_set_id%& option makes Exim remember the authenticated username
6125 in &$authenticated_id$&, which can be used later in ACLs or routers. The
6126 &%server_prompts%& option configures the &(plaintext)& authenticator so
6127 that it implements the details of the specific authentication mechanism,
6128 i.e. PLAIN or LOGIN. The &%server_advertise_condition%& setting controls
6129 when Exim offers authentication to clients; in the examples, this is only
6130 when TLS or SSL has been started, so to enable the authenticators you also
6131 need to add support for TLS as described in section &<<SECTdefconfmain>>&.
6132
6133 The &%server_condition%& setting defines how to verify that the username and
6134 password are correct. In the examples it just produces an error message.
6135 To make the authenticators work, you can use a string expansion
6136 expression like one of the examples in chapter &<<CHAPplaintext>>&.
6137
6138 Beware that the sequence of the parameters to PLAIN and LOGIN differ; the
6139 usercode and password are in different positions.
6140 Chapter &<<CHAPplaintext>>& covers both.
6141
6142 .ecindex IIDconfiwal
6143
6144
6145
6146 . ////////////////////////////////////////////////////////////////////////////
6147 . ////////////////////////////////////////////////////////////////////////////
6148
6149 .chapter "Regular expressions" "CHAPregexp"
6150
6151 .cindex "regular expressions" "library"
6152 .cindex "PCRE"
6153 Exim supports the use of regular expressions in many of its options. It
6154 uses the PCRE regular expression library; this provides regular expression
6155 matching that is compatible with Perl 5. The syntax and semantics of
6156 regular expressions is discussed in many Perl reference books, and also in
6157 Jeffrey Friedl's &'Mastering Regular Expressions'&, which is published by
6158 O'Reilly (see &url(http://www.oreilly.com/catalog/regex2/)).
6159
6160 The documentation for the syntax and semantics of the regular expressions that
6161 are supported by PCRE is included in the PCRE distribution, and no further
6162 description is included here. The PCRE functions are called from Exim using
6163 the default option settings (that is, with no PCRE options set), except that
6164 the PCRE_CASELESS option is set when the matching is required to be
6165 case-insensitive.
6166
6167 In most cases, when a regular expression is required in an Exim configuration,
6168 it has to start with a circumflex, in order to distinguish it from plain text
6169 or an &"ends with"& wildcard. In this example of a configuration setting, the
6170 second item in the colon-separated list is a regular expression.
6171 .code
6172 domains = a.b.c : ^\\d{3} : *.y.z : ...
6173 .endd
6174 The doubling of the backslash is required because of string expansion that
6175 precedes interpretation &-- see section &<<SECTlittext>>& for more discussion
6176 of this issue, and a way of avoiding the need for doubling backslashes. The
6177 regular expression that is eventually used in this example contains just one
6178 backslash. The circumflex is included in the regular expression, and has the
6179 normal effect of &"anchoring"& it to the start of the string that is being
6180 matched.
6181
6182 There are, however, two cases where a circumflex is not required for the
6183 recognition of a regular expression: these are the &%match%& condition in a
6184 string expansion, and the &%matches%& condition in an Exim filter file. In
6185 these cases, the relevant string is always treated as a regular expression; if
6186 it does not start with a circumflex, the expression is not anchored, and can
6187 match anywhere in the subject string.
6188
6189 In all cases, if you want a regular expression to match at the end of a string,
6190 you must code the $ metacharacter to indicate this. For example:
6191 .code
6192 domains = ^\\d{3}\\.example
6193 .endd
6194 matches the domain &'123.example'&, but it also matches &'123.example.com'&.
6195 You need to use:
6196 .code
6197 domains = ^\\d{3}\\.example\$
6198 .endd
6199 if you want &'example'& to be the top-level domain. The backslash before the
6200 $ is needed because string expansion also interprets dollar characters.
6201
6202
6203
6204 . ////////////////////////////////////////////////////////////////////////////
6205 . ////////////////////////////////////////////////////////////////////////////
6206
6207 .chapter "File and database lookups" "CHAPfdlookup"
6208 .scindex IIDfidalo1 "file" "lookups"
6209 .scindex IIDfidalo2 "database" "lookups"
6210 .cindex "lookup" "description of"
6211 Exim can be configured to look up data in files or databases as it processes
6212 messages. Two different kinds of syntax are used:
6213
6214 .olist
6215 A string that is to be expanded may contain explicit lookup requests. These
6216 cause parts of the string to be replaced by data that is obtained from the
6217 lookup. Lookups of this type are conditional expansion items. Different results
6218 can be defined for the cases of lookup success and failure. See chapter
6219 &<<CHAPexpand>>&, where string expansions are described in detail.
6220 .next
6221 Lists of domains, hosts, and email addresses can contain lookup requests as a
6222 way of avoiding excessively long linear lists. In this case, the data that is
6223 returned by the lookup is often (but not always) discarded; whether the lookup
6224 succeeds or fails is what really counts. These kinds of list are described in
6225 chapter &<<CHAPdomhosaddlists>>&.
6226 .endlist
6227
6228 String expansions, lists, and lookups interact with each other in such a way
6229 that there is no order in which to describe any one of them that does not
6230 involve references to the others. Each of these three chapters makes more sense
6231 if you have read the other two first. If you are reading this for the first
6232 time, be aware that some of it will make a lot more sense after you have read
6233 chapters &<<CHAPdomhosaddlists>>& and &<<CHAPexpand>>&.
6234
6235 .section "Examples of different lookup syntax" "SECID60"
6236 It is easy to confuse the two different kinds of lookup, especially as the
6237 lists that may contain the second kind are always expanded before being
6238 processed as lists. Therefore, they may also contain lookups of the first kind.
6239 Be careful to distinguish between the following two examples:
6240 .code
6241 domains = ${lookup{$sender_host_address}lsearch{/some/file}}
6242 domains = lsearch;/some/file
6243 .endd
6244 The first uses a string expansion, the result of which must be a domain list.
6245 No strings have been specified for a successful or a failing lookup; the
6246 defaults in this case are the looked-up data and an empty string, respectively.
6247 The expansion takes place before the string is processed as a list, and the
6248 file that is searched could contain lines like this:
6249 .code
6250 192.168.3.4: domain1:domain2:...
6251 192.168.1.9: domain3:domain4:...
6252 .endd
6253 When the lookup succeeds, the result of the expansion is a list of domains (and
6254 possibly other types of item that are allowed in domain lists).
6255
6256 In the second example, the lookup is a single item in a domain list. It causes
6257 Exim to use a lookup to see if the domain that is being processed can be found
6258 in the file. The file could contains lines like this:
6259 .code
6260 domain1:
6261 domain2:
6262 .endd
6263 Any data that follows the keys is not relevant when checking that the domain
6264 matches the list item.
6265
6266 It is possible, though no doubt confusing, to use both kinds of lookup at once.
6267 Consider a file containing lines like this:
6268 .code
6269 192.168.5.6: lsearch;/another/file
6270 .endd
6271 If the value of &$sender_host_address$& is 192.168.5.6, expansion of the
6272 first &%domains%& setting above generates the second setting, which therefore
6273 causes a second lookup to occur.
6274
6275 The rest of this chapter describes the different lookup types that are
6276 available. Any of them can be used in any part of the configuration where a
6277 lookup is permitted.
6278
6279
6280 .section "Lookup types" "SECID61"
6281 .cindex "lookup" "types of"
6282 .cindex "single-key lookup" "definition of"
6283 Two different types of data lookup are implemented:
6284
6285 .ilist
6286 The &'single-key'& type requires the specification of a file in which to look,
6287 and a single key to search for. The key must be a non-empty string for the
6288 lookup to succeed. The lookup type determines how the file is searched.
6289 .next
6290 .cindex "query-style lookup" "definition of"
6291 The &'query-style'& type accepts a generalized database query. No particular
6292 key value is assumed by Exim for query-style lookups. You can use whichever
6293 Exim variables you need to construct the database query.
6294 .endlist
6295
6296 The code for each lookup type is in a separate source file that is included in
6297 the binary of Exim only if the corresponding compile-time option is set. The
6298 default settings in &_src/EDITME_& are:
6299 .code
6300 LOOKUP_DBM=yes
6301 LOOKUP_LSEARCH=yes
6302 .endd
6303 which means that only linear searching and DBM lookups are included by default.
6304 For some types of lookup (e.g. SQL databases), you need to install appropriate
6305 libraries and header files before building Exim.
6306
6307
6308
6309
6310 .section "Single-key lookup types" "SECTsinglekeylookups"
6311 .cindex "lookup" "single-key types"
6312 .cindex "single-key lookup" "list of types"
6313 The following single-key lookup types are implemented:
6314
6315 .ilist
6316 .cindex "cdb" "description of"
6317 .cindex "lookup" "cdb"
6318 .cindex "binary zero" "in lookup key"
6319 &(cdb)&: The given file is searched as a Constant DataBase file, using the key
6320 string without a terminating binary zero. The cdb format is designed for
6321 indexed files that are read frequently and never updated, except by total
6322 re-creation. As such, it is particularly suitable for large files containing
6323 aliases or other indexed data referenced by an MTA. Information about cdb can
6324 be found in several places:
6325 .display
6326 &url(http://www.pobox.com/~djb/cdb.html)
6327 &url(ftp://ftp.corpit.ru/pub/tinycdb/)
6328 &url(http://packages.debian.org/stable/utils/freecdb.html)
6329 .endd
6330 A cdb distribution is not needed in order to build Exim with cdb support,
6331 because the code for reading cdb files is included directly in Exim itself.
6332 However, no means of building or testing cdb files is provided with Exim, so
6333 you need to obtain a cdb distribution in order to do this.
6334 .next
6335 .cindex "DBM" "lookup type"
6336 .cindex "lookup" "dbm"
6337 .cindex "binary zero" "in lookup key"
6338 &(dbm)&: Calls to DBM library functions are used to extract data from the given
6339 DBM file by looking up the record with the given key. A terminating binary
6340 zero is included in the key that is passed to the DBM library. See section
6341 &<<SECTdb>>& for a discussion of DBM libraries.
6342
6343 .cindex "Berkeley DB library" "file format"
6344 For all versions of Berkeley DB, Exim uses the DB_HASH style of database
6345 when building DBM files using the &%exim_dbmbuild%& utility. However, when
6346 using Berkeley DB versions 3 or 4, it opens existing databases for reading with
6347 the DB_UNKNOWN option. This enables it to handle any of the types of database
6348 that the library supports, and can be useful for accessing DBM files created by
6349 other applications. (For earlier DB versions, DB_HASH is always used.)
6350 .next
6351 .cindex "lookup" "dbmjz"
6352 .cindex "lookup" "dbm &-- embedded NULs"
6353 .cindex "sasldb2"
6354 .cindex "dbmjz lookup type"
6355 &(dbmjz)&: This is the same as &(dbm)&, except that the lookup key is
6356 interpreted as an Exim list; the elements of the list are joined together with
6357 ASCII NUL characters to form the lookup key.  An example usage would be to
6358 authenticate incoming SMTP calls using the passwords from Cyrus SASL's
6359 &_/etc/sasldb2_& file with the &(gsasl)& authenticator or Exim's own
6360 &(cram_md5)& authenticator.
6361 .next
6362 .cindex "lookup" "dbmnz"
6363 .cindex "lookup" "dbm &-- terminating zero"
6364 .cindex "binary zero" "in lookup key"
6365 .cindex "Courier"
6366 .cindex "&_/etc/userdbshadow.dat_&"
6367 .cindex "dbmnz lookup type"
6368 &(dbmnz)&: This is the same as &(dbm)&, except that a terminating binary zero
6369 is not included in the key that is passed to the DBM library. You may need this
6370 if you want to look up data in files that are created by or shared with some
6371 other application that does not use terminating zeros. For example, you need to
6372 use &(dbmnz)& rather than &(dbm)& if you want to authenticate incoming SMTP
6373 calls using the passwords from Courier's &_/etc/userdbshadow.dat_& file. Exim's
6374 utility program for creating DBM files (&'exim_dbmbuild'&) includes the zeros
6375 by default, but has an option to omit them (see section &<<SECTdbmbuild>>&).
6376 .next
6377 .cindex "lookup" "dsearch"
6378 .cindex "dsearch lookup type"
6379 &(dsearch)&: The given file must be a directory; this is searched for an entry
6380 whose name is the key by calling the &[lstat()]& function. The key may not
6381 contain any forward slash characters. If &[lstat()]& succeeds, the result of
6382 the lookup is the name of the entry, which may be a file, directory,
6383 symbolic link, or any other kind of directory entry. An example of how this
6384 lookup can be used to support virtual domains is given in section
6385 &<<SECTvirtualdomains>>&.
6386 .next
6387 .cindex "lookup" "iplsearch"
6388 .cindex "iplsearch lookup type"
6389 &(iplsearch)&: The given file is a text file containing keys and data. A key is
6390 terminated by a colon or white space or the end of the line. The keys in the
6391 file must be IP addresses, or IP addresses with CIDR masks. Keys that involve
6392 IPv6 addresses must be enclosed in quotes to prevent the first internal colon
6393 being interpreted as a key terminator. For example:
6394 .code
6395 1.2.3.4:           data for 1.2.3.4
6396 192.168.0.0/16:    data for 192.168.0.0/16
6397 "abcd::cdab":      data for abcd::cdab
6398 "abcd:abcd::/32"   data for abcd:abcd::/32
6399 .endd
6400 The key for an &(iplsearch)& lookup must be an IP address (without a mask). The
6401 file is searched linearly, using the CIDR masks where present, until a matching
6402 key is found. The first key that matches is used; there is no attempt to find a
6403 &"best"& match. Apart from the way the keys are matched, the processing for
6404 &(iplsearch)& is the same as for &(lsearch)&.
6405
6406 &*Warning 1*&: Unlike most other single-key lookup types, a file of data for
6407 &(iplsearch)& can &'not'& be turned into a DBM or cdb file, because those
6408 lookup types support only literal keys.
6409
6410 &*Warning 2*&: In a host list, you must always use &(net-iplsearch)& so that
6411 the implicit key is the host's IP address rather than its name (see section
6412 &<<SECThoslispatsikey>>&).
6413 .next
6414 .cindex "linear search"
6415 .cindex "lookup" "lsearch"
6416 .cindex "lsearch lookup type"
6417 .cindex "case sensitivity" "in lsearch lookup"
6418 &(lsearch)&: The given file is a text file that is searched linearly for a
6419 line beginning with the search key, terminated by a colon or white space or the
6420 end of the line. The search is case-insensitive; that is, upper and lower case
6421 letters are treated as the same. The first occurrence of the key that is found
6422 in the file is used.
6423
6424 White space between the key and the colon is permitted. The remainder of the
6425 line, with leading and trailing white space removed, is the data. This can be
6426 continued onto subsequent lines by starting them with any amount of white
6427 space, but only a single space character is included in the data at such a
6428 junction. If the data begins with a colon, the key must be terminated by a
6429 colon, for example:
6430 .code
6431 baduser:  :fail:
6432 .endd
6433 Empty lines and lines beginning with # are ignored, even if they occur in the
6434 middle of an item. This is the traditional textual format of alias files. Note
6435 that the keys in an &(lsearch)& file are literal strings. There is no
6436 wildcarding of any kind.
6437
6438 .cindex "lookup" "lsearch &-- colons in keys"
6439 .cindex "white space" "in lsearch key"
6440 In most &(lsearch)& files, keys are not required to contain colons or #
6441 characters, or white space. However, if you need this feature, it is available.
6442 If a key begins with a doublequote character, it is terminated only by a
6443 matching quote (or end of line), and the normal escaping rules apply to its
6444 contents (see section &<<SECTstrings>>&). An optional colon is permitted after
6445 quoted keys (exactly as for unquoted keys). There is no special handling of
6446 quotes for the data part of an &(lsearch)& line.
6447
6448 .next
6449 .cindex "NIS lookup type"
6450 .cindex "lookup" "NIS"
6451 .cindex "binary zero" "in lookup key"
6452 &(nis)&: The given file is the name of a NIS map, and a NIS lookup is done with
6453 the given key, without a terminating binary zero. There is a variant called
6454 &(nis0)& which does include the terminating binary zero in the key. This is
6455 reportedly needed for Sun-style alias files. Exim does not recognize NIS
6456 aliases; the full map names must be used.
6457
6458 .next
6459 .cindex "wildlsearch lookup type"
6460 .cindex "lookup" "wildlsearch"
6461 .cindex "nwildlsearch lookup type"
6462 .cindex "lookup" "nwildlsearch"
6463 &(wildlsearch)& or &(nwildlsearch)&: These search a file linearly, like
6464 &(lsearch)&, but instead of being interpreted as a literal string, each key in
6465 the file may be wildcarded. The difference between these two lookup types is
6466 that for &(wildlsearch)&, each key in the file is string-expanded before being
6467 used, whereas for &(nwildlsearch)&, no expansion takes place.
6468
6469 .cindex "case sensitivity" "in (n)wildlsearch lookup"
6470 Like &(lsearch)&, the testing is done case-insensitively. However, keys in the
6471 file that are regular expressions can be made case-sensitive by the use of
6472 &`(-i)`& within the pattern. The following forms of wildcard are recognized:
6473
6474 . ==== As this is a nested list, any displays it contains must be indented
6475 . ==== as otherwise they are too far to the left.
6476
6477 .olist
6478 The string may begin with an asterisk to mean &"ends with"&. For example:
6479 .code
6480     *.a.b.c       data for anything.a.b.c
6481     *fish         data for anythingfish
6482 .endd
6483 .next
6484 The string may begin with a circumflex to indicate a regular expression. For
6485 example, for &(wildlsearch)&:
6486 .code
6487     ^\N\d+\.a\.b\N    data for <digits>.a.b
6488 .endd
6489 Note the use of &`\N`& to disable expansion of the contents of the regular
6490 expression. If you are using &(nwildlsearch)&, where the keys are not
6491 string-expanded, the equivalent entry is:
6492 .code
6493     ^\d+\.a\.b        data for <digits>.a.b
6494 .endd
6495 The case-insensitive flag is set at the start of compiling the regular
6496 expression, but it can be turned off by using &`(-i)`& at an appropriate point.
6497 For example, to make the entire pattern case-sensitive:
6498 .code
6499     ^(?-i)\d+\.a\.b        data for <digits>.a.b
6500 .endd
6501
6502 If the regular expression contains white space or colon characters, you must
6503 either quote it (see &(lsearch)& above), or represent these characters in other
6504 ways. For example, &`\s`& can be used for white space and &`\x3A`& for a
6505 colon. This may be easier than quoting, because if you quote, you have to
6506 escape all the backslashes inside the quotes.
6507
6508 &*Note*&: It is not possible to capture substrings in a regular expression
6509 match for later use, because the results of all lookups are cached. If a lookup
6510 is repeated, the result is taken from the cache, and no actual pattern matching
6511 takes place. The values of all the numeric variables are unset after a
6512 &((n)wildlsearch)& match.
6513
6514 .next
6515 Although I cannot see it being of much use, the general matching function that
6516 is used to implement &((n)wildlsearch)& means that the string may begin with a
6517 lookup name terminated by a semicolon, and followed by lookup data. For
6518 example:
6519 .code
6520     cdb;/some/file  data for keys that match the file
6521 .endd
6522 The data that is obtained from the nested lookup is discarded.
6523 .endlist olist
6524
6525 Keys that do not match any of these patterns are interpreted literally. The
6526 continuation rules for the data are the same as for &(lsearch)&, and keys may
6527 be followed by optional colons.
6528
6529 &*Warning*&: Unlike most other single-key lookup types, a file of data for
6530 &((n)wildlsearch)& can &'not'& be turned into a DBM or cdb file, because those
6531 lookup types support only literal keys.
6532 .endlist ilist
6533
6534
6535 .section "Query-style lookup types" "SECID62"
6536 .cindex "lookup" "query-style types"
6537 .cindex "query-style lookup" "list of types"
6538 The supported query-style lookup types are listed below. Further details about
6539 many of them are given in later sections.
6540
6541 .ilist
6542 .cindex "DNS" "as a lookup type"
6543 .cindex "lookup" "DNS"
6544 &(dnsdb)&: This does a DNS search for one or more records whose domain names
6545 are given in the supplied query. The resulting data is the contents of the
6546 records. See section &<<SECTdnsdb>>&.
6547 .next
6548 .cindex "InterBase lookup type"
6549 .cindex "lookup" "InterBase"
6550 &(ibase)&: This does a lookup in an InterBase database.
6551 .next
6552 .cindex "LDAP" "lookup type"
6553 .cindex "lookup" "LDAP"
6554 &(ldap)&: This does an LDAP lookup using a query in the form of a URL, and
6555 returns attributes from a single entry. There is a variant called &(ldapm)&
6556 that permits values from multiple entries to be returned. A third variant
6557 called &(ldapdn)& returns the Distinguished Name of a single entry instead of
6558 any attribute values. See section &<<SECTldap>>&.
6559 .next
6560 .cindex "MySQL" "lookup type"
6561 .cindex "lookup" "MySQL"
6562 &(mysql)&: The format of the query is an SQL statement that is passed to a
6563 MySQL database. See section &<<SECTsql>>&.
6564 .next
6565 .cindex "NIS+ lookup type"
6566 .cindex "lookup" "NIS+"
6567 &(nisplus)&: This does a NIS+ lookup using a query that can specify the name of
6568 the field to be returned. See section &<<SECTnisplus>>&.
6569 .next
6570 .cindex "Oracle" "lookup type"
6571 .cindex "lookup" "Oracle"
6572 &(oracle)&: The format of the query is an SQL statement that is passed to an
6573 Oracle database. See section &<<SECTsql>>&.
6574 .next
6575 .cindex "lookup" "passwd"
6576 .cindex "passwd lookup type"
6577 .cindex "&_/etc/passwd_&"
6578 &(passwd)& is a query-style lookup with queries that are just user names. The
6579 lookup calls &[getpwnam()]& to interrogate the system password data, and on
6580 success, the result string is the same as you would get from an &(lsearch)&
6581 lookup on a traditional &_/etc/passwd file_&, though with &`*`& for the
6582 password value. For example:
6583 .code
6584 *:42:42:King Rat:/home/kr:/bin/bash
6585 .endd
6586 .next
6587 .cindex "PostgreSQL lookup type"
6588 .cindex "lookup" "PostgreSQL"
6589 &(pgsql)&: The format of the query is an SQL statement that is passed to a
6590 PostgreSQL database. See section &<<SECTsql>>&.
6591
6592 .next
6593 .cindex "sqlite lookup type"
6594 .cindex "lookup" "sqlite"
6595 &(sqlite)&: The format of the query is a file name followed by an SQL statement
6596 that is passed to an SQLite database. See section &<<SECTsqlite>>&.
6597
6598 .next
6599 &(testdb)&: This is a lookup type that is used for testing Exim. It is
6600 not likely to be useful in normal operation.
6601 .next
6602 .cindex "whoson lookup type"
6603 .cindex "lookup" "whoson"
6604 &(whoson)&: &'Whoson'& (&url(http://whoson.sourceforge.net)) is a protocol that
6605 allows a server to check whether a particular (dynamically allocated) IP
6606 address is currently allocated to a known (trusted) user and, optionally, to
6607 obtain the identity of the said user. For SMTP servers, &'Whoson'& was popular
6608 at one time for &"POP before SMTP"& authentication, but that approach has been
6609 superseded by SMTP authentication. In Exim, &'Whoson'& can be used to implement
6610 &"POP before SMTP"& checking using ACL statements such as
6611 .code
6612 require condition = \
6613   ${lookup whoson {$sender_host_address}{yes}{no}}
6614 .endd
6615 The query consists of a single IP address. The value returned is the name of
6616 the authenticated user, which is stored in the variable &$value$&. However, in
6617 this example, the data in &$value$& is not used; the result of the lookup is
6618 one of the fixed strings &"yes"& or &"no"&.
6619 .endlist
6620
6621
6622
6623 .section "Temporary errors in lookups" "SECID63"
6624 .cindex "lookup" "temporary error in"
6625 Lookup functions can return temporary error codes if the lookup cannot be
6626 completed. For example, an SQL or LDAP database might be unavailable. For this
6627 reason, it is not advisable to use a lookup that might do this for critical
6628 options such as a list of local domains.
6629
6630 When a lookup cannot be completed in a router or transport, delivery
6631 of the message (to the relevant address) is deferred, as for any other
6632 temporary error. In other circumstances Exim may assume the lookup has failed,
6633 or may give up altogether.
6634
6635
6636
6637 .section "Default values in single-key lookups" "SECTdefaultvaluelookups"
6638 .cindex "wildcard lookups"
6639 .cindex "lookup" "default values"
6640 .cindex "lookup" "wildcard"
6641 .cindex "lookup" "* added to type"
6642 .cindex "default" "in single-key lookups"
6643 In this context, a &"default value"& is a value specified by the administrator
6644 that is to be used if a lookup fails.
6645
6646 &*Note:*& This section applies only to single-key lookups. For query-style
6647 lookups, the facilities of the query language must be used. An attempt to
6648 specify a default for a query-style lookup provokes an error.
6649
6650 If &"*"& is added to a single-key lookup type (for example, &%lsearch*%&)
6651 and the initial lookup fails, the key &"*"& is looked up in the file to
6652 provide a default value. See also the section on partial matching below.
6653
6654 .cindex "*@ with single-key lookup"
6655 .cindex "lookup" "*@ added to type"
6656 .cindex "alias file" "per-domain default"
6657 Alternatively, if &"*@"& is added to a single-key lookup type (for example
6658 &%dbm*@%&) then, if the initial lookup fails and the key contains an @
6659 character, a second lookup is done with everything before the last @ replaced
6660 by *. This makes it possible to provide per-domain defaults in alias files
6661 that include the domains in the keys. If the second lookup fails (or doesn't
6662 take place because there is no @ in the key), &"*"& is looked up.
6663 For example, a &(redirect)& router might contain:
6664 .code
6665 data = ${lookup{$local_part@$domain}lsearch*@{/etc/mix-aliases}}
6666 .endd
6667 Suppose the address that is being processed is &'jane@eyre.example'&. Exim
6668 looks up these keys, in this order:
6669 .code
6670 jane@eyre.example
6671 *@eyre.example
6672 *
6673 .endd
6674 The data is taken from whichever key it finds first. &*Note*&: In an
6675 &(lsearch)& file, this does not mean the first of these keys in the file. A
6676 complete scan is done for each key, and only if it is not found at all does
6677 Exim move on to try the next key.
6678
6679
6680
6681 .section "Partial matching in single-key lookups" "SECTpartiallookup"
6682 .cindex "partial matching"
6683 .cindex "wildcard lookups"
6684 .cindex "lookup" "partial matching"
6685 .cindex "lookup" "wildcard"
6686 .cindex "asterisk" "in search type"
6687 The normal operation of a single-key lookup is to search the file for an exact
6688 match with the given key. However, in a number of situations where domains are
6689 being looked up, it is useful to be able to do partial matching. In this case,
6690 information in the file that has a key starting with &"*."& is matched by any
6691 domain that ends with the components that follow the full stop. For example, if
6692 a key in a DBM file is
6693 .code
6694 *.dates.fict.example
6695 .endd
6696 then when partial matching is enabled this is matched by (amongst others)
6697 &'2001.dates.fict.example'& and &'1984.dates.fict.example'&. It is also matched
6698 by &'dates.fict.example'&, if that does not appear as a separate key in the
6699 file.
6700
6701 &*Note*&: Partial matching is not available for query-style lookups. It is
6702 also not available for any lookup items in address lists (see section
6703 &<<SECTaddresslist>>&).
6704
6705 Partial matching is implemented by doing a series of separate lookups using
6706 keys constructed by modifying the original subject key. This means that it can
6707 be used with any of the single-key lookup types, provided that
6708 partial matching keys
6709 beginning with a special prefix (default &"*."&) are included in the data file.
6710 Keys in the file that do not begin with the prefix are matched only by
6711 unmodified subject keys when partial matching is in use.
6712
6713 Partial matching is requested by adding the string &"partial-"& to the front of
6714 the name of a single-key lookup type, for example, &%partial-dbm%&. When this
6715 is done, the subject key is first looked up unmodified; if that fails, &"*."&
6716 is added at the start of the subject key, and it is looked up again. If that
6717 fails, further lookups are tried with dot-separated components removed from the
6718 start of the subject key, one-by-one, and &"*."& added on the front of what
6719 remains.
6720
6721 A minimum number of two non-* components are required. This can be adjusted
6722 by including a number before the hyphen in the search type. For example,
6723 &%partial3-lsearch%& specifies a minimum of three non-* components in the
6724 modified keys. Omitting the number is equivalent to &"partial2-"&. If the
6725 subject key is &'2250.dates.fict.example'& then the following keys are looked
6726 up when the minimum number of non-* components is two:
6727 .code
6728 2250.dates.fict.example
6729 *.2250.dates.fict.example
6730 *.dates.fict.example
6731 *.fict.example
6732 .endd
6733 As soon as one key in the sequence is successfully looked up, the lookup
6734 finishes.
6735
6736 .cindex "lookup" "partial matching &-- changing prefix"
6737 .cindex "prefix" "for partial matching"
6738 The use of &"*."& as the partial matching prefix is a default that can be
6739 changed. The motivation for this feature is to allow Exim to operate with file
6740 formats that are used by other MTAs. A different prefix can be supplied in
6741 parentheses instead of the hyphen after &"partial"&. For example:
6742 .code
6743 domains = partial(.)lsearch;/some/file
6744 .endd
6745 In this example, if the domain is &'a.b.c'&, the sequence of lookups is
6746 &`a.b.c`&, &`.a.b.c`&, and &`.b.c`& (the default minimum of 2 non-wild
6747 components is unchanged). The prefix may consist of any punctuation characters
6748 other than a closing parenthesis. It may be empty, for example:
6749 .code
6750 domains = partial1()cdb;/some/file
6751 .endd
6752 For this example, if the domain is &'a.b.c'&, the sequence of lookups is
6753 &`a.b.c`&, &`b.c`&, and &`c`&.
6754
6755 If &"partial0"& is specified, what happens at the end (when the lookup with
6756 just one non-wild component has failed, and the original key is shortened right
6757 down to the null string) depends on the prefix:
6758
6759 .ilist
6760 If the prefix has zero length, the whole lookup fails.
6761 .next
6762 If the prefix has length 1, a lookup for just the prefix is done. For
6763 example, the final lookup for &"partial0(.)"& is for &`.`& alone.
6764 .next
6765 Otherwise, if the prefix ends in a dot, the dot is removed, and the
6766 remainder is looked up. With the default prefix, therefore, the final lookup is
6767 for &"*"& on its own.
6768 .next
6769 Otherwise, the whole prefix is looked up.
6770 .endlist
6771
6772
6773 If the search type ends in &"*"& or &"*@"& (see section
6774 &<<SECTdefaultvaluelookups>>& above), the search for an ultimate default that
6775 this implies happens after all partial lookups have failed. If &"partial0"& is
6776 specified, adding &"*"& to the search type has no effect with the default
6777 prefix, because the &"*"& key is already included in the sequence of partial
6778 lookups. However, there might be a use for lookup types such as
6779 &"partial0(.)lsearch*"&.
6780
6781 The use of &"*"& in lookup partial matching differs from its use as a wildcard
6782 in domain lists and the like. Partial matching works only in terms of
6783 dot-separated components; a key such as &`*fict.example`&
6784 in a database file is useless, because the asterisk in a partial matching
6785 subject key is always followed by a dot.
6786
6787
6788
6789
6790 .section "Lookup caching" "SECID64"
6791 .cindex "lookup" "caching"
6792 .cindex "caching" "lookup data"
6793 Exim caches all lookup results in order to avoid needless repetition of
6794 lookups. However, because (apart from the daemon) Exim operates as a collection
6795 of independent, short-lived processes, this caching applies only within a
6796 single Exim process. There is no inter-process lookup caching facility.
6797
6798 For single-key lookups, Exim keeps the relevant files open in case there is
6799 another lookup that needs them. In some types of configuration this can lead to
6800 many files being kept open for messages with many recipients. To avoid hitting
6801 the operating system limit on the number of simultaneously open files, Exim
6802 closes the least recently used file when it needs to open more files than its
6803 own internal limit, which can be changed via the &%lookup_open_max%& option.
6804
6805 The single-key lookup files are closed and the lookup caches are flushed at
6806 strategic points during delivery &-- for example, after all routing is
6807 complete.
6808
6809
6810
6811
6812 .section "Quoting lookup data" "SECID65"
6813 .cindex "lookup" "quoting"
6814 .cindex "quoting" "in lookups"
6815 When data from an incoming message is included in a query-style lookup, there
6816 is the possibility of special characters in the data messing up the syntax of
6817 the query. For example, a NIS+ query that contains
6818 .code
6819 [name=$local_part]
6820 .endd
6821 will be broken if the local part happens to contain a closing square bracket.
6822 For NIS+, data can be enclosed in double quotes like this:
6823 .code
6824 [name="$local_part"]
6825 .endd
6826 but this still leaves the problem of a double quote in the data. The rule for
6827 NIS+ is that double quotes must be doubled. Other lookup types have different
6828 rules, and to cope with the differing requirements, an expansion operator
6829 of the following form is provided:
6830 .code
6831 ${quote_<lookup-type>:<string>}
6832 .endd
6833 For example, the safest way to write the NIS+ query is
6834 .code
6835 [name="${quote_nisplus:$local_part}"]
6836 .endd
6837 See chapter &<<CHAPexpand>>& for full coverage of string expansions. The quote
6838 operator can be used for all lookup types, but has no effect for single-key
6839 lookups, since no quoting is ever needed in their key strings.
6840
6841
6842
6843
6844 .section "More about dnsdb" "SECTdnsdb"
6845 .cindex "dnsdb lookup"
6846 .cindex "lookup" "dnsdb"
6847 .cindex "DNS" "as a lookup type"
6848 The &(dnsdb)& lookup type uses the DNS as its database. A simple query consists
6849 of a record type and a domain name, separated by an equals sign. For example,
6850 an expansion string could contain:
6851 .code
6852 ${lookup dnsdb{mx=a.b.example}{$value}fail}
6853 .endd
6854 If the lookup succeeds, the result is placed in &$value$&, which in this case
6855 is used on its own as the result. If the lookup does not succeed, the
6856 &`fail`& keyword causes a &'forced expansion failure'& &-- see section
6857 &<<SECTforexpfai>>& for an explanation of what this means.
6858
6859 The supported DNS record types are A, CNAME, MX, NS, PTR, SPF, SRV, and TXT,
6860 and, when Exim is compiled with IPv6 support, AAAA (and A6 if that is also
6861 configured). If no type is given, TXT is assumed. When the type is PTR,
6862 the data can be an IP address, written as normal; inversion and the addition of
6863 &%in-addr.arpa%& or &%ip6.arpa%& happens automatically. For example:
6864 .code
6865 ${lookup dnsdb{ptr=192.168.4.5}{$value}fail}
6866 .endd
6867 If the data for a PTR record is not a syntactically valid IP address, it is not
6868 altered and nothing is added.
6869
6870 .cindex "MX record" "in &(dnsdb)& lookup"
6871 .cindex "SRV record" "in &(dnsdb)& lookup"
6872 For an MX lookup, both the preference value and the host name are returned for
6873 each record, separated by a space. For an SRV lookup, the priority, weight,
6874 port, and host name are returned for each record, separated by spaces.
6875
6876 For any record type, if multiple records are found (or, for A6 lookups, if a
6877 single record leads to multiple addresses), the data is returned as a
6878 concatenation, with newline as the default separator. The order, of course,
6879 depends on the DNS resolver. You can specify a different separator character
6880 between multiple records by putting a right angle-bracket followed immediately
6881 by the new separator at the start of the query. For example:
6882 .code
6883 ${lookup dnsdb{>: a=host1.example}}
6884 .endd
6885 It is permitted to specify a space as the separator character. Further
6886 white space is ignored.
6887
6888 .cindex "TXT record" "in &(dnsdb)& lookup"
6889 .cindex "SPF record" "in &(dnsdb)& lookup"
6890 For TXT records with multiple items of data, only the first item is returned,
6891 unless a separator for them is specified using a comma after the separator
6892 character followed immediately by the TXT record item separator. To concatenate
6893 items without a separator, use a semicolon instead. For SPF records the
6894 default behaviour is to concatenate multiple items without using a separator.
6895 .code
6896 ${lookup dnsdb{>\n,: txt=a.b.example}}
6897 ${lookup dnsdb{>\n; txt=a.b.example}}
6898 ${lookup dnsdb{spf=example.org}}
6899 .endd
6900 It is permitted to specify a space as the separator character. Further
6901 white space is ignored.
6902
6903 .section "Pseudo dnsdb record types" "SECID66"
6904 .cindex "MX record" "in &(dnsdb)& lookup"
6905 By default, both the preference value and the host name are returned for
6906 each MX record, separated by a space. If you want only host names, you can use
6907 the pseudo-type MXH:
6908 .code
6909 ${lookup dnsdb{mxh=a.b.example}}
6910 .endd
6911 In this case, the preference values are omitted, and just the host names are
6912 returned.
6913
6914 .cindex "name server for enclosing domain"
6915 Another pseudo-type is ZNS (for &"zone NS"&). It performs a lookup for NS
6916 records on the given domain, but if none are found, it removes the first
6917 component of the domain name, and tries again. This process continues until NS
6918 records are found or there are no more components left (or there is a DNS
6919 error). In other words, it may return the name servers for a top-level domain,
6920 but it never returns the root name servers. If there are no NS records for the
6921 top-level domain, the lookup fails. Consider these examples:
6922 .code
6923 ${lookup dnsdb{zns=xxx.quercite.com}}
6924 ${lookup dnsdb{zns=xxx.edu}}
6925 .endd
6926 Assuming that in each case there are no NS records for the full domain name,
6927 the first returns the name servers for &%quercite.com%&, and the second returns
6928 the name servers for &%edu%&.
6929
6930 You should be careful about how you use this lookup because, unless the
6931 top-level domain does not exist, the lookup always returns some host names. The
6932 sort of use to which this might be put is for seeing if the name servers for a
6933 given domain are on a blacklist. You can probably assume that the name servers
6934 for the high-level domains such as &%com%& or &%co.uk%& are not going to be on
6935 such a list.
6936
6937 .cindex "CSA" "in &(dnsdb)& lookup"
6938 A third pseudo-type is CSA (Client SMTP Authorization). This looks up SRV
6939 records according to the CSA rules, which are described in section
6940 &<<SECTverifyCSA>>&. Although &(dnsdb)& supports SRV lookups directly, this is
6941 not sufficient because of the extra parent domain search behaviour of CSA. The
6942 result of a successful lookup such as:
6943 .code
6944 ${lookup dnsdb {csa=$sender_helo_name}}
6945 .endd
6946 has two space-separated fields: an authorization code and a target host name.
6947 The authorization code can be &"Y"& for yes, &"N"& for no, &"X"& for explicit
6948 authorization required but absent, or &"?"& for unknown.
6949
6950 .cindex "A+" "in &(dnsdb)& lookup"
6951 The pseudo-type A+ performs an A6 lookup (if configured) followed by an AAAA
6952 and then an A lookup.  All results are returned; defer processing
6953 (see below) is handled separately for each lookup.  Example:
6954 .code
6955 ${lookup dnsdb {>; a+=$sender_helo_name}}
6956 .endd
6957
6958
6959 .section "Multiple dnsdb lookups" "SECID67"
6960 In the previous sections, &(dnsdb)& lookups for a single domain are described.
6961 However, you can specify a list of domains or IP addresses in a single
6962 &(dnsdb)& lookup. The list is specified in the normal Exim way, with colon as
6963 the default separator, but with the ability to change this. For example:
6964 .code
6965 ${lookup dnsdb{one.domain.com:two.domain.com}}
6966 ${lookup dnsdb{a=one.host.com:two.host.com}}
6967 ${lookup dnsdb{ptr = <; 1.2.3.4 ; 4.5.6.8}}
6968 .endd
6969 In order to retain backwards compatibility, there is one special case: if
6970 the lookup type is PTR and no change of separator is specified, Exim looks
6971 to see if the rest of the string is precisely one IPv6 address. In this
6972 case, it does not treat it as a list.
6973
6974 The data from each lookup is concatenated, with newline separators by default,
6975 in the same way that multiple DNS records for a single item are handled. A
6976 different separator can be specified, as described above.
6977
6978 The &(dnsdb)& lookup fails only if all the DNS lookups fail. If there is a
6979 temporary DNS error for any of them, the behaviour is controlled by
6980 an optional keyword followed by a comma that may appear before the record
6981 type. The possible keywords are &"defer_strict"&, &"defer_never"&, and
6982 &"defer_lax"&. With &"strict"& behaviour, any temporary DNS error causes the
6983 whole lookup to defer. With &"never"& behaviour, a temporary DNS error is
6984 ignored, and the behaviour is as if the DNS lookup failed to find anything.
6985 With &"lax"& behaviour, all the queries are attempted, but a temporary DNS
6986 error causes the whole lookup to defer only if none of the other lookups
6987 succeed. The default is &"lax"&, so the following lookups are equivalent:
6988 .code
6989 ${lookup dnsdb{defer_lax,a=one.host.com:two.host.com}}
6990 ${lookup dnsdb{a=one.host.com:two.host.com}}
6991 .endd
6992 Thus, in the default case, as long as at least one of the DNS lookups
6993 yields some data, the lookup succeeds.
6994
6995
6996
6997
6998 .section "More about LDAP" "SECTldap"
6999 .cindex "LDAP" "lookup, more about"
7000 .cindex "lookup" "LDAP"
7001 .cindex "Solaris" "LDAP"
7002 The original LDAP implementation came from the University of Michigan; this has
7003 become &"Open LDAP"&, and there are now two different releases. Another
7004 implementation comes from Netscape, and Solaris 7 and subsequent releases
7005 contain inbuilt LDAP support. Unfortunately, though these are all compatible at
7006 the lookup function level, their error handling is different. For this reason
7007 it is necessary to set a compile-time variable when building Exim with LDAP, to
7008 indicate which LDAP library is in use. One of the following should appear in
7009 your &_Local/Makefile_&:
7010 .code
7011 LDAP_LIB_TYPE=UMICHIGAN
7012 LDAP_LIB_TYPE=OPENLDAP1
7013 LDAP_LIB_TYPE=OPENLDAP2
7014 LDAP_LIB_TYPE=NETSCAPE
7015 LDAP_LIB_TYPE=SOLARIS
7016 .endd
7017 If LDAP_LIB_TYPE is not set, Exim assumes &`OPENLDAP1`&, which has the
7018 same interface as the University of Michigan version.
7019
7020 There are three LDAP lookup types in Exim. These behave slightly differently in
7021 the way they handle the results of a query:
7022
7023 .ilist
7024 &(ldap)& requires the result to contain just one entry; if there are more, it
7025 gives an error.
7026 .next
7027 &(ldapdn)& also requires the result to contain just one entry, but it is the
7028 Distinguished Name that is returned rather than any attribute values.
7029 .next
7030 &(ldapm)& permits the result to contain more than one entry; the attributes
7031 from all of them are returned.
7032 .endlist
7033
7034
7035 For &(ldap)& and &(ldapm)&, if a query finds only entries with no attributes,
7036 Exim behaves as if the entry did not exist, and the lookup fails. The format of
7037 the data returned by a successful lookup is described in the next section.
7038 First we explain how LDAP queries are coded.
7039
7040
7041 .section "Format of LDAP queries" "SECTforldaque"
7042 .cindex "LDAP" "query format"
7043 An LDAP query takes the form of a URL as defined in RFC 2255. For example, in
7044 the configuration of a &(redirect)& router one might have this setting:
7045 .code
7046 data = ${lookup ldap \
7047   {ldap:///cn=$local_part,o=University%20of%20Cambridge,\
7048   c=UK?mailbox?base?}}
7049 .endd
7050 .cindex "LDAP" "with TLS"
7051 The URL may begin with &`ldap`& or &`ldaps`& if your LDAP library supports
7052 secure (encrypted) LDAP connections. The second of these ensures that an
7053 encrypted TLS connection is used.
7054
7055 With sufficiently modern LDAP libraries, Exim supports forcing TLS over regular
7056 LDAP connections, rather than the SSL-on-connect &`ldaps`&.
7057 See the &%ldap_start_tls%& option.
7058
7059
7060 .section "LDAP quoting" "SECID68"
7061 .cindex "LDAP" "quoting"
7062 Two levels of quoting are required in LDAP queries, the first for LDAP itself
7063 and the second because the LDAP query is represented as a URL. Furthermore,
7064 within an LDAP query, two different kinds of quoting are required. For this
7065 reason, there are two different LDAP-specific quoting operators.
7066
7067 The &%quote_ldap%& operator is designed for use on strings that are part of
7068 filter specifications. Conceptually, it first does the following conversions on
7069 the string:
7070 .code
7071 *   =>   \2A
7072 (   =>   \28
7073 )   =>   \29
7074 \   =>   \5C
7075 .endd
7076 in accordance with RFC 2254. The resulting string is then quoted according
7077 to the rules for URLs, that is, all non-alphanumeric characters except
7078 .code
7079 ! $ ' - . _ ( ) * +
7080 .endd
7081 are converted to their hex values, preceded by a percent sign. For example:
7082 .code
7083 ${quote_ldap: a(bc)*, a<yz>; }
7084 .endd
7085 yields
7086 .code
7087 %20a%5C28bc%5C29%5C2A%2C%20a%3Cyz%3E%3B%20
7088 .endd
7089 Removing the URL quoting, this is (with a leading and a trailing space):
7090 .code
7091 a\28bc\29\2A, a<yz>;
7092 .endd
7093 The &%quote_ldap_dn%& operator is designed for use on strings that are part of
7094 base DN specifications in queries. Conceptually, it first converts the string
7095 by inserting a backslash in front of any of the following characters:
7096 .code
7097 , + " \ < > ;
7098 .endd
7099 It also inserts a backslash before any leading spaces or # characters, and
7100 before any trailing spaces. (These rules are in RFC 2253.) The resulting string
7101 is then quoted according to the rules for URLs. For example:
7102 .code
7103 ${quote_ldap_dn: a(bc)*, a<yz>; }
7104 .endd
7105 yields
7106 .code
7107 %5C%20a(bc)*%5C%2C%20a%5C%3Cyz%5C%3E%5C%3B%5C%20
7108 .endd
7109 Removing the URL quoting, this is (with a trailing space):
7110 .code
7111 \ a(bc)*\, a\<yz\>\;\
7112 .endd
7113 There are some further comments about quoting in the section on LDAP
7114 authentication below.
7115
7116
7117 .section "LDAP connections" "SECID69"
7118 .cindex "LDAP" "connections"
7119 The connection to an LDAP server may either be over TCP/IP, or, when OpenLDAP
7120 is in use, via a Unix domain socket. The example given above does not specify
7121 an LDAP server. A server that is reached by TCP/IP can be specified in a query
7122 by starting it with
7123 .code
7124 ldap://<hostname>:<port>/...
7125 .endd
7126 If the port (and preceding colon) are omitted, the standard LDAP port (389) is
7127 used. When no server is specified in a query, a list of default servers is
7128 taken from the &%ldap_default_servers%& configuration option. This supplies a
7129 colon-separated list of servers which are tried in turn until one successfully
7130 handles a query, or there is a serious error. Successful handling either
7131 returns the requested data, or indicates that it does not exist. Serious errors
7132 are syntactical, or multiple values when only a single value is expected.
7133 Errors which cause the next server to be tried are connection failures, bind
7134 failures, and timeouts.
7135
7136 For each server name in the list, a port number can be given. The standard way
7137 of specifying a host and port is to use a colon separator (RFC 1738). Because
7138 &%ldap_default_servers%& is a colon-separated list, such colons have to be
7139 doubled. For example
7140 .code
7141 ldap_default_servers = ldap1.example.com::145:ldap2.example.com
7142 .endd
7143 If &%ldap_default_servers%& is unset, a URL with no server name is passed
7144 to the LDAP library with no server name, and the library's default (normally
7145 the local host) is used.
7146
7147 If you are using the OpenLDAP library, you can connect to an LDAP server using
7148 a Unix domain socket instead of a TCP/IP connection. This is specified by using
7149 &`ldapi`& instead of &`ldap`& in LDAP queries. What follows here applies only
7150 to OpenLDAP. If Exim is compiled with a different LDAP library, this feature is
7151 not available.
7152
7153 For this type of connection, instead of a host name for the server, a pathname
7154 for the socket is required, and the port number is not relevant. The pathname
7155 can be specified either as an item in &%ldap_default_servers%&, or inline in
7156 the query. In the former case, you can have settings such as
7157 .code
7158 ldap_default_servers = /tmp/ldap.sock : backup.ldap.your.domain
7159 .endd
7160 When the pathname is given in the query, you have to escape the slashes as
7161 &`%2F`& to fit in with the LDAP URL syntax. For example:
7162 .code
7163 ${lookup ldap {ldapi://%2Ftmp%2Fldap.sock/o=...
7164 .endd
7165 When Exim processes an LDAP lookup and finds that the &"hostname"& is really
7166 a pathname, it uses the Unix domain socket code, even if the query actually
7167 specifies &`ldap`& or &`ldaps`&. In particular, no encryption is used for a
7168 socket connection. This behaviour means that you can use a setting of
7169 &%ldap_default_servers%& such as in the example above with traditional &`ldap`&
7170 or &`ldaps`& queries, and it will work. First, Exim tries a connection via
7171 the Unix domain socket; if that fails, it tries a TCP/IP connection to the
7172 backup host.
7173
7174 If an explicit &`ldapi`& type is given in a query when a host name is
7175 specified, an error is diagnosed. However, if there are more items in
7176 &%ldap_default_servers%&, they are tried. In other words:
7177
7178 .ilist
7179 Using a pathname with &`ldap`& or &`ldaps`& forces the use of the Unix domain
7180 interface.
7181 .next
7182 Using &`ldapi`& with a host name causes an error.
7183 .endlist
7184
7185
7186 Using &`ldapi`& with no host or path in the query, and no setting of
7187 &%ldap_default_servers%&, does whatever the library does by default.
7188
7189
7190
7191 .section "LDAP authentication and control information" "SECID70"
7192 .cindex "LDAP" "authentication"
7193 The LDAP URL syntax provides no way of passing authentication and other control
7194 information to the server. To make this possible, the URL in an LDAP query may
7195 be preceded by any number of <&'name'&>=<&'value'&> settings, separated by
7196 spaces. If a value contains spaces it must be enclosed in double quotes, and
7197 when double quotes are used, backslash is interpreted in the usual way inside
7198 them. The following names are recognized:
7199 .display
7200 &`DEREFERENCE`&  set the dereferencing parameter
7201 &`NETTIME    `&  set a timeout for a network operation
7202 &`USER       `&  set the DN, for authenticating the LDAP bind
7203 &`PASS       `&  set the password, likewise
7204 &`REFERRALS  `&  set the referrals parameter
7205 &`SIZE       `&  set the limit for the number of entries returned
7206 &`TIME       `&  set the maximum waiting time for a query
7207 .endd
7208 The value of the DEREFERENCE parameter must be one of the words &"never"&,
7209 &"searching"&, &"finding"&, or &"always"&. The value of the REFERRALS parameter
7210 must be &"follow"& (the default) or &"nofollow"&. The latter stops the LDAP
7211 library from trying to follow referrals issued by the LDAP server.
7212
7213 The name CONNECT is an obsolete name for NETTIME, retained for
7214 backwards compatibility. This timeout (specified as a number of seconds) is
7215 enforced from the client end for operations that can be carried out over a
7216 network. Specifically, it applies to network connections and calls to the
7217 &'ldap_result()'& function. If the value is greater than zero, it is used if
7218 LDAP_OPT_NETWORK_TIMEOUT is defined in the LDAP headers (OpenLDAP), or
7219 if LDAP_X_OPT_CONNECT_TIMEOUT is defined in the LDAP headers (Netscape
7220 SDK 4.1). A value of zero forces an explicit setting of &"no timeout"& for
7221 Netscape SDK; for OpenLDAP no action is taken.
7222
7223 The TIME parameter (also a number of seconds) is passed to the server to
7224 set a server-side limit on the time taken to complete a search.
7225
7226
7227 Here is an example of an LDAP query in an Exim lookup that uses some of these
7228 values. This is a single line, folded to fit on the page:
7229 .code
7230 ${lookup ldap
7231   {user="cn=manager,o=University of Cambridge,c=UK" pass=secret
7232   ldap:///o=University%20of%20Cambridge,c=UK?sn?sub?(cn=foo)}
7233   {$value}fail}
7234 .endd
7235 The encoding of spaces as &`%20`& is a URL thing which should not be done for
7236 any of the auxiliary data. Exim configuration settings that include lookups
7237 which contain password information should be preceded by &"hide"& to prevent
7238 non-admin users from using the &%-bP%& option to see their values.
7239
7240 The auxiliary data items may be given in any order. The default is no
7241 connection timeout (the system timeout is used), no user or password, no limit
7242 on the number of entries returned, and no time limit on queries.
7243
7244 When a DN is quoted in the USER= setting for LDAP authentication, Exim
7245 removes any URL quoting that it may contain before passing it LDAP. Apparently
7246 some libraries do this for themselves, but some do not. Removing the URL
7247 quoting has two advantages:
7248
7249 .ilist
7250 It makes it possible to use the same &%quote_ldap_dn%& expansion for USER=
7251 DNs as with DNs inside actual queries.
7252 .next
7253 It permits spaces inside USER= DNs.
7254 .endlist
7255
7256 For example, a setting such as
7257 .code
7258 USER=cn=${quote_ldap_dn:$1}
7259 .endd
7260 should work even if &$1$& contains spaces.
7261
7262 Expanded data for the PASS= value should be quoted using the &%quote%&
7263 expansion operator, rather than the LDAP quote operators. The only reason this
7264 field needs quoting is to ensure that it conforms to the Exim syntax, which
7265 does not allow unquoted spaces. For example:
7266 .code
7267 PASS=${quote:$3}
7268 .endd
7269 The LDAP authentication mechanism can be used to check passwords as part of
7270 SMTP authentication. See the &%ldapauth%& expansion string condition in chapter
7271 &<<CHAPexpand>>&.
7272
7273
7274
7275 .section "Format of data returned by LDAP" "SECID71"
7276 .cindex "LDAP" "returned data formats"
7277 The &(ldapdn)& lookup type returns the Distinguished Name from a single entry
7278 as a sequence of values, for example
7279 .code
7280 cn=manager, o=University of Cambridge, c=UK
7281 .endd
7282 The &(ldap)& lookup type generates an error if more than one entry matches the
7283 search filter, whereas &(ldapm)& permits this case, and inserts a newline in
7284 the result between the data from different entries. It is possible for multiple
7285 values to be returned for both &(ldap)& and &(ldapm)&, but in the former case
7286 you know that whatever values are returned all came from a single entry in the
7287 directory.
7288
7289 In the common case where you specify a single attribute in your LDAP query, the
7290 result is not quoted, and does not contain the attribute name. If the attribute
7291 has multiple values, they are separated by commas.
7292
7293 If you specify multiple attributes, the result contains space-separated, quoted
7294 strings, each preceded by the attribute name and an equals sign. Within the
7295 quotes, the quote character, backslash, and newline are escaped with
7296 backslashes, and commas are used to separate multiple values for the attribute.
7297 Apart from the escaping, the string within quotes takes the same form as the
7298 output when a single attribute is requested. Specifying no attributes is the
7299 same as specifying all of an entry's attributes.
7300
7301 Here are some examples of the output format. The first line of each pair is an
7302 LDAP query, and the second is the data that is returned. The attribute called
7303 &%attr1%& has two values, whereas &%attr2%& has only one value:
7304 .code
7305 ldap:///o=base?attr1?sub?(uid=fred)
7306 value1.1, value1.2
7307
7308 ldap:///o=base?attr2?sub?(uid=fred)
7309 value two
7310
7311 ldap:///o=base?attr1,attr2?sub?(uid=fred)
7312 attr1="value1.1, value1.2" attr2="value two"
7313
7314 ldap:///o=base??sub?(uid=fred)
7315 objectClass="top" attr1="value1.1, value1.2" attr2="value two"
7316 .endd
7317 The &%extract%& operator in string expansions can be used to pick out
7318 individual fields from data that consists of &'key'&=&'value'& pairs. You can
7319 make use of Exim's &%-be%& option to run expansion tests and thereby check the
7320 results of LDAP lookups.
7321
7322
7323
7324
7325 .section "More about NIS+" "SECTnisplus"
7326 .cindex "NIS+ lookup type"
7327 .cindex "lookup" "NIS+"
7328 NIS+ queries consist of a NIS+ &'indexed name'& followed by an optional colon
7329 and field name. If this is given, the result of a successful query is the
7330 contents of the named field; otherwise the result consists of a concatenation
7331 of &'field-name=field-value'& pairs, separated by spaces. Empty values and
7332 values containing spaces are quoted. For example, the query
7333 .code
7334 [name=mg1456],passwd.org_dir
7335 .endd
7336 might return the string
7337 .code
7338 name=mg1456 passwd="" uid=999 gid=999 gcos="Martin Guerre"
7339 home=/home/mg1456 shell=/bin/bash shadow=""
7340 .endd
7341 (split over two lines here to fit on the page), whereas
7342 .code
7343 [name=mg1456],passwd.org_dir:gcos
7344 .endd
7345 would just return
7346 .code
7347 Martin Guerre
7348 .endd
7349 with no quotes. A NIS+ lookup fails if NIS+ returns more than one table entry
7350 for the given indexed key. The effect of the &%quote_nisplus%& expansion
7351 operator is to double any quote characters within the text.
7352
7353
7354
7355 .section "SQL lookups" "SECTsql"
7356 .cindex "SQL lookup types"
7357 .cindex "MySQL" "lookup type"
7358 .cindex "PostgreSQL lookup type"
7359 .cindex "lookup" "MySQL"
7360 .cindex "lookup" "PostgreSQL"
7361 .cindex "Oracle" "lookup type"
7362 .cindex "lookup" "Oracle"
7363 .cindex "InterBase lookup type"
7364 .cindex "lookup" "InterBase"
7365 Exim can support lookups in InterBase, MySQL, Oracle, PostgreSQL, and SQLite
7366 databases. Queries for these databases contain SQL statements, so an example
7367 might be
7368 .code
7369 ${lookup mysql{select mailbox from users where id='userx'}\
7370   {$value}fail}
7371 .endd
7372 If the result of the query contains more than one field, the data for each
7373 field in the row is returned, preceded by its name, so the result of
7374 .code
7375 ${lookup pgsql{select home,name from users where id='userx'}\
7376   {$value}}
7377 .endd
7378 might be
7379 .code
7380 home=/home/userx name="Mister X"
7381 .endd
7382 Empty values and values containing spaces are double quoted, with embedded
7383 quotes escaped by a backslash. If the result of the query contains just one
7384 field, the value is passed back verbatim, without a field name, for example:
7385 .code
7386 Mister X
7387 .endd
7388 If the result of the query yields more than one row, it is all concatenated,
7389 with a newline between the data for each row.
7390
7391
7392 .section "More about MySQL, PostgreSQL, Oracle, and InterBase" "SECID72"
7393 .cindex "MySQL" "lookup type"
7394 .cindex "PostgreSQL lookup type"
7395 .cindex "lookup" "MySQL"
7396 .cindex "lookup" "PostgreSQL"
7397 .cindex "Oracle" "lookup type"
7398 .cindex "lookup" "Oracle"
7399 .cindex "InterBase lookup type"
7400 .cindex "lookup" "InterBase"
7401 If any MySQL, PostgreSQL, Oracle, or InterBase lookups are used, the
7402 &%mysql_servers%&, &%pgsql_servers%&, &%oracle_servers%&, or &%ibase_servers%&
7403 option (as appropriate) must be set to a colon-separated list of server
7404 information.
7405 (For MySQL and PostgreSQL only, the global option need not be set if all
7406 queries contain their own server information &-- see section
7407 &<<SECTspeserque>>&.) Each item in the list is a slash-separated list of four
7408 items: host name, database name, user name, and password. In the case of
7409 Oracle, the host name field is used for the &"service name"&, and the database
7410 name field is not used and should be empty. For example:
7411 .code
7412 hide oracle_servers = oracle.plc.example//userx/abcdwxyz
7413 .endd
7414 Because password data is sensitive, you should always precede the setting with
7415 &"hide"&, to prevent non-admin users from obtaining the setting via the &%-bP%&
7416 option. Here is an example where two MySQL servers are listed:
7417 .code
7418 hide mysql_servers = localhost/users/root/secret:\
7419                      otherhost/users/root/othersecret
7420 .endd
7421 For MySQL and PostgreSQL, a host may be specified as <&'name'&>:<&'port'&> but
7422 because this is a colon-separated list, the colon has to be doubled. For each
7423 query, these parameter groups are tried in order until a connection is made and
7424 a query is successfully processed. The result of a query may be that no data is
7425 found, but that is still a successful query. In other words, the list of
7426 servers provides a backup facility, not a list of different places to look.
7427
7428 The &%quote_mysql%&, &%quote_pgsql%&, and &%quote_oracle%& expansion operators
7429 convert newline, tab, carriage return, and backspace to \n, \t, \r, and \b
7430 respectively, and the characters single-quote, double-quote, and backslash
7431 itself are escaped with backslashes. The &%quote_pgsql%& expansion operator, in
7432 addition, escapes the percent and underscore characters. This cannot be done
7433 for MySQL because these escapes are not recognized in contexts where these
7434 characters are not special.
7435
7436 .section "Specifying the server in the query" "SECTspeserque"
7437 For MySQL and PostgreSQL lookups (but not currently for Oracle and InterBase),
7438 it is possible to specify a list of servers with an individual query. This is
7439 done by starting the query with
7440 .display
7441 &`servers=`&&'server1:server2:server3:...'&&`;`&
7442 .endd
7443 Each item in the list may take one of two forms:
7444 .olist
7445 If it contains no slashes it is assumed to be just a host name. The appropriate
7446 global option (&%mysql_servers%& or &%pgsql_servers%&) is searched for a host
7447 of the same name, and the remaining parameters (database, user, password) are
7448 taken from there.
7449 .next
7450 If it contains any slashes, it is taken as a complete parameter set.
7451 .endlist
7452 The list of servers is used in exactly the same way as the global list.
7453 Once a connection to a server has happened and a query has been
7454 successfully executed, processing of the lookup ceases.
7455
7456 This feature is intended for use in master/slave situations where updates
7457 are occurring and you want to update the master rather than a slave. If the
7458 master is in the list as a backup for reading, you might have a global setting
7459 like this:
7460 .code
7461 mysql_servers = slave1/db/name/pw:\
7462                 slave2/db/name/pw:\
7463                 master/db/name/pw
7464 .endd
7465 In an updating lookup, you could then write:
7466 .code
7467 ${lookup mysql{servers=master; UPDATE ...} }
7468 .endd
7469 That query would then be sent only to the master server. If, on the other hand,
7470 the master is not to be used for reading, and so is not present in the global
7471 option, you can still update it by a query of this form:
7472 .code
7473 ${lookup pgsql{servers=master/db/name/pw; UPDATE ...} }
7474 .endd
7475
7476
7477 .section "Special MySQL features" "SECID73"
7478 For MySQL, an empty host name or the use of &"localhost"& in &%mysql_servers%&
7479 causes a connection to the server on the local host by means of a Unix domain
7480 socket. An alternate socket can be specified in parentheses. The full syntax of
7481 each item in &%mysql_servers%& is:
7482 .display
7483 <&'hostname'&>::<&'port'&>(<&'socket name'&>)/<&'database'&>/&&&
7484   <&'user'&>/<&'password'&>
7485 .endd
7486 Any of the three sub-parts of the first field can be omitted. For normal use on
7487 the local host it can be left blank or set to just &"localhost"&.
7488
7489 No database need be supplied &-- but if it is absent here, it must be given in
7490 the queries.
7491
7492 If a MySQL query is issued that does not request any data (an insert, update,
7493 or delete command), the result of the lookup is the number of rows affected.
7494
7495 &*Warning*&: This can be misleading. If an update does not actually change
7496 anything (for example, setting a field to the value it already has), the result
7497 is zero because no rows are affected.
7498
7499
7500 .section "Special PostgreSQL features" "SECID74"
7501 PostgreSQL lookups can also use Unix domain socket connections to the database.
7502 This is usually faster and costs less CPU time than a TCP/IP connection.
7503 However it can be used only if the mail server runs on the same machine as the
7504 database server. A configuration line for PostgreSQL via Unix domain sockets
7505 looks like this:
7506 .code
7507 hide pgsql_servers = (/tmp/.s.PGSQL.5432)/db/user/password : ...
7508 .endd
7509 In other words, instead of supplying a host name, a path to the socket is
7510 given. The path name is enclosed in parentheses so that its slashes aren't
7511 visually confused with the delimiters for the other server parameters.
7512
7513 If a PostgreSQL query is issued that does not request any data (an insert,
7514 update, or delete command), the result of the lookup is the number of rows
7515 affected.
7516
7517 .section "More about SQLite" "SECTsqlite"
7518 .cindex "lookup" "SQLite"
7519 .cindex "sqlite lookup type"
7520 SQLite is different to the other SQL lookups because a file name is required in
7521 addition to the SQL query. An SQLite database is a single file, and there is no
7522 daemon as in the other SQL databases. The interface to Exim requires the name
7523 of the file, as an absolute path, to be given at the start of the query. It is
7524 separated from the query by white space. This means that the path name cannot
7525 contain white space. Here is a lookup expansion example:
7526 .code
7527 ${lookup sqlite {/some/thing/sqlitedb \
7528   select name from aliases where id='userx';}}
7529 .endd
7530 In a list, the syntax is similar. For example:
7531 .code
7532 domainlist relay_to_domains = sqlite;/some/thing/sqlitedb \
7533    select * from relays where ip='$sender_host_address';
7534 .endd
7535 The only character affected by the &%quote_sqlite%& operator is a single
7536 quote, which it doubles.
7537
7538 The SQLite library handles multiple simultaneous accesses to the database
7539 internally. Multiple readers are permitted, but only one process can
7540 update at once. Attempts to access the database while it is being updated
7541 are rejected after a timeout period, during which the SQLite library
7542 waits for the lock to be released. In Exim, the default timeout is set
7543 to 5 seconds, but it can be changed by means of the &%sqlite_lock_timeout%&
7544 option.
7545 .ecindex IIDfidalo1
7546 .ecindex IIDfidalo2
7547
7548
7549 . ////////////////////////////////////////////////////////////////////////////
7550 . ////////////////////////////////////////////////////////////////////////////
7551
7552 .chapter "Domain, host, address, and local part lists" &&&
7553          "CHAPdomhosaddlists" &&&
7554          "Domain, host, and address lists"
7555 .scindex IIDdohoadli "lists of domains; hosts; etc."
7556 A number of Exim configuration options contain lists of domains, hosts,
7557 email addresses, or local parts. For example, the &%hold_domains%& option
7558 contains a list of domains whose delivery is currently suspended. These lists
7559 are also used as data in ACL statements (see chapter &<<CHAPACL>>&), and as
7560 arguments to expansion conditions such as &%match_domain%&.
7561
7562 Each item in one of these lists is a pattern to be matched against a domain,
7563 host, email address, or local part, respectively. In the sections below, the
7564 different types of pattern for each case are described, but first we cover some
7565 general facilities that apply to all four kinds of list.
7566
7567
7568
7569 .section "Expansion of lists" "SECID75"
7570 .cindex "expansion" "of lists"
7571 Each list is expanded as a single string before it is used. The result of
7572 expansion must be a list, possibly containing empty items, which is split up
7573 into separate items for matching. By default, colon is the separator character,
7574 but this can be varied if necessary. See sections &<<SECTlistconstruct>>& and
7575 &<<SECTempitelis>>& for details of the list syntax; the second of these
7576 discusses the way to specify empty list items.
7577
7578
7579 If the string expansion is forced to fail, Exim behaves as if the item it is
7580 testing (domain, host, address, or local part) is not in the list. Other
7581 expansion failures cause temporary errors.
7582
7583 If an item in a list is a regular expression, backslashes, dollars and possibly
7584 other special characters in the expression must be protected against
7585 misinterpretation by the string expander. The easiest way to do this is to use
7586 the &`\N`& expansion feature to indicate that the contents of the regular
7587 expression should not be expanded. For example, in an ACL you might have:
7588 .code
7589 deny senders = \N^\d{8}\w@.*\.baddomain\.example$\N : \
7590                ${lookup{$domain}lsearch{/badsenders/bydomain}}
7591 .endd
7592 The first item is a regular expression that is protected from expansion by
7593 &`\N`&, whereas the second uses the expansion to obtain a list of unwanted
7594 senders based on the receiving domain.
7595
7596
7597
7598
7599 .section "Negated items in lists" "SECID76"
7600 .cindex "list" "negation"
7601 .cindex "negation" "in lists"
7602 Items in a list may be positive or negative. Negative items are indicated by a
7603 leading exclamation mark, which may be followed by optional white space. A list
7604 defines a set of items (domains, etc). When Exim processes one of these lists,
7605 it is trying to find out whether a domain, host, address, or local part
7606 (respectively) is in the set that is defined by the list. It works like this:
7607
7608 The list is scanned from left to right. If a positive item is matched, the
7609 subject that is being checked is in the set; if a negative item is matched, the
7610 subject is not in the set. If the end of the list is reached without the
7611 subject having matched any of the patterns, it is in the set if the last item
7612 was a negative one, but not if it was a positive one. For example, the list in
7613 .code
7614 domainlist relay_to_domains = !a.b.c : *.b.c
7615 .endd
7616 matches any domain ending in &'.b.c'& except for &'a.b.c'&. Domains that match
7617 neither &'a.b.c'& nor &'*.b.c'& do not match, because the last item in the
7618 list is positive. However, if the setting were
7619 .code
7620 domainlist relay_to_domains = !a.b.c
7621 .endd
7622 then all domains other than &'a.b.c'& would match because the last item in the
7623 list is negative. In other words, a list that ends with a negative item behaves
7624 as if it had an extra item &`:*`& on the end.
7625
7626 Another way of thinking about positive and negative items in lists is to read
7627 the connector as &"or"& after a positive item and as &"and"& after a negative
7628 item.
7629
7630
7631
7632 .section "File names in lists" "SECTfilnamlis"
7633 .cindex "list" "file name in"
7634 If an item in a domain, host, address, or local part list is an absolute file
7635 name (beginning with a slash character), each line of the file is read and
7636 processed as if it were an independent item in the list, except that further
7637 file names are not allowed,
7638 and no expansion of the data from the file takes place.
7639 Empty lines in the file are ignored, and the file may also contain comment
7640 lines:
7641
7642 .ilist
7643 For domain and host lists, if a # character appears anywhere in a line of the
7644 file, it and all following characters are ignored.
7645 .next
7646 Because local parts may legitimately contain # characters, a comment in an
7647 address list or local part list file is recognized only if # is preceded by
7648 white space or the start of the line. For example:
7649 .code
7650 not#comment@x.y.z   # but this is a comment
7651 .endd
7652 .endlist
7653
7654 Putting a file name in a list has the same effect as inserting each line of the
7655 file as an item in the list (blank lines and comments excepted). However, there
7656 is one important difference: the file is read each time the list is processed,
7657 so if its contents vary over time, Exim's behaviour changes.
7658
7659 If a file name is preceded by an exclamation mark, the sense of any match
7660 within the file is inverted. For example, if
7661 .code
7662 hold_domains = !/etc/nohold-domains
7663 .endd
7664 and the file contains the lines
7665 .code
7666 !a.b.c
7667 *.b.c
7668 .endd
7669 then &'a.b.c'& is in the set of domains defined by &%hold_domains%&, whereas
7670 any domain matching &`*.b.c`& is not.
7671
7672
7673
7674 .section "An lsearch file is not an out-of-line list" "SECID77"
7675 As will be described in the sections that follow, lookups can be used in lists
7676 to provide indexed methods of checking list membership. There has been some
7677 confusion about the way &(lsearch)& lookups work in lists. Because
7678 an &(lsearch)& file contains plain text and is scanned sequentially, it is
7679 sometimes thought that it is allowed to contain wild cards and other kinds of
7680 non-constant pattern. This is not the case. The keys in an &(lsearch)& file are
7681 always fixed strings, just as for any other single-key lookup type.
7682
7683 If you want to use a file to contain wild-card patterns that form part of a
7684 list, just give the file name on its own, without a search type, as described
7685 in the previous section. You could also use the &(wildlsearch)& or
7686 &(nwildlsearch)&, but there is no advantage in doing this.
7687
7688
7689
7690
7691 .section "Named lists" "SECTnamedlists"
7692 .cindex "named lists"
7693 .cindex "list" "named"
7694 A list of domains, hosts, email addresses, or local parts can be given a name
7695 which is then used to refer to the list elsewhere in the configuration. This is
7696 particularly convenient if the same list is required in several different
7697 places. It also allows lists to be given meaningful names, which can improve
7698 the readability of the configuration. For example, it is conventional to define
7699 a domain list called &'local_domains'& for all the domains that are handled
7700 locally on a host, using a configuration line such as
7701 .code
7702 domainlist local_domains = localhost:my.dom.example
7703 .endd
7704 Named lists are referenced by giving their name preceded by a plus sign, so,
7705 for example, a router that is intended to handle local domains would be
7706 configured with the line
7707 .code
7708 domains = +local_domains
7709 .endd
7710 The first router in a configuration is often one that handles all domains
7711 except the local ones, using a configuration with a negated item like this:
7712 .code
7713 dnslookup:
7714   driver = dnslookup
7715   domains = ! +local_domains
7716   transport = remote_smtp
7717   no_more
7718 .endd
7719 The four kinds of named list are created by configuration lines starting with
7720 the words &%domainlist%&, &%hostlist%&, &%addresslist%&, or &%localpartlist%&,
7721 respectively. Then there follows the name that you are defining, followed by an
7722 equals sign and the list itself. For example:
7723 .code
7724 hostlist    relay_from_hosts = 192.168.23.0/24 : my.friend.example
7725 addresslist bad_senders = cdb;/etc/badsenders
7726 .endd
7727 A named list may refer to other named lists:
7728 .code
7729 domainlist  dom1 = first.example : second.example
7730 domainlist  dom2 = +dom1 : third.example
7731 domainlist  dom3 = fourth.example : +dom2 : fifth.example
7732 .endd
7733 &*Warning*&: If the last item in a referenced list is a negative one, the
7734 effect may not be what you intended, because the negation does not propagate
7735 out to the higher level. For example, consider:
7736 .code
7737 domainlist  dom1 = !a.b
7738 domainlist  dom2 = +dom1 : *.b
7739 .endd
7740 The second list specifies &"either in the &%dom1%& list or &'*.b'&"&. The first
7741 list specifies just &"not &'a.b'&"&, so the domain &'x.y'& matches it. That
7742 means it matches the second list as well. The effect is not the same as
7743 .code
7744 domainlist  dom2 = !a.b : *.b
7745 .endd
7746 where &'x.y'& does not match. It's best to avoid negation altogether in
7747 referenced lists if you can.
7748
7749 Named lists may have a performance advantage. When Exim is routing an
7750 address or checking an incoming message, it caches the result of tests on named
7751 lists. So, if you have a setting such as
7752 .code
7753 domains = +local_domains
7754 .endd
7755 on several of your routers
7756 or in several ACL statements,
7757 the actual test is done only for the first one. However, the caching works only
7758 if there are no expansions within the list itself or any sublists that it
7759 references. In other words, caching happens only for lists that are known to be
7760 the same each time they are referenced.
7761
7762 By default, there may be up to 16 named lists of each type. This limit can be
7763 extended by changing a compile-time variable. The use of domain and host lists
7764 is recommended for concepts such as local domains, relay domains, and relay
7765 hosts. The default configuration is set up like this.
7766
7767
7768
7769 .section "Named lists compared with macros" "SECID78"
7770 .cindex "list" "named compared with macro"
7771 .cindex "macro" "compared with named list"
7772 At first sight, named lists might seem to be no different from macros in the
7773 configuration file. However, macros are just textual substitutions. If you
7774 write
7775 .code
7776 ALIST = host1 : host2
7777 auth_advertise_hosts = !ALIST
7778 .endd
7779 it probably won't do what you want, because that is exactly the same as
7780 .code
7781 auth_advertise_hosts = !host1 : host2
7782 .endd
7783 Notice that the second host name is not negated. However, if you use a host
7784 list, and write
7785 .code
7786 hostlist alist = host1 : host2
7787 auth_advertise_hosts = ! +alist
7788 .endd
7789 the negation applies to the whole list, and so that is equivalent to
7790 .code
7791 auth_advertise_hosts = !host1 : !host2
7792 .endd
7793
7794
7795 .section "Named list caching" "SECID79"
7796 .cindex "list" "caching of named"
7797 .cindex "caching" "named lists"
7798 While processing a message, Exim caches the result of checking a named list if
7799 it is sure that the list is the same each time. In practice, this means that
7800 the cache operates only if the list contains no $ characters, which guarantees
7801 that it will not change when it is expanded. Sometimes, however, you may have
7802 an expanded list that you know will be the same each time within a given
7803 message. For example:
7804 .code
7805 domainlist special_domains = \
7806            ${lookup{$sender_host_address}cdb{/some/file}}
7807 .endd
7808 This provides a list of domains that depends only on the sending host's IP
7809 address. If this domain list is referenced a number of times (for example,
7810 in several ACL lines, or in several routers) the result of the check is not
7811 cached by default, because Exim does not know that it is going to be the
7812 same list each time.
7813
7814 By appending &`_cache`& to &`domainlist`& you can tell Exim to go ahead and
7815 cache the result anyway. For example:
7816 .code
7817 domainlist_cache special_domains = ${lookup{...
7818 .endd
7819 If you do this, you should be absolutely sure that caching is going to do
7820 the right thing in all cases. When in doubt, leave it out.
7821
7822
7823
7824 .section "Domain lists" "SECTdomainlist"
7825 .cindex "domain list" "patterns for"
7826 .cindex "list" "domain list"
7827 Domain lists contain patterns that are to be matched against a mail domain.
7828 The following types of item may appear in domain lists:
7829
7830 .ilist
7831 .cindex "primary host name"
7832 .cindex "host name" "matched in domain list"
7833 .oindex "&%primary_hostname%&"
7834 .cindex "domain list" "matching primary host name"
7835 .cindex "@ in a domain list"
7836 If a pattern consists of a single @ character, it matches the local host name,
7837 as set by the &%primary_hostname%& option (or defaulted). This makes it
7838 possible to use the same configuration file on several different hosts that
7839 differ only in their names.
7840 .next
7841 .cindex "@[] in a domain list"
7842 .cindex "domain list" "matching local IP interfaces"
7843 .cindex "domain literal"
7844 If a pattern consists of the string &`@[]`& it matches an IP address enclosed
7845 in square brackets (as in an email address that contains a domain literal), but
7846 only if that IP address is recognized as local for email routing purposes. The
7847 &%local_interfaces%& and &%extra_local_interfaces%& options can be used to
7848 control which of a host's several IP addresses are treated as local.
7849 In today's Internet, the use of domain literals is controversial.
7850 .next
7851 .cindex "@mx_any"
7852 .cindex "@mx_primary"
7853 .cindex "@mx_secondary"
7854 .cindex "domain list" "matching MX pointers to local host"
7855 If a pattern consists of the string &`@mx_any`& it matches any domain that
7856 has an MX record pointing to the local host or to any host that is listed in
7857 .oindex "&%hosts_treat_as_local%&"
7858 &%hosts_treat_as_local%&. The items &`@mx_primary`& and &`@mx_secondary`&
7859 are similar, except that the first matches only when a primary MX target is the
7860 local host, and the second only when no primary MX target is the local host,
7861 but a secondary MX target is. &"Primary"& means an MX record with the lowest
7862 preference value &-- there may of course be more than one of them.
7863
7864 The MX lookup that takes place when matching a pattern of this type is
7865 performed with the resolver options for widening names turned off. Thus, for
7866 example, a single-component domain will &'not'& be expanded by adding the
7867 resolver's default domain. See the &%qualify_single%& and &%search_parents%&
7868 options of the &(dnslookup)& router for a discussion of domain widening.
7869
7870 Sometimes you may want to ignore certain IP addresses when using one of these
7871 patterns. You can specify this by following the pattern with &`/ignore=`&<&'ip
7872 list'&>, where <&'ip list'&> is a list of IP addresses. These addresses are
7873 ignored when processing the pattern (compare the &%ignore_target_hosts%& option
7874 on a router). For example:
7875 .code
7876 domains = @mx_any/ignore=127.0.0.1
7877 .endd
7878 This example matches any domain that has an MX record pointing to one of
7879 the local host's IP addresses other than 127.0.0.1.
7880
7881 The list of IP addresses is in fact processed by the same code that processes
7882 host lists, so it may contain CIDR-coded network specifications and it may also
7883 contain negative items.
7884
7885 Because the list of IP addresses is a sublist within a domain list, you have to
7886 be careful about delimiters if there is more than one address. Like any other
7887 list, the default delimiter can be changed. Thus, you might have:
7888 .code
7889 domains = @mx_any/ignore=<;127.0.0.1;0.0.0.0 : \
7890           an.other.domain : ...
7891 .endd
7892 so that the sublist uses semicolons for delimiters. When IPv6 addresses are
7893 involved, it is easiest to change the delimiter for the main list as well:
7894 .code
7895 domains = <? @mx_any/ignore=<;127.0.0.1;::1 ? \
7896           an.other.domain ? ...
7897 .endd
7898 .next
7899 .cindex "asterisk" "in domain list"
7900 .cindex "domain list" "asterisk in"
7901 .cindex "domain list" "matching &""ends with""&"
7902 If a pattern starts with an asterisk, the remaining characters of the pattern
7903 are compared with the terminating characters of the domain. The use of &"*"& in
7904 domain lists differs from its use in partial matching lookups. In a domain
7905 list, the character following the asterisk need not be a dot, whereas partial
7906 matching works only in terms of dot-separated components. For example, a domain
7907 list item such as &`*key.ex`& matches &'donkey.ex'& as well as
7908 &'cipher.key.ex'&.
7909
7910 .next
7911 .cindex "regular expressions" "in domain list"
7912 .cindex "domain list" "matching regular expression"
7913 If a pattern starts with a circumflex character, it is treated as a regular
7914 expression, and matched against the domain using a regular expression matching
7915 function. The circumflex is treated as part of the regular expression.
7916 Email domains are case-independent, so this regular expression match is by
7917 default case-independent, but you can make it case-dependent by starting it
7918 with &`(?-i)`&. References to descriptions of the syntax of regular expressions
7919 are given in chapter &<<CHAPregexp>>&.
7920
7921 &*Warning*&: Because domain lists are expanded before being processed, you
7922 must escape any backslash and dollar characters in the regular expression, or
7923 use the special &`\N`& sequence (see chapter &<<CHAPexpand>>&) to specify that
7924 it is not to be expanded (unless you really do want to build a regular
7925 expression by expansion, of course).
7926 .next
7927 .cindex "lookup" "in domain list"
7928 .cindex "domain list" "matching by lookup"
7929 If a pattern starts with the name of a single-key lookup type followed by a
7930 semicolon (for example, &"dbm;"& or &"lsearch;"&), the remainder of the pattern
7931 must be a file name in a suitable format for the lookup type. For example, for
7932 &"cdb;"& it must be an absolute path:
7933 .code
7934 domains = cdb;/etc/mail/local_domains.cdb
7935 .endd
7936 The appropriate type of lookup is done on the file using the domain name as the
7937 key. In most cases, the data that is looked up is not used; Exim is interested
7938 only in whether or not the key is present in the file. However, when a lookup
7939 is used for the &%domains%& option on a router
7940 or a &%domains%& condition in an ACL statement, the data is preserved in the
7941 &$domain_data$& variable and can be referred to in other router options or
7942 other statements in the same ACL.
7943
7944 .next
7945 Any of the single-key lookup type names may be preceded by
7946 &`partial`&<&'n'&>&`-`&, where the <&'n'&> is optional, for example,
7947 .code
7948 domains = partial-dbm;/partial/domains
7949 .endd
7950 This causes partial matching logic to be invoked; a description of how this
7951 works is given in section &<<SECTpartiallookup>>&.
7952
7953 .next
7954 .cindex "asterisk" "in lookup type"
7955 Any of the single-key lookup types may be followed by an asterisk. This causes
7956 a default lookup for a key consisting of a single asterisk to be done if the
7957 original lookup fails. This is not a useful feature when using a domain list to
7958 select particular domains (because any domain would match), but it might have
7959 value if the result of the lookup is being used via the &$domain_data$&
7960 expansion variable.
7961 .next
7962 If the pattern starts with the name of a query-style lookup type followed by a
7963 semicolon (for example, &"nisplus;"& or &"ldap;"&), the remainder of the
7964 pattern must be an appropriate query for the lookup type, as described in
7965 chapter &<<CHAPfdlookup>>&. For example:
7966 .code
7967 hold_domains = mysql;select domain from holdlist \
7968   where domain = '${quote_mysql:$domain}';
7969 .endd
7970 In most cases, the data that is looked up is not used (so for an SQL query, for
7971 example, it doesn't matter what field you select). Exim is interested only in
7972 whether or not the query succeeds. However, when a lookup is used for the
7973 &%domains%& option on a router, the data is preserved in the &$domain_data$&
7974 variable and can be referred to in other options.
7975 .next
7976 .cindex "domain list" "matching literal domain name"
7977 If none of the above cases apply, a caseless textual comparison is made
7978 between the pattern and the domain.
7979 .endlist
7980
7981 Here is an example that uses several different kinds of pattern:
7982 .code
7983 domainlist funny_domains = \
7984   @ : \
7985   lib.unseen.edu : \
7986   *.foundation.fict.example : \
7987   \N^[1-2]\d{3}\.fict\.example$\N : \
7988   partial-dbm;/opt/data/penguin/book : \
7989   nis;domains.byname : \
7990   nisplus;[name=$domain,status=local],domains.org_dir
7991 .endd
7992 There are obvious processing trade-offs among the various matching modes. Using
7993 an asterisk is faster than a regular expression, and listing a few names
7994 explicitly probably is too. The use of a file or database lookup is expensive,
7995 but may be the only option if hundreds of names are required. Because the
7996 patterns are tested in order, it makes sense to put the most commonly matched
7997 patterns earlier.
7998
7999
8000
8001 .section "Host lists" "SECThostlist"
8002 .cindex "host list" "patterns in"
8003 .cindex "list" "host list"
8004 Host lists are used to control what remote hosts are allowed to do. For
8005 example, some hosts may be allowed to use the local host as a relay, and some
8006 may be permitted to use the SMTP ETRN command. Hosts can be identified in
8007 two different ways, by name or by IP address. In a host list, some types of
8008 pattern are matched to a host name, and some are matched to an IP address.
8009 You need to be particularly careful with this when single-key lookups are
8010 involved, to ensure that the right value is being used as the key.
8011
8012
8013 .section "Special host list patterns" "SECID80"
8014 .cindex "empty item in hosts list"
8015 .cindex "host list" "empty string in"
8016 If a host list item is the empty string, it matches only when no remote host is
8017 involved. This is the case when a message is being received from a local
8018 process using SMTP on the standard input, that is, when a TCP/IP connection is
8019 not used.
8020
8021 .cindex "asterisk" "in host list"
8022 The special pattern &"*"& in a host list matches any host or no host. Neither
8023 the IP address nor the name is actually inspected.
8024
8025
8026
8027 .section "Host list patterns that match by IP address" "SECThoslispatip"
8028 .cindex "host list" "matching IP addresses"
8029 If an IPv4 host calls an IPv6 host and the call is accepted on an IPv6 socket,
8030 the incoming address actually appears in the IPv6 host as
8031 &`::ffff:`&<&'v4address'&>. When such an address is tested against a host
8032 list, it is converted into a traditional IPv4 address first. (Not all operating
8033 systems accept IPv4 calls on IPv6 sockets, as there have been some security
8034 concerns.)
8035
8036 The following types of pattern in a host list check the remote host by
8037 inspecting its IP address:
8038
8039 .ilist
8040 If the pattern is a plain domain name (not a regular expression, not starting
8041 with *, not a lookup of any kind), Exim calls the operating system function
8042 to find the associated IP address(es). Exim uses the newer
8043 &[getipnodebyname()]& function when available, otherwise &[gethostbyname()]&.
8044 This typically causes a forward DNS lookup of the name. The result is compared
8045 with the IP address of the subject host.
8046
8047 If there is a temporary problem (such as a DNS timeout) with the host name
8048 lookup, a temporary error occurs. For example, if the list is being used in an
8049 ACL condition, the ACL gives a &"defer"& response, usually leading to a
8050 temporary SMTP error code. If no IP address can be found for the host name,
8051 what happens is described in section &<<SECTbehipnot>>& below.
8052
8053 .next
8054 .cindex "@ in a host list"
8055 If the pattern is &"@"&, the primary host name is substituted and used as a
8056 domain name, as just described.
8057
8058 .next
8059 If the pattern is an IP address, it is matched against the IP address of the
8060 subject host. IPv4 addresses are given in the normal &"dotted-quad"& notation.
8061 IPv6 addresses can be given in colon-separated format, but the colons have to
8062 be doubled so as not to be taken as item separators when the default list
8063 separator is used. IPv6 addresses are recognized even when Exim is compiled
8064 without IPv6 support. This means that if they appear in a host list on an
8065 IPv4-only host, Exim will not treat them as host names. They are just addresses
8066 that can never match a client host.
8067
8068 .next
8069 .cindex "@[] in a host list"
8070 If the pattern is &"@[]"&, it matches the IP address of any IP interface on
8071 the local host. For example, if the local host is an IPv4 host with one
8072 interface address 10.45.23.56, these two ACL statements have the same effect:
8073 .code
8074 accept hosts = 127.0.0.1 : 10.45.23.56
8075 accept hosts = @[]
8076 .endd
8077 .next
8078 .cindex "CIDR notation"
8079 If the pattern is an IP address followed by a slash and a mask length (for
8080 example 10.11.42.0/24), it is matched against the IP address of the subject
8081 host under the given mask. This allows, an entire network of hosts to be
8082 included (or excluded) by a single item. The mask uses CIDR notation; it
8083 specifies the number of address bits that must match, starting from the most
8084 significant end of the address.
8085
8086 &*Note*&: The mask is &'not'& a count of addresses, nor is it the high number
8087 of a range of addresses. It is the number of bits in the network portion of the
8088 address. The above example specifies a 24-bit netmask, so it matches all 256
8089 addresses in the 10.11.42.0 network. An item such as
8090 .code
8091 192.168.23.236/31
8092 .endd
8093 matches just two addresses, 192.168.23.236 and 192.168.23.237. A mask value of
8094 32 for an IPv4 address is the same as no mask at all; just a single address
8095 matches.
8096
8097 Here is another example which shows an IPv4 and an IPv6 network:
8098 .code
8099 recipient_unqualified_hosts = 192.168.0.0/16: \
8100                               3ffe::ffff::836f::::/48
8101 .endd
8102 The doubling of list separator characters applies only when these items
8103 appear inline in a host list. It is not required when indirecting via a file.
8104 For example:
8105 .code
8106 recipient_unqualified_hosts = /opt/exim/unqualnets
8107 .endd
8108 could make use of a file containing
8109 .code
8110 172.16.0.0/12
8111 3ffe:ffff:836f::/48
8112 .endd
8113 to have exactly the same effect as the previous example. When listing IPv6
8114 addresses inline, it is usually more convenient to use the facility for
8115 changing separator characters. This list contains the same two networks:
8116 .code
8117 recipient_unqualified_hosts = <; 172.16.0.0/12; \
8118                                  3ffe:ffff:836f::/48
8119 .endd
8120 The separator is changed to semicolon by the leading &"<;"& at the start of the
8121 list.
8122 .endlist
8123
8124
8125
8126 .section "Host list patterns for single-key lookups by host address" &&&
8127          "SECThoslispatsikey"
8128 .cindex "host list" "lookup of IP address"
8129 When a host is to be identified by a single-key lookup of its complete IP
8130 address, the pattern takes this form:
8131 .display
8132 &`net-<`&&'single-key-search-type'&&`>;<`&&'search-data'&&`>`&
8133 .endd
8134 For example:
8135 .code
8136 hosts_lookup = net-cdb;/hosts-by-ip.db
8137 .endd
8138 The text form of the IP address of the subject host is used as the lookup key.
8139 IPv6 addresses are converted to an unabbreviated form, using lower case
8140 letters, with dots as separators because colon is the key terminator in
8141 &(lsearch)& files. [Colons can in fact be used in keys in &(lsearch)& files by
8142 quoting the keys, but this is a facility that was added later.] The data
8143 returned by the lookup is not used.
8144
8145 .cindex "IP address" "masking"
8146 .cindex "host list" "masked IP address"
8147 Single-key lookups can also be performed using masked IP addresses, using
8148 patterns of this form:
8149 .display
8150 &`net<`&&'number'&&`>-<`&&'single-key-search-type'&&`>;<`&&'search-data'&&`>`&
8151 .endd
8152 For example:
8153 .code
8154 net24-dbm;/networks.db
8155 .endd
8156 The IP address of the subject host is masked using <&'number'&> as the mask
8157 length. A textual string is constructed from the masked value, followed by the
8158 mask, and this is used as the lookup key. For example, if the host's IP address
8159 is 192.168.34.6, the key that is looked up for the above example is
8160 &"192.168.34.0/24"&.
8161
8162 When an IPv6 address is converted to a string, dots are normally used instead
8163 of colons, so that keys in &(lsearch)& files need not contain colons (which
8164 terminate &(lsearch)& keys). This was implemented some time before the ability
8165 to quote keys was made available in &(lsearch)& files. However, the more
8166 recently implemented &(iplsearch)& files do require colons in IPv6 keys
8167 (notated using the quoting facility) so as to distinguish them from IPv4 keys.
8168 For this reason, when the lookup type is &(iplsearch)&, IPv6 addresses are
8169 converted using colons and not dots. In all cases, full, unabbreviated IPv6
8170 addresses are always used.
8171
8172 Ideally, it would be nice to tidy up this anomalous situation by changing to
8173 colons in all cases, given that quoting is now available for &(lsearch)&.
8174 However, this would be an incompatible change that might break some existing
8175 configurations.
8176
8177 &*Warning*&: Specifying &%net32-%& (for an IPv4 address) or &%net128-%& (for an
8178 IPv6 address) is not the same as specifying just &%net-%& without a number. In
8179 the former case the key strings include the mask value, whereas in the latter
8180 case the IP address is used on its own.
8181
8182
8183
8184 .section "Host list patterns that match by host name" "SECThoslispatnam"
8185 .cindex "host" "lookup failures"
8186 .cindex "unknown host name"
8187 .cindex "host list" "matching host name"
8188 There are several types of pattern that require Exim to know the name of the
8189 remote host. These are either wildcard patterns or lookups by name. (If a
8190 complete hostname is given without any wildcarding, it is used to find an IP
8191 address to match against, as described in section &<<SECThoslispatip>>&
8192 above.)
8193
8194 If the remote host name is not already known when Exim encounters one of these
8195 patterns, it has to be found from the IP address.
8196 Although many sites on the Internet are conscientious about maintaining reverse
8197 DNS data for their hosts, there are also many that do not do this.
8198 Consequently, a name cannot always be found, and this may lead to unwanted
8199 effects. Take care when configuring host lists with wildcarded name patterns.
8200 Consider what will happen if a name cannot be found.
8201
8202 Because of the problems of determining host names from IP addresses, matching
8203 against host names is not as common as matching against IP addresses.
8204
8205 By default, in order to find a host name, Exim first does a reverse DNS lookup;
8206 if no name is found in the DNS, the system function (&[gethostbyaddr()]& or
8207 &[getipnodebyaddr()]& if available) is tried. The order in which these lookups
8208 are done can be changed by setting the &%host_lookup_order%& option. For
8209 security, once Exim has found one or more names, it looks up the IP addresses
8210 for these names and compares them with the IP address that it started with.
8211 Only those names whose IP addresses match are accepted. Any other names are
8212 discarded. If no names are left, Exim behaves as if the host name cannot be
8213 found. In the most common case there is only one name and one IP address.
8214
8215 There are some options that control what happens if a host name cannot be
8216 found. These are described in section &<<SECTbehipnot>>& below.
8217
8218 .cindex "host" "alias for"
8219 .cindex "alias for host"
8220 As a result of aliasing, hosts may have more than one name. When processing any
8221 of the following types of pattern, all the host's names are checked:
8222
8223 .ilist
8224 .cindex "asterisk" "in host list"
8225 If a pattern starts with &"*"& the remainder of the item must match the end of
8226 the host name. For example, &`*.b.c`& matches all hosts whose names end in
8227 &'.b.c'&. This special simple form is provided because this is a very common
8228 requirement. Other kinds of wildcarding require the use of a regular
8229 expression.
8230 .next
8231 .cindex "regular expressions" "in host list"
8232 .cindex "host list" "regular expression in"
8233 If the item starts with &"^"& it is taken to be a regular expression which is
8234 matched against the host name. Host names are case-independent, so this regular
8235 expression match is by default case-independent, but you can make it
8236 case-dependent by starting it with &`(?-i)`&. References to descriptions of the
8237 syntax of regular expressions are given in chapter &<<CHAPregexp>>&. For
8238 example,
8239 .code
8240 ^(a|b)\.c\.d$
8241 .endd
8242 is a regular expression that matches either of the two hosts &'a.c.d'& or
8243 &'b.c.d'&. When a regular expression is used in a host list, you must take care
8244 that backslash and dollar characters are not misinterpreted as part of the
8245 string expansion. The simplest way to do this is to use &`\N`& to mark that
8246 part of the string as non-expandable. For example:
8247 .code
8248 sender_unqualified_hosts = \N^(a|b)\.c\.d$\N : ....
8249 .endd
8250 &*Warning*&: If you want to match a complete host name, you must include the
8251 &`$`& terminating metacharacter in the regular expression, as in the above
8252 example. Without it, a match at the start of the host name is all that is
8253 required.
8254 .endlist
8255
8256
8257
8258
8259 .section "Behaviour when an IP address or name cannot be found" "SECTbehipnot"
8260 .cindex "host" "lookup failures, permanent"
8261 While processing a host list, Exim may need to look up an IP address from a
8262 name (see section &<<SECThoslispatip>>&), or it may need to look up a host name
8263 from an IP address (see section &<<SECThoslispatnam>>&). In either case, the
8264 behaviour when it fails to find the information it is seeking is the same.
8265
8266 &*Note*&: This section applies to permanent lookup failures. It does &'not'&
8267 apply to temporary DNS errors, whose handling is described in the next section.
8268
8269 .cindex "&`+include_unknown`&"
8270 .cindex "&`+ignore_unknown`&"
8271 By default, Exim behaves as if the host does not match the list. This may not
8272 always be what you want to happen. To change Exim's behaviour, the special
8273 items &`+include_unknown`& or &`+ignore_unknown`& may appear in the list (at
8274 top level &-- they are not recognized in an indirected file).
8275
8276 .ilist
8277 If any item that follows &`+include_unknown`& requires information that
8278 cannot found, Exim behaves as if the host does match the list. For example,
8279 .code
8280 host_reject_connection = +include_unknown:*.enemy.ex
8281 .endd
8282 rejects connections from any host whose name matches &`*.enemy.ex`&, and also
8283 any hosts whose name it cannot find.
8284
8285 .next
8286 If any item that follows &`+ignore_unknown`& requires information that cannot
8287 be found, Exim ignores that item and proceeds to the rest of the list. For
8288 example:
8289 .code
8290 accept hosts = +ignore_unknown : friend.example : \
8291                192.168.4.5
8292 .endd
8293 accepts from any host whose name is &'friend.example'& and from 192.168.4.5,
8294 whether or not its host name can be found. Without &`+ignore_unknown`&, if no
8295 name can be found for 192.168.4.5, it is rejected.
8296 .endlist
8297
8298 Both &`+include_unknown`& and &`+ignore_unknown`& may appear in the same
8299 list. The effect of each one lasts until the next, or until the end of the
8300 list.
8301
8302
8303 .section "Temporary DNS errors when looking up host information" &&&
8304          "SECTtemdnserr"
8305 .cindex "host" "lookup failures, temporary"
8306 .cindex "&`+include_defer`&"
8307 .cindex "&`+ignore_defer`&"
8308 A temporary DNS lookup failure normally causes a defer action (except when
8309 &%dns_again_means_nonexist%& converts it into a permanent error). However,
8310 host lists can include &`+ignore_defer`& and &`+include_defer`&, analagous to
8311 &`+ignore_unknown`& and &`+include_unknown`&, as described in the previous
8312 section. These options should be used with care, probably only in non-critical
8313 host lists such as whitelists.
8314
8315
8316
8317 .section "Host list patterns for single-key lookups by host name" &&&
8318          "SECThoslispatnamsk"
8319 .cindex "unknown host name"
8320 .cindex "host list" "matching host name"
8321 If a pattern is of the form
8322 .display
8323 <&'single-key-search-type'&>;<&'search-data'&>
8324 .endd
8325 for example
8326 .code
8327 dbm;/host/accept/list
8328 .endd
8329 a single-key lookup is performed, using the host name as its key. If the
8330 lookup succeeds, the host matches the item. The actual data that is looked up
8331 is not used.
8332
8333 &*Reminder*&: With this kind of pattern, you must have host &'names'& as
8334 keys in the file, not IP addresses. If you want to do lookups based on IP
8335 addresses, you must precede the search type with &"net-"& (see section
8336 &<<SECThoslispatsikey>>&). There is, however, no reason why you could not use
8337 two items in the same list, one doing an address lookup and one doing a name
8338 lookup, both using the same file.
8339
8340
8341
8342 .section "Host list patterns for query-style lookups" "SECID81"
8343 If a pattern is of the form
8344 .display
8345 <&'query-style-search-type'&>;<&'query'&>
8346 .endd
8347 the query is obeyed, and if it succeeds, the host matches the item. The actual
8348 data that is looked up is not used. The variables &$sender_host_address$& and
8349 &$sender_host_name$& can be used in the query. For example:
8350 .code
8351 hosts_lookup = pgsql;\
8352   select ip from hostlist where ip='$sender_host_address'
8353 .endd
8354 The value of &$sender_host_address$& for an IPv6 address contains colons. You
8355 can use the &%sg%& expansion item to change this if you need to. If you want to
8356 use masked IP addresses in database queries, you can use the &%mask%& expansion
8357 operator.
8358
8359 If the query contains a reference to &$sender_host_name$&, Exim automatically
8360 looks up the host name if it has not already done so. (See section
8361 &<<SECThoslispatnam>>& for comments on finding host names.)
8362
8363 Historical note: prior to release 4.30, Exim would always attempt to find a
8364 host name before running the query, unless the search type was preceded by
8365 &`net-`&. This is no longer the case. For backwards compatibility, &`net-`& is
8366 still recognized for query-style lookups, but its presence or absence has no
8367 effect. (Of course, for single-key lookups, &`net-`& &'is'& important.
8368 See section &<<SECThoslispatsikey>>&.)
8369
8370
8371
8372 .section "Mixing wildcarded host names and addresses in host lists" &&&
8373          "SECTmixwilhos"
8374 .cindex "host list" "mixing names and addresses in"
8375 If you have name lookups or wildcarded host names and IP addresses in the same
8376 host list, you should normally put the IP addresses first. For example, in an
8377 ACL you could have:
8378 .code
8379 accept hosts = 10.9.8.7 : *.friend.example
8380 .endd
8381 The reason for this lies in the left-to-right way that Exim processes lists.
8382 It can test IP addresses without doing any DNS lookups, but when it reaches an
8383 item that requires a host name, it fails if it cannot find a host name to
8384 compare with the pattern. If the above list is given in the opposite order, the
8385 &%accept%& statement fails for a host whose name cannot be found, even if its
8386 IP address is 10.9.8.7.
8387
8388 If you really do want to do the name check first, and still recognize the IP
8389 address, you can rewrite the ACL like this:
8390 .code
8391 accept hosts = *.friend.example
8392 accept hosts = 10.9.8.7
8393 .endd
8394 If the first &%accept%& fails, Exim goes on to try the second one. See chapter
8395 &<<CHAPACL>>& for details of ACLs.
8396
8397
8398
8399
8400
8401 .section "Address lists" "SECTaddresslist"
8402 .cindex "list" "address list"
8403 .cindex "address list" "empty item"
8404 .cindex "address list" "patterns"
8405 Address lists contain patterns that are matched against mail addresses. There
8406 is one special case to be considered: the sender address of a bounce message is
8407 always empty. You can test for this by providing an empty item in an address
8408 list. For example, you can set up a router to process bounce messages by
8409 using this option setting:
8410 .code
8411 senders = :
8412 .endd
8413 The presence of the colon creates an empty item. If you do not provide any
8414 data, the list is empty and matches nothing. The empty sender can also be
8415 detected by a regular expression that matches an empty string,
8416 and by a query-style lookup that succeeds when &$sender_address$& is empty.
8417
8418 Non-empty items in an address list can be straightforward email addresses. For
8419 example:
8420 .code
8421 senders = jbc@askone.example : hs@anacreon.example
8422 .endd
8423 A certain amount of wildcarding is permitted. If a pattern contains an @
8424 character, but is not a regular expression and does not begin with a
8425 semicolon-terminated lookup type (described below), the local part of the
8426 subject address is compared with the local part of the pattern, which may start
8427 with an asterisk. If the local parts match, the domain is checked in exactly
8428 the same way as for a pattern in a domain list. For example, the domain can be
8429 wildcarded, refer to a named list, or be a lookup:
8430 .code
8431 deny senders = *@*.spamming.site:\
8432                *@+hostile_domains:\
8433                bozo@partial-lsearch;/list/of/dodgy/sites:\
8434                *@dbm;/bad/domains.db
8435 .endd
8436 .cindex "local part" "starting with !"
8437 .cindex "address list" "local part starting with !"
8438 If a local part that begins with an exclamation mark is required, it has to be
8439 specified using a regular expression, because otherwise the exclamation mark is
8440 treated as a sign of negation, as is standard in lists.
8441
8442 If a non-empty pattern that is not a regular expression or a lookup does not
8443 contain an @ character, it is matched against the domain part of the subject
8444 address. The only two formats that are recognized this way are a literal
8445 domain, or a domain pattern that starts with *. In both these cases, the effect
8446 is the same as if &`*@`& preceded the pattern. For example:
8447 .code
8448 deny senders = enemy.domain : *.enemy.domain
8449 .endd
8450
8451 The following kinds of more complicated address list pattern can match any
8452 address, including the empty address that is characteristic of bounce message
8453 senders:
8454
8455 .ilist
8456 .cindex "regular expressions" "in address list"
8457 .cindex "address list" "regular expression in"
8458 If (after expansion) a pattern starts with &"^"&, a regular expression match is
8459 done against the complete address, with the pattern as the regular expression.
8460 You must take care that backslash and dollar characters are not misinterpreted
8461 as part of the string expansion. The simplest way to do this is to use &`\N`&
8462 to mark that part of the string as non-expandable. For example:
8463 .code
8464 deny senders = \N^.*this.*@example\.com$\N : \
8465                \N^\d{8}.+@spamhaus.example$\N : ...
8466 .endd
8467 The &`\N`& sequences are removed by the expansion, so these items do indeed
8468 start with &"^"& by the time they are being interpreted as address patterns.
8469
8470 .next
8471 .cindex "address list" "lookup for complete address"
8472 Complete addresses can be looked up by using a pattern that starts with a
8473 lookup type terminated by a semicolon, followed by the data for the lookup. For
8474 example:
8475 .code
8476 deny senders = cdb;/etc/blocked.senders : \
8477   mysql;select address from blocked where \
8478   address='${quote_mysql:$sender_address}'
8479 .endd
8480 Both query-style and single-key lookup types can be used. For a single-key
8481 lookup type, Exim uses the complete address as the key. However, empty keys are
8482 not supported for single-key lookups, so a match against the empty address
8483 always fails. This restriction does not apply to query-style lookups.
8484
8485 Partial matching for single-key lookups (section &<<SECTpartiallookup>>&)
8486 cannot be used, and is ignored if specified, with an entry being written to the
8487 panic log.
8488 .cindex "*@ with single-key lookup"
8489 However, you can configure lookup defaults, as described in section
8490 &<<SECTdefaultvaluelookups>>&, but this is useful only for the &"*@"& type of
8491 default. For example, with this lookup:
8492 .code
8493 accept senders = lsearch*@;/some/file
8494 .endd
8495 the file could contains lines like this:
8496 .code
8497 user1@domain1.example
8498 *@domain2.example
8499 .endd
8500 and for the sender address &'nimrod@jaeger.example'&, the sequence of keys
8501 that are tried is:
8502 .code
8503 nimrod@jaeger.example
8504 *@jaeger.example
8505 *
8506 .endd
8507 &*Warning 1*&: Do not include a line keyed by &"*"& in the file, because that
8508 would mean that every address matches, thus rendering the test useless.
8509
8510 &*Warning 2*&: Do not confuse these two kinds of item:
8511 .code
8512 deny recipients = dbm*@;/some/file
8513 deny recipients = *@dbm;/some/file
8514 .endd
8515 The first does a whole address lookup, with defaulting, as just described,
8516 because it starts with a lookup type. The second matches the local part and
8517 domain independently, as described in a bullet point below.
8518 .endlist
8519
8520
8521 The following kinds of address list pattern can match only non-empty addresses.
8522 If the subject address is empty, a match against any of these pattern types
8523 always fails.
8524
8525
8526 .ilist
8527 .cindex "@@ with single-key lookup"
8528 .cindex "address list" "@@ lookup type"
8529 .cindex "address list" "split local part and domain"
8530 If a pattern starts with &"@@"& followed by a single-key lookup item
8531 (for example, &`@@lsearch;/some/file`&), the address that is being checked is
8532 split into a local part and a domain. The domain is looked up in the file. If
8533 it is not found, there is no match. If it is found, the data that is looked up
8534 from the file is treated as a colon-separated list of local part patterns, each
8535 of which is matched against the subject local part in turn.
8536
8537 .cindex "asterisk" "in address list"
8538 The lookup may be a partial one, and/or one involving a search for a default
8539 keyed by &"*"& (see section &<<SECTdefaultvaluelookups>>&). The local part
8540 patterns that are looked up can be regular expressions or begin with &"*"&, or
8541 even be further lookups. They may also be independently negated. For example,
8542 with
8543 .code
8544 deny senders = @@dbm;/etc/reject-by-domain
8545 .endd
8546 the data from which the DBM file is built could contain lines like
8547 .code
8548 baddomain.com:  !postmaster : *
8549 .endd
8550 to reject all senders except &%postmaster%& from that domain.
8551
8552 .cindex "local part" "starting with !"
8553 If a local part that actually begins with an exclamation mark is required, it
8554 has to be specified using a regular expression. In &(lsearch)& files, an entry
8555 may be split over several lines by indenting the second and subsequent lines,
8556 but the separating colon must still be included at line breaks. White space
8557 surrounding the colons is ignored. For example:
8558 .code
8559 aol.com:  spammer1 : spammer2 : ^[0-9]+$ :
8560   spammer3 : spammer4
8561 .endd
8562 As in all colon-separated lists in Exim, a colon can be included in an item by
8563 doubling.
8564
8565 If the last item in the list starts with a right angle-bracket, the remainder
8566 of the item is taken as a new key to look up in order to obtain a continuation
8567 list of local parts. The new key can be any sequence of characters. Thus one
8568 might have entries like
8569 .code
8570 aol.com: spammer1 : spammer 2 : >*
8571 xyz.com: spammer3 : >*
8572 *:       ^\d{8}$
8573 .endd
8574 in a file that was searched with &%@@dbm*%&, to specify a match for 8-digit
8575 local parts for all domains, in addition to the specific local parts listed for
8576 each domain. Of course, using this feature costs another lookup each time a
8577 chain is followed, but the effort needed to maintain the data is reduced.
8578
8579 .cindex "loop" "in lookups"
8580 It is possible to construct loops using this facility, and in order to catch
8581 them, the chains may be no more than fifty items long.
8582
8583 .next
8584 The @@<&'lookup'&> style of item can also be used with a query-style
8585 lookup, but in this case, the chaining facility is not available. The lookup
8586 can only return a single list of local parts.
8587 .endlist
8588
8589 &*Warning*&: There is an important difference between the address list items
8590 in these two examples:
8591 .code
8592 senders = +my_list
8593 senders = *@+my_list
8594 .endd
8595 In the first one, &`my_list`& is a named address list, whereas in the second
8596 example it is a named domain list.
8597
8598
8599
8600
8601 .section "Case of letters in address lists" "SECTcasletadd"
8602 .cindex "case of local parts"
8603 .cindex "address list" "case forcing"
8604 .cindex "case forcing in address lists"
8605 Domains in email addresses are always handled caselessly, but for local parts
8606 case may be significant on some systems (see &%caseful_local_part%& for how
8607 Exim deals with this when routing addresses). However, RFC 2505 (&'Anti-Spam
8608 Recommendations for SMTP MTAs'&) suggests that matching of addresses to
8609 blocking lists should be done in a case-independent manner. Since most address
8610 lists in Exim are used for this kind of control, Exim attempts to do this by
8611 default.
8612
8613 The domain portion of an address is always lowercased before matching it to an
8614 address list. The local part is lowercased by default, and any string
8615 comparisons that take place are done caselessly. This means that the data in
8616 the address list itself, in files included as plain file names, and in any file
8617 that is looked up using the &"@@"& mechanism, can be in any case. However, the
8618 keys in files that are looked up by a search type other than &(lsearch)& (which
8619 works caselessly) must be in lower case, because these lookups are not
8620 case-independent.
8621
8622 .cindex "&`+caseful`&"
8623 To allow for the possibility of caseful address list matching, if an item in
8624 an address list is the string &"+caseful"&, the original case of the local
8625 part is restored for any comparisons that follow, and string comparisons are no
8626 longer case-independent. This does not affect the domain, which remains in
8627 lower case. However, although independent matches on the domain alone are still
8628 performed caselessly, regular expressions that match against an entire address
8629 become case-sensitive after &"+caseful"& has been seen.
8630
8631
8632
8633 .section "Local part lists" "SECTlocparlis"
8634 .cindex "list" "local part list"
8635 .cindex "local part" "list"
8636 Case-sensitivity in local part lists is handled in the same way as for address
8637 lists, as just described. The &"+caseful"& item can be used if required. In a
8638 setting of the &%local_parts%& option in a router with &%caseful_local_part%&
8639 set false, the subject is lowercased and the matching is initially
8640 case-insensitive. In this case, &"+caseful"& will restore case-sensitive
8641 matching in the local part list, but not elsewhere in the router. If
8642 &%caseful_local_part%& is set true in a router, matching in the &%local_parts%&
8643 option is case-sensitive from the start.
8644
8645 If a local part list is indirected to a file (see section &<<SECTfilnamlis>>&),
8646 comments are handled in the same way as address lists &-- they are recognized
8647 only if the # is preceded by white space or the start of the line.
8648 Otherwise, local part lists are matched in the same way as domain lists, except
8649 that the special items that refer to the local host (&`@`&, &`@[]`&,
8650 &`@mx_any`&, &`@mx_primary`&, and &`@mx_secondary`&) are not recognized.
8651 Refer to section &<<SECTdomainlist>>& for details of the other available item
8652 types.
8653 .ecindex IIDdohoadli
8654
8655
8656
8657
8658 . ////////////////////////////////////////////////////////////////////////////
8659 . ////////////////////////////////////////////////////////////////////////////
8660
8661 .chapter "String expansions" "CHAPexpand"
8662 .scindex IIDstrexp "expansion" "of strings"
8663 Many strings in Exim's run time configuration are expanded before use. Some of
8664 them are expanded every time they are used; others are expanded only once.
8665
8666 When a string is being expanded it is copied verbatim from left to right except
8667 when a dollar or backslash character is encountered. A dollar specifies the
8668 start of a portion of the string that is interpreted and replaced as described
8669 below in section &<<SECTexpansionitems>>& onwards. Backslash is used as an
8670 escape character, as described in the following section.
8671
8672 Whether a string is expanded depends upon the context.  Usually this is solely
8673 dependent upon the option for which a value is sought; in this documentation,
8674 options for which string expansion is performed are marked with &dagger; after
8675 the data type.  ACL rules always expand strings.  A couple of expansion
8676 conditions do not expand some of the brace-delimited branches, for security
8677 reasons.
8678
8679
8680
8681 .section "Literal text in expanded strings" "SECTlittext"
8682 .cindex "expansion" "including literal text"
8683 An uninterpreted dollar can be included in an expanded string by putting a
8684 backslash in front of it. A backslash can be used to prevent any special
8685 character being treated specially in an expansion, including backslash itself.
8686 If the string appears in quotes in the configuration file, two backslashes are
8687 required because the quotes themselves cause interpretation of backslashes when
8688 the string is read in (see section &<<SECTstrings>>&).
8689
8690 .cindex "expansion" "non-expandable substrings"
8691 A portion of the string can specified as non-expandable by placing it between
8692 two occurrences of &`\N`&. This is particularly useful for protecting regular
8693 expressions, which often contain backslashes and dollar signs. For example:
8694 .code
8695 deny senders = \N^\d{8}[a-z]@some\.site\.example$\N
8696 .endd
8697 On encountering the first &`\N`&, the expander copies subsequent characters
8698 without interpretation until it reaches the next &`\N`& or the end of the
8699 string.
8700
8701
8702
8703 .section "Character escape sequences in expanded strings" "SECID82"
8704 .cindex "expansion" "escape sequences"
8705 A backslash followed by one of the letters &"n"&, &"r"&, or &"t"& in an
8706 expanded string is recognized as an escape sequence for the character newline,
8707 carriage return, or tab, respectively. A backslash followed by up to three
8708 octal digits is recognized as an octal encoding for a single character, and a
8709 backslash followed by &"x"& and up to two hexadecimal digits is a hexadecimal
8710 encoding.
8711
8712 These escape sequences are also recognized in quoted strings when they are read
8713 in. Their interpretation in expansions as well is useful for unquoted strings,
8714 and for other cases such as looked-up strings that are then expanded.
8715
8716
8717 .section "Testing string expansions" "SECID83"
8718 .cindex "expansion" "testing"
8719 .cindex "testing" "string expansion"
8720 .oindex "&%-be%&"
8721 Many expansions can be tested by calling Exim with the &%-be%& option. This
8722 takes the command arguments, or lines from the standard input if there are no
8723 arguments, runs them through the string expansion code, and writes the results
8724 to the standard output. Variables based on configuration values are set up, but
8725 since no message is being processed, variables such as &$local_part$& have no
8726 value. Nevertheless the &%-be%& option can be useful for checking out file and
8727 database lookups, and the use of expansion operators such as &%sg%&, &%substr%&
8728 and &%nhash%&.
8729
8730 Exim gives up its root privilege when it is called with the &%-be%& option, and
8731 instead runs under the uid and gid it was called with, to prevent users from
8732 using &%-be%& for reading files to which they do not have access.
8733
8734 .oindex "&%-bem%&"
8735 If you want to test expansions that include variables whose values are taken
8736 from a message, there are two other options that can be used. The &%-bem%&
8737 option is like &%-be%& except that it is followed by a file name. The file is
8738 read as a message before doing the test expansions. For example:
8739 .code
8740 exim -bem /tmp/test.message '$h_subject:'
8741 .endd
8742 The &%-Mset%& option is used in conjunction with &%-be%& and is followed by an
8743 Exim message identifier. For example:
8744 .code
8745 exim -be -Mset 1GrA8W-0004WS-LQ '$recipients'
8746 .endd
8747 This loads the message from Exim's spool before doing the test expansions, and
8748 is therefore restricted to admin users.
8749
8750
8751 .section "Forced expansion failure" "SECTforexpfai"
8752 .cindex "expansion" "forced failure"
8753 A number of expansions that are described in the following section have
8754 alternative &"true"& and &"false"& substrings, enclosed in brace characters
8755 (which are sometimes called &"curly brackets"&). Which of the two strings is
8756 used depends on some condition that is evaluated as part of the expansion. If,
8757 instead of a &"false"& substring, the word &"fail"& is used (not in braces),
8758 the entire string expansion fails in a way that can be detected by the code
8759 that requested the expansion. This is called &"forced expansion failure"&, and
8760 its consequences depend on the circumstances. In some cases it is no different
8761 from any other expansion failure, but in others a different action may be
8762 taken. Such variations are mentioned in the documentation of the option that is
8763 being expanded.
8764
8765
8766
8767
8768 .section "Expansion items" "SECTexpansionitems"
8769 The following items are recognized in expanded strings. White space may be used
8770 between sub-items that are keywords or substrings enclosed in braces inside an
8771 outer set of braces, to improve readability. &*Warning*&: Within braces,
8772 white space is significant.
8773
8774 .vlist
8775 .vitem &*$*&<&'variable&~name'&>&~or&~&*${*&<&'variable&~name'&>&*}*&
8776 .cindex "expansion" "variables"
8777 Substitute the contents of the named variable, for example:
8778 .code
8779 $local_part
8780 ${domain}
8781 .endd
8782 The second form can be used to separate the name from subsequent alphanumeric
8783 characters. This form (using braces) is available only for variables; it does
8784 &'not'& apply to message headers. The names of the variables are given in
8785 section &<<SECTexpvar>>& below. If the name of a non-existent variable is
8786 given, the expansion fails.
8787
8788 .vitem &*${*&<&'op'&>&*:*&<&'string'&>&*}*&
8789 .cindex "expansion" "operators"
8790 The string is first itself expanded, and then the operation specified by
8791 <&'op'&> is applied to it. For example:
8792 .code
8793 ${lc:$local_part}
8794 .endd
8795 The string starts with the first character after the colon, which may be
8796 leading white space. A list of operators is given in section &<<SECTexpop>>&
8797 below. The operator notation is used for simple expansion items that have just
8798 one argument, because it reduces the number of braces and therefore makes the
8799 string easier to understand.
8800
8801 .vitem &*$bheader_*&<&'header&~name'&>&*:*&&~or&~&*$bh_*&<&'header&~name'&>&*:*&
8802 This item inserts &"basic"& header lines. It is described with the &%header%&
8803 expansion item below.
8804
8805
8806 .vitem "&*${acl{*&<&'name'&>&*}{*&<&'arg'&>&*}...}*&"
8807 .cindex "expansion" "calling an acl"
8808 .cindex "&%acl%&" "call from expansion"
8809 The name and zero to nine argument strings are first expanded separately.  The expanded
8810 arguments are assigned to the variables &$acl_arg1$& to &$acl_arg9$& in order.
8811 Any unused are made empty.  The variable &$acl_narg$& is set to the number of
8812 arguments.  The named ACL (see chapter &<<CHAPACL>>&) is called
8813 and may use the variables; if another acl expansion is used the values
8814 are restored after it returns.  If the ACL sets
8815 a value using a "message =" modifier and returns accept or deny, the value becomes
8816 the result of the expansion.
8817 If no message is set and the ACL returns accept or deny
8818 the expansion result is an empty string.
8819 If the ACL returns defer the result is a forced-fail.  Otherwise the expansion fails.
8820
8821
8822 .vitem "&*${dlfunc{*&<&'file'&>&*}{*&<&'function'&>&*}{*&<&'arg'&>&*}&&&
8823        {*&<&'arg'&>&*}...}*&"
8824 .cindex &%dlfunc%&
8825 This expansion dynamically loads and then calls a locally-written C function.
8826 This functionality is available only if Exim is compiled with
8827 .code
8828 EXPAND_DLFUNC=yes
8829 .endd
8830 set in &_Local/Makefile_&. Once loaded, Exim remembers the dynamically loaded
8831 object so that it doesn't reload the same object file in the same Exim process
8832 (but of course Exim does start new processes frequently).
8833
8834 There may be from zero to eight arguments to the function. When compiling
8835 a local function that is to be called in this way, &_local_scan.h_& should be
8836 included. The Exim variables and functions that are defined by that API
8837 are also available for dynamically loaded functions. The function itself
8838 must have the following type:
8839 .code
8840 int dlfunction(uschar **yield, int argc, uschar *argv[])
8841 .endd
8842 Where &`uschar`& is a typedef for &`unsigned char`& in &_local_scan.h_&. The
8843 function should return one of the following values:
8844
8845 &`OK`&: Success. The string that is placed in the variable &'yield'& is put
8846 into the expanded string that is being built.
8847
8848 &`FAIL`&: A non-forced expansion failure occurs, with the error message taken
8849 from &'yield'&, if it is set.
8850
8851 &`FAIL_FORCED`&: A forced expansion failure occurs, with the error message
8852 taken from &'yield'& if it is set.
8853
8854 &`ERROR`&: Same as &`FAIL`&, except that a panic log entry is written.
8855
8856 When compiling a function that is to be used in this way with gcc,
8857 you need to add &%-shared%& to the gcc command. Also, in the Exim build-time
8858 configuration, you must add &%-export-dynamic%& to EXTRALIBS.
8859
8860 .vitem "&*${extract{*&<&'key'&>&*}{*&<&'string1'&>&*}{*&<&'string2'&>&*}&&&
8861        {*&<&'string3'&>&*}}*&"
8862 .cindex "expansion" "extracting substrings by key"
8863 .cindex "&%extract%&" "substrings by key"
8864 The key and <&'string1'&> are first expanded separately. Leading and trailing
8865 white space is removed from the key (but not from any of the strings). The key
8866 must not consist entirely of digits. The expanded <&'string1'&> must be of the
8867 form:
8868 .display
8869 <&'key1'&> = <&'value1'&>  <&'key2'&> = <&'value2'&> ...
8870 .endd
8871 .vindex "&$value$&"
8872 where the equals signs and spaces (but not both) are optional. If any of the
8873 values contain white space, they must be enclosed in double quotes, and any
8874 values that are enclosed in double quotes are subject to escape processing as
8875 described in section &<<SECTstrings>>&. The expanded <&'string1'&> is searched
8876 for the value that corresponds to the key. The search is case-insensitive. If
8877 the key is found, <&'string2'&> is expanded, and replaces the whole item;
8878 otherwise <&'string3'&> is used. During the expansion of <&'string2'&> the
8879 variable &$value$& contains the value that has been extracted. Afterwards, it
8880 is restored to any previous value it might have had.
8881
8882 If {<&'string3'&>} is omitted, the item is replaced by an empty string if the
8883 key is not found. If {<&'string2'&>} is also omitted, the value that was
8884 extracted is used. Thus, for example, these two expansions are identical, and
8885 yield &"2001"&:
8886 .code
8887 ${extract{gid}{uid=1984 gid=2001}}
8888 ${extract{gid}{uid=1984 gid=2001}{$value}}
8889 .endd
8890 Instead of {<&'string3'&>} the word &"fail"& (not in curly brackets) can
8891 appear, for example:
8892 .code
8893 ${extract{Z}{A=... B=...}{$value} fail }
8894 .endd
8895 This forces an expansion failure (see section &<<SECTforexpfai>>&);
8896 {<&'string2'&>} must be present for &"fail"& to be recognized.
8897
8898
8899 .vitem "&*${extract{*&<&'number'&>&*}{*&<&'separators'&>&*}&&&
8900         {*&<&'string1'&>&*}{*&<&'string2'&>&*}{*&<&'string3'&>&*}}*&"
8901 .cindex "expansion" "extracting substrings by number"
8902 .cindex "&%extract%&" "substrings by number"
8903 The <&'number'&> argument must consist entirely of decimal digits,
8904 apart from leading and trailing white space, which is ignored.
8905 This is what distinguishes this form of &%extract%& from the previous kind. It
8906 behaves in the same way, except that, instead of extracting a named field, it
8907 extracts from <&'string1'&> the field whose number is given as the first
8908 argument. You can use &$value$& in <&'string2'&> or &`fail`& instead of
8909 <&'string3'&> as before.
8910
8911 The fields in the string are separated by any one of the characters in the
8912 separator string. These may include space or tab characters.
8913 The first field is numbered one. If the number is negative, the fields are
8914 counted from the end of the string, with the rightmost one numbered -1. If the
8915 number given is zero, the entire string is returned. If the modulus of the
8916 number is greater than the number of fields in the string, the result is the
8917 expansion of <&'string3'&>, or the empty string if <&'string3'&> is not
8918 provided. For example:
8919 .code
8920 ${extract{2}{:}{x:42:99:& Mailer::/bin/bash}}
8921 .endd
8922 yields &"42"&, and
8923 .code
8924 ${extract{-4}{:}{x:42:99:& Mailer::/bin/bash}}
8925 .endd
8926 yields &"99"&. Two successive separators mean that the field between them is
8927 empty (for example, the fifth field above).
8928
8929
8930 .vitem &*${filter{*&<&'string'&>&*}{*&<&'condition'&>&*}}*&
8931 .cindex "list" "selecting by condition"
8932 .cindex "expansion" "selecting from list by condition"
8933 .vindex "&$item$&"
8934 After expansion, <&'string'&> is interpreted as a list, colon-separated by
8935 default, but the separator can be changed in the usual way. For each item
8936 in this list, its value is place in &$item$&, and then the condition is
8937 evaluated. If the condition is true, &$item$& is added to the output as an
8938 item in a new list; if the condition is false, the item is discarded. The
8939 separator used for the output list is the same as the one used for the
8940 input, but a separator setting is not included in the output. For example:
8941 .code
8942 ${filter{a:b:c}{!eq{$item}{b}}
8943 .endd
8944 yields &`a:c`&. At the end of the expansion, the value of &$item$& is restored
8945 to what it was before. See also the &*map*& and &*reduce*& expansion items.
8946
8947
8948 .vitem &*${hash{*&<&'string1'&>&*}{*&<&'string2'&>&*}{*&<&'string3'&>&*}}*&
8949 .cindex "hash function" "textual"
8950 .cindex "expansion" "textual hash"
8951 This is a textual hashing function, and was the first to be implemented in
8952 early versions of Exim. In current releases, there are other hashing functions
8953 (numeric, MD5, and SHA-1), which are described below.
8954
8955 The first two strings, after expansion, must be numbers. Call them <&'m'&> and
8956 <&'n'&>. If you are using fixed values for these numbers, that is, if
8957 <&'string1'&> and <&'string2'&> do not change when they are expanded, you can
8958 use the simpler operator notation that avoids some of the braces:
8959 .code
8960 ${hash_<n>_<m>:<string>}
8961 .endd
8962 The second number is optional (in both notations). If <&'n'&> is greater than
8963 or equal to the length of the string, the expansion item returns the string.
8964 Otherwise it computes a new string of length <&'n'&> by applying a hashing
8965 function to the string. The new string consists of characters taken from the
8966 first <&'m'&> characters of the string
8967 .code
8968 abcdefghijklmnopqrstuvwxyzABCDEFGHIJKLMNOPQWRSTUVWXYZ0123456789
8969 .endd
8970 If <&'m'&> is not present the value 26 is used, so that only lower case
8971 letters appear. For example:
8972 .display
8973 &`$hash{3}{monty}}           `&   yields  &`jmg`&
8974 &`$hash{5}{monty}}           `&   yields  &`monty`&
8975 &`$hash{4}{62}{monty python}}`&   yields  &`fbWx`&
8976 .endd
8977
8978 .vitem "&*$header_*&<&'header&~name'&>&*:*&&~or&~&&&
8979         &*$h_*&<&'header&~name'&>&*:*&" &&&
8980        "&*$bheader_*&<&'header&~name'&>&*:*&&~or&~&&&
8981         &*$bh_*&<&'header&~name'&>&*:*&" &&&
8982        "&*$rheader_*&<&'header&~name'&>&*:*&&~or&~&&&
8983         &*$rh_*&<&'header&~name'&>&*:*&"
8984 .cindex "expansion" "header insertion"
8985 .vindex "&$header_$&"
8986 .vindex "&$bheader_$&"
8987 .vindex "&$rheader_$&"
8988 .cindex "header lines" "in expansion strings"
8989 .cindex "header lines" "character sets"
8990 .cindex "header lines" "decoding"
8991 Substitute the contents of the named message header line, for example
8992 .code
8993 $header_reply-to:
8994 .endd
8995 The newline that terminates a header line is not included in the expansion, but
8996 internal newlines (caused by splitting the header line over several physical
8997 lines) may be present.
8998
8999 The difference between &%rheader%&, &%bheader%&, and &%header%& is in the way
9000 the data in the header line is interpreted.
9001
9002 .ilist
9003 .cindex "white space" "in header lines"
9004 &%rheader%& gives the original &"raw"& content of the header line, with no
9005 processing at all, and without the removal of leading and trailing white space.
9006
9007 .next
9008 .cindex "base64 encoding" "in header lines"
9009 &%bheader%& removes leading and trailing white space, and then decodes base64
9010 or quoted-printable MIME &"words"& within the header text, but does no
9011 character set translation. If decoding of what looks superficially like a MIME
9012 &"word"& fails, the raw string is returned. If decoding
9013 .cindex "binary zero" "in header line"
9014 produces a binary zero character, it is replaced by a question mark &-- this is
9015 what Exim does for binary zeros that are actually received in header lines.
9016
9017 .next
9018 &%header%& tries to translate the string as decoded by &%bheader%& to a
9019 standard character set. This is an attempt to produce the same string as would
9020 be displayed on a user's MUA. If translation fails, the &%bheader%& string is
9021 returned. Translation is attempted only on operating systems that support the
9022 &[iconv()]& function. This is indicated by the compile-time macro HAVE_ICONV in
9023 a system Makefile or in &_Local/Makefile_&.
9024 .endlist ilist
9025
9026 In a filter file, the target character set for &%header%& can be specified by a
9027 command of the following form:
9028 .code
9029 headers charset "UTF-8"
9030 .endd
9031 This command affects all references to &$h_$& (or &$header_$&) expansions in
9032 subsequently obeyed filter commands. In the absence of this command, the target
9033 character set in a filter is taken from the setting of the &%headers_charset%&
9034 option in the runtime configuration. The value of this option defaults to the
9035 value of HEADERS_CHARSET in &_Local/Makefile_&. The ultimate default is
9036 ISO-8859-1.
9037
9038 Header names follow the syntax of RFC 2822, which states that they may contain
9039 any printing characters except space and colon. Consequently, curly brackets
9040 &'do not'& terminate header names, and should not be used to enclose them as
9041 if they were variables. Attempting to do so causes a syntax error.
9042
9043 Only header lines that are common to all copies of a message are visible to
9044 this mechanism. These are the original header lines that are received with the
9045 message, and any that are added by an ACL statement or by a system
9046 filter. Header lines that are added to a particular copy of a message by a
9047 router or transport are not accessible.
9048
9049 For incoming SMTP messages, no header lines are visible in ACLs that are obeyed
9050 before the DATA ACL, because the header structure is not set up until the
9051 message is received. Header lines that are added in a RCPT ACL (for example)
9052 are saved until the message's incoming header lines are available, at which
9053 point they are added. When a DATA ACL is running, however, header lines added
9054 by earlier ACLs are visible.
9055
9056 Upper case and lower case letters are synonymous in header names. If the
9057 following character is white space, the terminating colon may be omitted, but
9058 this is not recommended, because you may then forget it when it is needed. When
9059 white space terminates the header name, it is included in the expanded string.
9060 If the message does not contain the given header, the expansion item is
9061 replaced by an empty string. (See the &%def%& condition in section
9062 &<<SECTexpcond>>& for a means of testing for the existence of a header.)
9063
9064 If there is more than one header with the same name, they are all concatenated
9065 to form the substitution string, up to a maximum length of 64K. Unless
9066 &%rheader%& is being used, leading and trailing white space is removed from
9067 each header before concatenation, and a completely empty header is ignored. A
9068 newline character is then inserted between non-empty headers, but there is no
9069 newline at the very end. For the &%header%& and &%bheader%& expansion, for
9070 those headers that contain lists of addresses, a comma is also inserted at the
9071 junctions between headers. This does not happen for the &%rheader%& expansion.
9072
9073
9074 .vitem &*${hmac{*&<&'hashname'&>&*}{*&<&'secret'&>&*}{*&<&'string'&>&*}}*&
9075 .cindex "expansion" "hmac hashing"
9076 .cindex &%hmac%&
9077 This function uses cryptographic hashing (either MD5 or SHA-1) to convert a
9078 shared secret and some text into a message authentication code, as specified in
9079 RFC 2104. This differs from &`${md5:secret_text...}`& or
9080 &`${sha1:secret_text...}`& in that the hmac step adds a signature to the
9081 cryptographic hash, allowing for authentication that is not possible with MD5
9082 or SHA-1 alone. The hash name must expand to either &`md5`& or &`sha1`& at
9083 present. For example:
9084 .code
9085 ${hmac{md5}{somesecret}{$primary_hostname $tod_log}}
9086 .endd
9087 For the hostname &'mail.example.com'& and time 2002-10-17 11:30:59, this
9088 produces:
9089 .code
9090 dd97e3ba5d1a61b5006108f8c8252953
9091 .endd
9092 As an example of how this might be used, you might put in the main part of
9093 an Exim configuration:
9094 .code
9095 SPAMSCAN_SECRET=cohgheeLei2thahw
9096 .endd
9097 In a router or a transport you could then have:
9098 .code
9099 headers_add = \
9100   X-Spam-Scanned: ${primary_hostname} ${message_exim_id} \
9101   ${hmac{md5}{SPAMSCAN_SECRET}\
9102   {${primary_hostname},${message_exim_id},$h_message-id:}}
9103 .endd
9104 Then given a message, you can check where it was scanned by looking at the
9105 &'X-Spam-Scanned:'& header line. If you know the secret, you can check that
9106 this header line is authentic by recomputing the authentication code from the
9107 host name, message ID and the &'Message-id:'& header line. This can be done
9108 using Exim's &%-be%& option, or by other means, for example by using the
9109 &'hmac_md5_hex()'& function in Perl.
9110
9111
9112 .vitem &*${if&~*&<&'condition'&>&*&~{*&<&'string1'&>&*}{*&<&'string2'&>&*}}*&
9113 .cindex "expansion" "conditional"
9114 .cindex "&%if%&, expansion item"
9115 If <&'condition'&> is true, <&'string1'&> is expanded and replaces the whole
9116 item; otherwise <&'string2'&> is used. The available conditions are described
9117 in section &<<SECTexpcond>>& below. For example:
9118 .code
9119 ${if eq {$local_part}{postmaster} {yes}{no} }
9120 .endd
9121 The second string need not be present; if it is not and the condition is not
9122 true, the item is replaced with nothing. Alternatively, the word &"fail"& may
9123 be present instead of the second string (without any curly brackets). In this
9124 case, the expansion is forced to fail if the condition is not true (see section
9125 &<<SECTforexpfai>>&).
9126
9127 If both strings are omitted, the result is the string &`true`& if the condition
9128 is true, and the empty string if the condition is false. This makes it less
9129 cumbersome to write custom ACL and router conditions. For example, instead of
9130 .code
9131 condition = ${if >{$acl_m4}{3}{true}{false}}
9132 .endd
9133 you can use
9134 .code
9135 condition = ${if >{$acl_m4}{3}}
9136 .endd
9137
9138 .vitem &*${length{*&<&'string1'&>&*}{*&<&'string2'&>&*}}*&
9139 .cindex "expansion" "string truncation"
9140 .cindex "&%length%& expansion item"
9141 The &%length%& item is used to extract the initial portion of a string. Both
9142 strings are expanded, and the first one must yield a number, <&'n'&>, say. If
9143 you are using a fixed value for the number, that is, if <&'string1'&> does not
9144 change when expanded, you can use the simpler operator notation that avoids
9145 some of the braces:
9146 .code
9147 ${length_<n>:<string>}
9148 .endd
9149 The result of this item is either the first <&'n'&> characters or the whole
9150 of <&'string2'&>, whichever is the shorter. Do not confuse &%length%& with
9151 &%strlen%&, which gives the length of a string.
9152
9153
9154 .vitem "&*${lookup{*&<&'key'&>&*}&~*&<&'search&~type'&>&*&~&&&
9155         {*&<&'file'&>&*}&~{*&<&'string1'&>&*}&~{*&<&'string2'&>&*}}*&"
9156 This is the first of one of two different types of lookup item, which are both
9157 described in the next item.
9158
9159 .vitem "&*${lookup&~*&<&'search&~type'&>&*&~{*&<&'query'&>&*}&~&&&
9160         {*&<&'string1'&>&*}&~{*&<&'string2'&>&*}}*&"
9161 .cindex "expansion" "lookup in"
9162 .cindex "file" "lookups"
9163 .cindex "lookup" "in expanded string"
9164 The two forms of lookup item specify data lookups in files and databases, as
9165 discussed in chapter &<<CHAPfdlookup>>&. The first form is used for single-key
9166 lookups, and the second is used for query-style lookups. The <&'key'&>,
9167 <&'file'&>, and <&'query'&> strings are expanded before use.
9168
9169 If there is any white space in a lookup item which is part of a filter command,
9170 a retry or rewrite rule, a routing rule for the &(manualroute)& router, or any
9171 other place where white space is significant, the lookup item must be enclosed
9172 in double quotes. The use of data lookups in users' filter files may be locked
9173 out by the system administrator.
9174
9175 .vindex "&$value$&"
9176 If the lookup succeeds, <&'string1'&> is expanded and replaces the entire item.
9177 During its expansion, the variable &$value$& contains the data returned by the
9178 lookup. Afterwards it reverts to the value it had previously (at the outer
9179 level it is empty). If the lookup fails, <&'string2'&> is expanded and replaces
9180 the entire item. If {<&'string2'&>} is omitted, the replacement is the empty
9181 string on failure. If <&'string2'&> is provided, it can itself be a nested
9182 lookup, thus providing a mechanism for looking up a default value when the
9183 original lookup fails.
9184
9185 If a nested lookup is used as part of <&'string1'&>, &$value$& contains the
9186 data for the outer lookup while the parameters of the second lookup are
9187 expanded, and also while <&'string2'&> of the second lookup is expanded, should
9188 the second lookup fail. Instead of {<&'string2'&>} the word &"fail"& can
9189 appear, and in this case, if the lookup fails, the entire expansion is forced
9190 to fail (see section &<<SECTforexpfai>>&). If both {<&'string1'&>} and
9191 {<&'string2'&>} are omitted, the result is the looked up value in the case of a
9192 successful lookup, and nothing in the case of failure.
9193
9194 For single-key lookups, the string &"partial"& is permitted to precede the
9195 search type in order to do partial matching, and * or *@ may follow a search
9196 type to request default lookups if the key does not match (see sections
9197 &<<SECTdefaultvaluelookups>>& and &<<SECTpartiallookup>>& for details).
9198
9199 .cindex "numerical variables (&$1$& &$2$& etc)" "in lookup expansion"
9200 If a partial search is used, the variables &$1$& and &$2$& contain the wild
9201 and non-wild parts of the key during the expansion of the replacement text.
9202 They return to their previous values at the end of the lookup item.
9203
9204 This example looks up the postmaster alias in the conventional alias file:
9205 .code
9206 ${lookup {postmaster} lsearch {/etc/aliases} {$value}}
9207 .endd
9208 This example uses NIS+ to look up the full name of the user corresponding to
9209 the local part of an address, forcing the expansion to fail if it is not found:
9210 .code
9211 ${lookup nisplus {[name=$local_part],passwd.org_dir:gcos} \
9212   {$value}fail}
9213 .endd
9214
9215
9216 .vitem &*${map{*&<&'string1'&>&*}{*&<&'string2'&>&*}}*&
9217 .cindex "expansion" "list creation"
9218 .vindex "&$item$&"
9219 After expansion, <&'string1'&> is interpreted as a list, colon-separated by
9220 default, but the separator can be changed in the usual way. For each item
9221 in this list, its value is place in &$item$&, and then <&'string2'&> is
9222 expanded and added to the output as an item in a new list. The separator used
9223 for the output list is the same as the one used for the input, but a separator
9224 setting is not included in the output. For example:
9225 .code
9226 ${map{a:b:c}{[$item]}} ${map{<- x-y-z}{($item)}}
9227 .endd
9228 expands to &`[a]:[b]:[c] (x)-(y)-(z)`&. At the end of the expansion, the
9229 value of &$item$& is restored to what it was before. See also the &*filter*&
9230 and &*reduce*& expansion items.
9231
9232 .vitem &*${nhash{*&<&'string1'&>&*}{*&<&'string2'&>&*}{*&<&'string3'&>&*}}*&
9233 .cindex "expansion" "numeric hash"
9234 .cindex "hash function" "numeric"
9235 The three strings are expanded; the first two must yield numbers. Call them
9236 <&'n'&> and <&'m'&>. If you are using fixed values for these numbers, that is,
9237 if <&'string1'&> and <&'string2'&> do not change when they are expanded, you
9238 can use the simpler operator notation that avoids some of the braces:
9239 .code
9240 ${nhash_<n>_<m>:<string>}
9241 .endd
9242 The second number is optional (in both notations). If there is only one number,
9243 the result is a number in the range 0&--<&'n'&>-1. Otherwise, the string is
9244 processed by a div/mod hash function that returns two numbers, separated by a
9245 slash, in the ranges 0 to <&'n'&>-1 and 0 to <&'m'&>-1, respectively. For
9246 example,
9247 .code
9248 ${nhash{8}{64}{supercalifragilisticexpialidocious}}
9249 .endd
9250 returns the string &"6/33"&.
9251
9252
9253
9254 .vitem &*${perl{*&<&'subroutine'&>&*}{*&<&'arg'&>&*}{*&<&'arg'&>&*}...}*&
9255 .cindex "Perl" "use in expanded string"
9256 .cindex "expansion" "calling Perl from"
9257 This item is available only if Exim has been built to include an embedded Perl
9258 interpreter. The subroutine name and the arguments are first separately
9259 expanded, and then the Perl subroutine is called with those arguments. No
9260 additional arguments need be given; the maximum number permitted, including the
9261 name of the subroutine, is nine.
9262
9263 The return value of the subroutine is inserted into the expanded string, unless
9264 the return value is &%undef%&. In that case, the expansion fails in the same
9265 way as an explicit &"fail"& on a lookup item. The return value is a scalar.
9266 Whatever you return is evaluated in a scalar context. For example, if you
9267 return the name of a Perl vector, the return value is the size of the vector,
9268 not its contents.
9269
9270 If the subroutine exits by calling Perl's &%die%& function, the expansion fails
9271 with the error message that was passed to &%die%&. More details of the embedded
9272 Perl facility are given in chapter &<<CHAPperl>>&.
9273
9274 The &(redirect)& router has an option called &%forbid_filter_perl%& which locks
9275 out the use of this expansion item in filter files.
9276
9277
9278 .vitem &*${prvs{*&<&'address'&>&*}{*&<&'secret'&>&*}{*&<&'keynumber'&>&*}}*&
9279 .cindex "&%prvs%& expansion item"
9280 The first argument is a complete email address and the second is secret
9281 keystring. The third argument, specifying a key number, is optional. If absent,
9282 it defaults to 0. The result of the expansion is a prvs-signed email address,
9283 to be typically used with the &%return_path%& option on an &(smtp)& transport
9284 as part of a bounce address tag validation (BATV) scheme. For more discussion
9285 and an example, see section &<<SECTverifyPRVS>>&.
9286
9287 .vitem "&*${prvscheck{*&<&'address'&>&*}{*&<&'secret'&>&*}&&&
9288         {*&<&'string'&>&*}}*&"
9289 .cindex "&%prvscheck%& expansion item"
9290 This expansion item is the complement of the &%prvs%& item. It is used for
9291 checking prvs-signed addresses. If the expansion of the first argument does not
9292 yield a syntactically valid prvs-signed address, the whole item expands to the
9293 empty string. When the first argument does expand to a syntactically valid
9294 prvs-signed address, the second argument is expanded, with the prvs-decoded
9295 version of the address and the key number extracted from the address in the
9296 variables &$prvscheck_address$& and &$prvscheck_keynum$&, respectively.
9297
9298 These two variables can be used in the expansion of the second argument to
9299 retrieve the secret. The validity of the prvs-signed address is then checked
9300 against the secret. The result is stored in the variable &$prvscheck_result$&,
9301 which is empty for failure or &"1"& for success.
9302
9303 The third argument is optional; if it is missing, it defaults to an empty
9304 string. This argument is now expanded. If the result is an empty string, the
9305 result of the expansion is the decoded version of the address. This is the case
9306 whether or not the signature was valid. Otherwise, the result of the expansion
9307 is the expansion of the third argument.
9308
9309 All three variables can be used in the expansion of the third argument.
9310 However, once the expansion is complete, only &$prvscheck_result$& remains set.
9311 For more discussion and an example, see section &<<SECTverifyPRVS>>&.
9312
9313 .vitem &*${readfile{*&<&'file&~name'&>&*}{*&<&'eol&~string'&>&*}}*&
9314 .cindex "expansion" "inserting an entire file"
9315 .cindex "file" "inserting into expansion"
9316 .cindex "&%readfile%& expansion item"
9317 The file name and end-of-line string are first expanded separately. The file is
9318 then read, and its contents replace the entire item. All newline characters in
9319 the file are replaced by the end-of-line string if it is present. Otherwise,
9320 newlines are left in the string.
9321 String expansion is not applied to the contents of the file. If you want this,
9322 you must wrap the item in an &%expand%& operator. If the file cannot be read,
9323 the string expansion fails.
9324
9325 The &(redirect)& router has an option called &%forbid_filter_readfile%& which
9326 locks out the use of this expansion item in filter files.
9327
9328
9329
9330 .vitem "&*${readsocket{*&<&'name'&>&*}{*&<&'request'&>&*}&&&
9331         {*&<&'timeout'&>&*}{*&<&'eol&~string'&>&*}{*&<&'fail&~string'&>&*}}*&"
9332 .cindex "expansion" "inserting from a socket"
9333 .cindex "socket, use of in expansion"
9334 .cindex "&%readsocket%& expansion item"
9335 This item inserts data from a Unix domain or Internet socket into the expanded
9336 string. The minimal way of using it uses just two arguments, as in these
9337 examples:
9338 .code
9339 ${readsocket{/socket/name}{request string}}
9340 ${readsocket{inet:some.host:1234}{request string}}
9341 .endd
9342 For a Unix domain socket, the first substring must be the path to the socket.
9343 For an Internet socket, the first substring must contain &`inet:`& followed by
9344 a host name or IP address, followed by a colon and a port, which can be a
9345 number or the name of a TCP port in &_/etc/services_&. An IP address may
9346 optionally be enclosed in square brackets. This is best for IPv6 addresses. For
9347 example:
9348 .code
9349 ${readsocket{inet:[::1]:1234}{request string}}
9350 .endd
9351 Only a single host name may be given, but if looking it up yields more than
9352 one IP address, they are each tried in turn until a connection is made. For
9353 both kinds of socket, Exim makes a connection, writes the request string
9354 (unless it is an empty string) and reads from the socket until an end-of-file
9355 is read. A timeout of 5 seconds is applied. Additional, optional arguments
9356 extend what can be done. Firstly, you can vary the timeout. For example:
9357 .code
9358 ${readsocket{/socket/name}{request string}{3s}}
9359 .endd
9360 A fourth argument allows you to change any newlines that are in the data
9361 that is read, in the same way as for &%readfile%& (see above). This example
9362 turns them into spaces:
9363 .code
9364 ${readsocket{inet:127.0.0.1:3294}{request string}{3s}{ }}
9365 .endd
9366 As with all expansions, the substrings are expanded before the processing
9367 happens. Errors in these sub-expansions cause the expansion to fail. In
9368 addition, the following errors can occur:
9369
9370 .ilist
9371 Failure to create a socket file descriptor;
9372 .next
9373 Failure to connect the socket;
9374 .next
9375 Failure to write the request string;
9376 .next
9377 Timeout on reading from the socket.
9378 .endlist
9379
9380 By default, any of these errors causes the expansion to fail. However, if
9381 you supply a fifth substring, it is expanded and used when any of the above
9382 errors occurs. For example:
9383 .code
9384 ${readsocket{/socket/name}{request string}{3s}{\n}\
9385   {socket failure}}
9386 .endd
9387 You can test for the existence of a Unix domain socket by wrapping this
9388 expansion in &`${if exists`&, but there is a race condition between that test
9389 and the actual opening of the socket, so it is safer to use the fifth argument
9390 if you want to be absolutely sure of avoiding an expansion error for a
9391 non-existent Unix domain socket, or a failure to connect to an Internet socket.
9392
9393 The &(redirect)& router has an option called &%forbid_filter_readsocket%& which
9394 locks out the use of this expansion item in filter files.
9395
9396
9397 .vitem &*${reduce{*&<&'string1'&>}{<&'string2'&>&*}{*&<&'string3'&>&*}}*&
9398 .cindex "expansion" "reducing a list to a scalar"
9399 .cindex "list" "reducing to a scalar"
9400 .vindex "&$value$&"
9401 .vindex "&$item$&"
9402 This operation reduces a list to a single, scalar string. After expansion,
9403 <&'string1'&> is interpreted as a list, colon-separated by default, but the
9404 separator can be changed in the usual way. Then <&'string2'&> is expanded and
9405 assigned to the &$value$& variable. After this, each item in the <&'string1'&>
9406 list is assigned to &$item$& in turn, and <&'string3'&> is expanded for each of
9407 them. The result of that expansion is assigned to &$value$& before the next
9408 iteration. When the end of the list is reached, the final value of &$value$& is
9409 added to the expansion output. The &*reduce*& expansion item can be used in a
9410 number of ways. For example, to add up a list of numbers:
9411 .code
9412 ${reduce {<, 1,2,3}{0}{${eval:$value+$item}}}
9413 .endd
9414 The result of that expansion would be &`6`&. The maximum of a list of numbers
9415 can be found:
9416 .code
9417 ${reduce {3:0:9:4:6}{0}{${if >{$item}{$value}{$item}{$value}}}}
9418 .endd
9419 At the end of a &*reduce*& expansion, the values of &$item$& and &$value$& are
9420 restored to what they were before. See also the &*filter*& and &*map*&
9421 expansion items.
9422
9423 .vitem &*$rheader_*&<&'header&~name'&>&*:*&&~or&~&*$rh_*&<&'header&~name'&>&*:*&
9424 This item inserts &"raw"& header lines. It is described with the &%header%&
9425 expansion item above.
9426
9427 .vitem "&*${run{*&<&'command'&>&*&~*&<&'args'&>&*}{*&<&'string1'&>&*}&&&
9428         {*&<&'string2'&>&*}}*&"
9429 .cindex "expansion" "running a command"
9430 .cindex "&%run%& expansion item"
9431 The command and its arguments are first expanded separately, and then the
9432 command is run in a separate process, but under the same uid and gid. As in
9433 other command executions from Exim, a shell is not used by default. If you want
9434 a shell, you must explicitly code it.
9435
9436 The standard input for the command exists, but is empty. The standard output
9437 and standard error are set to the same file descriptor.
9438 .cindex "return code" "from &%run%& expansion"
9439 .vindex "&$value$&"
9440 If the command succeeds (gives a zero return code) <&'string1'&> is expanded
9441 and replaces the entire item; during this expansion, the standard output/error
9442 from the command is in the variable &$value$&. If the command fails,
9443 <&'string2'&>, if present, is expanded and used. Once again, during the
9444 expansion, the standard output/error from the command is in the variable
9445 &$value$&.
9446
9447 If <&'string2'&> is absent, the result is empty. Alternatively, <&'string2'&>
9448 can be the word &"fail"& (not in braces) to force expansion failure if the
9449 command does not succeed. If both strings are omitted, the result is contents
9450 of the standard output/error on success, and nothing on failure.
9451
9452 .vindex "&$run_in_acl$&"
9453 The standard output/error of the command is put in the variable &$value$&.
9454 In this ACL example, the output of a command is logged for the admin to
9455 troubleshoot:
9456 .code
9457 warn  condition    = ${run{/usr/bin/id}{yes}{no}}
9458       log_message  = Output of id: $value
9459 .endd
9460 If the command requires shell idioms, such as the > redirect operator, the
9461 shell must be invoked directly, such as with:
9462 .code
9463 ${run{/bin/bash -c "/usr/bin/id >/tmp/id"}{yes}{yes}}
9464 .endd
9465
9466 .vindex "&$runrc$&"
9467 The return code from the command is put in the variable &$runrc$&, and this
9468 remains set afterwards, so in a filter file you can do things like this:
9469 .code
9470 if "${run{x y z}{}}$runrc" is 1 then ...
9471   elif $runrc is 2 then ...
9472   ...
9473 endif
9474 .endd
9475 If execution of the command fails (for example, the command does not exist),
9476 the return code is 127 &-- the same code that shells use for non-existent
9477 commands.
9478
9479 &*Warning*&: In a router or transport, you cannot assume the order in which
9480 option values are expanded, except for those preconditions whose order of
9481 testing is documented. Therefore, you cannot reliably expect to set &$runrc$&
9482 by the expansion of one option, and use it in another.
9483
9484 The &(redirect)& router has an option called &%forbid_filter_run%& which locks
9485 out the use of this expansion item in filter files.
9486
9487
9488 .vitem &*${sg{*&<&'subject'&>&*}{*&<&'regex'&>&*}{*&<&'replacement'&>&*}}*&
9489 .cindex "expansion" "string substitution"
9490 .cindex "&%sg%& expansion item"
9491 This item works like Perl's substitution operator (s) with the global (/g)
9492 option; hence its name. However, unlike the Perl equivalent, Exim does not
9493 modify the subject string; instead it returns the modified string for insertion
9494 into the overall expansion. The item takes three arguments: the subject string,
9495 a regular expression, and a substitution string. For example:
9496 .code
9497 ${sg{abcdefabcdef}{abc}{xyz}}
9498 .endd
9499 yields &"xyzdefxyzdef"&. Because all three arguments are expanded before use,
9500 if any $ or \ characters are required in the regular expression or in the
9501 substitution string, they have to be escaped. For example:
9502 .code
9503 ${sg{abcdef}{^(...)(...)\$}{\$2\$1}}
9504 .endd
9505 yields &"defabc"&, and
9506 .code
9507 ${sg{1=A 4=D 3=C}{\N(\d+)=\N}{K\$1=}}
9508 .endd
9509 yields &"K1=A K4=D K3=C"&. Note the use of &`\N`& to protect the contents of
9510 the regular expression from string expansion.
9511
9512
9513
9514 .vitem &*${substr{*&<&'string1'&>&*}{*&<&'string2'&>&*}{*&<&'string3'&>&*}}*&
9515 .cindex "&%substr%& expansion item"
9516 .cindex "substring extraction"
9517 .cindex "expansion" "substring extraction"
9518 The three strings are expanded; the first two must yield numbers. Call them
9519 <&'n'&> and <&'m'&>. If you are using fixed values for these numbers, that is,
9520 if <&'string1'&> and <&'string2'&> do not change when they are expanded, you
9521 can use the simpler operator notation that avoids some of the braces:
9522 .code
9523 ${substr_<n>_<m>:<string>}
9524 .endd
9525 The second number is optional (in both notations).
9526 If it is absent in the simpler format, the preceding underscore must also be
9527 omitted.
9528
9529 The &%substr%& item can be used to extract more general substrings than
9530 &%length%&. The first number, <&'n'&>, is a starting offset, and <&'m'&> is the
9531 length required. For example
9532 .code
9533 ${substr{3}{2}{$local_part}}
9534 .endd
9535 If the starting offset is greater than the string length the result is the
9536 null string; if the length plus starting offset is greater than the string
9537 length, the result is the right-hand part of the string, starting from the
9538 given offset. The first character in the string has offset zero.
9539
9540 The &%substr%& expansion item can take negative offset values to count
9541 from the right-hand end of its operand. The last character is offset -1, the
9542 second-last is offset -2, and so on. Thus, for example,
9543 .code
9544 ${substr{-5}{2}{1234567}}
9545 .endd
9546 yields &"34"&. If the absolute value of a negative offset is greater than the
9547 length of the string, the substring starts at the beginning of the string, and
9548 the length is reduced by the amount of overshoot. Thus, for example,
9549 .code
9550 ${substr{-5}{2}{12}}
9551 .endd
9552 yields an empty string, but
9553 .code
9554 ${substr{-3}{2}{12}}
9555 .endd
9556 yields &"1"&.
9557
9558 When the second number is omitted from &%substr%&, the remainder of the string
9559 is taken if the offset is positive. If it is negative, all characters in the
9560 string preceding the offset point are taken. For example, an offset of -1 and
9561 no length, as in these semantically identical examples:
9562 .code
9563 ${substr_-1:abcde}
9564 ${substr{-1}{abcde}}
9565 .endd
9566 yields all but the last character of the string, that is, &"abcd"&.
9567
9568
9569
9570 .vitem "&*${tr{*&<&'subject'&>&*}{*&<&'characters'&>&*}&&&
9571         {*&<&'replacements'&>&*}}*&"
9572 .cindex "expansion" "character translation"
9573 .cindex "&%tr%& expansion item"
9574 This item does single-character translation on its subject string. The second
9575 argument is a list of characters to be translated in the subject string. Each
9576 matching character is replaced by the corresponding character from the
9577 replacement list. For example
9578 .code
9579 ${tr{abcdea}{ac}{13}}
9580 .endd
9581 yields &`1b3de1`&. If there are duplicates in the second character string, the
9582 last occurrence is used. If the third string is shorter than the second, its
9583 last character is replicated. However, if it is empty, no translation takes
9584 place.
9585 .endlist
9586
9587
9588
9589 .section "Expansion operators" "SECTexpop"
9590 .cindex "expansion" "operators"
9591 For expansion items that perform transformations on a single argument string,
9592 the &"operator"& notation is used because it is simpler and uses fewer braces.
9593 The substring is first expanded before the operation is applied to it. The
9594 following operations can be performed:
9595
9596 .vlist
9597 .vitem &*${address:*&<&'string'&>&*}*&
9598 .cindex "expansion" "RFC 2822 address handling"
9599 .cindex "&%address%& expansion item"
9600 The string is interpreted as an RFC 2822 address, as it might appear in a
9601 header line, and the effective address is extracted from it. If the string does
9602 not parse successfully, the result is empty.
9603
9604
9605 .vitem &*${addresses:*&<&'string'&>&*}*&
9606 .cindex "expansion" "RFC 2822 address handling"
9607 .cindex "&%addresses%& expansion item"
9608 The string (after expansion) is interpreted as a list of addresses in RFC
9609 2822 format, such as can be found in a &'To:'& or &'Cc:'& header line. The
9610 operative address (&'local-part@domain'&) is extracted from each item, and the
9611 result of the expansion is a colon-separated list, with appropriate
9612 doubling of colons should any happen to be present in the email addresses.
9613 Syntactically invalid RFC2822 address items are omitted from the output.
9614
9615 It is possible to specify a character other than colon for the output
9616 separator by starting the string with > followed by the new separator
9617 character. For example:
9618 .code
9619 ${addresses:>& Chief <ceo@up.stairs>, sec@base.ment (dogsbody)}
9620 .endd
9621 expands to &`ceo@up.stairs&&sec@base.ment`&. Compare the &*address*& (singular)
9622 expansion item, which extracts the working address from a single RFC2822
9623 address. See the &*filter*&, &*map*&, and &*reduce*& items for ways of
9624 processing lists.
9625
9626
9627 .vitem &*${base62:*&<&'digits'&>&*}*&
9628 .cindex "&%base62%& expansion item"
9629 .cindex "expansion" "conversion to base 62"
9630 The string must consist entirely of decimal digits. The number is converted to
9631 base 62 and output as a string of six characters, including leading zeros. In
9632 the few operating environments where Exim uses base 36 instead of base 62 for
9633 its message identifiers (because those systems do not have case-sensitive file
9634 names), base 36 is used by this operator, despite its name. &*Note*&: Just to
9635 be absolutely clear: this is &'not'& base64 encoding.
9636
9637 .vitem &*${base62d:*&<&'base-62&~digits'&>&*}*&
9638 .cindex "&%base62d%& expansion item"
9639 .cindex "expansion" "conversion to base 62"
9640 The string must consist entirely of base-62 digits, or, in operating
9641 environments where Exim uses base 36 instead of base 62 for its message
9642 identifiers, base-36 digits. The number is converted to decimal and output as a
9643 string.
9644
9645
9646 .vitem &*${domain:*&<&'string'&>&*}*&
9647 .cindex "domain" "extraction"
9648 .cindex "expansion" "domain extraction"
9649 The string is interpreted as an RFC 2822 address and the domain is extracted
9650 from it. If the string does not parse successfully, the result is empty.
9651
9652
9653 .vitem &*${escape:*&<&'string'&>&*}*&
9654 .cindex "expansion" "escaping non-printing characters"
9655 .cindex "&%escape%& expansion item"
9656 If the string contains any non-printing characters, they are converted to
9657 escape sequences starting with a backslash. Whether characters with the most
9658 significant bit set (so-called &"8-bit characters"&) count as printing or not
9659 is controlled by the &%print_topbitchars%& option.
9660
9661
9662 .vitem &*${eval:*&<&'string'&>&*}*&&~and&~&*${eval10:*&<&'string'&>&*}*&
9663 .cindex "expansion" "expression evaluation"
9664 .cindex "expansion" "arithmetic expression"
9665 .cindex "&%eval%& expansion item"
9666 These items supports simple arithmetic and bitwise logical operations in
9667 expansion strings. The string (after expansion) must be a conventional
9668 arithmetic expression, but it is limited to basic arithmetic operators, bitwise
9669 logical operators, and parentheses. All operations are carried out using
9670 integer arithmetic. The operator priorities are as follows (the same as in the
9671 C programming language):
9672 .table2 70pt 300pt
9673 .irow &'highest:'& "not (~), negate (-)"
9674 .irow ""   "multiply (*), divide (/), remainder (%)"
9675 .irow ""   "plus (+), minus (-)"
9676 .irow ""   "shift-left (<<), shift-right (>>)"
9677 .irow ""   "and (&&)"
9678 .irow ""   "xor (^)"
9679 .irow &'lowest:'&  "or (|)"
9680 .endtable
9681 Binary operators with the same priority are evaluated from left to right. White
9682 space is permitted before or after operators.
9683
9684 For &%eval%&, numbers may be decimal, octal (starting with &"0"&) or
9685 hexadecimal (starting with &"0x"&). For &%eval10%&, all numbers are taken as
9686 decimal, even if they start with a leading zero; hexadecimal numbers are not
9687 permitted. This can be useful when processing numbers extracted from dates or
9688 times, which often do have leading zeros.
9689
9690 A number may be followed by &"K"&, &"M"& or &"G"& to multiply it by 1024, 1024*1024
9691 or 1024*1024*1024,
9692 respectively. Negative numbers are supported. The result of the computation is
9693 a decimal representation of the answer (without &"K"&, &"M"& or &"G"&). For example:
9694
9695 .display
9696 &`${eval:1+1}            `&  yields 2
9697 &`${eval:1+2*3}          `&  yields 7
9698 &`${eval:(1+2)*3}        `&  yields 9
9699 &`${eval:2+42%5}         `&  yields 4
9700 &`${eval:0xc&amp;5}          `&  yields 4
9701 &`${eval:0xc|5}          `&  yields 13
9702 &`${eval:0xc^5}          `&  yields 9
9703 &`${eval:0xc>>1}         `&  yields 6
9704 &`${eval:0xc<<1}         `&  yields 24
9705 &`${eval:~255&amp;0x1234}    `&  yields 4608
9706 &`${eval:-(~255&amp;0x1234)} `&  yields -4608
9707 .endd
9708
9709 As a more realistic example, in an ACL you might have
9710 .code
9711 deny   message = Too many bad recipients
9712        condition =                    \
9713          ${if and {                   \
9714            {>{$rcpt_count}{10}}       \
9715            {                          \
9716            <                          \
9717              {$recipients_count}      \
9718              {${eval:$rcpt_count/2}}  \
9719            }                          \
9720          }{yes}{no}}
9721 .endd
9722 The condition is true if there have been more than 10 RCPT commands and
9723 fewer than half of them have resulted in a valid recipient.
9724
9725
9726 .vitem &*${expand:*&<&'string'&>&*}*&
9727 .cindex "expansion" "re-expansion of substring"
9728 The &%expand%& operator causes a string to be expanded for a second time. For
9729 example,
9730 .code
9731 ${expand:${lookup{$domain}dbm{/some/file}{$value}}}
9732 .endd
9733 first looks up a string in a file while expanding the operand for &%expand%&,
9734 and then re-expands what it has found.
9735
9736
9737 .vitem &*${from_utf8:*&<&'string'&>&*}*&
9738 .cindex "Unicode"
9739 .cindex "UTF-8" "conversion from"
9740 .cindex "expansion" "UTF-8 conversion"
9741 .cindex "&%from_utf8%& expansion item"
9742 The world is slowly moving towards Unicode, although there are no standards for
9743 email yet. However, other applications (including some databases) are starting
9744 to store data in Unicode, using UTF-8 encoding. This operator converts from a
9745 UTF-8 string to an ISO-8859-1 string. UTF-8 code values greater than 255 are
9746 converted to underscores. The input must be a valid UTF-8 string. If it is not,
9747 the result is an undefined sequence of bytes.
9748
9749 Unicode code points with values less than 256 are compatible with ASCII and
9750 ISO-8859-1 (also known as Latin-1).
9751 For example, character 169 is the copyright symbol in both cases, though the
9752 way it is encoded is different. In UTF-8, more than one byte is needed for
9753 characters with code values greater than 127, whereas ISO-8859-1 is a
9754 single-byte encoding (but thereby limited to 256 characters). This makes
9755 translation from UTF-8 to ISO-8859-1 straightforward.
9756
9757
9758 .vitem &*${hash_*&<&'n'&>&*_*&<&'m'&>&*:*&<&'string'&>&*}*&
9759 .cindex "hash function" "textual"
9760 .cindex "expansion" "textual hash"
9761 The &%hash%& operator is a simpler interface to the hashing function that can
9762 be used when the two parameters are fixed numbers (as opposed to strings that
9763 change when expanded). The effect is the same as
9764 .code
9765 ${hash{<n>}{<m>}{<string>}}
9766 .endd
9767 See the description of the general &%hash%& item above for details. The
9768 abbreviation &%h%& can be used when &%hash%& is used as an operator.
9769
9770
9771
9772 .vitem &*${hex2b64:*&<&'hexstring'&>&*}*&
9773 .cindex "base64 encoding" "conversion from hex"
9774 .cindex "expansion" "hex to base64"
9775 .cindex "&%hex2b64%& expansion item"
9776 This operator converts a hex string into one that is base64 encoded. This can
9777 be useful for processing the output of the MD5 and SHA-1 hashing functions.
9778
9779
9780
9781 .vitem &*${hexquote:*&<&'string'&>&*}*&
9782 .cindex "quoting" "hex-encoded unprintable characters"
9783 .cindex "&%hexquote%& expansion item"
9784 This operator converts non-printable characters in a string into a hex
9785 escape form. Byte values between 33 (!) and 126 (~) inclusive are left
9786 as is, and other byte values are converted to &`\xNN`&, for example a
9787 byt value 127 is converted to &`\x7f`&.
9788
9789
9790 .vitem &*${lc:*&<&'string'&>&*}*&
9791 .cindex "case forcing in strings"
9792 .cindex "string" "case forcing"
9793 .cindex "lower casing"
9794 .cindex "expansion" "case forcing"
9795 .cindex "&%lc%& expansion item"
9796 This forces the letters in the string into lower-case, for example:
9797 .code
9798 ${lc:$local_part}
9799 .endd
9800
9801 .vitem &*${length_*&<&'number'&>&*:*&<&'string'&>&*}*&
9802 .cindex "expansion" "string truncation"
9803 .cindex "&%length%& expansion item"
9804 The &%length%& operator is a simpler interface to the &%length%& function that
9805 can be used when the parameter is a fixed number (as opposed to a string that
9806 changes when expanded). The effect is the same as
9807 .code
9808 ${length{<number>}{<string>}}
9809 .endd
9810 See the description of the general &%length%& item above for details. Note that
9811 &%length%& is not the same as &%strlen%&. The abbreviation &%l%& can be used
9812 when &%length%& is used as an operator.
9813
9814
9815 .vitem &*${listcount:*&<&'string'&>&*}*&
9816 .cindex "expansion" "list item count"
9817 .cindex "list" "item count"
9818 .cindex "list" "count of items"
9819 .cindex "&%listcount%& expansion item"
9820 The string is interpreted as a list and the number of items is returned.
9821
9822
9823 .vitem &*${listnamed:*&<&'name'&>&*}*&&~and&~&*${list_*&<&'type'&>&*name*&>&*}*&
9824 .cindex "expansion" "named list"
9825 .cindex "&%listnamed%& expansion item"
9826 The name is interpreted as a named list and the content of the list is returned,
9827 expanding any referenced lists, re-quoting as needed for colon-separation.
9828 If the optional type if given it must be one of "a", "d", "h" or "l"
9829 and selects address-, domain-, host- or localpart- lists to search among respectively.
9830 Otherwise all types are searched in an undefined order and the first
9831 matching list is returned.
9832
9833
9834 .vitem &*${local_part:*&<&'string'&>&*}*&
9835 .cindex "expansion" "local part extraction"
9836 .cindex "&%local_part%& expansion item"
9837 The string is interpreted as an RFC 2822 address and the local part is
9838 extracted from it. If the string does not parse successfully, the result is
9839 empty.
9840
9841
9842 .vitem &*${mask:*&<&'IP&~address'&>&*/*&<&'bit&~count'&>&*}*&
9843 .cindex "masked IP address"
9844 .cindex "IP address" "masking"
9845 .cindex "CIDR notation"
9846 .cindex "expansion" "IP address masking"
9847 .cindex "&%mask%& expansion item"
9848 If the form of the string to be operated on is not an IP address followed by a
9849 slash and an integer (that is, a network address in CIDR notation), the
9850 expansion fails. Otherwise, this operator converts the IP address to binary,
9851 masks off the least significant bits according to the bit count, and converts
9852 the result back to text, with mask appended. For example,
9853 .code
9854 ${mask:10.111.131.206/28}
9855 .endd
9856 returns the string &"10.111.131.192/28"&. Since this operation is expected to
9857 be mostly used for looking up masked addresses in files, the result for an IPv6
9858 address uses dots to separate components instead of colons, because colon
9859 terminates a key string in lsearch files. So, for example,
9860 .code
9861 ${mask:3ffe:ffff:836f:0a00:000a:0800:200a:c031/99}
9862 .endd
9863 returns the string
9864 .code
9865 3ffe.ffff.836f.0a00.000a.0800.2000.0000/99
9866 .endd
9867 Letters in IPv6 addresses are always output in lower case.
9868
9869
9870 .vitem &*${md5:*&<&'string'&>&*}*&
9871 .cindex "MD5 hash"
9872 .cindex "expansion" "MD5 hash"
9873 .cindex "&%md5%& expansion item"
9874 The &%md5%& operator computes the MD5 hash value of the string, and returns it
9875 as a 32-digit hexadecimal number, in which any letters are in lower case.
9876
9877
9878 .vitem &*${nhash_*&<&'n'&>&*_*&<&'m'&>&*:*&<&'string'&>&*}*&
9879 .cindex "expansion" "numeric hash"
9880 .cindex "hash function" "numeric"
9881 The &%nhash%& operator is a simpler interface to the numeric hashing function
9882 that can be used when the two parameters are fixed numbers (as opposed to
9883 strings that change when expanded). The effect is the same as
9884 .code
9885 ${nhash{<n>}{<m>}{<string>}}
9886 .endd
9887 See the description of the general &%nhash%& item above for details.
9888
9889
9890 .vitem &*${quote:*&<&'string'&>&*}*&
9891 .cindex "quoting" "in string expansions"
9892 .cindex "expansion" "quoting"
9893 .cindex "&%quote%& expansion item"
9894 The &%quote%& operator puts its argument into double quotes if it
9895 is an empty string or
9896 contains anything other than letters, digits, underscores, dots, and hyphens.
9897 Any occurrences of double quotes and backslashes are escaped with a backslash.
9898 Newlines and carriage returns are converted to &`\n`& and &`\r`&,
9899 respectively For example,
9900 .code
9901 ${quote:ab"*"cd}
9902 .endd
9903 becomes
9904 .code
9905 "ab\"*\"cd"
9906 .endd
9907 The place where this is useful is when the argument is a substitution from a
9908 variable or a message header.
9909
9910 .vitem &*${quote_local_part:*&<&'string'&>&*}*&
9911 .cindex "&%quote_local_part%& expansion item"
9912 This operator is like &%quote%&, except that it quotes the string only if
9913 required to do so by the rules of RFC 2822 for quoting local parts. For
9914 example, a plus sign would not cause quoting (but it would for &%quote%&).
9915 If you are creating a new email address from the contents of &$local_part$&
9916 (or any other unknown data), you should always use this operator.
9917
9918
9919 .vitem &*${quote_*&<&'lookup-type'&>&*:*&<&'string'&>&*}*&
9920 .cindex "quoting" "lookup-specific"
9921 This operator applies lookup-specific quoting rules to the string. Each
9922 query-style lookup type has its own quoting rules which are described with
9923 the lookups in chapter &<<CHAPfdlookup>>&. For example,
9924 .code
9925 ${quote_ldap:two * two}
9926 .endd
9927 returns
9928 .code
9929 two%20%5C2A%20two
9930 .endd
9931 For single-key lookup types, no quoting is ever necessary and this operator
9932 yields an unchanged string.
9933
9934
9935 .vitem &*${randint:*&<&'n'&>&*}*&
9936 .cindex "random number"
9937 This operator returns a somewhat random number which is less than the
9938 supplied number and is at least 0.  The quality of this randomness depends
9939 on how Exim was built; the values are not suitable for keying material.
9940 If Exim is linked against OpenSSL then RAND_pseudo_bytes() is used.
9941 If Exim is linked against GnuTLS then gnutls_rnd(GNUTLS_RND_NONCE) is used,
9942 for versions of GnuTLS with that function.
9943 Otherwise, the implementation may be arc4random(), random() seeded by
9944 srandomdev() or srandom(), or a custom implementation even weaker than
9945 random().
9946
9947
9948 .vitem &*${reverse_ip:*&<&'ipaddr'&>&*}*&
9949 .cindex "expansion" "IP address"
9950 This operator reverses an IP address; for IPv4 addresses, the result is in
9951 dotted-quad decimal form, while for IPv6 addreses the result is in
9952 dotted-nibble hexadecimal form.  In both cases, this is the "natural" form
9953 for DNS.  For example,
9954 .code
9955 ${reverse_ip:192.0.2.4}
9956 ${reverse_ip:2001:0db8:c42:9:1:abcd:192.0.2.127}
9957 .endd
9958 returns
9959 .code
9960 4.2.0.192
9961 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
9962 .endd
9963
9964
9965 .vitem &*${rfc2047:*&<&'string'&>&*}*&
9966 .cindex "expansion" "RFC 2047"
9967 .cindex "RFC 2047" "expansion operator"
9968 .cindex "&%rfc2047%& expansion item"
9969 This operator encodes text according to the rules of RFC 2047. This is an
9970 encoding that is used in header lines to encode non-ASCII characters. It is
9971 assumed that the input string is in the encoding specified by the
9972 &%headers_charset%& option, which defaults to ISO-8859-1. If the string
9973 contains only characters in the range 33&--126, and no instances of the
9974 characters
9975 .code
9976 ? = ( ) < > @ , ; : \ " . [ ] _
9977 .endd
9978 it is not modified. Otherwise, the result is the RFC 2047 encoding of the
9979 string, using as many &"encoded words"& as necessary to encode all the
9980 characters.
9981
9982
9983 .vitem &*${rfc2047d:*&<&'string'&>&*}*&
9984 .cindex "expansion" "RFC 2047"
9985 .cindex "RFC 2047" "decoding"
9986 .cindex "&%rfc2047d%& expansion item"
9987 This operator decodes strings that are encoded as per RFC 2047. Binary zero
9988 bytes are replaced by question marks. Characters are converted into the
9989 character set defined by &%headers_charset%&. Overlong RFC 2047 &"words"& are
9990 not recognized unless &%check_rfc2047_length%& is set false.
9991
9992 &*Note*&: If you use &%$header%&_&'xxx'&&*:*& (or &%$h%&_&'xxx'&&*:*&) to
9993 access a header line, RFC 2047 decoding is done automatically. You do not need
9994 to use this operator as well.
9995
9996
9997
9998 .vitem &*${rxquote:*&<&'string'&>&*}*&
9999 .cindex "quoting" "in regular expressions"
10000 .cindex "regular expressions" "quoting"
10001 .cindex "&%rxquote%& expansion item"
10002 The &%rxquote%& operator inserts a backslash before any non-alphanumeric
10003 characters in its argument. This is useful when substituting the values of
10004 variables or headers inside regular expressions.
10005
10006
10007 .vitem &*${sha1:*&<&'string'&>&*}*&
10008 .cindex "SHA-1 hash"
10009 .cindex "expansion" "SHA-1 hashing"
10010 .cindex "&%sha2%& expansion item"
10011 The &%sha1%& operator computes the SHA-1 hash value of the string, and returns
10012 it as a 40-digit hexadecimal number, in which any letters are in upper case.
10013
10014
10015 .vitem &*${stat:*&<&'string'&>&*}*&
10016 .cindex "expansion" "statting a file"
10017 .cindex "file" "extracting characteristics"
10018 .cindex "&%stat%& expansion item"
10019 The string, after expansion, must be a file path. A call to the &[stat()]&
10020 function is made for this path. If &[stat()]& fails, an error occurs and the
10021 expansion fails. If it succeeds, the data from the stat replaces the item, as a
10022 series of <&'name'&>=<&'value'&> pairs, where the values are all numerical,
10023 except for the value of &"smode"&. The names are: &"mode"& (giving the mode as
10024 a 4-digit octal number), &"smode"& (giving the mode in symbolic format as a
10025 10-character string, as for the &'ls'& command), &"inode"&, &"device"&,
10026 &"links"&, &"uid"&, &"gid"&, &"size"&, &"atime"&, &"mtime"&, and &"ctime"&. You
10027 can extract individual fields using the &%extract%& expansion item.
10028
10029 The use of the &%stat%& expansion in users' filter files can be locked out by
10030 the system administrator. &*Warning*&: The file size may be incorrect on 32-bit
10031 systems for files larger than 2GB.
10032
10033 .vitem &*${str2b64:*&<&'string'&>&*}*&
10034 .cindex "expansion" "base64 encoding"
10035 .cindex "base64 encoding" "in string expansion"
10036 .cindex "&%str2b64%& expansion item"
10037 This operator converts a string into one that is base64 encoded.
10038
10039
10040
10041 .vitem &*${strlen:*&<&'string'&>&*}*&
10042 .cindex "expansion" "string length"
10043 .cindex "string" "length in expansion"
10044 .cindex "&%strlen%& expansion item"
10045 The item is replace by the length of the expanded string, expressed as a
10046 decimal number. &*Note*&: Do not confuse &%strlen%& with &%length%&.
10047
10048
10049 .vitem &*${substr_*&<&'start'&>&*_*&<&'length'&>&*:*&<&'string'&>&*}*&
10050 .cindex "&%substr%& expansion item"
10051 .cindex "substring extraction"
10052 .cindex "expansion" "substring expansion"
10053 The &%substr%& operator is a simpler interface to the &%substr%& function that
10054 can be used when the two parameters are fixed numbers (as opposed to strings
10055 that change when expanded). The effect is the same as
10056 .code
10057 ${substr{<start>}{<length>}{<string>}}
10058 .endd
10059 See the description of the general &%substr%& item above for details. The
10060 abbreviation &%s%& can be used when &%substr%& is used as an operator.
10061
10062 .vitem &*${time_eval:*&<&'string'&>&*}*&
10063 .cindex "&%time_eval%& expansion item"
10064 .cindex "time interval" "decoding"
10065 This item converts an Exim time interval such as &`2d4h5m`& into a number of
10066 seconds.
10067
10068 .vitem &*${time_interval:*&<&'string'&>&*}*&
10069 .cindex "&%time_interval%& expansion item"
10070 .cindex "time interval" "formatting"
10071 The argument (after sub-expansion) must be a sequence of decimal digits that
10072 represents an interval of time as a number of seconds. It is converted into a
10073 number of larger units and output in Exim's normal time format, for example,
10074 &`1w3d4h2m6s`&.
10075
10076 .vitem &*${uc:*&<&'string'&>&*}*&
10077 .cindex "case forcing in strings"
10078 .cindex "string" "case forcing"
10079 .cindex "upper casing"
10080 .cindex "expansion" "case forcing"
10081 .cindex "&%uc%& expansion item"
10082 This forces the letters in the string into upper-case.
10083 .endlist
10084
10085
10086
10087
10088
10089
10090 .section "Expansion conditions" "SECTexpcond"
10091 .scindex IIDexpcond "expansion" "conditions"
10092 The following conditions are available for testing by the &%${if%& construct
10093 while expanding strings:
10094
10095 .vlist
10096 .vitem &*!*&<&'condition'&>
10097 .cindex "expansion" "negating a condition"
10098 .cindex "negation" "in expansion condition"
10099 Preceding any condition with an exclamation mark negates the result of the
10100 condition.
10101
10102 .vitem <&'symbolic&~operator'&>&~&*{*&<&'string1'&>&*}{*&<&'string2'&>&*}*&
10103 .cindex "numeric comparison"
10104 .cindex "expansion" "numeric comparison"
10105 There are a number of symbolic operators for doing numeric comparisons. They
10106 are:
10107 .display
10108 &`=   `&   equal
10109 &`==  `&   equal
10110 &`>   `&   greater
10111 &`>=  `&   greater or equal
10112 &`<   `&   less
10113 &`<=  `&   less or equal
10114 .endd
10115 For example:
10116 .code
10117 ${if >{$message_size}{10M} ...
10118 .endd
10119 Note that the general negation operator provides for inequality testing. The
10120 two strings must take the form of optionally signed decimal integers,
10121 optionally followed by one of the letters &"K"&, &"M"& or &"G"& (in either upper or
10122 lower case), signifying multiplication by 1024, 1024*1024 or 1024*1024*1024, respectively.
10123 As a special case, the numerical value of an empty string is taken as
10124 zero.
10125
10126 In all cases, a relative comparator OP is testing if <&'string1'&> OP
10127 <&'string2'&>; the above example is checking if &$message_size$& is larger than
10128 10M, not if 10M is larger than &$message_size$&.
10129
10130
10131 .vitem &*acl&~{{*&<&'name'&>&*}{*&<&'arg1'&>&*}&&&
10132         {*&<&'arg2'&>&*}...}*&
10133 .cindex "expansion" "calling an acl"
10134 .cindex "&%acl%&" "expansion condition"
10135 The name and zero to nine argument strings are first expanded separately.  The expanded
10136 arguments are assigned to the variables &$acl_arg1$& to &$acl_arg9$& in order.
10137 Any unused are made empty.  The variable &$acl_narg$& is set to the number of
10138 arguments.  The named ACL (see chapter &<<CHAPACL>>&) is called
10139 and may use the variables; if another acl expansion is used the values
10140 are restored after it returns.  If the ACL sets
10141 a value using a "message =" modifier the variable $value becomes
10142 the result of the expansion, otherwise it is empty.
10143 If the ACL returns accept the condition is true; if deny, false.
10144 If the ACL returns defer the result is a forced-fail.
10145
10146 .vitem &*bool&~{*&<&'string'&>&*}*&
10147 .cindex "expansion" "boolean parsing"
10148 .cindex "&%bool%& expansion condition"
10149 This condition turns a string holding a true or false representation into
10150 a boolean state.  It parses &"true"&, &"false"&, &"yes"& and &"no"&
10151 (case-insensitively); also positive integer numbers map to true if non-zero,
10152 false if zero.
10153 An empty string is treated as false.
10154 Leading and trailing whitespace is ignored;
10155 thus a string consisting only of whitespace is false.
10156 All other string values will result in expansion failure.
10157
10158 When combined with ACL variables, this expansion condition will let you
10159 make decisions in one place and act on those decisions in another place.
10160 For example:
10161 .code
10162 ${if bool{$acl_m_privileged_sender} ...
10163 .endd
10164
10165
10166 .vitem &*bool_lax&~{*&<&'string'&>&*}*&
10167 .cindex "expansion" "boolean parsing"
10168 .cindex "&%bool_lax%& expansion condition"
10169 Like &%bool%&, this condition turns a string into a boolean state.  But
10170 where &%bool%& accepts a strict set of strings, &%bool_lax%& uses the same
10171 loose definition that the Router &%condition%& option uses.  The empty string
10172 and the values &"false"&, &"no"& and &"0"& map to false, all others map to
10173 true.  Leading and trailing whitespace is ignored.
10174
10175 Note that where &"bool{00}"& is false, &"bool_lax{00}"& is true.
10176
10177 .vitem &*crypteq&~{*&<&'string1'&>&*}{*&<&'string2'&>&*}*&
10178 .cindex "expansion" "encrypted comparison"
10179 .cindex "encrypted strings, comparing"
10180 .cindex "&%crypteq%& expansion condition"
10181 This condition is included in the Exim binary if it is built to support any
10182 authentication mechanisms (see chapter &<<CHAPSMTPAUTH>>&). Otherwise, it is
10183 necessary to define SUPPORT_CRYPTEQ in &_Local/Makefile_& to get &%crypteq%&
10184 included in the binary.
10185
10186 The &%crypteq%& condition has two arguments. The first is encrypted and
10187 compared against the second, which is already encrypted. The second string may
10188 be in the LDAP form for storing encrypted strings, which starts with the
10189 encryption type in curly brackets, followed by the data. If the second string
10190 does not begin with &"{"& it is assumed to be encrypted with &[crypt()]& or
10191 &[crypt16()]& (see below), since such strings cannot begin with &"{"&.
10192 Typically this will be a field from a password file. An example of an encrypted
10193 string in LDAP form is:
10194 .code
10195 {md5}CY9rzUYh03PK3k6DJie09g==
10196 .endd
10197 If such a string appears directly in an expansion, the curly brackets have to
10198 be quoted, because they are part of the expansion syntax. For example:
10199 .code
10200 ${if crypteq {test}{\{md5\}CY9rzUYh03PK3k6DJie09g==}{yes}{no}}
10201 .endd
10202 The following encryption types (whose names are matched case-independently) are
10203 supported:
10204
10205 .ilist
10206 .cindex "MD5 hash"
10207 .cindex "base64 encoding" "in encrypted password"
10208 &%{md5}%& computes the MD5 digest of the first string, and expresses this as
10209 printable characters to compare with the remainder of the second string. If the
10210 length of the comparison string is 24, Exim assumes that it is base64 encoded
10211 (as in the above example). If the length is 32, Exim assumes that it is a
10212 hexadecimal encoding of the MD5 digest. If the length not 24 or 32, the
10213 comparison fails.
10214
10215 .next
10216 .cindex "SHA-1 hash"
10217 &%{sha1}%& computes the SHA-1 digest of the first string, and expresses this as
10218 printable characters to compare with the remainder of the second string. If the
10219 length of the comparison string is 28, Exim assumes that it is base64 encoded.
10220 If the length is 40, Exim assumes that it is a hexadecimal encoding of the
10221 SHA-1 digest. If the length is not 28 or 40, the comparison fails.
10222
10223 .next
10224 .cindex "&[crypt()]&"
10225 &%{crypt}%& calls the &[crypt()]& function, which traditionally used to use
10226 only the first eight characters of the password. However, in modern operating
10227 systems this is no longer true, and in many cases the entire password is used,
10228 whatever its length.
10229
10230 .next
10231 .cindex "&[crypt16()]&"
10232 &%{crypt16}%& calls the &[crypt16()]& function, which was originally created to
10233 use up to 16 characters of the password in some operating systems. Again, in
10234 modern operating systems, more characters may be used.
10235 .endlist
10236 Exim has its own version of &[crypt16()]&, which is just a double call to
10237 &[crypt()]&. For operating systems that have their own version, setting
10238 HAVE_CRYPT16 in &_Local/Makefile_& when building Exim causes it to use the
10239 operating system version instead of its own. This option is set by default in
10240 the OS-dependent &_Makefile_& for those operating systems that are known to
10241 support &[crypt16()]&.
10242
10243 Some years after Exim's &[crypt16()]& was implemented, a user discovered that
10244 it was not using the same algorithm as some operating systems' versions. It
10245 turns out that as well as &[crypt16()]& there is a function called
10246 &[bigcrypt()]& in some operating systems. This may or may not use the same
10247 algorithm, and both of them may be different to Exim's built-in &[crypt16()]&.
10248
10249 However, since there is now a move away from the traditional &[crypt()]&
10250 functions towards using SHA1 and other algorithms, tidying up this area of
10251 Exim is seen as very low priority.
10252
10253 If you do not put a encryption type (in curly brackets) in a &%crypteq%&
10254 comparison, the default is usually either &`{crypt}`& or &`{crypt16}`&, as
10255 determined by the setting of DEFAULT_CRYPT in &_Local/Makefile_&. The default
10256 default is &`{crypt}`&. Whatever the default, you can always use either
10257 function by specifying it explicitly in curly brackets.
10258
10259 .vitem &*def:*&<&'variable&~name'&>
10260 .cindex "expansion" "checking for empty variable"
10261 .cindex "&%def%& expansion condition"
10262 The &%def%& condition must be followed by the name of one of the expansion
10263 variables defined in section &<<SECTexpvar>>&. The condition is true if the
10264 variable does not contain the empty string. For example:
10265 .code
10266 ${if def:sender_ident {from $sender_ident}}
10267 .endd
10268 Note that the variable name is given without a leading &%$%& character. If the
10269 variable does not exist, the expansion fails.
10270
10271 .vitem "&*def:header_*&<&'header&~name'&>&*:*&&~&~or&~&&&
10272         &~&*def:h_*&<&'header&~name'&>&*:*&"
10273 .cindex "expansion" "checking header line existence"
10274 This condition is true if a message is being processed and the named header
10275 exists in the message. For example,
10276 .code
10277 ${if def:header_reply-to:{$h_reply-to:}{$h_from:}}
10278 .endd
10279 &*Note*&: No &%$%& appears before &%header_%& or &%h_%& in the condition, and
10280 the header name must be terminated by a colon if white space does not follow.
10281
10282 .vitem &*eq&~{*&<&'string1'&>&*}{*&<&'string2'&>&*}*& &&&
10283        &*eqi&~{*&<&'string1'&>&*}{*&<&'string2'&>&*}*&
10284 .cindex "string" "comparison"
10285 .cindex "expansion" "string comparison"
10286 .cindex "&%eq%& expansion condition"
10287 .cindex "&%eqi%& expansion condition"
10288 The two substrings are first expanded. The condition is true if the two
10289 resulting strings are identical. For &%eq%& the comparison includes the case of
10290 letters, whereas for &%eqi%& the comparison is case-independent.
10291
10292 .vitem &*exists&~{*&<&'file&~name'&>&*}*&
10293 .cindex "expansion" "file existence test"
10294 .cindex "file" "existence test"
10295 .cindex "&%exists%&, expansion condition"
10296 The substring is first expanded and then interpreted as an absolute path. The
10297 condition is true if the named file (or directory) exists. The existence test
10298 is done by calling the &[stat()]& function. The use of the &%exists%& test in
10299 users' filter files may be locked out by the system administrator.
10300
10301 .vitem &*first_delivery*&
10302 .cindex "delivery" "first"
10303 .cindex "first delivery"
10304 .cindex "expansion" "first delivery test"
10305 .cindex "&%first_delivery%& expansion condition"
10306 This condition, which has no data, is true during a message's first delivery
10307 attempt. It is false during any subsequent delivery attempts.
10308
10309
10310 .vitem "&*forall{*&<&'a list'&>&*}{*&<&'a condition'&>&*}*&" &&&
10311        "&*forany{*&<&'a list'&>&*}{*&<&'a condition'&>&*}*&"
10312 .cindex "list" "iterative conditions"
10313 .cindex "expansion" "&*forall*& condition"
10314 .cindex "expansion" "&*forany*& condition"
10315 .vindex "&$item$&"
10316 These conditions iterate over a list. The first argument is expanded to form
10317 the list. By default, the list separator is a colon, but it can be changed by
10318 the normal method. The second argument is interpreted as a condition that is to
10319 be applied to each item in the list in turn. During the interpretation of the
10320 condition, the current list item is placed in a variable called &$item$&.
10321 .ilist
10322 For &*forany*&, interpretation stops if the condition is true for any item, and
10323 the result of the whole condition is true. If the condition is false for all
10324 items in the list, the overall condition is false.
10325 .next
10326 For &*forall*&, interpretation stops if the condition is false for any item,
10327 and the result of the whole condition is false. If the condition is true for
10328 all items in the list, the overall condition is true.
10329 .endlist
10330 Note that negation of &*forany*& means that the condition must be false for all
10331 items for the overall condition to succeed, and negation of &*forall*& means
10332 that the condition must be false for at least one item. In this example, the
10333 list separator is changed to a comma:
10334 .code
10335 ${if forany{<, $recipients}{match{$item}{^user3@}}{yes}{no}}
10336 .endd
10337 The value of &$item$& is saved and restored while &*forany*& or &*forall*& is
10338 being processed, to enable these expansion items to be nested.
10339
10340 To scan a named list, expand it with the &*listnamed*& operator.
10341
10342
10343 .vitem &*ge&~{*&<&'string1'&>&*}{*&<&'string2'&>&*}*& &&&
10344        &*gei&~{*&<&'string1'&>&*}{*&<&'string2'&>&*}*&
10345 .cindex "string" "comparison"
10346 .cindex "expansion" "string comparison"
10347 .cindex "&%ge%& expansion condition"
10348 .cindex "&%gei%& expansion condition"
10349 The two substrings are first expanded. The condition is true if the first
10350 string is lexically greater than or equal to the second string. For &%ge%& the
10351 comparison includes the case of letters, whereas for &%gei%& the comparison is
10352 case-independent.
10353
10354 .vitem &*gt&~{*&<&'string1'&>&*}{*&<&'string2'&>&*}*& &&&
10355        &*gti&~{*&<&'string1'&>&*}{*&<&'string2'&>&*}*&
10356 .cindex "string" "comparison"
10357 .cindex "expansion" "string comparison"
10358 .cindex "&%gt%& expansion condition"
10359 .cindex "&%gti%& expansion condition"
10360 The two substrings are first expanded. The condition is true if the first
10361 string is lexically greater than the second string. For &%gt%& the comparison
10362 includes the case of letters, whereas for &%gti%& the comparison is
10363 case-independent.
10364
10365 .vitem &*inlist&~{*&<&'string1'&>&*}{*&<&'string2'&>&*}*& &&&
10366        &*inlisti&~{*&<&'string1'&>&*}{*&<&'string2'&>&*}*&
10367 .cindex "string" "comparison"
10368 .cindex "list" "iterative conditions"
10369 Both strings are expanded; the second string is treated as a list of simple
10370 strings; if the first string is a member of the second, then the condition
10371 is true.
10372
10373 These are simpler to use versions of the more powerful &*forany*& condition.
10374 Examples, and the &*forany*& equivalents:
10375 .code
10376 ${if inlist{needle}{foo:needle:bar}}
10377   ${if forany{foo:needle:bar}{eq{$item}{needle}}}
10378 ${if inlisti{Needle}{fOo:NeeDLE:bAr}}
10379   ${if forany{fOo:NeeDLE:bAr}{eqi{$item}{Needle}}}
10380 .endd
10381
10382 .vitem &*isip&~{*&<&'string'&>&*}*&  &&&
10383        &*isip4&~{*&<&'string'&>&*}*& &&&
10384        &*isip6&~{*&<&'string'&>&*}*&
10385 .cindex "IP address" "testing string format"
10386 .cindex "string" "testing for IP address"
10387 .cindex "&%isip%& expansion condition"
10388 .cindex "&%isip4%& expansion condition"
10389 .cindex "&%isip6%& expansion condition"
10390 The substring is first expanded, and then tested to see if it has the form of
10391 an IP address. Both IPv4 and IPv6 addresses are valid for &%isip%&, whereas
10392 &%isip4%& and &%isip6%& test specifically for IPv4 or IPv6 addresses.
10393
10394 For an IPv4 address, the test is for four dot-separated components, each of
10395 which consists of from one to three digits. For an IPv6 address, up to eight
10396 colon-separated components are permitted, each containing from one to four
10397 hexadecimal digits. There may be fewer than eight components if an empty
10398 component (adjacent colons) is present. Only one empty component is permitted.
10399
10400 &*Note*&: The checks are just on the form of the address; actual numerical
10401 values are not considered. Thus, for example, 999.999.999.999 passes the IPv4
10402 check. The main use of these tests is to distinguish between IP addresses and
10403 host names, or between IPv4 and IPv6 addresses. For example, you could use
10404 .code
10405 ${if isip4{$sender_host_address}...
10406 .endd
10407 to test which IP version an incoming SMTP connection is using.
10408
10409 .vitem &*ldapauth&~{*&<&'ldap&~query'&>&*}*&
10410 .cindex "LDAP" "use for authentication"
10411 .cindex "expansion" "LDAP authentication test"
10412 .cindex "&%ldapauth%& expansion condition"
10413 This condition supports user authentication using LDAP. See section
10414 &<<SECTldap>>& for details of how to use LDAP in lookups and the syntax of
10415 queries. For this use, the query must contain a user name and password. The
10416 query itself is not used, and can be empty. The condition is true if the
10417 password is not empty, and the user name and password are accepted by the LDAP
10418 server. An empty password is rejected without calling LDAP because LDAP binds
10419 with an empty password are considered anonymous regardless of the username, and
10420 will succeed in most configurations. See chapter &<<CHAPSMTPAUTH>>& for details
10421 of SMTP authentication, and chapter &<<CHAPplaintext>>& for an example of how
10422 this can be used.
10423
10424
10425 .vitem &*le&~{*&<&'string1'&>&*}{*&<&'string2'&>&*}*& &&&
10426        &*lei&~{*&<&'string1'&>&*}{*&<&'string2'&>&*}*&
10427 .cindex "string" "comparison"
10428 .cindex "expansion" "string comparison"
10429 .cindex "&%le%& expansion condition"
10430 .cindex "&%lei%& expansion condition"
10431 The two substrings are first expanded. The condition is true if the first
10432 string is lexically less than or equal to the second string. For &%le%& the
10433 comparison includes the case of letters, whereas for &%lei%& the comparison is
10434 case-independent.
10435
10436 .vitem &*lt&~{*&<&'string1'&>&*}{*&<&'string2'&>&*}*& &&&
10437        &*lti&~{*&<&'string1'&>&*}{*&<&'string2'&>&*}*&
10438 .cindex "string" "comparison"
10439 .cindex "expansion" "string comparison"
10440 .cindex "&%lt%& expansion condition"
10441 .cindex "&%lti%& expansion condition"
10442 The two substrings are first expanded. The condition is true if the first
10443 string is lexically less than the second string. For &%lt%& the comparison
10444 includes the case of letters, whereas for &%lti%& the comparison is
10445 case-independent.
10446
10447
10448 .vitem &*match&~{*&<&'string1'&>&*}{*&<&'string2'&>&*}*&
10449 .cindex "expansion" "regular expression comparison"
10450 .cindex "regular expressions" "match in expanded string"
10451 .cindex "&%match%& expansion condition"
10452 The two substrings are first expanded. The second is then treated as a regular
10453 expression and applied to the first. Because of the pre-expansion, if the
10454 regular expression contains dollar, or backslash characters, they must be
10455 escaped. Care must also be taken if the regular expression contains braces
10456 (curly brackets). A closing brace must be escaped so that it is not taken as a
10457 premature termination of <&'string2'&>. The easiest approach is to use the
10458 &`\N`& feature to disable expansion of the regular expression.
10459 For example,
10460 .code
10461 ${if match {$local_part}{\N^\d{3}\N} ...
10462 .endd
10463 If the whole expansion string is in double quotes, further escaping of
10464 backslashes is also required.
10465
10466 The condition is true if the regular expression match succeeds.
10467 The regular expression is not required to begin with a circumflex
10468 metacharacter, but if there is no circumflex, the expression is not anchored,
10469 and it may match anywhere in the subject, not just at the start. If you want
10470 the pattern to match at the end of the subject, you must include the &`$`&
10471 metacharacter at an appropriate point.
10472
10473 .cindex "numerical variables (&$1$& &$2$& etc)" "in &%if%& expansion"
10474 At the start of an &%if%& expansion the values of the numeric variable
10475 substitutions &$1$& etc. are remembered. Obeying a &%match%& condition that
10476 succeeds causes them to be reset to the substrings of that condition and they
10477 will have these values during the expansion of the success string. At the end
10478 of the &%if%& expansion, the previous values are restored. After testing a
10479 combination of conditions using &%or%&, the subsequent values of the numeric
10480 variables are those of the condition that succeeded.
10481
10482 .vitem &*match_address&~{*&<&'string1'&>&*}{*&<&'string2'&>&*}*&
10483 .cindex "&%match_address%& expansion condition"
10484 See &*match_local_part*&.
10485
10486 .vitem &*match_domain&~{*&<&'string1'&>&*}{*&<&'string2'&>&*}*&
10487 .cindex "&%match_domain%& expansion condition"
10488 See &*match_local_part*&.
10489
10490 .vitem &*match_ip&~{*&<&'string1'&>&*}{*&<&'string2'&>&*}*&
10491 .cindex "&%match_ip%& expansion condition"
10492 This condition matches an IP address to a list of IP address patterns. It must
10493 be followed by two argument strings. The first (after expansion) must be an IP
10494 address or an empty string. The second (not expanded) is a restricted host
10495 list that can match only an IP address, not a host name. For example:
10496 .code
10497 ${if match_ip{$sender_host_address}{1.2.3.4:5.6.7.8}{...}{...}}
10498 .endd
10499 The specific types of host list item that are permitted in the list are:
10500
10501 .ilist
10502 An IP address, optionally with a CIDR mask.
10503 .next
10504 A single asterisk, which matches any IP address.
10505 .next
10506 An empty item, which matches only if the IP address is empty. This could be
10507 useful for testing for a locally submitted message or one from specific hosts
10508 in a single test such as
10509 . ==== As this is a nested list, any displays it contains must be indented
10510 . ==== as otherwise they are too far to the left. This comment applies to
10511 . ==== the use of xmlto plus fop. There's no problem when formatting with
10512 . ==== sdop, with or without the extra indent.
10513 .code
10514   ${if match_ip{$sender_host_address}{:4.3.2.1:...}{...}{...}}
10515 .endd
10516 where the first item in the list is the empty string.
10517 .next
10518 The item @[] matches any of the local host's interface addresses.
10519 .next
10520 Single-key lookups are assumed to be like &"net-"& style lookups in host lists,
10521 even if &`net-`& is not specified. There is never any attempt to turn the IP
10522 address into a host name. The most common type of linear search for
10523 &*match_ip*& is likely to be &*iplsearch*&, in which the file can contain CIDR
10524 masks. For example:
10525 .code
10526   ${if match_ip{$sender_host_address}{iplsearch;/some/file}...
10527 .endd
10528 It is of course possible to use other kinds of lookup, and in such a case, you
10529 do need to specify the &`net-`& prefix if you want to specify a specific
10530 address mask, for example:
10531 .code
10532   ${if match_ip{$sender_host_address}{net24-dbm;/some/file}...
10533 .endd
10534 However, unless you are combining a &%match_ip%& condition with others, it is
10535 just as easy to use the fact that a lookup is itself a condition, and write:
10536 .code
10537   ${lookup{${mask:$sender_host_address/24}}dbm{/a/file}...
10538 .endd
10539 .endlist ilist
10540
10541 Note that <&'string2'&> is not itself subject to string expansion, unless
10542 Exim was built with the EXPAND_LISTMATCH_RHS option.
10543
10544 Consult section &<<SECThoslispatip>>& for further details of these patterns.
10545
10546 .vitem &*match_local_part&~{*&<&'string1'&>&*}{*&<&'string2'&>&*}*&
10547 .cindex "domain list" "in expansion condition"
10548 .cindex "address list" "in expansion condition"
10549 .cindex "local part" "list, in expansion condition"
10550 .cindex "&%match_local_part%& expansion condition"
10551 This condition, together with &%match_address%& and &%match_domain%&, make it
10552 possible to test domain, address, and local part lists within expansions. Each
10553 condition requires two arguments: an item and a list to match. A trivial
10554 example is:
10555 .code
10556 ${if match_domain{a.b.c}{x.y.z:a.b.c:p.q.r}{yes}{no}}
10557 .endd
10558 In each case, the second argument may contain any of the allowable items for a
10559 list of the appropriate type. Also, because the second argument (after
10560 expansion) is a standard form of list, it is possible to refer to a named list.
10561 Thus, you can use conditions like this:
10562 .code
10563 ${if match_domain{$domain}{+local_domains}{...
10564 .endd
10565 .cindex "&`+caseful`&"
10566 For address lists, the matching starts off caselessly, but the &`+caseful`&
10567 item can be used, as in all address lists, to cause subsequent items to
10568 have their local parts matched casefully. Domains are always matched
10569 caselessly.
10570
10571 Note that <&'string2'&> is not itself subject to string expansion, unless
10572 Exim was built with the EXPAND_LISTMATCH_RHS option.
10573
10574 &*Note*&: Host lists are &'not'& supported in this way. This is because
10575 hosts have two identities: a name and an IP address, and it is not clear
10576 how to specify cleanly how such a test would work. However, IP addresses can be
10577 matched using &%match_ip%&.
10578
10579 .vitem &*pam&~{*&<&'string1'&>&*:*&<&'string2'&>&*:...}*&
10580 .cindex "PAM authentication"
10581 .cindex "AUTH" "with PAM"
10582 .cindex "Solaris" "PAM support"
10583 .cindex "expansion" "PAM authentication test"
10584 .cindex "&%pam%& expansion condition"
10585 &'Pluggable Authentication Modules'&
10586 (&url(http://www.kernel.org/pub/linux/libs/pam/)) are a facility that is
10587 available in the latest releases of Solaris and in some GNU/Linux
10588 distributions. The Exim support, which is intended for use in conjunction with
10589 the SMTP AUTH command, is available only if Exim is compiled with
10590 .code
10591 SUPPORT_PAM=yes
10592 .endd
10593 in &_Local/Makefile_&. You probably need to add &%-lpam%& to EXTRALIBS, and
10594 in some releases of GNU/Linux &%-ldl%& is also needed.
10595
10596 The argument string is first expanded, and the result must be a
10597 colon-separated list of strings. Leading and trailing white space is ignored.
10598 The PAM module is initialized with the service name &"exim"& and the user name
10599 taken from the first item in the colon-separated data string (<&'string1'&>).
10600 The remaining items in the data string are passed over in response to requests
10601 from the authentication function. In the simple case there will only be one
10602 request, for a password, so the data consists of just two strings.
10603
10604 There can be problems if any of the strings are permitted to contain colon
10605 characters. In the usual way, these have to be doubled to avoid being taken as
10606 separators. If the data is being inserted from a variable, the &%sg%& expansion
10607 item can be used to double any existing colons. For example, the configuration
10608 of a LOGIN authenticator might contain this setting:
10609 .code
10610 server_condition = ${if pam{$auth1:${sg{$auth2}{:}{::}}}}
10611 .endd
10612 For a PLAIN authenticator you could use:
10613 .code
10614 server_condition = ${if pam{$auth2:${sg{$auth3}{:}{::}}}}
10615 .endd
10616 In some operating systems, PAM authentication can be done only from a process
10617 running as root. Since Exim is running as the Exim user when receiving
10618 messages, this means that PAM cannot be used directly in those systems.
10619 A patched version of the &'pam_unix'& module that comes with the
10620 Linux PAM package is available from &url(http://www.e-admin.de/pam_exim/).
10621 The patched module allows one special uid/gid combination, in addition to root,
10622 to authenticate. If you build the patched module to allow the Exim user and
10623 group, PAM can then be used from an Exim authenticator.
10624
10625
10626 .vitem &*pwcheck&~{*&<&'string1'&>&*:*&<&'string2'&>&*}*&
10627 .cindex "&'pwcheck'& daemon"
10628 .cindex "Cyrus"
10629 .cindex "expansion" "&'pwcheck'& authentication test"
10630 .cindex "&%pwcheck%& expansion condition"
10631 This condition supports user authentication using the Cyrus &'pwcheck'& daemon.
10632 This is one way of making it possible for passwords to be checked by a process
10633 that is not running as root. &*Note*&: The use of &'pwcheck'& is now
10634 deprecated. Its replacement is &'saslauthd'& (see below).
10635
10636 The pwcheck support is not included in Exim by default. You need to specify
10637 the location of the pwcheck daemon's socket in &_Local/Makefile_& before
10638 building Exim. For example:
10639 .code
10640 CYRUS_PWCHECK_SOCKET=/var/pwcheck/pwcheck
10641 .endd
10642 You do not need to install the full Cyrus software suite in order to use
10643 the pwcheck daemon. You can compile and install just the daemon alone
10644 from the Cyrus SASL library. Ensure that &'exim'& is the only user that has
10645 access to the &_/var/pwcheck_& directory.
10646
10647 The &%pwcheck%& condition takes one argument, which must be the user name and
10648 password, separated by a colon. For example, in a LOGIN authenticator
10649 configuration, you might have this:
10650 .code
10651 server_condition = ${if pwcheck{$auth1:$auth2}}
10652 .endd
10653 Again, for a PLAIN authenticator configuration, this would be:
10654 .code
10655 server_condition = ${if pwcheck{$auth2:$auth3}}
10656 .endd
10657 .vitem &*queue_running*&
10658 .cindex "queue runner" "detecting when delivering from"
10659 .cindex "expansion" "queue runner test"
10660 .cindex "&%queue_running%& expansion condition"
10661 This condition, which has no data, is true during delivery attempts that are
10662 initiated by queue runner processes, and false otherwise.
10663
10664
10665 .vitem &*radius&~{*&<&'authentication&~string'&>&*}*&
10666 .cindex "Radius"
10667 .cindex "expansion" "Radius authentication"
10668 .cindex "&%radius%& expansion condition"
10669 Radius authentication (RFC 2865) is supported in a similar way to PAM. You must
10670 set RADIUS_CONFIG_FILE in &_Local/Makefile_& to specify the location of
10671 the Radius client configuration file in order to build Exim with Radius
10672 support.
10673
10674 With just that one setting, Exim expects to be linked with the &%radiusclient%&
10675 library, using the original API. If you are using release 0.4.0 or later of
10676 this library, you need to set
10677 .code
10678 RADIUS_LIB_TYPE=RADIUSCLIENTNEW
10679 .endd
10680 in &_Local/Makefile_& when building Exim. You can also link Exim with the
10681 &%libradius%& library that comes with FreeBSD. To do this, set
10682 .code
10683 RADIUS_LIB_TYPE=RADLIB
10684 .endd
10685 in &_Local/Makefile_&, in addition to setting RADIUS_CONFIGURE_FILE.
10686 You may also have to supply a suitable setting in EXTRALIBS so that the
10687 Radius library can be found when Exim is linked.
10688
10689 The string specified by RADIUS_CONFIG_FILE is expanded and passed to the
10690 Radius client library, which calls the Radius server. The condition is true if
10691 the authentication is successful. For example:
10692 .code
10693 server_condition = ${if radius{<arguments>}}
10694 .endd
10695
10696
10697 .vitem "&*saslauthd&~{{*&<&'user'&>&*}{*&<&'password'&>&*}&&&
10698         {*&<&'service'&>&*}{*&<&'realm'&>&*}}*&"
10699 .cindex "&'saslauthd'& daemon"
10700 .cindex "Cyrus"
10701 .cindex "expansion" "&'saslauthd'& authentication test"
10702 .cindex "&%saslauthd%& expansion condition"
10703 This condition supports user authentication using the Cyrus &'saslauthd'&
10704 daemon. This replaces the older &'pwcheck'& daemon, which is now deprecated.
10705 Using this daemon is one way of making it possible for passwords to be checked
10706 by a process that is not running as root.
10707
10708 The saslauthd support is not included in Exim by default. You need to specify
10709 the location of the saslauthd daemon's socket in &_Local/Makefile_& before
10710 building Exim. For example:
10711 .code
10712 CYRUS_SASLAUTHD_SOCKET=/var/state/saslauthd/mux
10713 .endd
10714 You do not need to install the full Cyrus software suite in order to use
10715 the saslauthd daemon. You can compile and install just the daemon alone
10716 from the Cyrus SASL library.
10717
10718 Up to four arguments can be supplied to the &%saslauthd%& condition, but only
10719 two are mandatory. For example:
10720 .code
10721 server_condition = ${if saslauthd{{$auth1}{$auth2}}}
10722 .endd
10723 The service and the realm are optional (which is why the arguments are enclosed
10724 in their own set of braces). For details of the meaning of the service and
10725 realm, and how to run the daemon, consult the Cyrus documentation.
10726 .endlist vlist
10727
10728
10729
10730 .section "Combining expansion conditions" "SECID84"
10731 .cindex "expansion" "combining conditions"
10732 Several conditions can be tested at once by combining them using the &%and%&
10733 and &%or%& combination conditions. Note that &%and%& and &%or%& are complete
10734 conditions on their own, and precede their lists of sub-conditions. Each
10735 sub-condition must be enclosed in braces within the overall braces that contain
10736 the list. No repetition of &%if%& is used.
10737
10738
10739 .vlist
10740 .vitem &*or&~{{*&<&'cond1'&>&*}{*&<&'cond2'&>&*}...}*&
10741 .cindex "&""or""& expansion condition"
10742 .cindex "expansion" "&""or""& of conditions"
10743 The sub-conditions are evaluated from left to right. The condition is true if
10744 any one of the sub-conditions is true.
10745 For example,
10746 .code
10747 ${if or {{eq{$local_part}{spqr}}{eq{$domain}{testing.com}}}...
10748 .endd
10749 When a true sub-condition is found, the following ones are parsed but not
10750 evaluated. If there are several &"match"& sub-conditions the values of the
10751 numeric variables afterwards are taken from the first one that succeeds.
10752
10753 .vitem &*and&~{{*&<&'cond1'&>&*}{*&<&'cond2'&>&*}...}*&
10754 .cindex "&""and""& expansion condition"
10755 .cindex "expansion" "&""and""& of conditions"
10756 The sub-conditions are evaluated from left to right. The condition is true if
10757 all of the sub-conditions are true. If there are several &"match"&
10758 sub-conditions, the values of the numeric variables afterwards are taken from
10759 the last one. When a false sub-condition is found, the following ones are
10760 parsed but not evaluated.
10761 .endlist
10762 .ecindex IIDexpcond
10763
10764
10765
10766
10767 .section "Expansion variables" "SECTexpvar"
10768 .cindex "expansion" "variables, list of"
10769 This section contains an alphabetical list of all the expansion variables. Some
10770 of them are available only when Exim is compiled with specific options such as
10771 support for TLS or the content scanning extension.
10772
10773 .vlist
10774 .vitem "&$0$&, &$1$&, etc"
10775 .cindex "numerical variables (&$1$& &$2$& etc)"
10776 When a &%match%& expansion condition succeeds, these variables contain the
10777 captured substrings identified by the regular expression during subsequent
10778 processing of the success string of the containing &%if%& expansion item.
10779 However, they do not retain their values afterwards; in fact, their previous
10780 values are restored at the end of processing an &%if%& item. The numerical
10781 variables may also be set externally by some other matching process which
10782 precedes the expansion of the string. For example, the commands available in
10783 Exim filter files include an &%if%& command with its own regular expression
10784 matching condition.
10785
10786 .vitem "&$acl_c...$&"
10787 Values can be placed in these variables by the &%set%& modifier in an ACL. They
10788 can be given any name that starts with &$acl_c$& and is at least six characters
10789 long, but the sixth character must be either a digit or an underscore. For
10790 example: &$acl_c5$&, &$acl_c_mycount$&. The values of the &$acl_c...$&
10791 variables persist throughout the lifetime of an SMTP connection. They can be
10792 used to pass information between ACLs and between different invocations of the
10793 same ACL. When a message is received, the values of these variables are saved
10794 with the message, and can be accessed by filters, routers, and transports
10795 during subsequent delivery.
10796
10797 .vitem "&$acl_m...$&"
10798 These variables are like the &$acl_c...$& variables, except that their values
10799 are reset after a message has been received. Thus, if several messages are
10800 received in one SMTP connection, &$acl_m...$& values are not passed on from one
10801 message to the next, as &$acl_c...$& values are. The &$acl_m...$& variables are
10802 also reset by MAIL, RSET, EHLO, HELO, and after starting a TLS session. When a
10803 message is received, the values of these variables are saved with the message,
10804 and can be accessed by filters, routers, and transports during subsequent
10805 delivery.
10806
10807 .vitem &$acl_verify_message$&
10808 .vindex "&$acl_verify_message$&"
10809 After an address verification has failed, this variable contains the failure
10810 message. It retains its value for use in subsequent modifiers. The message can
10811 be preserved by coding like this:
10812 .code
10813 warn !verify = sender
10814      set acl_m0 = $acl_verify_message
10815 .endd
10816 You can use &$acl_verify_message$& during the expansion of the &%message%& or
10817 &%log_message%& modifiers, to include information about the verification
10818 failure.
10819
10820 .vitem &$address_data$&
10821 .vindex "&$address_data$&"
10822 This variable is set by means of the &%address_data%& option in routers. The
10823 value then remains with the address while it is processed by subsequent routers
10824 and eventually a transport. If the transport is handling multiple addresses,
10825 the value from the first address is used. See chapter &<<CHAProutergeneric>>&
10826 for more details. &*Note*&: The contents of &$address_data$& are visible in
10827 user filter files.
10828
10829 If &$address_data$& is set when the routers are called from an ACL to verify
10830 a recipient address, the final value is still in the variable for subsequent
10831 conditions and modifiers of the ACL statement. If routing the address caused it
10832 to be redirected to just one address, the child address is also routed as part
10833 of the verification, and in this case the final value of &$address_data$& is
10834 from the child's routing.
10835
10836 If &$address_data$& is set when the routers are called from an ACL to verify a
10837 sender address, the final value is also preserved, but this time in
10838 &$sender_address_data$&, to distinguish it from data from a recipient
10839 address.
10840
10841 In both cases (recipient and sender verification), the value does not persist
10842 after the end of the current ACL statement. If you want to preserve
10843 these values for longer, you can save them in ACL variables.
10844
10845 .vitem &$address_file$&
10846 .vindex "&$address_file$&"
10847 When, as a result of aliasing, forwarding, or filtering, a message is directed
10848 to a specific file, this variable holds the name of the file when the transport
10849 is running. At other times, the variable is empty. For example, using the
10850 default configuration, if user &%r2d2%& has a &_.forward_& file containing
10851 .code
10852 /home/r2d2/savemail
10853 .endd
10854 then when the &(address_file)& transport is running, &$address_file$&
10855 contains the text string &`/home/r2d2/savemail`&.
10856 .cindex "Sieve filter" "value of &$address_file$&"
10857 For Sieve filters, the value may be &"inbox"& or a relative folder name. It is
10858 then up to the transport configuration to generate an appropriate absolute path
10859 to the relevant file.
10860
10861 .vitem &$address_pipe$&
10862 .vindex "&$address_pipe$&"
10863 When, as a result of aliasing or forwarding, a message is directed to a pipe,
10864 this variable holds the pipe command when the transport is running.
10865
10866 .vitem "&$auth1$& &-- &$auth3$&"
10867 .vindex "&$auth1$&, &$auth2$&, etc"
10868 These variables are used in SMTP authenticators (see chapters
10869 &<<CHAPplaintext>>&&--&<<CHAPspa>>&). Elsewhere, they are empty.
10870
10871 .vitem &$authenticated_id$&
10872 .cindex "authentication" "id"
10873 .vindex "&$authenticated_id$&"
10874 When a server successfully authenticates a client it may be configured to
10875 preserve some of the authentication information in the variable
10876 &$authenticated_id$& (see chapter &<<CHAPSMTPAUTH>>&). For example, a
10877 user/password authenticator configuration might preserve the user name for use
10878 in the routers. Note that this is not the same information that is saved in
10879 &$sender_host_authenticated$&.
10880 When a message is submitted locally (that is, not over a TCP connection)
10881 the value of &$authenticated_id$& is normally the login name of the calling
10882 process. However, a trusted user can override this by means of the &%-oMai%&
10883 command line option.
10884
10885
10886
10887
10888 .vitem &$authenticated_sender$&
10889 .cindex "sender" "authenticated"
10890 .cindex "authentication" "sender"
10891 .cindex "AUTH" "on MAIL command"
10892 .vindex "&$authenticated_sender$&"
10893 When acting as a server, Exim takes note of the AUTH= parameter on an incoming
10894 SMTP MAIL command if it believes the sender is sufficiently trusted, as
10895 described in section &<<SECTauthparamail>>&. Unless the data is the string
10896 &"<>"&, it is set as the authenticated sender of the message, and the value is
10897 available during delivery in the &$authenticated_sender$& variable. If the
10898 sender is not trusted, Exim accepts the syntax of AUTH=, but ignores the data.
10899
10900 .vindex "&$qualify_domain$&"
10901 When a message is submitted locally (that is, not over a TCP connection), the
10902 value of &$authenticated_sender$& is an address constructed from the login
10903 name of the calling process and &$qualify_domain$&, except that a trusted user
10904 can override this by means of the &%-oMas%& command line option.
10905
10906
10907 .vitem &$authentication_failed$&
10908 .cindex "authentication" "failure"
10909 .vindex "&$authentication_failed$&"
10910 This variable is set to &"1"& in an Exim server if a client issues an AUTH
10911 command that does not succeed. Otherwise it is set to &"0"&. This makes it
10912 possible to distinguish between &"did not try to authenticate"&
10913 (&$sender_host_authenticated$& is empty and &$authentication_failed$& is set to
10914 &"0"&) and &"tried to authenticate but failed"& (&$sender_host_authenticated$&
10915 is empty and &$authentication_failed$& is set to &"1"&). Failure includes any
10916 negative response to an AUTH command, including (for example) an attempt to use
10917 an undefined mechanism.
10918
10919 .vitem &$av_failed$&
10920 .cindex "content scanning" "AV scanner failure"
10921 This variable is available when Exim is compiled with the content-scanning
10922 extension. It is set to &"0"& by default, but will be set to &"1"& if any
10923 problem occurs with the virus scanner (specified by &%av_scanner%&) during
10924 the ACL malware condition.
10925
10926 .vitem &$body_linecount$&
10927 .cindex "message body" "line count"
10928 .cindex "body of message" "line count"
10929 .vindex "&$body_linecount$&"
10930 When a message is being received or delivered, this variable contains the
10931 number of lines in the message's body. See also &$message_linecount$&.
10932
10933 .vitem &$body_zerocount$&
10934 .cindex "message body" "binary zero count"
10935 .cindex "body of message" "binary zero count"
10936 .cindex "binary zero" "in message body"
10937 .vindex "&$body_zerocount$&"
10938 When a message is being received or delivered, this variable contains the
10939 number of binary zero bytes (ASCII NULs) in the message's body.
10940
10941 .vitem &$bounce_recipient$&
10942 .vindex "&$bounce_recipient$&"
10943 This is set to the recipient address of a bounce message while Exim is creating
10944 it. It is useful if a customized bounce message text file is in use (see
10945 chapter &<<CHAPemsgcust>>&).
10946
10947 .vitem &$bounce_return_size_limit$&
10948 .vindex "&$bounce_return_size_limit$&"
10949 This contains the value set in the &%bounce_return_size_limit%& option, rounded
10950 up to a multiple of 1000. It is useful when a customized error message text
10951 file is in use (see chapter &<<CHAPemsgcust>>&).
10952
10953 .vitem &$caller_gid$&
10954 .cindex "gid (group id)" "caller"
10955 .vindex "&$caller_gid$&"
10956 The real group id under which the process that called Exim was running. This is
10957 not the same as the group id of the originator of a message (see
10958 &$originator_gid$&). If Exim re-execs itself, this variable in the new
10959 incarnation normally contains the Exim gid.
10960
10961 .vitem &$caller_uid$&
10962 .cindex "uid (user id)" "caller"
10963 .vindex "&$caller_uid$&"
10964 The real user id under which the process that called Exim was running. This is
10965 not the same as the user id of the originator of a message (see
10966 &$originator_uid$&). If Exim re-execs itself, this variable in the new
10967 incarnation normally contains the Exim uid.
10968
10969 .vitem &$compile_date$&
10970 .vindex "&$compile_date$&"
10971 The date on which the Exim binary was compiled.
10972
10973 .vitem &$compile_number$&
10974 .vindex "&$compile_number$&"
10975 The building process for Exim keeps a count of the number
10976 of times it has been compiled. This serves to distinguish different
10977 compilations of the same version of the program.
10978
10979 .vitem &$demime_errorlevel$&
10980 .vindex "&$demime_errorlevel$&"
10981 This variable is available when Exim is compiled with
10982 the content-scanning extension and the obsolete &%demime%& condition. For
10983 details, see section &<<SECTdemimecond>>&.
10984
10985 .vitem &$demime_reason$&
10986 .vindex "&$demime_reason$&"
10987 This variable is available when Exim is compiled with the
10988 content-scanning extension and the obsolete &%demime%& condition. For details,
10989 see section &<<SECTdemimecond>>&.
10990
10991 .vitem &$dnslist_domain$& &&&
10992        &$dnslist_matched$& &&&
10993        &$dnslist_text$& &&&
10994        &$dnslist_value$&
10995 .vindex "&$dnslist_domain$&"
10996 .vindex "&$dnslist_matched$&"
10997 .vindex "&$dnslist_text$&"
10998 .vindex "&$dnslist_value$&"
10999 .cindex "black list (DNS)"
11000 When a DNS (black) list lookup succeeds, these variables are set to contain
11001 the following data from the lookup: the list's domain name, the key that was
11002 looked up, the contents of any associated TXT record, and the value from the
11003 main A record. See section &<<SECID204>>& for more details.
11004
11005 .vitem &$domain$&
11006 .vindex "&$domain$&"
11007 When an address is being routed, or delivered on its own, this variable
11008 contains the domain. Uppercase letters in the domain are converted into lower
11009 case for &$domain$&.
11010
11011 Global address rewriting happens when a message is received, so the value of
11012 &$domain$& during routing and delivery is the value after rewriting. &$domain$&
11013 is set during user filtering, but not during system filtering, because a
11014 message may have many recipients and the system filter is called just once.
11015
11016 When more than one address is being delivered at once (for example, several
11017 RCPT commands in one SMTP delivery), &$domain$& is set only if they all
11018 have the same domain. Transports can be restricted to handling only one domain
11019 at a time if the value of &$domain$& is required at transport time &-- this is
11020 the default for local transports. For further details of the environment in
11021 which local transports are run, see chapter &<<CHAPenvironment>>&.
11022
11023 .oindex "&%delay_warning_condition%&"
11024 At the end of a delivery, if all deferred addresses have the same domain, it is
11025 set in &$domain$& during the expansion of &%delay_warning_condition%&.
11026
11027 The &$domain$& variable is also used in some other circumstances:
11028
11029 .ilist
11030 When an ACL is running for a RCPT command, &$domain$& contains the domain of
11031 the recipient address. The domain of the &'sender'& address is in
11032 &$sender_address_domain$& at both MAIL time and at RCPT time. &$domain$& is not
11033 normally set during the running of the MAIL ACL. However, if the sender address
11034 is verified with a callout during the MAIL ACL, the sender domain is placed in
11035 &$domain$& during the expansions of &%hosts%&, &%interface%&, and &%port%& in
11036 the &(smtp)& transport.
11037
11038 .next
11039 When a rewrite item is being processed (see chapter &<<CHAPrewrite>>&),
11040 &$domain$& contains the domain portion of the address that is being rewritten;
11041 it can be used in the expansion of the replacement address, for example, to
11042 rewrite domains by file lookup.
11043
11044 .next
11045 With one important exception, whenever a domain list is being scanned,
11046 &$domain$& contains the subject domain. &*Exception*&: When a domain list in
11047 a &%sender_domains%& condition in an ACL is being processed, the subject domain
11048 is in &$sender_address_domain$& and not in &$domain$&. It works this way so
11049 that, in a RCPT ACL, the sender domain list can be dependent on the
11050 recipient domain (which is what is in &$domain$& at this time).
11051
11052 .next
11053 .cindex "ETRN" "value of &$domain$&"
11054 .oindex "&%smtp_etrn_command%&"
11055 When the &%smtp_etrn_command%& option is being expanded, &$domain$& contains
11056 the complete argument of the ETRN command (see section &<<SECTETRN>>&).
11057 .endlist
11058
11059
11060 .vitem &$domain_data$&
11061 .vindex "&$domain_data$&"
11062 When the &%domains%& option on a router matches a domain by
11063 means of a lookup, the data read by the lookup is available during the running
11064 of the router as &$domain_data$&. In addition, if the driver routes the
11065 address to a transport, the value is available in that transport. If the
11066 transport is handling multiple addresses, the value from the first address is
11067 used.
11068
11069 &$domain_data$& is also set when the &%domains%& condition in an ACL matches a
11070 domain by means of a lookup. The data read by the lookup is available during
11071 the rest of the ACL statement. In all other situations, this variable expands
11072 to nothing.
11073
11074 .vitem &$exim_gid$&
11075 .vindex "&$exim_gid$&"
11076 This variable contains the numerical value of the Exim group id.
11077
11078 .vitem &$exim_path$&
11079 .vindex "&$exim_path$&"
11080 This variable contains the path to the Exim binary.
11081
11082 .vitem &$exim_uid$&
11083 .vindex "&$exim_uid$&"
11084 This variable contains the numerical value of the Exim user id.
11085
11086 .vitem &$found_extension$&
11087 .vindex "&$found_extension$&"
11088 This variable is available when Exim is compiled with the
11089 content-scanning extension and the obsolete &%demime%& condition. For details,
11090 see section &<<SECTdemimecond>>&.
11091
11092 .vitem &$header_$&<&'name'&>
11093 This is not strictly an expansion variable. It is expansion syntax for
11094 inserting the message header line with the given name. Note that the name must
11095 be terminated by colon or white space, because it may contain a wide variety of
11096 characters. Note also that braces must &'not'& be used.
11097
11098 .vitem &$headers_added$&
11099 .vindex "&$headers_added$&"
11100 Within an ACL this variable contains the headers added so far by
11101 the ACL modifier add_header (section &<<SECTaddheadacl>>&).
11102 The headers are a newline-separated list.
11103
11104 .vitem &$home$&
11105 .vindex "&$home$&"
11106 When the &%check_local_user%& option is set for a router, the user's home
11107 directory is placed in &$home$& when the check succeeds. In particular, this
11108 means it is set during the running of users' filter files. A router may also
11109 explicitly set a home directory for use by a transport; this can be overridden
11110 by a setting on the transport itself.
11111
11112 When running a filter test via the &%-bf%& option, &$home$& is set to the value
11113 of the environment variable HOME.
11114
11115 .vitem &$host$&
11116 .vindex "&$host$&"
11117 If a router assigns an address to a transport (any transport), and passes a
11118 list of hosts with the address, the value of &$host$& when the transport starts
11119 to run is the name of the first host on the list. Note that this applies both
11120 to local and remote transports.
11121
11122 .cindex "transport" "filter"
11123 .cindex "filter" "transport filter"
11124 For the &(smtp)& transport, if there is more than one host, the value of
11125 &$host$& changes as the transport works its way through the list. In
11126 particular, when the &(smtp)& transport is expanding its options for encryption
11127 using TLS, or for specifying a transport filter (see chapter
11128 &<<CHAPtransportgeneric>>&), &$host$& contains the name of the host to which it
11129 is connected.
11130
11131 When used in the client part of an authenticator configuration (see chapter
11132 &<<CHAPSMTPAUTH>>&), &$host$& contains the name of the server to which the
11133 client is connected.
11134
11135
11136 .vitem &$host_address$&
11137 .vindex "&$host_address$&"
11138 This variable is set to the remote host's IP address whenever &$host$& is set
11139 for a remote connection. It is also set to the IP address that is being checked
11140 when the &%ignore_target_hosts%& option is being processed.
11141
11142 .vitem &$host_data$&
11143 .vindex "&$host_data$&"
11144 If a &%hosts%& condition in an ACL is satisfied by means of a lookup, the
11145 result of the lookup is made available in the &$host_data$& variable. This
11146 allows you, for example, to do things like this:
11147 .code
11148 deny  hosts = net-lsearch;/some/file
11149 message = $host_data
11150 .endd
11151 .vitem &$host_lookup_deferred$&
11152 .cindex "host name" "lookup, failure of"
11153 .vindex "&$host_lookup_deferred$&"
11154 This variable normally contains &"0"&, as does &$host_lookup_failed$&. When a
11155 message comes from a remote host and there is an attempt to look up the host's
11156 name from its IP address, and the attempt is not successful, one of these
11157 variables is set to &"1"&.
11158
11159 .ilist
11160 If the lookup receives a definite negative response (for example, a DNS lookup
11161 succeeded, but no records were found), &$host_lookup_failed$& is set to &"1"&.
11162
11163 .next
11164 If there is any kind of problem during the lookup, such that Exim cannot
11165 tell whether or not the host name is defined (for example, a timeout for a DNS
11166 lookup), &$host_lookup_deferred$& is set to &"1"&.
11167 .endlist ilist
11168
11169 Looking up a host's name from its IP address consists of more than just a
11170 single reverse lookup. Exim checks that a forward lookup of at least one of the
11171 names it receives from a reverse lookup yields the original IP address. If this
11172 is not the case, Exim does not accept the looked up name(s), and
11173 &$host_lookup_failed$& is set to &"1"&. Thus, being able to find a name from an
11174 IP address (for example, the existence of a PTR record in the DNS) is not
11175 sufficient on its own for the success of a host name lookup. If the reverse
11176 lookup succeeds, but there is a lookup problem such as a timeout when checking
11177 the result, the name is not accepted, and &$host_lookup_deferred$& is set to
11178 &"1"&. See also &$sender_host_name$&.
11179
11180 .vitem &$host_lookup_failed$&
11181 .vindex "&$host_lookup_failed$&"
11182 See &$host_lookup_deferred$&.
11183
11184
11185 .vitem &$inode$&
11186 .vindex "&$inode$&"
11187 The only time this variable is set is while expanding the &%directory_file%&
11188 option in the &(appendfile)& transport. The variable contains the inode number
11189 of the temporary file which is about to be renamed. It can be used to construct
11190 a unique name for the file.
11191
11192 .vitem &$interface_address$&
11193 .vindex "&$interface_address$&"
11194 This is an obsolete name for &$received_ip_address$&.
11195
11196 .vitem &$interface_port$&
11197 .vindex "&$interface_port$&"
11198 This is an obsolete name for &$received_port$&.
11199
11200 .vitem &$item$&
11201 .vindex "&$item$&"
11202 This variable is used during the expansion of &*forall*& and &*forany*&
11203 conditions (see section &<<SECTexpcond>>&), and &*filter*&, &*map*&, and
11204 &*reduce*& items (see section &<<SECTexpcond>>&). In other circumstances, it is
11205 empty.
11206
11207 .vitem &$ldap_dn$&
11208 .vindex "&$ldap_dn$&"
11209 This variable, which is available only when Exim is compiled with LDAP support,
11210 contains the DN from the last entry in the most recently successful LDAP
11211 lookup.
11212
11213 .vitem &$load_average$&
11214 .vindex "&$load_average$&"
11215 This variable contains the system load average, multiplied by 1000 so that it
11216 is an integer. For example, if the load average is 0.21, the value of the
11217 variable is 210. The value is recomputed every time the variable is referenced.
11218
11219 .vitem &$local_part$&
11220 .vindex "&$local_part$&"
11221 When an address is being routed, or delivered on its own, this
11222 variable contains the local part. When a number of addresses are being
11223 delivered together (for example, multiple RCPT commands in an SMTP
11224 session), &$local_part$& is not set.
11225
11226 Global address rewriting happens when a message is received, so the value of
11227 &$local_part$& during routing and delivery is the value after rewriting.
11228 &$local_part$& is set during user filtering, but not during system filtering,
11229 because a message may have many recipients and the system filter is called just
11230 once.
11231
11232 .vindex "&$local_part_prefix$&"
11233 .vindex "&$local_part_suffix$&"
11234 If a local part prefix or suffix has been recognized, it is not included in the
11235 value of &$local_part$& during routing and subsequent delivery. The values of
11236 any prefix or suffix are in &$local_part_prefix$& and
11237 &$local_part_suffix$&, respectively.
11238
11239 When a message is being delivered to a file, pipe, or autoreply transport as a
11240 result of aliasing or forwarding, &$local_part$& is set to the local part of
11241 the parent address, not to the file name or command (see &$address_file$& and
11242 &$address_pipe$&).
11243
11244 When an ACL is running for a RCPT command, &$local_part$& contains the
11245 local part of the recipient address.
11246
11247 When a rewrite item is being processed (see chapter &<<CHAPrewrite>>&),
11248 &$local_part$& contains the local part of the address that is being rewritten;
11249 it can be used in the expansion of the replacement address, for example.
11250
11251 In all cases, all quoting is removed from the local part. For example, for both
11252 the addresses
11253 .code
11254 "abc:xyz"@test.example
11255 abc\:xyz@test.example
11256 .endd
11257 the value of &$local_part$& is
11258 .code
11259 abc:xyz
11260 .endd
11261 If you use &$local_part$& to create another address, you should always wrap it
11262 inside a quoting operator. For example, in a &(redirect)& router you could
11263 have:
11264 .code
11265 data = ${quote_local_part:$local_part}@new.domain.example
11266 .endd
11267 &*Note*&: The value of &$local_part$& is normally lower cased. If you want
11268 to process local parts in a case-dependent manner in a router, you can set the
11269 &%caseful_local_part%& option (see chapter &<<CHAProutergeneric>>&).
11270
11271 .vitem &$local_part_data$&
11272 .vindex "&$local_part_data$&"
11273 When the &%local_parts%& option on a router matches a local part by means of a
11274 lookup, the data read by the lookup is available during the running of the
11275 router as &$local_part_data$&. In addition, if the driver routes the address
11276 to a transport, the value is available in that transport. If the transport is
11277 handling multiple addresses, the value from the first address is used.
11278
11279 &$local_part_data$& is also set when the &%local_parts%& condition in an ACL
11280 matches a local part by means of a lookup. The data read by the lookup is
11281 available during the rest of the ACL statement. In all other situations, this
11282 variable expands to nothing.
11283
11284 .vitem &$local_part_prefix$&
11285 .vindex "&$local_part_prefix$&"
11286 When an address is being routed or delivered, and a
11287 specific prefix for the local part was recognized, it is available in this
11288 variable, having been removed from &$local_part$&.
11289
11290 .vitem &$local_part_suffix$&
11291 .vindex "&$local_part_suffix$&"
11292 When an address is being routed or delivered, and a
11293 specific suffix for the local part was recognized, it is available in this
11294 variable, having been removed from &$local_part$&.
11295
11296 .vitem &$local_scan_data$&
11297 .vindex "&$local_scan_data$&"
11298 This variable contains the text returned by the &[local_scan()]& function when
11299 a message is received. See chapter &<<CHAPlocalscan>>& for more details.
11300
11301 .vitem &$local_user_gid$&
11302 .vindex "&$local_user_gid$&"
11303 See &$local_user_uid$&.
11304
11305 .vitem &$local_user_uid$&
11306 .vindex "&$local_user_uid$&"
11307 This variable and &$local_user_gid$& are set to the uid and gid after the
11308 &%check_local_user%& router precondition succeeds. This means that their values
11309 are available for the remaining preconditions (&%senders%&, &%require_files%&,
11310 and &%condition%&), for the &%address_data%& expansion, and for any
11311 router-specific expansions. At all other times, the values in these variables
11312 are &`(uid_t)(-1)`& and &`(gid_t)(-1)`&, respectively.
11313
11314 .vitem &$localhost_number$&
11315 .vindex "&$localhost_number$&"
11316 This contains the expanded value of the
11317 &%localhost_number%& option. The expansion happens after the main options have
11318 been read.
11319
11320 .vitem &$log_inodes$&
11321 .vindex "&$log_inodes$&"
11322 The number of free inodes in the disk partition where Exim's
11323 log files are being written. The value is recalculated whenever the variable is
11324 referenced. If the relevant file system does not have the concept of inodes,
11325 the value of is -1. See also the &%check_log_inodes%& option.
11326
11327 .vitem &$log_space$&
11328 .vindex "&$log_space$&"
11329 The amount of free space (as a number of kilobytes) in the disk
11330 partition where Exim's log files are being written. The value is recalculated
11331 whenever the variable is referenced. If the operating system does not have the
11332 ability to find the amount of free space (only true for experimental systems),
11333 the space value is -1. See also the &%check_log_space%& option.
11334
11335
11336 .vitem &$mailstore_basename$&
11337 .vindex "&$mailstore_basename$&"
11338 This variable is set only when doing deliveries in &"mailstore"& format in the
11339 &(appendfile)& transport. During the expansion of the &%mailstore_prefix%&,
11340 &%mailstore_suffix%&, &%message_prefix%&, and &%message_suffix%& options, it
11341 contains the basename of the files that are being written, that is, the name
11342 without the &".tmp"&, &".env"&, or &".msg"& suffix. At all other times, this
11343 variable is empty.
11344
11345 .vitem &$malware_name$&
11346 .vindex "&$malware_name$&"
11347 This variable is available when Exim is compiled with the
11348 content-scanning extension. It is set to the name of the virus that was found
11349 when the ACL &%malware%& condition is true (see section &<<SECTscanvirus>>&).
11350
11351 .vitem &$max_received_linelength$&
11352 .vindex "&$max_received_linelength$&"
11353 .cindex "maximum" "line length"
11354 .cindex "line length" "maximum"
11355 This variable contains the number of bytes in the longest line that was
11356 received as part of the message, not counting the line termination
11357 character(s).
11358
11359 .vitem &$message_age$&
11360 .cindex "message" "age of"
11361 .vindex "&$message_age$&"
11362 This variable is set at the start of a delivery attempt to contain the number
11363 of seconds since the message was received. It does not change during a single
11364 delivery attempt.
11365
11366 .vitem &$message_body$&
11367 .cindex "body of message" "expansion variable"
11368 .cindex "message body" "in expansion"
11369 .cindex "binary zero" "in message body"
11370 .vindex "&$message_body$&"
11371 .oindex "&%message_body_visible%&"
11372 This variable contains the initial portion of a message's body while it is
11373 being delivered, and is intended mainly for use in filter files. The maximum
11374 number of characters of the body that are put into the variable is set by the
11375 &%message_body_visible%& configuration option; the default is 500.
11376
11377 .oindex "&%message_body_newlines%&"
11378 By default, newlines are converted into spaces in &$message_body$&, to make it
11379 easier to search for phrases that might be split over a line break. However,
11380 this can be disabled by setting &%message_body_newlines%& to be true. Binary
11381 zeros are always converted into spaces.
11382
11383 .vitem &$message_body_end$&
11384 .cindex "body of message" "expansion variable"
11385 .cindex "message body" "in expansion"
11386 .vindex "&$message_body_end$&"
11387 This variable contains the final portion of a message's
11388 body while it is being delivered. The format and maximum size are as for
11389 &$message_body$&.
11390
11391 .vitem &$message_body_size$&
11392 .cindex "body of message" "size"
11393 .cindex "message body" "size"
11394 .vindex "&$message_body_size$&"
11395 When a message is being delivered, this variable contains the size of the body
11396 in bytes. The count starts from the character after the blank line that
11397 separates the body from the header. Newlines are included in the count. See
11398 also &$message_size$&, &$body_linecount$&, and &$body_zerocount$&.
11399
11400 .vitem &$message_exim_id$&
11401 .vindex "&$message_exim_id$&"
11402 When a message is being received or delivered, this variable contains the
11403 unique message id that is generated and used by Exim to identify the message.
11404 An id is not created for a message until after its header has been successfully
11405 received. &*Note*&: This is &'not'& the contents of the &'Message-ID:'& header
11406 line; it is the local id that Exim assigns to the message, for example:
11407 &`1BXTIK-0001yO-VA`&.
11408
11409 .vitem &$message_headers$&
11410 .vindex &$message_headers$&
11411 This variable contains a concatenation of all the header lines when a message
11412 is being processed, except for lines added by routers or transports. The header
11413 lines are separated by newline characters. Their contents are decoded in the
11414 same way as a header line that is inserted by &%bheader%&.
11415
11416 .vitem &$message_headers_raw$&
11417 .vindex &$message_headers_raw$&
11418 This variable is like &$message_headers$& except that no processing of the
11419 contents of header lines is done.
11420
11421 .vitem &$message_id$&
11422 This is an old name for &$message_exim_id$&, which is now deprecated.
11423
11424 .vitem &$message_linecount$&
11425 .vindex "&$message_linecount$&"
11426 This variable contains the total number of lines in the header and body of the
11427 message. Compare &$body_linecount$&, which is the count for the body only.
11428 During the DATA and content-scanning ACLs, &$message_linecount$& contains the
11429 number of lines received. Before delivery happens (that is, before filters,
11430 routers, and transports run) the count is increased to include the
11431 &'Received:'& header line that Exim standardly adds, and also any other header
11432 lines that are added by ACLs. The blank line that separates the message header
11433 from the body is not counted.
11434
11435 As with the special case of &$message_size$&, during the expansion of the
11436 appendfile transport's maildir_tag option in maildir format, the value of
11437 &$message_linecount$& is the precise size of the number of newlines in the
11438 file that has been written (minus one for the blank line between the
11439 header and the body).
11440
11441 Here is an example of the use of this variable in a DATA ACL:
11442 .code
11443 deny message   = Too many lines in message header
11444      condition = \
11445       ${if <{250}{${eval:$message_linecount - $body_linecount}}}
11446 .endd
11447 In the MAIL and RCPT ACLs, the value is zero because at that stage the
11448 message has not yet been received.
11449
11450 .vitem &$message_size$&
11451 .cindex "size" "of message"
11452 .cindex "message" "size"
11453 .vindex "&$message_size$&"
11454 When a message is being processed, this variable contains its size in bytes. In
11455 most cases, the size includes those headers that were received with the
11456 message, but not those (such as &'Envelope-to:'&) that are added to individual
11457 deliveries as they are written. However, there is one special case: during the
11458 expansion of the &%maildir_tag%& option in the &(appendfile)& transport while
11459 doing a delivery in maildir format, the value of &$message_size$& is the
11460 precise size of the file that has been written. See also
11461 &$message_body_size$&, &$body_linecount$&, and &$body_zerocount$&.
11462
11463 .cindex "RCPT" "value of &$message_size$&"
11464 While running a per message ACL (mail/rcpt/predata), &$message_size$&
11465 contains the size supplied on the MAIL command, or -1 if no size was given. The
11466 value may not, of course, be truthful.
11467
11468 .vitem &$mime_$&&'xxx'&
11469 A number of variables whose names start with &$mime$& are
11470 available when Exim is compiled with the content-scanning extension. For
11471 details, see section &<<SECTscanmimepart>>&.
11472
11473 .vitem "&$n0$& &-- &$n9$&"
11474 These variables are counters that can be incremented by means
11475 of the &%add%& command in filter files.
11476
11477 .vitem &$original_domain$&
11478 .vindex "&$domain$&"
11479 .vindex "&$original_domain$&"
11480 When a top-level address is being processed for delivery, this contains the
11481 same value as &$domain$&. However, if a &"child"& address (for example,
11482 generated by an alias, forward, or filter file) is being processed, this
11483 variable contains the domain of the original address (lower cased). This
11484 differs from &$parent_domain$& only when there is more than one level of
11485 aliasing or forwarding. When more than one address is being delivered in a
11486 single transport run, &$original_domain$& is not set.
11487
11488 If a new address is created by means of a &%deliver%& command in a system
11489 filter, it is set up with an artificial &"parent"& address. This has the local
11490 part &'system-filter'& and the default qualify domain.
11491
11492 .vitem &$original_local_part$&
11493 .vindex "&$local_part$&"
11494 .vindex "&$original_local_part$&"
11495 When a top-level address is being processed for delivery, this contains the
11496 same value as &$local_part$&, unless a prefix or suffix was removed from the
11497 local part, because &$original_local_part$& always contains the full local
11498 part. When a &"child"& address (for example, generated by an alias, forward, or
11499 filter file) is being processed, this variable contains the full local part of
11500 the original address.
11501
11502 If the router that did the redirection processed the local part
11503 case-insensitively, the value in &$original_local_part$& is in lower case.
11504 This variable differs from &$parent_local_part$& only when there is more than
11505 one level of aliasing or forwarding. When more than one address is being
11506 delivered in a single transport run, &$original_local_part$& is not set.
11507
11508 If a new address is created by means of a &%deliver%& command in a system
11509 filter, it is set up with an artificial &"parent"& address. This has the local
11510 part &'system-filter'& and the default qualify domain.
11511
11512 .vitem &$originator_gid$&
11513 .cindex "gid (group id)" "of originating user"
11514 .cindex "sender" "gid"
11515 .vindex "&$caller_gid$&"
11516 .vindex "&$originator_gid$&"
11517 This variable contains the value of &$caller_gid$& that was set when the
11518 message was received. For messages received via the command line, this is the
11519 gid of the sending user. For messages received by SMTP over TCP/IP, this is
11520 normally the gid of the Exim user.
11521
11522 .vitem &$originator_uid$&
11523 .cindex "uid (user id)" "of originating user"
11524 .cindex "sender" "uid"
11525 .vindex "&$caller_uid$&"
11526 .vindex "&$originaltor_uid$&"
11527 The value of &$caller_uid$& that was set when the message was received. For
11528 messages received via the command line, this is the uid of the sending user.
11529 For messages received by SMTP over TCP/IP, this is normally the uid of the Exim
11530 user.
11531
11532 .vitem &$parent_domain$&
11533 .vindex "&$parent_domain$&"
11534 This variable is similar to &$original_domain$& (see
11535 above), except that it refers to the immediately preceding parent address.
11536
11537 .vitem &$parent_local_part$&
11538 .vindex "&$parent_local_part$&"
11539 This variable is similar to &$original_local_part$&
11540 (see above), except that it refers to the immediately preceding parent address.
11541
11542 .vitem &$pid$&
11543 .cindex "pid (process id)" "of current process"
11544 .vindex "&$pid$&"
11545 This variable contains the current process id.
11546
11547 .vitem &$pipe_addresses$&
11548 .cindex "filter" "transport filter"
11549 .cindex "transport" "filter"
11550 .vindex "&$pipe_addresses$&"
11551 This is not an expansion variable, but is mentioned here because the string
11552 &`$pipe_addresses`& is handled specially in the command specification for the
11553 &(pipe)& transport (chapter &<<CHAPpipetransport>>&) and in transport filters
11554 (described under &%transport_filter%& in chapter &<<CHAPtransportgeneric>>&).
11555 It cannot be used in general expansion strings, and provokes an &"unknown
11556 variable"& error if encountered.
11557
11558 .vitem &$primary_hostname$&
11559 .vindex "&$primary_hostname$&"
11560 This variable contains the value set by &%primary_hostname%& in the
11561 configuration file, or read by the &[uname()]& function. If &[uname()]& returns
11562 a single-component name, Exim calls &[gethostbyname()]& (or
11563 &[getipnodebyname()]& where available) in an attempt to acquire a fully
11564 qualified host name. See also &$smtp_active_hostname$&.
11565
11566
11567 .vitem &$prvscheck_address$&
11568 This variable is used in conjunction with the &%prvscheck%& expansion item,
11569 which is described in sections &<<SECTexpansionitems>>& and
11570 &<<SECTverifyPRVS>>&.
11571
11572 .vitem &$prvscheck_keynum$&
11573 This variable is used in conjunction with the &%prvscheck%& expansion item,
11574 which is described in sections &<<SECTexpansionitems>>& and
11575 &<<SECTverifyPRVS>>&.
11576
11577 .vitem &$prvscheck_result$&
11578 This variable is used in conjunction with the &%prvscheck%& expansion item,
11579 which is described in sections &<<SECTexpansionitems>>& and
11580 &<<SECTverifyPRVS>>&.
11581
11582 .vitem &$qualify_domain$&
11583 .vindex "&$qualify_domain$&"
11584 The value set for the &%qualify_domain%& option in the configuration file.
11585
11586 .vitem &$qualify_recipient$&
11587 .vindex "&$qualify_recipient$&"
11588 The value set for the &%qualify_recipient%& option in the configuration file,
11589 or if not set, the value of &$qualify_domain$&.
11590
11591 .vitem &$rcpt_count$&
11592 .vindex "&$rcpt_count$&"
11593 When a message is being received by SMTP, this variable contains the number of
11594 RCPT commands received for the current message. If this variable is used in a
11595 RCPT ACL, its value includes the current command.
11596
11597 .vitem &$rcpt_defer_count$&
11598 .vindex "&$rcpt_defer_count$&"
11599 .cindex "4&'xx'& responses" "count of"
11600 When a message is being received by SMTP, this variable contains the number of
11601 RCPT commands in the current message that have previously been rejected with a
11602 temporary (4&'xx'&) response.
11603
11604 .vitem &$rcpt_fail_count$&
11605 .vindex "&$rcpt_fail_count$&"
11606 When a message is being received by SMTP, this variable contains the number of
11607 RCPT commands in the current message that have previously been rejected with a
11608 permanent (5&'xx'&) response.
11609
11610 .vitem &$received_count$&
11611 .vindex "&$received_count$&"
11612 This variable contains the number of &'Received:'& header lines in the message,
11613 including the one added by Exim (so its value is always greater than zero). It
11614 is available in the DATA ACL, the non-SMTP ACL, and while routing and
11615 delivering.
11616
11617 .vitem &$received_for$&
11618 .vindex "&$received_for$&"
11619 If there is only a single recipient address in an incoming message, this
11620 variable contains that address when the &'Received:'& header line is being
11621 built. The value is copied after recipient rewriting has happened, but before
11622 the &[local_scan()]& function is run.
11623
11624 .vitem &$received_ip_address$&
11625 .vindex "&$received_ip_address$&"
11626 As soon as an Exim server starts processing an incoming TCP/IP connection, this
11627 variable is set to the address of the local IP interface, and &$received_port$&
11628 is set to the local port number. (The remote IP address and port are in
11629 &$sender_host_address$& and &$sender_host_port$&.) When testing with &%-bh%&,
11630 the port value is -1 unless it has been set using the &%-oMi%& command line
11631 option.
11632
11633 As well as being useful in ACLs (including the &"connect"& ACL), these variable
11634 could be used, for example, to make the file name for a TLS certificate depend
11635 on which interface and/or port is being used for the incoming connection. The
11636 values of &$received_ip_address$& and &$received_port$& are saved with any
11637 messages that are received, thus making these variables available at delivery
11638 time.
11639
11640 &*Note:*& There are no equivalent variables for outgoing connections, because
11641 the values are unknown (unless they are explicitly set by options of the
11642 &(smtp)& transport).
11643
11644 .vitem &$received_port$&
11645 .vindex "&$received_port$&"
11646 See &$received_ip_address$&.
11647
11648 .vitem &$received_protocol$&
11649 .vindex "&$received_protocol$&"
11650 When a message is being processed, this variable contains the name of the
11651 protocol by which it was received. Most of the names used by Exim are defined
11652 by RFCs 821, 2821, and 3848. They start with &"smtp"& (the client used HELO) or
11653 &"esmtp"& (the client used EHLO). This can be followed by &"s"& for secure
11654 (encrypted) and/or &"a"& for authenticated. Thus, for example, if the protocol
11655 is set to &"esmtpsa"&, the message was received over an encrypted SMTP
11656 connection and the client was successfully authenticated.
11657
11658 Exim uses the protocol name &"smtps"& for the case when encryption is
11659 automatically set up on connection without the use of STARTTLS (see
11660 &%tls_on_connect_ports%&), and the client uses HELO to initiate the
11661 encrypted SMTP session. The name &"smtps"& is also used for the rare situation
11662 where the client initially uses EHLO, sets up an encrypted connection using
11663 STARTTLS, and then uses HELO afterwards.
11664
11665 The &%-oMr%& option provides a way of specifying a custom protocol name for
11666 messages that are injected locally by trusted callers. This is commonly used to
11667 identify messages that are being re-injected after some kind of scanning.
11668
11669 .vitem &$received_time$&
11670 .vindex "&$received_time$&"
11671 This variable contains the date and time when the current message was received,
11672 as a number of seconds since the start of the Unix epoch.
11673
11674 .vitem &$recipient_data$&
11675 .vindex "&$recipient_data$&"
11676 This variable is set after an indexing lookup success in an ACL &%recipients%&
11677 condition. It contains the data from the lookup, and the value remains set
11678 until the next &%recipients%& test. Thus, you can do things like this:
11679 .display
11680 &`require recipients  = cdb*@;/some/file`&
11681 &`deny    `&&'some further test involving'& &`$recipient_data`&
11682 .endd
11683 &*Warning*&: This variable is set only when a lookup is used as an indexing
11684 method in the address list, using the semicolon syntax as in the example above.
11685 The variable is not set for a lookup that is used as part of the string
11686 expansion that all such lists undergo before being interpreted.
11687
11688 .vitem &$recipient_verify_failure$&
11689 .vindex "&$recipient_verify_failure$&"
11690 In an ACL, when a recipient verification fails, this variable contains
11691 information about the failure. It is set to one of the following words:
11692
11693 .ilist
11694 &"qualify"&: The address was unqualified (no domain), and the message
11695 was neither local nor came from an exempted host.
11696
11697 .next
11698 &"route"&: Routing failed.
11699
11700 .next
11701 &"mail"&: Routing succeeded, and a callout was attempted; rejection occurred at
11702 or before the MAIL command (that is, on initial connection, HELO, or
11703 MAIL).
11704
11705 .next
11706 &"recipient"&: The RCPT command in a callout was rejected.
11707 .next
11708
11709 &"postmaster"&: The postmaster check in a callout was rejected.
11710 .endlist
11711
11712 The main use of this variable is expected to be to distinguish between
11713 rejections of MAIL and rejections of RCPT.
11714
11715 .vitem &$recipients$&
11716 .vindex "&$recipients$&"
11717 This variable contains a list of envelope recipients for a message. A comma and
11718 a space separate the addresses in the replacement text. However, the variable
11719 is not generally available, to prevent exposure of Bcc recipients in
11720 unprivileged users' filter files. You can use &$recipients$& only in these
11721 cases:
11722
11723 .olist
11724 In a system filter file.
11725 .next
11726 In the ACLs associated with the DATA command and with non-SMTP messages, that
11727 is, the ACLs defined by &%acl_smtp_predata%&, &%acl_smtp_data%&,
11728 &%acl_smtp_mime%&, &%acl_not_smtp_start%&, &%acl_not_smtp%&, and
11729 &%acl_not_smtp_mime%&.
11730 .next
11731 From within a &[local_scan()]& function.
11732 .endlist
11733
11734
11735 .vitem &$recipients_count$&
11736 .vindex "&$recipients_count$&"
11737 When a message is being processed, this variable contains the number of
11738 envelope recipients that came with the message. Duplicates are not excluded
11739 from the count. While a message is being received over SMTP, the number
11740 increases for each accepted recipient. It can be referenced in an ACL.
11741
11742
11743 .vitem &$regex_match_string$&
11744 .vindex "&$regex_match_string$&"
11745 This variable is set to contain the matching regular expression after a
11746 &%regex%& ACL condition has matched (see section &<<SECTscanregex>>&).
11747
11748
11749 .vitem &$reply_address$&
11750 .vindex "&$reply_address$&"
11751 When a message is being processed, this variable contains the contents of the
11752 &'Reply-To:'& header line if one exists and it is not empty, or otherwise the
11753 contents of the &'From:'& header line. Apart from the removal of leading
11754 white space, the value is not processed in any way. In particular, no RFC 2047
11755 decoding or character code translation takes place.
11756
11757 .vitem &$return_path$&
11758 .vindex "&$return_path$&"
11759 When a message is being delivered, this variable contains the return path &--
11760 the sender field that will be sent as part of the envelope. It is not enclosed
11761 in <> characters. At the start of routing an address, &$return_path$& has the
11762 same value as &$sender_address$&, but if, for example, an incoming message to a
11763 mailing list has been expanded by a router which specifies a different address
11764 for bounce messages, &$return_path$& subsequently contains the new bounce
11765 address, whereas &$sender_address$& always contains the original sender address
11766 that was received with the message. In other words, &$sender_address$& contains
11767 the incoming envelope sender, and &$return_path$& contains the outgoing
11768 envelope sender.
11769
11770 .vitem &$return_size_limit$&
11771 .vindex "&$return_size_limit$&"
11772 This is an obsolete name for &$bounce_return_size_limit$&.
11773
11774 .vitem &$router_name$&
11775 .cindex "router" "name"
11776 .cindex "name" "of router"
11777 .vindex "&$router_name$&"
11778 During the running of a router this variable contains its name.
11779
11780 .vitem &$runrc$&
11781 .cindex "return code" "from &%run%& expansion"
11782 .vindex "&$runrc$&"
11783 This variable contains the return code from a command that is run by the
11784 &%${run...}%& expansion item. &*Warning*&: In a router or transport, you cannot
11785 assume the order in which option values are expanded, except for those
11786 preconditions whose order of testing is documented. Therefore, you cannot
11787 reliably expect to set &$runrc$& by the expansion of one option, and use it in
11788 another.
11789
11790 .vitem &$self_hostname$&
11791 .oindex "&%self%&" "value of host name"
11792 .vindex "&$self_hostname$&"
11793 When an address is routed to a supposedly remote host that turns out to be the
11794 local host, what happens is controlled by the &%self%& generic router option.
11795 One of its values causes the address to be passed to another router. When this
11796 happens, &$self_hostname$& is set to the name of the local host that the
11797 original router encountered. In other circumstances its contents are null.
11798
11799 .vitem &$sender_address$&
11800 .vindex "&$sender_address$&"
11801 When a message is being processed, this variable contains the sender's address
11802 that was received in the message's envelope. The case of letters in the address
11803 is retained, in both the local part and the domain. For bounce messages, the
11804 value of this variable is the empty string. See also &$return_path$&.
11805
11806 .vitem &$sender_address_data$&
11807 .vindex "&$address_data$&"
11808 .vindex "&$sender_address_data$&"
11809 If &$address_data$& is set when the routers are called from an ACL to verify a
11810 sender address, the final value is preserved in &$sender_address_data$&, to
11811 distinguish it from data from a recipient address. The value does not persist
11812 after the end of the current ACL statement. If you want to preserve it for
11813 longer, you can save it in an ACL variable.
11814
11815 .vitem &$sender_address_domain$&
11816 .vindex "&$sender_address_domain$&"
11817 The domain portion of &$sender_address$&.
11818
11819 .vitem &$sender_address_local_part$&
11820 .vindex "&$sender_address_local_part$&"
11821 The local part portion of &$sender_address$&.
11822
11823 .vitem &$sender_data$&
11824 .vindex "&$sender_data$&"
11825 This variable is set after a lookup success in an ACL &%senders%& condition or
11826 in a router &%senders%& option. It contains the data from the lookup, and the
11827 value remains set until the next &%senders%& test. Thus, you can do things like
11828 this:
11829 .display
11830 &`require senders      = cdb*@;/some/file`&
11831 &`deny    `&&'some further test involving'& &`$sender_data`&
11832 .endd
11833 &*Warning*&: This variable is set only when a lookup is used as an indexing
11834 method in the address list, using the semicolon syntax as in the example above.
11835 The variable is not set for a lookup that is used as part of the string
11836 expansion that all such lists undergo before being interpreted.
11837
11838 .vitem &$sender_fullhost$&
11839 .vindex "&$sender_fullhost$&"
11840 When a message is received from a remote host, this variable contains the host
11841 name and IP address in a single string. It ends with the IP address in square
11842 brackets, followed by a colon and a port number if the logging of ports is
11843 enabled. The format of the rest of the string depends on whether the host
11844 issued a HELO or EHLO SMTP command, and whether the host name was verified by
11845 looking up its IP address. (Looking up the IP address can be forced by the
11846 &%host_lookup%& option, independent of verification.) A plain host name at the
11847 start of the string is a verified host name; if this is not present,
11848 verification either failed or was not requested. A host name in parentheses is
11849 the argument of a HELO or EHLO command. This is omitted if it is identical to
11850 the verified host name or to the host's IP address in square brackets.
11851
11852 .vitem &$sender_helo_name$&
11853 .vindex "&$sender_helo_name$&"
11854 When a message is received from a remote host that has issued a HELO or EHLO
11855 command, the argument of that command is placed in this variable. It is also
11856 set if HELO or EHLO is used when a message is received using SMTP locally via
11857 the &%-bs%& or &%-bS%& options.
11858
11859 .vitem &$sender_host_address$&
11860 .vindex "&$sender_host_address$&"
11861 When a message is received from a remote host, this variable contains that
11862 host's IP address. For locally submitted messages, it is empty.
11863
11864 .vitem &$sender_host_authenticated$&
11865 .vindex "&$sender_host_authenticated$&"
11866 This variable contains the name (not the public name) of the authenticator
11867 driver that successfully authenticated the client from which the message was
11868 received. It is empty if there was no successful authentication. See also
11869 &$authenticated_id$&.
11870
11871 .new
11872 .vitem &$sender_host_dnssec$&
11873 .vindex "&$sender_host_dnssec$&"
11874 If &$sender_host_name$& has been populated (by reference, &%hosts_lookup%& or
11875 otherwise) then this boolean will have been set true if, and only if, the
11876 resolver library states that the reverse DNS was authenticated data.  At all
11877 other times, this variable is false.
11878
11879 It is likely that you will need to coerce DNSSEC support on in the resolver
11880 library, by setting:
11881 .code
11882 dns_use_dnssec = 1
11883 .endd
11884
11885 Exim does not perform DNSSEC validation itself, instead leaving that to a
11886 validating resolver (eg, unbound, or bind with suitable configuration).
11887
11888 Exim does not (currently) check to see if the forward DNS was also secured
11889 with DNSSEC, only the reverse DNS.
11890
11891 If you have changed &%host_lookup_order%& so that &`bydns`& is not the first
11892 mechanism in the list, then this variable will be false.
11893 .wen
11894
11895
11896 .vitem &$sender_host_name$&
11897 .vindex "&$sender_host_name$&"
11898 When a message is received from a remote host, this variable contains the
11899 host's name as obtained by looking up its IP address. For messages received by
11900 other means, this variable is empty.
11901
11902 .vindex "&$host_lookup_failed$&"
11903 If the host name has not previously been looked up, a reference to
11904 &$sender_host_name$& triggers a lookup (for messages from remote hosts).
11905 A looked up name is accepted only if it leads back to the original IP address
11906 via a forward lookup. If either the reverse or the forward lookup fails to find
11907 any data, or if the forward lookup does not yield the original IP address,
11908 &$sender_host_name$& remains empty, and &$host_lookup_failed$& is set to &"1"&.
11909
11910 .vindex "&$host_lookup_deferred$&"
11911 However, if either of the lookups cannot be completed (for example, there is a
11912 DNS timeout), &$host_lookup_deferred$& is set to &"1"&, and
11913 &$host_lookup_failed$& remains set to &"0"&.
11914
11915 Once &$host_lookup_failed$& is set to &"1"&, Exim does not try to look up the
11916 host name again if there is a subsequent reference to &$sender_host_name$&
11917 in the same Exim process, but it does try again if &$host_lookup_deferred$&
11918 is set to &"1"&.
11919
11920 Exim does not automatically look up every calling host's name. If you want
11921 maximum efficiency, you should arrange your configuration so that it avoids
11922 these lookups altogether. The lookup happens only if one or more of the
11923 following are true:
11924
11925 .ilist
11926 A string containing &$sender_host_name$& is expanded.
11927 .next
11928 The calling host matches the list in &%host_lookup%&. In the default
11929 configuration, this option is set to *, so it must be changed if lookups are
11930 to be avoided. (In the code, the default for &%host_lookup%& is unset.)
11931 .next
11932 Exim needs the host name in order to test an item in a host list. The items
11933 that require this are described in sections &<<SECThoslispatnam>>& and
11934 &<<SECThoslispatnamsk>>&.
11935 .next
11936 The calling host matches &%helo_try_verify_hosts%& or &%helo_verify_hosts%&.
11937 In this case, the host name is required to compare with the name quoted in any
11938 EHLO or HELO commands that the client issues.
11939 .next
11940 The remote host issues a EHLO or HELO command that quotes one of the
11941 domains in &%helo_lookup_domains%&. The default value of this option is
11942 . ==== As this is a nested list, any displays it contains must be indented
11943 . ==== as otherwise they are too far to the left.
11944 .code
11945   helo_lookup_domains = @ : @[]
11946 .endd
11947 which causes a lookup if a remote host (incorrectly) gives the server's name or
11948 IP address in an EHLO or HELO command.
11949 .endlist
11950
11951
11952 .vitem &$sender_host_port$&
11953 .vindex "&$sender_host_port$&"
11954 When a message is received from a remote host, this variable contains the port
11955 number that was used on the remote host.
11956
11957 .vitem &$sender_ident$&
11958 .vindex "&$sender_ident$&"
11959 When a message is received from a remote host, this variable contains the
11960 identification received in response to an RFC 1413 request. When a message has
11961 been received locally, this variable contains the login name of the user that
11962 called Exim.
11963
11964 .vitem &$sender_rate_$&&'xxx'&
11965 A number of variables whose names begin &$sender_rate_$& are set as part of the
11966 &%ratelimit%& ACL condition. Details are given in section
11967 &<<SECTratelimiting>>&.
11968
11969 .vitem &$sender_rcvhost$&
11970 .cindex "DNS" "reverse lookup"
11971 .cindex "reverse DNS lookup"
11972 .vindex "&$sender_rcvhost$&"
11973 This is provided specifically for use in &'Received:'& headers. It starts with
11974 either the verified host name (as obtained from a reverse DNS lookup) or, if
11975 there is no verified host name, the IP address in square brackets. After that
11976 there may be text in parentheses. When the first item is a verified host name,
11977 the first thing in the parentheses is the IP address in square brackets,
11978 followed by a colon and a port number if port logging is enabled. When the
11979 first item is an IP address, the port is recorded as &"port=&'xxxx'&"& inside
11980 the parentheses.
11981
11982 There may also be items of the form &"helo=&'xxxx'&"& if HELO or EHLO
11983 was used and its argument was not identical to the real host name or IP
11984 address, and &"ident=&'xxxx'&"& if an RFC 1413 ident string is available. If
11985 all three items are present in the parentheses, a newline and tab are inserted
11986 into the string, to improve the formatting of the &'Received:'& header.
11987
11988 .vitem &$sender_verify_failure$&
11989 .vindex "&$sender_verify_failure$&"
11990 In an ACL, when a sender verification fails, this variable contains information
11991 about the failure. The details are the same as for
11992 &$recipient_verify_failure$&.
11993
11994 .vitem &$sending_ip_address$&
11995 .vindex "&$sending_ip_address$&"
11996 This variable is set whenever an outgoing SMTP connection to another host has
11997 been set up. It contains the IP address of the local interface that is being
11998 used. This is useful if a host that has more than one IP address wants to take
11999 on different personalities depending on which one is being used. For incoming
12000 connections, see &$received_ip_address$&.
12001
12002 .vitem &$sending_port$&
12003 .vindex "&$sending_port$&"
12004 This variable is set whenever an outgoing SMTP connection to another host has
12005 been set up. It contains the local port that is being used. For incoming
12006 connections, see &$received_port$&.
12007
12008 .vitem &$smtp_active_hostname$&
12009 .vindex "&$smtp_active_hostname$&"
12010 During an incoming SMTP session, this variable contains the value of the active
12011 host name, as specified by the &%smtp_active_hostname%& option. The value of
12012 &$smtp_active_hostname$& is saved with any message that is received, so its
12013 value can be consulted during routing and delivery.
12014
12015 .vitem &$smtp_command$&
12016 .vindex "&$smtp_command$&"
12017 During the processing of an incoming SMTP command, this variable contains the
12018 entire command. This makes it possible to distinguish between HELO and EHLO in
12019 the HELO ACL, and also to distinguish between commands such as these:
12020 .code
12021 MAIL FROM:<>
12022 MAIL FROM: <>
12023 .endd
12024 For a MAIL command, extra parameters such as SIZE can be inspected. For a RCPT
12025 command, the address in &$smtp_command$& is the original address before any
12026 rewriting, whereas the values in &$local_part$& and &$domain$& are taken from
12027 the address after SMTP-time rewriting.
12028
12029 .vitem &$smtp_command_argument$&
12030 .cindex "SMTP" "command, argument for"
12031 .vindex "&$smtp_command_argument$&"
12032 While an ACL is running to check an SMTP command, this variable contains the
12033 argument, that is, the text that follows the command name, with leading white
12034 space removed. Following the introduction of &$smtp_command$&, this variable is
12035 somewhat redundant, but is retained for backwards compatibility.
12036
12037 .vitem &$smtp_count_at_connection_start$&
12038 .vindex "&$smtp_count_at_connection_start$&"
12039 This variable is set greater than zero only in processes spawned by the Exim
12040 daemon for handling incoming SMTP connections. The name is deliberately long,
12041 in order to emphasize what the contents are. When the daemon accepts a new
12042 connection, it increments this variable. A copy of the variable is passed to
12043 the child process that handles the connection, but its value is fixed, and
12044 never changes. It is only an approximation of how many incoming connections
12045 there actually are, because many other connections may come and go while a
12046 single connection is being processed. When a child process terminates, the
12047 daemon decrements its copy of the variable.
12048
12049 .vitem "&$sn0$& &-- &$sn9$&"
12050 These variables are copies of the values of the &$n0$& &-- &$n9$& accumulators
12051 that were current at the end of the system filter file. This allows a system
12052 filter file to set values that can be tested in users' filter files. For
12053 example, a system filter could set a value indicating how likely it is that a
12054 message is junk mail.
12055
12056 .vitem &$spam_$&&'xxx'&
12057 A number of variables whose names start with &$spam$& are available when Exim
12058 is compiled with the content-scanning extension. For details, see section
12059 &<<SECTscanspamass>>&.
12060
12061
12062 .vitem &$spool_directory$&
12063 .vindex "&$spool_directory$&"
12064 The name of Exim's spool directory.
12065
12066 .vitem &$spool_inodes$&
12067 .vindex "&$spool_inodes$&"
12068 The number of free inodes in the disk partition where Exim's spool files are
12069 being written. The value is recalculated whenever the variable is referenced.
12070 If the relevant file system does not have the concept of inodes, the value of
12071 is -1. See also the &%check_spool_inodes%& option.
12072
12073 .vitem &$spool_space$&
12074 .vindex "&$spool_space$&"
12075 The amount of free space (as a number of kilobytes) in the disk partition where
12076 Exim's spool files are being written. The value is recalculated whenever the
12077 variable is referenced. If the operating system does not have the ability to
12078 find the amount of free space (only true for experimental systems), the space
12079 value is -1. For example, to check in an ACL that there is at least 50
12080 megabytes free on the spool, you could write:
12081 .code
12082 condition = ${if > {$spool_space}{50000}}
12083 .endd
12084 See also the &%check_spool_space%& option.
12085
12086
12087 .vitem &$thisaddress$&
12088 .vindex "&$thisaddress$&"
12089 This variable is set only during the processing of the &%foranyaddress%&
12090 command in a filter file. Its use is explained in the description of that
12091 command, which can be found in the separate document entitled &'Exim's
12092 interfaces to mail filtering'&.
12093
12094 .vitem &$tls_in_bits$&
12095 .vindex "&$tls_in_bits$&"
12096 Contains an approximation of the TLS cipher's bit-strength
12097 on the inbound connection; the meaning of
12098 this depends upon the TLS implementation used.
12099 If TLS has not been negotiated, the value will be 0.
12100 The value of this is automatically fed into the Cyrus SASL authenticator
12101 when acting as a server, to specify the "external SSF" (a SASL term).
12102
12103 The deprecated &$tls_bits$& variable refers to the inbound side
12104 except when used in the context of an outbound SMTP delivery, when it refers to
12105 the outbound.
12106
12107 .vitem &$tls_out_bits$&
12108 .vindex "&$tls_out_bits$&"
12109 Contains an approximation of the TLS cipher's bit-strength
12110 on an outbound SMTP connection; the meaning of
12111 this depends upon the TLS implementation used.
12112 If TLS has not been negotiated, the value will be 0.
12113
12114 .vitem &$tls_in_certificate_verified$&
12115 .vindex "&$tls_in_certificate_verified$&"
12116 This variable is set to &"1"& if a TLS certificate was verified when the
12117 message was received, and &"0"& otherwise.
12118
12119 The deprecated &$tls_certificate_verfied$& variable refers to the inbound side
12120 except when used in the context of an outbound SMTP delivery, when it refers to
12121 the outbound.
12122
12123 .vitem &$tls_out_certificate_verified$&
12124 .vindex "&$tls_out_certificate_verified$&"
12125 This variable is set to &"1"& if a TLS certificate was verified when an
12126 outbound SMTP connection was made,
12127 and &"0"& otherwise.
12128
12129 .vitem &$tls_in_cipher$&
12130 .vindex "&$tls_in_cipher$&"
12131 .vindex "&$tls_cipher$&"
12132 When a message is received from a remote host over an encrypted SMTP
12133 connection, this variable is set to the cipher suite that was negotiated, for
12134 example DES-CBC3-SHA. In other circumstances, in particular, for message
12135 received over unencrypted connections, the variable is empty. Testing
12136 &$tls_cipher$& for emptiness is one way of distinguishing between encrypted and
12137 non-encrypted connections during ACL processing.
12138
12139 The deprecated &$tls_cipher$& variable is the same as &$tls_in_cipher$& during message reception,
12140 but in the context of an outward SMTP delivery taking place via the &(smtp)& transport
12141 becomes the same as &$tls_out_cipher$&.
12142
12143 .vitem &$tls_out_cipher$&
12144 .vindex "&$tls_out_cipher$&"
12145 This variable is
12146 cleared before any outgoing SMTP connection is made,
12147 and then set to the outgoing cipher suite if one is negotiated. See chapter
12148 &<<CHAPTLS>>& for details of TLS support and chapter &<<CHAPsmtptrans>>& for
12149 details of the &(smtp)& transport.
12150
12151 .vitem &$tls_in_peerdn$&
12152 .vindex "&$tls_in_peerdn$&"
12153 .vindex "&$tls_peerdn$&"
12154 When a message is received from a remote host over an encrypted SMTP
12155 connection, and Exim is configured to request a certificate from the client,
12156 the value of the Distinguished Name of the certificate is made available in the
12157 &$tls_in_peerdn$& during subsequent processing.
12158
12159 The deprecated &$tls_peerdn$& variable refers to the inbound side
12160 except when used in the context of an outbound SMTP delivery, when it refers to
12161 the outbound.
12162
12163 .vitem &$tls_out_peerdn$&
12164 .vindex "&$tls_out_peerdn$&"
12165 When a message is being delivered to a remote host over an encrypted SMTP
12166 connection, and Exim is configured to request a certificate from the server,
12167 the value of the Distinguished Name of the certificate is made available in the
12168 &$tls_out_peerdn$& during subsequent processing.
12169
12170 .vitem &$tls_in_sni$&
12171 .vindex "&$tls_in_sni$&"
12172 .vindex "&$tls_sni$&"
12173 .cindex "TLS" "Server Name Indication"
12174 When a TLS session is being established, if the client sends the Server
12175 Name Indication extension, the value will be placed in this variable.
12176 If the variable appears in &%tls_certificate%& then this option and
12177 some others, described in &<<SECTtlssni>>&,
12178 will be re-expanded early in the TLS session, to permit
12179 a different certificate to be presented (and optionally a different key to be
12180 used) to the client, based upon the value of the SNI extension.
12181
12182 The deprecated &$tls_sni$& variable refers to the inbound side
12183 except when used in the context of an outbound SMTP delivery, when it refers to
12184 the outbound.
12185
12186 .vitem &$tls_out_sni$&
12187 .vindex "&$tls_out_sni$&"
12188 .cindex "TLS" "Server Name Indication"
12189 During outbound
12190 SMTP deliveries, this variable reflects the value of the &%tls_sni%& option on
12191 the transport.
12192
12193 .vitem &$tod_bsdinbox$&
12194 .vindex "&$tod_bsdinbox$&"
12195 The time of day and the date, in the format required for BSD-style mailbox
12196 files, for example: Thu Oct 17 17:14:09 1995.
12197
12198 .vitem &$tod_epoch$&
12199 .vindex "&$tod_epoch$&"
12200 The time and date as a number of seconds since the start of the Unix epoch.
12201
12202 .vitem &$tod_epoch_l$&
12203 .vindex "&$tod_epoch_l$&"
12204 The time and date as a number of microseconds since the start of the Unix epoch.
12205
12206 .vitem &$tod_full$&
12207 .vindex "&$tod_full$&"
12208 A full version of the time and date, for example: Wed, 16 Oct 1995 09:51:40
12209 +0100. The timezone is always given as a numerical offset from UTC, with
12210 positive values used for timezones that are ahead (east) of UTC, and negative
12211 values for those that are behind (west).
12212
12213 .vitem &$tod_log$&
12214 .vindex "&$tod_log$&"
12215 The time and date in the format used for writing Exim's log files, for example:
12216 1995-10-12 15:32:29, but without a timezone.
12217
12218 .vitem &$tod_logfile$&
12219 .vindex "&$tod_logfile$&"
12220 This variable contains the date in the format yyyymmdd. This is the format that
12221 is used for datestamping log files when &%log_file_path%& contains the &`%D`&
12222 flag.
12223
12224 .vitem &$tod_zone$&
12225 .vindex "&$tod_zone$&"
12226 This variable contains the numerical value of the local timezone, for example:
12227 -0500.
12228
12229 .vitem &$tod_zulu$&
12230 .vindex "&$tod_zulu$&"
12231 This variable contains the UTC date and time in &"Zulu"& format, as specified
12232 by ISO 8601, for example: 20030221154023Z.
12233
12234 .vitem &$transport_name$&
12235 .cindex "transport" "name"
12236 .cindex "name" "of transport"
12237 .vindex "&$transport_name$&"
12238 During the running of a transport, this variable contains its name.
12239
12240 .vitem &$value$&
12241 .vindex "&$value$&"
12242 This variable contains the result of an expansion lookup, extraction operation,
12243 or external command, as described above. It is also used during a
12244 &*reduce*& expansion.
12245
12246 .vitem &$version_number$&
12247 .vindex "&$version_number$&"
12248 The version number of Exim.
12249
12250 .vitem &$warn_message_delay$&
12251 .vindex "&$warn_message_delay$&"
12252 This variable is set only during the creation of a message warning about a
12253 delivery delay. Details of its use are explained in section &<<SECTcustwarn>>&.
12254
12255 .vitem &$warn_message_recipients$&
12256 .vindex "&$warn_message_recipients$&"
12257 This variable is set only during the creation of a message warning about a
12258 delivery delay. Details of its use are explained in section &<<SECTcustwarn>>&.
12259 .endlist
12260 .ecindex IIDstrexp
12261
12262
12263
12264 . ////////////////////////////////////////////////////////////////////////////
12265 . ////////////////////////////////////////////////////////////////////////////
12266
12267 .chapter "Embedded Perl" "CHAPperl"
12268 .scindex IIDperl "Perl" "calling from Exim"
12269 Exim can be built to include an embedded Perl interpreter. When this is done,
12270 Perl subroutines can be called as part of the string expansion process. To make
12271 use of the Perl support, you need version 5.004 or later of Perl installed on
12272 your system. To include the embedded interpreter in the Exim binary, include
12273 the line
12274 .code
12275 EXIM_PERL = perl.o
12276 .endd
12277 in your &_Local/Makefile_& and then build Exim in the normal way.
12278
12279
12280 .section "Setting up so Perl can be used" "SECID85"
12281 .oindex "&%perl_startup%&"
12282 Access to Perl subroutines is via a global configuration option called
12283 &%perl_startup%& and an expansion string operator &%${perl ...}%&. If there is
12284 no &%perl_startup%& option in the Exim configuration file then no Perl
12285 interpreter is started and there is almost no overhead for Exim (since none of
12286 the Perl library will be paged in unless used). If there is a &%perl_startup%&
12287 option then the associated value is taken to be Perl code which is executed in
12288 a newly created Perl interpreter.
12289
12290 The value of &%perl_startup%& is not expanded in the Exim sense, so you do not
12291 need backslashes before any characters to escape special meanings. The option
12292 should usually be something like
12293 .code
12294 perl_startup = do '/etc/exim.pl'
12295 .endd
12296 where &_/etc/exim.pl_& is Perl code which defines any subroutines you want to
12297 use from Exim. Exim can be configured either to start up a Perl interpreter as
12298 soon as it is entered, or to wait until the first time it is needed. Starting
12299 the interpreter at the beginning ensures that it is done while Exim still has
12300 its setuid privilege, but can impose an unnecessary overhead if Perl is not in
12301 fact used in a particular run. Also, note that this does not mean that Exim is
12302 necessarily running as root when Perl is called at a later time. By default,
12303 the interpreter is started only when it is needed, but this can be changed in
12304 two ways:
12305
12306 .ilist
12307 .oindex "&%perl_at_start%&"
12308 Setting &%perl_at_start%& (a boolean option) in the configuration requests
12309 a startup when Exim is entered.
12310 .next
12311 The command line option &%-ps%& also requests a startup when Exim is entered,
12312 overriding the setting of &%perl_at_start%&.
12313 .endlist
12314
12315 There is also a command line option &%-pd%& (for delay) which suppresses the
12316 initial startup, even if &%perl_at_start%& is set.
12317
12318
12319 .section "Calling Perl subroutines" "SECID86"
12320 When the configuration file includes a &%perl_startup%& option you can make use
12321 of the string expansion item to call the Perl subroutines that are defined
12322 by the &%perl_startup%& code. The operator is used in any of the following
12323 forms:
12324 .code
12325 ${perl{foo}}
12326 ${perl{foo}{argument}}
12327 ${perl{foo}{argument1}{argument2} ... }
12328 .endd
12329 which calls the subroutine &%foo%& with the given arguments. A maximum of eight
12330 arguments may be passed. Passing more than this results in an expansion failure
12331 with an error message of the form
12332 .code
12333 Too many arguments passed to Perl subroutine "foo" (max is 8)
12334 .endd
12335 The return value of the Perl subroutine is evaluated in a scalar context before
12336 it is passed back to Exim to be inserted into the expanded string. If the
12337 return value is &'undef'&, the expansion is forced to fail in the same way as
12338 an explicit &"fail"& on an &%if%& or &%lookup%& item. If the subroutine aborts
12339 by obeying Perl's &%die%& function, the expansion fails with the error message
12340 that was passed to &%die%&.
12341
12342
12343 .section "Calling Exim functions from Perl" "SECID87"
12344 Within any Perl code called from Exim, the function &'Exim::expand_string()'&
12345 is available to call back into Exim's string expansion function. For example,
12346 the Perl code
12347 .code
12348 my $lp = Exim::expand_string('$local_part');
12349 .endd
12350 makes the current Exim &$local_part$& available in the Perl variable &$lp$&.
12351 Note those are single quotes and not double quotes to protect against
12352 &$local_part$& being interpolated as a Perl variable.
12353
12354 If the string expansion is forced to fail by a &"fail"& item, the result of
12355 &'Exim::expand_string()'& is &%undef%&. If there is a syntax error in the
12356 expansion string, the Perl call from the original expansion string fails with
12357 an appropriate error message, in the same way as if &%die%& were used.
12358
12359 .cindex "debugging" "from embedded Perl"
12360 .cindex "log" "writing from embedded Perl"
12361 Two other Exim functions are available for use from within Perl code.
12362 &'Exim::debug_write()'& writes a string to the standard error stream if Exim's
12363 debugging is enabled. If you want a newline at the end, you must supply it.
12364 &'Exim::log_write()'& writes a string to Exim's main log, adding a leading
12365 timestamp. In this case, you should not supply a terminating newline.
12366
12367
12368 .section "Use of standard output and error by Perl" "SECID88"
12369 .cindex "Perl" "standard output and error"
12370 You should not write to the standard error or output streams from within your
12371 Perl code, as it is not defined how these are set up. In versions of Exim
12372 before 4.50, it is possible for the standard output or error to refer to the
12373 SMTP connection during message reception via the daemon. Writing to this stream
12374 is certain to cause chaos. From Exim 4.50 onwards, the standard output and
12375 error streams are connected to &_/dev/null_& in the daemon. The chaos is
12376 avoided, but the output is lost.
12377
12378 .cindex "Perl" "use of &%warn%&"
12379 The Perl &%warn%& statement writes to the standard error stream by default.
12380 Calls to &%warn%& may be embedded in Perl modules that you use, but over which
12381 you have no control. When Exim starts up the Perl interpreter, it arranges for
12382 output from the &%warn%& statement to be written to the Exim main log. You can
12383 change this by including appropriate Perl magic somewhere in your Perl code.
12384 For example, to discard &%warn%& output completely, you need this:
12385 .code
12386 $SIG{__WARN__} = sub { };
12387 .endd
12388 Whenever a &%warn%& is obeyed, the anonymous subroutine is called. In this
12389 example, the code for the subroutine is empty, so it does nothing, but you can
12390 include any Perl code that you like. The text of the &%warn%& message is passed
12391 as the first subroutine argument.
12392 .ecindex IIDperl
12393
12394
12395 . ////////////////////////////////////////////////////////////////////////////
12396 . ////////////////////////////////////////////////////////////////////////////
12397
12398 .chapter "Starting the daemon and the use of network interfaces" &&&
12399          "CHAPinterfaces" &&&
12400          "Starting the daemon"
12401 .cindex "daemon" "starting"
12402 .cindex "interface" "listening"
12403 .cindex "network interface"
12404 .cindex "interface" "network"
12405 .cindex "IP address" "for listening"
12406 .cindex "daemon" "listening IP addresses"
12407 .cindex "TCP/IP" "setting listening interfaces"
12408 .cindex "TCP/IP" "setting listening ports"
12409 A host that is connected to a TCP/IP network may have one or more physical
12410 hardware network interfaces. Each of these interfaces may be configured as one
12411 or more &"logical"& interfaces, which are the entities that a program actually
12412 works with. Each of these logical interfaces is associated with an IP address.
12413 In addition, TCP/IP software supports &"loopback"& interfaces (127.0.0.1 in
12414 IPv4 and ::1 in IPv6), which do not use any physical hardware. Exim requires
12415 knowledge about the host's interfaces for use in three different circumstances:
12416
12417 .olist
12418 When a listening daemon is started, Exim needs to know which interfaces
12419 and ports to listen on.
12420 .next
12421 When Exim is routing an address, it needs to know which IP addresses
12422 are associated with local interfaces. This is required for the correct
12423 processing of MX lists by removing the local host and others with the
12424 same or higher priority values. Also, Exim needs to detect cases
12425 when an address is routed to an IP address that in fact belongs to the
12426 local host. Unless the &%self%& router option or the &%allow_localhost%&
12427 option of the smtp transport is set (as appropriate), this is treated
12428 as an error situation.
12429 .next
12430 When Exim connects to a remote host, it may need to know which interface to use
12431 for the outgoing connection.
12432 .endlist
12433
12434
12435 Exim's default behaviour is likely to be appropriate in the vast majority
12436 of cases. If your host has only one interface, and you want all its IP
12437 addresses to be treated in the same way, and you are using only the
12438 standard SMTP port, you should not need to take any special action. The
12439 rest of this chapter does not apply to you.
12440
12441 In a more complicated situation you may want to listen only on certain
12442 interfaces, or on different ports, and for this reason there are a number of
12443 options that can be used to influence Exim's behaviour. The rest of this
12444 chapter describes how they operate.
12445
12446 When a message is received over TCP/IP, the interface and port that were
12447 actually used are set in &$received_ip_address$& and &$received_port$&.
12448
12449
12450
12451 .section "Starting a listening daemon" "SECID89"
12452 When a listening daemon is started (by means of the &%-bd%& command line
12453 option), the interfaces and ports on which it listens are controlled by the
12454 following options:
12455
12456 .ilist
12457 &%daemon_smtp_ports%& contains a list of default ports. (For backward
12458 compatibility, this option can also be specified in the singular.)
12459 .next
12460 &%local_interfaces%& contains list of interface IP addresses on which to
12461 listen. Each item may optionally also specify a port.
12462 .endlist
12463
12464 The default list separator in both cases is a colon, but this can be changed as
12465 described in section &<<SECTlistconstruct>>&. When IPv6 addresses are involved,
12466 it is usually best to change the separator to avoid having to double all the
12467 colons. For example:
12468 .code
12469 local_interfaces = <; 127.0.0.1 ; \
12470                       192.168.23.65 ; \
12471                       ::1 ; \
12472                       3ffe:ffff:836f::fe86:a061
12473 .endd
12474 There are two different formats for specifying a port along with an IP address
12475 in &%local_interfaces%&:
12476
12477 .olist
12478 The port is added onto the address with a dot separator. For example, to listen
12479 on port 1234 on two different IP addresses:
12480 .code
12481 local_interfaces = <; 192.168.23.65.1234 ; \
12482                       3ffe:ffff:836f::fe86:a061.1234
12483 .endd
12484 .next
12485 The IP address is enclosed in square brackets, and the port is added
12486 with a colon separator, for example:
12487 .code
12488 local_interfaces = <; [192.168.23.65]:1234 ; \
12489                       [3ffe:ffff:836f::fe86:a061]:1234
12490 .endd
12491 .endlist
12492
12493 When a port is not specified, the value of &%daemon_smtp_ports%& is used. The
12494 default setting contains just one port:
12495 .code
12496 daemon_smtp_ports = smtp
12497 .endd
12498 If more than one port is listed, each interface that does not have its own port
12499 specified listens on all of them. Ports that are listed in
12500 &%daemon_smtp_ports%& can be identified either by name (defined in
12501 &_/etc/services_&) or by number. However, when ports are given with individual
12502 IP addresses in &%local_interfaces%&, only numbers (not names) can be used.
12503
12504
12505
12506 .section "Special IP listening addresses" "SECID90"
12507 The addresses 0.0.0.0 and ::0 are treated specially. They are interpreted
12508 as &"all IPv4 interfaces"& and &"all IPv6 interfaces"&, respectively. In each
12509 case, Exim tells the TCP/IP stack to &"listen on all IPv&'x'& interfaces"&
12510 instead of setting up separate listening sockets for each interface. The
12511 default value of &%local_interfaces%& is
12512 .code
12513 local_interfaces = 0.0.0.0
12514 .endd
12515 when Exim is built without IPv6 support; otherwise it is:
12516 .code
12517 local_interfaces = <; ::0 ; 0.0.0.0
12518 .endd
12519 Thus, by default, Exim listens on all available interfaces, on the SMTP port.
12520
12521
12522
12523 .section "Overriding local_interfaces and daemon_smtp_ports" "SECID91"
12524 The &%-oX%& command line option can be used to override the values of
12525 &%daemon_smtp_ports%& and/or &%local_interfaces%& for a particular daemon
12526 instance. Another way of doing this would be to use macros and the &%-D%&
12527 option. However, &%-oX%& can be used by any admin user, whereas modification of
12528 the runtime configuration by &%-D%& is allowed only when the caller is root or
12529 exim.
12530
12531 The value of &%-oX%& is a list of items. The default colon separator can be
12532 changed in the usual way if required. If there are any items that do not
12533 contain dots or colons (that is, are not IP addresses), the value of
12534 &%daemon_smtp_ports%& is replaced by the list of those items. If there are any
12535 items that do contain dots or colons, the value of &%local_interfaces%& is
12536 replaced by those items. Thus, for example,
12537 .code
12538 -oX 1225
12539 .endd
12540 overrides &%daemon_smtp_ports%&, but leaves &%local_interfaces%& unchanged,
12541 whereas
12542 .code
12543 -oX 192.168.34.5.1125
12544 .endd
12545 overrides &%local_interfaces%&, leaving &%daemon_smtp_ports%& unchanged.
12546 (However, since &%local_interfaces%& now contains no items without ports, the
12547 value of &%daemon_smtp_ports%& is no longer relevant in this example.)
12548
12549
12550
12551 .section "Support for the obsolete SSMTP (or SMTPS) protocol" "SECTsupobssmt"
12552 .cindex "ssmtp protocol"
12553 .cindex "smtps protocol"
12554 .cindex "SMTP" "ssmtp protocol"
12555 .cindex "SMTP" "smtps protocol"
12556 Exim supports the obsolete SSMTP protocol (also known as SMTPS) that was used
12557 before the STARTTLS command was standardized for SMTP. Some legacy clients
12558 still use this protocol. If the &%tls_on_connect_ports%& option is set to a
12559 list of port numbers, connections to those ports must use SSMTP. The most
12560 common use of this option is expected to be
12561 .code
12562 tls_on_connect_ports = 465
12563 .endd
12564 because 465 is the usual port number used by the legacy clients. There is also
12565 a command line option &%-tls-on-connect%&, which forces all ports to behave in
12566 this way when a daemon is started.
12567
12568 &*Warning*&: Setting &%tls_on_connect_ports%& does not of itself cause the
12569 daemon to listen on those ports. You must still specify them in
12570 &%daemon_smtp_ports%&, &%local_interfaces%&, or the &%-oX%& option. (This is
12571 because &%tls_on_connect_ports%& applies to &%inetd%& connections as well as to
12572 connections via the daemon.)
12573
12574
12575
12576
12577 .section "IPv6 address scopes" "SECID92"
12578 .cindex "IPv6" "address scopes"
12579 IPv6 addresses have &"scopes"&, and a host with multiple hardware interfaces
12580 can, in principle, have the same link-local IPv6 address on different
12581 interfaces. Thus, additional information is needed, over and above the IP
12582 address, to distinguish individual interfaces. A convention of using a
12583 percent sign followed by something (often the interface name) has been
12584 adopted in some cases, leading to addresses like this:
12585 .code
12586 fe80::202:b3ff:fe03:45c1%eth0
12587 .endd
12588 To accommodate this usage, a percent sign followed by an arbitrary string is
12589 allowed at the end of an IPv6 address. By default, Exim calls &[getaddrinfo()]&
12590 to convert a textual IPv6 address for actual use. This function recognizes the
12591 percent convention in operating systems that support it, and it processes the
12592 address appropriately. Unfortunately, some older libraries have problems with
12593 &[getaddrinfo()]&. If
12594 .code
12595 IPV6_USE_INET_PTON=yes
12596 .endd
12597 is set in &_Local/Makefile_& (or an OS-dependent Makefile) when Exim is built,
12598 Exim uses &'inet_pton()'& to convert a textual IPv6 address for actual use,
12599 instead of &[getaddrinfo()]&. (Before version 4.14, it always used this
12600 function.) Of course, this means that the additional functionality of
12601 &[getaddrinfo()]& &-- recognizing scoped addresses &-- is lost.
12602
12603 .section "Disabling IPv6" "SECID93"
12604 .cindex "IPv6" "disabling"
12605 Sometimes it happens that an Exim binary that was compiled with IPv6 support is
12606 run on a host whose kernel does not support IPv6. The binary will fall back to
12607 using IPv4, but it may waste resources looking up AAAA records, and trying to
12608 connect to IPv6 addresses, causing delays to mail delivery. If you set the
12609 .oindex "&%disable_ipv6%&"
12610 &%disable_ipv6%& option true, even if the Exim binary has IPv6 support, no IPv6
12611 activities take place. AAAA records are never looked up, and any IPv6 addresses
12612 that are listed in &%local_interfaces%&, data for the &(manualroute)& router,
12613 etc. are ignored. If IP literals are enabled, the &(ipliteral)& router declines
12614 to handle IPv6 literal addresses.
12615
12616 On the other hand, when IPv6 is in use, there may be times when you want to
12617 disable it for certain hosts or domains. You can use the &%dns_ipv4_lookup%&
12618 option to globally suppress the lookup of AAAA records for specified domains,
12619 and you can use the &%ignore_target_hosts%& generic router option to ignore
12620 IPv6 addresses in an individual router.
12621
12622
12623
12624 .section "Examples of starting a listening daemon" "SECID94"
12625 The default case in an IPv6 environment is
12626 .code
12627 daemon_smtp_ports = smtp
12628 local_interfaces = <; ::0 ; 0.0.0.0
12629 .endd
12630 This specifies listening on the smtp port on all IPv6 and IPv4 interfaces.
12631 Either one or two sockets may be used, depending on the characteristics of
12632 the TCP/IP stack. (This is complicated and messy; for more information,
12633 read the comments in the &_daemon.c_& source file.)
12634
12635 To specify listening on ports 25 and 26 on all interfaces:
12636 .code
12637 daemon_smtp_ports = 25 : 26
12638 .endd
12639 (leaving &%local_interfaces%& at the default setting) or, more explicitly:
12640 .code
12641 local_interfaces = <; ::0.25     ; ::0.26 \
12642                       0.0.0.0.25 ; 0.0.0.0.26
12643 .endd
12644 To listen on the default port on all IPv4 interfaces, and on port 26 on the
12645 IPv4 loopback address only:
12646 .code
12647 local_interfaces = 0.0.0.0 : 127.0.0.1.26
12648 .endd
12649 To specify listening on the default port on specific interfaces only:
12650 .code
12651 local_interfaces = 10.0.0.67 : 192.168.34.67
12652 .endd
12653 &*Warning*&: Such a setting excludes listening on the loopback interfaces.
12654
12655
12656
12657 .section "Recognizing the local host" "SECTreclocipadd"
12658 The &%local_interfaces%& option is also used when Exim needs to determine
12659 whether or not an IP address refers to the local host. That is, the IP
12660 addresses of all the interfaces on which a daemon is listening are always
12661 treated as local.
12662
12663 For this usage, port numbers in &%local_interfaces%& are ignored. If either of
12664 the items 0.0.0.0 or ::0 are encountered, Exim gets a complete list of
12665 available interfaces from the operating system, and extracts the relevant
12666 (that is, IPv4 or IPv6) addresses to use for checking.
12667
12668 Some systems set up large numbers of virtual interfaces in order to provide
12669 many virtual web servers. In this situation, you may want to listen for
12670 email on only a few of the available interfaces, but nevertheless treat all
12671 interfaces as local when routing. You can do this by setting
12672 &%extra_local_interfaces%& to a list of IP addresses, possibly including the
12673 &"all"& wildcard values. These addresses are recognized as local, but are not
12674 used for listening. Consider this example:
12675 .code
12676 local_interfaces = <; 127.0.0.1 ; ::1 ; \
12677                       192.168.53.235 ; \
12678                       3ffe:2101:12:1:a00:20ff:fe86:a061
12679
12680 extra_local_interfaces = <; ::0 ; 0.0.0.0
12681 .endd
12682 The daemon listens on the loopback interfaces and just one IPv4 and one IPv6
12683 address, but all available interface addresses are treated as local when
12684 Exim is routing.
12685
12686 In some environments the local host name may be in an MX list, but with an IP
12687 address that is not assigned to any local interface. In other cases it may be
12688 desirable to treat other host names as if they referred to the local host. Both
12689 these cases can be handled by setting the &%hosts_treat_as_local%& option.
12690 This contains host names rather than IP addresses. When a host is referenced
12691 during routing, either via an MX record or directly, it is treated as the local
12692 host if its name matches &%hosts_treat_as_local%&, or if any of its IP
12693 addresses match &%local_interfaces%& or &%extra_local_interfaces%&.
12694
12695
12696
12697 .section "Delivering to a remote host" "SECID95"
12698 Delivery to a remote host is handled by the smtp transport. By default, it
12699 allows the system's TCP/IP functions to choose which interface to use (if
12700 there is more than one) when connecting to a remote host. However, the
12701 &%interface%& option can be set to specify which interface is used. See the
12702 description of the smtp transport in chapter &<<CHAPsmtptrans>>& for more
12703 details.
12704
12705
12706
12707
12708 . ////////////////////////////////////////////////////////////////////////////
12709 . ////////////////////////////////////////////////////////////////////////////
12710
12711 .chapter "Main configuration" "CHAPmainconfig"
12712 .scindex IIDconfima "configuration file" "main section"
12713 .scindex IIDmaiconf "main configuration"
12714 The first part of the run time configuration file contains three types of item:
12715
12716 .ilist
12717 Macro definitions: These lines start with an upper case letter. See section
12718 &<<SECTmacrodefs>>& for details of macro processing.
12719 .next
12720 Named list definitions: These lines start with one of the words &"domainlist"&,
12721 &"hostlist"&, &"addresslist"&, or &"localpartlist"&. Their use is described in
12722 section &<<SECTnamedlists>>&.
12723 .next
12724 Main configuration settings: Each setting occupies one line of the file
12725 (with possible continuations). If any setting is preceded by the word
12726 &"hide"&, the &%-bP%& command line option displays its value to admin users
12727 only. See section &<<SECTcos>>& for a description of the syntax of these option
12728 settings.
12729 .endlist
12730
12731 This chapter specifies all the main configuration options, along with their
12732 types and default values. For ease of finding a particular option, they appear
12733 in alphabetical order in section &<<SECTalomo>>& below. However, because there
12734 are now so many options, they are first listed briefly in functional groups, as
12735 an aid to finding the name of the option you are looking for. Some options are
12736 listed in more than one group.
12737
12738 .section "Miscellaneous" "SECID96"
12739 .table2
12740 .row &%bi_command%&                  "to run for &%-bi%& command line option"
12741 .row &%disable_ipv6%&                "do no IPv6 processing"
12742 .row &%keep_malformed%&              "for broken files &-- should not happen"
12743 .row &%localhost_number%&            "for unique message ids in clusters"
12744 .row &%message_body_newlines%&       "retain newlines in &$message_body$&"
12745 .row &%message_body_visible%&        "how much to show in &$message_body$&"
12746 .row &%mua_wrapper%&                 "run in &""MUA wrapper""& mode"
12747 .row &%print_topbitchars%&           "top-bit characters are printing"
12748 .row &%timezone%&                    "force time zone"
12749 .endtable
12750
12751
12752 .section "Exim parameters" "SECID97"
12753 .table2
12754 .row &%exim_group%&                  "override compiled-in value"
12755 .row &%exim_path%&                   "override compiled-in value"
12756 .row &%exim_user%&                   "override compiled-in value"
12757 .row &%primary_hostname%&            "default from &[uname()]&"
12758 .row &%split_spool_directory%&       "use multiple directories"
12759 .row &%spool_directory%&             "override compiled-in value"
12760 .endtable
12761
12762
12763
12764 .section "Privilege controls" "SECID98"
12765 .table2
12766 .row &%admin_groups%&                "groups that are Exim admin users"
12767 .row &%deliver_drop_privilege%&      "drop root for delivery processes"
12768 .row &%local_from_check%&            "insert &'Sender:'& if necessary"
12769 .row &%local_from_prefix%&           "for testing &'From:'& for local sender"
12770 .row &%local_from_suffix%&           "for testing &'From:'& for local sender"
12771 .row &%local_sender_retain%&         "keep &'Sender:'& from untrusted user"
12772 .row &%never_users%&                 "do not run deliveries as these"
12773 .row &%prod_requires_admin%&         "forced delivery requires admin user"
12774 .row &%queue_list_requires_admin%&   "queue listing requires admin user"
12775 .row &%trusted_groups%&              "groups that are trusted"
12776 .row &%trusted_users%&               "users that are trusted"
12777 .endtable
12778
12779
12780
12781 .section "Logging" "SECID99"
12782 .table2
12783 .row &%hosts_connection_nolog%&      "exemption from connect logging"
12784 .row &%log_file_path%&               "override compiled-in value"
12785 .row &%log_selector%&                "set/unset optional logging"
12786 .row &%log_timezone%&                "add timezone to log lines"
12787 .row &%message_logs%&                "create per-message logs"
12788 .row &%preserve_message_logs%&       "after message completion"
12789 .row &%process_log_path%&            "for SIGUSR1 and &'exiwhat'&"
12790 .row &%syslog_duplication%&          "controls duplicate log lines on syslog"
12791 .row &%syslog_facility%&             "set syslog &""facility""& field"
12792 .row &%syslog_processname%&          "set syslog &""ident""& field"
12793 .row &%syslog_timestamp%&            "timestamp syslog lines"
12794 .row &%write_rejectlog%&             "control use of message log"
12795 .endtable
12796
12797
12798
12799 .section "Frozen messages" "SECID100"
12800 .table2
12801 .row &%auto_thaw%&                   "sets time for retrying frozen messages"
12802 .row &%freeze_tell%&                 "send message when freezing"
12803 .row &%move_frozen_messages%&        "to another directory"
12804 .row &%timeout_frozen_after%&        "keep frozen messages only so long"
12805 .endtable
12806
12807
12808
12809 .section "Data lookups" "SECID101"
12810 .table2
12811 .row &%ibase_servers%&               "InterBase servers"
12812 .row &%ldap_ca_cert_dir%&            "dir of CA certs to verify LDAP server's"
12813 .row &%ldap_ca_cert_file%&           "file of CA certs to verify LDAP server's"
12814 .row &%ldap_cert_file%&              "client cert file for LDAP"
12815 .row &%ldap_cert_key%&               "client key file for LDAP"
12816 .row &%ldap_cipher_suite%&           "TLS negotiation preference control"
12817 .row &%ldap_default_servers%&        "used if no server in query"
12818 .row &%ldap_require_cert%&           "action to take without LDAP server cert"
12819 .row &%ldap_start_tls%&              "require TLS within LDAP"
12820 .row &%ldap_version%&                "set protocol version"
12821 .row &%lookup_open_max%&             "lookup files held open"
12822 .row &%mysql_servers%&               "default MySQL servers"
12823 .row &%oracle_servers%&              "Oracle servers"
12824 .row &%pgsql_servers%&               "default PostgreSQL servers"
12825 .row &%sqlite_lock_timeout%&         "as it says"
12826 .endtable
12827
12828
12829
12830 .section "Message ids" "SECID102"
12831 .table2
12832 .row &%message_id_header_domain%&    "used to build &'Message-ID:'& header"
12833 .row &%message_id_header_text%&      "ditto"
12834 .endtable
12835
12836
12837
12838 .section "Embedded Perl Startup" "SECID103"
12839 .table2
12840 .row &%perl_at_start%&               "always start the interpreter"
12841 .row &%perl_startup%&                "code to obey when starting Perl"
12842 .endtable
12843
12844
12845
12846 .section "Daemon" "SECID104"
12847 .table2
12848 .row &%daemon_smtp_ports%&           "default ports"
12849 .row &%daemon_startup_retries%&      "number of times to retry"
12850 .row &%daemon_startup_sleep%&        "time to sleep between tries"
12851 .row &%extra_local_interfaces%&      "not necessarily listened on"
12852 .row &%local_interfaces%&            "on which to listen, with optional ports"
12853 .row &%pid_file_path%&               "override compiled-in value"
12854 .row &%queue_run_max%&               "maximum simultaneous queue runners"
12855 .endtable
12856
12857
12858
12859 .section "Resource control" "SECID105"
12860 .table2
12861 .row &%check_log_inodes%&            "before accepting a message"
12862 .row &%check_log_space%&             "before accepting a message"
12863 .row &%check_spool_inodes%&          "before accepting a message"
12864 .row &%check_spool_space%&           "before accepting a message"
12865 .row &%deliver_queue_load_max%&      "no queue deliveries if load high"
12866 .row &%queue_only_load%&             "queue incoming if load high"
12867 .row &%queue_only_load_latch%&       "don't re-evaluate load for each message"
12868 .row &%queue_run_max%&               "maximum simultaneous queue runners"
12869 .row &%remote_max_parallel%&         "parallel SMTP delivery per message"
12870 .row &%smtp_accept_max%&             "simultaneous incoming connections"
12871 .row &%smtp_accept_max_nonmail%&     "non-mail commands"
12872 .row &%smtp_accept_max_nonmail_hosts%& "hosts to which the limit applies"
12873 .row &%smtp_accept_max_per_connection%& "messages per connection"
12874 .row &%smtp_accept_max_per_host%&    "connections from one host"
12875 .row &%smtp_accept_queue%&           "queue mail if more connections"
12876 .row &%smtp_accept_queue_per_connection%& "queue if more messages per &&&
12877                                            connection"
12878 .row &%smtp_accept_reserve%&         "only reserve hosts if more connections"
12879 .row &%smtp_check_spool_space%&      "from SIZE on MAIL command"
12880 .row &%smtp_connect_backlog%&        "passed to TCP/IP stack"
12881 .row &%smtp_load_reserve%&           "SMTP from reserved hosts if load high"
12882 .row &%smtp_reserve_hosts%&          "these are the reserve hosts"
12883 .endtable
12884
12885
12886
12887 .section "Policy controls" "SECID106"
12888 .table2
12889 .row &%acl_not_smtp%&                "ACL for non-SMTP messages"
12890 .row &%acl_not_smtp_mime%&           "ACL for non-SMTP MIME parts"
12891 .row &%acl_not_smtp_start%&          "ACL for start of non-SMTP message"
12892 .row &%acl_smtp_auth%&               "ACL for AUTH"
12893 .row &%acl_smtp_connect%&            "ACL for connection"
12894 .row &%acl_smtp_data%&               "ACL for DATA"
12895 .row &%acl_smtp_dkim%&               "ACL for DKIM verification"
12896 .row &%acl_smtp_etrn%&               "ACL for ETRN"
12897 .row &%acl_smtp_expn%&               "ACL for EXPN"
12898 .row &%acl_smtp_helo%&               "ACL for EHLO or HELO"
12899 .row &%acl_smtp_mail%&               "ACL for MAIL"
12900 .row &%acl_smtp_mailauth%&           "ACL for AUTH on MAIL command"
12901 .row &%acl_smtp_mime%&               "ACL for MIME parts"
12902 .row &%acl_smtp_predata%&            "ACL for start of data"
12903 .row &%acl_smtp_quit%&               "ACL for QUIT"
12904 .row &%acl_smtp_rcpt%&               "ACL for RCPT"
12905 .row &%acl_smtp_starttls%&           "ACL for STARTTLS"
12906 .row &%acl_smtp_vrfy%&               "ACL for VRFY"
12907 .row &%av_scanner%&                  "specify virus scanner"
12908 .row &%check_rfc2047_length%&        "check length of RFC 2047 &""encoded &&&
12909                                       words""&"
12910 .row &%dns_csa_search_limit%&        "control CSA parent search depth"
12911 .row &%dns_csa_use_reverse%&         "en/disable CSA IP reverse search"
12912 .row &%header_maxsize%&              "total size of message header"
12913 .row &%header_line_maxsize%&         "individual header line limit"
12914 .row &%helo_accept_junk_hosts%&      "allow syntactic junk from these hosts"
12915 .row &%helo_allow_chars%&            "allow illegal chars in HELO names"
12916 .row &%helo_lookup_domains%&         "lookup hostname for these HELO names"
12917 .row &%helo_try_verify_hosts%&       "HELO soft-checked for these hosts"
12918 .row &%helo_verify_hosts%&           "HELO hard-checked for these hosts"
12919 .row &%host_lookup%&                 "host name looked up for these hosts"
12920 .row &%host_lookup_order%&           "order of DNS and local name lookups"
12921 .row &%host_reject_connection%&      "reject connection from these hosts"
12922 .row &%hosts_treat_as_local%&        "useful in some cluster configurations"
12923 .row &%local_scan_timeout%&          "timeout for &[local_scan()]&"
12924 .row &%message_size_limit%&          "for all messages"
12925 .row &%percent_hack_domains%&        "recognize %-hack for these domains"
12926 .row &%spamd_address%&               "set interface to SpamAssassin"
12927 .row &%strict_acl_vars%&             "object to unset ACL variables"
12928 .endtable
12929
12930
12931
12932 .section "Callout cache" "SECID107"
12933 .table2
12934 .row &%callout_domain_negative_expire%& "timeout for negative domain cache &&&
12935                                          item"
12936 .row &%callout_domain_positive_expire%& "timeout for positive domain cache &&&
12937                                          item"
12938 .row &%callout_negative_expire%&     "timeout for negative address cache item"
12939 .row &%callout_positive_expire%&     "timeout for positive address cache item"
12940 .row &%callout_random_local_part%&   "string to use for &""random""& testing"
12941 .endtable
12942
12943
12944
12945 .section "TLS" "SECID108"
12946 .table2
12947 .row &%gnutls_compat_mode%&          "use GnuTLS compatibility mode"
12948 .row &%gnutls_enable_pkcs11%&        "allow GnuTLS to autoload PKCS11 modules"
12949 .row &%openssl_options%&             "adjust OpenSSL compatibility options"
12950 .row &%tls_advertise_hosts%&         "advertise TLS to these hosts"
12951 .row &%tls_certificate%&             "location of server certificate"
12952 .row &%tls_crl%&                     "certificate revocation list"
12953 .row &%tls_dh_max_bits%&             "clamp D-H bit count suggestion"
12954 .row &%tls_dhparam%&                 "DH parameters for server"
12955 .row &%tls_on_connect_ports%&        "specify SSMTP (SMTPS) ports"
12956 .row &%tls_privatekey%&              "location of server private key"
12957 .row &%tls_remember_esmtp%&          "don't reset after starting TLS"
12958 .row &%tls_require_ciphers%&         "specify acceptable ciphers"
12959 .row &%tls_try_verify_hosts%&        "try to verify client certificate"
12960 .row &%tls_verify_certificates%&     "expected client certificates"
12961 .row &%tls_verify_hosts%&            "insist on client certificate verify"
12962 .endtable
12963
12964
12965
12966 .section "Local user handling" "SECID109"
12967 .table2
12968 .row &%finduser_retries%&            "useful in NIS environments"
12969 .row &%gecos_name%&                  "used when creating &'Sender:'&"
12970 .row &%gecos_pattern%&               "ditto"
12971 .row &%max_username_length%&         "for systems that truncate"
12972 .row &%unknown_login%&               "used when no login name found"
12973 .row &%unknown_username%&            "ditto"
12974 .row &%uucp_from_pattern%&           "for recognizing &""From ""& lines"
12975 .row &%uucp_from_sender%&            "ditto"
12976 .endtable
12977
12978
12979
12980 .section "All incoming messages (SMTP and non-SMTP)" "SECID110"
12981 .table2
12982 .row &%header_maxsize%&              "total size of message header"
12983 .row &%header_line_maxsize%&         "individual header line limit"
12984 .row &%message_size_limit%&          "applies to all messages"
12985 .row &%percent_hack_domains%&        "recognize %-hack for these domains"
12986 .row &%received_header_text%&        "expanded to make &'Received:'&"
12987 .row &%received_headers_max%&        "for mail loop detection"
12988 .row &%recipients_max%&              "limit per message"
12989 .row &%recipients_max_reject%&       "permanently reject excess recipients"
12990 .endtable
12991
12992
12993
12994
12995 .section "Non-SMTP incoming messages" "SECID111"
12996 .table2
12997 .row &%receive_timeout%&             "for non-SMTP messages"
12998 .endtable
12999
13000
13001
13002
13003
13004 .section "Incoming SMTP messages" "SECID112"
13005 See also the &'Policy controls'& section above.
13006
13007 .table2
13008 .row &%host_lookup%&                 "host name looked up for these hosts"
13009 .row &%host_lookup_order%&           "order of DNS and local name lookups"
13010 .row &%recipient_unqualified_hosts%& "may send unqualified recipients"
13011 .row &%rfc1413_hosts%&               "make ident calls to these hosts"
13012 .row &%rfc1413_query_timeout%&       "zero disables ident calls"
13013 .row &%sender_unqualified_hosts%&    "may send unqualified senders"
13014 .row &%smtp_accept_keepalive%&       "some TCP/IP magic"
13015 .row &%smtp_accept_max%&             "simultaneous incoming connections"
13016 .row &%smtp_accept_max_nonmail%&     "non-mail commands"
13017 .row &%smtp_accept_max_nonmail_hosts%& "hosts to which the limit applies"
13018 .row &%smtp_accept_max_per_connection%& "messages per connection"
13019 .row &%smtp_accept_max_per_host%&    "connections from one host"
13020 .row &%smtp_accept_queue%&           "queue mail if more connections"
13021 .row &%smtp_accept_queue_per_connection%& "queue if more messages per &&&
13022                                            connection"
13023 .row &%smtp_accept_reserve%&         "only reserve hosts if more connections"
13024 .row &%smtp_active_hostname%&        "host name to use in messages"
13025 .row &%smtp_banner%&                 "text for welcome banner"
13026 .row &%smtp_check_spool_space%&      "from SIZE on MAIL command"
13027 .row &%smtp_connect_backlog%&        "passed to TCP/IP stack"
13028 .row &%smtp_enforce_sync%&           "of SMTP command/responses"
13029 .row &%smtp_etrn_command%&           "what to run for ETRN"
13030 .row &%smtp_etrn_serialize%&         "only one at once"
13031 .row &%smtp_load_reserve%&           "only reserve hosts if this load"
13032 .row &%smtp_max_unknown_commands%&   "before dropping connection"
13033 .row &%smtp_ratelimit_hosts%&        "apply ratelimiting to these hosts"
13034 .row &%smtp_ratelimit_mail%&         "ratelimit for MAIL commands"
13035 .row &%smtp_ratelimit_rcpt%&         "ratelimit for RCPT commands"
13036 .row &%smtp_receive_timeout%&        "per command or data line"
13037 .row &%smtp_reserve_hosts%&          "these are the reserve hosts"
13038 .row &%smtp_return_error_details%&   "give detail on rejections"
13039 .endtable
13040
13041
13042
13043 .section "SMTP extensions" "SECID113"
13044 .table2
13045 .row &%accept_8bitmime%&             "advertise 8BITMIME"
13046 .row &%auth_advertise_hosts%&        "advertise AUTH to these hosts"
13047 .row &%ignore_fromline_hosts%&       "allow &""From ""& from these hosts"
13048 .row &%ignore_fromline_local%&       "allow &""From ""& from local SMTP"
13049 .row &%pipelining_advertise_hosts%&  "advertise pipelining to these hosts"
13050 .row &%tls_advertise_hosts%&         "advertise TLS to these hosts"
13051 .endtable
13052
13053
13054
13055 .section "Processing messages" "SECID114"
13056 .table2
13057 .row &%allow_domain_literals%&       "recognize domain literal syntax"
13058 .row &%allow_mx_to_ip%&              "allow MX to point to IP address"
13059 .row &%allow_utf8_domains%&          "in addresses"
13060 .row &%check_rfc2047_length%&        "check length of RFC 2047 &""encoded &&&
13061                                       words""&"
13062 .row &%delivery_date_remove%&        "from incoming messages"
13063 .row &%envelope_to_remove%&          "from incoming messages"
13064 .row &%extract_addresses_remove_arguments%& "affects &%-t%& processing"
13065 .row &%headers_charset%&             "default for translations"
13066 .row &%qualify_domain%&              "default for senders"
13067 .row &%qualify_recipient%&           "default for recipients"
13068 .row &%return_path_remove%&          "from incoming messages"
13069 .row &%strip_excess_angle_brackets%& "in addresses"
13070 .row &%strip_trailing_dot%&          "at end of addresses"
13071 .row &%untrusted_set_sender%&        "untrusted can set envelope sender"
13072 .endtable
13073
13074
13075
13076 .section "System filter" "SECID115"
13077 .table2
13078 .row &%system_filter%&               "locate system filter"
13079 .row &%system_filter_directory_transport%& "transport for delivery to a &&&
13080                                             directory"
13081 .row &%system_filter_file_transport%& "transport for delivery to a file"
13082 .row &%system_filter_group%&         "group for filter running"
13083 .row &%system_filter_pipe_transport%& "transport for delivery to a pipe"
13084 .row &%system_filter_reply_transport%& "transport for autoreply delivery"
13085 .row &%system_filter_user%&          "user for filter running"
13086 .endtable
13087
13088
13089
13090 .section "Routing and delivery" "SECID116"
13091 .table2
13092 .row &%disable_ipv6%&                "do no IPv6 processing"
13093 .row &%dns_again_means_nonexist%&    "for broken domains"
13094 .row &%dns_check_names_pattern%&     "pre-DNS syntax check"
13095 .row &%dns_ipv4_lookup%&             "only v4 lookup for these domains"
13096 .row &%dns_retrans%&                 "parameter for resolver"
13097 .row &%dns_retry%&                   "parameter for resolver"
13098 .row &%dns_use_dnssec%&              "parameter for resolver"
13099 .row &%dns_use_edns0%&               "parameter for resolver"
13100 .row &%hold_domains%&                "hold delivery for these domains"
13101 .row &%local_interfaces%&            "for routing checks"
13102 .row &%queue_domains%&               "no immediate delivery for these"
13103 .row &%queue_only%&                  "no immediate delivery at all"
13104 .row &%queue_only_file%&             "no immediate delivery if file exists"
13105 .row &%queue_only_load%&             "no immediate delivery if load is high"
13106 .row &%queue_only_load_latch%&       "don't re-evaluate load for each message"
13107 .row &%queue_only_override%&         "allow command line to override"
13108 .row &%queue_run_in_order%&          "order of arrival"
13109 .row &%queue_run_max%&               "of simultaneous queue runners"
13110 .row &%queue_smtp_domains%&          "no immediate SMTP delivery for these"
13111 .row &%remote_max_parallel%&         "parallel SMTP delivery per message"
13112 .row &%remote_sort_domains%&         "order of remote deliveries"
13113 .row &%retry_data_expire%&           "timeout for retry data"
13114 .row &%retry_interval_max%&          "safety net for retry rules"
13115 .endtable
13116
13117
13118
13119 .section "Bounce and warning messages" "SECID117"
13120 .table2
13121 .row &%bounce_message_file%&         "content of bounce"
13122 .row &%bounce_message_text%&         "content of bounce"
13123 .row &%bounce_return_body%&          "include body if returning message"
13124 .row &%bounce_return_message%&       "include original message in bounce"
13125 .row &%bounce_return_size_limit%&    "limit on returned message"
13126 .row &%bounce_sender_authentication%& "send authenticated sender with bounce"
13127 .row &%dsn_from%&                    "set &'From:'& contents in bounces"
13128 .row &%errors_copy%&                 "copy bounce messages"
13129 .row &%errors_reply_to%&             "&'Reply-to:'& in bounces"
13130 .row &%delay_warning%&               "time schedule"
13131 .row &%delay_warning_condition%&     "condition for warning messages"
13132 .row &%ignore_bounce_errors_after%&  "discard undeliverable bounces"
13133 .row &%smtp_return_error_details%&   "give detail on rejections"
13134 .row &%warn_message_file%&           "content of warning message"
13135 .endtable
13136
13137
13138
13139 .section "Alphabetical list of main options" "SECTalomo"
13140 Those options that undergo string expansion before use are marked with
13141 &dagger;.
13142
13143 .option accept_8bitmime main boolean true
13144 .cindex "8BITMIME"
13145 .cindex "8-bit characters"
13146 .cindex "log" "selectors"
13147 .cindex "log" "8BITMIME"
13148 This option causes Exim to send 8BITMIME in its response to an SMTP
13149 EHLO command, and to accept the BODY= parameter on MAIL commands.
13150 However, though Exim is 8-bit clean, it is not a protocol converter, and it
13151 takes no steps to do anything special with messages received by this route.
13152
13153 Historically Exim kept this option off by default, but the maintainers
13154 feel that in today's Internet, this causes more problems than it solves.
13155 It now defaults to true.
13156 A more detailed analysis of the issues is provided by Dan Bernstein:
13157 .display
13158 &url(http://cr.yp.to/smtp/8bitmime.html)
13159 .endd
13160
13161 To log received 8BITMIME status use
13162 .code
13163 log_selector = +8bitmime
13164 .endd
13165
13166 .option acl_not_smtp main string&!! unset
13167 .cindex "&ACL;" "for non-SMTP messages"
13168 .cindex "non-SMTP messages" "ACLs for"
13169 This option defines the ACL that is run when a non-SMTP message has been
13170 read and is on the point of being accepted. See chapter &<<CHAPACL>>& for
13171 further details.
13172
13173 .option acl_not_smtp_mime main string&!! unset
13174 This option defines the ACL that is run for individual MIME parts of non-SMTP
13175 messages. It operates in exactly the same way as &%acl_smtp_mime%& operates for
13176 SMTP messages.
13177
13178 .option acl_not_smtp_start main string&!! unset
13179 .cindex "&ACL;" "at start of non-SMTP message"
13180 .cindex "non-SMTP messages" "ACLs for"
13181 This option defines the ACL that is run before Exim starts reading a
13182 non-SMTP message. See chapter &<<CHAPACL>>& for further details.
13183
13184 .option acl_smtp_auth main string&!! unset
13185 .cindex "&ACL;" "setting up for SMTP commands"
13186 .cindex "AUTH" "ACL for"
13187 This option defines the ACL that is run when an SMTP AUTH command is
13188 received. See chapter &<<CHAPACL>>& for further details.
13189
13190 .option acl_smtp_connect main string&!! unset
13191 .cindex "&ACL;" "on SMTP connection"
13192 This option defines the ACL that is run when an SMTP connection is received.
13193 See chapter &<<CHAPACL>>& for further details.
13194
13195 .option acl_smtp_data main string&!! unset
13196 .cindex "DATA" "ACL for"
13197 This option defines the ACL that is run after an SMTP DATA command has been
13198 processed and the message itself has been received, but before the final
13199 acknowledgment is sent. See chapter &<<CHAPACL>>& for further details.
13200
13201 .option acl_smtp_etrn main string&!! unset
13202 .cindex "ETRN" "ACL for"
13203 This option defines the ACL that is run when an SMTP ETRN command is
13204 received. See chapter &<<CHAPACL>>& for further details.
13205
13206 .option acl_smtp_expn main string&!! unset
13207 .cindex "EXPN" "ACL for"
13208 This option defines the ACL that is run when an SMTP EXPN command is
13209 received. See chapter &<<CHAPACL>>& for further details.
13210
13211 .option acl_smtp_helo main string&!! unset
13212 .cindex "EHLO" "ACL for"
13213 .cindex "HELO" "ACL for"
13214 This option defines the ACL that is run when an SMTP EHLO or HELO
13215 command is received. See chapter &<<CHAPACL>>& for further details.
13216
13217
13218 .option acl_smtp_mail main string&!! unset
13219 .cindex "MAIL" "ACL for"
13220 This option defines the ACL that is run when an SMTP MAIL command is
13221 received. See chapter &<<CHAPACL>>& for further details.
13222
13223 .option acl_smtp_mailauth main string&!! unset
13224 .cindex "AUTH" "on MAIL command"
13225 This option defines the ACL that is run when there is an AUTH parameter on
13226 a MAIL command. See chapter &<<CHAPACL>>& for details of ACLs, and chapter
13227 &<<CHAPSMTPAUTH>>& for details of authentication.
13228
13229 .option acl_smtp_mime main string&!! unset
13230 .cindex "MIME content scanning" "ACL for"
13231 This option is available when Exim is built with the content-scanning
13232 extension. It defines the ACL that is run for each MIME part in a message. See
13233 section &<<SECTscanmimepart>>& for details.
13234
13235 .option acl_smtp_predata main string&!! unset
13236 This option defines the ACL that is run when an SMTP DATA command is
13237 received, before the message itself is received. See chapter &<<CHAPACL>>& for
13238 further details.
13239
13240 .option acl_smtp_quit main string&!! unset
13241 .cindex "QUIT, ACL for"
13242 This option defines the ACL that is run when an SMTP QUIT command is
13243 received. See chapter &<<CHAPACL>>& for further details.
13244
13245 .option acl_smtp_rcpt main string&!! unset
13246 .cindex "RCPT" "ACL for"
13247 This option defines the ACL that is run when an SMTP RCPT command is
13248 received. See chapter &<<CHAPACL>>& for further details.
13249
13250 .option acl_smtp_starttls main string&!! unset
13251 .cindex "STARTTLS, ACL for"
13252 This option defines the ACL that is run when an SMTP STARTTLS command is
13253 received. See chapter &<<CHAPACL>>& for further details.
13254
13255 .option acl_smtp_vrfy main string&!! unset
13256 .cindex "VRFY" "ACL for"
13257 This option defines the ACL that is run when an SMTP VRFY command is
13258 received. See chapter &<<CHAPACL>>& for further details.
13259
13260 .option admin_groups main "string list&!!" unset
13261 .cindex "admin user"
13262 This option is expanded just once, at the start of Exim's processing. If the
13263 current group or any of the supplementary groups of an Exim caller is in this
13264 colon-separated list, the caller has admin privileges. If all your system
13265 programmers are in a specific group, for example, you can give them all Exim
13266 admin privileges by putting that group in &%admin_groups%&. However, this does
13267 not permit them to read Exim's spool files (whose group owner is the Exim gid).
13268 To permit this, you have to add individuals to the Exim group.
13269
13270 .option allow_domain_literals main boolean false
13271 .cindex "domain literal"
13272 If this option is set, the RFC 2822 domain literal format is permitted in
13273 email addresses. The option is not set by default, because the domain literal
13274 format is not normally required these days, and few people know about it. It
13275 has, however, been exploited by mail abusers.
13276
13277 Unfortunately, it seems that some DNS black list maintainers are using this
13278 format to report black listing to postmasters. If you want to accept messages
13279 addressed to your hosts by IP address, you need to set
13280 &%allow_domain_literals%& true, and also to add &`@[]`& to the list of local
13281 domains (defined in the named domain list &%local_domains%& in the default
13282 configuration). This &"magic string"& matches the domain literal form of all
13283 the local host's IP addresses.
13284
13285
13286 .option allow_mx_to_ip main boolean false
13287 .cindex "MX record" "pointing to IP address"
13288 It appears that more and more DNS zone administrators are breaking the rules
13289 and putting domain names that look like IP addresses on the right hand side of
13290 MX records. Exim follows the rules and rejects this, giving an error message
13291 that explains the mis-configuration. However, some other MTAs support this
13292 practice, so to avoid &"Why can't Exim do this?"& complaints,
13293 &%allow_mx_to_ip%& exists, in order to enable this heinous activity. It is not
13294 recommended, except when you have no other choice.
13295
13296 .option allow_utf8_domains main boolean false
13297 .cindex "domain" "UTF-8 characters in"
13298 .cindex "UTF-8" "in domain name"
13299 Lots of discussion is going on about internationalized domain names. One
13300 camp is strongly in favour of just using UTF-8 characters, and it seems
13301 that at least two other MTAs permit this. This option allows Exim users to
13302 experiment if they wish.
13303
13304 If it is set true, Exim's domain parsing function allows valid
13305 UTF-8 multicharacters to appear in domain name components, in addition to
13306 letters, digits, and hyphens. However, just setting this option is not
13307 enough; if you want to look up these domain names in the DNS, you must also
13308 adjust the value of &%dns_check_names_pattern%& to match the extended form. A
13309 suitable setting is:
13310 .code
13311 dns_check_names_pattern = (?i)^(?>(?(1)\.|())[a-z0-9\xc0-\xff]\
13312   (?>[-a-z0-9\x80-\xff]*[a-z0-9\x80-\xbf])?)+$
13313 .endd
13314 Alternatively, you can just disable this feature by setting
13315 .code
13316 dns_check_names_pattern =
13317 .endd
13318 That is, set the option to an empty string so that no check is done.
13319
13320
13321 .option auth_advertise_hosts main "host list&!!" *
13322 .cindex "authentication" "advertising"
13323 .cindex "AUTH" "advertising"
13324 If any server authentication mechanisms are configured, Exim advertises them in
13325 response to an EHLO command only if the calling host matches this list.
13326 Otherwise, Exim does not advertise AUTH.
13327 Exim does not accept AUTH commands from clients to which it has not
13328 advertised the availability of AUTH. The advertising of individual
13329 authentication mechanisms can be controlled by the use of the
13330 &%server_advertise_condition%& generic authenticator option on the individual
13331 authenticators. See chapter &<<CHAPSMTPAUTH>>& for further details.
13332
13333 Certain mail clients (for example, Netscape) require the user to provide a name
13334 and password for authentication if AUTH is advertised, even though it may
13335 not be needed (the host may accept messages from hosts on its local LAN without
13336 authentication, for example). The &%auth_advertise_hosts%& option can be used
13337 to make these clients more friendly by excluding them from the set of hosts to
13338 which Exim advertises AUTH.
13339
13340 .cindex "AUTH" "advertising when encrypted"
13341 If you want to advertise the availability of AUTH only when the connection
13342 is encrypted using TLS, you can make use of the fact that the value of this
13343 option is expanded, with a setting like this:
13344 .code
13345 auth_advertise_hosts = ${if eq{$tls_in_cipher}{}{}{*}}
13346 .endd
13347 .vindex "&$tls_in_cipher$&"
13348 If &$tls_in_cipher$& is empty, the session is not encrypted, and the result of
13349 the expansion is empty, thus matching no hosts. Otherwise, the result of the
13350 expansion is *, which matches all hosts.
13351
13352
13353 .option auto_thaw main time 0s
13354 .cindex "thawing messages"
13355 .cindex "unfreezing messages"
13356 If this option is set to a time greater than zero, a queue runner will try a
13357 new delivery attempt on any frozen message, other than a bounce message, if
13358 this much time has passed since it was frozen. This may result in the message
13359 being re-frozen if nothing has changed since the last attempt. It is a way of
13360 saying &"keep on trying, even though there are big problems"&.
13361
13362 &*Note*&: This is an old option, which predates &%timeout_frozen_after%& and
13363 &%ignore_bounce_errors_after%&. It is retained for compatibility, but it is not
13364 thought to be very useful any more, and its use should probably be avoided.
13365
13366
13367 .option av_scanner main string "see below"
13368 This option is available if Exim is built with the content-scanning extension.
13369 It specifies which anti-virus scanner to use. The default value is:
13370 .code
13371 sophie:/var/run/sophie
13372 .endd
13373 If the value of &%av_scanner%& starts with a dollar character, it is expanded
13374 before use. See section &<<SECTscanvirus>>& for further details.
13375
13376
13377 .option bi_command main string unset
13378 .oindex "&%-bi%&"
13379 This option supplies the name of a command that is run when Exim is called with
13380 the &%-bi%& option (see chapter &<<CHAPcommandline>>&). The string value is
13381 just the command name, it is not a complete command line. If an argument is
13382 required, it must come from the &%-oA%& command line option.
13383
13384
13385 .option bounce_message_file main string unset
13386 .cindex "bounce message" "customizing"
13387 .cindex "customizing" "bounce message"
13388 This option defines a template file containing paragraphs of text to be used
13389 for constructing bounce messages.  Details of the file's contents are given in
13390 chapter &<<CHAPemsgcust>>&. See also &%warn_message_file%&.
13391
13392
13393 .option bounce_message_text main string unset
13394 When this option is set, its contents are included in the default bounce
13395 message immediately after &"This message was created automatically by mail
13396 delivery software."& It is not used if &%bounce_message_file%& is set.
13397
13398 .option bounce_return_body main boolean true
13399 .cindex "bounce message" "including body"
13400 This option controls whether the body of an incoming message is included in a
13401 bounce message when &%bounce_return_message%& is true. The default setting
13402 causes the entire message, both header and body, to be returned (subject to the
13403 value of &%bounce_return_size_limit%&). If this option is false, only the
13404 message header is included. In the case of a non-SMTP message containing an
13405 error that is detected during reception, only those header lines preceding the
13406 point at which the error was detected are returned.
13407 .cindex "bounce message" "including original"
13408
13409 .option bounce_return_message main boolean true
13410 If this option is set false, none of the original message is included in
13411 bounce messages generated by Exim. See also &%bounce_return_size_limit%& and
13412 &%bounce_return_body%&.
13413
13414
13415 .option bounce_return_size_limit main integer 100K
13416 .cindex "size" "of bounce, limit"
13417 .cindex "bounce message" "size limit"
13418 .cindex "limit" "bounce message size"
13419 This option sets a limit in bytes on the size of messages that are returned to
13420 senders as part of bounce messages when &%bounce_return_message%& is true. The
13421 limit should be less than the value of the global &%message_size_limit%& and of
13422 any &%message_size_limit%& settings on transports, to allow for the bounce text
13423 that Exim generates. If this option is set to zero there is no limit.
13424
13425 When the body of any message that is to be included in a bounce message is
13426 greater than the limit, it is truncated, and a comment pointing this out is
13427 added at the top. The actual cutoff may be greater than the value given, owing
13428 to the use of buffering for transferring the message in chunks (typically 8K in
13429 size). The idea is to save bandwidth on those undeliverable 15-megabyte
13430 messages.
13431
13432 .option bounce_sender_authentication main string unset
13433 .cindex "bounce message" "sender authentication"
13434 .cindex "authentication" "bounce message"
13435 .cindex "AUTH" "on bounce message"
13436 This option provides an authenticated sender address that is sent with any
13437 bounce messages generated by Exim that are sent over an authenticated SMTP
13438 connection. A typical setting might be:
13439 .code
13440 bounce_sender_authentication = mailer-daemon@my.domain.example
13441 .endd
13442 which would cause bounce messages to be sent using the SMTP command:
13443 .code
13444 MAIL FROM:<> AUTH=mailer-daemon@my.domain.example
13445 .endd
13446 The value of &%bounce_sender_authentication%& must always be a complete email
13447 address.
13448
13449 .option callout_domain_negative_expire main time 3h
13450 .cindex "caching" "callout timeouts"
13451 .cindex "callout" "caching timeouts"
13452 This option specifies the expiry time for negative callout cache data for a
13453 domain. See section &<<SECTcallver>>& for details of callout verification, and
13454 section &<<SECTcallvercache>>& for details of the caching.
13455
13456
13457 .option callout_domain_positive_expire main time 7d
13458 This option specifies the expiry time for positive callout cache data for a
13459 domain. See section &<<SECTcallver>>& for details of callout verification, and
13460 section &<<SECTcallvercache>>& for details of the caching.
13461
13462
13463 .option callout_negative_expire main time 2h
13464 This option specifies the expiry time for negative callout cache data for an
13465 address. See section &<<SECTcallver>>& for details of callout verification, and
13466 section &<<SECTcallvercache>>& for details of the caching.
13467
13468
13469 .option callout_positive_expire main time 24h
13470 This option specifies the expiry time for positive callout cache data for an
13471 address. See section &<<SECTcallver>>& for details of callout verification, and
13472 section &<<SECTcallvercache>>& for details of the caching.
13473
13474
13475 .option callout_random_local_part main string&!! "see below"
13476 This option defines the &"random"& local part that can be used as part of
13477 callout verification. The default value is
13478 .code
13479 $primary_hostname-$tod_epoch-testing
13480 .endd
13481 See section &<<CALLaddparcall>>& for details of how this value is used.
13482
13483
13484 .option check_log_inodes main integer 0
13485 See &%check_spool_space%& below.
13486
13487
13488 .option check_log_space main integer 0
13489 See &%check_spool_space%& below.
13490
13491 .oindex "&%check_rfc2047_length%&"
13492 .cindex "RFC 2047" "disabling length check"
13493 .option check_rfc2047_length main boolean true
13494 RFC 2047 defines a way of encoding non-ASCII characters in headers using a
13495 system of &"encoded words"&. The RFC specifies a maximum length for an encoded
13496 word; strings to be encoded that exceed this length are supposed to use
13497 multiple encoded words. By default, Exim does not recognize encoded words that
13498 exceed the maximum length. However, it seems that some software, in violation
13499 of the RFC, generates overlong encoded words. If &%check_rfc2047_length%& is
13500 set false, Exim recognizes encoded words of any length.
13501
13502
13503 .option check_spool_inodes main integer 0
13504 See &%check_spool_space%& below.
13505
13506
13507 .option check_spool_space main integer 0
13508 .cindex "checking disk space"
13509 .cindex "disk space, checking"
13510 .cindex "spool directory" "checking space"
13511 The four &%check_...%& options allow for checking of disk resources before a
13512 message is accepted.
13513
13514 .vindex "&$log_inodes$&"
13515 .vindex "&$log_space$&"
13516 .vindex "&$spool_inodes$&"
13517 .vindex "&$spool_space$&"
13518 When any of these options are set, they apply to all incoming messages. If you
13519 want to apply different checks to different kinds of message, you can do so by
13520 testing the variables &$log_inodes$&, &$log_space$&, &$spool_inodes$&, and
13521 &$spool_space$& in an ACL with appropriate additional conditions.
13522
13523
13524 &%check_spool_space%& and &%check_spool_inodes%& check the spool partition if
13525 either value is greater than zero, for example:
13526 .code
13527 check_spool_space = 10M
13528 check_spool_inodes = 100
13529 .endd
13530 The spool partition is the one that contains the directory defined by
13531 SPOOL_DIRECTORY in &_Local/Makefile_&. It is used for holding messages in
13532 transit.
13533
13534 &%check_log_space%& and &%check_log_inodes%&  check the partition in which log
13535 files are written if either is greater than zero. These should be set only if
13536 &%log_file_path%& and &%spool_directory%& refer to different partitions.
13537
13538 If there is less space or fewer inodes than requested, Exim refuses to accept
13539 incoming mail. In the case of SMTP input this is done by giving a 452 temporary
13540 error response to the MAIL command. If ESMTP is in use and there was a
13541 SIZE parameter on the MAIL command, its value is added to the
13542 &%check_spool_space%& value, and the check is performed even if
13543 &%check_spool_space%& is zero, unless &%no_smtp_check_spool_space%& is set.
13544
13545 The values for &%check_spool_space%& and &%check_log_space%& are held as a
13546 number of kilobytes. If a non-multiple of 1024 is specified, it is rounded up.
13547
13548 For non-SMTP input and for batched SMTP input, the test is done at start-up; on
13549 failure a message is written to stderr and Exim exits with a non-zero code, as
13550 it obviously cannot send an error message of any kind.
13551
13552 .option daemon_smtp_ports main string &`smtp`&
13553 .cindex "port" "for daemon"
13554 .cindex "TCP/IP" "setting listening ports"
13555 This option specifies one or more default SMTP ports on which the Exim daemon
13556 listens. See chapter &<<CHAPinterfaces>>& for details of how it is used. For
13557 backward compatibility, &%daemon_smtp_port%& (singular) is a synonym.
13558
13559 .option daemon_startup_retries main integer 9
13560 .cindex "daemon startup, retrying"
13561 This option, along with &%daemon_startup_sleep%&, controls the retrying done by
13562 the daemon at startup when it cannot immediately bind a listening socket
13563 (typically because the socket is already in use): &%daemon_startup_retries%&
13564 defines the number of retries after the first failure, and
13565 &%daemon_startup_sleep%& defines the length of time to wait between retries.
13566
13567 .option daemon_startup_sleep main time 30s
13568 See &%daemon_startup_retries%&.
13569
13570 .option delay_warning main "time list" 24h
13571 .cindex "warning of delay"
13572 .cindex "delay warning, specifying"
13573 When a message is delayed, Exim sends a warning message to the sender at
13574 intervals specified by this option. The data is a colon-separated list of times
13575 after which to send warning messages. If the value of the option is an empty
13576 string or a zero time, no warnings are sent. Up to 10 times may be given. If a
13577 message has been on the queue for longer than the last time, the last interval
13578 between the times is used to compute subsequent warning times. For example,
13579 with
13580 .code
13581 delay_warning = 4h:8h:24h
13582 .endd
13583 the first message is sent after 4 hours, the second after 8 hours, and
13584 the third one after 24 hours. After that, messages are sent every 16 hours,
13585 because that is the interval between the last two times on the list. If you set
13586 just one time, it specifies the repeat interval. For example, with:
13587 .code
13588 delay_warning = 6h
13589 .endd
13590 messages are repeated every six hours. To stop warnings after a given time, set
13591 a very large time at the end of the list. For example:
13592 .code
13593 delay_warning = 2h:12h:99d
13594 .endd
13595
13596 .option delay_warning_condition main string&!! "see below"
13597 .vindex "&$domain$&"
13598 The string is expanded at the time a warning message might be sent. If all the
13599 deferred addresses have the same domain, it is set in &$domain$& during the
13600 expansion. Otherwise &$domain$& is empty. If the result of the expansion is a
13601 forced failure, an empty string, or a string matching any of &"0"&, &"no"& or
13602 &"false"& (the comparison being done caselessly) then the warning message is
13603 not sent. The default is:
13604 .code
13605 delay_warning_condition = ${if or {\
13606   { !eq{$h_list-id:$h_list-post:$h_list-subscribe:}{} }\
13607   { match{$h_precedence:}{(?i)bulk|list|junk} }\
13608   { match{$h_auto-submitted:}{(?i)auto-generated|auto-replied} }\
13609   } {no}{yes}}
13610 .endd
13611 This suppresses the sending of warnings for messages that contain &'List-ID:'&,
13612 &'List-Post:'&, or &'List-Subscribe:'& headers, or have &"bulk"&, &"list"& or
13613 &"junk"& in a &'Precedence:'& header, or have &"auto-generated"& or
13614 &"auto-replied"& in an &'Auto-Submitted:'& header.
13615
13616 .option deliver_drop_privilege main boolean false
13617 .cindex "unprivileged delivery"
13618 .cindex "delivery" "unprivileged"
13619 If this option is set true, Exim drops its root privilege at the start of a
13620 delivery process, and runs as the Exim user throughout. This severely restricts
13621 the kinds of local delivery that are possible, but is viable in certain types
13622 of configuration. There is a discussion about the use of root privilege in
13623 chapter &<<CHAPsecurity>>&.
13624
13625 .option deliver_queue_load_max main fixed-point unset
13626 .cindex "load average"
13627 .cindex "queue runner" "abandoning"
13628 When this option is set, a queue run is abandoned if the system load average
13629 becomes greater than the value of the option. The option has no effect on
13630 ancient operating systems on which Exim cannot determine the load average.
13631 See also &%queue_only_load%& and &%smtp_load_reserve%&.
13632
13633
13634 .option delivery_date_remove main boolean true
13635 .cindex "&'Delivery-date:'& header line"
13636 Exim's transports have an option for adding a &'Delivery-date:'& header to a
13637 message when it is delivered, in exactly the same way as &'Return-path:'& is
13638 handled. &'Delivery-date:'& records the actual time of delivery. Such headers
13639 should not be present in incoming messages, and this option causes them to be
13640 removed at the time the message is received, to avoid any problems that might
13641 occur when a delivered message is subsequently sent on to some other recipient.
13642
13643 .option disable_fsync main boolean false
13644 .cindex "&[fsync()]&, disabling"
13645 This option is available only if Exim was built with the compile-time option
13646 ENABLE_DISABLE_FSYNC. When this is not set, a reference to &%disable_fsync%& in
13647 a runtime configuration generates an &"unknown option"& error. You should not
13648 build Exim with ENABLE_DISABLE_FSYNC or set &%disable_fsync%& unless you
13649 really, really, really understand what you are doing. &'No pre-compiled
13650 distributions of Exim should ever make this option available.'&
13651
13652 When &%disable_fsync%& is set true, Exim no longer calls &[fsync()]& to force
13653 updated files' data to be written to disc before continuing. Unexpected events
13654 such as crashes and power outages may cause data to be lost or scrambled.
13655 Here be Dragons. &*Beware.*&
13656
13657
13658 .option disable_ipv6 main boolean false
13659 .cindex "IPv6" "disabling"
13660 If this option is set true, even if the Exim binary has IPv6 support, no IPv6
13661 activities take place. AAAA records are never looked up, and any IPv6 addresses
13662 that are listed in &%local_interfaces%&, data for the &%manualroute%& router,
13663 etc. are ignored. If IP literals are enabled, the &(ipliteral)& router declines
13664 to handle IPv6 literal addresses.
13665
13666
13667 .option dns_again_means_nonexist main "domain list&!!" unset
13668 .cindex "DNS" "&""try again""& response; overriding"
13669 DNS lookups give a &"try again"& response for the DNS errors
13670 &"non-authoritative host not found"& and &"SERVERFAIL"&. This can cause Exim to
13671 keep trying to deliver a message, or to give repeated temporary errors to
13672 incoming mail. Sometimes the effect is caused by a badly set up name server and
13673 may persist for a long time. If a domain which exhibits this problem matches
13674 anything in &%dns_again_means_nonexist%&, it is treated as if it did not exist.
13675 This option should be used with care. You can make it apply to reverse lookups
13676 by a setting such as this:
13677 .code
13678 dns_again_means_nonexist = *.in-addr.arpa
13679 .endd
13680 This option applies to all DNS lookups that Exim does. It also applies when the
13681 &[gethostbyname()]& or &[getipnodebyname()]& functions give temporary errors,
13682 since these are most likely to be caused by DNS lookup problems. The
13683 &(dnslookup)& router has some options of its own for controlling what happens
13684 when lookups for MX or SRV records give temporary errors. These more specific
13685 options are applied after this global option.
13686
13687 .option dns_check_names_pattern main string "see below"
13688 .cindex "DNS" "pre-check of name syntax"
13689 When this option is set to a non-empty string, it causes Exim to check domain
13690 names for characters that are not allowed in host names before handing them to
13691 the DNS resolver, because some resolvers give temporary errors for names that
13692 contain unusual characters. If a domain name contains any unwanted characters,
13693 a &"not found"& result is forced, and the resolver is not called. The check is
13694 done by matching the domain name against a regular expression, which is the
13695 value of this option. The default pattern is
13696 .code
13697 dns_check_names_pattern = \
13698   (?i)^(?>(?(1)\.|())[^\W_](?>[a-z0-9/-]*[^\W_])?)+$
13699 .endd
13700 which permits only letters, digits, slashes, and hyphens in components, but
13701 they must start and end with a letter or digit. Slashes are not, in fact,
13702 permitted in host names, but they are found in certain NS records (which can be
13703 accessed in Exim by using a &%dnsdb%& lookup). If you set
13704 &%allow_utf8_domains%&, you must modify this pattern, or set the option to an
13705 empty string.
13706
13707 .option dns_csa_search_limit main integer 5
13708 This option controls the depth of parental searching for CSA SRV records in the
13709 DNS, as described in more detail in section &<<SECTverifyCSA>>&.
13710
13711 .option dns_csa_use_reverse main boolean true
13712 This option controls whether or not an IP address, given as a CSA domain, is
13713 reversed and looked up in the reverse DNS, as described in more detail in
13714 section &<<SECTverifyCSA>>&.
13715
13716 .option dns_ipv4_lookup main "domain list&!!" unset
13717 .cindex "IPv6" "DNS lookup for AAAA records"
13718 .cindex "DNS" "IPv6 lookup for AAAA records"
13719 When Exim is compiled with IPv6 support and &%disable_ipv6%& is not set, it
13720 looks for IPv6 address records (AAAA records) as well as IPv4 address records
13721 (A records) when trying to find IP addresses for hosts, unless the host's
13722 domain matches this list.
13723
13724 This is a fudge to help with name servers that give big delays or otherwise do
13725 not work for the AAAA record type. In due course, when the world's name
13726 servers have all been upgraded, there should be no need for this option.
13727
13728
13729 .option dns_retrans main time 0s
13730 .cindex "DNS" "resolver options"
13731 The options &%dns_retrans%& and &%dns_retry%& can be used to set the
13732 retransmission and retry parameters for DNS lookups. Values of zero (the
13733 defaults) leave the system default settings unchanged. The first value is the
13734 time between retries, and the second is the number of retries. It isn't
13735 totally clear exactly how these settings affect the total time a DNS lookup may
13736 take. I haven't found any documentation about timeouts on DNS lookups; these
13737 parameter values are available in the external resolver interface structure,
13738 but nowhere does it seem to describe how they are used or what you might want
13739 to set in them.
13740
13741
13742 .option dns_retry main integer 0
13743 See &%dns_retrans%& above.
13744
13745
13746 .new
13747 .option dns_use_dnssec main integer -1
13748 .cindex "DNS" "resolver options"
13749 .cindex "DNS" "DNSSEC"
13750 If this option is set to a non-negative number then Exim will initialise the
13751 DNS resolver library to either use or not use DNSSEC, overriding the system
13752 default. A value of 0 coerces DNSSEC off, a value of 1 coerces DNSSEC on.
13753
13754 If the resolver library does not support DNSSEC then this option has no effect.
13755 .wen
13756
13757
13758 .option dns_use_edns0 main integer -1
13759 .cindex "DNS" "resolver options"
13760 .cindex "DNS" "EDNS0"
13761 If this option is set to a non-negative number then Exim will initialise the
13762 DNS resolver library to either use or not use EDNS0 extensions, overriding
13763 the system default. A value of 0 coerces EDNS0 off, a value of 1 coerces EDNS0
13764 on.
13765
13766 If the resolver library does not support EDNS0 then this option has no effect.
13767
13768
13769 .option drop_cr main boolean false
13770 This is an obsolete option that is now a no-op. It used to affect the way Exim
13771 handled CR and LF characters in incoming messages. What happens now is
13772 described in section &<<SECTlineendings>>&.
13773
13774 .option dsn_from main "string&!!" "see below"
13775 .cindex "&'From:'& header line" "in bounces"
13776 .cindex "bounce messages" "&'From:'& line, specifying"
13777 This option can be used to vary the contents of &'From:'& header lines in
13778 bounces and other automatically generated messages (&"Delivery Status
13779 Notifications"& &-- hence the name of the option). The default setting is:
13780 .code
13781 dsn_from = Mail Delivery System <Mailer-Daemon@$qualify_domain>
13782 .endd
13783 The value is expanded every time it is needed. If the expansion fails, a
13784 panic is logged, and the default value is used.
13785
13786 .option envelope_to_remove main boolean true
13787 .cindex "&'Envelope-to:'& header line"
13788 Exim's transports have an option for adding an &'Envelope-to:'& header to a
13789 message when it is delivered, in exactly the same way as &'Return-path:'& is
13790 handled. &'Envelope-to:'& records the original recipient address from the
13791 messages's envelope that caused the delivery to happen. Such headers should not
13792 be present in incoming messages, and this option causes them to be removed at
13793 the time the message is received, to avoid any problems that might occur when a
13794 delivered message is subsequently sent on to some other recipient.
13795
13796
13797 .option errors_copy main "string list&!!" unset
13798 .cindex "bounce message" "copy to other address"
13799 .cindex "copy of bounce message"
13800 Setting this option causes Exim to send bcc copies of bounce messages that it
13801 generates to other addresses. &*Note*&: This does not apply to bounce messages
13802 coming from elsewhere. The value of the option is a colon-separated list of
13803 items. Each item consists of a pattern, terminated by white space, followed by
13804 a comma-separated list of email addresses. If a pattern contains spaces, it
13805 must be enclosed in double quotes.
13806
13807 Each pattern is processed in the same way as a single item in an address list
13808 (see section &<<SECTaddresslist>>&). When a pattern matches the recipient of
13809 the bounce message, the message is copied to the addresses on the list. The
13810 items are scanned in order, and once a matching one is found, no further items
13811 are examined. For example:
13812 .code
13813 errors_copy = spqr@mydomain   postmaster@mydomain.example :\
13814               rqps@mydomain   hostmaster@mydomain.example,\
13815                               postmaster@mydomain.example
13816 .endd
13817 .vindex "&$domain$&"
13818 .vindex "&$local_part$&"
13819 The address list is expanded before use. The expansion variables &$local_part$&
13820 and &$domain$& are set from the original recipient of the error message, and if
13821 there was any wildcard matching in the pattern, the expansion
13822 .cindex "numerical variables (&$1$& &$2$& etc)" "in &%errors_copy%&"
13823 variables &$0$&, &$1$&, etc. are set in the normal way.
13824
13825
13826 .option errors_reply_to main string unset
13827 .cindex "bounce message" "&'Reply-to:'& in"
13828 By default, Exim's bounce and delivery warning messages contain the header line
13829 .display
13830 &`From: Mail Delivery System <Mailer-Daemon@`&&'qualify-domain'&&`>`&
13831 .endd
13832 .oindex &%quota_warn_message%&
13833 where &'qualify-domain'& is the value of the &%qualify_domain%& option.
13834 A warning message that is generated by the &%quota_warn_message%& option in an
13835 &(appendfile)& transport may contain its own &'From:'& header line that
13836 overrides the default.
13837
13838 Experience shows that people reply to bounce messages. If the
13839 &%errors_reply_to%& option is set, a &'Reply-To:'& header is added to bounce
13840 and warning messages. For example:
13841 .code
13842 errors_reply_to = postmaster@my.domain.example
13843 .endd
13844 The value of the option is not expanded. It must specify a valid RFC 2822
13845 address. However, if a warning message that is generated by the
13846 &%quota_warn_message%& option in an &(appendfile)& transport contain its
13847 own &'Reply-To:'& header line, the value of the &%errors_reply_to%& option is
13848 not used.
13849
13850
13851 .option exim_group main string "compile-time configured"
13852 .cindex "gid (group id)" "Exim's own"
13853 .cindex "Exim group"
13854 This option changes the gid under which Exim runs when it gives up root
13855 privilege. The default value is compiled into the binary. The value of this
13856 option is used only when &%exim_user%& is also set. Unless it consists entirely
13857 of digits, the string is looked up using &[getgrnam()]&, and failure causes a
13858 configuration error. See chapter &<<CHAPsecurity>>& for a discussion of
13859 security issues.
13860
13861
13862 .option exim_path main string "see below"
13863 .cindex "Exim binary, path name"
13864 This option specifies the path name of the Exim binary, which is used when Exim
13865 needs to re-exec itself. The default is set up to point to the file &'exim'& in
13866 the directory configured at compile time by the BIN_DIRECTORY setting. It
13867 is necessary to change &%exim_path%& if, exceptionally, Exim is run from some
13868 other place.
13869 &*Warning*&: Do not use a macro to define the value of this option, because
13870 you will break those Exim utilities that scan the configuration file to find
13871 where the binary is. (They then use the &%-bP%& option to extract option
13872 settings such as the value of &%spool_directory%&.)
13873
13874
13875 .option exim_user main string "compile-time configured"
13876 .cindex "uid (user id)" "Exim's own"
13877 .cindex "Exim user"
13878 This option changes the uid under which Exim runs when it gives up root
13879 privilege. The default value is compiled into the binary. Ownership of the run
13880 time configuration file and the use of the &%-C%& and &%-D%& command line
13881 options is checked against the values in the binary, not what is set here.
13882
13883 Unless it consists entirely of digits, the string is looked up using
13884 &[getpwnam()]&, and failure causes a configuration error. If &%exim_group%& is
13885 not also supplied, the gid is taken from the result of &[getpwnam()]& if it is
13886 used. See chapter &<<CHAPsecurity>>& for a discussion of security issues.
13887
13888
13889 .option extra_local_interfaces main "string list" unset
13890 This option defines network interfaces that are to be considered local when
13891 routing, but which are not used for listening by the daemon. See section
13892 &<<SECTreclocipadd>>& for details.
13893
13894
13895 . Allow this long option name to split; give it unsplit as a fifth argument
13896 . for the automatic .oindex that is generated by .option.
13897
13898 .option "extract_addresses_remove_ &~&~arguments" main boolean true &&&
13899          extract_addresses_remove_arguments
13900 .oindex "&%-t%&"
13901 .cindex "command line" "addresses with &%-t%&"
13902 .cindex "Sendmail compatibility" "&%-t%& option"
13903 According to some Sendmail documentation (Sun, IRIX, HP-UX), if any addresses
13904 are present on the command line when the &%-t%& option is used to build an
13905 envelope from a message's &'To:'&, &'Cc:'& and &'Bcc:'& headers, the command
13906 line addresses are removed from the recipients list. This is also how Smail
13907 behaves. However, other Sendmail documentation (the O'Reilly book) states that
13908 command line addresses are added to those obtained from the header lines. When
13909 &%extract_addresses_remove_arguments%& is true (the default), Exim subtracts
13910 argument headers. If it is set false, Exim adds rather than removes argument
13911 addresses.
13912
13913
13914 .option finduser_retries main integer 0
13915 .cindex "NIS, retrying user lookups"
13916 On systems running NIS or other schemes in which user and group information is
13917 distributed from a remote system, there can be times when &[getpwnam()]& and
13918 related functions fail, even when given valid data, because things time out.
13919 Unfortunately these failures cannot be distinguished from genuine &"not found"&
13920 errors. If &%finduser_retries%& is set greater than zero, Exim will try that
13921 many extra times to find a user or a group, waiting for one second between
13922 retries.
13923
13924 .cindex "&_/etc/passwd_&" "multiple reading of"
13925 You should not set this option greater than zero if your user information is in
13926 a traditional &_/etc/passwd_& file, because it will cause Exim needlessly to
13927 search the file multiple times for non-existent users, and also cause delay.
13928
13929
13930
13931 .option freeze_tell main "string list, comma separated" unset
13932 .cindex "freezing messages" "sending a message when freezing"
13933 On encountering certain errors, or when configured to do so in a system filter,
13934 ACL, or special router, Exim freezes a message. This means that no further
13935 delivery attempts take place until an administrator thaws the message, or the
13936 &%auto_thaw%&, &%ignore_bounce_errors_after%&, or &%timeout_frozen_after%&
13937 feature cause it to be processed. If &%freeze_tell%& is set, Exim generates a
13938 warning message whenever it freezes something, unless the message it is
13939 freezing is a locally-generated bounce message. (Without this exception there
13940 is the possibility of looping.) The warning message is sent to the addresses
13941 supplied as the comma-separated value of this option. If several of the
13942 message's addresses cause freezing, only a single message is sent. If the
13943 freezing was automatic, the reason(s) for freezing can be found in the message
13944 log. If you configure freezing in a filter or ACL, you must arrange for any
13945 logging that you require.
13946
13947
13948 .option gecos_name main string&!! unset
13949 .cindex "HP-UX"
13950 .cindex "&""gecos""& field, parsing"
13951 Some operating systems, notably HP-UX, use the &"gecos"& field in the system
13952 password file to hold other information in addition to users' real names. Exim
13953 looks up this field for use when it is creating &'Sender:'& or &'From:'&
13954 headers. If either &%gecos_pattern%& or &%gecos_name%& are unset, the contents
13955 of the field are used unchanged, except that, if an ampersand is encountered,
13956 it is replaced by the user's login name with the first character forced to
13957 upper case, since this is a convention that is observed on many systems.
13958
13959 When these options are set, &%gecos_pattern%& is treated as a regular
13960 expression that is to be applied to the field (again with && replaced by the
13961 login name), and if it matches, &%gecos_name%& is expanded and used as the
13962 user's name.
13963
13964 .cindex "numerical variables (&$1$& &$2$& etc)" "in &%gecos_name%&"
13965 Numeric variables such as &$1$&, &$2$&, etc. can be used in the expansion to
13966 pick up sub-fields that were matched by the pattern. In HP-UX, where the user's
13967 name terminates at the first comma, the following can be used:
13968 .code
13969 gecos_pattern = ([^,]*)
13970 gecos_name = $1
13971 .endd
13972
13973 .option gecos_pattern main string unset
13974 See &%gecos_name%& above.
13975
13976
13977 .option gnutls_compat_mode main boolean unset
13978 This option controls whether GnuTLS is used in compatibility mode in an Exim
13979 server. This reduces security slightly, but improves interworking with older
13980 implementations of TLS.
13981
13982
13983 .new
13984 option gnutls_enable_pkcs11 main boolean unset
13985 This option will let GnuTLS (2.12.0 or later) autoload PKCS11 modules with
13986 the p11-kit configuration files in &_/etc/pkcs11/modules/_&.
13987
13988 See
13989 &url(http://www.gnu.org/software/gnutls/manual/gnutls.html#Smart-cards-and-HSMs)
13990 for documentation.
13991 .wen
13992
13993
13994
13995 .option headers_charset main string "see below"
13996 This option sets a default character set for translating from encoded MIME
13997 &"words"& in header lines, when referenced by an &$h_xxx$& expansion item. The
13998 default is the value of HEADERS_CHARSET in &_Local/Makefile_&. The
13999 ultimate default is ISO-8859-1. For more details see the description of header
14000 insertions in section &<<SECTexpansionitems>>&.
14001
14002
14003
14004 .option header_maxsize main integer "see below"
14005 .cindex "header section" "maximum size of"
14006 .cindex "limit" "size of message header section"
14007 This option controls the overall maximum size of a message's header
14008 section. The default is the value of HEADER_MAXSIZE in
14009 &_Local/Makefile_&; the default for that is 1M. Messages with larger header
14010 sections are rejected.
14011
14012
14013 .option header_line_maxsize main integer 0
14014 .cindex "header lines" "maximum size of"
14015 .cindex "limit" "size of one header line"
14016 This option limits the length of any individual header line in a message, after
14017 all the continuations have been joined together. Messages with individual
14018 header lines that are longer than the limit are rejected. The default value of
14019 zero means &"no limit"&.
14020
14021
14022
14023
14024 .option helo_accept_junk_hosts main "host list&!!" unset
14025 .cindex "HELO" "accepting junk data"
14026 .cindex "EHLO" "accepting junk data"
14027 Exim checks the syntax of HELO and EHLO commands for incoming SMTP
14028 mail, and gives an error response for invalid data. Unfortunately, there are
14029 some SMTP clients that send syntactic junk. They can be accommodated by setting
14030 this option. Note that this is a syntax check only. See &%helo_verify_hosts%&
14031 if you want to do semantic checking.
14032 See also &%helo_allow_chars%& for a way of extending the permitted character
14033 set.
14034
14035
14036 .option helo_allow_chars main string unset
14037 .cindex "HELO" "underscores in"
14038 .cindex "EHLO" "underscores in"
14039 .cindex "underscore in EHLO/HELO"
14040 This option can be set to a string of rogue characters that are permitted in
14041 all EHLO and HELO names in addition to the standard letters, digits,
14042 hyphens, and dots. If you really must allow underscores, you can set
14043 .code
14044 helo_allow_chars = _
14045 .endd
14046 Note that the value is one string, not a list.
14047
14048
14049 .option helo_lookup_domains main "domain list&!!" &`@:@[]`&
14050 .cindex "HELO" "forcing reverse lookup"
14051 .cindex "EHLO" "forcing reverse lookup"
14052 If the domain given by a client in a HELO or EHLO command matches this
14053 list, a reverse lookup is done in order to establish the host's true name. The
14054 default forces a lookup if the client host gives the server's name or any of
14055 its IP addresses (in brackets), something that broken clients have been seen to
14056 do.
14057
14058
14059 .option helo_try_verify_hosts main "host list&!!" unset
14060 .cindex "HELO verifying" "optional"
14061 .cindex "EHLO" "verifying, optional"
14062 By default, Exim just checks the syntax of HELO and EHLO commands (see
14063 &%helo_accept_junk_hosts%& and &%helo_allow_chars%&). However, some sites like
14064 to do more extensive checking of the data supplied by these commands. The ACL
14065 condition &`verify = helo`& is provided to make this possible.
14066 Formerly, it was necessary also to set this option (&%helo_try_verify_hosts%&)
14067 to force the check to occur. From release 4.53 onwards, this is no longer
14068 necessary. If the check has not been done before &`verify = helo`& is
14069 encountered, it is done at that time. Consequently, this option is obsolete.
14070 Its specification is retained here for backwards compatibility.
14071
14072 When an EHLO or HELO command is received, if the calling host matches
14073 &%helo_try_verify_hosts%&, Exim checks that the host name given in the HELO or
14074 EHLO command either:
14075
14076 .ilist
14077 is an IP literal matching the calling address of the host, or
14078 .next
14079 .cindex "DNS" "reverse lookup"
14080 .cindex "reverse DNS lookup"
14081 matches the host name that Exim obtains by doing a reverse lookup of the
14082 calling host address, or
14083 .next
14084 when looked up using &[gethostbyname()]& (or &[getipnodebyname()]& when
14085 available) yields the calling host address.
14086 .endlist
14087
14088 However, the EHLO or HELO command is not rejected if any of the checks
14089 fail. Processing continues, but the result of the check is remembered, and can
14090 be detected later in an ACL by the &`verify = helo`& condition.
14091
14092 .option helo_verify_hosts main "host list&!!" unset
14093 .cindex "HELO verifying" "mandatory"
14094 .cindex "EHLO" "verifying, mandatory"
14095 Like &%helo_try_verify_hosts%&, this option is obsolete, and retained only for
14096 backwards compatibility. For hosts that match this option, Exim checks the host
14097 name given in the HELO or EHLO in the same way as for
14098 &%helo_try_verify_hosts%&. If the check fails, the HELO or EHLO command is
14099 rejected with a 550 error, and entries are written to the main and reject logs.
14100 If a MAIL command is received before EHLO or HELO, it is rejected with a 503
14101 error.
14102
14103 .option hold_domains main "domain list&!!" unset
14104 .cindex "domain" "delaying delivery"
14105 .cindex "delivery" "delaying certain domains"
14106 This option allows mail for particular domains to be held on the queue
14107 manually. The option is overridden if a message delivery is forced with the
14108 &%-M%&, &%-qf%&, &%-Rf%& or &%-Sf%& options, and also while testing or
14109 verifying addresses using &%-bt%& or &%-bv%&. Otherwise, if a domain matches an
14110 item in &%hold_domains%&, no routing or delivery for that address is done, and
14111 it is deferred every time the message is looked at.
14112
14113 This option is intended as a temporary operational measure for delaying the
14114 delivery of mail while some problem is being sorted out, or some new
14115 configuration tested. If you just want to delay the processing of some
14116 domains until a queue run occurs, you should use &%queue_domains%& or
14117 &%queue_smtp_domains%&, not &%hold_domains%&.
14118
14119 A setting of &%hold_domains%& does not override Exim's code for removing
14120 messages from the queue if they have been there longer than the longest retry
14121 time in any retry rule. If you want to hold messages for longer than the normal
14122 retry times, insert a dummy retry rule with a long retry time.
14123
14124
14125 .option host_lookup main "host list&!!" unset
14126 .cindex "host name" "lookup, forcing"
14127 Exim does not look up the name of a calling host from its IP address unless it
14128 is required to compare against some host list, or the host matches
14129 &%helo_try_verify_hosts%& or &%helo_verify_hosts%&, or the host matches this
14130 option (which normally contains IP addresses rather than host names). The
14131 default configuration file contains
14132 .code
14133 host_lookup = *
14134 .endd
14135 which causes a lookup to happen for all hosts. If the expense of these lookups
14136 is felt to be too great, the setting can be changed or removed.
14137
14138 After a successful reverse lookup, Exim does a forward lookup on the name it
14139 has obtained, to verify that it yields the IP address that it started with. If
14140 this check fails, Exim behaves as if the name lookup failed.
14141
14142 .vindex "&$host_lookup_failed$&"
14143 .vindex "&$sender_host_name$&"
14144 After any kind of failure, the host name (in &$sender_host_name$&) remains
14145 unset, and &$host_lookup_failed$& is set to the string &"1"&. See also
14146 &%dns_again_means_nonexist%&, &%helo_lookup_domains%&, and
14147 &`verify = reverse_host_lookup`& in ACLs.
14148
14149
14150 .option host_lookup_order main "string list" &`bydns:byaddr`&
14151 This option specifies the order of different lookup methods when Exim is trying
14152 to find a host name from an IP address. The default is to do a DNS lookup
14153 first, and then to try a local lookup (using &[gethostbyaddr()]& or equivalent)
14154 if that fails. You can change the order of these lookups, or omit one entirely,
14155 if you want.
14156
14157 &*Warning*&: The &"byaddr"& method does not always yield aliases when there are
14158 multiple PTR records in the DNS and the IP address is not listed in
14159 &_/etc/hosts_&. Different operating systems give different results in this
14160 case. That is why the default tries a DNS lookup first.
14161
14162
14163
14164 .option host_reject_connection main "host list&!!" unset
14165 .cindex "host" "rejecting connections from"
14166 If this option is set, incoming SMTP calls from the hosts listed are rejected
14167 as soon as the connection is made.
14168 This option is obsolete, and retained only for backward compatibility, because
14169 nowadays the ACL specified by &%acl_smtp_connect%& can also reject incoming
14170 connections immediately.
14171
14172 The ability to give an immediate rejection (either by this option or using an
14173 ACL) is provided for use in unusual cases. Many hosts will just try again,
14174 sometimes without much delay. Normally, it is better to use an ACL to reject
14175 incoming messages at a later stage, such as after RCPT commands. See
14176 chapter &<<CHAPACL>>&.
14177
14178
14179 .option hosts_connection_nolog main "host list&!!" unset
14180 .cindex "host" "not logging connections from"
14181 This option defines a list of hosts for which connection logging does not
14182 happen, even though the &%smtp_connection%& log selector is set. For example,
14183 you might want not to log SMTP connections from local processes, or from
14184 127.0.0.1, or from your local LAN. This option is consulted in the main loop of
14185 the daemon; you should therefore strive to restrict its value to a short inline
14186 list of IP addresses and networks. To disable logging SMTP connections from
14187 local processes, you must create a host list with an empty item. For example:
14188 .code
14189 hosts_connection_nolog = :
14190 .endd
14191 If the &%smtp_connection%& log selector is not set, this option has no effect.
14192
14193
14194
14195 .option hosts_treat_as_local main "domain list&!!" unset
14196 .cindex "local host" "domains treated as"
14197 .cindex "host" "treated as local"
14198 If this option is set, any host names that match the domain list are treated as
14199 if they were the local host when Exim is scanning host lists obtained from MX
14200 records
14201 or other sources. Note that the value of this option is a domain list, not a
14202 host list, because it is always used to check host names, not IP addresses.
14203
14204 This option also applies when Exim is matching the special items
14205 &`@mx_any`&, &`@mx_primary`&, and &`@mx_secondary`& in a domain list (see
14206 section &<<SECTdomainlist>>&), and when checking the &%hosts%& option in the
14207 &(smtp)& transport for the local host (see the &%allow_localhost%& option in
14208 that transport). See also &%local_interfaces%&, &%extra_local_interfaces%&, and
14209 chapter &<<CHAPinterfaces>>&, which contains a discussion about local network
14210 interfaces and recognizing the local host.
14211
14212
14213 .option ibase_servers main "string list" unset
14214 .cindex "InterBase" "server list"
14215 This option provides a list of InterBase servers and associated connection data,
14216 to be used in conjunction with &(ibase)& lookups (see section &<<SECID72>>&).
14217 The option is available only if Exim has been built with InterBase support.
14218
14219
14220
14221 .option ignore_bounce_errors_after main time 10w
14222 .cindex "bounce message" "discarding"
14223 .cindex "discarding bounce message"
14224 This option affects the processing of bounce messages that cannot be delivered,
14225 that is, those that suffer a permanent delivery failure. (Bounce messages that
14226 suffer temporary delivery failures are of course retried in the usual way.)
14227
14228 After a permanent delivery failure, bounce messages are frozen,
14229 because there is no sender to whom they can be returned. When a frozen bounce
14230 message has been on the queue for more than the given time, it is unfrozen at
14231 the next queue run, and a further delivery is attempted. If delivery fails
14232 again, the bounce message is discarded. This makes it possible to keep failed
14233 bounce messages around for a shorter time than the normal maximum retry time
14234 for frozen messages. For example,
14235 .code
14236 ignore_bounce_errors_after = 12h
14237 .endd
14238 retries failed bounce message deliveries after 12 hours, discarding any further
14239 failures. If the value of this option is set to a zero time period, bounce
14240 failures are discarded immediately. Setting a very long time (as in the default
14241 value) has the effect of disabling this option. For ways of automatically
14242 dealing with other kinds of frozen message, see &%auto_thaw%& and
14243 &%timeout_frozen_after%&.
14244
14245
14246 .option ignore_fromline_hosts main "host list&!!" unset
14247 .cindex "&""From""& line"
14248 .cindex "UUCP" "&""From""& line"
14249 Some broken SMTP clients insist on sending a UUCP-like &"From&~"& line before
14250 the headers of a message. By default this is treated as the start of the
14251 message's body, which means that any following headers are not recognized as
14252 such. Exim can be made to ignore it by setting &%ignore_fromline_hosts%& to
14253 match those hosts that insist on sending it. If the sender is actually a local
14254 process rather than a remote host, and is using &%-bs%& to inject the messages,
14255 &%ignore_fromline_local%& must be set to achieve this effect.
14256
14257
14258 .option ignore_fromline_local main boolean false
14259 See &%ignore_fromline_hosts%& above.
14260
14261
14262 .option keep_malformed main time 4d
14263 This option specifies the length of time to keep messages whose spool files
14264 have been corrupted in some way. This should, of course, never happen. At the
14265 next attempt to deliver such a message, it gets removed. The incident is
14266 logged.
14267
14268
14269 .option ldap_ca_cert_dir main string unset
14270 .cindex "LDAP", "TLS CA certificate directory"
14271 This option indicates which directory contains CA certificates for verifying
14272 a TLS certificate presented by an LDAP server.
14273 While Exim does not provide a default value, your SSL library may.
14274 Analogous to &%tls_verify_certificates%& but as a client-side option for LDAP
14275 and constrained to be a directory.
14276
14277
14278 .option ldap_ca_cert_file main string unset
14279 .cindex "LDAP", "TLS CA certificate file"
14280 This option indicates which file contains CA certificates for verifying
14281 a TLS certificate presented by an LDAP server.
14282 While Exim does not provide a default value, your SSL library may.
14283 Analogous to &%tls_verify_certificates%& but as a client-side option for LDAP
14284 and constrained to be a file.
14285
14286
14287 .option ldap_cert_file main string unset
14288 .cindex "LDAP" "TLS client certificate file"
14289 This option indicates which file contains an TLS client certificate which
14290 Exim should present to the LDAP server during TLS negotiation.
14291 Should be used together with &%ldap_cert_key%&.
14292
14293
14294 .option ldap_cert_key main string unset
14295 .cindex "LDAP" "TLS client key file"
14296 This option indicates which file contains the secret/private key to use
14297 to prove identity to the LDAP server during TLS negotiation.
14298 Should be used together with &%ldap_cert_file%&, which contains the
14299 identity to be proven.
14300
14301
14302 .option ldap_cipher_suite main string unset
14303 .cindex "LDAP" "TLS cipher suite"
14304 This controls the TLS cipher-suite negotiation during TLS negotiation with
14305 the LDAP server.  See &<<SECTreqciphssl>>& for more details of the format of
14306 cipher-suite options with OpenSSL (as used by LDAP client libraries).
14307
14308
14309 .option ldap_default_servers main "string list" unset
14310 .cindex "LDAP" "default servers"
14311 This option provides a list of LDAP servers which are tried in turn when an
14312 LDAP query does not contain a server. See section &<<SECTforldaque>>& for
14313 details of LDAP queries. This option is available only when Exim has been built
14314 with LDAP support.
14315
14316
14317 .option ldap_require_cert main string unset.
14318 .cindex "LDAP" "policy for LDAP server TLS cert presentation"
14319 This should be one of the values "hard", "demand", "allow", "try" or "never".
14320 A value other than one of these is interpreted as "never".
14321 See the entry "TLS_REQCERT" in your system man page for ldap.conf(5).
14322 Although Exim does not set a default, the LDAP library probably defaults
14323 to hard/demand.
14324
14325
14326 .option ldap_start_tls main boolean false
14327 .cindex "LDAP" "whether or not to negotiate TLS"
14328 If set, Exim will attempt to negotiate TLS with the LDAP server when
14329 connecting on a regular LDAP port.  This is the LDAP equivalent of SMTP's
14330 "STARTTLS".  This is distinct from using "ldaps", which is the LDAP form
14331 of SSL-on-connect.
14332 In the event of failure to negotiate TLS, the action taken is controlled
14333 by &%ldap_require_cert%&.
14334
14335
14336 .option ldap_version main integer unset
14337 .cindex "LDAP" "protocol version, forcing"
14338 This option can be used to force Exim to set a specific protocol version for
14339 LDAP. If it option is unset, it is shown by the &%-bP%& command line option as
14340 -1. When this is the case, the default is 3 if LDAP_VERSION3 is defined in
14341 the LDAP headers; otherwise it is 2. This option is available only when Exim
14342 has been built with LDAP support.
14343
14344
14345
14346 .option local_from_check main boolean true
14347 .cindex "&'Sender:'& header line" "disabling addition of"
14348 .cindex "&'From:'& header line" "disabling checking of"
14349 When a message is submitted locally (that is, not over a TCP/IP connection) by
14350 an untrusted user, Exim removes any existing &'Sender:'& header line, and
14351 checks that the &'From:'& header line matches the login of the calling user and
14352 the domain specified by &%qualify_domain%&.
14353
14354 &*Note*&: An unqualified address (no domain) in the &'From:'& header in a
14355 locally submitted message is automatically qualified by Exim, unless the
14356 &%-bnq%& command line option is used.
14357
14358 You can use &%local_from_prefix%& and &%local_from_suffix%& to permit affixes
14359 on the local part. If the &'From:'& header line does not match, Exim adds a
14360 &'Sender:'& header with an address constructed from the calling user's login
14361 and the default qualify domain.
14362
14363 If &%local_from_check%& is set false, the &'From:'& header check is disabled,
14364 and no &'Sender:'& header is ever added. If, in addition, you want to retain
14365 &'Sender:'& header lines supplied by untrusted users, you must also set
14366 &%local_sender_retain%& to be true.
14367
14368 .cindex "envelope sender"
14369 These options affect only the header lines in the message. The envelope sender
14370 is still forced to be the login id at the qualify domain unless
14371 &%untrusted_set_sender%& permits the user to supply an envelope sender.
14372
14373 For messages received over TCP/IP, an ACL can specify &"submission mode"& to
14374 request similar header line checking. See section &<<SECTthesenhea>>&, which
14375 has more details about &'Sender:'& processing.
14376
14377
14378
14379
14380 .option local_from_prefix main string unset
14381 When Exim checks the &'From:'& header line of locally submitted messages for
14382 matching the login id (see &%local_from_check%& above), it can be configured to
14383 ignore certain prefixes and suffixes in the local part of the address. This is
14384 done by setting &%local_from_prefix%& and/or &%local_from_suffix%& to
14385 appropriate lists, in the same form as the &%local_part_prefix%& and
14386 &%local_part_suffix%& router options (see chapter &<<CHAProutergeneric>>&). For
14387 example, if
14388 .code
14389 local_from_prefix = *-
14390 .endd
14391 is set, a &'From:'& line containing
14392 .code
14393 From: anything-user@your.domain.example
14394 .endd
14395 will not cause a &'Sender:'& header to be added if &'user@your.domain.example'&
14396 matches the actual sender address that is constructed from the login name and
14397 qualify domain.
14398
14399
14400 .option local_from_suffix main string unset
14401 See &%local_from_prefix%& above.
14402
14403
14404 .option local_interfaces main "string list" "see below"
14405 This option controls which network interfaces are used by the daemon for
14406 listening; they are also used to identify the local host when routing. Chapter
14407 &<<CHAPinterfaces>>& contains a full description of this option and the related
14408 options &%daemon_smtp_ports%&, &%extra_local_interfaces%&,
14409 &%hosts_treat_as_local%&, and &%tls_on_connect_ports%&. The default value for
14410 &%local_interfaces%& is
14411 .code
14412 local_interfaces = 0.0.0.0
14413 .endd
14414 when Exim is built without IPv6 support; otherwise it is
14415 .code
14416 local_interfaces = <; ::0 ; 0.0.0.0
14417 .endd
14418
14419 .option local_scan_timeout main time 5m
14420 .cindex "timeout" "for &[local_scan()]& function"
14421 .cindex "&[local_scan()]& function" "timeout"
14422 This timeout applies to the &[local_scan()]& function (see chapter
14423 &<<CHAPlocalscan>>&). Zero means &"no timeout"&. If the timeout is exceeded,
14424 the incoming message is rejected with a temporary error if it is an SMTP
14425 message. For a non-SMTP message, the message is dropped and Exim ends with a
14426 non-zero code. The incident is logged on the main and reject logs.
14427
14428
14429
14430 .option local_sender_retain main boolean false
14431 .cindex "&'Sender:'& header line" "retaining from local submission"
14432 When a message is submitted locally (that is, not over a TCP/IP connection) by
14433 an untrusted user, Exim removes any existing &'Sender:'& header line. If you
14434 do not want this to happen, you must set &%local_sender_retain%&, and you must
14435 also set &%local_from_check%& to be false (Exim will complain if you do not).
14436 See also the ACL modifier &`control = suppress_local_fixups`&. Section
14437 &<<SECTthesenhea>>& has more details about &'Sender:'& processing.
14438
14439
14440
14441
14442 .option localhost_number main string&!! unset
14443 .cindex "host" "locally unique number for"
14444 .cindex "message ids" "with multiple hosts"
14445 .vindex "&$localhost_number$&"
14446 Exim's message ids are normally unique only within the local host. If
14447 uniqueness among a set of hosts is required, each host must set a different
14448 value for the &%localhost_number%& option. The string is expanded immediately
14449 after reading the configuration file (so that a number can be computed from the
14450 host name, for example) and the result of the expansion must be a number in the
14451 range 0&--16 (or 0&--10 on operating systems with case-insensitive file
14452 systems). This is available in subsequent string expansions via the variable
14453 &$localhost_number$&. When &%localhost_number is set%&, the final two
14454 characters of the message id, instead of just being a fractional part of the
14455 time, are computed from the time and the local host number as described in
14456 section &<<SECTmessiden>>&.
14457
14458
14459
14460 .option log_file_path main "string list&!!" "set at compile time"
14461 .cindex "log" "file path for"
14462 This option sets the path which is used to determine the names of Exim's log
14463 files, or indicates that logging is to be to syslog, or both. It is expanded
14464 when Exim is entered, so it can, for example, contain a reference to the host
14465 name. If no specific path is set for the log files at compile or run time, they
14466 are written in a sub-directory called &_log_& in Exim's spool directory.
14467 Chapter &<<CHAPlog>>& contains further details about Exim's logging, and
14468 section &<<SECTwhelogwri>>& describes how the contents of &%log_file_path%& are
14469 used. If this string is fixed at your installation (contains no expansion
14470 variables) it is recommended that you do not set this option in the
14471 configuration file, but instead supply the path using LOG_FILE_PATH in
14472 &_Local/Makefile_& so that it is available to Exim for logging errors detected
14473 early on &-- in particular, failure to read the configuration file.
14474
14475
14476 .option log_selector main string unset
14477 .cindex "log" "selectors"
14478 This option can be used to reduce or increase the number of things that Exim
14479 writes to its log files. Its argument is made up of names preceded by plus or
14480 minus characters. For example:
14481 .code
14482 log_selector = +arguments -retry_defer
14483 .endd
14484 A list of possible names and what they control is given in the chapter on
14485 logging, in section &<<SECTlogselector>>&.
14486
14487
14488 .option log_timezone main boolean false
14489 .cindex "log" "timezone for entries"
14490 .vindex "&$tod_log$&"
14491 .vindex "&$tod_zone$&"
14492 By default, the timestamps on log lines are in local time without the
14493 timezone. This means that if your timezone changes twice a year, the timestamps
14494 in log lines are ambiguous for an hour when the clocks go back. One way of
14495 avoiding this problem is to set the timezone to UTC. An alternative is to set
14496 &%log_timezone%& true. This turns on the addition of the timezone offset to
14497 timestamps in log lines. Turning on this option can add quite a lot to the size
14498 of log files because each line is extended by 6 characters. Note that the
14499 &$tod_log$& variable contains the log timestamp without the zone, but there is
14500 another variable called &$tod_zone$& that contains just the timezone offset.
14501
14502
14503 .option lookup_open_max main integer 25
14504 .cindex "too many open files"
14505 .cindex "open files, too many"
14506 .cindex "file" "too many open"
14507 .cindex "lookup" "maximum open files"
14508 .cindex "limit" "open files for lookups"
14509 This option limits the number of simultaneously open files for single-key
14510 lookups that use regular files (that is, &(lsearch)&, &(dbm)&, and &(cdb)&).
14511 Exim normally keeps these files open during routing, because often the same
14512 file is required several times. If the limit is reached, Exim closes the least
14513 recently used file. Note that if you are using the &'ndbm'& library, it
14514 actually opens two files for each logical DBM database, though it still counts
14515 as one for the purposes of &%lookup_open_max%&. If you are getting &"too many
14516 open files"& errors with NDBM, you need to reduce the value of
14517 &%lookup_open_max%&.
14518
14519
14520 .option max_username_length main integer 0
14521 .cindex "length of login name"
14522 .cindex "user name" "maximum length"
14523 .cindex "limit" "user name length"
14524 Some operating systems are broken in that they truncate long arguments to
14525 &[getpwnam()]& to eight characters, instead of returning &"no such user"&. If
14526 this option is set greater than zero, any attempt to call &[getpwnam()]& with
14527 an argument that is longer behaves as if &[getpwnam()]& failed.
14528
14529
14530 .option message_body_newlines main bool false
14531 .cindex "message body" "newlines in variables"
14532 .cindex "newline" "in message body variables"
14533 .vindex "&$message_body$&"
14534 .vindex "&$message_body_end$&"
14535 By default, newlines in the message body are replaced by spaces when setting
14536 the &$message_body$& and &$message_body_end$& expansion variables. If this
14537 option is set true, this no longer happens.
14538
14539
14540 .option message_body_visible main integer 500
14541 .cindex "body of message" "visible size"
14542 .cindex "message body" "visible size"
14543 .vindex "&$message_body$&"
14544 .vindex "&$message_body_end$&"
14545 This option specifies how much of a message's body is to be included in the
14546 &$message_body$& and &$message_body_end$& expansion variables.
14547
14548
14549 .option message_id_header_domain main string&!! unset
14550 .cindex "&'Message-ID:'& header line"
14551 If this option is set, the string is expanded and used as the right hand side
14552 (domain) of the &'Message-ID:'& header that Exim creates if a
14553 locally-originated incoming message does not have one. &"Locally-originated"&
14554 means &"not received over TCP/IP."&
14555 Otherwise, the primary host name is used.
14556 Only letters, digits, dot and hyphen are accepted; any other characters are
14557 replaced by hyphens. If the expansion is forced to fail, or if the result is an
14558 empty string, the option is ignored.
14559
14560
14561 .option message_id_header_text main string&!! unset
14562 If this variable is set, the string is expanded and used to augment the text of
14563 the &'Message-id:'& header that Exim creates if a locally-originated incoming
14564 message does not have one. The text of this header is required by RFC 2822 to
14565 take the form of an address. By default, Exim uses its internal message id as
14566 the local part, and the primary host name as the domain. If this option is set,
14567 it is expanded, and provided the expansion is not forced to fail, and does not
14568 yield an empty string, the result is inserted into the header immediately
14569 before the @, separated from the internal message id by a dot. Any characters
14570 that are illegal in an address are automatically converted into hyphens. This
14571 means that variables such as &$tod_log$& can be used, because the spaces and
14572 colons will become hyphens.
14573
14574
14575 .option message_logs main boolean true
14576 .cindex "message logs" "disabling"
14577 .cindex "log" "message log; disabling"
14578 If this option is turned off, per-message log files are not created in the
14579 &_msglog_& spool sub-directory. This reduces the amount of disk I/O required by
14580 Exim, by reducing the number of files involved in handling a message from a
14581 minimum of four (header spool file, body spool file, delivery journal, and
14582 per-message log) to three. The other major I/O activity is Exim's main log,
14583 which is not affected by this option.
14584
14585
14586 .option message_size_limit main string&!! 50M
14587 .cindex "message" "size limit"
14588 .cindex "limit" "message size"
14589 .cindex "size" "of message, limit"
14590 This option limits the maximum size of message that Exim will process. The
14591 value is expanded for each incoming connection so, for example, it can be made
14592 to depend on the IP address of the remote host for messages arriving via
14593 TCP/IP. After expansion, the value must be a sequence of decimal digits,
14594 optionally followed by K or M.
14595
14596 &*Note*&: This limit cannot be made to depend on a message's sender or any
14597 other properties of an individual message, because it has to be advertised in
14598 the server's response to EHLO. String expansion failure causes a temporary
14599 error. A value of zero means no limit, but its use is not recommended. See also
14600 &%bounce_return_size_limit%&.
14601
14602 Incoming SMTP messages are failed with a 552 error if the limit is
14603 exceeded; locally-generated messages either get a stderr message or a delivery
14604 failure message to the sender, depending on the &%-oe%& setting. Rejection of
14605 an oversized message is logged in both the main and the reject logs. See also
14606 the generic transport option &%message_size_limit%&, which limits the size of
14607 message that an individual transport can process.
14608
14609 If you use a virus-scanner and set this option to to a value larger than the
14610 maximum size that your virus-scanner is configured to support, you may get
14611 failures triggered by large mails.  The right size to configure for the
14612 virus-scanner depends upon what data is passed and the options in use but it's
14613 probably safest to just set it to a little larger than this value.  Eg, with a
14614 default Exim message size of 50M and a default ClamAV StreamMaxLength of 10M,
14615 some problems may result.
14616
14617 A value of 0 will disable size limit checking; Exim will still advertise the
14618 SIZE extension in an EHLO response, but without a limit, so as to permit
14619 SMTP clients to still indicate the message size along with the MAIL verb.
14620
14621
14622 .option move_frozen_messages main boolean false
14623 .cindex "frozen messages" "moving"
14624 This option, which is available only if Exim has been built with the setting
14625 .code
14626 SUPPORT_MOVE_FROZEN_MESSAGES=yes
14627 .endd
14628 in &_Local/Makefile_&, causes frozen messages and their message logs to be
14629 moved from the &_input_& and &_msglog_& directories on the spool to &_Finput_&
14630 and &_Fmsglog_&, respectively. There is currently no support in Exim or the
14631 standard utilities for handling such moved messages, and they do not show up in
14632 lists generated by &%-bp%& or by the Exim monitor.
14633
14634
14635 .option mua_wrapper main boolean false
14636 Setting this option true causes Exim to run in a very restrictive mode in which
14637 it passes messages synchronously to a smart host. Chapter &<<CHAPnonqueueing>>&
14638 contains a full description of this facility.
14639
14640
14641
14642 .option mysql_servers main "string list" unset
14643 .cindex "MySQL" "server list"
14644 This option provides a list of MySQL servers and associated connection data, to
14645 be used in conjunction with &(mysql)& lookups (see section &<<SECID72>>&). The
14646 option is available only if Exim has been built with MySQL support.
14647
14648
14649 .option never_users main "string list&!!" unset
14650 This option is expanded just once, at the start of Exim's processing. Local
14651 message deliveries are normally run in processes that are setuid to the
14652 recipient, and remote deliveries are normally run under Exim's own uid and gid.
14653 It is usually desirable to prevent any deliveries from running as root, as a
14654 safety precaution.
14655
14656 When Exim is built, an option called FIXED_NEVER_USERS can be set to a
14657 list of users that must not be used for local deliveries. This list is fixed in
14658 the binary and cannot be overridden by the configuration file. By default, it
14659 contains just the single user name &"root"&. The &%never_users%& runtime option
14660 can be used to add more users to the fixed list.
14661
14662 If a message is to be delivered as one of the users on the fixed list or the
14663 &%never_users%& list, an error occurs, and delivery is deferred. A common
14664 example is
14665 .code
14666 never_users = root:daemon:bin
14667 .endd
14668 Including root is redundant if it is also on the fixed list, but it does no
14669 harm. This option overrides the &%pipe_as_creator%& option of the &(pipe)&
14670 transport driver.
14671
14672
14673 .option openssl_options main "string list" "+no_sslv2"
14674 .cindex "OpenSSL "compatibility options"
14675 This option allows an administrator to adjust the SSL options applied
14676 by OpenSSL to connections.  It is given as a space-separated list of items,
14677 each one to be +added or -subtracted from the current value.
14678
14679 This option is only available if Exim is built against OpenSSL.  The values
14680 available for this option vary according to the age of your OpenSSL install.
14681 The &"all"& value controls a subset of flags which are available, typically
14682 the bug workaround options.  The &'SSL_CTX_set_options'& man page will
14683 list the values known on your system and Exim should support all the
14684 &"bug workaround"& options and many of the &"modifying"& options.  The Exim
14685 names lose the leading &"SSL_OP_"& and are lower-cased.
14686
14687 Note that adjusting the options can have severe impact upon the security of
14688 SSL as used by Exim.  It is possible to disable safety checks and shoot
14689 yourself in the foot in various unpleasant ways.  This option should not be
14690 adjusted lightly.  An unrecognised item will be detected at startup, by
14691 invoking Exim with the &%-bV%& flag.
14692
14693 Historical note: prior to release 4.80, Exim defaulted this value to
14694 "+dont_insert_empty_fragments", which may still be needed for compatibility
14695 with some clients, but which lowers security by increasing exposure to
14696 some now infamous attacks.
14697
14698 An example:
14699 .code
14700 # Make both old MS and old Eudora happy:
14701 openssl_options = -all +microsoft_big_sslv3_buffer \
14702                        +dont_insert_empty_fragments
14703 .endd
14704
14705 Possible options may include:
14706 .ilist
14707 &`all`&
14708 .next
14709 &`allow_unsafe_legacy_renegotiation`&
14710 .next
14711 &`cipher_server_preference`&
14712 .next
14713 &`dont_insert_empty_fragments`&
14714 .next
14715 &`ephemeral_rsa`&
14716 .next
14717 &`legacy_server_connect`&
14718 .next
14719 &`microsoft_big_sslv3_buffer`&
14720 .next
14721 &`microsoft_sess_id_bug`&
14722 .next
14723 &`msie_sslv2_rsa_padding`&
14724 .next
14725 &`netscape_challenge_bug`&
14726 .next
14727 &`netscape_reuse_cipher_change_bug`&
14728 .next
14729 &`no_compression`&
14730 .next
14731 &`no_session_resumption_on_renegotiation`&
14732 .next
14733 &`no_sslv2`&
14734 .next
14735 &`no_sslv3`&
14736 .next
14737 &`no_ticket`&
14738 .next
14739 &`no_tlsv1`&
14740 .next
14741 &`no_tlsv1_1`&
14742 .next
14743 &`no_tlsv1_2`&
14744 .next
14745 &`safari_ecdhe_ecdsa_bug`&
14746 .next
14747 &`single_dh_use`&
14748 .next
14749 &`single_ecdh_use`&
14750 .next
14751 &`ssleay_080_client_dh_bug`&
14752 .next
14753 &`sslref2_reuse_cert_type_bug`&
14754 .next
14755 &`tls_block_padding_bug`&
14756 .next
14757 &`tls_d5_bug`&
14758 .next
14759 &`tls_rollback_bug`&
14760 .endlist
14761
14762 .new
14763 As an aside, the &`safari_ecdhe_ecdsa_bug`& item is a misnomer and affects
14764 all clients connecting using the MacOS SecureTransport TLS facility prior
14765 to MacOS 10.8.4, including email clients.  If you see old MacOS clients failing
14766 to negotiate TLS then this option value might help, provided that your OpenSSL
14767 release is new enough to contain this work-around.  This may be a situation
14768 where you have to upgrade OpenSSL to get buggy clients working.
14769 .wen
14770
14771
14772 .option oracle_servers main "string list" unset
14773 .cindex "Oracle" "server list"
14774 This option provides a list of Oracle servers and associated connection data,
14775 to be used in conjunction with &(oracle)& lookups (see section &<<SECID72>>&).
14776 The option is available only if Exim has been built with Oracle support.
14777
14778
14779 .option percent_hack_domains main "domain list&!!" unset
14780 .cindex "&""percent hack""&"
14781 .cindex "source routing" "in email address"
14782 .cindex "address" "source-routed"
14783 The &"percent hack"& is the convention whereby a local part containing a
14784 percent sign is re-interpreted as a new email address, with the percent
14785 replaced by @. This is sometimes called &"source routing"&, though that term is
14786 also applied to RFC 2822 addresses that begin with an @ character. If this
14787 option is set, Exim implements the percent facility for those domains listed,
14788 but no others. This happens before an incoming SMTP address is tested against
14789 an ACL.
14790
14791 &*Warning*&: The &"percent hack"& has often been abused by people who are
14792 trying to get round relaying restrictions. For this reason, it is best avoided
14793 if at all possible. Unfortunately, a number of less security-conscious MTAs
14794 implement it unconditionally. If you are running Exim on a gateway host, and
14795 routing mail through to internal MTAs without processing the local parts, it is
14796 a good idea to reject recipient addresses with percent characters in their
14797 local parts. Exim's default configuration does this.
14798
14799
14800 .option perl_at_start main boolean false
14801 This option is available only when Exim is built with an embedded Perl
14802 interpreter. See chapter &<<CHAPperl>>& for details of its use.
14803
14804
14805 .option perl_startup main string unset
14806 This option is available only when Exim is built with an embedded Perl
14807 interpreter. See chapter &<<CHAPperl>>& for details of its use.
14808
14809
14810 .option pgsql_servers main "string list" unset
14811 .cindex "PostgreSQL lookup type" "server list"
14812 This option provides a list of PostgreSQL servers and associated connection
14813 data, to be used in conjunction with &(pgsql)& lookups (see section
14814 &<<SECID72>>&). The option is available only if Exim has been built with
14815 PostgreSQL support.
14816
14817
14818 .option pid_file_path main string&!! "set at compile time"
14819 .cindex "daemon" "pid file path"
14820 .cindex "pid file, path for"
14821 This option sets the name of the file to which the Exim daemon writes its
14822 process id. The string is expanded, so it can contain, for example, references
14823 to the host name:
14824 .code
14825 pid_file_path = /var/log/$primary_hostname/exim.pid
14826 .endd
14827 If no path is set, the pid is written to the file &_exim-daemon.pid_& in Exim's
14828 spool directory.
14829 The value set by the option can be overridden by the &%-oP%& command line
14830 option. A pid file is not written if a &"non-standard"& daemon is run by means
14831 of the &%-oX%& option, unless a path is explicitly supplied by &%-oP%&.
14832
14833
14834 .option pipelining_advertise_hosts main "host list&!!" *
14835 .cindex "PIPELINING" "suppressing advertising"
14836 This option can be used to suppress the advertisement of the SMTP
14837 PIPELINING extension to specific hosts. See also the &*no_pipelining*&
14838 control in section &<<SECTcontrols>>&. When PIPELINING is not advertised and
14839 &%smtp_enforce_sync%& is true, an Exim server enforces strict synchronization
14840 for each SMTP command and response. When PIPELINING is advertised, Exim assumes
14841 that clients will use it; &"out of order"& commands that are &"expected"& do
14842 not count as protocol errors (see &%smtp_max_synprot_errors%&).
14843
14844
14845 .option preserve_message_logs main boolean false
14846 .cindex "message logs" "preserving"
14847 If this option is set, message log files are not deleted when messages are
14848 completed. Instead, they are moved to a sub-directory of the spool directory
14849 called &_msglog.OLD_&, where they remain available for statistical or debugging
14850 purposes. This is a dangerous option to set on systems with any appreciable
14851 volume of mail. Use with care!
14852
14853
14854 .option primary_hostname main string "see below"
14855 .cindex "name" "of local host"
14856 .cindex "host" "name of local"
14857 .cindex "local host" "name of"
14858 .vindex "&$primary_hostname$&"
14859 This specifies the name of the current host. It is used in the default EHLO or
14860 HELO command for outgoing SMTP messages (changeable via the &%helo_data%&
14861 option in the &(smtp)& transport), and as the default for &%qualify_domain%&.
14862 The value is also used by default in some SMTP response messages from an Exim
14863 server. This can be changed dynamically by setting &%smtp_active_hostname%&.
14864
14865 If &%primary_hostname%& is not set, Exim calls &[uname()]& to find the host
14866 name. If this fails, Exim panics and dies. If the name returned by &[uname()]&
14867 contains only one component, Exim passes it to &[gethostbyname()]& (or
14868 &[getipnodebyname()]& when available) in order to obtain the fully qualified
14869 version. The variable &$primary_hostname$& contains the host name, whether set
14870 explicitly by this option, or defaulted.
14871
14872
14873 .option print_topbitchars main boolean false
14874 .cindex "printing characters"
14875 .cindex "8-bit characters"
14876 By default, Exim considers only those characters whose codes lie in the range
14877 32&--126 to be printing characters. In a number of circumstances (for example,
14878 when writing log entries) non-printing characters are converted into escape
14879 sequences, primarily to avoid messing up the layout. If &%print_topbitchars%&
14880 is set, code values of 128 and above are also considered to be printing
14881 characters.
14882
14883 This option also affects the header syntax checks performed by the
14884 &(autoreply)& transport, and whether Exim uses RFC 2047 encoding of
14885 the user's full name when constructing From: and Sender: addresses (as
14886 described in section &<<SECTconstr>>&). Setting this option can cause
14887 Exim to generate eight bit message headers that do not conform to the
14888 standards.
14889
14890
14891 .option process_log_path main string unset
14892 .cindex "process log path"
14893 .cindex "log" "process log"
14894 .cindex "&'exiwhat'&"
14895 This option sets the name of the file to which an Exim process writes its
14896 &"process log"& when sent a USR1 signal. This is used by the &'exiwhat'&
14897 utility script. If this option is unset, the file called &_exim-process.info_&
14898 in Exim's spool directory is used. The ability to specify the name explicitly
14899 can be useful in environments where two different Exims are running, using
14900 different spool directories.
14901
14902
14903 .option prod_requires_admin main boolean true
14904 .oindex "&%-M%&"
14905 .oindex "&%-R%&"
14906 .oindex "&%-q%&"
14907 The &%-M%&, &%-R%&, and &%-q%& command-line options require the caller to be an
14908 admin user unless &%prod_requires_admin%& is set false. See also
14909 &%queue_list_requires_admin%&.
14910
14911
14912 .option qualify_domain main string "see below"
14913 .cindex "domain" "for qualifying addresses"
14914 .cindex "address" "qualification"
14915 This option specifies the domain name that is added to any envelope sender
14916 addresses that do not have a domain qualification. It also applies to
14917 recipient addresses if &%qualify_recipient%& is not set. Unqualified addresses
14918 are accepted by default only for locally-generated messages. Qualification is
14919 also applied to addresses in header lines such as &'From:'& and &'To:'& for
14920 locally-generated messages, unless the &%-bnq%& command line option is used.
14921
14922 Messages from external sources must always contain fully qualified addresses,
14923 unless the sending host matches &%sender_unqualified_hosts%& or
14924 &%recipient_unqualified_hosts%& (as appropriate), in which case incoming
14925 addresses are qualified with &%qualify_domain%& or &%qualify_recipient%& as
14926 necessary. Internally, Exim always works with fully qualified envelope
14927 addresses. If &%qualify_domain%& is not set, it defaults to the
14928 &%primary_hostname%& value.
14929
14930
14931 .option qualify_recipient main string "see below"
14932 This option allows you to specify a different domain for qualifying recipient
14933 addresses to the one that is used for senders. See &%qualify_domain%& above.
14934
14935
14936
14937 .option queue_domains main "domain list&!!" unset
14938 .cindex "domain" "specifying non-immediate delivery"
14939 .cindex "queueing incoming messages"
14940 .cindex "message" "queueing certain domains"
14941 This option lists domains for which immediate delivery is not required.
14942 A delivery process is started whenever a message is received, but only those
14943 domains that do not match are processed. All other deliveries wait until the
14944 next queue run. See also &%hold_domains%& and &%queue_smtp_domains%&.
14945
14946
14947 .option queue_list_requires_admin main boolean true
14948 .oindex "&%-bp%&"
14949 The &%-bp%& command-line option, which lists the messages that are on the
14950 queue, requires the caller to be an admin user unless
14951 &%queue_list_requires_admin%& is set false. See also &%prod_requires_admin%&.
14952
14953
14954 .option queue_only main boolean false
14955 .cindex "queueing incoming messages"
14956 .cindex "message" "queueing unconditionally"
14957 If &%queue_only%& is set, a delivery process is not automatically started
14958 whenever a message is received. Instead, the message waits on the queue for the
14959 next queue run. Even if &%queue_only%& is false, incoming messages may not get
14960 delivered immediately when certain conditions (such as heavy load) occur.
14961
14962 The &%-odq%& command line has the same effect as &%queue_only%&. The &%-odb%&
14963 and &%-odi%& command line options override &%queue_only%& unless
14964 &%queue_only_override%& is set false. See also &%queue_only_file%&,
14965 &%queue_only_load%&, and &%smtp_accept_queue%&.
14966
14967
14968 .option queue_only_file main string unset
14969 .cindex "queueing incoming messages"
14970 .cindex "message" "queueing by file existence"
14971 This option can be set to a colon-separated list of absolute path names, each
14972 one optionally preceded by &"smtp"&. When Exim is receiving a message,
14973 it tests for the existence of each listed path using a call to &[stat()]&. For
14974 each path that exists, the corresponding queueing option is set.
14975 For paths with no prefix, &%queue_only%& is set; for paths prefixed by
14976 &"smtp"&, &%queue_smtp_domains%& is set to match all domains. So, for example,
14977 .code
14978 queue_only_file = smtp/some/file
14979 .endd
14980 causes Exim to behave as if &%queue_smtp_domains%& were set to &"*"& whenever
14981 &_/some/file_& exists.
14982
14983
14984 .option queue_only_load main fixed-point unset
14985 .cindex "load average"
14986 .cindex "queueing incoming messages"
14987 .cindex "message" "queueing by load"
14988 If the system load average is higher than this value, incoming messages from
14989 all sources are queued, and no automatic deliveries are started. If this
14990 happens during local or remote SMTP input, all subsequent messages received on
14991 the same SMTP connection are queued by default, whatever happens to the load in
14992 the meantime, but this can be changed by setting &%queue_only_load_latch%&
14993 false.
14994
14995 Deliveries will subsequently be performed by queue runner processes. This
14996 option has no effect on ancient operating systems on which Exim cannot
14997 determine the load average. See also &%deliver_queue_load_max%& and
14998 &%smtp_load_reserve%&.
14999
15000
15001 .option queue_only_load_latch main boolean true
15002 .cindex "load average" "re-evaluating per message"
15003 When this option is true (the default), once one message has been queued
15004 because the load average is higher than the value set by &%queue_only_load%&,
15005 all subsequent messages received on the same SMTP connection are also queued.
15006 This is a deliberate choice; even though the load average may fall below the
15007 threshold, it doesn't seem right to deliver later messages on the same
15008 connection when not delivering earlier ones. However, there are special
15009 circumstances such as very long-lived connections from scanning appliances
15010 where this is not the best strategy. In such cases, &%queue_only_load_latch%&
15011 should be set false. This causes the value of the load average to be
15012 re-evaluated for each message.
15013
15014
15015 .option queue_only_override main boolean true
15016 .cindex "queueing incoming messages"
15017 When this option is true, the &%-od%&&'x'& command line options override the
15018 setting of &%queue_only%& or &%queue_only_file%& in the configuration file. If
15019 &%queue_only_override%& is set false, the &%-od%&&'x'& options cannot be used
15020 to override; they are accepted, but ignored.
15021
15022
15023 .option queue_run_in_order main boolean false
15024 .cindex "queue runner" "processing messages in order"
15025 If this option is set, queue runs happen in order of message arrival instead of
15026 in an arbitrary order. For this to happen, a complete list of the entire queue
15027 must be set up before the deliveries start. When the queue is all held in a
15028 single directory (the default), a single list is created for both the ordered
15029 and the non-ordered cases. However, if &%split_spool_directory%& is set, a
15030 single list is not created when &%queue_run_in_order%& is false. In this case,
15031 the sub-directories are processed one at a time (in a random order), and this
15032 avoids setting up one huge list for the whole queue. Thus, setting
15033 &%queue_run_in_order%& with &%split_spool_directory%& may degrade performance
15034 when the queue is large, because of the extra work in setting up the single,
15035 large list. In most situations, &%queue_run_in_order%& should not be set.
15036
15037
15038
15039 .option queue_run_max main integer 5
15040 .cindex "queue runner" "maximum number of"
15041 This controls the maximum number of queue runner processes that an Exim daemon
15042 can run simultaneously. This does not mean that it starts them all at once,
15043 but rather that if the maximum number are still running when the time comes to
15044 start another one, it refrains from starting another one. This can happen with
15045 very large queues and/or very sluggish deliveries. This option does not,
15046 however, interlock with other processes, so additional queue runners can be
15047 started by other means, or by killing and restarting the daemon.
15048
15049 Setting this option to zero does not suppress queue runs; rather, it disables
15050 the limit, allowing any number of simultaneous queue runner processes to be
15051 run. If you do not want queue runs to occur, omit the &%-q%&&'xx'& setting on
15052 the daemon's command line.
15053
15054 .option queue_smtp_domains main "domain list&!!" unset
15055 .cindex "queueing incoming messages"
15056 .cindex "message" "queueing remote deliveries"
15057 When this option is set, a delivery process is started whenever a message is
15058 received, routing is performed, and local deliveries take place.
15059 However, if any SMTP deliveries are required for domains that match
15060 &%queue_smtp_domains%&, they are not immediately delivered, but instead the
15061 message waits on the queue for the next queue run. Since routing of the message
15062 has taken place, Exim knows to which remote hosts it must be delivered, and so
15063 when the queue run happens, multiple messages for the same host are delivered
15064 over a single SMTP connection. The &%-odqs%& command line option causes all
15065 SMTP deliveries to be queued in this way, and is equivalent to setting
15066 &%queue_smtp_domains%& to &"*"&. See also &%hold_domains%& and
15067 &%queue_domains%&.
15068
15069
15070 .option receive_timeout main time 0s
15071 .cindex "timeout" "for non-SMTP input"
15072 This option sets the timeout for accepting a non-SMTP message, that is, the
15073 maximum time that Exim waits when reading a message on the standard input. If
15074 the value is zero, it will wait for ever. This setting is overridden by the
15075 &%-or%& command line option. The timeout for incoming SMTP messages is
15076 controlled by &%smtp_receive_timeout%&.
15077
15078 .option received_header_text main string&!! "see below"
15079 .cindex "customizing" "&'Received:'& header"
15080 .cindex "&'Received:'& header line" "customizing"
15081 This string defines the contents of the &'Received:'& message header that is
15082 added to each message, except for the timestamp, which is automatically added
15083 on at the end (preceded by a semicolon). The string is expanded each time it is
15084 used. If the expansion yields an empty string, no &'Received:'& header line is
15085 added to the message. Otherwise, the string should start with the text
15086 &"Received:"& and conform to the RFC 2822 specification for &'Received:'&
15087 header lines. The default setting is:
15088
15089 .code
15090 received_header_text = Received: \
15091   ${if def:sender_rcvhost {from $sender_rcvhost\n\t}\
15092   {${if def:sender_ident \
15093   {from ${quote_local_part:$sender_ident} }}\
15094   ${if def:sender_helo_name {(helo=$sender_helo_name)\n\t}}}}\
15095   by $primary_hostname \
15096   ${if def:received_protocol {with $received_protocol}} \
15097   ${if def:tls_in_cipher {($tls_in_cipher)\n\t}}\
15098   (Exim $version_number)\n\t\
15099   ${if def:sender_address \
15100   {(envelope-from <$sender_address>)\n\t}}\
15101   id $message_exim_id\
15102   ${if def:received_for {\n\tfor $received_for}}
15103 .endd
15104
15105 The reference to the TLS cipher is omitted when Exim is built without TLS
15106 support. The use of conditional expansions ensures that this works for both
15107 locally generated messages and messages received from remote hosts, giving
15108 header lines such as the following:
15109 .code
15110 Received: from scrooge.carol.example ([192.168.12.25] ident=root)
15111 by marley.carol.example with esmtp (Exim 4.00)
15112 (envelope-from <bob@carol.example>)
15113 id 16IOWa-00019l-00
15114 for chas@dickens.example; Tue, 25 Dec 2001 14:43:44 +0000
15115 Received: by scrooge.carol.example with local (Exim 4.00)
15116 id 16IOWW-000083-00; Tue, 25 Dec 2001 14:43:41 +0000
15117 .endd
15118 Until the body of the message has been received, the timestamp is the time when
15119 the message started to be received. Once the body has arrived, and all policy
15120 checks have taken place, the timestamp is updated to the time at which the
15121 message was accepted.
15122
15123
15124 .option received_headers_max main integer 30
15125 .cindex "loop" "prevention"
15126 .cindex "mail loop prevention"
15127 .cindex "&'Received:'& header line" "counting"
15128 When a message is to be delivered, the number of &'Received:'& headers is
15129 counted, and if it is greater than this parameter, a mail loop is assumed to
15130 have occurred, the delivery is abandoned, and an error message is generated.
15131 This applies to both local and remote deliveries.
15132
15133
15134 .option recipient_unqualified_hosts main "host list&!!" unset
15135 .cindex "unqualified addresses"
15136 .cindex "host" "unqualified addresses from"
15137 This option lists those hosts from which Exim is prepared to accept unqualified
15138 recipient addresses in message envelopes. The addresses are made fully
15139 qualified by the addition of the &%qualify_recipient%& value. This option also
15140 affects message header lines. Exim does not reject unqualified recipient
15141 addresses in headers, but it qualifies them only if the message came from a
15142 host that matches &%recipient_unqualified_hosts%&,
15143 or if the message was submitted locally (not using TCP/IP), and the &%-bnq%&
15144 option was not set.
15145
15146
15147 .option recipients_max main integer 0
15148 .cindex "limit" "number of recipients"
15149 .cindex "recipient" "maximum number"
15150 If this option is set greater than zero, it specifies the maximum number of
15151 original recipients for any message. Additional recipients that are generated
15152 by aliasing or forwarding do not count. SMTP messages get a 452 response for
15153 all recipients over the limit; earlier recipients are delivered as normal.
15154 Non-SMTP messages with too many recipients are failed, and no deliveries are
15155 done.
15156
15157 .cindex "RCPT" "maximum number of incoming"
15158 &*Note*&: The RFCs specify that an SMTP server should accept at least 100
15159 RCPT commands in a single message.
15160
15161
15162 .option recipients_max_reject main boolean false
15163 If this option is set true, Exim rejects SMTP messages containing too many
15164 recipients by giving 552 errors to the surplus RCPT commands, and a 554
15165 error to the eventual DATA command. Otherwise (the default) it gives a 452
15166 error to the surplus RCPT commands and accepts the message on behalf of the
15167 initial set of recipients. The remote server should then re-send the message
15168 for the remaining recipients at a later time.
15169
15170
15171 .option remote_max_parallel main integer 2
15172 .cindex "delivery" "parallelism for remote"
15173 This option controls parallel delivery of one message to a number of remote
15174 hosts. If the value is less than 2, parallel delivery is disabled, and Exim
15175 does all the remote deliveries for a message one by one. Otherwise, if a single
15176 message has to be delivered to more than one remote host, or if several copies
15177 have to be sent to the same remote host, up to &%remote_max_parallel%&
15178 deliveries are done simultaneously. If more than &%remote_max_parallel%&
15179 deliveries are required, the maximum number of processes are started, and as
15180 each one finishes, another is begun. The order of starting processes is the
15181 same as if sequential delivery were being done, and can be controlled by the
15182 &%remote_sort_domains%& option. If parallel delivery takes place while running
15183 with debugging turned on, the debugging output from each delivery process is
15184 tagged with its process id.
15185
15186 This option controls only the maximum number of parallel deliveries for one
15187 message in one Exim delivery process. Because Exim has no central queue
15188 manager, there is no way of controlling the total number of simultaneous
15189 deliveries if the configuration allows a delivery attempt as soon as a message
15190 is received.
15191
15192 .cindex "number of deliveries"
15193 .cindex "delivery" "maximum number of"
15194 If you want to control the total number of deliveries on the system, you
15195 need to set the &%queue_only%& option. This ensures that all incoming messages
15196 are added to the queue without starting a delivery process. Then set up an Exim
15197 daemon to start queue runner processes at appropriate intervals (probably
15198 fairly often, for example, every minute), and limit the total number of queue
15199 runners by setting the &%queue_run_max%& parameter. Because each queue runner
15200 delivers only one message at a time, the maximum number of deliveries that can
15201 then take place at once is &%queue_run_max%& multiplied by
15202 &%remote_max_parallel%&.
15203
15204 If it is purely remote deliveries you want to control, use
15205 &%queue_smtp_domains%& instead of &%queue_only%&. This has the added benefit of
15206 doing the SMTP routing before queueing, so that several messages for the same
15207 host will eventually get delivered down the same connection.
15208
15209
15210 .option remote_sort_domains main "domain list&!!" unset
15211 .cindex "sorting remote deliveries"
15212 .cindex "delivery" "sorting remote"
15213 When there are a number of remote deliveries for a message, they are sorted by
15214 domain into the order given by this list. For example,
15215 .code
15216 remote_sort_domains = *.cam.ac.uk:*.uk
15217 .endd
15218 would attempt to deliver to all addresses in the &'cam.ac.uk'& domain first,
15219 then to those in the &%uk%& domain, then to any others.
15220
15221
15222 .option retry_data_expire main time 7d
15223 .cindex "hints database" "data expiry"
15224 This option sets a &"use before"& time on retry information in Exim's hints
15225 database. Any older retry data is ignored. This means that, for example, once a
15226 host has not been tried for 7 days, Exim behaves as if it has no knowledge of
15227 past failures.
15228
15229
15230 .option retry_interval_max main time 24h
15231 .cindex "retry" "limit on interval"
15232 .cindex "limit" "on retry interval"
15233 Chapter &<<CHAPretry>>& describes Exim's mechanisms for controlling the
15234 intervals between delivery attempts for messages that cannot be delivered
15235 straight away. This option sets an overall limit to the length of time between
15236 retries. It cannot be set greater than 24 hours; any attempt to do so forces
15237 the default value.
15238
15239
15240 .option return_path_remove main boolean true
15241 .cindex "&'Return-path:'& header line" "removing"
15242 RFC 2821, section 4.4, states that an SMTP server must insert a
15243 &'Return-path:'& header line into a message when it makes a &"final delivery"&.
15244 The &'Return-path:'& header preserves the sender address as received in the
15245 MAIL command. This description implies that this header should not be present
15246 in an incoming message. If &%return_path_remove%& is true, any existing
15247 &'Return-path:'& headers are removed from messages at the time they are
15248 received. Exim's transports have options for adding &'Return-path:'& headers at
15249 the time of delivery. They are normally used only for final local deliveries.
15250
15251
15252 .option return_size_limit main integer 100K
15253 This option is an obsolete synonym for &%bounce_return_size_limit%&.
15254
15255
15256 .option rfc1413_hosts main "host list&!!" *
15257 .cindex "RFC 1413"
15258 .cindex "host" "for RFC 1413 calls"
15259 RFC 1413 identification calls are made to any client host which matches an item
15260 in the list.
15261
15262 .option rfc1413_query_timeout main time 5s
15263 .cindex "RFC 1413" "query timeout"
15264 .cindex "timeout" "for RFC 1413 call"
15265 This sets the timeout on RFC 1413 identification calls. If it is set to zero,
15266 no RFC 1413 calls are ever made.
15267
15268
15269 .option sender_unqualified_hosts main "host list&!!" unset
15270 .cindex "unqualified addresses"
15271 .cindex "host" "unqualified addresses from"
15272 This option lists those hosts from which Exim is prepared to accept unqualified
15273 sender addresses. The addresses are made fully qualified by the addition of
15274 &%qualify_domain%&. This option also affects message header lines. Exim does
15275 not reject unqualified addresses in headers that contain sender addresses, but
15276 it qualifies them only if the message came from a host that matches
15277 &%sender_unqualified_hosts%&, or if the message was submitted locally (not
15278 using TCP/IP), and the &%-bnq%& option was not set.
15279
15280
15281 .option smtp_accept_keepalive main boolean true
15282 .cindex "keepalive" "on incoming connection"
15283 This option controls the setting of the SO_KEEPALIVE option on incoming
15284 TCP/IP socket connections. When set, it causes the kernel to probe idle
15285 connections periodically, by sending packets with &"old"& sequence numbers. The
15286 other end of the connection should send an acknowledgment if the connection is
15287 still okay or a reset if the connection has been aborted. The reason for doing
15288 this is that it has the beneficial effect of freeing up certain types of
15289 connection that can get stuck when the remote host is disconnected without
15290 tidying up the TCP/IP call properly. The keepalive mechanism takes several
15291 hours to detect unreachable hosts.
15292
15293
15294
15295 .option smtp_accept_max main integer 20
15296 .cindex "limit" "incoming SMTP connections"
15297 .cindex "SMTP" "incoming connection count"
15298 .cindex "inetd"
15299 This option specifies the maximum number of simultaneous incoming SMTP calls
15300 that Exim will accept. It applies only to the listening daemon; there is no
15301 control (in Exim) when incoming SMTP is being handled by &'inetd'&. If the
15302 value is set to zero, no limit is applied. However, it is required to be
15303 non-zero if either &%smtp_accept_max_per_host%& or &%smtp_accept_queue%& is
15304 set. See also &%smtp_accept_reserve%& and &%smtp_load_reserve%&.
15305
15306 A new SMTP connection is immediately rejected if the &%smtp_accept_max%& limit
15307 has been reached. If not, Exim first checks &%smtp_accept_max_per_host%&. If
15308 that limit has not been reached for the client host, &%smtp_accept_reserve%&
15309 and &%smtp_load_reserve%& are then checked before accepting the connection.
15310
15311
15312 .option smtp_accept_max_nonmail main integer 10
15313 .cindex "limit" "non-mail SMTP commands"
15314 .cindex "SMTP" "limiting non-mail commands"
15315 Exim counts the number of &"non-mail"& commands in an SMTP session, and drops
15316 the connection if there are too many. This option defines &"too many"&. The
15317 check catches some denial-of-service attacks, repeated failing AUTHs, or a mad
15318 client looping sending EHLO, for example. The check is applied only if the
15319 client host matches &%smtp_accept_max_nonmail_hosts%&.
15320
15321 When a new message is expected, one occurrence of RSET is not counted. This
15322 allows a client to send one RSET between messages (this is not necessary,
15323 but some clients do it). Exim also allows one uncounted occurrence of HELO
15324 or EHLO, and one occurrence of STARTTLS between messages. After
15325 starting up a TLS session, another EHLO is expected, and so it too is not
15326 counted. The first occurrence of AUTH in a connection, or immediately
15327 following STARTTLS is not counted. Otherwise, all commands other than
15328 MAIL, RCPT, DATA, and QUIT are counted.
15329
15330
15331 .option smtp_accept_max_nonmail_hosts main "host list&!!" *
15332 You can control which hosts are subject to the &%smtp_accept_max_nonmail%&
15333 check by setting this option. The default value makes it apply to all hosts. By
15334 changing the value, you can exclude any badly-behaved hosts that you have to
15335 live with.
15336
15337
15338 . Allow this long option name to split; give it unsplit as a fifth argument
15339 . for the automatic .oindex that is generated by .option.
15340
15341 .option "smtp_accept_max_per_connection" main integer 1000 &&&
15342          smtp_accept_max_per_connection
15343 .cindex "SMTP" "limiting incoming message count"
15344 .cindex "limit" "messages per SMTP connection"
15345 The value of this option limits the number of MAIL commands that Exim is
15346 prepared to accept over a single SMTP connection, whether or not each command
15347 results in the transfer of a message. After the limit is reached, a 421
15348 response is given to subsequent MAIL commands. This limit is a safety
15349 precaution against a client that goes mad (incidents of this type have been
15350 seen).
15351
15352
15353 .option smtp_accept_max_per_host main string&!! unset
15354 .cindex "limit" "SMTP connections from one host"
15355 .cindex "host" "limiting SMTP connections from"
15356 This option restricts the number of simultaneous IP connections from a single
15357 host (strictly, from a single IP address) to the Exim daemon. The option is
15358 expanded, to enable different limits to be applied to different hosts by
15359 reference to &$sender_host_address$&. Once the limit is reached, additional
15360 connection attempts from the same host are rejected with error code 421. This
15361 is entirely independent of &%smtp_accept_reserve%&. The option's default value
15362 of zero imposes no limit. If this option is set greater than zero, it is
15363 required that &%smtp_accept_max%& be non-zero.
15364
15365 &*Warning*&: When setting this option you should not use any expansion
15366 constructions that take an appreciable amount of time. The expansion and test
15367 happen in the main daemon loop, in order to reject additional connections
15368 without forking additional processes (otherwise a denial-of-service attack
15369 could cause a vast number or processes to be created). While the daemon is
15370 doing this processing, it cannot accept any other incoming connections.
15371
15372
15373
15374 .option smtp_accept_queue main integer 0
15375 .cindex "SMTP" "incoming connection count"
15376 .cindex "queueing incoming messages"
15377 .cindex "message" "queueing by SMTP connection count"
15378 If the number of simultaneous incoming SMTP connections being handled via the
15379 listening daemon exceeds this value, messages received by SMTP are just placed
15380 on the queue; no delivery processes are started automatically. The count is
15381 fixed at the start of an SMTP connection. It cannot be updated in the
15382 subprocess that receives messages, and so the queueing or not queueing applies
15383 to all messages received in the same connection.
15384
15385 A value of zero implies no limit, and clearly any non-zero value is useful only
15386 if it is less than the &%smtp_accept_max%& value (unless that is zero). See
15387 also &%queue_only%&, &%queue_only_load%&, &%queue_smtp_domains%&, and the
15388 various &%-od%&&'x'& command line options.
15389
15390
15391 . Allow this long option name to split; give it unsplit as a fifth argument
15392 . for the automatic .oindex that is generated by .option.
15393
15394 .option "smtp_accept_queue_per_ &~&~connection" main integer 10 &&&
15395          smtp_accept_queue_per_connection
15396 .cindex "queueing incoming messages"
15397 .cindex "message" "queueing by message count"
15398 This option limits the number of delivery processes that Exim starts
15399 automatically when receiving messages via SMTP, whether via the daemon or by
15400 the use of &%-bs%& or &%-bS%&. If the value of the option is greater than zero,
15401 and the number of messages received in a single SMTP session exceeds this
15402 number, subsequent messages are placed on the queue, but no delivery processes
15403 are started. This helps to limit the number of Exim processes when a server
15404 restarts after downtime and there is a lot of mail waiting for it on other
15405 systems. On large systems, the default should probably be increased, and on
15406 dial-in client systems it should probably be set to zero (that is, disabled).
15407
15408
15409 .option smtp_accept_reserve main integer 0
15410 .cindex "SMTP" "incoming call count"
15411 .cindex "host" "reserved"
15412 When &%smtp_accept_max%& is set greater than zero, this option specifies a
15413 number of SMTP connections that are reserved for connections from the hosts
15414 that are specified in &%smtp_reserve_hosts%&. The value set in
15415 &%smtp_accept_max%& includes this reserve pool. The specified hosts are not
15416 restricted to this number of connections; the option specifies a minimum number
15417 of connection slots for them, not a maximum. It is a guarantee that this group
15418 of hosts can always get at least &%smtp_accept_reserve%& connections. However,
15419 the limit specified by &%smtp_accept_max_per_host%& is still applied to each
15420 individual host.
15421
15422 For example, if &%smtp_accept_max%& is set to 50 and &%smtp_accept_reserve%& is
15423 set to 5, once there are 45 active connections (from any hosts), new
15424 connections are accepted only from hosts listed in &%smtp_reserve_hosts%&,
15425 provided the other criteria for acceptance are met.
15426
15427
15428 .option smtp_active_hostname main string&!! unset
15429 .cindex "host" "name in SMTP responses"
15430 .cindex "SMTP" "host name in responses"
15431 .vindex "&$primary_hostname$&"
15432 This option is provided for multi-homed servers that want to masquerade as
15433 several different hosts. At the start of an incoming SMTP connection, its value
15434 is expanded and used instead of the value of &$primary_hostname$& in SMTP
15435 responses. For example, it is used as domain name in the response to an
15436 incoming HELO or EHLO command.
15437
15438 .vindex "&$smtp_active_hostname$&"
15439 The active hostname is placed in the &$smtp_active_hostname$& variable, which
15440 is saved with any messages that are received. It is therefore available for use
15441 in routers and transports when the message is later delivered.
15442
15443 If this option is unset, or if its expansion is forced to fail, or if the
15444 expansion results in an empty string, the value of &$primary_hostname$& is
15445 used. Other expansion failures cause a message to be written to the main and
15446 panic logs, and the SMTP command receives a temporary error. Typically, the
15447 value of &%smtp_active_hostname%& depends on the incoming interface address.
15448 For example:
15449 .code
15450 smtp_active_hostname = ${if eq{$received_ip_address}{10.0.0.1}\
15451   {cox.mydomain}{box.mydomain}}
15452 .endd
15453
15454 Although &$smtp_active_hostname$& is primarily concerned with incoming
15455 messages, it is also used as the default for HELO commands in callout
15456 verification if there is no remote transport from which to obtain a
15457 &%helo_data%& value.
15458
15459 .option smtp_banner main string&!! "see below"
15460 .cindex "SMTP" "welcome banner"
15461 .cindex "banner for SMTP"
15462 .cindex "welcome banner for SMTP"
15463 .cindex "customizing" "SMTP banner"
15464 This string, which is expanded every time it is used, is output as the initial
15465 positive response to an SMTP connection. The default setting is:
15466 .code
15467 smtp_banner = $smtp_active_hostname ESMTP Exim \
15468   $version_number $tod_full
15469 .endd
15470 Failure to expand the string causes a panic error. If you want to create a
15471 multiline response to the initial SMTP connection, use &"\n"& in the string at
15472 appropriate points, but not at the end. Note that the 220 code is not included
15473 in this string. Exim adds it automatically (several times in the case of a
15474 multiline response).
15475
15476
15477 .option smtp_check_spool_space main boolean true
15478 .cindex "checking disk space"
15479 .cindex "disk space, checking"
15480 .cindex "spool directory" "checking space"
15481 When this option is set, if an incoming SMTP session encounters the SIZE
15482 option on a MAIL command, it checks that there is enough space in the
15483 spool directory's partition to accept a message of that size, while still
15484 leaving free the amount specified by &%check_spool_space%& (even if that value
15485 is zero). If there isn't enough space, a temporary error code is returned.
15486
15487
15488 .option smtp_connect_backlog main integer 20
15489 .cindex "connection backlog"
15490 .cindex "SMTP" "connection backlog"
15491 .cindex "backlog of connections"
15492 This option specifies a maximum number of waiting SMTP connections. Exim passes
15493 this value to the TCP/IP system when it sets up its listener. Once this number
15494 of connections are waiting for the daemon's attention, subsequent connection
15495 attempts are refused at the TCP/IP level. At least, that is what the manuals
15496 say; in some circumstances such connection attempts have been observed to time
15497 out instead. For large systems it is probably a good idea to increase the
15498 value (to 50, say). It also gives some protection against denial-of-service
15499 attacks by SYN flooding.
15500
15501
15502 .option smtp_enforce_sync main boolean true
15503 .cindex "SMTP" "synchronization checking"
15504 .cindex "synchronization checking in SMTP"
15505 The SMTP protocol specification requires the client to wait for a response from
15506 the server at certain points in the dialogue. Without PIPELINING these
15507 synchronization points are after every command; with PIPELINING they are
15508 fewer, but they still exist.
15509
15510 Some spamming sites send out a complete set of SMTP commands without waiting
15511 for any response. Exim protects against this by rejecting a message if the
15512 client has sent further input when it should not have. The error response &"554
15513 SMTP synchronization error"& is sent, and the connection is dropped. Testing
15514 for this error cannot be perfect because of transmission delays (unexpected
15515 input may be on its way but not yet received when Exim checks). However, it
15516 does detect many instances.
15517
15518 The check can be globally disabled by setting &%smtp_enforce_sync%& false.
15519 If you want to disable the check selectively (for example, only for certain
15520 hosts), you can do so by an appropriate use of a &%control%& modifier in an ACL
15521 (see section &<<SECTcontrols>>&). See also &%pipelining_advertise_hosts%&.
15522
15523
15524
15525 .option smtp_etrn_command main string&!! unset
15526 .cindex "ETRN" "command to be run"
15527 .vindex "&$domain$&"
15528 If this option is set, the given command is run whenever an SMTP ETRN
15529 command is received from a host that is permitted to issue such commands (see
15530 chapter &<<CHAPACL>>&). The string is split up into separate arguments which
15531 are independently expanded. The expansion variable &$domain$& is set to the
15532 argument of the ETRN command, and no syntax checking is done on it. For
15533 example:
15534 .code
15535 smtp_etrn_command = /etc/etrn_command $domain \
15536                     $sender_host_address
15537 .endd
15538 A new process is created to run the command, but Exim does not wait for it to
15539 complete. Consequently, its status cannot be checked. If the command cannot be
15540 run, a line is written to the panic log, but the ETRN caller still receives
15541 a 250 success response. Exim is normally running under its own uid when
15542 receiving SMTP, so it is not possible for it to change the uid before running
15543 the command.
15544
15545
15546 .option smtp_etrn_serialize main boolean true
15547 .cindex "ETRN" "serializing"
15548 When this option is set, it prevents the simultaneous execution of more than
15549 one identical command as a result of ETRN in an SMTP connection. See
15550 section &<<SECTETRN>>& for details.
15551
15552
15553 .option smtp_load_reserve main fixed-point unset
15554 .cindex "load average"
15555 If the system load average ever gets higher than this, incoming SMTP calls are
15556 accepted only from those hosts that match an entry in &%smtp_reserve_hosts%&.
15557 If &%smtp_reserve_hosts%& is not set, no incoming SMTP calls are accepted when
15558 the load is over the limit. The option has no effect on ancient operating
15559 systems on which Exim cannot determine the load average. See also
15560 &%deliver_queue_load_max%& and &%queue_only_load%&.
15561
15562
15563
15564 .option smtp_max_synprot_errors main integer 3
15565 .cindex "SMTP" "limiting syntax and protocol errors"
15566 .cindex "limit" "SMTP syntax and protocol errors"
15567 Exim rejects SMTP commands that contain syntax or protocol errors. In
15568 particular, a syntactically invalid email address, as in this command:
15569 .code
15570 RCPT TO:<abc xyz@a.b.c>
15571 .endd
15572 causes immediate rejection of the command, before any other tests are done.
15573 (The ACL cannot be run if there is no valid address to set up for it.) An
15574 example of a protocol error is receiving RCPT before MAIL. If there are
15575 too many syntax or protocol errors in one SMTP session, the connection is
15576 dropped. The limit is set by this option.
15577
15578 .cindex "PIPELINING" "expected errors"
15579 When the PIPELINING extension to SMTP is in use, some protocol errors are
15580 &"expected"&, for instance, a RCPT command after a rejected MAIL command.
15581 Exim assumes that PIPELINING will be used if it advertises it (see
15582 &%pipelining_advertise_hosts%&), and in this situation, &"expected"& errors do
15583 not count towards the limit.
15584
15585
15586
15587 .option smtp_max_unknown_commands main integer 3
15588 .cindex "SMTP" "limiting unknown commands"
15589 .cindex "limit" "unknown SMTP commands"
15590 If there are too many unrecognized commands in an incoming SMTP session, an
15591 Exim server drops the connection. This is a defence against some kinds of abuse
15592 that subvert web
15593 clients
15594 into making connections to SMTP ports; in these circumstances, a number of
15595 non-SMTP command lines are sent first.
15596
15597
15598
15599 .option smtp_ratelimit_hosts main "host list&!!" unset
15600 .cindex "SMTP" "rate limiting"
15601 .cindex "limit" "rate of message arrival"
15602 .cindex "RCPT" "rate limiting"
15603 Some sites find it helpful to be able to limit the rate at which certain hosts
15604 can send them messages, and the rate at which an individual message can specify
15605 recipients.
15606
15607 Exim has two rate-limiting facilities. This section describes the older
15608 facility, which can limit rates within a single connection. The newer
15609 &%ratelimit%& ACL condition can limit rates across all connections. See section
15610 &<<SECTratelimiting>>& for details of the newer facility.
15611
15612 When a host matches &%smtp_ratelimit_hosts%&, the values of
15613 &%smtp_ratelimit_mail%& and &%smtp_ratelimit_rcpt%& are used to control the
15614 rate of acceptance of MAIL and RCPT commands in a single SMTP session,
15615 respectively. Each option, if set, must contain a set of four comma-separated
15616 values:
15617
15618 .ilist
15619 A threshold, before which there is no rate limiting.
15620 .next
15621 An initial time delay. Unlike other times in Exim, numbers with decimal
15622 fractional parts are allowed here.
15623 .next
15624 A factor by which to increase the delay each time.
15625 .next
15626 A maximum value for the delay. This should normally be less than 5 minutes,
15627 because after that time, the client is liable to timeout the SMTP command.
15628 .endlist
15629
15630 For example, these settings have been used successfully at the site which
15631 first suggested this feature, for controlling mail from their customers:
15632 .code
15633 smtp_ratelimit_mail = 2,0.5s,1.05,4m
15634 smtp_ratelimit_rcpt = 4,0.25s,1.015,4m
15635 .endd
15636 The first setting specifies delays that are applied to MAIL commands after
15637 two have been received over a single connection. The initial delay is 0.5
15638 seconds, increasing by a factor of 1.05 each time. The second setting applies
15639 delays to RCPT commands when more than four occur in a single message.
15640
15641
15642 .option smtp_ratelimit_mail main string unset
15643 See &%smtp_ratelimit_hosts%& above.
15644
15645
15646 .option smtp_ratelimit_rcpt main string unset
15647 See &%smtp_ratelimit_hosts%& above.
15648
15649
15650 .option smtp_receive_timeout main time 5m
15651 .cindex "timeout" "for SMTP input"
15652 .cindex "SMTP" "input timeout"
15653 This sets a timeout value for SMTP reception. It applies to all forms of SMTP
15654 input, including batch SMTP. If a line of input (either an SMTP command or a
15655 data line) is not received within this time, the SMTP connection is dropped and
15656 the message is abandoned.
15657 A line is written to the log containing one of the following messages:
15658 .code
15659 SMTP command timeout on connection from...
15660 SMTP data timeout on connection from...
15661 .endd
15662 The former means that Exim was expecting to read an SMTP command; the latter
15663 means that it was in the DATA phase, reading the contents of a message.
15664
15665
15666 .oindex "&%-os%&"
15667 The value set by this option can be overridden by the
15668 &%-os%& command-line option. A setting of zero time disables the timeout, but
15669 this should never be used for SMTP over TCP/IP. (It can be useful in some cases
15670 of local input using &%-bs%& or &%-bS%&.) For non-SMTP input, the reception
15671 timeout is controlled by &%receive_timeout%& and &%-or%&.
15672
15673
15674 .option smtp_reserve_hosts main "host list&!!" unset
15675 This option defines hosts for which SMTP connections are reserved; see
15676 &%smtp_accept_reserve%& and &%smtp_load_reserve%& above.
15677
15678
15679 .option smtp_return_error_details main boolean false
15680 .cindex "SMTP" "details policy failures"
15681 .cindex "policy control" "rejection, returning details"
15682 In the default state, Exim uses bland messages such as
15683 &"Administrative prohibition"& when it rejects SMTP commands for policy
15684 reasons. Many sysadmins like this because it gives away little information
15685 to spammers. However, some other sysadmins who are applying strict checking
15686 policies want to give out much fuller information about failures. Setting
15687 &%smtp_return_error_details%& true causes Exim to be more forthcoming. For
15688 example, instead of &"Administrative prohibition"&, it might give:
15689 .code
15690 550-Rejected after DATA: '>' missing at end of address:
15691 550 failing address in "From" header is: <user@dom.ain
15692 .endd
15693
15694 .option spamd_address main string "see below"
15695 This option is available when Exim is compiled with the content-scanning
15696 extension. It specifies how Exim connects to SpamAssassin's &%spamd%& daemon.
15697 The default value is
15698 .code
15699 127.0.0.1 783
15700 .endd
15701 See section &<<SECTscanspamass>>& for more details.
15702
15703
15704
15705 .option split_spool_directory main boolean false
15706 .cindex "multiple spool directories"
15707 .cindex "spool directory" "split"
15708 .cindex "directories, multiple"
15709 If this option is set, it causes Exim to split its input directory into 62
15710 subdirectories, each with a single alphanumeric character as its name. The
15711 sixth character of the message id is used to allocate messages to
15712 subdirectories; this is the least significant base-62 digit of the time of
15713 arrival of the message.
15714
15715 Splitting up the spool in this way may provide better performance on systems
15716 where there are long mail queues, by reducing the number of files in any one
15717 directory. The msglog directory is also split up in a similar way to the input
15718 directory; however, if &%preserve_message_logs%& is set, all old msglog files
15719 are still placed in the single directory &_msglog.OLD_&.
15720
15721 It is not necessary to take any special action for existing messages when
15722 changing &%split_spool_directory%&. Exim notices messages that are in the
15723 &"wrong"& place, and continues to process them. If the option is turned off
15724 after a period of being on, the subdirectories will eventually empty and be
15725 automatically deleted.
15726
15727 When &%split_spool_directory%& is set, the behaviour of queue runner processes
15728 changes. Instead of creating a list of all messages in the queue, and then
15729 trying to deliver each one in turn, it constructs a list of those in one
15730 sub-directory and tries to deliver them, before moving on to the next
15731 sub-directory. The sub-directories are processed in a random order. This
15732 spreads out the scanning of the input directories, and uses less memory. It is
15733 particularly beneficial when there are lots of messages on the queue. However,
15734 if &%queue_run_in_order%& is set, none of this new processing happens. The
15735 entire queue has to be scanned and sorted before any deliveries can start.
15736
15737
15738 .option spool_directory main string&!! "set at compile time"
15739 .cindex "spool directory" "path to"
15740 This defines the directory in which Exim keeps its spool, that is, the messages
15741 it is waiting to deliver. The default value is taken from the compile-time
15742 configuration setting, if there is one. If not, this option must be set. The
15743 string is expanded, so it can contain, for example, a reference to
15744 &$primary_hostname$&.
15745
15746 If the spool directory name is fixed on your installation, it is recommended
15747 that you set it at build time rather than from this option, particularly if the
15748 log files are being written to the spool directory (see &%log_file_path%&).
15749 Otherwise log files cannot be used for errors that are detected early on, such
15750 as failures in the configuration file.
15751
15752 By using this option to override the compiled-in path, it is possible to run
15753 tests of Exim without using the standard spool.
15754
15755 .option sqlite_lock_timeout main time 5s
15756 .cindex "sqlite lookup type" "lock timeout"
15757 This option controls the timeout that the &(sqlite)& lookup uses when trying to
15758 access an SQLite database. See section &<<SECTsqlite>>& for more details.
15759
15760 .option strict_acl_vars main boolean false
15761 .cindex "&ACL;" "variables, handling unset"
15762 This option controls what happens if a syntactically valid but undefined ACL
15763 variable is referenced. If it is false (the default), an empty string
15764 is substituted; if it is true, an error is generated. See section
15765 &<<SECTaclvariables>>& for details of ACL variables.
15766
15767 .option strip_excess_angle_brackets main boolean false
15768 .cindex "angle brackets, excess"
15769 If this option is set, redundant pairs of angle brackets round &"route-addr"&
15770 items in addresses are stripped. For example, &'<<xxx@a.b.c.d>>'& is
15771 treated as &'<xxx@a.b.c.d>'&. If this is in the envelope and the message is
15772 passed on to another MTA, the excess angle brackets are not passed on. If this
15773 option is not set, multiple pairs of angle brackets cause a syntax error.
15774
15775
15776 .option strip_trailing_dot main boolean false
15777 .cindex "trailing dot on domain"
15778 .cindex "dot" "trailing on domain"
15779 If this option is set, a trailing dot at the end of a domain in an address is
15780 ignored. If this is in the envelope and the message is passed on to another
15781 MTA, the dot is not passed on. If this option is not set, a dot at the end of a
15782 domain causes a syntax error.
15783 However, addresses in header lines are checked only when an ACL requests header
15784 syntax checking.
15785
15786
15787 .option syslog_duplication main boolean true
15788 .cindex "syslog" "duplicate log lines; suppressing"
15789 When Exim is logging to syslog, it writes the log lines for its three
15790 separate logs at different syslog priorities so that they can in principle
15791 be separated on the logging hosts. Some installations do not require this
15792 separation, and in those cases, the duplication of certain log lines is a
15793 nuisance. If &%syslog_duplication%& is set false, only one copy of any
15794 particular log line is written to syslog. For lines that normally go to
15795 both the main log and the reject log, the reject log version (possibly
15796 containing message header lines) is written, at LOG_NOTICE priority.
15797 Lines that normally go to both the main and the panic log are written at
15798 the LOG_ALERT priority.
15799
15800
15801 .option syslog_facility main string unset
15802 .cindex "syslog" "facility; setting"
15803 This option sets the syslog &"facility"& name, used when Exim is logging to
15804 syslog. The value must be one of the strings &"mail"&, &"user"&, &"news"&,
15805 &"uucp"&, &"daemon"&, or &"local&'x'&"& where &'x'& is a digit between 0 and 7.
15806 If this option is unset, &"mail"& is used. See chapter &<<CHAPlog>>& for
15807 details of Exim's logging.
15808
15809
15810
15811 .option syslog_processname main string &`exim`&
15812 .cindex "syslog" "process name; setting"
15813 This option sets the syslog &"ident"& name, used when Exim is logging to
15814 syslog. The value must be no longer than 32 characters. See chapter
15815 &<<CHAPlog>>& for details of Exim's logging.
15816
15817
15818
15819 .option syslog_timestamp main boolean true
15820 .cindex "syslog" "timestamps"
15821 If &%syslog_timestamp%& is set false, the timestamps on Exim's log lines are
15822 omitted when these lines are sent to syslog. See chapter &<<CHAPlog>>& for
15823 details of Exim's logging.
15824
15825
15826 .option system_filter main string&!! unset
15827 .cindex "filter" "system filter"
15828 .cindex "system filter" "specifying"
15829 .cindex "Sieve filter" "not available for system filter"
15830 This option specifies an Exim filter file that is applied to all messages at
15831 the start of each delivery attempt, before any routing is done. System filters
15832 must be Exim filters; they cannot be Sieve filters. If the system filter
15833 generates any deliveries to files or pipes, or any new mail messages, the
15834 appropriate &%system_filter_..._transport%& option(s) must be set, to define
15835 which transports are to be used. Details of this facility are given in chapter
15836 &<<CHAPsystemfilter>>&.
15837
15838
15839 .option system_filter_directory_transport main string&!! unset
15840 .vindex "&$address_file$&"
15841 This sets the name of the transport driver that is to be used when the
15842 &%save%& command in a system message filter specifies a path ending in &"/"&,
15843 implying delivery of each message into a separate file in some directory.
15844 During the delivery, the variable &$address_file$& contains the path name.
15845
15846
15847 .option system_filter_file_transport main string&!! unset
15848 .cindex "file" "transport for system filter"
15849 This sets the name of the transport driver that is to be used when the &%save%&
15850 command in a system message filter specifies a path not ending in &"/"&. During
15851 the delivery, the variable &$address_file$& contains the path name.
15852
15853 .option system_filter_group main string unset
15854 .cindex "gid (group id)" "system filter"
15855 This option is used only when &%system_filter_user%& is also set. It sets the
15856 gid under which the system filter is run, overriding any gid that is associated
15857 with the user. The value may be numerical or symbolic.
15858
15859 .option system_filter_pipe_transport main string&!! unset
15860 .cindex "&(pipe)& transport" "for system filter"
15861 .vindex "&$address_pipe$&"
15862 This specifies the transport driver that is to be used when a &%pipe%& command
15863 is used in a system filter. During the delivery, the variable &$address_pipe$&
15864 contains the pipe command.
15865
15866
15867 .option system_filter_reply_transport main string&!! unset
15868 .cindex "&(autoreply)& transport" "for system filter"
15869 This specifies the transport driver that is to be used when a &%mail%& command
15870 is used in a system filter.
15871
15872
15873 .option system_filter_user main string unset
15874 .cindex "uid (user id)" "system filter"
15875 If this option is set to root, the system filter is run in the main Exim
15876 delivery process, as root.  Otherwise, the system filter runs in a separate
15877 process, as the given user, defaulting to the Exim run-time user.
15878 Unless the string consists entirely of digits, it
15879 is looked up in the password data. Failure to find the named user causes a
15880 configuration error. The gid is either taken from the password data, or
15881 specified by &%system_filter_group%&. When the uid is specified numerically,
15882 &%system_filter_group%& is required to be set.
15883
15884 If the system filter generates any pipe, file, or reply deliveries, the uid
15885 under which the filter is run is used when transporting them, unless a
15886 transport option overrides.
15887
15888
15889 .option tcp_nodelay main boolean true
15890 .cindex "daemon" "TCP_NODELAY on sockets"
15891 .cindex "Nagle algorithm"
15892 .cindex "TCP_NODELAY on listening sockets"
15893 If this option is set false, it stops the Exim daemon setting the
15894 TCP_NODELAY option on its listening sockets. Setting TCP_NODELAY
15895 turns off the &"Nagle algorithm"&, which is a way of improving network
15896 performance in interactive (character-by-character) situations. Turning it off
15897 should improve Exim's performance a bit, so that is what happens by default.
15898 However, it appears that some broken clients cannot cope, and time out. Hence
15899 this option. It affects only those sockets that are set up for listening by the
15900 daemon. Sockets created by the smtp transport for delivering mail always set
15901 TCP_NODELAY.
15902
15903
15904 .option timeout_frozen_after main time 0s
15905 .cindex "frozen messages" "timing out"
15906 .cindex "timeout" "frozen messages"
15907 If &%timeout_frozen_after%& is set to a time greater than zero, a frozen
15908 message of any kind that has been on the queue for longer than the given time
15909 is automatically cancelled at the next queue run. If the frozen message is a
15910 bounce message, it is just discarded; otherwise, a bounce is sent to the
15911 sender, in a similar manner to cancellation by the &%-Mg%& command line option.
15912 If you want to timeout frozen bounce messages earlier than other kinds of
15913 frozen message, see &%ignore_bounce_errors_after%&.
15914
15915 &*Note:*& the default value of zero means no timeouts; with this setting,
15916 frozen messages remain on the queue forever (except for any frozen bounce
15917 messages that are released by &%ignore_bounce_errors_after%&).
15918
15919
15920 .option timezone main string unset
15921 .cindex "timezone, setting"
15922 The value of &%timezone%& is used to set the environment variable TZ while
15923 running Exim (if it is different on entry). This ensures that all timestamps
15924 created by Exim are in the required timezone. If you want all your timestamps
15925 to be in UTC (aka GMT) you should set
15926 .code
15927 timezone = UTC
15928 .endd
15929 The default value is taken from TIMEZONE_DEFAULT in &_Local/Makefile_&,
15930 or, if that is not set, from the value of the TZ environment variable when Exim
15931 is built. If &%timezone%& is set to the empty string, either at build or run
15932 time, any existing TZ variable is removed from the environment when Exim
15933 runs. This is appropriate behaviour for obtaining wall-clock time on some, but
15934 unfortunately not all, operating systems.
15935
15936
15937 .option tls_advertise_hosts main "host list&!!" unset
15938 .cindex "TLS" "advertising"
15939 .cindex "encryption" "on SMTP connection"
15940 .cindex "SMTP" "encrypted connection"
15941 When Exim is built with support for TLS encrypted connections, the availability
15942 of the STARTTLS command to set up an encrypted session is advertised in
15943 response to EHLO only to those client hosts that match this option. See
15944 chapter &<<CHAPTLS>>& for details of Exim's support for TLS.
15945
15946
15947 .option tls_certificate main string&!! unset
15948 .cindex "TLS" "server certificate; location of"
15949 .cindex "certificate" "server, location of"
15950 The value of this option is expanded, and must then be the absolute path to a
15951 file which contains the server's certificates. The server's private key is also
15952 assumed to be in this file if &%tls_privatekey%& is unset. See chapter
15953 &<<CHAPTLS>>& for further details.
15954
15955 &*Note*&: The certificates defined by this option are used only when Exim is
15956 receiving incoming messages as a server. If you want to supply certificates for
15957 use when sending messages as a client, you must set the &%tls_certificate%&
15958 option in the relevant &(smtp)& transport.
15959
15960 If the option contains &$tls_out_sni$& and Exim is built against OpenSSL, then
15961 if the OpenSSL build supports TLS extensions and the TLS client sends the
15962 Server Name Indication extension, then this option and others documented in
15963 &<<SECTtlssni>>& will be re-expanded.
15964
15965 .option tls_crl main string&!! unset
15966 .cindex "TLS" "server certificate revocation list"
15967 .cindex "certificate" "revocation list for server"
15968 This option specifies a certificate revocation list. The expanded value must
15969 be the name of a file that contains a CRL in PEM format.
15970
15971 See &<<SECTtlssni>>& for discussion of when this option might be re-expanded.
15972
15973
15974 .option tls_dh_max_bits main integer 2236
15975 .cindex "TLS" "D-H bit count"
15976 The number of bits used for Diffie-Hellman key-exchange may be suggested by
15977 the chosen TLS library.  That value might prove to be too high for
15978 interoperability.  This option provides a maximum clamp on the value
15979 suggested, trading off security for interoperability.
15980
15981 The value must be at least 1024.
15982
15983 The value 2236 was chosen because, at time of adding the option, it was the
15984 hard-coded maximum value supported by the NSS cryptographic library, as used
15985 by Thunderbird, while GnuTLS was suggesting 2432 bits as normal.
15986
15987 If you prefer more security and are willing to break some clients, raise this
15988 number.
15989
15990 Note that the value passed to GnuTLS for *generating* a new prime may be a
15991 little less than this figure, because GnuTLS is inexact and may produce a
15992 larger prime than requested.
15993
15994
15995 .option tls_dhparam main string&!! unset
15996 .cindex "TLS" "D-H parameters for server"
15997 The value of this option is expanded and indicates the source of DH parameters
15998 to be used by Exim.
15999
16000 If it is a filename starting with a &`/`&, then it names a file from which DH
16001 parameters should be loaded.  If the file exists, it should hold a PEM-encoded
16002 PKCS#3 representation of the DH prime.  If the file does not exist, for
16003 OpenSSL it is an error.  For GnuTLS, Exim will attempt to create the file and
16004 fill it with a generated DH prime.  For OpenSSL, if the DH bit-count from
16005 loading the file is greater than &%tls_dh_max_bits%& then it will be ignored,
16006 and treated as though the &%tls_dhparam%& were set to "none".
16007
16008 If this option expands to the string "none", then no DH parameters will be
16009 loaded by Exim.
16010
16011 If this option expands to the string "historic" and Exim is using GnuTLS, then
16012 Exim will attempt to load a file from inside the spool directory.  If the file
16013 does not exist, Exim will attempt to create it.
16014 See section &<<SECTgnutlsparam>>& for further details.
16015
16016 If Exim is using OpenSSL and this option is empty or unset, then Exim will load
16017 a default DH prime; the default is the 2048 bit prime described in section
16018 2.2 of RFC 5114, "2048-bit MODP Group with 224-bit Prime Order Subgroup", which
16019 in IKE is assigned number 23.
16020
16021 Otherwise, the option must expand to the name used by Exim for any of a number
16022 of DH primes specified in RFC 2409, RFC 3526 and RFC 5114.  As names, Exim uses
16023 "ike" followed by the number used by IKE, of "default" which corresponds to
16024 "ike23".
16025
16026 The available primes are:
16027 &`ike1`&, &`ike2`&, &`ike5`&,
16028 &`ike14`&, &`ike15`&, &`ike16`&, &`ike17`&, &`ike18`&,
16029 &`ike22`&, &`ike23`& (aka &`default`&) and &`ike24`&.
16030
16031 Some of these will be too small to be accepted by clients.
16032 Some may be too large to be accepted by clients.
16033
16034
16035 .option tls_on_connect_ports main "string list" unset
16036 This option specifies a list of incoming SSMTP (aka SMTPS) ports that should
16037 operate the obsolete SSMTP (SMTPS) protocol, where a TLS session is immediately
16038 set up without waiting for the client to issue a STARTTLS command. For
16039 further details, see section &<<SECTsupobssmt>>&.
16040
16041
16042
16043 .option tls_privatekey main string&!! unset
16044 .cindex "TLS" "server private key; location of"
16045 The value of this option is expanded, and must then be the absolute path to a
16046 file which contains the server's private key. If this option is unset, or if
16047 the expansion is forced to fail, or the result is an empty string, the private
16048 key is assumed to be in the same file as the server's certificates. See chapter
16049 &<<CHAPTLS>>& for further details.
16050
16051 See &<<SECTtlssni>>& for discussion of when this option might be re-expanded.
16052
16053
16054 .option tls_remember_esmtp main boolean false
16055 .cindex "TLS" "esmtp state; remembering"
16056 .cindex "TLS" "broken clients"
16057 If this option is set true, Exim violates the RFCs by remembering that it is in
16058 &"esmtp"& state after successfully negotiating a TLS session. This provides
16059 support for broken clients that fail to send a new EHLO after starting a
16060 TLS session.
16061
16062
16063 .option tls_require_ciphers main string&!! unset
16064 .cindex "TLS" "requiring specific ciphers"
16065 .cindex "cipher" "requiring specific"
16066 This option controls which ciphers can be used for incoming TLS connections.
16067 The &(smtp)& transport has an option of the same name for controlling outgoing
16068 connections. This option is expanded for each connection, so can be varied for
16069 different clients if required. The value of this option must be a list of
16070 permitted cipher suites. The OpenSSL and GnuTLS libraries handle cipher control
16071 in somewhat different ways. If GnuTLS is being used, the client controls the
16072 preference order of the available ciphers. Details are given in sections
16073 &<<SECTreqciphssl>>& and &<<SECTreqciphgnu>>&.
16074
16075
16076 .option tls_try_verify_hosts main "host list&!!" unset
16077 .cindex "TLS" "client certificate verification"
16078 .cindex "certificate" "verification of client"
16079 See &%tls_verify_hosts%& below.
16080
16081
16082 .option tls_verify_certificates main string&!! unset
16083 .cindex "TLS" "client certificate verification"
16084 .cindex "certificate" "verification of client"
16085 The value of this option is expanded, and must then be the absolute path to
16086 a file containing permitted certificates for clients that
16087 match &%tls_verify_hosts%& or &%tls_try_verify_hosts%&. Alternatively, if you
16088 are using OpenSSL, you can set &%tls_verify_certificates%& to the name of a
16089 directory containing certificate files. This does not work with GnuTLS; the
16090 option must be set to the name of a single file if you are using GnuTLS.
16091
16092 These certificates should be for the certificate authorities trusted, rather
16093 than the public cert of individual clients.  With both OpenSSL and GnuTLS, if
16094 the value is a file then the certificates are sent by Exim as a server to
16095 connecting clients, defining the list of accepted certificate authorities.
16096 Thus the values defined should be considered public data.  To avoid this,
16097 use OpenSSL with a directory.
16098
16099 See &<<SECTtlssni>>& for discussion of when this option might be re-expanded.
16100
16101 A forced expansion failure or setting to an empty string is equivalent to
16102 being unset.
16103
16104
16105 .option tls_verify_hosts main "host list&!!" unset
16106 .cindex "TLS" "client certificate verification"
16107 .cindex "certificate" "verification of client"
16108 This option, along with &%tls_try_verify_hosts%&, controls the checking of
16109 certificates from clients. The expected certificates are defined by
16110 &%tls_verify_certificates%&, which must be set. A configuration error occurs if
16111 either &%tls_verify_hosts%& or &%tls_try_verify_hosts%& is set and
16112 &%tls_verify_certificates%& is not set.
16113
16114 Any client that matches &%tls_verify_hosts%& is constrained by
16115 &%tls_verify_certificates%&. When the client initiates a TLS session, it must
16116 present one of the listed certificates. If it does not, the connection is
16117 aborted. &*Warning*&: Including a host in &%tls_verify_hosts%& does not require
16118 the host to use TLS. It can still send SMTP commands through unencrypted
16119 connections. Forcing a client to use TLS has to be done separately using an
16120 ACL to reject inappropriate commands when the connection is not encrypted.
16121
16122 A weaker form of checking is provided by &%tls_try_verify_hosts%&. If a client
16123 matches this option (but not &%tls_verify_hosts%&), Exim requests a
16124 certificate and checks it against &%tls_verify_certificates%&, but does not
16125 abort the connection if there is no certificate or if it does not match. This
16126 state can be detected in an ACL, which makes it possible to implement policies
16127 such as &"accept for relay only if a verified certificate has been received,
16128 but accept for local delivery if encrypted, even without a verified
16129 certificate"&.
16130
16131 Client hosts that match neither of these lists are not asked to present
16132 certificates.
16133
16134
16135 .option trusted_groups main "string list&!!" unset
16136 .cindex "trusted groups"
16137 .cindex "groups" "trusted"
16138 This option is expanded just once, at the start of Exim's processing. If this
16139 option is set, any process that is running in one of the listed groups, or
16140 which has one of them as a supplementary group, is trusted. The groups can be
16141 specified numerically or by name. See section &<<SECTtrustedadmin>>& for
16142 details of what trusted callers are permitted to do. If neither
16143 &%trusted_groups%& nor &%trusted_users%& is set, only root and the Exim user
16144 are trusted.
16145
16146 .option trusted_users main "string list&!!" unset
16147 .cindex "trusted users"
16148 .cindex "user" "trusted"
16149 This option is expanded just once, at the start of Exim's processing. If this
16150 option is set, any process that is running as one of the listed users is
16151 trusted. The users can be specified numerically or by name. See section
16152 &<<SECTtrustedadmin>>& for details of what trusted callers are permitted to do.
16153 If neither &%trusted_groups%& nor &%trusted_users%& is set, only root and the
16154 Exim user are trusted.
16155
16156 .option unknown_login main string&!! unset
16157 .cindex "uid (user id)" "unknown caller"
16158 .vindex "&$caller_uid$&"
16159 This is a specialized feature for use in unusual configurations. By default, if
16160 the uid of the caller of Exim cannot be looked up using &[getpwuid()]&, Exim
16161 gives up. The &%unknown_login%& option can be used to set a login name to be
16162 used in this circumstance. It is expanded, so values like &%user$caller_uid%&
16163 can be set. When &%unknown_login%& is used, the value of &%unknown_username%&
16164 is used for the user's real name (gecos field), unless this has been set by the
16165 &%-F%& option.
16166
16167 .option unknown_username main string unset
16168 See &%unknown_login%&.
16169
16170 .option untrusted_set_sender main "address list&!!" unset
16171 .cindex "trusted users"
16172 .cindex "sender" "setting by untrusted user"
16173 .cindex "untrusted user setting sender"
16174 .cindex "user" "untrusted setting sender"
16175 .cindex "envelope sender"
16176 When an untrusted user submits a message to Exim using the standard input, Exim
16177 normally creates an envelope sender address from the user's login and the
16178 default qualification domain. Data from the &%-f%& option (for setting envelope
16179 senders on non-SMTP messages) or the SMTP MAIL command (if &%-bs%& or &%-bS%&
16180 is used) is ignored.
16181
16182 However, untrusted users are permitted to set an empty envelope sender address,
16183 to declare that a message should never generate any bounces. For example:
16184 .code
16185 exim -f '<>' user@domain.example
16186 .endd
16187 .vindex "&$sender_ident$&"
16188 The &%untrusted_set_sender%& option allows you to permit untrusted users to set
16189 other envelope sender addresses in a controlled way. When it is set, untrusted
16190 users are allowed to set envelope sender addresses that match any of the
16191 patterns in the list. Like all address lists, the string is expanded. The
16192 identity of the user is in &$sender_ident$&, so you can, for example, restrict
16193 users to setting senders that start with their login ids
16194 followed by a hyphen
16195 by a setting like this:
16196 .code
16197 untrusted_set_sender = ^$sender_ident-
16198 .endd
16199 If you want to allow untrusted users to set envelope sender addresses without
16200 restriction, you can use
16201 .code
16202 untrusted_set_sender = *
16203 .endd
16204 The &%untrusted_set_sender%& option applies to all forms of local input, but
16205 only to the setting of the envelope sender. It does not permit untrusted users
16206 to use the other options which trusted user can use to override message
16207 parameters. Furthermore, it does not stop Exim from removing an existing
16208 &'Sender:'& header in the message, or from adding a &'Sender:'& header if
16209 necessary. See &%local_sender_retain%& and &%local_from_check%& for ways of
16210 overriding these actions. The handling of the &'Sender:'& header is also
16211 described in section &<<SECTthesenhea>>&.
16212
16213 The log line for a message's arrival shows the envelope sender following
16214 &"<="&. For local messages, the user's login always follows, after &"U="&. In
16215 &%-bp%& displays, and in the Exim monitor, if an untrusted user sets an
16216 envelope sender address, the user's login is shown in parentheses after the
16217 sender address.
16218
16219
16220 .option uucp_from_pattern main string "see below"
16221 .cindex "&""From""& line"
16222 .cindex "UUCP" "&""From""& line"
16223 Some applications that pass messages to an MTA via a command line interface use
16224 an initial line starting with &"From&~"& to pass the envelope sender. In
16225 particular, this is used by UUCP software. Exim recognizes such a line by means
16226 of a regular expression that is set in &%uucp_from_pattern%&. When the pattern
16227 matches, the sender address is constructed by expanding the contents of
16228 &%uucp_from_sender%&, provided that the caller of Exim is a trusted user. The
16229 default pattern recognizes lines in the following two forms:
16230 .code
16231 From ph10 Fri Jan  5 12:35 GMT 1996
16232 From ph10 Fri, 7 Jan 97 14:00:00 GMT
16233 .endd
16234 The pattern can be seen by running
16235 .code
16236 exim -bP uucp_from_pattern
16237 .endd
16238 It checks only up to the hours and minutes, and allows for a 2-digit or 4-digit
16239 year in the second case. The first word after &"From&~"& is matched in the
16240 regular expression by a parenthesized subpattern. The default value for
16241 &%uucp_from_sender%& is &"$1"&, which therefore just uses this first word
16242 (&"ph10"& in the example above) as the message's sender. See also
16243 &%ignore_fromline_hosts%&.
16244
16245
16246 .option uucp_from_sender main string&!! &`$1`&
16247 See &%uucp_from_pattern%& above.
16248
16249
16250 .option warn_message_file main string unset
16251 .cindex "warning of delay" "customizing the message"
16252 .cindex "customizing" "warning message"
16253 This option defines a template file containing paragraphs of text to be used
16254 for constructing the warning message which is sent by Exim when a message has
16255 been on the queue for a specified amount of time, as specified by
16256 &%delay_warning%&. Details of the file's contents are given in chapter
16257 &<<CHAPemsgcust>>&. See also &%bounce_message_file%&.
16258
16259
16260 .option write_rejectlog main boolean true
16261 .cindex "reject log" "disabling"
16262 If this option is set false, Exim no longer writes anything to the reject log.
16263 See chapter &<<CHAPlog>>& for details of what Exim writes to its logs.
16264 .ecindex IIDconfima
16265 .ecindex IIDmaiconf
16266
16267
16268
16269
16270 . ////////////////////////////////////////////////////////////////////////////
16271 . ////////////////////////////////////////////////////////////////////////////
16272
16273 .chapter "Generic options for routers" "CHAProutergeneric"
16274 .scindex IIDgenoprou1 "options" "generic; for routers"
16275 .scindex IIDgenoprou2 "generic options" "router"
16276 This chapter describes the generic options that apply to all routers.
16277 Those that are preconditions are marked with &Dagger; in the &"use"& field.
16278
16279 For a general description of how a router operates, see sections
16280 &<<SECTrunindrou>>& and &<<SECTrouprecon>>&. The latter specifies the order in
16281 which the preconditions are tested. The order of expansion of the options that
16282 provide data for a transport is: &%errors_to%&, &%headers_add%&,
16283 &%headers_remove%&, &%transport%&.
16284
16285
16286
16287 .option address_data routers string&!! unset
16288 .cindex "router" "data attached to address"
16289 The string is expanded just before the router is run, that is, after all the
16290 precondition tests have succeeded. If the expansion is forced to fail, the
16291 router declines, the value of &%address_data%& remains unchanged, and the
16292 &%more%& option controls what happens next. Other expansion failures cause
16293 delivery of the address to be deferred.
16294
16295 .vindex "&$address_data$&"
16296 When the expansion succeeds, the value is retained with the address, and can be
16297 accessed using the variable &$address_data$& in the current router, subsequent
16298 routers, and the eventual transport.
16299
16300 &*Warning*&: If the current or any subsequent router is a &(redirect)& router
16301 that runs a user's filter file, the contents of &$address_data$& are accessible
16302 in the filter. This is not normally a problem, because such data is usually
16303 either not confidential or it &"belongs"& to the current user, but if you do
16304 put confidential data into &$address_data$& you need to remember this point.
16305
16306 Even if the router declines or passes, the value of &$address_data$& remains
16307 with the address, though it can be changed by another &%address_data%& setting
16308 on a subsequent router. If a router generates child addresses, the value of
16309 &$address_data$& propagates to them. This also applies to the special kind of
16310 &"child"& that is generated by a router with the &%unseen%& option.
16311
16312 The idea of &%address_data%& is that you can use it to look up a lot of data
16313 for the address once, and then pick out parts of the data later. For example,
16314 you could use a single LDAP lookup to return a string of the form
16315 .code
16316 uid=1234 gid=5678 mailbox=/mail/xyz forward=/home/xyz/.forward
16317 .endd
16318 In the transport you could pick out the mailbox by a setting such as
16319 .code
16320 file = ${extract{mailbox}{$address_data}}
16321 .endd
16322 This makes the configuration file less messy, and also reduces the number of
16323 lookups (though Exim does cache lookups).
16324
16325 .vindex "&$sender_address_data$&"
16326 .vindex "&$address_data$&"
16327 The &%address_data%& facility is also useful as a means of passing information
16328 from one router to another, and from a router to a transport. In addition, if
16329 &$address_data$& is set by a router when verifying a recipient address from an
16330 ACL, it remains available for use in the rest of the ACL statement. After
16331 verifying a sender, the value is transferred to &$sender_address_data$&.
16332
16333
16334
16335 .option address_test routers&!? boolean true
16336 .oindex "&%-bt%&"
16337 .cindex "router" "skipping when address testing"
16338 If this option is set false, the router is skipped when routing is being tested
16339 by means of the &%-bt%& command line option. This can be a convenience when
16340 your first router sends messages to an external scanner, because it saves you
16341 having to set the &"already scanned"& indicator when testing real address
16342 routing.
16343
16344
16345
16346 .option cannot_route_message routers string&!! unset
16347 .cindex "router" "customizing &""cannot route""& message"
16348 .cindex "customizing" "&""cannot route""& message"
16349 This option specifies a text message that is used when an address cannot be
16350 routed because Exim has run out of routers. The default message is
16351 &"Unrouteable address"&. This option is useful only on routers that have
16352 &%more%& set false, or on the very last router in a configuration, because the
16353 value that is used is taken from the last router that is considered. This
16354 includes a router that is skipped because its preconditions are not met, as
16355 well as a router that declines. For example, using the default configuration,
16356 you could put:
16357 .code
16358 cannot_route_message = Remote domain not found in DNS
16359 .endd
16360 on the first router, which is a &(dnslookup)& router with &%more%& set false,
16361 and
16362 .code
16363 cannot_route_message = Unknown local user
16364 .endd
16365 on the final router that checks for local users. If string expansion fails for
16366 this option, the default message is used. Unless the expansion failure was
16367 explicitly forced, a message about the failure is written to the main and panic
16368 logs, in addition to the normal message about the routing failure.
16369
16370
16371 .option caseful_local_part routers boolean false
16372 .cindex "case of local parts"
16373 .cindex "router" "case of local parts"
16374 By default, routers handle the local parts of addresses in a case-insensitive
16375 manner, though the actual case is preserved for transmission with the message.
16376 If you want the case of letters to be significant in a router, you must set
16377 this option true. For individual router options that contain address or local
16378 part lists (for example, &%local_parts%&), case-sensitive matching can be
16379 turned on by &"+caseful"& as a list item. See section &<<SECTcasletadd>>& for
16380 more details.
16381
16382 .vindex "&$local_part$&"
16383 .vindex "&$original_local_part$&"
16384 .vindex "&$parent_local_part$&"
16385 The value of the &$local_part$& variable is forced to lower case while a
16386 router is running unless &%caseful_local_part%& is set. When a router assigns
16387 an address to a transport, the value of &$local_part$& when the transport runs
16388 is the same as it was in the router. Similarly, when a router generates child
16389 addresses by aliasing or forwarding, the values of &$original_local_part$&
16390 and &$parent_local_part$& are those that were used by the redirecting router.
16391
16392 This option applies to the processing of an address by a router. When a
16393 recipient address is being processed in an ACL, there is a separate &%control%&
16394 modifier that can be used to specify case-sensitive processing within the ACL
16395 (see section &<<SECTcontrols>>&).
16396
16397
16398
16399 .option check_local_user routers&!? boolean false
16400 .cindex "local user, checking in router"
16401 .cindex "router" "checking for local user"
16402 .cindex "&_/etc/passwd_&"
16403 .vindex "&$home$&"
16404 When this option is true, Exim checks that the local part of the recipient
16405 address (with affixes removed if relevant) is the name of an account on the
16406 local system. The check is done by calling the &[getpwnam()]& function rather
16407 than trying to read &_/etc/passwd_& directly. This means that other methods of
16408 holding password data (such as NIS) are supported. If the local part is a local
16409 user, &$home$& is set from the password data, and can be tested in other
16410 preconditions that are evaluated after this one (the order of evaluation is
16411 given in section &<<SECTrouprecon>>&). However, the value of &$home$& can be
16412 overridden by &%router_home_directory%&. If the local part is not a local user,
16413 the router is skipped.
16414
16415 If you want to check that the local part is either the name of a local user
16416 or matches something else, you cannot combine &%check_local_user%& with a
16417 setting of &%local_parts%&, because that specifies the logical &'and'& of the
16418 two conditions. However, you can use a &(passwd)& lookup in a &%local_parts%&
16419 setting to achieve this. For example:
16420 .code
16421 local_parts = passwd;$local_part : lsearch;/etc/other/users
16422 .endd
16423 Note, however, that the side effects of &%check_local_user%& (such as setting
16424 up a home directory) do not occur when a &(passwd)& lookup is used in a
16425 &%local_parts%& (or any other) precondition.
16426
16427
16428
16429 .option condition routers&!? string&!! unset
16430 .cindex "router" "customized precondition"
16431 This option specifies a general precondition test that has to succeed for the
16432 router to be called. The &%condition%& option is the last precondition to be
16433 evaluated (see section &<<SECTrouprecon>>&). The string is expanded, and if the
16434 result is a forced failure, or an empty string, or one of the strings &"0"& or
16435 &"no"& or &"false"& (checked without regard to the case of the letters), the
16436 router is skipped, and the address is offered to the next one.
16437
16438 If the result is any other value, the router is run (as this is the last
16439 precondition to be evaluated, all the other preconditions must be true).
16440
16441 This option is unusual in that multiple &%condition%& options may be present.
16442 All &%condition%& options must succeed.
16443
16444 The &%condition%& option provides a means of applying custom conditions to the
16445 running of routers. Note that in the case of a simple conditional expansion,
16446 the default expansion values are exactly what is wanted. For example:
16447 .code
16448 condition = ${if >{$message_age}{600}}
16449 .endd
16450 Because of the default behaviour of the string expansion, this is equivalent to
16451 .code
16452 condition = ${if >{$message_age}{600}{true}{}}
16453 .endd
16454
16455 A multiple condition example, which succeeds:
16456 .code
16457 condition = ${if >{$message_age}{600}}
16458 condition = ${if !eq{${lc:$local_part}}{postmaster}}
16459 condition = foobar
16460 .endd
16461
16462 If the expansion fails (other than forced failure) delivery is deferred. Some
16463 of the other precondition options are common special cases that could in fact
16464 be specified using &%condition%&.
16465
16466
16467 .option debug_print routers string&!! unset
16468 .cindex "testing" "variables in drivers"
16469 If this option is set and debugging is enabled (see the &%-d%& command line
16470 option) or in address-testing mode (see the &%-bt%& command line option),
16471 the string is expanded and included in the debugging output.
16472 If expansion of the string fails, the error message is written to the debugging
16473 output, and Exim carries on processing.
16474 This option is provided to help with checking out the values of variables and
16475 so on when debugging router configurations. For example, if a &%condition%&
16476 option appears not to be working, &%debug_print%& can be used to output the
16477 variables it references. The output happens after checks for &%domains%&,
16478 &%local_parts%&, and &%check_local_user%& but before any other preconditions
16479 are tested. A newline is added to the text if it does not end with one.
16480 The variable &$router_name$& contains the name of the router.
16481
16482
16483
16484 .option disable_logging routers boolean false
16485 If this option is set true, nothing is logged for any routing errors
16486 or for any deliveries caused by this router. You should not set this option
16487 unless you really, really know what you are doing. See also the generic
16488 transport option of the same name.
16489
16490
16491 .option domains routers&!? "domain list&!!" unset
16492 .cindex "router" "restricting to specific domains"
16493 .vindex "&$domain_data$&"
16494 If this option is set, the router is skipped unless the current domain matches
16495 the list. If the match is achieved by means of a file lookup, the data that the
16496 lookup returned for the domain is placed in &$domain_data$& for use in string
16497 expansions of the driver's private options. See section &<<SECTrouprecon>>& for
16498 a list of the order in which preconditions are evaluated.
16499
16500
16501
16502 .option driver routers string unset
16503 This option must always be set. It specifies which of the available routers is
16504 to be used.
16505
16506
16507
16508 .option errors_to routers string&!! unset
16509 .cindex "envelope sender"
16510 .cindex "router" "changing address for errors"
16511 If a router successfully handles an address, it may assign the address to a
16512 transport for delivery or it may generate child addresses. In both cases, if
16513 there is a delivery problem during later processing, the resulting bounce
16514 message is sent to the address that results from expanding this string,
16515 provided that the address verifies successfully. The &%errors_to%& option is
16516 expanded before &%headers_add%&, &%headers_remove%&, and &%transport%&.
16517
16518 The &%errors_to%& setting associated with an address can be overridden if it
16519 subsequently passes through other routers that have their own &%errors_to%&
16520 settings, or if the message is delivered by a transport with a &%return_path%&
16521 setting.
16522
16523 If &%errors_to%& is unset, or the expansion is forced to fail, or the result of
16524 the expansion fails to verify, the errors address associated with the incoming
16525 address is used. At top level, this is the envelope sender. A non-forced
16526 expansion failure causes delivery to be deferred.
16527
16528 If an address for which &%errors_to%& has been set ends up being delivered over
16529 SMTP, the envelope sender for that delivery is the &%errors_to%& value, so that
16530 any bounces that are generated by other MTAs on the delivery route are also
16531 sent there. You can set &%errors_to%& to the empty string by either of these
16532 settings:
16533 .code
16534 errors_to =
16535 errors_to = ""
16536 .endd
16537 An expansion item that yields an empty string has the same effect. If you do
16538 this, a locally detected delivery error for addresses processed by this router
16539 no longer gives rise to a bounce message; the error is discarded. If the
16540 address is delivered to a remote host, the return path is set to &`<>`&, unless
16541 overridden by the &%return_path%& option on the transport.
16542
16543 .vindex "&$address_data$&"
16544 If for some reason you want to discard local errors, but use a non-empty
16545 MAIL command for remote delivery, you can preserve the original return
16546 path in &$address_data$& in the router, and reinstate it in the transport by
16547 setting &%return_path%&.
16548
16549 The most common use of &%errors_to%& is to direct mailing list bounces to the
16550 manager of the list, as described in section &<<SECTmailinglists>>&, or to
16551 implement VERP (Variable Envelope Return Paths) (see section &<<SECTverp>>&).
16552
16553
16554
16555 .option expn routers&!? boolean true
16556 .cindex "address" "testing"
16557 .cindex "testing" "addresses"
16558 .cindex "EXPN" "router skipping"
16559 .cindex "router" "skipping for EXPN"
16560 If this option is turned off, the router is skipped when testing an address
16561 as a result of processing an SMTP EXPN command. You might, for example,
16562 want to turn it off on a router for users' &_.forward_& files, while leaving it
16563 on for the system alias file.
16564 See section &<<SECTrouprecon>>& for a list of the order in which preconditions
16565 are evaluated.
16566
16567 The use of the SMTP EXPN command is controlled by an ACL (see chapter
16568 &<<CHAPACL>>&). When Exim is running an EXPN command, it is similar to testing
16569 an address with &%-bt%&. Compare VRFY, whose counterpart is &%-bv%&.
16570
16571
16572
16573 .option fail_verify routers boolean false
16574 .cindex "router" "forcing verification failure"
16575 Setting this option has the effect of setting both &%fail_verify_sender%& and
16576 &%fail_verify_recipient%& to the same value.
16577
16578
16579
16580 .option fail_verify_recipient routers boolean false
16581 If this option is true and an address is accepted by this router when
16582 verifying a recipient, verification fails.
16583
16584
16585
16586 .option fail_verify_sender routers boolean false
16587 If this option is true and an address is accepted by this router when
16588 verifying a sender, verification fails.
16589
16590
16591
16592 .option fallback_hosts routers "string list" unset
16593 .cindex "router" "fallback hosts"
16594 .cindex "fallback" "hosts specified on router"
16595 String expansion is not applied to this option. The argument must be a
16596 colon-separated list of host names or IP addresses. The list separator can be
16597 changed (see section &<<SECTlistconstruct>>&), and a port can be specified with
16598 each name or address. In fact, the format of each item is exactly the same as
16599 defined for the list of hosts in a &(manualroute)& router (see section
16600 &<<SECTformatonehostitem>>&).
16601
16602 If a router queues an address for a remote transport, this host list is
16603 associated with the address, and used instead of the transport's fallback host
16604 list. If &%hosts_randomize%& is set on the transport, the order of the list is
16605 randomized for each use. See the &%fallback_hosts%& option of the &(smtp)&
16606 transport for further details.
16607
16608
16609 .option group routers string&!! "see below"
16610 .cindex "gid (group id)" "local delivery"
16611 .cindex "local transports" "uid and gid"
16612 .cindex "transport" "local"
16613 .cindex "router" "setting group"
16614 When a router queues an address for a transport, and the transport does not
16615 specify a group, the group given here is used when running the delivery
16616 process.
16617 The group may be specified numerically or by name. If expansion fails, the
16618 error is logged and delivery is deferred.
16619 The default is unset, unless &%check_local_user%& is set, when the default
16620 is taken from the password information. See also &%initgroups%& and &%user%&
16621 and the discussion in chapter &<<CHAPenvironment>>&.
16622
16623
16624
16625 .option headers_add routers string&!! unset
16626 .cindex "header lines" "adding"
16627 .cindex "router" "adding header lines"
16628 This option specifies a string of text that is expanded at routing time, and
16629 associated with any addresses that are accepted by the router. However, this
16630 option has no effect when an address is just being verified. The way in which
16631 the text is used to add header lines at transport time is described in section
16632 &<<SECTheadersaddrem>>&. New header lines are not actually added until the
16633 message is in the process of being transported. This means that references to
16634 header lines in string expansions in the transport's configuration do not
16635 &"see"& the added header lines.
16636
16637 The &%headers_add%& option is expanded after &%errors_to%&, but before
16638 &%headers_remove%& and &%transport%&. If the expanded string is empty, or if
16639 the expansion is forced to fail, the option has no effect. Other expansion
16640 failures are treated as configuration errors.
16641
16642 Unlike most options, &%headers_add%& can be specified multiple times
16643 for a router; all listed headers are added.
16644
16645 &*Warning 1*&: The &%headers_add%& option cannot be used for a &(redirect)&
16646 router that has the &%one_time%& option set.
16647
16648 .cindex "duplicate addresses"
16649 .oindex "&%unseen%&"
16650 &*Warning 2*&: If the &%unseen%& option is set on the router, all header
16651 additions are deleted when the address is passed on to subsequent routers.
16652 For a &%redirect%& router, if a generated address is the same as the incoming
16653 address, this can lead to duplicate addresses with different header
16654 modifications. Exim does not do duplicate deliveries (except, in certain
16655 circumstances, to pipes -- see section &<<SECTdupaddr>>&), but it is undefined
16656 which of the duplicates is discarded, so this ambiguous situation should be
16657 avoided. The &%repeat_use%& option of the &%redirect%& router may be of help.
16658
16659
16660
16661 .option headers_remove routers string&!! unset
16662 .cindex "header lines" "removing"
16663 .cindex "router" "removing header lines"
16664 This option specifies a string of text that is expanded at routing time, and
16665 associated with any addresses that are accepted by the router. However, this
16666 option has no effect when an address is just being verified. The way in which
16667 the text is used to remove header lines at transport time is described in
16668 section &<<SECTheadersaddrem>>&. Header lines are not actually removed until
16669 the message is in the process of being transported. This means that references
16670 to header lines in string expansions in the transport's configuration still
16671 &"see"& the original header lines.
16672
16673 The &%headers_remove%& option is expanded after &%errors_to%& and
16674 &%headers_add%&, but before &%transport%&. If the expansion is forced to fail,
16675 the option has no effect. Other expansion failures are treated as configuration
16676 errors.
16677
16678 Unlike most options, &%headers_remove%& can be specified multiple times
16679 for a router; all listed headers are removed.
16680
16681 &*Warning 1*&: The &%headers_remove%& option cannot be used for a &(redirect)&
16682 router that has the &%one_time%& option set.
16683
16684 &*Warning 2*&: If the &%unseen%& option is set on the router, all header
16685 removal requests are deleted when the address is passed on to subsequent
16686 routers, and this can lead to problems with duplicates -- see the similar
16687 warning for &%headers_add%& above.
16688
16689
16690 .option ignore_target_hosts routers "host list&!!" unset
16691 .cindex "IP address" "discarding"
16692 .cindex "router" "discarding IP addresses"
16693 Although this option is a host list, it should normally contain IP address
16694 entries rather than names. If any host that is looked up by the router has an
16695 IP address that matches an item in this list, Exim behaves as if that IP
16696 address did not exist. This option allows you to cope with rogue DNS entries
16697 like
16698 .code
16699 remote.domain.example.  A  127.0.0.1
16700 .endd
16701 by setting
16702 .code
16703 ignore_target_hosts = 127.0.0.1
16704 .endd
16705 on the relevant router. If all the hosts found by a &(dnslookup)& router are
16706 discarded in this way, the router declines. In a conventional configuration, an
16707 attempt to mail to such a domain would normally provoke the &"unrouteable
16708 domain"& error, and an attempt to verify an address in the domain would fail.
16709 Similarly, if &%ignore_target_hosts%& is set on an &(ipliteral)& router, the
16710 router declines if presented with one of the listed addresses.
16711
16712 You can use this option to disable the use of IPv4 or IPv6 for mail delivery by
16713 means of the first or the second of the following settings, respectively:
16714 .code
16715 ignore_target_hosts = 0.0.0.0/0
16716 ignore_target_hosts = <; 0::0/0
16717 .endd
16718 The pattern in the first line matches all IPv4 addresses, whereas the pattern
16719 in the second line matches all IPv6 addresses.
16720
16721 This option may also be useful for ignoring link-local and site-local IPv6
16722 addresses. Because, like all host lists, the value of &%ignore_target_hosts%&
16723 is expanded before use as a list, it is possible to make it dependent on the
16724 domain that is being routed.
16725
16726 .vindex "&$host_address$&"
16727 During its expansion, &$host_address$& is set to the IP address that is being
16728 checked.
16729
16730 .option initgroups routers boolean false
16731 .cindex "additional groups"
16732 .cindex "groups" "additional"
16733 .cindex "local transports" "uid and gid"
16734 .cindex "transport" "local"
16735 If the router queues an address for a transport, and this option is true, and
16736 the uid supplied by the router is not overridden by the transport, the
16737 &[initgroups()]& function is called when running the transport to ensure that
16738 any additional groups associated with the uid are set up. See also &%group%&
16739 and &%user%& and the discussion in chapter &<<CHAPenvironment>>&.
16740
16741
16742
16743 .option local_part_prefix routers&!? "string list" unset
16744 .cindex "router" "prefix for local part"
16745 .cindex "prefix" "for local part, used in router"
16746 If this option is set, the router is skipped unless the local part starts with
16747 one of the given strings, or &%local_part_prefix_optional%& is true. See
16748 section &<<SECTrouprecon>>& for a list of the order in which preconditions are
16749 evaluated.
16750
16751 The list is scanned from left to right, and the first prefix that matches is
16752 used. A limited form of wildcard is available; if the prefix begins with an
16753 asterisk, it matches the longest possible sequence of arbitrary characters at
16754 the start of the local part. An asterisk should therefore always be followed by
16755 some character that does not occur in normal local parts.
16756 .cindex "multiple mailboxes"
16757 .cindex "mailbox" "multiple"
16758 Wildcarding can be used to set up multiple user mailboxes, as described in
16759 section &<<SECTmulbox>>&.
16760
16761 .vindex "&$local_part$&"
16762 .vindex "&$local_part_prefix$&"
16763 During the testing of the &%local_parts%& option, and while the router is
16764 running, the prefix is removed from the local part, and is available in the
16765 expansion variable &$local_part_prefix$&. When a message is being delivered, if
16766 the router accepts the address, this remains true during subsequent delivery by
16767 a transport. In particular, the local part that is transmitted in the RCPT
16768 command for LMTP, SMTP, and BSMTP deliveries has the prefix removed by default.
16769 This behaviour can be overridden by setting &%rcpt_include_affixes%& true on
16770 the relevant transport.
16771
16772 When an address is being verified, &%local_part_prefix%& affects only the
16773 behaviour of the router. If the callout feature of verification is in use, this
16774 means that the full address, including the prefix, will be used during the
16775 callout.
16776
16777 The prefix facility is commonly used to handle local parts of the form
16778 &%owner-something%&. Another common use is to support local parts of the form
16779 &%real-username%& to bypass a user's &_.forward_& file &-- helpful when trying
16780 to tell a user their forwarding is broken &-- by placing a router like this one
16781 immediately before the router that handles &_.forward_& files:
16782 .code
16783 real_localuser:
16784   driver = accept
16785   local_part_prefix = real-
16786   check_local_user
16787   transport = local_delivery
16788 .endd
16789 For security, it would probably be a good idea to restrict the use of this
16790 router to locally-generated messages, using a condition such as this:
16791 .code
16792   condition = ${if match {$sender_host_address}\
16793                          {\N^(|127\.0\.0\.1)$\N}}
16794 .endd
16795
16796 If both &%local_part_prefix%& and &%local_part_suffix%& are set for a router,
16797 both conditions must be met if not optional. Care must be taken if wildcards
16798 are used in both a prefix and a suffix on the same router. Different
16799 separator characters must be used to avoid ambiguity.
16800
16801
16802 .option local_part_prefix_optional routers boolean false
16803 See &%local_part_prefix%& above.
16804
16805
16806
16807 .option local_part_suffix routers&!? "string list" unset
16808 .cindex "router" "suffix for local part"
16809 .cindex "suffix for local part" "used in router"
16810 This option operates in the same way as &%local_part_prefix%&, except that the
16811 local part must end (rather than start) with the given string, the
16812 &%local_part_suffix_optional%& option determines whether the suffix is
16813 mandatory, and the wildcard * character, if present, must be the last
16814 character of the suffix. This option facility is commonly used to handle local
16815 parts of the form &%something-request%& and multiple user mailboxes of the form
16816 &%username-foo%&.
16817
16818
16819 .option local_part_suffix_optional routers boolean false
16820 See &%local_part_suffix%& above.
16821
16822
16823
16824 .option local_parts routers&!? "local part list&!!" unset
16825 .cindex "router" "restricting to specific local parts"
16826 .cindex "local part" "checking in router"
16827 The router is run only if the local part of the address matches the list.
16828 See section &<<SECTrouprecon>>& for a list of the order in which preconditions
16829 are evaluated, and
16830 section &<<SECTlocparlis>>& for a discussion of local part lists. Because the
16831 string is expanded, it is possible to make it depend on the domain, for
16832 example:
16833 .code
16834 local_parts = dbm;/usr/local/specials/$domain
16835 .endd
16836 .vindex "&$local_part_data$&"
16837 If the match is achieved by a lookup, the data that the lookup returned
16838 for the local part is placed in the variable &$local_part_data$& for use in
16839 expansions of the router's private options. You might use this option, for
16840 example, if you have a large number of local virtual domains, and you want to
16841 send all postmaster mail to the same place without having to set up an alias in
16842 each virtual domain:
16843 .code
16844 postmaster:
16845   driver = redirect
16846   local_parts = postmaster
16847   data = postmaster@real.domain.example
16848 .endd
16849
16850
16851 .option log_as_local routers boolean "see below"
16852 .cindex "log" "delivery line"
16853 .cindex "delivery" "log line format"
16854 Exim has two logging styles for delivery, the idea being to make local
16855 deliveries stand out more visibly from remote ones. In the &"local"& style, the
16856 recipient address is given just as the local part, without a domain. The use of
16857 this style is controlled by this option. It defaults to true for the &(accept)&
16858 router, and false for all the others. This option applies only when a
16859 router assigns an address to a transport. It has no effect on routers that
16860 redirect addresses.
16861
16862
16863
16864 .option more routers boolean&!! true
16865 The result of string expansion for this option must be a valid boolean value,
16866 that is, one of the strings &"yes"&, &"no"&, &"true"&, or &"false"&. Any other
16867 result causes an error, and delivery is deferred. If the expansion is forced to
16868 fail, the default value for the option (true) is used. Other failures cause
16869 delivery to be deferred.
16870
16871 If this option is set false, and the router declines to handle the address, no
16872 further routers are tried, routing fails, and the address is bounced.
16873 .oindex "&%self%&"
16874 However, if the router explicitly passes an address to the following router by
16875 means of the setting
16876 .code
16877 self = pass
16878 .endd
16879 or otherwise, the setting of &%more%& is ignored. Also, the setting of &%more%&
16880 does not affect the behaviour if one of the precondition tests fails. In that
16881 case, the address is always passed to the next router.
16882
16883 Note that &%address_data%& is not considered to be a precondition. If its
16884 expansion is forced to fail, the router declines, and the value of &%more%&
16885 controls what happens next.
16886
16887
16888 .option pass_on_timeout routers boolean false
16889 .cindex "timeout" "of router"
16890 .cindex "router" "timeout"
16891 If a router times out during a host lookup, it normally causes deferral of the
16892 address. If &%pass_on_timeout%& is set, the address is passed on to the next
16893 router, overriding &%no_more%&. This may be helpful for systems that are
16894 intermittently connected to the Internet, or those that want to pass to a smart
16895 host any messages that cannot immediately be delivered.
16896
16897 There are occasional other temporary errors that can occur while doing DNS
16898 lookups. They are treated in the same way as a timeout, and this option
16899 applies to all of them.
16900
16901
16902
16903 .option pass_router routers string unset
16904 .cindex "router" "go to after &""pass""&"
16905 Routers that recognize the generic &%self%& option (&(dnslookup)&,
16906 &(ipliteral)&, and &(manualroute)&) are able to return &"pass"&, forcing
16907 routing to continue, and overriding a false setting of &%more%&. When one of
16908 these routers returns &"pass"&, the address is normally handed on to the next
16909 router in sequence. This can be changed by setting &%pass_router%& to the name
16910 of another router. However (unlike &%redirect_router%&) the named router must
16911 be below the current router, to avoid loops. Note that this option applies only
16912 to the special case of &"pass"&. It does not apply when a router returns
16913 &"decline"& because it cannot handle an address.
16914
16915
16916
16917 .option redirect_router routers string unset
16918 .cindex "router" "start at after redirection"
16919 Sometimes an administrator knows that it is pointless to reprocess addresses
16920 generated from alias or forward files with the same router again. For
16921 example, if an alias file translates real names into login ids there is no
16922 point searching the alias file a second time, especially if it is a large file.
16923
16924 The &%redirect_router%& option can be set to the name of any router instance.
16925 It causes the routing of any generated addresses to start at the named router
16926 instead of at the first router. This option has no effect if the router in
16927 which it is set does not generate new addresses.
16928
16929
16930
16931 .option require_files routers&!? "string list&!!" unset
16932 .cindex "file" "requiring for router"
16933 .cindex "router" "requiring file existence"
16934 This option provides a general mechanism for predicating the running of a
16935 router on the existence or non-existence of certain files or directories.
16936 Before running a router, as one of its precondition tests, Exim works its way
16937 through the &%require_files%& list, expanding each item separately.
16938
16939 Because the list is split before expansion, any colons in expansion items must
16940 be doubled, or the facility for using a different list separator must be used.
16941 If any expansion is forced to fail, the item is ignored. Other expansion
16942 failures cause routing of the address to be deferred.
16943
16944 If any expanded string is empty, it is ignored. Otherwise, except as described
16945 below, each string must be a fully qualified file path, optionally preceded by
16946 &"!"&. The paths are passed to the &[stat()]& function to test for the
16947 existence of the files or directories. The router is skipped if any paths not
16948 preceded by &"!"& do not exist, or if any paths preceded by &"!"& do exist.
16949
16950 .cindex "NFS"
16951 If &[stat()]& cannot determine whether a file exists or not, delivery of
16952 the message is deferred. This can happen when NFS-mounted filesystems are
16953 unavailable.
16954
16955 This option is checked after the &%domains%&, &%local_parts%&, and &%senders%&
16956 options, so you cannot use it to check for the existence of a file in which to
16957 look up a domain, local part, or sender. (See section &<<SECTrouprecon>>& for a
16958 full list of the order in which preconditions are evaluated.) However, as
16959 these options are all expanded, you can use the &%exists%& expansion condition
16960 to make such tests. The &%require_files%& option is intended for checking files
16961 that the router may be going to use internally, or which are needed by a
16962 transport (for example &_.procmailrc_&).
16963
16964 During delivery, the &[stat()]& function is run as root, but there is a
16965 facility for some checking of the accessibility of a file by another user.
16966 This is not a proper permissions check, but just a &"rough"& check that
16967 operates as follows:
16968
16969 If an item in a &%require_files%& list does not contain any forward slash
16970 characters, it is taken to be the user (and optional group, separated by a
16971 comma) to be checked for subsequent files in the list. If no group is specified
16972 but the user is specified symbolically, the gid associated with the uid is
16973 used. For example:
16974 .code
16975 require_files = mail:/some/file
16976 require_files = $local_part:$home/.procmailrc
16977 .endd
16978 If a user or group name in a &%require_files%& list does not exist, the
16979 &%require_files%& condition fails.
16980
16981 Exim performs the check by scanning along the components of the file path, and
16982 checking the access for the given uid and gid. It checks for &"x"& access on
16983 directories, and &"r"& access on the final file. Note that this means that file
16984 access control lists, if the operating system has them, are ignored.
16985
16986 &*Warning 1*&: When the router is being run to verify addresses for an
16987 incoming SMTP message, Exim is not running as root, but under its own uid. This
16988 may affect the result of a &%require_files%& check. In particular, &[stat()]&
16989 may yield the error EACCES (&"Permission denied"&). This means that the Exim
16990 user is not permitted to read one of the directories on the file's path.
16991
16992 &*Warning 2*&: Even when Exim is running as root while delivering a message,
16993 &[stat()]& can yield EACCES for a file in an NFS directory that is mounted
16994 without root access. In this case, if a check for access by a particular user
16995 is requested, Exim creates a subprocess that runs as that user, and tries the
16996 check again in that process.
16997
16998 The default action for handling an unresolved EACCES is to consider it to
16999 be caused by a configuration error, and routing is deferred because the
17000 existence or non-existence of the file cannot be determined. However, in some
17001 circumstances it may be desirable to treat this condition as if the file did
17002 not exist. If the file name (or the exclamation mark that precedes the file
17003 name for non-existence) is preceded by a plus sign, the EACCES error is treated
17004 as if the file did not exist. For example:
17005 .code
17006 require_files = +/some/file
17007 .endd
17008 If the router is not an essential part of verification (for example, it
17009 handles users' &_.forward_& files), another solution is to set the &%verify%&
17010 option false so that the router is skipped when verifying.
17011
17012
17013
17014 .option retry_use_local_part routers boolean "see below"
17015 .cindex "hints database" "retry keys"
17016 .cindex "local part" "in retry keys"
17017 When a delivery suffers a temporary routing failure, a retry record is created
17018 in Exim's hints database. For addresses whose routing depends only on the
17019 domain, the key for the retry record should not involve the local part, but for
17020 other addresses, both the domain and the local part should be included.
17021 Usually, remote routing is of the former kind, and local routing is of the
17022 latter kind.
17023
17024 This option controls whether the local part is used to form the key for retry
17025 hints for addresses that suffer temporary errors while being handled by this
17026 router. The default value is true for any router that has &%check_local_user%&
17027 set, and false otherwise. Note that this option does not apply to hints keys
17028 for transport delays; they are controlled by a generic transport option of the
17029 same name.
17030
17031 The setting of &%retry_use_local_part%& applies only to the router on which it
17032 appears. If the router generates child addresses, they are routed
17033 independently; this setting does not become attached to them.
17034
17035
17036
17037 .option router_home_directory routers string&!! unset
17038 .cindex "router" "home directory for"
17039 .cindex "home directory" "for router"
17040 .vindex "&$home$&"
17041 This option sets a home directory for use while the router is running. (Compare
17042 &%transport_home_directory%&, which sets a home directory for later
17043 transporting.) In particular, if used on a &(redirect)& router, this option
17044 sets a value for &$home$& while a filter is running. The value is expanded;
17045 forced expansion failure causes the option to be ignored &-- other failures
17046 cause the router to defer.
17047
17048 Expansion of &%router_home_directory%& happens immediately after the
17049 &%check_local_user%& test (if configured), before any further expansions take
17050 place.
17051 (See section &<<SECTrouprecon>>& for a list of the order in which preconditions
17052 are evaluated.)
17053 While the router is running, &%router_home_directory%& overrides the value of
17054 &$home$& that came from &%check_local_user%&.
17055
17056 When a router accepts an address and assigns it to a local transport (including
17057 the cases when a &(redirect)& router generates a pipe, file, or autoreply
17058 delivery), the home directory setting for the transport is taken from the first
17059 of these values that is set:
17060
17061 .ilist
17062 The &%home_directory%& option on the transport;
17063 .next
17064 The &%transport_home_directory%& option on the router;
17065 .next
17066 The password data if &%check_local_user%& is set on the router;
17067 .next
17068 The &%router_home_directory%& option on the router.
17069 .endlist
17070
17071 In other words, &%router_home_directory%& overrides the password data for the
17072 router, but not for the transport.
17073
17074
17075
17076 .option self routers string freeze
17077 .cindex "MX record" "pointing to local host"
17078 .cindex "local host" "MX pointing to"
17079 This option applies to those routers that use a recipient address to find a
17080 list of remote hosts. Currently, these are the &(dnslookup)&, &(ipliteral)&,
17081 and &(manualroute)& routers.
17082 Certain configurations of the &(queryprogram)& router can also specify a list
17083 of remote hosts.
17084 Usually such routers are configured to send the message to a remote host via an
17085 &(smtp)& transport. The &%self%& option specifies what happens when the first
17086 host on the list turns out to be the local host.
17087 The way in which Exim checks for the local host is described in section
17088 &<<SECTreclocipadd>>&.
17089
17090 Normally this situation indicates either an error in Exim's configuration (for
17091 example, the router should be configured not to process this domain), or an
17092 error in the DNS (for example, the MX should not point to this host). For this
17093 reason, the default action is to log the incident, defer the address, and
17094 freeze the message. The following alternatives are provided for use in special
17095 cases:
17096
17097 .vlist
17098 .vitem &%defer%&
17099 Delivery of the message is tried again later, but the message is not frozen.
17100
17101 .vitem "&%reroute%&: <&'domain'&>"
17102 The domain is changed to the given domain, and the address is passed back to
17103 be reprocessed by the routers. No rewriting of headers takes place. This
17104 behaviour is essentially a redirection.
17105
17106 .vitem "&%reroute: rewrite:%& <&'domain'&>"
17107 The domain is changed to the given domain, and the address is passed back to be
17108 reprocessed by the routers. Any headers that contain the original domain are
17109 rewritten.
17110
17111 .vitem &%pass%&
17112 .oindex "&%more%&"
17113 .vindex "&$self_hostname$&"
17114 The router passes the address to the next router, or to the router named in the
17115 &%pass_router%& option if it is set. This overrides &%no_more%&. During
17116 subsequent routing and delivery, the variable &$self_hostname$& contains the
17117 name of the local host that the router encountered. This can be used to
17118 distinguish between different cases for hosts with multiple names. The
17119 combination
17120 .code
17121 self = pass
17122 no_more
17123 .endd
17124 ensures that only those addresses that routed to the local host are passed on.
17125 Without &%no_more%&, addresses that were declined for other reasons would also
17126 be passed to the next router.
17127
17128 .vitem &%fail%&
17129 Delivery fails and an error report is generated.
17130
17131 .vitem &%send%&
17132 .cindex "local host" "sending to"
17133 The anomaly is ignored and the address is queued for the transport. This
17134 setting should be used with extreme caution. For an &(smtp)& transport, it
17135 makes sense only in cases where the program that is listening on the SMTP port
17136 is not this version of Exim. That is, it must be some other MTA, or Exim with a
17137 different configuration file that handles the domain in another way.
17138 .endlist
17139
17140
17141
17142 .option senders routers&!? "address list&!!" unset
17143 .cindex "router" "checking senders"
17144 If this option is set, the router is skipped unless the message's sender
17145 address matches something on the list.
17146 See section &<<SECTrouprecon>>& for a list of the order in which preconditions
17147 are evaluated.
17148
17149 There are issues concerning verification when the running of routers is
17150 dependent on the sender. When Exim is verifying the address in an &%errors_to%&
17151 setting, it sets the sender to the null string. When using the &%-bt%& option
17152 to check a configuration file, it is necessary also to use the &%-f%& option to
17153 set an appropriate sender. For incoming mail, the sender is unset when
17154 verifying the sender, but is available when verifying any recipients. If the
17155 SMTP VRFY command is enabled, it must be used after MAIL if the sender address
17156 matters.
17157
17158
17159 .option translate_ip_address routers string&!! unset
17160 .cindex "IP address" "translating"
17161 .cindex "packet radio"
17162 .cindex "router" "IP address translation"
17163 There exist some rare networking situations (for example, packet radio) where
17164 it is helpful to be able to translate IP addresses generated by normal routing
17165 mechanisms into other IP addresses, thus performing a kind of manual IP
17166 routing. This should be done only if the normal IP routing of the TCP/IP stack
17167 is inadequate or broken. Because this is an extremely uncommon requirement, the
17168 code to support this option is not included in the Exim binary unless
17169 SUPPORT_TRANSLATE_IP_ADDRESS=yes is set in &_Local/Makefile_&.
17170
17171 .vindex "&$host_address$&"
17172 The &%translate_ip_address%& string is expanded for every IP address generated
17173 by the router, with the generated address set in &$host_address$&. If the
17174 expansion is forced to fail, no action is taken.
17175 For any other expansion error, delivery of the message is deferred.
17176 If the result of the expansion is an IP address, that replaces the original
17177 address; otherwise the result is assumed to be a host name &-- this is looked
17178 up using &[gethostbyname()]& (or &[getipnodebyname()]& when available) to
17179 produce one or more replacement IP addresses. For example, to subvert all IP
17180 addresses in some specific networks, this could be added to a router:
17181 .code
17182 translate_ip_address = \
17183   ${lookup{${mask:$host_address/26}}lsearch{/some/file}\
17184     {$value}fail}}
17185 .endd
17186 The file would contain lines like
17187 .code
17188 10.2.3.128/26    some.host
17189 10.8.4.34/26     10.44.8.15
17190 .endd
17191 You should not make use of this facility unless you really understand what you
17192 are doing.
17193
17194
17195
17196 .option transport routers string&!! unset
17197 This option specifies the transport to be used when a router accepts an address
17198 and sets it up for delivery. A transport is never needed if a router is used
17199 only for verification. The value of the option is expanded at routing time,
17200 after the expansion of &%errors_to%&, &%headers_add%&, and &%headers_remove%&,
17201 and result must be the name of one of the configured transports. If it is not,
17202 delivery is deferred.
17203
17204 The &%transport%& option is not used by the &(redirect)& router, but it does
17205 have some private options that set up transports for pipe and file deliveries
17206 (see chapter &<<CHAPredirect>>&).
17207
17208
17209
17210 .option transport_current_directory routers string&!! unset
17211 .cindex "current directory for local transport"
17212 This option associates a current directory with any address that is routed
17213 to a local transport. This can happen either because a transport is
17214 explicitly configured for the router, or because it generates a delivery to a
17215 file or a pipe. During the delivery process (that is, at transport time), this
17216 option string is expanded and is set as the current directory, unless
17217 overridden by a setting on the transport.
17218 If the expansion fails for any reason, including forced failure, an error is
17219 logged, and delivery is deferred.
17220 See chapter &<<CHAPenvironment>>& for details of the local delivery
17221 environment.
17222
17223
17224
17225
17226 .option transport_home_directory routers string&!! "see below"
17227 .cindex "home directory" "for local transport"
17228 This option associates a home directory with any address that is routed to a
17229 local transport. This can happen either because a transport is explicitly
17230 configured for the router, or because it generates a delivery to a file or a
17231 pipe. During the delivery process (that is, at transport time), the option
17232 string is expanded and is set as the home directory, unless overridden by a
17233 setting of &%home_directory%& on the transport.
17234 If the expansion fails for any reason, including forced failure, an error is
17235 logged, and delivery is deferred.
17236
17237 If the transport does not specify a home directory, and
17238 &%transport_home_directory%& is not set for the router, the home directory for
17239 the transport is taken from the password data if &%check_local_user%& is set for
17240 the router. Otherwise it is taken from &%router_home_directory%& if that option
17241 is set; if not, no home directory is set for the transport.
17242
17243 See chapter &<<CHAPenvironment>>& for further details of the local delivery
17244 environment.
17245
17246
17247
17248
17249 .option unseen routers boolean&!! false
17250 .cindex "router" "carrying on after success"
17251 The result of string expansion for this option must be a valid boolean value,
17252 that is, one of the strings &"yes"&, &"no"&, &"true"&, or &"false"&. Any other
17253 result causes an error, and delivery is deferred. If the expansion is forced to
17254 fail, the default value for the option (false) is used. Other failures cause
17255 delivery to be deferred.
17256
17257 When this option is set true, routing does not cease if the router accepts the
17258 address. Instead, a copy of the incoming address is passed to the next router,
17259 overriding a false setting of &%more%&. There is little point in setting
17260 &%more%& false if &%unseen%& is always true, but it may be useful in cases when
17261 the value of &%unseen%& contains expansion items (and therefore, presumably, is
17262 sometimes true and sometimes false).
17263
17264 .cindex "copy of message (&%unseen%& option)"
17265 Setting the &%unseen%& option has a similar effect to the &%unseen%& command
17266 qualifier in filter files. It can be used to cause copies of messages to be
17267 delivered to some other destination, while also carrying out a normal delivery.
17268 In effect, the current address is made into a &"parent"& that has two children
17269 &-- one that is delivered as specified by this router, and a clone that goes on
17270 to be routed further. For this reason, &%unseen%& may not be combined with the
17271 &%one_time%& option in a &(redirect)& router.
17272
17273 &*Warning*&: Header lines added to the address (or specified for removal) by
17274 this router or by previous routers affect the &"unseen"& copy of the message
17275 only. The clone that continues to be processed by further routers starts with
17276 no added headers and none specified for removal. For a &%redirect%& router, if
17277 a generated address is the same as the incoming address, this can lead to
17278 duplicate addresses with different header modifications. Exim does not do
17279 duplicate deliveries (except, in certain circumstances, to pipes -- see section
17280 &<<SECTdupaddr>>&), but it is undefined which of the duplicates is discarded,
17281 so this ambiguous situation should be avoided. The &%repeat_use%& option of the
17282 &%redirect%& router may be of help.
17283
17284 Unlike the handling of header modifications, any data that was set by the
17285 &%address_data%& option in the current or previous routers &'is'& passed on to
17286 subsequent routers.
17287
17288
17289 .option user routers string&!! "see below"
17290 .cindex "uid (user id)" "local delivery"
17291 .cindex "local transports" "uid and gid"
17292 .cindex "transport" "local"
17293 .cindex "router" "user for filter processing"
17294 .cindex "filter" "user for processing"
17295 When a router queues an address for a transport, and the transport does not
17296 specify a user, the user given here is used when running the delivery process.
17297 The user may be specified numerically or by name. If expansion fails, the
17298 error is logged and delivery is deferred.
17299 This user is also used by the &(redirect)& router when running a filter file.
17300 The default is unset, except when &%check_local_user%& is set. In this case,
17301 the default is taken from the password information. If the user is specified as
17302 a name, and &%group%& is not set, the group associated with the user is used.
17303 See also &%initgroups%& and &%group%& and the discussion in chapter
17304 &<<CHAPenvironment>>&.
17305
17306
17307
17308 .option verify routers&!? boolean true
17309 Setting this option has the effect of setting &%verify_sender%& and
17310 &%verify_recipient%& to the same value.
17311
17312
17313 .option verify_only routers&!? boolean false
17314 .cindex "EXPN" "with &%verify_only%&"
17315 .oindex "&%-bv%&"
17316 .cindex "router" "used only when verifying"
17317 If this option is set, the router is used only when verifying an address,
17318 delivering in cutthrough mode or
17319 testing with the &%-bv%& option, not when actually doing a delivery, testing
17320 with the &%-bt%& option, or running the SMTP EXPN command. It can be further
17321 restricted to verifying only senders or recipients by means of
17322 &%verify_sender%& and &%verify_recipient%&.
17323
17324 &*Warning*&: When the router is being run to verify addresses for an incoming
17325 SMTP message, Exim is not running as root, but under its own uid. If the router
17326 accesses any files, you need to make sure that they are accessible to the Exim
17327 user or group.
17328
17329
17330 .option verify_recipient routers&!? boolean true
17331 If this option is false, the router is skipped when verifying recipient
17332 addresses,
17333 delivering in cutthrough mode
17334 or testing recipient verification using &%-bv%&.
17335 See section &<<SECTrouprecon>>& for a list of the order in which preconditions
17336 are evaluated.
17337
17338
17339 .option verify_sender routers&!? boolean true
17340 If this option is false, the router is skipped when verifying sender addresses
17341 or testing sender verification using &%-bvs%&.
17342 See section &<<SECTrouprecon>>& for a list of the order in which preconditions
17343 are evaluated.
17344 .ecindex IIDgenoprou1
17345 .ecindex IIDgenoprou2
17346
17347
17348
17349
17350
17351
17352 . ////////////////////////////////////////////////////////////////////////////
17353 . ////////////////////////////////////////////////////////////////////////////
17354
17355 .chapter "The accept router" "CHID4"
17356 .cindex "&(accept)& router"
17357 .cindex "routers" "&(accept)&"
17358 The &(accept)& router has no private options of its own. Unless it is being
17359 used purely for verification (see &%verify_only%&) a transport is required to
17360 be defined by the generic &%transport%& option. If the preconditions that are
17361 specified by generic options are met, the router accepts the address and queues
17362 it for the given transport. The most common use of this router is for setting
17363 up deliveries to local mailboxes. For example:
17364 .code
17365 localusers:
17366   driver = accept
17367   domains = mydomain.example
17368   check_local_user
17369   transport = local_delivery
17370 .endd
17371 The &%domains%& condition in this example checks the domain of the address, and
17372 &%check_local_user%& checks that the local part is the login of a local user.
17373 When both preconditions are met, the &(accept)& router runs, and queues the
17374 address for the &(local_delivery)& transport.
17375
17376
17377
17378
17379
17380
17381 . ////////////////////////////////////////////////////////////////////////////
17382 . ////////////////////////////////////////////////////////////////////////////
17383
17384 .chapter "The dnslookup router" "CHAPdnslookup"
17385 .scindex IIDdnsrou1 "&(dnslookup)& router"
17386 .scindex IIDdnsrou2 "routers" "&(dnslookup)&"
17387 The &(dnslookup)& router looks up the hosts that handle mail for the
17388 recipient's domain in the DNS. A transport must always be set for this router,
17389 unless &%verify_only%& is set.
17390
17391 If SRV support is configured (see &%check_srv%& below), Exim first searches for
17392 SRV records. If none are found, or if SRV support is not configured,
17393 MX records are looked up. If no MX records exist, address records are sought.
17394 However, &%mx_domains%& can be set to disable the direct use of address
17395 records.
17396
17397 MX records of equal priority are sorted by Exim into a random order. Exim then
17398 looks for address records for the host names obtained from MX or SRV records.
17399 When a host has more than one IP address, they are sorted into a random order,
17400 except that IPv6 addresses are always sorted before IPv4 addresses. If all the
17401 IP addresses found are discarded by a setting of the &%ignore_target_hosts%&
17402 generic option, the router declines.
17403
17404 Unless they have the highest priority (lowest MX value), MX records that point
17405 to the local host, or to any host name that matches &%hosts_treat_as_local%&,
17406 are discarded, together with any other MX records of equal or lower priority.
17407
17408 .cindex "MX record" "pointing to local host"
17409 .cindex "local host" "MX pointing to"
17410 .oindex "&%self%&" "in &(dnslookup)& router"
17411 If the host pointed to by the highest priority MX record, or looked up as an
17412 address record, is the local host, or matches &%hosts_treat_as_local%&, what
17413 happens is controlled by the generic &%self%& option.
17414
17415
17416 .section "Problems with DNS lookups" "SECTprowitdnsloo"
17417 There have been problems with DNS servers when SRV records are looked up.
17418 Some mis-behaving servers return a DNS error or timeout when a non-existent
17419 SRV record is sought. Similar problems have in the past been reported for
17420 MX records. The global &%dns_again_means_nonexist%& option can help with this
17421 problem, but it is heavy-handed because it is a global option.
17422
17423 For this reason, there are two options, &%srv_fail_domains%& and
17424 &%mx_fail_domains%&, that control what happens when a DNS lookup in a
17425 &(dnslookup)& router results in a DNS failure or a &"try again"& response. If
17426 an attempt to look up an SRV or MX record causes one of these results, and the
17427 domain matches the relevant list, Exim behaves as if the DNS had responded &"no
17428 such record"&. In the case of an SRV lookup, this means that the router
17429 proceeds to look for MX records; in the case of an MX lookup, it proceeds to
17430 look for A or AAAA records, unless the domain matches &%mx_domains%&, in which
17431 case routing fails.
17432
17433
17434 .section "Declining addresses by dnslookup" "SECTdnslookupdecline"
17435 .cindex "&(dnslookup)& router" "declines"
17436 There are a few cases where a &(dnslookup)& router will decline to accept
17437 an address; if such a router is expected to handle "all remaining non-local
17438 domains", then it is important to set &%no_more%&.
17439
17440 Reasons for a &(dnslookup)& router to decline currently include:
17441 .ilist
17442 The domain does not exist in DNS
17443 .next
17444 The domain exists but the MX record's host part is just "."; this is a common
17445 convention (borrowed from SRV) used to indicate that there is no such service
17446 for this domain and to not fall back to trying A/AAAA records.
17447 .next
17448 Ditto, but for SRV records, when &%check_srv%& is set on this router.
17449 .next
17450 MX record points to a non-existent host.
17451 .next
17452 MX record points to an IP address and the main section option
17453 &%allow_mx_to_ip%& is not set.
17454 .next
17455 MX records exist and point to valid hosts, but all hosts resolve only to
17456 addresses blocked by the &%ignore_target_hosts%& generic option on this router.
17457 .next
17458 The domain is not syntactically valid (see also &%allow_utf8_domains%& and
17459 &%dns_check_names_pattern%& for handling one variant of this)
17460 .next
17461 &%check_secondary_mx%& is set on this router but the local host can
17462 not be found in the MX records (see below)
17463 .endlist
17464
17465
17466
17467
17468 .section "Private options for dnslookup" "SECID118"
17469 .cindex "options" "&(dnslookup)& router"
17470 The private options for the &(dnslookup)& router are as follows:
17471
17472 .option check_secondary_mx dnslookup boolean false
17473 .cindex "MX record" "checking for secondary"
17474 If this option is set, the router declines unless the local host is found in
17475 (and removed from) the list of hosts obtained by MX lookup. This can be used to
17476 process domains for which the local host is a secondary mail exchanger
17477 differently to other domains. The way in which Exim decides whether a host is
17478 the local host is described in section &<<SECTreclocipadd>>&.
17479
17480
17481 .option check_srv dnslookup string&!! unset
17482 .cindex "SRV record" "enabling use of"
17483 The &(dnslookup)& router supports the use of SRV records (see RFC 2782) in
17484 addition to MX and address records. The support is disabled by default. To
17485 enable SRV support, set the &%check_srv%& option to the name of the service
17486 required. For example,
17487 .code
17488 check_srv = smtp
17489 .endd
17490 looks for SRV records that refer to the normal smtp service. The option is
17491 expanded, so the service name can vary from message to message or address
17492 to address. This might be helpful if SRV records are being used for a
17493 submission service. If the expansion is forced to fail, the &%check_srv%&
17494 option is ignored, and the router proceeds to look for MX records in the
17495 normal way.
17496
17497 When the expansion succeeds, the router searches first for SRV records for
17498 the given service (it assumes TCP protocol). A single SRV record with a
17499 host name that consists of just a single dot indicates &"no such service for
17500 this domain"&; if this is encountered, the router declines. If other kinds of
17501 SRV record are found, they are used to construct a host list for delivery
17502 according to the rules of RFC 2782. MX records are not sought in this case.
17503
17504 When no SRV records are found, MX records (and address records) are sought in
17505 the traditional way. In other words, SRV records take precedence over MX
17506 records, just as MX records take precedence over address records. Note that
17507 this behaviour is not sanctioned by RFC 2782, though a previous draft RFC
17508 defined it. It is apparently believed that MX records are sufficient for email
17509 and that SRV records should not be used for this purpose. However, SRV records
17510 have an additional &"weight"& feature which some people might find useful when
17511 trying to split an SMTP load between hosts of different power.
17512
17513 See section &<<SECTprowitdnsloo>>& above for a discussion of Exim's behaviour
17514 when there is a DNS lookup error.
17515
17516
17517
17518 .option mx_domains dnslookup "domain list&!!" unset
17519 .cindex "MX record" "required to exist"
17520 .cindex "SRV record" "required to exist"
17521 A domain that matches &%mx_domains%& is required to have either an MX or an SRV
17522 record in order to be recognized. (The name of this option could be improved.)
17523 For example, if all the mail hosts in &'fict.example'& are known to have MX
17524 records, except for those in &'discworld.fict.example'&, you could use this
17525 setting:
17526 .code
17527 mx_domains = ! *.discworld.fict.example : *.fict.example
17528 .endd
17529 This specifies that messages addressed to a domain that matches the list but
17530 has no MX record should be bounced immediately instead of being routed using
17531 the address record.
17532
17533
17534 .option mx_fail_domains dnslookup "domain list&!!" unset
17535 If the DNS lookup for MX records for one of the domains in this list causes a
17536 DNS lookup error, Exim behaves as if no MX records were found. See section
17537 &<<SECTprowitdnsloo>>& for more discussion.
17538
17539
17540
17541
17542 .option qualify_single dnslookup boolean true
17543 .cindex "DNS" "resolver options"
17544 .cindex "DNS" "qualifying single-component names"
17545 When this option is true, the resolver option RES_DEFNAMES is set for DNS
17546 lookups. Typically, but not standardly, this causes the resolver to qualify
17547 single-component names with the default domain. For example, on a machine
17548 called &'dictionary.ref.example'&, the domain &'thesaurus'& would be changed to
17549 &'thesaurus.ref.example'& inside the resolver. For details of what your
17550 resolver actually does, consult your man pages for &'resolver'& and
17551 &'resolv.conf'&.
17552
17553
17554
17555 .option rewrite_headers dnslookup boolean true
17556 .cindex "rewriting" "header lines"
17557 .cindex "header lines" "rewriting"
17558 If the domain name in the address that is being processed is not fully
17559 qualified, it may be expanded to its full form by a DNS lookup. For example, if
17560 an address is specified as &'dormouse@teaparty'&, the domain might be
17561 expanded to &'teaparty.wonderland.fict.example'&. Domain expansion can also
17562 occur as a result of setting the &%widen_domains%& option. If
17563 &%rewrite_headers%& is true, all occurrences of the abbreviated domain name in
17564 any &'Bcc:'&, &'Cc:'&, &'From:'&, &'Reply-to:'&, &'Sender:'&, and &'To:'&
17565 header lines of the message are rewritten with the full domain name.
17566
17567 This option should be turned off only when it is known that no message is
17568 ever going to be sent outside an environment where the abbreviation makes
17569 sense.
17570
17571 When an MX record is looked up in the DNS and matches a wildcard record, name
17572 servers normally return a record containing the name that has been looked up,
17573 making it impossible to detect whether a wildcard was present or not. However,
17574 some name servers have recently been seen to return the wildcard entry. If the
17575 name returned by a DNS lookup begins with an asterisk, it is not used for
17576 header rewriting.
17577
17578
17579 .option same_domain_copy_routing dnslookup boolean false
17580 .cindex "address" "copying routing"
17581 Addresses with the same domain are normally routed by the &(dnslookup)& router
17582 to the same list of hosts. However, this cannot be presumed, because the router
17583 options and preconditions may refer to the local part of the address. By
17584 default, therefore, Exim routes each address in a message independently. DNS
17585 servers run caches, so repeated DNS lookups are not normally expensive, and in
17586 any case, personal messages rarely have more than a few recipients.
17587
17588 If you are running mailing lists with large numbers of subscribers at the same
17589 domain, and you are using a &(dnslookup)& router which is independent of the
17590 local part, you can set &%same_domain_copy_routing%& to bypass repeated DNS
17591 lookups for identical domains in one message. In this case, when &(dnslookup)&
17592 routes an address to a remote transport, any other unrouted addresses in the
17593 message that have the same domain are automatically given the same routing
17594 without processing them independently,
17595 provided the following conditions are met:
17596
17597 .ilist
17598 No router that processed the address specified &%headers_add%& or
17599 &%headers_remove%&.
17600 .next
17601 The router did not change the address in any way, for example, by &"widening"&
17602 the domain.
17603 .endlist
17604
17605
17606
17607
17608 .option search_parents dnslookup boolean false
17609 .cindex "DNS" "resolver options"
17610 When this option is true, the resolver option RES_DNSRCH is set for DNS
17611 lookups. This is different from the &%qualify_single%& option in that it
17612 applies to domains containing dots. Typically, but not standardly, it causes
17613 the resolver to search for the name in the current domain and in parent
17614 domains. For example, on a machine in the &'fict.example'& domain, if looking
17615 up &'teaparty.wonderland'& failed, the resolver would try
17616 &'teaparty.wonderland.fict.example'&. For details of what your resolver
17617 actually does, consult your man pages for &'resolver'& and &'resolv.conf'&.
17618
17619 Setting this option true can cause problems in domains that have a wildcard MX
17620 record, because any domain that does not have its own MX record matches the
17621 local wildcard.
17622
17623
17624
17625 .option srv_fail_domains dnslookup "domain list&!!" unset
17626 If the DNS lookup for SRV records for one of the domains in this list causes a
17627 DNS lookup error, Exim behaves as if no SRV records were found. See section
17628 &<<SECTprowitdnsloo>>& for more discussion.
17629
17630
17631
17632
17633 .option widen_domains dnslookup "string list" unset
17634 .cindex "domain" "partial; widening"
17635 If a DNS lookup fails and this option is set, each of its strings in turn is
17636 added onto the end of the domain, and the lookup is tried again. For example,
17637 if
17638 .code
17639 widen_domains = fict.example:ref.example
17640 .endd
17641 is set and a lookup of &'klingon.dictionary'& fails,
17642 &'klingon.dictionary.fict.example'& is looked up, and if this fails,
17643 &'klingon.dictionary.ref.example'& is tried. Note that the &%qualify_single%&
17644 and &%search_parents%& options can cause some widening to be undertaken inside
17645 the DNS resolver. &%widen_domains%& is not applied to sender addresses
17646 when verifying, unless &%rewrite_headers%& is false (not the default).
17647
17648
17649 .section "Effect of qualify_single and search_parents" "SECID119"
17650 When a domain from an envelope recipient is changed by the resolver as a result
17651 of the &%qualify_single%& or &%search_parents%& options, Exim rewrites the
17652 corresponding address in the message's header lines unless &%rewrite_headers%&
17653 is set false. Exim then re-routes the address, using the full domain.
17654
17655 These two options affect only the DNS lookup that takes place inside the router
17656 for the domain of the address that is being routed. They do not affect lookups
17657 such as that implied by
17658 .code
17659 domains = @mx_any
17660 .endd
17661 that may happen while processing a router precondition before the router is
17662 entered. No widening ever takes place for these lookups.
17663 .ecindex IIDdnsrou1
17664 .ecindex IIDdnsrou2
17665
17666
17667
17668
17669
17670
17671
17672
17673
17674 . ////////////////////////////////////////////////////////////////////////////
17675 . ////////////////////////////////////////////////////////////////////////////
17676
17677 .chapter "The ipliteral router" "CHID5"
17678 .cindex "&(ipliteral)& router"
17679 .cindex "domain literal" "routing"
17680 .cindex "routers" "&(ipliteral)&"
17681 This router has no private options. Unless it is being used purely for
17682 verification (see &%verify_only%&) a transport is required to be defined by the
17683 generic &%transport%& option. The router accepts the address if its domain part
17684 takes the form of an RFC 2822 domain literal. For example, the &(ipliteral)&
17685 router handles the address
17686 .code
17687 root@[192.168.1.1]
17688 .endd
17689 by setting up delivery to the host with that IP address. IPv4 domain literals
17690 consist of an IPv4 address enclosed in square brackets. IPv6 domain literals
17691 are similar, but the address is preceded by &`ipv6:`&. For example:
17692 .code
17693 postmaster@[ipv6:fe80::a00:20ff:fe86:a061.5678]
17694 .endd
17695 Exim allows &`ipv4:`& before IPv4 addresses, for consistency, and on the
17696 grounds that sooner or later somebody will try it.
17697
17698 .oindex "&%self%&" "in &(ipliteral)& router"
17699 If the IP address matches something in &%ignore_target_hosts%&, the router
17700 declines. If an IP literal turns out to refer to the local host, the generic
17701 &%self%& option determines what happens.
17702
17703 The RFCs require support for domain literals; however, their use is
17704 controversial in today's Internet. If you want to use this router, you must
17705 also set the main configuration option &%allow_domain_literals%&. Otherwise,
17706 Exim will not recognize the domain literal syntax in addresses.
17707
17708
17709
17710 . ////////////////////////////////////////////////////////////////////////////
17711 . ////////////////////////////////////////////////////////////////////////////
17712
17713 .chapter "The iplookup router" "CHID6"
17714 .cindex "&(iplookup)& router"
17715 .cindex "routers" "&(iplookup)&"
17716 The &(iplookup)& router was written to fulfil a specific requirement in
17717 Cambridge University (which in fact no longer exists). For this reason, it is
17718 not included in the binary of Exim by default. If you want to include it, you
17719 must set
17720 .code
17721 ROUTER_IPLOOKUP=yes
17722 .endd
17723 in your &_Local/Makefile_& configuration file.
17724
17725 The &(iplookup)& router routes an address by sending it over a TCP or UDP
17726 connection to one or more specific hosts. The host can then return the same or
17727 a different address &-- in effect rewriting the recipient address in the
17728 message's envelope. The new address is then passed on to subsequent routers. If
17729 this process fails, the address can be passed on to other routers, or delivery
17730 can be deferred. Since &(iplookup)& is just a rewriting router, a transport
17731 must not be specified for it.
17732
17733 .cindex "options" "&(iplookup)& router"
17734 .option hosts iplookup string unset
17735 This option must be supplied. Its value is a colon-separated list of host
17736 names. The hosts are looked up using &[gethostbyname()]&
17737 (or &[getipnodebyname()]& when available)
17738 and are tried in order until one responds to the query. If none respond, what
17739 happens is controlled by &%optional%&.
17740
17741
17742 .option optional iplookup boolean false
17743 If &%optional%& is true, if no response is obtained from any host, the address
17744 is passed to the next router, overriding &%no_more%&. If &%optional%& is false,
17745 delivery to the address is deferred.
17746
17747
17748 .option port iplookup integer 0
17749 .cindex "port" "&(iplookup)& router"
17750 This option must be supplied. It specifies the port number for the TCP or UDP
17751 call.
17752
17753
17754 .option protocol iplookup string udp
17755 This option can be set to &"udp"& or &"tcp"& to specify which of the two
17756 protocols is to be used.
17757
17758
17759 .option query iplookup string&!! "see below"
17760 This defines the content of the query that is sent to the remote hosts. The
17761 default value is:
17762 .code
17763 $local_part@$domain $local_part@$domain
17764 .endd
17765 The repetition serves as a way of checking that a response is to the correct
17766 query in the default case (see &%response_pattern%& below).
17767
17768
17769 .option reroute iplookup string&!! unset
17770 If this option is not set, the rerouted address is precisely the byte string
17771 returned by the remote host, up to the first white space, if any. If set, the
17772 string is expanded to form the rerouted address. It can include parts matched
17773 in the response by &%response_pattern%& by means of numeric variables such as
17774 &$1$&, &$2$&, etc. The variable &$0$& refers to the entire input string,
17775 whether or not a pattern is in use. In all cases, the rerouted address must end
17776 up in the form &'local_part@domain'&.
17777
17778
17779 .option response_pattern iplookup string unset
17780 This option can be set to a regular expression that is applied to the string
17781 returned from the remote host. If the pattern does not match the response, the
17782 router declines. If &%response_pattern%& is not set, no checking of the
17783 response is done, unless the query was defaulted, in which case there is a
17784 check that the text returned after the first white space is the original
17785 address. This checks that the answer that has been received is in response to
17786 the correct question. For example, if the response is just a new domain, the
17787 following could be used:
17788 .code
17789 response_pattern = ^([^@]+)$
17790 reroute = $local_part@$1
17791 .endd
17792
17793 .option timeout iplookup time 5s
17794 This specifies the amount of time to wait for a response from the remote
17795 machine. The same timeout is used for the &[connect()]& function for a TCP
17796 call. It does not apply to UDP.
17797
17798
17799
17800
17801 . ////////////////////////////////////////////////////////////////////////////
17802 . ////////////////////////////////////////////////////////////////////////////
17803
17804 .chapter "The manualroute router" "CHID7"
17805 .scindex IIDmanrou1 "&(manualroute)& router"
17806 .scindex IIDmanrou2 "routers" "&(manualroute)&"
17807 .cindex "domain" "manually routing"
17808 The &(manualroute)& router is so-called because it provides a way of manually
17809 routing an address according to its domain. It is mainly used when you want to
17810 route addresses to remote hosts according to your own rules, bypassing the
17811 normal DNS routing that looks up MX records. However, &(manualroute)& can also
17812 route to local transports, a facility that may be useful if you want to save
17813 messages for dial-in hosts in local files.
17814
17815 The &(manualroute)& router compares a list of domain patterns with the domain
17816 it is trying to route. If there is no match, the router declines. Each pattern
17817 has associated with it a list of hosts and some other optional data, which may
17818 include a transport. The combination of a pattern and its data is called a
17819 &"routing rule"&. For patterns that do not have an associated transport, the
17820 generic &%transport%& option must specify a transport, unless the router is
17821 being used purely for verification (see &%verify_only%&).
17822
17823 .vindex "&$host$&"
17824 In the case of verification, matching the domain pattern is sufficient for the
17825 router to accept the address. When actually routing an address for delivery,
17826 an address that matches a domain pattern is queued for the associated
17827 transport. If the transport is not a local one, a host list must be associated
17828 with the pattern; IP addresses are looked up for the hosts, and these are
17829 passed to the transport along with the mail address. For local transports, a
17830 host list is optional. If it is present, it is passed in &$host$& as a single
17831 text string.
17832
17833 The list of routing rules can be provided as an inline string in
17834 &%route_list%&, or the data can be obtained by looking up the domain in a file
17835 or database by setting &%route_data%&. Only one of these settings may appear in
17836 any one instance of &(manualroute)&. The format of routing rules is described
17837 below, following the list of private options.
17838
17839
17840 .section "Private options for manualroute" "SECTprioptman"
17841
17842 .cindex "options" "&(manualroute)& router"
17843 The private options for the &(manualroute)& router are as follows:
17844
17845 .option host_all_ignored manualroute string defer
17846 See &%host_find_failed%&.
17847
17848 .option host_find_failed manualroute string freeze
17849 This option controls what happens when &(manualroute)& tries to find an IP
17850 address for a host, and the host does not exist. The option can be set to one
17851 of the following values:
17852 .code
17853 decline
17854 defer
17855 fail
17856 freeze
17857 ignore
17858 pass
17859 .endd
17860 The default (&"freeze"&) assumes that this state is a serious configuration
17861 error. The difference between &"pass"& and &"decline"& is that the former
17862 forces the address to be passed to the next router (or the router defined by
17863 &%pass_router%&),
17864 .oindex "&%more%&"
17865 overriding &%no_more%&, whereas the latter passes the address to the next
17866 router only if &%more%& is true.
17867
17868 The value &"ignore"& causes Exim to completely ignore a host whose IP address
17869 cannot be found. If all the hosts in the list are ignored, the behaviour is
17870 controlled by the &%host_all_ignored%& option. This takes the same values
17871 as &%host_find_failed%&, except that it cannot be set to &"ignore"&.
17872
17873 The &%host_find_failed%& option applies only to a definite &"does not exist"&
17874 state; if a host lookup gets a temporary error, delivery is deferred unless the
17875 generic &%pass_on_timeout%& option is set.
17876
17877
17878 .option hosts_randomize manualroute boolean false
17879 .cindex "randomized host list"
17880 .cindex "host" "list of; randomized"
17881 If this option is set, the order of the items in a host list in a routing rule
17882 is randomized each time the list is used, unless an option in the routing rule
17883 overrides (see below). Randomizing the order of a host list can be used to do
17884 crude load sharing. However, if more than one mail address is routed by the
17885 same router to the same host list, the host lists are considered to be the same
17886 (even though they may be randomized into different orders) for the purpose of
17887 deciding whether to batch the deliveries into a single SMTP transaction.
17888
17889 When &%hosts_randomize%& is true, a host list may be split
17890 into groups whose order is separately randomized. This makes it possible to
17891 set up MX-like behaviour. The boundaries between groups are indicated by an
17892 item that is just &`+`& in the host list. For example:
17893 .code
17894 route_list = * host1:host2:host3:+:host4:host5
17895 .endd
17896 The order of the first three hosts and the order of the last two hosts is
17897 randomized for each use, but the first three always end up before the last two.
17898 If &%hosts_randomize%& is not set, a &`+`& item in the list is ignored. If a
17899 randomized host list is passed to an &(smtp)& transport that also has
17900 &%hosts_randomize set%&, the list is not re-randomized.
17901
17902
17903 .option route_data manualroute string&!! unset
17904 If this option is set, it must expand to yield the data part of a routing rule.
17905 Typically, the expansion string includes a lookup based on the domain. For
17906 example:
17907 .code
17908 route_data = ${lookup{$domain}dbm{/etc/routes}}
17909 .endd
17910 If the expansion is forced to fail, or the result is an empty string, the
17911 router declines. Other kinds of expansion failure cause delivery to be
17912 deferred.
17913
17914
17915 .option route_list manualroute "string list" unset
17916 This string is a list of routing rules, in the form defined below. Note that,
17917 unlike most string lists, the items are separated by semicolons. This is so
17918 that they may contain colon-separated host lists.
17919
17920
17921 .option same_domain_copy_routing manualroute boolean false
17922 .cindex "address" "copying routing"
17923 Addresses with the same domain are normally routed by the &(manualroute)&
17924 router to the same list of hosts. However, this cannot be presumed, because the
17925 router options and preconditions may refer to the local part of the address. By
17926 default, therefore, Exim routes each address in a message independently. DNS
17927 servers run caches, so repeated DNS lookups are not normally expensive, and in
17928 any case, personal messages rarely have more than a few recipients.
17929
17930 If you are running mailing lists with large numbers of subscribers at the same
17931 domain, and you are using a &(manualroute)& router which is independent of the
17932 local part, you can set &%same_domain_copy_routing%& to bypass repeated DNS
17933 lookups for identical domains in one message. In this case, when
17934 &(manualroute)& routes an address to a remote transport, any other unrouted
17935 addresses in the message that have the same domain are automatically given the
17936 same routing without processing them independently. However, this is only done
17937 if &%headers_add%& and &%headers_remove%& are unset.
17938
17939
17940
17941
17942 .section "Routing rules in route_list" "SECID120"
17943 The value of &%route_list%& is a string consisting of a sequence of routing
17944 rules, separated by semicolons. If a semicolon is needed in a rule, it can be
17945 entered as two semicolons. Alternatively, the list separator can be changed as
17946 described (for colon-separated lists) in section &<<SECTlistconstruct>>&.
17947 Empty rules are ignored. The format of each rule is
17948 .display
17949 <&'domain pattern'&>  <&'list of hosts'&>  <&'options'&>
17950 .endd
17951 The following example contains two rules, each with a simple domain pattern and
17952 no options:
17953 .code
17954 route_list = \
17955   dict.ref.example  mail-1.ref.example:mail-2.ref.example ; \
17956   thes.ref.example  mail-3.ref.example:mail-4.ref.example
17957 .endd
17958 The three parts of a rule are separated by white space. The pattern and the
17959 list of hosts can be enclosed in quotes if necessary, and if they are, the
17960 usual quoting rules apply. Each rule in a &%route_list%& must start with a
17961 single domain pattern, which is the only mandatory item in the rule. The
17962 pattern is in the same format as one item in a domain list (see section
17963 &<<SECTdomainlist>>&),
17964 except that it may not be the name of an interpolated file.
17965 That is, it may be wildcarded, or a regular expression, or a file or database
17966 lookup (with semicolons doubled, because of the use of semicolon as a separator
17967 in a &%route_list%&).
17968
17969 The rules in &%route_list%& are searched in order until one of the patterns
17970 matches the domain that is being routed. The list of hosts and then options are
17971 then used as described below. If there is no match, the router declines. When
17972 &%route_list%& is set, &%route_data%& must not be set.
17973
17974
17975
17976 .section "Routing rules in route_data" "SECID121"
17977 The use of &%route_list%& is convenient when there are only a small number of
17978 routing rules. For larger numbers, it is easier to use a file or database to
17979 hold the routing information, and use the &%route_data%& option instead.
17980 The value of &%route_data%& is a list of hosts, followed by (optional) options.
17981 Most commonly, &%route_data%& is set as a string that contains an
17982 expansion lookup. For example, suppose we place two routing rules in a file
17983 like this:
17984 .code
17985 dict.ref.example:  mail-1.ref.example:mail-2.ref.example
17986 thes.ref.example:  mail-3.ref.example:mail-4.ref.example
17987 .endd
17988 This data can be accessed by setting
17989 .code
17990 route_data = ${lookup{$domain}lsearch{/the/file/name}}
17991 .endd
17992 Failure of the lookup results in an empty string, causing the router to
17993 decline. However, you do not have to use a lookup in &%route_data%&. The only
17994 requirement is that the result of expanding the string is a list of hosts,
17995 possibly followed by options, separated by white space. The list of hosts must
17996 be enclosed in quotes if it contains white space.
17997
17998
17999
18000
18001 .section "Format of the list of hosts" "SECID122"
18002 A list of hosts, whether obtained via &%route_data%& or &%route_list%&, is
18003 always separately expanded before use. If the expansion fails, the router
18004 declines. The result of the expansion must be a colon-separated list of names
18005 and/or IP addresses, optionally also including ports. The format of each item
18006 in the list is described in the next section. The list separator can be changed
18007 as described in section &<<SECTlistconstruct>>&.
18008
18009 If the list of hosts was obtained from a &%route_list%& item, the following
18010 variables are set during its expansion:
18011
18012 .ilist
18013 .cindex "numerical variables (&$1$& &$2$&  etc)" "in &(manualroute)& router"
18014 If the domain was matched against a regular expression, the numeric variables
18015 &$1$&, &$2$&, etc. may be set. For example:
18016 .code
18017 route_list = ^domain(\d+)   host-$1.text.example
18018 .endd
18019 .next
18020 &$0$& is always set to the entire domain.
18021 .next
18022 &$1$& is also set when partial matching is done in a file lookup.
18023
18024 .next
18025 .vindex "&$value$&"
18026 If the pattern that matched the domain was a lookup item, the data that was
18027 looked up is available in the expansion variable &$value$&. For example:
18028 .code
18029 route_list = lsearch;;/some/file.routes  $value
18030 .endd
18031 .endlist
18032
18033 Note the doubling of the semicolon in the pattern that is necessary because
18034 semicolon is the default route list separator.
18035
18036
18037
18038 .section "Format of one host item" "SECTformatonehostitem"
18039 Each item in the list of hosts is either a host name or an IP address,
18040 optionally with an attached port number. When no port is given, an IP address
18041 is not enclosed in brackets. When a port is specified, it overrides the port
18042 specification on the transport. The port is separated from the name or address
18043 by a colon. This leads to some complications:
18044
18045 .ilist
18046 Because colon is the default separator for the list of hosts, either
18047 the colon that specifies a port must be doubled, or the list separator must
18048 be changed. The following two examples have the same effect:
18049 .code
18050 route_list = * "host1.tld::1225 : host2.tld::1226"
18051 route_list = * "<+ host1.tld:1225 + host2.tld:1226"
18052 .endd
18053 .next
18054 When IPv6 addresses are involved, it gets worse, because they contain
18055 colons of their own. To make this case easier, it is permitted to
18056 enclose an IP address (either v4 or v6) in square brackets if a port
18057 number follows. For example:
18058 .code
18059 route_list = * "</ [10.1.1.1]:1225 / [::1]:1226"
18060 .endd
18061 .endlist
18062
18063 .section "How the list of hosts is used" "SECThostshowused"
18064 When an address is routed to an &(smtp)& transport by &(manualroute)&, each of
18065 the hosts is tried, in the order specified, when carrying out the SMTP
18066 delivery. However, the order can be changed by setting the &%hosts_randomize%&
18067 option, either on the router (see section &<<SECTprioptman>>& above), or on the
18068 transport.
18069
18070 Hosts may be listed by name or by IP address. An unadorned name in the list of
18071 hosts is interpreted as a host name. A name that is followed by &`/MX`& is
18072 interpreted as an indirection to a sublist of hosts obtained by looking up MX
18073 records in the DNS. For example:
18074 .code
18075 route_list = *  x.y.z:p.q.r/MX:e.f.g
18076 .endd
18077 If this feature is used with a port specifier, the port must come last. For
18078 example:
18079 .code
18080 route_list = *  dom1.tld/mx::1225
18081 .endd
18082 If the &%hosts_randomize%& option is set, the order of the items in the list is
18083 randomized before any lookups are done. Exim then scans the list; for any name
18084 that is not followed by &`/MX`& it looks up an IP address. If this turns out to
18085 be an interface on the local host and the item is not the first in the list,
18086 Exim discards it and any subsequent items. If it is the first item, what
18087 happens is controlled by the
18088 .oindex "&%self%&" "in &(manualroute)& router"
18089 &%self%& option of the router.
18090
18091 A name on the list that is followed by &`/MX`& is replaced with the list of
18092 hosts obtained by looking up MX records for the name. This is always a DNS
18093 lookup; the &%bydns%& and &%byname%& options (see section &<<SECThowoptused>>&
18094 below) are not relevant here. The order of these hosts is determined by the
18095 preference values in the MX records, according to the usual rules. Because
18096 randomizing happens before the MX lookup, it does not affect the order that is
18097 defined by MX preferences.
18098
18099 If the local host is present in the sublist obtained from MX records, but is
18100 not the most preferred host in that list, it and any equally or less
18101 preferred hosts are removed before the sublist is inserted into the main list.
18102
18103 If the local host is the most preferred host in the MX list, what happens
18104 depends on where in the original list of hosts the &`/MX`& item appears. If it
18105 is not the first item (that is, there are previous hosts in the main list),
18106 Exim discards this name and any subsequent items in the main list.
18107
18108 If the MX item is first in the list of hosts, and the local host is the
18109 most preferred host, what happens is controlled by the &%self%& option of the
18110 router.
18111
18112 DNS failures when lookup up the MX records are treated in the same way as DNS
18113 failures when looking up IP addresses: &%pass_on_timeout%& and
18114 &%host_find_failed%& are used when relevant.
18115
18116 The generic &%ignore_target_hosts%& option applies to all hosts in the list,
18117 whether obtained from an MX lookup or not.
18118
18119
18120
18121 .section "How the options are used" "SECThowoptused"
18122 The options are a sequence of words; in practice no more than three are ever
18123 present. One of the words can be the name of a transport; this overrides the
18124 &%transport%& option on the router for this particular routing rule only. The
18125 other words (if present) control randomization of the list of hosts on a
18126 per-rule basis, and how the IP addresses of the hosts are to be found when
18127 routing to a remote transport. These options are as follows:
18128
18129 .ilist
18130 &%randomize%&: randomize the order of the hosts in this list, overriding the
18131 setting of &%hosts_randomize%& for this routing rule only.
18132 .next
18133 &%no_randomize%&: do not randomize the order of the hosts in this list,
18134 overriding the setting of &%hosts_randomize%& for this routing rule only.
18135 .next
18136 &%byname%&: use &[getipnodebyname()]& (&[gethostbyname()]& on older systems) to
18137 find IP addresses. This function may ultimately cause a DNS lookup, but it may
18138 also look in &_/etc/hosts_& or other sources of information.
18139 .next
18140 &%bydns%&: look up address records for the hosts directly in the DNS; fail if
18141 no address records are found. If there is a temporary DNS error (such as a
18142 timeout), delivery is deferred.
18143 .endlist
18144
18145 For example:
18146 .code
18147 route_list = domain1  host1:host2:host3  randomize bydns;\
18148              domain2  host4:host5
18149 .endd
18150 If neither &%byname%& nor &%bydns%& is given, Exim behaves as follows: First, a
18151 DNS lookup is done. If this yields anything other than HOST_NOT_FOUND, that
18152 result is used. Otherwise, Exim goes on to try a call to &[getipnodebyname()]&
18153 or &[gethostbyname()]&, and the result of the lookup is the result of that
18154 call.
18155
18156 &*Warning*&: It has been discovered that on some systems, if a DNS lookup
18157 called via &[getipnodebyname()]& times out, HOST_NOT_FOUND is returned
18158 instead of TRY_AGAIN. That is why the default action is to try a DNS
18159 lookup first. Only if that gives a definite &"no such host"& is the local
18160 function called.
18161
18162
18163
18164 If no IP address for a host can be found, what happens is controlled by the
18165 &%host_find_failed%& option.
18166
18167 .vindex "&$host$&"
18168 When an address is routed to a local transport, IP addresses are not looked up.
18169 The host list is passed to the transport in the &$host$& variable.
18170
18171
18172
18173 .section "Manualroute examples" "SECID123"
18174 In some of the examples that follow, the presence of the &%remote_smtp%&
18175 transport, as defined in the default configuration file, is assumed:
18176
18177 .ilist
18178 .cindex "smart host" "example router"
18179 The &(manualroute)& router can be used to forward all external mail to a
18180 &'smart host'&. If you have set up, in the main part of the configuration, a
18181 named domain list that contains your local domains, for example:
18182 .code
18183 domainlist local_domains = my.domain.example
18184 .endd
18185 You can arrange for all other domains to be routed to a smart host by making
18186 your first router something like this:
18187 .code
18188 smart_route:
18189   driver = manualroute
18190   domains = !+local_domains
18191   transport = remote_smtp
18192   route_list = * smarthost.ref.example
18193 .endd
18194 This causes all non-local addresses to be sent to the single host
18195 &'smarthost.ref.example'&. If a colon-separated list of smart hosts is given,
18196 they are tried in order
18197 (but you can use &%hosts_randomize%& to vary the order each time).
18198 Another way of configuring the same thing is this:
18199 .code
18200 smart_route:
18201   driver = manualroute
18202   transport = remote_smtp
18203   route_list = !+local_domains  smarthost.ref.example
18204 .endd
18205 There is no difference in behaviour between these two routers as they stand.
18206 However, they behave differently if &%no_more%& is added to them. In the first
18207 example, the router is skipped if the domain does not match the &%domains%&
18208 precondition; the following router is always tried. If the router runs, it
18209 always matches the domain and so can never decline. Therefore, &%no_more%&
18210 would have no effect. In the second case, the router is never skipped; it
18211 always runs. However, if it doesn't match the domain, it declines. In this case
18212 &%no_more%& would prevent subsequent routers from running.
18213
18214 .next
18215 .cindex "mail hub example"
18216 A &'mail hub'& is a host which receives mail for a number of domains via MX
18217 records in the DNS and delivers it via its own private routing mechanism. Often
18218 the final destinations are behind a firewall, with the mail hub being the one
18219 machine that can connect to machines both inside and outside the firewall. The
18220 &(manualroute)& router is usually used on a mail hub to route incoming messages
18221 to the correct hosts. For a small number of domains, the routing can be inline,
18222 using the &%route_list%& option, but for a larger number a file or database
18223 lookup is easier to manage.
18224
18225 If the domain names are in fact the names of the machines to which the mail is
18226 to be sent by the mail hub, the configuration can be quite simple. For
18227 example:
18228 .code
18229 hub_route:
18230   driver = manualroute
18231   transport = remote_smtp
18232   route_list = *.rhodes.tvs.example  $domain
18233 .endd
18234 This configuration routes domains that match &`*.rhodes.tvs.example`& to hosts
18235 whose names are the same as the mail domains. A similar approach can be taken
18236 if the host name can be obtained from the domain name by a string manipulation
18237 that the expansion facilities can handle. Otherwise, a lookup based on the
18238 domain can be used to find the host:
18239 .code
18240 through_firewall:
18241   driver = manualroute
18242   transport = remote_smtp
18243   route_data = ${lookup {$domain} cdb {/internal/host/routes}}
18244 .endd
18245 The result of the lookup must be the name or IP address of the host (or
18246 hosts) to which the address is to be routed. If the lookup fails, the route
18247 data is empty, causing the router to decline. The address then passes to the
18248 next router.
18249
18250 .next
18251 .cindex "batched SMTP output example"
18252 .cindex "SMTP" "batched outgoing; example"
18253 You can use &(manualroute)& to deliver messages to pipes or files in batched
18254 SMTP format for onward transportation by some other means. This is one way of
18255 storing mail for a dial-up host when it is not connected. The route list entry
18256 can be as simple as a single domain name in a configuration like this:
18257 .code
18258 save_in_file:
18259   driver = manualroute
18260   transport = batchsmtp_appendfile
18261   route_list = saved.domain.example
18262 .endd
18263 though often a pattern is used to pick up more than one domain. If there are
18264 several domains or groups of domains with different transport requirements,
18265 different transports can be listed in the routing information:
18266 .code
18267 save_in_file:
18268   driver = manualroute
18269   route_list = \
18270     *.saved.domain1.example  $domain  batch_appendfile; \
18271     *.saved.domain2.example  \
18272       ${lookup{$domain}dbm{/domain2/hosts}{$value}fail} \
18273       batch_pipe
18274 .endd
18275 .vindex "&$domain$&"
18276 .vindex "&$host$&"
18277 The first of these just passes the domain in the &$host$& variable, which
18278 doesn't achieve much (since it is also in &$domain$&), but the second does a
18279 file lookup to find a value to pass, causing the router to decline to handle
18280 the address if the lookup fails.
18281
18282 .next
18283 .cindex "UUCP" "example of router for"
18284 Routing mail directly to UUCP software is a specific case of the use of
18285 &(manualroute)& in a gateway to another mail environment. This is an example of
18286 one way it can be done:
18287 .code
18288 # Transport
18289 uucp:
18290   driver = pipe
18291   user = nobody
18292   command = /usr/local/bin/uux -r - \
18293     ${substr_-5:$host}!rmail ${local_part}
18294   return_fail_output = true
18295
18296 # Router
18297 uucphost:
18298   transport = uucp
18299   driver = manualroute
18300   route_data = \
18301     ${lookup{$domain}lsearch{/usr/local/exim/uucphosts}}
18302 .endd
18303 The file &_/usr/local/exim/uucphosts_& contains entries like
18304 .code
18305 darksite.ethereal.example:           darksite.UUCP
18306 .endd
18307 It can be set up more simply without adding and removing &".UUCP"& but this way
18308 makes clear the distinction between the domain name
18309 &'darksite.ethereal.example'& and the UUCP host name &'darksite'&.
18310 .endlist
18311 .ecindex IIDmanrou1
18312 .ecindex IIDmanrou2
18313
18314
18315
18316
18317
18318
18319
18320
18321 . ////////////////////////////////////////////////////////////////////////////
18322 . ////////////////////////////////////////////////////////////////////////////
18323
18324 .chapter "The queryprogram router" "CHAPdriverlast"
18325 .scindex IIDquerou1 "&(queryprogram)& router"
18326 .scindex IIDquerou2 "routers" "&(queryprogram)&"
18327 .cindex "routing" "by external program"
18328 The &(queryprogram)& router routes an address by running an external command
18329 and acting on its output. This is an expensive way to route, and is intended
18330 mainly for use in lightly-loaded systems, or for performing experiments.
18331 However, if it is possible to use the precondition options (&%domains%&,
18332 &%local_parts%&, etc) to skip this router for most addresses, it could sensibly
18333 be used in special cases, even on a busy host. There are the following private
18334 options:
18335 .cindex "options" "&(queryprogram)& router"
18336
18337 .option command queryprogram string&!! unset
18338 This option must be set. It specifies the command that is to be run. The
18339 command is split up into a command name and arguments, and then each is
18340 expanded separately (exactly as for a &(pipe)& transport, described in chapter
18341 &<<CHAPpipetransport>>&).
18342
18343
18344 .option command_group queryprogram string unset
18345 .cindex "gid (group id)" "in &(queryprogram)& router"
18346 This option specifies a gid to be set when running the command while routing an
18347 address for deliver. It must be set if &%command_user%& specifies a numerical
18348 uid. If it begins with a digit, it is interpreted as the numerical value of the
18349 gid. Otherwise it is looked up using &[getgrnam()]&.
18350
18351
18352 .option command_user queryprogram string unset
18353 .cindex "uid (user id)" "for &(queryprogram)&"
18354 This option must be set. It specifies the uid which is set when running the
18355 command while routing an address for delivery. If the value begins with a digit,
18356 it is interpreted as the numerical value of the uid. Otherwise, it is looked up
18357 using &[getpwnam()]& to obtain a value for the uid and, if &%command_group%& is
18358 not set, a value for the gid also.
18359
18360 &*Warning:*& Changing uid and gid is possible only when Exim is running as
18361 root, which it does during a normal delivery in a conventional configuration.
18362 However, when an address is being verified during message reception, Exim is
18363 usually running as the Exim user, not as root. If the &(queryprogram)& router
18364 is called from a non-root process, Exim cannot change uid or gid before running
18365 the command. In this circumstance the command runs under the current uid and
18366 gid.
18367
18368
18369 .option current_directory queryprogram string /
18370 This option specifies an absolute path which is made the current directory
18371 before running the command.
18372
18373
18374 .option timeout queryprogram time 1h
18375 If the command does not complete within the timeout period, its process group
18376 is killed and the message is frozen. A value of zero time specifies no
18377 timeout.
18378
18379
18380 The standard output of the command is connected to a pipe, which is read when
18381 the command terminates. It should consist of a single line of output,
18382 containing up to five fields, separated by white space. The maximum length of
18383 the line is 1023 characters. Longer lines are silently truncated. The first
18384 field is one of the following words (case-insensitive):
18385
18386 .ilist
18387 &'Accept'&: routing succeeded; the remaining fields specify what to do (see
18388 below).
18389 .next
18390 &'Decline'&: the router declines; pass the address to the next router, unless
18391 &%no_more%& is set.
18392 .next
18393 &'Fail'&: routing failed; do not pass the address to any more routers. Any
18394 subsequent text on the line is an error message. If the router is run as part
18395 of address verification during an incoming SMTP message, the message is
18396 included in the SMTP response.
18397 .next
18398 &'Defer'&: routing could not be completed at this time; try again later. Any
18399 subsequent text on the line is an error message which is logged. It is not
18400 included in any SMTP response.
18401 .next
18402 &'Freeze'&: the same as &'defer'&, except that the message is frozen.
18403 .next
18404 &'Pass'&: pass the address to the next router (or the router specified by
18405 &%pass_router%&), overriding &%no_more%&.
18406 .next
18407 &'Redirect'&: the message is redirected. The remainder of the line is a list of
18408 new addresses, which are routed independently, starting with the first router,
18409 or the router specified by &%redirect_router%&, if set.
18410 .endlist
18411
18412 When the first word is &'accept'&, the remainder of the line consists of a
18413 number of keyed data values, as follows (split into two lines here, to fit on
18414 the page):
18415 .code
18416 ACCEPT TRANSPORT=<transport> HOSTS=<list of hosts>
18417 LOOKUP=byname|bydns DATA=<text>
18418 .endd
18419 The data items can be given in any order, and all are optional. If no transport
18420 is included, the transport specified by the generic &%transport%& option is
18421 used. The list of hosts and the lookup type are needed only if the transport is
18422 an &(smtp)& transport that does not itself supply a list of hosts.
18423
18424 The format of the list of hosts is the same as for the &(manualroute)& router.
18425 As well as host names and IP addresses with optional port numbers, as described
18426 in section &<<SECTformatonehostitem>>&, it may contain names followed by
18427 &`/MX`& to specify sublists of hosts that are obtained by looking up MX records
18428 (see section &<<SECThostshowused>>&).
18429
18430 If the lookup type is not specified, Exim behaves as follows when trying to
18431 find an IP address for each host: First, a DNS lookup is done. If this yields
18432 anything other than HOST_NOT_FOUND, that result is used. Otherwise, Exim
18433 goes on to try a call to &[getipnodebyname()]& or &[gethostbyname()]&, and the
18434 result of the lookup is the result of that call.
18435
18436 .vindex "&$address_data$&"
18437 If the DATA field is set, its value is placed in the &$address_data$&
18438 variable. For example, this return line
18439 .code
18440 accept hosts=x1.y.example:x2.y.example data="rule1"
18441 .endd
18442 routes the address to the default transport, passing a list of two hosts. When
18443 the transport runs, the string &"rule1"& is in &$address_data$&.
18444 .ecindex IIDquerou1
18445 .ecindex IIDquerou2
18446
18447
18448
18449
18450 . ////////////////////////////////////////////////////////////////////////////
18451 . ////////////////////////////////////////////////////////////////////////////
18452
18453 .chapter "The redirect router" "CHAPredirect"
18454 .scindex IIDredrou1 "&(redirect)& router"
18455 .scindex IIDredrou2 "routers" "&(redirect)&"
18456 .cindex "alias file" "in a &(redirect)& router"
18457 .cindex "address redirection" "&(redirect)& router"
18458 The &(redirect)& router handles several kinds of address redirection. Its most
18459 common uses are for resolving local part aliases from a central alias file
18460 (usually called &_/etc/aliases_&) and for handling users' personal &_.forward_&
18461 files, but it has many other potential uses. The incoming address can be
18462 redirected in several different ways:
18463
18464 .ilist
18465 It can be replaced by one or more new addresses which are themselves routed
18466 independently.
18467 .next
18468 It can be routed to be delivered to a given file or directory.
18469 .next
18470 It can be routed to be delivered to a specified pipe command.
18471 .next
18472 It can cause an automatic reply to be generated.
18473 .next
18474 It can be forced to fail, optionally with a custom error message.
18475 .next
18476 It can be temporarily deferred, optionally with a custom message.
18477 .next
18478 It can be discarded.
18479 .endlist
18480
18481 The generic &%transport%& option must not be set for &(redirect)& routers.
18482 However, there are some private options which define transports for delivery to
18483 files and pipes, and for generating autoreplies. See the &%file_transport%&,
18484 &%pipe_transport%& and &%reply_transport%& descriptions below.
18485
18486
18487
18488 .section "Redirection data" "SECID124"
18489 The router operates by interpreting a text string which it obtains either by
18490 expanding the contents of the &%data%& option, or by reading the entire
18491 contents of a file whose name is given in the &%file%& option. These two
18492 options are mutually exclusive. The first is commonly used for handling system
18493 aliases, in a configuration like this:
18494 .code
18495 system_aliases:
18496   driver = redirect
18497   data = ${lookup{$local_part}lsearch{/etc/aliases}}
18498 .endd
18499 If the lookup fails, the expanded string in this example is empty. When the
18500 expansion of &%data%& results in an empty string, the router declines. A forced
18501 expansion failure also causes the router to decline; other expansion failures
18502 cause delivery to be deferred.
18503
18504 A configuration using &%file%& is commonly used for handling users'
18505 &_.forward_& files, like this:
18506 .code
18507 userforward:
18508   driver = redirect
18509   check_local_user
18510   file = $home/.forward
18511   no_verify
18512 .endd
18513 If the file does not exist, or causes no action to be taken (for example, it is
18514 empty or consists only of comments), the router declines. &*Warning*&: This
18515 is not the case when the file contains syntactically valid items that happen to
18516 yield empty addresses, for example, items containing only RFC 2822 address
18517 comments.
18518
18519
18520
18521 .section "Forward files and address verification" "SECID125"
18522 .cindex "address redirection" "while verifying"
18523 It is usual to set &%no_verify%& on &(redirect)& routers which handle users'
18524 &_.forward_& files, as in the example above. There are two reasons for this:
18525
18526 .ilist
18527 When Exim is receiving an incoming SMTP message from a remote host, it is
18528 running under the Exim uid, not as root. Exim is unable to change uid to read
18529 the file as the user, and it may not be able to read it as the Exim user. So in
18530 practice the router may not be able to operate.
18531 .next
18532 However, even when the router can operate, the existence of a &_.forward_& file
18533 is unimportant when verifying an address. What should be checked is whether the
18534 local part is a valid user name or not. Cutting out the redirection processing
18535 saves some resources.
18536 .endlist
18537
18538
18539
18540
18541
18542
18543 .section "Interpreting redirection data" "SECID126"
18544 .cindex "Sieve filter" "specifying in redirection data"
18545 .cindex "filter" "specifying in redirection data"
18546 The contents of the data string, whether obtained from &%data%& or &%file%&,
18547 can be interpreted in two different ways:
18548
18549 .ilist
18550 If the &%allow_filter%& option is set true, and the data begins with the text
18551 &"#Exim filter"& or &"#Sieve filter"&, it is interpreted as a list of
18552 &'filtering'& instructions in the form of an Exim or Sieve filter file,
18553 respectively. Details of the syntax and semantics of filter files are described
18554 in a separate document entitled &'Exim's interfaces to mail filtering'&; this
18555 document is intended for use by end users.
18556 .next
18557 Otherwise, the data must be a comma-separated list of redirection items, as
18558 described in the next section.
18559 .endlist
18560
18561 When a message is redirected to a file (a &"mail folder"&), the file name given
18562 in a non-filter redirection list must always be an absolute path. A filter may
18563 generate a relative path &-- how this is handled depends on the transport's
18564 configuration. See section &<<SECTfildiropt>>& for a discussion of this issue
18565 for the &(appendfile)& transport.
18566
18567
18568
18569 .section "Items in a non-filter redirection list" "SECTitenonfilred"
18570 .cindex "address redirection" "non-filter list items"
18571 When the redirection data is not an Exim or Sieve filter, for example, if it
18572 comes from a conventional alias or forward file, it consists of a list of
18573 addresses, file names, pipe commands, or certain special items (see section
18574 &<<SECTspecitredli>>& below). The special items can be individually enabled or
18575 disabled by means of options whose names begin with &%allow_%& or &%forbid_%&,
18576 depending on their default values. The items in the list are separated by
18577 commas or newlines.
18578 If a comma is required in an item, the entire item must be enclosed in double
18579 quotes.
18580
18581 Lines starting with a # character are comments, and are ignored, and # may
18582 also appear following a comma, in which case everything between the # and the
18583 next newline character is ignored.
18584
18585 If an item is entirely enclosed in double quotes, these are removed. Otherwise
18586 double quotes are retained because some forms of mail address require their use
18587 (but never to enclose the entire address). In the following description,
18588 &"item"& refers to what remains after any surrounding double quotes have been
18589 removed.
18590
18591 .vindex "&$local_part$&"
18592 &*Warning*&: If you use an Exim expansion to construct a redirection address,
18593 and the expansion contains a reference to &$local_part$&, you should make use
18594 of the &%quote_local_part%& expansion operator, in case the local part contains
18595 special characters. For example, to redirect all mail for the domain
18596 &'obsolete.example'&, retaining the existing local part, you could use this
18597 setting:
18598 .code
18599 data = ${quote_local_part:$local_part}@newdomain.example
18600 .endd
18601
18602
18603 .section "Redirecting to a local mailbox" "SECTredlocmai"
18604 .cindex "routing" "loops in"
18605 .cindex "loop" "while routing, avoidance of"
18606 .cindex "address redirection" "to local mailbox"
18607 A redirection item may safely be the same as the address currently under
18608 consideration. This does not cause a routing loop, because a router is
18609 automatically skipped if any ancestor of the address that is being processed
18610 is the same as the current address and was processed by the current router.
18611 Such an address is therefore passed to the following routers, so it is handled
18612 as if there were no redirection. When making this loop-avoidance test, the
18613 complete local part, including any prefix or suffix, is used.
18614
18615 .cindex "address redirection" "local part without domain"
18616 Specifying the same local part without a domain is a common usage in personal
18617 filter files when the user wants to have messages delivered to the local
18618 mailbox and also forwarded elsewhere. For example, the user whose login is
18619 &'cleo'& might have a &_.forward_& file containing this:
18620 .code
18621 cleo, cleopatra@egypt.example
18622 .endd
18623 .cindex "backslash in alias file"
18624 .cindex "alias file" "backslash in"
18625 For compatibility with other MTAs, such unqualified local parts may be
18626 preceded by &"\"&, but this is not a requirement for loop prevention. However,
18627 it does make a difference if more than one domain is being handled
18628 synonymously.
18629
18630 If an item begins with &"\"& and the rest of the item parses as a valid RFC
18631 2822 address that does not include a domain, the item is qualified using the
18632 domain of the incoming address. In the absence of a leading &"\"&, unqualified
18633 addresses are qualified using the value in &%qualify_recipient%&, but you can
18634 force the incoming domain to be used by setting &%qualify_preserve_domain%&.
18635
18636 Care must be taken if there are alias names for local users.
18637 Consider an MTA handling a single local domain where the system alias file
18638 contains:
18639 .code
18640 Sam.Reman: spqr
18641 .endd
18642 Now suppose that Sam (whose login id is &'spqr'&) wants to save copies of
18643 messages in the local mailbox, and also forward copies elsewhere. He creates
18644 this forward file:
18645 .code
18646 Sam.Reman, spqr@reme.elsewhere.example
18647 .endd
18648 With these settings, an incoming message addressed to &'Sam.Reman'& fails. The
18649 &(redirect)& router for system aliases does not process &'Sam.Reman'& the
18650 second time round, because it has previously routed it,
18651 and the following routers presumably cannot handle the alias. The forward file
18652 should really contain
18653 .code
18654 spqr, spqr@reme.elsewhere.example
18655 .endd
18656 but because this is such a common error, the &%check_ancestor%& option (see
18657 below) exists to provide a way to get round it. This is normally set on a
18658 &(redirect)& router that is handling users' &_.forward_& files.
18659
18660
18661
18662 .section "Special items in redirection lists" "SECTspecitredli"
18663 In addition to addresses, the following types of item may appear in redirection
18664 lists (that is, in non-filter redirection data):
18665
18666 .ilist
18667 .cindex "pipe" "in redirection list"
18668 .cindex "address redirection" "to pipe"
18669 An item is treated as a pipe command if it begins with &"|"& and does not parse
18670 as a valid RFC 2822 address that includes a domain. A transport for running the
18671 command must be specified by the &%pipe_transport%& option.
18672 Normally, either the router or the transport specifies a user and a group under
18673 which to run the delivery. The default is to use the Exim user and group.
18674
18675 Single or double quotes can be used for enclosing the individual arguments of
18676 the pipe command; no interpretation of escapes is done for single quotes. If
18677 the command contains a comma character, it is necessary to put the whole item
18678 in double quotes, for example:
18679 .code
18680 "|/some/command ready,steady,go"
18681 .endd
18682 since items in redirection lists are terminated by commas. Do not, however,
18683 quote just the command. An item such as
18684 .code
18685 |"/some/command ready,steady,go"
18686 .endd
18687 is interpreted as a pipe with a rather strange command name, and no arguments.
18688
18689 .new
18690 Note that the above example assumes that the text comes from a lookup source
18691 of some sort, so that the quotes are part of the data.  If composing a
18692 redirect router with a &%data%& option directly specifying this command, the
18693 quotes will be used by the configuration parser to define the extent of one
18694 string, but will not be passed down into the redirect router itself.  There
18695 are two main approaches to get around this: escape quotes to be part of the
18696 data itself, or avoid using this mechanism and instead create a custom
18697 transport with the &%command%& option set and reference that transport from
18698 an &%accept%& router.
18699 .wen
18700
18701 .next
18702 .cindex "file" "in redirection list"
18703 .cindex "address redirection" "to file"
18704 An item is interpreted as a path name if it begins with &"/"& and does not
18705 parse as a valid RFC 2822 address that includes a domain. For example,
18706 .code
18707 /home/world/minbari
18708 .endd
18709 is treated as a file name, but
18710 .code
18711 /s=molari/o=babylon/@x400gate.way
18712 .endd
18713 is treated as an address. For a file name, a transport must be specified using
18714 the &%file_transport%& option. However, if the generated path name ends with a
18715 forward slash character, it is interpreted as a directory name rather than a
18716 file name, and &%directory_transport%& is used instead.
18717
18718 Normally, either the router or the transport specifies a user and a group under
18719 which to run the delivery. The default is to use the Exim user and group.
18720
18721 .cindex "&_/dev/null_&"
18722 However, if a redirection item is the path &_/dev/null_&, delivery to it is
18723 bypassed at a high level, and the log entry shows &"**bypassed**"&
18724 instead of a transport name. In this case the user and group are not used.
18725
18726 .next
18727 .cindex "included address list"
18728 .cindex "address redirection" "included external list"
18729 If an item is of the form
18730 .code
18731 :include:<path name>
18732 .endd
18733 a list of further items is taken from the given file and included at that
18734 point. &*Note*&: Such a file can not be a filter file; it is just an
18735 out-of-line addition to the list. The items in the included list are separated
18736 by commas or newlines and are not subject to expansion. If this is the first
18737 item in an alias list in an &(lsearch)& file, a colon must be used to terminate
18738 the alias name. This example is incorrect:
18739 .code
18740 list1    :include:/opt/lists/list1
18741 .endd
18742 It must be given as
18743 .code
18744 list1:   :include:/opt/lists/list1
18745 .endd
18746 .next
18747 .cindex "address redirection" "to black hole"
18748 Sometimes you want to throw away mail to a particular local part. Making the
18749 &%data%& option expand to an empty string does not work, because that causes
18750 the router to decline. Instead, the alias item
18751 .cindex "black hole"
18752 .cindex "abandoning mail"
18753 &':blackhole:'& can be used. It does what its name implies. No delivery is
18754 done, and no error message is generated. This has the same effect as specifing
18755 &_/dev/null_& as a destination, but it can be independently disabled.
18756
18757 &*Warning*&: If &':blackhole:'& appears anywhere in a redirection list, no
18758 delivery is done for the original local part, even if other redirection items
18759 are present. If you are generating a multi-item list (for example, by reading a
18760 database) and need the ability to provide a no-op item, you must use
18761 &_/dev/null_&.
18762
18763 .next
18764 .cindex "delivery" "forcing failure"
18765 .cindex "delivery" "forcing deferral"
18766 .cindex "failing delivery" "forcing"
18767 .cindex "deferred delivery, forcing"
18768 .cindex "customizing" "failure message"
18769 An attempt to deliver a particular address can be deferred or forced to fail by
18770 redirection items of the form
18771 .code
18772 :defer:
18773 :fail:
18774 .endd
18775 respectively. When a redirection list contains such an item, it applies
18776 to the entire redirection; any other items in the list are ignored. Any
18777 text following &':fail:'& or &':defer:'& is placed in the error text
18778 associated with the failure. For example, an alias file might contain:
18779 .code
18780 X.Employee:  :fail: Gone away, no forwarding address
18781 .endd
18782 In the case of an address that is being verified from an ACL or as the subject
18783 of a
18784 .cindex "VRFY" "error text, display of"
18785 VRFY command, the text is included in the SMTP error response by
18786 default.
18787 .cindex "EXPN" "error text, display of"
18788 The text is not included in the response to an EXPN command. In non-SMTP cases
18789 the text is included in the error message that Exim generates.
18790
18791 .cindex "SMTP" "error codes"
18792 By default, Exim sends a 451 SMTP code for a &':defer:'&, and 550 for
18793 &':fail:'&. However, if the message starts with three digits followed by a
18794 space, optionally followed by an extended code of the form &'n.n.n'&, also
18795 followed by a space, and the very first digit is the same as the default error
18796 code, the code from the message is used instead. If the very first digit is
18797 incorrect, a panic error is logged, and the default code is used. You can
18798 suppress the use of the supplied code in a redirect router by setting the
18799 &%forbid_smtp_code%& option true. In this case, any SMTP code is quietly
18800 ignored.
18801
18802 .vindex "&$acl_verify_message$&"
18803 In an ACL, an explicitly provided message overrides the default, but the
18804 default message is available in the variable &$acl_verify_message$& and can
18805 therefore be included in a custom message if this is desired.
18806
18807 Normally the error text is the rest of the redirection list &-- a comma does
18808 not terminate it &-- but a newline does act as a terminator. Newlines are not
18809 normally present in alias expansions. In &(lsearch)& lookups they are removed
18810 as part of the continuation process, but they may exist in other kinds of
18811 lookup and in &':include:'& files.
18812
18813 During routing for message delivery (as opposed to verification), a redirection
18814 containing &':fail:'& causes an immediate failure of the incoming address,
18815 whereas &':defer:'& causes the message to remain on the queue so that a
18816 subsequent delivery attempt can happen at a later time. If an address is
18817 deferred for too long, it will ultimately fail, because the normal retry
18818 rules still apply.
18819
18820 .next
18821 .cindex "alias file" "exception to default"
18822 Sometimes it is useful to use a single-key search type with a default (see
18823 chapter &<<CHAPfdlookup>>&) to look up aliases. However, there may be a need
18824 for exceptions to the default. These can be handled by aliasing them to
18825 &':unknown:'&. This differs from &':fail:'& in that it causes the &(redirect)&
18826 router to decline, whereas &':fail:'& forces routing to fail. A lookup which
18827 results in an empty redirection list has the same effect.
18828 .endlist
18829
18830
18831 .section "Duplicate addresses" "SECTdupaddr"
18832 .cindex "duplicate addresses"
18833 .cindex "address duplicate, discarding"
18834 .cindex "pipe" "duplicated"
18835 Exim removes duplicate addresses from the list to which it is delivering, so as
18836 to deliver just one copy to each address. This does not apply to deliveries
18837 routed to pipes by different immediate parent addresses, but an indirect
18838 aliasing scheme of the type
18839 .code
18840 pipe:       |/some/command $local_part
18841 localpart1: pipe
18842 localpart2: pipe
18843 .endd
18844 does not work with a message that is addressed to both local parts, because
18845 when the second is aliased to the intermediate local part &"pipe"& it gets
18846 discarded as being the same as a previously handled address. However, a scheme
18847 such as
18848 .code
18849 localpart1: |/some/command $local_part
18850 localpart2: |/some/command $local_part
18851 .endd
18852 does result in two different pipe deliveries, because the immediate parents of
18853 the pipes are distinct.
18854
18855
18856
18857 .section "Repeated redirection expansion" "SECID128"
18858 .cindex "repeated redirection expansion"
18859 .cindex "address redirection" "repeated for each delivery attempt"
18860 When a message cannot be delivered to all of its recipients immediately,
18861 leading to two or more delivery attempts, redirection expansion is carried out
18862 afresh each time for those addresses whose children were not all previously
18863 delivered. If redirection is being used as a mailing list, this can lead to new
18864 members of the list receiving copies of old messages. The &%one_time%& option
18865 can be used to avoid this.
18866
18867
18868 .section "Errors in redirection lists" "SECID129"
18869 .cindex "address redirection" "errors"
18870 If &%skip_syntax_errors%& is set, a malformed address that causes a parsing
18871 error is skipped, and an entry is written to the main log. This may be useful
18872 for mailing lists that are automatically managed. Otherwise, if an error is
18873 detected while generating the list of new addresses, the original address is
18874 deferred. See also &%syntax_errors_to%&.
18875
18876
18877
18878 .section "Private options for the redirect router" "SECID130"
18879
18880 .cindex "options" "&(redirect)& router"
18881 The private options for the &(redirect)& router are as follows:
18882
18883
18884 .option allow_defer redirect boolean false
18885 Setting this option allows the use of &':defer:'& in non-filter redirection
18886 data, or the &%defer%& command in an Exim filter file.
18887
18888
18889 .option allow_fail redirect boolean false
18890 .cindex "failing delivery" "from filter"
18891 If this option is true, the &':fail:'& item can be used in a redirection list,
18892 and the &%fail%& command may be used in an Exim filter file.
18893
18894
18895 .option allow_filter redirect boolean false
18896 .cindex "filter" "enabling use of"
18897 .cindex "Sieve filter" "enabling use of"
18898 Setting this option allows Exim to interpret redirection data that starts with
18899 &"#Exim filter"& or &"#Sieve filter"& as a set of filtering instructions. There
18900 are some features of Exim filter files that some administrators may wish to
18901 lock out; see the &%forbid_filter_%&&'xxx'& options below.
18902
18903 It is also possible to lock out Exim filters or Sieve filters while allowing
18904 the other type; see &%forbid_exim_filter%& and &%forbid_sieve_filter%&.
18905
18906
18907 The filter is run using the uid and gid set by the generic &%user%& and
18908 &%group%& options. These take their defaults from the password data if
18909 &%check_local_user%& is set, so in the normal case of users' personal filter
18910 files, the filter is run as the relevant user. When &%allow_filter%& is set
18911 true, Exim insists that either &%check_local_user%& or &%user%& is set.
18912
18913
18914
18915 .option allow_freeze redirect boolean false
18916 .cindex "freezing messages" "allowing in filter"
18917 Setting this option allows the use of the &%freeze%& command in an Exim filter.
18918 This command is more normally encountered in system filters, and is disabled by
18919 default for redirection filters because it isn't something you usually want to
18920 let ordinary users do.
18921
18922
18923
18924 .option check_ancestor redirect boolean false
18925 This option is concerned with handling generated addresses that are the same
18926 as some address in the list of redirection ancestors of the current address.
18927 Although it is turned off by default in the code, it is set in the default
18928 configuration file for handling users' &_.forward_& files. It is recommended
18929 for this use of the &(redirect)& router.
18930
18931 When &%check_ancestor%& is set, if a generated address (including the domain)
18932 is the same as any ancestor of the current address, it is replaced by a copy of
18933 the current address. This helps in the case where local part A is aliased to B,
18934 and B has a &_.forward_& file pointing back to A. For example, within a single
18935 domain, the local part &"Joe.Bloggs"& is aliased to &"jb"& and
18936 &_&~jb/.forward_& contains:
18937 .code
18938 \Joe.Bloggs, <other item(s)>
18939 .endd
18940 Without the &%check_ancestor%& setting, either local part (&"jb"& or
18941 &"joe.bloggs"&) gets processed once by each router and so ends up as it was
18942 originally. If &"jb"& is the real mailbox name, mail to &"jb"& gets delivered
18943 (having been turned into &"joe.bloggs"& by the &_.forward_& file and back to
18944 &"jb"& by the alias), but mail to &"joe.bloggs"& fails. Setting
18945 &%check_ancestor%& on the &(redirect)& router that handles the &_.forward_&
18946 file prevents it from turning &"jb"& back into &"joe.bloggs"& when that was the
18947 original address. See also the &%repeat_use%& option below.
18948
18949
18950 .option check_group redirect boolean "see below"
18951 When the &%file%& option is used, the group owner of the file is checked only
18952 when this option is set. The permitted groups are those listed in the
18953 &%owngroups%& option, together with the user's default group if
18954 &%check_local_user%& is set. If the file has the wrong group, routing is
18955 deferred. The default setting for this option is true if &%check_local_user%&
18956 is set and the &%modemask%& option permits the group write bit, or if the
18957 &%owngroups%& option is set. Otherwise it is false, and no group check occurs.
18958
18959
18960
18961 .option check_owner redirect boolean "see below"
18962 When the &%file%& option is used, the owner of the file is checked only when
18963 this option is set. If &%check_local_user%& is set, the local user is
18964 permitted; otherwise the owner must be one of those listed in the &%owners%&
18965 option. The default value for this option is true if &%check_local_user%& or
18966 &%owners%& is set. Otherwise the default is false, and no owner check occurs.
18967
18968
18969 .option data redirect string&!! unset
18970 This option is mutually exclusive with &%file%&. One or other of them must be
18971 set, but not both. The contents of &%data%& are expanded, and then used as the
18972 list of forwarding items, or as a set of filtering instructions. If the
18973 expansion is forced to fail, or the result is an empty string or a string that
18974 has no effect (consists entirely of comments), the router declines.
18975
18976 When filtering instructions are used, the string must begin with &"#Exim
18977 filter"&, and all comments in the string, including this initial one, must be
18978 terminated with newline characters. For example:
18979 .code
18980 data = #Exim filter\n\
18981        if $h_to: contains Exim then save $home/mail/exim endif
18982 .endd
18983 If you are reading the data from a database where newlines cannot be included,
18984 you can use the &${sg}$& expansion item to turn the escape string of your
18985 choice into a newline.
18986
18987
18988 .option directory_transport redirect string&!! unset
18989 A &(redirect)& router sets up a direct delivery to a directory when a path name
18990 ending with a slash is specified as a new &"address"&. The transport used is
18991 specified by this option, which, after expansion, must be the name of a
18992 configured transport. This should normally be an &(appendfile)& transport.
18993
18994
18995 .option file redirect string&!! unset
18996 This option specifies the name of a file that contains the redirection data. It
18997 is mutually exclusive with the &%data%& option. The string is expanded before
18998 use; if the expansion is forced to fail, the router declines. Other expansion
18999 failures cause delivery to be deferred. The result of a successful expansion
19000 must be an absolute path. The entire file is read and used as the redirection
19001 data. If the data is an empty string or a string that has no effect (consists
19002 entirely of comments), the router declines.
19003
19004 .cindex "NFS" "checking for file existence"
19005 If the attempt to open the file fails with a &"does not exist"& error, Exim
19006 runs a check on the containing directory,
19007 unless &%ignore_enotdir%& is true (see below).
19008 If the directory does not appear to exist, delivery is deferred. This can
19009 happen when users' &_.forward_& files are in NFS-mounted directories, and there
19010 is a mount problem. If the containing directory does exist, but the file does
19011 not, the router declines.
19012
19013
19014 .option file_transport redirect string&!! unset
19015 .vindex "&$address_file$&"
19016 A &(redirect)& router sets up a direct delivery to a file when a path name not
19017 ending in a slash is specified as a new &"address"&. The transport used is
19018 specified by this option, which, after expansion, must be the name of a
19019 configured transport. This should normally be an &(appendfile)& transport. When
19020 it is running, the file name is in &$address_file$&.
19021
19022
19023 .option filter_prepend_home redirect boolean true
19024 When this option is true, if a &(save)& command in an Exim filter specifies a
19025 relative path, and &$home$& is defined, it is automatically prepended to the
19026 relative path. If this option is set false, this action does not happen. The
19027 relative path is then passed to the transport unmodified.
19028
19029
19030 .option forbid_blackhole redirect boolean false
19031 If this option is true, the &':blackhole:'& item may not appear in a
19032 redirection list.
19033
19034
19035 .option forbid_exim_filter redirect boolean false
19036 If this option is set true, only Sieve filters are permitted when
19037 &%allow_filter%& is true.
19038
19039
19040
19041
19042 .option forbid_file redirect boolean false
19043 .cindex "delivery" "to file; forbidding"
19044 .cindex "Sieve filter" "forbidding delivery to a file"
19045 .cindex "Sieve filter" "&""keep""& facility; disabling"
19046 If this option is true, this router may not generate a new address that
19047 specifies delivery to a local file or directory, either from a filter or from a
19048 conventional forward file. This option is forced to be true if &%one_time%& is
19049 set. It applies to Sieve filters as well as to Exim filters, but if true, it
19050 locks out the Sieve's &"keep"& facility.
19051
19052
19053 .option forbid_filter_dlfunc redirect boolean false
19054 .cindex "filter" "locking out certain features"
19055 If this option is true, string expansions in Exim filters are not allowed to
19056 make use of the &%dlfunc%& expansion facility to run dynamically loaded
19057 functions.
19058
19059 .option forbid_filter_existstest redirect boolean false
19060 .cindex "expansion" "statting a file"
19061 If this option is true, string expansions in Exim filters are not allowed to
19062 make use of the &%exists%& condition or the &%stat%& expansion item.
19063
19064 .option forbid_filter_logwrite redirect boolean false
19065 If this option is true, use of the logging facility in Exim filters is not
19066 permitted. Logging is in any case available only if the filter is being run
19067 under some unprivileged uid (which is normally the case for ordinary users'
19068 &_.forward_& files).
19069
19070
19071 .option forbid_filter_lookup redirect boolean false
19072 If this option is true, string expansions in Exim filter files are not allowed
19073 to make use of &%lookup%& items.
19074
19075
19076 .option forbid_filter_perl redirect boolean false
19077 This option has an effect only if Exim is built with embedded Perl support. If
19078 it is true, string expansions in Exim filter files are not allowed to make use
19079 of the embedded Perl support.
19080
19081
19082 .option forbid_filter_readfile redirect boolean false
19083 If this option is true, string expansions in Exim filter files are not allowed
19084 to make use of &%readfile%& items.
19085
19086
19087 .option forbid_filter_readsocket redirect boolean false
19088 If this option is true, string expansions in Exim filter files are not allowed
19089 to make use of &%readsocket%& items.
19090
19091
19092 .option forbid_filter_reply redirect boolean false
19093 If this option is true, this router may not generate an automatic reply
19094 message. Automatic replies can be generated only from Exim or Sieve filter
19095 files, not from traditional forward files. This option is forced to be true if
19096 &%one_time%& is set.
19097
19098
19099 .option forbid_filter_run redirect boolean false
19100 If this option is true, string expansions in Exim filter files are not allowed
19101 to make use of &%run%& items.
19102
19103
19104 .option forbid_include redirect boolean false
19105 If this option is true, items of the form
19106 .code
19107 :include:<path name>
19108 .endd
19109 are not permitted in non-filter redirection lists.
19110
19111
19112 .option forbid_pipe redirect boolean false
19113 .cindex "delivery" "to pipe; forbidding"
19114 If this option is true, this router may not generate a new address which
19115 specifies delivery to a pipe, either from an Exim filter or from a conventional
19116 forward file. This option is forced to be true if &%one_time%& is set.
19117
19118
19119 .option forbid_sieve_filter redirect boolean false
19120 If this option is set true, only Exim filters are permitted when
19121 &%allow_filter%& is true.
19122
19123
19124 .cindex "SMTP" "error codes"
19125 .option forbid_smtp_code redirect boolean false
19126 If this option is set true, any SMTP error codes that are present at the start
19127 of messages specified for &`:defer:`& or &`:fail:`& are quietly ignored, and
19128 the default codes (451 and 550, respectively) are always used.
19129
19130
19131
19132
19133 .option hide_child_in_errmsg redirect boolean false
19134 .cindex "bounce message" "redirection details; suppressing"
19135 If this option is true, it prevents Exim from quoting a child address if it
19136 generates a bounce or delay message for it. Instead it says &"an address
19137 generated from <&'the top level address'&>"&. Of course, this applies only to
19138 bounces generated locally. If a message is forwarded to another host, &'its'&
19139 bounce may well quote the generated address.
19140
19141
19142 .option ignore_eacces redirect boolean false
19143 .cindex "EACCES"
19144 If this option is set and an attempt to open a redirection file yields the
19145 EACCES error (permission denied), the &(redirect)& router behaves as if the
19146 file did not exist.
19147
19148
19149 .option ignore_enotdir redirect boolean false
19150 .cindex "ENOTDIR"
19151 If this option is set and an attempt to open a redirection file yields the
19152 ENOTDIR error (something on the path is not a directory), the &(redirect)&
19153 router behaves as if the file did not exist.
19154
19155 Setting &%ignore_enotdir%& has another effect as well: When a &(redirect)&
19156 router that has the &%file%& option set discovers that the file does not exist
19157 (the ENOENT error), it tries to &[stat()]& the parent directory, as a check
19158 against unmounted NFS directories. If the parent can not be statted, delivery
19159 is deferred. However, it seems wrong to do this check when &%ignore_enotdir%&
19160 is set, because that option tells Exim to ignore &"something on the path is not
19161 a directory"& (the ENOTDIR error). This is a confusing area, because it seems
19162 that some operating systems give ENOENT where others give ENOTDIR.
19163
19164
19165
19166 .option include_directory redirect string unset
19167 If this option is set, the path names of any &':include:'& items in a
19168 redirection list must start with this directory.
19169
19170
19171 .option modemask redirect "octal integer" 022
19172 This specifies mode bits which must not be set for a file specified by the
19173 &%file%& option. If any of the forbidden bits are set, delivery is deferred.
19174
19175
19176 .option one_time redirect boolean false
19177 .cindex "one-time aliasing/forwarding expansion"
19178 .cindex "alias file" "one-time expansion"
19179 .cindex "forward file" "one-time expansion"
19180 .cindex "mailing lists" "one-time expansion"
19181 .cindex "address redirection" "one-time expansion"
19182 Sometimes the fact that Exim re-evaluates aliases and reprocesses redirection
19183 files each time it tries to deliver a message causes a problem when one or more
19184 of the generated addresses fails be delivered at the first attempt. The problem
19185 is not one of duplicate delivery &-- Exim is clever enough to handle that &--
19186 but of what happens when the redirection list changes during the time that the
19187 message is on Exim's queue. This is particularly true in the case of mailing
19188 lists, where new subscribers might receive copies of messages that were posted
19189 before they subscribed.
19190
19191 If &%one_time%& is set and any addresses generated by the router fail to
19192 deliver at the first attempt, the failing addresses are added to the message as
19193 &"top level"& addresses, and the parent address that generated them is marked
19194 &"delivered"&. Thus, redirection does not happen again at the next delivery
19195 attempt.
19196
19197 &*Warning 1*&: Any header line addition or removal that is specified by this
19198 router would be lost if delivery did not succeed at the first attempt. For this
19199 reason, the &%headers_add%& and &%headers_remove%& generic options are not
19200 permitted when &%one_time%& is set.
19201
19202 &*Warning 2*&: To ensure that the router generates only addresses (as opposed
19203 to pipe or file deliveries or auto-replies) &%forbid_file%&, &%forbid_pipe%&,
19204 and &%forbid_filter_reply%& are forced to be true when &%one_time%& is set.
19205
19206 &*Warning 3*&: The &%unseen%& generic router option may not be set with
19207 &%one_time%&.
19208
19209 The original top-level address is remembered with each of the generated
19210 addresses, and is output in any log messages. However, any intermediate parent
19211 addresses are not recorded. This makes a difference to the log only if
19212 &%all_parents%& log selector is set. It is expected that &%one_time%& will
19213 typically be used for mailing lists, where there is normally just one level of
19214 expansion.
19215
19216
19217 .option owners redirect "string list" unset
19218 .cindex "ownership" "alias file"
19219 .cindex "ownership" "forward file"
19220 .cindex "alias file" "ownership"
19221 .cindex "forward file" "ownership"
19222 This specifies a list of permitted owners for the file specified by &%file%&.
19223 This list is in addition to the local user when &%check_local_user%& is set.
19224 See &%check_owner%& above.
19225
19226
19227 .option owngroups redirect "string list" unset
19228 This specifies a list of permitted groups for the file specified by &%file%&.
19229 The list is in addition to the local user's primary group when
19230 &%check_local_user%& is set. See &%check_group%& above.
19231
19232
19233 .option pipe_transport redirect string&!! unset
19234 .vindex "&$address_pipe$&"
19235 A &(redirect)& router sets up a direct delivery to a pipe when a string
19236 starting with a vertical bar character is specified as a new &"address"&. The
19237 transport used is specified by this option, which, after expansion, must be the
19238 name of a configured transport. This should normally be a &(pipe)& transport.
19239 When the transport is run, the pipe command is in &$address_pipe$&.
19240
19241
19242 .option qualify_domain redirect string&!! unset
19243 .vindex "&$qualify_recipient$&"
19244 If this option is set, and an unqualified address (one without a domain) is
19245 generated, and that address would normally be qualified by the global setting
19246 in &%qualify_recipient%&, it is instead qualified with the domain specified by
19247 expanding this string. If the expansion fails, the router declines. If you want
19248 to revert to the default, you can have the expansion generate
19249 &$qualify_recipient$&.
19250
19251 This option applies to all unqualified addresses generated by Exim filters,
19252 but for traditional &_.forward_& files, it applies only to addresses that are
19253 not preceded by a backslash. Sieve filters cannot generate unqualified
19254 addresses.
19255
19256 .option qualify_preserve_domain redirect boolean false
19257 .cindex "domain" "in redirection; preserving"
19258 .cindex "preserving domain in redirection"
19259 .cindex "address redirection" "domain; preserving"
19260 If this option is set, the router's local &%qualify_domain%& option must not be
19261 set (a configuration error occurs if it is). If an unqualified address (one
19262 without a domain) is generated, it is qualified with the domain of the parent
19263 address (the immediately preceding ancestor) instead of the global
19264 &%qualify_recipient%& value. In the case of a traditional &_.forward_& file,
19265 this applies whether or not the address is preceded by a backslash.
19266
19267
19268 .option repeat_use redirect boolean true
19269 If this option is set false, the router is skipped for a child address that has
19270 any ancestor that was routed by this router. This test happens before any of
19271 the other preconditions are tested. Exim's default anti-looping rules skip
19272 only when the ancestor is the same as the current address. See also
19273 &%check_ancestor%& above and the generic &%redirect_router%& option.
19274
19275
19276 .option reply_transport redirect string&!! unset
19277 A &(redirect)& router sets up an automatic reply when a &%mail%& or
19278 &%vacation%& command is used in a filter file. The transport used is specified
19279 by this option, which, after expansion, must be the name of a configured
19280 transport. This should normally be an &(autoreply)& transport. Other transports
19281 are unlikely to do anything sensible or useful.
19282
19283
19284 .option rewrite redirect boolean true
19285 .cindex "address redirection" "disabling rewriting"
19286 If this option is set false, addresses generated by the router are not
19287 subject to address rewriting. Otherwise, they are treated like new addresses
19288 and are rewritten according to the global rewriting rules.
19289
19290
19291 .option sieve_subaddress redirect string&!! unset
19292 The value of this option is passed to a Sieve filter to specify the
19293 :subaddress part of an address.
19294
19295 .option sieve_useraddress redirect string&!! unset
19296 The value of this option is passed to a Sieve filter to specify the :user part
19297 of an address. However, if it is unset, the entire original local part
19298 (including any prefix or suffix) is used for :user.
19299
19300
19301 .option sieve_vacation_directory redirect string&!! unset
19302 .cindex "Sieve filter" "vacation directory"
19303 To enable the &"vacation"& extension for Sieve filters, you must set
19304 &%sieve_vacation_directory%& to the directory where vacation databases are held
19305 (do not put anything else in that directory), and ensure that the
19306 &%reply_transport%& option refers to an &(autoreply)& transport. Each user
19307 needs their own directory; Exim will create it if necessary.
19308
19309
19310
19311 .option skip_syntax_errors redirect boolean false
19312 .cindex "forward file" "broken"
19313 .cindex "address redirection" "broken files"
19314 .cindex "alias file" "broken"
19315 .cindex "broken alias or forward files"
19316 .cindex "ignoring faulty addresses"
19317 .cindex "skipping faulty addresses"
19318 .cindex "error" "skipping bad syntax"
19319 If &%skip_syntax_errors%& is set, syntactically malformed addresses in
19320 non-filter redirection data are skipped, and each failing address is logged. If
19321 &%syntax_errors_to%& is set, a message is sent to the address it defines,
19322 giving details of the failures. If &%syntax_errors_text%& is set, its contents
19323 are expanded and placed at the head of the error message generated by
19324 &%syntax_errors_to%&. Usually it is appropriate to set &%syntax_errors_to%& to
19325 be the same address as the generic &%errors_to%& option. The
19326 &%skip_syntax_errors%& option is often used when handling mailing lists.
19327
19328 If all the addresses in a redirection list are skipped because of syntax
19329 errors, the router declines to handle the original address, and it is passed to
19330 the following routers.
19331
19332 If &%skip_syntax_errors%& is set when an Exim filter is interpreted, any syntax
19333 error in the filter causes filtering to be abandoned without any action being
19334 taken. The incident is logged, and the router declines to handle the address,
19335 so it is passed to the following routers.
19336
19337 .cindex "Sieve filter" "syntax errors in"
19338 Syntax errors in a Sieve filter file cause the &"keep"& action to occur. This
19339 action is specified by RFC 3028. The values of &%skip_syntax_errors%&,
19340 &%syntax_errors_to%&, and &%syntax_errors_text%& are not used.
19341
19342 &%skip_syntax_errors%& can be used to specify that errors in users' forward
19343 lists or filter files should not prevent delivery. The &%syntax_errors_to%&
19344 option, used with an address that does not get redirected, can be used to
19345 notify users of these errors, by means of a router like this:
19346 .code
19347 userforward:
19348   driver = redirect
19349   allow_filter
19350   check_local_user
19351   file = $home/.forward
19352   file_transport = address_file
19353   pipe_transport = address_pipe
19354   reply_transport = address_reply
19355   no_verify
19356   skip_syntax_errors
19357   syntax_errors_to = real-$local_part@$domain
19358   syntax_errors_text = \
19359    This is an automatically generated message. An error has\n\
19360    been found in your .forward file. Details of the error are\n\
19361    reported below. While this error persists, you will receive\n\
19362    a copy of this message for every message that is addressed\n\
19363    to you. If your .forward file is a filter file, or if it is\n\
19364    a non-filter file containing no valid forwarding addresses,\n\
19365    a copy of each incoming message will be put in your normal\n\
19366    mailbox. If a non-filter file contains at least one valid\n\
19367    forwarding address, forwarding to the valid addresses will\n\
19368    happen, and those will be the only deliveries that occur.
19369 .endd
19370 You also need a router to ensure that local addresses that are prefixed by
19371 &`real-`& are recognized, but not forwarded or filtered. For example, you could
19372 put this immediately before the &(userforward)& router:
19373 .code
19374 real_localuser:
19375   driver = accept
19376   check_local_user
19377   local_part_prefix = real-
19378   transport = local_delivery
19379 .endd
19380 For security, it would probably be a good idea to restrict the use of this
19381 router to locally-generated messages, using a condition such as this:
19382 .code
19383   condition = ${if match {$sender_host_address}\
19384                          {\N^(|127\.0\.0\.1)$\N}}
19385 .endd
19386
19387
19388 .option syntax_errors_text redirect string&!! unset
19389 See &%skip_syntax_errors%& above.
19390
19391
19392 .option syntax_errors_to redirect string unset
19393 See &%skip_syntax_errors%& above.
19394 .ecindex IIDredrou1
19395 .ecindex IIDredrou2
19396
19397
19398
19399
19400
19401
19402 . ////////////////////////////////////////////////////////////////////////////
19403 . ////////////////////////////////////////////////////////////////////////////
19404
19405 .chapter "Environment for running local transports" "CHAPenvironment" &&&
19406          "Environment for local transports"
19407 .scindex IIDenvlotra1 "local transports" "environment for"
19408 .scindex IIDenvlotra2 "environment for local transports"
19409 .scindex IIDenvlotra3 "transport" "local; environment for"
19410 Local transports handle deliveries to files and pipes. (The &(autoreply)&
19411 transport can be thought of as similar to a pipe.) Exim always runs transports
19412 in subprocesses, under specified uids and gids. Typical deliveries to local
19413 mailboxes run under the uid and gid of the local user.
19414
19415 Exim also sets a specific current directory while running the transport; for
19416 some transports a home directory setting is also relevant. The &(pipe)&
19417 transport is the only one that sets up environment variables; see section
19418 &<<SECTpipeenv>>& for details.
19419
19420 The values used for the uid, gid, and the directories may come from several
19421 different places. In many cases, the router that handles the address associates
19422 settings with that address as a result of its &%check_local_user%&, &%group%&,
19423 or &%user%& options. However, values may also be given in the transport's own
19424 configuration, and these override anything that comes from the router.
19425
19426
19427
19428 .section "Concurrent deliveries" "SECID131"
19429 .cindex "concurrent deliveries"
19430 .cindex "simultaneous deliveries"
19431 If two different messages for the same local recipient arrive more or less
19432 simultaneously, the two delivery processes are likely to run concurrently. When
19433 the &(appendfile)& transport is used to write to a file, Exim applies locking
19434 rules to stop concurrent processes from writing to the same file at the same
19435 time.
19436
19437 However, when you use a &(pipe)& transport, it is up to you to arrange any
19438 locking that is needed. Here is a silly example:
19439 .code
19440 my_transport:
19441   driver = pipe
19442   command = /bin/sh -c 'cat >>/some/file'
19443 .endd
19444 This is supposed to write the message at the end of the file. However, if two
19445 messages arrive at the same time, the file will be scrambled. You can use the
19446 &%exim_lock%& utility program (see section &<<SECTmailboxmaint>>&) to lock a
19447 file using the same algorithm that Exim itself uses.
19448
19449
19450
19451
19452 .section "Uids and gids" "SECTenvuidgid"
19453 .cindex "local transports" "uid and gid"
19454 .cindex "transport" "local; uid and gid"
19455 All transports have the options &%group%& and &%user%&. If &%group%& is set, it
19456 overrides any group that the router set in the address, even if &%user%& is not
19457 set for the transport. This makes it possible, for example, to run local mail
19458 delivery under the uid of the recipient (set by the router), but in a special
19459 group (set by the transport). For example:
19460 .code
19461 # Routers ...
19462 # User/group are set by check_local_user in this router
19463 local_users:
19464   driver = accept
19465   check_local_user
19466   transport = group_delivery
19467
19468 # Transports ...
19469 # This transport overrides the group
19470 group_delivery:
19471   driver = appendfile
19472   file = /var/spool/mail/$local_part
19473   group = mail
19474 .endd
19475 If &%user%& is set for a transport, its value overrides what is set in the
19476 address by the router. If &%user%& is non-numeric and &%group%& is not set, the
19477 gid associated with the user is used. If &%user%& is numeric, &%group%& must be
19478 set.
19479
19480 .oindex "&%initgroups%&"
19481 When the uid is taken from the transport's configuration, the &[initgroups()]&
19482 function is called for the groups associated with that uid if the
19483 &%initgroups%& option is set for the transport. When the uid is not specified
19484 by the transport, but is associated with the address by a router, the option
19485 for calling &[initgroups()]& is taken from the router configuration.
19486
19487 .cindex "&(pipe)& transport" "uid for"
19488 The &(pipe)& transport contains the special option &%pipe_as_creator%&. If this
19489 is set and &%user%& is not set, the uid of the process that called Exim to
19490 receive the message is used, and if &%group%& is not set, the corresponding
19491 original gid is also used.
19492
19493 This is the detailed preference order for obtaining a gid; the first of the
19494 following that is set is used:
19495
19496 .ilist
19497 A &%group%& setting of the transport;
19498 .next
19499 A &%group%& setting of the router;
19500 .next
19501 A gid associated with a user setting of the router, either as a result of
19502 &%check_local_user%& or an explicit non-numeric &%user%& setting;
19503 .next
19504 The group associated with a non-numeric &%user%& setting of the transport;
19505 .next
19506 In a &(pipe)& transport, the creator's gid if &%deliver_as_creator%& is set and
19507 the uid is the creator's uid;
19508 .next
19509 The Exim gid if the Exim uid is being used as a default.
19510 .endlist
19511
19512 If, for example, the user is specified numerically on the router and there are
19513 no group settings, no gid is available. In this situation, an error occurs.
19514 This is different for the uid, for which there always is an ultimate default.
19515 The first of the following that is set is used:
19516
19517 .ilist
19518 A &%user%& setting of the transport;
19519 .next
19520 In a &(pipe)& transport, the creator's uid if &%deliver_as_creator%& is set;
19521 .next
19522 A &%user%& setting of the router;
19523 .next
19524 A &%check_local_user%& setting of the router;
19525 .next
19526 The Exim uid.
19527 .endlist
19528
19529 Of course, an error will still occur if the uid that is chosen is on the
19530 &%never_users%& list.
19531
19532
19533
19534
19535
19536 .section "Current and home directories" "SECID132"
19537 .cindex "current directory for local transport"
19538 .cindex "home directory" "for local transport"
19539 .cindex "transport" "local; home directory for"
19540 .cindex "transport" "local; current directory for"
19541 Routers may set current and home directories for local transports by means of
19542 the &%transport_current_directory%& and &%transport_home_directory%& options.
19543 However, if the transport's &%current_directory%& or &%home_directory%& options
19544 are set, they override the router's values. In detail, the home directory
19545 for a local transport is taken from the first of these values that is set:
19546
19547 .ilist
19548 The &%home_directory%& option on the transport;
19549 .next
19550 The &%transport_home_directory%& option on the router;
19551 .next
19552 The password data if &%check_local_user%& is set on the router;
19553 .next
19554 The &%router_home_directory%& option on the router.
19555 .endlist
19556
19557 The current directory is taken from the first of these values that is set:
19558
19559 .ilist
19560 The &%current_directory%& option on the transport;
19561 .next
19562 The &%transport_current_directory%& option on the router.
19563 .endlist
19564
19565
19566 If neither the router nor the transport sets a current directory, Exim uses the
19567 value of the home directory, if it is set. Otherwise it sets the current
19568 directory to &_/_& before running a local transport.
19569
19570
19571
19572 .section "Expansion variables derived from the address" "SECID133"
19573 .vindex "&$domain$&"
19574 .vindex "&$local_part$&"
19575 .vindex "&$original_domain$&"
19576 Normally a local delivery is handling a single address, and in that case the
19577 variables such as &$domain$& and &$local_part$& are set during local
19578 deliveries. However, in some circumstances more than one address may be handled
19579 at once (for example, while writing batch SMTP for onward transmission by some
19580 other means). In this case, the variables associated with the local part are
19581 never set, &$domain$& is set only if all the addresses have the same domain,
19582 and &$original_domain$& is never set.
19583 .ecindex IIDenvlotra1
19584 .ecindex IIDenvlotra2
19585 .ecindex IIDenvlotra3
19586
19587
19588
19589
19590
19591
19592
19593 . ////////////////////////////////////////////////////////////////////////////
19594 . ////////////////////////////////////////////////////////////////////////////
19595
19596 .chapter "Generic options for transports" "CHAPtransportgeneric"
19597 .scindex IIDgenoptra1 "generic options" "transport"
19598 .scindex IIDgenoptra2 "options" "generic; for transports"
19599 .scindex IIDgenoptra3 "transport" "generic options for"
19600 The following generic options apply to all transports:
19601
19602
19603 .option body_only transports boolean false
19604 .cindex "transport" "body only"
19605 .cindex "message" "transporting body only"
19606 .cindex "body of message" "transporting"
19607 If this option is set, the message's headers are not transported. It is
19608 mutually exclusive with &%headers_only%&. If it is used with the &(appendfile)&
19609 or &(pipe)& transports, the settings of &%message_prefix%& and
19610 &%message_suffix%& should be checked, because this option does not
19611 automatically suppress them.
19612
19613
19614 .option current_directory transports string&!! unset
19615 .cindex "transport" "current directory for"
19616 This specifies the current directory that is to be set while running the
19617 transport, overriding any value that may have been set by the router.
19618 If the expansion fails for any reason, including forced failure, an error is
19619 logged, and delivery is deferred.
19620
19621
19622 .option disable_logging transports boolean false
19623 If this option is set true, nothing is logged for any
19624 deliveries by the transport or for any
19625 transport errors. You should not set this option unless you really, really know
19626 what you are doing.
19627
19628
19629 .option debug_print transports string&!! unset
19630 .cindex "testing" "variables in drivers"
19631 If this option is set and debugging is enabled (see the &%-d%& command line
19632 option), the string is expanded and included in the debugging output when the
19633 transport is run.
19634 If expansion of the string fails, the error message is written to the debugging
19635 output, and Exim carries on processing.
19636 This facility is provided to help with checking out the values of variables and
19637 so on when debugging driver configurations. For example, if a &%headers_add%&
19638 option is not working properly, &%debug_print%& could be used to output the
19639 variables it references. A newline is added to the text if it does not end with
19640 one.
19641 The variables &$transport_name$& and &$router_name$& contain the name of the
19642 transport and the router that called it.
19643
19644
19645 .option delivery_date_add transports boolean false
19646 .cindex "&'Delivery-date:'& header line"
19647 If this option is true, a &'Delivery-date:'& header is added to the message.
19648 This gives the actual time the delivery was made. As this is not a standard
19649 header, Exim has a configuration option (&%delivery_date_remove%&) which
19650 requests its removal from incoming messages, so that delivered messages can
19651 safely be resent to other recipients.
19652
19653
19654 .option driver transports string unset
19655 This specifies which of the available transport drivers is to be used.
19656 There is no default, and this option must be set for every transport.
19657
19658
19659 .option envelope_to_add transports boolean false
19660 .cindex "&'Envelope-to:'& header line"
19661 If this option is true, an &'Envelope-to:'& header is added to the message.
19662 This gives the original address(es) in the incoming envelope that caused this
19663 delivery to happen. More than one address may be present if the transport is
19664 configured to handle several addresses at once, or if more than one original
19665 address was redirected to the same final address. As this is not a standard
19666 header, Exim has a configuration option (&%envelope_to_remove%&) which requests
19667 its removal from incoming messages, so that delivered messages can safely be
19668 resent to other recipients.
19669
19670
19671 .option group transports string&!! "Exim group"
19672 .cindex "transport" "group; specifying"
19673 This option specifies a gid for running the transport process, overriding any
19674 value that the router supplies, and also overriding any value associated with
19675 &%user%& (see below).
19676
19677
19678 .option headers_add transports string&!! unset
19679 .cindex "header lines" "adding in transport"
19680 .cindex "transport" "header lines; adding"
19681 This option specifies a string of text that is expanded and added to the header
19682 portion of a message as it is transported, as described in section
19683 &<<SECTheadersaddrem>>&. Additional header lines can also be specified by
19684 routers. If the result of the expansion is an empty string, or if the expansion
19685 is forced to fail, no action is taken. Other expansion failures are treated as
19686 errors and cause the delivery to be deferred.
19687
19688 Unlike most options, &%headers_add%& can be specified multiple times
19689 for a transport; all listed headers are added.
19690
19691
19692
19693 .option headers_only transports boolean false
19694 .cindex "transport" "header lines only"
19695 .cindex "message" "transporting headers only"
19696 .cindex "header lines" "transporting"
19697 If this option is set, the message's body is not transported. It is mutually
19698 exclusive with &%body_only%&. If it is used with the &(appendfile)& or &(pipe)&
19699 transports, the settings of &%message_prefix%& and &%message_suffix%& should be
19700 checked, since this option does not automatically suppress them.
19701
19702
19703 .option headers_remove transports string&!! unset
19704 .cindex "header lines" "removing"
19705 .cindex "transport" "header lines; removing"
19706 This option specifies a string that is expanded into a list of header names;
19707 these headers are omitted from the message as it is transported, as described
19708 in section &<<SECTheadersaddrem>>&. Header removal can also be specified by
19709 routers. If the result of the expansion is an empty string, or if the expansion
19710 is forced to fail, no action is taken. Other expansion failures are treated as
19711 errors and cause the delivery to be deferred.
19712
19713 Unlike most options, &%headers_remove%& can be specified multiple times
19714 for a router; all listed headers are added.
19715
19716
19717
19718 .option headers_rewrite transports string unset
19719 .cindex "transport" "header lines; rewriting"
19720 .cindex "rewriting" "at transport time"
19721 This option allows addresses in header lines to be rewritten at transport time,
19722 that is, as the message is being copied to its destination. The contents of the
19723 option are a colon-separated list of rewriting rules. Each rule is in exactly
19724 the same form as one of the general rewriting rules that are applied when a
19725 message is received. These are described in chapter &<<CHAPrewrite>>&. For
19726 example,
19727 .code
19728 headers_rewrite = a@b c@d f : \
19729                   x@y w@z
19730 .endd
19731 changes &'a@b'& into &'c@d'& in &'From:'& header lines, and &'x@y'& into
19732 &'w@z'& in all address-bearing header lines. The rules are applied to the
19733 header lines just before they are written out at transport time, so they affect
19734 only those copies of the message that pass through the transport. However, only
19735 the message's original header lines, and any that were added by a system
19736 filter, are rewritten. If a router or transport adds header lines, they are not
19737 affected by this option. These rewriting rules are &'not'& applied to the
19738 envelope. You can change the return path using &%return_path%&, but you cannot
19739 change envelope recipients at this time.
19740
19741
19742 .option home_directory transports string&!! unset
19743 .cindex "transport" "home directory for"
19744 .vindex "&$home$&"
19745 This option specifies a home directory setting for a local transport,
19746 overriding any value that may be set by the router. The home directory is
19747 placed in &$home$& while expanding the transport's private options. It is also
19748 used as the current directory if no current directory is set by the
19749 &%current_directory%& option on the transport or the
19750 &%transport_current_directory%& option on the router. If the expansion fails
19751 for any reason, including forced failure, an error is logged, and delivery is
19752 deferred.
19753
19754
19755 .option initgroups transports boolean false
19756 .cindex "additional groups"
19757 .cindex "groups" "additional"
19758 .cindex "transport" "group; additional"
19759 If this option is true and the uid for the delivery process is provided by the
19760 transport, the &[initgroups()]& function is called when running the transport
19761 to ensure that any additional groups associated with the uid are set up.
19762
19763
19764 .option message_size_limit transports string&!! 0
19765 .cindex "limit" "message size per transport"
19766 .cindex "size" "of message, limit"
19767 .cindex "transport" "message size; limiting"
19768 This option controls the size of messages passed through the transport. It is
19769 expanded before use; the result of the expansion must be a sequence of decimal
19770 digits, optionally followed by K or M. If the expansion fails for any reason,
19771 including forced failure, or if the result is not of the required form,
19772 delivery is deferred. If the value is greater than zero and the size of a
19773 message exceeds this limit, the address is failed. If there is any chance that
19774 the resulting bounce message could be routed to the same transport, you should
19775 ensure that &%return_size_limit%& is less than the transport's
19776 &%message_size_limit%&, as otherwise the bounce message will fail to get
19777 delivered.
19778
19779
19780
19781 .option rcpt_include_affixes transports boolean false
19782 .cindex "prefix" "for local part, including in envelope"
19783 .cindex "suffix for local part" "including in envelope"
19784 .cindex "local part" "prefix"
19785 .cindex "local part" "suffix"
19786 When this option is false (the default), and an address that has had any
19787 affixes (prefixes or suffixes) removed from the local part is delivered by any
19788 form of SMTP or LMTP, the affixes are not included. For example, if a router
19789 that contains
19790 .code
19791 local_part_prefix = *-
19792 .endd
19793 routes the address &'abc-xyz@some.domain'& to an SMTP transport, the envelope
19794 is delivered with
19795 .code
19796 RCPT TO:<xyz@some.domain>
19797 .endd
19798 This is also the case when an ACL-time callout is being used to verify a
19799 recipient address. However, if &%rcpt_include_affixes%& is set true, the
19800 whole local part is included in the RCPT command. This option applies to BSMTP
19801 deliveries by the &(appendfile)& and &(pipe)& transports as well as to the
19802 &(lmtp)& and &(smtp)& transports.
19803
19804
19805 .option retry_use_local_part transports boolean "see below"
19806 .cindex "hints database" "retry keys"
19807 When a delivery suffers a temporary failure, a retry record is created
19808 in Exim's hints database. For remote deliveries, the key for the retry record
19809 is based on the name and/or IP address of the failing remote host. For local
19810 deliveries, the key is normally the entire address, including both the local
19811 part and the domain. This is suitable for most common cases of local delivery
19812 temporary failure &-- for example, exceeding a mailbox quota should delay only
19813 deliveries to that mailbox, not to the whole domain.
19814
19815 However, in some special cases you may want to treat a temporary local delivery
19816 as a failure associated with the domain, and not with a particular local part.
19817 (For example, if you are storing all mail for some domain in files.) You can do
19818 this by setting &%retry_use_local_part%& false.
19819
19820 For all the local transports, its default value is true. For remote transports,
19821 the default value is false for tidiness, but changing the value has no effect
19822 on a remote transport in the current implementation.
19823
19824
19825 .option return_path transports string&!! unset
19826 .cindex "envelope sender"
19827 .cindex "transport" "return path; changing"
19828 .cindex "return path" "changing in transport"
19829 If this option is set, the string is expanded at transport time and replaces
19830 the existing return path (envelope sender) value in the copy of the message
19831 that is being delivered. An empty return path is permitted. This feature is
19832 designed for remote deliveries, where the value of this option is used in the
19833 SMTP MAIL command. If you set &%return_path%& for a local transport, the
19834 only effect is to change the address that is placed in the &'Return-path:'&
19835 header line, if one is added to the message (see the next option).
19836
19837 &*Note:*& A changed return path is not logged unless you add
19838 &%return_path_on_delivery%& to the log selector.
19839
19840 .vindex "&$return_path$&"
19841 The expansion can refer to the existing value via &$return_path$&. This is
19842 either the message's envelope sender, or an address set by the
19843 &%errors_to%& option on a router. If the expansion is forced to fail, no
19844 replacement occurs; if it fails for another reason, delivery is deferred. This
19845 option can be used to support VERP (Variable Envelope Return Paths) &-- see
19846 section &<<SECTverp>>&.
19847
19848 &*Note*&: If a delivery error is detected locally, including the case when a
19849 remote server rejects a message at SMTP time, the bounce message is not sent to
19850 the value of this option. It is sent to the previously set errors address.
19851 This defaults to the incoming sender address, but can be changed by setting
19852 &%errors_to%& in a router.
19853
19854
19855
19856 .option return_path_add transports boolean false
19857 .cindex "&'Return-path:'& header line"
19858 If this option is true, a &'Return-path:'& header is added to the message.
19859 Although the return path is normally available in the prefix line of BSD
19860 mailboxes, this is commonly not displayed by MUAs, and so the user does not
19861 have easy access to it.
19862
19863 RFC 2821 states that the &'Return-path:'& header is added to a message &"when
19864 the delivery SMTP server makes the final delivery"&. This implies that this
19865 header should not be present in incoming messages. Exim has a configuration
19866 option, &%return_path_remove%&, which requests removal of this header from
19867 incoming messages, so that delivered messages can safely be resent to other
19868 recipients.
19869
19870
19871 .option shadow_condition transports string&!! unset
19872 See &%shadow_transport%& below.
19873
19874
19875 .option shadow_transport transports string unset
19876 .cindex "shadow transport"
19877 .cindex "transport" "shadow"
19878 A local transport may set the &%shadow_transport%& option to the name of
19879 another local transport. Shadow remote transports are not supported.
19880
19881 Whenever a delivery to the main transport succeeds, and either
19882 &%shadow_condition%& is unset, or its expansion does not result in the empty
19883 string or one of the strings &"0"& or &"no"& or &"false"&, the message is also
19884 passed to the shadow transport, with the same delivery address or addresses. If
19885 expansion fails, no action is taken except that non-forced expansion failures
19886 cause a log line to be written.
19887
19888 The result of the shadow transport is discarded and does not affect the
19889 subsequent processing of the message. Only a single level of shadowing is
19890 provided; the &%shadow_transport%& option is ignored on any transport when it
19891 is running as a shadow. Options concerned with output from pipes are also
19892 ignored. The log line for the successful delivery has an item added on the end,
19893 of the form
19894 .code
19895 ST=<shadow transport name>
19896 .endd
19897 If the shadow transport did not succeed, the error message is put in
19898 parentheses afterwards. Shadow transports can be used for a number of different
19899 purposes, including keeping more detailed log information than Exim normally
19900 provides, and implementing automatic acknowledgment policies based on message
19901 headers that some sites insist on.
19902
19903
19904 .option transport_filter transports string&!! unset
19905 .cindex "transport" "filter"
19906 .cindex "filter" "transport filter"
19907 This option sets up a filtering (in the Unix shell sense) process for messages
19908 at transport time. It should not be confused with mail filtering as set up by
19909 individual users or via a system filter.
19910
19911 When the message is about to be written out, the command specified by
19912 &%transport_filter%& is started up in a separate, parallel process, and
19913 the entire message, including the header lines, is passed to it on its standard
19914 input (this in fact is done from a third process, to avoid deadlock). The
19915 command must be specified as an absolute path.
19916
19917 The lines of the message that are written to the transport filter are
19918 terminated by newline (&"\n"&). The message is passed to the filter before any
19919 SMTP-specific processing, such as turning &"\n"& into &"\r\n"& and escaping
19920 lines beginning with a dot, and also before any processing implied by the
19921 settings of &%check_string%& and &%escape_string%& in the &(appendfile)& or
19922 &(pipe)& transports.
19923
19924 The standard error for the filter process is set to the same destination as its
19925 standard output; this is read and written to the message's ultimate
19926 destination. The process that writes the message to the filter, the
19927 filter itself, and the original process that reads the result and delivers it
19928 are all run in parallel, like a shell pipeline.
19929
19930 The filter can perform any transformations it likes, but of course should take
19931 care not to break RFC 2822 syntax. Exim does not check the result, except to
19932 test for a final newline when SMTP is in use. All messages transmitted over
19933 SMTP must end with a newline, so Exim supplies one if it is missing.
19934
19935 .cindex "content scanning" "per user"
19936 A transport filter can be used to provide content-scanning on a per-user basis
19937 at delivery time if the only required effect of the scan is to modify the
19938 message. For example, a content scan could insert a new header line containing
19939 a spam score. This could be interpreted by a filter in the user's MUA. It is
19940 not possible to discard a message at this stage.
19941
19942 .cindex "SMTP" "SIZE"
19943 A problem might arise if the filter increases the size of a message that is
19944 being sent down an SMTP connection. If the receiving SMTP server has indicated
19945 support for the SIZE parameter, Exim will have sent the size of the message
19946 at the start of the SMTP session. If what is actually sent is substantially
19947 more, the server might reject the message. This can be worked round by setting
19948 the &%size_addition%& option on the &(smtp)& transport, either to allow for
19949 additions to the message, or to disable the use of SIZE altogether.
19950
19951 .vindex "&$pipe_addresses$&"
19952 The value of the &%transport_filter%& option is the command string for starting
19953 the filter, which is run directly from Exim, not under a shell. The string is
19954 parsed by Exim in the same way as a command string for the &(pipe)& transport:
19955 Exim breaks it up into arguments and then expands each argument separately (see
19956 section &<<SECThowcommandrun>>&). Any kind of expansion failure causes delivery
19957 to be deferred. The special argument &$pipe_addresses$& is replaced by a number
19958 of arguments, one for each address that applies to this delivery. (This isn't
19959 an ideal name for this feature here, but as it was already implemented for the
19960 &(pipe)& transport, it seemed sensible not to change it.)
19961
19962 .vindex "&$host$&"
19963 .vindex "&$host_address$&"
19964 The expansion variables &$host$& and &$host_address$& are available when the
19965 transport is a remote one. They contain the name and IP address of the host to
19966 which the message is being sent. For example:
19967 .code
19968 transport_filter = /some/directory/transport-filter.pl \
19969   $host $host_address $sender_address $pipe_addresses
19970 .endd
19971
19972 Two problems arise if you want to use more complicated expansion items to
19973 generate transport filter commands, both of which due to the fact that the
19974 command is split up &'before'& expansion.
19975 .ilist
19976 If an expansion item contains white space, you must quote it, so that it is all
19977 part of the same command item. If the entire option setting is one such
19978 expansion item, you have to take care what kind of quoting you use. For
19979 example:
19980 .code
19981 transport_filter = '/bin/cmd${if eq{$host}{a.b.c}{1}{2}}'
19982 .endd
19983 This runs the command &(/bin/cmd1)& if the host name is &'a.b.c'&, and
19984 &(/bin/cmd2)& otherwise. If double quotes had been used, they would have been
19985 stripped by Exim when it read the option's value. When the value is used, if
19986 the single quotes were missing, the line would be split into two items,
19987 &`/bin/cmd${if`& and &`eq{$host}{a.b.c}{1}{2}`&, and an error would occur when
19988 Exim tried to expand the first one.
19989 .next
19990 Except for the special case of &$pipe_addresses$& that is mentioned above, an
19991 expansion cannot generate multiple arguments, or a command name followed by
19992 arguments. Consider this example:
19993 .code
19994 transport_filter = ${lookup{$host}lsearch{/a/file}\
19995                     {$value}{/bin/cat}}
19996 .endd
19997 The result of the lookup is interpreted as the name of the command, even
19998 if it contains white space. The simplest way round this is to use a shell:
19999 .code
20000 transport_filter = /bin/sh -c ${lookup{$host}lsearch{/a/file}\
20001                                {$value}{/bin/cat}}
20002 .endd
20003 .endlist
20004
20005 The filter process is run under the same uid and gid as the normal delivery.
20006 For remote deliveries this is the Exim uid/gid by default. The command should
20007 normally yield a zero return code. Transport filters are not supposed to fail.
20008 A non-zero code is taken to mean that the transport filter encountered some
20009 serious problem. Delivery of the message is deferred; the message remains on
20010 the queue and is tried again later. It is not possible to cause a message to be
20011 bounced from a transport filter.
20012
20013 If a transport filter is set on an autoreply transport, the original message is
20014 passed through the filter as it is being copied into the newly generated
20015 message, which happens if the &%return_message%& option is set.
20016
20017
20018 .option transport_filter_timeout transports time 5m
20019 .cindex "transport" "filter, timeout"
20020 When Exim is reading the output of a transport filter, it applies a timeout
20021 that can be set by this option. Exceeding the timeout is normally treated as a
20022 temporary delivery failure. However, if a transport filter is used with a
20023 &(pipe)& transport, a timeout in the transport filter is treated in the same
20024 way as a timeout in the pipe command itself. By default, a timeout is a hard
20025 error, but if the &(pipe)& transport's &%timeout_defer%& option is set true, it
20026 becomes a temporary error.
20027
20028
20029 .option user transports string&!! "Exim user"
20030 .cindex "uid (user id)" "local delivery"
20031 .cindex "transport" "user, specifying"
20032 This option specifies the user under whose uid the delivery process is to be
20033 run, overriding any uid that may have been set by the router. If the user is
20034 given as a name, the uid is looked up from the password data, and the
20035 associated group is taken as the value of the gid to be used if the &%group%&
20036 option is not set.
20037
20038 For deliveries that use local transports, a user and group are normally
20039 specified explicitly or implicitly (for example, as a result of
20040 &%check_local_user%&) by the router or transport.
20041
20042 .cindex "hints database" "access by remote transport"
20043 For remote transports, you should leave this option unset unless you really are
20044 sure you know what you are doing. When a remote transport is running, it needs
20045 to be able to access Exim's hints databases, because each host may have its own
20046 retry data.
20047 .ecindex IIDgenoptra1
20048 .ecindex IIDgenoptra2
20049 .ecindex IIDgenoptra3
20050
20051
20052
20053
20054
20055
20056 . ////////////////////////////////////////////////////////////////////////////
20057 . ////////////////////////////////////////////////////////////////////////////
20058
20059 .chapter "Address batching in local transports" "CHAPbatching" &&&
20060          "Address batching"
20061 .cindex "transport" "local; address batching in"
20062 The only remote transport (&(smtp)&) is normally configured to handle more than
20063 one address at a time, so that when several addresses are routed to the same
20064 remote host, just one copy of the message is sent. Local transports, however,
20065 normally handle one address at a time. That is, a separate instance of the
20066 transport is run for each address that is routed to the transport. A separate
20067 copy of the message is delivered each time.
20068
20069 .cindex "batched local delivery"
20070 .oindex "&%batch_max%&"
20071 .oindex "&%batch_id%&"
20072 In special cases, it may be desirable to handle several addresses at once in a
20073 local transport, for example:
20074
20075 .ilist
20076 In an &(appendfile)& transport, when storing messages in files for later
20077 delivery by some other means, a single copy of the message with multiple
20078 recipients saves space.
20079 .next
20080 In an &(lmtp)& transport, when delivering over &"local SMTP"& to some process,
20081 a single copy saves time, and is the normal way LMTP is expected to work.
20082 .next
20083 In a &(pipe)& transport, when passing the message
20084 to a scanner program or
20085 to some other delivery mechanism such as UUCP, multiple recipients may be
20086 acceptable.
20087 .endlist
20088
20089 These three local transports all have the same options for controlling multiple
20090 (&"batched"&) deliveries, namely &%batch_max%& and &%batch_id%&. To save
20091 repeating the information for each transport, these options are described here.
20092
20093 The &%batch_max%& option specifies the maximum number of addresses that can be
20094 delivered together in a single run of the transport. Its default value is one
20095 (no batching). When more than one address is routed to a transport that has a
20096 &%batch_max%& value greater than one, the addresses are delivered in a batch
20097 (that is, in a single run of the transport with multiple recipients), subject
20098 to certain conditions:
20099
20100 .ilist
20101 .vindex "&$local_part$&"
20102 If any of the transport's options contain a reference to &$local_part$&, no
20103 batching is possible.
20104 .next
20105 .vindex "&$domain$&"
20106 If any of the transport's options contain a reference to &$domain$&, only
20107 addresses with the same domain are batched.
20108 .next
20109 .cindex "customizing" "batching condition"
20110 If &%batch_id%& is set, it is expanded for each address, and only those
20111 addresses with the same expanded value are batched. This allows you to specify
20112 customized batching conditions. Failure of the expansion for any reason,
20113 including forced failure, disables batching, but it does not stop the delivery
20114 from taking place.
20115 .next
20116 Batched addresses must also have the same errors address (where to send
20117 delivery errors), the same header additions and removals, the same user and
20118 group for the transport, and if a host list is present, the first host must
20119 be the same.
20120 .endlist
20121
20122 In the case of the &(appendfile)& and &(pipe)& transports, batching applies
20123 both when the file or pipe command is specified in the transport, and when it
20124 is specified by a &(redirect)& router, but all the batched addresses must of
20125 course be routed to the same file or pipe command. These two transports have an
20126 option called &%use_bsmtp%&, which causes them to deliver the message in
20127 &"batched SMTP"& format, with the envelope represented as SMTP commands. The
20128 &%check_string%& and &%escape_string%& options are forced to the values
20129 .code
20130 check_string = "."
20131 escape_string = ".."
20132 .endd
20133 when batched SMTP is in use. A full description of the batch SMTP mechanism is
20134 given in section &<<SECTbatchSMTP>>&. The &(lmtp)& transport does not have a
20135 &%use_bsmtp%& option, because it always delivers using the SMTP protocol.
20136
20137 .cindex "&'Envelope-to:'& header line"
20138 If the generic &%envelope_to_add%& option is set for a batching transport, the
20139 &'Envelope-to:'& header that is added to the message contains all the addresses
20140 that are being processed together. If you are using a batching &(appendfile)&
20141 transport without &%use_bsmtp%&, the only way to preserve the recipient
20142 addresses is to set the &%envelope_to_add%& option.
20143
20144 .cindex "&(pipe)& transport" "with multiple addresses"
20145 .vindex "&$pipe_addresses$&"
20146 If you are using a &(pipe)& transport without BSMTP, and setting the
20147 transport's &%command%& option, you can include &$pipe_addresses$& as part of
20148 the command. This is not a true variable; it is a bit of magic that causes each
20149 of the recipient addresses to be inserted into the command as a separate
20150 argument. This provides a way of accessing all the addresses that are being
20151 delivered in the batch. &*Note:*& This is not possible for pipe commands that
20152 are specified by a &(redirect)& router.
20153
20154
20155
20156
20157 . ////////////////////////////////////////////////////////////////////////////
20158 . ////////////////////////////////////////////////////////////////////////////
20159
20160 .chapter "The appendfile transport" "CHAPappendfile"
20161 .scindex IIDapptra1 "&(appendfile)& transport"
20162 .scindex IIDapptra2 "transports" "&(appendfile)&"
20163 .cindex "directory creation"
20164 .cindex "creating directories"
20165 The &(appendfile)& transport delivers a message by appending it to an existing
20166 file, or by creating an entirely new file in a specified directory. Single
20167 files to which messages are appended can be in the traditional Unix mailbox
20168 format, or optionally in the MBX format supported by the Pine MUA and
20169 University of Washington IMAP daemon, &'inter alia'&. When each message is
20170 being delivered as a separate file, &"maildir"& format can optionally be used
20171 to give added protection against failures that happen part-way through the
20172 delivery. A third form of separate-file delivery known as &"mailstore"& is also
20173 supported. For all file formats, Exim attempts to create as many levels of
20174 directory as necessary, provided that &%create_directory%& is set.
20175
20176 The code for the optional formats is not included in the Exim binary by
20177 default. It is necessary to set SUPPORT_MBX, SUPPORT_MAILDIR and/or
20178 SUPPORT_MAILSTORE in &_Local/Makefile_& to have the appropriate code
20179 included.
20180
20181 .cindex "quota" "system"
20182 Exim recognizes system quota errors, and generates an appropriate message. Exim
20183 also supports its own quota control within the transport, for use when the
20184 system facility is unavailable or cannot be used for some reason.
20185
20186 If there is an error while appending to a file (for example, quota exceeded or
20187 partition filled), Exim attempts to reset the file's length and last
20188 modification time back to what they were before. If there is an error while
20189 creating an entirely new file, the new file is removed.
20190
20191 Before appending to a file, a number of security checks are made, and the
20192 file is locked. A detailed description is given below, after the list of
20193 private options.
20194
20195 The &(appendfile)& transport is most commonly used for local deliveries to
20196 users' mailboxes. However, it can also be used as a pseudo-remote transport for
20197 putting messages into files for remote delivery by some means other than Exim.
20198 &"Batch SMTP"& format is often used in this case (see the &%use_bsmtp%&
20199 option).
20200
20201
20202
20203 .section "The file and directory options" "SECTfildiropt"
20204 The &%file%& option specifies a single file, to which the message is appended;
20205 the &%directory%& option specifies a directory, in which a new file containing
20206 the message is created. Only one of these two options can be set, and for
20207 normal deliveries to mailboxes, one of them &'must'& be set.
20208
20209 .vindex "&$address_file$&"
20210 .vindex "&$local_part$&"
20211 However, &(appendfile)& is also used for delivering messages to files or
20212 directories whose names (or parts of names) are obtained from alias,
20213 forwarding, or filtering operations (for example, a &%save%& command in a
20214 user's Exim filter). When such a transport is running, &$local_part$& contains
20215 the local part that was aliased or forwarded, and &$address_file$& contains the
20216 name (or partial name) of the file or directory generated by the redirection
20217 operation. There are two cases:
20218
20219 .ilist
20220 If neither &%file%& nor &%directory%& is set, the redirection operation
20221 must specify an absolute path (one that begins with &`/`&). This is the most
20222 common case when users with local accounts use filtering to sort mail into
20223 different folders. See for example, the &(address_file)& transport in the
20224 default configuration. If the path ends with a slash, it is assumed to be the
20225 name of a directory. A delivery to a directory can also be forced by setting
20226 &%maildir_format%& or &%mailstore_format%&.
20227 .next
20228 If &%file%& or &%directory%& is set for a delivery from a redirection, it is
20229 used to determine the file or directory name for the delivery. Normally, the
20230 contents of &$address_file$& are used in some way in the string expansion.
20231 .endlist
20232
20233
20234 .cindex "Sieve filter" "configuring &(appendfile)&"
20235 .cindex "Sieve filter" "relative mailbox path handling"
20236 As an example of the second case, consider an environment where users do not
20237 have home directories. They may be permitted to use Exim filter commands of the
20238 form:
20239 .code
20240 save folder23
20241 .endd
20242 or Sieve filter commands of the form:
20243 .code
20244 require "fileinto";
20245 fileinto "folder23";
20246 .endd
20247 In this situation, the expansion of &%file%& or &%directory%& in the transport
20248 must transform the relative path into an appropriate absolute file name. In the
20249 case of Sieve filters, the name &'inbox'& must be handled. It is the name that
20250 is used as a result of a &"keep"& action in the filter. This example shows one
20251 way of handling this requirement:
20252 .code
20253 file = ${if eq{$address_file}{inbox} \
20254             {/var/mail/$local_part} \
20255             {${if eq{${substr_0_1:$address_file}}{/} \
20256                   {$address_file} \
20257                   {$home/mail/$address_file} \
20258             }} \
20259        }
20260 .endd
20261 With this setting of &%file%&, &'inbox'& refers to the standard mailbox
20262 location, absolute paths are used without change, and other folders are in the
20263 &_mail_& directory within the home directory.
20264
20265 &*Note 1*&: While processing an Exim filter, a relative path such as
20266 &_folder23_& is turned into an absolute path if a home directory is known to
20267 the router. In particular, this is the case if &%check_local_user%& is set. If
20268 you want to prevent this happening at routing time, you can set
20269 &%router_home_directory%& empty. This forces the router to pass the relative
20270 path to the transport.
20271
20272 &*Note 2*&: An absolute path in &$address_file$& is not treated specially;
20273 the &%file%& or &%directory%& option is still used if it is set.
20274
20275
20276
20277
20278 .section "Private options for appendfile" "SECID134"
20279 .cindex "options" "&(appendfile)& transport"
20280
20281
20282
20283 .option allow_fifo appendfile boolean false
20284 .cindex "fifo (named pipe)"
20285 .cindex "named pipe (fifo)"
20286 .cindex "pipe" "named (fifo)"
20287 Setting this option permits delivery to named pipes (FIFOs) as well as to
20288 regular files. If no process is reading the named pipe at delivery time, the
20289 delivery is deferred.
20290
20291
20292 .option allow_symlink appendfile boolean false
20293 .cindex "symbolic link" "to mailbox"
20294 .cindex "mailbox" "symbolic link"
20295 By default, &(appendfile)& will not deliver if the path name for the file is
20296 that of a symbolic link. Setting this option relaxes that constraint, but there
20297 are security issues involved in the use of symbolic links. Be sure you know
20298 what you are doing if you set this. Details of exactly what this option affects
20299 are included in the discussion which follows this list of options.
20300
20301
20302 .option batch_id appendfile string&!! unset
20303 See the description of local delivery batching in chapter &<<CHAPbatching>>&.
20304 However, batching is automatically disabled for &(appendfile)& deliveries that
20305 happen as a result of forwarding or aliasing or other redirection directly to a
20306 file.
20307
20308
20309 .option batch_max appendfile integer 1
20310 See the description of local delivery batching in chapter &<<CHAPbatching>>&.
20311
20312
20313 .option check_group appendfile boolean false
20314 When this option is set, the group owner of the file defined by the &%file%&
20315 option is checked to see that it is the same as the group under which the
20316 delivery process is running. The default setting is false because the default
20317 file mode is 0600, which means that the group is irrelevant.
20318
20319
20320 .option check_owner appendfile boolean true
20321 When this option is set, the owner of the file defined by the &%file%& option
20322 is checked to ensure that it is the same as the user under which the delivery
20323 process is running.
20324
20325
20326 .option check_string appendfile string "see below"
20327 .cindex "&""From""& line"
20328 As &(appendfile)& writes the message, the start of each line is tested for
20329 matching &%check_string%&, and if it does, the initial matching characters are
20330 replaced by the contents of &%escape_string%&. The value of &%check_string%& is
20331 a literal string, not a regular expression, and the case of any letters it
20332 contains is significant.
20333
20334 If &%use_bsmtp%& is set the values of &%check_string%& and &%escape_string%&
20335 are forced to &"."& and &".."& respectively, and any settings in the
20336 configuration are ignored. Otherwise, they default to &"From&~"& and
20337 &">From&~"& when the &%file%& option is set, and unset when any of the
20338 &%directory%&, &%maildir%&, or &%mailstore%& options are set.
20339
20340 The default settings, along with &%message_prefix%& and &%message_suffix%&, are
20341 suitable for traditional &"BSD"& mailboxes, where a line beginning with
20342 &"From&~"& indicates the start of a new message. All four options need changing
20343 if another format is used. For example, to deliver to mailboxes in MMDF format:
20344 .cindex "MMDF format mailbox"
20345 .cindex "mailbox" "MMDF format"
20346 .code
20347 check_string = "\1\1\1\1\n"
20348 escape_string = "\1\1\1\1 \n"
20349 message_prefix = "\1\1\1\1\n"
20350 message_suffix = "\1\1\1\1\n"
20351 .endd
20352 .option create_directory appendfile boolean true
20353 .cindex "directory creation"
20354 When this option is true, Exim attempts to create any missing superior
20355 directories for the file that it is about to write. A created directory's mode
20356 is given by the &%directory_mode%& option.
20357
20358 The group ownership of a newly created directory is highly dependent on the
20359 operating system (and possibly the file system) that is being used. For
20360 example, in Solaris, if the parent directory has the setgid bit set, its group
20361 is propagated to the child; if not, the currently set group is used. However,
20362 in FreeBSD, the parent's group is always used.
20363
20364
20365
20366 .option create_file appendfile string anywhere
20367 This option constrains the location of files and directories that are created
20368 by this transport. It applies to files defined by the &%file%& option and
20369 directories defined by the &%directory%& option. In the case of maildir
20370 delivery, it applies to the top level directory, not the maildir directories
20371 beneath.
20372
20373 The option must be set to one of the words &"anywhere"&, &"inhome"&, or
20374 &"belowhome"&. In the second and third cases, a home directory must have been
20375 set for the transport. This option is not useful when an explicit file name is
20376 given for normal mailbox deliveries. It is intended for the case when file
20377 names are generated from users' &_.forward_& files. These are usually handled
20378 by an &(appendfile)& transport called &%address_file%&. See also
20379 &%file_must_exist%&.
20380
20381
20382 .option directory appendfile string&!! unset
20383 This option is mutually exclusive with the &%file%& option, but one of &%file%&
20384 or &%directory%& must be set, unless the delivery is the direct result of a
20385 redirection (see section &<<SECTfildiropt>>&).
20386
20387 When &%directory%& is set, the string is expanded, and the message is delivered
20388 into a new file or files in or below the given directory, instead of being
20389 appended to a single mailbox file. A number of different formats are provided
20390 (see &%maildir_format%& and &%mailstore_format%&), and see section
20391 &<<SECTopdir>>& for further details of this form of delivery.
20392
20393
20394 .option directory_file appendfile string&!! "see below"
20395 .cindex "base62"
20396 .vindex "&$inode$&"
20397 When &%directory%& is set, but neither &%maildir_format%& nor
20398 &%mailstore_format%& is set, &(appendfile)& delivers each message into a file
20399 whose name is obtained by expanding this string. The default value is:
20400 .code
20401 q${base62:$tod_epoch}-$inode
20402 .endd
20403 This generates a unique name from the current time, in base 62 form, and the
20404 inode of the file. The variable &$inode$& is available only when expanding this
20405 option.
20406
20407
20408 .option directory_mode appendfile "octal integer" 0700
20409 If &(appendfile)& creates any directories as a result of the
20410 &%create_directory%& option, their mode is specified by this option.
20411
20412
20413 .option escape_string appendfile string "see description"
20414 See &%check_string%& above.
20415
20416
20417 .option file appendfile string&!! unset
20418 This option is mutually exclusive with the &%directory%& option, but one of
20419 &%file%& or &%directory%& must be set, unless the delivery is the direct result
20420 of a redirection (see section &<<SECTfildiropt>>&). The &%file%& option
20421 specifies a single file, to which the message is appended. One or more of
20422 &%use_fcntl_lock%&, &%use_flock_lock%&, or &%use_lockfile%& must be set with
20423 &%file%&.
20424
20425 .cindex "NFS" "lock file"
20426 .cindex "locking files"
20427 .cindex "lock files"
20428 If you are using more than one host to deliver over NFS into the same
20429 mailboxes, you should always use lock files.
20430
20431 The string value is expanded for each delivery, and must yield an absolute
20432 path. The most common settings of this option are variations on one of these
20433 examples:
20434 .code
20435 file = /var/spool/mail/$local_part
20436 file = /home/$local_part/inbox
20437 file = $home/inbox
20438 .endd
20439 .cindex "&""sticky""& bit"
20440 In the first example, all deliveries are done into the same directory. If Exim
20441 is configured to use lock files (see &%use_lockfile%& below) it must be able to
20442 create a file in the directory, so the &"sticky"& bit must be turned on for
20443 deliveries to be possible, or alternatively the &%group%& option can be used to
20444 run the delivery under a group id which has write access to the directory.
20445
20446
20447
20448 .option file_format appendfile string unset
20449 .cindex "file" "mailbox; checking existing format"
20450 This option requests the transport to check the format of an existing file
20451 before adding to it. The check consists of matching a specific string at the
20452 start of the file. The value of the option consists of an even number of
20453 colon-separated strings. The first of each pair is the test string, and the
20454 second is the name of a transport. If the transport associated with a matched
20455 string is not the current transport, control is passed over to the other
20456 transport. For example, suppose the standard &(local_delivery)& transport has
20457 this added to it:
20458 .code
20459 file_format = "From       : local_delivery :\
20460                \1\1\1\1\n : local_mmdf_delivery"
20461 .endd
20462 Mailboxes that begin with &"From"& are still handled by this transport, but if
20463 a mailbox begins with four binary ones followed by a newline, control is passed
20464 to a transport called &%local_mmdf_delivery%&, which presumably is configured
20465 to do the delivery in MMDF format. If a mailbox does not exist or is empty, it
20466 is assumed to match the current transport. If the start of a mailbox doesn't
20467 match any string, or if the transport named for a given string is not defined,
20468 delivery is deferred.
20469
20470
20471 .option file_must_exist appendfile boolean false
20472 If this option is true, the file specified by the &%file%& option must exist.
20473 A temporary error occurs if it does not, causing delivery to be deferred.
20474 If this option is false, the file is created if it does not exist.
20475
20476
20477 .option lock_fcntl_timeout appendfile time 0s
20478 .cindex "timeout" "mailbox locking"
20479 .cindex "mailbox" "locking, blocking and non-blocking"
20480 .cindex "locking files"
20481 By default, the &(appendfile)& transport uses non-blocking calls to &[fcntl()]&
20482 when locking an open mailbox file. If the call fails, the delivery process
20483 sleeps for &%lock_interval%& and tries again, up to &%lock_retries%& times.
20484 Non-blocking calls are used so that the file is not kept open during the wait
20485 for the lock; the reason for this is to make it as safe as possible for
20486 deliveries over NFS in the case when processes might be accessing an NFS
20487 mailbox without using a lock file. This should not be done, but
20488 misunderstandings and hence misconfigurations are not unknown.
20489
20490 On a busy system, however, the performance of a non-blocking lock approach is
20491 not as good as using a blocking lock with a timeout. In this case, the waiting
20492 is done inside the system call, and Exim's delivery process acquires the lock
20493 and can proceed as soon as the previous lock holder releases it.
20494
20495 If &%lock_fcntl_timeout%& is set to a non-zero time, blocking locks, with that
20496 timeout, are used. There may still be some retrying: the maximum number of
20497 retries is
20498 .code
20499 (lock_retries * lock_interval) / lock_fcntl_timeout
20500 .endd
20501 rounded up to the next whole number. In other words, the total time during
20502 which &(appendfile)& is trying to get a lock is roughly the same, unless
20503 &%lock_fcntl_timeout%& is set very large.
20504
20505 You should consider setting this option if you are getting a lot of delayed
20506 local deliveries because of errors of the form
20507 .code
20508 failed to lock mailbox /some/file (fcntl)
20509 .endd
20510
20511 .option lock_flock_timeout appendfile time 0s
20512 This timeout applies to file locking when using &[flock()]& (see
20513 &%use_flock%&); the timeout operates in a similar manner to
20514 &%lock_fcntl_timeout%&.
20515
20516
20517 .option lock_interval appendfile time 3s
20518 This specifies the time to wait between attempts to lock the file. See below
20519 for details of locking.
20520
20521
20522 .option lock_retries appendfile integer 10
20523 This specifies the maximum number of attempts to lock the file. A value of zero
20524 is treated as 1. See below for details of locking.
20525
20526
20527 .option lockfile_mode appendfile "octal integer" 0600
20528 This specifies the mode of the created lock file, when a lock file is being
20529 used (see &%use_lockfile%& and &%use_mbx_lock%&).
20530
20531
20532 .option lockfile_timeout appendfile time 30m
20533 .cindex "timeout" "mailbox locking"
20534 When a lock file is being used (see &%use_lockfile%&), if a lock file already
20535 exists and is older than this value, it is assumed to have been left behind by
20536 accident, and Exim attempts to remove it.
20537
20538
20539 .option mailbox_filecount appendfile string&!! unset
20540 .cindex "mailbox" "specifying size of"
20541 .cindex "size" "of mailbox"
20542 If this option is set, it is expanded, and the result is taken as the current
20543 number of files in the mailbox. It must be a decimal number, optionally
20544 followed by K or M. This provides a way of obtaining this information from an
20545 external source that maintains the data.
20546
20547
20548 .option mailbox_size appendfile string&!! unset
20549 .cindex "mailbox" "specifying size of"
20550 .cindex "size" "of mailbox"
20551 If this option is set, it is expanded, and the result is taken as the current
20552 size the mailbox. It must be a decimal number, optionally followed by K or M.
20553 This provides a way of obtaining this information from an external source that
20554 maintains the data. This is likely to be helpful for maildir deliveries where
20555 it is computationally expensive to compute the size of a mailbox.
20556
20557
20558
20559 .option maildir_format appendfile boolean false
20560 .cindex "maildir format" "specifying"
20561 If this option is set with the &%directory%& option, the delivery is into a new
20562 file, in the &"maildir"& format that is used by other mail software. When the
20563 transport is activated directly from a &(redirect)& router (for example, the
20564 &(address_file)& transport in the default configuration), setting
20565 &%maildir_format%& causes the path received from the router to be treated as a
20566 directory, whether or not it ends with &`/`&. This option is available only if
20567 SUPPORT_MAILDIR is present in &_Local/Makefile_&. See section
20568 &<<SECTmaildirdelivery>>& below for further details.
20569
20570
20571 .option maildir_quota_directory_regex appendfile string "See below"
20572 .cindex "maildir format" "quota; directories included in"
20573 .cindex "quota" "maildir; directories included in"
20574 This option is relevant only when &%maildir_use_size_file%& is set. It defines
20575 a regular expression for specifying directories, relative to the quota
20576 directory (see &%quota_directory%&), that should be included in the quota
20577 calculation. The default value is:
20578 .code
20579 maildir_quota_directory_regex = ^(?:cur|new|\..*)$
20580 .endd
20581 This includes the &_cur_& and &_new_& directories, and any maildir++ folders
20582 (directories whose names begin with a dot). If you want to exclude the
20583 &_Trash_&
20584 folder from the count (as some sites do), you need to change this setting to
20585 .code
20586 maildir_quota_directory_regex = ^(?:cur|new|\.(?!Trash).*)$
20587 .endd
20588 This uses a negative lookahead in the regular expression to exclude the
20589 directory whose name is &_.Trash_&. When a directory is excluded from quota
20590 calculations, quota processing is bypassed for any messages that are delivered
20591 directly into that directory.
20592
20593
20594 .option maildir_retries appendfile integer 10
20595 This option specifies the number of times to retry when writing a file in
20596 &"maildir"& format. See section &<<SECTmaildirdelivery>>& below.
20597
20598
20599 .option maildir_tag appendfile string&!! unset
20600 This option applies only to deliveries in maildir format, and is described in
20601 section &<<SECTmaildirdelivery>>& below.
20602
20603
20604 .option maildir_use_size_file appendfile&!! boolean false
20605 .cindex "maildir format" "&_maildirsize_& file"
20606 The result of string expansion for this option must be a valid boolean value.
20607 If it is true, it enables support for &_maildirsize_& files. Exim
20608 creates a &_maildirsize_& file in a maildir if one does not exist, taking the
20609 quota from the &%quota%& option of the transport. If &%quota%& is unset, the
20610 value is zero. See &%maildir_quota_directory_regex%& above and section
20611 &<<SECTmaildirdelivery>>& below for further details.
20612
20613 .option maildirfolder_create_regex appendfile string unset
20614 .cindex "maildir format" "&_maildirfolder_& file"
20615 .cindex "&_maildirfolder_&, creating"
20616 The value of this option is a regular expression. If it is unset, it has no
20617 effect. Otherwise, before a maildir delivery takes place, the pattern is
20618 matched against the name of the maildir directory, that is, the directory
20619 containing the &_new_& and &_tmp_& subdirectories that will be used for the
20620 delivery. If there is a match, Exim checks for the existence of a file called
20621 &_maildirfolder_& in the directory, and creates it if it does not exist.
20622 See section &<<SECTmaildirdelivery>>& for more details.
20623
20624
20625 .option mailstore_format appendfile boolean false
20626 .cindex "mailstore format" "specifying"
20627 If this option is set with the &%directory%& option, the delivery is into two
20628 new files in  &"mailstore"& format. The option is available only if
20629 SUPPORT_MAILSTORE is present in &_Local/Makefile_&. See section &<<SECTopdir>>&
20630 below for further details.
20631
20632
20633 .option mailstore_prefix appendfile string&!! unset
20634 This option applies only to deliveries in mailstore format, and is described in
20635 section &<<SECTopdir>>& below.
20636
20637
20638 .option mailstore_suffix appendfile string&!! unset
20639 This option applies only to deliveries in mailstore format, and is described in
20640 section &<<SECTopdir>>& below.
20641
20642
20643 .option mbx_format appendfile boolean false
20644 .cindex "locking files"
20645 .cindex "file" "locking"
20646 .cindex "file" "MBX format"
20647 .cindex "MBX format, specifying"
20648 This option is available only if Exim has been compiled with SUPPORT_MBX
20649 set in &_Local/Makefile_&. If &%mbx_format%& is set with the &%file%& option,
20650 the message is appended to the mailbox file in MBX format instead of
20651 traditional Unix format. This format is supported by Pine4 and its associated
20652 IMAP and POP daemons, by means of the &'c-client'& library that they all use.
20653
20654 &*Note*&: The &%message_prefix%& and &%message_suffix%& options are not
20655 automatically changed by the use of &%mbx_format%&. They should normally be set
20656 empty when using MBX format, so this option almost always appears in this
20657 combination:
20658 .code
20659 mbx_format = true
20660 message_prefix =
20661 message_suffix =
20662 .endd
20663 If none of the locking options are mentioned in the configuration,
20664 &%use_mbx_lock%& is assumed and the other locking options default to false. It
20665 is possible to specify the other kinds of locking with &%mbx_format%&, but
20666 &%use_fcntl_lock%& and &%use_mbx_lock%& are mutually exclusive. MBX locking
20667 interworks with &'c-client'&, providing for shared access to the mailbox. It
20668 should not be used if any program that does not use this form of locking is
20669 going to access the mailbox, nor should it be used if the mailbox file is NFS
20670 mounted, because it works only when the mailbox is accessed from a single host.
20671
20672 If you set &%use_fcntl_lock%& with an MBX-format mailbox, you cannot use
20673 the standard version of &'c-client'&, because as long as it has a mailbox open
20674 (this means for the whole of a Pine or IMAP session), Exim will not be able to
20675 append messages to it.
20676
20677
20678 .option message_prefix appendfile string&!! "see below"
20679 .cindex "&""From""& line"
20680 The string specified here is expanded and output at the start of every message.
20681 The default is unset unless &%file%& is specified and &%use_bsmtp%& is not set,
20682 in which case it is:
20683 .code
20684 message_prefix = "From ${if def:return_path{$return_path}\
20685   {MAILER-DAEMON}} $tod_bsdinbox\n"
20686 .endd
20687 &*Note:*& If you set &%use_crlf%& true, you must change any occurrences of
20688 &`\n`& to &`\r\n`& in &%message_prefix%&.
20689
20690 .option message_suffix appendfile string&!! "see below"
20691 The string specified here is expanded and output at the end of every message.
20692 The default is unset unless &%file%& is specified and &%use_bsmtp%& is not set,
20693 in which case it is a single newline character. The suffix can be suppressed by
20694 setting
20695 .code
20696 message_suffix =
20697 .endd
20698 &*Note:*& If you set &%use_crlf%& true, you must change any occurrences of
20699 &`\n`& to &`\r\n`& in &%message_suffix%&.
20700
20701 .option mode appendfile "octal integer" 0600
20702 If the output file is created, it is given this mode. If it already exists and
20703 has wider permissions, they are reduced to this mode. If it has narrower
20704 permissions, an error occurs unless &%mode_fail_narrower%& is false. However,
20705 if the delivery is the result of a &%save%& command in a filter file specifying
20706 a particular mode, the mode of the output file is always forced to take that
20707 value, and this option is ignored.
20708
20709
20710 .option mode_fail_narrower appendfile boolean true
20711 This option applies in the case when an existing mailbox file has a narrower
20712 mode than that specified by the &%mode%& option. If &%mode_fail_narrower%& is
20713 true, the delivery is deferred (&"mailbox has the wrong mode"&); otherwise Exim
20714 continues with the delivery attempt, using the existing mode of the file.
20715
20716
20717 .option notify_comsat appendfile boolean false
20718 If this option is true, the &'comsat'& daemon is notified after every
20719 successful delivery to a user mailbox. This is the daemon that notifies logged
20720 on users about incoming mail.
20721
20722
20723 .option quota appendfile string&!! unset
20724 .cindex "quota" "imposed by Exim"
20725 This option imposes a limit on the size of the file to which Exim is appending,
20726 or to the total space used in the directory tree when the &%directory%& option
20727 is set. In the latter case, computation of the space used is expensive, because
20728 all the files in the directory (and any sub-directories) have to be
20729 individually inspected and their sizes summed. (See &%quota_size_regex%& and
20730 &%maildir_use_size_file%& for ways to avoid this in environments where users
20731 have no shell access to their mailboxes).
20732
20733 As there is no interlock against two simultaneous deliveries into a
20734 multi-file mailbox, it is possible for the quota to be overrun in this case.
20735 For single-file mailboxes, of course, an interlock is a necessity.
20736
20737 A file's size is taken as its &'used'& value. Because of blocking effects, this
20738 may be a lot less than the actual amount of disk space allocated to the file.
20739 If the sizes of a number of files are being added up, the rounding effect can
20740 become quite noticeable, especially on systems that have large block sizes.
20741 Nevertheless, it seems best to stick to the &'used'& figure, because this is
20742 the obvious value which users understand most easily.
20743
20744 The value of the option is expanded, and must then be a numerical value
20745 (decimal point allowed), optionally followed by one of the letters K, M, or G,
20746 for kilobytes, megabytes, or gigabytes. If Exim is running on a system with
20747 large file support (Linux and FreeBSD have this), mailboxes larger than 2G can
20748 be handled.
20749
20750 &*Note*&: A value of zero is interpreted as &"no quota"&.
20751
20752 The expansion happens while Exim is running as root, before it changes uid for
20753 the delivery. This means that files that are inaccessible to the end user can
20754 be used to hold quota values that are looked up in the expansion. When delivery
20755 fails because this quota is exceeded, the handling of the error is as for
20756 system quota failures.
20757
20758 By default, Exim's quota checking mimics system quotas, and restricts the
20759 mailbox to the specified maximum size, though the value is not accurate to the
20760 last byte, owing to separator lines and additional headers that may get added
20761 during message delivery. When a mailbox is nearly full, large messages may get
20762 refused even though small ones are accepted, because the size of the current
20763 message is added to the quota when the check is made. This behaviour can be
20764 changed by setting &%quota_is_inclusive%& false. When this is done, the check
20765 for exceeding the quota does not include the current message. Thus, deliveries
20766 continue until the quota has been exceeded; thereafter, no further messages are
20767 delivered. See also &%quota_warn_threshold%&.
20768
20769
20770 .option quota_directory appendfile string&!! unset
20771 This option defines the directory to check for quota purposes when delivering
20772 into individual files. The default is the delivery directory, or, if a file
20773 called &_maildirfolder_& exists in a maildir directory, the parent of the
20774 delivery directory.
20775
20776
20777 .option quota_filecount appendfile string&!! 0
20778 This option applies when the &%directory%& option is set. It limits the total
20779 number of files in the directory (compare the inode limit in system quotas). It
20780 can only be used if &%quota%& is also set. The value is expanded; an expansion
20781 failure causes delivery to be deferred. A value of zero is interpreted as
20782 &"no quota"&.
20783
20784
20785 .option quota_is_inclusive appendfile boolean true
20786 See &%quota%& above.
20787
20788
20789 .option quota_size_regex appendfile string unset
20790 This option applies when one of the delivery modes that writes a separate file
20791 for each message is being used. When Exim wants to find the size of one of
20792 these files in order to test the quota, it first checks &%quota_size_regex%&.
20793 If this is set to a regular expression that matches the file name, and it
20794 captures one string, that string is interpreted as a representation of the
20795 file's size. The value of &%quota_size_regex%& is not expanded.
20796
20797 This feature is useful only when users have no shell access to their mailboxes
20798 &-- otherwise they could defeat the quota simply by renaming the files. This
20799 facility can be used with maildir deliveries, by setting &%maildir_tag%& to add
20800 the file length to the file name. For example:
20801 .code
20802 maildir_tag = ,S=$message_size
20803 quota_size_regex = ,S=(\d+)
20804 .endd
20805 An alternative to &$message_size$& is &$message_linecount$&, which contains the
20806 number of lines in the message.
20807
20808 The regular expression should not assume that the length is at the end of the
20809 file name (even though &%maildir_tag%& puts it there) because maildir MUAs
20810 sometimes add other information onto the ends of message file names.
20811
20812 Section &<<SECID136>>& contains further information.
20813
20814
20815 .option quota_warn_message appendfile string&!! "see below"
20816 See below for the use of this option. If it is not set when
20817 &%quota_warn_threshold%& is set, it defaults to
20818 .code
20819 quota_warn_message = "\
20820   To: $local_part@$domain\n\
20821   Subject: Your mailbox\n\n\
20822   This message is automatically created \
20823   by mail delivery software.\n\n\
20824   The size of your mailbox has exceeded \
20825   a warning threshold that is\n\
20826   set by the system administrator.\n"
20827 .endd
20828
20829
20830 .option quota_warn_threshold appendfile string&!! 0
20831 .cindex "quota" "warning threshold"
20832 .cindex "mailbox" "size warning"
20833 .cindex "size" "of mailbox"
20834 This option is expanded in the same way as &%quota%& (see above). If the
20835 resulting value is greater than zero, and delivery of the message causes the
20836 size of the file or total space in the directory tree to cross the given
20837 threshold, a warning message is sent. If &%quota%& is also set, the threshold
20838 may be specified as a percentage of it by following the value with a percent
20839 sign. For example:
20840 .code
20841 quota = 10M
20842 quota_warn_threshold = 75%
20843 .endd
20844 If &%quota%& is not set, a setting of &%quota_warn_threshold%& that ends with a
20845 percent sign is ignored.
20846
20847 The warning message itself is specified by the &%quota_warn_message%& option,
20848 and it must start with a &'To:'& header line containing the recipient(s) of the
20849 warning message. These do not necessarily have to include the recipient(s) of
20850 the original message. A &'Subject:'& line should also normally be supplied. You
20851 can include any other header lines that you want. If you do not include a
20852 &'From:'& line, the default is:
20853 .code
20854 From: Mail Delivery System <mailer-daemon@$qualify_domain_sender>
20855 .endd
20856 .oindex &%errors_reply_to%&
20857 If you supply a &'Reply-To:'& line, it overrides the global &%errors_reply_to%&
20858 option.
20859
20860 The &%quota%& option does not have to be set in order to use this option; they
20861 are independent of one another except when the threshold is specified as a
20862 percentage.
20863
20864
20865 .option use_bsmtp appendfile boolean false
20866 .cindex "envelope sender"
20867 If this option is set true, &(appendfile)& writes messages in &"batch SMTP"&
20868 format, with the envelope sender and recipient(s) included as SMTP commands. If
20869 you want to include a leading HELO command with such messages, you can do
20870 so by setting the &%message_prefix%& option. See section &<<SECTbatchSMTP>>&
20871 for details of batch SMTP.
20872
20873
20874 .option use_crlf appendfile boolean false
20875 .cindex "carriage return"
20876 .cindex "linefeed"
20877 This option causes lines to be terminated with the two-character CRLF sequence
20878 (carriage return, linefeed) instead of just a linefeed character. In the case
20879 of batched SMTP, the byte sequence written to the file is then an exact image
20880 of what would be sent down a real SMTP connection.
20881
20882 &*Note:*& The contents of the &%message_prefix%& and &%message_suffix%& options
20883 (which are used to supply the traditional &"From&~"& and blank line separators
20884 in Berkeley-style mailboxes) are written verbatim, so must contain their own
20885 carriage return characters if these are needed. In cases where these options
20886 have non-empty defaults, the values end with a single linefeed, so they must be
20887 changed to end with &`\r\n`& if &%use_crlf%& is set.
20888
20889
20890 .option use_fcntl_lock appendfile boolean "see below"
20891 This option controls the use of the &[fcntl()]& function to lock a file for
20892 exclusive use when a message is being appended. It is set by default unless
20893 &%use_flock_lock%& is set. Otherwise, it should be turned off only if you know
20894 that all your MUAs use lock file locking. When both &%use_fcntl_lock%& and
20895 &%use_flock_lock%& are unset, &%use_lockfile%& must be set.
20896
20897
20898 .option use_flock_lock appendfile boolean false
20899 This option is provided to support the use of &[flock()]& for file locking, for
20900 the few situations where it is needed. Most modern operating systems support
20901 &[fcntl()]& and &[lockf()]& locking, and these two functions interwork with
20902 each other. Exim uses &[fcntl()]& locking by default.
20903
20904 This option is required only if you are using an operating system where
20905 &[flock()]& is used by programs that access mailboxes (typically MUAs), and
20906 where &[flock()]& does not correctly interwork with &[fcntl()]&. You can use
20907 both &[fcntl()]& and &[flock()]& locking simultaneously if you want.
20908
20909 .cindex "Solaris" "&[flock()]& support"
20910 Not all operating systems provide &[flock()]&. Some versions of Solaris do not
20911 have it (and some, I think, provide a not quite right version built on top of
20912 &[lockf()]&). If the OS does not have &[flock()]&, Exim will be built without
20913 the ability to use it, and any attempt to do so will cause a configuration
20914 error.
20915
20916 &*Warning*&: &[flock()]& locks do not work on NFS files (unless &[flock()]&
20917 is just being mapped onto &[fcntl()]& by the OS).
20918
20919
20920 .option use_lockfile appendfile boolean "see below"
20921 If this option is turned off, Exim does not attempt to create a lock file when
20922 appending to a mailbox file. In this situation, the only locking is by
20923 &[fcntl()]&. You should only turn &%use_lockfile%& off if you are absolutely
20924 sure that every MUA that is ever going to look at your users' mailboxes uses
20925 &[fcntl()]& rather than a lock file, and even then only when you are not
20926 delivering over NFS from more than one host.
20927
20928 .cindex "NFS" "lock file"
20929 In order to append to an NFS file safely from more than one host, it is
20930 necessary to take out a lock &'before'& opening the file, and the lock file
20931 achieves this. Otherwise, even with &[fcntl()]& locking, there is a risk of
20932 file corruption.
20933
20934 The &%use_lockfile%& option is set by default unless &%use_mbx_lock%& is set.
20935 It is not possible to turn both &%use_lockfile%& and &%use_fcntl_lock%& off,
20936 except when &%mbx_format%& is set.
20937
20938
20939 .option use_mbx_lock appendfile boolean "see below"
20940 This option is available only if Exim has been compiled with SUPPORT_MBX
20941 set in &_Local/Makefile_&. Setting the option specifies that special MBX
20942 locking rules be used. It is set by default if &%mbx_format%& is set and none
20943 of the locking options are mentioned in the configuration. The locking rules
20944 are the same as are used by the &'c-client'& library that underlies Pine and
20945 the IMAP4 and POP daemons that come with it (see the discussion below). The
20946 rules allow for shared access to the mailbox. However, this kind of locking
20947 does not work when the mailbox is NFS mounted.
20948
20949 You can set &%use_mbx_lock%& with either (or both) of &%use_fcntl_lock%& and
20950 &%use_flock_lock%& to control what kind of locking is used in implementing the
20951 MBX locking rules. The default is to use &[fcntl()]& if &%use_mbx_lock%& is set
20952 without &%use_fcntl_lock%& or &%use_flock_lock%&.
20953
20954
20955
20956
20957 .section "Operational details for appending" "SECTopappend"
20958 .cindex "appending to a file"
20959 .cindex "file" "appending"
20960 Before appending to a file, the following preparations are made:
20961
20962 .ilist
20963 If the name of the file is &_/dev/null_&, no action is taken, and a success
20964 return is given.
20965
20966 .next
20967 .cindex "directory creation"
20968 If any directories on the file's path are missing, Exim creates them if the
20969 &%create_directory%& option is set. A created directory's mode is given by the
20970 &%directory_mode%& option.
20971
20972 .next
20973 If &%file_format%& is set, the format of an existing file is checked. If this
20974 indicates that a different transport should be used, control is passed to that
20975 transport.
20976
20977 .next
20978 .cindex "file" "locking"
20979 .cindex "locking files"
20980 .cindex "NFS" "lock file"
20981 If &%use_lockfile%& is set, a lock file is built in a way that will work
20982 reliably over NFS, as follows:
20983
20984 .olist
20985 Create a &"hitching post"& file whose name is that of the lock file with the
20986 current time, primary host name, and process id added, by opening for writing
20987 as a new file. If this fails with an access error, delivery is deferred.
20988 .next
20989 Close the hitching post file, and hard link it to the lock file name.
20990 .next
20991 If the call to &[link()]& succeeds, creation of the lock file has succeeded.
20992 Unlink the hitching post name.
20993 .next
20994 Otherwise, use &[stat()]& to get information about the hitching post file, and
20995 then unlink hitching post name. If the number of links is exactly two, creation
20996 of the lock file succeeded but something (for example, an NFS server crash and
20997 restart) caused this fact not to be communicated to the &[link()]& call.
20998 .next
20999 If creation of the lock file failed, wait for &%lock_interval%& and try again,
21000 up to &%lock_retries%& times. However, since any program that writes to a
21001 mailbox should complete its task very quickly, it is reasonable to time out old
21002 lock files that are normally the result of user agent and system crashes. If an
21003 existing lock file is older than &%lockfile_timeout%& Exim attempts to unlink
21004 it before trying again.
21005 .endlist olist
21006
21007 .next
21008 A call is made to &[lstat()]& to discover whether the main file exists, and if
21009 so, what its characteristics are. If &[lstat()]& fails for any reason other
21010 than non-existence, delivery is deferred.
21011
21012 .next
21013 .cindex "symbolic link" "to mailbox"
21014 .cindex "mailbox" "symbolic link"
21015 If the file does exist and is a symbolic link, delivery is deferred, unless the
21016 &%allow_symlink%& option is set, in which case the ownership of the link is
21017 checked, and then &[stat()]& is called to find out about the real file, which
21018 is then subjected to the checks below. The check on the top-level link
21019 ownership prevents one user creating a link for another's mailbox in a sticky
21020 directory, though allowing symbolic links in this case is definitely not a good
21021 idea. If there is a chain of symbolic links, the intermediate ones are not
21022 checked.
21023
21024 .next
21025 If the file already exists but is not a regular file, or if the file's owner
21026 and group (if the group is being checked &-- see &%check_group%& above) are
21027 different from the user and group under which the delivery is running,
21028 delivery is deferred.
21029
21030 .next
21031 If the file's permissions are more generous than specified, they are reduced.
21032 If they are insufficient, delivery is deferred, unless &%mode_fail_narrower%&
21033 is set false, in which case the delivery is tried using the existing
21034 permissions.
21035
21036 .next
21037 The file's inode number is saved, and the file is then opened for appending.
21038 If this fails because the file has vanished, &(appendfile)& behaves as if it
21039 hadn't existed (see below). For any other failures, delivery is deferred.
21040
21041 .next
21042 If the file is opened successfully, check that the inode number hasn't
21043 changed, that it is still a regular file, and that the owner and permissions
21044 have not changed. If anything is wrong, defer delivery and freeze the message.
21045
21046 .next
21047 If the file did not exist originally, defer delivery if the &%file_must_exist%&
21048 option is set. Otherwise, check that the file is being created in a permitted
21049 directory if the &%create_file%& option is set (deferring on failure), and then
21050 open for writing as a new file, with the O_EXCL and O_CREAT options,
21051 except when dealing with a symbolic link (the &%allow_symlink%& option must be
21052 set). In this case, which can happen if the link points to a non-existent file,
21053 the file is opened for writing using O_CREAT but not O_EXCL, because
21054 that prevents link following.
21055
21056 .next
21057 .cindex "loop" "while file testing"
21058 If opening fails because the file exists, obey the tests given above for
21059 existing files. However, to avoid looping in a situation where the file is
21060 being continuously created and destroyed, the exists/not-exists loop is broken
21061 after 10 repetitions, and the message is then frozen.
21062
21063 .next
21064 If opening fails with any other error, defer delivery.
21065
21066 .next
21067 .cindex "file" "locking"
21068 .cindex "locking files"
21069 Once the file is open, unless both &%use_fcntl_lock%& and &%use_flock_lock%&
21070 are false, it is locked using &[fcntl()]& or &[flock()]& or both. If
21071 &%use_mbx_lock%& is false, an exclusive lock is requested in each case.
21072 However, if &%use_mbx_lock%& is true, Exim takes out a shared lock on the open
21073 file, and an exclusive lock on the file whose name is
21074 .code
21075 /tmp/.<device-number>.<inode-number>
21076 .endd
21077 using the device and inode numbers of the open mailbox file, in accordance with
21078 the MBX locking rules. This file is created with a mode that is specified by
21079 the &%lockfile_mode%& option.
21080
21081 If Exim fails to lock the file, there are two possible courses of action,
21082 depending on the value of the locking timeout. This is obtained from
21083 &%lock_fcntl_timeout%& or &%lock_flock_timeout%&, as appropriate.
21084
21085 If the timeout value is zero, the file is closed, Exim waits for
21086 &%lock_interval%&, and then goes back and re-opens the file as above and tries
21087 to lock it again. This happens up to &%lock_retries%& times, after which the
21088 delivery is deferred.
21089
21090 If the timeout has a value greater than zero, blocking calls to &[fcntl()]& or
21091 &[flock()]& are used (with the given timeout), so there has already been some
21092 waiting involved by the time locking fails. Nevertheless, Exim does not give up
21093 immediately. It retries up to
21094 .code
21095 (lock_retries * lock_interval) / <timeout>
21096 .endd
21097 times (rounded up).
21098 .endlist
21099
21100 At the end of delivery, Exim closes the file (which releases the &[fcntl()]&
21101 and/or &[flock()]& locks) and then deletes the lock file if one was created.
21102
21103
21104 .section "Operational details for delivery to a new file" "SECTopdir"
21105 .cindex "delivery" "to single file"
21106 .cindex "&""From""& line"
21107 When the &%directory%& option is set instead of &%file%&, each message is
21108 delivered into a newly-created file or set of files. When &(appendfile)& is
21109 activated directly from a &(redirect)& router, neither &%file%& nor
21110 &%directory%& is normally set, because the path for delivery is supplied by the
21111 router. (See for example, the &(address_file)& transport in the default
21112 configuration.) In this case, delivery is to a new file if either the path name
21113 ends in &`/`&, or the &%maildir_format%& or &%mailstore_format%& option is set.
21114
21115 No locking is required while writing the message to a new file, so the various
21116 locking options of the transport are ignored. The &"From"& line that by default
21117 separates messages in a single file is not normally needed, nor is the escaping
21118 of message lines that start with &"From"&, and there is no need to ensure a
21119 newline at the end of each message. Consequently, the default values for
21120 &%check_string%&, &%message_prefix%&, and &%message_suffix%& are all unset when
21121 any of &%directory%&, &%maildir_format%&, or &%mailstore_format%& is set.
21122
21123 If Exim is required to check a &%quota%& setting, it adds up the sizes of all
21124 the files in the delivery directory by default. However, you can specify a
21125 different directory by setting &%quota_directory%&. Also, for maildir
21126 deliveries (see below) the &_maildirfolder_& convention is honoured.
21127
21128
21129 .cindex "maildir format"
21130 .cindex "mailstore format"
21131 There are three different ways in which delivery to individual files can be
21132 done, controlled by the settings of the &%maildir_format%& and
21133 &%mailstore_format%& options. Note that code to support maildir or mailstore
21134 formats is not included in the binary unless SUPPORT_MAILDIR or
21135 SUPPORT_MAILSTORE, respectively, is set in &_Local/Makefile_&.
21136
21137 .cindex "directory creation"
21138 In all three cases an attempt is made to create the directory and any necessary
21139 sub-directories if they do not exist, provided that the &%create_directory%&
21140 option is set (the default). The location of a created directory can be
21141 constrained by setting &%create_file%&. A created directory's mode is given by
21142 the &%directory_mode%& option. If creation fails, or if the
21143 &%create_directory%& option is not set when creation is required, delivery is
21144 deferred.
21145
21146
21147
21148 .section "Maildir delivery" "SECTmaildirdelivery"
21149 .cindex "maildir format" "description of"
21150 If the &%maildir_format%& option is true, Exim delivers each message by writing
21151 it to a file whose name is &_tmp/<stime>.H<mtime>P<pid>.<host>_& in the
21152 directory that is defined by the &%directory%& option (the &"delivery
21153 directory"&). If the delivery is successful, the file is renamed into the
21154 &_new_& subdirectory.
21155
21156 In the file name, <&'stime'&> is the current time of day in seconds, and
21157 <&'mtime'&> is the microsecond fraction of the time. After a maildir delivery,
21158 Exim checks that the time-of-day clock has moved on by at least one microsecond
21159 before terminating the delivery process. This guarantees uniqueness for the
21160 file name. However, as a precaution, Exim calls &[stat()]& for the file before
21161 opening it. If any response other than ENOENT (does not exist) is given,
21162 Exim waits 2 seconds and tries again, up to &%maildir_retries%& times.
21163
21164 Before Exim carries out a maildir delivery, it ensures that subdirectories
21165 called &_new_&, &_cur_&, and &_tmp_& exist in the delivery directory. If they
21166 do not exist, Exim tries to create them and any superior directories in their
21167 path, subject to the &%create_directory%& and &%create_file%& options. If the
21168 &%maildirfolder_create_regex%& option is set, and the regular expression it
21169 contains matches the delivery directory, Exim also ensures that a file called
21170 &_maildirfolder_& exists in the delivery directory. If a missing directory or
21171 &_maildirfolder_& file cannot be created, delivery is deferred.
21172
21173 These features make it possible to use Exim to create all the necessary files
21174 and directories in a maildir mailbox, including subdirectories for maildir++
21175 folders. Consider this example:
21176 .code
21177 maildir_format = true
21178 directory = /var/mail/$local_part\
21179            ${if eq{$local_part_suffix}{}{}\
21180            {/.${substr_1:$local_part_suffix}}}
21181 maildirfolder_create_regex = /\.[^/]+$
21182 .endd
21183 If &$local_part_suffix$& is empty (there was no suffix for the local part),
21184 delivery is into a toplevel maildir with a name like &_/var/mail/pimbo_& (for
21185 the user called &'pimbo'&). The pattern in &%maildirfolder_create_regex%& does
21186 not match this name, so Exim will not look for or create the file
21187 &_/var/mail/pimbo/maildirfolder_&, though it will create
21188 &_/var/mail/pimbo/{cur,new,tmp}_& if necessary.
21189
21190 However, if &$local_part_suffix$& contains &`-eximusers`& (for example),
21191 delivery is into the maildir++ folder &_/var/mail/pimbo/.eximusers_&, which
21192 does match &%maildirfolder_create_regex%&. In this case, Exim will create
21193 &_/var/mail/pimbo/.eximusers/maildirfolder_& as well as the three maildir
21194 directories &_/var/mail/pimbo/.eximusers/{cur,new,tmp}_&.
21195
21196 &*Warning:*& Take care when setting &%maildirfolder_create_regex%& that it does
21197 not inadvertently match the toplevel maildir directory, because a
21198 &_maildirfolder_& file at top level would completely break quota calculations.
21199
21200 .cindex "quota" "in maildir delivery"
21201 .cindex "maildir++"
21202 If Exim is required to check a &%quota%& setting before a maildir delivery, and
21203 &%quota_directory%& is not set, it looks for a file called &_maildirfolder_& in
21204 the maildir directory (alongside &_new_&, &_cur_&, &_tmp_&). If this exists,
21205 Exim assumes the directory is a maildir++ folder directory, which is one level
21206 down from the user's top level mailbox directory. This causes it to start at
21207 the parent directory instead of the current directory when calculating the
21208 amount of space used.
21209
21210 One problem with delivering into a multi-file mailbox is that it is
21211 computationally expensive to compute the size of the mailbox for quota
21212 checking. Various approaches have been taken to reduce the amount of work
21213 needed. The next two sections describe two of them. A third alternative is to
21214 use some external process for maintaining the size data, and use the expansion
21215 of the &%mailbox_size%& option as a way of importing it into Exim.
21216
21217
21218
21219
21220 .section "Using tags to record message sizes" "SECID135"
21221 If &%maildir_tag%& is set, the string is expanded for each delivery.
21222 When the maildir file is renamed into the &_new_& sub-directory, the
21223 tag is added to its name. However, if adding the tag takes the length of the
21224 name to the point where the test &[stat()]& call fails with ENAMETOOLONG,
21225 the tag is dropped and the maildir file is created with no tag.
21226
21227
21228 .vindex "&$message_size$&"
21229 Tags can be used to encode the size of files in their names; see
21230 &%quota_size_regex%& above for an example. The expansion of &%maildir_tag%&
21231 happens after the message has been written. The value of the &$message_size$&
21232 variable is set to the number of bytes actually written. If the expansion is
21233 forced to fail, the tag is ignored, but a non-forced failure causes delivery to
21234 be deferred. The expanded tag may contain any printing characters except &"/"&.
21235 Non-printing characters in the string are ignored; if the resulting string is
21236 empty, it is ignored. If it starts with an alphanumeric character, a leading
21237 colon is inserted; this default has not proven to be the path that popular
21238 maildir implementations have chosen (but changing it in Exim would break
21239 backwards compatibility).
21240
21241 For one common implementation, you might set:
21242 .code
21243 maildir_tag = ,S=${message_size}
21244 .endd
21245 but you should check the documentation of the other software to be sure.
21246
21247 It is advisable to also set &%quota_size_regex%& when setting &%maildir_tag%&
21248 as this allows Exim to extract the size from your tag, instead of having to
21249 &[stat()]& each message file.
21250
21251
21252 .section "Using a maildirsize file" "SECID136"
21253 .cindex "quota" "in maildir delivery"
21254 .cindex "maildir format" "&_maildirsize_& file"
21255 If &%maildir_use_size_file%& is true, Exim implements the maildir++ rules for
21256 storing quota and message size information in a file called &_maildirsize_&
21257 within the toplevel maildir directory. If this file does not exist, Exim
21258 creates it, setting the quota from the &%quota%& option of the transport. If
21259 the maildir directory itself does not exist, it is created before any attempt
21260 to write a &_maildirsize_& file.
21261
21262 The &_maildirsize_& file is used to hold information about the sizes of
21263 messages in the maildir, thus speeding up quota calculations. The quota value
21264 in the file is just a cache; if the quota is changed in the transport, the new
21265 value overrides the cached value when the next message is delivered. The cache
21266 is maintained for the benefit of other programs that access the maildir and
21267 need to know the quota.
21268
21269 If the &%quota%& option in the transport is unset or zero, the &_maildirsize_&
21270 file is maintained (with a zero quota setting), but no quota is imposed.
21271
21272 A regular expression is available for controlling which directories in the
21273 maildir participate in quota calculations when a &_maildirsizefile_& is in use.
21274 See the description of the &%maildir_quota_directory_regex%& option above for
21275 details.
21276
21277
21278 .section "Mailstore delivery" "SECID137"
21279 .cindex "mailstore format" "description of"
21280 If the &%mailstore_format%& option is true, each message is written as two
21281 files in the given directory. A unique base name is constructed from the
21282 message id and the current delivery process, and the files that are written use
21283 this base name plus the suffixes &_.env_& and &_.msg_&. The &_.env_& file
21284 contains the message's envelope, and the &_.msg_& file contains the message
21285 itself. The base name is placed in the variable &$mailstore_basename$&.
21286
21287 During delivery, the envelope is first written to a file with the suffix
21288 &_.tmp_&. The &_.msg_& file is then written, and when it is complete, the
21289 &_.tmp_& file is renamed as the &_.env_& file. Programs that access messages in
21290 mailstore format should wait for the presence of both a &_.msg_& and a &_.env_&
21291 file before accessing either of them. An alternative approach is to wait for
21292 the absence of a &_.tmp_& file.
21293
21294 The envelope file starts with any text defined by the &%mailstore_prefix%&
21295 option, expanded and terminated by a newline if there isn't one. Then follows
21296 the sender address on one line, then all the recipient addresses, one per line.
21297 There can be more than one recipient only if the &%batch_max%& option is set
21298 greater than one. Finally, &%mailstore_suffix%& is expanded and the result
21299 appended to the file, followed by a newline if it does not end with one.
21300
21301 If expansion of &%mailstore_prefix%& or &%mailstore_suffix%& ends with a forced
21302 failure, it is ignored. Other expansion errors are treated as serious
21303 configuration errors, and delivery is deferred. The variable
21304 &$mailstore_basename$& is available for use during these expansions.
21305
21306
21307 .section "Non-special new file delivery" "SECID138"
21308 If neither &%maildir_format%& nor &%mailstore_format%& is set, a single new
21309 file is created directly in the named directory. For example, when delivering
21310 messages into files in batched SMTP format for later delivery to some host (see
21311 section &<<SECTbatchSMTP>>&), a setting such as
21312 .code
21313 directory = /var/bsmtp/$host
21314 .endd
21315 might be used. A message is written to a file with a temporary name, which is
21316 then renamed when the delivery is complete. The final name is obtained by
21317 expanding the contents of the &%directory_file%& option.
21318 .ecindex IIDapptra1
21319 .ecindex IIDapptra2
21320
21321
21322
21323
21324
21325
21326 . ////////////////////////////////////////////////////////////////////////////
21327 . ////////////////////////////////////////////////////////////////////////////
21328
21329 .chapter "The autoreply transport" "CHID8"
21330 .scindex IIDauttra1 "transports" "&(autoreply)&"
21331 .scindex IIDauttra2 "&(autoreply)& transport"
21332 The &(autoreply)& transport is not a true transport in that it does not cause
21333 the message to be transmitted. Instead, it generates a new mail message as an
21334 automatic reply to the incoming message. &'References:'& and
21335 &'Auto-Submitted:'& header lines are included. These are constructed according
21336 to the rules in RFCs 2822 and 3834, respectively.
21337
21338 If the router that passes the message to this transport does not have the
21339 &%unseen%& option set, the original message (for the current recipient) is not
21340 delivered anywhere. However, when the &%unseen%& option is set on the router
21341 that passes the message to this transport, routing of the address continues, so
21342 another router can set up a normal message delivery.
21343
21344
21345 The &(autoreply)& transport is usually run as the result of mail filtering, a
21346 &"vacation"& message being the standard example. However, it can also be run
21347 directly from a router like any other transport. To reduce the possibility of
21348 message cascades, messages created by the &(autoreply)& transport always have
21349 empty envelope sender addresses, like bounce messages.
21350
21351 The parameters of the message to be sent can be specified in the configuration
21352 by options described below. However, these are used only when the address
21353 passed to the transport does not contain its own reply information. When the
21354 transport is run as a consequence of a
21355 &%mail%&
21356 or &%vacation%& command in a filter file, the parameters of the message are
21357 supplied by the filter, and passed with the address. The transport's options
21358 that define the message are then ignored (so they are not usually set in this
21359 case). The message is specified entirely by the filter or by the transport; it
21360 is never built from a mixture of options. However, the &%file_optional%&,
21361 &%mode%&, and &%return_message%& options apply in all cases.
21362
21363 &(Autoreply)& is implemented as a local transport. When used as a result of a
21364 command in a user's filter file, &(autoreply)& normally runs under the uid and
21365 gid of the user, and with appropriate current and home directories (see chapter
21366 &<<CHAPenvironment>>&).
21367
21368 There is a subtle difference between routing a message to a &(pipe)& transport
21369 that generates some text to be returned to the sender, and routing it to an
21370 &(autoreply)& transport. This difference is noticeable only if more than one
21371 address from the same message is so handled. In the case of a pipe, the
21372 separate outputs from the different addresses are gathered up and returned to
21373 the sender in a single message, whereas if &(autoreply)& is used, a separate
21374 message is generated for each address that is passed to it.
21375
21376 Non-printing characters are not permitted in the header lines generated for the
21377 message that &(autoreply)& creates, with the exception of newlines that are
21378 immediately followed by white space. If any non-printing characters are found,
21379 the transport defers.
21380 Whether characters with the top bit set count as printing characters or not is
21381 controlled by the &%print_topbitchars%& global option.
21382
21383 If any of the generic options for manipulating headers (for example,
21384 &%headers_add%&) are set on an &(autoreply)& transport, they apply to the copy
21385 of the original message that is included in the generated message when
21386 &%return_message%& is set. They do not apply to the generated message itself.
21387
21388 .vindex "&$sender_address$&"
21389 If the &(autoreply)& transport receives return code 2 from Exim when it submits
21390 the message, indicating that there were no recipients, it does not treat this
21391 as an error. This means that autoreplies sent to &$sender_address$& when this
21392 is empty (because the incoming message is a bounce message) do not cause
21393 problems. They are just discarded.
21394
21395
21396
21397 .section "Private options for autoreply" "SECID139"
21398 .cindex "options" "&(autoreply)& transport"
21399
21400 .option bcc autoreply string&!! unset
21401 This specifies the addresses that are to receive &"blind carbon copies"& of the
21402 message when the message is specified by the transport.
21403
21404
21405 .option cc autoreply string&!! unset
21406 This specifies recipients of the message and the contents of the &'Cc:'& header
21407 when the message is specified by the transport.
21408
21409
21410 .option file autoreply string&!! unset
21411 The contents of the file are sent as the body of the message when the message
21412 is specified by the transport. If both &%file%& and &%text%& are set, the text
21413 string comes first.
21414
21415
21416 .option file_expand autoreply boolean false
21417 If this is set, the contents of the file named by the &%file%& option are
21418 subjected to string expansion as they are added to the message.
21419
21420
21421 .option file_optional autoreply boolean false
21422 If this option is true, no error is generated if the file named by the &%file%&
21423 option or passed with the address does not exist or cannot be read.
21424
21425
21426 .option from autoreply string&!! unset
21427 This specifies the contents of the &'From:'& header when the message is
21428 specified by the transport.
21429
21430
21431 .option headers autoreply string&!! unset
21432 This specifies additional RFC 2822 headers that are to be added to the message
21433 when the message is specified by the transport. Several can be given by using
21434 &"\n"& to separate them. There is no check on the format.
21435
21436
21437 .option log autoreply string&!! unset
21438 This option names a file in which a record of every message sent is logged when
21439 the message is specified by the transport.
21440
21441
21442 .option mode autoreply "octal integer" 0600
21443 If either the log file or the &"once"& file has to be created, this mode is
21444 used.
21445
21446
21447 .option never_mail autoreply "address list&!!" unset
21448 If any run of the transport creates a message with a recipient that matches any
21449 item in the list, that recipient is quietly discarded. If all recipients are
21450 discarded, no message is created. This applies both when the recipients are
21451 generated by a filter and when they are specified in the transport.
21452
21453
21454
21455 .option once autoreply string&!! unset
21456 This option names a file or DBM database in which a record of each &'To:'&
21457 recipient is kept when the message is specified by the transport. &*Note*&:
21458 This does not apply to &'Cc:'& or &'Bcc:'& recipients.
21459
21460 If &%once%& is unset, or is set to an empty string, the message is always sent.
21461 By default, if &%once%& is set to a non-empty file name, the message
21462 is not sent if a potential recipient is already listed in the database.
21463 However, if the &%once_repeat%& option specifies a time greater than zero, the
21464 message is sent if that much time has elapsed since a message was last sent to
21465 this recipient. A setting of zero time for &%once_repeat%& (the default)
21466 prevents a message from being sent a second time &-- in this case, zero means
21467 infinity.
21468
21469 If &%once_file_size%& is zero, a DBM database is used to remember recipients,
21470 and it is allowed to grow as large as necessary. If &%once_file_size%& is set
21471 greater than zero, it changes the way Exim implements the &%once%& option.
21472 Instead of using a DBM file to record every recipient it sends to, it uses a
21473 regular file, whose size will never get larger than the given value.
21474
21475 In the file, Exim keeps a linear list of recipient addresses and the times at
21476 which they were sent messages. If the file is full when a new address needs to
21477 be added, the oldest address is dropped. If &%once_repeat%& is not set, this
21478 means that a given recipient may receive multiple messages, but at
21479 unpredictable intervals that depend on the rate of turnover of addresses in the
21480 file. If &%once_repeat%& is set, it specifies a maximum time between repeats.
21481
21482
21483 .option once_file_size autoreply integer 0
21484 See &%once%& above.
21485
21486
21487 .option once_repeat autoreply time&!! 0s
21488 See &%once%& above.
21489 After expansion, the value of this option must be a valid time value.
21490
21491
21492 .option reply_to autoreply string&!! unset
21493 This specifies the contents of the &'Reply-To:'& header when the message is
21494 specified by the transport.
21495
21496
21497 .option return_message autoreply boolean false
21498 If this is set, a copy of the original message is returned with the new
21499 message, subject to the maximum size set in the &%return_size_limit%& global
21500 configuration option.
21501
21502
21503 .option subject autoreply string&!! unset
21504 This specifies the contents of the &'Subject:'& header when the message is
21505 specified by the transport. It is tempting to quote the original subject in
21506 automatic responses. For example:
21507 .code
21508 subject = Re: $h_subject:
21509 .endd
21510 There is a danger in doing this, however. It may allow a third party to
21511 subscribe your users to an opt-in mailing list, provided that the list accepts
21512 bounce messages as subscription confirmations. Well-managed lists require a
21513 non-bounce message to confirm a subscription, so the danger is relatively
21514 small.
21515
21516
21517
21518 .option text autoreply string&!! unset
21519 This specifies a single string to be used as the body of the message when the
21520 message is specified by the transport. If both &%text%& and &%file%& are set,
21521 the text comes first.
21522
21523
21524 .option to autoreply string&!! unset
21525 This specifies recipients of the message and the contents of the &'To:'& header
21526 when the message is specified by the transport.
21527 .ecindex IIDauttra1
21528 .ecindex IIDauttra2
21529
21530
21531
21532
21533 . ////////////////////////////////////////////////////////////////////////////
21534 . ////////////////////////////////////////////////////////////////////////////
21535
21536 .chapter "The lmtp transport" "CHAPLMTP"
21537 .cindex "transports" "&(lmtp)&"
21538 .cindex "&(lmtp)& transport"
21539 .cindex "LMTP" "over a pipe"
21540 .cindex "LMTP" "over a socket"
21541 The &(lmtp)& transport runs the LMTP protocol (RFC 2033) over a pipe to a
21542 specified command
21543 or by interacting with a Unix domain socket.
21544 This transport is something of a cross between the &(pipe)& and &(smtp)&
21545 transports. Exim also has support for using LMTP over TCP/IP; this is
21546 implemented as an option for the &(smtp)& transport. Because LMTP is expected
21547 to be of minority interest, the default build-time configure in &_src/EDITME_&
21548 has it commented out. You need to ensure that
21549 .code
21550 TRANSPORT_LMTP=yes
21551 .endd
21552 .cindex "options" "&(lmtp)& transport"
21553 is present in your &_Local/Makefile_& in order to have the &(lmtp)& transport
21554 included in the Exim binary. The private options of the &(lmtp)& transport are
21555 as follows:
21556
21557 .option batch_id lmtp string&!! unset
21558 See the description of local delivery batching in chapter &<<CHAPbatching>>&.
21559
21560
21561 .option batch_max lmtp integer 1
21562 This limits the number of addresses that can be handled in a single delivery.
21563 Most LMTP servers can handle several addresses at once, so it is normally a
21564 good idea to increase this value. See the description of local delivery
21565 batching in chapter &<<CHAPbatching>>&.
21566
21567
21568 .option command lmtp string&!! unset
21569 This option must be set if &%socket%& is not set. The string is a command which
21570 is run in a separate process. It is split up into a command name and list of
21571 arguments, each of which is separately expanded (so expansion cannot change the
21572 number of arguments). The command is run directly, not via a shell. The message
21573 is passed to the new process using the standard input and output to operate the
21574 LMTP protocol.
21575
21576 .option ignore_quota lmtp boolean false
21577 .cindex "LMTP" "ignoring quota errors"
21578 If this option is set true, the string &`IGNOREQUOTA`& is added to RCPT
21579 commands, provided that the LMTP server has advertised support for IGNOREQUOTA
21580 in its response to the LHLO command.
21581
21582 .option socket lmtp string&!! unset
21583 This option must be set if &%command%& is not set. The result of expansion must
21584 be the name of a Unix domain socket. The transport connects to the socket and
21585 delivers the message to it using the LMTP protocol.
21586
21587
21588 .option timeout lmtp time 5m
21589 The transport is aborted if the created process or Unix domain socket does not
21590 respond to LMTP commands or message input within this timeout. Delivery
21591 is deferred, and will be tried again later. Here is an example of a typical
21592 LMTP transport:
21593 .code
21594 lmtp:
21595   driver = lmtp
21596   command = /some/local/lmtp/delivery/program
21597   batch_max = 20
21598   user = exim
21599 .endd
21600 This delivers up to 20 addresses at a time, in a mixture of domains if
21601 necessary, running as the user &'exim'&.
21602
21603
21604
21605 . ////////////////////////////////////////////////////////////////////////////
21606 . ////////////////////////////////////////////////////////////////////////////
21607
21608 .chapter "The pipe transport" "CHAPpipetransport"
21609 .scindex IIDpiptra1 "transports" "&(pipe)&"
21610 .scindex IIDpiptra2 "&(pipe)& transport"
21611 The &(pipe)& transport is used to deliver messages via a pipe to a command
21612 running in another process. One example is the use of &(pipe)& as a
21613 pseudo-remote transport for passing messages to some other delivery mechanism
21614 (such as UUCP). Another is the use by individual users to automatically process
21615 their incoming messages. The &(pipe)& transport can be used in one of the
21616 following ways:
21617
21618 .ilist
21619 .vindex "&$local_part$&"
21620 A router routes one address to a transport in the normal way, and the
21621 transport is configured as a &(pipe)& transport. In this case, &$local_part$&
21622 contains the local part of the address (as usual), and the command that is run
21623 is specified by the &%command%& option on the transport.
21624 .next
21625 .vindex "&$pipe_addresses$&"
21626 If the &%batch_max%& option is set greater than 1 (the default is 1), the
21627 transport can handle more than one address in a single run. In this case, when
21628 more than one address is routed to the transport, &$local_part$& is not set
21629 (because it is not unique). However, the pseudo-variable &$pipe_addresses$&
21630 (described in section &<<SECThowcommandrun>>& below) contains all the addresses
21631 that are routed to the transport.
21632 .next
21633 .vindex "&$address_pipe$&"
21634 A router redirects an address directly to a pipe command (for example, from an
21635 alias or forward file). In this case, &$address_pipe$& contains the text of the
21636 pipe command, and the &%command%& option on the transport is ignored unless
21637 &%force_command%& is set. If only one address is being transported
21638 (&%batch_max%& is not greater than one, or only one address was redirected to
21639 this pipe command), &$local_part$& contains the local part that was redirected.
21640 .endlist
21641
21642
21643 The &(pipe)& transport is a non-interactive delivery method. Exim can also
21644 deliver messages over pipes using the LMTP interactive protocol. This is
21645 implemented by the &(lmtp)& transport.
21646
21647 In the case when &(pipe)& is run as a consequence of an entry in a local user's
21648 &_.forward_& file, the command runs under the uid and gid of that user. In
21649 other cases, the uid and gid have to be specified explicitly, either on the
21650 transport or on the router that handles the address. Current and &"home"&
21651 directories are also controllable. See chapter &<<CHAPenvironment>>& for
21652 details of the local delivery environment and chapter &<<CHAPbatching>>&
21653 for a discussion of local delivery batching.
21654
21655
21656 .section "Concurrent delivery" "SECID140"
21657 If two messages arrive at almost the same time, and both are routed to a pipe
21658 delivery, the two pipe transports may be run concurrently. You must ensure that
21659 any pipe commands you set up are robust against this happening. If the commands
21660 write to a file, the &%exim_lock%& utility might be of use.
21661
21662
21663
21664
21665 .section "Returned status and data" "SECID141"
21666 .cindex "&(pipe)& transport" "returned data"
21667 If the command exits with a non-zero return code, the delivery is deemed to
21668 have failed, unless either the &%ignore_status%& option is set (in which case
21669 the return code is treated as zero), or the return code is one of those listed
21670 in the &%temp_errors%& option, which are interpreted as meaning &"try again
21671 later"&. In this case, delivery is deferred. Details of a permanent failure are
21672 logged, but are not included in the bounce message, which merely contains
21673 &"local delivery failed"&.
21674
21675 If the command exits on a signal and the &%freeze_signal%& option is set then
21676 the message will be frozen in the queue. If that option is not set, a bounce
21677 will be sent as normal.
21678
21679 If the return code is greater than 128 and the command being run is a shell
21680 script, it normally means that the script was terminated by a signal whose
21681 value is the return code minus 128. The &%freeze_signal%& option does not
21682 apply in this case.
21683
21684 If Exim is unable to run the command (that is, if &[execve()]& fails), the
21685 return code is set to 127. This is the value that a shell returns if it is
21686 asked to run a non-existent command. The wording for the log line suggests that
21687 a non-existent command may be the problem.
21688
21689 The &%return_output%& option can affect the result of a pipe delivery. If it is
21690 set and the command produces any output on its standard output or standard
21691 error streams, the command is considered to have failed, even if it gave a zero
21692 return code or if &%ignore_status%& is set. The output from the command is
21693 included as part of the bounce message. The &%return_fail_output%& option is
21694 similar, except that output is returned only when the command exits with a
21695 failure return code, that is, a value other than zero or a code that matches
21696 &%temp_errors%&.
21697
21698
21699
21700 .section "How the command is run" "SECThowcommandrun"
21701 .cindex "&(pipe)& transport" "path for command"
21702 The command line is (by default) broken down into a command name and arguments
21703 by the &(pipe)& transport itself. The &%allow_commands%& and
21704 &%restrict_to_path%& options can be used to restrict the commands that may be
21705 run.
21706
21707 .cindex "quoting" "in pipe command"
21708 Unquoted arguments are delimited by white space. If an argument appears in
21709 double quotes, backslash is interpreted as an escape character in the usual
21710 way. If an argument appears in single quotes, no escaping is done.
21711
21712 String expansion is applied to the command line except when it comes from a
21713 traditional &_.forward_& file (commands from a filter file are expanded). The
21714 expansion is applied to each argument in turn rather than to the whole line.
21715 For this reason, any string expansion item that contains white space must be
21716 quoted so as to be contained within a single argument. A setting such as
21717 .code
21718 command = /some/path ${if eq{$local_part}{postmaster}{xx}{yy}}
21719 .endd
21720 will not work, because the expansion item gets split between several
21721 arguments. You have to write
21722 .code
21723 command = /some/path "${if eq{$local_part}{postmaster}{xx}{yy}}"
21724 .endd
21725 to ensure that it is all in one argument. The expansion is done in this way,
21726 argument by argument, so that the number of arguments cannot be changed as a
21727 result of expansion, and quotes or backslashes in inserted variables do not
21728 interact with external quoting. However, this leads to problems if you want to
21729 generate multiple arguments (or the command name plus arguments) from a single
21730 expansion. In this situation, the simplest solution is to use a shell. For
21731 example:
21732 .code
21733 command = /bin/sh -c ${lookup{$local_part}lsearch{/some/file}}
21734 .endd
21735
21736 .cindex "transport" "filter"
21737 .cindex "filter" "transport filter"
21738 .vindex "&$pipe_addresses$&"
21739 Special handling takes place when an argument consists of precisely the text
21740 &`$pipe_addresses`&. This is not a general expansion variable; the only
21741 place this string is recognized is when it appears as an argument for a pipe or
21742 transport filter command. It causes each address that is being handled to be
21743 inserted in the argument list at that point &'as a separate argument'&. This
21744 avoids any problems with spaces or shell metacharacters, and is of use when a
21745 &(pipe)& transport is handling groups of addresses in a batch.
21746
21747 If &%force_command%& is enabled on the transport, Special handling takes place
21748 for an argument that consists of precisely the text &`$address_pipe`&.  It
21749 is handled similarly to &$pipe_addresses$& above.  It is expanded and each
21750 argument is inserted in the argument list at that point
21751 &'as a separate argument'&.  The &`$address_pipe`& item does not need to be
21752 the only item in the argument; in fact, if it were then &%force_command%&
21753 should behave as a no-op.  Rather, it should be used to adjust the command
21754 run while preserving the argument vector separation.
21755
21756 After splitting up into arguments and expansion, the resulting command is run
21757 in a subprocess directly from the transport, &'not'& under a shell. The
21758 message that is being delivered is supplied on the standard input, and the
21759 standard output and standard error are both connected to a single pipe that is
21760 read by Exim. The &%max_output%& option controls how much output the command
21761 may produce, and the &%return_output%& and &%return_fail_output%& options
21762 control what is done with it.
21763
21764 Not running the command under a shell (by default) lessens the security risks
21765 in cases when a command from a user's filter file is built out of data that was
21766 taken from an incoming message. If a shell is required, it can of course be
21767 explicitly specified as the command to be run. However, there are circumstances
21768 where existing commands (for example, in &_.forward_& files) expect to be run
21769 under a shell and cannot easily be modified. To allow for these cases, there is
21770 an option called &%use_shell%&, which changes the way the &(pipe)& transport
21771 works. Instead of breaking up the command line as just described, it expands it
21772 as a single string and passes the result to &_/bin/sh_&. The
21773 &%restrict_to_path%& option and the &$pipe_addresses$& facility cannot be used
21774 with &%use_shell%&, and the whole mechanism is inherently less secure.
21775
21776
21777
21778 .section "Environment variables" "SECTpipeenv"
21779 .cindex "&(pipe)& transport" "environment for command"
21780 .cindex "environment for pipe transport"
21781 The environment variables listed below are set up when the command is invoked.
21782 This list is a compromise for maximum compatibility with other MTAs. Note that
21783 the &%environment%& option can be used to add additional variables to this
21784 environment.
21785 .display
21786 &`DOMAIN            `&   the domain of the address
21787 &`HOME              `&   the home directory, if set
21788 &`HOST              `&   the host name when called from a router (see below)
21789 &`LOCAL_PART        `&   see below
21790 &`LOCAL_PART_PREFIX `&   see below
21791 &`LOCAL_PART_SUFFIX `&   see below
21792 &`LOGNAME           `&   see below
21793 &`MESSAGE_ID        `&   Exim's local ID for the message
21794 &`PATH              `&   as specified by the &%path%& option below
21795 &`QUALIFY_DOMAIN    `&   the sender qualification domain
21796 &`RECIPIENT         `&   the complete recipient address
21797 &`SENDER            `&   the sender of the message (empty if a bounce)
21798 &`SHELL             `&   &`/bin/sh`&
21799 &`TZ                `&   the value of the &%timezone%& option, if set
21800 &`USER              `&   see below
21801 .endd
21802 When a &(pipe)& transport is called directly from (for example) an &(accept)&
21803 router, LOCAL_PART is set to the local part of the address. When it is
21804 called as a result of a forward or alias expansion, LOCAL_PART is set to
21805 the local part of the address that was expanded. In both cases, any affixes are
21806 removed from the local part, and made available in LOCAL_PART_PREFIX and
21807 LOCAL_PART_SUFFIX, respectively. LOGNAME and USER are set to the
21808 same value as LOCAL_PART for compatibility with other MTAs.
21809
21810 .cindex "HOST"
21811 HOST is set only when a &(pipe)& transport is called from a router that
21812 associates hosts with an address, typically when using &(pipe)& as a
21813 pseudo-remote transport. HOST is set to the first host name specified by
21814 the router.
21815
21816 .cindex "HOME"
21817 If the transport's generic &%home_directory%& option is set, its value is used
21818 for the HOME environment variable. Otherwise, a home directory may be set
21819 by the router's &%transport_home_directory%& option, which defaults to the
21820 user's home directory if &%check_local_user%& is set.
21821
21822
21823 .section "Private options for pipe" "SECID142"
21824 .cindex "options" "&(pipe)& transport"
21825
21826
21827
21828 .option allow_commands pipe "string list&!!" unset
21829 .cindex "&(pipe)& transport" "permitted commands"
21830 The string is expanded, and is then interpreted as a colon-separated list of
21831 permitted commands. If &%restrict_to_path%& is not set, the only commands
21832 permitted are those in the &%allow_commands%& list. They need not be absolute
21833 paths; the &%path%& option is still used for relative paths. If
21834 &%restrict_to_path%& is set with &%allow_commands%&, the command must either be
21835 in the &%allow_commands%& list, or a name without any slashes that is found on
21836 the path. In other words, if neither &%allow_commands%& nor
21837 &%restrict_to_path%& is set, there is no restriction on the command, but
21838 otherwise only commands that are permitted by one or the other are allowed. For
21839 example, if
21840 .code
21841 allow_commands = /usr/bin/vacation
21842 .endd
21843 and &%restrict_to_path%& is not set, the only permitted command is
21844 &_/usr/bin/vacation_&. The &%allow_commands%& option may not be set if
21845 &%use_shell%& is set.
21846
21847
21848 .option batch_id pipe string&!! unset
21849 See the description of local delivery batching in chapter &<<CHAPbatching>>&.
21850
21851
21852 .option batch_max pipe integer 1
21853 This limits the number of addresses that can be handled in a single delivery.
21854 See the description of local delivery batching in chapter &<<CHAPbatching>>&.
21855
21856
21857 .option check_string pipe string unset
21858 As &(pipe)& writes the message, the start of each line is tested for matching
21859 &%check_string%&, and if it does, the initial matching characters are replaced
21860 by the contents of &%escape_string%&, provided both are set. The value of
21861 &%check_string%& is a literal string, not a regular expression, and the case of
21862 any letters it contains is significant. When &%use_bsmtp%& is set, the contents
21863 of &%check_string%& and &%escape_string%& are forced to values that implement
21864 the SMTP escaping protocol. Any settings made in the configuration file are
21865 ignored.
21866
21867
21868 .option command pipe string&!! unset
21869 This option need not be set when &(pipe)& is being used to deliver to pipes
21870 obtained directly from address redirections. In other cases, the option must be
21871 set, to provide a command to be run. It need not yield an absolute path (see
21872 the &%path%& option below). The command is split up into separate arguments by
21873 Exim, and each argument is separately expanded, as described in section
21874 &<<SECThowcommandrun>>& above.
21875
21876
21877 .option environment pipe string&!! unset
21878 .cindex "&(pipe)& transport" "environment for command"
21879 .cindex "environment for &(pipe)& transport"
21880 This option is used to add additional variables to the environment in which the
21881 command runs (see section &<<SECTpipeenv>>& for the default list). Its value is
21882 a string which is expanded, and then interpreted as a colon-separated list of
21883 environment settings of the form <&'name'&>=<&'value'&>.
21884
21885
21886 .option escape_string pipe string unset
21887 See &%check_string%& above.
21888
21889
21890 .option freeze_exec_fail pipe boolean false
21891 .cindex "exec failure"
21892 .cindex "failure of exec"
21893 .cindex "&(pipe)& transport" "failure of exec"
21894 Failure to exec the command in a pipe transport is by default treated like
21895 any other failure while running the command. However, if &%freeze_exec_fail%&
21896 is set, failure to exec is treated specially, and causes the message to be
21897 frozen, whatever the setting of &%ignore_status%&.
21898
21899
21900 .option freeze_signal pipe boolean false
21901 .cindex "signal exit"
21902 .cindex "&(pipe)& transport", "signal exit"
21903 Normally if the process run by a command in a pipe transport exits on a signal,
21904 a bounce message is sent. If &%freeze_signal%& is set, the message will be
21905 frozen in Exim's queue instead.
21906
21907
21908 .option force_command pipe boolean false
21909 .cindex "force command"
21910 .cindex "&(pipe)& transport", "force command"
21911 Normally when a router redirects an address directly to a pipe command
21912 the &%command%& option on the transport is ignored.  If &%force_command%&
21913 is set, the &%command%& option will used. This is especially
21914 useful for forcing a wrapper or additional argument to be added to the
21915 command. For example:
21916 .code
21917 command = /usr/bin/remote_exec myhost -- $address_pipe
21918 force_command
21919 .endd
21920
21921 Note that &$address_pipe$& is handled specially in &%command%& when
21922 &%force_command%& is set, expanding out to the original argument vector as
21923 separate items, similarly to a Unix shell &`"$@"`& construct.
21924
21925 .option ignore_status pipe boolean false
21926 If this option is true, the status returned by the subprocess that is set up to
21927 run the command is ignored, and Exim behaves as if zero had been returned.
21928 Otherwise, a non-zero status or termination by signal causes an error return
21929 from the transport unless the status value is one of those listed in
21930 &%temp_errors%&; these cause the delivery to be deferred and tried again later.
21931
21932 &*Note*&: This option does not apply to timeouts, which do not return a status.
21933 See the &%timeout_defer%& option for how timeouts are handled.
21934
21935 .option log_defer_output pipe boolean false
21936 .cindex "&(pipe)& transport" "logging output"
21937 If this option is set, and the status returned by the command is
21938 one of the codes listed in &%temp_errors%& (that is, delivery was deferred),
21939 and any output was produced, the first line of it is written to the main log.
21940
21941
21942 .option log_fail_output pipe boolean false
21943 If this option is set, and the command returns any output, and also ends with a
21944 return code that is neither zero nor one of the return codes listed in
21945 &%temp_errors%& (that is, the delivery failed), the first line of output is
21946 written to the main log. This option and &%log_output%& are mutually exclusive.
21947 Only one of them may be set.
21948
21949
21950
21951 .option log_output pipe boolean false
21952 If this option is set and the command returns any output, the first line of
21953 output is written to the main log, whatever the return code. This option and
21954 &%log_fail_output%& are mutually exclusive. Only one of them may be set.
21955
21956
21957
21958 .option max_output pipe integer 20K
21959 This specifies the maximum amount of output that the command may produce on its
21960 standard output and standard error file combined. If the limit is exceeded, the
21961 process running the command is killed. This is intended as a safety measure to
21962 catch runaway processes. The limit is applied independently of the settings of
21963 the options that control what is done with such output (for example,
21964 &%return_output%&). Because of buffering effects, the amount of output may
21965 exceed the limit by a small amount before Exim notices.
21966
21967
21968 .option message_prefix pipe string&!! "see below"
21969 The string specified here is expanded and output at the start of every message.
21970 The default is unset if &%use_bsmtp%& is set. Otherwise it is
21971 .code
21972 message_prefix = \
21973   From ${if def:return_path{$return_path}{MAILER-DAEMON}}\
21974   ${tod_bsdinbox}\n
21975 .endd
21976 .cindex "Cyrus"
21977 .cindex "&%tmail%&"
21978 .cindex "&""From""& line"
21979 This is required by the commonly used &_/usr/bin/vacation_& program.
21980 However, it must &'not'& be present if delivery is to the Cyrus IMAP server,
21981 or to the &%tmail%& local delivery agent. The prefix can be suppressed by
21982 setting
21983 .code
21984 message_prefix =
21985 .endd
21986 &*Note:*& If you set &%use_crlf%& true, you must change any occurrences of
21987 &`\n`& to &`\r\n`& in &%message_prefix%&.
21988
21989
21990 .option message_suffix pipe string&!! "see below"
21991 The string specified here is expanded and output at the end of every message.
21992 The default is unset if &%use_bsmtp%& is set. Otherwise it is a single newline.
21993 The suffix can be suppressed by setting
21994 .code
21995 message_suffix =
21996 .endd
21997 &*Note:*& If you set &%use_crlf%& true, you must change any occurrences of
21998 &`\n`& to &`\r\n`& in &%message_suffix%&.
21999
22000
22001 .option path pipe string "see below"
22002 This option specifies the string that is set up in the PATH environment
22003 variable of the subprocess. The default is:
22004 .code
22005 /bin:/usr/bin
22006 .endd
22007 If the &%command%& option does not yield an absolute path name, the command is
22008 sought in the PATH directories, in the usual way. &*Warning*&: This does not
22009 apply to a command specified as a transport filter.
22010
22011
22012 .option permit_coredump pipe boolean false
22013 Normally Exim inhibits core-dumps during delivery.  If you have a need to get
22014 a core-dump of a pipe command, enable this command.  This enables core-dumps
22015 during delivery and affects both the Exim binary and the pipe command run.
22016 It is recommended that this option remain off unless and until you have a need
22017 for it and that this only be enabled when needed, as the risk of excessive
22018 resource consumption can be quite high.  Note also that Exim is typically
22019 installed as a setuid binary and most operating systems will inhibit coredumps
22020 of these by default, so further OS-specific action may be required.
22021
22022
22023 .option pipe_as_creator pipe boolean false
22024 .cindex "uid (user id)" "local delivery"
22025 If the generic &%user%& option is not set and this option is true, the delivery
22026 process is run under the uid that was in force when Exim was originally called
22027 to accept the message. If the group id is not otherwise set (via the generic
22028 &%group%& option), the gid that was in force when Exim was originally called to
22029 accept the message is used.
22030
22031
22032 .option restrict_to_path pipe boolean false
22033 When this option is set, any command name not listed in &%allow_commands%& must
22034 contain no slashes. The command is searched for only in the directories listed
22035 in the &%path%& option. This option is intended for use in the case when a pipe
22036 command has been generated from a user's &_.forward_& file. This is usually
22037 handled by a &(pipe)& transport called &%address_pipe%&.
22038
22039
22040 .option return_fail_output pipe boolean false
22041 If this option is true, and the command produced any output and ended with a
22042 return code other than zero or one of the codes listed in &%temp_errors%& (that
22043 is, the delivery failed), the output is returned in the bounce message.
22044 However, if the message has a null sender (that is, it is itself a bounce
22045 message), output from the command is discarded. This option and
22046 &%return_output%& are mutually exclusive. Only one of them may be set.
22047
22048
22049
22050 .option return_output pipe boolean false
22051 If this option is true, and the command produced any output, the delivery is
22052 deemed to have failed whatever the return code from the command, and the output
22053 is returned in the bounce message. Otherwise, the output is just discarded.
22054 However, if the message has a null sender (that is, it is a bounce message),
22055 output from the command is always discarded, whatever the setting of this
22056 option. This option and &%return_fail_output%& are mutually exclusive. Only one
22057 of them may be set.
22058
22059
22060
22061 .option temp_errors pipe "string list" "see below"
22062 .cindex "&(pipe)& transport" "temporary failure"
22063 This option contains either a colon-separated list of numbers, or a single
22064 asterisk. If &%ignore_status%& is false
22065 and &%return_output%& is not set,
22066 and the command exits with a non-zero return code, the failure is treated as
22067 temporary and the delivery is deferred if the return code matches one of the
22068 numbers, or if the setting is a single asterisk. Otherwise, non-zero return
22069 codes are treated as permanent errors. The default setting contains the codes
22070 defined by EX_TEMPFAIL and EX_CANTCREAT in &_sysexits.h_&. If Exim is
22071 compiled on a system that does not define these macros, it assumes values of 75
22072 and 73, respectively.
22073
22074
22075 .option timeout pipe time 1h
22076 If the command fails to complete within this time, it is killed. This normally
22077 causes the delivery to fail (but see &%timeout_defer%&). A zero time interval
22078 specifies no timeout. In order to ensure that any subprocesses created by the
22079 command are also killed, Exim makes the initial process a process group leader,
22080 and kills the whole process group on a timeout. However, this can be defeated
22081 if one of the processes starts a new process group.
22082
22083 .option timeout_defer pipe boolean false
22084 A timeout in a &(pipe)& transport, either in the command that the transport
22085 runs, or in a transport filter that is associated with it, is by default
22086 treated as a hard error, and the delivery fails. However, if &%timeout_defer%&
22087 is set true, both kinds of timeout become temporary errors, causing the
22088 delivery to be deferred.
22089
22090 .option umask pipe "octal integer" 022
22091 This specifies the umask setting for the subprocess that runs the command.
22092
22093
22094 .option use_bsmtp pipe boolean false
22095 .cindex "envelope sender"
22096 If this option is set true, the &(pipe)& transport writes messages in &"batch
22097 SMTP"& format, with the envelope sender and recipient(s) included as SMTP
22098 commands. If you want to include a leading HELO command with such messages,
22099 you can do so by setting the &%message_prefix%& option. See section
22100 &<<SECTbatchSMTP>>& for details of batch SMTP.
22101
22102 .option use_classresources pipe boolean false
22103 .cindex "class resources (BSD)"
22104 This option is available only when Exim is running on FreeBSD, NetBSD, or
22105 BSD/OS. If it is set true, the &[setclassresources()]& function is used to set
22106 resource limits when a &(pipe)& transport is run to perform a delivery. The
22107 limits for the uid under which the pipe is to run are obtained from the login
22108 class database.
22109
22110
22111 .option use_crlf pipe boolean false
22112 .cindex "carriage return"
22113 .cindex "linefeed"
22114 This option causes lines to be terminated with the two-character CRLF sequence
22115 (carriage return, linefeed) instead of just a linefeed character. In the case
22116 of batched SMTP, the byte sequence written to the pipe is then an exact image
22117 of what would be sent down a real SMTP connection.
22118
22119 The contents of the &%message_prefix%& and &%message_suffix%& options are
22120 written verbatim, so must contain their own carriage return characters if these
22121 are needed. When &%use_bsmtp%& is not set, the default values for both
22122 &%message_prefix%& and &%message_suffix%& end with a single linefeed, so their
22123 values must be changed to end with &`\r\n`& if &%use_crlf%& is set.
22124
22125
22126 .option use_shell pipe boolean false
22127 .vindex "&$pipe_addresses$&"
22128 If this option is set, it causes the command to be passed to &_/bin/sh_&
22129 instead of being run directly from the transport, as described in section
22130 &<<SECThowcommandrun>>&. This is less secure, but is needed in some situations
22131 where the command is expected to be run under a shell and cannot easily be
22132 modified. The &%allow_commands%& and &%restrict_to_path%& options, and the
22133 &`$pipe_addresses`& facility are incompatible with &%use_shell%&. The
22134 command is expanded as a single string, and handed to &_/bin/sh_& as data for
22135 its &%-c%& option.
22136
22137
22138
22139 .section "Using an external local delivery agent" "SECID143"
22140 .cindex "local delivery" "using an external agent"
22141 .cindex "&'procmail'&"
22142 .cindex "external local delivery"
22143 .cindex "delivery" "&'procmail'&"
22144 .cindex "delivery" "by external agent"
22145 The &(pipe)& transport can be used to pass all messages that require local
22146 delivery to a separate local delivery agent such as &%procmail%&. When doing
22147 this, care must be taken to ensure that the pipe is run under an appropriate
22148 uid and gid. In some configurations one wants this to be a uid that is trusted
22149 by the delivery agent to supply the correct sender of the message. It may be
22150 necessary to recompile or reconfigure the delivery agent so that it trusts an
22151 appropriate user. The following is an example transport and router
22152 configuration for &%procmail%&:
22153 .code
22154 # transport
22155 procmail_pipe:
22156   driver = pipe
22157   command = /usr/local/bin/procmail -d $local_part
22158   return_path_add
22159   delivery_date_add
22160   envelope_to_add
22161   check_string = "From "
22162   escape_string = ">From "
22163   umask = 077
22164   user = $local_part
22165   group = mail
22166
22167 # router
22168 procmail:
22169   driver = accept
22170   check_local_user
22171   transport = procmail_pipe
22172 .endd
22173 In this example, the pipe is run as the local user, but with the group set to
22174 &'mail'&. An alternative is to run the pipe as a specific user such as &'mail'&
22175 or &'exim'&, but in this case you must arrange for &%procmail%& to trust that
22176 user to supply a correct sender address. If you do not specify either a
22177 &%group%& or a &%user%& option, the pipe command is run as the local user. The
22178 home directory is the user's home directory by default.
22179
22180 &*Note*&: The command that the pipe transport runs does &'not'& begin with
22181 .code
22182 IFS=" "
22183 .endd
22184 as shown in some &%procmail%& documentation, because Exim does not by default
22185 use a shell to run pipe commands.
22186
22187 .cindex "Cyrus"
22188 The next example shows a transport and a router for a system where local
22189 deliveries are handled by the Cyrus IMAP server.
22190 .code
22191 # transport
22192 local_delivery_cyrus:
22193   driver = pipe
22194   command = /usr/cyrus/bin/deliver \
22195             -m ${substr_1:$local_part_suffix} -- $local_part
22196   user = cyrus
22197   group = mail
22198   return_output
22199   log_output
22200   message_prefix =
22201   message_suffix =
22202
22203 # router
22204 local_user_cyrus:
22205   driver = accept
22206   check_local_user
22207   local_part_suffix = .*
22208   transport = local_delivery_cyrus
22209 .endd
22210 Note the unsetting of &%message_prefix%& and &%message_suffix%&, and the use of
22211 &%return_output%& to cause any text written by Cyrus to be returned to the
22212 sender.
22213 .ecindex IIDpiptra1
22214 .ecindex IIDpiptra2
22215
22216
22217 . ////////////////////////////////////////////////////////////////////////////
22218 . ////////////////////////////////////////////////////////////////////////////
22219
22220 .chapter "The smtp transport" "CHAPsmtptrans"
22221 .scindex IIDsmttra1 "transports" "&(smtp)&"
22222 .scindex IIDsmttra2 "&(smtp)& transport"
22223 The &(smtp)& transport delivers messages over TCP/IP connections using the SMTP
22224 or LMTP protocol. The list of hosts to try can either be taken from the address
22225 that is being processed (having been set up by the router), or specified
22226 explicitly for the transport. Timeout and retry processing (see chapter
22227 &<<CHAPretry>>&) is applied to each IP address independently.
22228
22229
22230 .section "Multiple messages on a single connection" "SECID144"
22231 The sending of multiple messages over a single TCP/IP connection can arise in
22232 two ways:
22233
22234 .ilist
22235 If a message contains more than &%max_rcpt%& (see below) addresses that are
22236 routed to the same host, more than one copy of the message has to be sent to
22237 that host. In this situation, multiple copies may be sent in a single run of
22238 the &(smtp)& transport over a single TCP/IP connection. (What Exim actually
22239 does when it has too many addresses to send in one message also depends on the
22240 value of the global &%remote_max_parallel%& option. Details are given in
22241 section &<<SECToutSMTPTCP>>&.)
22242 .next
22243 .cindex "hints database" "remembering routing"
22244 When a message has been successfully delivered over a TCP/IP connection, Exim
22245 looks in its hints database to see if there are any other messages awaiting a
22246 connection to the same host. If there are, a new delivery process is started
22247 for one of them, and the current TCP/IP connection is passed on to it. The new
22248 process may in turn send multiple copies and possibly create yet another
22249 process.
22250 .endlist
22251
22252
22253 For each copy sent over the same TCP/IP connection, a sequence counter is
22254 incremented, and if it ever gets to the value of &%connection_max_messages%&,
22255 no further messages are sent over that connection.
22256
22257
22258
22259 .section "Use of the $host and $host_address variables" "SECID145"
22260 .vindex "&$host$&"
22261 .vindex "&$host_address$&"
22262 At the start of a run of the &(smtp)& transport, the values of &$host$& and
22263 &$host_address$& are the name and IP address of the first host on the host list
22264 passed by the router. However, when the transport is about to connect to a
22265 specific host, and while it is connected to that host, &$host$& and
22266 &$host_address$& are set to the values for that host. These are the values
22267 that are in force when the &%helo_data%&, &%hosts_try_auth%&, &%interface%&,
22268 &%serialize_hosts%&, and the various TLS options are expanded.
22269
22270
22271 .section "Use of $tls_cipher and $tls_peerdn" "usecippeer"
22272 .vindex &$tls_bits$&
22273 .vindex &$tls_cipher$&
22274 .vindex &$tls_peerdn$&
22275 .vindex &$tls_sni$&
22276 At the start of a run of the &(smtp)& transport, the values of &$tls_bits$&,
22277 &$tls_cipher$&, &$tls_peerdn$& and &$tls_sni$&
22278 are the values that were set when the message was received.
22279 These are the values that are used for options that are expanded before any
22280 SMTP connections are made. Just before each connection is made, these four
22281 variables are emptied. If TLS is subsequently started, they are set to the
22282 appropriate values for the outgoing connection, and these are the values that
22283 are in force when any authenticators are run and when the
22284 &%authenticated_sender%& option is expanded.
22285
22286 These variables are deprecated in favour of &$tls_in_cipher$& et. al.
22287 and will be removed in a future release.
22288
22289
22290 .section "Private options for smtp" "SECID146"
22291 .cindex "options" "&(smtp)& transport"
22292 The private options of the &(smtp)& transport are as follows:
22293
22294
22295 .option address_retry_include_sender smtp boolean true
22296 .cindex "4&'xx'& responses" "retrying after"
22297 When an address is delayed because of a 4&'xx'& response to a RCPT command, it
22298 is the combination of sender and recipient that is delayed in subsequent queue
22299 runs until the retry time is reached. You can delay the recipient without
22300 reference to the sender (which is what earlier versions of Exim did), by
22301 setting &%address_retry_include_sender%& false. However, this can lead to
22302 problems with servers that regularly issue 4&'xx'& responses to RCPT commands.
22303
22304 .option allow_localhost smtp boolean false
22305 .cindex "local host" "sending to"
22306 .cindex "fallback" "hosts specified on transport"
22307 When a host specified in &%hosts%& or &%fallback_hosts%& (see below) turns out
22308 to be the local host, or is listed in &%hosts_treat_as_local%&, delivery is
22309 deferred by default. However, if &%allow_localhost%& is set, Exim goes on to do
22310 the delivery anyway. This should be used only in special cases when the
22311 configuration ensures that no looping will result (for example, a differently
22312 configured Exim is listening on the port to which the message is sent).
22313
22314
22315 .option authenticated_sender smtp string&!! unset
22316 .cindex "Cyrus"
22317 When Exim has authenticated as a client, or if &%authenticated_sender_force%&
22318 is true, this option sets a value for the AUTH= item on outgoing MAIL commands,
22319 overriding any existing authenticated sender value. If the string expansion is
22320 forced to fail, the option is ignored. Other expansion failures cause delivery
22321 to be deferred. If the result of expansion is an empty string, that is also
22322 ignored.
22323
22324 The expansion happens after the outgoing connection has been made and TLS
22325 started, if required. This means that the &$host$&, &$host_address$&,
22326 &$tls_out_cipher$&, and &$tls_out_peerdn$& variables are set according to the
22327 particular connection.
22328
22329 If the SMTP session is not authenticated, the expansion of
22330 &%authenticated_sender%& still happens (and can cause the delivery to be
22331 deferred if it fails), but no AUTH= item is added to MAIL commands
22332 unless &%authenticated_sender_force%& is true.
22333
22334 This option allows you to use the &(smtp)& transport in LMTP mode to
22335 deliver mail to Cyrus IMAP and provide the proper local part as the
22336 &"authenticated sender"&, via a setting such as:
22337 .code
22338 authenticated_sender = $local_part
22339 .endd
22340 This removes the need for IMAP subfolders to be assigned special ACLs to
22341 allow direct delivery to those subfolders.
22342
22343 Because of expected uses such as that just described for Cyrus (when no
22344 domain is involved), there is no checking on the syntax of the provided
22345 value.
22346
22347
22348 .option authenticated_sender_force smtp boolean false
22349 If this option is set true, the &%authenticated_sender%& option's value
22350 is used for the AUTH= item on outgoing MAIL commands, even if Exim has not
22351 authenticated as a client.
22352
22353
22354 .option command_timeout smtp time 5m
22355 This sets a timeout for receiving a response to an SMTP command that has been
22356 sent out. It is also used when waiting for the initial banner line from the
22357 remote host. Its value must not be zero.
22358
22359
22360 .option connect_timeout smtp time 5m
22361 This sets a timeout for the &[connect()]& function, which sets up a TCP/IP call
22362 to a remote host. A setting of zero allows the system timeout (typically
22363 several minutes) to act. To have any effect, the value of this option must be
22364 less than the system timeout. However, it has been observed that on some
22365 systems there is no system timeout, which is why the default value for this
22366 option is 5 minutes, a value recommended by RFC 1123.
22367
22368
22369 .option connection_max_messages smtp integer 500
22370 .cindex "SMTP" "passed connection"
22371 .cindex "SMTP" "multiple deliveries"
22372 .cindex "multiple SMTP deliveries"
22373 This controls the maximum number of separate message deliveries that are sent
22374 over a single TCP/IP connection. If the value is zero, there is no limit.
22375 For testing purposes, this value can be overridden by the &%-oB%& command line
22376 option.
22377
22378
22379 .option data_timeout smtp time 5m
22380 This sets a timeout for the transmission of each block in the data portion of
22381 the message. As a result, the overall timeout for a message depends on the size
22382 of the message. Its value must not be zero. See also &%final_timeout%&.
22383
22384
22385 .option delay_after_cutoff smtp boolean true
22386 This option controls what happens when all remote IP addresses for a given
22387 domain have been inaccessible for so long that they have passed their retry
22388 cutoff times.
22389
22390 In the default state, if the next retry time has not been reached for any of
22391 them, the address is bounced without trying any deliveries. In other words,
22392 Exim delays retrying an IP address after the final cutoff time until a new
22393 retry time is reached, and can therefore bounce an address without ever trying
22394 a delivery, when machines have been down for a long time. Some people are
22395 unhappy at this prospect, so...
22396
22397 If &%delay_after_cutoff%& is set false, Exim behaves differently. If all IP
22398 addresses are past their final cutoff time, Exim tries to deliver to those
22399 IP addresses that have not been tried since the message arrived. If there are
22400 none, of if they all fail, the address is bounced. In other words, it does not
22401 delay when a new message arrives, but immediately tries those expired IP
22402 addresses that haven't been tried since the message arrived. If there is a
22403 continuous stream of messages for the dead hosts, unsetting
22404 &%delay_after_cutoff%& means that there will be many more attempts to deliver
22405 to them.
22406
22407
22408 .option dns_qualify_single smtp boolean true
22409 If the &%hosts%& or &%fallback_hosts%& option is being used,
22410 and the &%gethostbyname%& option is false,
22411 the RES_DEFNAMES resolver option is set. See the &%qualify_single%& option
22412 in chapter &<<CHAPdnslookup>>& for more details.
22413
22414
22415 .option dns_search_parents smtp boolean false
22416 If the &%hosts%& or &%fallback_hosts%& option is being used, and the
22417 &%gethostbyname%& option is false, the RES_DNSRCH resolver option is set.
22418 See the &%search_parents%& option in chapter &<<CHAPdnslookup>>& for more
22419 details.
22420
22421
22422 .new
22423 .option dscp smtp string&!! unset
22424 .cindex "DCSP" "outbound"
22425 This option causes the DSCP value associated with a socket to be set to one
22426 of a number of fixed strings or to numeric value.
22427 The &%-bI:dscp%& option may be used to ask Exim which names it knows of.
22428 Common values include &`throughput`&, &`mincost`&, and on newer systems
22429 &`ef`&, &`af41`&, etc.  Numeric values may be in the range 0 to 0x3F.
22430
22431 The outbound packets from Exim will be marked with this value in the header
22432 (for IPv4, the TOS field; for IPv6, the TCLASS field); there is no guarantee
22433 that these values will have any effect, not be stripped by networking
22434 equipment, or do much of anything without cooperation with your Network
22435 Engineer and those of all network operators between the source and destination.
22436 .wen
22437
22438
22439 .option fallback_hosts smtp "string list" unset
22440 .cindex "fallback" "hosts specified on transport"
22441 String expansion is not applied to this option. The argument must be a
22442 colon-separated list of host names or IP addresses, optionally also including
22443 port numbers, though the separator can be changed, as described in section
22444 &<<SECTlistconstruct>>&. Each individual item in the list is the same as an
22445 item in a &%route_list%& setting for the &(manualroute)& router, as described
22446 in section &<<SECTformatonehostitem>>&.
22447
22448 Fallback hosts can also be specified on routers, which associate them with the
22449 addresses they process. As for the &%hosts%& option without &%hosts_override%&,
22450 &%fallback_hosts%& specified on the transport is used only if the address does
22451 not have its own associated fallback host list. Unlike &%hosts%&, a setting of
22452 &%fallback_hosts%& on an address is not overridden by &%hosts_override%&.
22453 However, &%hosts_randomize%& does apply to fallback host lists.
22454
22455 If Exim is unable to deliver to any of the hosts for a particular address, and
22456 the errors are not permanent rejections, the address is put on a separate
22457 transport queue with its host list replaced by the fallback hosts, unless the
22458 address was routed via MX records and the current host was in the original MX
22459 list. In that situation, the fallback host list is not used.
22460
22461 Once normal deliveries are complete, the fallback queue is delivered by
22462 re-running the same transports with the new host lists. If several failing
22463 addresses have the same fallback hosts (and &%max_rcpt%& permits it), a single
22464 copy of the message is sent.
22465
22466 The resolution of the host names on the fallback list is controlled by the
22467 &%gethostbyname%& option, as for the &%hosts%& option. Fallback hosts apply
22468 both to cases when the host list comes with the address and when it is taken
22469 from &%hosts%&. This option provides a &"use a smart host only if delivery
22470 fails"& facility.
22471
22472
22473 .option final_timeout smtp time 10m
22474 This is the timeout that applies while waiting for the response to the final
22475 line containing just &"."& that terminates a message. Its value must not be
22476 zero.
22477
22478 .option gethostbyname smtp boolean false
22479 If this option is true when the &%hosts%& and/or &%fallback_hosts%& options are
22480 being used, names are looked up using &[gethostbyname()]&
22481 (or &[getipnodebyname()]& when available)
22482 instead of using the DNS. Of course, that function may in fact use the DNS, but
22483 it may also consult other sources of information such as &_/etc/hosts_&.
22484
22485 .option gnutls_compat_mode smtp boolean unset
22486 This option controls whether GnuTLS is used in compatibility mode in an Exim
22487 server. This reduces security slightly, but improves interworking with older
22488 implementations of TLS.
22489
22490 .option helo_data smtp string&!! "see below"
22491 .cindex "HELO" "argument, setting"
22492 .cindex "EHLO" "argument, setting"
22493 .cindex "LHLO argument setting"
22494 The value of this option is expanded after a connection to a another host has
22495 been set up. The result is used as the argument for the EHLO, HELO, or LHLO
22496 command that starts the outgoing SMTP or LMTP session. The default value of the
22497 option is:
22498 .code
22499 $primary_hostname
22500 .endd
22501 During the expansion, the variables &$host$& and &$host_address$& are set to
22502 the identity of the remote host, and the variables &$sending_ip_address$& and
22503 &$sending_port$& are set to the local IP address and port number that are being
22504 used. These variables can be used to generate different values for different
22505 servers or different local IP addresses. For example, if you want the string
22506 that is used for &%helo_data%& to be obtained by a DNS lookup of the outgoing
22507 interface address, you could use this:
22508 .code
22509 helo_data = ${lookup dnsdb{ptr=$sending_ip_address}{$value}\
22510   {$primary_hostname}}
22511 .endd
22512 The use of &%helo_data%& applies both to sending messages and when doing
22513 callouts.
22514
22515 .option hosts smtp "string list&!!" unset
22516 Hosts are associated with an address by a router such as &(dnslookup)&, which
22517 finds the hosts by looking up the address domain in the DNS, or by
22518 &(manualroute)&, which has lists of hosts in its configuration. However,
22519 email addresses can be passed to the &(smtp)& transport by any router, and not
22520 all of them can provide an associated list of hosts.
22521
22522 The &%hosts%& option specifies a list of hosts to be used if the address being
22523 processed does not have any hosts associated with it. The hosts specified by
22524 &%hosts%& are also used, whether or not the address has its own hosts, if
22525 &%hosts_override%& is set.
22526
22527 The string is first expanded, before being interpreted as a colon-separated
22528 list of host names or IP addresses, possibly including port numbers. The
22529 separator may be changed to something other than colon, as described in section
22530 &<<SECTlistconstruct>>&. Each individual item in the list is the same as an
22531 item in a &%route_list%& setting for the &(manualroute)& router, as described
22532 in section &<<SECTformatonehostitem>>&. However, note that the &`/MX`& facility
22533 of the &(manualroute)& router is not available here.
22534
22535 If the expansion fails, delivery is deferred. Unless the failure was caused by
22536 the inability to complete a lookup, the error is logged to the panic log as
22537 well as the main log. Host names are looked up either by searching directly for
22538 address records in the DNS or by calling &[gethostbyname()]& (or
22539 &[getipnodebyname()]& when available), depending on the setting of the
22540 &%gethostbyname%& option. When Exim is compiled with IPv6 support, if a host
22541 that is looked up in the DNS has both IPv4 and IPv6 addresses, both types of
22542 address are used.
22543
22544 During delivery, the hosts are tried in order, subject to their retry status,
22545 unless &%hosts_randomize%& is set.
22546
22547
22548 .option hosts_avoid_esmtp smtp "host list&!!" unset
22549 .cindex "ESMTP, avoiding use of"
22550 .cindex "HELO" "forcing use of"
22551 .cindex "EHLO" "avoiding use of"
22552 .cindex "PIPELINING" "avoiding the use of"
22553 This option is for use with broken hosts that announce ESMTP facilities (for
22554 example, PIPELINING) and then fail to implement them properly. When a host
22555 matches &%hosts_avoid_esmtp%&, Exim sends HELO rather than EHLO at the
22556 start of the SMTP session. This means that it cannot use any of the ESMTP
22557 facilities such as AUTH, PIPELINING, SIZE, and STARTTLS.
22558
22559
22560 .option hosts_avoid_pipelining smtp "host list&!!" unset
22561 .cindex "PIPELINING" "avoiding the use of"
22562 Exim will not use the SMTP PIPELINING extension when delivering to any host
22563 that matches this list, even if the server host advertises PIPELINING support.
22564
22565
22566 .option hosts_avoid_tls smtp "host list&!!" unset
22567 .cindex "TLS" "avoiding for certain hosts"
22568 Exim will not try to start a TLS session when delivering to any host that
22569 matches this list. See chapter &<<CHAPTLS>>& for details of TLS.
22570
22571 .option hosts_verify_avoid_tls smtp "host list&!!" *
22572 .cindex "TLS" "avoiding for certain hosts"
22573 Exim will not try to start a TLS session for a verify callout,
22574 or when delivering in cutthrough mode,
22575 to any host that matches this list.
22576 Note that the default is to not use TLS.
22577
22578
22579 .option hosts_max_try smtp integer 5
22580 .cindex "host" "maximum number to try"
22581 .cindex "limit" "number of hosts tried"
22582 .cindex "limit" "number of MX tried"
22583 .cindex "MX record" "maximum tried"
22584 This option limits the number of IP addresses that are tried for any one
22585 delivery in cases where there are temporary delivery errors. Section
22586 &<<SECTvalhosmax>>& describes in detail how the value of this option is used.
22587
22588
22589 .option hosts_max_try_hardlimit smtp integer 50
22590 This is an additional check on the maximum number of IP addresses that Exim
22591 tries for any one delivery. Section &<<SECTvalhosmax>>& describes its use and
22592 why it exists.
22593
22594
22595
22596 .option hosts_nopass_tls smtp "host list&!!" unset
22597 .cindex "TLS" "passing connection"
22598 .cindex "multiple SMTP deliveries"
22599 .cindex "TLS" "multiple message deliveries"
22600 For any host that matches this list, a connection on which a TLS session has
22601 been started will not be passed to a new delivery process for sending another
22602 message on the same connection. See section &<<SECTmulmessam>>& for an
22603 explanation of when this might be needed.
22604
22605
22606 .option hosts_override smtp boolean false
22607 If this option is set and the &%hosts%& option is also set, any hosts that are
22608 attached to the address are ignored, and instead the hosts specified by the
22609 &%hosts%& option are always used. This option does not apply to
22610 &%fallback_hosts%&.
22611
22612
22613 .option hosts_randomize smtp boolean false
22614 .cindex "randomized host list"
22615 .cindex "host" "list of; randomized"
22616 .cindex "fallback" "randomized hosts"
22617 If this option is set, and either the list of hosts is taken from the
22618 &%hosts%& or the &%fallback_hosts%& option, or the hosts supplied by the router
22619 were not obtained from MX records (this includes fallback hosts from the
22620 router), and were not randomized by the router, the order of trying the hosts
22621 is randomized each time the transport runs. Randomizing the order of a host
22622 list can be used to do crude load sharing.
22623
22624 When &%hosts_randomize%& is true, a host list may be split into groups whose
22625 order is separately randomized. This makes it possible to set up MX-like
22626 behaviour. The boundaries between groups are indicated by an item that is just
22627 &`+`& in the host list. For example:
22628 .code
22629 hosts = host1:host2:host3:+:host4:host5
22630 .endd
22631 The order of the first three hosts and the order of the last two hosts is
22632 randomized for each use, but the first three always end up before the last two.
22633 If &%hosts_randomize%& is not set, a &`+`& item in the list is ignored.
22634
22635 .option hosts_require_auth smtp "host list&!!" unset
22636 .cindex "authentication" "required by client"
22637 This option provides a list of servers for which authentication must succeed
22638 before Exim will try to transfer a message. If authentication fails for
22639 servers which are not in this list, Exim tries to send unauthenticated. If
22640 authentication fails for one of these servers, delivery is deferred. This
22641 temporary error is detectable in the retry rules, so it can be turned into a
22642 hard failure if required. See also &%hosts_try_auth%&, and chapter
22643 &<<CHAPSMTPAUTH>>& for details of authentication.
22644
22645
22646 .option hosts_require_tls smtp "host list&!!" unset
22647 .cindex "TLS" "requiring for certain servers"
22648 Exim will insist on using a TLS session when delivering to any host that
22649 matches this list. See chapter &<<CHAPTLS>>& for details of TLS.
22650 &*Note*&: This option affects outgoing mail only. To insist on TLS for
22651 incoming messages, use an appropriate ACL.
22652
22653 .option hosts_try_auth smtp "host list&!!" unset
22654 .cindex "authentication" "optional in client"
22655 This option provides a list of servers to which, provided they announce
22656 authentication support, Exim will attempt to authenticate as a client when it
22657 connects. If authentication fails, Exim will try to transfer the message
22658 unauthenticated. See also &%hosts_require_auth%&, and chapter
22659 &<<CHAPSMTPAUTH>>& for details of authentication.
22660
22661 .option interface smtp "string list&!!" unset
22662 .cindex "bind IP address"
22663 .cindex "IP address" "binding"
22664 .vindex "&$host$&"
22665 .vindex "&$host_address$&"
22666 This option specifies which interface to bind to when making an outgoing SMTP
22667 call. The value is an IP address, not an interface name such as
22668 &`eth0`&. Do not confuse this with the interface address that was used when a
22669 message was received, which is in &$received_ip_address$&, formerly known as
22670 &$interface_address$&. The name was changed to minimize confusion with the
22671 outgoing interface address. There is no variable that contains an outgoing
22672 interface address because, unless it is set by this option, its value is
22673 unknown.
22674
22675 During the expansion of the &%interface%& option the variables &$host$& and
22676 &$host_address$& refer to the host to which a connection is about to be made
22677 during the expansion of the string. Forced expansion failure, or an empty
22678 string result causes the option to be ignored. Otherwise, after expansion, the
22679 string must be a list of IP addresses, colon-separated by default, but the
22680 separator can be changed in the usual way. For example:
22681 .code
22682 interface = <; 192.168.123.123 ; 3ffe:ffff:836f::fe86:a061
22683 .endd
22684 The first interface of the correct type (IPv4 or IPv6) is used for the outgoing
22685 connection. If none of them are the correct type, the option is ignored. If
22686 &%interface%& is not set, or is ignored, the system's IP functions choose which
22687 interface to use if the host has more than one.
22688
22689
22690 .option keepalive smtp boolean true
22691 .cindex "keepalive" "on outgoing connection"
22692 This option controls the setting of SO_KEEPALIVE on outgoing TCP/IP socket
22693 connections. When set, it causes the kernel to probe idle connections
22694 periodically, by sending packets with &"old"& sequence numbers. The other end
22695 of the connection should send a acknowledgment if the connection is still okay
22696 or a reset if the connection has been aborted. The reason for doing this is
22697 that it has the beneficial effect of freeing up certain types of connection
22698 that can get stuck when the remote host is disconnected without tidying up the
22699 TCP/IP call properly. The keepalive mechanism takes several hours to detect
22700 unreachable hosts.
22701
22702
22703 .option lmtp_ignore_quota smtp boolean false
22704 .cindex "LMTP" "ignoring quota errors"
22705 If this option is set true when the &%protocol%& option is set to &"lmtp"&, the
22706 string &`IGNOREQUOTA`& is added to RCPT commands, provided that the LMTP server
22707 has advertised support for IGNOREQUOTA in its response to the LHLO command.
22708
22709 .option max_rcpt smtp integer 100
22710 .cindex "RCPT" "maximum number of outgoing"
22711 This option limits the number of RCPT commands that are sent in a single
22712 SMTP message transaction. Each set of addresses is treated independently, and
22713 so can cause parallel connections to the same host if &%remote_max_parallel%&
22714 permits this.
22715
22716
22717 .option multi_domain smtp boolean true
22718 .vindex "&$domain$&"
22719 When this option is set, the &(smtp)& transport can handle a number of
22720 addresses containing a mixture of different domains provided they all resolve
22721 to the same list of hosts. Turning the option off restricts the transport to
22722 handling only one domain at a time. This is useful if you want to use
22723 &$domain$& in an expansion for the transport, because it is set only when there
22724 is a single domain involved in a remote delivery.
22725
22726
22727 .option port smtp string&!! "see below"
22728 .cindex "port" "sending TCP/IP"
22729 .cindex "TCP/IP" "setting outgoing port"
22730 This option specifies the TCP/IP port on the server to which Exim connects.
22731 &*Note:*& Do not confuse this with the port that was used when a message was
22732 received, which is in &$received_port$&, formerly known as &$interface_port$&.
22733 The name was changed to minimize confusion with the outgoing port. There is no
22734 variable that contains an outgoing port.
22735
22736 If the value of this option begins with a digit it is taken as a port number;
22737 otherwise it is looked up using &[getservbyname()]&. The default value is
22738 normally &"smtp"&, but if &%protocol%& is set to &"lmtp"&, the default is
22739 &"lmtp"&. If the expansion fails, or if a port number cannot be found, delivery
22740 is deferred.
22741
22742
22743
22744 .option protocol smtp string smtp
22745 .cindex "LMTP" "over TCP/IP"
22746 .cindex "ssmtp protocol" "outbound"
22747 .cindex "TLS" "SSL-on-connect outbound"
22748 .vindex "&$port$&"
22749 If this option is set to &"lmtp"& instead of &"smtp"&, the default value for
22750 the &%port%& option changes to &"lmtp"&, and the transport operates the LMTP
22751 protocol (RFC 2033) instead of SMTP. This protocol is sometimes used for local
22752 deliveries into closed message stores. Exim also has support for running LMTP
22753 over a pipe to a local process &-- see chapter &<<CHAPLMTP>>&.
22754
22755 If this option is set to &"smtps"&, the default vaule for the &%port%& option
22756 changes to &"smtps"&, and the transport initiates TLS immediately after
22757 connecting, as an outbound SSL-on-connect, instead of using STARTTLS to upgrade.
22758 The Internet standards bodies strongly discourage use of this mode.
22759
22760
22761 .option retry_include_ip_address smtp boolean true
22762 Exim normally includes both the host name and the IP address in the key it
22763 constructs for indexing retry data after a temporary delivery failure. This
22764 means that when one of several IP addresses for a host is failing, it gets
22765 tried periodically (controlled by the retry rules), but use of the other IP
22766 addresses is not affected.
22767
22768 However, in some dialup environments hosts are assigned a different IP address
22769 each time they connect. In this situation the use of the IP address as part of
22770 the retry key leads to undesirable behaviour. Setting this option false causes
22771 Exim to use only the host name. This should normally be done on a separate
22772 instance of the &(smtp)& transport, set up specially to handle the dialup
22773 hosts.
22774
22775
22776 .option serialize_hosts smtp "host list&!!" unset
22777 .cindex "serializing connections"
22778 .cindex "host" "serializing connections"
22779 Because Exim operates in a distributed manner, if several messages for the same
22780 host arrive at around the same time, more than one simultaneous connection to
22781 the remote host can occur. This is not usually a problem except when there is a
22782 slow link between the hosts. In that situation it may be helpful to restrict
22783 Exim to one connection at a time. This can be done by setting
22784 &%serialize_hosts%& to match the relevant hosts.
22785
22786 .cindex "hints database" "serializing deliveries to a host"
22787 Exim implements serialization by means of a hints database in which a record is
22788 written whenever a process connects to one of the restricted hosts. The record
22789 is deleted when the connection is completed. Obviously there is scope for
22790 records to get left lying around if there is a system or program crash. To
22791 guard against this, Exim ignores any records that are more than six hours old.
22792
22793 If you set up this kind of serialization, you should also arrange to delete the
22794 relevant hints database whenever your system reboots. The names of the files
22795 start with &_misc_& and they are kept in the &_spool/db_& directory. There
22796 may be one or two files, depending on the type of DBM in use. The same files
22797 are used for ETRN serialization.
22798
22799
22800 .option size_addition smtp integer 1024
22801 .cindex "SMTP" "SIZE"
22802 .cindex "message" "size issue for transport filter"
22803 .cindex "size" "of message"
22804 .cindex "transport" "filter"
22805 .cindex "filter" "transport filter"
22806 If a remote SMTP server indicates that it supports the SIZE option of the
22807 MAIL command, Exim uses this to pass over the message size at the start of
22808 an SMTP transaction. It adds the value of &%size_addition%& to the value it
22809 sends, to allow for headers and other text that may be added during delivery by
22810 configuration options or in a transport filter. It may be necessary to increase
22811 this if a lot of text is added to messages.
22812
22813 Alternatively, if the value of &%size_addition%& is set negative, it disables
22814 the use of the SIZE option altogether.
22815
22816
22817 .option tls_certificate smtp string&!! unset
22818 .cindex "TLS" "client certificate, location of"
22819 .cindex "certificate" "client, location of"
22820 .vindex "&$host$&"
22821 .vindex "&$host_address$&"
22822 The value of this option must be the absolute path to a file which contains the
22823 client's certificate, for possible use when sending a message over an encrypted
22824 connection. The values of &$host$& and &$host_address$& are set to the name and
22825 address of the server during the expansion. See chapter &<<CHAPTLS>>& for
22826 details of TLS.
22827
22828 &*Note*&: This option must be set if you want Exim to be able to use a TLS
22829 certificate when sending messages as a client. The global option of the same
22830 name specifies the certificate for Exim as a server; it is not automatically
22831 assumed that the same certificate should be used when Exim is operating as a
22832 client.
22833
22834
22835 .option tls_crl smtp string&!! unset
22836 .cindex "TLS" "client certificate revocation list"
22837 .cindex "certificate" "revocation list for client"
22838 This option specifies a certificate revocation list. The expanded value must
22839 be the name of a file that contains a CRL in PEM format.
22840
22841
22842 .new
22843 .option tls_dh_min_bits smtp integer 1024
22844 .cindex "TLS" "Diffie-Hellman minimum acceptable size"
22845 When establishing a TLS session, if a ciphersuite which uses Diffie-Hellman
22846 key agreement is negotiated, the server will provide a large prime number
22847 for use.  This option establishes the minimum acceptable size of that number.
22848 If the parameter offered by the server is too small, then the TLS handshake
22849 will fail.
22850
22851 Only supported when using GnuTLS.
22852 .wen
22853
22854
22855 .option tls_privatekey smtp string&!! unset
22856 .cindex "TLS" "client private key, location of"
22857 .vindex "&$host$&"
22858 .vindex "&$host_address$&"
22859 The value of this option must be the absolute path to a file which contains the
22860 client's private key. This is used when sending a message over an encrypted
22861 connection using a client certificate. The values of &$host$& and
22862 &$host_address$& are set to the name and address of the server during the
22863 expansion. If this option is unset, or the expansion is forced to fail, or the
22864 result is an empty string, the private key is assumed to be in the same file as
22865 the certificate. See chapter &<<CHAPTLS>>& for details of TLS.
22866
22867
22868 .option tls_require_ciphers smtp string&!! unset
22869 .cindex "TLS" "requiring specific ciphers"
22870 .cindex "cipher" "requiring specific"
22871 .vindex "&$host$&"
22872 .vindex "&$host_address$&"
22873 The value of this option must be a list of permitted cipher suites, for use
22874 when setting up an outgoing encrypted connection. (There is a global option of
22875 the same name for controlling incoming connections.) The values of &$host$& and
22876 &$host_address$& are set to the name and address of the server during the
22877 expansion. See chapter &<<CHAPTLS>>& for details of TLS; note that this option
22878 is used in different ways by OpenSSL and GnuTLS (see sections
22879 &<<SECTreqciphssl>>& and &<<SECTreqciphgnu>>&). For GnuTLS, the order of the
22880 ciphers is a preference order.
22881
22882
22883
22884 .option tls_sni smtp string&!! unset
22885 .cindex "TLS" "Server Name Indication"
22886 .vindex "&$tls_sni$&"
22887 If this option is set then it sets the $tls_out_sni variable and causes any
22888 TLS session to pass this value as the Server Name Indication extension to
22889 the remote side, which can be used by the remote side to select an appropriate
22890 certificate and private key for the session.
22891
22892 See &<<SECTtlssni>>& for more information.
22893
22894 Note that for OpenSSL, this feature requires a build of OpenSSL that supports
22895 TLS extensions.
22896
22897
22898
22899
22900 .option tls_tempfail_tryclear smtp boolean true
22901 .cindex "4&'xx'& responses" "to STARTTLS"
22902 When the server host is not in &%hosts_require_tls%&, and there is a problem in
22903 setting up a TLS session, this option determines whether or not Exim should try
22904 to deliver the message unencrypted. If it is set false, delivery to the
22905 current host is deferred; if there are other hosts, they are tried. If this
22906 option is set true, Exim attempts to deliver unencrypted after a 4&'xx'&
22907 response to STARTTLS. Also, if STARTTLS is accepted, but the subsequent
22908 TLS negotiation fails, Exim closes the current connection (because it is in an
22909 unknown state), opens a new one to the same host, and then tries the delivery
22910 in clear.
22911
22912
22913 .option tls_verify_certificates smtp string&!! unset
22914 .cindex "TLS" "server certificate verification"
22915 .cindex "certificate" "verification of server"
22916 .vindex "&$host$&"
22917 .vindex "&$host_address$&"
22918 The value of this option must be the absolute path to a file containing
22919 permitted server certificates, for use when setting up an encrypted connection.
22920 Alternatively, if you are using OpenSSL, you can set
22921 &%tls_verify_certificates%& to the name of a directory containing certificate
22922 files. This does not work with GnuTLS; the option must be set to the name of a
22923 single file if you are using GnuTLS. The values of &$host$& and
22924 &$host_address$& are set to the name and address of the server during the
22925 expansion of this option. See chapter &<<CHAPTLS>>& for details of TLS.
22926
22927
22928
22929
22930 .section "How the limits for the number of hosts to try are used" &&&
22931          "SECTvalhosmax"
22932 .cindex "host" "maximum number to try"
22933 .cindex "limit" "hosts; maximum number tried"
22934 There are two options that are concerned with the number of hosts that are
22935 tried when an SMTP delivery takes place. They are &%hosts_max_try%& and
22936 &%hosts_max_try_hardlimit%&.
22937
22938
22939 The &%hosts_max_try%& option limits the number of hosts that are tried
22940 for a single delivery. However, despite the term &"host"& in its name, the
22941 option actually applies to each IP address independently. In other words, a
22942 multihomed host is treated as several independent hosts, just as it is for
22943 retrying.
22944
22945 Many of the larger ISPs have multiple MX records which often point to
22946 multihomed hosts. As a result, a list of a dozen or more IP addresses may be
22947 created as a result of routing one of these domains.
22948
22949 Trying every single IP address on such a long list does not seem sensible; if
22950 several at the top of the list fail, it is reasonable to assume there is some
22951 problem that is likely to affect all of them. Roughly speaking, the value of
22952 &%hosts_max_try%& is the maximum number that are tried before deferring the
22953 delivery. However, the logic cannot be quite that simple.
22954
22955 Firstly, IP addresses that are skipped because their retry times have not
22956 arrived do not count, and in addition, addresses that are past their retry
22957 limits are also not counted, even when they are tried. This means that when
22958 some IP addresses are past their retry limits, more than the value of
22959 &%hosts_max_retry%& may be tried. The reason for this behaviour is to ensure
22960 that all IP addresses are considered before timing out an email address (but
22961 see below for an exception).
22962
22963 Secondly, when the &%hosts_max_try%& limit is reached, Exim looks down the host
22964 list to see if there is a subsequent host with a different (higher valued) MX.
22965 If there is, that host is considered next, and the current IP address is used
22966 but not counted. This behaviour helps in the case of a domain with a retry rule
22967 that hardly ever delays any hosts, as is now explained:
22968
22969 Consider the case of a long list of hosts with one MX value, and a few with a
22970 higher MX value. If &%hosts_max_try%& is small (the default is 5) only a few
22971 hosts at the top of the list are tried at first. With the default retry rule,
22972 which specifies increasing retry times, the higher MX hosts are eventually
22973 tried when those at the top of the list are skipped because they have not
22974 reached their retry times.
22975
22976 However, it is common practice to put a fixed short retry time on domains for
22977 large ISPs, on the grounds that their servers are rarely down for very long.
22978 Unfortunately, these are exactly the domains that tend to resolve to long lists
22979 of hosts. The short retry time means that the lowest MX hosts are tried every
22980 time. The attempts may be in a different order because of random sorting, but
22981 without the special MX check, the higher MX hosts would never be tried until
22982 all the lower MX hosts had timed out (which might be several days), because
22983 there are always some lower MX hosts that have reached their retry times. With
22984 the special check, Exim considers at least one IP address from each MX value at
22985 every delivery attempt, even if the &%hosts_max_try%& limit has already been
22986 reached.
22987
22988 The above logic means that &%hosts_max_try%& is not a hard limit, and in
22989 particular, Exim normally eventually tries all the IP addresses before timing
22990 out an email address. When &%hosts_max_try%& was implemented, this seemed a
22991 reasonable thing to do. Recently, however, some lunatic DNS configurations have
22992 been set up with hundreds of IP addresses for some domains. It can
22993 take a very long time indeed for an address to time out in these cases.
22994
22995 The &%hosts_max_try_hardlimit%& option was added to help with this problem.
22996 Exim never tries more than this number of IP addresses; if it hits this limit
22997 and they are all timed out, the email address is bounced, even though not all
22998 possible IP addresses have been tried.
22999 .ecindex IIDsmttra1
23000 .ecindex IIDsmttra2
23001
23002
23003
23004
23005
23006 . ////////////////////////////////////////////////////////////////////////////
23007 . ////////////////////////////////////////////////////////////////////////////
23008
23009 .chapter "Address rewriting" "CHAPrewrite"
23010 .scindex IIDaddrew "rewriting" "addresses"
23011 There are some circumstances in which Exim automatically rewrites domains in
23012 addresses. The two most common are when an address is given without a domain
23013 (referred to as an &"unqualified address"&) or when an address contains an
23014 abbreviated domain that is expanded by DNS lookup.
23015
23016 Unqualified envelope addresses are accepted only for locally submitted
23017 messages, or for messages that are received from hosts matching
23018 &%sender_unqualified_hosts%& or &%recipient_unqualified_hosts%&, as
23019 appropriate. Unqualified addresses in header lines are qualified if they are in
23020 locally submitted messages, or messages from hosts that are permitted to send
23021 unqualified envelope addresses. Otherwise, unqualified addresses in header
23022 lines are neither qualified nor rewritten.
23023
23024 One situation in which Exim does &'not'& automatically rewrite a domain is
23025 when it is the name of a CNAME record in the DNS. The older RFCs suggest that
23026 such a domain should be rewritten using the &"canonical"& name, and some MTAs
23027 do this. The new RFCs do not contain this suggestion.
23028
23029
23030 .section "Explicitly configured address rewriting" "SECID147"
23031 This chapter describes the rewriting rules that can be used in the
23032 main rewrite section of the configuration file, and also in the generic
23033 &%headers_rewrite%& option that can be set on any transport.
23034
23035 Some people believe that configured address rewriting is a Mortal Sin.
23036 Others believe that life is not possible without it. Exim provides the
23037 facility; you do not have to use it.
23038
23039 The main rewriting rules that appear in the &"rewrite"& section of the
23040 configuration file are applied to addresses in incoming messages, both envelope
23041 addresses and addresses in header lines. Each rule specifies the types of
23042 address to which it applies.
23043
23044 Whether or not addresses in header lines are rewritten depends on the origin of
23045 the headers and the type of rewriting. Global rewriting, that is, rewriting
23046 rules from the rewrite section of the configuration file, is applied only to
23047 those headers that were received with the message. Header lines that are added
23048 by ACLs or by a system filter or by individual routers or transports (which
23049 are specific to individual recipient addresses) are not rewritten by the global
23050 rules.
23051
23052 Rewriting at transport time, by means of the &%headers_rewrite%& option,
23053 applies all headers except those added by routers and transports. That is, as
23054 well as the headers that were received with the message, it also applies to
23055 headers that were added by an ACL or a system filter.
23056
23057
23058 In general, rewriting addresses from your own system or domain has some
23059 legitimacy. Rewriting other addresses should be done only with great care and
23060 in special circumstances. The author of Exim believes that rewriting should be
23061 used sparingly, and mainly for &"regularizing"& addresses in your own domains.
23062 Although it can sometimes be used as a routing tool, this is very strongly
23063 discouraged.
23064
23065 There are two commonly encountered circumstances where rewriting is used, as
23066 illustrated by these examples:
23067
23068 .ilist
23069 The company whose domain is &'hitch.fict.example'& has a number of hosts that
23070 exchange mail with each other behind a firewall, but there is only a single
23071 gateway to the outer world. The gateway rewrites &'*.hitch.fict.example'& as
23072 &'hitch.fict.example'& when sending mail off-site.
23073 .next
23074 A host rewrites the local parts of its own users so that, for example,
23075 &'fp42@hitch.fict.example'& becomes &'Ford.Prefect@hitch.fict.example'&.
23076 .endlist
23077
23078
23079
23080 .section "When does rewriting happen?" "SECID148"
23081 .cindex "rewriting" "timing of"
23082 .cindex "&ACL;" "rewriting addresses in"
23083 Configured address rewriting can take place at several different stages of a
23084 message's processing.
23085
23086 .vindex "&$sender_address$&"
23087 At the start of an ACL for MAIL, the sender address may have been rewritten
23088 by a special SMTP-time rewrite rule (see section &<<SECTrewriteS>>&), but no
23089 ordinary rewrite rules have yet been applied. If, however, the sender address
23090 is verified in the ACL, it is rewritten before verification, and remains
23091 rewritten thereafter. The subsequent value of &$sender_address$& is the
23092 rewritten address. This also applies if sender verification happens in a
23093 RCPT ACL. Otherwise, when the sender address is not verified, it is
23094 rewritten as soon as a message's header lines have been received.
23095
23096 .vindex "&$domain$&"
23097 .vindex "&$local_part$&"
23098 Similarly, at the start of an ACL for RCPT, the current recipient's address
23099 may have been rewritten by a special SMTP-time rewrite rule, but no ordinary
23100 rewrite rules have yet been applied to it. However, the behaviour is different
23101 from the sender address when a recipient is verified. The address is rewritten
23102 for the verification, but the rewriting is not remembered at this stage. The
23103 value of &$local_part$& and &$domain$& after verification are always the same
23104 as they were before (that is, they contain the unrewritten &-- except for
23105 SMTP-time rewriting &-- address).
23106
23107 As soon as a message's header lines have been received, all the envelope
23108 recipient addresses are permanently rewritten, and rewriting is also applied to
23109 the addresses in the header lines (if configured). This happens before adding
23110 any header lines that were specified in MAIL or RCPT ACLs, and
23111 .cindex "&[local_scan()]& function" "address rewriting; timing of"
23112 before the DATA ACL and &[local_scan()]& functions are run.
23113
23114 When an address is being routed, either for delivery or for verification,
23115 rewriting is applied immediately to child addresses that are generated by
23116 redirection, unless &%no_rewrite%& is set on the router.
23117
23118 .cindex "envelope sender" "rewriting at transport time"
23119 .cindex "rewriting" "at transport time"
23120 .cindex "header lines" "rewriting at transport time"
23121 At transport time, additional rewriting of addresses in header lines can be
23122 specified by setting the generic &%headers_rewrite%& option on a transport.
23123 This option contains rules that are identical in form to those in the rewrite
23124 section of the configuration file. They are applied to the original message
23125 header lines and any that were added by ACLs or a system filter. They are not
23126 applied to header lines that are added by routers or the transport.
23127
23128 The outgoing envelope sender can be rewritten by means of the &%return_path%&
23129 transport option. However, it is not possible to rewrite envelope recipients at
23130 transport time.
23131
23132
23133
23134
23135 .section "Testing the rewriting rules that apply on input" "SECID149"
23136 .cindex "rewriting" "testing"
23137 .cindex "testing" "rewriting"
23138 Exim's input rewriting configuration appears in a part of the run time
23139 configuration file headed by &"begin rewrite"&. It can be tested by the
23140 &%-brw%& command line option. This takes an address (which can be a full RFC
23141 2822 address) as its argument. The output is a list of how the address would be
23142 transformed by the rewriting rules for each of the different places it might
23143 appear in an incoming message, that is, for each different header and for the
23144 envelope sender and recipient fields. For example,
23145 .code
23146 exim -brw ph10@exim.workshop.example
23147 .endd
23148 might produce the output
23149 .code
23150 sender: Philip.Hazel@exim.workshop.example
23151 from: Philip.Hazel@exim.workshop.example
23152 to: ph10@exim.workshop.example
23153 cc: ph10@exim.workshop.example
23154 bcc: ph10@exim.workshop.example
23155 reply-to: Philip.Hazel@exim.workshop.example
23156 env-from: Philip.Hazel@exim.workshop.example
23157 env-to: ph10@exim.workshop.example
23158 .endd
23159 which shows that rewriting has been set up for that address when used in any of
23160 the source fields, but not when it appears as a recipient address. At the
23161 present time, there is no equivalent way of testing rewriting rules that are
23162 set for a particular transport.
23163
23164
23165 .section "Rewriting rules" "SECID150"
23166 .cindex "rewriting" "rules"
23167 The rewrite section of the configuration file consists of lines of rewriting
23168 rules in the form
23169 .display
23170 <&'source pattern'&>  <&'replacement'&>  <&'flags'&>
23171 .endd
23172 Rewriting rules that are specified for the &%headers_rewrite%& generic
23173 transport option are given as a colon-separated list. Each item in the list
23174 takes the same form as a line in the main rewriting configuration (except that
23175 any colons must be doubled, of course).
23176
23177 The formats of source patterns and replacement strings are described below.
23178 Each is terminated by white space, unless enclosed in double quotes, in which
23179 case normal quoting conventions apply inside the quotes. The flags are single
23180 characters which may appear in any order. Spaces and tabs between them are
23181 ignored.
23182
23183 For each address that could potentially be rewritten, the rules are scanned in
23184 order, and replacements for the address from earlier rules can themselves be
23185 replaced by later rules (but see the &"q"& and &"R"& flags).
23186
23187 The order in which addresses are rewritten is undefined, may change between
23188 releases, and must not be relied on, with one exception: when a message is
23189 received, the envelope sender is always rewritten first, before any header
23190 lines are rewritten. For example, the replacement string for a rewrite of an
23191 address in &'To:'& must not assume that the message's address in &'From:'& has
23192 (or has not) already been rewritten. However, a rewrite of &'From:'& may assume
23193 that the envelope sender has already been rewritten.
23194
23195 .vindex "&$domain$&"
23196 .vindex "&$local_part$&"
23197 The variables &$local_part$& and &$domain$& can be used in the replacement
23198 string to refer to the address that is being rewritten. Note that lookup-driven
23199 rewriting can be done by a rule of the form
23200 .code
23201 *@*   ${lookup ...
23202 .endd
23203 where the lookup key uses &$1$& and &$2$& or &$local_part$& and &$domain$& to
23204 refer to the address that is being rewritten.
23205
23206
23207 .section "Rewriting patterns" "SECID151"
23208 .cindex "rewriting" "patterns"
23209 .cindex "address list" "in a rewriting pattern"
23210 The source pattern in a rewriting rule is any item which may appear in an
23211 address list (see section &<<SECTaddresslist>>&). It is in fact processed as a
23212 single-item address list, which means that it is expanded before being tested
23213 against the address. As always, if you use a regular expression as a pattern,
23214 you must take care to escape dollar and backslash characters, or use the &`\N`&
23215 facility to suppress string expansion within the regular expression.
23216
23217 Domains in patterns should be given in lower case. Local parts in patterns are
23218 case-sensitive. If you want to do case-insensitive matching of local parts, you
23219 can use a regular expression that starts with &`^(?i)`&.
23220
23221 .cindex "numerical variables (&$1$& &$2$& etc)" "in rewriting rules"
23222 After matching, the numerical variables &$1$&, &$2$&, etc. may be set,
23223 depending on the type of match which occurred. These can be used in the
23224 replacement string to insert portions of the incoming address. &$0$& always
23225 refers to the complete incoming address. When a regular expression is used, the
23226 numerical variables are set from its capturing subexpressions. For other types
23227 of pattern they are set as follows:
23228
23229 .ilist
23230 If a local part or domain starts with an asterisk, the numerical variables
23231 refer to the character strings matched by asterisks, with &$1$& associated with
23232 the first asterisk, and &$2$& with the second, if present. For example, if the
23233 pattern
23234 .code
23235 *queen@*.fict.example
23236 .endd
23237 is matched against the address &'hearts-queen@wonderland.fict.example'& then
23238 .code
23239 $0 = hearts-queen@wonderland.fict.example
23240 $1 = hearts-
23241 $2 = wonderland
23242 .endd
23243 Note that if the local part does not start with an asterisk, but the domain
23244 does, it is &$1$& that contains the wild part of the domain.
23245
23246 .next
23247 If the domain part of the pattern is a partial lookup, the wild and fixed parts
23248 of the domain are placed in the next available numerical variables. Suppose,
23249 for example, that the address &'foo@bar.baz.example'& is processed by a
23250 rewriting rule of the form
23251 .display
23252 &`*@partial-dbm;/some/dbm/file`&    <&'replacement string'&>
23253 .endd
23254 and the key in the file that matches the domain is &`*.baz.example`&. Then
23255 .code
23256 $1 = foo
23257 $2 = bar
23258 $3 = baz.example
23259 .endd
23260 If the address &'foo@baz.example'& is looked up, this matches the same
23261 wildcard file entry, and in this case &$2$& is set to the empty string, but
23262 &$3$& is still set to &'baz.example'&. If a non-wild key is matched in a
23263 partial lookup, &$2$& is again set to the empty string and &$3$& is set to the
23264 whole domain. For non-partial domain lookups, no numerical variables are set.
23265 .endlist
23266
23267
23268 .section "Rewriting replacements" "SECID152"
23269 .cindex "rewriting" "replacements"
23270 If the replacement string for a rule is a single asterisk, addresses that
23271 match the pattern and the flags are &'not'& rewritten, and no subsequent
23272 rewriting rules are scanned. For example,
23273 .code
23274 hatta@lookingglass.fict.example  *  f
23275 .endd
23276 specifies that &'hatta@lookingglass.fict.example'& is never to be rewritten in
23277 &'From:'& headers.
23278
23279 .vindex "&$domain$&"
23280 .vindex "&$local_part$&"
23281 If the replacement string is not a single asterisk, it is expanded, and must
23282 yield a fully qualified address. Within the expansion, the variables
23283 &$local_part$& and &$domain$& refer to the address that is being rewritten.
23284 Any letters they contain retain their original case &-- they are not lower
23285 cased. The numerical variables are set up according to the type of pattern that
23286 matched the address, as described above. If the expansion is forced to fail by
23287 the presence of &"fail"& in a conditional or lookup item, rewriting by the
23288 current rule is abandoned, but subsequent rules may take effect. Any other
23289 expansion failure causes the entire rewriting operation to be abandoned, and an
23290 entry written to the panic log.
23291
23292
23293
23294 .section "Rewriting flags" "SECID153"
23295 There are three different kinds of flag that may appear on rewriting rules:
23296
23297 .ilist
23298 Flags that specify which headers and envelope addresses to rewrite: E, F, T, b,
23299 c, f, h, r, s, t.
23300 .next
23301 A flag that specifies rewriting at SMTP time: S.
23302 .next
23303 Flags that control the rewriting process: Q, q, R, w.
23304 .endlist
23305
23306 For rules that are part of the &%headers_rewrite%& generic transport option,
23307 E, F, T, and S are not permitted.
23308
23309
23310
23311 .section "Flags specifying which headers and envelope addresses to rewrite" &&&
23312          "SECID154"
23313 .cindex "rewriting" "flags"
23314 If none of the following flag letters, nor the &"S"& flag (see section
23315 &<<SECTrewriteS>>&) are present, a main rewriting rule applies to all headers
23316 and to both the sender and recipient fields of the envelope, whereas a
23317 transport-time rewriting rule just applies to all headers. Otherwise, the
23318 rewriting rule is skipped unless the relevant addresses are being processed.
23319 .display
23320 &`E`&       rewrite all envelope fields
23321 &`F`&       rewrite the envelope From field
23322 &`T`&       rewrite the envelope To field
23323 &`b`&       rewrite the &'Bcc:'& header
23324 &`c`&       rewrite the &'Cc:'& header
23325 &`f`&       rewrite the &'From:'& header
23326 &`h`&       rewrite all headers
23327 &`r`&       rewrite the &'Reply-To:'& header
23328 &`s`&       rewrite the &'Sender:'& header
23329 &`t`&       rewrite the &'To:'& header
23330 .endd
23331 "All headers" means all of the headers listed above that can be selected
23332 individually, plus their &'Resent-'& versions. It does not include
23333 other headers such as &'Subject:'& etc.
23334
23335 You should be particularly careful about rewriting &'Sender:'& headers, and
23336 restrict this to special known cases in your own domains.
23337
23338
23339 .section "The SMTP-time rewriting flag" "SECTrewriteS"
23340 .cindex "SMTP" "rewriting malformed addresses"
23341 .cindex "RCPT" "rewriting argument of"
23342 .cindex "MAIL" "rewriting argument of"
23343 The rewrite flag &"S"& specifies a rewrite of incoming envelope addresses at
23344 SMTP time, as soon as an address is received in a MAIL or RCPT command, and
23345 before any other processing; even before syntax checking. The pattern is
23346 required to be a regular expression, and it is matched against the whole of the
23347 data for the command, including any surrounding angle brackets.
23348
23349 .vindex "&$domain$&"
23350 .vindex "&$local_part$&"
23351 This form of rewrite rule allows for the handling of addresses that are not
23352 compliant with RFCs 2821 and 2822 (for example, &"bang paths"& in batched SMTP
23353 input). Because the input is not required to be a syntactically valid address,
23354 the variables &$local_part$& and &$domain$& are not available during the
23355 expansion of the replacement string. The result of rewriting replaces the
23356 original address in the MAIL or RCPT command.
23357
23358
23359 .section "Flags controlling the rewriting process" "SECID155"
23360 There are four flags which control the way the rewriting process works. These
23361 take effect only when a rule is invoked, that is, when the address is of the
23362 correct type (matches the flags) and matches the pattern:
23363
23364 .ilist
23365 If the &"Q"& flag is set on a rule, the rewritten address is permitted to be an
23366 unqualified local part. It is qualified with &%qualify_recipient%&. In the
23367 absence of &"Q"& the rewritten address must always include a domain.
23368 .next
23369 If the &"q"& flag is set on a rule, no further rewriting rules are considered,
23370 even if no rewriting actually takes place because of a &"fail"& in the
23371 expansion. The &"q"& flag is not effective if the address is of the wrong type
23372 (does not match the flags) or does not match the pattern.
23373 .next
23374 The &"R"& flag causes a successful rewriting rule to be re-applied to the new
23375 address, up to ten times. It can be combined with the &"q"& flag, to stop
23376 rewriting once it fails to match (after at least one successful rewrite).
23377 .next
23378 .cindex "rewriting" "whole addresses"
23379 When an address in a header is rewritten, the rewriting normally applies only
23380 to the working part of the address, with any comments and RFC 2822 &"phrase"&
23381 left unchanged. For example, rewriting might change
23382 .code
23383 From: Ford Prefect <fp42@restaurant.hitch.fict.example>
23384 .endd
23385 into
23386 .code
23387 From: Ford Prefect <prefectf@hitch.fict.example>
23388 .endd
23389 .cindex "RFC 2047"
23390 Sometimes there is a need to replace the whole address item, and this can be
23391 done by adding the flag letter &"w"& to a rule. If this is set on a rule that
23392 causes an address in a header line to be rewritten, the entire address is
23393 replaced, not just the working part. The replacement must be a complete RFC
23394 2822 address, including the angle brackets if necessary. If text outside angle
23395 brackets contains a character whose value is greater than 126 or less than 32
23396 (except for tab), the text is encoded according to RFC 2047. The character set
23397 is taken from &%headers_charset%&, which defaults to ISO-8859-1.
23398
23399 When the &"w"& flag is set on a rule that causes an envelope address to be
23400 rewritten, all but the working part of the replacement address is discarded.
23401 .endlist
23402
23403
23404 .section "Rewriting examples" "SECID156"
23405 Here is an example of the two common rewriting paradigms:
23406 .code
23407 *@*.hitch.fict.example  $1@hitch.fict.example
23408 *@hitch.fict.example    ${lookup{$1}dbm{/etc/realnames}\
23409                      {$value}fail}@hitch.fict.example bctfrF
23410 .endd
23411 Note the use of &"fail"& in the lookup expansion in the second rule, forcing
23412 the string expansion to fail if the lookup does not succeed. In this context it
23413 has the effect of leaving the original address unchanged, but Exim goes on to
23414 consider subsequent rewriting rules, if any, because the &"q"& flag is not
23415 present in that rule. An alternative to &"fail"& would be to supply &$1$&
23416 explicitly, which would cause the rewritten address to be the same as before,
23417 at the cost of a small bit of processing. Not supplying either of these is an
23418 error, since the rewritten address would then contain no local part.
23419
23420 The first example above replaces the domain with a superior, more general
23421 domain. This may not be desirable for certain local parts. If the rule
23422 .code
23423 root@*.hitch.fict.example  *
23424 .endd
23425 were inserted before the first rule, rewriting would be suppressed for the
23426 local part &'root'& at any domain ending in &'hitch.fict.example'&.
23427
23428 Rewriting can be made conditional on a number of tests, by making use of
23429 &${if$& in the expansion item. For example, to apply a rewriting rule only to
23430 messages that originate outside the local host:
23431 .code
23432 *@*.hitch.fict.example  "${if !eq {$sender_host_address}{}\
23433                          {$1@hitch.fict.example}fail}"
23434 .endd
23435 The replacement string is quoted in this example because it contains white
23436 space.
23437
23438 .cindex "rewriting" "bang paths"
23439 .cindex "bang paths" "rewriting"
23440 Exim does not handle addresses in the form of &"bang paths"&. If it sees such
23441 an address it treats it as an unqualified local part which it qualifies with
23442 the local qualification domain (if the source of the message is local or if the
23443 remote host is permitted to send unqualified addresses). Rewriting can
23444 sometimes be used to handle simple bang paths with a fixed number of
23445 components. For example, the rule
23446 .code
23447 \N^([^!]+)!(.*)@your.domain.example$\N   $2@$1
23448 .endd
23449 rewrites a two-component bang path &'host.name!user'& as the domain address
23450 &'user@host.name'&. However, there is a security implication in using this as
23451 a global rewriting rule for envelope addresses. It can provide a backdoor
23452 method for using your system as a relay, because the incoming addresses appear
23453 to be local. If the bang path addresses are received via SMTP, it is safer to
23454 use the &"S"& flag to rewrite them as they are received, so that relay checking
23455 can be done on the rewritten addresses.
23456 .ecindex IIDaddrew
23457
23458
23459
23460
23461
23462 . ////////////////////////////////////////////////////////////////////////////
23463 . ////////////////////////////////////////////////////////////////////////////
23464
23465 .chapter "Retry configuration" "CHAPretry"
23466 .scindex IIDretconf1 "retry" "configuration, description of"
23467 .scindex IIDregconf2 "configuration file" "retry section"
23468 The &"retry"& section of the runtime configuration file contains a list of
23469 retry rules that control how often Exim tries to deliver messages that cannot
23470 be delivered at the first attempt. If there are no retry rules (the section is
23471 empty or not present), there are no retries. In this situation, temporary
23472 errors are treated as permanent. The default configuration contains a single,
23473 general-purpose retry rule (see section &<<SECID57>>&). The &%-brt%& command
23474 line option can be used to test which retry rule will be used for a given
23475 address, domain and error.
23476
23477 The most common cause of retries is temporary failure to deliver to a remote
23478 host because the host is down, or inaccessible because of a network problem.
23479 Exim's retry processing in this case is applied on a per-host (strictly, per IP
23480 address) basis, not on a per-message basis. Thus, if one message has recently
23481 been delayed, delivery of a new message to the same host is not immediately
23482 tried, but waits for the host's retry time to arrive. If the &%retry_defer%&
23483 log selector is set, the message
23484 .cindex "retry" "time not reached"
23485 &"retry time not reached"& is written to the main log whenever a delivery is
23486 skipped for this reason. Section &<<SECToutSMTPerr>>& contains more details of
23487 the handling of errors during remote deliveries.
23488
23489 Retry processing applies to routing as well as to delivering, except as covered
23490 in the next paragraph. The retry rules do not distinguish between these
23491 actions. It is not possible, for example, to specify different behaviour for
23492 failures to route the domain &'snark.fict.example'& and failures to deliver to
23493 the host &'snark.fict.example'&. I didn't think anyone would ever need this
23494 added complication, so did not implement it. However, although they share the
23495 same retry rule, the actual retry times for routing and transporting a given
23496 domain are maintained independently.
23497
23498 When a delivery is not part of a queue run (typically an immediate delivery on
23499 receipt of a message), the routers are always run, and local deliveries are
23500 always attempted, even if retry times are set for them. This makes for better
23501 behaviour if one particular message is causing problems (for example, causing
23502 quota overflow, or provoking an error in a filter file). If such a delivery
23503 suffers a temporary failure, the retry data is updated as normal, and
23504 subsequent delivery attempts from queue runs occur only when the retry time for
23505 the local address is reached.
23506
23507 .section "Changing retry rules" "SECID157"
23508 If you change the retry rules in your configuration, you should consider
23509 whether or not to delete the retry data that is stored in Exim's spool area in
23510 files with names like &_db/retry_&. Deleting any of Exim's hints files is
23511 always safe; that is why they are called &"hints"&.
23512
23513 The hints retry data contains suggested retry times based on the previous
23514 rules. In the case of a long-running problem with a remote host, it might
23515 record the fact that the host has timed out. If your new rules increase the
23516 timeout time for such a host, you should definitely remove the old retry data
23517 and let Exim recreate it, based on the new rules. Otherwise Exim might bounce
23518 messages that it should now be retaining.
23519
23520
23521
23522 .section "Format of retry rules" "SECID158"
23523 .cindex "retry" "rules"
23524 Each retry rule occupies one line and consists of three or four parts,
23525 separated by white space: a pattern, an error name, an optional list of sender
23526 addresses, and a list of retry parameters. The pattern and sender lists must be
23527 enclosed in double quotes if they contain white space. The rules are searched
23528 in order until one is found where the pattern, error name, and sender list (if
23529 present) match the failing host or address, the error that occurred, and the
23530 message's sender, respectively.
23531
23532
23533 The pattern is any single item that may appear in an address list (see section
23534 &<<SECTaddresslist>>&). It is in fact processed as a one-item address list,
23535 which means that it is expanded before being tested against the address that
23536 has been delayed. A negated address list item is permitted. Address
23537 list processing treats a plain domain name as if it were preceded by &"*@"&,
23538 which makes it possible for many retry rules to start with just a domain. For
23539 example,
23540 .code
23541 lookingglass.fict.example        *  F,24h,30m;
23542 .endd
23543 provides a rule for any address in the &'lookingglass.fict.example'& domain,
23544 whereas
23545 .code
23546 alice@lookingglass.fict.example  *  F,24h,30m;
23547 .endd
23548 applies only to temporary failures involving the local part &%alice%&.
23549 In practice, almost all rules start with a domain name pattern without a local
23550 part.
23551
23552 .cindex "regular expressions" "in retry rules"
23553 &*Warning*&: If you use a regular expression in a routing rule pattern, it
23554 must match a complete address, not just a domain, because that is how regular
23555 expressions work in address lists.
23556 .display
23557 &`^\Nxyz\d+\.abc\.example$\N        *  G,1h,10m,2`&     &%Wrong%&
23558 &`^\N[^@]+@xyz\d+\.abc\.example$\N  *  G,1h,10m,2`&     &%Right%&
23559 .endd
23560
23561
23562 .section "Choosing which retry rule to use for address errors" "SECID159"
23563 When Exim is looking for a retry rule after a routing attempt has failed (for
23564 example, after a DNS timeout), each line in the retry configuration is tested
23565 against the complete address only if &%retry_use_local_part%& is set for the
23566 router. Otherwise, only the domain is used, except when matching against a
23567 regular expression, when the local part of the address is replaced with &"*"&.
23568 A domain on its own can match a domain pattern, or a pattern that starts with
23569 &"*@"&. By default, &%retry_use_local_part%& is true for routers where
23570 &%check_local_user%& is true, and false for other routers.
23571
23572 Similarly, when Exim is looking for a retry rule after a local delivery has
23573 failed (for example, after a mailbox full error), each line in the retry
23574 configuration is tested against the complete address only if
23575 &%retry_use_local_part%& is set for the transport (it defaults true for all
23576 local transports).
23577
23578 .cindex "4&'xx'& responses" "retry rules for"
23579 However, when Exim is looking for a retry rule after a remote delivery attempt
23580 suffers an address error (a 4&'xx'& SMTP response for a recipient address), the
23581 whole address is always used as the key when searching the retry rules. The
23582 rule that is found is used to create a retry time for the combination of the
23583 failing address and the message's sender. It is the combination of sender and
23584 recipient that is delayed in subsequent queue runs until its retry time is
23585 reached. You can delay the recipient without regard to the sender by setting
23586 &%address_retry_include_sender%& false in the &(smtp)& transport but this can
23587 lead to problems with servers that regularly issue 4&'xx'& responses to RCPT
23588 commands.
23589
23590
23591
23592 .section "Choosing which retry rule to use for host and message errors" &&&
23593          "SECID160"
23594 For a temporary error that is not related to an individual address (for
23595 example, a connection timeout), each line in the retry configuration is checked
23596 twice. First, the name of the remote host is used as a domain name (preceded by
23597 &"*@"& when matching a regular expression). If this does not match the line,
23598 the domain from the email address is tried in a similar fashion. For example,
23599 suppose the MX records for &'a.b.c.example'& are
23600 .code
23601 a.b.c.example  MX  5  x.y.z.example
23602                MX  6  p.q.r.example
23603                MX  7  m.n.o.example
23604 .endd
23605 and the retry rules are
23606 .code
23607 p.q.r.example    *      F,24h,30m;
23608 a.b.c.example    *      F,4d,45m;
23609 .endd
23610 and a delivery to the host &'x.y.z.example'& suffers a connection failure. The
23611 first rule matches neither the host nor the domain, so Exim looks at the second
23612 rule. This does not match the host, but it does match the domain, so it is used
23613 to calculate the retry time for the host &'x.y.z.example'&. Meanwhile, Exim
23614 tries to deliver to &'p.q.r.example'&. If this also suffers a host error, the
23615 first retry rule is used, because it matches the host.
23616
23617 In other words, temporary failures to deliver to host &'p.q.r.example'& use the
23618 first rule to determine retry times, but for all the other hosts for the domain
23619 &'a.b.c.example'&, the second rule is used. The second rule is also used if
23620 routing to &'a.b.c.example'& suffers a temporary failure.
23621
23622 &*Note*&: The host name is used when matching the patterns, not its IP address.
23623 However, if a message is routed directly to an IP address without the use of a
23624 host name, for example, if a &(manualroute)& router contains a setting such as:
23625 .code
23626 route_list = *.a.example  192.168.34.23
23627 .endd
23628 then the &"host name"& that is used when searching for a retry rule is the
23629 textual form of the IP address.
23630
23631 .section "Retry rules for specific errors" "SECID161"
23632 .cindex "retry" "specific errors; specifying"
23633 The second field in a retry rule is the name of a particular error, or an
23634 asterisk, which matches any error. The errors that can be tested for are:
23635
23636 .vlist
23637 .vitem &%auth_failed%&
23638 Authentication failed when trying to send to a host in the
23639 &%hosts_require_auth%& list in an &(smtp)& transport.
23640
23641 .vitem &%data_4xx%&
23642 A 4&'xx'& error was received for an outgoing DATA command, either immediately
23643 after the command, or after sending the message's data.
23644
23645 .vitem &%mail_4xx%&
23646 A 4&'xx'& error was received for an outgoing MAIL command.
23647
23648 .vitem &%rcpt_4xx%&
23649 A 4&'xx'& error was received for an outgoing RCPT command.
23650 .endlist
23651
23652 For the three 4&'xx'& errors, either the first or both of the x's can be given
23653 as specific digits, for example: &`mail_45x`& or &`rcpt_436`&. For example, to
23654 recognize 452 errors given to RCPT commands for addresses in a certain domain,
23655 and have retries every ten minutes with a one-hour timeout, you could set up a
23656 retry rule of this form:
23657 .code
23658 the.domain.name  rcpt_452   F,1h,10m
23659 .endd
23660 These errors apply to both outgoing SMTP (the &(smtp)& transport) and outgoing
23661 LMTP (either the &(lmtp)& transport, or the &(smtp)& transport in LMTP mode).
23662
23663 .vlist
23664 .vitem &%lost_connection%&
23665 A server unexpectedly closed the SMTP connection. There may, of course,
23666 legitimate reasons for this (host died, network died), but if it repeats a lot
23667 for the same host, it indicates something odd.
23668
23669 .vitem &%refused_MX%&
23670 A connection to a host obtained from an MX record was refused.
23671
23672 .vitem &%refused_A%&
23673 A connection to a host not obtained from an MX record was refused.
23674
23675 .vitem &%refused%&
23676 A connection was refused.
23677
23678 .vitem &%timeout_connect_MX%&
23679 A connection attempt to a host obtained from an MX record timed out.
23680
23681 .vitem &%timeout_connect_A%&
23682 A connection attempt to a host not obtained from an MX record timed out.
23683
23684 .vitem &%timeout_connect%&
23685 A connection attempt timed out.
23686
23687 .vitem &%timeout_MX%&
23688 There was a timeout while connecting or during an SMTP session with a host
23689 obtained from an MX record.
23690
23691 .vitem &%timeout_A%&
23692 There was a timeout while connecting or during an SMTP session with a host not
23693 obtained from an MX record.
23694
23695 .vitem &%timeout%&
23696 There was a timeout while connecting or during an SMTP session.
23697
23698 .vitem &%tls_required%&
23699 The server was required to use TLS (it matched &%hosts_require_tls%& in the
23700 &(smtp)& transport), but either did not offer TLS, or it responded with 4&'xx'&
23701 to STARTTLS, or there was a problem setting up the TLS connection.
23702
23703 .vitem &%quota%&
23704 A mailbox quota was exceeded in a local delivery by the &(appendfile)&
23705 transport.
23706
23707 .vitem &%quota_%&<&'time'&>
23708 .cindex "quota" "error testing in retry rule"
23709 .cindex "retry" "quota error testing"
23710 A mailbox quota was exceeded in a local delivery by the &(appendfile)&
23711 transport, and the mailbox has not been accessed for <&'time'&>. For example,
23712 &'quota_4d'& applies to a quota error when the mailbox has not been accessed
23713 for four days.
23714 .endlist
23715
23716 .cindex "mailbox" "time of last read"
23717 The idea of &%quota_%&<&'time'&> is to make it possible to have shorter
23718 timeouts when the mailbox is full and is not being read by its owner. Ideally,
23719 it should be based on the last time that the user accessed the mailbox.
23720 However, it is not always possible to determine this. Exim uses the following
23721 heuristic rules:
23722
23723 .ilist
23724 If the mailbox is a single file, the time of last access (the &"atime"&) is
23725 used. As no new messages are being delivered (because the mailbox is over
23726 quota), Exim does not access the file, so this is the time of last user access.
23727 .next
23728 .cindex "maildir format" "time of last read"
23729 For a maildir delivery, the time of last modification of the &_new_&
23730 subdirectory is used. As the mailbox is over quota, no new files are created in
23731 the &_new_& subdirectory, because no new messages are being delivered. Any
23732 change to the &_new_& subdirectory is therefore assumed to be the result of an
23733 MUA moving a new message to the &_cur_& directory when it is first read. The
23734 time that is used is therefore the last time that the user read a new message.
23735 .next
23736 For other kinds of multi-file mailbox, the time of last access cannot be
23737 obtained, so a retry rule that uses this type of error field is never matched.
23738 .endlist
23739
23740 The quota errors apply both to system-enforced quotas and to Exim's own quota
23741 mechanism in the &(appendfile)& transport. The &'quota'& error also applies
23742 when a local delivery is deferred because a partition is full (the ENOSPC
23743 error).
23744
23745
23746
23747 .section "Retry rules for specified senders" "SECID162"
23748 .cindex "retry" "rules; sender-specific"
23749 You can specify retry rules that apply only when the failing message has a
23750 specific sender. In particular, this can be used to define retry rules that
23751 apply only to bounce messages. The third item in a retry rule can be of this
23752 form:
23753 .display
23754 &`senders=`&<&'address list'&>
23755 .endd
23756 The retry timings themselves are then the fourth item. For example:
23757 .code
23758 *   rcpt_4xx   senders=:   F,1h,30m
23759 .endd
23760 matches recipient 4&'xx'& errors for bounce messages sent to any address at any
23761 host. If the address list contains white space, it must be enclosed in quotes.
23762 For example:
23763 .code
23764 a.domain  rcpt_452  senders="xb.dom : yc.dom"  G,8h,10m,1.5
23765 .endd
23766 &*Warning*&: This facility can be unhelpful if it is used for host errors
23767 (which do not depend on the recipient). The reason is that the sender is used
23768 only to match the retry rule. Once the rule has been found for a host error,
23769 its contents are used to set a retry time for the host, and this will apply to
23770 all messages, not just those with specific senders.
23771
23772 When testing retry rules using &%-brt%&, you can supply a sender using the
23773 &%-f%& command line option, like this:
23774 .code
23775 exim -f "" -brt user@dom.ain
23776 .endd
23777 If you do not set &%-f%& with &%-brt%&, a retry rule that contains a senders
23778 list is never matched.
23779
23780
23781
23782
23783
23784 .section "Retry parameters" "SECID163"
23785 .cindex "retry" "parameters in rules"
23786 The third (or fourth, if a senders list is present) field in a retry rule is a
23787 sequence of retry parameter sets, separated by semicolons. Each set consists of
23788 .display
23789 <&'letter'&>,<&'cutoff time'&>,<&'arguments'&>
23790 .endd
23791 The letter identifies the algorithm for computing a new retry time; the cutoff
23792 time is the time beyond which this algorithm no longer applies, and the
23793 arguments vary the algorithm's action. The cutoff time is measured from the
23794 time that the first failure for the domain (combined with the local part if
23795 relevant) was detected, not from the time the message was received.
23796
23797 .cindex "retry" "algorithms"
23798 .cindex "retry" "fixed intervals"
23799 .cindex "retry" "increasing intervals"
23800 .cindex "retry" "random intervals"
23801 The available algorithms are:
23802
23803 .ilist
23804 &'F'&: retry at fixed intervals. There is a single time parameter specifying
23805 the interval.
23806 .next
23807 &'G'&: retry at geometrically increasing intervals. The first argument
23808 specifies a starting value for the interval, and the second a multiplier, which
23809 is used to increase the size of the interval at each retry.
23810 .next
23811 &'H'&: retry at randomized intervals. The arguments are as for &'G'&. For each
23812 retry, the previous interval is multiplied by the factor in order to get a
23813 maximum for the next interval. The minimum interval is the first argument of
23814 the parameter, and an actual interval is chosen randomly between them. Such a
23815 rule has been found to be helpful in cluster configurations when all the
23816 members of the cluster restart at once, and may therefore synchronize their
23817 queue processing times.
23818 .endlist
23819
23820 When computing the next retry time, the algorithm definitions are scanned in
23821 order until one whose cutoff time has not yet passed is reached. This is then
23822 used to compute a new retry time that is later than the current time. In the
23823 case of fixed interval retries, this simply means adding the interval to the
23824 current time. For geometrically increasing intervals, retry intervals are
23825 computed from the rule's parameters until one that is greater than the previous
23826 interval is found. The main configuration variable
23827 .cindex "limit" "retry interval"
23828 .cindex "retry" "interval, maximum"
23829 .oindex "&%retry_interval_max%&"
23830 &%retry_interval_max%& limits the maximum interval between retries. It
23831 cannot be set greater than &`24h`&, which is its default value.
23832
23833 A single remote domain may have a number of hosts associated with it, and each
23834 host may have more than one IP address. Retry algorithms are selected on the
23835 basis of the domain name, but are applied to each IP address independently. If,
23836 for example, a host has two IP addresses and one is unusable, Exim will
23837 generate retry times for it and will not try to use it until its next retry
23838 time comes. Thus the good IP address is likely to be tried first most of the
23839 time.
23840
23841 .cindex "hints database" "use for retrying"
23842 Retry times are hints rather than promises. Exim does not make any attempt to
23843 run deliveries exactly at the computed times. Instead, a queue runner process
23844 starts delivery processes for delayed messages periodically, and these attempt
23845 new deliveries only for those addresses that have passed their next retry time.
23846 If a new message arrives for a deferred address, an immediate delivery attempt
23847 occurs only if the address has passed its retry time. In the absence of new
23848 messages, the minimum time between retries is the interval between queue runner
23849 processes. There is not much point in setting retry times of five minutes if
23850 your queue runners happen only once an hour, unless there are a significant
23851 number of incoming messages (which might be the case on a system that is
23852 sending everything to a smart host, for example).
23853
23854 The data in the retry hints database can be inspected by using the
23855 &'exim_dumpdb'& or &'exim_fixdb'& utility programs (see chapter
23856 &<<CHAPutils>>&). The latter utility can also be used to change the data. The
23857 &'exinext'& utility script can be used to find out what the next retry times
23858 are for the hosts associated with a particular mail domain, and also for local
23859 deliveries that have been deferred.
23860
23861
23862 .section "Retry rule examples" "SECID164"
23863 Here are some example retry rules:
23864 .code
23865 alice@wonderland.fict.example quota_5d  F,7d,3h
23866 wonderland.fict.example       quota_5d
23867 wonderland.fict.example       *         F,1h,15m; G,2d,1h,2;
23868 lookingglass.fict.example     *         F,24h,30m;
23869 *                 refused_A   F,2h,20m;
23870 *                 *           F,2h,15m; G,16h,1h,1.5; F,5d,8h
23871 .endd
23872 The first rule sets up special handling for mail to
23873 &'alice@wonderland.fict.example'& when there is an over-quota error and the
23874 mailbox has not been read for at least 5 days. Retries continue every three
23875 hours for 7 days. The second rule handles over-quota errors for all other local
23876 parts at &'wonderland.fict.example'&; the absence of a local part has the same
23877 effect as supplying &"*@"&. As no retry algorithms are supplied, messages that
23878 fail are bounced immediately if the mailbox has not been read for at least 5
23879 days.
23880
23881 The third rule handles all other errors at &'wonderland.fict.example'&; retries
23882 happen every 15 minutes for an hour, then with geometrically increasing
23883 intervals until two days have passed since a delivery first failed. After the
23884 first hour there is a delay of one hour, then two hours, then four hours, and
23885 so on (this is a rather extreme example).
23886
23887 The fourth rule controls retries for the domain &'lookingglass.fict.example'&.
23888 They happen every 30 minutes for 24 hours only. The remaining two rules handle
23889 all other domains, with special action for connection refusal from hosts that
23890 were not obtained from an MX record.
23891
23892 The final rule in a retry configuration should always have asterisks in the
23893 first two fields so as to provide a general catch-all for any addresses that do
23894 not have their own special handling. This example tries every 15 minutes for 2
23895 hours, then with intervals starting at one hour and increasing by a factor of
23896 1.5 up to 16 hours, then every 8 hours up to 5 days.
23897
23898
23899
23900 .section "Timeout of retry data" "SECID165"
23901 .cindex "timeout" "of retry data"
23902 .oindex "&%retry_data_expire%&"
23903 .cindex "hints database" "data expiry"
23904 .cindex "retry" "timeout of data"
23905 Exim timestamps the data that it writes to its retry hints database. When it
23906 consults the data during a delivery it ignores any that is older than the value
23907 set in &%retry_data_expire%& (default 7 days). If, for example, a host hasn't
23908 been tried for 7 days, Exim will try to deliver to it immediately a message
23909 arrives, and if that fails, it will calculate a retry time as if it were
23910 failing for the first time.
23911
23912 This improves the behaviour for messages routed to rarely-used hosts such as MX
23913 backups. If such a host was down at one time, and happens to be down again when
23914 Exim tries a month later, using the old retry data would imply that it had been
23915 down all the time, which is not a justified assumption.
23916
23917 If a host really is permanently dead, this behaviour causes a burst of retries
23918 every now and again, but only if messages routed to it are rare. If there is a
23919 message at least once every 7 days the retry data never expires.
23920
23921
23922
23923
23924 .section "Long-term failures" "SECID166"
23925 .cindex "delivery failure, long-term"
23926 .cindex "retry" "after long-term failure"
23927 Special processing happens when an email address has been failing for so long
23928 that the cutoff time for the last algorithm is reached. For example, using the
23929 default retry rule:
23930 .code
23931 * * F,2h,15m; G,16h,1h,1.5; F,4d,6h
23932 .endd
23933 the cutoff time is four days. Reaching the retry cutoff is independent of how
23934 long any specific message has been failing; it is the length of continuous
23935 failure for the recipient address that counts.
23936
23937 When the cutoff time is reached for a local delivery, or for all the IP
23938 addresses associated with a remote delivery, a subsequent delivery failure
23939 causes Exim to give up on the address, and a bounce message is generated.
23940 In order to cater for new messages that use the failing address, a next retry
23941 time is still computed from the final algorithm, and is used as follows:
23942
23943 For local deliveries, one delivery attempt is always made for any subsequent
23944 messages. If this delivery fails, the address fails immediately. The
23945 post-cutoff retry time is not used.
23946
23947 If the delivery is remote, there are two possibilities, controlled by the
23948 .oindex "&%delay_after_cutoff%&"
23949 &%delay_after_cutoff%& option of the &(smtp)& transport. The option is true by
23950 default. Until the post-cutoff retry time for one of the IP addresses is
23951 reached, the failing email address is bounced immediately, without a delivery
23952 attempt taking place. After that time, one new delivery attempt is made to
23953 those IP addresses that are past their retry times, and if that still fails,
23954 the address is bounced and new retry times are computed.
23955
23956 In other words, when all the hosts for a given email address have been failing
23957 for a long time, Exim bounces rather then defers until one of the hosts' retry
23958 times is reached. Then it tries once, and bounces if that attempt fails. This
23959 behaviour ensures that few resources are wasted in repeatedly trying to deliver
23960 to a broken destination, but if the host does recover, Exim will eventually
23961 notice.
23962
23963 If &%delay_after_cutoff%& is set false, Exim behaves differently. If all IP
23964 addresses are past their final cutoff time, Exim tries to deliver to those IP
23965 addresses that have not been tried since the message arrived. If there are
23966 no suitable IP addresses, or if they all fail, the address is bounced. In other
23967 words, it does not delay when a new message arrives, but tries the expired
23968 addresses immediately, unless they have been tried since the message arrived.
23969 If there is a continuous stream of messages for the failing domains, setting
23970 &%delay_after_cutoff%& false means that there will be many more attempts to
23971 deliver to permanently failing IP addresses than when &%delay_after_cutoff%& is
23972 true.
23973
23974 .section "Deliveries that work intermittently" "SECID167"
23975 .cindex "retry" "intermittently working deliveries"
23976 Some additional logic is needed to cope with cases where a host is
23977 intermittently available, or when a message has some attribute that prevents
23978 its delivery when others to the same address get through. In this situation,
23979 because some messages are successfully delivered, the &"retry clock"& for the
23980 host or address keeps getting reset by the successful deliveries, and so
23981 failing messages remain on the queue for ever because the cutoff time is never
23982 reached.
23983
23984 Two exceptional actions are applied to prevent this happening. The first
23985 applies to errors that are related to a message rather than a remote host.
23986 Section &<<SECToutSMTPerr>>& has a discussion of the different kinds of error;
23987 examples of message-related errors are 4&'xx'& responses to MAIL or DATA
23988 commands, and quota failures. For this type of error, if a message's arrival
23989 time is earlier than the &"first failed"& time for the error, the earlier time
23990 is used when scanning the retry rules to decide when to try next and when to
23991 time out the address.
23992
23993 The exceptional second action applies in all cases. If a message has been on
23994 the queue for longer than the cutoff time of any applicable retry rule for a
23995 given address, a delivery is attempted for that address, even if it is not yet
23996 time, and if this delivery fails, the address is timed out. A new retry time is
23997 not computed in this case, so that other messages for the same address are
23998 considered immediately.
23999 .ecindex IIDretconf1
24000 .ecindex IIDregconf2
24001
24002
24003
24004
24005
24006
24007 . ////////////////////////////////////////////////////////////////////////////
24008 . ////////////////////////////////////////////////////////////////////////////
24009
24010 .chapter "SMTP authentication" "CHAPSMTPAUTH"
24011 .scindex IIDauthconf1 "SMTP" "authentication configuration"
24012 .scindex IIDauthconf2 "authentication"
24013 The &"authenticators"& section of Exim's run time configuration is concerned
24014 with SMTP authentication. This facility is an extension to the SMTP protocol,
24015 described in RFC 2554, which allows a client SMTP host to authenticate itself
24016 to a server. This is a common way for a server to recognize clients that are
24017 permitted to use it as a relay. SMTP authentication is not of relevance to the
24018 transfer of mail between servers that have no managerial connection with each
24019 other.
24020
24021 .cindex "AUTH" "description of"
24022 Very briefly, the way SMTP authentication works is as follows:
24023
24024 .ilist
24025 The server advertises a number of authentication &'mechanisms'& in response to
24026 the client's EHLO command.
24027 .next
24028 The client issues an AUTH command, naming a specific mechanism. The command
24029 may, optionally, contain some authentication data.
24030 .next
24031 The server may issue one or more &'challenges'&, to which the client must send
24032 appropriate responses. In simple authentication mechanisms, the challenges are
24033 just prompts for user names and passwords. The server does not have to issue
24034 any challenges &-- in some mechanisms the relevant data may all be transmitted
24035 with the AUTH command.
24036 .next
24037 The server either accepts or denies authentication.
24038 .next
24039 If authentication succeeds, the client may optionally make use of the AUTH
24040 option on the MAIL command to pass an authenticated sender in subsequent
24041 mail transactions. Authentication lasts for the remainder of the SMTP
24042 connection.
24043 .next
24044 If authentication fails, the client may give up, or it may try a different
24045 authentication mechanism, or it may try transferring mail over the
24046 unauthenticated connection.
24047 .endlist
24048
24049 If you are setting up a client, and want to know which authentication
24050 mechanisms the server supports, you can use Telnet to connect to port 25 (the
24051 SMTP port) on the server, and issue an EHLO command. The response to this
24052 includes the list of supported mechanisms. For example:
24053 .display
24054 &`$ `&&*&`telnet server.example 25`&*&
24055 &`Trying 192.168.34.25...`&
24056 &`Connected to server.example.`&
24057 &`Escape character is &#x0027;^]&#x0027;.`&
24058 &`220 server.example ESMTP Exim 4.20 ...`&
24059 &*&`ehlo client.example`&*&
24060 &`250-server.example Hello client.example [10.8.4.5]`&
24061 &`250-SIZE 52428800`&
24062 &`250-PIPELINING`&
24063 &`250-AUTH PLAIN`&
24064 &`250 HELP`&
24065 .endd
24066 The second-last line of this example output shows that the server supports
24067 authentication using the PLAIN mechanism. In Exim, the different authentication
24068 mechanisms are configured by specifying &'authenticator'& drivers. Like the
24069 routers and transports, which authenticators are included in the binary is
24070 controlled by build-time definitions. The following are currently available,
24071 included by setting
24072 .code
24073 AUTH_CRAM_MD5=yes
24074 AUTH_CYRUS_SASL=yes
24075 AUTH_DOVECOT=yes
24076 AUTH_GSASL=yes
24077 AUTH_HEIMDAL_GSSAPI=yes
24078 AUTH_PLAINTEXT=yes
24079 AUTH_SPA=yes
24080 .endd
24081 in &_Local/Makefile_&, respectively. The first of these supports the CRAM-MD5
24082 authentication mechanism (RFC 2195), and the second provides an interface to
24083 the Cyrus SASL authentication library.
24084 The third is an interface to Dovecot's authentication system, delegating the
24085 work via a socket interface.
24086 The fourth provides an interface to the GNU SASL authentication library, which
24087 provides mechanisms but typically not data sources.
24088 The fifth provides direct access to Heimdal GSSAPI, geared for Kerberos, but
24089 supporting setting a server keytab.
24090 The sixth can be configured to support
24091 the PLAIN authentication mechanism (RFC 2595) or the LOGIN mechanism, which is
24092 not formally documented, but used by several MUAs. The seventh authenticator
24093 supports Microsoft's &'Secure Password Authentication'& mechanism.
24094
24095 The authenticators are configured using the same syntax as other drivers (see
24096 section &<<SECTfordricon>>&). If no authenticators are required, no
24097 authentication section need be present in the configuration file. Each
24098 authenticator can in principle have both server and client functions. When Exim
24099 is receiving SMTP mail, it is acting as a server; when it is sending out
24100 messages over SMTP, it is acting as a client. Authenticator configuration
24101 options are provided for use in both these circumstances.
24102
24103 To make it clear which options apply to which situation, the prefixes
24104 &%server_%& and &%client_%& are used on option names that are specific to
24105 either the server or the client function, respectively. Server and client
24106 functions are disabled if none of their options are set. If an authenticator is
24107 to be used for both server and client functions, a single definition, using
24108 both sets of options, is required. For example:
24109 .code
24110 cram:
24111   driver = cram_md5
24112   public_name = CRAM-MD5
24113   server_secret = ${if eq{$auth1}{ph10}{secret1}fail}
24114   client_name = ph10
24115   client_secret = secret2
24116 .endd
24117 The &%server_%& option is used when Exim is acting as a server, and the
24118 &%client_%& options when it is acting as a client.
24119
24120 Descriptions of the individual authenticators are given in subsequent chapters.
24121 The remainder of this chapter covers the generic options for the
24122 authenticators, followed by general discussion of the way authentication works
24123 in Exim.
24124
24125 &*Beware:*& the meaning of &$auth1$&, &$auth2$&, ... varies on a per-driver and
24126 per-mechanism basis.  Please read carefully to determine which variables hold
24127 account labels such as usercodes and which hold passwords or other
24128 authenticating data.
24129
24130 Note that some mechanisms support two different identifiers for accounts: the
24131 &'authentication id'& and the &'authorization id'&.  The contractions &'authn'&
24132 and &'authz'& are commonly encountered.  The American spelling is standard here.
24133 Conceptually, authentication data such as passwords are tied to the identifier
24134 used to authenticate; servers may have rules to permit one user to act as a
24135 second user, so that after login the session is treated as though that second
24136 user had logged in.  That second user is the &'authorization id'&.  A robust
24137 configuration might confirm that the &'authz'& field is empty or matches the
24138 &'authn'& field.  Often this is just ignored.  The &'authn'& can be considered
24139 as verified data, the &'authz'& as an unverified request which the server might
24140 choose to honour.
24141
24142 A &'realm'& is a text string, typically a domain name, presented by a server
24143 to a client to help it select an account and credentials to use.  In some
24144 mechanisms, the client and server provably agree on the realm, but clients
24145 typically can not treat the realm as secure data to be blindly trusted.
24146
24147
24148
24149 .section "Generic options for authenticators" "SECID168"
24150 .cindex "authentication" "generic options"
24151 .cindex "options" "generic; for authenticators"
24152
24153 .option client_condition authenticators string&!! unset
24154 When Exim is authenticating as a client, it skips any authenticator whose
24155 &%client_condition%& expansion yields &"0"&, &"no"&, or &"false"&. This can be
24156 used, for example, to skip plain text authenticators when the connection is not
24157 encrypted by a setting such as:
24158 .code
24159 client_condition = ${if !eq{$tls_out_cipher}{}}
24160 .endd
24161
24162
24163 .option client_set_id authenticators string&!! unset
24164 When client authentication succeeds, this condition is expanded; the
24165 result is used in the log lines for outbound messasges.
24166 Typically it will be the user name used for authentication.
24167
24168
24169 .option driver authenticators string unset
24170 This option must always be set. It specifies which of the available
24171 authenticators is to be used.
24172
24173
24174 .option public_name authenticators string unset
24175 This option specifies the name of the authentication mechanism that the driver
24176 implements, and by which it is known to the outside world. These names should
24177 contain only upper case letters, digits, underscores, and hyphens (RFC 2222),
24178 but Exim in fact matches them caselessly. If &%public_name%& is not set, it
24179 defaults to the driver's instance name.
24180
24181
24182 .option server_advertise_condition authenticators string&!! unset
24183 When a server is about to advertise an authentication mechanism, the condition
24184 is expanded. If it yields the empty string, &"0"&, &"no"&, or &"false"&, the
24185 mechanism is not advertised.
24186 If the expansion fails, the mechanism is not advertised. If the failure was not
24187 forced, and was not caused by a lookup defer, the incident is logged.
24188 See section &<<SECTauthexiser>>& below for further discussion.
24189
24190
24191 .option server_condition authenticators string&!! unset
24192 This option must be set for a &%plaintext%& server authenticator, where it
24193 is used directly to control authentication. See section &<<SECTplainserver>>&
24194 for details.
24195
24196 For the &(gsasl)& authenticator, this option is required for various
24197 mechanisms; see chapter &<<CHAPgsasl>>& for details.
24198
24199 For the other authenticators, &%server_condition%& can be used as an additional
24200 authentication or authorization mechanism that is applied after the other
24201 authenticator conditions succeed. If it is set, it is expanded when the
24202 authenticator would otherwise return a success code. If the expansion is forced
24203 to fail, authentication fails. Any other expansion failure causes a temporary
24204 error code to be returned. If the result of a successful expansion is an empty
24205 string, &"0"&, &"no"&, or &"false"&, authentication fails. If the result of the
24206 expansion is &"1"&, &"yes"&, or &"true"&, authentication succeeds. For any
24207 other result, a temporary error code is returned, with the expanded string as
24208 the error text.
24209
24210
24211 .option server_debug_print authenticators string&!! unset
24212 If this option is set and authentication debugging is enabled (see the &%-d%&
24213 command line option), the string is expanded and included in the debugging
24214 output when the authenticator is run as a server. This can help with checking
24215 out the values of variables.
24216 If expansion of the string fails, the error message is written to the debugging
24217 output, and Exim carries on processing.
24218
24219
24220 .option server_set_id authenticators string&!! unset
24221 .vindex "&$authenticated_id$&"
24222 When an Exim server successfully authenticates a client, this string is
24223 expanded using data from the authentication, and preserved for any incoming
24224 messages in the variable &$authenticated_id$&. It is also included in the log
24225 lines for incoming messages. For example, a user/password authenticator
24226 configuration might preserve the user name that was used to authenticate, and
24227 refer to it subsequently during delivery of the message.
24228 If expansion fails, the option is ignored.
24229
24230
24231 .option server_mail_auth_condition authenticators string&!! unset
24232 This option allows a server to discard authenticated sender addresses supplied
24233 as part of MAIL commands in SMTP connections that are authenticated by the
24234 driver on which &%server_mail_auth_condition%& is set. The option is not used
24235 as part of the authentication process; instead its (unexpanded) value is
24236 remembered for later use.
24237 How it is used is described in the following section.
24238
24239
24240
24241
24242
24243 .section "The AUTH parameter on MAIL commands" "SECTauthparamail"
24244 .cindex "authentication" "sender; authenticated"
24245 .cindex "AUTH" "on MAIL command"
24246 When a client supplied an AUTH= item on a MAIL command, Exim applies
24247 the following checks before accepting it as the authenticated sender of the
24248 message:
24249
24250 .ilist
24251 If the connection is not using extended SMTP (that is, HELO was used rather
24252 than EHLO), the use of AUTH= is a syntax error.
24253 .next
24254 If the value of the AUTH= parameter is &"<>"&, it is ignored.
24255 .next
24256 .vindex "&$authenticated_sender$&"
24257 If &%acl_smtp_mailauth%& is defined, the ACL it specifies is run. While it is
24258 running, the value of &$authenticated_sender$& is set to the value obtained
24259 from the AUTH= parameter. If the ACL does not yield &"accept"&, the value of
24260 &$authenticated_sender$& is deleted. The &%acl_smtp_mailauth%& ACL may not
24261 return &"drop"& or &"discard"&. If it defers, a temporary error code (451) is
24262 given for the MAIL command.
24263 .next
24264 If &%acl_smtp_mailauth%& is not defined, the value of the AUTH= parameter
24265 is accepted and placed in &$authenticated_sender$& only if the client has
24266 authenticated.
24267 .next
24268 If the AUTH= value was accepted by either of the two previous rules, and
24269 the client has authenticated, and the authenticator has a setting for the
24270 &%server_mail_auth_condition%&, the condition is checked at this point. The
24271 valued that was saved from the authenticator is expanded. If the expansion
24272 fails, or yields an empty string, &"0"&, &"no"&, or &"false"&, the value of
24273 &$authenticated_sender$& is deleted. If the expansion yields any other value,
24274 the value of &$authenticated_sender$& is retained and passed on with the
24275 message.
24276 .endlist
24277
24278
24279 When &$authenticated_sender$& is set for a message, it is passed on to other
24280 hosts to which Exim authenticates as a client. Do not confuse this value with
24281 &$authenticated_id$&, which is a string obtained from the authentication
24282 process, and which is not usually a complete email address.
24283
24284 .vindex "&$sender_address$&"
24285 Whenever an AUTH= value is ignored, the incident is logged. The ACL for
24286 MAIL, if defined, is run after AUTH= is accepted or ignored. It can
24287 therefore make use of &$authenticated_sender$&. The converse is not true: the
24288 value of &$sender_address$& is not yet set up when the &%acl_smtp_mailauth%&
24289 ACL is run.
24290
24291
24292
24293 .section "Authentication on an Exim server" "SECTauthexiser"
24294 .cindex "authentication" "on an Exim server"
24295 When Exim receives an EHLO command, it advertises the public names of those
24296 authenticators that are configured as servers, subject to the following
24297 conditions:
24298
24299 .ilist
24300 The client host must match &%auth_advertise_hosts%& (default *).
24301 .next
24302 It the &%server_advertise_condition%& option is set, its expansion must not
24303 yield the empty string, &"0"&, &"no"&, or &"false"&.
24304 .endlist
24305
24306 The order in which the authenticators are defined controls the order in which
24307 the mechanisms are advertised.
24308
24309 Some mail clients (for example, some versions of Netscape) require the user to
24310 provide a name and password for authentication whenever AUTH is advertised,
24311 even though authentication may not in fact be needed (for example, Exim may be
24312 set up to allow unconditional relaying from the client by an IP address check).
24313 You can make such clients more friendly by not advertising AUTH to them.
24314 For example, if clients on the 10.9.8.0/24 network are permitted (by the ACL
24315 that runs for RCPT) to relay without authentication, you should set
24316 .code
24317 auth_advertise_hosts = ! 10.9.8.0/24
24318 .endd
24319 so that no authentication mechanisms are advertised to them.
24320
24321 The &%server_advertise_condition%& controls the advertisement of individual
24322 authentication mechanisms. For example, it can be used to restrict the
24323 advertisement of a particular mechanism to encrypted connections, by a setting
24324 such as:
24325 .code
24326 server_advertise_condition = ${if eq{$tls_in_cipher}{}{no}{yes}}
24327 .endd
24328 .vindex "&$tls_in_cipher$&"
24329 If the session is encrypted, &$tls_in_cipher$& is not empty, and so the expansion
24330 yields &"yes"&, which allows the advertisement to happen.
24331
24332 When an Exim server receives an AUTH command from a client, it rejects it
24333 immediately if AUTH was not advertised in response to an earlier EHLO
24334 command. This is the case if
24335
24336 .ilist
24337 The client host does not match &%auth_advertise_hosts%&; or
24338 .next
24339 No authenticators are configured with server options; or
24340 .next
24341 Expansion of &%server_advertise_condition%& blocked the advertising of all the
24342 server authenticators.
24343 .endlist
24344
24345
24346 Otherwise, Exim runs the ACL specified by &%acl_smtp_auth%& in order
24347 to decide whether to accept the command. If &%acl_smtp_auth%& is not set,
24348 AUTH is accepted from any client host.
24349
24350 If AUTH is not rejected by the ACL, Exim searches its configuration for a
24351 server authentication mechanism that was advertised in response to EHLO and
24352 that matches the one named in the AUTH command. If it finds one, it runs
24353 the appropriate authentication protocol, and authentication either succeeds or
24354 fails. If there is no matching advertised mechanism, the AUTH command is
24355 rejected with a 504 error.
24356
24357 .vindex "&$received_protocol$&"
24358 .vindex "&$sender_host_authenticated$&"
24359 When a message is received from an authenticated host, the value of
24360 &$received_protocol$& is set to &"esmtpa"& or &"esmtpsa"& instead of &"esmtp"&
24361 or &"esmtps"&, and &$sender_host_authenticated$& contains the name (not the
24362 public name) of the authenticator driver that successfully authenticated the
24363 client from which the message was received. This variable is empty if there was
24364 no successful authentication.
24365
24366
24367
24368
24369 .section "Testing server authentication" "SECID169"
24370 .cindex "authentication" "testing a server"
24371 .cindex "AUTH" "testing a server"
24372 .cindex "base64 encoding" "creating authentication test data"
24373 Exim's &%-bh%& option can be useful for testing server authentication
24374 configurations. The data for the AUTH command has to be sent using base64
24375 encoding. A quick way to produce such data for testing is the following Perl
24376 script:
24377 .code
24378 use MIME::Base64;
24379 printf ("%s", encode_base64(eval "\"$ARGV[0]\""));
24380 .endd
24381 .cindex "binary zero" "in authentication data"
24382 This interprets its argument as a Perl string, and then encodes it. The
24383 interpretation as a Perl string allows binary zeros, which are required for
24384 some kinds of authentication, to be included in the data. For example, a
24385 command line to run this script on such data might be
24386 .code
24387 encode '\0user\0password'
24388 .endd
24389 Note the use of single quotes to prevent the shell interpreting the
24390 backslashes, so that they can be interpreted by Perl to specify characters
24391 whose code value is zero.
24392
24393 &*Warning 1*&: If either of the user or password strings starts with an octal
24394 digit, you must use three zeros instead of one after the leading backslash. If
24395 you do not, the octal digit that starts your string will be incorrectly
24396 interpreted as part of the code for the first character.
24397
24398 &*Warning 2*&: If there are characters in the strings that Perl interprets
24399 specially, you must use a Perl escape to prevent them being misinterpreted. For
24400 example, a command such as
24401 .code
24402 encode '\0user@domain.com\0pas$$word'
24403 .endd
24404 gives an incorrect answer because of the unescaped &"@"& and &"$"& characters.
24405
24406 If you have the &%mimencode%& command installed, another way to do produce
24407 base64-encoded strings is to run the command
24408 .code
24409 echo -e -n `\0user\0password' | mimencode
24410 .endd
24411 The &%-e%& option of &%echo%& enables the interpretation of backslash escapes
24412 in the argument, and the &%-n%& option specifies no newline at the end of its
24413 output. However, not all versions of &%echo%& recognize these options, so you
24414 should check your version before relying on this suggestion.
24415
24416
24417
24418 .section "Authentication by an Exim client" "SECID170"
24419 .cindex "authentication" "on an Exim client"
24420 The &(smtp)& transport has two options called &%hosts_require_auth%& and
24421 &%hosts_try_auth%&. When the &(smtp)& transport connects to a server that
24422 announces support for authentication, and the host matches an entry in either
24423 of these options, Exim (as a client) tries to authenticate as follows:
24424
24425 .ilist
24426 For each authenticator that is configured as a client, in the order in which
24427 they are defined in the configuration, it searches the authentication
24428 mechanisms announced by the server for one whose name matches the public name
24429 of the authenticator.
24430 .next
24431 .vindex "&$host$&"
24432 .vindex "&$host_address$&"
24433 When it finds one that matches, it runs the authenticator's client code. The
24434 variables &$host$& and &$host_address$& are available for any string expansions
24435 that the client might do. They are set to the server's name and IP address. If
24436 any expansion is forced to fail, the authentication attempt is abandoned, and
24437 Exim moves on to the next authenticator. Otherwise an expansion failure causes
24438 delivery to be deferred.
24439 .next
24440 If the result of the authentication attempt is a temporary error or a timeout,
24441 Exim abandons trying to send the message to the host for the moment. It will
24442 try again later. If there are any backup hosts available, they are tried in the
24443 usual way.
24444 .next
24445 If the response to authentication is a permanent error (5&'xx'& code), Exim
24446 carries on searching the list of authenticators and tries another one if
24447 possible. If all authentication attempts give permanent errors, or if there are
24448 no attempts because no mechanisms match (or option expansions force failure),
24449 what happens depends on whether the host matches &%hosts_require_auth%& or
24450 &%hosts_try_auth%&. In the first case, a temporary error is generated, and
24451 delivery is deferred. The error can be detected in the retry rules, and thereby
24452 turned into a permanent error if you wish. In the second case, Exim tries to
24453 deliver the message unauthenticated.
24454 .endlist
24455
24456 .cindex "AUTH" "on MAIL command"
24457 When Exim has authenticated itself to a remote server, it adds the AUTH
24458 parameter to the MAIL commands it sends, if it has an authenticated sender for
24459 the message. If the message came from a remote host, the authenticated sender
24460 is the one that was receiving on an incoming MAIL command, provided that the
24461 incoming connection was authenticated and the &%server_mail_auth%& condition
24462 allowed the authenticated sender to be retained. If a local process calls Exim
24463 to send a message, the sender address that is built from the login name and
24464 &%qualify_domain%& is treated as authenticated. However, if the
24465 &%authenticated_sender%& option is set on the &(smtp)& transport, it overrides
24466 the authenticated sender that was received with the message.
24467 .ecindex IIDauthconf1
24468 .ecindex IIDauthconf2
24469
24470
24471
24472
24473
24474
24475 . ////////////////////////////////////////////////////////////////////////////
24476 . ////////////////////////////////////////////////////////////////////////////
24477
24478 .chapter "The plaintext authenticator" "CHAPplaintext"
24479 .scindex IIDplaiauth1 "&(plaintext)& authenticator"
24480 .scindex IIDplaiauth2 "authenticators" "&(plaintext)&"
24481 The &(plaintext)& authenticator can be configured to support the PLAIN and
24482 LOGIN authentication mechanisms, both of which transfer authentication data as
24483 plain (unencrypted) text (though base64 encoded). The use of plain text is a
24484 security risk; you are strongly advised to insist on the use of SMTP encryption
24485 (see chapter &<<CHAPTLS>>&) if you use the PLAIN or LOGIN mechanisms. If you do
24486 use unencrypted plain text, you should not use the same passwords for SMTP
24487 connections as you do for login accounts.
24488
24489 .section "Plaintext options" "SECID171"
24490 .cindex "options" "&(plaintext)& authenticator (server)"
24491 When configured as a server, &(plaintext)& uses the following options:
24492
24493 .option server_condition authenticators string&!! unset
24494 This is actually a global authentication option, but it must be set in order to
24495 configure the &(plaintext)& driver as a server. Its use is described below.
24496
24497 .option server_prompts plaintext string&!! unset
24498 The contents of this option, after expansion, must be a colon-separated list of
24499 prompt strings. If expansion fails, a temporary authentication rejection is
24500 given.
24501
24502 .section "Using plaintext in a server" "SECTplainserver"
24503 .cindex "AUTH" "in &(plaintext)& authenticator"
24504 .cindex "binary zero" "in &(plaintext)& authenticator"
24505 .cindex "numerical variables (&$1$& &$2$& etc)" &&&
24506         "in &(plaintext)& authenticator"
24507 .vindex "&$auth1$&, &$auth2$&, etc"
24508 .cindex "base64 encoding" "in &(plaintext)& authenticator"
24509
24510 When running as a server, &(plaintext)& performs the authentication test by
24511 expanding a string. The data sent by the client with the AUTH command, or in
24512 response to subsequent prompts, is base64 encoded, and so may contain any byte
24513 values when decoded. If any data is supplied with the command, it is treated as
24514 a list of strings, separated by NULs (binary zeros), the first three of which
24515 are placed in the expansion variables &$auth1$&, &$auth2$&, and &$auth3$&
24516 (neither LOGIN nor PLAIN uses more than three strings).
24517
24518 For compatibility with previous releases of Exim, the values are also placed in
24519 the expansion variables &$1$&, &$2$&, and &$3$&. However, the use of these
24520 variables for this purpose is now deprecated, as it can lead to confusion in
24521 string expansions that also use them for other things.
24522
24523 If there are more strings in &%server_prompts%& than the number of strings
24524 supplied with the AUTH command, the remaining prompts are used to obtain more
24525 data. Each response from the client may be a list of NUL-separated strings.
24526
24527 .vindex "&$authenticated_id$&"
24528 Once a sufficient number of data strings have been received,
24529 &%server_condition%& is expanded. If the expansion is forced to fail,
24530 authentication fails. Any other expansion failure causes a temporary error code
24531 to be returned. If the result of a successful expansion is an empty string,
24532 &"0"&, &"no"&, or &"false"&, authentication fails. If the result of the
24533 expansion is &"1"&, &"yes"&, or &"true"&, authentication succeeds and the
24534 generic &%server_set_id%& option is expanded and saved in &$authenticated_id$&.
24535 For any other result, a temporary error code is returned, with the expanded
24536 string as the error text.
24537
24538 &*Warning*&: If you use a lookup in the expansion to find the user's
24539 password, be sure to make the authentication fail if the user is unknown.
24540 There are good and bad examples at the end of the next section.
24541
24542
24543
24544 .section "The PLAIN authentication mechanism" "SECID172"
24545 .cindex "PLAIN authentication mechanism"
24546 .cindex "authentication" "PLAIN mechanism"
24547 .cindex "binary zero" "in &(plaintext)& authenticator"
24548 The PLAIN authentication mechanism (RFC 2595) specifies that three strings be
24549 sent as one item of data (that is, one combined string containing two NUL
24550 separators). The data is sent either as part of the AUTH command, or
24551 subsequently in response to an empty prompt from the server.
24552
24553 The second and third strings are a user name and a corresponding password.
24554 Using a single fixed user name and password as an example, this could be
24555 configured as follows:
24556 .code
24557 fixed_plain:
24558   driver = plaintext
24559   public_name = PLAIN
24560   server_prompts = :
24561   server_condition = \
24562     ${if and {{eq{$auth2}{username}}{eq{$auth3}{mysecret}}}}
24563   server_set_id = $auth2
24564 .endd
24565 Note that the default result strings from &%if%& (&"true"& or an empty string)
24566 are exactly what we want here, so they need not be specified. Obviously, if the
24567 password contains expansion-significant characters such as dollar, backslash,
24568 or closing brace, they have to be escaped.
24569
24570 The &%server_prompts%& setting specifies a single, empty prompt (empty items at
24571 the end of a string list are ignored). If all the data comes as part of the
24572 AUTH command, as is commonly the case, the prompt is not used. This
24573 authenticator is advertised in the response to EHLO as
24574 .code
24575 250-AUTH PLAIN
24576 .endd
24577 and a client host can authenticate itself by sending the command
24578 .code
24579 AUTH PLAIN AHVzZXJuYW1lAG15c2VjcmV0
24580 .endd
24581 As this contains three strings (more than the number of prompts), no further
24582 data is required from the client. Alternatively, the client may just send
24583 .code
24584 AUTH PLAIN
24585 .endd
24586 to initiate authentication, in which case the server replies with an empty
24587 prompt. The client must respond with the combined data string.
24588
24589 The data string is base64 encoded, as required by the RFC. This example,
24590 when decoded, is <&'NUL'&>&`username`&<&'NUL'&>&`mysecret`&, where <&'NUL'&>
24591 represents a zero byte. This is split up into three strings, the first of which
24592 is empty. The &%server_condition%& option in the authenticator checks that the
24593 second two are &`username`& and &`mysecret`& respectively.
24594
24595 Having just one fixed user name and password, as in this example, is not very
24596 realistic, though for a small organization with only a handful of
24597 authenticating clients it could make sense.
24598
24599 A more sophisticated instance of this authenticator could use the user name in
24600 &$auth2$& to look up a password in a file or database, and maybe do an encrypted
24601 comparison (see &%crypteq%& in chapter &<<CHAPexpand>>&). Here is a example of
24602 this approach, where the passwords are looked up in a DBM file. &*Warning*&:
24603 This is an incorrect example:
24604 .code
24605 server_condition = \
24606   ${if eq{$auth3}{${lookup{$auth2}dbm{/etc/authpwd}}}}
24607 .endd
24608 The expansion uses the user name (&$auth2$&) as the key to look up a password,
24609 which it then compares to the supplied password (&$auth3$&). Why is this example
24610 incorrect? It works fine for existing users, but consider what happens if a
24611 non-existent user name is given. The lookup fails, but as no success/failure
24612 strings are given for the lookup, it yields an empty string. Thus, to defeat
24613 the authentication, all a client has to do is to supply a non-existent user
24614 name and an empty password. The correct way of writing this test is:
24615 .code
24616 server_condition = ${lookup{$auth2}dbm{/etc/authpwd}\
24617   {${if eq{$value}{$auth3}}} {false}}
24618 .endd
24619 In this case, if the lookup succeeds, the result is checked; if the lookup
24620 fails, &"false"& is returned and authentication fails. If &%crypteq%& is being
24621 used instead of &%eq%&, the first example is in fact safe, because &%crypteq%&
24622 always fails if its second argument is empty. However, the second way of
24623 writing the test makes the logic clearer.
24624
24625
24626 .section "The LOGIN authentication mechanism" "SECID173"
24627 .cindex "LOGIN authentication mechanism"
24628 .cindex "authentication" "LOGIN mechanism"
24629 The LOGIN authentication mechanism is not documented in any RFC, but is in use
24630 in a number of programs. No data is sent with the AUTH command. Instead, a
24631 user name and password are supplied separately, in response to prompts. The
24632 plaintext authenticator can be configured to support this as in this example:
24633 .code
24634 fixed_login:
24635   driver = plaintext
24636   public_name = LOGIN
24637   server_prompts = User Name : Password
24638   server_condition = \
24639     ${if and {{eq{$auth1}{username}}{eq{$auth2}{mysecret}}}}
24640   server_set_id = $auth1
24641 .endd
24642 Because of the way plaintext operates, this authenticator accepts data supplied
24643 with the AUTH command (in contravention of the specification of LOGIN), but
24644 if the client does not supply it (as is the case for LOGIN clients), the prompt
24645 strings are used to obtain two data items.
24646
24647 Some clients are very particular about the precise text of the prompts. For
24648 example, Outlook Express is reported to recognize only &"Username:"& and
24649 &"Password:"&. Here is an example of a LOGIN authenticator that uses those
24650 strings. It uses the &%ldapauth%& expansion condition to check the user
24651 name and password by binding to an LDAP server:
24652 .code
24653 login:
24654   driver = plaintext
24655   public_name = LOGIN
24656   server_prompts = Username:: : Password::
24657   server_condition = ${if and{{ \
24658     !eq{}{$auth1} }{ \
24659     ldapauth{\
24660       user="uid=${quote_ldap_dn:$auth1},ou=people,o=example.org" \
24661       pass=${quote:$auth2} \
24662       ldap://ldap.example.org/} }} }
24663   server_set_id = uid=$auth1,ou=people,o=example.org
24664 .endd
24665 We have to check that the username is not empty before using it, because LDAP
24666 does not permit empty DN components. We must also use the &%quote_ldap_dn%&
24667 operator to correctly quote the DN for authentication. However, the basic
24668 &%quote%& operator, rather than any of the LDAP quoting operators, is the
24669 correct one to use for the password, because quoting is needed only to make
24670 the password conform to the Exim syntax. At the LDAP level, the password is an
24671 uninterpreted string.
24672
24673
24674 .section "Support for different kinds of authentication" "SECID174"
24675 A number of string expansion features are provided for the purpose of
24676 interfacing to different ways of user authentication. These include checking
24677 traditionally encrypted passwords from &_/etc/passwd_& (or equivalent), PAM,
24678 Radius, &%ldapauth%&, &'pwcheck'&, and &'saslauthd'&. For details see section
24679 &<<SECTexpcond>>&.
24680
24681
24682
24683
24684 .section "Using plaintext in a client" "SECID175"
24685 .cindex "options" "&(plaintext)& authenticator (client)"
24686 The &(plaintext)& authenticator has two client options:
24687
24688 .option client_ignore_invalid_base64 plaintext boolean false
24689 If the client receives a server prompt that is not a valid base64 string,
24690 authentication is abandoned by default. However, if this option is set true,
24691 the error in the challenge is ignored and the client sends the response as
24692 usual.
24693
24694 .option client_send plaintext string&!! unset
24695 The string is a colon-separated list of authentication data strings. Each
24696 string is independently expanded before being sent to the server. The first
24697 string is sent with the AUTH command; any more strings are sent in response
24698 to prompts from the server. Before each string is expanded, the value of the
24699 most recent prompt is placed in the next &$auth$&<&'n'&> variable, starting
24700 with &$auth1$& for the first prompt. Up to three prompts are stored in this
24701 way. Thus, the prompt that is received in response to sending the first string
24702 (with the AUTH command) can be used in the expansion of the second string, and
24703 so on. If an invalid base64 string is received when
24704 &%client_ignore_invalid_base64%& is set, an empty string is put in the
24705 &$auth$&<&'n'&> variable.
24706
24707 &*Note*&: You cannot use expansion to create multiple strings, because
24708 splitting takes priority and happens first.
24709
24710 Because the PLAIN authentication mechanism requires NUL (binary zero) bytes in
24711 the data, further processing is applied to each string before it is sent. If
24712 there are any single circumflex characters in the string, they are converted to
24713 NULs. Should an actual circumflex be required as data, it must be doubled in
24714 the string.
24715
24716 This is an example of a client configuration that implements the PLAIN
24717 authentication mechanism with a fixed user name and password:
24718 .code
24719 fixed_plain:
24720   driver = plaintext
24721   public_name = PLAIN
24722   client_send = ^username^mysecret
24723 .endd
24724 The lack of colons means that the entire text is sent with the AUTH
24725 command, with the circumflex characters converted to NULs. A similar example
24726 that uses the LOGIN mechanism is:
24727 .code
24728 fixed_login:
24729   driver = plaintext
24730   public_name = LOGIN
24731   client_send = : username : mysecret
24732 .endd
24733 The initial colon means that the first string is empty, so no data is sent with
24734 the AUTH command itself. The remaining strings are sent in response to
24735 prompts.
24736 .ecindex IIDplaiauth1
24737 .ecindex IIDplaiauth2
24738
24739
24740
24741
24742 . ////////////////////////////////////////////////////////////////////////////
24743 . ////////////////////////////////////////////////////////////////////////////
24744
24745 .chapter "The cram_md5 authenticator" "CHID9"
24746 .scindex IIDcramauth1 "&(cram_md5)& authenticator"
24747 .scindex IIDcramauth2 "authenticators" "&(cram_md5)&"
24748 .cindex "CRAM-MD5 authentication mechanism"
24749 .cindex "authentication" "CRAM-MD5 mechanism"
24750 The CRAM-MD5 authentication mechanism is described in RFC 2195. The server
24751 sends a challenge string to the client, and the response consists of a user
24752 name and the CRAM-MD5 digest of the challenge string combined with a secret
24753 string (password) which is known to both server and client. Thus, the secret
24754 is not sent over the network as plain text, which makes this authenticator more
24755 secure than &(plaintext)&. However, the downside is that the secret has to be
24756 available in plain text at either end.
24757
24758
24759 .section "Using cram_md5 as a server" "SECID176"
24760 .cindex "options" "&(cram_md5)& authenticator (server)"
24761 This authenticator has one server option, which must be set to configure the
24762 authenticator as a server:
24763
24764 .option server_secret cram_md5 string&!! unset
24765 .cindex "numerical variables (&$1$& &$2$& etc)" "in &(cram_md5)& authenticator"
24766 When the server receives the client's response, the user name is placed in
24767 the expansion variable &$auth1$&, and &%server_secret%& is expanded to
24768 obtain the password for that user. The server then computes the CRAM-MD5 digest
24769 that the client should have sent, and checks that it received the correct
24770 string. If the expansion of &%server_secret%& is forced to fail, authentication
24771 fails. If the expansion fails for some other reason, a temporary error code is
24772 returned to the client.
24773
24774 For compatibility with previous releases of Exim, the user name is also placed
24775 in &$1$&. However, the use of this variables for this purpose is now
24776 deprecated, as it can lead to confusion in string expansions that also use
24777 numeric variables for other things.
24778
24779 For example, the following authenticator checks that the user name given by the
24780 client is &"ph10"&, and if so, uses &"secret"& as the password. For any other
24781 user name, authentication fails.
24782 .code
24783 fixed_cram:
24784   driver = cram_md5
24785   public_name = CRAM-MD5
24786   server_secret = ${if eq{$auth1}{ph10}{secret}fail}
24787   server_set_id = $auth1
24788 .endd
24789 .vindex "&$authenticated_id$&"
24790 If authentication succeeds, the setting of &%server_set_id%& preserves the user
24791 name in &$authenticated_id$&. A more typical configuration might look up the
24792 secret string in a file, using the user name as the key. For example:
24793 .code
24794 lookup_cram:
24795   driver = cram_md5
24796   public_name = CRAM-MD5
24797   server_secret = ${lookup{$auth1}lsearch{/etc/authpwd}\
24798                   {$value}fail}
24799   server_set_id = $auth1
24800 .endd
24801 Note that this expansion explicitly forces failure if the lookup fails
24802 because &$auth1$& contains an unknown user name.
24803
24804 As another example, if you wish to re-use a Cyrus SASL sasldb2 file without
24805 using the relevant libraries, you need to know the realm to specify in the
24806 lookup and then ask for the &"userPassword"& attribute for that user in that
24807 realm, with:
24808 .code
24809 cyrusless_crammd5:
24810   driver = cram_md5
24811   public_name = CRAM-MD5
24812   server_secret = ${lookup{$auth1:mail.example.org:userPassword}\
24813                   dbmjz{/etc/sasldb2}}
24814   server_set_id = $auth1
24815 .endd
24816
24817 .section "Using cram_md5 as a client" "SECID177"
24818 .cindex "options" "&(cram_md5)& authenticator (client)"
24819 When used as a client, the &(cram_md5)& authenticator has two options:
24820
24821
24822
24823 .option client_name cram_md5 string&!! "the primary host name"
24824 This string is expanded, and the result used as the user name data when
24825 computing the response to the server's challenge.
24826
24827
24828 .option client_secret cram_md5 string&!! unset
24829 This option must be set for the authenticator to work as a client. Its value is
24830 expanded and the result used as the secret string when computing the response.
24831
24832
24833 .vindex "&$host$&"
24834 .vindex "&$host_address$&"
24835 Different user names and secrets can be used for different servers by referring
24836 to &$host$& or &$host_address$& in the options. Forced failure of either
24837 expansion string is treated as an indication that this authenticator is not
24838 prepared to handle this case. Exim moves on to the next configured client
24839 authenticator. Any other expansion failure causes Exim to give up trying to
24840 send the message to the current server.
24841
24842 A simple example configuration of a &(cram_md5)& authenticator, using fixed
24843 strings, is:
24844 .code
24845 fixed_cram:
24846   driver = cram_md5
24847   public_name = CRAM-MD5
24848   client_name = ph10
24849   client_secret = secret
24850 .endd
24851 .ecindex IIDcramauth1
24852 .ecindex IIDcramauth2
24853
24854
24855
24856 . ////////////////////////////////////////////////////////////////////////////
24857 . ////////////////////////////////////////////////////////////////////////////
24858
24859 .chapter "The cyrus_sasl authenticator" "CHID10"
24860 .scindex IIDcyrauth1 "&(cyrus_sasl)& authenticator"
24861 .scindex IIDcyrauth2 "authenticators" "&(cyrus_sasl)&"
24862 .cindex "Cyrus" "SASL library"
24863 .cindex "Kerberos"
24864 The code for this authenticator was provided by Matthew Byng-Maddick of A L
24865 Digital Ltd (&url(http://www.aldigital.co.uk)).
24866
24867 The &(cyrus_sasl)& authenticator provides server support for the Cyrus SASL
24868 library implementation of the RFC 2222 (&"Simple Authentication and Security
24869 Layer"&). This library supports a number of authentication mechanisms,
24870 including PLAIN and LOGIN, but also several others that Exim does not support
24871 directly. In particular, there is support for Kerberos authentication.
24872
24873 The &(cyrus_sasl)& authenticator provides a gatewaying mechanism directly to
24874 the Cyrus interface, so if your Cyrus library can do, for example, CRAM-MD5,
24875 then so can the &(cyrus_sasl)& authenticator. By default it uses the public
24876 name of the driver to determine which mechanism to support.
24877
24878 Where access to some kind of secret file is required, for example in GSSAPI
24879 or CRAM-MD5, it is worth noting that the authenticator runs as the Exim
24880 user, and that the Cyrus SASL library has no way of escalating privileges
24881 by default. You may also find you need to set environment variables,
24882 depending on the driver you are using.
24883
24884 The application name provided by Exim is &"exim"&, so various SASL options may
24885 be set in &_exim.conf_& in your SASL directory. If you are using GSSAPI for
24886 Kerberos, note that because of limitations in the GSSAPI interface,
24887 changing the server keytab might need to be communicated down to the Kerberos
24888 layer independently. The mechanism for doing so is dependent upon the Kerberos
24889 implementation.
24890
24891 For example, for older releases of Heimdal, the environment variable KRB5_KTNAME
24892 may be set to point to an alternative keytab file. Exim will pass this
24893 variable through from its own inherited environment when started as root or the
24894 Exim user. The keytab file needs to be readable by the Exim user.
24895 With newer releases of Heimdal, a setuid Exim may cause Heimdal to discard the
24896 environment variable.  In practice, for those releases, the Cyrus authenticator
24897 is not a suitable interface for GSSAPI (Kerberos) support.  Instead, consider
24898 the &(heimdal_gssapi)& authenticator, described in chapter &<<CHAPheimdalgss>>&
24899
24900
24901 .section "Using cyrus_sasl as a server" "SECID178"
24902 The &(cyrus_sasl)& authenticator has four private options. It puts the username
24903 (on a successful authentication) into &$auth1$&. For compatibility with
24904 previous releases of Exim, the username is also placed in &$1$&. However, the
24905 use of this variable for this purpose is now deprecated, as it can lead to
24906 confusion in string expansions that also use numeric variables for other
24907 things.
24908
24909
24910 .option server_hostname cyrus_sasl string&!! "see below"
24911 This option selects the hostname that is used when communicating with the
24912 library. The default value is &`$primary_hostname`&. It is up to the underlying
24913 SASL plug-in what it does with this data.
24914
24915
24916 .option server_mech cyrus_sasl string "see below"
24917 This option selects the authentication mechanism this driver should use. The
24918 default is the value of the generic &%public_name%& option. This option allows
24919 you to use a different underlying mechanism from the advertised name. For
24920 example:
24921 .code
24922 sasl:
24923   driver = cyrus_sasl
24924   public_name = X-ANYTHING
24925   server_mech = CRAM-MD5
24926   server_set_id = $auth1
24927 .endd
24928
24929 .option server_realm cyrus_sasl string&!! unset
24930 This specifies the SASL realm that the server claims to be in.
24931
24932
24933 .option server_service cyrus_sasl string &`smtp`&
24934 This is the SASL service that the server claims to implement.
24935
24936
24937 For straightforward cases, you do not need to set any of the authenticator's
24938 private options. All you need to do is to specify an appropriate mechanism as
24939 the public name. Thus, if you have a SASL library that supports CRAM-MD5 and
24940 PLAIN, you could have two authenticators as follows:
24941 .code
24942 sasl_cram_md5:
24943   driver = cyrus_sasl
24944   public_name = CRAM-MD5
24945   server_set_id = $auth1
24946
24947 sasl_plain:
24948   driver = cyrus_sasl
24949   public_name = PLAIN
24950   server_set_id = $auth2
24951 .endd
24952 Cyrus SASL does implement the LOGIN authentication method, even though it is
24953 not a standard method. It is disabled by default in the source distribution,
24954 but it is present in many binary distributions.
24955 .ecindex IIDcyrauth1
24956 .ecindex IIDcyrauth2
24957
24958
24959
24960
24961 . ////////////////////////////////////////////////////////////////////////////
24962 . ////////////////////////////////////////////////////////////////////////////
24963 .chapter "The dovecot authenticator" "CHAPdovecot"
24964 .scindex IIDdcotauth1 "&(dovecot)& authenticator"
24965 .scindex IIDdcotauth2 "authenticators" "&(dovecot)&"
24966 This authenticator is an interface to the authentication facility of the
24967 Dovecot POP/IMAP server, which can support a number of authentication methods.
24968 If you are using Dovecot to authenticate POP/IMAP clients, it might be helpful
24969 to use the same mechanisms for SMTP authentication. This is a server
24970 authenticator only. There is only one option:
24971
24972 .option server_socket dovecot string unset
24973
24974 This option must specify the socket that is the interface to Dovecot
24975 authentication. The &%public_name%& option must specify an authentication
24976 mechanism that Dovecot is configured to support. You can have several
24977 authenticators for different mechanisms. For example:
24978 .code
24979 dovecot_plain:
24980   driver = dovecot
24981   public_name = PLAIN
24982   server_socket = /var/run/dovecot/auth-client
24983   server_set_id = $auth2
24984
24985 dovecot_ntlm:
24986   driver = dovecot
24987   public_name = NTLM
24988   server_socket = /var/run/dovecot/auth-client
24989   server_set_id = $auth1
24990 .endd
24991 If the SMTP connection is encrypted, or if &$sender_host_address$& is equal to
24992 &$received_ip_address$& (that is, the connection is local), the &"secured"&
24993 option is passed in the Dovecot authentication command. If, for a TLS
24994 connection, a client certificate has been verified, the &"valid-client-cert"&
24995 option is passed. When authentication succeeds, the identity of the user
24996 who authenticated is placed in &$auth1$&.
24997 .ecindex IIDdcotauth1
24998 .ecindex IIDdcotauth2
24999
25000
25001 . ////////////////////////////////////////////////////////////////////////////
25002 . ////////////////////////////////////////////////////////////////////////////
25003 .chapter "The gsasl authenticator" "CHAPgsasl"
25004 .scindex IIDgsaslauth1 "&(gsasl)& authenticator"
25005 .scindex IIDgsaslauth2 "authenticators" "&(gsasl)&"
25006 .cindex "authentication" "GNU SASL"
25007 .cindex "authentication" "SASL"
25008 .cindex "authentication" "EXTERNAL"
25009 .cindex "authentication" "ANONYMOUS"
25010 .cindex "authentication" "PLAIN"
25011 .cindex "authentication" "LOGIN"
25012 .cindex "authentication" "DIGEST-MD5"
25013 .cindex "authentication" "CRAM-MD5"
25014 .cindex "authentication" "SCRAM-SHA-1"
25015 The &(gsasl)& authenticator provides server integration for the GNU SASL
25016 library and the mechanisms it provides.  This is new as of the 4.80 release
25017 and there are a few areas where the library does not let Exim smoothly
25018 scale to handle future authentication mechanisms, so no guarantee can be
25019 made that any particular new authentication mechanism will be supported
25020 without code changes in Exim.
25021
25022
25023 .option server_channelbinding gsasl boolean false
25024 Some authentication mechanisms are able to use external context at both ends
25025 of the session to bind the authentication to that context, and fail the
25026 authentication process if that context differs.  Specifically, some TLS
25027 ciphersuites can provide identifying information about the cryptographic
25028 context.
25029
25030 This means that certificate identity and verification becomes a non-issue,
25031 as a man-in-the-middle attack will cause the correct client and server to
25032 see different identifiers and authentication will fail.
25033
25034 This is currently only supported when using the GnuTLS library.  This is
25035 only usable by mechanisms which support "channel binding"; at time of
25036 writing, that's the SCRAM family.
25037
25038 This defaults off to ensure smooth upgrade across Exim releases, in case
25039 this option causes some clients to start failing.  Some future release
25040 of Exim may switch the default to be true.
25041
25042
25043 .option server_hostname gsasl string&!! "see below"
25044 This option selects the hostname that is used when communicating with the
25045 library. The default value is &`$primary_hostname`&.
25046 Some mechanisms will use this data.
25047
25048
25049 .option server_mech gsasl string "see below"
25050 This option selects the authentication mechanism this driver should use. The
25051 default is the value of the generic &%public_name%& option. This option allows
25052 you to use a different underlying mechanism from the advertised name. For
25053 example:
25054 .code
25055 sasl:
25056   driver = gsasl
25057   public_name = X-ANYTHING
25058   server_mech = CRAM-MD5
25059   server_set_id = $auth1
25060 .endd
25061
25062
25063 .option server_password gsasl string&!! unset
25064 Various mechanisms need access to the cleartext password on the server, so
25065 that proof-of-possession can be demonstrated on the wire, without sending
25066 the password itself.
25067
25068 The data available for lookup varies per mechanism.
25069 In all cases, &$auth1$& is set to the &'authentication id'&.
25070 The &$auth2$& variable will always be the &'authorization id'& (&'authz'&)
25071 if available, else the empty string.
25072 The &$auth3$& variable will always be the &'realm'& if available,
25073 else the empty string.
25074
25075 A forced failure will cause authentication to defer.
25076
25077 If using this option, it may make sense to set the &%server_condition%&
25078 option to be simply "true".
25079
25080
25081 .option server_realm gsasl string&!! unset
25082 This specifies the SASL realm that the server claims to be in.
25083 Some mechanisms will use this data.
25084
25085
25086 .option server_scram_iter gsasl string&!! unset
25087 This option provides data for the SCRAM family of mechanisms.
25088 &$auth1$& is not available at evaluation time.
25089 (This may change, as we receive feedback on use)
25090
25091
25092 .option server_scram_salt gsasl string&!! unset
25093 This option provides data for the SCRAM family of mechanisms.
25094 &$auth1$& is not available at evaluation time.
25095 (This may change, as we receive feedback on use)
25096
25097
25098 .option server_service gsasl string &`smtp`&
25099 This is the SASL service that the server claims to implement.
25100 Some mechanisms will use this data.
25101
25102
25103 .section "&(gsasl)& auth variables" "SECTgsaslauthvar"
25104 .vindex "&$auth1$&, &$auth2$&, etc"
25105 These may be set when evaluating specific options, as detailed above.
25106 They will also be set when evaluating &%server_condition%&.
25107
25108 Unless otherwise stated below, the &(gsasl)& integration will use the following
25109 meanings for these variables:
25110
25111 .ilist
25112 .vindex "&$auth1$&"
25113 &$auth1$&: the &'authentication id'&
25114 .next
25115 .vindex "&$auth2$&"
25116 &$auth2$&: the &'authorization id'&
25117 .next
25118 .vindex "&$auth3$&"
25119 &$auth3$&: the &'realm'&
25120 .endlist
25121
25122 On a per-mechanism basis:
25123
25124 .ilist
25125 .cindex "authentication" "EXTERNAL"
25126 EXTERNAL: only &$auth1$& is set, to the possibly empty &'authorization id'&;
25127 the &%server_condition%& option must be present.
25128 .next
25129 .cindex "authentication" "ANONYMOUS"
25130 ANONYMOUS: only &$auth1$& is set, to the possibly empty &'anonymous token'&;
25131 the &%server_condition%& option must be present.
25132 .next
25133 .cindex "authentication" "GSSAPI"
25134 GSSAPI: &$auth1$& will be set to the &'GSSAPI Display Name'&;
25135 &$auth2$& will be set to the &'authorization id'&,
25136 the &%server_condition%& option must be present.
25137 .endlist
25138
25139 An &'anonymous token'& is something passed along as an unauthenticated
25140 identifier; this is analogous to FTP anonymous authentication passing an
25141 email address, or software-identifier@, as the "password".
25142
25143
25144 An example showing the password having the realm specified in the callback
25145 and demonstrating a Cyrus SASL to GSASL migration approach is:
25146 .code
25147 gsasl_cyrusless_crammd5:
25148   driver = gsasl
25149   public_name = CRAM-MD5
25150   server_realm = imap.example.org
25151   server_password = ${lookup{$auth1:$auth3:userPassword}\
25152                     dbmjz{/etc/sasldb2}{$value}fail}
25153   server_set_id = ${quote:$auth1}
25154   server_condition = yes
25155 .endd
25156
25157
25158 . ////////////////////////////////////////////////////////////////////////////
25159 . ////////////////////////////////////////////////////////////////////////////
25160
25161 .chapter "The heimdal_gssapi authenticator" "CHAPheimdalgss"
25162 .scindex IIDheimdalgssauth1 "&(heimdal_gssapi)& authenticator"
25163 .scindex IIDheimdalgssauth2 "authenticators" "&(heimdal_gssapi)&"
25164 .cindex "authentication" "GSSAPI"
25165 .cindex "authentication" "Kerberos"
25166 The &(heimdal_gssapi)& authenticator provides server integration for the
25167 Heimdal GSSAPI/Kerberos library, permitting Exim to set a keytab pathname
25168 reliably.
25169
25170 .option server_hostname heimdal_gssapi string&!! "see below"
25171 This option selects the hostname that is used, with &%server_service%&,
25172 for constructing the GSS server name, as a &'GSS_C_NT_HOSTBASED_SERVICE'&
25173 identifier.  The default value is &`$primary_hostname`&.
25174
25175 .option server_keytab heimdal_gssapi string&!! unset
25176 If set, then Heimdal will not use the system default keytab (typically
25177 &_/etc/krb5.keytab_&) but instead the pathname given in this option.
25178 The value should be a pathname, with no &"file:"& prefix.
25179
25180 .option server_service heimdal_gssapi string&!! "smtp"
25181 This option specifies the service identifier used, in conjunction with
25182 &%server_hostname%&, for building the identifer for finding credentials
25183 from the keytab.
25184
25185
25186 .section "&(heimdal_gssapi)& auth variables" "SECTheimdalgssauthvar"
25187 Beware that these variables will typically include a realm, thus will appear
25188 to be roughly like an email address already.  The &'authzid'& in &$auth2$& is
25189 not verified, so a malicious client can set it to anything.
25190
25191 The &$auth1$& field should be safely trustable as a value from the Key
25192 Distribution Center.  Note that these are not quite email addresses.
25193 Each identifier is for a role, and so the left-hand-side may include a
25194 role suffix.  For instance, &"joe/admin@EXAMPLE.ORG"&.
25195
25196 .vindex "&$auth1$&, &$auth2$&, etc"
25197 .ilist
25198 .vindex "&$auth1$&"
25199 &$auth1$&: the &'authentication id'&, set to the GSS Display Name.
25200 .next
25201 .vindex "&$auth2$&"
25202 &$auth2$&: the &'authorization id'&, sent within SASL encapsulation after
25203 authentication.  If that was empty, this will also be set to the
25204 GSS Display Name.
25205 .endlist
25206
25207
25208 . ////////////////////////////////////////////////////////////////////////////
25209 . ////////////////////////////////////////////////////////////////////////////
25210
25211 .chapter "The spa authenticator" "CHAPspa"
25212 .scindex IIDspaauth1 "&(spa)& authenticator"
25213 .scindex IIDspaauth2 "authenticators" "&(spa)&"
25214 .cindex "authentication" "Microsoft Secure Password"
25215 .cindex "authentication" "NTLM"
25216 .cindex "Microsoft Secure Password Authentication"
25217 .cindex "NTLM authentication"
25218 The &(spa)& authenticator provides client support for Microsoft's &'Secure
25219 Password Authentication'& mechanism,
25220 which is also sometimes known as NTLM (NT LanMan). The code for client side of
25221 this authenticator was contributed by Marc Prud'hommeaux, and much of it is
25222 taken from the Samba project (&url(http://www.samba.org)). The code for the
25223 server side was subsequently contributed by Tom Kistner. The mechanism works as
25224 follows:
25225
25226 .ilist
25227 After the AUTH command has been accepted, the client sends an SPA
25228 authentication request based on the user name and optional domain.
25229 .next
25230 The server sends back a challenge.
25231 .next
25232 The client builds a challenge response which makes use of the user's password
25233 and sends it to the server, which then accepts or rejects it.
25234 .endlist
25235
25236 Encryption is used to protect the password in transit.
25237
25238
25239
25240 .section "Using spa as a server" "SECID179"
25241 .cindex "options" "&(spa)& authenticator (server)"
25242 The &(spa)& authenticator has just one server option:
25243
25244 .option server_password spa string&!! unset
25245 .cindex "numerical variables (&$1$& &$2$& etc)" "in &(spa)& authenticator"
25246 This option is expanded, and the result must be the cleartext password for the
25247 authenticating user, whose name is at this point in &$auth1$&. For
25248 compatibility with previous releases of Exim, the user name is also placed in
25249 &$1$&. However, the use of this variable for this purpose is now deprecated, as
25250 it can lead to confusion in string expansions that also use numeric variables
25251 for other things. For example:
25252 .code
25253 spa:
25254   driver = spa
25255   public_name = NTLM
25256   server_password = \
25257     ${lookup{$auth1}lsearch{/etc/exim/spa_clearpass}{$value}fail}
25258 .endd
25259 If the expansion is forced to fail, authentication fails. Any other expansion
25260 failure causes a temporary error code to be returned.
25261
25262
25263
25264
25265
25266 .section "Using spa as a client" "SECID180"
25267 .cindex "options" "&(spa)& authenticator (client)"
25268 The &(spa)& authenticator has the following client options:
25269
25270
25271
25272 .option client_domain spa string&!! unset
25273 This option specifies an optional domain for the authentication.
25274
25275
25276 .option client_password spa string&!! unset
25277 This option specifies the user's password, and must be set.
25278
25279
25280 .option client_username spa string&!! unset
25281 This option specifies the user name, and must be set. Here is an example of a
25282 configuration of this authenticator for use with the mail servers at
25283 &'msn.com'&:
25284 .code
25285 msn:
25286   driver = spa
25287   public_name = MSN
25288   client_username = msn/msn_username
25289   client_password = msn_plaintext_password
25290   client_domain = DOMAIN_OR_UNSET
25291 .endd
25292 .ecindex IIDspaauth1
25293 .ecindex IIDspaauth2
25294
25295
25296
25297
25298
25299 . ////////////////////////////////////////////////////////////////////////////
25300 . ////////////////////////////////////////////////////////////////////////////
25301
25302 .chapter "Encrypted SMTP connections using TLS/SSL" "CHAPTLS" &&&
25303          "Encrypted SMTP connections"
25304 .scindex IIDencsmtp1 "encryption" "on SMTP connection"
25305 .scindex IIDencsmtp2 "SMTP" "encryption"
25306 .cindex "TLS" "on SMTP connection"
25307 .cindex "OpenSSL"
25308 .cindex "GnuTLS"
25309 Support for TLS (Transport Layer Security), formerly known as SSL (Secure
25310 Sockets Layer), is implemented by making use of the OpenSSL library or the
25311 GnuTLS library (Exim requires GnuTLS release 1.0 or later). There is no
25312 cryptographic code in the Exim distribution itself for implementing TLS. In
25313 order to use this feature you must install OpenSSL or GnuTLS, and then build a
25314 version of Exim that includes TLS support (see section &<<SECTinctlsssl>>&).
25315 You also need to understand the basic concepts of encryption at a managerial
25316 level, and in particular, the way that public keys, private keys, and
25317 certificates are used.
25318
25319 RFC 3207 defines how SMTP connections can make use of encryption. Once a
25320 connection is established, the client issues a STARTTLS command. If the
25321 server accepts this, the client and the server negotiate an encryption
25322 mechanism. If the negotiation succeeds, the data that subsequently passes
25323 between them is encrypted.
25324
25325 Exim's ACLs can detect whether the current SMTP session is encrypted or not,
25326 and if so, what cipher suite is in use, whether the client supplied a
25327 certificate, and whether or not that certificate was verified. This makes it
25328 possible for an Exim server to deny or accept certain commands based on the
25329 encryption state.
25330
25331 &*Warning*&: Certain types of firewall and certain anti-virus products can
25332 disrupt TLS connections. You need to turn off SMTP scanning for these products
25333 in order to get TLS to work.
25334
25335
25336
25337 .section "Support for the legacy &""ssmtp""& (aka &""smtps""&) protocol" &&&
25338          "SECID284"
25339 .cindex "ssmtp protocol"
25340 .cindex "smtps protocol"
25341 .cindex "SMTP" "ssmtp protocol"
25342 .cindex "SMTP" "smtps protocol"
25343 Early implementations of encrypted SMTP used a different TCP port from normal
25344 SMTP, and expected an encryption negotiation to start immediately, instead of
25345 waiting for a STARTTLS command from the client using the standard SMTP
25346 port. The protocol was called &"ssmtp"& or &"smtps"&, and port 465 was
25347 allocated for this purpose.
25348
25349 This approach was abandoned when encrypted SMTP was standardized, but there are
25350 still some legacy clients that use it. Exim supports these clients by means of
25351 the &%tls_on_connect_ports%& global option. Its value must be a list of port
25352 numbers; the most common use is expected to be:
25353 .code
25354 tls_on_connect_ports = 465
25355 .endd
25356 The port numbers specified by this option apply to all SMTP connections, both
25357 via the daemon and via &'inetd'&. You still need to specify all the ports that
25358 the daemon uses (by setting &%daemon_smtp_ports%& or &%local_interfaces%& or
25359 the &%-oX%& command line option) because &%tls_on_connect_ports%& does not add
25360 an extra port &-- rather, it specifies different behaviour on a port that is
25361 defined elsewhere.
25362
25363 There is also a &%-tls-on-connect%& command line option. This overrides
25364 &%tls_on_connect_ports%&; it forces the legacy behaviour for all ports.
25365
25366
25367
25368
25369
25370
25371 .section "OpenSSL vs GnuTLS" "SECTopenvsgnu"
25372 .cindex "TLS" "OpenSSL &'vs'& GnuTLS"
25373 The first TLS support in Exim was implemented using OpenSSL. Support for GnuTLS
25374 followed later, when the first versions of GnuTLS were released. To build Exim
25375 to use GnuTLS, you need to set
25376 .code
25377 USE_GNUTLS=yes
25378 .endd
25379 in Local/Makefile, in addition to
25380 .code
25381 SUPPORT_TLS=yes
25382 .endd
25383 You must also set TLS_LIBS and TLS_INCLUDE appropriately, so that the
25384 include files and libraries for GnuTLS can be found.
25385
25386 There are some differences in usage when using GnuTLS instead of OpenSSL:
25387
25388 .ilist
25389 The &%tls_verify_certificates%& option must contain the name of a file, not the
25390 name of a directory (for OpenSSL it can be either).
25391 .next
25392 The default value for &%tls_dhparam%& differs for historical reasons.
25393 .next
25394 .vindex "&$tls_in_peerdn$&"
25395 .vindex "&$tls_out_peerdn$&"
25396 Distinguished Name (DN) strings reported by the OpenSSL library use a slash for
25397 separating fields; GnuTLS uses commas, in accordance with RFC 2253. This
25398 affects the value of the &$tls_in_peerdn$& and &$tls_out_peerdn$& variables.
25399 .next
25400 OpenSSL identifies cipher suites using hyphens as separators, for example:
25401 DES-CBC3-SHA. GnuTLS historically used underscores, for example:
25402 RSA_ARCFOUR_SHA. What is more, OpenSSL complains if underscores are present
25403 in a cipher list. To make life simpler, Exim changes underscores to hyphens
25404 for OpenSSL and passes the string unchanged to GnuTLS (expecting the library
25405 to handle its own older variants) when processing lists of cipher suites in the
25406 &%tls_require_ciphers%& options (the global option and the &(smtp)& transport
25407 option).
25408 .next
25409 The &%tls_require_ciphers%& options operate differently, as described in the
25410 sections &<<SECTreqciphssl>>& and &<<SECTreqciphgnu>>&.
25411 .next
25412 .new
25413 The &%tls_dh_min_bits%& SMTP transport option is only honoured by GnuTLS.
25414 When using OpenSSL, this option is ignored.
25415 (If an API is found to let OpenSSL be configured in this way,
25416 let the Exim Maintainers know and we'll likely use it).
25417 .wen
25418 .next
25419 Some other recently added features may only be available in one or the other.
25420 This should be documented with the feature.  If the documentation does not
25421 explicitly state that the feature is infeasible in the other TLS
25422 implementation, then patches are welcome.
25423 .endlist
25424
25425
25426 .section "GnuTLS parameter computation" "SECTgnutlsparam"
25427 This section only applies if &%tls_dhparam%& is set to &`historic`& or to
25428 an explicit path; if the latter, then the text about generation still applies,
25429 but not the chosen filename.
25430 By default, as of Exim 4.80 a hard-coded D-H prime is used.
25431 See the documentation of &%tls_dhparam%& for more information.
25432
25433 GnuTLS uses D-H parameters that may take a substantial amount of time
25434 to compute. It is unreasonable to re-compute them for every TLS session.
25435 Therefore, Exim keeps this data in a file in its spool directory, called
25436 &_gnutls-params-NNNN_& for some value of NNNN, corresponding to the number
25437 of bits requested.
25438 The file is owned by the Exim user and is readable only by
25439 its owner. Every Exim process that start up GnuTLS reads the D-H
25440 parameters from this file. If the file does not exist, the first Exim process
25441 that needs it computes the data and writes it to a temporary file which is
25442 renamed once it is complete. It does not matter if several Exim processes do
25443 this simultaneously (apart from wasting a few resources). Once a file is in
25444 place, new Exim processes immediately start using it.
25445
25446 For maximum security, the parameters that are stored in this file should be
25447 recalculated periodically, the frequency depending on your paranoia level.
25448 If you are avoiding using the fixed D-H primes published in RFCs, then you
25449 are concerned about some advanced attacks and will wish to do this; if you do
25450 not regenerate then you might as well stick to the standard primes.
25451
25452 Arranging this is easy in principle; just delete the file when you want new
25453 values to be computed. However, there may be a problem. The calculation of new
25454 parameters needs random numbers, and these are obtained from &_/dev/random_&.
25455 If the system is not very active, &_/dev/random_& may delay returning data
25456 until enough randomness (entropy) is available. This may cause Exim to hang for
25457 a substantial amount of time, causing timeouts on incoming connections.
25458
25459 The solution is to generate the parameters externally to Exim. They are stored
25460 in &_gnutls-params-N_& in PEM format, which means that they can be
25461 generated externally using the &(certtool)& command that is part of GnuTLS.
25462
25463 To replace the parameters with new ones, instead of deleting the file
25464 and letting Exim re-create it, you can generate new parameters using
25465 &(certtool)& and, when this has been done, replace Exim's cache file by
25466 renaming. The relevant commands are something like this:
25467 .code
25468 # ls
25469 [ look for file; assume gnutls-params-2236 is the most recent ]
25470 # rm -f new-params
25471 # touch new-params
25472 # chown exim:exim new-params
25473 # chmod 0600 new-params
25474 # certtool --generate-dh-params --bits 2236 >>new-params
25475 # openssl dhparam -noout -text -in new-params | head
25476 [ check the first line, make sure it's not more than 2236;
25477   if it is, then go back to the start ("rm") and repeat
25478   until the size generated is at most the size requested ]
25479 # chmod 0400 new-params
25480 # mv new-params gnutls-params-2236
25481 .endd
25482 If Exim never has to generate the parameters itself, the possibility of
25483 stalling is removed.
25484
25485 The filename changed in Exim 4.80, to gain the -bits suffix.  The value which
25486 Exim will choose depends upon the version of GnuTLS in use.  For older GnuTLS,
25487 the value remains hard-coded in Exim as 1024.  As of GnuTLS 2.12.x, there is
25488 a way for Exim to ask for the "normal" number of bits for D-H public-key usage,
25489 and Exim does so.  This attempt to remove Exim from TLS policy decisions
25490 failed, as GnuTLS 2.12 returns a value higher than the current hard-coded limit
25491 of the NSS library.  Thus Exim gains the &%tls_dh_max_bits%& global option,
25492 which applies to all D-H usage, client or server.  If the value returned by
25493 GnuTLS is greater than &%tls_dh_max_bits%& then the value will be clamped down
25494 to &%tls_dh_max_bits%&.  The default value has been set at the current NSS
25495 limit, which is still much higher than Exim historically used.
25496
25497 The filename and bits used will change as the GnuTLS maintainers change the
25498 value for their parameter &`GNUTLS_SEC_PARAM_NORMAL`&, as clamped by
25499 &%tls_dh_max_bits%&.  At the time of writing (mid 2012), GnuTLS 2.12 recommends
25500 2432 bits, while NSS is limited to 2236 bits.
25501
25502 In fact, the requested value will be *lower* than &%tls_dh_max_bits%&, to
25503 increase the chance of the generated prime actually being within acceptable
25504 bounds, as GnuTLS has been observed to overshoot.  Note the check step in the
25505 procedure above.  There is no sane procedure available to Exim to double-check
25506 the size of the generated prime, so it might still be too large.
25507
25508
25509 .section "Requiring specific ciphers in OpenSSL" "SECTreqciphssl"
25510 .cindex "TLS" "requiring specific ciphers (OpenSSL)"
25511 .oindex "&%tls_require_ciphers%&" "OpenSSL"
25512 There is a function in the OpenSSL library that can be passed a list of cipher
25513 suites before the cipher negotiation takes place. This specifies which ciphers
25514 are acceptable. The list is colon separated and may contain names like
25515 DES-CBC3-SHA. Exim passes the expanded value of &%tls_require_ciphers%&
25516 directly to this function call.
25517 Many systems will install the OpenSSL manual-pages, so you may have
25518 &'ciphers(1)'& available to you.
25519 The following quotation from the OpenSSL
25520 documentation specifies what forms of item are allowed in the cipher string:
25521
25522 .ilist
25523 It can consist of a single cipher suite such as RC4-SHA.
25524 .next
25525 It can represent a list of cipher suites containing a certain algorithm,
25526 or cipher suites of a certain type. For example SHA1 represents all
25527 ciphers suites using the digest algorithm SHA1 and SSLv3 represents all
25528 SSL v3 algorithms.
25529 .next
25530 Lists of cipher suites can be combined in a single cipher string using
25531 the + character. This is used as a logical and operation. For example
25532 SHA1+DES represents all cipher suites containing the SHA1 and the DES
25533 algorithms.
25534 .endlist
25535
25536 Each cipher string can be optionally preceded by one of the characters &`!`&,
25537 &`-`& or &`+`&.
25538 .ilist
25539 If &`!`& is used, the ciphers are permanently deleted from the list. The
25540 ciphers deleted can never reappear in the list even if they are explicitly
25541 stated.
25542 .next
25543 If &`-`& is used, the ciphers are deleted from the list, but some or all
25544 of the ciphers can be added again by later options.
25545 .next
25546 If &`+`& is used, the ciphers are moved to the end of the list. This
25547 option does not add any new ciphers; it just moves matching existing ones.
25548 .endlist
25549
25550 If none of these characters is present, the string is interpreted as
25551 a list of ciphers to be appended to the current preference list. If the list
25552 includes any ciphers already present they will be ignored: that is, they will
25553 not be moved to the end of the list.
25554 .endlist
25555
25556 The OpenSSL &'ciphers(1)'& command may be used to test the results of a given
25557 string:
25558 .code
25559 # note single-quotes to get ! past any shell history expansion
25560 $ openssl ciphers 'HIGH:!MD5:!SHA1'
25561 .endd
25562
25563 This example will let the library defaults be permitted on the MX port, where
25564 there's probably no identity verification anyway, but ups the ante on the
25565 submission ports where the administrator might have some influence on the
25566 choice of clients used:
25567 .code
25568 # OpenSSL variant; see man ciphers(1)
25569 tls_require_ciphers = ${if =={$received_port}{25}\
25570                            {DEFAULT}\
25571                            {HIGH:!MD5:!SHA1}}
25572 .endd
25573
25574
25575
25576 .section "Requiring specific ciphers or other parameters in GnuTLS" &&&
25577          "SECTreqciphgnu"
25578 .cindex "GnuTLS" "specifying parameters for"
25579 .cindex "TLS" "specifying ciphers (GnuTLS)"
25580 .cindex "TLS" "specifying key exchange methods (GnuTLS)"
25581 .cindex "TLS" "specifying MAC algorithms (GnuTLS)"
25582 .cindex "TLS" "specifying protocols (GnuTLS)"
25583 .cindex "TLS" "specifying priority string (GnuTLS)"
25584 .oindex "&%tls_require_ciphers%&" "GnuTLS"
25585 The GnuTLS library allows the caller to provide a "priority string", documented
25586 as part of the &[gnutls_priority_init]& function.  This is very similar to the
25587 ciphersuite specification in OpenSSL.
25588
25589 The &%tls_require_ciphers%& option is treated as the GnuTLS priority string.
25590
25591 The &%tls_require_ciphers%& option is available both as an global option,
25592 controlling how Exim behaves as a server, and also as an option of the
25593 &(smtp)& transport, controlling how Exim behaves as a client.  In both cases
25594 the value is string expanded.  The resulting string is not an Exim list and
25595 the string is given to the GnuTLS library, so that Exim does not need to be
25596 aware of future feature enhancements of GnuTLS.
25597
25598 Documentation of the strings accepted may be found in the GnuTLS manual, under
25599 "Priority strings".  This is online as
25600 &url(http://www.gnu.org/software/gnutls/manual/html_node/Priority-Strings.html),
25601 but beware that this relates to GnuTLS 3, which may be newer than the version
25602 installed on your system.  If you are using GnuTLS 3,
25603 &url(http://www.gnu.org/software/gnutls/manual/html_node/Listing-the-ciphersuites-in-a-priority-string.html, then the example code)
25604 on that site can be used to test a given string.
25605
25606 Prior to Exim 4.80, an older API of GnuTLS was used, and Exim supported three
25607 additional options, "&%gnutls_require_kx%&", "&%gnutls_require_mac%&" and
25608 "&%gnutls_require_protocols%&".  &%tls_require_ciphers%& was an Exim list.
25609
25610 This example will let the library defaults be permitted on the MX port, where
25611 there's probably no identity verification anyway, and lowers security further
25612 by increasing compatibility; but this ups the ante on the submission ports
25613 where the administrator might have some influence on the choice of clients
25614 used:
25615 .code
25616 # GnuTLS variant
25617 tls_require_ciphers = ${if =={$received_port}{25}\
25618                            {NORMAL:%COMPAT}\
25619                            {SECURE128}}
25620 .endd
25621
25622
25623 .section "Configuring an Exim server to use TLS" "SECID182"
25624 .cindex "TLS" "configuring an Exim server"
25625 When Exim has been built with TLS support, it advertises the availability of
25626 the STARTTLS command to client hosts that match &%tls_advertise_hosts%&,
25627 but not to any others. The default value of this option is unset, which means
25628 that STARTTLS is not advertised at all. This default is chosen because you
25629 need to set some other options in order to make TLS available, and also it is
25630 sensible for systems that want to use TLS only as a client.
25631
25632 If a client issues a STARTTLS command and there is some configuration
25633 problem in the server, the command is rejected with a 454 error. If the client
25634 persists in trying to issue SMTP commands, all except QUIT are rejected
25635 with the error
25636 .code
25637 554 Security failure
25638 .endd
25639 If a STARTTLS command is issued within an existing TLS session, it is
25640 rejected with a 554 error code.
25641
25642 To enable TLS operations on a server, you must set &%tls_advertise_hosts%& to
25643 match some hosts. You can, of course, set it to * to match all hosts.
25644 However, this is not all you need to do. TLS sessions to a server won't work
25645 without some further configuration at the server end.
25646
25647 It is rumoured that all existing clients that support TLS/SSL use RSA
25648 encryption. To make this work you need to set, in the server,
25649 .code
25650 tls_certificate = /some/file/name
25651 tls_privatekey = /some/file/name
25652 .endd
25653 These options are, in fact, expanded strings, so you can make them depend on
25654 the identity of the client that is connected if you wish. The first file
25655 contains the server's X509 certificate, and the second contains the private key
25656 that goes with it. These files need to be readable by the Exim user, and must
25657 always be given as full path names. They can be the same file if both the
25658 certificate and the key are contained within it. If &%tls_privatekey%& is not
25659 set, or if its expansion is forced to fail or results in an empty string, this
25660 is assumed to be the case. The certificate file may also contain intermediate
25661 certificates that need to be sent to the client to enable it to authenticate
25662 the server's certificate.
25663
25664 If you do not understand about certificates and keys, please try to find a
25665 source of this background information, which is not Exim-specific. (There are a
25666 few comments below in section &<<SECTcerandall>>&.)
25667
25668 &*Note*&: These options do not apply when Exim is operating as a client &--
25669 they apply only in the case of a server. If you need to use a certificate in an
25670 Exim client, you must set the options of the same names in an &(smtp)&
25671 transport.
25672
25673 With just these options, an Exim server will be able to use TLS. It does not
25674 require the client to have a certificate (but see below for how to insist on
25675 this). There is one other option that may be needed in other situations. If
25676 .code
25677 tls_dhparam = /some/file/name
25678 .endd
25679 is set, the SSL library is initialized for the use of Diffie-Hellman ciphers
25680 with the parameters contained in the file.
25681 Set this to &`none`& to disable use of DH entirely, by making no prime
25682 available:
25683 .code
25684 tls_dhparam = none
25685 .endd
25686 This may also be set to a string identifying a standard prime to be used for
25687 DH; if it is set to &`default`& or, for OpenSSL, is unset, then the prime
25688 used is &`ike23`&.  There are a few standard primes available, see the
25689 documetnation for &%tls_dhparam%& for the complete list.
25690
25691 See the command
25692 .code
25693 openssl dhparam
25694 .endd
25695 for a way of generating file data.
25696
25697 The strings supplied for these three options are expanded every time a client
25698 host connects. It is therefore possible to use different certificates and keys
25699 for different hosts, if you so wish, by making use of the client's IP address
25700 in &$sender_host_address$& to control the expansion. If a string expansion is
25701 forced to fail, Exim behaves as if the option is not set.
25702
25703 .cindex "cipher" "logging"
25704 .cindex "log" "TLS cipher"
25705 .vindex "&$tls_in_cipher$&"
25706 The variable &$tls_in_cipher$& is set to the cipher suite that was negotiated for
25707 an incoming TLS connection. It is included in the &'Received:'& header of an
25708 incoming message (by default &-- you can, of course, change this), and it is
25709 also included in the log line that records a message's arrival, keyed by
25710 &"X="&, unless the &%tls_cipher%& log selector is turned off. The &%encrypted%&
25711 condition can be used to test for specific cipher suites in ACLs.
25712
25713 Once TLS has been established, the ACLs that run for subsequent SMTP commands
25714 can check the name of the cipher suite and vary their actions accordingly. The
25715 cipher suite names vary, depending on which TLS library is being used. For
25716 example, OpenSSL uses the name DES-CBC3-SHA for the cipher suite which in other
25717 contexts is known as TLS_RSA_WITH_3DES_EDE_CBC_SHA. Check the OpenSSL or GnuTLS
25718 documentation for more details.
25719
25720 For outgoing SMTP deliveries, &$tls_out_cipher$& is used and logged
25721 (again depending on the &%tls_cipher%& log selector).
25722
25723
25724 .section "Requesting and verifying client certificates" "SECID183"
25725 .cindex "certificate" "verification of client"
25726 .cindex "TLS" "client certificate verification"
25727 If you want an Exim server to request a certificate when negotiating a TLS
25728 session with a client, you must set either &%tls_verify_hosts%& or
25729 &%tls_try_verify_hosts%&. You can, of course, set either of them to * to
25730 apply to all TLS connections. For any host that matches one of these options,
25731 Exim requests a certificate as part of the setup of the TLS session. The
25732 contents of the certificate are verified by comparing it with a list of
25733 expected certificates. These must be available in a file or,
25734 for OpenSSL only (not GnuTLS), a directory, identified by
25735 &%tls_verify_certificates%&.
25736
25737 A file can contain multiple certificates, concatenated end to end. If a
25738 directory is used
25739 (OpenSSL only),
25740 each certificate must be in a separate file, with a name (or a symbolic link)
25741 of the form <&'hash'&>.0, where <&'hash'&> is a hash value constructed from the
25742 certificate. You can compute the relevant hash by running the command
25743 .code
25744 openssl x509 -hash -noout -in /cert/file
25745 .endd
25746 where &_/cert/file_& contains a single certificate.
25747
25748 The difference between &%tls_verify_hosts%& and &%tls_try_verify_hosts%& is
25749 what happens if the client does not supply a certificate, or if the certificate
25750 does not match any of the certificates in the collection named by
25751 &%tls_verify_certificates%&. If the client matches &%tls_verify_hosts%&, the
25752 attempt to set up a TLS session is aborted, and the incoming connection is
25753 dropped. If the client matches &%tls_try_verify_hosts%&, the (encrypted) SMTP
25754 session continues. ACLs that run for subsequent SMTP commands can detect the
25755 fact that no certificate was verified, and vary their actions accordingly. For
25756 example, you can insist on a certificate before accepting a message for
25757 relaying, but not when the message is destined for local delivery.
25758
25759 .vindex "&$tls_in_peerdn$&"
25760 When a client supplies a certificate (whether it verifies or not), the value of
25761 the Distinguished Name of the certificate is made available in the variable
25762 &$tls_in_peerdn$& during subsequent processing of the message.
25763
25764 .cindex "log" "distinguished name"
25765 Because it is often a long text string, it is not included in the log line or
25766 &'Received:'& header by default. You can arrange for it to be logged, keyed by
25767 &"DN="&, by setting the &%tls_peerdn%& log selector, and you can use
25768 &%received_header_text%& to change the &'Received:'& header. When no
25769 certificate is supplied, &$tls_in_peerdn$& is empty.
25770
25771
25772 .section "Revoked certificates" "SECID184"
25773 .cindex "TLS" "revoked certificates"
25774 .cindex "revocation list"
25775 .cindex "certificate" "revocation list"
25776 Certificate issuing authorities issue Certificate Revocation Lists (CRLs) when
25777 certificates are revoked. If you have such a list, you can pass it to an Exim
25778 server using the global option called &%tls_crl%& and to an Exim client using
25779 an identically named option for the &(smtp)& transport. In each case, the value
25780 of the option is expanded and must then be the name of a file that contains a
25781 CRL in PEM format.
25782
25783
25784 .section "Configuring an Exim client to use TLS" "SECID185"
25785 .cindex "cipher" "logging"
25786 .cindex "log" "TLS cipher"
25787 .cindex "log" "distinguished name"
25788 .cindex "TLS" "configuring an Exim client"
25789 The &%tls_cipher%& and &%tls_peerdn%& log selectors apply to outgoing SMTP
25790 deliveries as well as to incoming, the latter one causing logging of the
25791 server certificate's DN. The remaining client configuration for TLS is all
25792 within the &(smtp)& transport.
25793
25794 It is not necessary to set any options to have TLS work in the &(smtp)&
25795 transport. If Exim is built with TLS support, and TLS is advertised by a
25796 server, the &(smtp)& transport always tries to start a TLS session. However,
25797 this can be prevented by setting &%hosts_avoid_tls%& (an option of the
25798 transport) to a list of server hosts for which TLS should not be used.
25799
25800 If you do not want Exim to attempt to send messages unencrypted when an attempt
25801 to set up an encrypted connection fails in any way, you can set
25802 &%hosts_require_tls%& to a list of hosts for which encryption is mandatory. For
25803 those hosts, delivery is always deferred if an encrypted connection cannot be
25804 set up. If there are any other hosts for the address, they are tried in the
25805 usual way.
25806
25807 When the server host is not in &%hosts_require_tls%&, Exim may try to deliver
25808 the message unencrypted. It always does this if the response to STARTTLS is
25809 a 5&'xx'& code. For a temporary error code, or for a failure to negotiate a TLS
25810 session after a success response code, what happens is controlled by the
25811 &%tls_tempfail_tryclear%& option of the &(smtp)& transport. If it is false,
25812 delivery to this host is deferred, and other hosts (if available) are tried. If
25813 it is true, Exim attempts to deliver unencrypted after a 4&'xx'& response to
25814 STARTTLS, and if STARTTLS is accepted, but the subsequent TLS
25815 negotiation fails, Exim closes the current connection (because it is in an
25816 unknown state), opens a new one to the same host, and then tries the delivery
25817 unencrypted.
25818
25819 The &%tls_certificate%& and &%tls_privatekey%& options of the &(smtp)&
25820 transport provide the client with a certificate, which is passed to the server
25821 if it requests it. If the server is Exim, it will request a certificate only if
25822 &%tls_verify_hosts%& or &%tls_try_verify_hosts%& matches the client.
25823
25824 If the &%tls_verify_certificates%& option is set on the &(smtp)& transport, it
25825 must name a file or,
25826 for OpenSSL only (not GnuTLS), a directory, that contains a collection of
25827 expected server certificates. The client verifies the server's certificate
25828 against this collection, taking into account any revoked certificates that are
25829 in the list defined by &%tls_crl%&.
25830
25831 If
25832 &%tls_require_ciphers%& is set on the &(smtp)& transport, it must contain a
25833 list of permitted cipher suites. If either of these checks fails, delivery to
25834 the current host is abandoned, and the &(smtp)& transport tries to deliver to
25835 alternative hosts, if any.
25836
25837  &*Note*&:
25838 These options must be set in the &(smtp)& transport for Exim to use TLS when it
25839 is operating as a client. Exim does not assume that a server certificate (set
25840 by the global options of the same name) should also be used when operating as a
25841 client.
25842
25843 .vindex "&$host$&"
25844 .vindex "&$host_address$&"
25845 All the TLS options in the &(smtp)& transport are expanded before use, with
25846 &$host$& and &$host_address$& containing the name and address of the server to
25847 which the client is connected. Forced failure of an expansion causes Exim to
25848 behave as if the relevant option were unset.
25849
25850 .vindex &$tls_out_bits$&
25851 .vindex &$tls_out_cipher$&
25852 .vindex &$tls_out_peerdn$&
25853 .vindex &$tls_out_sni$&
25854 Before an SMTP connection is established, the
25855 &$tls_out_bits$&, &$tls_out_cipher$&, &$tls_out_peerdn$& and &$tls_out_sni$&
25856 variables are emptied. (Until the first connection, they contain the values
25857 that were set when the message was received.) If STARTTLS is subsequently
25858 successfully obeyed, these variables are set to the relevant values for the
25859 outgoing connection.
25860
25861
25862
25863 .section "Use of TLS Server Name Indication" "SECTtlssni"
25864 .cindex "TLS" "Server Name Indication"
25865 .vindex "&$tls_in_sni$&"
25866 .oindex "&%tls_in_sni%&"
25867 With TLS1.0 or above, there is an extension mechanism by which extra
25868 information can be included at various points in the protocol.  One of these
25869 extensions, documented in RFC 6066 (and before that RFC 4366) is
25870 &"Server Name Indication"&, commonly &"SNI"&.  This extension is sent by the
25871 client in the initial handshake, so that the server can examine the servername
25872 within and possibly choose to use different certificates and keys (and more)
25873 for this session.
25874
25875 This is analagous to HTTP's &"Host:"& header, and is the main mechanism by
25876 which HTTPS-enabled web-sites can be virtual-hosted, many sites to one IP
25877 address.
25878
25879 With SMTP to MX, there are the same problems here as in choosing the identity
25880 against which to validate a certificate: you can't rely on insecure DNS to
25881 provide the identity which you then cryptographically verify.  So this will
25882 be of limited use in that environment.
25883
25884 With SMTP to Submission, there is a well-defined hostname which clients are
25885 connecting to and can validate certificates against.  Thus clients &*can*&
25886 choose to include this information in the TLS negotiation.  If this becomes
25887 wide-spread, then hosters can choose to present different certificates to
25888 different clients.  Or even negotiate different cipher suites.
25889
25890 The &%tls_sni%& option on an SMTP transport is an expanded string; the result,
25891 if not empty, will be sent on a TLS session as part of the handshake.  There's
25892 nothing more to it.  Choosing a sensible value not derived insecurely is the
25893 only point of caution.  The &$tls_out_sni$& variable will be set to this string
25894 for the lifetime of the client connection (including during authentication).
25895
25896 Except during SMTP client sessions, if &$tls_in_sni$& is set then it is a string
25897 received from a client.
25898 It can be logged with the &%log_selector%& item &`+tls_sni`&.
25899
25900 If the string &`tls_in_sni`& appears in the main section's &%tls_certificate%&
25901 option (prior to expansion) then the following options will be re-expanded
25902 during TLS session handshake, to permit alternative values to be chosen:
25903
25904 .ilist
25905 .vindex "&%tls_certificate%&"
25906 &%tls_certificate%&
25907 .next
25908 .vindex "&%tls_crl%&"
25909 &%tls_crl%&
25910 .next
25911 .vindex "&%tls_privatekey%&"
25912 &%tls_privatekey%&
25913 .next
25914 .vindex "&%tls_verify_certificates%&"
25915 &%tls_verify_certificates%&
25916 .endlist
25917
25918 Great care should be taken to deal with matters of case, various injection
25919 attacks in the string (&`../`& or SQL), and ensuring that a valid filename
25920 can always be referenced; it is important to remember that &$tls_sni$& is
25921 arbitrary unverified data provided prior to authentication.
25922
25923 The Exim developers are proceeding cautiously and so far no other TLS options
25924 are re-expanded.
25925
25926 When Exim is built againt OpenSSL, OpenSSL must have been built with support
25927 for TLS Extensions.  This holds true for OpenSSL 1.0.0+ and 0.9.8+ with
25928 enable-tlsext in EXTRACONFIGURE.  If you invoke &(openssl s_client -h)& and
25929 see &`-servername`& in the output, then OpenSSL has support.
25930
25931 When Exim is built against GnuTLS, SNI support is available as of GnuTLS
25932 0.5.10.  (Its presence predates the current API which Exim uses, so if Exim
25933 built, then you have SNI support).
25934
25935
25936
25937 .section "Multiple messages on the same encrypted TCP/IP connection" &&&
25938          "SECTmulmessam"
25939 .cindex "multiple SMTP deliveries with TLS"
25940 .cindex "TLS" "multiple message deliveries"
25941 Exim sends multiple messages down the same TCP/IP connection by starting up
25942 an entirely new delivery process for each message, passing the socket from
25943 one process to the next. This implementation does not fit well with the use
25944 of TLS, because there is quite a lot of state information associated with a TLS
25945 connection, not just a socket identification. Passing all the state information
25946 to a new process is not feasible. Consequently, Exim shuts down an existing TLS
25947 session before passing the socket to a new process. The new process may then
25948 try to start a new TLS session, and if successful, may try to re-authenticate
25949 if AUTH is in use, before sending the next message.
25950
25951 The RFC is not clear as to whether or not an SMTP session continues in clear
25952 after TLS has been shut down, or whether TLS may be restarted again later, as
25953 just described. However, if the server is Exim, this shutdown and
25954 reinitialization works. It is not known which (if any) other servers operate
25955 successfully if the client closes a TLS session and continues with unencrypted
25956 SMTP, but there are certainly some that do not work. For such servers, Exim
25957 should not pass the socket to another process, because the failure of the
25958 subsequent attempt to use it would cause Exim to record a temporary host error,
25959 and delay other deliveries to that host.
25960
25961 To test for this case, Exim sends an EHLO command to the server after
25962 closing down the TLS session. If this fails in any way, the connection is
25963 closed instead of being passed to a new delivery process, but no retry
25964 information is recorded.
25965
25966 There is also a manual override; you can set &%hosts_nopass_tls%& on the
25967 &(smtp)& transport to match those hosts for which Exim should not pass
25968 connections to new processes if TLS has been used.
25969
25970
25971
25972
25973 .section "Certificates and all that" "SECTcerandall"
25974 .cindex "certificate" "references to discussion"
25975 In order to understand fully how TLS works, you need to know about
25976 certificates, certificate signing, and certificate authorities. This is not the
25977 place to give a tutorial, especially as I do not know very much about it
25978 myself. Some helpful introduction can be found in the FAQ for the SSL addition
25979 to Apache, currently at
25980 .display
25981 &url(http://www.modssl.org/docs/2.7/ssl_faq.html#ToC24)
25982 .endd
25983 Other parts of the &'modssl'& documentation are also helpful, and have
25984 links to further files.
25985 Eric Rescorla's book, &'SSL and TLS'&, published by Addison-Wesley (ISBN
25986 0-201-61598-3), contains both introductory and more in-depth descriptions.
25987 Some sample programs taken from the book are available from
25988 .display
25989 &url(http://www.rtfm.com/openssl-examples/)
25990 .endd
25991
25992
25993 .section "Certificate chains" "SECID186"
25994 The file named by &%tls_certificate%& may contain more than one
25995 certificate. This is useful in the case where the certificate that is being
25996 sent is validated by an intermediate certificate which the other end does
25997 not have. Multiple certificates must be in the correct order in the file.
25998 First the host's certificate itself, then the first intermediate
25999 certificate to validate the issuer of the host certificate, then the next
26000 intermediate certificate to validate the issuer of the first intermediate
26001 certificate, and so on, until finally (optionally) the root certificate.
26002 The root certificate must already be trusted by the recipient for
26003 validation to succeed, of course, but if it's not preinstalled, sending the
26004 root certificate along with the rest makes it available for the user to
26005 install if the receiving end is a client MUA that can interact with a user.
26006
26007
26008 .section "Self-signed certificates" "SECID187"
26009 .cindex "certificate" "self-signed"
26010 You can create a self-signed certificate using the &'req'& command provided
26011 with OpenSSL, like this:
26012 . ==== Do not shorten the duration here without reading and considering
26013 . ==== the text below.  Please leave it at 9999 days.
26014 .code
26015 openssl req -x509 -newkey rsa:1024 -keyout file1 -out file2 \
26016             -days 9999 -nodes
26017 .endd
26018 &_file1_& and &_file2_& can be the same file; the key and the certificate are
26019 delimited and so can be identified independently. The &%-days%& option
26020 specifies a period for which the certificate is valid. The &%-nodes%& option is
26021 important: if you do not set it, the key is encrypted with a passphrase
26022 that you are prompted for, and any use that is made of the key causes more
26023 prompting for the passphrase. This is not helpful if you are going to use
26024 this certificate and key in an MTA, where prompting is not possible.
26025
26026 . ==== I expect to still be working 26 years from now.  The less technical
26027 . ==== debt I create, in terms of storing up trouble for my later years, the
26028 . ==== happier I will be then.  We really have reached the point where we
26029 . ==== should start, at the very least, provoking thought and making folks
26030 . ==== pause before proceeding, instead of leaving all the fixes until two
26031 . ==== years before 2^31 seconds after the 1970 Unix epoch.
26032 . ==== -pdp, 2012
26033 NB: we are now past the point where 9999 days takes us past the 32-bit Unix
26034 epoch.  If your system uses unsigned time_t (most do) and is 32-bit, then
26035 the above command might produce a date in the past.  Think carefully about
26036 the lifetime of the systems you're deploying, and either reduce the duration
26037 of the certificate or reconsider your platform deployment.  (At time of
26038 writing, reducing the duration is the most likely choice, but the inexorable
26039 progression of time takes us steadily towards an era where this will not
26040 be a sensible resolution).
26041
26042 A self-signed certificate made in this way is sufficient for testing, and
26043 may be adequate for all your requirements if you are mainly interested in
26044 encrypting transfers, and not in secure identification.
26045
26046 However, many clients require that the certificate presented by the server be a
26047 user (also called &"leaf"& or &"site"&) certificate, and not a self-signed
26048 certificate. In this situation, the self-signed certificate described above
26049 must be installed on the client host as a trusted root &'certification
26050 authority'& (CA), and the certificate used by Exim must be a user certificate
26051 signed with that self-signed certificate.
26052
26053 For information on creating self-signed CA certificates and using them to sign
26054 user certificates, see the &'General implementation overview'& chapter of the
26055 Open-source PKI book, available online at
26056 &url(http://ospkibook.sourceforge.net/).
26057 .ecindex IIDencsmtp1
26058 .ecindex IIDencsmtp2
26059
26060
26061
26062 . ////////////////////////////////////////////////////////////////////////////
26063 . ////////////////////////////////////////////////////////////////////////////
26064
26065 .chapter "Access control lists" "CHAPACL"
26066 .scindex IIDacl "&ACL;" "description"
26067 .cindex "control of incoming mail"
26068 .cindex "message" "controlling incoming"
26069 .cindex "policy control" "access control lists"
26070 Access Control Lists (ACLs) are defined in a separate section of the run time
26071 configuration file, headed by &"begin acl"&. Each ACL definition starts with a
26072 name, terminated by a colon. Here is a complete ACL section that contains just
26073 one very small ACL:
26074 .code
26075 begin acl
26076 small_acl:
26077   accept   hosts = one.host.only
26078 .endd
26079 You can have as many lists as you like in the ACL section, and the order in
26080 which they appear does not matter. The lists are self-terminating.
26081
26082 The majority of ACLs are used to control Exim's behaviour when it receives
26083 certain SMTP commands. This applies both to incoming TCP/IP connections, and
26084 when a local process submits a message using SMTP by specifying the &%-bs%&
26085 option. The most common use is for controlling which recipients are accepted
26086 in incoming messages. In addition, you can define an ACL that is used to check
26087 local non-SMTP messages. The default configuration file contains an example of
26088 a realistic ACL for checking RCPT commands. This is discussed in chapter
26089 &<<CHAPdefconfil>>&.
26090
26091
26092 .section "Testing ACLs" "SECID188"
26093 The &%-bh%& command line option provides a way of testing your ACL
26094 configuration locally by running a fake SMTP session with which you interact.
26095 The host &'relay-test.mail-abuse.org'& provides a service for checking your
26096 relaying configuration (see section &<<SECTcheralcon>>& for more details).
26097
26098
26099
26100 .section "Specifying when ACLs are used" "SECID189"
26101 .cindex "&ACL;" "options for specifying"
26102 In order to cause an ACL to be used, you have to name it in one of the relevant
26103 options in the main part of the configuration. These options are:
26104 .cindex "AUTH" "ACL for"
26105 .cindex "DATA" "ACLs for"
26106 .cindex "ETRN" "ACL for"
26107 .cindex "EXPN" "ACL for"
26108 .cindex "HELO" "ACL for"
26109 .cindex "EHLO" "ACL for"
26110 .cindex "MAIL" "ACL for"
26111 .cindex "QUIT, ACL for"
26112 .cindex "RCPT" "ACL for"
26113 .cindex "STARTTLS, ACL for"
26114 .cindex "VRFY" "ACL for"
26115 .cindex "SMTP" "connection, ACL for"
26116 .cindex "non-SMTP messages" "ACLs for"
26117 .cindex "MIME content scanning" "ACL for"
26118
26119 .table2 140pt
26120 .irow &%acl_not_smtp%&         "ACL for non-SMTP messages"
26121 .irow &%acl_not_smtp_mime%&    "ACL for non-SMTP MIME parts"
26122 .irow &%acl_not_smtp_start%&   "ACL at start of non-SMTP message"
26123 .irow &%acl_smtp_auth%&        "ACL for AUTH"
26124 .irow &%acl_smtp_connect%&     "ACL for start of SMTP connection"
26125 .irow &%acl_smtp_data%&        "ACL after DATA is complete"
26126 .irow &%acl_smtp_etrn%&        "ACL for ETRN"
26127 .irow &%acl_smtp_expn%&        "ACL for EXPN"
26128 .irow &%acl_smtp_helo%&        "ACL for HELO or EHLO"
26129 .irow &%acl_smtp_mail%&        "ACL for MAIL"
26130 .irow &%acl_smtp_mailauth%&    "ACL for the AUTH parameter of MAIL"
26131 .irow &%acl_smtp_mime%&        "ACL for content-scanning MIME parts"
26132 .irow &%acl_smtp_notquit%&     "ACL for non-QUIT terminations"
26133 .irow &%acl_smtp_predata%&     "ACL at start of DATA command"
26134 .irow &%acl_smtp_quit%&        "ACL for QUIT"
26135 .irow &%acl_smtp_rcpt%&        "ACL for RCPT"
26136 .irow &%acl_smtp_starttls%&    "ACL for STARTTLS"
26137 .irow &%acl_smtp_vrfy%&        "ACL for VRFY"
26138 .endtable
26139
26140 For example, if you set
26141 .code
26142 acl_smtp_rcpt = small_acl
26143 .endd
26144 the little ACL defined above is used whenever Exim receives a RCPT command
26145 in an SMTP dialogue. The majority of policy tests on incoming messages can be
26146 done when RCPT commands arrive. A rejection of RCPT should cause the
26147 sending MTA to give up on the recipient address contained in the RCPT
26148 command, whereas rejection at other times may cause the client MTA to keep on
26149 trying to deliver the message. It is therefore recommended that you do as much
26150 testing as possible at RCPT time.
26151
26152
26153 .section "The non-SMTP ACLs" "SECID190"
26154 .cindex "non-SMTP messages" "ACLs for"
26155 The non-SMTP ACLs apply to all non-interactive incoming messages, that is, they
26156 apply to batched SMTP as well as to non-SMTP messages. (Batched SMTP is not
26157 really SMTP.) Many of the ACL conditions (for example, host tests, and tests on
26158 the state of the SMTP connection such as encryption and authentication) are not
26159 relevant and are forbidden in these ACLs. However, the sender and recipients
26160 are known, so the &%senders%& and &%sender_domains%& conditions and the
26161 &$sender_address$& and &$recipients$& variables can be used. Variables such as
26162 &$authenticated_sender$& are also available. You can specify added header lines
26163 in any of these ACLs.
26164
26165 The &%acl_not_smtp_start%& ACL is run right at the start of receiving a
26166 non-SMTP message, before any of the message has been read. (This is the
26167 analogue of the &%acl_smtp_predata%& ACL for SMTP input.) In the case of
26168 batched SMTP input, it runs after the DATA command has been reached. The
26169 result of this ACL is ignored; it cannot be used to reject a message. If you
26170 really need to, you could set a value in an ACL variable here and reject based
26171 on that in the &%acl_not_smtp%& ACL. However, this ACL can be used to set
26172 controls, and in particular, it can be used to set
26173 .code
26174 control = suppress_local_fixups
26175 .endd
26176 This cannot be used in the other non-SMTP ACLs because by the time they are
26177 run, it is too late.
26178
26179 The &%acl_not_smtp_mime%& ACL is available only when Exim is compiled with the
26180 content-scanning extension. For details, see chapter &<<CHAPexiscan>>&.
26181
26182 The &%acl_not_smtp%& ACL is run just before the &[local_scan()]& function. Any
26183 kind of rejection is treated as permanent, because there is no way of sending a
26184 temporary error for these kinds of message.
26185
26186
26187 .section "The SMTP connect ACL" "SECID191"
26188 .cindex "SMTP" "connection, ACL for"
26189 .oindex &%smtp_banner%&
26190 The ACL test specified by &%acl_smtp_connect%& happens at the start of an SMTP
26191 session, after the test specified by &%host_reject_connection%& (which is now
26192 an anomaly) and any TCP Wrappers testing (if configured). If the connection is
26193 accepted by an &%accept%& verb that has a &%message%& modifier, the contents of
26194 the message override the banner message that is otherwise specified by the
26195 &%smtp_banner%& option.
26196
26197
26198 .section "The EHLO/HELO ACL" "SECID192"
26199 .cindex "EHLO" "ACL for"
26200 .cindex "HELO" "ACL for"
26201 The ACL test specified by &%acl_smtp_helo%& happens when the client issues an
26202 EHLO or HELO command, after the tests specified by &%helo_accept_junk_hosts%&,
26203 &%helo_allow_chars%&, &%helo_verify_hosts%&, and &%helo_try_verify_hosts%&.
26204 Note that a client may issue more than one EHLO or HELO command in an SMTP
26205 session, and indeed is required to issue a new EHLO or HELO after successfully
26206 setting up encryption following a STARTTLS command.
26207
26208 If the command is accepted by an &%accept%& verb that has a &%message%&
26209 modifier, the message may not contain more than one line (it will be truncated
26210 at the first newline and a panic logged if it does). Such a message cannot
26211 affect the EHLO options that are listed on the second and subsequent lines of
26212 an EHLO response.
26213
26214
26215 .section "The DATA ACLs" "SECID193"
26216 .cindex "DATA" "ACLs for"
26217 Two ACLs are associated with the DATA command, because it is two-stage
26218 command, with two responses being sent to the client.
26219 When the DATA command is received, the ACL defined by &%acl_smtp_predata%&
26220 is obeyed. This gives you control after all the RCPT commands, but before
26221 the message itself is received. It offers the opportunity to give a negative
26222 response to the DATA command before the data is transmitted. Header lines
26223 added by MAIL or RCPT ACLs are not visible at this time, but any that
26224 are defined here are visible when the &%acl_smtp_data%& ACL is run.
26225
26226 You cannot test the contents of the message, for example, to verify addresses
26227 in the headers, at RCPT time or when the DATA command is received. Such
26228 tests have to appear in the ACL that is run after the message itself has been
26229 received, before the final response to the DATA command is sent. This is
26230 the ACL specified by &%acl_smtp_data%&, which is the second ACL that is
26231 associated with the DATA command.
26232
26233 For both of these ACLs, it is not possible to reject individual recipients. An
26234 error response rejects the entire message. Unfortunately, it is known that some
26235 MTAs do not treat hard (5&'xx'&) responses to the DATA command (either
26236 before or after the data) correctly &-- they keep the message on their queues
26237 and try again later, but that is their problem, though it does waste some of
26238 your resources.
26239
26240 The &%acl_smtp_data%& ACL is run after both the &%acl_smtp_dkim%& and
26241 the &%acl_smtp_mime%& ACLs.
26242
26243
26244 .section "The SMTP DKIM ACL" "SECTDKIMACL"
26245 The &%acl_smtp_dkim%& ACL is available only when Exim is compiled with DKIM support
26246 enabled (which is the default).
26247
26248 The ACL test specified by &%acl_smtp_dkim%& happens after a message has been
26249 received, and is executed for each DKIM signature found in a message.  If not
26250 otherwise specified, the default action is to accept.
26251
26252 This ACL is evaluated before &%acl_smtp_mime%& and &%acl_smtp_data%&.
26253
26254 For details on the operation of DKIM, see chapter &<<CHAPdkim>>&.
26255
26256
26257 .section "The SMTP MIME ACL" "SECID194"
26258 The &%acl_smtp_mime%& option is available only when Exim is compiled with the
26259 content-scanning extension. For details, see chapter &<<CHAPexiscan>>&.
26260
26261 This ACL is evaluated after &%acl_smtp_dkim%& but before &%acl_smtp_data%&.
26262
26263
26264 .section "The QUIT ACL" "SECTQUITACL"
26265 .cindex "QUIT, ACL for"
26266 The ACL for the SMTP QUIT command is anomalous, in that the outcome of the ACL
26267 does not affect the response code to QUIT, which is always 221. Thus, the ACL
26268 does not in fact control any access. For this reason, the only verbs that are
26269 permitted are &%accept%& and &%warn%&.
26270
26271 This ACL can be used for tasks such as custom logging at the end of an SMTP
26272 session. For example, you can use ACL variables in other ACLs to count
26273 messages, recipients, etc., and log the totals at QUIT time using one or
26274 more &%logwrite%& modifiers on a &%warn%& verb.
26275
26276 &*Warning*&: Only the &$acl_c$&&'x'& variables can be used for this, because
26277 the &$acl_m$&&'x'& variables are reset at the end of each incoming message.
26278
26279 You do not need to have a final &%accept%&, but if you do, you can use a
26280 &%message%& modifier to specify custom text that is sent as part of the 221
26281 response to QUIT.
26282
26283 This ACL is run only for a &"normal"& QUIT. For certain kinds of disastrous
26284 failure (for example, failure to open a log file, or when Exim is bombing out
26285 because it has detected an unrecoverable error), all SMTP commands from the
26286 client are given temporary error responses until QUIT is received or the
26287 connection is closed. In these special cases, the QUIT ACL does not run.
26288
26289
26290 .section "The not-QUIT ACL" "SECTNOTQUITACL"
26291 .vindex &$acl_smtp_notquit$&
26292 The not-QUIT ACL, specified by &%acl_smtp_notquit%&, is run in most cases when
26293 an SMTP session ends without sending QUIT. However, when Exim itself is in bad
26294 trouble, such as being unable to write to its log files, this ACL is not run,
26295 because it might try to do things (such as write to log files) that make the
26296 situation even worse.
26297
26298 Like the QUIT ACL, this ACL is provided to make it possible to do customized
26299 logging or to gather statistics, and its outcome is ignored. The &%delay%&
26300 modifier is forbidden in this ACL, and the only permitted verbs are &%accept%&
26301 and &%warn%&.
26302
26303 .vindex &$smtp_notquit_reason$&
26304 When the not-QUIT ACL is running, the variable &$smtp_notquit_reason$& is set
26305 to a string that indicates the reason for the termination of the SMTP
26306 connection. The possible values are:
26307 .table2
26308 .irow &`acl-drop`&                 "Another ACL issued a &%drop%& command"
26309 .irow &`bad-commands`&             "Too many unknown or non-mail commands"
26310 .irow &`command-timeout`&          "Timeout while reading SMTP commands"
26311 .irow &`connection-lost`&          "The SMTP connection has been lost"
26312 .irow &`data-timeout`&             "Timeout while reading message data"
26313 .irow &`local-scan-error`&         "The &[local_scan()]& function crashed"
26314 .irow &`local-scan-timeout`&       "The &[local_scan()]& function timed out"
26315 .irow &`signal-exit`&              "SIGTERM or SIGINT"
26316 .irow &`synchronization-error`&    "SMTP synchronization error"
26317 .irow &`tls-failed`&               "TLS failed to start"
26318 .endtable
26319 In most cases when an SMTP connection is closed without having received QUIT,
26320 Exim sends an SMTP response message before actually closing the connection.
26321 With the exception of the &`acl-drop`& case, the default message can be
26322 overridden by the &%message%& modifier in the not-QUIT ACL. In the case of a
26323 &%drop%& verb in another ACL, it is the message from the other ACL that is
26324 used.
26325
26326
26327 .section "Finding an ACL to use" "SECID195"
26328 .cindex "&ACL;" "finding which to use"
26329 The value of an &%acl_smtp_%&&'xxx'& option is expanded before use, so
26330 you can use different ACLs in different circumstances. For example,
26331 .code
26332 acl_smtp_rcpt = ${if ={25}{$interface_port} \
26333                      {acl_check_rcpt} {acl_check_rcpt_submit} }
26334 .endd
26335 In the default configuration file there are some example settings for
26336 providing an RFC 4409 message submission service on port 587 and a
26337 non-standard &"smtps"& service on port 465. You can use a string
26338 expansion like this to choose an ACL for MUAs on these ports which is
26339 more appropriate for this purpose than the default ACL on port 25.
26340
26341 The expanded string does not have to be the name of an ACL in the
26342 configuration file; there are other possibilities. Having expanded the
26343 string, Exim searches for an ACL as follows:
26344
26345 .ilist
26346 If the string begins with a slash, Exim uses it as a file name, and reads its
26347 contents as an ACL. The lines are processed in the same way as lines in the
26348 Exim configuration file. In particular, continuation lines are supported, blank
26349 lines are ignored, as are lines whose first non-whitespace character is &"#"&.
26350 If the file does not exist or cannot be read, an error occurs (typically
26351 causing a temporary failure of whatever caused the ACL to be run). For example:
26352 .code
26353 acl_smtp_data = /etc/acls/\
26354   ${lookup{$sender_host_address}lsearch\
26355   {/etc/acllist}{$value}{default}}
26356 .endd
26357 This looks up an ACL file to use on the basis of the host's IP address, falling
26358 back to a default if the lookup fails. If an ACL is successfully read from a
26359 file, it is retained in memory for the duration of the Exim process, so that it
26360 can be re-used without having to re-read the file.
26361 .next
26362 If the string does not start with a slash, and does not contain any spaces,
26363 Exim searches the ACL section of the configuration for an ACL whose name
26364 matches the string.
26365 .next
26366 If no named ACL is found, or if the string contains spaces, Exim parses
26367 the string as an inline ACL. This can save typing in cases where you just
26368 want to have something like
26369 .code
26370 acl_smtp_vrfy = accept
26371 .endd
26372 in order to allow free use of the VRFY command. Such a string may contain
26373 newlines; it is processed in the same way as an ACL that is read from a file.
26374 .endlist
26375
26376
26377
26378
26379 .section "ACL return codes" "SECID196"
26380 .cindex "&ACL;" "return codes"
26381 Except for the QUIT ACL, which does not affect the SMTP return code (see
26382 section &<<SECTQUITACL>>& above), the result of running an ACL is either
26383 &"accept"& or &"deny"&, or, if some test cannot be completed (for example, if a
26384 database is down), &"defer"&. These results cause 2&'xx'&, 5&'xx'&, and 4&'xx'&
26385 return codes, respectively, to be used in the SMTP dialogue. A fourth return,
26386 &"error"&, occurs when there is an error such as invalid syntax in the ACL.
26387 This also causes a 4&'xx'& return code.
26388
26389 For the non-SMTP ACL, &"defer"& and &"error"& are treated in the same way as
26390 &"deny"&, because there is no mechanism for passing temporary errors to the
26391 submitters of non-SMTP messages.
26392
26393
26394 ACLs that are relevant to message reception may also return &"discard"&. This
26395 has the effect of &"accept"&, but causes either the entire message or an
26396 individual recipient address to be discarded. In other words, it is a
26397 blackholing facility. Use it with care.
26398
26399 If the ACL for MAIL returns &"discard"&, all recipients are discarded, and no
26400 ACL is run for subsequent RCPT commands. The effect of &"discard"& in a
26401 RCPT ACL is to discard just the one recipient address. If there are no
26402 recipients left when the message's data is received, the DATA ACL is not
26403 run. A &"discard"& return from the DATA or the non-SMTP ACL discards all the
26404 remaining recipients. The &"discard"& return is not permitted for the
26405 &%acl_smtp_predata%& ACL.
26406
26407
26408 .cindex "&[local_scan()]& function" "when all recipients discarded"
26409 The &[local_scan()]& function is always run, even if there are no remaining
26410 recipients; it may create new recipients.
26411
26412
26413
26414 .section "Unset ACL options" "SECID197"
26415 .cindex "&ACL;" "unset options"
26416 The default actions when any of the &%acl_%&&'xxx'& options are unset are not
26417 all the same. &*Note*&: These defaults apply only when the relevant ACL is
26418 not defined at all. For any defined ACL, the default action when control
26419 reaches the end of the ACL statements is &"deny"&.
26420
26421 For &%acl_smtp_quit%& and &%acl_not_smtp_start%& there is no default because
26422 these two are ACLs that are used only for their side effects. They cannot be
26423 used to accept or reject anything.
26424
26425 For &%acl_not_smtp%&, &%acl_smtp_auth%&, &%acl_smtp_connect%&,
26426 &%acl_smtp_data%&, &%acl_smtp_helo%&, &%acl_smtp_mail%&, &%acl_smtp_mailauth%&,
26427 &%acl_smtp_mime%&, &%acl_smtp_predata%&, and &%acl_smtp_starttls%&, the action
26428 when the ACL is not defined is &"accept"&.
26429
26430 For the others (&%acl_smtp_etrn%&, &%acl_smtp_expn%&, &%acl_smtp_rcpt%&, and
26431 &%acl_smtp_vrfy%&), the action when the ACL is not defined is &"deny"&.
26432 This means that &%acl_smtp_rcpt%& must be defined in order to receive any
26433 messages over an SMTP connection. For an example, see the ACL in the default
26434 configuration file.
26435
26436
26437
26438
26439 .section "Data for message ACLs" "SECID198"
26440 .cindex "&ACL;" "data for message ACL"
26441 .vindex &$domain$&
26442 .vindex &$local_part$&
26443 .vindex &$sender_address$&
26444 .vindex &$sender_host_address$&
26445 .vindex &$smtp_command$&
26446 When a MAIL or RCPT ACL, or either of the DATA ACLs, is running, the variables
26447 that contain information about the host and the message's sender (for example,
26448 &$sender_host_address$& and &$sender_address$&) are set, and can be used in ACL
26449 statements. In the case of RCPT (but not MAIL or DATA), &$domain$& and
26450 &$local_part$& are set from the argument address. The entire SMTP command
26451 is available in &$smtp_command$&.
26452
26453 When an ACL for the AUTH parameter of MAIL is running, the variables that
26454 contain information about the host are set, but &$sender_address$& is not yet
26455 set. Section &<<SECTauthparamail>>& contains a discussion of this parameter and
26456 how it is used.
26457
26458 .vindex "&$message_size$&"
26459 The &$message_size$& variable is set to the value of the SIZE parameter on
26460 the MAIL command at MAIL, RCPT and pre-data time, or to -1 if
26461 that parameter is not given. The value is updated to the true message size by
26462 the time the final DATA ACL is run (after the message data has been
26463 received).
26464
26465 .vindex "&$rcpt_count$&"
26466 .vindex "&$recipients_count$&"
26467 The &$rcpt_count$& variable increases by one for each RCPT command received.
26468 The &$recipients_count$& variable increases by one each time a RCPT command is
26469 accepted, so while an ACL for RCPT is being processed, it contains the number
26470 of previously accepted recipients. At DATA time (for both the DATA ACLs),
26471 &$rcpt_count$& contains the total number of RCPT commands, and
26472 &$recipients_count$& contains the total number of accepted recipients.
26473
26474
26475
26476
26477
26478 .section "Data for non-message ACLs" "SECTdatfornon"
26479 .cindex "&ACL;" "data for non-message ACL"
26480 .vindex &$smtp_command_argument$&
26481 .vindex &$smtp_command$&
26482 When an ACL is being run for AUTH, EHLO, ETRN, EXPN, HELO, STARTTLS, or VRFY,
26483 the remainder of the SMTP command line is placed in &$smtp_command_argument$&,
26484 and the entire SMTP command is available in &$smtp_command$&.
26485 These variables can be tested using a &%condition%& condition. For example,
26486 here is an ACL for use with AUTH, which insists that either the session is
26487 encrypted, or the CRAM-MD5 authentication method is used. In other words, it
26488 does not permit authentication methods that use cleartext passwords on
26489 unencrypted connections.
26490 .code
26491 acl_check_auth:
26492   accept encrypted = *
26493   accept condition = ${if eq{${uc:$smtp_command_argument}}\
26494                      {CRAM-MD5}}
26495   deny   message   = TLS encryption or CRAM-MD5 required
26496 .endd
26497 (Another way of applying this restriction is to arrange for the authenticators
26498 that use cleartext passwords not to be advertised when the connection is not
26499 encrypted. You can use the generic &%server_advertise_condition%& authenticator
26500 option to do this.)
26501
26502
26503
26504 .section "Format of an ACL" "SECID199"
26505 .cindex "&ACL;" "format of"
26506 .cindex "&ACL;" "verbs, definition of"
26507 An individual ACL consists of a number of statements. Each statement starts
26508 with a verb, optionally followed by a number of conditions and &"modifiers"&.
26509 Modifiers can change the way the verb operates, define error and log messages,
26510 set variables, insert delays, and vary the processing of accepted messages.
26511
26512 If all the conditions are met, the verb is obeyed. The same condition may be
26513 used (with different arguments) more than once in the same statement. This
26514 provides a means of specifying an &"and"& conjunction between conditions. For
26515 example:
26516 .code
26517 deny  dnslists = list1.example
26518 dnslists = list2.example
26519 .endd
26520 If there are no conditions, the verb is always obeyed. Exim stops evaluating
26521 the conditions and modifiers when it reaches a condition that fails. What
26522 happens then depends on the verb (and in one case, on a special modifier). Not
26523 all the conditions make sense at every testing point. For example, you cannot
26524 test a sender address in the ACL that is run for a VRFY command.
26525
26526
26527 .section "ACL verbs" "SECID200"
26528 The ACL verbs are as follows:
26529
26530 .ilist
26531 .cindex "&%accept%& ACL verb"
26532 &%accept%&: If all the conditions are met, the ACL returns &"accept"&. If any
26533 of the conditions are not met, what happens depends on whether &%endpass%&
26534 appears among the conditions (for syntax see below). If the failing condition
26535 is before &%endpass%&, control is passed to the next ACL statement; if it is
26536 after &%endpass%&, the ACL returns &"deny"&. Consider this statement, used to
26537 check a RCPT command:
26538 .code
26539 accept domains = +local_domains
26540 endpass
26541 verify = recipient
26542 .endd
26543 If the recipient domain does not match the &%domains%& condition, control
26544 passes to the next statement. If it does match, the recipient is verified, and
26545 the command is accepted if verification succeeds. However, if verification
26546 fails, the ACL yields &"deny"&, because the failing condition is after
26547 &%endpass%&.
26548
26549 The &%endpass%& feature has turned out to be confusing to many people, so its
26550 use is not recommended nowadays. It is always possible to rewrite an ACL so
26551 that &%endpass%& is not needed, and it is no longer used in the default
26552 configuration.
26553
26554 .cindex "&%message%& ACL modifier" "with &%accept%&"
26555 If a &%message%& modifier appears on an &%accept%& statement, its action
26556 depends on whether or not &%endpass%& is present. In the absence of &%endpass%&
26557 (when an &%accept%& verb either accepts or passes control to the next
26558 statement), &%message%& can be used to vary the message that is sent when an
26559 SMTP command is accepted. For example, in a RCPT ACL you could have:
26560 .display
26561 &`accept  `&<&'some conditions'&>
26562 &`        message = OK, I will allow you through today`&
26563 .endd
26564 You can specify an SMTP response code, optionally followed by an &"extended
26565 response code"& at the start of the message, but the first digit must be the
26566 same as would be sent by default, which is 2 for an &%accept%& verb.
26567
26568 If &%endpass%& is present in an &%accept%& statement, &%message%& specifies
26569 an error message that is used when access is denied. This behaviour is retained
26570 for backward compatibility, but current &"best practice"& is to avoid the use
26571 of &%endpass%&.
26572
26573
26574 .next
26575 .cindex "&%defer%& ACL verb"
26576 &%defer%&: If all the conditions are true, the ACL returns &"defer"& which, in
26577 an SMTP session, causes a 4&'xx'& response to be given. For a non-SMTP ACL,
26578 &%defer%& is the same as &%deny%&, because there is no way of sending a
26579 temporary error. For a RCPT command, &%defer%& is much the same as using a
26580 &(redirect)& router and &`:defer:`& while verifying, but the &%defer%& verb can
26581 be used in any ACL, and even for a recipient it might be a simpler approach.
26582
26583
26584 .next
26585 .cindex "&%deny%& ACL verb"
26586 &%deny%&: If all the conditions are met, the ACL returns &"deny"&. If any of
26587 the conditions are not met, control is passed to the next ACL statement. For
26588 example,
26589 .code
26590 deny dnslists = blackholes.mail-abuse.org
26591 .endd
26592 rejects commands from hosts that are on a DNS black list.
26593
26594
26595 .next
26596 .cindex "&%discard%& ACL verb"
26597 &%discard%&: This verb behaves like &%accept%&, except that it returns
26598 &"discard"& from the ACL instead of &"accept"&. It is permitted only on ACLs
26599 that are concerned with receiving messages. When all the conditions are true,
26600 the sending entity receives a &"success"& response. However, &%discard%& causes
26601 recipients to be discarded. If it is used in an ACL for RCPT, just the one
26602 recipient is discarded; if used for MAIL, DATA or in the non-SMTP ACL, all the
26603 message's recipients are discarded. Recipients that are discarded before DATA
26604 do not appear in the log line when the &%received_recipients%& log selector is set.
26605
26606 If the &%log_message%& modifier is set when &%discard%& operates,
26607 its contents are added to the line that is automatically written to the log.
26608 The &%message%& modifier operates exactly as it does for &%accept%&.
26609
26610
26611 .next
26612 .cindex "&%drop%& ACL verb"
26613 &%drop%&: This verb behaves like &%deny%&, except that an SMTP connection is
26614 forcibly closed after the 5&'xx'& error message has been sent. For example:
26615 .code
26616 drop   message   = I don't take more than 20 RCPTs
26617        condition = ${if > {$rcpt_count}{20}}
26618 .endd
26619 There is no difference between &%deny%& and &%drop%& for the connect-time ACL.
26620 The connection is always dropped after sending a 550 response.
26621
26622 .next
26623 .cindex "&%require%& ACL verb"
26624 &%require%&: If all the conditions are met, control is passed to the next ACL
26625 statement. If any of the conditions are not met, the ACL returns &"deny"&. For
26626 example, when checking a RCPT command,
26627 .code
26628 require message = Sender did not verify
26629         verify  = sender
26630 .endd
26631 passes control to subsequent statements only if the message's sender can be
26632 verified. Otherwise, it rejects the command. Note the positioning of the
26633 &%message%& modifier, before the &%verify%& condition. The reason for this is
26634 discussed in section &<<SECTcondmodproc>>&.
26635
26636 .next
26637 .cindex "&%warn%& ACL verb"
26638 &%warn%&: If all the conditions are true, a line specified by the
26639 &%log_message%& modifier is written to Exim's main log. Control always passes
26640 to the next ACL statement. If any condition is false, the log line is not
26641 written. If an identical log line is requested several times in the same
26642 message, only one copy is actually written to the log. If you want to force
26643 duplicates to be written, use the &%logwrite%& modifier instead.
26644
26645 If &%log_message%& is not present, a &%warn%& verb just checks its conditions
26646 and obeys any &"immediate"& modifiers (such as &%control%&, &%set%&,
26647 &%logwrite%&, &%add_header%&, and &%remove_header%&) that appear before the
26648 first failing condition. There is more about adding header lines in section
26649 &<<SECTaddheadacl>>&.
26650
26651 If any condition on a &%warn%& statement cannot be completed (that is, there is
26652 some sort of defer), the log line specified by &%log_message%& is not written.
26653 This does not include the case of a forced failure from a lookup, which
26654 is considered to be a successful completion. After a defer, no further
26655 conditions or modifiers in the &%warn%& statement are processed. The incident
26656 is logged, and the ACL continues to be processed, from the next statement
26657 onwards.
26658
26659
26660 .vindex "&$acl_verify_message$&"
26661 When one of the &%warn%& conditions is an address verification that fails, the
26662 text of the verification failure message is in &$acl_verify_message$&. If you
26663 want this logged, you must set it up explicitly. For example:
26664 .code
26665 warn   !verify = sender
26666        log_message = sender verify failed: $acl_verify_message
26667 .endd
26668 .endlist
26669
26670 At the end of each ACL there is an implicit unconditional &%deny%&.
26671
26672 As you can see from the examples above, the conditions and modifiers are
26673 written one to a line, with the first one on the same line as the verb, and
26674 subsequent ones on following lines. If you have a very long condition, you can
26675 continue it onto several physical lines by the usual backslash continuation
26676 mechanism. It is conventional to align the conditions vertically.
26677
26678
26679
26680 .section "ACL variables" "SECTaclvariables"
26681 .cindex "&ACL;" "variables"
26682 There are some special variables that can be set during ACL processing. They
26683 can be used to pass information between different ACLs, different invocations
26684 of the same ACL in the same SMTP connection, and between ACLs and the routers,
26685 transports, and filters that are used to deliver a message. The names of these
26686 variables must begin with &$acl_c$& or &$acl_m$&, followed either by a digit or
26687 an underscore, but the remainder of the name can be any sequence of
26688 alphanumeric characters and underscores that you choose. There is no limit on
26689 the number of ACL variables. The two sets act as follows:
26690 .ilist
26691 The values of those variables whose names begin with &$acl_c$& persist
26692 throughout an SMTP connection. They are never reset. Thus, a value that is set
26693 while receiving one message is still available when receiving the next message
26694 on the same SMTP connection.
26695 .next
26696 The values of those variables whose names begin with &$acl_m$& persist only
26697 while a message is being received. They are reset afterwards. They are also
26698 reset by MAIL, RSET, EHLO, HELO, and after starting up a TLS session.
26699 .endlist
26700
26701 When a message is accepted, the current values of all the ACL variables are
26702 preserved with the message and are subsequently made available at delivery
26703 time. The ACL variables are set by a modifier called &%set%&. For example:
26704 .code
26705 accept hosts = whatever
26706        set acl_m4 = some value
26707 accept authenticated = *
26708        set acl_c_auth = yes
26709 .endd
26710 &*Note*&: A leading dollar sign is not used when naming a variable that is to
26711 be set. If you want to set a variable without taking any action, you can use a
26712 &%warn%& verb without any other modifiers or conditions.
26713
26714 .oindex &%strict_acl_vars%&
26715 What happens if a syntactically valid but undefined ACL variable is
26716 referenced depends on the setting of the &%strict_acl_vars%& option. If it is
26717 false (the default), an empty string is substituted; if it is true, an
26718 error is generated.
26719
26720 Versions of Exim before 4.64 have a limited set of numbered variables, but
26721 their names are compatible, so there is no problem with upgrading.
26722
26723
26724 .section "Condition and modifier processing" "SECTcondmodproc"
26725 .cindex "&ACL;" "conditions; processing"
26726 .cindex "&ACL;" "modifiers; processing"
26727 An exclamation mark preceding a condition negates its result. For example:
26728 .code
26729 deny   domains = *.dom.example
26730       !verify  = recipient
26731 .endd
26732 causes the ACL to return &"deny"& if the recipient domain ends in
26733 &'dom.example'& and the recipient address cannot be verified. Sometimes
26734 negation can be used on the right-hand side of a condition. For example, these
26735 two statements are equivalent:
26736 .code
26737 deny  hosts = !192.168.3.4
26738 deny !hosts =  192.168.3.4
26739 .endd
26740 However, for many conditions (&%verify%& being a good example), only left-hand
26741 side negation of the whole condition is possible.
26742
26743 The arguments of conditions and modifiers are expanded. A forced failure
26744 of an expansion causes a condition to be ignored, that is, it behaves as if the
26745 condition is true. Consider these two statements:
26746 .code
26747 accept  senders = ${lookup{$host_name}lsearch\
26748                   {/some/file}{$value}fail}
26749 accept  senders = ${lookup{$host_name}lsearch\
26750                   {/some/file}{$value}{}}
26751 .endd
26752 Each attempts to look up a list of acceptable senders. If the lookup succeeds,
26753 the returned list is searched, but if the lookup fails the behaviour is
26754 different in the two cases. The &%fail%& in the first statement causes the
26755 condition to be ignored, leaving no further conditions. The &%accept%& verb
26756 therefore succeeds. The second statement, however, generates an empty list when
26757 the lookup fails. No sender can match an empty list, so the condition fails,
26758 and therefore the &%accept%& also fails.
26759
26760 ACL modifiers appear mixed in with conditions in ACL statements. Some of them
26761 specify actions that are taken as the conditions for a statement are checked;
26762 others specify text for messages that are used when access is denied or a
26763 warning is generated. The &%control%& modifier affects the way an incoming
26764 message is handled.
26765
26766 The positioning of the modifiers in an ACL statement is important, because the
26767 processing of a verb ceases as soon as its outcome is known. Only those
26768 modifiers that have already been encountered will take effect. For example,
26769 consider this use of the &%message%& modifier:
26770 .code
26771 require message = Can't verify sender
26772         verify  = sender
26773         message = Can't verify recipient
26774         verify  = recipient
26775         message = This message cannot be used
26776 .endd
26777 If sender verification fails, Exim knows that the result of the statement is
26778 &"deny"&, so it goes no further. The first &%message%& modifier has been seen,
26779 so its text is used as the error message. If sender verification succeeds, but
26780 recipient verification fails, the second message is used. If recipient
26781 verification succeeds, the third message becomes &"current"&, but is never used
26782 because there are no more conditions to cause failure.
26783
26784 For the &%deny%& verb, on the other hand, it is always the last &%message%&
26785 modifier that is used, because all the conditions must be true for rejection to
26786 happen. Specifying more than one &%message%& modifier does not make sense, and
26787 the message can even be specified after all the conditions. For example:
26788 .code
26789 deny   hosts = ...
26790       !senders = *@my.domain.example
26791        message = Invalid sender from client host
26792 .endd
26793 The &"deny"& result does not happen until the end of the statement is reached,
26794 by which time Exim has set up the message.
26795
26796
26797
26798 .section "ACL modifiers" "SECTACLmodi"
26799 .cindex "&ACL;" "modifiers; list of"
26800 The ACL modifiers are as follows:
26801
26802 .vlist
26803 .vitem &*add_header*&&~=&~<&'text'&>
26804 This modifier specifies one or more header lines that are to be added to an
26805 incoming message, assuming, of course, that the message is ultimately
26806 accepted. For details, see section &<<SECTaddheadacl>>&.
26807
26808 .vitem &*continue*&&~=&~<&'text'&>
26809 .cindex "&%continue%& ACL modifier"
26810 .cindex "database" "updating in ACL"
26811 This modifier does nothing of itself, and processing of the ACL always
26812 continues with the next condition or modifier. The value of &%continue%& is in
26813 the side effects of expanding its argument. Typically this could be used to
26814 update a database. It is really just a syntactic tidiness, to avoid having to
26815 write rather ugly lines like this:
26816 .display
26817 &`condition = ${if eq{0}{`&<&'some expansion'&>&`}{true}{true}}`&
26818 .endd
26819 Instead, all you need is
26820 .display
26821 &`continue = `&<&'some expansion'&>
26822 .endd
26823
26824 .vitem &*control*&&~=&~<&'text'&>
26825 .cindex "&%control%& ACL modifier"
26826 This modifier affects the subsequent processing of the SMTP connection or of an
26827 incoming message that is accepted. The effect of the first type of control
26828 lasts for the duration of the connection, whereas the effect of the second type
26829 lasts only until the current message has been received. The message-specific
26830 controls always apply to the whole message, not to individual recipients,
26831 even if the &%control%& modifier appears in a RCPT ACL.
26832
26833 As there are now quite a few controls that can be applied, they are described
26834 separately in section &<<SECTcontrols>>&. The &%control%& modifier can be used
26835 in several different ways. For example:
26836
26837 . ==== As this is a nested list, any displays it contains must be indented
26838 . ==== as otherwise they are too far to the left. That comment applies only
26839 . ==== when xmlto and fop are used; formatting with sdop gets it right either
26840 . ==== way.
26841
26842 .ilist
26843 It can be at the end of an &%accept%& statement:
26844 .code
26845     accept  ...some conditions
26846             control = queue_only
26847 .endd
26848 In this case, the control is applied when this statement yields &"accept"&, in
26849 other words, when the conditions are all true.
26850
26851 .next
26852 It can be in the middle of an &%accept%& statement:
26853 .code
26854     accept  ...some conditions...
26855             control = queue_only
26856             ...some more conditions...
26857 .endd
26858 If the first set of conditions are true, the control is applied, even if the
26859 statement does not accept because one of the second set of conditions is false.
26860 In this case, some subsequent statement must yield &"accept"& for the control
26861 to be relevant.
26862
26863 .next
26864 It can be used with &%warn%& to apply the control, leaving the
26865 decision about accepting or denying to a subsequent verb. For
26866 example:
26867 .code
26868     warn    ...some conditions...
26869             control = freeze
26870     accept  ...
26871 .endd
26872 This example of &%warn%& does not contain &%message%&, &%log_message%&, or
26873 &%logwrite%&, so it does not add anything to the message and does not write a
26874 log entry.
26875
26876 .next
26877 If you want to apply a control unconditionally, you can use it with a
26878 &%require%& verb. For example:
26879 .code
26880     require  control = no_multiline_responses
26881 .endd
26882 .endlist
26883
26884 .vitem &*delay*&&~=&~<&'time'&>
26885 .cindex "&%delay%& ACL modifier"
26886 .oindex "&%-bh%&"
26887 This modifier may appear in any ACL except notquit. It causes Exim to wait for
26888 the time interval before proceeding. However, when testing Exim using the
26889 &%-bh%& option, the delay is not actually imposed (an appropriate message is
26890 output instead). The time is given in the usual Exim notation, and the delay
26891 happens as soon as the modifier is processed. In an SMTP session, pending
26892 output is flushed before the delay is imposed.
26893
26894 Like &%control%&, &%delay%& can be used with &%accept%& or &%deny%&, for
26895 example:
26896 .code
26897 deny    ...some conditions...
26898         delay = 30s
26899 .endd
26900 The delay happens if all the conditions are true, before the statement returns
26901 &"deny"&. Compare this with:
26902 .code
26903 deny    delay = 30s
26904         ...some conditions...
26905 .endd
26906 which waits for 30s before processing the conditions. The &%delay%& modifier
26907 can also be used with &%warn%& and together with &%control%&:
26908 .code
26909 warn    ...some conditions...
26910         delay = 2m
26911         control = freeze
26912 accept  ...
26913 .endd
26914
26915 If &%delay%& is encountered when the SMTP PIPELINING extension is in use,
26916 responses to several commands are no longer buffered and sent in one packet (as
26917 they would normally be) because all output is flushed before imposing the
26918 delay. This optimization is disabled so that a number of small delays do not
26919 appear to the client as one large aggregated delay that might provoke an
26920 unwanted timeout. You can, however, disable output flushing for &%delay%& by
26921 using a &%control%& modifier to set &%no_delay_flush%&.
26922
26923
26924 .vitem &*endpass*&
26925 .cindex "&%endpass%& ACL modifier"
26926 This modifier, which has no argument, is recognized only in &%accept%& and
26927 &%discard%& statements. It marks the boundary between the conditions whose
26928 failure causes control to pass to the next statement, and the conditions whose
26929 failure causes the ACL to return &"deny"&. This concept has proved to be
26930 confusing to some people, so the use of &%endpass%& is no longer recommended as
26931 &"best practice"&. See the description of &%accept%& above for more details.
26932
26933
26934 .vitem &*log_message*&&~=&~<&'text'&>
26935 .cindex "&%log_message%& ACL modifier"
26936 This modifier sets up a message that is used as part of the log message if the
26937 ACL denies access or a &%warn%& statement's conditions are true. For example:
26938 .code
26939 require log_message = wrong cipher suite $tls_in_cipher
26940         encrypted   = DES-CBC3-SHA
26941 .endd
26942 &%log_message%& is also used when recipients are discarded by &%discard%&. For
26943 example:
26944 .display
26945 &`discard `&<&'some conditions'&>
26946 &`        log_message = Discarded $local_part@$domain because...`&
26947 .endd
26948 When access is denied, &%log_message%& adds to any underlying error message
26949 that may exist because of a condition failure. For example, while verifying a
26950 recipient address, a &':fail:'& redirection might have already set up a
26951 message.
26952
26953 The message may be defined before the conditions to which it applies, because
26954 the string expansion does not happen until Exim decides that access is to be
26955 denied. This means that any variables that are set by the condition are
26956 available for inclusion in the message. For example, the &$dnslist_$&<&'xxx'&>
26957 variables are set after a DNS black list lookup succeeds. If the expansion of
26958 &%log_message%& fails, or if the result is an empty string, the modifier is
26959 ignored.
26960
26961 .vindex "&$acl_verify_message$&"
26962 If you want to use a &%warn%& statement to log the result of an address
26963 verification, you can use &$acl_verify_message$& to include the verification
26964 error message.
26965
26966 If &%log_message%& is used with a &%warn%& statement, &"Warning:"& is added to
26967 the start of the logged message. If the same warning log message is requested
26968 more than once while receiving  a single email message, only one copy is
26969 actually logged. If you want to log multiple copies, use &%logwrite%& instead
26970 of &%log_message%&. In the absence of &%log_message%& and &%logwrite%&, nothing
26971 is logged for a successful &%warn%& statement.
26972
26973 If &%log_message%& is not present and there is no underlying error message (for
26974 example, from the failure of address verification), but &%message%& is present,
26975 the &%message%& text is used for logging rejections. However, if any text for
26976 logging contains newlines, only the first line is logged. In the absence of
26977 both &%log_message%& and &%message%&, a default built-in message is used for
26978 logging rejections.
26979
26980
26981 .vitem "&*log_reject_target*&&~=&~<&'log name list'&>"
26982 .cindex "&%log_reject_target%& ACL modifier"
26983 .cindex "logging in ACL" "specifying which log"
26984 This modifier makes it possible to specify which logs are used for messages
26985 about ACL rejections. Its argument is a colon-separated list of words that can
26986 be &"main"&, &"reject"&, or &"panic"&. The default is &`main:reject`&. The list
26987 may be empty, in which case a rejection is not logged at all. For example, this
26988 ACL fragment writes no logging information when access is denied:
26989 .display
26990 &`deny `&<&'some conditions'&>
26991 &`     log_reject_target =`&
26992 .endd
26993 This modifier can be used in SMTP and non-SMTP ACLs. It applies to both
26994 permanent and temporary rejections. Its effect lasts for the rest of the
26995 current ACL.
26996
26997
26998 .vitem &*logwrite*&&~=&~<&'text'&>
26999 .cindex "&%logwrite%& ACL modifier"
27000 .cindex "logging in ACL" "immediate"
27001 This modifier writes a message to a log file as soon as it is encountered when
27002 processing an ACL. (Compare &%log_message%&, which, except in the case of
27003 &%warn%& and &%discard%&, is used only if the ACL statement denies
27004 access.) The &%logwrite%& modifier can be used to log special incidents in
27005 ACLs. For example:
27006 .display
27007 &`accept `&<&'some special conditions'&>
27008 &`       control  = freeze`&
27009 &`       logwrite = froze message because ...`&
27010 .endd
27011 By default, the message is written to the main log. However, it may begin
27012 with a colon, followed by a comma-separated list of log names, and then
27013 another colon, to specify exactly which logs are to be written. For
27014 example:
27015 .code
27016 logwrite = :main,reject: text for main and reject logs
27017 logwrite = :panic: text for panic log only
27018 .endd
27019
27020
27021 .vitem &*message*&&~=&~<&'text'&>
27022 .cindex "&%message%& ACL modifier"
27023 This modifier sets up a text string that is expanded and used as a response
27024 message when an ACL statement terminates the ACL with an &"accept"&, &"deny"&,
27025 or &"defer"& response. (In the case of the &%accept%& and &%discard%& verbs,
27026 there is some complication if &%endpass%& is involved; see the description of
27027 &%accept%& for details.)
27028
27029 The expansion of the message happens at the time Exim decides that the ACL is
27030 to end, not at the time it processes &%message%&. If the expansion fails, or
27031 generates an empty string, the modifier is ignored. Here is an example where
27032 &%message%& must be specified first, because the ACL ends with a rejection if
27033 the &%hosts%& condition fails:
27034 .code
27035 require  message = Host not recognized
27036          hosts = 10.0.0.0/8
27037 .endd
27038 (Once a condition has failed, no further conditions or modifiers are
27039 processed.)
27040
27041 .cindex "SMTP" "error codes"
27042 .oindex "&%smtp_banner%&
27043 For ACLs that are triggered by SMTP commands, the message is returned as part
27044 of the SMTP response. The use of &%message%& with &%accept%& (or &%discard%&)
27045 is meaningful only for SMTP, as no message is returned when a non-SMTP message
27046 is accepted. In the case of the connect ACL, accepting with a message modifier
27047 overrides the value of &%smtp_banner%&. For the EHLO/HELO ACL, a customized
27048 accept message may not contain more than one line (otherwise it will be
27049 truncated at the first newline and a panic logged), and it cannot affect the
27050 EHLO options.
27051
27052 When SMTP is involved, the message may begin with an overriding response code,
27053 consisting of three digits optionally followed by an &"extended response code"&
27054 of the form &'n.n.n'&, each code being followed by a space. For example:
27055 .code
27056 deny  message = 599 1.2.3 Host not welcome
27057       hosts = 192.168.34.0/24
27058 .endd
27059 The first digit of the supplied response code must be the same as would be sent
27060 by default. A panic occurs if it is not. Exim uses a 550 code when it denies
27061 access, but for the predata ACL, note that the default success code is 354, not
27062 2&'xx'&.
27063
27064 Notwithstanding the previous paragraph, for the QUIT ACL, unlike the others,
27065 the message modifier cannot override the 221 response code.
27066
27067 The text in a &%message%& modifier is literal; any quotes are taken as
27068 literals, but because the string is expanded, backslash escapes are processed
27069 anyway. If the message contains newlines, this gives rise to a multi-line SMTP
27070 response.
27071
27072 .vindex "&$acl_verify_message$&"
27073 If &%message%& is used on a statement that verifies an address, the message
27074 specified overrides any message that is generated by the verification process.
27075 However, the original message is available in the variable
27076 &$acl_verify_message$&, so you can incorporate it into your message if you
27077 wish. In particular, if you want the text from &%:fail:%& items in &(redirect)&
27078 routers to be passed back as part of the SMTP response, you should either not
27079 use a &%message%& modifier, or make use of &$acl_verify_message$&.
27080
27081 For compatibility with previous releases of Exim, a &%message%& modifier that
27082 is used with a &%warn%& verb behaves in a similar way to the &%add_header%&
27083 modifier, but this usage is now deprecated. However, &%message%& acts only when
27084 all the conditions are true, wherever it appears in an ACL command, whereas
27085 &%add_header%& acts as soon as it is encountered. If &%message%& is used with
27086 &%warn%& in an ACL that is not concerned with receiving a message, it has no
27087 effect.
27088
27089
27090 .vitem &*remove_header*&&~=&~<&'text'&>
27091 This modifier specifies one or more header names in a colon-separated list
27092  that are to be removed from an incoming message, assuming, of course, that
27093 the message is ultimately accepted. For details, see section &<<SECTremoveheadacl>>&.
27094
27095
27096 .vitem &*set*&&~<&'acl_name'&>&~=&~<&'value'&>
27097 .cindex "&%set%& ACL modifier"
27098 This modifier puts a value into one of the ACL variables (see section
27099 &<<SECTaclvariables>>&).
27100
27101
27102 .vitem &*udpsend*&&~=&~<&'parameters'&>
27103 This modifier sends a UDP packet, for purposes such as statistics
27104 collection or behaviour monitoring. The parameters are expanded, and
27105 the result of the expansion must be a colon-separated list consisting
27106 of a destination server, port number, and the packet contents. The
27107 server can be specified as a host name or IPv4 or IPv6 address. The
27108 separator can be changed with the usual angle bracket syntax. For
27109 example, you might want to collect information on which hosts connect
27110 when:
27111 .code
27112 udpsend = <; 2001:dB8::dead:beef ; 1234 ;\
27113              $tod_zulu $sender_host_address
27114 .endd
27115 .endlist
27116
27117
27118
27119
27120
27121 .section "Use of the control modifier" "SECTcontrols"
27122 .cindex "&%control%& ACL modifier"
27123 The &%control%& modifier supports the following settings:
27124
27125 .vlist
27126 .vitem &*control&~=&~allow_auth_unadvertised*&
27127 This modifier allows a client host to use the SMTP AUTH command even when it
27128 has not been advertised in response to EHLO. Furthermore, because there are
27129 apparently some really broken clients that do this, Exim will accept AUTH after
27130 HELO (rather than EHLO) when this control is set. It should be used only if you
27131 really need it, and you should limit its use to those broken clients that do
27132 not work without it. For example:
27133 .code
27134 warn hosts   = 192.168.34.25
27135      control = allow_auth_unadvertised
27136 .endd
27137 Normally, when an Exim server receives an AUTH command, it checks the name of
27138 the authentication mechanism that is given in the command to ensure that it
27139 matches an advertised mechanism. When this control is set, the check that a
27140 mechanism has been advertised is bypassed. Any configured mechanism can be used
27141 by the client. This control is permitted only in the connection and HELO ACLs.
27142
27143
27144 .vitem &*control&~=&~caseful_local_part*& &&&
27145        &*control&~=&~caselower_local_part*&
27146 .cindex "&ACL;" "case of local part in"
27147 .cindex "case of local parts"
27148 .vindex "&$local_part$&"
27149 These two controls are permitted only in the ACL specified by &%acl_smtp_rcpt%&
27150 (that is, during RCPT processing). By default, the contents of &$local_part$&
27151 are lower cased before ACL processing. If &"caseful_local_part"& is specified,
27152 any uppercase letters in the original local part are restored in &$local_part$&
27153 for the rest of the ACL, or until a control that sets &"caselower_local_part"&
27154 is encountered.
27155
27156 These controls affect only the current recipient. Moreover, they apply only to
27157 local part handling that takes place directly in the ACL (for example, as a key
27158 in lookups). If a test to verify the recipient is obeyed, the case-related
27159 handling of the local part during the verification is controlled by the router
27160 configuration (see the &%caseful_local_part%& generic router option).
27161
27162 This facility could be used, for example, to add a spam score to local parts
27163 containing upper case letters. For example, using &$acl_m4$& to accumulate the
27164 spam score:
27165 .code
27166 warn  control = caseful_local_part
27167       set acl_m4 = ${eval:\
27168                      $acl_m4 + \
27169                      ${if match{$local_part}{[A-Z]}{1}{0}}\
27170                     }
27171       control = caselower_local_part
27172 .endd
27173 Notice that we put back the lower cased version afterwards, assuming that
27174 is what is wanted for subsequent tests.
27175
27176
27177 .new
27178 .vitem &*control&~=&~cutthrough_delivery*&
27179 .cindex "&ACL;" "cutthrough routing"
27180 .cindex "cutthrough" "requesting"
27181 This option requests delivery be attempted while the item is being received.
27182 It is usable in the RCPT ACL and valid only for single-recipient mails forwarded
27183 from one SMTP connection to another.  If a recipient-verify callout connection is
27184 requested in the same ACL it is held open and used for the data, otherwise one is made
27185 after the ACL completes.  Note that routers are used in verify mode.
27186
27187 Should the ultimate destination system positively accept or reject the mail,
27188 a corresponding indication is given to the source system and nothing is queued.
27189 If there is a temporary error the item is queued for later delivery in the
27190 usual fashion. If the item is successfully delivered in cutthrough mode the log line
27191 is tagged with ">>" rather than "=>" and appears before the acceptance "<="
27192 line.
27193
27194 Delivery in this mode avoids the generation of a bounce mail to a (possibly faked)
27195 sender when the destination system is doing content-scan based rejection.
27196 .wen
27197
27198
27199 .new
27200 .vitem &*control&~=&~debug/*&<&'options'&>
27201 .cindex "&ACL;" "enabling debug logging"
27202 .cindex "debugging" "enabling from an ACL"
27203 This control turns on debug logging, almost as though Exim had been invoked
27204 with &`-d`&, with the output going to a new logfile, by default called
27205 &'debuglog'&.  The filename can be adjusted with the &'tag'& option, which
27206 may access any variables already defined.  The logging may be adjusted with
27207 the &'opts'& option, which takes the same values as the &`-d`& command-line
27208 option.  Some examples (which depend on variables that don't exist in all
27209 contexts):
27210 .code
27211       control = debug
27212       control = debug/tag=.$sender_host_address
27213       control = debug/opts=+expand+acl
27214       control = debug/tag=.$message_exim_id/opts=+expand
27215 .endd
27216 .wen
27217
27218
27219 .new
27220 .vitem &*control&~=&~dkim_disable_verify*&
27221 .cindex "disable DKIM verify"
27222 .cindex "DKIM" "disable verify"
27223 This control turns off DKIM verification processing entirely.  For details on
27224 the operation and configuration of DKIM, see chapter &<<CHAPdkim>>&.
27225 .wen
27226
27227
27228 .new
27229 .vitem &*control&~=&~dscp/*&<&'value'&>
27230 .cindex "&ACL;" "setting DSCP value"
27231 .cindex "DSCP" "inbound"
27232 This option causes the DSCP value associated with the socket for the inbound
27233 connection to be adjusted to a given value, given as one of a number of fixed
27234 strings or to numeric value.
27235 The &%-bI:dscp%& option may be used to ask Exim which names it knows of.
27236 Common values include &`throughput`&, &`mincost`&, and on newer systems
27237 &`ef`&, &`af41`&, etc.  Numeric values may be in the range 0 to 0x3F.
27238
27239 The outbound packets from Exim will be marked with this value in the header
27240 (for IPv4, the TOS field; for IPv6, the TCLASS field); there is no guarantee
27241 that these values will have any effect, not be stripped by networking
27242 equipment, or do much of anything without cooperation with your Network
27243 Engineer and those of all network operators between the source and destination.
27244 .wen
27245
27246
27247 .vitem &*control&~=&~enforce_sync*& &&&
27248        &*control&~=&~no_enforce_sync*&
27249 .cindex "SMTP" "synchronization checking"
27250 .cindex "synchronization checking in SMTP"
27251 These controls make it possible to be selective about when SMTP synchronization
27252 is enforced. The global option &%smtp_enforce_sync%& specifies the initial
27253 state of the switch (it is true by default). See the description of this option
27254 in chapter &<<CHAPmainconfig>>& for details of SMTP synchronization checking.
27255
27256 The effect of these two controls lasts for the remainder of the SMTP
27257 connection. They can appear in any ACL except the one for the non-SMTP
27258 messages. The most straightforward place to put them is in the ACL defined by
27259 &%acl_smtp_connect%&, which is run at the start of an incoming SMTP connection,
27260 before the first synchronization check. The expected use is to turn off the
27261 synchronization checks for badly-behaved hosts that you nevertheless need to
27262 work with.
27263
27264
27265 .vitem &*control&~=&~fakedefer/*&<&'message'&>
27266 .cindex "fake defer"
27267 .cindex "defer, fake"
27268 This control works in exactly the same way as &%fakereject%& (described below)
27269 except that it causes an SMTP 450 response after the message data instead of a
27270 550 response. You must take care when using &%fakedefer%& because it causes the
27271 messages to be duplicated when the sender retries. Therefore, you should not
27272 use &%fakedefer%& if the message is to be delivered normally.
27273
27274 .vitem &*control&~=&~fakereject/*&<&'message'&>
27275 .cindex "fake rejection"
27276 .cindex "rejection, fake"
27277 This control is permitted only for the MAIL, RCPT, and DATA ACLs, in other
27278 words, only when an SMTP message is being received. If Exim accepts the
27279 message, instead the final 250 response, a 550 rejection message is sent.
27280 However, Exim proceeds to deliver the message as normal. The control applies
27281 only to the current message, not to any subsequent ones that may be received in
27282 the same SMTP connection.
27283
27284 The text for the 550 response is taken from the &%control%& modifier. If no
27285 message is supplied, the following is used:
27286 .code
27287 550-Your message has been rejected but is being
27288 550-kept for evaluation.
27289 550-If it was a legitimate message, it may still be
27290 550 delivered to the target recipient(s).
27291 .endd
27292 This facility should be used with extreme caution.
27293
27294 .vitem &*control&~=&~freeze*&
27295 .cindex "frozen messages" "forcing in ACL"
27296 This control is permitted only for the MAIL, RCPT, DATA, and non-SMTP ACLs, in
27297 other words, only when a message is being received. If the message is accepted,
27298 it is placed on Exim's queue and frozen. The control applies only to the
27299 current message, not to any subsequent ones that may be received in the same
27300 SMTP connection.
27301
27302 This modifier can optionally be followed by &`/no_tell`&. If the global option
27303 &%freeze_tell%& is set, it is ignored for the current message (that is, nobody
27304 is told about the freezing), provided all the &*control=freeze*& modifiers that
27305 are obeyed for the current message have the &`/no_tell`& option.
27306
27307 .vitem &*control&~=&~no_delay_flush*&
27308 .cindex "SMTP" "output flushing, disabling for delay"
27309 Exim normally flushes SMTP output before implementing a delay in an ACL, to
27310 avoid unexpected timeouts in clients when the SMTP PIPELINING extension is in
27311 use. This control, as long as it is encountered before the &%delay%& modifier,
27312 disables such output flushing.
27313
27314 .vitem &*control&~=&~no_callout_flush*&
27315 .cindex "SMTP" "output flushing, disabling for callout"
27316 Exim normally flushes SMTP output before performing a callout in an ACL, to
27317 avoid unexpected timeouts in clients when the SMTP PIPELINING extension is in
27318 use. This control, as long as it is encountered before the &%verify%& condition
27319 that causes the callout, disables such output flushing.
27320
27321 .vitem &*control&~=&~no_mbox_unspool*&
27322 This control is available when Exim is compiled with the content scanning
27323 extension. Content scanning may require a copy of the current message, or parts
27324 of it, to be written in &"mbox format"& to a spool file, for passing to a virus
27325 or spam scanner. Normally, such copies are deleted when they are no longer
27326 needed. If this control is set, the copies are not deleted. The control applies
27327 only to the current message, not to any subsequent ones that may be received in
27328 the same SMTP connection. It is provided for debugging purposes and is unlikely
27329 to be useful in production.
27330
27331 .vitem &*control&~=&~no_multiline_responses*&
27332 .cindex "multiline responses, suppressing"
27333 This control is permitted for any ACL except the one for non-SMTP messages.
27334 It seems that there are broken clients in use that cannot handle multiline
27335 SMTP responses, despite the fact that RFC 821 defined them over 20 years ago.
27336
27337 If this control is set, multiline SMTP responses from ACL rejections are
27338 suppressed. One way of doing this would have been to put out these responses as
27339 one long line. However, RFC 2821 specifies a maximum of 512 bytes per response
27340 (&"use multiline responses for more"& it says &-- ha!), and some of the
27341 responses might get close to that. So this facility, which is after all only a
27342 sop to broken clients, is implemented by doing two very easy things:
27343
27344 .ilist
27345 Extra information that is normally output as part of a rejection caused by
27346 sender verification failure is omitted. Only the final line (typically &"sender
27347 verification failed"&) is sent.
27348 .next
27349 If a &%message%& modifier supplies a multiline response, only the first
27350 line is output.
27351 .endlist
27352
27353 The setting of the switch can, of course, be made conditional on the
27354 calling host. Its effect lasts until the end of the SMTP connection.
27355
27356 .vitem &*control&~=&~no_pipelining*&
27357 .cindex "PIPELINING" "suppressing advertising"
27358 This control turns off the advertising of the PIPELINING extension to SMTP in
27359 the current session. To be useful, it must be obeyed before Exim sends its
27360 response to an EHLO command. Therefore, it should normally appear in an ACL
27361 controlled by &%acl_smtp_connect%& or &%acl_smtp_helo%&. See also
27362 &%pipelining_advertise_hosts%&.
27363
27364 .vitem &*control&~=&~queue_only*&
27365 .oindex "&%queue_only%&"
27366 .cindex "queueing incoming messages"
27367 This control is permitted only for the MAIL, RCPT, DATA, and non-SMTP ACLs, in
27368 other words, only when a message is being received. If the message is accepted,
27369 it is placed on Exim's queue and left there for delivery by a subsequent queue
27370 runner. No immediate delivery process is started. In other words, it has the
27371 effect as the &%queue_only%& global option. However, the control applies only
27372 to the current message, not to any subsequent ones that may be received in the
27373 same SMTP connection.
27374
27375 .vitem &*control&~=&~submission/*&<&'options'&>
27376 .cindex "message" "submission"
27377 .cindex "submission mode"
27378 This control is permitted only for the MAIL, RCPT, and start of data ACLs (the
27379 latter is the one defined by &%acl_smtp_predata%&). Setting it tells Exim that
27380 the current message is a submission from a local MUA. In this case, Exim
27381 operates in &"submission mode"&, and applies certain fixups to the message if
27382 necessary. For example, it adds a &'Date:'& header line if one is not present.
27383 This control is not permitted in the &%acl_smtp_data%& ACL, because that is too
27384 late (the message has already been created).
27385
27386 Chapter &<<CHAPmsgproc>>& describes the processing that Exim applies to
27387 messages. Section &<<SECTsubmodnon>>& covers the processing that happens in
27388 submission mode; the available options for this control are described there.
27389 The control applies only to the current message, not to any subsequent ones
27390 that may be received in the same SMTP connection.
27391
27392 .vitem &*control&~=&~suppress_local_fixups*&
27393 .cindex "submission fixups, suppressing"
27394 This control applies to locally submitted (non TCP/IP) messages, and is the
27395 complement of &`control = submission`&. It disables the fixups that are
27396 normally applied to locally-submitted messages. Specifically:
27397
27398 .ilist
27399 Any &'Sender:'& header line is left alone (in this respect, it is a
27400 dynamic version of &%local_sender_retain%&).
27401 .next
27402 No &'Message-ID:'&, &'From:'&, or &'Date:'& header lines are added.
27403 .next
27404 There is no check that &'From:'& corresponds to the actual sender.
27405 .endlist ilist
27406
27407 This control may be useful when a remotely-originated message is accepted,
27408 passed to some scanning program, and then re-submitted for delivery. It can be
27409 used only in the &%acl_smtp_mail%&, &%acl_smtp_rcpt%&, &%acl_smtp_predata%&,
27410 and &%acl_not_smtp_start%& ACLs, because it has to be set before the message's
27411 data is read.
27412
27413 &*Note:*& This control applies only to the current message, not to any others
27414 that are being submitted at the same time using &%-bs%& or &%-bS%&.
27415 .endlist vlist
27416
27417
27418 .section "Summary of message fixup control" "SECTsummesfix"
27419 All four possibilities for message fixups can be specified:
27420
27421 .ilist
27422 Locally submitted, fixups applied: the default.
27423 .next
27424 Locally submitted, no fixups applied: use
27425 &`control = suppress_local_fixups`&.
27426 .next
27427 Remotely submitted, no fixups applied: the default.
27428 .next
27429 Remotely submitted, fixups applied: use &`control = submission`&.
27430 .endlist
27431
27432
27433
27434 .section "Adding header lines in ACLs" "SECTaddheadacl"
27435 .cindex "header lines" "adding in an ACL"
27436 .cindex "header lines" "position of added lines"
27437 .cindex "&%add_header%& ACL modifier"
27438 The &%add_header%& modifier can be used to add one or more extra header lines
27439 to an incoming message, as in this example:
27440 .code
27441 warn dnslists = sbl.spamhaus.org : \
27442                 dialup.mail-abuse.org
27443      add_header = X-blacklisted-at: $dnslist_domain
27444 .endd
27445 The &%add_header%& modifier is permitted in the MAIL, RCPT, PREDATA, DATA,
27446 MIME, and non-SMTP ACLs (in other words, those that are concerned with
27447 receiving a message). The message must ultimately be accepted for
27448 &%add_header%& to have any significant effect. You can use &%add_header%& with
27449 any ACL verb, including &%deny%& (though this is potentially useful only in a
27450 RCPT ACL).
27451
27452 Leading and trailing newlines are removed from
27453 the data for the &%add_header%& modifier; if it then
27454 contains one or more newlines that
27455 are not followed by a space or a tab, it is assumed to contain multiple header
27456 lines. Each one is checked for valid syntax; &`X-ACL-Warn:`& is added to the
27457 front of any line that is not a valid header line.
27458
27459 Added header lines are accumulated during the MAIL, RCPT, and predata ACLs.
27460 They are added to the message before processing the DATA and MIME ACLs.
27461 However, if an identical header line is requested more than once, only one copy
27462 is actually added to the message. Further header lines may be accumulated
27463 during the DATA and MIME ACLs, after which they are added to the message, again
27464 with duplicates suppressed. Thus, it is possible to add two identical header
27465 lines to an SMTP message, but only if one is added before DATA and one after.
27466 In the case of non-SMTP messages, new headers are accumulated during the
27467 non-SMTP ACLs, and are added to the message after all the ACLs have run. If a
27468 message is rejected after DATA or by the non-SMTP ACL, all added header lines
27469 are included in the entry that is written to the reject log.
27470
27471 .cindex "header lines" "added; visibility of"
27472 Header lines are not visible in string expansions
27473 of message headers
27474 until they are added to the
27475 message. It follows that header lines defined in the MAIL, RCPT, and predata
27476 ACLs are not visible until the DATA ACL and MIME ACLs are run. Similarly,
27477 header lines that are added by the DATA or MIME ACLs are not visible in those
27478 ACLs. Because of this restriction, you cannot use header lines as a way of
27479 passing data between (for example) the MAIL and RCPT ACLs. If you want to do
27480 this, you can use ACL variables, as described in section
27481 &<<SECTaclvariables>>&.
27482
27483 The list of headers yet to be added is given by the &%$headers_added%& variable.
27484
27485 The &%add_header%& modifier acts immediately as it is encountered during the
27486 processing of an ACL. Notice the difference between these two cases:
27487 .display
27488 &`accept add_header = ADDED: some text`&
27489 &`       `&<&'some condition'&>
27490
27491 &`accept `&<&'some condition'&>
27492 &`       add_header = ADDED: some text`&
27493 .endd
27494 In the first case, the header line is always added, whether or not the
27495 condition is true. In the second case, the header line is added only if the
27496 condition is true. Multiple occurrences of &%add_header%& may occur in the same
27497 ACL statement. All those that are encountered before a condition fails are
27498 honoured.
27499
27500 .cindex "&%warn%& ACL verb"
27501 For compatibility with previous versions of Exim, a &%message%& modifier for a
27502 &%warn%& verb acts in the same way as &%add_header%&, except that it takes
27503 effect only if all the conditions are true, even if it appears before some of
27504 them. Furthermore, only the last occurrence of &%message%& is honoured. This
27505 usage of &%message%& is now deprecated. If both &%add_header%& and &%message%&
27506 are present on a &%warn%& verb, both are processed according to their
27507 specifications.
27508
27509 By default, new header lines are added to a message at the end of the existing
27510 header lines. However, you can specify that any particular header line should
27511 be added right at the start (before all the &'Received:'& lines), immediately
27512 after the first block of &'Received:'& lines, or immediately before any line
27513 that is not a &'Received:'& or &'Resent-something:'& header.
27514
27515 This is done by specifying &":at_start:"&, &":after_received:"&, or
27516 &":at_start_rfc:"& (or, for completeness, &":at_end:"&) before the text of the
27517 header line, respectively. (Header text cannot start with a colon, as there has
27518 to be a header name first.) For example:
27519 .code
27520 warn add_header = \
27521        :after_received:X-My-Header: something or other...
27522 .endd
27523 If more than one header line is supplied in a single &%add_header%& modifier,
27524 each one is treated independently and can therefore be placed differently. If
27525 you add more than one line at the start, or after the Received: block, they end
27526 up in reverse order.
27527
27528 &*Warning*&: This facility currently applies only to header lines that are
27529 added in an ACL. It does NOT work for header lines that are added in a
27530 system filter or in a router or transport.
27531
27532
27533
27534 .section "Removing header lines in ACLs" "SECTremoveheadacl"
27535 .cindex "header lines" "removing in an ACL"
27536 .cindex "header lines" "position of removed lines"
27537 .cindex "&%remove_header%& ACL modifier"
27538 The &%remove_header%& modifier can be used to remove one or more header lines
27539 from an incoming message, as in this example:
27540 .code
27541 warn   message        = Remove internal headers
27542        remove_header  = x-route-mail1 : x-route-mail2
27543 .endd
27544 The &%remove_header%& modifier is permitted in the MAIL, RCPT, PREDATA, DATA,
27545 MIME, and non-SMTP ACLs (in other words, those that are concerned with
27546 receiving a message). The message must ultimately be accepted for
27547 &%remove_header%& to have any significant effect. You can use &%remove_header%&
27548 with any ACL verb, including &%deny%&, though this is really not useful for
27549 any verb that doesn't result in a delivered message.
27550
27551 More than one header can be removed at the same time by using a colon separated
27552 list of header names. The header matching is case insensitive. Wildcards are
27553 not permitted, nor is list expansion performed, so you cannot use hostlists to
27554 create a list of headers, however both connection and message variable expansion
27555 are performed (&%$acl_c_*%& and &%$acl_m_*%&), illustrated in this example:
27556 .code
27557 warn   hosts           = +internal_hosts
27558        set acl_c_ihdrs = x-route-mail1 : x-route-mail2
27559 warn   message         = Remove internal headers
27560        remove_header   = $acl_c_ihdrs
27561 .endd
27562 Removed header lines are accumulated during the MAIL, RCPT, and predata ACLs.
27563 They are removed from the message before processing the DATA and MIME ACLs.
27564 There is no harm in attempting to remove the same header twice nor is removing
27565 a non-existent header. Further header lines to be removed may be accumulated
27566 during the DATA and MIME ACLs, after which they are removed from the message,
27567 if present. In the case of non-SMTP messages, headers to be removed are
27568 accumulated during the non-SMTP ACLs, and are removed from the message after
27569 all the ACLs have run. If a message is rejected after DATA or by the non-SMTP
27570 ACL, there really is no effect because there is no logging of what headers
27571 would have been removed.
27572
27573 .cindex "header lines" "removed; visibility of"
27574 Header lines are not visible in string expansions until the DATA phase when it
27575 is received. Any header lines removed in the MAIL, RCPT, and predata ACLs are
27576 not visible in the DATA ACL and MIME ACLs. Similarly, header lines that are
27577 removed by the DATA or MIME ACLs are still visible in those ACLs. Because of
27578 this restriction, you cannot use header lines as a way of controlling data
27579 passed between (for example) the MAIL and RCPT ACLs. If you want to do this,
27580 you should instead use ACL variables, as described in section
27581 &<<SECTaclvariables>>&.
27582
27583 The &%remove_header%& modifier acts immediately as it is encountered during the
27584 processing of an ACL. Notice the difference between these two cases:
27585 .display
27586 &`accept remove_header = X-Internal`&
27587 &`       `&<&'some condition'&>
27588
27589 &`accept `&<&'some condition'&>
27590 &`       remove_header = X-Internal`&
27591 .endd
27592 In the first case, the header line is always removed, whether or not the
27593 condition is true. In the second case, the header line is removed only if the
27594 condition is true. Multiple occurrences of &%remove_header%& may occur in the
27595 same ACL statement. All those that are encountered before a condition fails
27596 are honoured.
27597
27598 &*Warning*&: This facility currently applies only to header lines that are
27599 present during ACL processing. It does NOT remove header lines that are added
27600 in a system filter or in a router or transport.
27601
27602
27603
27604
27605
27606 .section "ACL conditions" "SECTaclconditions"
27607 .cindex "&ACL;" "conditions; list of"
27608 Some of the conditions listed in this section are available only when Exim is
27609 compiled with the content-scanning extension. They are included here briefly
27610 for completeness. More detailed descriptions can be found in the discussion on
27611 content scanning in chapter &<<CHAPexiscan>>&.
27612
27613 Not all conditions are relevant in all circumstances. For example, testing
27614 senders and recipients does not make sense in an ACL that is being run as the
27615 result of the arrival of an ETRN command, and checks on message headers can be
27616 done only in the ACLs specified by &%acl_smtp_data%& and &%acl_not_smtp%&. You
27617 can use the same condition (with different parameters) more than once in the
27618 same ACL statement. This provides a way of specifying an &"and"& conjunction.
27619 The conditions are as follows:
27620
27621
27622 .vlist
27623 .vitem &*acl&~=&~*&<&'name&~of&~acl&~or&~ACL&~string&~or&~file&~name&~'&>
27624 .cindex "&ACL;" "nested"
27625 .cindex "&ACL;" "indirect"
27626 .cindex "&ACL;" "arguments"
27627 .cindex "&%acl%& ACL condition"
27628 The possible values of the argument are the same as for the
27629 &%acl_smtp_%&&'xxx'& options. The named or inline ACL is run. If it returns
27630 &"accept"& the condition is true; if it returns &"deny"& the condition is
27631 false. If it returns &"defer"&, the current ACL returns &"defer"& unless the
27632 condition is on a &%warn%& verb. In that case, a &"defer"& return makes the
27633 condition false. This means that further processing of the &%warn%& verb
27634 ceases, but processing of the ACL continues.
27635
27636 If the argument is a named ACL, up to nine space-separated optional values
27637 can be appended; they appear within the called ACL in $acl_arg1 to $acl_arg9,
27638 and $acl_narg is set to the count of values.
27639 Previous values of these variables are restored after the call returns.
27640 The name and values are expanded separately.
27641
27642 If the nested &%acl%& returns &"drop"& and the outer condition denies access,
27643 the connection is dropped. If it returns &"discard"&, the verb must be
27644 &%accept%& or &%discard%&, and the action is taken immediately &-- no further
27645 conditions are tested.
27646
27647 ACLs may be nested up to 20 deep; the limit exists purely to catch runaway
27648 loops. This condition allows you to use different ACLs in different
27649 circumstances. For example, different ACLs can be used to handle RCPT commands
27650 for different local users or different local domains.
27651
27652 .vitem &*authenticated&~=&~*&<&'string&~list'&>
27653 .cindex "&%authenticated%& ACL condition"
27654 .cindex "authentication" "ACL checking"
27655 .cindex "&ACL;" "testing for authentication"
27656 If the SMTP connection is not authenticated, the condition is false. Otherwise,
27657 the name of the authenticator is tested against the list. To test for
27658 authentication by any authenticator, you can set
27659 .code
27660 authenticated = *
27661 .endd
27662
27663 .vitem &*condition&~=&~*&<&'string'&>
27664 .cindex "&%condition%& ACL condition"
27665 .cindex "customizing" "ACL condition"
27666 .cindex "&ACL;" "customized test"
27667 .cindex "&ACL;" "testing, customized"
27668 This feature allows you to make up custom conditions. If the result of
27669 expanding the string is an empty string, the number zero, or one of the strings
27670 &"no"& or &"false"&, the condition is false. If the result is any non-zero
27671 number, or one of the strings &"yes"& or &"true"&, the condition is true. For
27672 any other value, some error is assumed to have occurred, and the ACL returns
27673 &"defer"&. However, if the expansion is forced to fail, the condition is
27674 ignored. The effect is to treat it as true, whether it is positive or
27675 negative.
27676
27677 .vitem &*decode&~=&~*&<&'location'&>
27678 .cindex "&%decode%& ACL condition"
27679 This condition is available only when Exim is compiled with the
27680 content-scanning extension, and it is allowed only in the ACL defined by
27681 &%acl_smtp_mime%&. It causes the current MIME part to be decoded into a file.
27682 If all goes well, the condition is true. It is false only if there are
27683 problems such as a syntax error or a memory shortage. For more details, see
27684 chapter &<<CHAPexiscan>>&.
27685
27686 .vitem &*demime&~=&~*&<&'extension&~list'&>
27687 .cindex "&%demime%& ACL condition"
27688 This condition is available only when Exim is compiled with the
27689 content-scanning extension. Its use is described in section
27690 &<<SECTdemimecond>>&.
27691
27692 .vitem &*dnslists&~=&~*&<&'list&~of&~domain&~names&~and&~other&~data'&>
27693 .cindex "&%dnslists%& ACL condition"
27694 .cindex "DNS list" "in ACL"
27695 .cindex "black list (DNS)"
27696 .cindex "&ACL;" "testing a DNS list"
27697 This condition checks for entries in DNS black lists. These are also known as
27698 &"RBL lists"&, after the original Realtime Blackhole List, but note that the
27699 use of the lists at &'mail-abuse.org'& now carries a charge. There are too many
27700 different variants of this condition to describe briefly here. See sections
27701 &<<SECTmorednslists>>&&--&<<SECTmorednslistslast>>& for details.
27702
27703 .vitem &*domains&~=&~*&<&'domain&~list'&>
27704 .cindex "&%domains%& ACL condition"
27705 .cindex "domain" "ACL checking"
27706 .cindex "&ACL;" "testing a recipient domain"
27707 .vindex "&$domain_data$&"
27708 This condition is relevant only after a RCPT command. It checks that the domain
27709 of the recipient address is in the domain list. If percent-hack processing is
27710 enabled, it is done before this test is done. If the check succeeds with a
27711 lookup, the result of the lookup is placed in &$domain_data$& until the next
27712 &%domains%& test.
27713
27714 &*Note carefully*& (because many people seem to fall foul of this): you cannot
27715 use &%domains%& in a DATA ACL.
27716
27717
27718 .vitem &*encrypted&~=&~*&<&'string&~list'&>
27719 .cindex "&%encrypted%& ACL condition"
27720 .cindex "encryption" "checking in an ACL"
27721 .cindex "&ACL;" "testing for encryption"
27722 If the SMTP connection is not encrypted, the condition is false. Otherwise, the
27723 name of the cipher suite in use is tested against the list. To test for
27724 encryption without testing for any specific cipher suite(s), set
27725 .code
27726 encrypted = *
27727 .endd
27728
27729
27730 .vitem &*hosts&~=&~*&<&'host&~list'&>
27731 .cindex "&%hosts%& ACL condition"
27732 .cindex "host" "ACL checking"
27733 .cindex "&ACL;" "testing the client host"
27734 This condition tests that the calling host matches the host list. If you have
27735 name lookups or wildcarded host names and IP addresses in the same host list,
27736 you should normally put the IP addresses first. For example, you could have:
27737 .code
27738 accept hosts = 10.9.8.7 : dbm;/etc/friendly/hosts
27739 .endd
27740 The lookup in this example uses the host name for its key. This is implied by
27741 the lookup type &"dbm"&. (For a host address lookup you would use &"net-dbm"&
27742 and it wouldn't matter which way round you had these two items.)
27743
27744 The reason for the problem with host names lies in the left-to-right way that
27745 Exim processes lists. It can test IP addresses without doing any DNS lookups,
27746 but when it reaches an item that requires a host name, it fails if it cannot
27747 find a host name to compare with the pattern. If the above list is given in the
27748 opposite order, the &%accept%& statement fails for a host whose name cannot be
27749 found, even if its IP address is 10.9.8.7.
27750
27751 If you really do want to do the name check first, and still recognize the IP
27752 address even if the name lookup fails, you can rewrite the ACL like this:
27753 .code
27754 accept hosts = dbm;/etc/friendly/hosts
27755 accept hosts = 10.9.8.7
27756 .endd
27757 The default action on failing to find the host name is to assume that the host
27758 is not in the list, so the first &%accept%& statement fails. The second
27759 statement can then check the IP address.
27760
27761 .vindex "&$host_data$&"
27762 If a &%hosts%& condition is satisfied by means of a lookup, the result
27763 of the lookup is made available in the &$host_data$& variable. This
27764 allows you, for example, to set up a statement like this:
27765 .code
27766 deny  hosts = net-lsearch;/some/file
27767 message = $host_data
27768 .endd
27769 which gives a custom error message for each denied host.
27770
27771 .vitem &*local_parts&~=&~*&<&'local&~part&~list'&>
27772 .cindex "&%local_parts%& ACL condition"
27773 .cindex "local part" "ACL checking"
27774 .cindex "&ACL;" "testing a local part"
27775 .vindex "&$local_part_data$&"
27776 This condition is relevant only after a RCPT command. It checks that the local
27777 part of the recipient address is in the list. If percent-hack processing is
27778 enabled, it is done before this test. If the check succeeds with a lookup, the
27779 result of the lookup is placed in &$local_part_data$&, which remains set until
27780 the next &%local_parts%& test.
27781
27782 .vitem &*malware&~=&~*&<&'option'&>
27783 .cindex "&%malware%& ACL condition"
27784 .cindex "&ACL;" "virus scanning"
27785 .cindex "&ACL;" "scanning for viruses"
27786 This condition is available only when Exim is compiled with the
27787 content-scanning extension. It causes the incoming message to be scanned for
27788 viruses. For details, see chapter &<<CHAPexiscan>>&.
27789
27790 .vitem &*mime_regex&~=&~*&<&'list&~of&~regular&~expressions'&>
27791 .cindex "&%mime_regex%& ACL condition"
27792 .cindex "&ACL;" "testing by regex matching"
27793 This condition is available only when Exim is compiled with the
27794 content-scanning extension, and it is allowed only in the ACL defined by
27795 &%acl_smtp_mime%&. It causes the current MIME part to be scanned for a match
27796 with any of the regular expressions. For details, see chapter
27797 &<<CHAPexiscan>>&.
27798
27799 .vitem &*ratelimit&~=&~*&<&'parameters'&>
27800 .cindex "rate limiting"
27801 This condition can be used to limit the rate at which a user or host submits
27802 messages. Details are given in section &<<SECTratelimiting>>&.
27803
27804 .vitem &*recipients&~=&~*&<&'address&~list'&>
27805 .cindex "&%recipients%& ACL condition"
27806 .cindex "recipient" "ACL checking"
27807 .cindex "&ACL;" "testing a recipient"
27808 This condition is relevant only after a RCPT command. It checks the entire
27809 recipient address against a list of recipients.
27810
27811 .vitem &*regex&~=&~*&<&'list&~of&~regular&~expressions'&>
27812 .cindex "&%regex%& ACL condition"
27813 .cindex "&ACL;" "testing by regex matching"
27814 This condition is available only when Exim is compiled with the
27815 content-scanning extension, and is available only in the DATA, MIME, and
27816 non-SMTP ACLs. It causes the incoming message to be scanned for a match with
27817 any of the regular expressions. For details, see chapter &<<CHAPexiscan>>&.
27818
27819 .vitem &*sender_domains&~=&~*&<&'domain&~list'&>
27820 .cindex "&%sender_domains%& ACL condition"
27821 .cindex "sender" "ACL checking"
27822 .cindex "&ACL;" "testing a sender domain"
27823 .vindex "&$domain$&"
27824 .vindex "&$sender_address_domain$&"
27825 This condition tests the domain of the sender of the message against the given
27826 domain list. &*Note*&: The domain of the sender address is in
27827 &$sender_address_domain$&. It is &'not'& put in &$domain$& during the testing
27828 of this condition. This is an exception to the general rule for testing domain
27829 lists. It is done this way so that, if this condition is used in an ACL for a
27830 RCPT command, the recipient's domain (which is in &$domain$&) can be used to
27831 influence the sender checking.
27832
27833 &*Warning*&: It is a bad idea to use this condition on its own as a control on
27834 relaying, because sender addresses are easily, and commonly, forged.
27835
27836 .vitem &*senders&~=&~*&<&'address&~list'&>
27837 .cindex "&%senders%& ACL condition"
27838 .cindex "sender" "ACL checking"
27839 .cindex "&ACL;" "testing a sender"
27840 This condition tests the sender of the message against the given list. To test
27841 for a bounce message, which has an empty sender, set
27842 .code
27843 senders = :
27844 .endd
27845 &*Warning*&: It is a bad idea to use this condition on its own as a control on
27846 relaying, because sender addresses are easily, and commonly, forged.
27847
27848 .vitem &*spam&~=&~*&<&'username'&>
27849 .cindex "&%spam%& ACL condition"
27850 .cindex "&ACL;" "scanning for spam"
27851 This condition is available only when Exim is compiled with the
27852 content-scanning extension. It causes the incoming message to be scanned by
27853 SpamAssassin. For details, see chapter &<<CHAPexiscan>>&.
27854
27855 .vitem &*verify&~=&~certificate*&
27856 .cindex "&%verify%& ACL condition"
27857 .cindex "TLS" "client certificate verification"
27858 .cindex "certificate" "verification of client"
27859 .cindex "&ACL;" "certificate verification"
27860 .cindex "&ACL;" "testing a TLS certificate"
27861 This condition is true in an SMTP session if the session is encrypted, and a
27862 certificate was received from the client, and the certificate was verified. The
27863 server requests a certificate only if the client matches &%tls_verify_hosts%&
27864 or &%tls_try_verify_hosts%& (see chapter &<<CHAPTLS>>&).
27865
27866 .vitem &*verify&~=&~csa*&
27867 .cindex "CSA verification"
27868 This condition checks whether the sending host (the client) is authorized to
27869 send email. Details of how this works are given in section
27870 &<<SECTverifyCSA>>&.
27871
27872 .vitem &*verify&~=&~header_sender/*&<&'options'&>
27873 .cindex "&%verify%& ACL condition"
27874 .cindex "&ACL;" "verifying sender in the header"
27875 .cindex "header lines" "verifying the sender in"
27876 .cindex "sender" "verifying in header"
27877 .cindex "verifying" "sender in header"
27878 This condition is relevant only in an ACL that is run after a message has been
27879 received, that is, in an ACL specified by &%acl_smtp_data%& or
27880 &%acl_not_smtp%&. It checks that there is a verifiable address in at least one
27881 of the &'Sender:'&, &'Reply-To:'&, or &'From:'& header lines. Such an address
27882 is loosely thought of as a &"sender"& address (hence the name of the test).
27883 However, an address that appears in one of these headers need not be an address
27884 that accepts bounce messages; only sender addresses in envelopes are required
27885 to accept bounces. Therefore, if you use the callout option on this check, you
27886 might want to arrange for a non-empty address in the MAIL command.
27887
27888 Details of address verification and the options are given later, starting at
27889 section &<<SECTaddressverification>>& (callouts are described in section
27890 &<<SECTcallver>>&). You can combine this condition with the &%senders%&
27891 condition to restrict it to bounce messages only:
27892 .code
27893 deny    senders = :
27894         message = A valid sender header is required for bounces
27895        !verify  = header_sender
27896 .endd
27897
27898 .vitem &*verify&~=&~header_syntax*&
27899 .cindex "&%verify%& ACL condition"
27900 .cindex "&ACL;" "verifying header syntax"
27901 .cindex "header lines" "verifying syntax"
27902 .cindex "verifying" "header syntax"
27903 This condition is relevant only in an ACL that is run after a message has been
27904 received, that is, in an ACL specified by &%acl_smtp_data%& or
27905 &%acl_not_smtp%&. It checks the syntax of all header lines that can contain
27906 lists of addresses (&'Sender:'&, &'From:'&, &'Reply-To:'&, &'To:'&, &'Cc:'&,
27907 and &'Bcc:'&). Unqualified addresses (local parts without domains) are
27908 permitted only in locally generated messages and from hosts that match
27909 &%sender_unqualified_hosts%& or &%recipient_unqualified_hosts%&, as
27910 appropriate.
27911
27912 Note that this condition is a syntax check only. However, a common spamming
27913 ploy used to be to send syntactically invalid headers such as
27914 .code
27915 To: @
27916 .endd
27917 and this condition can be used to reject such messages, though they are not as
27918 common as they used to be.
27919
27920 .vitem &*verify&~=&~helo*&
27921 .cindex "&%verify%& ACL condition"
27922 .cindex "&ACL;" "verifying HELO/EHLO"
27923 .cindex "HELO" "verifying"
27924 .cindex "EHLO" "verifying"
27925 .cindex "verifying" "EHLO"
27926 .cindex "verifying" "HELO"
27927 This condition is true if a HELO or EHLO command has been received from the
27928 client host, and its contents have been verified. If there has been no previous
27929 attempt to verify the HELO/EHLO contents, it is carried out when this
27930 condition is encountered. See the description of the &%helo_verify_hosts%& and
27931 &%helo_try_verify_hosts%& options for details of how to request verification
27932 independently of this condition.
27933
27934 For SMTP input that does not come over TCP/IP (the &%-bs%& command line
27935 option), this condition is always true.
27936
27937
27938 .vitem &*verify&~=&~not_blind*&
27939 .cindex "verifying" "not blind"
27940 .cindex "bcc recipients, verifying none"
27941 This condition checks that there are no blind (bcc) recipients in the message.
27942 Every envelope recipient must appear either in a &'To:'& header line or in a
27943 &'Cc:'& header line for this condition to be true. Local parts are checked
27944 case-sensitively; domains are checked case-insensitively. If &'Resent-To:'& or
27945 &'Resent-Cc:'& header lines exist, they are also checked. This condition can be
27946 used only in a DATA or non-SMTP ACL.
27947
27948 There are, of course, many legitimate messages that make use of blind (bcc)
27949 recipients. This check should not be used on its own for blocking messages.
27950
27951
27952 .vitem &*verify&~=&~recipient/*&<&'options'&>
27953 .cindex "&%verify%& ACL condition"
27954 .cindex "&ACL;" "verifying recipient"
27955 .cindex "recipient" "verifying"
27956 .cindex "verifying" "recipient"
27957 .vindex "&$address_data$&"
27958 This condition is relevant only after a RCPT command. It verifies the current
27959 recipient. Details of address verification are given later, starting at section
27960 &<<SECTaddressverification>>&. After a recipient has been verified, the value
27961 of &$address_data$& is the last value that was set while routing the address.
27962 This applies even if the verification fails. When an address that is being
27963 verified is redirected to a single address, verification continues with the new
27964 address, and in that case, the subsequent value of &$address_data$& is the
27965 value for the child address.
27966
27967 .vitem &*verify&~=&~reverse_host_lookup*&
27968 .cindex "&%verify%& ACL condition"
27969 .cindex "&ACL;" "verifying host reverse lookup"
27970 .cindex "host" "verifying reverse lookup"
27971 This condition ensures that a verified host name has been looked up from the IP
27972 address of the client host. (This may have happened already if the host name
27973 was needed for checking a host list, or if the host matched &%host_lookup%&.)
27974 Verification ensures that the host name obtained from a reverse DNS lookup, or
27975 one of its aliases, does, when it is itself looked up in the DNS, yield the
27976 original IP address.
27977
27978 If this condition is used for a locally generated message (that is, when there
27979 is no client host involved), it always succeeds.
27980
27981 .vitem &*verify&~=&~sender/*&<&'options'&>
27982 .cindex "&%verify%& ACL condition"
27983 .cindex "&ACL;" "verifying sender"
27984 .cindex "sender" "verifying"
27985 .cindex "verifying" "sender"
27986 This condition is relevant only after a MAIL or RCPT command, or after a
27987 message has been received (the &%acl_smtp_data%& or &%acl_not_smtp%& ACLs). If
27988 the message's sender is empty (that is, this is a bounce message), the
27989 condition is true. Otherwise, the sender address is verified.
27990
27991 .vindex "&$address_data$&"
27992 .vindex "&$sender_address_data$&"
27993 If there is data in the &$address_data$& variable at the end of routing, its
27994 value is placed in &$sender_address_data$& at the end of verification. This
27995 value can be used in subsequent conditions and modifiers in the same ACL
27996 statement. It does not persist after the end of the current statement. If you
27997 want to preserve the value for longer, you can save it in an ACL variable.
27998
27999 Details of verification are given later, starting at section
28000 &<<SECTaddressverification>>&. Exim caches the result of sender verification,
28001 to avoid doing it more than once per message.
28002
28003 .vitem &*verify&~=&~sender=*&<&'address'&>&*/*&<&'options'&>
28004 .cindex "&%verify%& ACL condition"
28005 This is a variation of the previous option, in which a modified address is
28006 verified as a sender.
28007 .endlist
28008
28009
28010
28011 .section "Using DNS lists" "SECTmorednslists"
28012 .cindex "DNS list" "in ACL"
28013 .cindex "black list (DNS)"
28014 .cindex "&ACL;" "testing a DNS list"
28015 In its simplest form, the &%dnslists%& condition tests whether the calling host
28016 is on at least one of a number of DNS lists by looking up the inverted IP
28017 address in one or more DNS domains. (Note that DNS list domains are not mail
28018 domains, so the &`+`& syntax for named lists doesn't work - it is used for
28019 special options instead.) For example, if the calling host's IP
28020 address is 192.168.62.43, and the ACL statement is
28021 .code
28022 deny dnslists = blackholes.mail-abuse.org : \
28023                 dialups.mail-abuse.org
28024 .endd
28025 the following records are looked up:
28026 .code
28027 43.62.168.192.blackholes.mail-abuse.org
28028 43.62.168.192.dialups.mail-abuse.org
28029 .endd
28030 As soon as Exim finds an existing DNS record, processing of the list stops.
28031 Thus, multiple entries on the list provide an &"or"& conjunction. If you want
28032 to test that a host is on more than one list (an &"and"& conjunction), you can
28033 use two separate conditions:
28034 .code
28035 deny dnslists = blackholes.mail-abuse.org
28036      dnslists = dialups.mail-abuse.org
28037 .endd
28038 If a DNS lookup times out or otherwise fails to give a decisive answer, Exim
28039 behaves as if the host does not match the list item, that is, as if the DNS
28040 record does not exist. If there are further items in the DNS list, they are
28041 processed.
28042
28043 This is usually the required action when &%dnslists%& is used with &%deny%&
28044 (which is the most common usage), because it prevents a DNS failure from
28045 blocking mail. However, you can change this behaviour by putting one of the
28046 following special items in the list:
28047 .display
28048 &`+include_unknown `&   behave as if the item is on the list
28049 &`+exclude_unknown `&   behave as if the item is not on the list (default)
28050 &`+defer_unknown   `&   give a temporary error
28051 .endd
28052 .cindex "&`+include_unknown`&"
28053 .cindex "&`+exclude_unknown`&"
28054 .cindex "&`+defer_unknown`&"
28055 Each of these applies to any subsequent items on the list. For example:
28056 .code
28057 deny dnslists = +defer_unknown : foo.bar.example
28058 .endd
28059 Testing the list of domains stops as soon as a match is found. If you want to
28060 warn for one list and block for another, you can use two different statements:
28061 .code
28062 deny  dnslists = blackholes.mail-abuse.org
28063 warn  message  = X-Warn: sending host is on dialups list
28064       dnslists = dialups.mail-abuse.org
28065 .endd
28066 DNS list lookups are cached by Exim for the duration of the SMTP session,
28067 so a lookup based on the IP address is done at most once for any incoming
28068 connection. Exim does not share information between multiple incoming
28069 connections (but your local name server cache should be active).
28070
28071
28072
28073 .section "Specifying the IP address for a DNS list lookup" "SECID201"
28074 .cindex "DNS list" "keyed by explicit IP address"
28075 By default, the IP address that is used in a DNS list lookup is the IP address
28076 of the calling host. However, you can specify another IP address by listing it
28077 after the domain name, introduced by a slash. For example:
28078 .code
28079 deny dnslists = black.list.tld/192.168.1.2
28080 .endd
28081 This feature is not very helpful with explicit IP addresses; it is intended for
28082 use with IP addresses that are looked up, for example, the IP addresses of the
28083 MX hosts or nameservers of an email sender address. For an example, see section
28084 &<<SECTmulkeyfor>>& below.
28085
28086
28087
28088
28089 .section "DNS lists keyed on domain names" "SECID202"
28090 .cindex "DNS list" "keyed by domain name"
28091 There are some lists that are keyed on domain names rather than inverted IP
28092 addresses (see for example the &'domain based zones'& link at
28093 &url(http://www.rfc-ignorant.org/)). No reversing of components is used
28094 with these lists. You can change the name that is looked up in a DNS list by
28095 listing it after the domain name, introduced by a slash. For example,
28096 .code
28097 deny  message  = Sender's domain is listed at $dnslist_domain
28098       dnslists = dsn.rfc-ignorant.org/$sender_address_domain
28099 .endd
28100 This particular example is useful only in ACLs that are obeyed after the
28101 RCPT or DATA commands, when a sender address is available. If (for
28102 example) the message's sender is &'user@tld.example'& the name that is looked
28103 up by this example is
28104 .code
28105 tld.example.dsn.rfc-ignorant.org
28106 .endd
28107 A single &%dnslists%& condition can contain entries for both names and IP
28108 addresses. For example:
28109 .code
28110 deny dnslists = sbl.spamhaus.org : \
28111                 dsn.rfc-ignorant.org/$sender_address_domain
28112 .endd
28113 The first item checks the sending host's IP address; the second checks a domain
28114 name. The whole condition is true if either of the DNS lookups succeeds.
28115
28116
28117
28118
28119 .section "Multiple explicit keys for a DNS list" "SECTmulkeyfor"
28120 .cindex "DNS list" "multiple keys for"
28121 The syntax described above for looking up explicitly-defined values (either
28122 names or IP addresses) in a DNS blacklist is a simplification. After the domain
28123 name for the DNS list, what follows the slash can in fact be a list of items.
28124 As with all lists in Exim, the default separator is a colon. However, because
28125 this is a sublist within the list of DNS blacklist domains, it is necessary
28126 either to double the separators like this:
28127 .code
28128 dnslists = black.list.tld/name.1::name.2
28129 .endd
28130 or to change the separator character, like this:
28131 .code
28132 dnslists = black.list.tld/<;name.1;name.2
28133 .endd
28134 If an item in the list is an IP address, it is inverted before the DNS
28135 blacklist domain is appended. If it is not an IP address, no inversion
28136 occurs. Consider this condition:
28137 .code
28138 dnslists = black.list.tld/<;192.168.1.2;a.domain
28139 .endd
28140 The DNS lookups that occur are:
28141 .code
28142 2.1.168.192.black.list.tld
28143 a.domain.black.list.tld
28144 .endd
28145 Once a DNS record has been found (that matches a specific IP return
28146 address, if specified &-- see section &<<SECTaddmatcon>>&), no further lookups
28147 are done. If there is a temporary DNS error, the rest of the sublist of domains
28148 or IP addresses is tried. A temporary error for the whole dnslists item occurs
28149 only if no other DNS lookup in this sublist succeeds. In other words, a
28150 successful lookup for any of the items in the sublist overrides a temporary
28151 error for a previous item.
28152
28153 The ability to supply a list of items after the slash is in some sense just a
28154 syntactic convenience. These two examples have the same effect:
28155 .code
28156 dnslists = black.list.tld/a.domain : black.list.tld/b.domain
28157 dnslists = black.list.tld/a.domain::b.domain
28158 .endd
28159 However, when the data for the list is obtained from a lookup, the second form
28160 is usually much more convenient. Consider this example:
28161 .code
28162 deny message  = The mail servers for the domain \
28163                 $sender_address_domain \
28164                 are listed at $dnslist_domain ($dnslist_value); \
28165                 see $dnslist_text.
28166      dnslists = sbl.spamhaus.org/<|${lookup dnsdb {>|a=<|\
28167                                    ${lookup dnsdb {>|mxh=\
28168                                    $sender_address_domain} }} }
28169 .endd
28170 Note the use of &`>|`& in the dnsdb lookup to specify the separator for
28171 multiple DNS records. The inner dnsdb lookup produces a list of MX hosts
28172 and the outer dnsdb lookup finds the IP addresses for these hosts. The result
28173 of expanding the condition might be something like this:
28174 .code
28175 dnslists = sbl.spahmaus.org/<|192.168.2.3|192.168.5.6|...
28176 .endd
28177 Thus, this example checks whether or not the IP addresses of the sender
28178 domain's mail servers are on the Spamhaus black list.
28179
28180 The key that was used for a successful DNS list lookup is put into the variable
28181 &$dnslist_matched$& (see section &<<SECID204>>&).
28182
28183
28184
28185
28186 .section "Data returned by DNS lists" "SECID203"
28187 .cindex "DNS list" "data returned from"
28188 DNS lists are constructed using address records in the DNS. The original RBL
28189 just used the address 127.0.0.1 on the right hand side of each record, but the
28190 RBL+ list and some other lists use a number of values with different meanings.
28191 The values used on the RBL+ list are:
28192 .display
28193 127.1.0.1  RBL
28194 127.1.0.2  DUL
28195 127.1.0.3  DUL and RBL
28196 127.1.0.4  RSS
28197 127.1.0.5  RSS and RBL
28198 127.1.0.6  RSS and DUL
28199 127.1.0.7  RSS and DUL and RBL
28200 .endd
28201 Section &<<SECTaddmatcon>>& below describes how you can distinguish between
28202 different values. Some DNS lists may return more than one address record;
28203 see section &<<SECThanmuldnsrec>>& for details of how they are checked.
28204
28205
28206 .section "Variables set from DNS lists" "SECID204"
28207 .cindex "expansion" "variables, set from DNS list"
28208 .cindex "DNS list" "variables set from"
28209 .vindex "&$dnslist_domain$&"
28210 .vindex "&$dnslist_matched$&"
28211 .vindex "&$dnslist_text$&"
28212 .vindex "&$dnslist_value$&"
28213 When an entry is found in a DNS list, the variable &$dnslist_domain$& contains
28214 the name of the overall domain that matched (for example,
28215 &`spamhaus.example`&), &$dnslist_matched$& contains the key within that domain
28216 (for example, &`192.168.5.3`&), and &$dnslist_value$& contains the data from
28217 the DNS record. When the key is an IP address, it is not reversed in
28218 &$dnslist_matched$& (though it is, of course, in the actual lookup). In simple
28219 cases, for example:
28220 .code
28221 deny dnslists = spamhaus.example
28222 .endd
28223 the key is also available in another variable (in this case,
28224 &$sender_host_address$&). In more complicated cases, however, this is not true.
28225 For example, using a data lookup (as described in section &<<SECTmulkeyfor>>&)
28226 might generate a dnslists lookup like this:
28227 .code
28228 deny dnslists = spamhaus.example/<|192.168.1.2|192.168.6.7|...
28229 .endd
28230 If this condition succeeds, the value in &$dnslist_matched$& might be
28231 &`192.168.6.7`& (for example).
28232
28233 If more than one address record is returned by the DNS lookup, all the IP
28234 addresses are included in &$dnslist_value$&, separated by commas and spaces.
28235 The variable &$dnslist_text$& contains the contents of any associated TXT
28236 record. For lists such as RBL+ the TXT record for a merged entry is often not
28237 very meaningful. See section &<<SECTmordetinf>>& for a way of obtaining more
28238 information.
28239
28240 You can use the DNS list variables in &%message%& or &%log_message%& modifiers
28241 &-- although these appear before the condition in the ACL, they are not
28242 expanded until after it has failed. For example:
28243 .code
28244 deny    hosts = !+local_networks
28245         message = $sender_host_address is listed \
28246                   at $dnslist_domain
28247         dnslists = rbl-plus.mail-abuse.example
28248 .endd
28249
28250
28251
28252 .section "Additional matching conditions for DNS lists" "SECTaddmatcon"
28253 .cindex "DNS list" "matching specific returned data"
28254 You can add an equals sign and an IP address after a &%dnslists%& domain name
28255 in order to restrict its action to DNS records with a matching right hand side.
28256 For example,
28257 .code
28258 deny dnslists = rblplus.mail-abuse.org=127.0.0.2
28259 .endd
28260 rejects only those hosts that yield 127.0.0.2. Without this additional data,
28261 any address record is considered to be a match. For the moment, we assume
28262 that the DNS lookup returns just one record. Section &<<SECThanmuldnsrec>>&
28263 describes how multiple records are handled.
28264
28265 More than one IP address may be given for checking, using a comma as a
28266 separator. These are alternatives &-- if any one of them matches, the
28267 &%dnslists%& condition is true. For example:
28268 .code
28269 deny  dnslists = a.b.c=127.0.0.2,127.0.0.3
28270 .endd
28271 If you want to specify a constraining address list and also specify names or IP
28272 addresses to be looked up, the constraining address list must be specified
28273 first. For example:
28274 .code
28275 deny dnslists = dsn.rfc-ignorant.org\
28276                 =127.0.0.2/$sender_address_domain
28277 .endd
28278
28279 If the character &`&&`& is used instead of &`=`&, the comparison for each
28280 listed IP address is done by a bitwise &"and"& instead of by an equality test.
28281 In other words, the listed addresses are used as bit masks. The comparison is
28282 true if all the bits in the mask are present in the address that is being
28283 tested. For example:
28284 .code
28285 dnslists = a.b.c&0.0.0.3
28286 .endd
28287 matches if the address is &'x.x.x.'&3, &'x.x.x.'&7, &'x.x.x.'&11, etc. If you
28288 want to test whether one bit or another bit is present (as opposed to both
28289 being present), you must use multiple values. For example:
28290 .code
28291 dnslists = a.b.c&0.0.0.1,0.0.0.2
28292 .endd
28293 matches if the final component of the address is an odd number or two times
28294 an odd number.
28295
28296
28297
28298 .section "Negated DNS matching conditions" "SECID205"
28299 You can supply a negative list of IP addresses as part of a &%dnslists%&
28300 condition. Whereas
28301 .code
28302 deny  dnslists = a.b.c=127.0.0.2,127.0.0.3
28303 .endd
28304 means &"deny if the host is in the black list at the domain &'a.b.c'& and the
28305 IP address yielded by the list is either 127.0.0.2 or 127.0.0.3"&,
28306 .code
28307 deny  dnslists = a.b.c!=127.0.0.2,127.0.0.3
28308 .endd
28309 means &"deny if the host is in the black list at the domain &'a.b.c'& and the
28310 IP address yielded by the list is not 127.0.0.2 and not 127.0.0.3"&. In other
28311 words, the result of the test is inverted if an exclamation mark appears before
28312 the &`=`& (or the &`&&`&) sign.
28313
28314 &*Note*&: This kind of negation is not the same as negation in a domain,
28315 host, or address list (which is why the syntax is different).
28316
28317 If you are using just one list, the negation syntax does not gain you much. The
28318 previous example is precisely equivalent to
28319 .code
28320 deny  dnslists = a.b.c
28321      !dnslists = a.b.c=127.0.0.2,127.0.0.3
28322 .endd
28323 However, if you are using multiple lists, the negation syntax is clearer.
28324 Consider this example:
28325 .code
28326 deny  dnslists = sbl.spamhaus.org : \
28327                  list.dsbl.org : \
28328                  dnsbl.njabl.org!=127.0.0.3 : \
28329                  relays.ordb.org
28330 .endd
28331 Using only positive lists, this would have to be:
28332 .code
28333 deny  dnslists = sbl.spamhaus.org : \
28334                  list.dsbl.org
28335 deny  dnslists = dnsbl.njabl.org
28336      !dnslists = dnsbl.njabl.org=127.0.0.3
28337 deny  dnslists = relays.ordb.org
28338 .endd
28339 which is less clear, and harder to maintain.
28340
28341
28342
28343
28344 .section "Handling multiple DNS records from a DNS list" "SECThanmuldnsrec"
28345 A DNS lookup for a &%dnslists%& condition may return more than one DNS record,
28346 thereby providing more than one IP address. When an item in a &%dnslists%& list
28347 is followed by &`=`& or &`&&`& and a list of IP addresses, in order to restrict
28348 the match to specific results from the DNS lookup, there are two ways in which
28349 the checking can be handled. For example, consider the condition:
28350 .code
28351 dnslists = a.b.c=127.0.0.1
28352 .endd
28353 What happens if the DNS lookup for the incoming IP address yields both
28354 127.0.0.1 and 127.0.0.2 by means of two separate DNS records? Is the
28355 condition true because at least one given value was found, or is it false
28356 because at least one of the found values was not listed? And how does this
28357 affect negated conditions? Both possibilities are provided for with the help of
28358 additional separators &`==`& and &`=&&`&.
28359
28360 .ilist
28361 If &`=`& or &`&&`& is used, the condition is true if any one of the looked up
28362 IP addresses matches one of the listed addresses. For the example above, the
28363 condition is true because 127.0.0.1 matches.
28364 .next
28365 If &`==`& or &`=&&`& is used, the condition is true only if every one of the
28366 looked up IP addresses matches one of the listed addresses. If the condition is
28367 changed to:
28368 .code
28369 dnslists = a.b.c==127.0.0.1
28370 .endd
28371 and the DNS lookup yields both 127.0.0.1 and 127.0.0.2, the condition is
28372 false because 127.0.0.2 is not listed. You would need to have:
28373 .code
28374 dnslists = a.b.c==127.0.0.1,127.0.0.2
28375 .endd
28376 for the condition to be true.
28377 .endlist
28378
28379 When &`!`& is used to negate IP address matching, it inverts the result, giving
28380 the precise opposite of the behaviour above. Thus:
28381 .ilist
28382 If &`!=`& or &`!&&`& is used, the condition is true if none of the looked up IP
28383 addresses matches one of the listed addresses. Consider:
28384 .code
28385 dnslists = a.b.c!&0.0.0.1
28386 .endd
28387 If the DNS lookup yields both 127.0.0.1 and 127.0.0.2, the condition is
28388 false because 127.0.0.1 matches.
28389 .next
28390 If &`!==`& or &`!=&&`& is used, the condition is true if there is at least one
28391 looked up IP address that does not match. Consider:
28392 .code
28393 dnslists = a.b.c!=&0.0.0.1
28394 .endd
28395 If the DNS lookup yields both 127.0.0.1 and 127.0.0.2, the condition is
28396 true, because 127.0.0.2 does not match. You would need to have:
28397 .code
28398 dnslists = a.b.c!=&0.0.0.1,0.0.0.2
28399 .endd
28400 for the condition to be false.
28401 .endlist
28402 When the DNS lookup yields only a single IP address, there is no difference
28403 between &`=`& and &`==`& and between &`&&`& and &`=&&`&.
28404
28405
28406
28407
28408 .section "Detailed information from merged DNS lists" "SECTmordetinf"
28409 .cindex "DNS list" "information from merged"
28410 When the facility for restricting the matching IP values in a DNS list is used,
28411 the text from the TXT record that is set in &$dnslist_text$& may not reflect
28412 the true reason for rejection. This happens when lists are merged and the IP
28413 address in the A record is used to distinguish them; unfortunately there is
28414 only one TXT record. One way round this is not to use merged lists, but that
28415 can be inefficient because it requires multiple DNS lookups where one would do
28416 in the vast majority of cases when the host of interest is not on any of the
28417 lists.
28418
28419 A less inefficient way of solving this problem is available. If
28420 two domain names, comma-separated, are given, the second is used first to
28421 do an initial check, making use of any IP value restrictions that are set.
28422 If there is a match, the first domain is used, without any IP value
28423 restrictions, to get the TXT record. As a byproduct of this, there is also
28424 a check that the IP being tested is indeed on the first list. The first
28425 domain is the one that is put in &$dnslist_domain$&. For example:
28426 .code
28427 reject message  = \
28428          rejected because $sender_host_address is blacklisted \
28429          at $dnslist_domain\n$dnslist_text
28430        dnslists = \
28431          sbl.spamhaus.org,sbl-xbl.spamhaus.org=127.0.0.2 : \
28432          dul.dnsbl.sorbs.net,dnsbl.sorbs.net=127.0.0.10
28433 .endd
28434 For the first blacklist item, this starts by doing a lookup in
28435 &'sbl-xbl.spamhaus.org'& and testing for a 127.0.0.2 return. If there is a
28436 match, it then looks in &'sbl.spamhaus.org'&, without checking the return
28437 value, and as long as something is found, it looks for the corresponding TXT
28438 record. If there is no match in &'sbl-xbl.spamhaus.org'&, nothing more is done.
28439 The second blacklist item is processed similarly.
28440
28441 If you are interested in more than one merged list, the same list must be
28442 given several times, but because the results of the DNS lookups are cached,
28443 the DNS calls themselves are not repeated. For example:
28444 .code
28445 reject dnslists = \
28446          http.dnsbl.sorbs.net,dnsbl.sorbs.net=127.0.0.2 : \
28447          socks.dnsbl.sorbs.net,dnsbl.sorbs.net=127.0.0.3 : \
28448          misc.dnsbl.sorbs.net,dnsbl.sorbs.net=127.0.0.4 : \
28449          dul.dnsbl.sorbs.net,dnsbl.sorbs.net=127.0.0.10
28450 .endd
28451 In this case there is one lookup in &'dnsbl.sorbs.net'&, and if none of the IP
28452 values matches (or if no record is found), this is the only lookup that is
28453 done. Only if there is a match is one of the more specific lists consulted.
28454
28455
28456
28457 .section "DNS lists and IPv6" "SECTmorednslistslast"
28458 .cindex "IPv6" "DNS black lists"
28459 .cindex "DNS list" "IPv6 usage"
28460 If Exim is asked to do a dnslist lookup for an IPv6 address, it inverts it
28461 nibble by nibble. For example, if the calling host's IP address is
28462 3ffe:ffff:836f:0a00:000a:0800:200a:c031, Exim might look up
28463 .code
28464 1.3.0.c.a.0.0.2.0.0.8.0.a.0.0.0.0.0.a.0.f.6.3.8.
28465   f.f.f.f.e.f.f.3.blackholes.mail-abuse.org
28466 .endd
28467 (split over two lines here to fit on the page). Unfortunately, some of the DNS
28468 lists contain wildcard records, intended for IPv4, that interact badly with
28469 IPv6. For example, the DNS entry
28470 .code
28471 *.3.some.list.example.    A    127.0.0.1
28472 .endd
28473 is probably intended to put the entire 3.0.0.0/8 IPv4 network on the list.
28474 Unfortunately, it also matches the entire 3::/4 IPv6 network.
28475
28476 You can exclude IPv6 addresses from DNS lookups by making use of a suitable
28477 &%condition%& condition, as in this example:
28478 .code
28479 deny   condition = ${if isip4{$sender_host_address}}
28480        dnslists  = some.list.example
28481 .endd
28482
28483 .section "Rate limiting incoming messages" "SECTratelimiting"
28484 .cindex "rate limiting" "client sending"
28485 .cindex "limiting client sending rates"
28486 .oindex "&%smtp_ratelimit_*%&"
28487 The &%ratelimit%& ACL condition can be used to measure and control the rate at
28488 which clients can send email. This is more powerful than the
28489 &%smtp_ratelimit_*%& options, because those options control the rate of
28490 commands in a single SMTP session only, whereas the &%ratelimit%& condition
28491 works across all connections (concurrent and sequential) from the same client
28492 host. The syntax of the &%ratelimit%& condition is:
28493 .display
28494 &`ratelimit =`& <&'m'&> &`/`& <&'p'&> &`/`& <&'options'&> &`/`& <&'key'&>
28495 .endd
28496 If the average client sending rate is less than &'m'& messages per time
28497 period &'p'& then the condition is false; otherwise it is true.
28498
28499 As a side-effect, the &%ratelimit%& condition sets the expansion variable
28500 &$sender_rate$& to the client's computed rate, &$sender_rate_limit$& to the
28501 configured value of &'m'&, and &$sender_rate_period$& to the configured value
28502 of &'p'&.
28503
28504 The parameter &'p'& is the smoothing time constant, in the form of an Exim
28505 time interval, for example, &`8h`& for eight hours. A larger time constant
28506 means that it takes Exim longer to forget a client's past behaviour. The
28507 parameter &'m'& is the maximum number of messages that a client is permitted to
28508 send in each time interval. It also specifies the number of messages permitted
28509 in a fast burst. By increasing both &'m'& and &'p'& but keeping &'m/p'&
28510 constant, you can allow a client to send more messages in a burst without
28511 changing its long-term sending rate limit. Conversely, if &'m'& and &'p'& are
28512 both small, messages must be sent at an even rate.
28513
28514 There is a script in &_util/ratelimit.pl_& which extracts sending rates from
28515 log files, to assist with choosing appropriate settings for &'m'& and &'p'&
28516 when deploying the &%ratelimit%& ACL condition. The script prints usage
28517 instructions when it is run with no arguments.
28518
28519 The key is used to look up the data for calculating the client's average
28520 sending rate. This data is stored in Exim's spool directory, alongside the
28521 retry and other hints databases. The default key is &$sender_host_address$&,
28522 which means Exim computes the sending rate of each client host IP address.
28523 By changing the key you can change how Exim identifies clients for the purpose
28524 of ratelimiting. For example, to limit the sending rate of each authenticated
28525 user, independent of the computer they are sending from, set the key to
28526 &$authenticated_id$&. You must ensure that the lookup key is meaningful; for
28527 example, &$authenticated_id$& is only meaningful if the client has
28528 authenticated (which you can check with the &%authenticated%& ACL condition).
28529
28530 The lookup key does not have to identify clients: If you want to limit the
28531 rate at which a recipient receives messages, you can use the key
28532 &`$local_part@$domain`& with the &%per_rcpt%& option (see below) in a RCPT
28533 ACL.
28534
28535 Each &%ratelimit%& condition can have up to four options. A &%per_*%& option
28536 specifies what Exim measures the rate of, for example messages or recipients
28537 or bytes. You can adjust the measurement using the &%unique=%& and/or
28538 &%count=%& options. You can also control when Exim updates the recorded rate
28539 using a &%strict%&, &%leaky%&, or &%readonly%& option. The options are
28540 separated by a slash, like the other parameters. They may appear in any order.
28541
28542 Internally, Exim appends the smoothing constant &'p'& onto the lookup key with
28543 any options that alter the meaning of the stored data. The limit &'m'& is not
28544 stored, so you can alter the configured maximum rate and Exim will still
28545 remember clients' past behaviour. If you change the &%per_*%& mode or add or
28546 remove the &%unique=%& option, the lookup key changes so Exim will forget past
28547 behaviour. The lookup key is not affected by changes to the update mode and
28548 the &%count=%& option.
28549
28550
28551 .section "Ratelimit options for what is being measured" "ratoptmea"
28552 .cindex "rate limiting" "per_* options"
28553 The &%per_conn%& option limits the client's connection rate. It is not
28554 normally used in the &%acl_not_smtp%&, &%acl_not_smtp_mime%&, or
28555 &%acl_not_smtp_start%& ACLs.
28556
28557 The &%per_mail%& option limits the client's rate of sending messages. This is
28558 the default if none of the &%per_*%& options is specified. It can be used in
28559 &%acl_smtp_mail%&, &%acl_smtp_rcpt%&, &%acl_smtp_predata%&, &%acl_smtp_mime%&,
28560 &%acl_smtp_data%&, or &%acl_not_smtp%&.
28561
28562 The &%per_byte%& option limits the sender's email bandwidth. It can be used in
28563 the same ACLs as the &%per_mail%& option, though it is best to use this option
28564 in the &%acl_smtp_mime%&, &%acl_smtp_data%& or &%acl_not_smtp%& ACLs; if it is
28565 used in an earlier ACL, Exim relies on the SIZE parameter given by the client
28566 in its MAIL command, which may be inaccurate or completely missing. You can
28567 follow the limit &'m'& in the configuration with K, M, or G to specify limits
28568 in kilobytes, megabytes, or gigabytes, respectively.
28569
28570 The &%per_rcpt%& option causes Exim to limit the rate at which recipients are
28571 accepted. It can be used in the &%acl_smtp_rcpt%&, &%acl_smtp_predata%&,
28572 &%acl_smtp_mime%&, &%acl_smtp_data%&, or &%acl_smtp_rcpt%& ACLs. In
28573 &%acl_smtp_rcpt%& the rate is updated one recipient at a time; in the other
28574 ACLs the rate is updated with the total recipient count in one go. Note that
28575 in either case the rate limiting engine will see a message with many
28576 recipients as a large high-speed burst.
28577
28578 The &%per_addr%& option is like the &%per_rcpt%& option, except it counts the
28579 number of different recipients that the client has sent messages to in the
28580 last time period. That is, if the client repeatedly sends messages to the same
28581 recipient, its measured rate is not increased. This option can only be used in
28582 &%acl_smtp_rcpt%&.
28583
28584 The &%per_cmd%& option causes Exim to recompute the rate every time the
28585 condition is processed. This can be used to limit the rate of any SMTP
28586 command. If it is used in multiple ACLs it can limit the aggregate rate of
28587 multiple different commands.
28588
28589 The &%count=%& option can be used to alter how much Exim adds to the client's
28590 measured rate. For example, the &%per_byte%& option is equivalent to
28591 &`per_mail/count=$message_size`&. If there is no &%count=%& option, Exim
28592 increases the measured rate by one (except for the &%per_rcpt%& option in ACLs
28593 other than &%acl_smtp_rcpt%&). The count does not have to be an integer.
28594
28595 The &%unique=%& option is described in section &<<ratoptuniq>>& below.
28596
28597
28598 .section "Ratelimit update modes" "ratoptupd"
28599 .cindex "rate limiting" "reading data without updating"
28600 You can specify one of three options with the &%ratelimit%& condition to
28601 control when its database is updated. This section describes the &%readonly%&
28602 mode, and the next section describes the &%strict%& and &%leaky%& modes.
28603
28604 If the &%ratelimit%& condition is used in &%readonly%& mode, Exim looks up a
28605 previously-computed rate to check against the limit.
28606
28607 For example, you can test the client's sending rate and deny it access (when
28608 it is too fast) in the connect ACL. If the client passes this check then it
28609 can go on to send a message, in which case its recorded rate will be updated
28610 in the MAIL ACL. Subsequent connections from the same client will check this
28611 new rate.
28612 .code
28613 acl_check_connect:
28614  deny ratelimit = 100 / 5m / readonly
28615     log_message = RATE CHECK: $sender_rate/$sender_rate_period \
28616                   (max $sender_rate_limit)
28617 # ...
28618 acl_check_mail:
28619  warn ratelimit = 100 / 5m / strict
28620     log_message = RATE UPDATE: $sender_rate/$sender_rate_period \
28621                   (max $sender_rate_limit)
28622 .endd
28623
28624 If Exim encounters multiple &%ratelimit%& conditions with the same key when
28625 processing a message then it may increase the client's measured rate more than
28626 it should. For example, this will happen if you check the &%per_rcpt%& option
28627 in both &%acl_smtp_rcpt%& and &%acl_smtp_data%&. However it's OK to check the
28628 same &%ratelimit%& condition multiple times in the same ACL. You can avoid any
28629 multiple update problems by using the &%readonly%& option on later ratelimit
28630 checks.
28631
28632 The &%per_*%& options described above do not make sense in some ACLs. If you
28633 use a &%per_*%& option in an ACL where it is not normally permitted then the
28634 update mode defaults to &%readonly%& and you cannot specify the &%strict%& or
28635 &%leaky%& modes. In other ACLs the default update mode is &%leaky%& (see the
28636 next section) so you must specify the &%readonly%& option explicitly.
28637
28638
28639 .section "Ratelimit options for handling fast clients" "ratoptfast"
28640 .cindex "rate limiting" "strict and leaky modes"
28641 If a client's average rate is greater than the maximum, the rate limiting
28642 engine can react in two possible ways, depending on the presence of the
28643 &%strict%& or &%leaky%& update modes. This is independent of the other
28644 counter-measures (such as rejecting the message) that may be specified by the
28645 rest of the ACL.
28646
28647 The &%leaky%& (default) option means that the client's recorded rate is not
28648 updated if it is above the limit. The effect of this is that Exim measures the
28649 client's average rate of successfully sent email, which cannot be greater than
28650 the maximum allowed. If the client is over the limit it may suffer some
28651 counter-measures (as specified in the ACL), but it will still be able to send
28652 email at the configured maximum rate, whatever the rate of its attempts. This
28653 is generally the better choice if you have clients that retry automatically.
28654 For example, it does not prevent a sender with an over-aggressive retry rate
28655 from getting any email through.
28656
28657 The &%strict%& option means that the client's recorded rate is always
28658 updated. The effect of this is that Exim measures the client's average rate
28659 of attempts to send email, which can be much higher than the maximum it is
28660 actually allowed. If the client is over the limit it may be subjected to
28661 counter-measures by the ACL. It must slow down and allow sufficient time to
28662 pass that its computed rate falls below the maximum before it can send email
28663 again. The time (the number of smoothing periods) it must wait and not
28664 attempt to send mail can be calculated with this formula:
28665 .code
28666         ln(peakrate/maxrate)
28667 .endd
28668
28669
28670 .section "Limiting the rate of different events" "ratoptuniq"
28671 .cindex "rate limiting" "counting unique events"
28672 The &%ratelimit%& &%unique=%& option controls a mechanism for counting the
28673 rate of different events. For example, the &%per_addr%& option uses this
28674 mechanism to count the number of different recipients that the client has
28675 sent messages to in the last time period; it is equivalent to
28676 &`per_rcpt/unique=$local_part@$domain`&. You could use this feature to
28677 measure the rate that a client uses different sender addresses with the
28678 options &`per_mail/unique=$sender_address`&.
28679
28680 For each &%ratelimit%& key Exim stores the set of &%unique=%& values that it
28681 has seen for that key. The whole set is thrown away when it is older than the
28682 rate smoothing period &'p'&, so each different event is counted at most once
28683 per period. In the &%leaky%& update mode, an event that causes the client to
28684 go over the limit is not added to the set, in the same way that the client's
28685 recorded rate is not updated in the same situation.
28686
28687 When you combine the &%unique=%& and &%readonly%& options, the specific
28688 &%unique=%& value is ignored, and Exim just retrieves the client's stored
28689 rate.
28690
28691 The &%unique=%& mechanism needs more space in the ratelimit database than the
28692 other &%ratelimit%& options in order to store the event set. The number of
28693 unique values is potentially as large as the rate limit, so the extra space
28694 required increases with larger limits.
28695
28696 The uniqueification is not perfect: there is a small probability that Exim
28697 will think a new event has happened before. If the sender's rate is less than
28698 the limit, Exim should be more than 99.9% correct. However in &%strict%& mode
28699 the measured rate can go above the limit, in which case Exim may under-count
28700 events by a significant margin. Fortunately, if the rate is high enough (2.7
28701 times the limit) that the false positive rate goes above 9%, then Exim will
28702 throw away the over-full event set before the measured rate falls below the
28703 limit. Therefore the only harm should be that exceptionally high sending rates
28704 are logged incorrectly; any countermeasures you configure will be as effective
28705 as intended.
28706
28707
28708 .section "Using rate limiting" "useratlim"
28709 Exim's other ACL facilities are used to define what counter-measures are taken
28710 when the rate limit is exceeded. This might be anything from logging a warning
28711 (for example, while measuring existing sending rates in order to define
28712 policy), through time delays to slow down fast senders, up to rejecting the
28713 message. For example:
28714 .code
28715 # Log all senders' rates
28716 warn ratelimit = 0 / 1h / strict
28717      log_message = Sender rate $sender_rate / $sender_rate_period
28718
28719 # Slow down fast senders; note the need to truncate $sender_rate
28720 # at the decimal point.
28721 warn ratelimit = 100 / 1h / per_rcpt / strict
28722      delay     = ${eval: ${sg{$sender_rate}{[.].*}{}} - \
28723                    $sender_rate_limit }s
28724
28725 # Keep authenticated users under control
28726 deny authenticated = *
28727      ratelimit = 100 / 1d / strict / $authenticated_id
28728
28729 # System-wide rate limit
28730 defer message = Sorry, too busy. Try again later.
28731      ratelimit = 10 / 1s / $primary_hostname
28732
28733 # Restrict incoming rate from each host, with a default
28734 # set using a macro and special cases looked up in a table.
28735 defer message = Sender rate exceeds $sender_rate_limit \
28736                messages per $sender_rate_period
28737      ratelimit = ${lookup {$sender_host_address} \
28738                    cdb {DB/ratelimits.cdb} \
28739                    {$value} {RATELIMIT} }
28740 .endd
28741 &*Warning*&: If you have a busy server with a lot of &%ratelimit%& tests,
28742 especially with the &%per_rcpt%& option, you may suffer from a performance
28743 bottleneck caused by locking on the ratelimit hints database. Apart from
28744 making your ACLs less complicated, you can reduce the problem by using a
28745 RAM disk for Exim's hints directory (usually &_/var/spool/exim/db/_&). However
28746 this means that Exim will lose its hints data after a reboot (including retry
28747 hints, the callout cache, and ratelimit data).
28748
28749
28750
28751 .section "Address verification" "SECTaddressverification"
28752 .cindex "verifying address" "options for"
28753 .cindex "policy control" "address verification"
28754 Several of the &%verify%& conditions described in section
28755 &<<SECTaclconditions>>& cause addresses to be verified. Section
28756 &<<SECTsenaddver>>& discusses the reporting of sender verification failures.
28757 The verification conditions can be followed by options that modify the
28758 verification process. The options are separated from the keyword and from each
28759 other by slashes, and some of them contain parameters. For example:
28760 .code
28761 verify = sender/callout
28762 verify = recipient/defer_ok/callout=10s,defer_ok
28763 .endd
28764 The first stage of address verification, which always happens, is to run the
28765 address through the routers, in &"verify mode"&. Routers can detect the
28766 difference between verification and routing for delivery, and their actions can
28767 be varied by a number of generic options such as &%verify%& and &%verify_only%&
28768 (see chapter &<<CHAProutergeneric>>&). If routing fails, verification fails.
28769 The available options are as follows:
28770
28771 .ilist
28772 If the &%callout%& option is specified, successful routing to one or more
28773 remote hosts is followed by a &"callout"& to those hosts as an additional
28774 check. Callouts and their sub-options are discussed in the next section.
28775 .next
28776 If there is a defer error while doing verification routing, the ACL
28777 normally returns &"defer"&. However, if you include &%defer_ok%& in the
28778 options, the condition is forced to be true instead. Note that this is a main
28779 verification option as well as a suboption for callouts.
28780 .next
28781 The &%no_details%& option is covered in section &<<SECTsenaddver>>&, which
28782 discusses the reporting of sender address verification failures.
28783 .next
28784 The &%success_on_redirect%& option causes verification always to succeed
28785 immediately after a successful redirection. By default, if a redirection
28786 generates just one address, that address is also verified. See further
28787 discussion in section &<<SECTredirwhilveri>>&.
28788 .endlist
28789
28790 .cindex "verifying address" "differentiating failures"
28791 .vindex "&$recipient_verify_failure$&"
28792 .vindex "&$sender_verify_failure$&"
28793 .vindex "&$acl_verify_message$&"
28794 After an address verification failure, &$acl_verify_message$& contains the
28795 error message that is associated with the failure. It can be preserved by
28796 coding like this:
28797 .code
28798 warn  !verify = sender
28799        set acl_m0 = $acl_verify_message
28800 .endd
28801 If you are writing your own custom rejection message or log message when
28802 denying access, you can use this variable to include information about the
28803 verification failure.
28804
28805 In addition, &$sender_verify_failure$& or &$recipient_verify_failure$& (as
28806 appropriate) contains one of the following words:
28807
28808 .ilist
28809 &%qualify%&: The address was unqualified (no domain), and the message
28810 was neither local nor came from an exempted host.
28811 .next
28812 &%route%&: Routing failed.
28813 .next
28814 &%mail%&: Routing succeeded, and a callout was attempted; rejection
28815 occurred at or before the MAIL command (that is, on initial
28816 connection, HELO, or MAIL).
28817 .next
28818 &%recipient%&: The RCPT command in a callout was rejected.
28819 .next
28820 &%postmaster%&: The postmaster check in a callout was rejected.
28821 .endlist
28822
28823 The main use of these variables is expected to be to distinguish between
28824 rejections of MAIL and rejections of RCPT in callouts.
28825
28826
28827
28828
28829 .section "Callout verification" "SECTcallver"
28830 .cindex "verifying address" "by callout"
28831 .cindex "callout" "verification"
28832 .cindex "SMTP" "callout verification"
28833 For non-local addresses, routing verifies the domain, but is unable to do any
28834 checking of the local part. There are situations where some means of verifying
28835 the local part is desirable. One way this can be done is to make an SMTP
28836 &'callback'& to a delivery host for the sender address or a &'callforward'& to
28837 a subsequent host for a recipient address, to see if the host accepts the
28838 address. We use the term &'callout'& to cover both cases. Note that for a
28839 sender address, the callback is not to the client host that is trying to
28840 deliver the message, but to one of the hosts that accepts incoming mail for the
28841 sender's domain.
28842
28843 Exim does not do callouts by default. If you want them to happen, you must
28844 request them by setting appropriate options on the &%verify%& condition, as
28845 described below. This facility should be used with care, because it can add a
28846 lot of resource usage to the cost of verifying an address. However, Exim does
28847 cache the results of callouts, which helps to reduce the cost. Details of
28848 caching are in section &<<SECTcallvercache>>&.
28849
28850 Recipient callouts are usually used only between hosts that are controlled by
28851 the same administration. For example, a corporate gateway host could use
28852 callouts to check for valid recipients on an internal mailserver. A successful
28853 callout does not guarantee that a real delivery to the address would succeed;
28854 on the other hand, a failing callout does guarantee that a delivery would fail.
28855
28856 If the &%callout%& option is present on a condition that verifies an address, a
28857 second stage of verification occurs if the address is successfully routed to
28858 one or more remote hosts. The usual case is routing by a &(dnslookup)& or a
28859 &(manualroute)& router, where the router specifies the hosts. However, if a
28860 router that does not set up hosts routes to an &(smtp)& transport with a
28861 &%hosts%& setting, the transport's hosts are used. If an &(smtp)& transport has
28862 &%hosts_override%& set, its hosts are always used, whether or not the router
28863 supplies a host list.
28864
28865 The port that is used is taken from the transport, if it is specified and is a
28866 remote transport. (For routers that do verification only, no transport need be
28867 specified.) Otherwise, the default SMTP port is used. If a remote transport
28868 specifies an outgoing interface, this is used; otherwise the interface is not
28869 specified. Likewise, the text that is used for the HELO command is taken from
28870 the transport's &%helo_data%& option; if there is no transport, the value of
28871 &$smtp_active_hostname$& is used.
28872
28873 For a sender callout check, Exim makes SMTP connections to the remote hosts, to
28874 test whether a bounce message could be delivered to the sender address. The
28875 following SMTP commands are sent:
28876 .display
28877 &`HELO `&<&'local host name'&>
28878 &`MAIL FROM:<>`&
28879 &`RCPT TO:`&<&'the address to be tested'&>
28880 &`QUIT`&
28881 .endd
28882 LHLO is used instead of HELO if the transport's &%protocol%& option is
28883 set to &"lmtp"&.
28884
28885 The callout may use EHLO, AUTH and/or STARTTLS given appropriate option
28886 settings.
28887
28888 A recipient callout check is similar. By default, it also uses an empty address
28889 for the sender. This default is chosen because most hosts do not make use of
28890 the sender address when verifying a recipient. Using the same address means
28891 that a single cache entry can be used for each recipient. Some sites, however,
28892 do make use of the sender address when verifying. These are catered for by the
28893 &%use_sender%& and &%use_postmaster%& options, described in the next section.
28894
28895 If the response to the RCPT command is a 2&'xx'& code, the verification
28896 succeeds. If it is 5&'xx'&, the verification fails. For any other condition,
28897 Exim tries the next host, if any. If there is a problem with all the remote
28898 hosts, the ACL yields &"defer"&, unless the &%defer_ok%& parameter of the
28899 &%callout%& option is given, in which case the condition is forced to succeed.
28900
28901 .cindex "SMTP" "output flushing, disabling for callout"
28902 A callout may take a little time. For this reason, Exim normally flushes SMTP
28903 output before performing a callout in an ACL, to avoid unexpected timeouts in
28904 clients when the SMTP PIPELINING extension is in use. The flushing can be
28905 disabled by using a &%control%& modifier to set &%no_callout_flush%&.
28906
28907
28908
28909
28910 .section "Additional parameters for callouts" "CALLaddparcall"
28911 .cindex "callout" "additional parameters for"
28912 The &%callout%& option can be followed by an equals sign and a number of
28913 optional parameters, separated by commas. For example:
28914 .code
28915 verify = recipient/callout=10s,defer_ok
28916 .endd
28917 The old syntax, which had &%callout_defer_ok%& and &%check_postmaster%& as
28918 separate verify options, is retained for backwards compatibility, but is now
28919 deprecated. The additional parameters for &%callout%& are as follows:
28920
28921
28922 .vlist
28923 .vitem <&'a&~time&~interval'&>
28924 .cindex "callout" "timeout, specifying"
28925 This specifies the timeout that applies for the callout attempt to each host.
28926 For example:
28927 .code
28928 verify = sender/callout=5s
28929 .endd
28930 The default is 30 seconds. The timeout is used for each response from the
28931 remote host. It is also used for the initial connection, unless overridden by
28932 the &%connect%& parameter.
28933
28934
28935 .vitem &*connect&~=&~*&<&'time&~interval'&>
28936 .cindex "callout" "connection timeout, specifying"
28937 This parameter makes it possible to set a different (usually smaller) timeout
28938 for making the SMTP connection. For example:
28939 .code
28940 verify = sender/callout=5s,connect=1s
28941 .endd
28942 If not specified, this timeout defaults to the general timeout value.
28943
28944 .vitem &*defer_ok*&
28945 .cindex "callout" "defer, action on"
28946 When this parameter is present, failure to contact any host, or any other kind
28947 of temporary error, is treated as success by the ACL. However, the cache is not
28948 updated in this circumstance.
28949
28950 .vitem &*fullpostmaster*&
28951 .cindex "callout" "full postmaster check"
28952 This operates like the &%postmaster%& option (see below), but if the check for
28953 &'postmaster@domain'& fails, it tries just &'postmaster'&, without a domain, in
28954 accordance with the specification in RFC 2821. The RFC states that the
28955 unqualified address &'postmaster'& should be accepted.
28956
28957
28958 .vitem &*mailfrom&~=&~*&<&'email&~address'&>
28959 .cindex "callout" "sender when verifying header"
28960 When verifying addresses in header lines using the &%header_sender%&
28961 verification option, Exim behaves by default as if the addresses are envelope
28962 sender addresses from a message. Callout verification therefore tests to see
28963 whether a bounce message could be delivered, by using an empty address in the
28964 MAIL command. However, it is arguable that these addresses might never be used
28965 as envelope senders, and could therefore justifiably reject bounce messages
28966 (empty senders). The &%mailfrom%& callout parameter allows you to specify what
28967 address to use in the MAIL command. For example:
28968 .code
28969 require  verify = header_sender/callout=mailfrom=abcd@x.y.z
28970 .endd
28971 This parameter is available only for the &%header_sender%& verification option.
28972
28973
28974 .vitem &*maxwait&~=&~*&<&'time&~interval'&>
28975 .cindex "callout" "overall timeout, specifying"
28976 This parameter sets an overall timeout for performing a callout verification.
28977 For example:
28978 .code
28979 verify = sender/callout=5s,maxwait=30s
28980 .endd
28981 This timeout defaults to four times the callout timeout for individual SMTP
28982 commands. The overall timeout applies when there is more than one host that can
28983 be tried. The timeout is checked before trying the next host. This prevents
28984 very long delays if there are a large number of hosts and all are timing out
28985 (for example, when network connections are timing out).
28986
28987
28988 .vitem &*no_cache*&
28989 .cindex "callout" "cache, suppressing"
28990 .cindex "caching callout, suppressing"
28991 When this parameter is given, the callout cache is neither read nor updated.
28992
28993 .vitem &*postmaster*&
28994 .cindex "callout" "postmaster; checking"
28995 When this parameter is set, a successful callout check is followed by a similar
28996 check for the local part &'postmaster'& at the same domain. If this address is
28997 rejected, the callout fails (but see &%fullpostmaster%& above). The result of
28998 the postmaster check is recorded in a cache record; if it is a failure, this is
28999 used to fail subsequent callouts for the domain without a connection being
29000 made, until the cache record expires.
29001
29002 .vitem &*postmaster_mailfrom&~=&~*&<&'email&~address'&>
29003 The postmaster check uses an empty sender in the MAIL command by default.
29004 You can use this parameter to do a postmaster check using a different address.
29005 For example:
29006 .code
29007 require  verify = sender/callout=postmaster_mailfrom=abc@x.y.z
29008 .endd
29009 If both &%postmaster%& and &%postmaster_mailfrom%& are present, the rightmost
29010 one overrides. The &%postmaster%& parameter is equivalent to this example:
29011 .code
29012 require  verify = sender/callout=postmaster_mailfrom=
29013 .endd
29014 &*Warning*&: The caching arrangements for postmaster checking do not take
29015 account of the sender address. It is assumed that either the empty address or
29016 a fixed non-empty address will be used. All that Exim remembers is that the
29017 postmaster check for the domain succeeded or failed.
29018
29019
29020 .vitem &*random*&
29021 .cindex "callout" "&""random""& check"
29022 When this parameter is set, before doing the normal callout check, Exim does a
29023 check for a &"random"& local part at the same domain. The local part is not
29024 really random &-- it is defined by the expansion of the option
29025 &%callout_random_local_part%&, which defaults to
29026 .code
29027 $primary_hostname-$tod_epoch-testing
29028 .endd
29029 The idea here is to try to determine whether the remote host accepts all local
29030 parts without checking. If it does, there is no point in doing callouts for
29031 specific local parts. If the &"random"& check succeeds, the result is saved in
29032 a cache record, and used to force the current and subsequent callout checks to
29033 succeed without a connection being made, until the cache record expires.
29034
29035 .vitem &*use_postmaster*&
29036 .cindex "callout" "sender for recipient check"
29037 This parameter applies to recipient callouts only. For example:
29038 .code
29039 deny  !verify = recipient/callout=use_postmaster
29040 .endd
29041 .vindex "&$qualify_domain$&"
29042 It causes a non-empty postmaster address to be used in the MAIL command when
29043 performing the callout for the recipient, and also for a &"random"& check if
29044 that is configured. The local part of the address is &`postmaster`& and the
29045 domain is the contents of &$qualify_domain$&.
29046
29047 .vitem &*use_sender*&
29048 This option applies to recipient callouts only. For example:
29049 .code
29050 require  verify = recipient/callout=use_sender
29051 .endd
29052 It causes the message's actual sender address to be used in the MAIL
29053 command when performing the callout, instead of an empty address. There is no
29054 need to use this option unless you know that the called hosts make use of the
29055 sender when checking recipients. If used indiscriminately, it reduces the
29056 usefulness of callout caching.
29057 .endlist
29058
29059 If you use any of the parameters that set a non-empty sender for the MAIL
29060 command (&%mailfrom%&, &%postmaster_mailfrom%&, &%use_postmaster%&, or
29061 &%use_sender%&), you should think about possible loops. Recipient checking is
29062 usually done between two hosts that are under the same management, and the host
29063 that receives the callouts is not normally configured to do callouts itself.
29064 Therefore, it is normally safe to use &%use_postmaster%& or &%use_sender%& in
29065 these circumstances.
29066
29067 However, if you use a non-empty sender address for a callout to an arbitrary
29068 host, there is the likelihood that the remote host will itself initiate a
29069 callout check back to your host. As it is checking what appears to be a message
29070 sender, it is likely to use an empty address in MAIL, thus avoiding a
29071 callout loop. However, to be on the safe side it would be best to set up your
29072 own ACLs so that they do not do sender verification checks when the recipient
29073 is the address you use for header sender or postmaster callout checking.
29074
29075 Another issue to think about when using non-empty senders for callouts is
29076 caching. When you set &%mailfrom%& or &%use_sender%&, the cache record is keyed
29077 by the sender/recipient combination; thus, for any given recipient, many more
29078 actual callouts are performed than when an empty sender or postmaster is used.
29079
29080
29081
29082
29083 .section "Callout caching" "SECTcallvercache"
29084 .cindex "hints database" "callout cache"
29085 .cindex "callout" "cache, description of"
29086 .cindex "caching" "callout"
29087 Exim caches the results of callouts in order to reduce the amount of resources
29088 used, unless you specify the &%no_cache%& parameter with the &%callout%&
29089 option. A hints database called &"callout"& is used for the cache. Two
29090 different record types are used: one records the result of a callout check for
29091 a specific address, and the other records information that applies to the
29092 entire domain (for example, that it accepts the local part &'postmaster'&).
29093
29094 When an original callout fails, a detailed SMTP error message is given about
29095 the failure. However, for subsequent failures use the cache data, this message
29096 is not available.
29097
29098 The expiry times for negative and positive address cache records are
29099 independent, and can be set by the global options &%callout_negative_expire%&
29100 (default 2h) and &%callout_positive_expire%& (default 24h), respectively.
29101
29102 If a host gives a negative response to an SMTP connection, or rejects any
29103 commands up to and including
29104 .code
29105 MAIL FROM:<>
29106 .endd
29107 (but not including the MAIL command with a non-empty address),
29108 any callout attempt is bound to fail. Exim remembers such failures in a
29109 domain cache record, which it uses to fail callouts for the domain without
29110 making new connections, until the domain record times out. There are two
29111 separate expiry times for domain cache records:
29112 &%callout_domain_negative_expire%& (default 3h) and
29113 &%callout_domain_positive_expire%& (default 7d).
29114
29115 Domain records expire when the negative expiry time is reached if callouts
29116 cannot be made for the domain, or if the postmaster check failed.
29117 Otherwise, they expire when the positive expiry time is reached. This
29118 ensures that, for example, a host that stops accepting &"random"& local parts
29119 will eventually be noticed.
29120
29121 The callout caching mechanism is based on the domain of the address that is
29122 being tested. If the domain routes to several hosts, it is assumed that their
29123 behaviour will be the same.
29124
29125
29126
29127 .section "Sender address verification reporting" "SECTsenaddver"
29128 .cindex "verifying" "suppressing error details"
29129 See section &<<SECTaddressverification>>& for a general discussion of
29130 verification. When sender verification fails in an ACL, the details of the
29131 failure are given as additional output lines before the 550 response to the
29132 relevant SMTP command (RCPT or DATA). For example, if sender callout is in use,
29133 you might see:
29134 .code
29135 MAIL FROM:<xyz@abc.example>
29136 250 OK
29137 RCPT TO:<pqr@def.example>
29138 550-Verification failed for <xyz@abc.example>
29139 550-Called:   192.168.34.43
29140 550-Sent:     RCPT TO:<xyz@abc.example>
29141 550-Response: 550 Unknown local part xyz in <xyz@abc.example>
29142 550 Sender verification failed
29143 .endd
29144 If more than one RCPT command fails in the same way, the details are given
29145 only for the first of them. However, some administrators do not want to send
29146 out this much information. You can suppress the details by adding
29147 &`/no_details`& to the ACL statement that requests sender verification. For
29148 example:
29149 .code
29150 verify = sender/no_details
29151 .endd
29152
29153 .section "Redirection while verifying" "SECTredirwhilveri"
29154 .cindex "verifying" "redirection while"
29155 .cindex "address redirection" "while verifying"
29156 A dilemma arises when a local address is redirected by aliasing or forwarding
29157 during verification: should the generated addresses themselves be verified,
29158 or should the successful expansion of the original address be enough to verify
29159 it? By default, Exim takes the following pragmatic approach:
29160
29161 .ilist
29162 When an incoming address is redirected to just one child address, verification
29163 continues with the child address, and if that fails to verify, the original
29164 verification also fails.
29165 .next
29166 When an incoming address is redirected to more than one child address,
29167 verification does not continue. A success result is returned.
29168 .endlist
29169
29170 This seems the most reasonable behaviour for the common use of aliasing as a
29171 way of redirecting different local parts to the same mailbox. It means, for
29172 example, that a pair of alias entries of the form
29173 .code
29174 A.Wol:   aw123
29175 aw123:   :fail: Gone away, no forwarding address
29176 .endd
29177 work as expected, with both local parts causing verification failure. When a
29178 redirection generates more than one address, the behaviour is more like a
29179 mailing list, where the existence of the alias itself is sufficient for
29180 verification to succeed.
29181
29182 It is possible, however, to change the default behaviour so that all successful
29183 redirections count as successful verifications, however many new addresses are
29184 generated. This is specified by the &%success_on_redirect%& verification
29185 option. For example:
29186 .code
29187 require verify = recipient/success_on_redirect/callout=10s
29188 .endd
29189 In this example, verification succeeds if a router generates a new address, and
29190 the callout does not occur, because no address was routed to a remote host.
29191
29192 When verification is being tested via the &%-bv%& option, the treatment of
29193 redirections is as just described, unless the &%-v%& or any debugging option is
29194 also specified. In that case, full verification is done for every generated
29195 address and a report is output for each of them.
29196
29197
29198
29199 .section "Client SMTP authorization (CSA)" "SECTverifyCSA"
29200 .cindex "CSA" "verifying"
29201 Client SMTP Authorization is a system that allows a site to advertise
29202 which machines are and are not permitted to send email. This is done by placing
29203 special SRV records in the DNS; these are looked up using the client's HELO
29204 domain. At the time of writing, CSA is still an Internet Draft. Client SMTP
29205 Authorization checks in Exim are performed by the ACL condition:
29206 .code
29207 verify = csa
29208 .endd
29209 This fails if the client is not authorized. If there is a DNS problem, or if no
29210 valid CSA SRV record is found, or if the client is authorized, the condition
29211 succeeds. These three cases can be distinguished using the expansion variable
29212 &$csa_status$&, which can take one of the values &"fail"&, &"defer"&,
29213 &"unknown"&, or &"ok"&. The condition does not itself defer because that would
29214 be likely to cause problems for legitimate email.
29215
29216 The error messages produced by the CSA code include slightly more
29217 detail. If &$csa_status$& is &"defer"&, this may be because of problems
29218 looking up the CSA SRV record, or problems looking up the CSA target
29219 address record. There are four reasons for &$csa_status$& being &"fail"&:
29220
29221 .ilist
29222 The client's host name is explicitly not authorized.
29223 .next
29224 The client's IP address does not match any of the CSA target IP addresses.
29225 .next
29226 The client's host name is authorized but it has no valid target IP addresses
29227 (for example, the target's addresses are IPv6 and the client is using IPv4).
29228 .next
29229 The client's host name has no CSA SRV record but a parent domain has asserted
29230 that all subdomains must be explicitly authorized.
29231 .endlist
29232
29233 The &%csa%& verification condition can take an argument which is the domain to
29234 use for the DNS query. The default is:
29235 .code
29236 verify = csa/$sender_helo_name
29237 .endd
29238 This implementation includes an extension to CSA. If the query domain
29239 is an address literal such as [192.0.2.95], or if it is a bare IP
29240 address, Exim searches for CSA SRV records in the reverse DNS as if
29241 the HELO domain was (for example) &'95.2.0.192.in-addr.arpa'&. Therefore it is
29242 meaningful to say:
29243 .code
29244 verify = csa/$sender_host_address
29245 .endd
29246 In fact, this is the check that Exim performs if the client does not say HELO.
29247 This extension can be turned off by setting the main configuration option
29248 &%dns_csa_use_reverse%& to be false.
29249
29250 If a CSA SRV record is not found for the domain itself, a search
29251 is performed through its parent domains for a record which might be
29252 making assertions about subdomains. The maximum depth of this search is limited
29253 using the main configuration option &%dns_csa_search_limit%&, which is 5 by
29254 default. Exim does not look for CSA SRV records in a top level domain, so the
29255 default settings handle HELO domains as long as seven
29256 (&'hostname.five.four.three.two.one.com'&). This encompasses the vast majority
29257 of legitimate HELO domains.
29258
29259 The &'dnsdb'& lookup also has support for CSA. Although &'dnsdb'& also supports
29260 direct SRV lookups, this is not sufficient because of the extra parent domain
29261 search behaviour of CSA, and (as with PTR lookups) &'dnsdb'& also turns IP
29262 addresses into lookups in the reverse DNS space. The result of a successful
29263 lookup such as:
29264 .code
29265 ${lookup dnsdb {csa=$sender_helo_name}}
29266 .endd
29267 has two space-separated fields: an authorization code and a target host name.
29268 The authorization code can be &"Y"& for yes, &"N"& for no, &"X"& for explicit
29269 authorization required but absent, or &"?"& for unknown.
29270
29271
29272
29273
29274 .section "Bounce address tag validation" "SECTverifyPRVS"
29275 .cindex "BATV, verifying"
29276 Bounce address tag validation (BATV) is a scheme whereby the envelope senders
29277 of outgoing messages have a cryptographic, timestamped &"tag"& added to them.
29278 Genuine incoming bounce messages should therefore always be addressed to
29279 recipients that have a valid tag. This scheme is a way of detecting unwanted
29280 bounce messages caused by sender address forgeries (often called &"collateral
29281 spam"&), because the recipients of such messages do not include valid tags.
29282
29283 There are two expansion items to help with the implementation of the BATV
29284 &"prvs"& (private signature) scheme in an Exim configuration. This scheme signs
29285 the original envelope sender address by using a simple key to add a hash of the
29286 address and some time-based randomizing information. The &%prvs%& expansion
29287 item creates a signed address, and the &%prvscheck%& expansion item checks one.
29288 The syntax of these expansion items is described in section
29289 &<<SECTexpansionitems>>&.
29290
29291 As an example, suppose the secret per-address keys are stored in an MySQL
29292 database. A query to look up the key for an address could be defined as a macro
29293 like this:
29294 .code
29295 PRVSCHECK_SQL = ${lookup mysql{SELECT secret FROM batv_prvs \
29296                 WHERE sender='${quote_mysql:$prvscheck_address}'\
29297                 }{$value}}
29298 .endd
29299 Suppose also that the senders who make use of BATV are defined by an address
29300 list called &%batv_senders%&. Then, in the ACL for RCPT commands, you could
29301 use this:
29302 .code
29303 # Bounces: drop unsigned addresses for BATV senders
29304 deny message = This address does not send an unsigned reverse path
29305      senders = :
29306      recipients = +batv_senders
29307
29308 # Bounces: In case of prvs-signed address, check signature.
29309 deny message = Invalid reverse path signature.
29310      senders = :
29311      condition  = ${prvscheck {$local_part@$domain}\
29312                   {PRVSCHECK_SQL}{1}}
29313      !condition = $prvscheck_result
29314 .endd
29315 The first statement rejects recipients for bounce messages that are addressed
29316 to plain BATV sender addresses, because it is known that BATV senders do not
29317 send out messages with plain sender addresses. The second statement rejects
29318 recipients that are prvs-signed, but with invalid signatures (either because
29319 the key is wrong, or the signature has timed out).
29320
29321 A non-prvs-signed address is not rejected by the second statement, because the
29322 &%prvscheck%& expansion yields an empty string if its first argument is not a
29323 prvs-signed address, thus causing the &%condition%& condition to be false. If
29324 the first argument is a syntactically valid prvs-signed address, the yield is
29325 the third string (in this case &"1"&), whether or not the cryptographic and
29326 timeout checks succeed. The &$prvscheck_result$& variable contains the result
29327 of the checks (empty for failure, &"1"& for success).
29328
29329 There is one more issue you must consider when implementing prvs-signing:
29330 you have to ensure that the routers accept prvs-signed addresses and
29331 deliver them correctly. The easiest way to handle this is to use a &(redirect)&
29332 router to remove the signature with a configuration along these lines:
29333 .code
29334 batv_redirect:
29335   driver = redirect
29336   data = ${prvscheck {$local_part@$domain}{PRVSCHECK_SQL}}
29337 .endd
29338 This works because, if the third argument of &%prvscheck%& is empty, the result
29339 of the expansion of a prvs-signed address is the decoded value of the original
29340 address. This router should probably be the first of your routers that handles
29341 local addresses.
29342
29343 To create BATV-signed addresses in the first place, a transport of this form
29344 can be used:
29345 .code
29346 external_smtp_batv:
29347   driver = smtp
29348   return_path = ${prvs {$return_path} \
29349                        {${lookup mysql{SELECT \
29350                        secret FROM batv_prvs WHERE \
29351                        sender='${quote_mysql:$sender_address}'} \
29352                        {$value}fail}}}
29353 .endd
29354 If no key can be found for the existing return path, no signing takes place.
29355
29356
29357
29358 .section "Using an ACL to control relaying" "SECTrelaycontrol"
29359 .cindex "&ACL;" "relay control"
29360 .cindex "relaying" "control by ACL"
29361 .cindex "policy control" "relay control"
29362 An MTA is said to &'relay'& a message if it receives it from some host and
29363 delivers it directly to another host as a result of a remote address contained
29364 within it. Redirecting a local address via an alias or forward file and then
29365 passing the message on to another host is not relaying,
29366 .cindex "&""percent hack""&"
29367 but a redirection as a result of the &"percent hack"& is.
29368
29369 Two kinds of relaying exist, which are termed &"incoming"& and &"outgoing"&.
29370 A host which is acting as a gateway or an MX backup is concerned with incoming
29371 relaying from arbitrary hosts to a specific set of domains. On the other hand,
29372 a host which is acting as a smart host for a number of clients is concerned
29373 with outgoing relaying from those clients to the Internet at large. Often the
29374 same host is fulfilling both functions,
29375 . ///
29376 . as illustrated in the diagram below,
29377 . ///
29378 but in principle these two kinds of relaying are entirely independent. What is
29379 not wanted is the transmission of mail from arbitrary remote hosts through your
29380 system to arbitrary domains.
29381
29382
29383 You can implement relay control by means of suitable statements in the ACL that
29384 runs for each RCPT command. For convenience, it is often easiest to use
29385 Exim's named list facility to define the domains and hosts involved. For
29386 example, suppose you want to do the following:
29387
29388 .ilist
29389 Deliver a number of domains to mailboxes on the local host (or process them
29390 locally in some other way). Let's say these are &'my.dom1.example'& and
29391 &'my.dom2.example'&.
29392 .next
29393 Relay mail for a number of other domains for which you are the secondary MX.
29394 These might be &'friend1.example'& and &'friend2.example'&.
29395 .next
29396 Relay mail from the hosts on your local LAN, to whatever domains are involved.
29397 Suppose your LAN is 192.168.45.0/24.
29398 .endlist
29399
29400
29401 In the main part of the configuration, you put the following definitions:
29402 .code
29403 domainlist local_domains    = my.dom1.example : my.dom2.example
29404 domainlist relay_to_domains = friend1.example : friend2.example
29405 hostlist   relay_from_hosts = 192.168.45.0/24
29406 .endd
29407 Now you can use these definitions in the ACL that is run for every RCPT
29408 command:
29409 .code
29410 acl_check_rcpt:
29411   accept domains = +local_domains : +relay_to_domains
29412   accept hosts   = +relay_from_hosts
29413 .endd
29414 The first statement accepts any RCPT command that contains an address in
29415 the local or relay domains. For any other domain, control passes to the second
29416 statement, which accepts the command only if it comes from one of the relay
29417 hosts. In practice, you will probably want to make your ACL more sophisticated
29418 than this, for example, by including sender and recipient verification. The
29419 default configuration includes a more comprehensive example, which is described
29420 in chapter &<<CHAPdefconfil>>&.
29421
29422
29423
29424 .section "Checking a relay configuration" "SECTcheralcon"
29425 .cindex "relaying" "checking control of"
29426 You can check the relay characteristics of your configuration in the same way
29427 that you can test any ACL behaviour for an incoming SMTP connection, by using
29428 the &%-bh%& option to run a fake SMTP session with which you interact.
29429
29430 For specifically testing for unwanted relaying, the host
29431 &'relay-test.mail-abuse.org'& provides a useful service. If you telnet to this
29432 host from the host on which Exim is running, using the normal telnet port, you
29433 will see a normal telnet connection message and then quite a long delay. Be
29434 patient. The remote host is making an SMTP connection back to your host, and
29435 trying a number of common probes to test for open relay vulnerability. The
29436 results of the tests will eventually appear on your terminal.
29437 .ecindex IIDacl
29438
29439
29440
29441 . ////////////////////////////////////////////////////////////////////////////
29442 . ////////////////////////////////////////////////////////////////////////////
29443
29444 .chapter "Content scanning at ACL time" "CHAPexiscan"
29445 .scindex IIDcosca "content scanning" "at ACL time"
29446 The extension of Exim to include content scanning at ACL time, formerly known
29447 as &"exiscan"&, was originally implemented as a patch by Tom Kistner. The code
29448 was integrated into the main source for Exim release 4.50, and Tom continues to
29449 maintain it. Most of the wording of this chapter is taken from Tom's
29450 specification.
29451
29452 It is also possible to scan the content of messages at other times. The
29453 &[local_scan()]& function (see chapter &<<CHAPlocalscan>>&) allows for content
29454 scanning after all the ACLs have run. A transport filter can be used to scan
29455 messages at delivery time (see the &%transport_filter%& option, described in
29456 chapter &<<CHAPtransportgeneric>>&).
29457
29458 If you want to include the ACL-time content-scanning features when you compile
29459 Exim, you need to arrange for WITH_CONTENT_SCAN to be defined in your
29460 &_Local/Makefile_&. When you do that, the Exim binary is built with:
29461
29462 .ilist
29463 Two additional ACLs (&%acl_smtp_mime%& and &%acl_not_smtp_mime%&) that are run
29464 for all MIME parts for SMTP and non-SMTP messages, respectively.
29465 .next
29466 Additional ACL conditions and modifiers: &%decode%&, &%malware%&,
29467 &%mime_regex%&, &%regex%&, and &%spam%&. These can be used in the ACL that is
29468 run at the end of message reception (the &%acl_smtp_data%& ACL).
29469 .next
29470 An additional control feature (&"no_mbox_unspool"&) that saves spooled copies
29471 of messages, or parts of messages, for debugging purposes.
29472 .next
29473 Additional expansion variables that are set in the new ACL and by the new
29474 conditions.
29475 .next
29476 Two new main configuration options: &%av_scanner%& and &%spamd_address%&.
29477 .endlist
29478
29479 There is another content-scanning configuration option for &_Local/Makefile_&,
29480 called WITH_OLD_DEMIME. If this is set, the old, deprecated &%demime%& ACL
29481 condition is compiled, in addition to all the other content-scanning features.
29482
29483 Content-scanning is continually evolving, and new features are still being
29484 added. While such features are still unstable and liable to incompatible
29485 changes, they are made available in Exim by setting options whose names begin
29486 EXPERIMENTAL_ in &_Local/Makefile_&. Such features are not documented in
29487 this manual. You can find out about them by reading the file called
29488 &_doc/experimental.txt_&.
29489
29490 All the content-scanning facilities work on a MBOX copy of the message that is
29491 temporarily created in a file called:
29492 .display
29493 <&'spool_directory'&>&`/scan/`&<&'message_id'&>/<&'message_id'&>&`.eml`&
29494 .endd
29495 The &_.eml_& extension is a friendly hint to virus scanners that they can
29496 expect an MBOX-like structure inside that file. The file is created when the
29497 first content scanning facility is called. Subsequent calls to content
29498 scanning conditions open the same file again. The directory is recursively
29499 removed when the &%acl_smtp_data%& ACL has finished running, unless
29500 .code
29501 control = no_mbox_unspool
29502 .endd
29503 has been encountered. When the MIME ACL decodes files, they are put into the
29504 same directory by default.
29505
29506
29507
29508 .section "Scanning for viruses" "SECTscanvirus"
29509 .cindex "virus scanning"
29510 .cindex "content scanning" "for viruses"
29511 .cindex "content scanning" "the &%malware%& condition"
29512 The &%malware%& ACL condition lets you connect virus scanner software to Exim.
29513 It supports a &"generic"& interface to scanners called via the shell, and
29514 specialized interfaces for &"daemon"& type virus scanners, which are resident
29515 in memory and thus are much faster.
29516
29517
29518 .oindex "&%av_scanner%&"
29519 You can set the &%av_scanner%& option in first part of the Exim configuration
29520 file to specify which scanner to use, together with any additional options that
29521 are needed. The basic syntax is as follows:
29522 .display
29523 &`av_scanner = <`&&'scanner-type'&&`>:<`&&'option1'&&`>:<`&&'option2'&&`>:[...]`&
29524 .endd
29525 If you do not set &%av_scanner%&, it defaults to
29526 .code
29527 av_scanner = sophie:/var/run/sophie
29528 .endd
29529 If the value of &%av_scanner%& starts with a dollar character, it is expanded
29530 before use. The following scanner types are supported in this release:
29531
29532 .vlist
29533 .vitem &%aveserver%&
29534 .cindex "virus scanners" "Kaspersky"
29535 This is the scanner daemon of Kaspersky Version 5. You can get a trial version
29536 at &url(http://www.kaspersky.com). This scanner type takes one option,
29537 which is the path to the daemon's UNIX socket. The default is shown in this
29538 example:
29539 .code
29540 av_scanner = aveserver:/var/run/aveserver
29541 .endd
29542
29543
29544 .vitem &%clamd%&
29545 .cindex "virus scanners" "clamd"
29546 This daemon-type scanner is GPL and free. You can get it at
29547 &url(http://www.clamav.net/). Some older versions of clamd do not seem to
29548 unpack MIME containers, so it used to be recommended to unpack MIME attachments
29549 in the MIME ACL. This no longer believed to be necessary. One option is
29550 required: either the path and name of a UNIX socket file, or a hostname or IP
29551 number, and a port, separated by space, as in the second of these examples:
29552 .code
29553 av_scanner = clamd:/opt/clamd/socket
29554 av_scanner = clamd:192.0.2.3 1234
29555 av_scanner = clamd:192.0.2.3 1234:local
29556 .endd
29557 If the value of av_scanner points to a UNIX socket file or contains the local
29558 keyword, then the ClamAV interface will pass a filename containing the data
29559 to be scanned, which will should normally result in less I/O happening and be
29560 more efficient.  Normally in the TCP case, the data is streamed to ClamAV as
29561 Exim does not assume that there is a common filesystem with the remote host.
29562 There is an option WITH_OLD_CLAMAV_STREAM in &_src/EDITME_& available, should
29563 you be running a version of ClamAV prior to 0.95.
29564 If the option is unset, the default is &_/tmp/clamd_&. Thanks to David Saez for
29565 contributing the code for this scanner.
29566
29567 .vitem &%cmdline%&
29568 .cindex "virus scanners" "command line interface"
29569 This is the keyword for the generic command line scanner interface. It can be
29570 used to attach virus scanners that are invoked from the shell. This scanner
29571 type takes 3 mandatory options:
29572
29573 .olist
29574 The full path and name of the scanner binary, with all command line options,
29575 and a placeholder (&`%s`&) for the directory to scan.
29576
29577 .next
29578 A regular expression to match against the STDOUT and STDERR output of the
29579 virus scanner. If the expression matches, a virus was found. You must make
29580 absolutely sure that this expression matches on &"virus found"&. This is called
29581 the &"trigger"& expression.
29582
29583 .next
29584 Another regular expression, containing exactly one pair of parentheses, to
29585 match the name of the virus found in the scanners output. This is called the
29586 &"name"& expression.
29587 .endlist olist
29588
29589 For example, Sophos Sweep reports a virus on a line like this:
29590 .code
29591 Virus 'W32/Magistr-B' found in file ./those.bat
29592 .endd
29593 For the trigger expression, we can match the phrase &"found in file"&. For the
29594 name expression, we want to extract the W32/Magistr-B string, so we can match
29595 for the single quotes left and right of it. Altogether, this makes the
29596 configuration setting:
29597 .code
29598 av_scanner = cmdline:\
29599              /path/to/sweep -ss -all -rec -archive %s:\
29600              found in file:'(.+)'
29601 .endd
29602 .vitem &%drweb%&
29603 .cindex "virus scanners" "DrWeb"
29604 The DrWeb daemon scanner (&url(http://www.sald.com/)) interface takes one
29605 argument, either a full path to a UNIX socket, or an IP address and port
29606 separated by white space, as in these examples:
29607 .code
29608 av_scanner = drweb:/var/run/drwebd.sock
29609 av_scanner = drweb:192.168.2.20 31337
29610 .endd
29611 If you omit the argument, the default path &_/usr/local/drweb/run/drwebd.sock_&
29612 is used. Thanks to Alex Miller for contributing the code for this scanner.
29613
29614 .vitem &%fsecure%&
29615 .cindex "virus scanners" "F-Secure"
29616 The F-Secure daemon scanner (&url(http://www.f-secure.com)) takes one
29617 argument which is the path to a UNIX socket. For example:
29618 .code
29619 av_scanner = fsecure:/path/to/.fsav
29620 .endd
29621 If no argument is given, the default is &_/var/run/.fsav_&. Thanks to Johan
29622 Thelmen for contributing the code for this scanner.
29623
29624 .vitem &%kavdaemon%&
29625 .cindex "virus scanners" "Kaspersky"
29626 This is the scanner daemon of Kaspersky Version 4. This version of the
29627 Kaspersky scanner is outdated. Please upgrade (see &%aveserver%& above). This
29628 scanner type takes one option, which is the path to the daemon's UNIX socket.
29629 For example:
29630 .code
29631 av_scanner = kavdaemon:/opt/AVP/AvpCtl
29632 .endd
29633 The default path is &_/var/run/AvpCtl_&.
29634
29635 .vitem &%mksd%&
29636 .cindex "virus scanners" "mksd"
29637 This is a daemon type scanner that is aimed mainly at Polish users, though some
29638 parts of documentation are now available in English. You can get it at
29639 &url(http://linux.mks.com.pl/). The only option for this scanner type is
29640 the maximum number of processes used simultaneously to scan the attachments,
29641 provided that the demime facility is employed and also provided that mksd has
29642 been run with at least the same number of child processes. For example:
29643 .code
29644 av_scanner = mksd:2
29645 .endd
29646 You can safely omit this option (the default value is 1).
29647
29648 .vitem &%sophie%&
29649 .cindex "virus scanners" "Sophos and Sophie"
29650 Sophie is a daemon that uses Sophos' &%libsavi%& library to scan for viruses.
29651 You can get Sophie at &url(http://www.clanfield.info/sophie/). The only option
29652 for this scanner type is the path to the UNIX socket that Sophie uses for
29653 client communication. For example:
29654 .code
29655 av_scanner = sophie:/tmp/sophie
29656 .endd
29657 The default path is &_/var/run/sophie_&, so if you are using this, you can omit
29658 the option.
29659 .endlist
29660
29661 When &%av_scanner%& is correctly set, you can use the &%malware%& condition in
29662 the DATA ACL. &*Note*&: You cannot use the &%malware%& condition in the MIME
29663 ACL.
29664
29665 The &%av_scanner%& option is expanded each time &%malware%& is called. This
29666 makes it possible to use different scanners. See further below for an example.
29667 The &%malware%& condition caches its results, so when you use it multiple times
29668 for the same message, the actual scanning process is only carried out once.
29669 However, using expandable items in &%av_scanner%& disables this caching, in
29670 which case each use of the &%malware%& condition causes a new scan of the
29671 message.
29672
29673 The &%malware%& condition takes a right-hand argument that is expanded before
29674 use. It can then be one of
29675
29676 .ilist
29677 &"true"&, &"*"&, or &"1"&, in which case the message is scanned for viruses.
29678 The condition succeeds if a virus was found, and fail otherwise. This is the
29679 recommended usage.
29680 .next
29681 &"false"& or &"0"& or an empty string, in which case no scanning is done and
29682 the condition fails immediately.
29683 .next
29684 A regular expression, in which case the message is scanned for viruses. The
29685 condition succeeds if a virus is found and its name matches the regular
29686 expression. This allows you to take special actions on certain types of virus.
29687 .endlist
29688
29689 You can append &`/defer_ok`& to the &%malware%& condition to accept messages
29690 even if there is a problem with the virus scanner. Otherwise, such a problem
29691 causes the ACL to defer.
29692
29693 .vindex "&$malware_name$&"
29694 When a virus is found, the condition sets up an expansion variable called
29695 &$malware_name$& that contains the name of the virus. You can use it in a
29696 &%message%& modifier that specifies the error returned to the sender, and/or in
29697 logging data.
29698
29699 If your virus scanner cannot unpack MIME and TNEF containers itself, you should
29700 use the &%demime%& condition (see section &<<SECTdemimecond>>&) before the
29701 &%malware%& condition.
29702
29703 Beware the interaction of Exim's &%message_size_limit%& with any size limits
29704 imposed by your anti-virus scanner.
29705
29706 Here is a very simple scanning example:
29707 .code
29708 deny message = This message contains malware ($malware_name)
29709      demime = *
29710      malware = *
29711 .endd
29712 The next example accepts messages when there is a problem with the scanner:
29713 .code
29714 deny message = This message contains malware ($malware_name)
29715      demime = *
29716      malware = */defer_ok
29717 .endd
29718 The next example shows how to use an ACL variable to scan with both sophie and
29719 aveserver. It assumes you have set:
29720 .code
29721 av_scanner = $acl_m0
29722 .endd
29723 in the main Exim configuration.
29724 .code
29725 deny message = This message contains malware ($malware_name)
29726      set acl_m0 = sophie
29727      malware = *
29728
29729 deny message = This message contains malware ($malware_name)
29730      set acl_m0 = aveserver
29731      malware = *
29732 .endd
29733
29734
29735 .section "Scanning with SpamAssassin" "SECTscanspamass"
29736 .cindex "content scanning" "for spam"
29737 .cindex "spam scanning"
29738 .cindex "SpamAssassin"
29739 The &%spam%& ACL condition calls SpamAssassin's &%spamd%& daemon to get a spam
29740 score and a report for the message. You can get SpamAssassin at
29741 &url(http://www.spamassassin.org), or, if you have a working Perl
29742 installation, you can use CPAN by running:
29743 .code
29744 perl -MCPAN -e 'install Mail::SpamAssassin'
29745 .endd
29746 SpamAssassin has its own set of configuration files. Please review its
29747 documentation to see how you can tweak it. The default installation should work
29748 nicely, however.
29749
29750 .oindex "&%spamd_address%&"
29751 After having installed and configured SpamAssassin, start the &%spamd%& daemon.
29752 By default, it listens on 127.0.0.1, TCP port 783. If you use another host or
29753 port for &%spamd%&, you must set the &%spamd_address%& option in the global
29754 part of the Exim configuration as follows (example):
29755 .code
29756 spamd_address = 192.168.99.45 387
29757 .endd
29758 You do not need to set this option if you use the default. As of version 2.60,
29759 &%spamd%& also supports communication over UNIX sockets. If you want to use
29760 these, supply &%spamd_address%& with an absolute file name instead of a
29761 address/port pair:
29762 .code
29763 spamd_address = /var/run/spamd_socket
29764 .endd
29765 You can have multiple &%spamd%& servers to improve scalability. These can
29766 reside on other hardware reachable over the network. To specify multiple
29767 &%spamd%& servers, put multiple address/port pairs in the &%spamd_address%&
29768 option, separated with colons:
29769 .code
29770 spamd_address = 192.168.2.10 783 : \
29771                 192.168.2.11 783 : \
29772                 192.168.2.12 783
29773 .endd
29774 Up to 32 &%spamd%& servers are supported. The servers are queried in a random
29775 fashion. When a server fails to respond to the connection attempt, all other
29776 servers are tried until one succeeds. If no server responds, the &%spam%&
29777 condition defers.
29778
29779 &*Warning*&: It is not possible to use the UNIX socket connection method with
29780 multiple &%spamd%& servers.
29781
29782 The &%spamd_address%& variable is expanded before use if it starts with
29783 a dollar sign. In this case, the expansion may return a string that is
29784 used as the list so that multiple spamd servers can be the result of an
29785 expansion.
29786
29787 .section "Calling SpamAssassin from an Exim ACL" "SECID206"
29788 Here is a simple example of the use of the &%spam%& condition in a DATA ACL:
29789 .code
29790 deny message = This message was classified as SPAM
29791      spam = joe
29792 .endd
29793 The right-hand side of the &%spam%& condition specifies a name. This is
29794 relevant if you have set up multiple SpamAssassin profiles. If you do not want
29795 to scan using a specific profile, but rather use the SpamAssassin system-wide
29796 default profile, you can scan for an unknown name, or simply use &"nobody"&.
29797 However, you must put something on the right-hand side.
29798
29799 The name allows you to use per-domain or per-user antispam profiles in
29800 principle, but this is not straightforward in practice, because a message may
29801 have multiple recipients, not necessarily all in the same domain. Because the
29802 &%spam%& condition has to be called from a DATA ACL in order to be able to
29803 read the contents of the message, the variables &$local_part$& and &$domain$&
29804 are not set.
29805
29806 The right-hand side of the &%spam%& condition is expanded before being used, so
29807 you can put lookups or conditions there. When the right-hand side evaluates to
29808 &"0"& or &"false"&, no scanning is done and the condition fails immediately.
29809
29810
29811 Scanning with SpamAssassin uses a lot of resources. If you scan every message,
29812 large ones may cause significant performance degradation. As most spam messages
29813 are quite small, it is recommended that you do not scan the big ones. For
29814 example:
29815 .code
29816 deny message = This message was classified as SPAM
29817      condition = ${if < {$message_size}{10K}}
29818      spam = nobody
29819 .endd
29820
29821 The &%spam%& condition returns true if the threshold specified in the user's
29822 SpamAssassin profile has been matched or exceeded. If you want to use the
29823 &%spam%& condition for its side effects (see the variables below), you can make
29824 it always return &"true"& by appending &`:true`& to the username.
29825
29826 .cindex "spam scanning" "returned variables"
29827 When the &%spam%& condition is run, it sets up a number of expansion
29828 variables. These variables are saved with the received message, thus they are
29829 available for use at delivery time.
29830
29831 .vlist
29832 .vitem &$spam_score$&
29833 The spam score of the message, for example &"3.4"& or &"30.5"&. This is useful
29834 for inclusion in log or reject messages.
29835
29836 .vitem &$spam_score_int$&
29837 The spam score of the message, multiplied by ten, as an integer value. For
29838 example &"34"& or &"305"&. It may appear to disagree with &$spam_score$&
29839 because &$spam_score$& is rounded and &$spam_score_int$& is truncated.
29840 The integer value is useful for numeric comparisons in conditions.
29841
29842 .vitem &$spam_bar$&
29843 A string consisting of a number of &"+"& or &"-"& characters, representing the
29844 integer part of the spam score value. A spam score of 4.4 would have a
29845 &$spam_bar$& value of &"++++"&. This is useful for inclusion in warning
29846 headers, since MUAs can match on such strings.
29847
29848 .vitem &$spam_report$&
29849 A multiline text table, containing the full SpamAssassin report for the
29850 message. Useful for inclusion in headers or reject messages.
29851 .endlist
29852
29853 The &%spam%& condition caches its results unless expansion in
29854 spamd_address was used. If you call it again with the same user name, it
29855 does not scan again, but rather returns the same values as before.
29856
29857 The &%spam%& condition returns DEFER if there is any error while running
29858 the message through SpamAssassin or if the expansion of spamd_address
29859 failed. If you want to treat DEFER as FAIL (to pass on to the next ACL
29860 statement block), append &`/defer_ok`& to the right-hand side of the
29861 spam condition, like this:
29862 .code
29863 deny message = This message was classified as SPAM
29864      spam    = joe/defer_ok
29865 .endd
29866 This causes messages to be accepted even if there is a problem with &%spamd%&.
29867
29868 Here is a longer, commented example of the use of the &%spam%&
29869 condition:
29870 .code
29871 # put headers in all messages (no matter if spam or not)
29872 warn  spam = nobody:true
29873       add_header = X-Spam-Score: $spam_score ($spam_bar)
29874       add_header = X-Spam-Report: $spam_report
29875
29876 # add second subject line with *SPAM* marker when message
29877 # is over threshold
29878 warn  spam = nobody
29879       add_header = Subject: *SPAM* $h_Subject:
29880
29881 # reject spam at high scores (> 12)
29882 deny  message = This message scored $spam_score spam points.
29883       spam = nobody:true
29884       condition = ${if >{$spam_score_int}{120}{1}{0}}
29885 .endd
29886
29887
29888
29889 .section "Scanning MIME parts" "SECTscanmimepart"
29890 .cindex "content scanning" "MIME parts"
29891 .cindex "MIME content scanning"
29892 .oindex "&%acl_smtp_mime%&"
29893 .oindex "&%acl_not_smtp_mime%&"
29894 The &%acl_smtp_mime%& global option specifies an ACL that is called once for
29895 each MIME part of an SMTP message, including multipart types, in the sequence
29896 of their position in the message. Similarly, the &%acl_not_smtp_mime%& option
29897 specifies an ACL that is used for the MIME parts of non-SMTP messages. These
29898 options may both refer to the same ACL if you want the same processing in both
29899 cases.
29900
29901 These ACLs are called (possibly many times) just before the &%acl_smtp_data%&
29902 ACL in the case of an SMTP message, or just before the &%acl_not_smtp%& ACL in
29903 the case of a non-SMTP message. However, a MIME ACL is called only if the
29904 message contains a &'Content-Type:'& header line. When a call to a MIME
29905 ACL does not yield &"accept"&, ACL processing is aborted and the appropriate
29906 result code is sent to the client. In the case of an SMTP message, the
29907 &%acl_smtp_data%& ACL is not called when this happens.
29908
29909 You cannot use the &%malware%& or &%spam%& conditions in a MIME ACL; these can
29910 only be used in the DATA or non-SMTP ACLs. However, you can use the &%regex%&
29911 condition to match against the raw MIME part. You can also use the
29912 &%mime_regex%& condition to match against the decoded MIME part (see section
29913 &<<SECTscanregex>>&).
29914
29915 At the start of a MIME ACL, a number of variables are set from the header
29916 information for the relevant MIME part. These are described below. The contents
29917 of the MIME part are not by default decoded into a disk file except for MIME
29918 parts whose content-type is &"message/rfc822"&. If you want to decode a MIME
29919 part into a disk file, you can use the &%decode%& condition. The general
29920 syntax is:
29921 .display
29922 &`decode = [/`&<&'path'&>&`/]`&<&'filename'&>
29923 .endd
29924 The right hand side is expanded before use. After expansion,
29925 the value can be:
29926
29927 .olist
29928 &"0"& or &"false"&, in which case no decoding is done.
29929 .next
29930 The string &"default"&. In that case, the file is put in the temporary
29931 &"default"& directory <&'spool_directory'&>&_/scan/_&<&'message_id'&>&_/_& with
29932 a sequential file name consisting of the message id and a sequence number. The
29933 full path and name is available in &$mime_decoded_filename$& after decoding.
29934 .next
29935 A full path name starting with a slash. If the full name is an existing
29936 directory, it is used as a replacement for the default directory. The filename
29937 is then sequentially assigned. If the path does not exist, it is used as
29938 the full path and file name.
29939 .next
29940 If the string does not start with a slash, it is used as the
29941 filename, and the default path is then used.
29942 .endlist
29943 The &%decode%& condition normally succeeds. It is only false for syntax
29944 errors or unusual circumstances such as memory shortages. You can easily decode
29945 a file with its original, proposed filename using
29946 .code
29947 decode = $mime_filename
29948 .endd
29949 However, you should keep in mind that &$mime_filename$& might contain
29950 anything. If you place files outside of the default path, they are not
29951 automatically unlinked.
29952
29953 For RFC822 attachments (these are messages attached to messages, with a
29954 content-type of &"message/rfc822"&), the ACL is called again in the same manner
29955 as for the primary message, only that the &$mime_is_rfc822$& expansion
29956 variable is set (see below). Attached messages are always decoded to disk
29957 before being checked, and the files are unlinked once the check is done.
29958
29959 The MIME ACL supports the &%regex%& and &%mime_regex%& conditions. These can be
29960 used to match regular expressions against raw and decoded MIME parts,
29961 respectively. They are described in section &<<SECTscanregex>>&.
29962
29963 .cindex "MIME content scanning" "returned variables"
29964 The following list describes all expansion variables that are
29965 available in the MIME ACL:
29966
29967 .vlist
29968 .vitem &$mime_boundary$&
29969 If the current part is a multipart (see &$mime_is_multipart$&) below, it should
29970 have a boundary string, which is stored in this variable. If the current part
29971 has no boundary parameter in the &'Content-Type:'& header, this variable
29972 contains the empty string.
29973
29974 .vitem &$mime_charset$&
29975 This variable contains the character set identifier, if one was found in the
29976 &'Content-Type:'& header. Examples for charset identifiers are:
29977 .code
29978 us-ascii
29979 gb2312 (Chinese)
29980 iso-8859-1
29981 .endd
29982 Please note that this value is not normalized, so you should do matches
29983 case-insensitively.
29984
29985 .vitem &$mime_content_description$&
29986 This variable contains the normalized content of the &'Content-Description:'&
29987 header. It can contain a human-readable description of the parts content. Some
29988 implementations repeat the filename for attachments here, but they are usually
29989 only used for display purposes.
29990
29991 .vitem &$mime_content_disposition$&
29992 This variable contains the normalized content of the &'Content-Disposition:'&
29993 header. You can expect strings like &"attachment"& or &"inline"& here.
29994
29995 .vitem &$mime_content_id$&
29996 This variable contains the normalized content of the &'Content-ID:'& header.
29997 This is a unique ID that can be used to reference a part from another part.
29998
29999 .vitem &$mime_content_size$&
30000 This variable is set only after the &%decode%& modifier (see above) has been
30001 successfully run. It contains the size of the decoded part in kilobytes. The
30002 size is always rounded up to full kilobytes, so only a completely empty part
30003 has a &$mime_content_size$& of zero.
30004
30005 .vitem &$mime_content_transfer_encoding$&
30006 This variable contains the normalized content of the
30007 &'Content-transfer-encoding:'& header. This is a symbolic name for an encoding
30008 type. Typical values are &"base64"& and &"quoted-printable"&.
30009
30010 .vitem &$mime_content_type$&
30011 If the MIME part has a &'Content-Type:'& header, this variable contains its
30012 value, lowercased, and without any options (like &"name"& or &"charset"&). Here
30013 are some examples of popular MIME types, as they may appear in this variable:
30014 .code
30015 text/plain
30016 text/html
30017 application/octet-stream
30018 image/jpeg
30019 audio/midi
30020 .endd
30021 If the MIME part has no &'Content-Type:'& header, this variable contains the
30022 empty string.
30023
30024 .vitem &$mime_decoded_filename$&
30025 This variable is set only after the &%decode%& modifier (see above) has been
30026 successfully run. It contains the full path and file name of the file
30027 containing the decoded data.
30028 .endlist
30029
30030 .cindex "RFC 2047"
30031 .vlist
30032 .vitem &$mime_filename$&
30033 This is perhaps the most important of the MIME variables. It contains a
30034 proposed filename for an attachment, if one was found in either the
30035 &'Content-Type:'& or &'Content-Disposition:'& headers. The filename will be
30036 RFC2047 decoded, but no additional sanity checks are done. If no filename was
30037 found, this variable contains the empty string.
30038
30039 .vitem &$mime_is_coverletter$&
30040 This variable attempts to differentiate the &"cover letter"& of an e-mail from
30041 attached data. It can be used to clamp down on flashy or unnecessarily encoded
30042 content in the cover letter, while not restricting attachments at all.
30043
30044 The variable contains 1 (true) for a MIME part believed to be part of the
30045 cover letter, and 0 (false) for an attachment. At present, the algorithm is as
30046 follows:
30047
30048 .olist
30049 The outermost MIME part of a message is always a cover letter.
30050
30051 .next
30052 If a multipart/alternative or multipart/related MIME part is a cover letter,
30053 so are all MIME subparts within that multipart.
30054
30055 .next
30056 If any other multipart is a cover letter, the first subpart is a cover letter,
30057 and the rest are attachments.
30058
30059 .next
30060 All parts contained within an attachment multipart are attachments.
30061 .endlist olist
30062
30063 As an example, the following will ban &"HTML mail"& (including that sent with
30064 alternative plain text), while allowing HTML files to be attached. HTML
30065 coverletter mail attached to non-HMTL coverletter mail will also be allowed:
30066 .code
30067 deny message = HTML mail is not accepted here
30068 !condition = $mime_is_rfc822
30069 condition = $mime_is_coverletter
30070 condition = ${if eq{$mime_content_type}{text/html}{1}{0}}
30071 .endd
30072 .vitem &$mime_is_multipart$&
30073 This variable has the value 1 (true) when the current part has the main type
30074 &"multipart"&, for example &"multipart/alternative"& or &"multipart/mixed"&.
30075 Since multipart entities only serve as containers for other parts, you may not
30076 want to carry out specific actions on them.
30077
30078 .vitem &$mime_is_rfc822$&
30079 This variable has the value 1 (true) if the current part is not a part of the
30080 checked message itself, but part of an attached message. Attached message
30081 decoding is fully recursive.
30082
30083 .vitem &$mime_part_count$&
30084 This variable is a counter that is raised for each processed MIME part. It
30085 starts at zero for the very first part (which is usually a multipart). The
30086 counter is per-message, so it is reset when processing RFC822 attachments (see
30087 &$mime_is_rfc822$&). The counter stays set after &%acl_smtp_mime%& is
30088 complete, so you can use it in the DATA ACL to determine the number of MIME
30089 parts of a message. For non-MIME messages, this variable contains the value -1.
30090 .endlist
30091
30092
30093
30094 .section "Scanning with regular expressions" "SECTscanregex"
30095 .cindex "content scanning" "with regular expressions"
30096 .cindex "regular expressions" "content scanning with"
30097 You can specify your own custom regular expression matches on the full body of
30098 the message, or on individual MIME parts.
30099
30100 The &%regex%& condition takes one or more regular expressions as arguments and
30101 matches them against the full message (when called in the DATA ACL) or a raw
30102 MIME part (when called in the MIME ACL). The &%regex%& condition matches
30103 linewise, with a maximum line length of 32K characters. That means you cannot
30104 have multiline matches with the &%regex%& condition.
30105
30106 The &%mime_regex%& condition can be called only in the MIME ACL. It matches up
30107 to 32K of decoded content (the whole content at once, not linewise). If the
30108 part has not been decoded with the &%decode%& modifier earlier in the ACL, it
30109 is decoded automatically when &%mime_regex%& is executed (using default path
30110 and filename values). If the decoded data is larger than  32K, only the first
30111 32K characters are checked.
30112
30113 The regular expressions are passed as a colon-separated list. To include a
30114 literal colon, you must double it. Since the whole right-hand side string is
30115 expanded before being used, you must also escape dollar signs and backslashes
30116 with more backslashes, or use the &`\N`& facility to disable expansion.
30117 Here is a simple example that contains two regular expressions:
30118 .code
30119 deny message = contains blacklisted regex ($regex_match_string)
30120      regex = [Mm]ortgage : URGENT BUSINESS PROPOSAL
30121 .endd
30122 The conditions returns true if any one of the regular expressions matches. The
30123 &$regex_match_string$& expansion variable is then set up and contains the
30124 matching regular expression.
30125
30126 &*Warning*&: With large messages, these conditions can be fairly
30127 CPU-intensive.
30128
30129
30130
30131
30132 .section "The demime condition" "SECTdemimecond"
30133 .cindex "content scanning" "MIME checking"
30134 .cindex "MIME content scanning"
30135 The &%demime%& ACL condition provides MIME unpacking, sanity checking and file
30136 extension blocking. It is usable only in the DATA and non-SMTP ACLs. The
30137 &%demime%& condition uses a simpler interface to MIME decoding than the MIME
30138 ACL functionality, but provides no additional facilities. Please note that this
30139 condition is deprecated and kept only for backward compatibility. You must set
30140 the WITH_OLD_DEMIME option in &_Local/Makefile_& at build time to be able to
30141 use the &%demime%& condition.
30142
30143 The &%demime%& condition unpacks MIME containers in the message. It detects
30144 errors in MIME containers and can match file extensions found in the message
30145 against a list. Using this facility produces files containing the unpacked MIME
30146 parts of the message in the temporary scan directory. If you do antivirus
30147 scanning, it is recommended that you use the &%demime%& condition before the
30148 antivirus (&%malware%&) condition.
30149
30150 On the right-hand side of the &%demime%& condition you can pass a
30151 colon-separated list of file extensions that it should match against. For
30152 example:
30153 .code
30154 deny message = Found blacklisted file attachment
30155      demime  = vbs:com:bat:pif:prf:lnk
30156 .endd
30157 If one of the file extensions is found, the condition is true, otherwise it is
30158 false. If there is a temporary error while demimeing (for example, &"disk
30159 full"&), the condition defers, and the message is temporarily rejected (unless
30160 the condition is on a &%warn%& verb).
30161
30162 The right-hand side is expanded before being treated as a list, so you can have
30163 conditions and lookups there. If it expands to an empty string, &"false"&, or
30164 zero (&"0"&), no demimeing is done and the condition is false.
30165
30166 The &%demime%& condition set the following variables:
30167
30168 .vlist
30169 .vitem &$demime_errorlevel$&
30170 .vindex "&$demime_errorlevel$&"
30171 When an error is detected in a MIME container, this variable contains the
30172 severity of the error, as an integer number. The higher the value, the more
30173 severe the error (the current maximum value is 3). If this variable is unset or
30174 zero, no error occurred.
30175
30176 .vitem &$demime_reason$&
30177 .vindex "&$demime_reason$&"
30178 When &$demime_errorlevel$& is greater than zero, this variable contains a
30179 human-readable text string describing the MIME error that occurred.
30180 .endlist
30181
30182 .vlist
30183 .vitem &$found_extension$&
30184 .vindex "&$found_extension$&"
30185 When the &%demime%& condition is true, this variable contains the file
30186 extension it found.
30187 .endlist
30188
30189 Both &$demime_errorlevel$& and &$demime_reason$& are set by the first call of
30190 the &%demime%& condition, and are not changed on subsequent calls.
30191
30192 If you do not want to check for file extensions, but rather use the &%demime%&
30193 condition for unpacking or error checking purposes, pass &"*"& as the
30194 right-hand side value. Here is a more elaborate example of how to use this
30195 facility:
30196 .code
30197 # Reject messages with serious MIME container errors
30198 deny  message = Found MIME error ($demime_reason).
30199       demime = *
30200       condition = ${if >{$demime_errorlevel}{2}{1}{0}}
30201
30202 # Reject known virus spreading file extensions.
30203 # Accepting these is pretty much braindead.
30204 deny  message = contains $found_extension file (blacklisted).
30205       demime  = com:vbs:bat:pif:scr
30206
30207 # Freeze .exe and .doc files. Postmaster can
30208 # examine them and eventually thaw them.
30209 deny  log_message = Another $found_extension file.
30210       demime = exe:doc
30211       control = freeze
30212 .endd
30213 .ecindex IIDcosca
30214
30215
30216
30217
30218 . ////////////////////////////////////////////////////////////////////////////
30219 . ////////////////////////////////////////////////////////////////////////////
30220
30221 .chapter "Adding a local scan function to Exim" "CHAPlocalscan" &&&
30222          "Local scan function"
30223 .scindex IIDlosca "&[local_scan()]& function" "description of"
30224 .cindex "customizing" "input scan using C function"
30225 .cindex "policy control" "by local scan function"
30226 In these days of email worms, viruses, and ever-increasing spam, some sites
30227 want to apply a lot of checking to messages before accepting them.
30228
30229 The content scanning extension (chapter &<<CHAPexiscan>>&) has facilities for
30230 passing messages to external virus and spam scanning software. You can also do
30231 a certain amount in Exim itself through string expansions and the &%condition%&
30232 condition in the ACL that runs after the SMTP DATA command or the ACL for
30233 non-SMTP messages (see chapter &<<CHAPACL>>&), but this has its limitations.
30234
30235 To allow for further customization to a site's own requirements, there is the
30236 possibility of linking Exim with a private message scanning function, written
30237 in C. If you want to run code that is written in something other than C, you
30238 can of course use a little C stub to call it.
30239
30240 The local scan function is run once for every incoming message, at the point
30241 when Exim is just about to accept the message.
30242 It can therefore be used to control non-SMTP messages from local processes as
30243 well as messages arriving via SMTP.
30244
30245 Exim applies a timeout to calls of the local scan function, and there is an
30246 option called &%local_scan_timeout%& for setting it. The default is 5 minutes.
30247 Zero means &"no timeout"&.
30248 Exim also sets up signal handlers for SIGSEGV, SIGILL, SIGFPE, and SIGBUS
30249 before calling the local scan function, so that the most common types of crash
30250 are caught. If the timeout is exceeded or one of those signals is caught, the
30251 incoming message is rejected with a temporary error if it is an SMTP message.
30252 For a non-SMTP message, the message is dropped and Exim ends with a non-zero
30253 code. The incident is logged on the main and reject logs.
30254
30255
30256
30257 .section "Building Exim to use a local scan function" "SECID207"
30258 .cindex "&[local_scan()]& function" "building Exim to use"
30259 To make use of the local scan function feature, you must tell Exim where your
30260 function is before building Exim, by setting LOCAL_SCAN_SOURCE in your
30261 &_Local/Makefile_&. A recommended place to put it is in the &_Local_&
30262 directory, so you might set
30263 .code
30264 LOCAL_SCAN_SOURCE=Local/local_scan.c
30265 .endd
30266 for example. The function must be called &[local_scan()]&. It is called by
30267 Exim after it has received a message, when the success return code is about to
30268 be sent. This is after all the ACLs have been run. The return code from your
30269 function controls whether the message is actually accepted or not. There is a
30270 commented template function (that just accepts the message) in the file
30271 _src/local_scan.c_.
30272
30273 If you want to make use of Exim's run time configuration file to set options
30274 for your &[local_scan()]& function, you must also set
30275 .code
30276 LOCAL_SCAN_HAS_OPTIONS=yes
30277 .endd
30278 in &_Local/Makefile_& (see section &<<SECTconoptloc>>& below).
30279
30280
30281
30282
30283 .section "API for local_scan()" "SECTapiforloc"
30284 .cindex "&[local_scan()]& function" "API description"
30285 You must include this line near the start of your code:
30286 .code
30287 #include "local_scan.h"
30288 .endd
30289 This header file defines a number of variables and other values, and the
30290 prototype for the function itself. Exim is coded to use unsigned char values
30291 almost exclusively, and one of the things this header defines is a shorthand
30292 for &`unsigned char`& called &`uschar`&.
30293 It also contains the following macro definitions, to simplify casting character
30294 strings and pointers to character strings:
30295 .code
30296 #define CS   (char *)
30297 #define CCS  (const char *)
30298 #define CSS  (char **)
30299 #define US   (unsigned char *)
30300 #define CUS  (const unsigned char *)
30301 #define USS  (unsigned char **)
30302 .endd
30303 The function prototype for &[local_scan()]& is:
30304 .code
30305 extern int local_scan(int fd, uschar **return_text);
30306 .endd
30307 The arguments are as follows:
30308
30309 .ilist
30310 &%fd%& is a file descriptor for the file that contains the body of the message
30311 (the -D file). The file is open for reading and writing, but updating it is not
30312 recommended. &*Warning*&: You must &'not'& close this file descriptor.
30313
30314 The descriptor is positioned at character 19 of the file, which is the first
30315 character of the body itself, because the first 19 characters are the message
30316 id followed by &`-D`& and a newline. If you rewind the file, you should use the
30317 macro SPOOL_DATA_START_OFFSET to reset to the start of the data, just in
30318 case this changes in some future version.
30319 .next
30320 &%return_text%& is an address which you can use to return a pointer to a text
30321 string at the end of the function. The value it points to on entry is NULL.
30322 .endlist
30323
30324 The function must return an &%int%& value which is one of the following macros:
30325
30326 .vlist
30327 .vitem &`LOCAL_SCAN_ACCEPT`&
30328 .vindex "&$local_scan_data$&"
30329 The message is accepted. If you pass back a string of text, it is saved with
30330 the message, and made available in the variable &$local_scan_data$&. No
30331 newlines are permitted (if there are any, they are turned into spaces) and the
30332 maximum length of text is 1000 characters.
30333
30334 .vitem &`LOCAL_SCAN_ACCEPT_FREEZE`&
30335 This behaves as LOCAL_SCAN_ACCEPT, except that the accepted message is
30336 queued without immediate delivery, and is frozen.
30337
30338 .vitem &`LOCAL_SCAN_ACCEPT_QUEUE`&
30339 This behaves as LOCAL_SCAN_ACCEPT, except that the accepted message is
30340 queued without immediate delivery.
30341
30342 .vitem &`LOCAL_SCAN_REJECT`&
30343 The message is rejected; the returned text is used as an error message which is
30344 passed back to the sender and which is also logged. Newlines are permitted &--
30345 they cause a multiline response for SMTP rejections, but are converted to
30346 &`\n`& in log lines. If no message is given, &"Administrative prohibition"& is
30347 used.
30348
30349 .vitem &`LOCAL_SCAN_TEMPREJECT`&
30350 The message is temporarily rejected; the returned text is used as an error
30351 message as for LOCAL_SCAN_REJECT. If no message is given, &"Temporary local
30352 problem"& is used.
30353
30354 .vitem &`LOCAL_SCAN_REJECT_NOLOGHDR`&
30355 This behaves as LOCAL_SCAN_REJECT, except that the header of the rejected
30356 message is not written to the reject log. It has the effect of unsetting the
30357 &%rejected_header%& log selector for just this rejection. If
30358 &%rejected_header%& is already unset (see the discussion of the
30359 &%log_selection%& option in section &<<SECTlogselector>>&), this code is the
30360 same as LOCAL_SCAN_REJECT.
30361
30362 .vitem &`LOCAL_SCAN_TEMPREJECT_NOLOGHDR`&
30363 This code is a variation of LOCAL_SCAN_TEMPREJECT in the same way that
30364 LOCAL_SCAN_REJECT_NOLOGHDR is a variation of LOCAL_SCAN_REJECT.
30365 .endlist
30366
30367 If the message is not being received by interactive SMTP, rejections are
30368 reported by writing to &%stderr%& or by sending an email, as configured by the
30369 &%-oe%& command line options.
30370
30371
30372
30373 .section "Configuration options for local_scan()" "SECTconoptloc"
30374 .cindex "&[local_scan()]& function" "configuration options"
30375 It is possible to have option settings in the main configuration file
30376 that set values in static variables in the &[local_scan()]& module. If you
30377 want to do this, you must have the line
30378 .code
30379 LOCAL_SCAN_HAS_OPTIONS=yes
30380 .endd
30381 in your &_Local/Makefile_& when you build Exim. (This line is in
30382 &_OS/Makefile-Default_&, commented out). Then, in the &[local_scan()]& source
30383 file, you must define static variables to hold the option values, and a table
30384 to define them.
30385
30386 The table must be a vector called &%local_scan_options%&, of type
30387 &`optionlist`&. Each entry is a triplet, consisting of a name, an option type,
30388 and a pointer to the variable that holds the value. The entries must appear in
30389 alphabetical order. Following &%local_scan_options%& you must also define a
30390 variable called &%local_scan_options_count%& that contains the number of
30391 entries in the table. Here is a short example, showing two kinds of option:
30392 .code
30393 static int my_integer_option = 42;
30394 static uschar *my_string_option = US"a default string";
30395
30396 optionlist local_scan_options[] = {
30397   { "my_integer", opt_int,       &my_integer_option },
30398   { "my_string",  opt_stringptr, &my_string_option }
30399 };
30400
30401 int local_scan_options_count =
30402   sizeof(local_scan_options)/sizeof(optionlist);
30403 .endd
30404 The values of the variables can now be changed from Exim's runtime
30405 configuration file by including a local scan section as in this example:
30406 .code
30407 begin local_scan
30408 my_integer = 99
30409 my_string = some string of text...
30410 .endd
30411 The available types of option data are as follows:
30412
30413 .vlist
30414 .vitem &*opt_bool*&
30415 This specifies a boolean (true/false) option. The address should point to a
30416 variable of type &`BOOL`&, which will be set to TRUE or FALSE, which are macros
30417 that are defined as &"1"& and &"0"&, respectively. If you want to detect
30418 whether such a variable has been set at all, you can initialize it to
30419 TRUE_UNSET. (BOOL variables are integers underneath, so can hold more than two
30420 values.)
30421
30422 .vitem &*opt_fixed*&
30423 This specifies a fixed point number, such as is used for load averages.
30424 The address should point to a variable of type &`int`&. The value is stored
30425 multiplied by 1000, so, for example, 1.4142 is truncated and stored as 1414.
30426
30427 .vitem &*opt_int*&
30428 This specifies an integer; the address should point to a variable of type
30429 &`int`&. The value may be specified in any of the integer formats accepted by
30430 Exim.
30431
30432 .vitem &*opt_mkint*&
30433 This is the same as &%opt_int%&, except that when such a value is output in a
30434 &%-bP%& listing, if it is an exact number of kilobytes or megabytes, it is
30435 printed with the suffix K or M.
30436
30437 .vitem &*opt_octint*&
30438 This also specifies an integer, but the value is always interpreted as an
30439 octal integer, whether or not it starts with the digit zero, and it is
30440 always output in octal.
30441
30442 .vitem &*opt_stringptr*&
30443 This specifies a string value; the address must be a pointer to a
30444 variable that points to a string (for example, of type &`uschar *`&).
30445
30446 .vitem &*opt_time*&
30447 This specifies a time interval value. The address must point to a variable of
30448 type &`int`&. The value that is placed there is a number of seconds.
30449 .endlist
30450
30451 If the &%-bP%& command line option is followed by &`local_scan`&, Exim prints
30452 out the values of all the &[local_scan()]& options.
30453
30454
30455
30456 .section "Available Exim variables" "SECID208"
30457 .cindex "&[local_scan()]& function" "available Exim variables"
30458 The header &_local_scan.h_& gives you access to a number of C variables. These
30459 are the only ones that are guaranteed to be maintained from release to release.
30460 Note, however, that you can obtain the value of any Exim expansion variable,
30461 including &$recipients$&, by calling &'expand_string()'&. The exported
30462 C variables are as follows:
30463
30464 .vlist
30465 .vitem &*int&~body_linecount*&
30466 This variable contains the number of lines in the message's body.
30467
30468 .vitem &*int&~body_zerocount*&
30469 This variable contains the number of binary zero bytes in the message's body.
30470
30471 .vitem &*unsigned&~int&~debug_selector*&
30472 This variable is set to zero when no debugging is taking place. Otherwise, it
30473 is a bitmap of debugging selectors. Two bits are identified for use in
30474 &[local_scan()]&; they are defined as macros:
30475
30476 .ilist
30477 The &`D_v`& bit is set when &%-v%& was present on the command line. This is a
30478 testing option that is not privileged &-- any caller may set it. All the
30479 other selector bits can be set only by admin users.
30480
30481 .next
30482 The &`D_local_scan`& bit is provided for use by &[local_scan()]&; it is set
30483 by the &`+local_scan`& debug selector. It is not included in the default set
30484 of debugging bits.
30485 .endlist ilist
30486
30487 Thus, to write to the debugging output only when &`+local_scan`& has been
30488 selected, you should use code like this:
30489 .code
30490 if ((debug_selector & D_local_scan) != 0)
30491   debug_printf("xxx", ...);
30492 .endd
30493 .vitem &*uschar&~*expand_string_message*&
30494 After a failing call to &'expand_string()'& (returned value NULL), the
30495 variable &%expand_string_message%& contains the error message, zero-terminated.
30496
30497 .vitem &*header_line&~*header_list*&
30498 A pointer to a chain of header lines. The &%header_line%& structure is
30499 discussed below.
30500
30501 .vitem &*header_line&~*header_last*&
30502 A pointer to the last of the header lines.
30503
30504 .vitem &*uschar&~*headers_charset*&
30505 The value of the &%headers_charset%& configuration option.
30506
30507 .vitem &*BOOL&~host_checking*&
30508 This variable is TRUE during a host checking session that is initiated by the
30509 &%-bh%& command line option.
30510
30511 .vitem &*uschar&~*interface_address*&
30512 The IP address of the interface that received the message, as a string. This
30513 is NULL for locally submitted messages.
30514
30515 .vitem &*int&~interface_port*&
30516 The port on which this message was received. When testing with the &%-bh%&
30517 command line option, the value of this variable is -1 unless a port has been
30518 specified via the &%-oMi%& option.
30519
30520 .vitem &*uschar&~*message_id*&
30521 This variable contains Exim's message id for the incoming message (the value of
30522 &$message_exim_id$&) as a zero-terminated string.
30523
30524 .vitem &*uschar&~*received_protocol*&
30525 The name of the protocol by which the message was received.
30526
30527 .vitem &*int&~recipients_count*&
30528 The number of accepted recipients.
30529
30530 .vitem &*recipient_item&~*recipients_list*&
30531 .cindex "recipient" "adding in local scan"
30532 .cindex "recipient" "removing in local scan"
30533 The list of accepted recipients, held in a vector of length
30534 &%recipients_count%&. The &%recipient_item%& structure is discussed below. You
30535 can add additional recipients by calling &'receive_add_recipient()'& (see
30536 below). You can delete recipients by removing them from the vector and
30537 adjusting the value in &%recipients_count%&. In particular, by setting
30538 &%recipients_count%& to zero you remove all recipients. If you then return the
30539 value &`LOCAL_SCAN_ACCEPT`&, the message is accepted, but immediately
30540 blackholed. To replace the recipients, you can set &%recipients_count%& to zero
30541 and then call &'receive_add_recipient()'& as often as needed.
30542
30543 .vitem &*uschar&~*sender_address*&
30544 The envelope sender address. For bounce messages this is the empty string.
30545
30546 .vitem &*uschar&~*sender_host_address*&
30547 The IP address of the sending host, as a string. This is NULL for
30548 locally-submitted messages.
30549
30550 .vitem &*uschar&~*sender_host_authenticated*&
30551 The name of the authentication mechanism that was used, or NULL if the message
30552 was not received over an authenticated SMTP connection.
30553
30554 .vitem &*uschar&~*sender_host_name*&
30555 The name of the sending host, if known.
30556
30557 .vitem &*int&~sender_host_port*&
30558 The port on the sending host.
30559
30560 .vitem &*BOOL&~smtp_input*&
30561 This variable is TRUE for all SMTP input, including BSMTP.
30562
30563 .vitem &*BOOL&~smtp_batched_input*&
30564 This variable is TRUE for BSMTP input.
30565
30566 .vitem &*int&~store_pool*&
30567 The contents of this variable control which pool of memory is used for new
30568 requests. See section &<<SECTmemhanloc>>& for details.
30569 .endlist
30570
30571
30572 .section "Structure of header lines" "SECID209"
30573 The &%header_line%& structure contains the members listed below.
30574 You can add additional header lines by calling the &'header_add()'& function
30575 (see below). You can cause header lines to be ignored (deleted) by setting
30576 their type to *.
30577
30578
30579 .vlist
30580 .vitem &*struct&~header_line&~*next*&
30581 A pointer to the next header line, or NULL for the last line.
30582
30583 .vitem &*int&~type*&
30584 A code identifying certain headers that Exim recognizes. The codes are printing
30585 characters, and are documented in chapter &<<CHAPspool>>& of this manual.
30586 Notice in particular that any header line whose type is * is not transmitted
30587 with the message. This flagging is used for header lines that have been
30588 rewritten, or are to be removed (for example, &'Envelope-sender:'& header
30589 lines.) Effectively, * means &"deleted"&.
30590
30591 .vitem &*int&~slen*&
30592 The number of characters in the header line, including the terminating and any
30593 internal newlines.
30594
30595 .vitem &*uschar&~*text*&
30596 A pointer to the text of the header. It always ends with a newline, followed by
30597 a zero byte. Internal newlines are preserved.
30598 .endlist
30599
30600
30601
30602 .section "Structure of recipient items" "SECID210"
30603 The &%recipient_item%& structure contains these members:
30604
30605 .vlist
30606 .vitem &*uschar&~*address*&
30607 This is a pointer to the recipient address as it was received.
30608
30609 .vitem &*int&~pno*&
30610 This is used in later Exim processing when top level addresses are created by
30611 the &%one_time%& option. It is not relevant at the time &[local_scan()]& is run
30612 and must always contain -1 at this stage.
30613
30614 .vitem &*uschar&~*errors_to*&
30615 If this value is not NULL, bounce messages caused by failing to deliver to the
30616 recipient are sent to the address it contains. In other words, it overrides the
30617 envelope sender for this one recipient. (Compare the &%errors_to%& generic
30618 router option.) If a &[local_scan()]& function sets an &%errors_to%& field to
30619 an unqualified address, Exim qualifies it using the domain from
30620 &%qualify_recipient%&. When &[local_scan()]& is called, the &%errors_to%& field
30621 is NULL for all recipients.
30622 .endlist
30623
30624
30625
30626 .section "Available Exim functions" "SECID211"
30627 .cindex "&[local_scan()]& function" "available Exim functions"
30628 The header &_local_scan.h_& gives you access to a number of Exim functions.
30629 These are the only ones that are guaranteed to be maintained from release to
30630 release:
30631
30632 .vlist
30633 .vitem "&*pid_t&~child_open(uschar&~**argv,&~uschar&~**envp,&~int&~newumask,&&&
30634        &~int&~*infdptr,&~int&~*outfdptr, &~&~BOOL&~make_leader)*&"
30635
30636 This function creates a child process that runs the command specified by
30637 &%argv%&. The environment for the process is specified by &%envp%&, which can
30638 be NULL if no environment variables are to be passed. A new umask is supplied
30639 for the process in &%newumask%&.
30640
30641 Pipes to the standard input and output of the new process are set up
30642 and returned to the caller via the &%infdptr%& and &%outfdptr%& arguments. The
30643 standard error is cloned to the standard output. If there are any file
30644 descriptors &"in the way"& in the new process, they are closed. If the final
30645 argument is TRUE, the new process is made into a process group leader.
30646
30647 The function returns the pid of the new process, or -1 if things go wrong.
30648
30649 .vitem &*int&~child_close(pid_t&~pid,&~int&~timeout)*&
30650 This function waits for a child process to terminate, or for a timeout (in
30651 seconds) to expire. A timeout value of zero means wait as long as it takes. The
30652 return value is as follows:
30653
30654 .ilist
30655 >= 0
30656
30657 The process terminated by a normal exit and the value is the process
30658 ending status.
30659
30660 .next
30661 < 0 and > &--256
30662
30663 The process was terminated by a signal and the value is the negation of the
30664 signal number.
30665
30666 .next
30667 &--256
30668
30669 The process timed out.
30670 .next
30671 &--257
30672
30673 The was some other error in wait(); &%errno%& is still set.
30674 .endlist
30675
30676 .vitem &*pid_t&~child_open_exim(int&~*fd)*&
30677 This function provide you with a means of submitting a new message to
30678 Exim. (Of course, you can also call &_/usr/sbin/sendmail_& yourself if you
30679 want, but this packages it all up for you.) The function creates a pipe,
30680 forks a subprocess that is running
30681 .code
30682 exim -t -oem -oi -f <>
30683 .endd
30684 and returns to you (via the &`int *`& argument) a file descriptor for the pipe
30685 that is connected to the standard input. The yield of the function is the PID
30686 of the subprocess. You can then write a message to the file descriptor, with
30687 recipients in &'To:'&, &'Cc:'&, and/or &'Bcc:'& header lines.
30688
30689 When you have finished, call &'child_close()'& to wait for the process to
30690 finish and to collect its ending status. A timeout value of zero is usually
30691 fine in this circumstance. Unless you have made a mistake with the recipient
30692 addresses, you should get a return code of zero.
30693
30694
30695 .vitem &*pid_t&~child_open_exim2(int&~*fd,&~uschar&~*sender,&~uschar&~&&&
30696        *sender_authentication)*&
30697 This function is a more sophisticated version of &'child_open()'&. The command
30698 that it runs is:
30699 .display
30700 &`exim -t -oem -oi -f `&&'sender'&&` -oMas `&&'sender_authentication'&
30701 .endd
30702 The third argument may be NULL, in which case the &%-oMas%& option is omitted.
30703
30704
30705 .vitem &*void&~debug_printf(char&~*,&~...)*&
30706 This is Exim's debugging function, with arguments as for &'(printf()'&. The
30707 output is written to the standard error stream. If no debugging is selected,
30708 calls to &'debug_printf()'& have no effect. Normally, you should make calls
30709 conditional on the &`local_scan`& debug selector by coding like this:
30710 .code
30711 if ((debug_selector & D_local_scan) != 0)
30712   debug_printf("xxx", ...);
30713 .endd
30714
30715 .vitem &*uschar&~*expand_string(uschar&~*string)*&
30716 This is an interface to Exim's string expansion code. The return value is the
30717 expanded string, or NULL if there was an expansion failure.
30718 The C variable &%expand_string_message%& contains an error message after an
30719 expansion failure. If expansion does not change the string, the return value is
30720 the pointer to the input string. Otherwise, the return value points to a new
30721 block of memory that was obtained by a call to &'store_get()'&. See section
30722 &<<SECTmemhanloc>>& below for a discussion of memory handling.
30723
30724 .vitem &*void&~header_add(int&~type,&~char&~*format,&~...)*&
30725 This function allows you to an add additional header line at the end of the
30726 existing ones. The first argument is the type, and should normally be a space
30727 character. The second argument is a format string and any number of
30728 substitution arguments as for &[sprintf()]&. You may include internal newlines
30729 if you want, and you must ensure that the string ends with a newline.
30730
30731 .vitem "&*void&~header_add_at_position(BOOL&~after,&~uschar&~*name,&~&&&
30732         BOOL&~topnot,&~int&~type,&~char&~*format, &~&~...)*&"
30733 This function adds a new header line at a specified point in the header
30734 chain. The header itself is specified as for &'header_add()'&.
30735
30736 If &%name%& is NULL, the new header is added at the end of the chain if
30737 &%after%& is true, or at the start if &%after%& is false. If &%name%& is not
30738 NULL, the header lines are searched for the first non-deleted header that
30739 matches the name. If one is found, the new header is added before it if
30740 &%after%& is false. If &%after%& is true, the new header is added after the
30741 found header and any adjacent subsequent ones with the same name (even if
30742 marked &"deleted"&). If no matching non-deleted header is found, the &%topnot%&
30743 option controls where the header is added. If it is true, addition is at the
30744 top; otherwise at the bottom. Thus, to add a header after all the &'Received:'&
30745 headers, or at the top if there are no &'Received:'& headers, you could use
30746 .code
30747 header_add_at_position(TRUE, US"Received", TRUE,
30748   ' ', "X-xxx: ...");
30749 .endd
30750 Normally, there is always at least one non-deleted &'Received:'& header, but
30751 there may not be if &%received_header_text%& expands to an empty string.
30752
30753
30754 .vitem &*void&~header_remove(int&~occurrence,&~uschar&~*name)*&
30755 This function removes header lines. If &%occurrence%& is zero or negative, all
30756 occurrences of the header are removed. If occurrence is greater than zero, that
30757 particular instance of the header is removed. If no header(s) can be found that
30758 match the specification, the function does nothing.
30759
30760
30761 .vitem "&*BOOL&~header_testname(header_line&~*hdr,&~uschar&~*name,&~&&&
30762         int&~length,&~BOOL&~notdel)*&"
30763 This function tests whether the given header has the given name. It is not just
30764 a string comparison, because white space is permitted between the name and the
30765 colon. If the &%notdel%& argument is true, a false return is forced for all
30766 &"deleted"& headers; otherwise they are not treated specially. For example:
30767 .code
30768 if (header_testname(h, US"X-Spam", 6, TRUE)) ...
30769 .endd
30770 .vitem &*uschar&~*lss_b64encode(uschar&~*cleartext,&~int&~length)*&
30771 .cindex "base64 encoding" "functions for &[local_scan()]& use"
30772 This function base64-encodes a string, which is passed by address and length.
30773 The text may contain bytes of any value, including zero. The result is passed
30774 back in dynamic memory that is obtained by calling &'store_get()'&. It is
30775 zero-terminated.
30776
30777 .vitem &*int&~lss_b64decode(uschar&~*codetext,&~uschar&~**cleartext)*&
30778 This function decodes a base64-encoded string. Its arguments are a
30779 zero-terminated base64-encoded string and the address of a variable that is set
30780 to point to the result, which is in dynamic memory. The length of the decoded
30781 string is the yield of the function. If the input is invalid base64 data, the
30782 yield is -1. A zero byte is added to the end of the output string to make it
30783 easy to interpret as a C string (assuming it contains no zeros of its own). The
30784 added zero byte is not included in the returned count.
30785
30786 .vitem &*int&~lss_match_domain(uschar&~*domain,&~uschar&~*list)*&
30787 This function checks for a match in a domain list. Domains are always
30788 matched caselessly. The return value is one of the following:
30789 .display
30790 &`OK     `& match succeeded
30791 &`FAIL   `& match failed
30792 &`DEFER  `& match deferred
30793 .endd
30794 DEFER is usually caused by some kind of lookup defer, such as the
30795 inability to contact a database.
30796
30797 .vitem "&*int&~lss_match_local_part(uschar&~*localpart,&~uschar&~*list,&~&&&
30798         BOOL&~caseless)*&"
30799 This function checks for a match in a local part list. The third argument
30800 controls case-sensitivity. The return values are as for
30801 &'lss_match_domain()'&.
30802
30803 .vitem "&*int&~lss_match_address(uschar&~*address,&~uschar&~*list,&~&&&
30804         BOOL&~caseless)*&"
30805 This function checks for a match in an address list. The third argument
30806 controls the case-sensitivity of the local part match. The domain is always
30807 matched caselessly. The return values are as for &'lss_match_domain()'&.
30808
30809 .vitem "&*int&~lss_match_host(uschar&~*host_name,&~uschar&~*host_address,&~&&&
30810         uschar&~*list)*&"
30811 This function checks for a match in a host list. The most common usage is
30812 expected to be
30813 .code
30814 lss_match_host(sender_host_name, sender_host_address, ...)
30815 .endd
30816 .vindex "&$sender_host_address$&"
30817 An empty address field matches an empty item in the host list. If the host name
30818 is NULL, the name corresponding to &$sender_host_address$& is automatically
30819 looked up if a host name is required to match an item in the list. The return
30820 values are as for &'lss_match_domain()'&, but in addition, &'lss_match_host()'&
30821 returns ERROR in the case when it had to look up a host name, but the lookup
30822 failed.
30823
30824 .vitem "&*void&~log_write(unsigned&~int&~selector,&~int&~which,&~char&~&&&
30825         *format,&~...)*&"
30826 This function writes to Exim's log files. The first argument should be zero (it
30827 is concerned with &%log_selector%&). The second argument can be &`LOG_MAIN`& or
30828 &`LOG_REJECT`& or &`LOG_PANIC`& or the inclusive &"or"& of any combination of
30829 them. It specifies to which log or logs the message is written. The remaining
30830 arguments are a format and relevant insertion arguments. The string should not
30831 contain any newlines, not even at the end.
30832
30833
30834 .vitem &*void&~receive_add_recipient(uschar&~*address,&~int&~pno)*&
30835 This function adds an additional recipient to the message. The first argument
30836 is the recipient address. If it is unqualified (has no domain), it is qualified
30837 with the &%qualify_recipient%& domain. The second argument must always be -1.
30838
30839 This function does not allow you to specify a private &%errors_to%& address (as
30840 described with the structure of &%recipient_item%& above), because it pre-dates
30841 the addition of that field to the structure. However, it is easy to add such a
30842 value afterwards. For example:
30843 .code
30844  receive_add_recipient(US"monitor@mydom.example", -1);
30845  recipients_list[recipients_count-1].errors_to =
30846    US"postmaster@mydom.example";
30847 .endd
30848
30849 .vitem &*BOOL&~receive_remove_recipient(uschar&~*recipient)*&
30850 This is a convenience function to remove a named recipient from the list of
30851 recipients. It returns true if a recipient was removed, and false if no
30852 matching recipient could be found. The argument must be a complete email
30853 address.
30854 .endlist
30855
30856
30857 .cindex "RFC 2047"
30858 .vlist
30859 .vitem "&*uschar&~rfc2047_decode(uschar&~*string,&~BOOL&~lencheck,&&&
30860   &~uschar&~*target,&~int&~zeroval,&~int&~*lenptr, &~&~uschar&~**error)*&"
30861 This function decodes strings that are encoded according to RFC 2047. Typically
30862 these are the contents of header lines. First, each &"encoded word"& is decoded
30863 from the Q or B encoding into a byte-string. Then, if provided with the name of
30864 a charset encoding, and if the &[iconv()]& function is available, an attempt is
30865 made  to translate the result to the named character set. If this fails, the
30866 binary string is returned with an error message.
30867
30868 The first argument is the string to be decoded. If &%lencheck%& is TRUE, the
30869 maximum MIME word length is enforced. The third argument is the target
30870 encoding, or NULL if no translation is wanted.
30871
30872 .cindex "binary zero" "in RFC 2047 decoding"
30873 .cindex "RFC 2047" "binary zero in"
30874 If a binary zero is encountered in the decoded string, it is replaced by the
30875 contents of the &%zeroval%& argument. For use with Exim headers, the value must
30876 not be 0 because header lines are handled as zero-terminated strings.
30877
30878 The function returns the result of processing the string, zero-terminated; if
30879 &%lenptr%& is not NULL, the length of the result is set in the variable to
30880 which it points. When &%zeroval%& is 0, &%lenptr%& should not be NULL.
30881
30882 If an error is encountered, the function returns NULL and uses the &%error%&
30883 argument to return an error message. The variable pointed to by &%error%& is
30884 set to NULL if there is no error; it may be set non-NULL even when the function
30885 returns a non-NULL value if decoding was successful, but there was a problem
30886 with translation.
30887
30888
30889 .vitem &*int&~smtp_fflush(void)*&
30890 This function is used in conjunction with &'smtp_printf()'&, as described
30891 below.
30892
30893 .vitem &*void&~smtp_printf(char&~*,&~...)*&
30894 The arguments of this function are like &[printf()]&; it writes to the SMTP
30895 output stream. You should use this function only when there is an SMTP output
30896 stream, that is, when the incoming message is being received via interactive
30897 SMTP. This is the case when &%smtp_input%& is TRUE and &%smtp_batched_input%&
30898 is FALSE. If you want to test for an incoming message from another host (as
30899 opposed to a local process that used the &%-bs%& command line option), you can
30900 test the value of &%sender_host_address%&, which is non-NULL when a remote host
30901 is involved.
30902
30903 If an SMTP TLS connection is established, &'smtp_printf()'& uses the TLS
30904 output function, so it can be used for all forms of SMTP connection.
30905
30906 Strings that are written by &'smtp_printf()'& from within &[local_scan()]&
30907 must start with an appropriate response code: 550 if you are going to return
30908 LOCAL_SCAN_REJECT, 451 if you are going to return
30909 LOCAL_SCAN_TEMPREJECT, and 250 otherwise. Because you are writing the
30910 initial lines of a multi-line response, the code must be followed by a hyphen
30911 to indicate that the line is not the final response line. You must also ensure
30912 that the lines you write terminate with CRLF. For example:
30913 .code
30914 smtp_printf("550-this is some extra info\r\n");
30915 return LOCAL_SCAN_REJECT;
30916 .endd
30917 Note that you can also create multi-line responses by including newlines in
30918 the data returned via the &%return_text%& argument. The added value of using
30919 &'smtp_printf()'& is that, for instance, you could introduce delays between
30920 multiple output lines.
30921
30922 The &'smtp_printf()'& function does not return any error indication, because it
30923 does not automatically flush pending output, and therefore does not test
30924 the state of the stream. (In the main code of Exim, flushing and error
30925 detection is done when Exim is ready for the next SMTP input command.) If
30926 you want to flush the output and check for an error (for example, the
30927 dropping of a TCP/IP connection), you can call &'smtp_fflush()'&, which has no
30928 arguments. It flushes the output stream, and returns a non-zero value if there
30929 is an error.
30930
30931 .vitem &*void&~*store_get(int)*&
30932 This function accesses Exim's internal store (memory) manager. It gets a new
30933 chunk of memory whose size is given by the argument. Exim bombs out if it ever
30934 runs out of memory. See the next section for a discussion of memory handling.
30935
30936 .vitem &*void&~*store_get_perm(int)*&
30937 This function is like &'store_get()'&, but it always gets memory from the
30938 permanent pool. See the next section for a discussion of memory handling.
30939
30940 .vitem &*uschar&~*string_copy(uschar&~*string)*&
30941 See below.
30942
30943 .vitem &*uschar&~*string_copyn(uschar&~*string,&~int&~length)*&
30944 See below.
30945
30946 .vitem &*uschar&~*string_sprintf(char&~*format,&~...)*&
30947 These three functions create strings using Exim's dynamic memory facilities.
30948 The first makes a copy of an entire string. The second copies up to a maximum
30949 number of characters, indicated by the second argument. The third uses a format
30950 and insertion arguments to create a new string. In each case, the result is a
30951 pointer to a new string in the current memory pool. See the next section for
30952 more discussion.
30953 .endlist
30954
30955
30956
30957 .section "More about Exim's memory handling" "SECTmemhanloc"
30958 .cindex "&[local_scan()]& function" "memory handling"
30959 No function is provided for freeing memory, because that is never needed.
30960 The dynamic memory that Exim uses when receiving a message is automatically
30961 recycled if another message is received by the same process (this applies only
30962 to incoming SMTP connections &-- other input methods can supply only one
30963 message at a time). After receiving the last message, a reception process
30964 terminates.
30965
30966 Because it is recycled, the normal dynamic memory cannot be used for holding
30967 data that must be preserved over a number of incoming messages on the same SMTP
30968 connection. However, Exim in fact uses two pools of dynamic memory; the second
30969 one is not recycled, and can be used for this purpose.
30970
30971 If you want to allocate memory that remains available for subsequent messages
30972 in the same SMTP connection, you should set
30973 .code
30974 store_pool = POOL_PERM
30975 .endd
30976 before calling the function that does the allocation. There is no need to
30977 restore the value if you do not need to; however, if you do want to revert to
30978 the normal pool, you can either restore the previous value of &%store_pool%& or
30979 set it explicitly to POOL_MAIN.
30980
30981 The pool setting applies to all functions that get dynamic memory, including
30982 &'expand_string()'&, &'store_get()'&, and the &'string_xxx()'& functions.
30983 There is also a convenience function called &'store_get_perm()'& that gets a
30984 block of memory from the permanent pool while preserving the value of
30985 &%store_pool%&.
30986 .ecindex IIDlosca
30987
30988
30989
30990
30991 . ////////////////////////////////////////////////////////////////////////////
30992 . ////////////////////////////////////////////////////////////////////////////
30993
30994 .chapter "System-wide message filtering" "CHAPsystemfilter"
30995 .scindex IIDsysfil1 "filter" "system filter"
30996 .scindex IIDsysfil2 "filtering all mail"
30997 .scindex IIDsysfil3 "system filter"
30998 The previous chapters (on ACLs and the local scan function) describe checks
30999 that can be applied to messages before they are accepted by a host. There is
31000 also a mechanism for checking messages once they have been received, but before
31001 they are delivered. This is called the &'system filter'&.
31002
31003 The system filter operates in a similar manner to users' filter files, but it
31004 is run just once per message (however many recipients the message has).
31005 It should not normally be used as a substitute for routing, because &%deliver%&
31006 commands in a system router provide new envelope recipient addresses.
31007 The system filter must be an Exim filter. It cannot be a Sieve filter.
31008
31009 The system filter is run at the start of a delivery attempt, before any routing
31010 is done. If a message fails to be completely delivered at the first attempt,
31011 the system filter is run again at the start of every retry.
31012 If you want your filter to do something only once per message, you can make use
31013 of the &%first_delivery%& condition in an &%if%& command in the filter to
31014 prevent it happening on retries.
31015
31016 .vindex "&$domain$&"
31017 .vindex "&$local_part$&"
31018 &*Warning*&: Because the system filter runs just once, variables that are
31019 specific to individual recipient addresses, such as &$local_part$& and
31020 &$domain$&, are not set, and the &"personal"& condition is not meaningful. If
31021 you want to run a centrally-specified filter for each recipient address
31022 independently, you can do so by setting up a suitable &(redirect)& router, as
31023 described in section &<<SECTperaddfil>>& below.
31024
31025
31026 .section "Specifying a system filter" "SECID212"
31027 .cindex "uid (user id)" "system filter"
31028 .cindex "gid (group id)" "system filter"
31029 The name of the file that contains the system filter must be specified by
31030 setting &%system_filter%&. If you want the filter to run under a uid and gid
31031 other than root, you must also set &%system_filter_user%& and
31032 &%system_filter_group%& as appropriate. For example:
31033 .code
31034 system_filter = /etc/mail/exim.filter
31035 system_filter_user = exim
31036 .endd
31037 If a system filter generates any deliveries directly to files or pipes (via the
31038 &%save%& or &%pipe%& commands), transports to handle these deliveries must be
31039 specified by setting &%system_filter_file_transport%& and
31040 &%system_filter_pipe_transport%&, respectively. Similarly,
31041 &%system_filter_reply_transport%& must be set to handle any messages generated
31042 by the &%reply%& command.
31043
31044
31045 .section "Testing a system filter" "SECID213"
31046 You can run simple tests of a system filter in the same way as for a user
31047 filter, but you should use &%-bF%& rather than &%-bf%&, so that features that
31048 are permitted only in system filters are recognized.
31049
31050 If you want to test the combined effect of a system filter and a user filter,
31051 you can use both &%-bF%& and &%-bf%& on the same command line.
31052
31053
31054
31055 .section "Contents of a system filter" "SECID214"
31056 The language used to specify system filters is the same as for users' filter
31057 files. It is described in the separate end-user document &'Exim's interface to
31058 mail filtering'&. However, there are some additional features that are
31059 available only in system filters; these are described in subsequent sections.
31060 If they are encountered in a user's filter file or when testing with &%-bf%&,
31061 they cause errors.
31062
31063 .cindex "frozen messages" "manual thaw; testing in filter"
31064 There are two special conditions which, though available in users' filter
31065 files, are designed for use in system filters. The condition &%first_delivery%&
31066 is true only for the first attempt at delivering a message, and
31067 &%manually_thawed%& is true only if the message has been frozen, and
31068 subsequently thawed by an admin user. An explicit forced delivery counts as a
31069 manual thaw, but thawing as a result of the &%auto_thaw%& setting does not.
31070
31071 &*Warning*&: If a system filter uses the &%first_delivery%& condition to
31072 specify an &"unseen"& (non-significant) delivery, and that delivery does not
31073 succeed, it will not be tried again.
31074 If you want Exim to retry an unseen delivery until it succeeds, you should
31075 arrange to set it up every time the filter runs.
31076
31077 When a system filter finishes running, the values of the variables &$n0$& &--
31078 &$n9$& are copied into &$sn0$& &-- &$sn9$& and are thereby made available to
31079 users' filter files. Thus a system filter can, for example, set up &"scores"&
31080 to which users' filter files can refer.
31081
31082
31083
31084 .section "Additional variable for system filters" "SECID215"
31085 .vindex "&$recipients$&"
31086 The expansion variable &$recipients$&, containing a list of all the recipients
31087 of the message (separated by commas and white space), is available in system
31088 filters. It is not available in users' filters for privacy reasons.
31089
31090
31091
31092 .section "Defer, freeze, and fail commands for system filters" "SECID216"
31093 .cindex "freezing messages"
31094 .cindex "message" "freezing"
31095 .cindex "message" "forced failure"
31096 .cindex "&%fail%&" "in system filter"
31097 .cindex "&%freeze%& in system filter"
31098 .cindex "&%defer%& in system filter"
31099 There are three extra commands (&%defer%&, &%freeze%& and &%fail%&) which are
31100 always available in system filters, but are not normally enabled in users'
31101 filters. (See the &%allow_defer%&, &%allow_freeze%& and &%allow_fail%& options
31102 for the &(redirect)& router.) These commands can optionally be followed by the
31103 word &%text%& and a string containing an error message, for example:
31104 .code
31105 fail text "this message looks like spam to me"
31106 .endd
31107 The keyword &%text%& is optional if the next character is a double quote.
31108
31109 The &%defer%& command defers delivery of the original recipients of the
31110 message. The &%fail%& command causes all the original recipients to be failed,
31111 and a bounce message to be created. The &%freeze%& command suspends all
31112 delivery attempts for the original recipients. In all cases, any new deliveries
31113 that are specified by the filter are attempted as normal after the filter has
31114 run.
31115
31116 The &%freeze%& command is ignored if the message has been manually unfrozen and
31117 not manually frozen since. This means that automatic freezing by a system
31118 filter can be used as a way of checking out suspicious messages. If a message
31119 is found to be all right, manually unfreezing it allows it to be delivered.
31120
31121 .cindex "log" "&%fail%& command log line"
31122 .cindex "&%fail%&" "log line; reducing"
31123 The text given with a fail command is used as part of the bounce message as
31124 well as being written to the log. If the message is quite long, this can fill
31125 up a lot of log space when such failures are common. To reduce the size of the
31126 log message, Exim interprets the text in a special way if it starts with the
31127 two characters &`<<`& and contains &`>>`& later. The text between these two
31128 strings is written to the log, and the rest of the text is used in the bounce
31129 message. For example:
31130 .code
31131 fail "<<filter test 1>>Your message is rejected \
31132      because it contains attachments that we are \
31133      not prepared to receive."
31134 .endd
31135
31136 .cindex "loop" "caused by &%fail%&"
31137 Take great care with the &%fail%& command when basing the decision to fail on
31138 the contents of the message, because the bounce message will of course include
31139 the contents of the original message and will therefore trigger the &%fail%&
31140 command again (causing a mail loop) unless steps are taken to prevent this.
31141 Testing the &%error_message%& condition is one way to prevent this. You could
31142 use, for example
31143 .code
31144 if $message_body contains "this is spam" and not error_message
31145 then fail text "spam is not wanted here" endif
31146 .endd
31147 though of course that might let through unwanted bounce messages. The
31148 alternative is clever checking of the body and/or headers to detect bounces
31149 generated by the filter.
31150
31151 The interpretation of a system filter file ceases after a
31152 &%defer%&,
31153 &%freeze%&, or &%fail%& command is obeyed. However, any deliveries that were
31154 set up earlier in the filter file are honoured, so you can use a sequence such
31155 as
31156 .code
31157 mail ...
31158 freeze
31159 .endd
31160 to send a specified message when the system filter is freezing (or deferring or
31161 failing) a message. The normal deliveries for the message do not, of course,
31162 take place.
31163
31164
31165
31166 .section "Adding and removing headers in a system filter" "SECTaddremheasys"
31167 .cindex "header lines" "adding; in system filter"
31168 .cindex "header lines" "removing; in system filter"
31169 .cindex "filter" "header lines; adding/removing"
31170 Two filter commands that are available only in system filters are:
31171 .code
31172 headers add <string>
31173 headers remove <string>
31174 .endd
31175 The argument for the &%headers add%& is a string that is expanded and then
31176 added to the end of the message's headers. It is the responsibility of the
31177 filter maintainer to make sure it conforms to RFC 2822 syntax. Leading white
31178 space is ignored, and if the string is otherwise empty, or if the expansion is
31179 forced to fail, the command has no effect.
31180
31181 You can use &"\n"& within the string, followed by white space, to specify
31182 continued header lines. More than one header may be added in one command by
31183 including &"\n"& within the string without any following white space. For
31184 example:
31185 .code
31186 headers add "X-header-1: ....\n  \
31187              continuation of X-header-1 ...\n\
31188              X-header-2: ...."
31189 .endd
31190 Note that the header line continuation white space after the first newline must
31191 be placed before the backslash that continues the input string, because white
31192 space after input continuations is ignored.
31193
31194 The argument for &%headers remove%& is a colon-separated list of header names.
31195 This command applies only to those headers that are stored with the message;
31196 those that are added at delivery time (such as &'Envelope-To:'& and
31197 &'Return-Path:'&) cannot be removed by this means. If there is more than one
31198 header with the same name, they are all removed.
31199
31200 The &%headers%& command in a system filter makes an immediate change to the set
31201 of header lines that was received with the message (with possible additions
31202 from ACL processing). Subsequent commands in the system filter operate on the
31203 modified set, which also forms the basis for subsequent message delivery.
31204 Unless further modified during routing or transporting, this set of headers is
31205 used for all recipients of the message.
31206
31207 During routing and transporting, the variables that refer to the contents of
31208 header lines refer only to those lines that are in this set. Thus, header lines
31209 that are added by a system filter are visible to users' filter files and to all
31210 routers and transports. This contrasts with the manipulation of header lines by
31211 routers and transports, which is not immediate, but which instead is saved up
31212 until the message is actually being written (see section
31213 &<<SECTheadersaddrem>>&).
31214
31215 If the message is not delivered at the first attempt, header lines that were
31216 added by the system filter are stored with the message, and so are still
31217 present at the next delivery attempt. Header lines that were removed are still
31218 present, but marked &"deleted"& so that they are not transported with the
31219 message. For this reason, it is usual to make the &%headers%& command
31220 conditional on &%first_delivery%& so that the set of header lines is not
31221 modified more than once.
31222
31223 Because header modification in a system filter acts immediately, you have to
31224 use an indirect approach if you want to modify the contents of a header line.
31225 For example:
31226 .code
31227 headers add "Old-Subject: $h_subject:"
31228 headers remove "Subject"
31229 headers add "Subject: new subject (was: $h_old-subject:)"
31230 headers remove "Old-Subject"
31231 .endd
31232
31233
31234
31235 .section "Setting an errors address in a system filter" "SECID217"
31236 .cindex "envelope sender"
31237 In a system filter, if a &%deliver%& command is followed by
31238 .code
31239 errors_to <some address>
31240 .endd
31241 in order to change the envelope sender (and hence the error reporting) for that
31242 delivery, any address may be specified. (In a user filter, only the current
31243 user's address can be set.) For example, if some mail is being monitored, you
31244 might use
31245 .code
31246 unseen deliver monitor@spying.example errors_to root@local.example
31247 .endd
31248 to take a copy which would not be sent back to the normal error reporting
31249 address if its delivery failed.
31250
31251
31252
31253 .section "Per-address filtering" "SECTperaddfil"
31254 .vindex "&$domain$&"
31255 .vindex "&$local_part$&"
31256 In contrast to the system filter, which is run just once per message for each
31257 delivery attempt, it is also possible to set up a system-wide filtering
31258 operation that runs once for each recipient address. In this case, variables
31259 such as &$local_part$& and &$domain$& can be used, and indeed, the choice of
31260 filter file could be made dependent on them. This is an example of a router
31261 which implements such a filter:
31262 .code
31263 central_filter:
31264   check_local_user
31265   driver = redirect
31266   domains = +local_domains
31267   file = /central/filters/$local_part
31268   no_verify
31269   allow_filter
31270   allow_freeze
31271 .endd
31272 The filter is run in a separate process under its own uid. Therefore, either
31273 &%check_local_user%& must be set (as above), in which case the filter is run as
31274 the local user, or the &%user%& option must be used to specify which user to
31275 use. If both are set, &%user%& overrides.
31276
31277 Care should be taken to ensure that none of the commands in the filter file
31278 specify a significant delivery if the message is to go on to be delivered to
31279 its intended recipient. The router will not then claim to have dealt with the
31280 address, so it will be passed on to subsequent routers to be delivered in the
31281 normal way.
31282 .ecindex IIDsysfil1
31283 .ecindex IIDsysfil2
31284 .ecindex IIDsysfil3
31285
31286
31287
31288
31289
31290
31291 . ////////////////////////////////////////////////////////////////////////////
31292 . ////////////////////////////////////////////////////////////////////////////
31293
31294 .chapter "Message processing" "CHAPmsgproc"
31295 .scindex IIDmesproc "message" "general processing"
31296 Exim performs various transformations on the sender and recipient addresses of
31297 all messages that it handles, and also on the messages' header lines. Some of
31298 these are optional and configurable, while others always take place. All of
31299 this processing, except rewriting as a result of routing, and the addition or
31300 removal of header lines while delivering, happens when a message is received,
31301 before it is placed on Exim's queue.
31302
31303 Some of the automatic processing takes place by default only for
31304 &"locally-originated"& messages. This adjective is used to describe messages
31305 that are not received over TCP/IP, but instead are passed to an Exim process on
31306 its standard input. This includes the interactive &"local SMTP"& case that is
31307 set up by the &%-bs%& command line option.
31308
31309 &*Note*&: Messages received over TCP/IP on the loopback interface (127.0.0.1
31310 or ::1) are not considered to be locally-originated. Exim does not treat the
31311 loopback interface specially in any way.
31312
31313 If you want the loopback interface to be treated specially, you must ensure
31314 that there are appropriate entries in your ACLs.
31315
31316
31317
31318
31319 .section "Submission mode for non-local messages" "SECTsubmodnon"
31320 .cindex "message" "submission"
31321 .cindex "submission mode"
31322 Processing that happens automatically for locally-originated messages (unless
31323 &%suppress_local_fixups%& is set) can also be requested for messages that are
31324 received over TCP/IP. The term &"submission mode"& is used to describe this
31325 state. Submission mode is set by the modifier
31326 .code
31327 control = submission
31328 .endd
31329 in a MAIL, RCPT, or pre-data ACL for an incoming message (see sections
31330 &<<SECTACLmodi>>& and &<<SECTcontrols>>&). This makes Exim treat the message as
31331 a local submission, and is normally used when the source of the message is
31332 known to be an MUA running on a client host (as opposed to an MTA). For
31333 example, to set submission mode for messages originating on the IPv4 loopback
31334 interface, you could include the following in the MAIL ACL:
31335 .code
31336 warn  hosts = 127.0.0.1
31337       control = submission
31338 .endd
31339 .cindex "&%sender_retain%& submission option"
31340 There are some options that can be used when setting submission mode. A slash
31341 is used to separate options. For example:
31342 .code
31343 control = submission/sender_retain
31344 .endd
31345 Specifying &%sender_retain%& has the effect of setting &%local_sender_retain%&
31346 true and &%local_from_check%& false for the current incoming message. The first
31347 of these allows an existing &'Sender:'& header in the message to remain, and
31348 the second suppresses the check to ensure that &'From:'& matches the
31349 authenticated sender. With this setting, Exim still fixes up messages by adding
31350 &'Date:'& and &'Message-ID:'& header lines if they are missing, but makes no
31351 attempt to check sender authenticity in header lines.
31352
31353 When &%sender_retain%& is not set, a submission mode setting may specify a
31354 domain to be used when generating a &'From:'& or &'Sender:'& header line. For
31355 example:
31356 .code
31357 control = submission/domain=some.domain
31358 .endd
31359 The domain may be empty. How this value is used is described in sections
31360 &<<SECTthefrohea>>& and &<<SECTthesenhea>>&. There is also a &%name%& option
31361 that allows you to specify the user's full name for inclusion in a created
31362 &'Sender:'& or &'From:'& header line. For example:
31363 .code
31364 accept authenticated = *
31365        control = submission/domain=wonderland.example/\
31366                             name=${lookup {$authenticated_id} \
31367                                    lsearch {/etc/exim/namelist}}
31368 .endd
31369 Because the name may contain any characters, including slashes, the &%name%&
31370 option must be given last. The remainder of the string is used as the name. For
31371 the example above, if &_/etc/exim/namelist_& contains:
31372 .code
31373 bigegg:  Humpty Dumpty
31374 .endd
31375 then when the sender has authenticated as &'bigegg'&, the generated &'Sender:'&
31376 line would be:
31377 .code
31378 Sender: Humpty Dumpty <bigegg@wonderland.example>
31379 .endd
31380 .cindex "return path" "in submission mode"
31381 By default, submission mode forces the return path to the same address as is
31382 used to create the &'Sender:'& header. However, if &%sender_retain%& is
31383 specified, the return path is also left unchanged.
31384
31385 &*Note*&: The changes caused by submission mode take effect after the predata
31386 ACL. This means that any sender checks performed before the fix-ups use the
31387 untrusted sender address specified by the user, not the trusted sender address
31388 specified by submission mode. Although this might be slightly unexpected, it
31389 does mean that you can configure ACL checks to spot that a user is trying to
31390 spoof another's address.
31391
31392 .section "Line endings" "SECTlineendings"
31393 .cindex "line endings"
31394 .cindex "carriage return"
31395 .cindex "linefeed"
31396 RFC 2821 specifies that CRLF (two characters: carriage-return, followed by
31397 linefeed) is the line ending for messages transmitted over the Internet using
31398 SMTP over TCP/IP. However, within individual operating systems, different
31399 conventions are used. For example, Unix-like systems use just LF, but others
31400 use CRLF or just CR.
31401
31402 Exim was designed for Unix-like systems, and internally, it stores messages
31403 using the system's convention of a single LF as a line terminator. When
31404 receiving a message, all line endings are translated to this standard format.
31405 Originally, it was thought that programs that passed messages directly to an
31406 MTA within an operating system would use that system's convention. Experience
31407 has shown that this is not the case; for example, there are Unix applications
31408 that use CRLF in this circumstance. For this reason, and for compatibility with
31409 other MTAs, the way Exim handles line endings for all messages is now as
31410 follows:
31411
31412 .ilist
31413 LF not preceded by CR is treated as a line ending.
31414 .next
31415 CR is treated as a line ending; if it is immediately followed by LF, the LF
31416 is ignored.
31417 .next
31418 The sequence &"CR, dot, CR"& does not terminate an incoming SMTP message,
31419 nor a local message in the state where a line containing only a dot is a
31420 terminator.
31421 .next
31422 If a bare CR is encountered within a header line, an extra space is added after
31423 the line terminator so as not to end the header line. The reasoning behind this
31424 is that bare CRs in header lines are most likely either to be mistakes, or
31425 people trying to play silly games.
31426 .next
31427 If the first header line received in a message ends with CRLF, a subsequent
31428 bare LF in a header line is treated in the same way as a bare CR in a header
31429 line.
31430 .endlist
31431
31432
31433
31434
31435
31436 .section "Unqualified addresses" "SECID218"
31437 .cindex "unqualified addresses"
31438 .cindex "address" "qualification"
31439 By default, Exim expects every envelope address it receives from an external
31440 host to be fully qualified. Unqualified addresses cause negative responses to
31441 SMTP commands. However, because SMTP is used as a means of transporting
31442 messages from MUAs running on personal workstations, there is sometimes a
31443 requirement to accept unqualified addresses from specific hosts or IP networks.
31444
31445 Exim has two options that separately control which hosts may send unqualified
31446 sender or recipient addresses in SMTP commands, namely
31447 &%sender_unqualified_hosts%& and &%recipient_unqualified_hosts%&. In both
31448 cases, if an unqualified address is accepted, it is qualified by adding the
31449 value of &%qualify_domain%& or &%qualify_recipient%&, as appropriate.
31450
31451 .oindex "&%qualify_domain%&"
31452 .oindex "&%qualify_recipient%&"
31453 Unqualified addresses in header lines are automatically qualified for messages
31454 that are locally originated, unless the &%-bnq%& option is given on the command
31455 line. For messages received over SMTP, unqualified addresses in header lines
31456 are qualified only if unqualified addresses are permitted in SMTP commands. In
31457 other words, such qualification is also controlled by
31458 &%sender_unqualified_hosts%& and &%recipient_unqualified_hosts%&,
31459
31460
31461
31462
31463 .section "The UUCP From line" "SECID219"
31464 .cindex "&""From""& line"
31465 .cindex "UUCP" "&""From""& line"
31466 .cindex "sender" "address"
31467 .oindex "&%uucp_from_pattern%&"
31468 .oindex "&%uucp_from_sender%&"
31469 .cindex "envelope sender"
31470 .cindex "Sendmail compatibility" "&""From""& line"
31471 Messages that have come from UUCP (and some other applications) often begin
31472 with a line containing the envelope sender and a timestamp, following the word
31473 &"From"&. Examples of two common formats are:
31474 .code
31475 From a.oakley@berlin.mus Fri Jan  5 12:35 GMT 1996
31476 From f.butler@berlin.mus Fri, 7 Jan 97 14:00:00 GMT
31477 .endd
31478 This line precedes the RFC 2822 header lines. For compatibility with Sendmail,
31479 Exim recognizes such lines at the start of messages that are submitted to it
31480 via the command line (that is, on the standard input). It does not recognize
31481 such lines in incoming SMTP messages, unless the sending host matches
31482 &%ignore_fromline_hosts%& or the &%-bs%& option was used for a local message
31483 and &%ignore_fromline_local%& is set. The recognition is controlled by a
31484 regular expression that is defined by the &%uucp_from_pattern%& option, whose
31485 default value matches the two common cases shown above and puts the address
31486 that follows &"From"& into &$1$&.
31487
31488 .cindex "numerical variables (&$1$& &$2$& etc)" "in &""From ""& line handling"
31489 When the caller of Exim for a non-SMTP message that contains a &"From"& line is
31490 a trusted user, the message's sender address is constructed by expanding the
31491 contents of &%uucp_sender_address%&, whose default value is &"$1"&. This is
31492 then parsed as an RFC 2822 address. If there is no domain, the local part is
31493 qualified with &%qualify_domain%& unless it is the empty string. However, if
31494 the command line &%-f%& option is used, it overrides the &"From"& line.
31495
31496 If the caller of Exim is not trusted, the &"From"& line is recognized, but the
31497 sender address is not changed. This is also the case for incoming SMTP messages
31498 that are permitted to contain &"From"& lines.
31499
31500 Only one &"From"& line is recognized. If there is more than one, the second is
31501 treated as a data line that starts the body of the message, as it is not valid
31502 as a header line. This also happens if a &"From"& line is present in an
31503 incoming SMTP message from a source that is not permitted to send them.
31504
31505
31506
31507 .section "Resent- header lines" "SECID220"
31508 .cindex "&%Resent-%& header lines"
31509 RFC 2822 makes provision for sets of header lines starting with the string
31510 &`Resent-`& to be added to a message when it is resent by the original
31511 recipient to somebody else. These headers are &'Resent-Date:'&,
31512 &'Resent-From:'&, &'Resent-Sender:'&, &'Resent-To:'&, &'Resent-Cc:'&,
31513 &'Resent-Bcc:'& and &'Resent-Message-ID:'&. The RFC says:
31514
31515 .blockquote
31516 &'Resent fields are strictly informational. They MUST NOT be used in the normal
31517 processing of replies or other such automatic actions on messages.'&
31518 .endblockquote
31519
31520 This leaves things a bit vague as far as other processing actions such as
31521 address rewriting are concerned. Exim treats &%Resent-%& header lines as
31522 follows:
31523
31524 .ilist
31525 A &'Resent-From:'& line that just contains the login id of the submitting user
31526 is automatically rewritten in the same way as &'From:'& (see below).
31527 .next
31528 If there's a rewriting rule for a particular header line, it is also applied to
31529 &%Resent-%& header lines of the same type. For example, a rule that rewrites
31530 &'From:'& also rewrites &'Resent-From:'&.
31531 .next
31532 For local messages, if &'Sender:'& is removed on input, &'Resent-Sender:'& is
31533 also removed.
31534 .next
31535 For a locally-submitted message,
31536 if there are any &%Resent-%& header lines but no &'Resent-Date:'&,
31537 &'Resent-From:'&, or &'Resent-Message-Id:'&, they are added as necessary. It is
31538 the contents of &'Resent-Message-Id:'& (rather than &'Message-Id:'&) which are
31539 included in log lines in this case.
31540 .next
31541 The logic for adding &'Sender:'& is duplicated for &'Resent-Sender:'& when any
31542 &%Resent-%& header lines are present.
31543 .endlist
31544
31545
31546
31547
31548 .section "The Auto-Submitted: header line" "SECID221"
31549 Whenever Exim generates an autoreply, a bounce, or a delay warning message, it
31550 includes the header line:
31551 .code
31552 Auto-Submitted: auto-replied
31553 .endd
31554
31555 .section "The Bcc: header line" "SECID222"
31556 .cindex "&'Bcc:'& header line"
31557 If Exim is called with the &%-t%& option, to take recipient addresses from a
31558 message's header, it removes any &'Bcc:'& header line that may exist (after
31559 extracting its addresses). If &%-t%& is not present on the command line, any
31560 existing &'Bcc:'& is not removed.
31561
31562
31563 .section "The Date: header line" "SECID223"
31564 .cindex "&'Date:'& header line"
31565 If a locally-generated or submission-mode message has no &'Date:'& header line,
31566 Exim adds one, using the current date and time, unless the
31567 &%suppress_local_fixups%& control has been specified.
31568
31569 .section "The Delivery-date: header line" "SECID224"
31570 .cindex "&'Delivery-date:'& header line"
31571 .oindex "&%delivery_date_remove%&"
31572 &'Delivery-date:'& header lines are not part of the standard RFC 2822 header
31573 set. Exim can be configured to add them to the final delivery of messages. (See
31574 the generic &%delivery_date_add%& transport option.) They should not be present
31575 in messages in transit. If the &%delivery_date_remove%& configuration option is
31576 set (the default), Exim removes &'Delivery-date:'& header lines from incoming
31577 messages.
31578
31579
31580 .section "The Envelope-to: header line" "SECID225"
31581 .cindex "&'Envelope-to:'& header line"
31582 .oindex "&%envelope_to_remove%&"
31583 &'Envelope-to:'& header lines are not part of the standard RFC 2822 header set.
31584 Exim can be configured to add them to the final delivery of messages. (See the
31585 generic &%envelope_to_add%& transport option.) They should not be present in
31586 messages in transit. If the &%envelope_to_remove%& configuration option is set
31587 (the default), Exim removes &'Envelope-to:'& header lines from incoming
31588 messages.
31589
31590
31591 .section "The From: header line" "SECTthefrohea"
31592 .cindex "&'From:'& header line"
31593 .cindex "Sendmail compatibility" "&""From""& line"
31594 .cindex "message" "submission"
31595 .cindex "submission mode"
31596 If a submission-mode message does not contain a &'From:'& header line, Exim
31597 adds one if either of the following conditions is true:
31598
31599 .ilist
31600 The envelope sender address is not empty (that is, this is not a bounce
31601 message). The added header line copies the envelope sender address.
31602 .next
31603 .vindex "&$authenticated_id$&"
31604 The SMTP session is authenticated and &$authenticated_id$& is not empty.
31605 .olist
31606 .vindex "&$qualify_domain$&"
31607 If no domain is specified by the submission control, the local part is
31608 &$authenticated_id$& and the domain is &$qualify_domain$&.
31609 .next
31610 If a non-empty domain is specified by the submission control, the local
31611 part is &$authenticated_id$&, and the domain is the specified domain.
31612 .next
31613 If an empty domain is specified by the submission control,
31614 &$authenticated_id$& is assumed to be the complete address.
31615 .endlist
31616 .endlist
31617
31618 A non-empty envelope sender takes precedence.
31619
31620 If a locally-generated incoming message does not contain a &'From:'& header
31621 line, and the &%suppress_local_fixups%& control is not set, Exim adds one
31622 containing the sender's address. The calling user's login name and full name
31623 are used to construct the address, as described in section &<<SECTconstr>>&.
31624 They are obtained from the password data by calling &[getpwuid()]& (but see the
31625 &%unknown_login%& configuration option). The address is qualified with
31626 &%qualify_domain%&.
31627
31628 For compatibility with Sendmail, if an incoming, non-SMTP message has a
31629 &'From:'& header line containing just the unqualified login name of the calling
31630 user, this is replaced by an address containing the user's login name and full
31631 name as described in section &<<SECTconstr>>&.
31632
31633
31634 .section "The Message-ID: header line" "SECID226"
31635 .cindex "&'Message-ID:'& header line"
31636 .cindex "message" "submission"
31637 .oindex "&%message_id_header_text%&"
31638 If a locally-generated or submission-mode incoming message does not contain a
31639 &'Message-ID:'& or &'Resent-Message-ID:'& header line, and the
31640 &%suppress_local_fixups%& control is not set, Exim adds a suitable header line
31641 to the message. If there are any &'Resent-:'& headers in the message, it
31642 creates &'Resent-Message-ID:'&. The id is constructed from Exim's internal
31643 message id, preceded by the letter E to ensure it starts with a letter, and
31644 followed by @ and the primary host name. Additional information can be included
31645 in this header line by setting the &%message_id_header_text%& and/or
31646 &%message_id_header_domain%& options.
31647
31648
31649 .section "The Received: header line" "SECID227"
31650 .cindex "&'Received:'& header line"
31651 A &'Received:'& header line is added at the start of every message. The
31652 contents are defined by the &%received_header_text%& configuration option, and
31653 Exim automatically adds a semicolon and a timestamp to the configured string.
31654
31655 The &'Received:'& header is generated as soon as the message's header lines
31656 have been received. At this stage, the timestamp in the &'Received:'& header
31657 line is the time that the message started to be received. This is the value
31658 that is seen by the DATA ACL and by the &[local_scan()]& function.
31659
31660 Once a message is accepted, the timestamp in the &'Received:'& header line is
31661 changed to the time of acceptance, which is (apart from a small delay while the
31662 -H spool file is written) the earliest time at which delivery could start.
31663
31664
31665 .section "The References: header line" "SECID228"
31666 .cindex "&'References:'& header line"
31667 Messages created by the &(autoreply)& transport include a &'References:'&
31668 header line. This is constructed according to the rules that are described in
31669 section 3.64 of RFC 2822 (which states that replies should contain such a
31670 header line), and section 3.14 of RFC 3834 (which states that automatic
31671 responses are not different in this respect). However, because some mail
31672 processing software does not cope well with very long header lines, no more
31673 than 12 message IDs are copied from the &'References:'& header line in the
31674 incoming message. If there are more than 12, the first one and then the final
31675 11 are copied, before adding the message ID of the incoming message.
31676
31677
31678
31679 .section "The Return-path: header line" "SECID229"
31680 .cindex "&'Return-path:'& header line"
31681 .oindex "&%return_path_remove%&"
31682 &'Return-path:'& header lines are defined as something an MTA may insert when
31683 it does the final delivery of messages. (See the generic &%return_path_add%&
31684 transport option.) Therefore, they should not be present in messages in
31685 transit. If the &%return_path_remove%& configuration option is set (the
31686 default), Exim removes &'Return-path:'& header lines from incoming messages.
31687
31688
31689
31690 .section "The Sender: header line" "SECTthesenhea"
31691 .cindex "&'Sender:'& header line"
31692 .cindex "message" "submission"
31693 For a locally-originated message from an untrusted user, Exim may remove an
31694 existing &'Sender:'& header line, and it may add a new one. You can modify
31695 these actions by setting the &%local_sender_retain%& option true, the
31696 &%local_from_check%& option false, or by using the &%suppress_local_fixups%&
31697 control setting.
31698
31699 When a local message is received from an untrusted user and
31700 &%local_from_check%& is true (the default), and the &%suppress_local_fixups%&
31701 control has not been set, a check is made to see if the address given in the
31702 &'From:'& header line is the correct (local) sender of the message. The address
31703 that is expected has the login name as the local part and the value of
31704 &%qualify_domain%& as the domain. Prefixes and suffixes for the local part can
31705 be permitted by setting &%local_from_prefix%& and &%local_from_suffix%&
31706 appropriately. If &'From:'& does not contain the correct sender, a &'Sender:'&
31707 line is added to the message.
31708
31709 If you set &%local_from_check%& false, this checking does not occur. However,
31710 the removal of an existing &'Sender:'& line still happens, unless you also set
31711 &%local_sender_retain%& to be true. It is not possible to set both of these
31712 options true at the same time.
31713
31714 .cindex "submission mode"
31715 By default, no processing of &'Sender:'& header lines is done for messages
31716 received over TCP/IP or for messages submitted by trusted users. However, when
31717 a message is received over TCP/IP in submission mode, and &%sender_retain%& is
31718 not specified on the submission control, the following processing takes place:
31719
31720 .vindex "&$authenticated_id$&"
31721 First, any existing &'Sender:'& lines are removed. Then, if the SMTP session is
31722 authenticated, and &$authenticated_id$& is not empty, a sender address is
31723 created as follows:
31724
31725 .ilist
31726 .vindex "&$qualify_domain$&"
31727 If no domain is specified by the submission control, the local part is
31728 &$authenticated_id$& and the domain is &$qualify_domain$&.
31729 .next
31730 If a non-empty domain is specified by the submission control, the local part
31731 is &$authenticated_id$&, and the domain is the specified domain.
31732 .next
31733 If an empty domain is specified by the submission control,
31734 &$authenticated_id$& is assumed to be the complete address.
31735 .endlist
31736
31737 This address is compared with the address in the &'From:'& header line. If they
31738 are different, a &'Sender:'& header line containing the created address is
31739 added. Prefixes and suffixes for the local part in &'From:'& can be permitted
31740 by setting &%local_from_prefix%& and &%local_from_suffix%& appropriately.
31741
31742 .cindex "return path" "created from &'Sender:'&"
31743 &*Note*&: Whenever a &'Sender:'& header line is created, the return path for
31744 the message (the envelope sender address) is changed to be the same address,
31745 except in the case of submission mode when &%sender_retain%& is specified.
31746
31747
31748
31749 .section "Adding and removing header lines in routers and transports" &&&
31750          "SECTheadersaddrem"
31751 .cindex "header lines" "adding; in router or transport"
31752 .cindex "header lines" "removing; in router or transport"
31753 When a message is delivered, the addition and removal of header lines can be
31754 specified in a system filter, or on any of the routers and transports that
31755 process the message. Section &<<SECTaddremheasys>>& contains details about
31756 modifying headers in a system filter. Header lines can also be added in an ACL
31757 as a message is received (see section &<<SECTaddheadacl>>&).
31758
31759 In contrast to what happens in a system filter, header modifications that are
31760 specified on routers and transports apply only to the particular recipient
31761 addresses that are being processed by those routers and transports. These
31762 changes do not actually take place until a copy of the message is being
31763 transported. Therefore, they do not affect the basic set of header lines, and
31764 they do not affect the values of the variables that refer to header lines.
31765
31766 &*Note*&: In particular, this means that any expansions in the configuration of
31767 the transport cannot refer to the modified header lines, because such
31768 expansions all occur before the message is actually transported.
31769
31770 For both routers and transports, the result of expanding a &%headers_add%&
31771 option must be in the form of one or more RFC 2822 header lines, separated by
31772 newlines (coded as &"\n"&). For example:
31773 .code
31774 headers_add = X-added-header: added by $primary_hostname\n\
31775               X-added-second: another added header line
31776 .endd
31777 Exim does not check the syntax of these added header lines.
31778
31779 Multiple &%headers_add%& options for a single router or transport can be
31780 specified; the values will be concatenated (with a separating newline
31781 added) before expansion.
31782
31783 The result of expanding &%headers_remove%& must consist of a colon-separated
31784 list of header names. This is confusing, because header names themselves are
31785 often terminated by colons. In this case, the colons are the list separators,
31786 not part of the names. For example:
31787 .code
31788 headers_remove = return-receipt-to:acknowledge-to
31789 .endd
31790
31791 Multiple &%headers_remove%& options for a single router or transport can be
31792 specified; the values will be concatenated (with a separating colon
31793 added) before expansion.
31794
31795 When &%headers_add%& or &%headers_remove%& is specified on a router, its value
31796 is expanded at routing time, and then associated with all addresses that are
31797 accepted by that router, and also with any new addresses that it generates. If
31798 an address passes through several routers as a result of aliasing or
31799 forwarding, the changes are cumulative.
31800
31801 .oindex "&%unseen%&"
31802 However, this does not apply to multiple routers that result from the use of
31803 the &%unseen%& option. Any header modifications that were specified by the
31804 &"unseen"& router or its predecessors apply only to the &"unseen"& delivery.
31805
31806 Addresses that end up with different &%headers_add%& or &%headers_remove%&
31807 settings cannot be delivered together in a batch, so a transport is always
31808 dealing with a set of addresses that have the same header-processing
31809 requirements.
31810
31811 The transport starts by writing the original set of header lines that arrived
31812 with the message, possibly modified by the system filter. As it writes out
31813 these lines, it consults the list of header names that were attached to the
31814 recipient address(es) by &%headers_remove%& options in routers, and it also
31815 consults the transport's own &%headers_remove%& option. Header lines whose
31816 names are on either of these lists are not written out. If there are multiple
31817 instances of any listed header, they are all skipped.
31818
31819 After the remaining original header lines have been written, new header
31820 lines that were specified by routers' &%headers_add%& options are written, in
31821 the order in which they were attached to the address. These are followed by any
31822 header lines specified by the transport's &%headers_add%& option.
31823
31824 This way of handling header line modifications in routers and transports has
31825 the following consequences:
31826
31827 .ilist
31828 The original set of header lines, possibly modified by the system filter,
31829 remains &"visible"&, in the sense that the &$header_$&&'xxx'& variables refer
31830 to it, at all times.
31831 .next
31832 Header lines that are added by a router's
31833 &%headers_add%& option are not accessible by means of the &$header_$&&'xxx'&
31834 expansion syntax in subsequent routers or the transport.
31835 .next
31836 Conversely, header lines that are specified for removal by &%headers_remove%&
31837 in a router remain visible to subsequent routers and the transport.
31838 .next
31839 Headers added to an address by &%headers_add%& in a router cannot be removed by
31840 a later router or by a transport.
31841 .next
31842 An added header can refer to the contents of an original header that is to be
31843 removed, even it has the same name as the added header. For example:
31844 .code
31845 headers_remove = subject
31846 headers_add = Subject: new subject (was: $h_subject:)
31847 .endd
31848 .endlist
31849
31850 &*Warning*&: The &%headers_add%& and &%headers_remove%& options cannot be used
31851 for a &(redirect)& router that has the &%one_time%& option set.
31852
31853
31854
31855
31856
31857 .section "Constructed addresses" "SECTconstr"
31858 .cindex "address" "constructed"
31859 .cindex "constructed address"
31860 When Exim constructs a sender address for a locally-generated message, it uses
31861 the form
31862 .display
31863 <&'user name'&>&~&~<&'login'&&`@`&&'qualify_domain'&>
31864 .endd
31865 For example:
31866 .code
31867 Zaphod Beeblebrox <zaphod@end.univ.example>
31868 .endd
31869 The user name is obtained from the &%-F%& command line option if set, or
31870 otherwise by looking up the calling user by &[getpwuid()]& and extracting the
31871 &"gecos"& field from the password entry. If the &"gecos"& field contains an
31872 ampersand character, this is replaced by the login name with the first letter
31873 upper cased, as is conventional in a number of operating systems. See the
31874 &%gecos_name%& option for a way to tailor the handling of the &"gecos"& field.
31875 The &%unknown_username%& option can be used to specify user names in cases when
31876 there is no password file entry.
31877
31878 .cindex "RFC 2047"
31879 In all cases, the user name is made to conform to RFC 2822 by quoting all or
31880 parts of it if necessary. In addition, if it contains any non-printing
31881 characters, it is encoded as described in RFC 2047, which defines a way of
31882 including non-ASCII characters in header lines. The value of the
31883 &%headers_charset%& option specifies the name of the encoding that is used (the
31884 characters are assumed to be in this encoding). The setting of
31885 &%print_topbitchars%& controls whether characters with the top bit set (that
31886 is, with codes greater than 127) count as printing characters or not.
31887
31888
31889
31890 .section "Case of local parts" "SECID230"
31891 .cindex "case of local parts"
31892 .cindex "local part" "case of"
31893 RFC 2822 states that the case of letters in the local parts of addresses cannot
31894 be assumed to be non-significant. Exim preserves the case of local parts of
31895 addresses, but by default it uses a lower-cased form when it is routing,
31896 because on most Unix systems, usernames are in lower case and case-insensitive
31897 routing is required. However, any particular router can be made to use the
31898 original case for local parts by setting the &%caseful_local_part%& generic
31899 router option.
31900
31901 .cindex "mixed-case login names"
31902 If you must have mixed-case user names on your system, the best way to proceed,
31903 assuming you want case-independent handling of incoming email, is to set up
31904 your first router to convert incoming local parts in your domains to the
31905 correct case by means of a file lookup. For example:
31906 .code
31907 correct_case:
31908   driver = redirect
31909   domains = +local_domains
31910   data = ${lookup{$local_part}cdb\
31911               {/etc/usercased.cdb}{$value}fail}\
31912               @$domain
31913 .endd
31914 For this router, the local part is forced to lower case by the default action
31915 (&%caseful_local_part%& is not set). The lower-cased local part is used to look
31916 up a new local part in the correct case. If you then set &%caseful_local_part%&
31917 on any subsequent routers which process your domains, they will operate on
31918 local parts with the correct case in a case-sensitive manner.
31919
31920
31921
31922 .section "Dots in local parts" "SECID231"
31923 .cindex "dot" "in local part"
31924 .cindex "local part" "dots in"
31925 RFC 2822 forbids empty components in local parts. That is, an unquoted local
31926 part may not begin or end with a dot, nor have two consecutive dots in the
31927 middle. However, it seems that many MTAs do not enforce this, so Exim permits
31928 empty components for compatibility.
31929
31930
31931
31932 .section "Rewriting addresses" "SECID232"
31933 .cindex "rewriting" "addresses"
31934 Rewriting of sender and recipient addresses, and addresses in headers, can
31935 happen automatically, or as the result of configuration options, as described
31936 in chapter &<<CHAPrewrite>>&. The headers that may be affected by this are
31937 &'Bcc:'&, &'Cc:'&, &'From:'&, &'Reply-To:'&, &'Sender:'&, and &'To:'&.
31938
31939 Automatic rewriting includes qualification, as mentioned above. The other case
31940 in which it can happen is when an incomplete non-local domain is given. The
31941 routing process may cause this to be expanded into the full domain name. For
31942 example, a header such as
31943 .code
31944 To: hare@teaparty
31945 .endd
31946 might get rewritten as
31947 .code
31948 To: hare@teaparty.wonderland.fict.example
31949 .endd
31950 Rewriting as a result of routing is the one kind of message processing that
31951 does not happen at input time, as it cannot be done until the address has
31952 been routed.
31953
31954 Strictly, one should not do &'any'& deliveries of a message until all its
31955 addresses have been routed, in case any of the headers get changed as a
31956 result of routing. However, doing this in practice would hold up many
31957 deliveries for unreasonable amounts of time, just because one address could not
31958 immediately be routed. Exim therefore does not delay other deliveries when
31959 routing of one or more addresses is deferred.
31960 .ecindex IIDmesproc
31961
31962
31963
31964 . ////////////////////////////////////////////////////////////////////////////
31965 . ////////////////////////////////////////////////////////////////////////////
31966
31967 .chapter "SMTP processing" "CHAPSMTP"
31968 .scindex IIDsmtpproc1 "SMTP" "processing details"
31969 .scindex IIDsmtpproc2 "LMTP" "processing details"
31970 Exim supports a number of different ways of using the SMTP protocol, and its
31971 LMTP variant, which is an interactive protocol for transferring messages into a
31972 closed mail store application. This chapter contains details of how SMTP is
31973 processed. For incoming mail, the following are available:
31974
31975 .ilist
31976 SMTP over TCP/IP (Exim daemon or &'inetd'&);
31977 .next
31978 SMTP over the standard input and output (the &%-bs%& option);
31979 .next
31980 Batched SMTP on the standard input (the &%-bS%& option).
31981 .endlist
31982
31983 For mail delivery, the following are available:
31984
31985 .ilist
31986 SMTP over TCP/IP (the &(smtp)& transport);
31987 .next
31988 LMTP over TCP/IP (the &(smtp)& transport with the &%protocol%& option set to
31989 &"lmtp"&);
31990 .next
31991 LMTP over a pipe to a process running in the local host (the &(lmtp)&
31992 transport);
31993 .next
31994 Batched SMTP to a file or pipe (the &(appendfile)& and &(pipe)& transports with
31995 the &%use_bsmtp%& option set).
31996 .endlist
31997
31998 &'Batched SMTP'& is the name for a process in which batches of messages are
31999 stored in or read from files (or pipes), in a format in which SMTP commands are
32000 used to contain the envelope information.
32001
32002
32003
32004 .section "Outgoing SMTP and LMTP over TCP/IP" "SECToutSMTPTCP"
32005 .cindex "SMTP" "outgoing over TCP/IP"
32006 .cindex "outgoing SMTP over TCP/IP"
32007 .cindex "LMTP" "over TCP/IP"
32008 .cindex "outgoing LMTP over TCP/IP"
32009 .cindex "EHLO"
32010 .cindex "HELO"
32011 .cindex "SIZE option on MAIL command"
32012 Outgoing SMTP and LMTP over TCP/IP is implemented by the &(smtp)& transport.
32013 The &%protocol%& option selects which protocol is to be used, but the actual
32014 processing is the same in both cases.
32015
32016 If, in response to its EHLO command, Exim is told that the SIZE
32017 parameter is supported, it adds SIZE=<&'n'&> to each subsequent MAIL
32018 command. The value of <&'n'&> is the message size plus the value of the
32019 &%size_addition%& option (default 1024) to allow for additions to the message
32020 such as per-transport header lines, or changes made in a
32021 .cindex "transport" "filter"
32022 .cindex "filter" "transport filter"
32023 transport filter. If &%size_addition%& is set negative, the use of SIZE is
32024 suppressed.
32025
32026 If the remote server advertises support for PIPELINING, Exim uses the
32027 pipelining extension to SMTP (RFC 2197) to reduce the number of TCP/IP packets
32028 required for the transaction.
32029
32030 If the remote server advertises support for the STARTTLS command, and Exim
32031 was built to support TLS encryption, it tries to start a TLS session unless the
32032 server matches &%hosts_avoid_tls%&. See chapter &<<CHAPTLS>>& for more details.
32033 Either a match in that or &%hosts_verify_avoid_tls%& apply when the transport
32034 is called for verification.
32035
32036 If the remote server advertises support for the AUTH command, Exim scans
32037 the authenticators configuration for any suitable client settings, as described
32038 in chapter &<<CHAPSMTPAUTH>>&.
32039
32040 .cindex "carriage return"
32041 .cindex "linefeed"
32042 Responses from the remote host are supposed to be terminated by CR followed by
32043 LF. However, there are known to be hosts that do not send CR characters, so in
32044 order to be able to interwork with such hosts, Exim treats LF on its own as a
32045 line terminator.
32046
32047 If a message contains a number of different addresses, all those with the same
32048 characteristics (for example, the same envelope sender) that resolve to the
32049 same set of hosts, in the same order, are sent in a single SMTP transaction,
32050 even if they are for different domains, unless there are more than the setting
32051 of the &%max_rcpt%&s option in the &(smtp)& transport allows, in which case
32052 they are split into groups containing no more than &%max_rcpt%&s addresses
32053 each. If &%remote_max_parallel%& is greater than one, such groups may be sent
32054 in parallel sessions. The order of hosts with identical MX values is not
32055 significant when checking whether addresses can be batched in this way.
32056
32057 When the &(smtp)& transport suffers a temporary failure that is not
32058 message-related, Exim updates its transport-specific database, which contains
32059 records indexed by host name that remember which messages are waiting for each
32060 particular host. It also updates the retry database with new retry times.
32061
32062 .cindex "hints database" "retry keys"
32063 Exim's retry hints are based on host name plus IP address, so if one address of
32064 a multi-homed host is broken, it will soon be skipped most of the time.
32065 See the next section for more detail about error handling.
32066
32067 .cindex "SMTP" "passed connection"
32068 .cindex "SMTP" "batching over TCP/IP"
32069 When a message is successfully delivered over a TCP/IP SMTP connection, Exim
32070 looks in the hints database for the transport to see if there are any queued
32071 messages waiting for the host to which it is connected. If it finds one, it
32072 creates a new Exim process using the &%-MC%& option (which can only be used by
32073 a process running as root or the Exim user) and passes the TCP/IP socket to it
32074 so that it can deliver another message using the same socket. The new process
32075 does only those deliveries that are routed to the connected host, and may in
32076 turn pass the socket on to a third process, and so on.
32077
32078 The &%connection_max_messages%& option of the &(smtp)& transport can be used to
32079 limit the number of messages sent down a single TCP/IP connection.
32080
32081 .cindex "asterisk" "after IP address"
32082 The second and subsequent messages delivered down an existing connection are
32083 identified in the main log by the addition of an asterisk after the closing
32084 square bracket of the IP address.
32085
32086
32087
32088
32089 .section "Errors in outgoing SMTP" "SECToutSMTPerr"
32090 .cindex "error" "in outgoing SMTP"
32091 .cindex "SMTP" "errors in outgoing"
32092 .cindex "host" "error"
32093 Three different kinds of error are recognized for outgoing SMTP: host errors,
32094 message errors, and recipient errors.
32095
32096 .vlist
32097 .vitem "&*Host errors*&"
32098 A host error is not associated with a particular message or with a
32099 particular recipient of a message. The host errors are:
32100
32101 .ilist
32102 Connection refused or timed out,
32103 .next
32104 Any error response code on connection,
32105 .next
32106 Any error response code to EHLO or HELO,
32107 .next
32108 Loss of connection at any time, except after &"."&,
32109 .next
32110 I/O errors at any time,
32111 .next
32112 Timeouts during the session, other than in response to MAIL, RCPT or
32113 the &"."& at the end of the data.
32114 .endlist ilist
32115
32116 For a host error, a permanent error response on connection, or in response to
32117 EHLO, causes all addresses routed to the host to be failed. Any other host
32118 error causes all addresses to be deferred, and retry data to be created for the
32119 host. It is not tried again, for any message, until its retry time arrives. If
32120 the current set of addresses are not all delivered in this run (to some
32121 alternative host), the message is added to the list of those waiting for this
32122 host, so if it is still undelivered when a subsequent successful delivery is
32123 made to the host, it will be sent down the same SMTP connection.
32124
32125 .vitem "&*Message errors*&"
32126 .cindex "message" "error"
32127 A message error is associated with a particular message when sent to a
32128 particular host, but not with a particular recipient of the message. The
32129 message errors are:
32130
32131 .ilist
32132 Any error response code to MAIL, DATA, or the &"."& that terminates
32133 the data,
32134 .next
32135 Timeout after MAIL,
32136 .next
32137 Timeout or loss of connection after the &"."& that terminates the data. A
32138 timeout after the DATA command itself is treated as a host error, as is loss of
32139 connection at any other time.
32140 .endlist ilist
32141
32142 For a message error, a permanent error response (5&'xx'&) causes all addresses
32143 to be failed, and a delivery error report to be returned to the sender. A
32144 temporary error response (4&'xx'&), or one of the timeouts, causes all
32145 addresses to be deferred. Retry data is not created for the host, but instead,
32146 a retry record for the combination of host plus message id is created. The
32147 message is not added to the list of those waiting for this host. This ensures
32148 that the failing message will not be sent to this host again until the retry
32149 time arrives. However, other messages that are routed to the host are not
32150 affected, so if it is some property of the message that is causing the error,
32151 it will not stop the delivery of other mail.
32152
32153 If the remote host specified support for the SIZE parameter in its response
32154 to EHLO, Exim adds SIZE=&'nnn'& to the MAIL command, so an
32155 over-large message will cause a message error because the error arrives as a
32156 response to MAIL.
32157
32158 .vitem "&*Recipient errors*&"
32159 .cindex "recipient" "error"
32160 A recipient error is associated with a particular recipient of a message. The
32161 recipient errors are:
32162
32163 .ilist
32164 Any error response to RCPT,
32165 .next
32166 Timeout after RCPT.
32167 .endlist
32168
32169 For a recipient error, a permanent error response (5&'xx'&) causes the
32170 recipient address to be failed, and a bounce message to be returned to the
32171 sender. A temporary error response (4&'xx'&) or a timeout causes the failing
32172 address to be deferred, and routing retry data to be created for it. This is
32173 used to delay processing of the address in subsequent queue runs, until its
32174 routing retry time arrives. This applies to all messages, but because it
32175 operates only in queue runs, one attempt will be made to deliver a new message
32176 to the failing address before the delay starts to operate. This ensures that,
32177 if the failure is really related to the message rather than the recipient
32178 (&"message too big for this recipient"& is a possible example), other messages
32179 have a chance of getting delivered. If a delivery to the address does succeed,
32180 the retry information gets cleared, so all stuck messages get tried again, and
32181 the retry clock is reset.
32182
32183 The message is not added to the list of those waiting for this host. Use of the
32184 host for other messages is unaffected, and except in the case of a timeout,
32185 other recipients are processed independently, and may be successfully delivered
32186 in the current SMTP session. After a timeout it is of course impossible to
32187 proceed with the session, so all addresses get deferred. However, those other
32188 than the one that failed do not suffer any subsequent retry delays. Therefore,
32189 if one recipient is causing trouble, the others have a chance of getting
32190 through when a subsequent delivery attempt occurs before the failing
32191 recipient's retry time.
32192 .endlist
32193
32194 In all cases, if there are other hosts (or IP addresses) available for the
32195 current set of addresses (for example, from multiple MX records), they are
32196 tried in this run for any undelivered addresses, subject of course to their
32197 own retry data. In other words, recipient error retry data does not take effect
32198 until the next delivery attempt.
32199
32200 Some hosts have been observed to give temporary error responses to every
32201 MAIL command at certain times (&"insufficient space"& has been seen). It
32202 would be nice if such circumstances could be recognized, and defer data for the
32203 host itself created, but this is not possible within the current Exim design.
32204 What actually happens is that retry data for every (host, message) combination
32205 is created.
32206
32207 The reason that timeouts after MAIL and RCPT are treated specially is that
32208 these can sometimes arise as a result of the remote host's verification
32209 procedures. Exim makes this assumption, and treats them as if a temporary error
32210 response had been received. A timeout after &"."& is treated specially because
32211 it is known that some broken implementations fail to recognize the end of the
32212 message if the last character of the last line is a binary zero. Thus, it is
32213 helpful to treat this case as a message error.
32214
32215 Timeouts at other times are treated as host errors, assuming a problem with the
32216 host, or the connection to it. If a timeout after MAIL, RCPT,
32217 or &"."& is really a connection problem, the assumption is that at the next try
32218 the timeout is likely to occur at some other point in the dialogue, causing it
32219 then to be treated as a host error.
32220
32221 There is experimental evidence that some MTAs drop the connection after the
32222 terminating &"."& if they do not like the contents of the message for some
32223 reason, in contravention of the RFC, which indicates that a 5&'xx'& response
32224 should be given. That is why Exim treats this case as a message rather than a
32225 host error, in order not to delay other messages to the same host.
32226
32227
32228
32229
32230 .section "Incoming SMTP messages over TCP/IP" "SECID233"
32231 .cindex "SMTP" "incoming over TCP/IP"
32232 .cindex "incoming SMTP over TCP/IP"
32233 .cindex "inetd"
32234 .cindex "daemon"
32235 Incoming SMTP messages can be accepted in one of two ways: by running a
32236 listening daemon, or by using &'inetd'&. In the latter case, the entry in
32237 &_/etc/inetd.conf_& should be like this:
32238 .code
32239 smtp stream tcp nowait exim /opt/exim/bin/exim in.exim -bs
32240 .endd
32241 Exim distinguishes between this case and the case of a locally running user
32242 agent using the &%-bs%& option by checking whether or not the standard input is
32243 a socket. When it is, either the port must be privileged (less than 1024), or
32244 the caller must be root or the Exim user. If any other user passes a socket
32245 with an unprivileged port number, Exim prints a message on the standard error
32246 stream and exits with an error code.
32247
32248 By default, Exim does not make a log entry when a remote host connects or
32249 disconnects (either via the daemon or &'inetd'&), unless the disconnection is
32250 unexpected. It can be made to write such log entries by setting the
32251 &%smtp_connection%& log selector.
32252
32253 .cindex "carriage return"
32254 .cindex "linefeed"
32255 Commands from the remote host are supposed to be terminated by CR followed by
32256 LF. However, there are known to be hosts that do not send CR characters. In
32257 order to be able to interwork with such hosts, Exim treats LF on its own as a
32258 line terminator.
32259 Furthermore, because common code is used for receiving messages from all
32260 sources, a CR on its own is also interpreted as a line terminator. However, the
32261 sequence &"CR, dot, CR"& does not terminate incoming SMTP data.
32262
32263 .cindex "EHLO" "invalid data"
32264 .cindex "HELO" "invalid data"
32265 One area that sometimes gives rise to problems concerns the EHLO or
32266 HELO commands. Some clients send syntactically invalid versions of these
32267 commands, which Exim rejects by default. (This is nothing to do with verifying
32268 the data that is sent, so &%helo_verify_hosts%& is not relevant.) You can tell
32269 Exim not to apply a syntax check by setting &%helo_accept_junk_hosts%& to
32270 match the broken hosts that send invalid commands.
32271
32272 .cindex "SIZE option on MAIL command"
32273 .cindex "MAIL" "SIZE option"
32274 The amount of disk space available is checked whenever SIZE is received on
32275 a MAIL command, independently of whether &%message_size_limit%& or
32276 &%check_spool_space%& is configured, unless &%smtp_check_spool_space%& is set
32277 false. A temporary error is given if there is not enough space. If
32278 &%check_spool_space%& is set, the check is for that amount of space plus the
32279 value given with SIZE, that is, it checks that the addition of the incoming
32280 message will not reduce the space below the threshold.
32281
32282 When a message is successfully received, Exim includes the local message id in
32283 its response to the final &"."& that terminates the data. If the remote host
32284 logs this text it can help with tracing what has happened to a message.
32285
32286 The Exim daemon can limit the number of simultaneous incoming connections it is
32287 prepared to handle (see the &%smtp_accept_max%& option). It can also limit the
32288 number of simultaneous incoming connections from a single remote host (see the
32289 &%smtp_accept_max_per_host%& option). Additional connection attempts are
32290 rejected using the SMTP temporary error code 421.
32291
32292 The Exim daemon does not rely on the SIGCHLD signal to detect when a
32293 subprocess has finished, as this can get lost at busy times. Instead, it looks
32294 for completed subprocesses every time it wakes up. Provided there are other
32295 things happening (new incoming calls, starts of queue runs), completed
32296 processes will be noticed and tidied away. On very quiet systems you may
32297 sometimes see a &"defunct"& Exim process hanging about. This is not a problem;
32298 it will be noticed when the daemon next wakes up.
32299
32300 When running as a daemon, Exim can reserve some SMTP slots for specific hosts,
32301 and can also be set up to reject SMTP calls from non-reserved hosts at times of
32302 high system load &-- for details see the &%smtp_accept_reserve%&,
32303 &%smtp_load_reserve%&, and &%smtp_reserve_hosts%& options. The load check
32304 applies in both the daemon and &'inetd'& cases.
32305
32306 Exim normally starts a delivery process for each message received, though this
32307 can be varied by means of the &%-odq%& command line option and the
32308 &%queue_only%&, &%queue_only_file%&, and &%queue_only_load%& options. The
32309 number of simultaneously running delivery processes started in this way from
32310 SMTP input can be limited by the &%smtp_accept_queue%& and
32311 &%smtp_accept_queue_per_connection%& options. When either limit is reached,
32312 subsequently received messages are just put on the input queue without starting
32313 a delivery process.
32314
32315 The controls that involve counts of incoming SMTP calls (&%smtp_accept_max%&,
32316 &%smtp_accept_queue%&, &%smtp_accept_reserve%&) are not available when Exim is
32317 started up from the &'inetd'& daemon, because in that case each connection is
32318 handled by an entirely independent Exim process. Control by load average is,
32319 however, available with &'inetd'&.
32320
32321 Exim can be configured to verify addresses in incoming SMTP commands as they
32322 are received. See chapter &<<CHAPACL>>& for details. It can also be configured
32323 to rewrite addresses at this time &-- before any syntax checking is done. See
32324 section &<<SECTrewriteS>>&.
32325
32326 Exim can also be configured to limit the rate at which a client host submits
32327 MAIL and RCPT commands in a single SMTP session. See the
32328 &%smtp_ratelimit_hosts%& option.
32329
32330
32331
32332 .section "Unrecognized SMTP commands" "SECID234"
32333 .cindex "SMTP" "unrecognized commands"
32334 If Exim receives more than &%smtp_max_unknown_commands%& unrecognized SMTP
32335 commands during a single SMTP connection, it drops the connection after sending
32336 the error response to the last command. The default value for
32337 &%smtp_max_unknown_commands%& is 3. This is a defence against some kinds of
32338 abuse that subvert web servers into making connections to SMTP ports; in these
32339 circumstances, a number of non-SMTP lines are sent first.
32340
32341
32342 .section "Syntax and protocol errors in SMTP commands" "SECID235"
32343 .cindex "SMTP" "syntax errors"
32344 .cindex "SMTP" "protocol errors"
32345 A syntax error is detected if an SMTP command is recognized, but there is
32346 something syntactically wrong with its data, for example, a malformed email
32347 address in a RCPT command. Protocol errors include invalid command
32348 sequencing such as RCPT before MAIL. If Exim receives more than
32349 &%smtp_max_synprot_errors%& such commands during a single SMTP connection, it
32350 drops the connection after sending the error response to the last command. The
32351 default value for &%smtp_max_synprot_errors%& is 3. This is a defence against
32352 broken clients that loop sending bad commands (yes, it has been seen).
32353
32354
32355
32356 .section "Use of non-mail SMTP commands" "SECID236"
32357 .cindex "SMTP" "non-mail commands"
32358 The &"non-mail"& SMTP commands are those other than MAIL, RCPT, and
32359 DATA. Exim counts such commands, and drops the connection if there are too
32360 many of them in a single SMTP session. This action catches some
32361 denial-of-service attempts and things like repeated failing AUTHs, or a mad
32362 client looping sending EHLO. The global option &%smtp_accept_max_nonmail%&
32363 defines what &"too many"& means. Its default value is 10.
32364
32365 When a new message is expected, one occurrence of RSET is not counted. This
32366 allows a client to send one RSET between messages (this is not necessary,
32367 but some clients do it). Exim also allows one uncounted occurrence of HELO
32368 or EHLO, and one occurrence of STARTTLS between messages. After
32369 starting up a TLS session, another EHLO is expected, and so it too is not
32370 counted.
32371
32372 The first occurrence of AUTH in a connection, or immediately following
32373 STARTTLS is also not counted. Otherwise, all commands other than MAIL,
32374 RCPT, DATA, and QUIT are counted.
32375
32376 You can control which hosts are subject to the limit set by
32377 &%smtp_accept_max_nonmail%& by setting
32378 &%smtp_accept_max_nonmail_hosts%&. The default value is &`*`&, which makes
32379 the limit apply to all hosts. This option means that you can exclude any
32380 specific badly-behaved hosts that you have to live with.
32381
32382
32383
32384
32385 .section "The VRFY and EXPN commands" "SECID237"
32386 When Exim receives a VRFY or EXPN command on a TCP/IP connection, it
32387 runs the ACL specified by &%acl_smtp_vrfy%& or &%acl_smtp_expn%& (as
32388 appropriate) in order to decide whether the command should be accepted or not.
32389 If no ACL is defined, the command is rejected.
32390
32391 .cindex "VRFY" "processing"
32392 When VRFY is accepted, it runs exactly the same code as when Exim is
32393 called with the &%-bv%& option.
32394
32395 .cindex "EXPN" "processing"
32396 When EXPN is accepted, a single-level expansion of the address is done.
32397 EXPN is treated as an &"address test"& (similar to the &%-bt%& option) rather
32398 than a verification (the &%-bv%& option). If an unqualified local part is given
32399 as the argument to EXPN, it is qualified with &%qualify_domain%&. Rejections
32400 of VRFY and EXPN commands are logged on the main and reject logs, and
32401 VRFY verification failures are logged on the main log for consistency with
32402 RCPT failures.
32403
32404
32405
32406 .section "The ETRN command" "SECTETRN"
32407 .cindex "ETRN" "processing"
32408 RFC 1985 describes an SMTP command called ETRN that is designed to
32409 overcome the security problems of the TURN command (which has fallen into
32410 disuse). When Exim receives an ETRN command on a TCP/IP connection, it runs
32411 the ACL specified by &%acl_smtp_etrn%& in order to decide whether the command
32412 should be accepted or not. If no ACL is defined, the command is rejected.
32413
32414 The ETRN command is concerned with &"releasing"& messages that are awaiting
32415 delivery to certain hosts. As Exim does not organize its message queue by host,
32416 the only form of ETRN that is supported by default is the one where the
32417 text starts with the &"#"& prefix, in which case the remainder of the text is
32418 specific to the SMTP server. A valid ETRN command causes a run of Exim with
32419 the &%-R%& option to happen, with the remainder of the ETRN text as its
32420 argument. For example,
32421 .code
32422 ETRN #brigadoon
32423 .endd
32424 runs the command
32425 .code
32426 exim -R brigadoon
32427 .endd
32428 which causes a delivery attempt on all messages with undelivered addresses
32429 containing the text &"brigadoon"&. When &%smtp_etrn_serialize%& is set (the
32430 default), Exim prevents the simultaneous execution of more than one queue run
32431 for the same argument string as a result of an ETRN command. This stops
32432 a misbehaving client from starting more than one queue runner at once.
32433
32434 .cindex "hints database" "ETRN serialization"
32435 Exim implements the serialization by means of a hints database in which a
32436 record is written whenever a process is started by ETRN, and deleted when
32437 the process completes. However, Exim does not keep the SMTP session waiting for
32438 the ETRN process to complete. Once ETRN is accepted, the client is sent
32439 a &"success"& return code. Obviously there is scope for hints records to get
32440 left lying around if there is a system or program crash. To guard against this,
32441 Exim ignores any records that are more than six hours old.
32442
32443 .oindex "&%smtp_etrn_command%&"
32444 For more control over what ETRN does, the &%smtp_etrn_command%& option can
32445 used. This specifies a command that is run whenever ETRN is received,
32446 whatever the form of its argument. For
32447 example:
32448 .code
32449 smtp_etrn_command = /etc/etrn_command $domain \
32450                     $sender_host_address
32451 .endd
32452 .vindex "&$domain$&"
32453 The string is split up into arguments which are independently expanded. The
32454 expansion variable &$domain$& is set to the argument of the ETRN command,
32455 and no syntax checking is done on the contents of this argument. Exim does not
32456 wait for the command to complete, so its status code is not checked. Exim runs
32457 under its own uid and gid when receiving incoming SMTP, so it is not possible
32458 for it to change them before running the command.
32459
32460
32461
32462 .section "Incoming local SMTP" "SECID238"
32463 .cindex "SMTP" "local incoming"
32464 Some user agents use SMTP to pass messages to their local MTA using the
32465 standard input and output, as opposed to passing the envelope on the command
32466 line and writing the message to the standard input. This is supported by the
32467 &%-bs%& option. This form of SMTP is handled in the same way as incoming
32468 messages over TCP/IP (including the use of ACLs), except that the envelope
32469 sender given in a MAIL command is ignored unless the caller is trusted. In
32470 an ACL you can detect this form of SMTP input by testing for an empty host
32471 identification. It is common to have this as the first line in the ACL that
32472 runs for RCPT commands:
32473 .code
32474 accept hosts = :
32475 .endd
32476 This accepts SMTP messages from local processes without doing any other tests.
32477
32478
32479
32480 .section "Outgoing batched SMTP" "SECTbatchSMTP"
32481 .cindex "SMTP" "batched outgoing"
32482 .cindex "batched SMTP output"
32483 Both the &(appendfile)& and &(pipe)& transports can be used for handling
32484 batched SMTP. Each has an option called &%use_bsmtp%& which causes messages to
32485 be output in BSMTP format. No SMTP responses are possible for this form of
32486 delivery. All it is doing is using SMTP commands as a way of transmitting the
32487 envelope along with the message.
32488
32489 The message is written to the file or pipe preceded by the SMTP commands
32490 MAIL and RCPT, and followed by a line containing a single dot. Lines in
32491 the message that start with a dot have an extra dot added. The SMTP command
32492 HELO is not normally used. If it is required, the &%message_prefix%& option
32493 can be used to specify it.
32494
32495 Because &(appendfile)& and &(pipe)& are both local transports, they accept only
32496 one recipient address at a time by default. However, you can arrange for them
32497 to handle several addresses at once by setting the &%batch_max%& option. When
32498 this is done for BSMTP, messages may contain multiple RCPT commands. See
32499 chapter &<<CHAPbatching>>& for more details.
32500
32501 .vindex "&$host$&"
32502 When one or more addresses are routed to a BSMTP transport by a router that
32503 sets up a host list, the name of the first host on the list is available to the
32504 transport in the variable &$host$&. Here is an example of such a transport and
32505 router:
32506 .code
32507 begin routers
32508 route_append:
32509   driver = manualroute
32510   transport = smtp_appendfile
32511   route_list = domain.example  batch.host.example
32512
32513 begin transports
32514 smtp_appendfile:
32515   driver = appendfile
32516   directory = /var/bsmtp/$host
32517   batch_max = 1000
32518   use_bsmtp
32519   user = exim
32520 .endd
32521 This causes messages addressed to &'domain.example'& to be written in BSMTP
32522 format to &_/var/bsmtp/batch.host.example_&, with only a single copy of each
32523 message (unless there are more than 1000 recipients).
32524
32525
32526
32527 .section "Incoming batched SMTP" "SECTincomingbatchedSMTP"
32528 .cindex "SMTP" "batched incoming"
32529 .cindex "batched SMTP input"
32530 The &%-bS%& command line option causes Exim to accept one or more messages by
32531 reading SMTP on the standard input, but to generate no responses. If the caller
32532 is trusted, the senders in the MAIL commands are believed; otherwise the
32533 sender is always the caller of Exim. Unqualified senders and receivers are not
32534 rejected (there seems little point) but instead just get qualified. HELO
32535 and EHLO act as RSET; VRFY, EXPN, ETRN and  HELP, act
32536 as NOOP; QUIT quits.
32537
32538 Minimal policy checking is done for BSMTP input. Only the non-SMTP
32539 ACL is run in the same way as for non-SMTP local input.
32540
32541 If an error is detected while reading a message, including a missing &"."& at
32542 the end, Exim gives up immediately. It writes details of the error to the
32543 standard output in a stylized way that the calling program should be able to
32544 make some use of automatically, for example:
32545 .code
32546 554 Unexpected end of file
32547 Transaction started in line 10
32548 Error detected in line 14
32549 .endd
32550 It writes a more verbose version, for human consumption, to the standard error
32551 file, for example:
32552 .code
32553 An error was detected while processing a file of BSMTP input.
32554 The error message was:
32555
32556 501 '>' missing at end of address
32557
32558 The SMTP transaction started in line 10.
32559 The error was detected in line 12.
32560 The SMTP command at fault was:
32561
32562 rcpt to:<malformed@in.com.plete
32563
32564 1 previous message was successfully processed.
32565 The rest of the batch was abandoned.
32566 .endd
32567 The return code from Exim is zero only if there were no errors. It is 1 if some
32568 messages were accepted before an error was detected, and 2 if no messages were
32569 accepted.
32570 .ecindex IIDsmtpproc1
32571 .ecindex IIDsmtpproc2
32572
32573
32574
32575 . ////////////////////////////////////////////////////////////////////////////
32576 . ////////////////////////////////////////////////////////////////////////////
32577
32578 .chapter "Customizing bounce and warning messages" "CHAPemsgcust" &&&
32579          "Customizing messages"
32580 When a message fails to be delivered, or remains on the queue for more than a
32581 configured amount of time, Exim sends a message to the original sender, or
32582 to an alternative configured address. The text of these messages is built into
32583 the code of Exim, but it is possible to change it, either by adding a single
32584 string, or by replacing each of the paragraphs by text supplied in a file.
32585
32586 The &'From:'& and &'To:'& header lines are automatically generated; you can
32587 cause a &'Reply-To:'& line to be added by setting the &%errors_reply_to%&
32588 option. Exim also adds the line
32589 .code
32590 Auto-Submitted: auto-generated
32591 .endd
32592 to all warning and bounce messages,
32593
32594
32595 .section "Customizing bounce messages" "SECID239"
32596 .cindex "customizing" "bounce message"
32597 .cindex "bounce message" "customizing"
32598 If &%bounce_message_text%& is set, its contents are included in the default
32599 message immediately after &"This message was created automatically by mail
32600 delivery software."& The string is not expanded. It is not used if
32601 &%bounce_message_file%& is set.
32602
32603 When &%bounce_message_file%& is set, it must point to a template file for
32604 constructing error messages. The file consists of a series of text items,
32605 separated by lines consisting of exactly four asterisks. If the file cannot be
32606 opened, default text is used and a message is written to the main and panic
32607 logs. If any text item in the file is empty, default text is used for that
32608 item.
32609
32610 .vindex "&$bounce_recipient$&"
32611 .vindex "&$bounce_return_size_limit$&"
32612 Each item of text that is read from the file is expanded, and there are two
32613 expansion variables which can be of use here: &$bounce_recipient$& is set to
32614 the recipient of an error message while it is being created, and
32615 &$bounce_return_size_limit$& contains the value of the &%return_size_limit%&
32616 option, rounded to a whole number.
32617
32618 The items must appear in the file in the following order:
32619
32620 .ilist
32621 The first item is included in the headers, and should include at least a
32622 &'Subject:'& header. Exim does not check the syntax of these headers.
32623 .next
32624 The second item forms the start of the error message. After it, Exim lists the
32625 failing addresses with their error messages.
32626 .next
32627 The third item is used to introduce any text from pipe transports that is to be
32628 returned to the sender. It is omitted if there is no such text.
32629 .next
32630 The fourth item is used to introduce the copy of the message that is returned
32631 as part of the error report.
32632 .next
32633 The fifth item is added after the fourth one if the returned message is
32634 truncated because it is bigger than &%return_size_limit%&.
32635 .next
32636 The sixth item is added after the copy of the original message.
32637 .endlist
32638
32639 The default state (&%bounce_message_file%& unset) is equivalent to the
32640 following file, in which the sixth item is empty. The &'Subject:'& and some
32641 other lines have been split in order to fit them on the page:
32642 .code
32643 Subject: Mail delivery failed
32644   ${if eq{$sender_address}{$bounce_recipient}
32645   {: returning message to sender}}
32646 ****
32647 This message was created automatically by mail delivery software.
32648
32649 A message ${if eq{$sender_address}{$bounce_recipient}
32650   {that you sent }{sent by
32651
32652 <$sender_address>
32653
32654 }}could not be delivered to all of its recipients.
32655 This is a permanent error. The following address(es) failed:
32656 ****
32657 The following text was generated during the delivery attempt(s):
32658 ****
32659 ------ This is a copy of the message, including all the headers.
32660   ------
32661 ****
32662 ------ The body of the message is $message_size characters long;
32663   only the first
32664 ------ $bounce_return_size_limit or so are included here.
32665 ****
32666 .endd
32667 .section "Customizing warning messages" "SECTcustwarn"
32668 .cindex "customizing" "warning message"
32669 .cindex "warning of delay" "customizing the message"
32670 The option &%warn_message_file%& can be pointed at a template file for use when
32671 warnings about message delays are created. In this case there are only three
32672 text sections:
32673
32674 .ilist
32675 The first item is included in the headers, and should include at least a
32676 &'Subject:'& header. Exim does not check the syntax of these headers.
32677 .next
32678 The second item forms the start of the warning message. After it, Exim lists
32679 the delayed addresses.
32680 .next
32681 The third item then ends the message.
32682 .endlist
32683
32684 The default state is equivalent to the following file, except that some lines
32685 have been split here, in order to fit them on the page:
32686 .code
32687 Subject: Warning: message $message_exim_id delayed
32688   $warn_message_delay
32689 ****
32690 This message was created automatically by mail delivery software.
32691
32692 A message ${if eq{$sender_address}{$warn_message_recipients}
32693 {that you sent }{sent by
32694
32695 <$sender_address>
32696
32697 }}has not been delivered to all of its recipients after
32698 more than $warn_message_delay on the queue on $primary_hostname.
32699
32700 The message identifier is:     $message_exim_id
32701 The subject of the message is: $h_subject
32702 The date of the message is:    $h_date
32703
32704 The following address(es) have not yet been delivered:
32705 ****
32706 No action is required on your part. Delivery attempts will
32707 continue for some time, and this warning may be repeated at
32708 intervals if the message remains undelivered. Eventually the
32709 mail delivery software will give up, and when that happens,
32710 the message will be returned to you.
32711 .endd
32712 .vindex "&$warn_message_delay$&"
32713 .vindex "&$warn_message_recipients$&"
32714 However, in the default state the subject and date lines are omitted if no
32715 appropriate headers exist. During the expansion of this file,
32716 &$warn_message_delay$& is set to the delay time in one of the forms &"<&'n'&>
32717 minutes"& or &"<&'n'&> hours"&, and &$warn_message_recipients$& contains a list
32718 of recipients for the warning message. There may be more than one if there are
32719 multiple addresses with different &%errors_to%& settings on the routers that
32720 handled them.
32721
32722
32723
32724
32725 . ////////////////////////////////////////////////////////////////////////////
32726 . ////////////////////////////////////////////////////////////////////////////
32727
32728 .chapter "Some common configuration settings" "CHAPcomconreq"
32729 This chapter discusses some configuration settings that seem to be fairly
32730 common. More examples and discussion can be found in the Exim book.
32731
32732
32733
32734 .section "Sending mail to a smart host" "SECID240"
32735 .cindex "smart host" "example router"
32736 If you want to send all mail for non-local domains to a &"smart host"&, you
32737 should replace the default &(dnslookup)& router with a router which does the
32738 routing explicitly:
32739 .code
32740 send_to_smart_host:
32741   driver = manualroute
32742   route_list = !+local_domains smart.host.name
32743   transport = remote_smtp
32744 .endd
32745 You can use the smart host's IP address instead of the name if you wish.
32746 If you are using Exim only to submit messages to a smart host, and not for
32747 receiving incoming messages, you can arrange for it to do the submission
32748 synchronously by setting the &%mua_wrapper%& option (see chapter
32749 &<<CHAPnonqueueing>>&).
32750
32751
32752
32753
32754 .section "Using Exim to handle mailing lists" "SECTmailinglists"
32755 .cindex "mailing lists"
32756 Exim can be used to run simple mailing lists, but for large and/or complicated
32757 requirements, the use of additional specialized mailing list software such as
32758 Majordomo or Mailman is recommended.
32759
32760 The &(redirect)& router can be used to handle mailing lists where each list
32761 is maintained in a separate file, which can therefore be managed by an
32762 independent manager. The &%domains%& router option can be used to run these
32763 lists in a separate domain from normal mail. For example:
32764 .code
32765 lists:
32766   driver = redirect
32767   domains = lists.example
32768   file = /usr/lists/$local_part
32769   forbid_pipe
32770   forbid_file
32771   errors_to = $local_part-request@lists.example
32772   no_more
32773 .endd
32774 This router is skipped for domains other than &'lists.example'&. For addresses
32775 in that domain, it looks for a file that matches the local part. If there is no
32776 such file, the router declines, but because &%no_more%& is set, no subsequent
32777 routers are tried, and so the whole delivery fails.
32778
32779 The &%forbid_pipe%& and &%forbid_file%& options prevent a local part from being
32780 expanded into a file name or a pipe delivery, which is usually inappropriate in
32781 a mailing list.
32782
32783 .oindex "&%errors_to%&"
32784 The &%errors_to%& option specifies that any delivery errors caused by addresses
32785 taken from a mailing list are to be sent to the given address rather than the
32786 original sender of the message. However, before acting on this, Exim verifies
32787 the error address, and ignores it if verification fails.
32788
32789 For example, using the configuration above, mail sent to
32790 &'dicts@lists.example'& is passed on to those addresses contained in
32791 &_/usr/lists/dicts_&, with error reports directed to
32792 &'dicts-request@lists.example'&, provided that this address can be verified.
32793 There could be a file called &_/usr/lists/dicts-request_& containing
32794 the address(es) of this particular list's manager(s), but other approaches,
32795 such as setting up an earlier router (possibly using the &%local_part_prefix%&
32796 or &%local_part_suffix%& options) to handle addresses of the form
32797 &%owner-%&&'xxx'& or &%xxx-%&&'request'&, are also possible.
32798
32799
32800
32801 .section "Syntax errors in mailing lists" "SECID241"
32802 .cindex "mailing lists" "syntax errors in"
32803 If an entry in redirection data contains a syntax error, Exim normally defers
32804 delivery of the original address. That means that a syntax error in a mailing
32805 list holds up all deliveries to the list. This may not be appropriate when a
32806 list is being maintained automatically from data supplied by users, and the
32807 addresses are not rigorously checked.
32808
32809 If the &%skip_syntax_errors%& option is set, the &(redirect)& router just skips
32810 entries that fail to parse, noting the incident in the log. If in addition
32811 &%syntax_errors_to%& is set to a verifiable address, a message is sent to it
32812 whenever a broken address is skipped. It is usually appropriate to set
32813 &%syntax_errors_to%& to the same address as &%errors_to%&.
32814
32815
32816
32817 .section "Re-expansion of mailing lists" "SECID242"
32818 .cindex "mailing lists" "re-expansion of"
32819 Exim remembers every individual address to which a message has been delivered,
32820 in order to avoid duplication, but it normally stores only the original
32821 recipient addresses with a message. If all the deliveries to a mailing list
32822 cannot be done at the first attempt, the mailing list is re-expanded when the
32823 delivery is next tried. This means that alterations to the list are taken into
32824 account at each delivery attempt, so addresses that have been added to
32825 the list since the message arrived will therefore receive a copy of the
32826 message, even though it pre-dates their subscription.
32827
32828 If this behaviour is felt to be undesirable, the &%one_time%& option can be set
32829 on the &(redirect)& router. If this is done, any addresses generated by the
32830 router that fail to deliver at the first attempt are added to the message as
32831 &"top level"& addresses, and the parent address that generated them is marked
32832 &"delivered"&. Thus, expansion of the mailing list does not happen again at the
32833 subsequent delivery attempts. The disadvantage of this is that if any of the
32834 failing addresses are incorrect, correcting them in the file has no effect on
32835 pre-existing messages.
32836
32837 The original top-level address is remembered with each of the generated
32838 addresses, and is output in any log messages. However, any intermediate parent
32839 addresses are not recorded. This makes a difference to the log only if the
32840 &%all_parents%& selector is set, but for mailing lists there is normally only
32841 one level of expansion anyway.
32842
32843
32844
32845 .section "Closed mailing lists" "SECID243"
32846 .cindex "mailing lists" "closed"
32847 The examples so far have assumed open mailing lists, to which anybody may
32848 send mail. It is also possible to set up closed lists, where mail is accepted
32849 from specified senders only. This is done by making use of the generic
32850 &%senders%& option to restrict the router that handles the list.
32851
32852 The following example uses the same file as a list of recipients and as a list
32853 of permitted senders. It requires three routers:
32854 .code
32855 lists_request:
32856   driver = redirect
32857   domains = lists.example
32858   local_part_suffix = -request
32859   file = /usr/lists/$local_part$local_part_suffix
32860   no_more
32861
32862 lists_post:
32863   driver = redirect
32864   domains = lists.example
32865   senders = ${if exists {/usr/lists/$local_part}\
32866              {lsearch;/usr/lists/$local_part}{*}}
32867   file = /usr/lists/$local_part
32868   forbid_pipe
32869   forbid_file
32870   errors_to = $local_part-request@lists.example
32871   no_more
32872
32873 lists_closed:
32874   driver = redirect
32875   domains = lists.example
32876   allow_fail
32877   data = :fail: $local_part@lists.example is a closed mailing list
32878 .endd
32879 All three routers have the same &%domains%& setting, so for any other domains,
32880 they are all skipped. The first router runs only if the local part ends in
32881 &%-request%&. It handles messages to the list manager(s) by means of an open
32882 mailing list.
32883
32884 The second router runs only if the &%senders%& precondition is satisfied. It
32885 checks for the existence of a list that corresponds to the local part, and then
32886 checks that the sender is on the list by means of a linear search. It is
32887 necessary to check for the existence of the file before trying to search it,
32888 because otherwise Exim thinks there is a configuration error. If the file does
32889 not exist, the expansion of &%senders%& is *, which matches all senders. This
32890 means that the router runs, but because there is no list, declines, and
32891 &%no_more%& ensures that no further routers are run. The address fails with an
32892 &"unrouteable address"& error.
32893
32894 The third router runs only if the second router is skipped, which happens when
32895 a mailing list exists, but the sender is not on it. This router forcibly fails
32896 the address, giving a suitable error message.
32897
32898
32899
32900
32901 .section "Variable Envelope Return Paths (VERP)" "SECTverp"
32902 .cindex "VERP"
32903 .cindex "Variable Envelope Return Paths"
32904 .cindex "envelope sender"
32905 Variable Envelope Return Paths &-- see &url(http://cr.yp.to/proto/verp.txt) &--
32906 are a way of helping mailing list administrators discover which subscription
32907 address is the cause of a particular delivery failure. The idea is to encode
32908 the original recipient address in the outgoing envelope sender address, so that
32909 if the message is forwarded by another host and then subsequently bounces, the
32910 original recipient can be extracted from the recipient address of the bounce.
32911
32912 .oindex &%errors_to%&
32913 .oindex &%return_path%&
32914 Envelope sender addresses can be modified by Exim using two different
32915 facilities: the &%errors_to%& option on a router (as shown in previous mailing
32916 list examples), or the &%return_path%& option on a transport. The second of
32917 these is effective only if the message is successfully delivered to another
32918 host; it is not used for errors detected on the local host (see the description
32919 of &%return_path%& in chapter &<<CHAPtransportgeneric>>&). Here is an example
32920 of the use of &%return_path%& to implement VERP on an &(smtp)& transport:
32921 .code
32922 verp_smtp:
32923   driver = smtp
32924   max_rcpt = 1
32925   return_path = \
32926     ${if match {$return_path}{^(.+?)-request@your.dom.example\$}\
32927       {$1-request+$local_part=$domain@your.dom.example}fail}
32928 .endd
32929 This has the effect of rewriting the return path (envelope sender) on outgoing
32930 SMTP messages, if the local part of the original return path ends in
32931 &"-request"&, and the domain is &'your.dom.example'&. The rewriting inserts the
32932 local part and domain of the recipient into the return path. Suppose, for
32933 example, that a message whose return path has been set to
32934 &'somelist-request@your.dom.example'& is sent to
32935 &'subscriber@other.dom.example'&. In the transport, the return path is
32936 rewritten as
32937 .code
32938 somelist-request+subscriber=other.dom.example@your.dom.example
32939 .endd
32940 .vindex "&$local_part$&"
32941 For this to work, you must tell Exim to send multiple copies of messages that
32942 have more than one recipient, so that each copy has just one recipient. This is
32943 achieved by setting &%max_rcpt%& to 1. Without this, a single copy of a message
32944 might be sent to several different recipients in the same domain, in which case
32945 &$local_part$& is not available in the transport, because it is not unique.
32946
32947 Unless your host is doing nothing but mailing list deliveries, you should
32948 probably use a separate transport for the VERP deliveries, so as not to use
32949 extra resources in making one-per-recipient copies for other deliveries. This
32950 can easily be done by expanding the &%transport%& option in the router:
32951 .code
32952 dnslookup:
32953   driver = dnslookup
32954   domains = ! +local_domains
32955   transport = \
32956     ${if match {$return_path}{^(.+?)-request@your.dom.example\$}\
32957       {verp_smtp}{remote_smtp}}
32958   no_more
32959 .endd
32960 If you want to change the return path using &%errors_to%& in a router instead
32961 of using &%return_path%& in the transport, you need to set &%errors_to%& on all
32962 routers that handle mailing list addresses. This will ensure that all delivery
32963 errors, including those detected on the local host, are sent to the VERP
32964 address.
32965
32966 On a host that does no local deliveries and has no manual routing, only the
32967 &(dnslookup)& router needs to be changed. A special transport is not needed for
32968 SMTP deliveries. Every mailing list recipient has its own return path value,
32969 and so Exim must hand them to the transport one at a time. Here is an example
32970 of a &(dnslookup)& router that implements VERP:
32971 .code
32972 verp_dnslookup:
32973   driver = dnslookup
32974   domains = ! +local_domains
32975   transport = remote_smtp
32976   errors_to = \
32977     ${if match {$return_path}{^(.+?)-request@your.dom.example\$}}
32978      {$1-request+$local_part=$domain@your.dom.example}fail}
32979   no_more
32980 .endd
32981 Before you start sending out messages with VERPed return paths, you must also
32982 configure Exim to accept the bounce messages that come back to those paths.
32983 Typically this is done by setting a &%local_part_suffix%& option for a
32984 router, and using this to route the messages to wherever you want to handle
32985 them.
32986
32987 The overhead incurred in using VERP depends very much on the size of the
32988 message, the number of recipient addresses that resolve to the same remote
32989 host, and the speed of the connection over which the message is being sent. If
32990 a lot of addresses resolve to the same host and the connection is slow, sending
32991 a separate copy of the message for each address may take substantially longer
32992 than sending a single copy with many recipients (for which VERP cannot be
32993 used).
32994
32995
32996
32997
32998
32999
33000 .section "Virtual domains" "SECTvirtualdomains"
33001 .cindex "virtual domains"
33002 .cindex "domain" "virtual"
33003 The phrase &'virtual domain'& is unfortunately used with two rather different
33004 meanings:
33005
33006 .ilist
33007 A domain for which there are no real mailboxes; all valid local parts are
33008 aliases for other email addresses. Common examples are organizational
33009 top-level domains and &"vanity"& domains.
33010 .next
33011 One of a number of independent domains that are all handled by the same host,
33012 with mailboxes on that host, but where the mailbox owners do not necessarily
33013 have login accounts on that host.
33014 .endlist
33015
33016 The first usage is probably more common, and does seem more &"virtual"& than
33017 the second. This kind of domain can be handled in Exim with a straightforward
33018 aliasing router. One approach is to create a separate alias file for each
33019 virtual domain. Exim can test for the existence of the alias file to determine
33020 whether the domain exists. The &(dsearch)& lookup type is useful here, leading
33021 to a router of this form:
33022 .code
33023 virtual:
33024   driver = redirect
33025   domains = dsearch;/etc/mail/virtual
33026   data = ${lookup{$local_part}lsearch{/etc/mail/virtual/$domain}}
33027   no_more
33028 .endd
33029 The &%domains%& option specifies that the router is to be skipped, unless there
33030 is a file in the &_/etc/mail/virtual_& directory whose name is the same as the
33031 domain that is being processed. When the router runs, it looks up the local
33032 part in the file to find a new address (or list of addresses). The &%no_more%&
33033 setting ensures that if the lookup fails (leading to &%data%& being an empty
33034 string), Exim gives up on the address without trying any subsequent routers.
33035
33036 This one router can handle all the virtual domains because the alias file names
33037 follow a fixed pattern. Permissions can be arranged so that appropriate people
33038 can edit the different alias files. A successful aliasing operation results in
33039 a new envelope recipient address, which is then routed from scratch.
33040
33041 The other kind of &"virtual"& domain can also be handled in a straightforward
33042 way. One approach is to create a file for each domain containing a list of
33043 valid local parts, and use it in a router like this:
33044 .code
33045 my_domains:
33046   driver = accept
33047   domains = dsearch;/etc/mail/domains
33048   local_parts = lsearch;/etc/mail/domains/$domain
33049   transport = my_mailboxes
33050 .endd
33051 The address is accepted if there is a file for the domain, and the local part
33052 can be found in the file. The &%domains%& option is used to check for the
33053 file's existence because &%domains%& is tested before the &%local_parts%&
33054 option (see section &<<SECTrouprecon>>&). You cannot use &%require_files%&,
33055 because that option is tested after &%local_parts%&. The transport is as
33056 follows:
33057 .code
33058 my_mailboxes:
33059   driver = appendfile
33060   file = /var/mail/$domain/$local_part
33061   user = mail
33062 .endd
33063 This uses a directory of mailboxes for each domain. The &%user%& setting is
33064 required, to specify which uid is to be used for writing to the mailboxes.
33065
33066 The configuration shown here is just one example of how you might support this
33067 requirement. There are many other ways this kind of configuration can be set
33068 up, for example, by using a database instead of separate files to hold all the
33069 information about the domains.
33070
33071
33072
33073 .section "Multiple user mailboxes" "SECTmulbox"
33074 .cindex "multiple mailboxes"
33075 .cindex "mailbox" "multiple"
33076 .cindex "local part" "prefix"
33077 .cindex "local part" "suffix"
33078 Heavy email users often want to operate with multiple mailboxes, into which
33079 incoming mail is automatically sorted. A popular way of handling this is to
33080 allow users to use multiple sender addresses, so that replies can easily be
33081 identified. Users are permitted to add prefixes or suffixes to their local
33082 parts for this purpose. The wildcard facility of the generic router options
33083 &%local_part_prefix%& and &%local_part_suffix%& can be used for this. For
33084 example, consider this router:
33085 .code
33086 userforward:
33087   driver = redirect
33088   check_local_user
33089   file = $home/.forward
33090   local_part_suffix = -*
33091   local_part_suffix_optional
33092   allow_filter
33093 .endd
33094 .vindex "&$local_part_suffix$&"
33095 It runs a user's &_.forward_& file for all local parts of the form
33096 &'username-*'&. Within the filter file the user can distinguish different
33097 cases by testing the variable &$local_part_suffix$&. For example:
33098 .code
33099 if $local_part_suffix contains -special then
33100 save /home/$local_part/Mail/special
33101 endif
33102 .endd
33103 If the filter file does not exist, or does not deal with such addresses, they
33104 fall through to subsequent routers, and, assuming no subsequent use of the
33105 &%local_part_suffix%& option is made, they presumably fail. Thus, users have
33106 control over which suffixes are valid.
33107
33108 Alternatively, a suffix can be used to trigger the use of a different
33109 &_.forward_& file &-- which is the way a similar facility is implemented in
33110 another MTA:
33111 .code
33112 userforward:
33113   driver = redirect
33114   check_local_user
33115   file = $home/.forward$local_part_suffix
33116   local_part_suffix = -*
33117   local_part_suffix_optional
33118   allow_filter
33119 .endd
33120 If there is no suffix, &_.forward_& is used; if the suffix is &'-special'&, for
33121 example, &_.forward-special_& is used. Once again, if the appropriate file
33122 does not exist, or does not deal with the address, it is passed on to
33123 subsequent routers, which could, if required, look for an unqualified
33124 &_.forward_& file to use as a default.
33125
33126
33127
33128 .section "Simplified vacation processing" "SECID244"
33129 .cindex "vacation processing"
33130 The traditional way of running the &'vacation'& program is for a user to set up
33131 a pipe command in a &_.forward_& file
33132 (see section &<<SECTspecitredli>>& for syntax details).
33133 This is prone to error by inexperienced users. There are two features of Exim
33134 that can be used to make this process simpler for users:
33135
33136 .ilist
33137 A local part prefix such as &"vacation-"& can be specified on a router which
33138 can cause the message to be delivered directly to the &'vacation'& program, or
33139 alternatively can use Exim's &(autoreply)& transport. The contents of a user's
33140 &_.forward_& file are then much simpler. For example:
33141 .code
33142 spqr, vacation-spqr
33143 .endd
33144 .next
33145 The &%require_files%& generic router option can be used to trigger a
33146 vacation delivery by checking for the existence of a certain file in the
33147 user's home directory. The &%unseen%& generic option should also be used, to
33148 ensure that the original delivery also proceeds. In this case, all the user has
33149 to do is to create a file called, say, &_.vacation_&, containing a vacation
33150 message.
33151 .endlist
33152
33153 Another advantage of both these methods is that they both work even when the
33154 use of arbitrary pipes by users is locked out.
33155
33156
33157
33158 .section "Taking copies of mail" "SECID245"
33159 .cindex "message" "copying every"
33160 Some installations have policies that require archive copies of all messages to
33161 be made. A single copy of each message can easily be taken by an appropriate
33162 command in a system filter, which could, for example, use a different file for
33163 each day's messages.
33164
33165 There is also a shadow transport mechanism that can be used to take copies of
33166 messages that are successfully delivered by local transports, one copy per
33167 delivery. This could be used, &'inter alia'&, to implement automatic
33168 notification of delivery by sites that insist on doing such things.
33169
33170
33171
33172 .section "Intermittently connected hosts" "SECID246"
33173 .cindex "intermittently connected hosts"
33174 It has become quite common (because it is cheaper) for hosts to connect to the
33175 Internet periodically rather than remain connected all the time. The normal
33176 arrangement is that mail for such hosts accumulates on a system that is
33177 permanently connected.
33178
33179 Exim was designed for use on permanently connected hosts, and so it is not
33180 particularly well-suited to use in an intermittently connected environment.
33181 Nevertheless there are some features that can be used.
33182
33183
33184 .section "Exim on the upstream server host" "SECID247"
33185 It is tempting to arrange for incoming mail for the intermittently connected
33186 host to remain on Exim's queue until the client connects. However, this
33187 approach does not scale very well. Two different kinds of waiting message are
33188 being mixed up in the same queue &-- those that cannot be delivered because of
33189 some temporary problem, and those that are waiting for their destination host
33190 to connect. This makes it hard to manage the queue, as well as wasting
33191 resources, because each queue runner scans the entire queue.
33192
33193 A better approach is to separate off those messages that are waiting for an
33194 intermittently connected host. This can be done by delivering these messages
33195 into local files in batch SMTP, &"mailstore"&, or other envelope-preserving
33196 format, from where they are transmitted by other software when their
33197 destination connects. This makes it easy to collect all the mail for one host
33198 in a single directory, and to apply local timeout rules on a per-message basis
33199 if required.
33200
33201 On a very small scale, leaving the mail on Exim's queue can be made to work. If
33202 you are doing this, you should configure Exim with a long retry period for the
33203 intermittent host. For example:
33204 .code
33205 cheshire.wonderland.fict.example    *   F,5d,24h
33206 .endd
33207 This stops a lot of failed delivery attempts from occurring, but Exim remembers
33208 which messages it has queued up for that host. Once the intermittent host comes
33209 online, forcing delivery of one message (either by using the &%-M%& or &%-R%&
33210 options, or by using the ETRN SMTP command (see section &<<SECTETRN>>&)
33211 causes all the queued up messages to be delivered, often down a single SMTP
33212 connection. While the host remains connected, any new messages get delivered
33213 immediately.
33214
33215 If the connecting hosts do not have fixed IP addresses, that is, if a host is
33216 issued with a different IP address each time it connects, Exim's retry
33217 mechanisms on the holding host get confused, because the IP address is normally
33218 used as part of the key string for holding retry information. This can be
33219 avoided by unsetting &%retry_include_ip_address%& on the &(smtp)& transport.
33220 Since this has disadvantages for permanently connected hosts, it is best to
33221 arrange a separate transport for the intermittently connected ones.
33222
33223
33224
33225 .section "Exim on the intermittently connected client host" "SECID248"
33226 The value of &%smtp_accept_queue_per_connection%& should probably be
33227 increased, or even set to zero (that is, disabled) on the intermittently
33228 connected host, so that all incoming messages down a single connection get
33229 delivered immediately.
33230
33231 .cindex "SMTP" "passed connection"
33232 .cindex "SMTP" "multiple deliveries"
33233 .cindex "multiple SMTP deliveries"
33234 Mail waiting to be sent from an intermittently connected host will probably
33235 not have been routed, because without a connection DNS lookups are not
33236 possible. This means that if a normal queue run is done at connection time,
33237 each message is likely to be sent in a separate SMTP session. This can be
33238 avoided by starting the queue run with a command line option beginning with
33239 &%-qq%& instead of &%-q%&. In this case, the queue is scanned twice. In the
33240 first pass, routing is done but no deliveries take place. The second pass is a
33241 normal queue run; since all the messages have been previously routed, those
33242 destined for the same host are likely to get sent as multiple deliveries in a
33243 single SMTP connection.
33244
33245
33246
33247 . ////////////////////////////////////////////////////////////////////////////
33248 . ////////////////////////////////////////////////////////////////////////////
33249
33250 .chapter "Using Exim as a non-queueing client" "CHAPnonqueueing" &&&
33251          "Exim as a non-queueing client"
33252 .cindex "client, non-queueing"
33253 .cindex "smart host" "suppressing queueing"
33254 On a personal computer, it is a common requirement for all
33255 email to be sent to a &"smart host"&. There are plenty of MUAs that can be
33256 configured to operate that way, for all the popular operating systems.
33257 However, there are some MUAs for Unix-like systems that cannot be so
33258 configured: they submit messages using the command line interface of
33259 &_/usr/sbin/sendmail_&. Furthermore, utility programs such as &'cron'& submit
33260 messages this way.
33261
33262 If the personal computer runs continuously, there is no problem, because it can
33263 run a conventional MTA that handles delivery to the smart host, and deal with
33264 any delays via its queueing mechanism. However, if the computer does not run
33265 continuously or runs different operating systems at different times, queueing
33266 email is not desirable.
33267
33268 There is therefore a requirement for something that can provide the
33269 &_/usr/sbin/sendmail_& interface but deliver messages to a smart host without
33270 any queueing or retrying facilities. Furthermore, the delivery to the smart
33271 host should be synchronous, so that if it fails, the sending MUA is immediately
33272 informed. In other words, we want something that extends an MUA that submits
33273 to a local MTA via the command line so that it behaves like one that submits
33274 to a remote smart host using TCP/SMTP.
33275
33276 There are a number of applications (for example, there is one called &'ssmtp'&)
33277 that do this job. However, people have found them to be lacking in various
33278 ways. For instance, you might want to allow aliasing and forwarding to be done
33279 before sending a message to the smart host.
33280
33281 Exim already had the necessary infrastructure for doing this job. Just a few
33282 tweaks were needed to make it behave as required, though it is somewhat of an
33283 overkill to use a fully-featured MTA for this purpose.
33284
33285 .oindex "&%mua_wrapper%&"
33286 There is a Boolean global option called &%mua_wrapper%&, defaulting false.
33287 Setting &%mua_wrapper%& true causes Exim to run in a special mode where it
33288 assumes that it is being used to &"wrap"& a command-line MUA in the manner
33289 just described. As well as setting &%mua_wrapper%&, you also need to provide a
33290 compatible router and transport configuration. Typically there will be just one
33291 router and one transport, sending everything to a smart host.
33292
33293 When run in MUA wrapping mode, the behaviour of Exim changes in the
33294 following ways:
33295
33296 .ilist
33297 A daemon cannot be run, nor will Exim accept incoming messages from &'inetd'&.
33298 In other words, the only way to submit messages is via the command line.
33299 .next
33300 Each message is synchronously delivered as soon as it is received (&%-odi%& is
33301 assumed). All queueing options (&%queue_only%&, &%queue_smtp_domains%&,
33302 &%control%& in an ACL, etc.) are quietly ignored. The Exim reception process
33303 does not finish until the delivery attempt is complete. If the delivery is
33304 successful, a zero return code is given.
33305 .next
33306 Address redirection is permitted, but the final routing for all addresses must
33307 be to the same remote transport, and to the same list of hosts. Furthermore,
33308 the return address (envelope sender) must be the same for all recipients, as
33309 must any added or deleted header lines. In other words, it must be possible to
33310 deliver the message in a single SMTP transaction, however many recipients there
33311 are.
33312 .next
33313 If these conditions are not met, or if routing any address results in a
33314 failure or defer status, or if Exim is unable to deliver all the recipients
33315 successfully to one of the smart hosts, delivery of the entire message fails.
33316 .next
33317 Because no queueing is allowed, all failures are treated as permanent; there
33318 is no distinction between 4&'xx'& and 5&'xx'& SMTP response codes from the
33319 smart host. Furthermore, because only a single yes/no response can be given to
33320 the caller, it is not possible to deliver to some recipients and not others. If
33321 there is an error (temporary or permanent) for any recipient, all are failed.
33322 .next
33323 If more than one smart host is listed, Exim will try another host after a
33324 connection failure or a timeout, in the normal way. However, if this kind of
33325 failure happens for all the hosts, the delivery fails.
33326 .next
33327 When delivery fails, an error message is written to the standard error stream
33328 (as well as to Exim's log), and Exim exits to the caller with a return code
33329 value 1. The message is expunged from Exim's spool files. No bounce messages
33330 are ever generated.
33331 .next
33332 No retry data is maintained, and any retry rules are ignored.
33333 .next
33334 A number of Exim options are overridden: &%deliver_drop_privilege%& is forced
33335 true, &%max_rcpt%& in the &(smtp)& transport is forced to &"unlimited"&,
33336 &%remote_max_parallel%& is forced to one, and fallback hosts are ignored.
33337 .endlist
33338
33339 The overall effect is that Exim makes a single synchronous attempt to deliver
33340 the message, failing if there is any kind of problem. Because no local
33341 deliveries are done and no daemon can be run, Exim does not need root
33342 privilege. It should be possible to run it setuid to &'exim'& instead of setuid
33343 to &'root'&. See section &<<SECTrunexiwitpri>>& for a general discussion about
33344 the advantages and disadvantages of running without root privilege.
33345
33346
33347
33348
33349 . ////////////////////////////////////////////////////////////////////////////
33350 . ////////////////////////////////////////////////////////////////////////////
33351
33352 .chapter "Log files" "CHAPlog"
33353 .scindex IIDloggen "log" "general description"
33354 .cindex "log" "types of"
33355 Exim writes three different logs, referred to as the main log, the reject log,
33356 and the panic log:
33357
33358 .ilist
33359 .cindex "main log"
33360 The main log records the arrival of each message and each delivery in a single
33361 line in each case. The format is as compact as possible, in an attempt to keep
33362 down the size of log files. Two-character flag sequences make it easy to pick
33363 out these lines. A number of other events are recorded in the main log. Some of
33364 them are optional, in which case the &%log_selector%& option controls whether
33365 they are included or not. A Perl script called &'eximstats'&, which does simple
33366 analysis of main log files, is provided in the Exim distribution (see section
33367 &<<SECTmailstat>>&).
33368 .next
33369 .cindex "reject log"
33370 The reject log records information from messages that are rejected as a result
33371 of a configuration option (that is, for policy reasons).
33372 The first line of each rejection is a copy of the line that is also written to
33373 the main log. Then, if the message's header has been read at the time the log
33374 is written, its contents are written to this log. Only the original header
33375 lines are available; header lines added by ACLs are not logged. You can use the
33376 reject log to check that your policy controls are working correctly; on a busy
33377 host this may be easier than scanning the main log for rejection messages. You
33378 can suppress the writing of the reject log by setting &%write_rejectlog%&
33379 false.
33380 .next
33381 .cindex "panic log"
33382 .cindex "system log"
33383 When certain serious errors occur, Exim writes entries to its panic log. If the
33384 error is sufficiently disastrous, Exim bombs out afterwards. Panic log entries
33385 are usually written to the main log as well, but can get lost amid the mass of
33386 other entries. The panic log should be empty under normal circumstances. It is
33387 therefore a good idea to check it (or to have a &'cron'& script check it)
33388 regularly, in order to become aware of any problems. When Exim cannot open its
33389 panic log, it tries as a last resort to write to the system log (syslog). This
33390 is opened with LOG_PID+LOG_CONS and the facility code of LOG_MAIL. The
33391 message itself is written at priority LOG_CRIT.
33392 .endlist
33393
33394 Every log line starts with a timestamp, in the format shown in the following
33395 example. Note that many of the examples shown in this chapter are line-wrapped.
33396 In the log file, this would be all on one line:
33397 .code
33398 2001-09-16 16:09:47 SMTP connection from [127.0.0.1] closed
33399   by QUIT
33400 .endd
33401 By default, the timestamps are in the local timezone. There are two
33402 ways of changing this:
33403
33404 .ilist
33405 You can set the &%timezone%& option to a different time zone; in particular, if
33406 you set
33407 .code
33408 timezone = UTC
33409 .endd
33410 the timestamps will be in UTC (aka GMT).
33411 .next
33412 If you set &%log_timezone%& true, the time zone is added to the timestamp, for
33413 example:
33414 .code
33415 2003-04-25 11:17:07 +0100 Start queue run: pid=12762
33416 .endd
33417 .endlist
33418
33419 .cindex "log" "process ids in"
33420 .cindex "pid (process id)" "in log lines"
33421 Exim does not include its process id in log lines by default, but you can
33422 request that it does so by specifying the &`pid`& log selector (see section
33423 &<<SECTlogselector>>&). When this is set, the process id is output, in square
33424 brackets, immediately after the time and date.
33425
33426
33427
33428
33429 .section "Where the logs are written" "SECTwhelogwri"
33430 .cindex "log" "destination"
33431 .cindex "log" "to file"
33432 .cindex "log" "to syslog"
33433 .cindex "syslog"
33434 The logs may be written to local files, or to syslog, or both. However, it
33435 should be noted that many syslog implementations use UDP as a transport, and
33436 are therefore unreliable in the sense that messages are not guaranteed to
33437 arrive at the loghost, nor is the ordering of messages necessarily maintained.
33438 It has also been reported that on large log files (tens of megabytes) you may
33439 need to tweak syslog to prevent it syncing the file with each write &-- on
33440 Linux this has been seen to make syslog take 90% plus of CPU time.
33441
33442 The destination for Exim's logs is configured by setting LOG_FILE_PATH in
33443 &_Local/Makefile_& or by setting &%log_file_path%& in the run time
33444 configuration. This latter string is expanded, so it can contain, for example,
33445 references to the host name:
33446 .code
33447 log_file_path = /var/log/$primary_hostname/exim_%slog
33448 .endd
33449 It is generally advisable, however, to set the string in &_Local/Makefile_&
33450 rather than at run time, because then the setting is available right from the
33451 start of Exim's execution. Otherwise, if there's something it wants to log
33452 before it has read the configuration file (for example, an error in the
33453 configuration file) it will not use the path you want, and may not be able to
33454 log at all.
33455
33456 The value of LOG_FILE_PATH or &%log_file_path%& is a colon-separated
33457 list, currently limited to at most two items. This is one option where the
33458 facility for changing a list separator may not be used. The list must always be
33459 colon-separated. If an item in the list is &"syslog"& then syslog is used;
33460 otherwise the item must either be an absolute path, containing &`%s`& at the
33461 point where &"main"&, &"reject"&, or &"panic"& is to be inserted, or be empty,
33462 implying the use of a default path.
33463
33464 When Exim encounters an empty item in the list, it searches the list defined by
33465 LOG_FILE_PATH, and uses the first item it finds that is neither empty nor
33466 &"syslog"&. This means that an empty item in &%log_file_path%& can be used to
33467 mean &"use the path specified at build time"&. It no such item exists, log
33468 files are written in the &_log_& subdirectory of the spool directory. This is
33469 equivalent to the setting:
33470 .code
33471 log_file_path = $spool_directory/log/%slog
33472 .endd
33473 If you do not specify anything at build time or run time, that is where the
33474 logs are written.
33475
33476 A log file path may also contain &`%D`& or &`%M`& if datestamped log file names
33477 are in use &-- see section &<<SECTdatlogfil>>& below.
33478
33479 Here are some examples of possible settings:
33480 .display
33481 &`LOG_FILE_PATH=syslog                    `& syslog only
33482 &`LOG_FILE_PATH=:syslog                   `& syslog and default path
33483 &`LOG_FILE_PATH=syslog : /usr/log/exim_%s `& syslog and specified path
33484 &`LOG_FILE_PATH=/usr/log/exim_%s          `& specified path only
33485 .endd
33486 If there are more than two paths in the list, the first is used and a panic
33487 error is logged.
33488
33489
33490
33491 .section "Logging to local files that are periodically &""cycled""&" "SECID285"
33492 .cindex "log" "cycling local files"
33493 .cindex "cycling logs"
33494 .cindex "&'exicyclog'&"
33495 .cindex "log" "local files; writing to"
33496 Some operating systems provide centralized and standardized methods for cycling
33497 log files. For those that do not, a utility script called &'exicyclog'& is
33498 provided (see section &<<SECTcyclogfil>>&). This renames and compresses the
33499 main and reject logs each time it is called. The maximum number of old logs to
33500 keep can be set. It is suggested this script is run as a daily &'cron'& job.
33501
33502 An Exim delivery process opens the main log when it first needs to write to it,
33503 and it keeps the file open in case subsequent entries are required &-- for
33504 example, if a number of different deliveries are being done for the same
33505 message. However, remote SMTP deliveries can take a long time, and this means
33506 that the file may be kept open long after it is renamed if &'exicyclog'& or
33507 something similar is being used to rename log files on a regular basis. To
33508 ensure that a switch of log files is noticed as soon as possible, Exim calls
33509 &[stat()]& on the main log's name before reusing an open file, and if the file
33510 does not exist, or its inode has changed, the old file is closed and Exim
33511 tries to open the main log from scratch. Thus, an old log file may remain open
33512 for quite some time, but no Exim processes should write to it once it has been
33513 renamed.
33514
33515
33516
33517 .section "Datestamped log files" "SECTdatlogfil"
33518 .cindex "log" "datestamped files"
33519 Instead of cycling the main and reject log files by renaming them
33520 periodically, some sites like to use files whose names contain a datestamp,
33521 for example, &_mainlog-20031225_&. The datestamp is in the form &_yyyymmdd_& or
33522 &_yyyymm_&. Exim has support for this way of working. It is enabled by setting
33523 the &%log_file_path%& option to a path that includes &`%D`& or &`%M`& at the
33524 point where the datestamp is required. For example:
33525 .code
33526 log_file_path = /var/spool/exim/log/%slog-%D
33527 log_file_path = /var/log/exim-%s-%D.log
33528 log_file_path = /var/spool/exim/log/%D-%slog
33529 log_file_path = /var/log/exim/%s.%M
33530 .endd
33531 As before, &`%s`& is replaced by &"main"& or &"reject"&; the following are
33532 examples of names generated by the above examples:
33533 .code
33534 /var/spool/exim/log/mainlog-20021225
33535 /var/log/exim-reject-20021225.log
33536 /var/spool/exim/log/20021225-mainlog
33537 /var/log/exim/main.200212
33538 .endd
33539 When this form of log file is specified, Exim automatically switches to new
33540 files at midnight. It does not make any attempt to compress old logs; you
33541 will need to write your own script if you require this. You should not
33542 run &'exicyclog'& with this form of logging.
33543
33544 The location of the panic log is also determined by &%log_file_path%&, but it
33545 is not datestamped, because rotation of the panic log does not make sense.
33546 When generating the name of the panic log, &`%D`& or &`%M`& are removed from
33547 the string. In addition, if it immediately follows a slash, a following
33548 non-alphanumeric character is removed; otherwise a preceding non-alphanumeric
33549 character is removed. Thus, the four examples above would give these panic
33550 log names:
33551 .code
33552 /var/spool/exim/log/paniclog
33553 /var/log/exim-panic.log
33554 /var/spool/exim/log/paniclog
33555 /var/log/exim/panic
33556 .endd
33557
33558
33559 .section "Logging to syslog" "SECID249"
33560 .cindex "log" "syslog; writing to"
33561 The use of syslog does not change what Exim logs or the format of its messages,
33562 except in one respect. If &%syslog_timestamp%& is set false, the timestamps on
33563 Exim's log lines are omitted when these lines are sent to syslog. Apart from
33564 that, the same strings are written to syslog as to log files. The syslog
33565 &"facility"& is set to LOG_MAIL, and the program name to &"exim"&
33566 by default, but you can change these by setting the &%syslog_facility%& and
33567 &%syslog_processname%& options, respectively. If Exim was compiled with
33568 SYSLOG_LOG_PID set in &_Local/Makefile_& (this is the default in
33569 &_src/EDITME_&), then, on systems that permit it (all except ULTRIX), the
33570 LOG_PID flag is set so that the &[syslog()]& call adds the pid as well as
33571 the time and host name to each line.
33572 The three log streams are mapped onto syslog priorities as follows:
33573
33574 .ilist
33575 &'mainlog'& is mapped to LOG_INFO
33576 .next
33577 &'rejectlog'& is mapped to LOG_NOTICE
33578 .next
33579 &'paniclog'& is mapped to LOG_ALERT
33580 .endlist
33581
33582 Many log lines are written to both &'mainlog'& and &'rejectlog'&, and some are
33583 written to both &'mainlog'& and &'paniclog'&, so there will be duplicates if
33584 these are routed by syslog to the same place. You can suppress this duplication
33585 by setting &%syslog_duplication%& false.
33586
33587 Exim's log lines can sometimes be very long, and some of its &'rejectlog'&
33588 entries contain multiple lines when headers are included. To cope with both
33589 these cases, entries written to syslog are split into separate &[syslog()]&
33590 calls at each internal newline, and also after a maximum of
33591 870 data characters. (This allows for a total syslog line length of 1024, when
33592 additions such as timestamps are added.) If you are running a syslog
33593 replacement that can handle lines longer than the 1024 characters allowed by
33594 RFC 3164, you should set
33595 .code
33596 SYSLOG_LONG_LINES=yes
33597 .endd
33598 in &_Local/Makefile_& before building Exim. That stops Exim from splitting long
33599 lines, but it still splits at internal newlines in &'reject'& log entries.
33600
33601 To make it easy to re-assemble split lines later, each component of a split
33602 entry starts with a string of the form [<&'n'&>/<&'m'&>] or [<&'n'&>\<&'m'&>]
33603 where <&'n'&> is the component number and <&'m'&> is the total number of
33604 components in the entry. The / delimiter is used when the line was split
33605 because it was too long; if it was split because of an internal newline, the \
33606 delimiter is used. For example, supposing the length limit to be 50 instead of
33607 870, the following would be the result of a typical rejection message to
33608 &'mainlog'& (LOG_INFO), each line in addition being preceded by the time, host
33609 name, and pid as added by syslog:
33610 .code
33611 [1/5] 2002-09-16 16:09:43 16RdAL-0006pc-00 rejected from
33612 [2/5]  [127.0.0.1] (ph10): syntax error in 'From' header
33613 [3/5]  when scanning for sender: missing or malformed lo
33614 [4/5] cal part in "<>" (envelope sender is <ph10@cam.exa
33615 [5/5] mple>)
33616 .endd
33617 The same error might cause the following lines to be written to &"rejectlog"&
33618 (LOG_NOTICE):
33619 .code
33620 [1/18] 2002-09-16 16:09:43 16RdAL-0006pc-00 rejected fro
33621 [2/18] m [127.0.0.1] (ph10): syntax error in 'From' head
33622 [3/18] er when scanning for sender: missing or malformed
33623 [4/18]  local part in "<>" (envelope sender is <ph10@cam
33624 [5\18] .example>)
33625 [6\18] Recipients: ph10@some.domain.cam.example
33626 [7\18] P Received: from [127.0.0.1] (ident=ph10)
33627 [8\18]        by xxxxx.cam.example with smtp (Exim 4.00)
33628 [9\18]        id 16RdAL-0006pc-00
33629 [10/18]        for ph10@cam.example; Mon, 16 Sep 2002 16:
33630 [11\18] 09:43 +0100
33631 [12\18] F From: <>
33632 [13\18]   Subject: this is a test header
33633 [18\18]   X-something: this is another header
33634 [15/18] I Message-Id: <E16RdAL-0006pc-00@xxxxx.cam.examp
33635 [16\18] le>
33636 [17\18] B Bcc:
33637 [18/18]   Date: Mon, 16 Sep 2002 16:09:43 +0100
33638 .endd
33639 Log lines that are neither too long nor contain newlines are written to syslog
33640 without modification.
33641
33642 If only syslog is being used, the Exim monitor is unable to provide a log tail
33643 display, unless syslog is routing &'mainlog'& to a file on the local host and
33644 the environment variable EXIMON_LOG_FILE_PATH is set to tell the monitor
33645 where it is.
33646
33647
33648
33649 .section "Log line flags" "SECID250"
33650 One line is written to the main log for each message received, and for each
33651 successful, unsuccessful, and delayed delivery. These lines can readily be
33652 picked out by the distinctive two-character flags that immediately follow the
33653 timestamp. The flags are:
33654 .display
33655 &`<=`&     message arrival
33656 &`=>`&     normal message delivery
33657 &`->`&     additional address in same delivery
33658 &`>>`&     cutthrough message delivery
33659 &`*>`&     delivery suppressed by &%-N%&
33660 &`**`&     delivery failed; address bounced
33661 &`==`&     delivery deferred; temporary problem
33662 .endd
33663
33664
33665 .section "Logging message reception" "SECID251"
33666 .cindex "log" "reception line"
33667 The format of the single-line entry in the main log that is written for every
33668 message received is shown in the basic example below, which is split over
33669 several lines in order to fit it on the page:
33670 .code
33671 2002-10-31 08:57:53 16ZCW1-0005MB-00 <= kryten@dwarf.fict.example
33672   H=mailer.fict.example [192.168.123.123] U=exim
33673   P=smtp S=5678 id=<incoming message id>
33674 .endd
33675 The address immediately following &"<="& is the envelope sender address. A
33676 bounce message is shown with the sender address &"<>"&, and if it is locally
33677 generated, this is followed by an item of the form
33678 .code
33679 R=<message id>
33680 .endd
33681 which is a reference to the message that caused the bounce to be sent.
33682
33683 .cindex "HELO"
33684 .cindex "EHLO"
33685 For messages from other hosts, the H and U fields identify the remote host and
33686 record the RFC 1413 identity of the user that sent the message, if one was
33687 received. The number given in square brackets is the IP address of the sending
33688 host. If there is a single, unparenthesized  host name in the H field, as
33689 above, it has been verified to correspond to the IP address (see the
33690 &%host_lookup%& option). If the name is in parentheses, it was the name quoted
33691 by the remote host in the SMTP HELO or EHLO command, and has not been
33692 verified. If verification yields a different name to that given for HELO or
33693 EHLO, the verified name appears first, followed by the HELO or EHLO
33694 name in parentheses.
33695
33696 Misconfigured hosts (and mail forgers) sometimes put an IP address, with or
33697 without brackets, in the HELO or EHLO command, leading to entries in
33698 the log containing text like these examples:
33699 .code
33700 H=(10.21.32.43) [192.168.8.34]
33701 H=([10.21.32.43]) [192.168.8.34]
33702 .endd
33703 This can be confusing. Only the final address in square brackets can be relied
33704 on.
33705
33706 For locally generated messages (that is, messages not received over TCP/IP),
33707 the H field is omitted, and the U field contains the login name of the caller
33708 of Exim.
33709
33710 .cindex "authentication" "logging"
33711 .cindex "AUTH" "logging"
33712 For all messages, the P field specifies the protocol used to receive the
33713 message. This is the value that is stored in &$received_protocol$&. In the case
33714 of incoming SMTP messages, the value indicates whether or not any SMTP
33715 extensions (ESMTP), encryption, or authentication were used. If the SMTP
33716 session was encrypted, there is an additional X field that records the cipher
33717 suite that was used.
33718
33719 The protocol is set to &"esmtpsa"& or &"esmtpa"& for messages received from
33720 hosts that have authenticated themselves using the SMTP AUTH command. The first
33721 value is used when the SMTP connection was encrypted (&"secure"&). In this case
33722 there is an additional item A= followed by the name of the authenticator that
33723 was used. If an authenticated identification was set up by the authenticator's
33724 &%server_set_id%& option, this is logged too, separated by a colon from the
33725 authenticator name.
33726
33727 .cindex "size" "of message"
33728 The id field records the existing message id, if present. The size of the
33729 received message is given by the S field. When the message is delivered,
33730 headers may be removed or added, so that the size of delivered copies of the
33731 message may not correspond with this value (and indeed may be different to each
33732 other).
33733
33734 The &%log_selector%& option can be used to request the logging of additional
33735 data when a message is received. See section &<<SECTlogselector>>& below.
33736
33737
33738
33739 .section "Logging deliveries" "SECID252"
33740 .cindex "log" "delivery line"
33741 The format of the single-line entry in the main log that is written for every
33742 delivery is shown in one of the examples below, for local and remote
33743 deliveries, respectively. Each example has been split into two lines in order
33744 to fit it on the page:
33745 .code
33746 2002-10-31 08:59:13 16ZCW1-0005MB-00 => marv
33747   <marv@hitch.fict.example> R=localuser T=local_delivery
33748 2002-10-31 09:00:10 16ZCW1-0005MB-00 =>
33749   monk@holistic.fict.example R=dnslookup T=remote_smtp
33750   H=holistic.fict.example [192.168.234.234]
33751 .endd
33752 For ordinary local deliveries, the original address is given in angle brackets
33753 after the final delivery address, which might be a pipe or a file. If
33754 intermediate address(es) exist between the original and the final address, the
33755 last of these is given in parentheses after the final address. The R and T
33756 fields record the router and transport that were used to process the address.
33757
33758 If SMTP AUTH was used for the delivery there is an additional item A=
33759 followed by the name of the authenticator that was used.
33760 If an authenticated identification was set up by the authenticator's &%client_set_id%&
33761 option, this is logged too, separated by a colon from the authenticator name.
33762
33763 If a shadow transport was run after a successful local delivery, the log line
33764 for the successful delivery has an item added on the end, of the form
33765 .display
33766 &`ST=<`&&'shadow transport name'&&`>`&
33767 .endd
33768 If the shadow transport did not succeed, the error message is put in
33769 parentheses afterwards.
33770
33771 .cindex "asterisk" "after IP address"
33772 When more than one address is included in a single delivery (for example, two
33773 SMTP RCPT commands in one transaction) the second and subsequent addresses are
33774 flagged with &`->`& instead of &`=>`&. When two or more messages are delivered
33775 down a single SMTP connection, an asterisk follows the IP address in the log
33776 lines for the second and subsequent messages.
33777
33778 .cindex "delivery" "cutthrough; logging"
33779 .cindex "cutthrough" "logging"
33780 When delivery is done in cutthrough mode it is flagged with &`>>`& and the log
33781 line precedes the reception line, since cutthrough waits for a possible
33782 rejection from the destination in case it can reject the sourced item.
33783
33784 The generation of a reply message by a filter file gets logged as a
33785 &"delivery"& to the addressee, preceded by &">"&.
33786
33787 The &%log_selector%& option can be used to request the logging of additional
33788 data when a message is delivered. See section &<<SECTlogselector>>& below.
33789
33790
33791 .section "Discarded deliveries" "SECID253"
33792 .cindex "discarded messages"
33793 .cindex "message" "discarded"
33794 .cindex "delivery" "discarded; logging"
33795 When a message is discarded as a result of the command &"seen finish"& being
33796 obeyed in a filter file which generates no deliveries, a log entry of the form
33797 .code
33798 2002-12-10 00:50:49 16auJc-0001UB-00 => discarded
33799   <low.club@bridge.example> R=userforward
33800 .endd
33801 is written, to record why no deliveries are logged. When a message is discarded
33802 because it is aliased to &":blackhole:"& the log line is like this:
33803 .code
33804 1999-03-02 09:44:33 10HmaX-0005vi-00 => :blackhole:
33805   <hole@nowhere.example> R=blackhole_router
33806 .endd
33807
33808
33809 .section "Deferred deliveries" "SECID254"
33810 When a delivery is deferred, a line of the following form is logged:
33811 .code
33812 2002-12-19 16:20:23 16aiQz-0002Q5-00 == marvin@endrest.example
33813   R=dnslookup T=smtp defer (146): Connection refused
33814 .endd
33815 In the case of remote deliveries, the error is the one that was given for the
33816 last IP address that was tried. Details of individual SMTP failures are also
33817 written to the log, so the above line would be preceded by something like
33818 .code
33819 2002-12-19 16:20:23 16aiQz-0002Q5-00 Failed to connect to
33820   mail1.endrest.example [192.168.239.239]: Connection refused
33821 .endd
33822 When a deferred address is skipped because its retry time has not been reached,
33823 a message is written to the log, but this can be suppressed by setting an
33824 appropriate value in &%log_selector%&.
33825
33826
33827
33828 .section "Delivery failures" "SECID255"
33829 .cindex "delivery" "failure; logging"
33830 If a delivery fails because an address cannot be routed, a line of the
33831 following form is logged:
33832 .code
33833 1995-12-19 16:20:23 0tRiQz-0002Q5-00 ** jim@trek99.example
33834   <jim@trek99.example>: unknown mail domain
33835 .endd
33836 If a delivery fails at transport time, the router and transport are shown, and
33837 the response from the remote host is included, as in this example:
33838 .code
33839 2002-07-11 07:14:17 17SXDU-000189-00 ** ace400@pb.example
33840   R=dnslookup T=remote_smtp: SMTP error from remote mailer
33841   after pipelined RCPT TO:<ace400@pb.example>: host
33842   pbmail3.py.example [192.168.63.111]: 553 5.3.0
33843   <ace400@pb.example>...Addressee unknown
33844 .endd
33845 The word &"pipelined"& indicates that the SMTP PIPELINING extension was being
33846 used. See &%hosts_avoid_esmtp%& in the &(smtp)& transport for a way of
33847 disabling PIPELINING. The log lines for all forms of delivery failure are
33848 flagged with &`**`&.
33849
33850
33851
33852 .section "Fake deliveries" "SECID256"
33853 .cindex "delivery" "fake; logging"
33854 If a delivery does not actually take place because the &%-N%& option has been
33855 used to suppress it, a normal delivery line is written to the log, except that
33856 &"=>"& is replaced by &"*>"&.
33857
33858
33859
33860 .section "Completion" "SECID257"
33861 A line of the form
33862 .code
33863 2002-10-31 09:00:11 16ZCW1-0005MB-00 Completed
33864 .endd
33865 is written to the main log when a message is about to be removed from the spool
33866 at the end of its processing.
33867
33868
33869
33870
33871 .section "Summary of Fields in Log Lines" "SECID258"
33872 .cindex "log" "summary of fields"
33873 A summary of the field identifiers that are used in log lines is shown in
33874 the following table:
33875 .display
33876 &`A   `&        authenticator name (and optional id and sender)
33877 &`C   `&        SMTP confirmation on delivery
33878 &`    `&        command list for &"no mail in SMTP session"&
33879 &`CV  `&        certificate verification status
33880 &`D   `&        duration of &"no mail in SMTP session"&
33881 &`DN  `&        distinguished name from peer certificate
33882 &`DT  `&        on &`=>`& lines: time taken for a delivery
33883 &`F   `&        sender address (on delivery lines)
33884 &`H   `&        host name and IP address
33885 &`I   `&        local interface used
33886 &`id  `&        message id for incoming message
33887 &`P   `&        on &`<=`& lines: protocol used
33888 &`    `&        on &`=>`& and &`**`& lines: return path
33889 &`QT  `&        on &`=>`& lines: time spent on queue so far
33890 &`    `&        on &"Completed"& lines: time spent on queue
33891 &`R   `&        on &`<=`& lines: reference for local bounce
33892 &`    `&        on &`=>`&  &`**`& and &`==`& lines: router name
33893 &`S   `&        size of message
33894 &`ST  `&        shadow transport name
33895 &`T   `&        on &`<=`& lines: message subject (topic)
33896 &`    `&        on &`=>`& &`**`& and &`==`& lines: transport name
33897 &`U   `&        local user or RFC 1413 identity
33898 &`X   `&        TLS cipher suite
33899 .endd
33900
33901
33902 .section "Other log entries" "SECID259"
33903 Various other types of log entry are written from time to time. Most should be
33904 self-explanatory. Among the more common are:
33905
33906 .ilist
33907 .cindex "retry" "time not reached"
33908 &'retry time not reached'&&~&~An address previously suffered a temporary error
33909 during routing or local delivery, and the time to retry has not yet arrived.
33910 This message is not written to an individual message log file unless it happens
33911 during the first delivery attempt.
33912 .next
33913 &'retry time not reached for any host'&&~&~An address previously suffered
33914 temporary errors during remote delivery, and the retry time has not yet arrived
33915 for any of the hosts to which it is routed.
33916 .next
33917 .cindex "spool directory" "file locked"
33918 &'spool file locked'&&~&~An attempt to deliver a message cannot proceed because
33919 some other Exim process is already working on the message. This can be quite
33920 common if queue running processes are started at frequent intervals. The
33921 &'exiwhat'& utility script can be used to find out what Exim processes are
33922 doing.
33923 .next
33924 .cindex "error" "ignored"
33925 &'error ignored'&&~&~There are several circumstances that give rise to this
33926 message:
33927 .olist
33928 Exim failed to deliver a bounce message whose age was greater than
33929 &%ignore_bounce_errors_after%&. The bounce was discarded.
33930 .next
33931 A filter file set up a delivery using the &"noerror"& option, and the delivery
33932 failed. The delivery was discarded.
33933 .next
33934 A delivery set up by a router configured with
33935 . ==== As this is a nested list, any displays it contains must be indented
33936 . ==== as otherwise they are too far to the left.
33937 .code
33938     errors_to = <>
33939 .endd
33940 failed. The delivery was discarded.
33941 .endlist olist
33942 .endlist ilist
33943
33944
33945
33946
33947
33948 .section "Reducing or increasing what is logged" "SECTlogselector"
33949 .cindex "log" "selectors"
33950 By setting the &%log_selector%& global option, you can disable some of Exim's
33951 default logging, or you can request additional logging. The value of
33952 &%log_selector%& is made up of names preceded by plus or minus characters. For
33953 example:
33954 .code
33955 log_selector = +arguments -retry_defer
33956 .endd
33957 The list of optional log items is in the following table, with the default
33958 selection marked by asterisks:
33959 .display
33960 &` 8bitmime                   `&  received 8BITMIME status
33961 &`*acl_warn_skipped           `&  skipped &%warn%& statement in ACL
33962 &` address_rewrite            `&  address rewriting
33963 &` all_parents                `&  all parents in => lines
33964 &` arguments                  `&  command line arguments
33965 &`*connection_reject          `&  connection rejections
33966 &`*delay_delivery             `&  immediate delivery delayed
33967 &` deliver_time               `&  time taken to perform delivery
33968 &` delivery_size              `&  add &`S=`&&'nnn'& to => lines
33969 &`*dnslist_defer              `&  defers of DNS list (aka RBL) lookups
33970 &`*etrn                       `&  ETRN commands
33971 &`*host_lookup_failed         `&  as it says
33972 &` ident_timeout              `&  timeout for ident connection
33973 &` incoming_interface         `&  incoming interface on <= lines
33974 &` incoming_port              `&  incoming port on <= lines
33975 &`*lost_incoming_connection   `&  as it says (includes timeouts)
33976 &` outgoing_port              `&  add remote port to => lines
33977 &`*queue_run                  `&  start and end queue runs
33978 &` queue_time                 `&  time on queue for one recipient
33979 &` queue_time_overall         `&  time on queue for whole message
33980 &` pid                        `&  Exim process id
33981 &` received_recipients        `&  recipients on <= lines
33982 &` received_sender            `&  sender on <= lines
33983 &`*rejected_header            `&  header contents on reject log
33984 &`*retry_defer                `&  &"retry time not reached"&
33985 &` return_path_on_delivery    `&  put return path on => and ** lines
33986 &` sender_on_delivery         `&  add sender to => lines
33987 &`*sender_verify_fail         `&  sender verification failures
33988 &`*size_reject                `&  rejection because too big
33989 &`*skip_delivery              `&  delivery skipped in a queue run
33990 &`*smtp_confirmation          `&  SMTP confirmation on => lines
33991 &` smtp_connection            `&  SMTP connections
33992 &` smtp_incomplete_transaction`&  incomplete SMTP transactions
33993 &` smtp_mailauth              `&  AUTH argument to MAIL commands
33994 &` smtp_no_mail               `&  session with no MAIL commands
33995 &` smtp_protocol_error        `&  SMTP protocol errors
33996 &` smtp_syntax_error          `&  SMTP syntax errors
33997 &` subject                    `&  contents of &'Subject:'& on <= lines
33998 &` tls_certificate_verified   `&  certificate verification status
33999 &`*tls_cipher                 `&  TLS cipher suite on <= and => lines
34000 &` tls_peerdn                 `&  TLS peer DN on <= and => lines
34001 &` tls_sni                    `&  TLS SNI on <= lines
34002 &` unknown_in_list            `&  DNS lookup failed in list match
34003
34004 &` all                        `&  all of the above
34005 .endd
34006 More details on each of these items follows:
34007
34008 .ilist
34009 .cindex "8BITMIME"
34010 .cindex "log" "8BITMIME"
34011 &%8bitmime%&: This causes Exim to log any 8BITMIME status of received messages,
34012 which may help in tracking down interoperability issues with ancient MTAs
34013 that are not 8bit clean.  This is added to the &"<="& line, tagged with
34014 &`M8S=`& and a value of &`0`&, &`7`& or &`8`&, corresponding to "not given",
34015 &`7BIT`& and &`8BITMIME`& respectively.
34016 .next
34017 .cindex "&%warn%& ACL verb" "log when skipping"
34018 &%acl_warn_skipped%&: When an ACL &%warn%& statement is skipped because one of
34019 its conditions cannot be evaluated, a log line to this effect is written if
34020 this log selector is set.
34021 .next
34022 .cindex "log" "rewriting"
34023 .cindex "rewriting" "logging"
34024 &%address_rewrite%&: This applies both to global rewrites and per-transport
34025 rewrites, but not to rewrites in filters run as an unprivileged user (because
34026 such users cannot access the log).
34027 .next
34028 .cindex "log" "full parentage"
34029 &%all_parents%&: Normally only the original and final addresses are logged on
34030 delivery lines; with this selector, intermediate parents are given in
34031 parentheses between them.
34032 .next
34033 .cindex "log" "Exim arguments"
34034 .cindex "Exim arguments, logging"
34035 &%arguments%&: This causes Exim to write the arguments with which it was called
34036 to the main log, preceded by the current working directory. This is a debugging
34037 feature, added to make it easier to find out how certain MUAs call
34038 &_/usr/sbin/sendmail_&. The logging does not happen if Exim has given up root
34039 privilege because it was called with the &%-C%& or &%-D%& options. Arguments
34040 that are empty or that contain white space are quoted. Non-printing characters
34041 are shown as escape sequences. This facility cannot log unrecognized arguments,
34042 because the arguments are checked before the configuration file is read. The
34043 only way to log such cases is to interpose a script such as &_util/logargs.sh_&
34044 between the caller and Exim.
34045 .next
34046 .cindex "log" "connection rejections"
34047 &%connection_reject%&: A log entry is written whenever an incoming SMTP
34048 connection is rejected, for whatever reason.
34049 .next
34050 .cindex "log" "delayed delivery"
34051 .cindex "delayed delivery, logging"
34052 &%delay_delivery%&: A log entry is written whenever a delivery process is not
34053 started for an incoming message because the load is too high or too many
34054 messages were received on one connection. Logging does not occur if no delivery
34055 process is started because &%queue_only%& is set or &%-odq%& was used.
34056 .next
34057 .cindex "log" "delivery duration"
34058 &%deliver_time%&: For each delivery, the amount of real time it has taken to
34059 perform the actual delivery is logged as DT=<&'time'&>, for example, &`DT=1s`&.
34060 .next
34061 .cindex "log" "message size on delivery"
34062 .cindex "size" "of message"
34063 &%delivery_size%&: For each delivery, the size of message delivered is added to
34064 the &"=>"& line, tagged with S=.
34065 .next
34066 .cindex "log" "dnslist defer"
34067 .cindex "DNS list" "logging defer"
34068 .cindex "black list (DNS)"
34069 &%dnslist_defer%&: A log entry is written if an attempt to look up a host in a
34070 DNS black list suffers a temporary error.
34071 .next
34072 .cindex "log" "ETRN commands"
34073 .cindex "ETRN" "logging"
34074 &%etrn%&: Every valid ETRN command that is received is logged, before the ACL
34075 is run to determine whether or not it is actually accepted. An invalid ETRN
34076 command, or one received within a message transaction is not logged by this
34077 selector (see &%smtp_syntax_error%& and &%smtp_protocol_error%&).
34078 .next
34079 .cindex "log" "host lookup failure"
34080 &%host_lookup_failed%&: When a lookup of a host's IP addresses fails to find
34081 any addresses, or when a lookup of an IP address fails to find a host name, a
34082 log line is written. This logging does not apply to direct DNS lookups when
34083 routing email addresses, but it does apply to &"byname"& lookups.
34084 .next
34085 .cindex "log" "ident timeout"
34086 .cindex "RFC 1413" "logging timeout"
34087 &%ident_timeout%&: A log line is written whenever an attempt to connect to a
34088 client's ident port times out.
34089 .next
34090 .cindex "log" "incoming interface"
34091 .cindex "interface" "logging"
34092 &%incoming_interface%&: The interface on which a message was received is added
34093 to the &"<="& line as an IP address in square brackets, tagged by I= and
34094 followed by a colon and the port number. The local interface and port are also
34095 added to other SMTP log lines, for example &"SMTP connection from"&, and to
34096 rejection lines.
34097 .next
34098 .cindex "log" "incoming remote port"
34099 .cindex "port" "logging remote"
34100 .cindex "TCP/IP" "logging incoming remote port"
34101 .vindex "&$sender_fullhost$&"
34102 .vindex "&$sender_rcvhost$&"
34103 &%incoming_port%&: The remote port number from which a message was received is
34104 added to log entries and &'Received:'& header lines, following the IP address
34105 in square brackets, and separated from it by a colon. This is implemented by
34106 changing the value that is put in the &$sender_fullhost$& and
34107 &$sender_rcvhost$& variables. Recording the remote port number has become more
34108 important with the widening use of NAT (see RFC 2505).
34109 .next
34110 .cindex "log" "dropped connection"
34111 &%lost_incoming_connection%&: A log line is written when an incoming SMTP
34112 connection is unexpectedly dropped.
34113 .next
34114 .cindex "log" "outgoing remote port"
34115 .cindex "port" "logging outgoint remote"
34116 .cindex "TCP/IP" "logging ougtoing remote port"
34117 &%outgoing_port%&: The remote port number is added to delivery log lines (those
34118 containing => tags) following the IP address. This option is not included in
34119 the default setting, because for most ordinary configurations, the remote port
34120 number is always 25 (the SMTP port).
34121 .next
34122 .cindex "log" "process ids in"
34123 .cindex "pid (process id)" "in log lines"
34124 &%pid%&: The current process id is added to every log line, in square brackets,
34125 immediately after the time and date.
34126 .next
34127 .cindex "log" "queue run"
34128 .cindex "queue runner" "logging"
34129 &%queue_run%&: The start and end of every queue run are logged.
34130 .next
34131 .cindex "log" "queue time"
34132 &%queue_time%&: The amount of time the message has been in the queue on the
34133 local host is logged as QT=<&'time'&> on delivery (&`=>`&) lines, for example,
34134 &`QT=3m45s`&. The clock starts when Exim starts to receive the message, so it
34135 includes reception time as well as the delivery time for the current address.
34136 This means that it may be longer than the difference between the arrival and
34137 delivery log line times, because the arrival log line is not written until the
34138 message has been successfully received.
34139 .next
34140 &%queue_time_overall%&: The amount of time the message has been in the queue on
34141 the local host is logged as QT=<&'time'&> on &"Completed"& lines, for
34142 example, &`QT=3m45s`&. The clock starts when Exim starts to receive the
34143 message, so it includes reception time as well as the total delivery time.
34144 .next
34145 .cindex "log" "recipients"
34146 &%received_recipients%&: The recipients of a message are listed in the main log
34147 as soon as the message is received. The list appears at the end of the log line
34148 that is written when a message is received, preceded by the word &"for"&. The
34149 addresses are listed after they have been qualified, but before any rewriting
34150 has taken place.
34151 Recipients that were discarded by an ACL for MAIL or RCPT do not appear
34152 in the list.
34153 .next
34154 .cindex "log" "sender reception"
34155 &%received_sender%&: The unrewritten original sender of a message is added to
34156 the end of the log line that records the message's arrival, after the word
34157 &"from"& (before the recipients if &%received_recipients%& is also set).
34158 .next
34159 .cindex "log" "header lines for rejection"
34160 &%rejected_header%&: If a message's header has been received at the time a
34161 rejection is written to the reject log, the complete header is added to the
34162 log. Header logging can be turned off individually for messages that are
34163 rejected by the &[local_scan()]& function (see section &<<SECTapiforloc>>&).
34164 .next
34165 .cindex "log" "retry defer"
34166 &%retry_defer%&: A log line is written if a delivery is deferred because a
34167 retry time has not yet been reached. However, this &"retry time not reached"&
34168 message is always omitted from individual message logs after the first delivery
34169 attempt.
34170 .next
34171 .cindex "log" "return path"
34172 &%return_path_on_delivery%&: The return path that is being transmitted with
34173 the message is included in delivery and bounce lines, using the tag P=.
34174 This is omitted if no delivery actually happens, for example, if routing fails,
34175 or if delivery is to &_/dev/null_& or to &`:blackhole:`&.
34176 .next
34177 .cindex "log" "sender on delivery"
34178 &%sender_on_delivery%&: The message's sender address is added to every delivery
34179 and bounce line, tagged by F= (for &"from"&).
34180 This is the original sender that was received with the message; it is not
34181 necessarily the same as the outgoing return path.
34182 .next
34183 .cindex "log" "sender verify failure"
34184 &%sender_verify_fail%&: If this selector is unset, the separate log line that
34185 gives details of a sender verification failure is not written. Log lines for
34186 the rejection of SMTP commands contain just &"sender verify failed"&, so some
34187 detail is lost.
34188 .next
34189 .cindex "log" "size rejection"
34190 &%size_reject%&: A log line is written whenever a message is rejected because
34191 it is too big.
34192 .next
34193 .cindex "log" "frozen messages; skipped"
34194 .cindex "frozen messages" "logging skipping"
34195 &%skip_delivery%&: A log line is written whenever a message is skipped during a
34196 queue run because it is frozen or because another process is already delivering
34197 it.
34198 .cindex "&""spool file is locked""&"
34199 The message that is written is &"spool file is locked"&.
34200 .next
34201 .cindex "log" "smtp confirmation"
34202 .cindex "SMTP" "logging confirmation"
34203 &%smtp_confirmation%&: The response to the final &"."& in the SMTP dialogue for
34204 outgoing messages is added to delivery log lines in the form &`C=`&<&'text'&>.
34205 A number of MTAs (including Exim) return an identifying string in this
34206 response.
34207 .next
34208 .cindex "log" "SMTP connections"
34209 .cindex "SMTP" "logging connections"
34210 &%smtp_connection%&: A log line is written whenever an SMTP connection is
34211 established or closed, unless the connection is from a host that matches
34212 &%hosts_connection_nolog%&. (In contrast, &%lost_incoming_connection%& applies
34213 only when the closure is unexpected.) This applies to connections from local
34214 processes that use &%-bs%& as well as to TCP/IP connections. If a connection is
34215 dropped in the middle of a message, a log line is always written, whether or
34216 not this selector is set, but otherwise nothing is written at the start and end
34217 of connections unless this selector is enabled.
34218
34219 For TCP/IP connections to an Exim daemon, the current number of connections is
34220 included in the log message for each new connection, but note that the count is
34221 reset if the daemon is restarted.
34222 Also, because connections are closed (and the closure is logged) in
34223 subprocesses, the count may not include connections that have been closed but
34224 whose termination the daemon has not yet noticed. Thus, while it is possible to
34225 match up the opening and closing of connections in the log, the value of the
34226 logged counts may not be entirely accurate.
34227 .next
34228 .cindex "log" "SMTP transaction; incomplete"
34229 .cindex "SMTP" "logging incomplete transactions"
34230 &%smtp_incomplete_transaction%&: When a mail transaction is aborted by
34231 RSET, QUIT, loss of connection, or otherwise, the incident is logged,
34232 and the message sender plus any accepted recipients are included in the log
34233 line. This can provide evidence of dictionary attacks.
34234 .next
34235 .cindex "log" "non-MAIL SMTP sessions"
34236 .cindex "MAIL" "logging session without"
34237 &%smtp_no_mail%&: A line is written to the main log whenever an accepted SMTP
34238 connection terminates without having issued a MAIL command. This includes both
34239 the case when the connection is dropped, and the case when QUIT is used. It
34240 does not include cases where the connection is rejected right at the start (by
34241 an ACL, or because there are too many connections, or whatever). These cases
34242 already have their own log lines.
34243
34244 The log line that is written contains the identity of the client in the usual
34245 way, followed by D= and a time, which records the duration of the connection.
34246 If the connection was authenticated, this fact is logged exactly as it is for
34247 an incoming message, with an A= item. If the connection was encrypted, CV=,
34248 DN=, and X= items may appear as they do for an incoming message, controlled by
34249 the same logging options.
34250
34251 Finally, if any SMTP commands were issued during the connection, a C= item
34252 is added to the line, listing the commands that were used. For example,
34253 .code
34254 C=EHLO,QUIT
34255 .endd
34256 shows that the client issued QUIT straight after EHLO. If there were fewer
34257 than 20 commands, they are all listed. If there were more than 20 commands,
34258 the last 20 are listed, preceded by &"..."&. However, with the default
34259 setting of 10 for &%smtp_accep_max_nonmail%&, the connection will in any case
34260 have been aborted before 20 non-mail commands are processed.
34261 .next
34262 &%smtp_mailauth%&: A third subfield with the authenticated sender,
34263 colon-separated, is appended to the A= item for a message arrival or delivery
34264 log line, if an AUTH argument to the SMTP MAIL command (see &<<SECTauthparamail>>&)
34265 was accepted or used.
34266 .next
34267 .cindex "log" "SMTP protocol error"
34268 .cindex "SMTP" "logging protocol error"
34269 &%smtp_protocol_error%&: A log line is written for every SMTP protocol error
34270 encountered. Exim does not have perfect detection of all protocol errors
34271 because of transmission delays and the use of pipelining. If PIPELINING has
34272 been advertised to a client, an Exim server assumes that the client will use
34273 it, and therefore it does not count &"expected"& errors (for example, RCPT
34274 received after rejecting MAIL) as protocol errors.
34275 .next
34276 .cindex "SMTP" "logging syntax errors"
34277 .cindex "SMTP" "syntax errors; logging"
34278 .cindex "SMTP" "unknown command; logging"
34279 .cindex "log" "unknown SMTP command"
34280 .cindex "log" "SMTP syntax error"
34281 &%smtp_syntax_error%&: A log line is written for every SMTP syntax error
34282 encountered. An unrecognized command is treated as a syntax error. For an
34283 external connection, the host identity is given; for an internal connection
34284 using &%-bs%& the sender identification (normally the calling user) is given.
34285 .next
34286 .cindex "log" "subject"
34287 .cindex "subject, logging"
34288 &%subject%&: The subject of the message is added to the arrival log line,
34289 preceded by &"T="& (T for &"topic"&, since S is already used for &"size"&).
34290 Any MIME &"words"& in the subject are decoded. The &%print_topbitchars%& option
34291 specifies whether characters with values greater than 127 should be logged
34292 unchanged, or whether they should be rendered as escape sequences.
34293 .next
34294 .cindex "log" "certificate verification"
34295 &%tls_certificate_verified%&: An extra item is added to <= and => log lines
34296 when TLS is in use. The item is &`CV=yes`& if the peer's certificate was
34297 verified, and &`CV=no`& if not.
34298 .next
34299 .cindex "log" "TLS cipher"
34300 .cindex "TLS" "logging cipher"
34301 &%tls_cipher%&: When a message is sent or received over an encrypted
34302 connection, the cipher suite used is added to the log line, preceded by X=.
34303 .next
34304 .cindex "log" "TLS peer DN"
34305 .cindex "TLS" "logging peer DN"
34306 &%tls_peerdn%&: When a message is sent or received over an encrypted
34307 connection, and a certificate is supplied by the remote host, the peer DN is
34308 added to the log line, preceded by DN=.
34309 .next
34310 .cindex "log" "TLS SNI"
34311 .cindex "TLS" "logging SNI"
34312 &%tls_sni%&: When a message is received over an encrypted connection, and
34313 the remote host provided the Server Name Indication extension, the SNI is
34314 added to the log line, preceded by SNI=.
34315 .next
34316 .cindex "log" "DNS failure in list"
34317 &%unknown_in_list%&: This setting causes a log entry to be written when the
34318 result of a list match is failure because a DNS lookup failed.
34319 .endlist
34320
34321
34322 .section "Message log" "SECID260"
34323 .cindex "message" "log file for"
34324 .cindex "log" "message log; description of"
34325 .cindex "&_msglog_& directory"
34326 .oindex "&%preserve_message_logs%&"
34327 In addition to the general log files, Exim writes a log file for each message
34328 that it handles. The names of these per-message logs are the message ids, and
34329 they are kept in the &_msglog_& sub-directory of the spool directory. Each
34330 message log contains copies of the log lines that apply to the message. This
34331 makes it easier to inspect the status of an individual message without having
34332 to search the main log. A message log is deleted when processing of the message
34333 is complete, unless &%preserve_message_logs%& is set, but this should be used
34334 only with great care because they can fill up your disk very quickly.
34335
34336 On a heavily loaded system, it may be desirable to disable the use of
34337 per-message logs, in order to reduce disk I/O. This can be done by setting the
34338 &%message_logs%& option false.
34339 .ecindex IIDloggen
34340
34341
34342
34343
34344 . ////////////////////////////////////////////////////////////////////////////
34345 . ////////////////////////////////////////////////////////////////////////////
34346
34347 .chapter "Exim utilities" "CHAPutils"
34348 .scindex IIDutils "utilities"
34349 A number of utility scripts and programs are supplied with Exim and are
34350 described in this chapter. There is also the Exim Monitor, which is covered in
34351 the next chapter. The utilities described here are:
34352
34353 .itable none 0 0 3  7* left  15* left  40* left
34354 .irow &<<SECTfinoutwha>>&     &'exiwhat'&       &&&
34355   "list what Exim processes are doing"
34356 .irow &<<SECTgreptheque>>&    &'exiqgrep'&      "grep the queue"
34357 .irow &<<SECTsumtheque>>&     &'exiqsumm'&      "summarize the queue"
34358 .irow &<<SECTextspeinf>>&     &'exigrep'&       "search the main log"
34359 .irow &<<SECTexipick>>&       &'exipick'&       "select messages on &&&
34360                                                 various criteria"
34361 .irow &<<SECTcyclogfil>>&     &'exicyclog'&     "cycle (rotate) log files"
34362 .irow &<<SECTmailstat>>&      &'eximstats'&     &&&
34363   "extract statistics from the log"
34364 .irow &<<SECTcheckaccess>>&   &'exim_checkaccess'& &&&
34365   "check address acceptance from given IP"
34366 .irow &<<SECTdbmbuild>>&      &'exim_dbmbuild'& "build a DBM file"
34367 .irow &<<SECTfinindret>>&     &'exinext'&       "extract retry information"
34368 .irow &<<SECThindatmai>>&     &'exim_dumpdb'&   "dump a hints database"
34369 .irow &<<SECThindatmai>>&     &'exim_tidydb'&   "clean up a hints database"
34370 .irow &<<SECThindatmai>>&     &'exim_fixdb'&    "patch a hints database"
34371 .irow &<<SECTmailboxmaint>>&  &'exim_lock'&     "lock a mailbox file"
34372 .endtable
34373
34374 Another utility that might be of use to sites with many MTAs is Tom Kistner's
34375 &'exilog'&. It provides log visualizations across multiple Exim servers. See
34376 &url(http://duncanthrax.net/exilog/) for details.
34377
34378
34379
34380
34381 .section "Finding out what Exim processes are doing (exiwhat)" "SECTfinoutwha"
34382 .cindex "&'exiwhat'&"
34383 .cindex "process, querying"
34384 .cindex "SIGUSR1"
34385 On operating systems that can restart a system call after receiving a signal
34386 (most modern OS), an Exim process responds to the SIGUSR1 signal by writing
34387 a line describing what it is doing to the file &_exim-process.info_& in the
34388 Exim spool directory. The &'exiwhat'& script sends the signal to all Exim
34389 processes it can find, having first emptied the file. It then waits for one
34390 second to allow the Exim processes to react before displaying the results. In
34391 order to run &'exiwhat'& successfully you have to have sufficient privilege to
34392 send the signal to the Exim processes, so it is normally run as root.
34393
34394 &*Warning*&: This is not an efficient process. It is intended for occasional
34395 use by system administrators. It is not sensible, for example, to set up a
34396 script that sends SIGUSR1 signals to Exim processes at short intervals.
34397
34398
34399 Unfortunately, the &'ps'& command that &'exiwhat'& uses to find Exim processes
34400 varies in different operating systems. Not only are different options used,
34401 but the format of the output is different. For this reason, there are some
34402 system configuration options that configure exactly how &'exiwhat'& works. If
34403 it doesn't seem to be working for you, check the following compile-time
34404 options:
34405 .display
34406 &`EXIWHAT_PS_CMD    `& the command for running &'ps'&
34407 &`EXIWHAT_PS_ARG    `& the argument for &'ps'&
34408 &`EXIWHAT_EGREP_ARG `& the argument for &'egrep'& to select from &'ps'& output
34409 &`EXIWHAT_KILL_ARG  `& the argument for the &'kill'& command
34410 .endd
34411 An example of typical output from &'exiwhat'& is
34412 .code
34413 164 daemon: -q1h, listening on port 25
34414 10483 running queue: waiting for 0tAycK-0002ij-00 (10492)
34415 10492 delivering 0tAycK-0002ij-00 to mail.ref.example
34416   [10.19.42.42] (editor@ref.example)
34417 10592 handling incoming call from [192.168.243.242]
34418 10628 accepting a local non-SMTP message
34419 .endd
34420 The first number in the output line is the process number. The third line has
34421 been split here, in order to fit it on the page.
34422
34423
34424
34425 .section "Selective queue listing (exiqgrep)" "SECTgreptheque"
34426 .cindex "&'exiqgrep'&"
34427 .cindex "queue" "grepping"
34428 This utility is a Perl script contributed by Matt Hubbard. It runs
34429 .code
34430 exim -bpu
34431 .endd
34432 to obtain a queue listing with undelivered recipients only, and then greps the
34433 output to select messages that match given criteria. The following selection
34434 options are available:
34435
34436 .vlist
34437 .vitem &*-f*&&~<&'regex'&>
34438 Match the sender address. The field that is tested is enclosed in angle
34439 brackets, so you can test for bounce messages with
34440 .code
34441 exiqgrep -f '^<>$'
34442 .endd
34443 .vitem &*-r*&&~<&'regex'&>
34444 Match a recipient address. The field that is tested is not enclosed in angle
34445 brackets.
34446
34447 .vitem &*-s*&&~<&'regex'&>
34448 Match against the size field.
34449
34450 .vitem &*-y*&&~<&'seconds'&>
34451 Match messages that are younger than the given time.
34452
34453 .vitem &*-o*&&~<&'seconds'&>
34454 Match messages that are older than the given time.
34455
34456 .vitem &*-z*&
34457 Match only frozen messages.
34458
34459 .vitem &*-x*&
34460 Match only non-frozen messages.
34461 .endlist
34462
34463 The following options control the format of the output:
34464
34465 .vlist
34466 .vitem &*-c*&
34467 Display only the count of matching messages.
34468
34469 .vitem &*-l*&
34470 Long format &-- display the full message information as output by Exim. This is
34471 the default.
34472
34473 .vitem &*-i*&
34474 Display message ids only.
34475
34476 .vitem &*-b*&
34477 Brief format &-- one line per message.
34478
34479 .vitem &*-R*&
34480 Display messages in reverse order.
34481 .endlist
34482
34483 There is one more option, &%-h%&, which outputs a list of options.
34484
34485
34486
34487 .section "Summarizing the queue (exiqsumm)" "SECTsumtheque"
34488 .cindex "&'exiqsumm'&"
34489 .cindex "queue" "summary"
34490 The &'exiqsumm'& utility is a Perl script which reads the output of &`exim
34491 -bp`& and produces a summary of the messages on the queue. Thus, you use it by
34492 running a command such as
34493 .code
34494 exim -bp | exiqsumm
34495 .endd
34496 The output consists of one line for each domain that has messages waiting for
34497 it, as in the following example:
34498 .code
34499 3   2322   74m   66m  msn.com.example
34500 .endd
34501 Each line lists the number of pending deliveries for a domain, their total
34502 volume, and the length of time that the oldest and the newest messages have
34503 been waiting. Note that the number of pending deliveries is greater than the
34504 number of messages when messages have more than one recipient.
34505
34506 A summary line is output at the end. By default the output is sorted on the
34507 domain name, but &'exiqsumm'& has the options &%-a%& and &%-c%&, which cause
34508 the output to be sorted by oldest message and by count of messages,
34509 respectively. There are also three options that split the messages for each
34510 domain into two or more subcounts: &%-b%& separates bounce messages, &%-f%&
34511 separates frozen messages, and &%-s%& separates messages according to their
34512 sender.
34513
34514 The output of &'exim -bp'& contains the original addresses in the message, so
34515 this also applies to the output from &'exiqsumm'&. No domains from addresses
34516 generated by aliasing or forwarding are included (unless the &%one_time%&
34517 option of the &(redirect)& router has been used to convert them into &"top
34518 level"& addresses).
34519
34520
34521
34522
34523 .section "Extracting specific information from the log (exigrep)" &&&
34524          "SECTextspeinf"
34525 .cindex "&'exigrep'&"
34526 .cindex "log" "extracts; grepping for"
34527 The &'exigrep'& utility is a Perl script that searches one or more main log
34528 files for entries that match a given pattern. When it finds a match, it
34529 extracts all the log entries for the relevant message, not just those that
34530 match the pattern. Thus, &'exigrep'& can extract complete log entries for a
34531 given message, or all mail for a given user, or for a given host, for example.
34532 The input files can be in Exim log format or syslog format.
34533 If a matching log line is not associated with a specific message, it is
34534 included in &'exigrep'&'s output without any additional lines. The usage is:
34535 .display
34536 &`exigrep [-t<`&&'n'&&`>] [-I] [-l] [-v] <`&&'pattern'&&`> [<`&&'log file'&&`>] ...`&
34537 .endd
34538 If no log file names are given on the command line, the standard input is read.
34539
34540 The &%-t%& argument specifies a number of seconds. It adds an additional
34541 condition for message selection. Messages that are complete are shown only if
34542 they spent more than <&'n'&> seconds on the queue.
34543
34544 By default, &'exigrep'& does case-insensitive matching. The &%-I%& option
34545 makes it case-sensitive. This may give a performance improvement when searching
34546 large log files. Without &%-I%&, the Perl pattern matches use Perl's &`/i`&
34547 option; with &%-I%& they do not. In both cases it is possible to change the
34548 case sensitivity within the pattern by using &`(?i)`& or &`(?-i)`&.
34549
34550 The &%-l%& option means &"literal"&, that is, treat all characters in the
34551 pattern as standing for themselves. Otherwise the pattern must be a Perl
34552 regular expression.
34553
34554 The &%-v%& option inverts the matching condition. That is, a line is selected
34555 if it does &'not'& match the pattern.
34556
34557 If the location of a &'zcat'& command is known from the definition of
34558 ZCAT_COMMAND in &_Local/Makefile_&, &'exigrep'& automatically passes any file
34559 whose name ends in COMPRESS_SUFFIX through &'zcat'& as it searches it.
34560
34561
34562 .section "Selecting messages by various criteria (exipick)" "SECTexipick"
34563 .cindex "&'exipick'&"
34564 John Jetmore's &'exipick'& utility is included in the Exim distribution. It
34565 lists messages from the queue according to a variety of criteria. For details
34566 of &'exipick'&'s facilities, visit the web page at
34567 &url(http://www.exim.org/eximwiki/ToolExipickManPage) or run &'exipick'& with
34568 the &%--help%& option.
34569
34570
34571 .section "Cycling log files (exicyclog)" "SECTcyclogfil"
34572 .cindex "log" "cycling local files"
34573 .cindex "cycling logs"
34574 .cindex "&'exicyclog'&"
34575 The &'exicyclog'& script can be used to cycle (rotate) &'mainlog'& and
34576 &'rejectlog'& files. This is not necessary if only syslog is being used, or if
34577 you are using log files with datestamps in their names (see section
34578 &<<SECTdatlogfil>>&). Some operating systems have their own standard mechanisms
34579 for log cycling, and these can be used instead of &'exicyclog'& if preferred.
34580 There are two command line options for &'exicyclog'&:
34581 .ilist
34582 &%-k%& <&'count'&> specifies the number of log files to keep, overriding the
34583 default that is set when Exim is built. The default default is 10.
34584 .next
34585 &%-l%& <&'path'&> specifies the log file path, in the same format as Exim's
34586 &%log_file_path%& option (for example, &`/var/log/exim_%slog`&), again
34587 overriding the script's default, which is to find the setting from Exim's
34588 configuration.
34589 .endlist
34590
34591 Each time &'exicyclog'& is run the file names get &"shuffled down"& by one. If
34592 the main log file name is &_mainlog_& (the default) then when &'exicyclog'& is
34593 run &_mainlog_& becomes &_mainlog.01_&, the previous &_mainlog.01_& becomes
34594 &_mainlog.02_& and so on, up to the limit that is set in the script or by the
34595 &%-k%& option. Log files whose numbers exceed the limit are discarded. Reject
34596 logs are handled similarly.
34597
34598 If the limit is greater than 99, the script uses 3-digit numbers such as
34599 &_mainlog.001_&, &_mainlog.002_&, etc. If you change from a number less than 99
34600 to one that is greater, or &'vice versa'&, you will have to fix the names of
34601 any existing log files.
34602
34603 If no &_mainlog_& file exists, the script does nothing. Files that &"drop off"&
34604 the end are deleted. All files with numbers greater than 01 are compressed,
34605 using a compression command which is configured by the COMPRESS_COMMAND
34606 setting in &_Local/Makefile_&. It is usual to run &'exicyclog'& daily from a
34607 root &%crontab%& entry of the form
34608 .code
34609 1 0 * * * su exim -c /usr/exim/bin/exicyclog
34610 .endd
34611 assuming you have used the name &"exim"& for the Exim user. You can run
34612 &'exicyclog'& as root if you wish, but there is no need.
34613
34614
34615
34616 .section "Mail statistics (eximstats)" "SECTmailstat"
34617 .cindex "statistics"
34618 .cindex "&'eximstats'&"
34619 A Perl script called &'eximstats'& is provided for extracting statistical
34620 information from log files. The output is either plain text, or HTML.
34621 Exim log files are also supported by the &'Lire'& system produced by the
34622 LogReport Foundation &url(http://www.logreport.org).
34623
34624 The &'eximstats'& script has been hacked about quite a bit over time. The
34625 latest version is the result of some extensive revision by Steve Campbell. A
34626 lot of information is given by default, but there are options for suppressing
34627 various parts of it. Following any options, the arguments to the script are a
34628 list of files, which should be main log files. For example:
34629 .code
34630 eximstats -nr /var/spool/exim/log/mainlog.01
34631 .endd
34632 By default, &'eximstats'& extracts information about the number and volume of
34633 messages received from or delivered to various hosts. The information is sorted
34634 both by message count and by volume, and the top fifty hosts in each category
34635 are listed on the standard output. Similar information, based on email
34636 addresses or domains instead of hosts can be requested by means of various
34637 options. For messages delivered and received locally, similar statistics are
34638 also produced per user.
34639
34640 The output also includes total counts and statistics about delivery errors, and
34641 histograms showing the number of messages received and deliveries made in each
34642 hour of the day. A delivery with more than one address in its envelope (for
34643 example, an SMTP transaction with more than one RCPT command) is counted
34644 as a single delivery by &'eximstats'&.
34645
34646 Though normally more deliveries than receipts are reported (as messages may
34647 have multiple recipients), it is possible for &'eximstats'& to report more
34648 messages received than delivered, even though the queue is empty at the start
34649 and end of the period in question. If an incoming message contains no valid
34650 recipients, no deliveries are recorded for it. A bounce message is handled as
34651 an entirely separate message.
34652
34653 &'eximstats'& always outputs a grand total summary giving the volume and number
34654 of messages received and deliveries made, and the number of hosts involved in
34655 each case. It also outputs the number of messages that were delayed (that is,
34656 not completely delivered at the first attempt), and the number that had at
34657 least one address that failed.
34658
34659 The remainder of the output is in sections that can be independently disabled
34660 or modified by various options. It consists of a summary of deliveries by
34661 transport, histograms of messages received and delivered per time interval
34662 (default per hour), information about the time messages spent on the queue,
34663 a list of relayed messages, lists of the top fifty sending hosts, local
34664 senders, destination hosts, and destination local users by count and by volume,
34665 and a list of delivery errors that occurred.
34666
34667 The relay information lists messages that were actually relayed, that is, they
34668 came from a remote host and were directly delivered to some other remote host,
34669 without being processed (for example, for aliasing or forwarding) locally.
34670
34671 There are quite a few options for &'eximstats'& to control exactly what it
34672 outputs. These are documented in the Perl script itself, and can be extracted
34673 by running the command &(perldoc)& on the script. For example:
34674 .code
34675 perldoc /usr/exim/bin/eximstats
34676 .endd
34677
34678 .section "Checking access policy (exim_checkaccess)" "SECTcheckaccess"
34679 .cindex "&'exim_checkaccess'&"
34680 .cindex "policy control" "checking access"
34681 .cindex "checking access"
34682 The &%-bh%& command line argument allows you to run a fake SMTP session with
34683 debugging output, in order to check what Exim is doing when it is applying
34684 policy controls to incoming SMTP mail. However, not everybody is sufficiently
34685 familiar with the SMTP protocol to be able to make full use of &%-bh%&, and
34686 sometimes you just want to answer the question &"Does this address have
34687 access?"& without bothering with any further details.
34688
34689 The &'exim_checkaccess'& utility is a &"packaged"& version of &%-bh%&. It takes
34690 two arguments, an IP address and an email address:
34691 .code
34692 exim_checkaccess 10.9.8.7 A.User@a.domain.example
34693 .endd
34694 The utility runs a call to Exim with the &%-bh%& option, to test whether the
34695 given email address would be accepted in a RCPT command in a TCP/IP
34696 connection from the host with the given IP address. The output of the utility
34697 is either the word &"accepted"&, or the SMTP error response, for example:
34698 .code
34699 Rejected:
34700 550 Relay not permitted
34701 .endd
34702 When running this test, the utility uses &`<>`& as the envelope sender address
34703 for the MAIL command, but you can change this by providing additional
34704 options. These are passed directly to the Exim command. For example, to specify
34705 that the test is to be run with the sender address &'himself@there.example'&
34706 you can use:
34707 .code
34708 exim_checkaccess 10.9.8.7 A.User@a.domain.example \
34709                  -f himself@there.example
34710 .endd
34711 Note that these additional Exim command line items must be given after the two
34712 mandatory arguments.
34713
34714 Because the &%exim_checkaccess%& uses &%-bh%&, it does not perform callouts
34715 while running its checks. You can run checks that include callouts by using
34716 &%-bhc%&, but this is not yet available in a &"packaged"& form.
34717
34718
34719
34720 .section "Making DBM files (exim_dbmbuild)" "SECTdbmbuild"
34721 .cindex "DBM" "building dbm files"
34722 .cindex "building DBM files"
34723 .cindex "&'exim_dbmbuild'&"
34724 .cindex "lower casing"
34725 .cindex "binary zero" "in lookup key"
34726 The &'exim_dbmbuild'& program reads an input file containing keys and data in
34727 the format used by the &(lsearch)& lookup (see section
34728 &<<SECTsinglekeylookups>>&). It writes a DBM file using the lower-cased alias
34729 names as keys and the remainder of the information as data. The lower-casing
34730 can be prevented by calling the program with the &%-nolc%& option.
34731
34732 A terminating zero is included as part of the key string. This is expected by
34733 the &(dbm)& lookup type. However, if the option &%-nozero%& is given,
34734 &'exim_dbmbuild'& creates files without terminating zeroes in either the key
34735 strings or the data strings. The &(dbmnz)& lookup type can be used with such
34736 files.
34737
34738 The program requires two arguments: the name of the input file (which can be a
34739 single hyphen to indicate the standard input), and the name of the output file.
34740 It creates the output under a temporary name, and then renames it if all went
34741 well.
34742
34743 .cindex "USE_DB"
34744 If the native DB interface is in use (USE_DB is set in a compile-time
34745 configuration file &-- this is common in free versions of Unix) the two file
34746 names must be different, because in this mode the Berkeley DB functions create
34747 a single output file using exactly the name given. For example,
34748 .code
34749 exim_dbmbuild /etc/aliases /etc/aliases.db
34750 .endd
34751 reads the system alias file and creates a DBM version of it in
34752 &_/etc/aliases.db_&.
34753
34754 In systems that use the &'ndbm'& routines (mostly proprietary versions of
34755 Unix), two files are used, with the suffixes &_.dir_& and &_.pag_&. In this
34756 environment, the suffixes are added to the second argument of
34757 &'exim_dbmbuild'&, so it can be the same as the first. This is also the case
34758 when the Berkeley functions are used in compatibility mode (though this is not
34759 recommended), because in that case it adds a &_.db_& suffix to the file name.
34760
34761 If a duplicate key is encountered, the program outputs a warning, and when it
34762 finishes, its return code is 1 rather than zero, unless the &%-noduperr%&
34763 option is used. By default, only the first of a set of duplicates is used &--
34764 this makes it compatible with &(lsearch)& lookups. There is an option
34765 &%-lastdup%& which causes it to use the data for the last duplicate instead.
34766 There is also an option &%-nowarn%&, which stops it listing duplicate keys to
34767 &%stderr%&. For other errors, where it doesn't actually make a new file, the
34768 return code is 2.
34769
34770
34771
34772
34773 .section "Finding individual retry times (exinext)" "SECTfinindret"
34774 .cindex "retry" "times"
34775 .cindex "&'exinext'&"
34776 A utility called &'exinext'& (mostly a Perl script) provides the ability to
34777 fish specific information out of the retry database. Given a mail domain (or a
34778 complete address), it looks up the hosts for that domain, and outputs any retry
34779 information for the hosts or for the domain. At present, the retry information
34780 is obtained by running &'exim_dumpdb'& (see below) and post-processing the
34781 output. For example:
34782 .code
34783 $ exinext piglet@milne.fict.example
34784 kanga.milne.example:192.168.8.1 error 146: Connection refused
34785   first failed: 21-Feb-1996 14:57:34
34786   last tried:   21-Feb-1996 14:57:34
34787   next try at:  21-Feb-1996 15:02:34
34788 roo.milne.example:192.168.8.3 error 146: Connection refused
34789   first failed: 20-Jan-1996 13:12:08
34790   last tried:   21-Feb-1996 11:42:03
34791   next try at:  21-Feb-1996 19:42:03
34792   past final cutoff time
34793 .endd
34794 You can also give &'exinext'& a local part, without a domain, and it
34795 will give any retry information for that local part in your default domain.
34796 A message id can be used to obtain retry information pertaining to a specific
34797 message. This exists only when an attempt to deliver a message to a remote host
34798 suffers a message-specific error (see section &<<SECToutSMTPerr>>&).
34799 &'exinext'& is not particularly efficient, but then it is not expected to be
34800 run very often.
34801
34802 The &'exinext'& utility calls Exim to find out information such as the location
34803 of the spool directory. The utility has &%-C%& and &%-D%& options, which are
34804 passed on to the &'exim'& commands. The first specifies an alternate Exim
34805 configuration file, and the second sets macros for use within the configuration
34806 file. These features are mainly to help in testing, but might also be useful in
34807 environments where more than one configuration file is in use.
34808
34809
34810
34811 .section "Hints database maintenance" "SECThindatmai"
34812 .cindex "hints database" "maintenance"
34813 .cindex "maintaining Exim's hints database"
34814 Three utility programs are provided for maintaining the DBM files that Exim
34815 uses to contain its delivery hint information. Each program requires two
34816 arguments. The first specifies the name of Exim's spool directory, and the
34817 second is the name of the database it is to operate on. These are as follows:
34818
34819 .ilist
34820 &'retry'&: the database of retry information
34821 .next
34822 &'wait-'&<&'transport name'&>: databases of information about messages waiting
34823 for remote hosts
34824 .next
34825 &'callout'&: the callout cache
34826 .next
34827 &'ratelimit'&: the data for implementing the ratelimit ACL condition
34828 .next
34829 &'misc'&: other hints data
34830 .endlist
34831
34832 The &'misc'& database is used for
34833
34834 .ilist
34835 Serializing ETRN runs (when &%smtp_etrn_serialize%& is set)
34836 .next
34837 Serializing delivery to a specific host (when &%serialize_hosts%& is set in an
34838 &(smtp)& transport)
34839 .endlist
34840
34841
34842
34843 .section "exim_dumpdb" "SECID261"
34844 .cindex "&'exim_dumpdb'&"
34845 The entire contents of a database are written to the standard output by the
34846 &'exim_dumpdb'& program, which has no options or arguments other than the
34847 spool and database names. For example, to dump the retry database:
34848 .code
34849 exim_dumpdb /var/spool/exim retry
34850 .endd
34851 Two lines of output are produced for each entry:
34852 .code
34853 T:mail.ref.example:192.168.242.242 146 77 Connection refused
34854 31-Oct-1995 12:00:12 02-Nov-1995 12:21:39 02-Nov-1995 20:21:39 *
34855 .endd
34856 The first item on the first line is the key of the record. It starts with one
34857 of the letters R, or T, depending on whether it refers to a routing or
34858 transport retry. For a local delivery, the next part is the local address; for
34859 a remote delivery it is the name of the remote host, followed by its failing IP
34860 address (unless &%retry_include_ip_address%& is set false on the &(smtp)&
34861 transport). If the remote port is not the standard one (port 25), it is added
34862 to the IP address. Then there follows an error code, an additional error code,
34863 and a textual description of the error.
34864
34865 The three times on the second line are the time of first failure, the time of
34866 the last delivery attempt, and the computed time for the next attempt. The line
34867 ends with an asterisk if the cutoff time for the last retry rule has been
34868 exceeded.
34869
34870 Each output line from &'exim_dumpdb'& for the &'wait-xxx'& databases
34871 consists of a host name followed by a list of ids for messages that are or were
34872 waiting to be delivered to that host. If there are a very large number for any
34873 one host, continuation records, with a sequence number added to the host name,
34874 may be seen. The data in these records is often out of date, because a message
34875 may be routed to several alternative hosts, and Exim makes no effort to keep
34876 cross-references.
34877
34878
34879
34880 .section "exim_tidydb" "SECID262"
34881 .cindex "&'exim_tidydb'&"
34882 The &'exim_tidydb'& utility program is used to tidy up the contents of a hints
34883 database. If run with no options, it removes all records that are more than 30
34884 days old. The age is calculated from the date and time that the record was last
34885 updated. Note that, in the case of the retry database, it is &'not'& the time
34886 since the first delivery failure. Information about a host that has been down
34887 for more than 30 days will remain in the database, provided that the record is
34888 updated sufficiently often.
34889
34890 The cutoff date can be altered by means of the &%-t%& option, which must be
34891 followed by a time. For example, to remove all records older than a week from
34892 the retry database:
34893 .code
34894 exim_tidydb -t 7d /var/spool/exim retry
34895 .endd
34896 Both the &'wait-xxx'& and &'retry'& databases contain items that involve
34897 message ids. In the former these appear as data in records keyed by host &--
34898 they were messages that were waiting for that host &-- and in the latter they
34899 are the keys for retry information for messages that have suffered certain
34900 types of error. When &'exim_tidydb'& is run, a check is made to ensure that
34901 message ids in database records are those of messages that are still on the
34902 queue. Message ids for messages that no longer exist are removed from
34903 &'wait-xxx'& records, and if this leaves any records empty, they are deleted.
34904 For the &'retry'& database, records whose keys are non-existent message ids are
34905 removed. The &'exim_tidydb'& utility outputs comments on the standard output
34906 whenever it removes information from the database.
34907
34908 Certain records are automatically removed by Exim when they are no longer
34909 needed, but others are not. For example, if all the MX hosts for a domain are
34910 down, a retry record is created for each one. If the primary MX host comes back
34911 first, its record is removed when Exim successfully delivers to it, but the
34912 records for the others remain because Exim has not tried to use those hosts.
34913
34914 It is important, therefore, to run &'exim_tidydb'& periodically on all the
34915 hints databases. You should do this at a quiet time of day, because it requires
34916 a database to be locked (and therefore inaccessible to Exim) while it does its
34917 work. Removing records from a DBM file does not normally make the file smaller,
34918 but all the common DBM libraries are able to re-use the space that is released.
34919 After an initial phase of increasing in size, the databases normally reach a
34920 point at which they no longer get any bigger, as long as they are regularly
34921 tidied.
34922
34923 &*Warning*&: If you never run &'exim_tidydb'&, the space used by the hints
34924 databases is likely to keep on increasing.
34925
34926
34927
34928
34929 .section "exim_fixdb" "SECID263"
34930 .cindex "&'exim_fixdb'&"
34931 The &'exim_fixdb'& program is a utility for interactively modifying databases.
34932 Its main use is for testing Exim, but it might also be occasionally useful for
34933 getting round problems in a live system. It has no options, and its interface
34934 is somewhat crude. On entry, it prompts for input with a right angle-bracket. A
34935 key of a database record can then be entered, and the data for that record is
34936 displayed.
34937
34938 If &"d"& is typed at the next prompt, the entire record is deleted. For all
34939 except the &'retry'& database, that is the only operation that can be carried
34940 out. For the &'retry'& database, each field is output preceded by a number, and
34941 data for individual fields can be changed by typing the field number followed
34942 by new data, for example:
34943 .code
34944 > 4 951102:1000
34945 .endd
34946 resets the time of the next delivery attempt. Time values are given as a
34947 sequence of digit pairs for year, month, day, hour, and minute. Colons can be
34948 used as optional separators.
34949
34950
34951
34952
34953 .section "Mailbox maintenance (exim_lock)" "SECTmailboxmaint"
34954 .cindex "mailbox" "maintenance"
34955 .cindex "&'exim_lock'&"
34956 .cindex "locking mailboxes"
34957 The &'exim_lock'& utility locks a mailbox file using the same algorithm as
34958 Exim. For a discussion of locking issues, see section &<<SECTopappend>>&.
34959 &'Exim_lock'& can be used to prevent any modification of a mailbox by Exim or
34960 a user agent while investigating a problem. The utility requires the name of
34961 the file as its first argument. If the locking is successful, the second
34962 argument is run as a command (using C's &[system()]& function); if there is no
34963 second argument, the value of the SHELL environment variable is used; if this
34964 is unset or empty, &_/bin/sh_& is run. When the command finishes, the mailbox
34965 is unlocked and the utility ends. The following options are available:
34966
34967 .vlist
34968 .vitem &%-fcntl%&
34969 Use &[fcntl()]& locking on the open mailbox.
34970
34971 .vitem &%-flock%&
34972 Use &[flock()]& locking on the open mailbox, provided the operating system
34973 supports it.
34974
34975 .vitem &%-interval%&
34976 This must be followed by a number, which is a number of seconds; it sets the
34977 interval to sleep between retries (default 3).
34978
34979 .vitem &%-lockfile%&
34980 Create a lock file before opening the mailbox.
34981
34982 .vitem &%-mbx%&
34983 Lock the mailbox using MBX rules.
34984
34985 .vitem &%-q%&
34986 Suppress verification output.
34987
34988 .vitem &%-retries%&
34989 This must be followed by a number; it sets the number of times to try to get
34990 the lock (default 10).
34991
34992 .vitem &%-restore_time%&
34993 This option causes &%exim_lock%& to restore the modified and read times to the
34994 locked file before exiting. This allows you to access a locked mailbox (for
34995 example, to take a backup copy) without disturbing the times that the user
34996 subsequently sees.
34997
34998 .vitem &%-timeout%&
34999 This must be followed by a number, which is a number of seconds; it sets a
35000 timeout to be used with a blocking &[fcntl()]& lock. If it is not set (the
35001 default), a non-blocking call is used.
35002
35003 .vitem &%-v%&
35004 Generate verbose output.
35005 .endlist
35006
35007 If none of &%-fcntl%&, &%-flock%&, &%-lockfile%& or &%-mbx%& are given, the
35008 default is to create a lock file and also to use &[fcntl()]& locking on the
35009 mailbox, which is the same as Exim's default. The use of &%-flock%& or
35010 &%-fcntl%& requires that the file be writeable; the use of &%-lockfile%&
35011 requires that the directory containing the file be writeable. Locking by lock
35012 file does not last for ever; Exim assumes that a lock file is expired if it is
35013 more than 30 minutes old.
35014
35015 The &%-mbx%& option can be used with either or both of &%-fcntl%& or
35016 &%-flock%&. It assumes &%-fcntl%& by default. MBX locking causes a shared lock
35017 to be taken out on the open mailbox, and an exclusive lock on the file
35018 &_/tmp/.n.m_& where &'n'& and &'m'& are the device number and inode
35019 number of the mailbox file. When the locking is released, if an exclusive lock
35020 can be obtained for the mailbox, the file in &_/tmp_& is deleted.
35021
35022 The default output contains verification of the locking that takes place. The
35023 &%-v%& option causes some additional information to be given. The &%-q%& option
35024 suppresses all output except error messages.
35025
35026 A command such as
35027 .code
35028 exim_lock /var/spool/mail/spqr
35029 .endd
35030 runs an interactive shell while the file is locked, whereas
35031 .display
35032 &`exim_lock -q /var/spool/mail/spqr <<End`&
35033 <&'some commands'&>
35034 &`End`&
35035 .endd
35036 runs a specific non-interactive sequence of commands while the file is locked,
35037 suppressing all verification output. A single command can be run by a command
35038 such as
35039 .code
35040 exim_lock -q /var/spool/mail/spqr \
35041   "cp /var/spool/mail/spqr /some/where"
35042 .endd
35043 Note that if a command is supplied, it must be entirely contained within the
35044 second argument &-- hence the quotes.
35045 .ecindex IIDutils
35046
35047
35048 . ////////////////////////////////////////////////////////////////////////////
35049 . ////////////////////////////////////////////////////////////////////////////
35050
35051 .chapter "The Exim monitor" "CHAPeximon"
35052 .scindex IIDeximon "Exim monitor" "description"
35053 .cindex "X-windows"
35054 .cindex "&'eximon'&"
35055 .cindex "Local/eximon.conf"
35056 .cindex "&_exim_monitor/EDITME_&"
35057 The Exim monitor is an application which displays in an X window information
35058 about the state of Exim's queue and what Exim is doing. An admin user can
35059 perform certain operations on messages from this GUI interface; however all
35060 such facilities are also available from the command line, and indeed, the
35061 monitor itself makes use of the command line to perform any actions requested.
35062
35063
35064
35065 .section "Running the monitor" "SECID264"
35066 The monitor is started by running the script called &'eximon'&. This is a shell
35067 script that sets up a number of environment variables, and then runs the
35068 binary called &_eximon.bin_&. The default appearance of the monitor window can
35069 be changed by editing the &_Local/eximon.conf_& file created by editing
35070 &_exim_monitor/EDITME_&. Comments in that file describe what the various
35071 parameters are for.
35072
35073 The parameters that get built into the &'eximon'& script can be overridden for
35074 a particular invocation by setting up environment variables of the same names,
35075 preceded by &`EXIMON_`&. For example, a shell command such as
35076 .code
35077 EXIMON_LOG_DEPTH=400 eximon
35078 .endd
35079 (in a Bourne-compatible shell) runs &'eximon'& with an overriding setting of
35080 the LOG_DEPTH parameter. If EXIMON_LOG_FILE_PATH is set in the environment, it
35081 overrides the Exim log file configuration. This makes it possible to have
35082 &'eximon'& tailing log data that is written to syslog, provided that MAIL.INFO
35083 syslog messages are routed to a file on the local host.
35084
35085 X resources can be used to change the appearance of the window in the normal
35086 way. For example, a resource setting of the form
35087 .code
35088 Eximon*background: gray94
35089 .endd
35090 changes the colour of the background to light grey rather than white. The
35091 stripcharts are drawn with both the data lines and the reference lines in
35092 black. This means that the reference lines are not visible when on top of the
35093 data. However, their colour can be changed by setting a resource called
35094 &"highlight"& (an odd name, but that's what the Athena stripchart widget uses).
35095 For example, if your X server is running Unix, you could set up lighter
35096 reference lines in the stripcharts by obeying
35097 .code
35098 xrdb -merge <<End
35099 Eximon*highlight: gray
35100 End
35101 .endd
35102 .cindex "admin user"
35103 In order to see the contents of messages on the queue, and to operate on them,
35104 &'eximon'& must either be run as root or by an admin user.
35105
35106 The command-line parameters of &'eximon'& are passed to &_eximon.bin_& and may
35107 contain X11 resource parameters interpreted by the X11 library.  In addition,
35108 if the first parameter starts with the string "gdb" then it is removed and the
35109 binary is invoked under gdb (the parameter is used as the gdb command-name, so
35110 versioned variants of gdb can be invoked).
35111
35112 The monitor's window is divided into three parts. The first contains one or
35113 more stripcharts and two action buttons, the second contains a &"tail"& of the
35114 main log file, and the third is a display of the queue of messages awaiting
35115 delivery, with two more action buttons. The following sections describe these
35116 different parts of the display.
35117
35118
35119
35120
35121 .section "The stripcharts" "SECID265"
35122 .cindex "stripchart"
35123 The first stripchart is always a count of messages on the queue. Its name can
35124 be configured by setting QUEUE_STRIPCHART_NAME in the
35125 &_Local/eximon.conf_& file. The remaining stripcharts are defined in the
35126 configuration script by regular expression matches on log file entries, making
35127 it possible to display, for example, counts of messages delivered to certain
35128 hosts or using certain transports. The supplied defaults display counts of
35129 received and delivered messages, and of local and SMTP deliveries. The default
35130 period between stripchart updates is one minute; this can be adjusted by a
35131 parameter in the &_Local/eximon.conf_& file.
35132
35133 The stripchart displays rescale themselves automatically as the value they are
35134 displaying changes. There are always 10 horizontal lines in each chart; the
35135 title string indicates the value of each division when it is greater than one.
35136 For example, &"x2"& means that each division represents a value of 2.
35137
35138 It is also possible to have a stripchart which shows the percentage fullness of
35139 a particular disk partition, which is useful when local deliveries are confined
35140 to a single partition.
35141
35142 .cindex "&%statvfs%& function"
35143 This relies on the availability of the &[statvfs()]& function or equivalent in
35144 the operating system. Most, but not all versions of Unix that support Exim have
35145 this. For this particular stripchart, the top of the chart always represents
35146 100%, and the scale is given as &"x10%"&. This chart is configured by setting
35147 SIZE_STRIPCHART and (optionally) SIZE_STRIPCHART_NAME in the
35148 &_Local/eximon.conf_& file.
35149
35150
35151
35152
35153 .section "Main action buttons" "SECID266"
35154 .cindex "size" "of monitor window"
35155 .cindex "Exim monitor" "window size"
35156 .cindex "window size"
35157 Below the stripcharts there is an action button for quitting the monitor. Next
35158 to this is another button marked &"Size"&. They are placed here so that
35159 shrinking the window to its default minimum size leaves just the queue count
35160 stripchart and these two buttons visible. Pressing the &"Size"& button causes
35161 the window to expand to its maximum size, unless it is already at the maximum,
35162 in which case it is reduced to its minimum.
35163
35164 When expanding to the maximum, if the window cannot be fully seen where it
35165 currently is, it is moved back to where it was the last time it was at full
35166 size. When it is expanding from its minimum size, the old position is
35167 remembered, and next time it is reduced to the minimum it is moved back there.
35168
35169 The idea is that you can keep a reduced window just showing one or two
35170 stripcharts at a convenient place on your screen, easily expand it to show
35171 the full window when required, and just as easily put it back to what it was.
35172 The idea is copied from what the &'twm'& window manager does for its
35173 &'f.fullzoom'& action. The minimum size of the window can be changed by setting
35174 the MIN_HEIGHT and MIN_WIDTH values in &_Local/eximon.conf_&.
35175
35176 Normally, the monitor starts up with the window at its full size, but it can be
35177 built so that it starts up with the window at its smallest size, by setting
35178 START_SMALL=yes in &_Local/eximon.conf_&.
35179
35180
35181
35182 .section "The log display" "SECID267"
35183 .cindex "log" "tail of; in monitor"
35184 The second section of the window is an area in which a display of the tail of
35185 the main log is maintained.
35186 To save space on the screen, the timestamp on each log line is shortened by
35187 removing the date and, if &%log_timezone%& is set, the timezone.
35188 The log tail is not available when the only destination for logging data is
35189 syslog, unless the syslog lines are routed to a local file whose name is passed
35190 to &'eximon'& via the EXIMON_LOG_FILE_PATH environment variable.
35191
35192 The log sub-window has a scroll bar at its lefthand side which can be used to
35193 move back to look at earlier text, and the up and down arrow keys also have a
35194 scrolling effect. The amount of log that is kept depends on the setting of
35195 LOG_BUFFER in &_Local/eximon.conf_&, which specifies the amount of memory
35196 to use. When this is full, the earlier 50% of data is discarded &-- this is
35197 much more efficient than throwing it away line by line. The sub-window also has
35198 a horizontal scroll bar for accessing the ends of long log lines. This is the
35199 only means of horizontal scrolling; the right and left arrow keys are not
35200 available. Text can be cut from this part of the window using the mouse in the
35201 normal way. The size of this subwindow is controlled by parameters in the
35202 configuration file &_Local/eximon.conf_&.
35203
35204 Searches of the text in the log window can be carried out by means of the ^R
35205 and ^S keystrokes, which default to a reverse and a forward search,
35206 respectively. The search covers only the text that is displayed in the window.
35207 It cannot go further back up the log.
35208
35209 The point from which the search starts is indicated by a caret marker. This is
35210 normally at the end of the text in the window, but can be positioned explicitly
35211 by pointing and clicking with the left mouse button, and is moved automatically
35212 by a successful search. If new text arrives in the window when it is scrolled
35213 back, the caret remains where it is, but if the window is not scrolled back,
35214 the caret is moved to the end of the new text.
35215
35216 Pressing ^R or ^S pops up a window into which the search text can be typed.
35217 There are buttons for selecting forward or reverse searching, for carrying out
35218 the search, and for cancelling. If the &"Search"& button is pressed, the search
35219 happens and the window remains so that further searches can be done. If the
35220 &"Return"& key is pressed, a single search is done and the window is closed. If
35221 ^C is typed the search is cancelled.
35222
35223 The searching facility is implemented using the facilities of the Athena text
35224 widget. By default this pops up a window containing both &"search"& and
35225 &"replace"& options. In order to suppress the unwanted &"replace"& portion for
35226 eximon, a modified version of the &%TextPop%& widget is distributed with Exim.
35227 However, the linkers in BSDI and HP-UX seem unable to handle an externally
35228 provided version of &%TextPop%& when the remaining parts of the text widget
35229 come from the standard libraries. The compile-time option EXIMON_TEXTPOP can be
35230 unset to cut out the modified &%TextPop%&, making it possible to build Eximon
35231 on these systems, at the expense of having unwanted items in the search popup
35232 window.
35233
35234
35235
35236 .section "The queue display" "SECID268"
35237 .cindex "queue" "display in monitor"
35238 The bottom section of the monitor window contains a list of all messages that
35239 are on the queue, which includes those currently being received or delivered,
35240 as well as those awaiting delivery. The size of this subwindow is controlled by
35241 parameters in the configuration file &_Local/eximon.conf_&, and the frequency
35242 at which it is updated is controlled by another parameter in the same file &--
35243 the default is 5 minutes, since queue scans can be quite expensive. However,
35244 there is an &"Update"& action button just above the display which can be used
35245 to force an update of the queue display at any time.
35246
35247 When a host is down for some time, a lot of pending mail can build up for it,
35248 and this can make it hard to deal with other messages on the queue. To help
35249 with this situation there is a button next to &"Update"& called &"Hide"&. If
35250 pressed, a dialogue box called &"Hide addresses ending with"& is put up. If you
35251 type anything in here and press &"Return"&, the text is added to a chain of
35252 such texts, and if every undelivered address in a message matches at least one
35253 of the texts, the message is not displayed.
35254
35255 If there is an address that does not match any of the texts, all the addresses
35256 are displayed as normal. The matching happens on the ends of addresses so, for
35257 example, &'cam.ac.uk'& specifies all addresses in Cambridge, while
35258 &'xxx@foo.com.example'& specifies just one specific address. When any hiding
35259 has been set up, a button called &"Unhide"& is displayed. If pressed, it
35260 cancels all hiding. Also, to ensure that hidden messages do not get forgotten,
35261 a hide request is automatically cancelled after one hour.
35262
35263 While the dialogue box is displayed, you can't press any buttons or do anything
35264 else to the monitor window. For this reason, if you want to cut text from the
35265 queue display to use in the dialogue box, you have to do the cutting before
35266 pressing the &"Hide"& button.
35267
35268 The queue display contains, for each unhidden queued message, the length of
35269 time it has been on the queue, the size of the message, the message id, the
35270 message sender, and the first undelivered recipient, all on one line. If it is
35271 a bounce message, the sender is shown as &"<>"&. If there is more than one
35272 recipient to which the message has not yet been delivered, subsequent ones are
35273 listed on additional lines, up to a maximum configured number, following which
35274 an ellipsis is displayed. Recipients that have already received the message are
35275 not shown.
35276
35277 .cindex "frozen messages" "display"
35278 If a message is frozen, an asterisk is displayed at the left-hand side.
35279
35280 The queue display has a vertical scroll bar, and can also be scrolled by means
35281 of the arrow keys. Text can be cut from it using the mouse in the normal way.
35282 The text searching facilities, as described above for the log window, are also
35283 available, but the caret is always moved to the end of the text when the queue
35284 display is updated.
35285
35286
35287
35288 .section "The queue menu" "SECID269"
35289 .cindex "queue" "menu in monitor"
35290 If the &%shift%& key is held down and the left button is clicked when the mouse
35291 pointer is over the text for any message, an action menu pops up, and the first
35292 line of the queue display for the message is highlighted. This does not affect
35293 any selected text.
35294
35295 If you want to use some other event for popping up the menu, you can set the
35296 MENU_EVENT parameter in &_Local/eximon.conf_& to change the default, or
35297 set EXIMON_MENU_EVENT in the environment before starting the monitor. The
35298 value set in this parameter is a standard X event description. For example, to
35299 run eximon using &%ctrl%& rather than &%shift%& you could use
35300 .code
35301 EXIMON_MENU_EVENT='Ctrl<Btn1Down>' eximon
35302 .endd
35303 The title of the menu is the message id, and it contains entries which act as
35304 follows:
35305
35306 .ilist
35307 &'message log'&: The contents of the message log for the message are displayed
35308 in a new text window.
35309 .next
35310 &'headers'&: Information from the spool file that contains the envelope
35311 information and headers is displayed in a new text window. See chapter
35312 &<<CHAPspool>>& for a description of the format of spool files.
35313 .next
35314 &'body'&: The contents of the spool file containing the body of the message are
35315 displayed in a new text window. There is a default limit of 20,000 bytes to the
35316 amount of data displayed. This can be changed by setting the BODY_MAX
35317 option at compile time, or the EXIMON_BODY_MAX option at run time.
35318 .next
35319 &'deliver message'&: A call to Exim is made using the &%-M%& option to request
35320 delivery of the message. This causes an automatic thaw if the message is
35321 frozen. The &%-v%& option is also set, and the output from Exim is displayed in
35322 a new text window. The delivery is run in a separate process, to avoid holding
35323 up the monitor while the delivery proceeds.
35324 .next
35325 &'freeze message'&: A call to Exim is made using the &%-Mf%& option to request
35326 that the message be frozen.
35327 .next
35328 .cindex "thawing messages"
35329 .cindex "unfreezing messages"
35330 .cindex "frozen messages" "thawing"
35331 &'thaw message'&: A call to Exim is made using the &%-Mt%& option to request
35332 that the message be thawed.
35333 .next
35334 .cindex "delivery" "forcing failure"
35335 &'give up on msg'&: A call to Exim is made using the &%-Mg%& option to request
35336 that Exim gives up trying to deliver the message. A bounce message is generated
35337 for any remaining undelivered addresses.
35338 .next
35339 &'remove message'&: A call to Exim is made using the &%-Mrm%& option to request
35340 that the message be deleted from the system without generating a bounce
35341 message.
35342 .next
35343 &'add recipient'&: A dialog box is displayed into which a recipient address can
35344 be typed. If the address is not qualified and the QUALIFY_DOMAIN parameter
35345 is set in &_Local/eximon.conf_&, the address is qualified with that domain.
35346 Otherwise it must be entered as a fully qualified address. Pressing RETURN
35347 causes a call to Exim to be made using the &%-Mar%& option to request that an
35348 additional recipient be added to the message, unless the entry box is empty, in
35349 which case no action is taken.
35350 .next
35351 &'mark delivered'&: A dialog box is displayed into which a recipient address
35352 can be typed. If the address is not qualified and the QUALIFY_DOMAIN parameter
35353 is set in &_Local/eximon.conf_&, the address is qualified with that domain.
35354 Otherwise it must be entered as a fully qualified address. Pressing RETURN
35355 causes a call to Exim to be made using the &%-Mmd%& option to mark the given
35356 recipient address as already delivered, unless the entry box is empty, in which
35357 case no action is taken.
35358 .next
35359 &'mark all delivered'&: A call to Exim is made using the &%-Mmad%& option to
35360 mark all recipient addresses as already delivered.
35361 .next
35362 &'edit sender'&: A dialog box is displayed initialized with the current
35363 sender's address. Pressing RETURN causes a call to Exim to be made using the
35364 &%-Mes%& option to replace the sender address, unless the entry box is empty,
35365 in which case no action is taken. If you want to set an empty sender (as in
35366 bounce messages), you must specify it as &"<>"&. Otherwise, if the address is
35367 not qualified and the QUALIFY_DOMAIN parameter is set in &_Local/eximon.conf_&,
35368 the address is qualified with that domain.
35369 .endlist
35370
35371 When a delivery is forced, a window showing the &%-v%& output is displayed. In
35372 other cases when a call to Exim is made, if there is any output from Exim (in
35373 particular, if the command fails) a window containing the command and the
35374 output is displayed. Otherwise, the results of the action are normally apparent
35375 from the log and queue displays. However, if you set ACTION_OUTPUT=yes in
35376 &_Local/eximon.conf_&, a window showing the Exim command is always opened, even
35377 if no output is generated.
35378
35379 The queue display is automatically updated for actions such as freezing and
35380 thawing, unless ACTION_QUEUE_UPDATE=no has been set in
35381 &_Local/eximon.conf_&. In this case the &"Update"& button has to be used to
35382 force an update of the display after one of these actions.
35383
35384 In any text window that is displayed as result of a menu action, the normal
35385 cut-and-paste facility is available, and searching can be carried out using ^R
35386 and ^S, as described above for the log tail window.
35387 .ecindex IIDeximon
35388
35389
35390
35391
35392
35393 . ////////////////////////////////////////////////////////////////////////////
35394 . ////////////////////////////////////////////////////////////////////////////
35395
35396 .chapter "Security considerations" "CHAPsecurity"
35397 .scindex IIDsecurcon "security" "discussion of"
35398 This chapter discusses a number of issues concerned with security, some of
35399 which are also covered in other parts of this manual.
35400
35401 For reasons that this author does not understand, some people have promoted
35402 Exim as a &"particularly secure"& mailer. Perhaps it is because of the
35403 existence of this chapter in the documentation. However, the intent of the
35404 chapter is simply to describe the way Exim works in relation to certain
35405 security concerns, not to make any specific claims about the effectiveness of
35406 its security as compared with other MTAs.
35407
35408 What follows is a description of the way Exim is supposed to be. Best efforts
35409 have been made to try to ensure that the code agrees with the theory, but an
35410 absence of bugs can never be guaranteed. Any that are reported will get fixed
35411 as soon as possible.
35412
35413
35414 .section "Building a more &""hardened""& Exim" "SECID286"
35415 .cindex "security" "build-time features"
35416 There are a number of build-time options that can be set in &_Local/Makefile_&
35417 to create Exim binaries that are &"harder"& to attack, in particular by a rogue
35418 Exim administrator who does not have the root password, or by someone who has
35419 penetrated the Exim (but not the root) account. These options are as follows:
35420
35421 .ilist
35422 ALT_CONFIG_PREFIX can be set to a string that is required to match the
35423 start of any file names used with the &%-C%& option. When it is set, these file
35424 names are also not allowed to contain the sequence &"/../"&. (However, if the
35425 value of the &%-C%& option is identical to the value of CONFIGURE_FILE in
35426 &_Local/Makefile_&, Exim ignores &%-C%& and proceeds as usual.) There is no
35427 default setting for &%ALT_CONFIG_PREFIX%&.
35428
35429 If the permitted configuration files are confined to a directory to
35430 which only root has access, this guards against someone who has broken
35431 into the Exim account from running a privileged Exim with an arbitrary
35432 configuration file, and using it to break into other accounts.
35433 .next
35434
35435 If a non-trusted configuration file (i.e. not the default configuration file
35436 or one which is trusted by virtue of being listed in the TRUSTED_CONFIG_LIST
35437 file) is specified with &%-C%&, or if macros are given with &%-D%& (but see
35438 the next item), then root privilege is retained only if the caller of Exim is
35439 root. This locks out the possibility of testing a configuration using &%-C%&
35440 right through message reception and delivery, even if the caller is root. The
35441 reception works, but by that time, Exim is running as the Exim user, so when
35442 it re-execs to regain privilege for the delivery, the use of &%-C%& causes
35443 privilege to be lost. However, root can test reception and delivery using two
35444 separate commands.
35445
35446 .next
35447 The WHITELIST_D_MACROS build option declares some macros to be safe to override
35448 with &%-D%& if the real uid is one of root, the Exim run-time user or the
35449 CONFIGURE_OWNER, if defined.  The potential impact of this option is limited by
35450 requiring the run-time value supplied to &%-D%& to match a regex that errs on
35451 the restrictive side.  Requiring build-time selection of safe macros is onerous
35452 but this option is intended solely as a transition mechanism to permit
35453 previously-working configurations to continue to work after release 4.73.
35454 .next
35455 If DISABLE_D_OPTION is defined, the use of the &%-D%& command line option
35456 is disabled.
35457 .next
35458 FIXED_NEVER_USERS can be set to a colon-separated list of users that are
35459 never to be used for any deliveries. This is like the &%never_users%& runtime
35460 option, but it cannot be overridden; the runtime option adds additional users
35461 to the list. The default setting is &"root"&; this prevents a non-root user who
35462 is permitted to modify the runtime file from using Exim as a way to get root.
35463 .endlist
35464
35465
35466
35467 .section "Root privilege" "SECID270"
35468 .cindex "setuid"
35469 .cindex "root privilege"
35470 The Exim binary is normally setuid to root, which means that it gains root
35471 privilege (runs as root) when it starts execution. In some special cases (for
35472 example, when the daemon is not in use and there are no local deliveries), it
35473 may be possible to run Exim setuid to some user other than root. This is
35474 discussed in the next section. However, in most installations, root privilege
35475 is required for two things:
35476
35477 .ilist
35478 To set up a socket connected to the standard SMTP port (25) when initialising
35479 the listening daemon. If Exim is run from &'inetd'&, this privileged action is
35480 not required.
35481 .next
35482 To be able to change uid and gid in order to read users' &_.forward_& files and
35483 perform local deliveries as the receiving user or as specified in the
35484 configuration.
35485 .endlist
35486
35487 It is not necessary to be root to do any of the other things Exim does, such as
35488 receiving messages and delivering them externally over SMTP, and it is
35489 obviously more secure if Exim does not run as root except when necessary.
35490 For this reason, a user and group for Exim to use must be defined in
35491 &_Local/Makefile_&. These are known as &"the Exim user"& and &"the Exim
35492 group"&. Their values can be changed by the run time configuration, though this
35493 is not recommended. Often a user called &'exim'& is used, but some sites use
35494 &'mail'& or another user name altogether.
35495
35496 Exim uses &[setuid()]& whenever it gives up root privilege. This is a permanent
35497 abdication; the process cannot regain root afterwards. Prior to release 4.00,
35498 &[seteuid()]& was used in some circumstances, but this is no longer the case.
35499
35500 After a new Exim process has interpreted its command line options, it changes
35501 uid and gid in the following cases:
35502
35503 .ilist
35504 .oindex "&%-C%&"
35505 .oindex "&%-D%&"
35506 If the &%-C%& option is used to specify an alternate configuration file, or if
35507 the &%-D%& option is used to define macro values for the configuration, and the
35508 calling process is not running as root, the uid and gid are changed to those of
35509 the calling process.
35510 However, if DISABLE_D_OPTION is defined in &_Local/Makefile_&, the &%-D%&
35511 option may not be used at all.
35512 If WHITELIST_D_MACROS is defined in &_Local/Makefile_&, then some macro values
35513 can be supplied if the calling process is running as root, the Exim run-time
35514 user or CONFIGURE_OWNER, if defined.
35515 .next
35516 .oindex "&%-be%&"
35517 .oindex "&%-bf%&"
35518 .oindex "&%-bF%&"
35519 If the expansion test option (&%-be%&) or one of the filter testing options
35520 (&%-bf%& or &%-bF%&) are used, the uid and gid are changed to those of the
35521 calling process.
35522 .next
35523 If the process is not a daemon process or a queue runner process or a delivery
35524 process or a process for testing address routing (started with &%-bt%&), the
35525 uid and gid are changed to the Exim user and group. This means that Exim always
35526 runs under its own uid and gid when receiving messages. This also applies when
35527 testing address verification
35528 .oindex "&%-bv%&"
35529 .oindex "&%-bh%&"
35530 (the &%-bv%& option) and testing incoming message policy controls (the &%-bh%&
35531 option).
35532 .next
35533 For a daemon, queue runner, delivery, or address testing process, the uid
35534 remains as root at this stage, but the gid is changed to the Exim group.
35535 .endlist
35536
35537 The processes that initially retain root privilege behave as follows:
35538
35539 .ilist
35540 A daemon process changes the gid to the Exim group and the uid to the Exim
35541 user after setting up one or more listening sockets. The &[initgroups()]&
35542 function is called, so that if the Exim user is in any additional groups, they
35543 will be used during message reception.
35544 .next
35545 A queue runner process retains root privilege throughout its execution. Its
35546 job is to fork a controlled sequence of delivery processes.
35547 .next
35548 A delivery process retains root privilege throughout most of its execution,
35549 but any actual deliveries (that is, the transports themselves) are run in
35550 subprocesses which always change to a non-root uid and gid. For local
35551 deliveries this is typically the uid and gid of the owner of the mailbox; for
35552 remote deliveries, the Exim uid and gid are used. Once all the delivery
35553 subprocesses have been run, a delivery process changes to the Exim uid and gid
35554 while doing post-delivery tidying up such as updating the retry database and
35555 generating bounce and warning messages.
35556
35557 While the recipient addresses in a message are being routed, the delivery
35558 process runs as root. However, if a user's filter file has to be processed,
35559 this is done in a subprocess that runs under the individual user's uid and
35560 gid. A system filter is run as root unless &%system_filter_user%& is set.
35561 .next
35562 A process that is testing addresses (the &%-bt%& option) runs as root so that
35563 the routing is done in the same environment as a message delivery.
35564 .endlist
35565
35566
35567
35568
35569 .section "Running Exim without privilege" "SECTrunexiwitpri"
35570 .cindex "privilege, running without"
35571 .cindex "unprivileged running"
35572 .cindex "root privilege" "running without"
35573 Some installations like to run Exim in an unprivileged state for more of its
35574 operation, for added security. Support for this mode of operation is provided
35575 by the global option &%deliver_drop_privilege%&. When this is set, the uid and
35576 gid are changed to the Exim user and group at the start of a delivery process
35577 (and also queue runner and address testing processes). This means that address
35578 routing is no longer run as root, and the deliveries themselves cannot change
35579 to any other uid.
35580
35581 .cindex SIGHUP
35582 .cindex "daemon" "restarting"
35583 Leaving the binary setuid to root, but setting &%deliver_drop_privilege%& means
35584 that the daemon can still be started in the usual way, and it can respond
35585 correctly to SIGHUP because the re-invocation regains root privilege.
35586
35587 An alternative approach is to make Exim setuid to the Exim user and also setgid
35588 to the Exim group. If you do this, the daemon must be started from a root
35589 process. (Calling Exim from a root process makes it behave in the way it does
35590 when it is setuid root.) However, the daemon cannot restart itself after a
35591 SIGHUP signal because it cannot regain privilege.
35592
35593 It is still useful to set &%deliver_drop_privilege%& in this case, because it
35594 stops Exim from trying to re-invoke itself to do a delivery after a message has
35595 been received. Such a re-invocation is a waste of resources because it has no
35596 effect.
35597
35598 If restarting the daemon is not an issue (for example, if &%mua_wrapper%& is
35599 set, or &'inetd'& is being used instead of a daemon), having the binary setuid
35600 to the Exim user seems a clean approach, but there is one complication:
35601
35602 In this style of operation, Exim is running with the real uid and gid set to
35603 those of the calling process, and the effective uid/gid set to Exim's values.
35604 Ideally, any association with the calling process' uid/gid should be dropped,
35605 that is, the real uid/gid should be reset to the effective values so as to
35606 discard any privileges that the caller may have. While some operating systems
35607 have a function that permits this action for a non-root effective uid, quite a
35608 number of them do not. Because of this lack of standardization, Exim does not
35609 address this problem at this time.
35610
35611 For this reason, the recommended approach for &"mostly unprivileged"& running
35612 is to keep the Exim binary setuid to root, and to set
35613 &%deliver_drop_privilege%&. This also has the advantage of allowing a daemon to
35614 be used in the most straightforward way.
35615
35616 If you configure Exim not to run delivery processes as root, there are a
35617 number of restrictions on what you can do:
35618
35619 .ilist
35620 You can deliver only as the Exim user/group. You should  explicitly use the
35621 &%user%& and &%group%& options to override routers or local transports that
35622 normally deliver as the recipient. This makes sure that configurations that
35623 work in this mode function the same way in normal mode. Any implicit or
35624 explicit specification of another user causes an error.
35625 .next
35626 Use of &_.forward_& files is severely restricted, such that it is usually
35627 not worthwhile to include them in the configuration.
35628 .next
35629 Users who wish to use &_.forward_& would have to make their home directory and
35630 the file itself accessible to the Exim user. Pipe and append-to-file entries,
35631 and their equivalents in Exim filters, cannot be used. While they could be
35632 enabled in the Exim user's name, that would be insecure and not very useful.
35633 .next
35634 Unless the local user mailboxes are all owned by the Exim user (possible in
35635 some POP3 or IMAP-only environments):
35636
35637 .olist
35638 They must be owned by the Exim group and be writeable by that group. This
35639 implies you must set &%mode%& in the appendfile configuration, as well as the
35640 mode of the mailbox files themselves.
35641 .next
35642 You must set &%no_check_owner%&, since most or all of the files will not be
35643 owned by the Exim user.
35644 .next
35645 You must set &%file_must_exist%&, because Exim cannot set the owner correctly
35646 on a newly created mailbox when unprivileged. This also implies that new
35647 mailboxes need to be created manually.
35648 .endlist olist
35649 .endlist ilist
35650
35651
35652 These restrictions severely restrict what can be done in local deliveries.
35653 However, there are no restrictions on remote deliveries. If you are running a
35654 gateway host that does no local deliveries, setting &%deliver_drop_privilege%&
35655 gives more security at essentially no cost.
35656
35657 If you are using the &%mua_wrapper%& facility (see chapter
35658 &<<CHAPnonqueueing>>&), &%deliver_drop_privilege%& is forced to be true.
35659
35660
35661
35662
35663 .section "Delivering to local files" "SECID271"
35664 Full details of the checks applied by &(appendfile)& before it writes to a file
35665 are given in chapter &<<CHAPappendfile>>&.
35666
35667
35668
35669 .section "Running local commands" "SECTsecconslocalcmds"
35670 There are a number of ways in which an administrator can configure Exim to run
35671 commands based upon received, untrustworthy, data. Further, in some
35672 configurations a user who can control a &_.forward_& file can also arrange to
35673 run commands. Configuration to check includes, but is not limited to:
35674
35675 .ilist
35676 Use of &%use_shell%& in the pipe transport: various forms of shell command
35677 injection may be possible with this option present. It is dangerous and should
35678 be used only with considerable caution. Consider constraints which whitelist
35679 allowed characters in a variable which is to be used in a pipe transport that
35680 has &%use_shell%& enabled.
35681 .next
35682 A number of options such as &%forbid_filter_run%&, &%forbid_filter_perl%&,
35683 &%forbid_filter_dlfunc%& and so forth which restrict facilities available to
35684 &_.forward_& files in a redirect router. If Exim is running on a central mail
35685 hub to which ordinary users do not have shell access, but home directories are
35686 NFS mounted (for instance) then administrators should review the list of these
35687 forbid options available, and should bear in mind that the options that may
35688 need forbidding can change as new features are added between releases.
35689 .next
35690 The &%${run...}%& expansion item does not use a shell by default, but
35691 administrators can configure use of &_/bin/sh_& as part of the command.
35692 Such invocations should be viewed with prejudicial suspicion.
35693 .next
35694 Administrators who use embedded Perl are advised to explore how Perl's
35695 taint checking might apply to their usage.
35696 .next
35697 Use of &%${expand...}%& is somewhat analagous to shell's eval builtin and
35698 administrators are well advised to view its use with suspicion, in case (for
35699 instance) it allows a local-part to contain embedded Exim directives.
35700 .next
35701 Use of &%${match_local_part...}%& and friends becomes more dangerous if
35702 Exim was built with EXPAND_LISTMATCH_RHS defined: the second string in
35703 each can reference arbitrary lists and files, rather than just being a list
35704 of opaque strings.
35705 The EXPAND_LISTMATCH_RHS option was added and set false by default because of
35706 real-world security vulnerabilities caused by its use with untrustworthy data
35707 injected in, for SQL injection attacks.
35708 Consider the use of the &%inlisti%& expansion condition instead.
35709 .endlist
35710
35711
35712
35713 .section "IPv4 source routing" "SECID272"
35714 .cindex "source routing" "in IP packets"
35715 .cindex "IP source routing"
35716 Many operating systems suppress IP source-routed packets in the kernel, but
35717 some cannot be made to do this, so Exim does its own check. It logs incoming
35718 IPv4 source-routed TCP calls, and then drops them. Things are all different in
35719 IPv6. No special checking is currently done.
35720
35721
35722
35723 .section "The VRFY, EXPN, and ETRN commands in SMTP" "SECID273"
35724 Support for these SMTP commands is disabled by default. If required, they can
35725 be enabled by defining suitable ACLs.
35726
35727
35728
35729
35730 .section "Privileged users" "SECID274"
35731 .cindex "trusted users"
35732 .cindex "admin user"
35733 .cindex "privileged user"
35734 .cindex "user" "trusted"
35735 .cindex "user" "admin"
35736 Exim recognizes two sets of users with special privileges. Trusted users are
35737 able to submit new messages to Exim locally, but supply their own sender
35738 addresses and information about a sending host. For other users submitting
35739 local messages, Exim sets up the sender address from the uid, and doesn't
35740 permit a remote host to be specified.
35741
35742 .oindex "&%-f%&"
35743 However, an untrusted user is permitted to use the &%-f%& command line option
35744 in the special form &%-f <>%& to indicate that a delivery failure for the
35745 message should not cause an error report. This affects the message's envelope,
35746 but it does not affect the &'Sender:'& header. Untrusted users may also be
35747 permitted to use specific forms of address with the &%-f%& option by setting
35748 the &%untrusted_set_sender%& option.
35749
35750 Trusted users are used to run processes that receive mail messages from some
35751 other mail domain and pass them on to Exim for delivery either locally, or over
35752 the Internet. Exim trusts a caller that is running as root, as the Exim user,
35753 as any user listed in the &%trusted_users%& configuration option, or under any
35754 group listed in the &%trusted_groups%& option.
35755
35756 Admin users are permitted to do things to the messages on Exim's queue. They
35757 can freeze or thaw messages, cause them to be returned to their senders, remove
35758 them entirely, or modify them in various ways. In addition, admin users can run
35759 the Exim monitor and see all the information it is capable of providing, which
35760 includes the contents of files on the spool.
35761
35762 .oindex "&%-M%&"
35763 .oindex "&%-q%&"
35764 By default, the use of the &%-M%& and &%-q%& options to cause Exim to attempt
35765 delivery of messages on its queue is restricted to admin users. This
35766 restriction can be relaxed by setting the &%no_prod_requires_admin%& option.
35767 Similarly, the use of &%-bp%& (and its variants) to list the contents of the
35768 queue is also restricted to admin users. This restriction can be relaxed by
35769 setting &%no_queue_list_requires_admin%&.
35770
35771 Exim recognizes an admin user if the calling process is running as root or as
35772 the Exim user or if any of the groups associated with the calling process is
35773 the Exim group. It is not necessary actually to be running under the Exim
35774 group. However, if admin users who are not root or the Exim user are to access
35775 the contents of files on the spool via the Exim monitor (which runs
35776 unprivileged), Exim must be built to allow group read access to its spool
35777 files.
35778
35779
35780
35781 .section "Spool files" "SECID275"
35782 .cindex "spool directory" "files"
35783 Exim's spool directory and everything it contains is owned by the Exim user and
35784 set to the Exim group. The mode for spool files is defined in the
35785 &_Local/Makefile_& configuration file, and defaults to 0640. This means that
35786 any user who is a member of the Exim group can access these files.
35787
35788
35789
35790 .section "Use of argv[0]" "SECID276"
35791 Exim examines the last component of &%argv[0]%&, and if it matches one of a set
35792 of specific strings, Exim assumes certain options. For example, calling Exim
35793 with the last component of &%argv[0]%& set to &"rsmtp"& is exactly equivalent
35794 to calling it with the option &%-bS%&. There are no security implications in
35795 this.
35796
35797
35798
35799 .section "Use of %f formatting" "SECID277"
35800 The only use made of &"%f"& by Exim is in formatting load average values. These
35801 are actually stored in integer variables as 1000 times the load average.
35802 Consequently, their range is limited and so therefore is the length of the
35803 converted output.
35804
35805
35806
35807 .section "Embedded Exim path" "SECID278"
35808 Exim uses its own path name, which is embedded in the code, only when it needs
35809 to re-exec in order to regain root privilege. Therefore, it is not root when it
35810 does so. If some bug allowed the path to get overwritten, it would lead to an
35811 arbitrary program's being run as exim, not as root.
35812
35813
35814
35815 .section "Dynamic module directory" "SECTdynmoddir"
35816 Any dynamically loadable modules must be installed into the directory
35817 defined in &`LOOKUP_MODULE_DIR`& in &_Local/Makefile_& for Exim to permit
35818 loading it.
35819
35820
35821 .section "Use of sprintf()" "SECID279"
35822 .cindex "&[sprintf()]&"
35823 A large number of occurrences of &"sprintf"& in the code are actually calls to
35824 &'string_sprintf()'&, a function that returns the result in malloc'd store.
35825 The intermediate formatting is done into a large fixed buffer by a function
35826 that runs through the format string itself, and checks the length of each
35827 conversion before performing it, thus preventing buffer overruns.
35828
35829 The remaining uses of &[sprintf()]& happen in controlled circumstances where
35830 the output buffer is known to be sufficiently long to contain the converted
35831 string.
35832
35833
35834
35835 .section "Use of debug_printf() and log_write()" "SECID280"
35836 Arbitrary strings are passed to both these functions, but they do their
35837 formatting by calling the function &'string_vformat()'&, which runs through
35838 the format string itself, and checks the length of each conversion.
35839
35840
35841
35842 .section "Use of strcat() and strcpy()" "SECID281"
35843 These are used only in cases where the output buffer is known to be large
35844 enough to hold the result.
35845 .ecindex IIDsecurcon
35846
35847
35848
35849
35850 . ////////////////////////////////////////////////////////////////////////////
35851 . ////////////////////////////////////////////////////////////////////////////
35852
35853 .chapter "Format of spool files" "CHAPspool"
35854 .scindex IIDforspo1 "format" "spool files"
35855 .scindex IIDforspo2 "spool directory" "format of files"
35856 .scindex IIDforspo3 "spool files" "format of"
35857 .cindex "spool files" "editing"
35858 A message on Exim's queue consists of two files, whose names are the message id
35859 followed by -D and -H, respectively. The data portion of the message is kept in
35860 the -D file on its own. The message's envelope, status, and headers are all
35861 kept in the -H file, whose format is described in this chapter. Each of these
35862 two files contains the final component of its own name as its first line. This
35863 is insurance against disk crashes where the directory is lost but the files
35864 themselves are recoverable.
35865
35866 Some people are tempted into editing -D files in order to modify messages. You
35867 need to be extremely careful if you do this; it is not recommended and you are
35868 on your own if you do it. Here are some of the pitfalls:
35869
35870 .ilist
35871 You must ensure that Exim does not try to deliver the message while you are
35872 fiddling with it. The safest way is to take out a write lock on the -D file,
35873 which is what Exim itself does, using &[fcntl()]&. If you update the file in
35874 place, the lock will be retained. If you write a new file and rename it, the
35875 lock will be lost at the instant of rename.
35876 .next
35877 .vindex "&$body_linecount$&"
35878 If you change the number of lines in the file, the value of
35879 &$body_linecount$&, which is stored in the -H file, will be incorrect. At
35880 present, this value is not used by Exim, but there is no guarantee that this
35881 will always be the case.
35882 .next
35883 If the message is in MIME format, you must take care not to break it.
35884 .next
35885 If the message is cryptographically signed, any change will invalidate the
35886 signature.
35887 .endlist
35888 All in all, modifying -D files is fraught with danger.
35889
35890 Files whose names end with -J may also be seen in the &_input_& directory (or
35891 its subdirectories when &%split_spool_directory%& is set). These are journal
35892 files, used to record addresses to which the message has been delivered during
35893 the course of a delivery attempt. If there are still undelivered recipients at
35894 the end, the -H file is updated, and the -J file is deleted. If, however, there
35895 is some kind of crash (for example, a power outage) before this happens, the -J
35896 file remains in existence. When Exim next processes the message, it notices the
35897 -J file and uses it to update the -H file before starting the next delivery
35898 attempt.
35899
35900 .section "Format of the -H file" "SECID282"
35901 .cindex "uid (user id)" "in spool file"
35902 .cindex "gid (group id)" "in spool file"
35903 The second line of the -H file contains the login name for the uid of the
35904 process that called Exim to read the message, followed by the numerical uid and
35905 gid. For a locally generated message, this is normally the user who sent the
35906 message. For a message received over TCP/IP via the daemon, it is
35907 normally the Exim user.
35908
35909 The third line of the file contains the address of the message's sender as
35910 transmitted in the envelope, contained in angle brackets. The sender address is
35911 empty for bounce messages. For incoming SMTP mail, the sender address is given
35912 in the MAIL command. For locally generated mail, the sender address is
35913 created by Exim from the login name of the current user and the configured
35914 &%qualify_domain%&. However, this can be overridden by the &%-f%& option or a
35915 leading &"From&~"& line if the caller is trusted, or if the supplied address is
35916 &"<>"& or an address that matches &%untrusted_set_senders%&.
35917
35918 The fourth line contains two numbers. The first is the time that the message
35919 was received, in the conventional Unix form &-- the number of seconds since the
35920 start of the epoch. The second number is a count of the number of messages
35921 warning of delayed delivery that have been sent to the sender.
35922
35923 There follow a number of lines starting with a hyphen. These can appear in any
35924 order, and are omitted when not relevant:
35925
35926 .vlist
35927 .vitem "&%-acl%&&~<&'number'&>&~<&'length'&>"
35928 This item is obsolete, and is not generated from Exim release 4.61 onwards;
35929 &%-aclc%& and &%-aclm%& are used instead. However, &%-acl%& is still
35930 recognized, to provide backward compatibility. In the old format, a line of
35931 this form is present for every ACL variable that is not empty. The number
35932 identifies the variable; the &%acl_c%&&*x*& variables are numbered 0&--9 and
35933 the &%acl_m%&&*x*& variables are numbered 10&--19. The length is the length of
35934 the data string for the variable. The string itself starts at the beginning of
35935 the next line, and is followed by a newline character. It may contain internal
35936 newlines.
35937
35938 .vitem "&%-aclc%&&~<&'rest-of-name'&>&~<&'length'&>"
35939 A line of this form is present for every ACL connection variable that is
35940 defined. Note that there is a space between &%-aclc%& and the rest of the name.
35941 The length is the length of the data string for the variable. The string itself
35942 starts at the beginning of the next line, and is followed by a newline
35943 character. It may contain internal newlines.
35944
35945 .vitem "&%-aclm%&&~<&'rest-of-name'&>&~<&'length'&>"
35946 A line of this form is present for every ACL message variable that is defined.
35947 Note that there is a space between &%-aclm%& and the rest of the name. The
35948 length is the length of the data string for the variable. The string itself
35949 starts at the beginning of the next line, and is followed by a newline
35950 character. It may contain internal newlines.
35951
35952 .vitem "&%-active_hostname%&&~<&'hostname'&>"
35953 This is present if, when the message was received over SMTP, the value of
35954 &$smtp_active_hostname$& was different to the value of &$primary_hostname$&.
35955
35956 .vitem &%-allow_unqualified_recipient%&
35957 This is present if unqualified recipient addresses are permitted in header
35958 lines (to stop such addresses from being qualified if rewriting occurs at
35959 transport time). Local messages that were input using &%-bnq%& and remote
35960 messages from hosts that match &%recipient_unqualified_hosts%& set this flag.
35961
35962 .vitem &%-allow_unqualified_sender%&
35963 This is present if unqualified sender addresses are permitted in header lines
35964 (to stop such addresses from being qualified if rewriting occurs at transport
35965 time). Local messages that were input using &%-bnq%& and remote messages from
35966 hosts that match &%sender_unqualified_hosts%& set this flag.
35967
35968 .vitem "&%-auth_id%&&~<&'text'&>"
35969 The id information for a message received on an authenticated SMTP connection
35970 &-- the value of the &$authenticated_id$& variable.
35971
35972 .vitem "&%-auth_sender%&&~<&'address'&>"
35973 The address of an authenticated sender &-- the value of the
35974 &$authenticated_sender$& variable.
35975
35976 .vitem "&%-body_linecount%&&~<&'number'&>"
35977 This records the number of lines in the body of the message, and is always
35978 present.
35979
35980 .vitem "&%-body_zerocount%&&~<&'number'&>"
35981 This records the number of binary zero bytes in the body of the message, and is
35982 present if the number is greater than zero.
35983
35984 .vitem &%-deliver_firsttime%&
35985 This is written when a new message is first added to the spool. When the spool
35986 file is updated after a deferral, it is omitted.
35987
35988 .vitem "&%-frozen%&&~<&'time'&>"
35989 .cindex "frozen messages" "spool data"
35990 The message is frozen, and the freezing happened at <&'time'&>.
35991
35992 .vitem "&%-helo_name%&&~<&'text'&>"
35993 This records the host name as specified by a remote host in a HELO or EHLO
35994 command.
35995
35996 .vitem "&%-host_address%&&~<&'address'&>.<&'port'&>"
35997 This records the IP address of the host from which the message was received and
35998 the remote port number that was used. It is omitted for locally generated
35999 messages.
36000
36001 .vitem "&%-host_auth%&&~<&'text'&>"
36002 If the message was received on an authenticated SMTP connection, this records
36003 the name of the authenticator &-- the value of the
36004 &$sender_host_authenticated$& variable.
36005
36006 .vitem &%-host_lookup_failed%&
36007 This is present if an attempt to look up the sending host's name from its IP
36008 address failed. It corresponds to the &$host_lookup_failed$& variable.
36009
36010 .vitem "&%-host_name%&&~<&'text'&>"
36011 .cindex "reverse DNS lookup"
36012 .cindex "DNS" "reverse lookup"
36013 This records the name of the remote host from which the message was received,
36014 if the host name was looked up from the IP address when the message was being
36015 received. It is not present if no reverse lookup was done.
36016
36017 .vitem "&%-ident%&&~<&'text'&>"
36018 For locally submitted messages, this records the login of the originating user,
36019 unless it was a trusted user and the &%-oMt%& option was used to specify an
36020 ident value. For messages received over TCP/IP, this records the ident string
36021 supplied by the remote host, if any.
36022
36023 .vitem "&%-interface_address%&&~<&'address'&>.<&'port'&>"
36024 This records the IP address of the local interface and the port number through
36025 which a message was received from a remote host. It is omitted for locally
36026 generated messages.
36027
36028 .vitem &%-local%&
36029 The message is from a local sender.
36030
36031 .vitem &%-localerror%&
36032 The message is a locally-generated bounce message.
36033
36034 .vitem "&%-local_scan%&&~<&'string'&>"
36035 This records the data string that was returned by the &[local_scan()]& function
36036 when the message was received &-- the value of the &$local_scan_data$&
36037 variable. It is omitted if no data was returned.
36038
36039 .vitem &%-manual_thaw%&
36040 The message was frozen but has been thawed manually, that is, by an explicit
36041 Exim command rather than via the auto-thaw process.
36042
36043 .vitem &%-N%&
36044 A testing delivery process was started using the &%-N%& option to suppress any
36045 actual deliveries, but delivery was deferred. At any further delivery attempts,
36046 &%-N%& is assumed.
36047
36048 .vitem &%-received_protocol%&
36049 This records the value of the &$received_protocol$& variable, which contains
36050 the name of the protocol by which the message was received.
36051
36052 .vitem &%-sender_set_untrusted%&
36053 The envelope sender of this message was set by an untrusted local caller (used
36054 to ensure that the caller is displayed in queue listings).
36055
36056 .vitem "&%-spam_score_int%&&~<&'number'&>"
36057 If a message was scanned by SpamAssassin, this is present. It records the value
36058 of &$spam_score_int$&.
36059
36060 .vitem &%-tls_certificate_verified%&
36061 A TLS certificate was received from the client that sent this message, and the
36062 certificate was verified by the server.
36063
36064 .vitem "&%-tls_cipher%&&~<&'cipher name'&>"
36065 When the message was received over an encrypted connection, this records the
36066 name of the cipher suite that was used.
36067
36068 .vitem "&%-tls_peerdn%&&~<&'peer DN'&>"
36069 When the message was received over an encrypted connection, and a certificate
36070 was received from the client, this records the Distinguished Name from that
36071 certificate.
36072 .endlist
36073
36074 Following the options there is a list of those addresses to which the message
36075 is not to be delivered. This set of addresses is initialized from the command
36076 line when the &%-t%& option is used and &%extract_addresses_remove_arguments%&
36077 is set; otherwise it starts out empty. Whenever a successful delivery is made,
36078 the address is added to this set. The addresses are kept internally as a
36079 balanced binary tree, and it is a representation of that tree which is written
36080 to the spool file. If an address is expanded via an alias or forward file, the
36081 original address is added to the tree when deliveries to all its child
36082 addresses are complete.
36083
36084 If the tree is empty, there is a single line in the spool file containing just
36085 the text &"XX"&. Otherwise, each line consists of two letters, which are either
36086 Y or N, followed by an address. The address is the value for the node of the
36087 tree, and the letters indicate whether the node has a left branch and/or a
36088 right branch attached to it, respectively. If branches exist, they immediately
36089 follow. Here is an example of a three-node tree:
36090 .code
36091 YY darcy@austen.fict.example
36092 NN alice@wonderland.fict.example
36093 NN editor@thesaurus.ref.example
36094 .endd
36095 After the non-recipients tree, there is a list of the message's recipients.
36096 This is a simple list, preceded by a count. It includes all the original
36097 recipients of the message, including those to whom the message has already been
36098 delivered. In the simplest case, the list contains one address per line. For
36099 example:
36100 .code
36101 4
36102 editor@thesaurus.ref.example
36103 darcy@austen.fict.example
36104 rdo@foundation
36105 alice@wonderland.fict.example
36106 .endd
36107 However, when a child address has been added to the top-level addresses as a
36108 result of the use of the &%one_time%& option on a &(redirect)& router, each
36109 line is of the following form:
36110 .display
36111 <&'top-level address'&> <&'errors_to address'&> &&&
36112   <&'length'&>,<&'parent number'&>#<&'flag bits'&>
36113 .endd
36114 The 01 flag bit indicates the presence of the three other fields that follow
36115 the top-level address. Other bits may be used in future to support additional
36116 fields. The <&'parent number'&> is the offset in the recipients list of the
36117 original parent of the &"one time"& address. The first two fields are the
36118 envelope sender that is associated with this address and its length. If the
36119 length is zero, there is no special envelope sender (there are then two space
36120 characters in the line). A non-empty field can arise from a &(redirect)& router
36121 that has an &%errors_to%& setting.
36122
36123
36124 A blank line separates the envelope and status information from the headers
36125 which follow. A header may occupy several lines of the file, and to save effort
36126 when reading it in, each header is preceded by a number and an identifying
36127 character. The number is the number of characters in the header, including any
36128 embedded newlines and the terminating newline. The character is one of the
36129 following:
36130
36131 .table2 50pt
36132 .row <&'blank'&>         "header in which Exim has no special interest"
36133 .row &`B`&               "&'Bcc:'& header"
36134 .row &`C`&               "&'Cc:'& header"
36135 .row &`F`&               "&'From:'& header"
36136 .row &`I`&               "&'Message-id:'& header"
36137 .row &`P`&               "&'Received:'& header &-- P for &""postmark""&"
36138 .row &`R`&               "&'Reply-To:'& header"
36139 .row &`S`&               "&'Sender:'& header"
36140 .row &`T`&               "&'To:'& header"
36141 .row &`*`&               "replaced or deleted header"
36142 .endtable
36143
36144 Deleted or replaced (rewritten) headers remain in the spool file for debugging
36145 purposes. They are not transmitted when the message is delivered. Here is a
36146 typical set of headers:
36147 .code
36148 111P Received: by hobbit.fict.example with local (Exim 4.00)
36149 id 14y9EI-00026G-00; Fri, 11 May 2001 10:28:59 +0100
36150 049  Message-Id: <E14y9EI-00026G-00@hobbit.fict.example>
36151 038* X-rewrote-sender: bb@hobbit.fict.example
36152 042* From: Bilbo Baggins <bb@hobbit.fict.example>
36153 049F From: Bilbo Baggins <B.Baggins@hobbit.fict.example>
36154 099* To: alice@wonderland.fict.example, rdo@foundation,
36155 darcy@austen.fict.example, editor@thesaurus.ref.example
36156 104T To: alice@wonderland.fict.example, rdo@foundation.example,
36157 darcy@austen.fict.example, editor@thesaurus.ref.example
36158 038  Date: Fri, 11 May 2001 10:28:59 +0100
36159 .endd
36160 The asterisked headers indicate that the envelope sender, &'From:'& header, and
36161 &'To:'& header have been rewritten, the last one because routing expanded the
36162 unqualified domain &'foundation'&.
36163 .ecindex IIDforspo1
36164 .ecindex IIDforspo2
36165 .ecindex IIDforspo3
36166
36167 . ////////////////////////////////////////////////////////////////////////////
36168 . ////////////////////////////////////////////////////////////////////////////
36169
36170 .chapter "Support for DKIM (DomainKeys Identified Mail)" "CHAPdkim" &&&
36171          "DKIM Support"
36172 .cindex "DKIM"
36173
36174 DKIM is a mechanism by which messages sent by some entity can be provably
36175 linked to a domain which that entity controls.  It permits reputation to
36176 be tracked on a per-domain basis, rather than merely upon source IP address.
36177 DKIM is documented in RFC 4871.
36178
36179 Since version 4.70, DKIM support is compiled into Exim by default. It can be
36180 disabled by setting DISABLE_DKIM=yes in Local/Makefile.
36181
36182 Exim's DKIM implementation allows to
36183 .olist
36184 Sign outgoing messages: This function is implemented in the SMTP transport.
36185 It can co-exist with all other Exim features, including transport filters.
36186 .next
36187 Verify signatures in incoming messages: This is implemented by an additional
36188 ACL (acl_smtp_dkim), which can be called several times per message, with
36189 different signature contexts.
36190 .endlist
36191
36192 In typical Exim style, the verification implementation does not include any
36193 default "policy". Instead it enables you to build your own policy using
36194 Exim's standard controls.
36195
36196 Please note that verification of DKIM signatures in incoming mail is turned
36197 on by default for logging purposes. For each signature in incoming email,
36198 exim will log a line displaying the most important signature details, and the
36199 signature status. Here is an example (with line-breaks added for clarity):
36200 .code
36201 2009-09-09 10:22:28 1MlIRf-0003LU-U3 DKIM:
36202     d=facebookmail.com s=q1-2009b
36203     c=relaxed/relaxed a=rsa-sha1
36204     i=@facebookmail.com t=1252484542 [verification succeeded]
36205 .endd
36206 You might want to turn off DKIM verification processing entirely for internal
36207 or relay mail sources. To do that, set the &%dkim_disable_verify%& ACL
36208 control modifier. This should typically be done in the RCPT ACL, at points
36209 where you accept mail from relay sources (internal hosts or authenticated
36210 senders).
36211
36212
36213 .section "Signing outgoing messages" "SECID513"
36214 .cindex "DKIM" "signing"
36215
36216 Signing is implemented by setting private options on the SMTP transport.
36217 These options take (expandable) strings as arguments.
36218
36219 .option dkim_domain smtp string&!! unset
36220 MANDATORY:
36221 The domain you want to sign with. The result of this expanded
36222 option is put into the &%$dkim_domain%& expansion variable.
36223
36224 .option dkim_selector smtp string&!! unset
36225 MANDATORY:
36226 This sets the key selector string. You can use the &%$dkim_domain%& expansion
36227 variable to look up a matching selector. The result is put in the expansion
36228 variable &%$dkim_selector%& which should be used in the &%dkim_private_key%&
36229 option along with &%$dkim_domain%&.
36230
36231 .option dkim_private_key smtp string&!! unset
36232 MANDATORY:
36233 This sets the private key to use. You can use the &%$dkim_domain%& and
36234 &%$dkim_selector%& expansion variables to determine the private key to use.
36235 The result can either
36236 .ilist
36237 be a valid RSA private key in ASCII armor, including line breaks.
36238 .next
36239 start with a slash, in which case it is treated as a file that contains
36240 the private key.
36241 .next
36242 be "0", "false" or the empty string, in which case the message will not
36243 be signed. This case will not result in an error, even if &%dkim_strict%&
36244 is set.
36245 .endlist
36246
36247 .option dkim_canon smtp string&!! unset
36248 OPTIONAL:
36249 This option sets the canonicalization method used when signing a message.
36250 The DKIM RFC currently supports two methods: "simple" and "relaxed".
36251 The option defaults to "relaxed" when unset. Note: the current implementation
36252 only supports using the same canonicalization method for both headers and body.
36253
36254 .option dkim_strict smtp string&!! unset
36255 OPTIONAL:
36256 This  option  defines  how  Exim  behaves  when  signing a message that
36257 should be signed fails for some reason.  When the expansion evaluates to
36258 either "1" or "true", Exim will defer. Otherwise Exim will send the message
36259 unsigned. You can use the &%$dkim_domain%& and &%$dkim_selector%& expansion
36260 variables here.
36261
36262 .option dkim_sign_headers smtp string&!! unset
36263 OPTIONAL:
36264 When set, this option must expand to (or be specified as) a colon-separated
36265 list of header names. Headers with these names will be included in the message
36266 signature. When unspecified, the header names recommended in RFC4871 will be
36267 used.
36268
36269
36270 .section "Verifying DKIM signatures in incoming mail" "SECID514"
36271 .cindex "DKIM" "verification"
36272
36273 Verification of DKIM signatures in incoming email is implemented via the
36274 &%acl_smtp_dkim%& ACL. By default, this ACL is called once for each
36275 syntactically(!) correct signature in the incoming message.
36276
36277 To evaluate the signature in the ACL a large number of expansion variables
36278 containing the signature status and its details are set up during the
36279 runtime of the ACL.
36280
36281 Calling the ACL only for existing signatures is not sufficient to build
36282 more advanced policies. For that reason, the global option
36283 &%dkim_verify_signers%&, and a global expansion variable
36284 &%$dkim_signers%& exist.
36285
36286 The global option &%dkim_verify_signers%& can be set to a colon-separated
36287 list of DKIM domains or identities for which the ACL &%acl_smtp_dkim%& is
36288 called. It is expanded when the message has been received. At this point,
36289 the expansion variable &%$dkim_signers%& already contains a colon-separated
36290 list of signer domains and identities for the message. When
36291 &%dkim_verify_signers%& is not specified in the main configuration,
36292 it defaults as:
36293 .code
36294 dkim_verify_signers = $dkim_signers
36295 .endd
36296 This leads to the default behaviour of calling &%acl_smtp_dkim%& for each
36297 DKIM signature in the message. Current DKIM verifiers may want to explicitly
36298 call the ACL for known domains or identities. This would be achieved as follows:
36299 .code
36300 dkim_verify_signers = paypal.com:ebay.com:$dkim_signers
36301 .endd
36302 This would result in &%acl_smtp_dkim%& always being called for "paypal.com"
36303 and "ebay.com", plus all domains and identities that have signatures in the message.
36304 You can also be more creative in constructing your policy. For example:
36305 .code
36306 dkim_verify_signers = $sender_address_domain:$dkim_signers
36307 .endd
36308
36309 If a domain or identity is listed several times in the (expanded) value of
36310 &%dkim_verify_signers%&, the ACL is only called once for that domain or identity.
36311
36312
36313 Inside the &%acl_smtp_dkim%&, the following expansion variables are
36314 available (from most to least important):
36315
36316
36317 .vlist
36318 .vitem &%$dkim_cur_signer%&
36319 The signer that is being evaluated in this ACL run. This can be a domain or
36320 an identity. This is one of the list items from the expanded main option
36321 &%dkim_verify_signers%& (see above).
36322 .vitem &%$dkim_verify_status%&
36323 A string describing the general status of the signature. One of
36324 .ilist
36325 &%none%&: There is no signature in the message for the current domain or
36326 identity (as reflected by &%$dkim_cur_signer%&).
36327 .next
36328 &%invalid%&: The signature could not be verified due to a processing error.
36329 More detail is available in &%$dkim_verify_reason%&.
36330 .next
36331 &%fail%&: Verification of the signature failed.  More detail is
36332 available in &%$dkim_verify_reason%&.
36333 .next
36334 &%pass%&: The signature passed verification. It is valid.
36335 .endlist
36336 .vitem &%$dkim_verify_reason%&
36337 A string giving a litte bit more detail when &%$dkim_verify_status%& is either
36338 "fail" or "invalid". One of
36339 .ilist
36340 &%pubkey_unavailable%& (when &%$dkim_verify_status%&="invalid"): The public
36341 key for the domain could not be retrieved. This may be a temporary problem.
36342 .next
36343 &%pubkey_syntax%& (when &%$dkim_verify_status%&="invalid"): The public key
36344 record for the domain is syntactically invalid.
36345 .next
36346 &%bodyhash_mismatch%& (when &%$dkim_verify_status%&="fail"): The calculated
36347 body hash does not match the one specified in the signature header. This
36348 means that the message body was modified in transit.
36349 .next
36350 &%signature_incorrect%& (when &%$dkim_verify_status%&="fail"): The signature
36351 could not be verified. This may mean that headers were modified,
36352 re-written or otherwise changed in a way which is incompatible with
36353 DKIM verification. It may of course also mean that the signature is forged.
36354 .endlist
36355 .vitem &%$dkim_domain%&
36356 The signing domain. IMPORTANT: This variable is only populated if there is
36357 an actual signature in the message for the current domain or identity (as
36358 reflected by &%$dkim_cur_signer%&).
36359 .vitem &%$dkim_identity%&
36360 The signing identity, if present. IMPORTANT: This variable is only populated
36361 if there is an actual signature in the message for the current domain or
36362 identity (as reflected by &%$dkim_cur_signer%&).
36363 .vitem &%$dkim_selector%&
36364 The key record selector string.
36365 .vitem &%$dkim_algo%&
36366 The algorithm used. One of 'rsa-sha1' or 'rsa-sha256'.
36367 .vitem &%$dkim_canon_body%&
36368 The body canonicalization method. One of 'relaxed' or 'simple'.
36369 .vitem &%dkim_canon_headers%&
36370 The header canonicalization method. One of 'relaxed' or 'simple'.
36371 .vitem &%$dkim_copiedheaders%&
36372 A transcript of headers and their values which are included in the signature
36373 (copied from the 'z=' tag of the signature).
36374 .vitem &%$dkim_bodylength%&
36375 The number of signed body bytes. If zero ("0"), the body is unsigned. If no
36376 limit was set by the signer, "9999999999999" is returned. This makes sure
36377 that this variable always expands to an integer value.
36378 .vitem &%$dkim_created%&
36379 UNIX timestamp reflecting the date and time when the signature was created.
36380 When this was not specified by the signer, "0" is returned.
36381 .vitem &%$dkim_expires%&
36382 UNIX timestamp reflecting the date and time when the signer wants the
36383 signature to be treated as "expired". When this was not specified by the
36384 signer, "9999999999999" is returned. This makes it possible to do useful
36385 integer size comparisons against this value.
36386 .vitem &%$dkim_headernames%&
36387 A colon-separated list of names of headers included in the signature.
36388 .vitem &%$dkim_key_testing%&
36389 "1" if the key record has the "testing" flag set, "0" if not.
36390 .vitem &%$nosubdomains%&
36391 "1" if the key record forbids subdomaining, "0" otherwise.
36392 .vitem &%$dkim_key_srvtype%&
36393 Service type (tag s=) from the key record. Defaults to "*" if not specified
36394 in the key record.
36395 .vitem &%$dkim_key_granularity%&
36396 Key granularity (tag g=) from the key record. Defaults to "*" if not specified
36397 in the key record.
36398 .vitem &%$dkim_key_notes%&
36399 Notes from the key record (tag n=).
36400 .endlist
36401
36402 In addition, two ACL conditions are provided:
36403
36404 .vlist
36405 .vitem &%dkim_signers%&
36406 ACL condition that checks a colon-separated list of domains or identities
36407 for a match against the domain or identity that the ACL is currently verifying
36408 (reflected by &%$dkim_cur_signer%&). This is typically used to restrict an ACL
36409 verb to a group of domains or identities. For example:
36410
36411 .code
36412 # Warn when Mail purportedly from GMail has no signature at all
36413 warn log_message = GMail sender without DKIM signature
36414      sender_domains = gmail.com
36415      dkim_signers = gmail.com
36416      dkim_status = none
36417 .endd
36418
36419 .vitem &%dkim_status%&
36420 ACL condition that checks a colon-separated list of possible DKIM verification
36421 results against the actual result of verification. This is typically used
36422 to restrict an ACL verb to a list of verification outcomes, for example:
36423
36424 .code
36425 deny message = Mail from Paypal with invalid/missing signature
36426      sender_domains = paypal.com:paypal.de
36427      dkim_signers = paypal.com:paypal.de
36428      dkim_status = none:invalid:fail
36429 .endd
36430
36431 The possible status keywords are: 'none','invalid','fail' and 'pass'. Please
36432 see the documentation of the &%$dkim_verify_status%& expansion variable above
36433 for more information of what they mean.
36434 .endlist
36435
36436 . ////////////////////////////////////////////////////////////////////////////
36437 . ////////////////////////////////////////////////////////////////////////////
36438
36439 .chapter "Adding new drivers or lookup types" "CHID13" &&&
36440          "Adding drivers or lookups"
36441 .cindex "adding drivers"
36442 .cindex "new drivers, adding"
36443 .cindex "drivers" "adding new"
36444 The following actions have to be taken in order to add a new router, transport,
36445 authenticator, or lookup type to Exim:
36446
36447 .olist
36448 Choose a name for the driver or lookup type that does not conflict with any
36449 existing name; I will use &"newdriver"& in what follows.
36450 .next
36451 Add to &_src/EDITME_& the line:
36452 .display
36453 <&'type'&>&`_NEWDRIVER=yes`&
36454 .endd
36455 where <&'type'&> is ROUTER, TRANSPORT, AUTH, or LOOKUP. If the
36456 code is not to be included in the binary by default, comment this line out. You
36457 should also add any relevant comments about the driver or lookup type.
36458 .next
36459 Add to &_src/config.h.defaults_& the line:
36460 .code
36461 #define <type>_NEWDRIVER
36462 .endd
36463 .next
36464 Edit &_src/drtables.c_&, adding conditional code to pull in the private header
36465 and create a table entry as is done for all the other drivers and lookup types.
36466 .next
36467 Edit &_scripts/lookups-Makefile_& if this is a new lookup; there is a for-loop
36468 near the bottom, ranging the &`name_mod`& variable over a list of all lookups.
36469 Add your &`NEWDRIVER`& to that list.
36470 As long as the dynamic module would be named &_newdriver.so_&, you can use the
36471 simple form that most lookups have.
36472 .next
36473 Edit &_Makefile_& in the appropriate sub-directory (&_src/routers_&,
36474 &_src/transports_&, &_src/auths_&, or &_src/lookups_&); add a line for the new
36475 driver or lookup type and add it to the definition of OBJ.
36476 .next
36477 Create &_newdriver.h_& and &_newdriver.c_& in the appropriate sub-directory of
36478 &_src_&.
36479 .next
36480 Edit &_scripts/MakeLinks_& and add commands to link the &_.h_& and &_.c_& files
36481 as for other drivers and lookups.
36482 .endlist
36483
36484 Then all you need to do is write the code! A good way to start is to make a
36485 proforma by copying an existing module of the same type, globally changing all
36486 occurrences of the name, and cutting out most of the code. Note that any
36487 options you create must be listed in alphabetical order, because the tables are
36488 searched using a binary chop procedure.
36489
36490 There is a &_README_& file in each of the sub-directories of &_src_& describing
36491 the interface that is expected.
36492
36493
36494
36495
36496 . ////////////////////////////////////////////////////////////////////////////
36497 . ////////////////////////////////////////////////////////////////////////////
36498
36499 . /////////////////////////////////////////////////////////////////////////////
36500 . These lines are processing instructions for the Simple DocBook Processor that
36501 . Philip Hazel has developed as a less cumbersome way of making PostScript and
36502 . PDFs than using xmlto and fop. They will be ignored by all other XML
36503 . processors.
36504 . /////////////////////////////////////////////////////////////////////////////
36505
36506 .literal xml
36507 <?sdop
36508   format="newpage"
36509   foot_right_recto="&chaptertitle;"
36510   foot_right_verso="&chaptertitle;"
36511 ?>
36512 .literal off
36513
36514 .makeindex "Options index"   "option"
36515 .makeindex "Variables index" "variable"
36516 .makeindex "Concept index"   "concept"
36517
36518
36519 . /////////////////////////////////////////////////////////////////////////////
36520 . /////////////////////////////////////////////////////////////////////////////