6b63062be49440008d5ffc81bfc6e4590ca41d58
[users/jgh/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. Remember that
45 . the <bookinfo> element must also be updated for each new edition.
46 . /////////////////////////////////////////////////////////////////////////////
47
48 .set previousversion "4.80"
49 .set version "4.80"
50
51 .set ACL "access control lists (ACLs)"
52 .set I   "&nbsp;&nbsp;&nbsp;&nbsp;"
53
54
55 . /////////////////////////////////////////////////////////////////////////////
56 . Additional xfpt markup used by this document, over and above the default
57 . provided in the xfpt library.
58 . /////////////////////////////////////////////////////////////////////////////
59
60 . --- Override the &$ flag to automatically insert a $ with the variable name
61
62 .flag &$  $&   "<varname>$"  "</varname>"
63
64 . --- Short flags for daggers in option headings. They will always be inside
65 . --- an italic string, but we want the daggers to be roman.
66
67 .flag &!!      "</emphasis>&dagger;<emphasis>"
68 .flag &!?      "</emphasis>&Dagger;<emphasis>"
69
70 . --- A macro for an Exim option definition heading, generating a one-line
71 . --- table with four columns. For cases when the option name is given with
72 . --- a space, so that it can be split, a fifth argument is used for the
73 . --- index entry.
74
75 .macro option
76 .arg 5
77 .oindex "&%$5%&"
78 .endarg
79 .arg -5
80 .oindex "&%$1%&"
81 .endarg
82 .itable all 0 0 4 8* left 6* center 6* center 6* right
83 .row "&%$1%&" "Use: &'$2'&" "Type: &'$3'&" "Default: &'$4'&"
84 .endtable
85 .endmacro
86
87 . --- A macro for the common 2-column tables. The width of the first column
88 . --- is suitable for the many tables at the start of the main options chapter;
89 . --- the small number of other 2-column tables override it.
90
91 .macro table2 196pt 254pt
92 .itable none 0 0 2 $1 left $2 left
93 .endmacro
94
95 . --- A macro that generates .row, but puts &I; at the start of the first
96 . --- argument, thus indenting it. Assume a minimum of two arguments, and
97 . --- allow up to four arguments, which is as many as we'll ever need.
98
99 .macro irow
100 .arg 4
101 .row "&I;$1" "$2" "$3" "$4"
102 .endarg
103 .arg -4
104 .arg 3
105 .row "&I;$1" "$2" "$3"
106 .endarg
107 .arg -3
108 .row "&I;$1" "$2"
109 .endarg
110 .endarg
111 .endmacro
112
113 . --- Macros for option, variable, and concept index entries. For a "range"
114 . --- style of entry, use .scindex for the start and .ecindex for the end. The
115 . --- first argument of .scindex and the only argument of .ecindex must be the
116 . --- ID that ties them together.
117
118 .macro cindex
119 &<indexterm role="concept">&
120 &<primary>&$1&</primary>&
121 .arg 2
122 &<secondary>&$2&</secondary>&
123 .endarg
124 &</indexterm>&
125 .endmacro
126
127 .macro scindex
128 &<indexterm role="concept" id="$1" class="startofrange">&
129 &<primary>&$2&</primary>&
130 .arg 3
131 &<secondary>&$3&</secondary>&
132 .endarg
133 &</indexterm>&
134 .endmacro
135
136 .macro ecindex
137 &<indexterm role="concept" startref="$1" class="endofrange"/>&
138 .endmacro
139
140 .macro oindex
141 &<indexterm role="option">&
142 &<primary>&$1&</primary>&
143 .arg 2
144 &<secondary>&$2&</secondary>&
145 .endarg
146 &</indexterm>&
147 .endmacro
148
149 .macro vindex
150 &<indexterm role="variable">&
151 &<primary>&$1&</primary>&
152 .arg 2
153 &<secondary>&$2&</secondary>&
154 .endarg
155 &</indexterm>&
156 .endmacro
157
158 .macro index
159 .echo "** Don't use .index; use .cindex or .oindex or .vindex"
160 .endmacro
161 . ////////////////////////////////////////////////////////////////////////////
162
163
164 . ////////////////////////////////////////////////////////////////////////////
165 . The <bookinfo> element is removed from the XML before processing for Ascii
166 . output formats.
167 . ////////////////////////////////////////////////////////////////////////////
168
169 .literal xml
170 <bookinfo>
171 <title>Specification of the Exim Mail Transfer Agent</title>
172 <titleabbrev>The Exim MTA</titleabbrev>
173 <date>17 May 2012</date>
174 <author><firstname>Exim</firstname><surname>Maintainers</surname></author>
175 <authorinitials>EM</authorinitials>
176 <revhistory><revision>
177   <revnumber>4.80</revnumber>
178   <date>17 May 2012</date>
179   <authorinitials>EM</authorinitials>
180 </revision></revhistory>
181 <copyright><year>2012</year><holder>University of Cambridge</holder></copyright>
182 </bookinfo>
183 .literal off
184
185
186 . /////////////////////////////////////////////////////////////////////////////
187 . This chunk of literal XML implements index entries of the form "x, see y" and
188 . "x, see also y". However, the DocBook DTD doesn't allow <indexterm> entries
189 . at the top level, so we have to put the .chapter directive first.
190 . /////////////////////////////////////////////////////////////////////////////
191
192 .chapter "Introduction" "CHID1"
193 .literal xml
194
195 <indexterm role="variable">
196   <primary>$1, $2, etc.</primary>
197   <see><emphasis>numerical variables</emphasis></see>
198 </indexterm>
199 <indexterm role="concept">
200   <primary>address</primary>
201   <secondary>rewriting</secondary>
202   <see><emphasis>rewriting</emphasis></see>
203 </indexterm>
204 <indexterm role="concept">
205   <primary>Bounce Address Tag Validation</primary>
206   <see><emphasis>BATV</emphasis></see>
207 </indexterm>
208 <indexterm role="concept">
209   <primary>Client SMTP Authorization</primary>
210   <see><emphasis>CSA</emphasis></see>
211 </indexterm>
212 <indexterm role="concept">
213   <primary>CR character</primary>
214   <see><emphasis>carriage return</emphasis></see>
215 </indexterm>
216 <indexterm role="concept">
217   <primary>CRL</primary>
218   <see><emphasis>certificate revocation list</emphasis></see>
219 </indexterm>
220 <indexterm role="concept">
221   <primary>delivery</primary>
222   <secondary>failure report</secondary>
223   <see><emphasis>bounce message</emphasis></see>
224 </indexterm>
225 <indexterm role="concept">
226   <primary>dialup</primary>
227   <see><emphasis>intermittently connected hosts</emphasis></see>
228 </indexterm>
229 <indexterm role="concept">
230   <primary>exiscan</primary>
231   <see><emphasis>content scanning</emphasis></see>
232 </indexterm>
233 <indexterm role="concept">
234   <primary>failover</primary>
235   <see><emphasis>fallback</emphasis></see>
236 </indexterm>
237 <indexterm role="concept">
238   <primary>fallover</primary>
239   <see><emphasis>fallback</emphasis></see>
240 </indexterm>
241 <indexterm role="concept">
242   <primary>filter</primary>
243   <secondary>Sieve</secondary>
244   <see><emphasis>Sieve filter</emphasis></see>
245 </indexterm>
246 <indexterm role="concept">
247   <primary>ident</primary>
248   <see><emphasis>RFC 1413</emphasis></see>
249 </indexterm>
250 <indexterm role="concept">
251   <primary>LF character</primary>
252   <see><emphasis>linefeed</emphasis></see>
253 </indexterm>
254 <indexterm role="concept">
255   <primary>maximum</primary>
256   <seealso><emphasis>limit</emphasis></seealso>
257 </indexterm>
258 <indexterm role="concept">
259   <primary>monitor</primary>
260   <see><emphasis>Exim monitor</emphasis></see>
261 </indexterm>
262 <indexterm role="concept">
263   <primary>no_<emphasis>xxx</emphasis></primary>
264   <see>entry for xxx</see>
265 </indexterm>
266 <indexterm role="concept">
267   <primary>NUL</primary>
268   <see><emphasis>binary zero</emphasis></see>
269 </indexterm>
270 <indexterm role="concept">
271   <primary>passwd file</primary>
272   <see><emphasis>/etc/passwd</emphasis></see>
273 </indexterm>
274 <indexterm role="concept">
275   <primary>process id</primary>
276   <see><emphasis>pid</emphasis></see>
277 </indexterm>
278 <indexterm role="concept">
279   <primary>RBL</primary>
280   <see><emphasis>DNS list</emphasis></see>
281 </indexterm>
282 <indexterm role="concept">
283   <primary>redirection</primary>
284   <see><emphasis>address redirection</emphasis></see>
285 </indexterm>
286 <indexterm role="concept">
287   <primary>return path</primary>
288   <seealso><emphasis>envelope sender</emphasis></seealso>
289 </indexterm>
290 <indexterm role="concept">
291   <primary>scanning</primary>
292   <see><emphasis>content scanning</emphasis></see>
293 </indexterm>
294 <indexterm role="concept">
295   <primary>SSL</primary>
296   <see><emphasis>TLS</emphasis></see>
297 </indexterm>
298 <indexterm role="concept">
299   <primary>string</primary>
300   <secondary>expansion</secondary>
301   <see><emphasis>expansion</emphasis></see>
302 </indexterm>
303 <indexterm role="concept">
304   <primary>top bit</primary>
305   <see><emphasis>8-bit characters</emphasis></see>
306 </indexterm>
307 <indexterm role="concept">
308   <primary>variables</primary>
309   <see><emphasis>expansion, variables</emphasis></see>
310 </indexterm>
311 <indexterm role="concept">
312   <primary>zero, binary</primary>
313   <see><emphasis>binary zero</emphasis></see>
314 </indexterm>
315
316 .literal off
317
318
319 . /////////////////////////////////////////////////////////////////////////////
320 . This is the real start of the first chapter. See the comment above as to why
321 . we can't have the .chapter line here.
322 . chapter "Introduction"
323 . /////////////////////////////////////////////////////////////////////////////
324
325 Exim is a mail transfer agent (MTA) for hosts that are running Unix or
326 Unix-like operating systems. It was designed on the assumption that it would be
327 run on hosts that are permanently connected to the Internet. However, it can be
328 used on intermittently connected hosts with suitable configuration adjustments.
329
330 Configuration files currently exist for the following operating systems: AIX,
331 BSD/OS (aka BSDI), Darwin (Mac OS X), DGUX, Dragonfly, FreeBSD, GNU/Hurd,
332 GNU/Linux, HI-OSF (Hitachi), HI-UX, HP-UX, IRIX, MIPS RISCOS, NetBSD, OpenBSD,
333 OpenUNIX, QNX, SCO, SCO SVR4.2 (aka UNIX-SV), Solaris (aka SunOS5), SunOS4,
334 Tru64-Unix (formerly Digital UNIX, formerly DEC-OSF1), Ultrix, and Unixware.
335 Some of these operating systems are no longer current and cannot easily be
336 tested, so the configuration files may no longer work in practice.
337
338 There are also configuration files for compiling Exim in the Cygwin environment
339 that can be installed on systems running Windows. However, this document does
340 not contain any information about running Exim in the Cygwin environment.
341
342 The terms and conditions for the use and distribution of Exim are contained in
343 the file &_NOTICE_&. Exim is distributed under the terms of the GNU General
344 Public Licence, a copy of which may be found in the file &_LICENCE_&.
345
346 The use, supply or promotion of Exim for the purpose of sending bulk,
347 unsolicited electronic mail is incompatible with the basic aims of the program,
348 which revolve around the free provision of a service that enhances the quality
349 of personal communications. The author of Exim regards indiscriminate
350 mass-mailing as an antisocial, irresponsible abuse of the Internet.
351
352 Exim owes a great deal to Smail 3 and its author, Ron Karr. Without the
353 experience of running and working on the Smail 3 code, I could never have
354 contemplated starting to write a new MTA. Many of the ideas and user interfaces
355 were originally taken from Smail 3, though the actual code of Exim is entirely
356 new, and has developed far beyond the initial concept.
357
358 Many people, both in Cambridge and around the world, have contributed to the
359 development and the testing of Exim, and to porting it to various operating
360 systems. I am grateful to them all. The distribution now contains a file called
361 &_ACKNOWLEDGMENTS_&, in which I have started recording the names of
362 contributors.
363
364
365 .section "Exim documentation" "SECID1"
366 . Keep this example change bar when updating the documentation!
367
368 .new
369 .cindex "documentation"
370 This edition of the Exim specification applies to version &version; of Exim.
371 Substantive changes from the &previousversion; edition are marked in some
372 renditions of the document; this paragraph is so marked if the rendition is
373 capable of showing a change indicator.
374 .wen
375
376 This document is very much a reference manual; it is not a tutorial. The reader
377 is expected to have some familiarity with the SMTP mail transfer protocol and
378 with general Unix system administration. Although there are some discussions
379 and examples in places, the information is mostly organized in a way that makes
380 it easy to look up, rather than in a natural order for sequential reading.
381 Furthermore, the manual aims to cover every aspect of Exim in detail, including
382 a number of rarely-used, special-purpose features that are unlikely to be of
383 very wide interest.
384
385 .cindex "books about Exim"
386 An &"easier"& discussion of Exim which provides more in-depth explanatory,
387 introductory, and tutorial material can be found in a book entitled &'The Exim
388 SMTP Mail Server'& (second edition, 2007), published by UIT Cambridge
389 (&url(http://www.uit.co.uk/exim-book/)).
390
391 This book also contains a chapter that gives a general introduction to SMTP and
392 Internet mail. Inevitably, however, the book is unlikely to be fully up-to-date
393 with the latest release of Exim. (Note that the earlier book about Exim,
394 published by O'Reilly, covers Exim 3, and many things have changed in Exim 4.)
395
396 .cindex "Debian" "information sources"
397 If you are using a Debian distribution of Exim, you will find information about
398 Debian-specific features in the file
399 &_/usr/share/doc/exim4-base/README.Debian_&.
400 The command &(man update-exim.conf)& is another source of Debian-specific
401 information.
402
403 .cindex "&_doc/NewStuff_&"
404 .cindex "&_doc/ChangeLog_&"
405 .cindex "change log"
406 As the program develops, there may be features in newer versions that have not
407 yet made it into this document, which is updated only when the most significant
408 digit of the fractional part of the version number changes. Specifications of
409 new features that are not yet in this manual are placed in the file
410 &_doc/NewStuff_& in the Exim distribution.
411
412 Some features may be classified as &"experimental"&. These may change
413 incompatibly while they are developing, or even be withdrawn. For this reason,
414 they are not documented in this manual. Information about experimental features
415 can be found in the file &_doc/experimental.txt_&.
416
417 All changes to the program (whether new features, bug fixes, or other kinds of
418 change) are noted briefly in the file called &_doc/ChangeLog_&.
419
420 .cindex "&_doc/spec.txt_&"
421 This specification itself is available as an ASCII file in &_doc/spec.txt_& so
422 that it can easily be searched with a text editor. Other files in the &_doc_&
423 directory are:
424
425 .table2 100pt
426 .row &_OptionLists.txt_&     "list of all options in alphabetical order"
427 .row &_dbm.discuss.txt_&     "discussion about DBM libraries"
428 .row &_exim.8_&              "a man page of Exim's command line options"
429 .row &_experimental.txt_&    "documentation of experimental features"
430 .row &_filter.txt_&          "specification of the filter language"
431 .row &_Exim3.upgrade_&       "upgrade notes from release 2 to release 3"
432 .row &_Exim4.upgrade_&       "upgrade notes from release 3 to release 4"
433 .endtable
434
435 The main specification and the specification of the filtering language are also
436 available in other formats (HTML, PostScript, PDF, and Texinfo). Section
437 &<<SECTavail>>& below tells you how to get hold of these.
438
439
440
441 .section "FTP and web sites" "SECID2"
442 .cindex "web site"
443 .cindex "FTP site"
444 The primary site for Exim source distributions is currently the University of
445 Cambridge's FTP site, whose contents are described in &'Where to find the Exim
446 distribution'& below. In addition, there is a web site and an FTP site at
447 &%exim.org%&. These are now also hosted at the University of Cambridge. The
448 &%exim.org%& site was previously hosted for a number of years by Energis
449 Squared, formerly Planet Online Ltd, whose support I gratefully acknowledge.
450
451 .cindex "wiki"
452 .cindex "FAQ"
453 As well as Exim distribution tar files, the Exim web site contains a number of
454 differently formatted versions of the documentation. A recent addition to the
455 online information is the Exim wiki (&url(http://wiki.exim.org)),
456 which contains what used to be a separate FAQ, as well as various other
457 examples, tips, and know-how that have been contributed by Exim users.
458
459 .cindex Bugzilla
460 An Exim Bugzilla exists at &url(http://bugs.exim.org). You can use
461 this to report bugs, and also to add items to the wish list. Please search
462 first to check that you are not duplicating a previous entry.
463
464
465
466 .section "Mailing lists" "SECID3"
467 .cindex "mailing lists" "for Exim users"
468 The following Exim mailing lists exist:
469
470 .table2 140pt
471 .row &'exim-announce@exim.org'&   "Moderated, low volume announcements list"
472 .row &'exim-users@exim.org'&      "General discussion list"
473 .row &'exim-dev@exim.org'&        "Discussion of bugs, enhancements, etc."
474 .row &'exim-cvs@exim.org'&        "Automated commit messages from the VCS"
475 .endtable
476
477 You can subscribe to these lists, change your existing subscriptions, and view
478 or search the archives via the mailing lists link on the Exim home page.
479 .cindex "Debian" "mailing list for"
480 If you are using a Debian distribution of Exim, you may wish to subscribe to
481 the Debian-specific mailing list &'pkg-exim4-users@lists.alioth.debian.org'&
482 via this web page:
483 .display
484 &url(http://lists.alioth.debian.org/mailman/listinfo/pkg-exim4-users)
485 .endd
486 Please ask Debian-specific questions on this list and not on the general Exim
487 lists.
488
489 .section "Exim training" "SECID4"
490 .cindex "training courses"
491 Training courses in Cambridge (UK) used to be run annually by the author of
492 Exim, before he retired. At the time of writing, there are no plans to run
493 further Exim courses in Cambridge. However, if that changes, relevant
494 information will be posted at &url(http://www-tus.csx.cam.ac.uk/courses/exim/).
495
496 .section "Bug reports" "SECID5"
497 .cindex "bug reports"
498 .cindex "reporting bugs"
499 Reports of obvious bugs can be emailed to &'bugs@exim.org'& or reported
500 via the Bugzilla (&url(http://bugs.exim.org)). However, if you are unsure
501 whether some behaviour is a bug or not, the best thing to do is to post a
502 message to the &'exim-dev'& mailing list and have it discussed.
503
504
505
506 .section "Where to find the Exim distribution" "SECTavail"
507 .cindex "FTP site"
508 .cindex "distribution" "ftp site"
509 The master ftp site for the Exim distribution is
510 .display
511 &*ftp://ftp.csx.cam.ac.uk/pub/software/email/exim*&
512 .endd
513 This is mirrored by
514 .display
515 &*ftp://ftp.exim.org/pub/exim*&
516 .endd
517 The file references that follow are relative to the &_exim_& directories at
518 these sites. There are now quite a number of independent mirror sites around
519 the world. Those that I know about are listed in the file called &_Mirrors_&.
520
521 Within the &_exim_& directory there are subdirectories called &_exim3_& (for
522 previous Exim 3 distributions), &_exim4_& (for the latest Exim 4
523 distributions), and &_Testing_& for testing versions. In the &_exim4_&
524 subdirectory, the current release can always be found in files called
525 .display
526 &_exim-n.nn.tar.gz_&
527 &_exim-n.nn.tar.bz2_&
528 .endd
529 where &'n.nn'& is the highest such version number in the directory. The two
530 files contain identical data; the only difference is the type of compression.
531 The &_.bz2_& file is usually a lot smaller than the &_.gz_& file.
532
533 .cindex "distribution" "signing details"
534 .cindex "distribution" "public key"
535 .cindex "public key for signed distribution"
536 .new
537 The distributions will be PGP signed by an individual key of the Release
538 Coordinator.  This key will have a uid containing an email address in the
539 &'exim.org'& domain and will have signatures from other people, including
540 other Exim maintainers.  We expect that the key will be in the "strong set" of
541 PGP keys.  There should be a trust path to that key from Nigel Metheringham's
542 PGP key, a version of which can be found in the release directory in the file
543 &_nigel-pubkey.asc_&.  All keys used will be available in public keyserver pools,
544 such as &'pool.sks-keyservers.net'&.
545
546 At time of last update, releases were being made by Phil Pennock and signed with
547 key &'0x403043153903637F'&, although that key is expected to be replaced in 2013.
548 A trust path from Nigel's key to Phil's can be observed at
549 &url(https://www.security.spodhuis.org/exim-trustpath).
550 .wen
551
552 The signatures for the tar bundles are in:
553 .display
554 &_exim-n.nn.tar.gz.asc_&
555 &_exim-n.nn.tar.bz2.asc_&
556 .endd
557 For each released version, the log of changes is made separately available in a
558 separate file in the directory &_ChangeLogs_& so that it is possible to
559 find out what has changed without having to download the entire distribution.
560
561 .cindex "documentation" "available formats"
562 The main distribution contains ASCII versions of this specification and other
563 documentation; other formats of the documents are available in separate files
564 inside the &_exim4_& directory of the FTP site:
565 .display
566 &_exim-html-n.nn.tar.gz_&
567 &_exim-pdf-n.nn.tar.gz_&
568 &_exim-postscript-n.nn.tar.gz_&
569 &_exim-texinfo-n.nn.tar.gz_&
570 .endd
571 These tar files contain only the &_doc_& directory, not the complete
572 distribution, and are also available in &_.bz2_& as well as &_.gz_& forms.
573
574
575 .section "Limitations" "SECID6"
576 .ilist
577 .cindex "limitations of Exim"
578 .cindex "bang paths" "not handled by Exim"
579 Exim is designed for use as an Internet MTA, and therefore handles addresses in
580 RFC 2822 domain format only. It cannot handle UUCP &"bang paths"&, though
581 simple two-component bang paths can be converted by a straightforward rewriting
582 configuration. This restriction does not prevent Exim from being interfaced to
583 UUCP as a transport mechanism, provided that domain addresses are used.
584 .next
585 .cindex "domainless addresses"
586 .cindex "address" "without domain"
587 Exim insists that every address it handles has a domain attached. For incoming
588 local messages, domainless addresses are automatically qualified with a
589 configured domain value. Configuration options specify from which remote
590 systems unqualified addresses are acceptable. These are then qualified on
591 arrival.
592 .next
593 .cindex "transport" "external"
594 .cindex "external transports"
595 The only external transport mechanisms that are currently implemented are SMTP
596 and LMTP over a TCP/IP network (including support for IPv6). However, a pipe
597 transport is available, and there are facilities for writing messages to files
598 and pipes, optionally in &'batched SMTP'& format; these facilities can be used
599 to send messages to other transport mechanisms such as UUCP, provided they can
600 handle domain-style addresses. Batched SMTP input is also catered for.
601 .next
602 Exim is not designed for storing mail for dial-in hosts. When the volumes of
603 such mail are large, it is better to get the messages &"delivered"& into files
604 (that is, off Exim's queue) and subsequently passed on to the dial-in hosts by
605 other means.
606 .next
607 Although Exim does have basic facilities for scanning incoming messages, these
608 are not comprehensive enough to do full virus or spam scanning. Such operations
609 are best carried out using additional specialized software packages. If you
610 compile Exim with the content-scanning extension, straightforward interfaces to
611 a number of common scanners are provided.
612 .endlist
613
614
615 .section "Run time configuration" "SECID7"
616 Exim's run time configuration is held in a single text file that is divided
617 into a number of sections. The entries in this file consist of keywords and
618 values, in the style of Smail 3 configuration files. A default configuration
619 file which is suitable for simple online installations is provided in the
620 distribution, and is described in chapter &<<CHAPdefconfil>>& below.
621
622
623 .section "Calling interface" "SECID8"
624 .cindex "Sendmail compatibility" "command line interface"
625 Like many MTAs, Exim has adopted the Sendmail command line interface so that it
626 can be a straight replacement for &_/usr/lib/sendmail_& or
627 &_/usr/sbin/sendmail_& when sending mail, but you do not need to know anything
628 about Sendmail in order to run Exim. For actions other than sending messages,
629 Sendmail-compatible options also exist, but those that produce output (for
630 example, &%-bp%&, which lists the messages on the queue) do so in Exim's own
631 format. There are also some additional options that are compatible with Smail
632 3, and some further options that are new to Exim. Chapter &<<CHAPcommandline>>&
633 documents all Exim's command line options. This information is automatically
634 made into the man page that forms part of the Exim distribution.
635
636 Control of messages on the queue can be done via certain privileged command
637 line options. There is also an optional monitor program called &'eximon'&,
638 which displays current information in an X window, and which contains a menu
639 interface to Exim's command line administration options.
640
641
642
643 .section "Terminology" "SECID9"
644 .cindex "terminology definitions"
645 .cindex "body of message" "definition of"
646 The &'body'& of a message is the actual data that the sender wants to transmit.
647 It is the last part of a message, and is separated from the &'header'& (see
648 below) by a blank line.
649
650 .cindex "bounce message" "definition of"
651 When a message cannot be delivered, it is normally returned to the sender in a
652 delivery failure message or a &"non-delivery report"& (NDR). The term
653 &'bounce'& is commonly used for this action, and the error reports are often
654 called &'bounce messages'&. This is a convenient shorthand for &"delivery
655 failure error report"&. Such messages have an empty sender address in the
656 message's &'envelope'& (see below) to ensure that they cannot themselves give
657 rise to further bounce messages.
658
659 The term &'default'& appears frequently in this manual. It is used to qualify a
660 value which is used in the absence of any setting in the configuration. It may
661 also qualify an action which is taken unless a configuration setting specifies
662 otherwise.
663
664 The term &'defer'& is used when the delivery of a message to a specific
665 destination cannot immediately take place for some reason (a remote host may be
666 down, or a user's local mailbox may be full). Such deliveries are &'deferred'&
667 until a later time.
668
669 The word &'domain'& is sometimes used to mean all but the first component of a
670 host's name. It is &'not'& used in that sense here, where it normally refers to
671 the part of an email address following the @ sign.
672
673 .cindex "envelope, definition of"
674 .cindex "sender" "definition of"
675 A message in transit has an associated &'envelope'&, as well as a header and a
676 body. The envelope contains a sender address (to which bounce messages should
677 be delivered), and any number of recipient addresses. References to the
678 sender or the recipients of a message usually mean the addresses in the
679 envelope. An MTA uses these addresses for delivery, and for returning bounce
680 messages, not the addresses that appear in the header lines.
681
682 .cindex "message" "header, definition of"
683 .cindex "header section" "definition of"
684 The &'header'& of a message is the first part of a message's text, consisting
685 of a number of lines, each of which has a name such as &'From:'&, &'To:'&,
686 &'Subject:'&, etc. Long header lines can be split over several text lines by
687 indenting the continuations. The header is separated from the body by a blank
688 line.
689
690 .cindex "local part" "definition of"
691 .cindex "domain" "definition of"
692 The term &'local part'&, which is taken from RFC 2822, is used to refer to that
693 part of an email address that precedes the @ sign. The part that follows the
694 @ sign is called the &'domain'& or &'mail domain'&.
695
696 .cindex "local delivery" "definition of"
697 .cindex "remote delivery, definition of"
698 The terms &'local delivery'& and &'remote delivery'& are used to distinguish
699 delivery to a file or a pipe on the local host from delivery by SMTP over
700 TCP/IP to another host. As far as Exim is concerned, all hosts other than the
701 host it is running on are &'remote'&.
702
703 .cindex "return path" "definition of"
704 &'Return path'& is another name that is used for the sender address in a
705 message's envelope.
706
707 .cindex "queue" "definition of"
708 The term &'queue'& is used to refer to the set of messages awaiting delivery,
709 because this term is in widespread use in the context of MTAs. However, in
710 Exim's case the reality is more like a pool than a queue, because there is
711 normally no ordering of waiting messages.
712
713 .cindex "queue runner" "definition of"
714 The term &'queue runner'& is used to describe a process that scans the queue
715 and attempts to deliver those messages whose retry times have come. This term
716 is used by other MTAs, and also relates to the command &%runq%&, but in Exim
717 the waiting messages are normally processed in an unpredictable order.
718
719 .cindex "spool directory" "definition of"
720 The term &'spool directory'& is used for a directory in which Exim keeps the
721 messages on its queue &-- that is, those that it is in the process of
722 delivering. This should not be confused with the directory in which local
723 mailboxes are stored, which is called a &"spool directory"& by some people. In
724 the Exim documentation, &"spool"& is always used in the first sense.
725
726
727
728
729
730
731 . ////////////////////////////////////////////////////////////////////////////
732 . ////////////////////////////////////////////////////////////////////////////
733
734 .chapter "Incorporated code" "CHID2"
735 .cindex "incorporated code"
736 .cindex "regular expressions" "library"
737 .cindex "PCRE"
738 A number of pieces of external code are included in the Exim distribution.
739
740 .ilist
741 Regular expressions are supported in the main Exim program and in the
742 Exim monitor using the freely-distributable PCRE library, copyright
743 &copy; University of Cambridge. The source to PCRE is no longer shipped with
744 Exim, so you will need to use the version of PCRE shipped with your system,
745 or obtain and install the full version of the library from
746 &url(ftp://ftp.csx.cam.ac.uk/pub/software/programming/pcre).
747 .next
748 .cindex "cdb" "acknowledgment"
749 Support for the cdb (Constant DataBase) lookup method is provided by code
750 contributed by Nigel Metheringham of (at the time he contributed it) Planet
751 Online Ltd. The implementation is completely contained within the code of Exim.
752 It does not link against an external cdb library. The code contains the
753 following statements:
754
755 .blockquote
756 Copyright &copy; 1998 Nigel Metheringham, Planet Online Ltd
757
758 This program is free software; you can redistribute it and/or modify it under
759 the terms of the GNU General Public License as published by the Free Software
760 Foundation; either version 2 of the License, or (at your option) any later
761 version.
762 This code implements Dan Bernstein's Constant DataBase (cdb) spec. Information,
763 the spec and sample code for cdb can be obtained from
764 &url(http://www.pobox.com/~djb/cdb.html). This implementation borrows
765 some code from Dan Bernstein's implementation (which has no license
766 restrictions applied to it).
767 .endblockquote
768 .next
769 .cindex "SPA authentication"
770 .cindex "Samba project"
771 .cindex "Microsoft Secure Password Authentication"
772 Client support for Microsoft's &'Secure Password Authentication'& is provided
773 by code contributed by Marc Prud'hommeaux. Server support was contributed by
774 Tom Kistner. This includes code taken from the Samba project, which is released
775 under the Gnu GPL.
776 .next
777 .cindex "Cyrus"
778 .cindex "&'pwcheck'& daemon"
779 .cindex "&'pwauthd'& daemon"
780 Support for calling the Cyrus &'pwcheck'& and &'saslauthd'& daemons is provided
781 by code taken from the Cyrus-SASL library and adapted by Alexander S.
782 Sabourenkov. The permission notice appears below, in accordance with the
783 conditions expressed therein.
784
785 .blockquote
786 Copyright &copy; 2001 Carnegie Mellon University.  All rights reserved.
787
788 Redistribution and use in source and binary forms, with or without
789 modification, are permitted provided that the following conditions
790 are met:
791
792 .olist
793 Redistributions of source code must retain the above copyright
794 notice, this list of conditions and the following disclaimer.
795 .next
796 Redistributions in binary form must reproduce the above copyright
797 notice, this list of conditions and the following disclaimer in
798 the documentation and/or other materials provided with the
799 distribution.
800 .next
801 The name &"Carnegie Mellon University"& must not be used to
802 endorse or promote products derived from this software without
803 prior written permission. For permission or any other legal
804 details, please contact
805 .display
806               Office of Technology Transfer
807               Carnegie Mellon University
808               5000 Forbes Avenue
809               Pittsburgh, PA  15213-3890
810               (412) 268-4387, fax: (412) 268-7395
811               tech-transfer@andrew.cmu.edu
812 .endd
813 .next
814 Redistributions of any form whatsoever must retain the following
815 acknowledgment:
816
817 &"This product includes software developed by Computing Services
818 at Carnegie Mellon University (&url(http://www.cmu.edu/computing/)."&
819
820 CARNEGIE MELLON UNIVERSITY DISCLAIMS ALL WARRANTIES WITH REGARD TO
821 THIS SOFTWARE, INCLUDING ALL IMPLIED WARRANTIES OF MERCHANTABILITY
822 AND FITNESS, IN NO EVENT SHALL CARNEGIE MELLON UNIVERSITY BE LIABLE
823 FOR ANY SPECIAL, INDIRECT OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES
824 WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS, WHETHER IN
825 AN ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING
826 OUT OF OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE.
827 .endlist
828 .endblockquote
829
830 .next
831 .cindex "Exim monitor" "acknowledgment"
832 .cindex "X-windows"
833 .cindex "Athena"
834 The Exim Monitor program, which is an X-Window application, includes
835 modified versions of the Athena StripChart and TextPop widgets.
836 This code is copyright by DEC and MIT, and their permission notice appears
837 below, in accordance with the conditions expressed therein.
838
839 .blockquote
840 Copyright 1987, 1988 by Digital Equipment Corporation, Maynard, Massachusetts,
841 and the Massachusetts Institute of Technology, Cambridge, Massachusetts.
842
843 All Rights Reserved
844
845 Permission to use, copy, modify, and distribute this software and its
846 documentation for any purpose and without fee is hereby granted,
847 provided that the above copyright notice appear in all copies and that
848 both that copyright notice and this permission notice appear in
849 supporting documentation, and that the names of Digital or MIT not be
850 used in advertising or publicity pertaining to distribution of the
851 software without specific, written prior permission.
852
853 DIGITAL DISCLAIMS ALL WARRANTIES WITH REGARD TO THIS SOFTWARE, INCLUDING
854 ALL IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS, IN NO EVENT SHALL
855 DIGITAL BE LIABLE FOR ANY SPECIAL, INDIRECT OR CONSEQUENTIAL DAMAGES OR
856 ANY DAMAGES WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS,
857 WHETHER IN AN ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION,
858 ARISING OUT OF OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS
859 SOFTWARE.
860 .endblockquote
861
862 .next
863 Many people have contributed code fragments, some large, some small, that were
864 not covered by any specific licence requirements. It is assumed that the
865 contributors are happy to see their code incorporated into Exim under the GPL.
866 .endlist
867
868
869
870
871
872 . ////////////////////////////////////////////////////////////////////////////
873 . ////////////////////////////////////////////////////////////////////////////
874
875 .chapter "How Exim receives and delivers mail" "CHID11" &&&
876          "Receiving and delivering mail"
877
878
879 .section "Overall philosophy" "SECID10"
880 .cindex "design philosophy"
881 Exim is designed to work efficiently on systems that are permanently connected
882 to the Internet and are handling a general mix of mail. In such circumstances,
883 most messages can be delivered immediately. Consequently, Exim does not
884 maintain independent queues of messages for specific domains or hosts, though
885 it does try to send several messages in a single SMTP connection after a host
886 has been down, and it also maintains per-host retry information.
887
888
889 .section "Policy control" "SECID11"
890 .cindex "policy control" "overview"
891 Policy controls are now an important feature of MTAs that are connected to the
892 Internet. Perhaps their most important job is to stop MTAs being abused as
893 &"open relays"& by misguided individuals who send out vast amounts of
894 unsolicited junk, and want to disguise its source. Exim provides flexible
895 facilities for specifying policy controls on incoming mail:
896
897 .ilist
898 .cindex "&ACL;" "introduction"
899 Exim 4 (unlike previous versions of Exim) implements policy controls on
900 incoming mail by means of &'Access Control Lists'& (ACLs). Each list is a
901 series of statements that may either grant or deny access. ACLs can be used at
902 several places in the SMTP dialogue while receiving a message from a remote
903 host. However, the most common places are after each RCPT command, and at the
904 very end of the message. The sysadmin can specify conditions for accepting or
905 rejecting individual recipients or the entire message, respectively, at these
906 two points (see chapter &<<CHAPACL>>&). Denial of access results in an SMTP
907 error code.
908 .next
909 An ACL is also available for locally generated, non-SMTP messages. In this
910 case, the only available actions are to accept or deny the entire message.
911 .next
912 When Exim is compiled with the content-scanning extension, facilities are
913 provided in the ACL mechanism for passing the message to external virus and/or
914 spam scanning software. The result of such a scan is passed back to the ACL,
915 which can then use it to decide what to do with the message.
916 .next
917 When a message has been received, either from a remote host or from the local
918 host, but before the final acknowledgment has been sent, a locally supplied C
919 function called &[local_scan()]& can be run to inspect the message and decide
920 whether to accept it or not (see chapter &<<CHAPlocalscan>>&). If the message
921 is accepted, the list of recipients can be modified by the function.
922 .next
923 Using the &[local_scan()]& mechanism is another way of calling external scanner
924 software. The &%SA-Exim%& add-on package works this way. It does not require
925 Exim to be compiled with the content-scanning extension.
926 .next
927 After a message has been accepted, a further checking mechanism is available in
928 the form of the &'system filter'& (see chapter &<<CHAPsystemfilter>>&). This
929 runs at the start of every delivery process.
930 .endlist
931
932
933
934 .section "User filters" "SECID12"
935 .cindex "filter" "introduction"
936 .cindex "Sieve filter"
937 In a conventional Exim configuration, users are able to run private filters by
938 setting up appropriate &_.forward_& files in their home directories. See
939 chapter &<<CHAPredirect>>& (about the &(redirect)& router) for the
940 configuration needed to support this, and the separate document entitled
941 &'Exim's interfaces to mail filtering'& for user details. Two different kinds
942 of filtering are available:
943
944 .ilist
945 Sieve filters are written in the standard filtering language that is defined
946 by RFC 3028.
947 .next
948 Exim filters are written in a syntax that is unique to Exim, but which is more
949 powerful than Sieve, which it pre-dates.
950 .endlist
951
952 User filters are run as part of the routing process, described below.
953
954
955
956 .section "Message identification" "SECTmessiden"
957 .cindex "message ids" "details of format"
958 .cindex "format" "of message id"
959 .cindex "id of message"
960 .cindex "base62"
961 .cindex "base36"
962 .cindex "Darwin"
963 .cindex "Cygwin"
964 Every message handled by Exim is given a &'message id'& which is sixteen
965 characters long. It is divided into three parts, separated by hyphens, for
966 example &`16VDhn-0001bo-D3`&. Each part is a sequence of letters and digits,
967 normally encoding numbers in base 62. However, in the Darwin operating
968 system (Mac OS X) and when Exim is compiled to run under Cygwin, base 36
969 (avoiding the use of lower case letters) is used instead, because the message
970 id is used to construct file names, and the names of files in those systems are
971 not always case-sensitive.
972
973 .cindex "pid (process id)" "re-use of"
974 The detail of the contents of the message id have changed as Exim has evolved.
975 Earlier versions relied on the operating system not re-using a process id (pid)
976 within one second. On modern operating systems, this assumption can no longer
977 be made, so the algorithm had to be changed. To retain backward compatibility,
978 the format of the message id was retained, which is why the following rules are
979 somewhat eccentric:
980
981 .ilist
982 The first six characters of the message id are the time at which the message
983 started to be received, to a granularity of one second. That is, this field
984 contains the number of seconds since the start of the epoch (the normal Unix
985 way of representing the date and time of day).
986 .next
987 After the first hyphen, the next six characters are the id of the process that
988 received the message.
989 .next
990 There are two different possibilities for the final two characters:
991 .olist
992 .oindex "&%localhost_number%&"
993 If &%localhost_number%& is not set, this value is the fractional part of the
994 time of reception, normally in units of 1/2000 of a second, but for systems
995 that must use base 36 instead of base 62 (because of case-insensitive file
996 systems), the units are 1/1000 of a second.
997 .next
998 If &%localhost_number%& is set, it is multiplied by 200 (100) and added to
999 the fractional part of the time, which in this case is in units of 1/200
1000 (1/100) of a second.
1001 .endlist
1002 .endlist
1003
1004 After a message has been received, Exim waits for the clock to tick at the
1005 appropriate resolution before proceeding, so that if another message is
1006 received by the same process, or by another process with the same (re-used)
1007 pid, it is guaranteed that the time will be different. In most cases, the clock
1008 will already have ticked while the message was being received.
1009
1010
1011 .section "Receiving mail" "SECID13"
1012 .cindex "receiving mail"
1013 .cindex "message" "reception"
1014 The only way Exim can receive mail from another host is using SMTP over
1015 TCP/IP, in which case the sender and recipient addresses are transferred using
1016 SMTP commands. However, from a locally running process (such as a user's MUA),
1017 there are several possibilities:
1018
1019 .ilist
1020 If the process runs Exim with the &%-bm%& option, the message is read
1021 non-interactively (usually via a pipe), with the recipients taken from the
1022 command line, or from the body of the message if &%-t%& is also used.
1023 .next
1024 If the process runs Exim with the &%-bS%& option, the message is also read
1025 non-interactively, but in this case the recipients are listed at the start of
1026 the message in a series of SMTP RCPT commands, terminated by a DATA
1027 command. This is so-called &"batch SMTP"& format,
1028 but it isn't really SMTP. The SMTP commands are just another way of passing
1029 envelope addresses in a non-interactive submission.
1030 .next
1031 If the process runs Exim with the &%-bs%& option, the message is read
1032 interactively, using the SMTP protocol. A two-way pipe is normally used for
1033 passing data between the local process and the Exim process.
1034 This is &"real"& SMTP and is handled in the same way as SMTP over TCP/IP. For
1035 example, the ACLs for SMTP commands are used for this form of submission.
1036 .next
1037 A local process may also make a TCP/IP call to the host's loopback address
1038 (127.0.0.1) or any other of its IP addresses. When receiving messages, Exim
1039 does not treat the loopback address specially. It treats all such connections
1040 in the same way as connections from other hosts.
1041 .endlist
1042
1043
1044 .cindex "message sender, constructed by Exim"
1045 .cindex "sender" "constructed by Exim"
1046 In the three cases that do not involve TCP/IP, the sender address is
1047 constructed from the login name of the user that called Exim and a default
1048 qualification domain (which can be set by the &%qualify_domain%& configuration
1049 option). For local or batch SMTP, a sender address that is passed using the
1050 SMTP MAIL command is ignored. However, the system administrator may allow
1051 certain users (&"trusted users"&) to specify a different sender address
1052 unconditionally, or all users to specify certain forms of different sender
1053 address. The &%-f%& option or the SMTP MAIL command is used to specify these
1054 different addresses. See section &<<SECTtrustedadmin>>& for details of trusted
1055 users, and the &%untrusted_set_sender%& option for a way of allowing untrusted
1056 users to change sender addresses.
1057
1058 Messages received by either of the non-interactive mechanisms are subject to
1059 checking by the non-SMTP ACL, if one is defined. Messages received using SMTP
1060 (either over TCP/IP, or interacting with a local process) can be checked by a
1061 number of ACLs that operate at different times during the SMTP session. Either
1062 individual recipients, or the entire message, can be rejected if local policy
1063 requirements are not met. The &[local_scan()]& function (see chapter
1064 &<<CHAPlocalscan>>&) is run for all incoming messages.
1065
1066 Exim can be configured not to start a delivery process when a message is
1067 received; this can be unconditional, or depend on the number of incoming SMTP
1068 connections or the system load. In these situations, new messages wait on the
1069 queue until a queue runner process picks them up. However, in standard
1070 configurations under normal conditions, delivery is started as soon as a
1071 message is received.
1072
1073
1074
1075
1076
1077 .section "Handling an incoming message" "SECID14"
1078 .cindex "spool directory" "files that hold a message"
1079 .cindex "file" "how a message is held"
1080 When Exim accepts a message, it writes two files in its spool directory. The
1081 first contains the envelope information, the current status of the message, and
1082 the header lines, and the second contains the body of the message. The names of
1083 the two spool files consist of the message id, followed by &`-H`& for the
1084 file containing the envelope and header, and &`-D`& for the data file.
1085
1086 .cindex "spool directory" "&_input_& sub-directory"
1087 By default all these message files are held in a single directory called
1088 &_input_& inside the general Exim spool directory. Some operating systems do
1089 not perform very well if the number of files in a directory gets large; to
1090 improve performance in such cases, the &%split_spool_directory%& option can be
1091 used. This causes Exim to split up the input files into 62 sub-directories
1092 whose names are single letters or digits. When this is done, the queue is
1093 processed one sub-directory at a time instead of all at once, which can improve
1094 overall performance even when there are not enough files in each directory to
1095 affect file system performance.
1096
1097 The envelope information consists of the address of the message's sender and
1098 the addresses of the recipients. This information is entirely separate from
1099 any addresses contained in the header lines. The status of the message includes
1100 a list of recipients who have already received the message. The format of the
1101 first spool file is described in chapter &<<CHAPspool>>&.
1102
1103 .cindex "rewriting" "addresses"
1104 Address rewriting that is specified in the rewrite section of the configuration
1105 (see chapter &<<CHAPrewrite>>&) is done once and for all on incoming addresses,
1106 both in the header lines and the envelope, at the time the message is accepted.
1107 If during the course of delivery additional addresses are generated (for
1108 example, via aliasing), these new addresses are rewritten as soon as they are
1109 generated. At the time a message is actually delivered (transported) further
1110 rewriting can take place; because this is a transport option, it can be
1111 different for different forms of delivery. It is also possible to specify the
1112 addition or removal of certain header lines at the time the message is
1113 delivered (see chapters &<<CHAProutergeneric>>& and
1114 &<<CHAPtransportgeneric>>&).
1115
1116
1117
1118 .section "Life of a message" "SECID15"
1119 .cindex "message" "life of"
1120 .cindex "message" "frozen"
1121 A message remains in the spool directory until it is completely delivered to
1122 its recipients or to an error address, or until it is deleted by an
1123 administrator or by the user who originally created it. In cases when delivery
1124 cannot proceed &-- for example, when a message can neither be delivered to its
1125 recipients nor returned to its sender, the message is marked &"frozen"& on the
1126 spool, and no more deliveries are attempted.
1127
1128 .cindex "frozen messages" "thawing"
1129 .cindex "message" "thawing frozen"
1130 An administrator can &"thaw"& such messages when the problem has been
1131 corrected, and can also freeze individual messages by hand if necessary. In
1132 addition, an administrator can force a delivery error, causing a bounce message
1133 to be sent.
1134
1135 .oindex "&%timeout_frozen_after%&"
1136 .oindex "&%ignore_bounce_errors_after%&"
1137 There are options called &%ignore_bounce_errors_after%& and
1138 &%timeout_frozen_after%&, which discard frozen messages after a certain time.
1139 The first applies only to frozen bounces, the second to any frozen messages.
1140
1141 .cindex "message" "log file for"
1142 .cindex "log" "file for each message"
1143 While Exim is working on a message, it writes information about each delivery
1144 attempt to its main log file. This includes successful, unsuccessful, and
1145 delayed deliveries for each recipient (see chapter &<<CHAPlog>>&). The log
1146 lines are also written to a separate &'message log'& file for each message.
1147 These logs are solely for the benefit of the administrator, and are normally
1148 deleted along with the spool files when processing of a message is complete.
1149 The use of individual message logs can be disabled by setting
1150 &%no_message_logs%&; this might give an improvement in performance on very busy
1151 systems.
1152
1153 .cindex "journal file"
1154 .cindex "file" "journal"
1155 All the information Exim itself needs to set up a delivery is kept in the first
1156 spool file, along with the header lines. When a successful delivery occurs, the
1157 address is immediately written at the end of a journal file, whose name is the
1158 message id followed by &`-J`&. At the end of a delivery run, if there are some
1159 addresses left to be tried again later, the first spool file (the &`-H`& file)
1160 is updated to indicate which these are, and the journal file is then deleted.
1161 Updating the spool file is done by writing a new file and renaming it, to
1162 minimize the possibility of data loss.
1163
1164 Should the system or the program crash after a successful delivery but before
1165 the spool file has been updated, the journal is left lying around. The next
1166 time Exim attempts to deliver the message, it reads the journal file and
1167 updates the spool file before proceeding. This minimizes the chances of double
1168 deliveries caused by crashes.
1169
1170
1171
1172 .section "Processing an address for delivery" "SECTprocaddress"
1173 .cindex "drivers" "definition of"
1174 .cindex "router" "definition of"
1175 .cindex "transport" "definition of"
1176 The main delivery processing elements of Exim are called &'routers'& and
1177 &'transports'&, and collectively these are known as &'drivers'&. Code for a
1178 number of them is provided in the source distribution, and compile-time options
1179 specify which ones are included in the binary. Run time options specify which
1180 ones are actually used for delivering messages.
1181
1182 .cindex "drivers" "instance definition"
1183 Each driver that is specified in the run time configuration is an &'instance'&
1184 of that particular driver type. Multiple instances are allowed; for example,
1185 you can set up several different &(smtp)& transports, each with different
1186 option values that might specify different ports or different timeouts. Each
1187 instance has its own identifying name. In what follows we will normally use the
1188 instance name when discussing one particular instance (that is, one specific
1189 configuration of the driver), and the generic driver name when discussing
1190 the driver's features in general.
1191
1192 A &'router'& is a driver that operates on an address, either determining how
1193 its delivery should happen, by assigning it to a specific transport, or
1194 converting the address into one or more new addresses (for example, via an
1195 alias file). A router may also explicitly choose to fail an address, causing it
1196 to be bounced.
1197
1198 A &'transport'& is a driver that transmits a copy of the message from Exim's
1199 spool to some destination. There are two kinds of transport: for a &'local'&
1200 transport, the destination is a file or a pipe on the local host, whereas for a
1201 &'remote'& transport the destination is some other host. A message is passed
1202 to a specific transport as a result of successful routing. If a message has
1203 several recipients, it may be passed to a number of different transports.
1204
1205 .cindex "preconditions" "definition of"
1206 An address is processed by passing it to each configured router instance in
1207 turn, subject to certain preconditions, until a router accepts the address or
1208 specifies that it should be bounced. We will describe this process in more
1209 detail shortly. First, as a simple example, we consider how each recipient
1210 address in a message is processed in a small configuration of three routers.
1211
1212 To make this a more concrete example, it is described in terms of some actual
1213 routers, but remember, this is only an example. You can configure Exim's
1214 routers in many different ways, and there may be any number of routers in a
1215 configuration.
1216
1217 The first router that is specified in a configuration is often one that handles
1218 addresses in domains that are not recognized specially by the local host. These
1219 are typically addresses for arbitrary domains on the Internet. A precondition
1220 is set up which looks for the special domains known to the host (for example,
1221 its own domain name), and the router is run for addresses that do &'not'&
1222 match. Typically, this is a router that looks up domains in the DNS in order to
1223 find the hosts to which this address routes. If it succeeds, the address is
1224 assigned to a suitable SMTP transport; if it does not succeed, the router is
1225 configured to fail the address.
1226
1227 The second router is reached only when the domain is recognized as one that
1228 &"belongs"& to the local host. This router does redirection &-- also known as
1229 aliasing and forwarding. When it generates one or more new addresses from the
1230 original, each of them is routed independently from the start. Otherwise, the
1231 router may cause an address to fail, or it may simply decline to handle the
1232 address, in which case the address is passed to the next router.
1233
1234 The final router in many configurations is one that checks to see if the
1235 address belongs to a local mailbox. The precondition may involve a check to
1236 see if the local part is the name of a login account, or it may look up the
1237 local part in a file or a database. If its preconditions are not met, or if
1238 the router declines, we have reached the end of the routers. When this happens,
1239 the address is bounced.
1240
1241
1242
1243 .section "Processing an address for verification" "SECID16"
1244 .cindex "router" "for verification"
1245 .cindex "verifying address" "overview"
1246 As well as being used to decide how to deliver to an address, Exim's routers
1247 are also used for &'address verification'&. Verification can be requested as
1248 one of the checks to be performed in an ACL for incoming messages, on both
1249 sender and recipient addresses, and it can be tested using the &%-bv%& and
1250 &%-bvs%& command line options.
1251
1252 When an address is being verified, the routers are run in &"verify mode"&. This
1253 does not affect the way the routers work, but it is a state that can be
1254 detected. By this means, a router can be skipped or made to behave differently
1255 when verifying. A common example is a configuration in which the first router
1256 sends all messages to a message-scanning program, unless they have been
1257 previously scanned. Thus, the first router accepts all addresses without any
1258 checking, making it useless for verifying. Normally, the &%no_verify%& option
1259 would be set for such a router, causing it to be skipped in verify mode.
1260
1261
1262
1263
1264 .section "Running an individual router" "SECTrunindrou"
1265 .cindex "router" "running details"
1266 .cindex "preconditions" "checking"
1267 .cindex "router" "result of running"
1268 As explained in the example above, a number of preconditions are checked before
1269 running a router. If any are not met, the router is skipped, and the address is
1270 passed to the next router. When all the preconditions on a router &'are'& met,
1271 the router is run. What happens next depends on the outcome, which is one of
1272 the following:
1273
1274 .ilist
1275 &'accept'&: The router accepts the address, and either assigns it to a
1276 transport, or generates one or more &"child"& addresses. Processing the
1277 original address ceases,
1278 .oindex "&%unseen%&"
1279 unless the &%unseen%& option is set on the router. This option
1280 can be used to set up multiple deliveries with different routing (for example,
1281 for keeping archive copies of messages). When &%unseen%& is set, the address is
1282 passed to the next router. Normally, however, an &'accept'& return marks the
1283 end of routing.
1284
1285 Any child addresses generated by the router are processed independently,
1286 starting with the first router by default. It is possible to change this by
1287 setting the &%redirect_router%& option to specify which router to start at for
1288 child addresses. Unlike &%pass_router%& (see below) the router specified by
1289 &%redirect_router%& may be anywhere in the router configuration.
1290 .next
1291 &'pass'&: The router recognizes the address, but cannot handle it itself. It
1292 requests that the address be passed to another router. By default the address
1293 is passed to the next router, but this can be changed by setting the
1294 &%pass_router%& option. However, (unlike &%redirect_router%&) the named router
1295 must be below the current router (to avoid loops).
1296 .next
1297 &'decline'&: The router declines to accept the address because it does not
1298 recognize it at all. By default, the address is passed to the next router, but
1299 this can be prevented by setting the &%no_more%& option. When &%no_more%& is
1300 set, all the remaining routers are skipped. In effect, &%no_more%& converts
1301 &'decline'& into &'fail'&.
1302 .next
1303 &'fail'&: The router determines that the address should fail, and queues it for
1304 the generation of a bounce message. There is no further processing of the
1305 original address unless &%unseen%& is set on the router.
1306 .next
1307 &'defer'&: The router cannot handle the address at the present time. (A
1308 database may be offline, or a DNS lookup may have timed out.) No further
1309 processing of the address happens in this delivery attempt. It is tried again
1310 next time the message is considered for delivery.
1311 .next
1312 &'error'&: There is some error in the router (for example, a syntax error in
1313 its configuration). The action is as for defer.
1314 .endlist
1315
1316 If an address reaches the end of the routers without having been accepted by
1317 any of them, it is bounced as unrouteable. The default error message in this
1318 situation is &"unrouteable address"&, but you can set your own message by
1319 making use of the &%cannot_route_message%& option. This can be set for any
1320 router; the value from the last router that &"saw"& the address is used.
1321
1322 Sometimes while routing you want to fail a delivery when some conditions are
1323 met but others are not, instead of passing the address on for further routing.
1324 You can do this by having a second router that explicitly fails the delivery
1325 when the relevant conditions are met. The &(redirect)& router has a &"fail"&
1326 facility for this purpose.
1327
1328
1329 .section "Duplicate addresses" "SECID17"
1330 .cindex "case of local parts"
1331 .cindex "address duplicate, discarding"
1332 .cindex "duplicate addresses"
1333 Once routing is complete, Exim scans the addresses that are assigned to local
1334 and remote transports, and discards any duplicates that it finds. During this
1335 check, local parts are treated as case-sensitive. This happens only when
1336 actually delivering a message; when testing routers with &%-bt%&, all the
1337 routed addresses are shown.
1338
1339
1340
1341 .section "Router preconditions" "SECTrouprecon"
1342 .cindex "router" "preconditions, order of processing"
1343 .cindex "preconditions" "order of processing"
1344 The preconditions that are tested for each router are listed below, in the
1345 order in which they are tested. The individual configuration options are
1346 described in more detail in chapter &<<CHAProutergeneric>>&.
1347
1348 .ilist
1349 The &%local_part_prefix%& and &%local_part_suffix%& options can specify that
1350 the local parts handled by the router may or must have certain prefixes and/or
1351 suffixes. If a mandatory affix (prefix or suffix) is not present, the router is
1352 skipped. These conditions are tested first. When an affix is present, it is
1353 removed from the local part before further processing, including the evaluation
1354 of any other conditions.
1355 .next
1356 Routers can be designated for use only when not verifying an address, that is,
1357 only when routing it for delivery (or testing its delivery routing). If the
1358 &%verify%& option is set false, the router is skipped when Exim is verifying an
1359 address.
1360 Setting the &%verify%& option actually sets two options, &%verify_sender%& and
1361 &%verify_recipient%&, which independently control the use of the router for
1362 sender and recipient verification. You can set these options directly if
1363 you want a router to be used for only one type of verification.
1364 Note that cutthrough delivery is classed as a recipient verification
1365 for this purpose.
1366 .next
1367 If the &%address_test%& option is set false, the router is skipped when Exim is
1368 run with the &%-bt%& option to test an address routing. This can be helpful
1369 when the first router sends all new messages to a scanner of some sort; it
1370 makes it possible to use &%-bt%& to test subsequent delivery routing without
1371 having to simulate the effect of the scanner.
1372 .next
1373 Routers can be designated for use only when verifying an address, as
1374 opposed to routing it for delivery. The &%verify_only%& option controls this.
1375 Again, cutthrough delibery counts as a verification.
1376 .next
1377 Individual routers can be explicitly skipped when running the routers to
1378 check an address given in the SMTP EXPN command (see the &%expn%& option).
1379 .next
1380 If the &%domains%& option is set, the domain of the address must be in the set
1381 of domains that it defines.
1382 .next
1383 .vindex "&$local_part_prefix$&"
1384 .vindex "&$local_part$&"
1385 .vindex "&$local_part_suffix$&"
1386 If the &%local_parts%& option is set, the local part of the address must be in
1387 the set of local parts that it defines. If &%local_part_prefix%& or
1388 &%local_part_suffix%& is in use, the prefix or suffix is removed from the local
1389 part before this check. If you want to do precondition tests on local parts
1390 that include affixes, you can do so by using a &%condition%& option (see below)
1391 that uses the variables &$local_part$&, &$local_part_prefix$&, and
1392 &$local_part_suffix$& as necessary.
1393 .next
1394 .vindex "&$local_user_uid$&"
1395 .vindex "&$local_user_gid$&"
1396 .vindex "&$home$&"
1397 If the &%check_local_user%& option is set, the local part must be the name of
1398 an account on the local host. If this check succeeds, the uid and gid of the
1399 local user are placed in &$local_user_uid$& and &$local_user_gid$& and the
1400 user's home directory is placed in &$home$&; these values can be used in the
1401 remaining preconditions.
1402 .next
1403 If the &%router_home_directory%& option is set, it is expanded at this point,
1404 because it overrides the value of &$home$&. If this expansion were left till
1405 later, the value of &$home$& as set by &%check_local_user%& would be used in
1406 subsequent tests. Having two different values of &$home$& in the same router
1407 could lead to confusion.
1408 .next
1409 If the &%senders%& option is set, the envelope sender address must be in the
1410 set of addresses that it defines.
1411 .next
1412 If the &%require_files%& option is set, the existence or non-existence of
1413 specified files is tested.
1414 .next
1415 .cindex "customizing" "precondition"
1416 If the &%condition%& option is set, it is evaluated and tested. This option
1417 uses an expanded string to allow you to set up your own custom preconditions.
1418 Expanded strings are described in chapter &<<CHAPexpand>>&.
1419 .endlist
1420
1421
1422 Note that &%require_files%& comes near the end of the list, so you cannot use
1423 it to check for the existence of a file in which to lookup up a domain, local
1424 part, or sender. However, as these options are all expanded, you can use the
1425 &%exists%& expansion condition to make such tests within each condition. The
1426 &%require_files%& option is intended for checking files that the router may be
1427 going to use internally, or which are needed by a specific transport (for
1428 example, &_.procmailrc_&).
1429
1430
1431
1432 .section "Delivery in detail" "SECID18"
1433 .cindex "delivery" "in detail"
1434 When a message is to be delivered, the sequence of events is as follows:
1435
1436 .ilist
1437 If a system-wide filter file is specified, the message is passed to it. The
1438 filter may add recipients to the message, replace the recipients, discard the
1439 message, cause a new message to be generated, or cause the message delivery to
1440 fail. The format of the system filter file is the same as for Exim user filter
1441 files, described in the separate document entitled &'Exim's interfaces to mail
1442 filtering'&.
1443 .cindex "Sieve filter" "not available for system filter"
1444 (&*Note*&: Sieve cannot be used for system filter files.)
1445
1446 Some additional features are available in system filters &-- see chapter
1447 &<<CHAPsystemfilter>>& for details. Note that a message is passed to the system
1448 filter only once per delivery attempt, however many recipients it has. However,
1449 if there are several delivery attempts because one or more addresses could not
1450 be immediately delivered, the system filter is run each time. The filter
1451 condition &%first_delivery%& can be used to detect the first run of the system
1452 filter.
1453 .next
1454 Each recipient address is offered to each configured router in turn, subject to
1455 its preconditions, until one is able to handle it. If no router can handle the
1456 address, that is, if they all decline, the address is failed. Because routers
1457 can be targeted at particular domains, several locally handled domains can be
1458 processed entirely independently of each other.
1459 .next
1460 .cindex "routing" "loops in"
1461 .cindex "loop" "while routing"
1462 A router that accepts an address may assign it to a local or a remote
1463 transport. However, the transport is not run at this time. Instead, the address
1464 is placed on a list for the particular transport, which will be run later.
1465 Alternatively, the router may generate one or more new addresses (typically
1466 from alias, forward, or filter files). New addresses are fed back into this
1467 process from the top, but in order to avoid loops, a router ignores any address
1468 which has an identically-named ancestor that was processed by itself.
1469 .next
1470 When all the routing has been done, addresses that have been successfully
1471 handled are passed to their assigned transports. When local transports are
1472 doing real local deliveries, they handle only one address at a time, but if a
1473 local transport is being used as a pseudo-remote transport (for example, to
1474 collect batched SMTP messages for transmission by some other means) multiple
1475 addresses can be handled. Remote transports can always handle more than one
1476 address at a time, but can be configured not to do so, or to restrict multiple
1477 addresses to the same domain.
1478 .next
1479 Each local delivery to a file or a pipe runs in a separate process under a
1480 non-privileged uid, and these deliveries are run one at a time. Remote
1481 deliveries also run in separate processes, normally under a uid that is private
1482 to Exim (&"the Exim user"&), but in this case, several remote deliveries can be
1483 run in parallel. The maximum number of simultaneous remote deliveries for any
1484 one message is set by the &%remote_max_parallel%& option.
1485 The order in which deliveries are done is not defined, except that all local
1486 deliveries happen before any remote deliveries.
1487 .next
1488 .cindex "queue runner"
1489 When it encounters a local delivery during a queue run, Exim checks its retry
1490 database to see if there has been a previous temporary delivery failure for the
1491 address before running the local transport. If there was a previous failure,
1492 Exim does not attempt a new delivery until the retry time for the address is
1493 reached. However, this happens only for delivery attempts that are part of a
1494 queue run. Local deliveries are always attempted when delivery immediately
1495 follows message reception, even if retry times are set for them. This makes for
1496 better behaviour if one particular message is causing problems (for example,
1497 causing quota overflow, or provoking an error in a filter file).
1498 .next
1499 .cindex "delivery" "retry in remote transports"
1500 Remote transports do their own retry handling, since an address may be
1501 deliverable to one of a number of hosts, each of which may have a different
1502 retry time. If there have been previous temporary failures and no host has
1503 reached its retry time, no delivery is attempted, whether in a queue run or
1504 not. See chapter &<<CHAPretry>>& for details of retry strategies.
1505 .next
1506 If there were any permanent errors, a bounce message is returned to an
1507 appropriate address (the sender in the common case), with details of the error
1508 for each failing address. Exim can be configured to send copies of bounce
1509 messages to other addresses.
1510 .next
1511 .cindex "delivery" "deferral"
1512 If one or more addresses suffered a temporary failure, the message is left on
1513 the queue, to be tried again later. Delivery of these addresses is said to be
1514 &'deferred'&.
1515 .next
1516 When all the recipient addresses have either been delivered or bounced,
1517 handling of the message is complete. The spool files and message log are
1518 deleted, though the message log can optionally be preserved if required.
1519 .endlist
1520
1521
1522
1523
1524 .section "Retry mechanism" "SECID19"
1525 .cindex "delivery" "retry mechanism"
1526 .cindex "retry" "description of mechanism"
1527 .cindex "queue runner"
1528 Exim's mechanism for retrying messages that fail to get delivered at the first
1529 attempt is the queue runner process. You must either run an Exim daemon that
1530 uses the &%-q%& option with a time interval to start queue runners at regular
1531 intervals, or use some other means (such as &'cron'&) to start them. If you do
1532 not arrange for queue runners to be run, messages that fail temporarily at the
1533 first attempt will remain on your queue for ever. A queue runner process works
1534 its way through the queue, one message at a time, trying each delivery that has
1535 passed its retry time.
1536 You can run several queue runners at once.
1537
1538 Exim uses a set of configured rules to determine when next to retry the failing
1539 address (see chapter &<<CHAPretry>>&). These rules also specify when Exim
1540 should give up trying to deliver to the address, at which point it generates a
1541 bounce message. If no retry rules are set for a particular host, address, and
1542 error combination, no retries are attempted, and temporary errors are treated
1543 as permanent.
1544
1545
1546
1547 .section "Temporary delivery failure" "SECID20"
1548 .cindex "delivery" "temporary failure"
1549 There are many reasons why a message may not be immediately deliverable to a
1550 particular address. Failure to connect to a remote machine (because it, or the
1551 connection to it, is down) is one of the most common. Temporary failures may be
1552 detected during routing as well as during the transport stage of delivery.
1553 Local deliveries may be delayed if NFS files are unavailable, or if a mailbox
1554 is on a file system where the user is over quota. Exim can be configured to
1555 impose its own quotas on local mailboxes; where system quotas are set they will
1556 also apply.
1557
1558 If a host is unreachable for a period of time, a number of messages may be
1559 waiting for it by the time it recovers, and sending them in a single SMTP
1560 connection is clearly beneficial. Whenever a delivery to a remote host is
1561 deferred,
1562 .cindex "hints database"
1563 Exim makes a note in its hints database, and whenever a successful
1564 SMTP delivery has happened, it looks to see if any other messages are waiting
1565 for the same host. If any are found, they are sent over the same SMTP
1566 connection, subject to a configuration limit as to the maximum number in any
1567 one connection.
1568
1569
1570
1571 .section "Permanent delivery failure" "SECID21"
1572 .cindex "delivery" "permanent failure"
1573 .cindex "bounce message" "when generated"
1574 When a message cannot be delivered to some or all of its intended recipients, a
1575 bounce message is generated. Temporary delivery failures turn into permanent
1576 errors when their timeout expires. All the addresses that fail in a given
1577 delivery attempt are listed in a single message. If the original message has
1578 many recipients, it is possible for some addresses to fail in one delivery
1579 attempt and others to fail subsequently, giving rise to more than one bounce
1580 message. The wording of bounce messages can be customized by the administrator.
1581 See chapter &<<CHAPemsgcust>>& for details.
1582
1583 .cindex "&'X-Failed-Recipients:'& header line"
1584 Bounce messages contain an &'X-Failed-Recipients:'& header line that lists the
1585 failed addresses, for the benefit of programs that try to analyse such messages
1586 automatically.
1587
1588 .cindex "bounce message" "recipient of"
1589 A bounce message is normally sent to the sender of the original message, as
1590 obtained from the message's envelope. For incoming SMTP messages, this is the
1591 address given in the MAIL command. However, when an address is expanded via a
1592 forward or alias file, an alternative address can be specified for delivery
1593 failures of the generated addresses. For a mailing list expansion (see section
1594 &<<SECTmailinglists>>&) it is common to direct bounce messages to the manager
1595 of the list.
1596
1597
1598
1599 .section "Failures to deliver bounce messages" "SECID22"
1600 .cindex "bounce message" "failure to deliver"
1601 If a bounce message (either locally generated or received from a remote host)
1602 itself suffers a permanent delivery failure, the message is left on the queue,
1603 but it is frozen, awaiting the attention of an administrator. There are options
1604 that can be used to make Exim discard such failed messages, or to keep them
1605 for only a short time (see &%timeout_frozen_after%& and
1606 &%ignore_bounce_errors_after%&).
1607
1608
1609
1610
1611
1612 . ////////////////////////////////////////////////////////////////////////////
1613 . ////////////////////////////////////////////////////////////////////////////
1614
1615 .chapter "Building and installing Exim" "CHID3"
1616 .scindex IIDbuex "building Exim"
1617
1618 .section "Unpacking" "SECID23"
1619 Exim is distributed as a gzipped or bzipped tar file which, when unpacked,
1620 creates a directory with the name of the current release (for example,
1621 &_exim-&version;_&) into which the following files are placed:
1622
1623 .table2 140pt
1624 .irow &_ACKNOWLEDGMENTS_& "contains some acknowledgments"
1625 .irow &_CHANGES_&         "contains a reference to where changes are &&&
1626   documented"
1627 .irow &_LICENCE_&         "the GNU General Public Licence"
1628 .irow &_Makefile_&        "top-level make file"
1629 .irow &_NOTICE_&          "conditions for the use of Exim"
1630 .irow &_README_&          "list of files, directories and simple build &&&
1631   instructions"
1632 .endtable
1633
1634 Other files whose names begin with &_README_& may also be present. The
1635 following subdirectories are created:
1636
1637 .table2 140pt
1638 .irow &_Local_&           "an empty directory for local configuration files"
1639 .irow &_OS_&              "OS-specific files"
1640 .irow &_doc_&             "documentation files"
1641 .irow &_exim_monitor_&    "source files for the Exim monitor"
1642 .irow &_scripts_&         "scripts used in the build process"
1643 .irow &_src_&             "remaining source files"
1644 .irow &_util_&            "independent utilities"
1645 .endtable
1646
1647 The main utility programs are contained in the &_src_& directory, and are built
1648 with the Exim binary. The &_util_& directory contains a few optional scripts
1649 that may be useful to some sites.
1650
1651
1652 .section "Multiple machine architectures and operating systems" "SECID24"
1653 .cindex "building Exim" "multiple OS/architectures"
1654 The building process for Exim is arranged to make it easy to build binaries for
1655 a number of different architectures and operating systems from the same set of
1656 source files. Compilation does not take place in the &_src_& directory.
1657 Instead, a &'build directory'& is created for each architecture and operating
1658 system.
1659 .cindex "symbolic link" "to build directory"
1660 Symbolic links to the sources are installed in this directory, which is where
1661 the actual building takes place. In most cases, Exim can discover the machine
1662 architecture and operating system for itself, but the defaults can be
1663 overridden if necessary.
1664
1665
1666 .section "PCRE library" "SECTpcre"
1667 .cindex "PCRE library"
1668 Exim no longer has an embedded PCRE library as the vast majority of
1669 modern systems include PCRE as a system library, although you may need
1670 to install the PCRE or PCRE development package for your operating
1671 system. If your system has a normal PCRE installation the Exim build
1672 process will need no further configuration. If the library or the
1673 headers are in an unusual location you will need to either set the PCRE_LIBS
1674 and INCLUDE directives appropriately,
1675 or set PCRE_CONFIG=yes to use the installed &(pcre-config)& command.
1676 If your operating system has no
1677 PCRE support then you will need to obtain and build the current PCRE
1678 from &url(ftp://ftp.csx.cam.ac.uk/pub/software/programming/pcre/).
1679 More information on PCRE is available at &url(http://www.pcre.org/).
1680
1681 .section "DBM libraries" "SECTdb"
1682 .cindex "DBM libraries" "discussion of"
1683 .cindex "hints database" "DBM files used for"
1684 Even if you do not use any DBM files in your configuration, Exim still needs a
1685 DBM library in order to operate, because it uses indexed files for its hints
1686 databases. Unfortunately, there are a number of DBM libraries in existence, and
1687 different operating systems often have different ones installed.
1688
1689 .cindex "Solaris" "DBM library for"
1690 .cindex "IRIX, DBM library for"
1691 .cindex "BSD, DBM library for"
1692 .cindex "Linux, DBM library for"
1693 If you are using Solaris, IRIX, one of the modern BSD systems, or a modern
1694 Linux distribution, the DBM configuration should happen automatically, and you
1695 may be able to ignore this section. Otherwise, you may have to learn more than
1696 you would like about DBM libraries from what follows.
1697
1698 .cindex "&'ndbm'& DBM library"
1699 Licensed versions of Unix normally contain a library of DBM functions operating
1700 via the &'ndbm'& interface, and this is what Exim expects by default. Free
1701 versions of Unix seem to vary in what they contain as standard. In particular,
1702 some early versions of Linux have no default DBM library, and different
1703 distributors have chosen to bundle different libraries with their packaged
1704 versions. However, the more recent releases seem to have standardized on the
1705 Berkeley DB library.
1706
1707 Different DBM libraries have different conventions for naming the files they
1708 use. When a program opens a file called &_dbmfile_&, there are several
1709 possibilities:
1710
1711 .olist
1712 A traditional &'ndbm'& implementation, such as that supplied as part of
1713 Solaris, operates on two files called &_dbmfile.dir_& and &_dbmfile.pag_&.
1714 .next
1715 .cindex "&'gdbm'& DBM library"
1716 The GNU library, &'gdbm'&, operates on a single file. If used via its &'ndbm'&
1717 compatibility interface it makes two different hard links to it with names
1718 &_dbmfile.dir_& and &_dbmfile.pag_&, but if used via its native interface, the
1719 file name is used unmodified.
1720 .next
1721 .cindex "Berkeley DB library"
1722 The Berkeley DB package, if called via its &'ndbm'& compatibility interface,
1723 operates on a single file called &_dbmfile.db_&, but otherwise looks to the
1724 programmer exactly the same as the traditional &'ndbm'& implementation.
1725 .next
1726 If the Berkeley package is used in its native mode, it operates on a single
1727 file called &_dbmfile_&; the programmer's interface is somewhat different to
1728 the traditional &'ndbm'& interface.
1729 .next
1730 To complicate things further, there are several very different versions of the
1731 Berkeley DB package. Version 1.85 was stable for a very long time, releases
1732 2.&'x'& and 3.&'x'& were current for a while, but the latest versions are now
1733 numbered 4.&'x'&. Maintenance of some of the earlier releases has ceased. All
1734 versions of Berkeley DB can be obtained from
1735 &url(http://www.sleepycat.com/).
1736 .next
1737 .cindex "&'tdb'& DBM library"
1738 Yet another DBM library, called &'tdb'&, is available from
1739 &url(http://download.sourceforge.net/tdb). It has its own interface, and also
1740 operates on a single file.
1741 .endlist
1742
1743 .cindex "USE_DB"
1744 .cindex "DBM libraries" "configuration for building"
1745 Exim and its utilities can be compiled to use any of these interfaces. In order
1746 to use any version of the Berkeley DB package in native mode, you must set
1747 USE_DB in an appropriate configuration file (typically
1748 &_Local/Makefile_&). For example:
1749 .code
1750 USE_DB=yes
1751 .endd
1752 Similarly, for gdbm you set USE_GDBM, and for tdb you set USE_TDB. An
1753 error is diagnosed if you set more than one of these.
1754
1755 At the lowest level, the build-time configuration sets none of these options,
1756 thereby assuming an interface of type (1). However, some operating system
1757 configuration files (for example, those for the BSD operating systems and
1758 Linux) assume type (4) by setting USE_DB as their default, and the
1759 configuration files for Cygwin set USE_GDBM. Anything you set in
1760 &_Local/Makefile_&, however, overrides these system defaults.
1761
1762 As well as setting USE_DB, USE_GDBM, or USE_TDB, it may also be
1763 necessary to set DBMLIB, to cause inclusion of the appropriate library, as
1764 in one of these lines:
1765 .code
1766 DBMLIB = -ldb
1767 DBMLIB = -ltdb
1768 .endd
1769 Settings like that will work if the DBM library is installed in the standard
1770 place. Sometimes it is not, and the library's header file may also not be in
1771 the default path. You may need to set INCLUDE to specify where the header
1772 file is, and to specify the path to the library more fully in DBMLIB, as in
1773 this example:
1774 .code
1775 INCLUDE=-I/usr/local/include/db-4.1
1776 DBMLIB=/usr/local/lib/db-4.1/libdb.a
1777 .endd
1778 There is further detailed discussion about the various DBM libraries in the
1779 file &_doc/dbm.discuss.txt_& in the Exim distribution.
1780
1781
1782
1783 .section "Pre-building configuration" "SECID25"
1784 .cindex "building Exim" "pre-building configuration"
1785 .cindex "configuration for building Exim"
1786 .cindex "&_Local/Makefile_&"
1787 .cindex "&_src/EDITME_&"
1788 Before building Exim, a local configuration file that specifies options
1789 independent of any operating system has to be created with the name
1790 &_Local/Makefile_&. A template for this file is supplied as the file
1791 &_src/EDITME_&, and it contains full descriptions of all the option settings
1792 therein. These descriptions are therefore not repeated here. If you are
1793 building Exim for the first time, the simplest thing to do is to copy
1794 &_src/EDITME_& to &_Local/Makefile_&, then read it and edit it appropriately.
1795
1796 There are three settings that you must supply, because Exim will not build
1797 without them. They are the location of the run time configuration file
1798 (CONFIGURE_FILE), the directory in which Exim binaries will be installed
1799 (BIN_DIRECTORY), and the identity of the Exim user (EXIM_USER and
1800 maybe EXIM_GROUP as well). The value of CONFIGURE_FILE can in fact be
1801 a colon-separated list of file names; Exim uses the first of them that exists.
1802
1803 There are a few other parameters that can be specified either at build time or
1804 at run time, to enable the same binary to be used on a number of different
1805 machines. However, if the locations of Exim's spool directory and log file
1806 directory (if not within the spool directory) are fixed, it is recommended that
1807 you specify them in &_Local/Makefile_& instead of at run time, so that errors
1808 detected early in Exim's execution (such as a malformed configuration file) can
1809 be logged.
1810
1811 .cindex "content scanning" "specifying at build time"
1812 Exim's interfaces for calling virus and spam scanning software directly from
1813 access control lists are not compiled by default. If you want to include these
1814 facilities, you need to set
1815 .code
1816 WITH_CONTENT_SCAN=yes
1817 .endd
1818 in your &_Local/Makefile_&. For details of the facilities themselves, see
1819 chapter &<<CHAPexiscan>>&.
1820
1821
1822 .cindex "&_Local/eximon.conf_&"
1823 .cindex "&_exim_monitor/EDITME_&"
1824 If you are going to build the Exim monitor, a similar configuration process is
1825 required. The file &_exim_monitor/EDITME_& must be edited appropriately for
1826 your installation and saved under the name &_Local/eximon.conf_&. If you are
1827 happy with the default settings described in &_exim_monitor/EDITME_&,
1828 &_Local/eximon.conf_& can be empty, but it must exist.
1829
1830 This is all the configuration that is needed in straightforward cases for known
1831 operating systems. However, the building process is set up so that it is easy
1832 to override options that are set by default or by operating-system-specific
1833 configuration files, for example to change the name of the C compiler, which
1834 defaults to &%gcc%&. See section &<<SECToverride>>& below for details of how to
1835 do this.
1836
1837
1838
1839 .section "Support for iconv()" "SECID26"
1840 .cindex "&[iconv()]& support"
1841 .cindex "RFC 2047"
1842 The contents of header lines in messages may be encoded according to the rules
1843 described RFC 2047. This makes it possible to transmit characters that are not
1844 in the ASCII character set, and to label them as being in a particular
1845 character set. When Exim is inspecting header lines by means of the &%$h_%&
1846 mechanism, it decodes them, and translates them into a specified character set
1847 (default ISO-8859-1). The translation is possible only if the operating system
1848 supports the &[iconv()]& function.
1849
1850 However, some of the operating systems that supply &[iconv()]& do not support
1851 very many conversions. The GNU &%libiconv%& library (available from
1852 &url(http://www.gnu.org/software/libiconv/)) can be installed on such
1853 systems to remedy this deficiency, as well as on systems that do not supply
1854 &[iconv()]& at all. After installing &%libiconv%&, you should add
1855 .code
1856 HAVE_ICONV=yes
1857 .endd
1858 to your &_Local/Makefile_& and rebuild Exim.
1859
1860
1861
1862 .section "Including TLS/SSL encryption support" "SECTinctlsssl"
1863 .cindex "TLS" "including support for TLS"
1864 .cindex "encryption" "including support for"
1865 .cindex "SUPPORT_TLS"
1866 .cindex "OpenSSL" "building Exim with"
1867 .cindex "GnuTLS" "building Exim with"
1868 Exim can be built to support encrypted SMTP connections, using the STARTTLS
1869 command as per RFC 2487. It can also support legacy clients that expect to
1870 start a TLS session immediately on connection to a non-standard port (see the
1871 &%tls_on_connect_ports%& runtime option and the &%-tls-on-connect%& command
1872 line option).
1873
1874 If you want to build Exim with TLS support, you must first install either the
1875 OpenSSL or GnuTLS library. There is no cryptographic code in Exim itself for
1876 implementing SSL.
1877
1878 If OpenSSL is installed, you should set
1879 .code
1880 SUPPORT_TLS=yes
1881 TLS_LIBS=-lssl -lcrypto
1882 .endd
1883 in &_Local/Makefile_&. You may also need to specify the locations of the
1884 OpenSSL library and include files. For example:
1885 .code
1886 SUPPORT_TLS=yes
1887 TLS_LIBS=-L/usr/local/openssl/lib -lssl -lcrypto
1888 TLS_INCLUDE=-I/usr/local/openssl/include/
1889 .endd
1890 .cindex "pkg-config" "OpenSSL"
1891 If you have &'pkg-config'& available, then instead you can just use:
1892 .code
1893 SUPPORT_TLS=yes
1894 USE_OPENSSL_PC=openssl
1895 .endd
1896 .cindex "USE_GNUTLS"
1897 If GnuTLS is installed, you should set
1898 .code
1899 SUPPORT_TLS=yes
1900 USE_GNUTLS=yes
1901 TLS_LIBS=-lgnutls -ltasn1 -lgcrypt
1902 .endd
1903 in &_Local/Makefile_&, and again you may need to specify the locations of the
1904 library and include files. For example:
1905 .code
1906 SUPPORT_TLS=yes
1907 USE_GNUTLS=yes
1908 TLS_LIBS=-L/usr/gnu/lib -lgnutls -ltasn1 -lgcrypt
1909 TLS_INCLUDE=-I/usr/gnu/include
1910 .endd
1911 .cindex "pkg-config" "GnuTLS"
1912 If you have &'pkg-config'& available, then instead you can just use:
1913 .code
1914 SUPPORT_TLS=yes
1915 USE_GNUTLS=yes
1916 USE_GNUTLS_PC=gnutls
1917 .endd
1918
1919 You do not need to set TLS_INCLUDE if the relevant directory is already
1920 specified in INCLUDE. Details of how to configure Exim to make use of TLS are
1921 given in chapter &<<CHAPTLS>>&.
1922
1923
1924
1925
1926 .section "Use of tcpwrappers" "SECID27"
1927
1928 .cindex "tcpwrappers, building Exim to support"
1929 .cindex "USE_TCP_WRAPPERS"
1930 .cindex "TCP_WRAPPERS_DAEMON_NAME"
1931 .cindex "tcp_wrappers_daemon_name"
1932 Exim can be linked with the &'tcpwrappers'& library in order to check incoming
1933 SMTP calls using the &'tcpwrappers'& control files. This may be a convenient
1934 alternative to Exim's own checking facilities for installations that are
1935 already making use of &'tcpwrappers'& for other purposes. To do this, you
1936 should set USE_TCP_WRAPPERS in &_Local/Makefile_&, arrange for the file
1937 &_tcpd.h_& to be available at compile time, and also ensure that the library
1938 &_libwrap.a_& is available at link time, typically by including &%-lwrap%& in
1939 EXTRALIBS_EXIM. For example, if &'tcpwrappers'& is installed in &_/usr/local_&,
1940 you might have
1941 .code
1942 USE_TCP_WRAPPERS=yes
1943 CFLAGS=-O -I/usr/local/include
1944 EXTRALIBS_EXIM=-L/usr/local/lib -lwrap
1945 .endd
1946 in &_Local/Makefile_&. The daemon name to use in the &'tcpwrappers'& control
1947 files is &"exim"&. For example, the line
1948 .code
1949 exim : LOCAL  192.168.1.  .friendly.domain.example
1950 .endd
1951 in your &_/etc/hosts.allow_& file allows connections from the local host, from
1952 the subnet 192.168.1.0/24, and from all hosts in &'friendly.domain.example'&.
1953 All other connections are denied. The daemon name used by &'tcpwrappers'&
1954 can be changed at build time by setting TCP_WRAPPERS_DAEMON_NAME in
1955 &_Local/Makefile_&, or by setting tcp_wrappers_daemon_name in the
1956 configure file. Consult the &'tcpwrappers'& documentation for
1957 further details.
1958
1959
1960 .section "Including support for IPv6" "SECID28"
1961 .cindex "IPv6" "including support for"
1962 Exim contains code for use on systems that have IPv6 support. Setting
1963 &`HAVE_IPV6=YES`& in &_Local/Makefile_& causes the IPv6 code to be included;
1964 it may also be necessary to set IPV6_INCLUDE and IPV6_LIBS on systems
1965 where the IPv6 support is not fully integrated into the normal include and
1966 library files.
1967
1968 Two different types of DNS record for handling IPv6 addresses have been
1969 defined. AAAA records (analogous to A records for IPv4) are in use, and are
1970 currently seen as the mainstream. Another record type called A6 was proposed
1971 as better than AAAA because it had more flexibility. However, it was felt to be
1972 over-complex, and its status was reduced to &"experimental"&. It is not known
1973 if anyone is actually using A6 records. Exim has support for A6 records, but
1974 this is included only if you set &`SUPPORT_A6=YES`& in &_Local/Makefile_&. The
1975 support has not been tested for some time.
1976
1977
1978
1979 .section "Dynamically loaded lookup module support" "SECTdynamicmodules"
1980 .cindex "lookup modules"
1981 .cindex "dynamic modules"
1982 .cindex ".so building"
1983 On some platforms, Exim supports not compiling all lookup types directly into
1984 the main binary, instead putting some into external modules which can be loaded
1985 on demand.
1986 This permits packagers to build Exim with support for lookups with extensive
1987 library dependencies without requiring all users to install all of those
1988 dependencies.
1989 Most, but not all, lookup types can be built this way.
1990
1991 Set &`LOOKUP_MODULE_DIR`& to the directory into which the modules will be
1992 installed; Exim will only load modules from that directory, as a security
1993 measure.  You will need to set &`CFLAGS_DYNAMIC`& if not already defined
1994 for your OS; see &_OS/Makefile-Linux_& for an example.
1995 Some other requirements for adjusting &`EXTRALIBS`& may also be necessary,
1996 see &_src/EDITME_& for details.
1997
1998 Then, for each module to be loaded dynamically, define the relevant
1999 &`LOOKUP_`&<&'lookup_type'&> flags to have the value "2" instead of "yes".
2000 For example, this will build in lsearch but load sqlite and mysql support
2001 on demand:
2002 .code
2003 LOOKUP_LSEARCH=yes
2004 LOOKUP_SQLITE=2
2005 LOOKUP_MYSQL=2
2006 .endd
2007
2008
2009 .section "The building process" "SECID29"
2010 .cindex "build directory"
2011 Once &_Local/Makefile_& (and &_Local/eximon.conf_&, if required) have been
2012 created, run &'make'& at the top level. It determines the architecture and
2013 operating system types, and creates a build directory if one does not exist.
2014 For example, on a Sun system running Solaris 8, the directory
2015 &_build-SunOS5-5.8-sparc_& is created.
2016 .cindex "symbolic link" "to source files"
2017 Symbolic links to relevant source files are installed in the build directory.
2018
2019 &*Warning*&: The &%-j%& (parallel) flag must not be used with &'make'&; the
2020 building process fails if it is set.
2021
2022 If this is the first time &'make'& has been run, it calls a script that builds
2023 a make file inside the build directory, using the configuration files from the
2024 &_Local_& directory. The new make file is then passed to another instance of
2025 &'make'&. This does the real work, building a number of utility scripts, and
2026 then compiling and linking the binaries for the Exim monitor (if configured), a
2027 number of utility programs, and finally Exim itself. The command &`make
2028 makefile`& can be used to force a rebuild of the make file in the build
2029 directory, should this ever be necessary.
2030
2031 If you have problems building Exim, check for any comments there may be in the
2032 &_README_& file concerning your operating system, and also take a look at the
2033 FAQ, where some common problems are covered.
2034
2035
2036
2037 .section 'Output from &"make"&' "SECID283"
2038 The output produced by the &'make'& process for compile lines is often very
2039 unreadable, because these lines can be very long. For this reason, the normal
2040 output is suppressed by default, and instead output similar to that which
2041 appears when compiling the 2.6 Linux kernel is generated: just a short line for
2042 each module that is being compiled or linked. However, it is still possible to
2043 get the full output, by calling &'make'& like this:
2044 .code
2045 FULLECHO='' make -e
2046 .endd
2047 The value of FULLECHO defaults to &"@"&, the flag character that suppresses
2048 command reflection in &'make'&. When you ask for the full output, it is
2049 given in addition to the short output.
2050
2051
2052
2053 .section "Overriding build-time options for Exim" "SECToverride"
2054 .cindex "build-time options, overriding"
2055 The main make file that is created at the beginning of the building process
2056 consists of the concatenation of a number of files which set configuration
2057 values, followed by a fixed set of &'make'& instructions. If a value is set
2058 more than once, the last setting overrides any previous ones. This provides a
2059 convenient way of overriding defaults. The files that are concatenated are, in
2060 order:
2061 .display
2062 &_OS/Makefile-Default_&
2063 &_OS/Makefile-_&<&'ostype'&>
2064 &_Local/Makefile_&
2065 &_Local/Makefile-_&<&'ostype'&>
2066 &_Local/Makefile-_&<&'archtype'&>
2067 &_Local/Makefile-_&<&'ostype'&>-<&'archtype'&>
2068 &_OS/Makefile-Base_&
2069 .endd
2070 .cindex "&_Local/Makefile_&"
2071 .cindex "building Exim" "operating system type"
2072 .cindex "building Exim" "architecture type"
2073 where <&'ostype'&> is the operating system type and <&'archtype'&> is the
2074 architecture type. &_Local/Makefile_& is required to exist, and the building
2075 process fails if it is absent. The other three &_Local_& files are optional,
2076 and are often not needed.
2077
2078 The values used for <&'ostype'&> and <&'archtype'&> are obtained from scripts
2079 called &_scripts/os-type_& and &_scripts/arch-type_& respectively. If either of
2080 the environment variables EXIM_OSTYPE or EXIM_ARCHTYPE is set, their
2081 values are used, thereby providing a means of forcing particular settings.
2082 Otherwise, the scripts try to get values from the &%uname%& command. If this
2083 fails, the shell variables OSTYPE and ARCHTYPE are inspected. A number
2084 of &'ad hoc'& transformations are then applied, to produce the standard names
2085 that Exim expects. You can run these scripts directly from the shell in order
2086 to find out what values are being used on your system.
2087
2088
2089 &_OS/Makefile-Default_& contains comments about the variables that are set
2090 therein. Some (but not all) are mentioned below. If there is something that
2091 needs changing, review the contents of this file and the contents of the make
2092 file for your operating system (&_OS/Makefile-<ostype>_&) to see what the
2093 default values are.
2094
2095
2096 .cindex "building Exim" "overriding default settings"
2097 If you need to change any of the values that are set in &_OS/Makefile-Default_&
2098 or in &_OS/Makefile-<ostype>_&, or to add any new definitions, you do not
2099 need to change the original files. Instead, you should make the changes by
2100 putting the new values in an appropriate &_Local_& file. For example,
2101 .cindex "Tru64-Unix build-time settings"
2102 when building Exim in many releases of the Tru64-Unix (formerly Digital UNIX,
2103 formerly DEC-OSF1) operating system, it is necessary to specify that the C
2104 compiler is called &'cc'& rather than &'gcc'&. Also, the compiler must be
2105 called with the option &%-std1%&, to make it recognize some of the features of
2106 Standard C that Exim uses. (Most other compilers recognize Standard C by
2107 default.) To do this, you should create a file called &_Local/Makefile-OSF1_&
2108 containing the lines
2109 .code
2110 CC=cc
2111 CFLAGS=-std1
2112 .endd
2113 If you are compiling for just one operating system, it may be easier to put
2114 these lines directly into &_Local/Makefile_&.
2115
2116 Keeping all your local configuration settings separate from the distributed
2117 files makes it easy to transfer them to new versions of Exim simply by copying
2118 the contents of the &_Local_& directory.
2119
2120
2121 .cindex "NIS lookup type" "including support for"
2122 .cindex "NIS+ lookup type" "including support for"
2123 .cindex "LDAP" "including support for"
2124 .cindex "lookup" "inclusion in binary"
2125 Exim contains support for doing LDAP, NIS, NIS+, and other kinds of file
2126 lookup, but not all systems have these components installed, so the default is
2127 not to include the relevant code in the binary. All the different kinds of file
2128 and database lookup that Exim supports are implemented as separate code modules
2129 which are included only if the relevant compile-time options are set. In the
2130 case of LDAP, NIS, and NIS+, the settings for &_Local/Makefile_& are:
2131 .code
2132 LOOKUP_LDAP=yes
2133 LOOKUP_NIS=yes
2134 LOOKUP_NISPLUS=yes
2135 .endd
2136 and similar settings apply to the other lookup types. They are all listed in
2137 &_src/EDITME_&. In many cases the relevant include files and interface
2138 libraries need to be installed before compiling Exim.
2139 .cindex "cdb" "including support for"
2140 However, there are some optional lookup types (such as cdb) for which
2141 the code is entirely contained within Exim, and no external include
2142 files or libraries are required. When a lookup type is not included in the
2143 binary, attempts to configure Exim to use it cause run time configuration
2144 errors.
2145
2146 .cindex "pkg-config" "lookups"
2147 .cindex "pkg-config" "authenticators"
2148 Many systems now use a tool called &'pkg-config'& to encapsulate information
2149 about how to compile against a library; Exim has some initial support for
2150 being able to use pkg-config for lookups and authenticators.  For any given
2151 makefile variable which starts &`LOOKUP_`& or &`AUTH_`&, you can add a new
2152 variable with the &`_PC`& suffix in the name and assign as the value the
2153 name of the package to be queried.  The results of querying via the
2154 &'pkg-config'& command will be added to the appropriate Makefile variables
2155 with &`+=`& directives, so your version of &'make'& will need to support that
2156 syntax.  For instance:
2157 .code
2158 LOOKUP_SQLITE=yes
2159 LOOKUP_SQLITE_PC=sqlite3
2160 AUTH_GSASL=yes
2161 AUTH_GSASL_PC=libgsasl
2162 AUTH_HEIMDAL_GSSAPI=yes
2163 AUTH_HEIMDAL_GSSAPI_PC=heimdal-gssapi
2164 .endd
2165
2166 .cindex "Perl" "including support for"
2167 Exim can be linked with an embedded Perl interpreter, allowing Perl
2168 subroutines to be called during string expansion. To enable this facility,
2169 .code
2170 EXIM_PERL=perl.o
2171 .endd
2172 must be defined in &_Local/Makefile_&. Details of this facility are given in
2173 chapter &<<CHAPperl>>&.
2174
2175 .cindex "X11 libraries, location of"
2176 The location of the X11 libraries is something that varies a lot between
2177 operating systems, and there may be different versions of X11 to cope
2178 with. Exim itself makes no use of X11, but if you are compiling the Exim
2179 monitor, the X11 libraries must be available.
2180 The following three variables are set in &_OS/Makefile-Default_&:
2181 .code
2182 X11=/usr/X11R6
2183 XINCLUDE=-I$(X11)/include
2184 XLFLAGS=-L$(X11)/lib
2185 .endd
2186 These are overridden in some of the operating-system configuration files. For
2187 example, in &_OS/Makefile-SunOS5_& there is
2188 .code
2189 X11=/usr/openwin
2190 XINCLUDE=-I$(X11)/include
2191 XLFLAGS=-L$(X11)/lib -R$(X11)/lib
2192 .endd
2193 If you need to override the default setting for your operating system, place a
2194 definition of all three of these variables into your
2195 &_Local/Makefile-<ostype>_& file.
2196
2197 .cindex "EXTRALIBS"
2198 If you need to add any extra libraries to the link steps, these can be put in a
2199 variable called EXTRALIBS, which appears in all the link commands, but by
2200 default is not defined. In contrast, EXTRALIBS_EXIM is used only on the
2201 command for linking the main Exim binary, and not for any associated utilities.
2202
2203 .cindex "DBM libraries" "configuration for building"
2204 There is also DBMLIB, which appears in the link commands for binaries that
2205 use DBM functions (see also section &<<SECTdb>>&). Finally, there is
2206 EXTRALIBS_EXIMON, which appears only in the link step for the Exim monitor
2207 binary, and which can be used, for example, to include additional X11
2208 libraries.
2209
2210 .cindex "configuration file" "editing"
2211 The make file copes with rebuilding Exim correctly if any of the configuration
2212 files are edited. However, if an optional configuration file is deleted, it is
2213 necessary to touch the associated non-optional file (that is,
2214 &_Local/Makefile_& or &_Local/eximon.conf_&) before rebuilding.
2215
2216
2217 .section "OS-specific header files" "SECID30"
2218 .cindex "&_os.h_&"
2219 .cindex "building Exim" "OS-specific C header files"
2220 The &_OS_& directory contains a number of files with names of the form
2221 &_os.h-<ostype>_&. These are system-specific C header files that should not
2222 normally need to be changed. There is a list of macro settings that are
2223 recognized in the file &_OS/os.configuring_&, which should be consulted if you
2224 are porting Exim to a new operating system.
2225
2226
2227
2228 .section "Overriding build-time options for the monitor" "SECID31"
2229 .cindex "building Eximon"
2230 A similar process is used for overriding things when building the Exim monitor,
2231 where the files that are involved are
2232 .display
2233 &_OS/eximon.conf-Default_&
2234 &_OS/eximon.conf-_&<&'ostype'&>
2235 &_Local/eximon.conf_&
2236 &_Local/eximon.conf-_&<&'ostype'&>
2237 &_Local/eximon.conf-_&<&'archtype'&>
2238 &_Local/eximon.conf-_&<&'ostype'&>-<&'archtype'&>
2239 .endd
2240 .cindex "&_Local/eximon.conf_&"
2241 As with Exim itself, the final three files need not exist, and in this case the
2242 &_OS/eximon.conf-<ostype>_& file is also optional. The default values in
2243 &_OS/eximon.conf-Default_& can be overridden dynamically by setting environment
2244 variables of the same name, preceded by EXIMON_. For example, setting
2245 EXIMON_LOG_DEPTH in the environment overrides the value of
2246 LOG_DEPTH at run time.
2247 .ecindex IIDbuex
2248
2249
2250 .section "Installing Exim binaries and scripts" "SECID32"
2251 .cindex "installing Exim"
2252 .cindex "BIN_DIRECTORY"
2253 The command &`make install`& runs the &(exim_install)& script with no
2254 arguments. The script copies binaries and utility scripts into the directory
2255 whose name is specified by the BIN_DIRECTORY setting in &_Local/Makefile_&.
2256 .cindex "setuid" "installing Exim with"
2257 The install script copies files only if they are newer than the files they are
2258 going to replace. The Exim binary is required to be owned by root and have the
2259 &'setuid'& bit set, for normal configurations. Therefore, you must run &`make
2260 install`& as root so that it can set up the Exim binary in this way. However, in
2261 some special situations (for example, if a host is doing no local deliveries)
2262 it may be possible to run Exim without making the binary setuid root (see
2263 chapter &<<CHAPsecurity>>& for details).
2264
2265 .cindex "CONFIGURE_FILE"
2266 Exim's run time configuration file is named by the CONFIGURE_FILE setting
2267 in &_Local/Makefile_&. If this names a single file, and the file does not
2268 exist, the default configuration file &_src/configure.default_& is copied there
2269 by the installation script. If a run time configuration file already exists, it
2270 is left alone. If CONFIGURE_FILE is a colon-separated list, naming several
2271 alternative files, no default is installed.
2272
2273 .cindex "system aliases file"
2274 .cindex "&_/etc/aliases_&"
2275 One change is made to the default configuration file when it is installed: the
2276 default configuration contains a router that references a system aliases file.
2277 The path to this file is set to the value specified by
2278 SYSTEM_ALIASES_FILE in &_Local/Makefile_& (&_/etc/aliases_& by default).
2279 If the system aliases file does not exist, the installation script creates it,
2280 and outputs a comment to the user.
2281
2282 The created file contains no aliases, but it does contain comments about the
2283 aliases a site should normally have. Mail aliases have traditionally been
2284 kept in &_/etc/aliases_&. However, some operating systems are now using
2285 &_/etc/mail/aliases_&. You should check if yours is one of these, and change
2286 Exim's configuration if necessary.
2287
2288 The default configuration uses the local host's name as the only local domain,
2289 and is set up to do local deliveries into the shared directory &_/var/mail_&,
2290 running as the local user. System aliases and &_.forward_& files in users' home
2291 directories are supported, but no NIS or NIS+ support is configured. Domains
2292 other than the name of the local host are routed using the DNS, with delivery
2293 over SMTP.
2294
2295 It is possible to install Exim for special purposes (such as building a binary
2296 distribution) in a private part of the file system. You can do this by a
2297 command such as
2298 .code
2299 make DESTDIR=/some/directory/ install
2300 .endd
2301 This has the effect of pre-pending the specified directory to all the file
2302 paths, except the name of the system aliases file that appears in the default
2303 configuration. (If a default alias file is created, its name &'is'& modified.)
2304 For backwards compatibility, ROOT is used if DESTDIR is not set,
2305 but this usage is deprecated.
2306
2307 .cindex "installing Exim" "what is not installed"
2308 Running &'make install'& does not copy the Exim 4 conversion script
2309 &'convert4r4'&. You will probably run this only once if you are
2310 upgrading from Exim 3. None of the documentation files in the &_doc_&
2311 directory are copied, except for the info files when you have set
2312 INFO_DIRECTORY, as described in section &<<SECTinsinfdoc>>& below.
2313
2314 For the utility programs, old versions are renamed by adding the suffix &_.O_&
2315 to their names. The Exim binary itself, however, is handled differently. It is
2316 installed under a name that includes the version number and the compile number,
2317 for example &_exim-&version;-1_&. The script then arranges for a symbolic link
2318 called &_exim_& to point to the binary. If you are updating a previous version
2319 of Exim, the script takes care to ensure that the name &_exim_& is never absent
2320 from the directory (as seen by other processes).
2321
2322 .cindex "installing Exim" "testing the script"
2323 If you want to see what the &'make install'& will do before running it for
2324 real, you can pass the &%-n%& option to the installation script by this
2325 command:
2326 .code
2327 make INSTALL_ARG=-n install
2328 .endd
2329 The contents of the variable INSTALL_ARG are passed to the installation
2330 script. You do not need to be root to run this test. Alternatively, you can run
2331 the installation script directly, but this must be from within the build
2332 directory. For example, from the top-level Exim directory you could use this
2333 command:
2334 .code
2335 (cd build-SunOS5-5.5.1-sparc; ../scripts/exim_install -n)
2336 .endd
2337 .cindex "installing Exim" "install script options"
2338 There are two other options that can be supplied to the installation script.
2339
2340 .ilist
2341 &%-no_chown%& bypasses the call to change the owner of the installed binary
2342 to root, and the call to make it a setuid binary.
2343 .next
2344 &%-no_symlink%& bypasses the setting up of the symbolic link &_exim_& to the
2345 installed binary.
2346 .endlist
2347
2348 INSTALL_ARG can be used to pass these options to the script. For example:
2349 .code
2350 make INSTALL_ARG=-no_symlink install
2351 .endd
2352 The installation script can also be given arguments specifying which files are
2353 to be copied. For example, to install just the Exim binary, and nothing else,
2354 without creating the symbolic link, you could use:
2355 .code
2356 make INSTALL_ARG='-no_symlink exim' install
2357 .endd
2358
2359
2360
2361 .section "Installing info documentation" "SECTinsinfdoc"
2362 .cindex "installing Exim" "&'info'& documentation"
2363 Not all systems use the GNU &'info'& system for documentation, and for this
2364 reason, the Texinfo source of Exim's documentation is not included in the main
2365 distribution. Instead it is available separately from the ftp site (see section
2366 &<<SECTavail>>&).
2367
2368 If you have defined INFO_DIRECTORY in &_Local/Makefile_& and the Texinfo
2369 source of the documentation is found in the source tree, running &`make
2370 install`& automatically builds the info files and installs them.
2371
2372
2373
2374 .section "Setting up the spool directory" "SECID33"
2375 .cindex "spool directory" "creating"
2376 When it starts up, Exim tries to create its spool directory if it does not
2377 exist. The Exim uid and gid are used for the owner and group of the spool
2378 directory. Sub-directories are automatically created in the spool directory as
2379 necessary.
2380
2381
2382
2383
2384 .section "Testing" "SECID34"
2385 .cindex "testing" "installation"
2386 Having installed Exim, you can check that the run time configuration file is
2387 syntactically valid by running the following command, which assumes that the
2388 Exim binary directory is within your PATH environment variable:
2389 .code
2390 exim -bV
2391 .endd
2392 If there are any errors in the configuration file, Exim outputs error messages.
2393 Otherwise it outputs the version number and build date,
2394 the DBM library that is being used, and information about which drivers and
2395 other optional code modules are included in the binary.
2396 Some simple routing tests can be done by using the address testing option. For
2397 example,
2398 .display
2399 &`exim -bt`& <&'local username'&>
2400 .endd
2401 should verify that it recognizes a local mailbox, and
2402 .display
2403 &`exim -bt`& <&'remote address'&>
2404 .endd
2405 a remote one. Then try getting it to deliver mail, both locally and remotely.
2406 This can be done by passing messages directly to Exim, without going through a
2407 user agent. For example:
2408 .code
2409 exim -v postmaster@your.domain.example
2410 From: user@your.domain.example
2411 To: postmaster@your.domain.example
2412 Subject: Testing Exim
2413
2414 This is a test message.
2415 ^D
2416 .endd
2417 The &%-v%& option causes Exim to output some verification of what it is doing.
2418 In this case you should see copies of three log lines, one for the message's
2419 arrival, one for its delivery, and one containing &"Completed"&.
2420
2421 .cindex "delivery" "problems with"
2422 If you encounter problems, look at Exim's log files (&'mainlog'& and
2423 &'paniclog'&) to see if there is any relevant information there. Another source
2424 of information is running Exim with debugging turned on, by specifying the
2425 &%-d%& option. If a message is stuck on Exim's spool, you can force a delivery
2426 with debugging turned on by a command of the form
2427 .display
2428 &`exim -d -M`& <&'exim-message-id'&>
2429 .endd
2430 You must be root or an &"admin user"& in order to do this. The &%-d%& option
2431 produces rather a lot of output, but you can cut this down to specific areas.
2432 For example, if you use &%-d-all+route%& only the debugging information
2433 relevant to routing is included. (See the &%-d%& option in chapter
2434 &<<CHAPcommandline>>& for more details.)
2435
2436 .cindex '&"sticky"& bit'
2437 .cindex "lock files"
2438 One specific problem that has shown up on some sites is the inability to do
2439 local deliveries into a shared mailbox directory, because it does not have the
2440 &"sticky bit"& set on it. By default, Exim tries to create a lock file before
2441 writing to a mailbox file, and if it cannot create the lock file, the delivery
2442 is deferred. You can get round this either by setting the &"sticky bit"& on the
2443 directory, or by setting a specific group for local deliveries and allowing
2444 that group to create files in the directory (see the comments above the
2445 &(local_delivery)& transport in the default configuration file). Another
2446 approach is to configure Exim not to use lock files, but just to rely on
2447 &[fcntl()]& locking instead. However, you should do this only if all user
2448 agents also use &[fcntl()]& locking. For further discussion of locking issues,
2449 see chapter &<<CHAPappendfile>>&.
2450
2451 One thing that cannot be tested on a system that is already running an MTA is
2452 the receipt of incoming SMTP mail on the standard SMTP port. However, the
2453 &%-oX%& option can be used to run an Exim daemon that listens on some other
2454 port, or &'inetd'& can be used to do this. The &%-bh%& option and the
2455 &'exim_checkaccess'& utility can be used to check out policy controls on
2456 incoming SMTP mail.
2457
2458 Testing a new version on a system that is already running Exim can most easily
2459 be done by building a binary with a different CONFIGURE_FILE setting. From
2460 within the run time configuration, all other file and directory names
2461 that Exim uses can be altered, in order to keep it entirely clear of the
2462 production version.
2463
2464
2465 .section "Replacing another MTA with Exim" "SECID35"
2466 .cindex "replacing another MTA"
2467 Building and installing Exim for the first time does not of itself put it in
2468 general use. The name by which the system's MTA is called by mail user agents
2469 is either &_/usr/sbin/sendmail_&, or &_/usr/lib/sendmail_& (depending on the
2470 operating system), and it is necessary to make this name point to the &'exim'&
2471 binary in order to get the user agents to pass messages to Exim. This is
2472 normally done by renaming any existing file and making &_/usr/sbin/sendmail_&
2473 or &_/usr/lib/sendmail_&
2474 .cindex "symbolic link" "to &'exim'& binary"
2475 a symbolic link to the &'exim'& binary. It is a good idea to remove any setuid
2476 privilege and executable status from the old MTA. It is then necessary to stop
2477 and restart the mailer daemon, if one is running.
2478
2479 .cindex "FreeBSD, MTA indirection"
2480 .cindex "&_/etc/mail/mailer.conf_&"
2481 Some operating systems have introduced alternative ways of switching MTAs. For
2482 example, if you are running FreeBSD, you need to edit the file
2483 &_/etc/mail/mailer.conf_& instead of setting up a symbolic link as just
2484 described. A typical example of the contents of this file for running Exim is
2485 as follows:
2486 .code
2487 sendmail            /usr/exim/bin/exim
2488 send-mail           /usr/exim/bin/exim
2489 mailq               /usr/exim/bin/exim -bp
2490 newaliases          /usr/bin/true
2491 .endd
2492 Once you have set up the symbolic link, or edited &_/etc/mail/mailer.conf_&,
2493 your Exim installation is &"live"&. Check it by sending a message from your
2494 favourite user agent.
2495
2496 You should consider what to tell your users about the change of MTA. Exim may
2497 have different capabilities to what was previously running, and there are
2498 various operational differences such as the text of messages produced by
2499 command line options and in bounce messages. If you allow your users to make
2500 use of Exim's filtering capabilities, you should make the document entitled
2501 &'Exim's interface to mail filtering'& available to them.
2502
2503
2504
2505 .section "Upgrading Exim" "SECID36"
2506 .cindex "upgrading Exim"
2507 If you are already running Exim on your host, building and installing a new
2508 version automatically makes it available to MUAs, or any other programs that
2509 call the MTA directly. However, if you are running an Exim daemon, you do need
2510 to send it a HUP signal, to make it re-execute itself, and thereby pick up the
2511 new binary. You do not need to stop processing mail in order to install a new
2512 version of Exim. The install script does not modify an existing runtime
2513 configuration file.
2514
2515
2516
2517
2518 .section "Stopping the Exim daemon on Solaris" "SECID37"
2519 .cindex "Solaris" "stopping Exim on"
2520 The standard command for stopping the mailer daemon on Solaris is
2521 .code
2522 /etc/init.d/sendmail stop
2523 .endd
2524 If &_/usr/lib/sendmail_& has been turned into a symbolic link, this script
2525 fails to stop Exim because it uses the command &'ps -e'& and greps the output
2526 for the text &"sendmail"&; this is not present because the actual program name
2527 (that is, &"exim"&) is given by the &'ps'& command with these options. A
2528 solution is to replace the line that finds the process id with something like
2529 .code
2530 pid=`cat /var/spool/exim/exim-daemon.pid`
2531 .endd
2532 to obtain the daemon's pid directly from the file that Exim saves it in.
2533
2534 Note, however, that stopping the daemon does not &"stop Exim"&. Messages can
2535 still be received from local processes, and if automatic delivery is configured
2536 (the normal case), deliveries will still occur.
2537
2538
2539
2540
2541 . ////////////////////////////////////////////////////////////////////////////
2542 . ////////////////////////////////////////////////////////////////////////////
2543
2544 .chapter "The Exim command line" "CHAPcommandline"
2545 .scindex IIDclo1 "command line" "options"
2546 .scindex IIDclo2 "options" "command line"
2547 Exim's command line takes the standard Unix form of a sequence of options,
2548 each starting with a hyphen character, followed by a number of arguments. The
2549 options are compatible with the main options of Sendmail, and there are also
2550 some additional options, some of which are compatible with Smail 3. Certain
2551 combinations of options do not make sense, and provoke an error if used.
2552 The form of the arguments depends on which options are set.
2553
2554
2555 .section "Setting options by program name" "SECID38"
2556 .cindex "&'mailq'&"
2557 If Exim is called under the name &'mailq'&, it behaves as if the option &%-bp%&
2558 were present before any other options.
2559 The &%-bp%& option requests a listing of the contents of the mail queue on the
2560 standard output.
2561 This feature is for compatibility with some systems that contain a command of
2562 that name in one of the standard libraries, symbolically linked to
2563 &_/usr/sbin/sendmail_& or &_/usr/lib/sendmail_&.
2564
2565 .cindex "&'rsmtp'&"
2566 If Exim is called under the name &'rsmtp'& it behaves as if the option &%-bS%&
2567 were present before any other options, for compatibility with Smail. The
2568 &%-bS%& option is used for reading in a number of messages in batched SMTP
2569 format.
2570
2571 .cindex "&'rmail'&"
2572 If Exim is called under the name &'rmail'& it behaves as if the &%-i%& and
2573 &%-oee%& options were present before any other options, for compatibility with
2574 Smail. The name &'rmail'& is used as an interface by some UUCP systems.
2575
2576 .cindex "&'runq'&"
2577 .cindex "queue runner"
2578 If Exim is called under the name &'runq'& it behaves as if the option &%-q%&
2579 were present before any other options, for compatibility with Smail. The &%-q%&
2580 option causes a single queue runner process to be started.
2581
2582 .cindex "&'newaliases'&"
2583 .cindex "alias file" "building"
2584 .cindex "Sendmail compatibility" "calling Exim as &'newaliases'&"
2585 If Exim is called under the name &'newaliases'& it behaves as if the option
2586 &%-bi%& were present before any other options, for compatibility with Sendmail.
2587 This option is used for rebuilding Sendmail's alias file. Exim does not have
2588 the concept of a single alias file, but can be configured to run a given
2589 command if called with the &%-bi%& option.
2590
2591
2592 .section "Trusted and admin users" "SECTtrustedadmin"
2593 Some Exim options are available only to &'trusted users'& and others are
2594 available only to &'admin users'&. In the description below, the phrases &"Exim
2595 user"& and &"Exim group"& mean the user and group defined by EXIM_USER and
2596 EXIM_GROUP in &_Local/Makefile_& or set by the &%exim_user%& and
2597 &%exim_group%& options. These do not necessarily have to use the name &"exim"&.
2598
2599 .ilist
2600 .cindex "trusted users" "definition of"
2601 .cindex "user" "trusted definition of"
2602 The trusted users are root, the Exim user, any user listed in the
2603 &%trusted_users%& configuration option, and any user whose current group or any
2604 supplementary group is one of those listed in the &%trusted_groups%&
2605 configuration option. Note that the Exim group is not automatically trusted.
2606
2607 .cindex '&"From"& line'
2608 .cindex "envelope sender"
2609 Trusted users are always permitted to use the &%-f%& option or a leading
2610 &"From&~"& line to specify the envelope sender of a message that is passed to
2611 Exim through the local interface (see the &%-bm%& and &%-f%& options below).
2612 See the &%untrusted_set_sender%& option for a way of permitting non-trusted
2613 users to set envelope senders.
2614
2615 .cindex "&'From:'& header line"
2616 .cindex "&'Sender:'& header line"
2617 For a trusted user, there is never any check on the contents of the &'From:'&
2618 header line, and a &'Sender:'& line is never added. Furthermore, any existing
2619 &'Sender:'& line in incoming local (non-TCP/IP) messages is not removed.
2620
2621 Trusted users may also specify a host name, host address, interface address,
2622 protocol name, ident value, and authentication data when submitting a message
2623 locally. Thus, they are able to insert messages into Exim's queue locally that
2624 have the characteristics of messages received from a remote host. Untrusted
2625 users may in some circumstances use &%-f%&, but can never set the other values
2626 that are available to trusted users.
2627 .next
2628 .cindex "user" "admin definition of"
2629 .cindex "admin user" "definition of"
2630 The admin users are root, the Exim user, and any user that is a member of the
2631 Exim group or of any group listed in the &%admin_groups%& configuration option.
2632 The current group does not have to be one of these groups.
2633
2634 Admin users are permitted to list the queue, and to carry out certain
2635 operations on messages, for example, to force delivery failures. It is also
2636 necessary to be an admin user in order to see the full information provided by
2637 the Exim monitor, and full debugging output.
2638
2639 By default, the use of the &%-M%&, &%-q%&, &%-R%&, and &%-S%& options to cause
2640 Exim to attempt delivery of messages on its queue is restricted to admin users.
2641 However, this restriction can be relaxed by setting the &%prod_requires_admin%&
2642 option false (that is, specifying &%no_prod_requires_admin%&).
2643
2644 Similarly, the use of the &%-bp%& option to list all the messages in the queue
2645 is restricted to admin users unless &%queue_list_requires_admin%& is set
2646 false.
2647 .endlist
2648
2649
2650 &*Warning*&: If you configure your system so that admin users are able to
2651 edit Exim's configuration file, you are giving those users an easy way of
2652 getting root. There is further discussion of this issue at the start of chapter
2653 &<<CHAPconf>>&.
2654
2655
2656
2657
2658 .section "Command line options" "SECID39"
2659 Exim's command line options are described in alphabetical order below. If none
2660 of the options that specifies a specific action (such as starting the daemon or
2661 a queue runner, or testing an address, or receiving a message in a specific
2662 format, or listing the queue) are present, and there is at least one argument
2663 on the command line, &%-bm%& (accept a local message on the standard input,
2664 with the arguments specifying the recipients) is assumed. Otherwise, Exim
2665 outputs a brief message about itself and exits.
2666
2667 . ////////////////////////////////////////////////////////////////////////////
2668 . Insert a stylized XML comment here, to identify the start of the command line
2669 . options. This is for the benefit of the Perl script that automatically
2670 . creates a man page for the options.
2671 . ////////////////////////////////////////////////////////////////////////////
2672
2673 .literal xml
2674 <!-- === Start of command line options === -->
2675 .literal off
2676
2677
2678 .vlist
2679 .vitem &%--%&
2680 .oindex "--"
2681 .cindex "options" "command line; terminating"
2682 This is a pseudo-option whose only purpose is to terminate the options and
2683 therefore to cause subsequent command line items to be treated as arguments
2684 rather than options, even if they begin with hyphens.
2685
2686 .vitem &%--help%&
2687 .oindex "&%--help%&"
2688 This option causes Exim to output a few sentences stating what it is.
2689 The same output is generated if the Exim binary is called with no options and
2690 no arguments.
2691
2692 .vitem &%--version%&
2693 .oindex "&%--version%&"
2694 This option is an alias for &%-bV%& and causes version information to be
2695 displayed.
2696
2697 .new
2698 .vitem &%-Ac%& &&&
2699        &%-Am%&
2700 .oindex "&%-Ac%&"
2701 .oindex "&%-Am%&"
2702 These options are used by Sendmail for selecting configuration files and are
2703 ignored by Exim.
2704 .wen
2705
2706 .vitem &%-B%&<&'type'&>
2707 .oindex "&%-B%&"
2708 .cindex "8-bit characters"
2709 .cindex "Sendmail compatibility" "8-bit characters"
2710 This is a Sendmail option for selecting 7 or 8 bit processing. Exim is 8-bit
2711 clean; it ignores this option.
2712
2713 .vitem &%-bd%&
2714 .oindex "&%-bd%&"
2715 .cindex "daemon"
2716 .cindex "SMTP" "listener"
2717 .cindex "queue runner"
2718 This option runs Exim as a daemon, awaiting incoming SMTP connections. Usually
2719 the &%-bd%& option is combined with the &%-q%&<&'time'&> option, to specify
2720 that the daemon should also initiate periodic queue runs.
2721
2722 The &%-bd%& option can be used only by an admin user. If either of the &%-d%&
2723 (debugging) or &%-v%& (verifying) options are set, the daemon does not
2724 disconnect from the controlling terminal. When running this way, it can be
2725 stopped by pressing ctrl-C.
2726
2727 By default, Exim listens for incoming connections to the standard SMTP port on
2728 all the host's running interfaces. However, it is possible to listen on other
2729 ports, on multiple ports, and only on specific interfaces. Chapter
2730 &<<CHAPinterfaces>>& contains a description of the options that control this.
2731
2732 When a listening daemon
2733 .cindex "daemon" "process id (pid)"
2734 .cindex "pid (process id)" "of daemon"
2735 is started without the use of &%-oX%& (that is, without overriding the normal
2736 configuration), it writes its process id to a file called &_exim-daemon.pid_&
2737 in Exim's spool directory. This location can be overridden by setting
2738 PID_FILE_PATH in &_Local/Makefile_&. The file is written while Exim is still
2739 running as root.
2740
2741 When &%-oX%& is used on the command line to start a listening daemon, the
2742 process id is not written to the normal pid file path. However, &%-oP%& can be
2743 used to specify a path on the command line if a pid file is required.
2744
2745 The SIGHUP signal
2746 .cindex "SIGHUP"
2747 .cindex "daemon" "restarting"
2748 can be used to cause the daemon to re-execute itself. This should be done
2749 whenever Exim's configuration file, or any file that is incorporated into it by
2750 means of the &%.include%& facility, is changed, and also whenever a new version
2751 of Exim is installed. It is not necessary to do this when other files that are
2752 referenced from the configuration (for example, alias files) are changed,
2753 because these are reread each time they are used.
2754
2755 .vitem &%-bdf%&
2756 .oindex "&%-bdf%&"
2757 This option has the same effect as &%-bd%& except that it never disconnects
2758 from the controlling terminal, even when no debugging is specified.
2759
2760 .vitem &%-be%&
2761 .oindex "&%-be%&"
2762 .cindex "testing" "string expansion"
2763 .cindex "expansion" "testing"
2764 Run Exim in expansion testing mode. Exim discards its root privilege, to
2765 prevent ordinary users from using this mode to read otherwise inaccessible
2766 files. If no arguments are given, Exim runs interactively, prompting for lines
2767 of data. Otherwise, it processes each argument in turn.
2768
2769 If Exim was built with USE_READLINE=yes in &_Local/Makefile_&, it tries
2770 to load the &%libreadline%& library dynamically whenever the &%-be%& option is
2771 used without command line arguments. If successful, it uses the &[readline()]&
2772 function, which provides extensive line-editing facilities, for reading the
2773 test data. A line history is supported.
2774
2775 Long expansion expressions can be split over several lines by using backslash
2776 continuations. As in Exim's run time configuration, white space at the start of
2777 continuation lines is ignored. Each argument or data line is passed through the
2778 string expansion mechanism, and the result is output. Variable values from the
2779 configuration file (for example, &$qualify_domain$&) are available, but no
2780 message-specific values (such as &$sender_domain$&) are set, because no message
2781 is being processed (but see &%-bem%& and &%-Mset%&).
2782
2783 &*Note*&: If you use this mechanism to test lookups, and you change the data
2784 files or databases you are using, you must exit and restart Exim before trying
2785 the same lookup again. Otherwise, because each Exim process caches the results
2786 of lookups, you will just get the same result as before.
2787
2788 .vitem &%-bem%&&~<&'filename'&>
2789 .oindex "&%-bem%&"
2790 .cindex "testing" "string expansion"
2791 .cindex "expansion" "testing"
2792 This option operates like &%-be%& except that it must be followed by the name
2793 of a file. For example:
2794 .code
2795 exim -bem /tmp/testmessage
2796 .endd
2797 The file is read as a message (as if receiving a locally-submitted non-SMTP
2798 message) before any of the test expansions are done. Thus, message-specific
2799 variables such as &$message_size$& and &$header_from:$& are available. However,
2800 no &'Received:'& header is added to the message. If the &%-t%& option is set,
2801 recipients are read from the headers in the normal way, and are shown in the
2802 &$recipients$& variable. Note that recipients cannot be given on the command
2803 line, because further arguments are taken as strings to expand (just like
2804 &%-be%&).
2805
2806 .vitem &%-bF%&&~<&'filename'&>
2807 .oindex "&%-bF%&"
2808 .cindex "system filter" "testing"
2809 .cindex "testing" "system filter"
2810 This option is the same as &%-bf%& except that it assumes that the filter being
2811 tested is a system filter. The additional commands that are available only in
2812 system filters are recognized.
2813
2814 .vitem &%-bf%&&~<&'filename'&>
2815 .oindex "&%-bf%&"
2816 .cindex "filter" "testing"
2817 .cindex "testing" "filter file"
2818 .cindex "forward file" "testing"
2819 .cindex "testing" "forward file"
2820 .cindex "Sieve filter" "testing"
2821 This option runs Exim in user filter testing mode; the file is the filter file
2822 to be tested, and a test message must be supplied on the standard input. If
2823 there are no message-dependent tests in the filter, an empty file can be
2824 supplied.
2825
2826 If you want to test a system filter file, use &%-bF%& instead of &%-bf%&. You
2827 can use both &%-bF%& and &%-bf%& on the same command, in order to test a system
2828 filter and a user filter in the same run. For example:
2829 .code
2830 exim -bF /system/filter -bf /user/filter </test/message
2831 .endd
2832 This is helpful when the system filter adds header lines or sets filter
2833 variables that are used by the user filter.
2834
2835 If the test filter file does not begin with one of the special lines
2836 .code
2837 # Exim filter
2838 # Sieve filter
2839 .endd
2840 it is taken to be a normal &_.forward_& file, and is tested for validity under
2841 that interpretation. See sections &<<SECTitenonfilred>>& to
2842 &<<SECTspecitredli>>& for a description of the possible contents of non-filter
2843 redirection lists.
2844
2845 The result of an Exim command that uses &%-bf%&, provided no errors are
2846 detected, is a list of the actions that Exim would try to take if presented
2847 with the message for real. More details of filter testing are given in the
2848 separate document entitled &'Exim's interfaces to mail filtering'&.
2849
2850 When testing a filter file,
2851 .cindex "&""From""& line"
2852 .cindex "envelope sender"
2853 .oindex "&%-f%&" "for filter testing"
2854 the envelope sender can be set by the &%-f%& option,
2855 or by a &"From&~"& line at the start of the test message. Various parameters
2856 that would normally be taken from the envelope recipient address of the message
2857 can be set by means of additional command line options (see the next four
2858 options).
2859
2860 .vitem &%-bfd%&&~<&'domain'&>
2861 .oindex "&%-bfd%&"
2862 .vindex "&$qualify_domain$&"
2863 This sets the domain of the recipient address when a filter file is being
2864 tested by means of the &%-bf%& option. The default is the value of
2865 &$qualify_domain$&.
2866
2867 .vitem &%-bfl%&&~<&'local&~part'&>
2868 .oindex "&%-bfl%&"
2869 This sets the local part of the recipient address when a filter file is being
2870 tested by means of the &%-bf%& option. The default is the username of the
2871 process that calls Exim. A local part should be specified with any prefix or
2872 suffix stripped, because that is how it appears to the filter when a message is
2873 actually being delivered.
2874
2875 .vitem &%-bfp%&&~<&'prefix'&>
2876 .oindex "&%-bfp%&"
2877 This sets the prefix of the local part of the recipient address when a filter
2878 file is being tested by means of the &%-bf%& option. The default is an empty
2879 prefix.
2880
2881 .vitem &%-bfs%&&~<&'suffix'&>
2882 .oindex "&%-bfs%&"
2883 This sets the suffix of the local part of the recipient address when a filter
2884 file is being tested by means of the &%-bf%& option. The default is an empty
2885 suffix.
2886
2887 .vitem &%-bh%&&~<&'IP&~address'&>
2888 .oindex "&%-bh%&"
2889 .cindex "testing" "incoming SMTP"
2890 .cindex "SMTP" "testing incoming"
2891 .cindex "testing" "relay control"
2892 .cindex "relaying" "testing configuration"
2893 .cindex "policy control" "testing"
2894 .cindex "debugging" "&%-bh%& option"
2895 This option runs a fake SMTP session as if from the given IP address, using the
2896 standard input and output. The IP address may include a port number at the end,
2897 after a full stop. For example:
2898 .code
2899 exim -bh 10.9.8.7.1234
2900 exim -bh fe80::a00:20ff:fe86:a061.5678
2901 .endd
2902 When an IPv6 address is given, it is converted into canonical form. In the case
2903 of the second example above, the value of &$sender_host_address$& after
2904 conversion to the canonical form is
2905 &`fe80:0000:0000:0a00:20ff:fe86:a061.5678`&.
2906
2907 Comments as to what is going on are written to the standard error file. These
2908 include lines beginning with &"LOG"& for anything that would have been logged.
2909 This facility is provided for testing configuration options for incoming
2910 messages, to make sure they implement the required policy. For example, you can
2911 test your relay controls using &%-bh%&.
2912
2913 &*Warning 1*&:
2914 .cindex "RFC 1413"
2915 You can test features of the configuration that rely on ident (RFC 1413)
2916 information by using the &%-oMt%& option. However, Exim cannot actually perform
2917 an ident callout when testing using &%-bh%& because there is no incoming SMTP
2918 connection.
2919
2920 &*Warning 2*&: Address verification callouts (see section &<<SECTcallver>>&)
2921 are also skipped when testing using &%-bh%&. If you want these callouts to
2922 occur, use &%-bhc%& instead.
2923
2924 Messages supplied during the testing session are discarded, and nothing is
2925 written to any of the real log files. There may be pauses when DNS (and other)
2926 lookups are taking place, and of course these may time out. The &%-oMi%& option
2927 can be used to specify a specific IP interface and port if this is important,
2928 and &%-oMaa%& and &%-oMai%& can be used to set parameters as if the SMTP
2929 session were authenticated.
2930
2931 The &'exim_checkaccess'& utility is a &"packaged"& version of &%-bh%& whose
2932 output just states whether a given recipient address from a given host is
2933 acceptable or not. See section &<<SECTcheckaccess>>&.
2934
2935 Features such as authentication and encryption, where the client input is not
2936 plain text, cannot easily be tested with &%-bh%&. Instead, you should use a
2937 specialized SMTP test program such as
2938 &url(http://jetmore.org/john/code/#swaks,swaks).
2939
2940 .vitem &%-bhc%&&~<&'IP&~address'&>
2941 .oindex "&%-bhc%&"
2942 This option operates in the same way as &%-bh%&, except that address
2943 verification callouts are performed if required. This includes consulting and
2944 updating the callout cache database.
2945
2946 .vitem &%-bi%&
2947 .oindex "&%-bi%&"
2948 .cindex "alias file" "building"
2949 .cindex "building alias file"
2950 .cindex "Sendmail compatibility" "&%-bi%& option"
2951 Sendmail interprets the &%-bi%& option as a request to rebuild its alias file.
2952 Exim does not have the concept of a single alias file, and so it cannot mimic
2953 this behaviour. However, calls to &_/usr/lib/sendmail_& with the &%-bi%& option
2954 tend to appear in various scripts such as NIS make files, so the option must be
2955 recognized.
2956
2957 If &%-bi%& is encountered, the command specified by the &%bi_command%&
2958 configuration option is run, under the uid and gid of the caller of Exim. If
2959 the &%-oA%& option is used, its value is passed to the command as an argument.
2960 The command set by &%bi_command%& may not contain arguments. The command can
2961 use the &'exim_dbmbuild'& utility, or some other means, to rebuild alias files
2962 if this is required. If the &%bi_command%& option is not set, calling Exim with
2963 &%-bi%& is a no-op.
2964
2965 .new
2966 . // Keep :help first, then the rest in alphabetical order
2967 .vitem &%-bI:help%&
2968 .oindex "&%-bI:help%&"
2969 .cindex "querying exim information"
2970 We shall provide various options starting &`-bI:`& for querying Exim for
2971 information.  The output of many of these will be intended for machine
2972 consumption.  This one is not.  The &%-bI:help%& option asks Exim for a
2973 synopsis of supported options beginning &`-bI:`&.  Use of any of these
2974 options shall cause Exim to exit after producing the requested output.
2975
2976 .vitem &%-bI:dscp%&
2977 .oindex "&%-bI:dscp%&"
2978 .cindex "DSCP" "values"
2979 This option causes Exim to emit an alphabetically sorted list of all
2980 recognised DSCP names.
2981
2982 .vitem &%-bI:sieve%&
2983 .oindex "&%-bI:sieve%&"
2984 .cindex "Sieve filter" "capabilities"
2985 This option causes Exim to emit an alphabetically sorted list of all supported
2986 Sieve protocol extensions on stdout, one per line.  This is anticipated to be
2987 useful for ManageSieve (RFC 5804) implementations, in providing that protocol's
2988 &`SIEVE`& capability response line.  As the precise list may depend upon
2989 compile-time build options, which this option will adapt to, this is the only
2990 way to guarantee a correct response.
2991 .wen
2992
2993 .vitem &%-bm%&
2994 .oindex "&%-bm%&"
2995 .cindex "local message reception"
2996 This option runs an Exim receiving process that accepts an incoming,
2997 locally-generated message on the standard input. The recipients are given as the
2998 command arguments (except when &%-t%& is also present &-- see below). Each
2999 argument can be a comma-separated list of RFC 2822 addresses. This is the
3000 default option for selecting the overall action of an Exim call; it is assumed
3001 if no other conflicting option is present.
3002
3003 If any addresses in the message are unqualified (have no domain), they are
3004 qualified by the values of the &%qualify_domain%& or &%qualify_recipient%&
3005 options, as appropriate. The &%-bnq%& option (see below) provides a way of
3006 suppressing this for special cases.
3007
3008 Policy checks on the contents of local messages can be enforced by means of
3009 the non-SMTP ACL. See chapter &<<CHAPACL>>& for details.
3010
3011 .cindex "return code" "for &%-bm%&"
3012 The return code is zero if the message is successfully accepted. Otherwise, the
3013 action is controlled by the &%-oe%&&'x'& option setting &-- see below.
3014
3015 The format
3016 .cindex "message" "format"
3017 .cindex "format" "message"
3018 .cindex "&""From""& line"
3019 .cindex "UUCP" "&""From""& line"
3020 .cindex "Sendmail compatibility" "&""From""& line"
3021 of the message must be as defined in RFC 2822, except that, for
3022 compatibility with Sendmail and Smail, a line in one of the forms
3023 .code
3024 From sender Fri Jan  5 12:55 GMT 1997
3025 From sender Fri, 5 Jan 97 12:55:01
3026 .endd
3027 (with the weekday optional, and possibly with additional text after the date)
3028 is permitted to appear at the start of the message. There appears to be no
3029 authoritative specification of the format of this line. Exim recognizes it by
3030 matching against the regular expression defined by the &%uucp_from_pattern%&
3031 option, which can be changed if necessary.
3032
3033 .oindex "&%-f%&" "overriding &""From""& line"
3034 The specified sender is treated as if it were given as the argument to the
3035 &%-f%& option, but if a &%-f%& option is also present, its argument is used in
3036 preference to the address taken from the message. The caller of Exim must be a
3037 trusted user for the sender of a message to be set in this way.
3038
3039 .vitem &%-bmalware%&&~<&'filename'&>
3040 .oindex "&%-bmalware%&"
3041 .cindex "testing", "malware"
3042 .cindex "malware scan test"
3043 This debugging option causes Exim to scan the given file,
3044 using the malware scanning framework.  The option of &%av_scanner%& influences
3045 this option, so if &%av_scanner%&'s value is dependent upon an expansion then
3046 the expansion should have defaults which apply to this invocation.  ACLs are
3047 not invoked, so if &%av_scanner%& references an ACL variable then that variable
3048 will never be populated and &%-bmalware%& will fail.
3049
3050 Exim will have changed working directory before resolving the filename, so
3051 using fully qualified pathnames is advisable.  Exim will be running as the Exim
3052 user when it tries to open the file, rather than as the invoking user.
3053 This option requires admin privileges.
3054
3055 The &%-bmalware%& option will not be extended to be more generally useful,
3056 there are better tools for file-scanning.  This option exists to help
3057 administrators verify their Exim and AV scanner configuration.
3058
3059 .vitem &%-bnq%&
3060 .oindex "&%-bnq%&"
3061 .cindex "address qualification, suppressing"
3062 By default, Exim automatically qualifies unqualified addresses (those
3063 without domains) that appear in messages that are submitted locally (that
3064 is, not over TCP/IP). This qualification applies both to addresses in
3065 envelopes, and addresses in header lines. Sender addresses are qualified using
3066 &%qualify_domain%&, and recipient addresses using &%qualify_recipient%& (which
3067 defaults to the value of &%qualify_domain%&).
3068
3069 Sometimes, qualification is not wanted. For example, if &%-bS%& (batch SMTP) is
3070 being used to re-submit messages that originally came from remote hosts after
3071 content scanning, you probably do not want to qualify unqualified addresses in
3072 header lines. (Such lines will be present only if you have not enabled a header
3073 syntax check in the appropriate ACL.)
3074
3075 The &%-bnq%& option suppresses all qualification of unqualified addresses in
3076 messages that originate on the local host. When this is used, unqualified
3077 addresses in the envelope provoke errors (causing message rejection) and
3078 unqualified addresses in header lines are left alone.
3079
3080
3081 .vitem &%-bP%&
3082 .oindex "&%-bP%&"
3083 .cindex "configuration options" "extracting"
3084 .cindex "options" "configuration &-- extracting"
3085 If this option is given with no arguments, it causes the values of all Exim's
3086 main configuration options to be written to the standard output. The values
3087 of one or more specific options can be requested by giving their names as
3088 arguments, for example:
3089 .code
3090 exim -bP qualify_domain hold_domains
3091 .endd
3092 .cindex "hiding configuration option values"
3093 .cindex "configuration options" "hiding value of"
3094 .cindex "options" "hiding value of"
3095 However, any option setting that is preceded by the word &"hide"& in the
3096 configuration file is not shown in full, except to an admin user. For other
3097 users, the output is as in this example:
3098 .code
3099 mysql_servers = <value not displayable>
3100 .endd
3101 If &%configure_file%& is given as an argument, the name of the run time
3102 configuration file is output.
3103 If a list of configuration files was supplied, the value that is output here
3104 is the name of the file that was actually used.
3105
3106 .new
3107 .cindex "options" "hiding name of"
3108 If the &%-n%& flag is given, then for most modes of &%-bP%& operation the
3109 name will not be output.
3110 .wen
3111
3112 .cindex "daemon" "process id (pid)"
3113 .cindex "pid (process id)" "of daemon"
3114 If &%log_file_path%& or &%pid_file_path%& are given, the names of the
3115 directories where log files and daemon pid files are written are output,
3116 respectively. If these values are unset, log files are written in a
3117 sub-directory of the spool directory called &%log%&, and the pid file is
3118 written directly into the spool directory.
3119
3120 If &%-bP%& is followed by a name preceded by &`+`&, for example,
3121 .code
3122 exim -bP +local_domains
3123 .endd
3124 it searches for a matching named list of any type (domain, host, address, or
3125 local part) and outputs what it finds.
3126
3127 .cindex "options" "router &-- extracting"
3128 .cindex "options" "transport &-- extracting"
3129 .cindex "options" "authenticator &-- extracting"
3130 If one of the words &%router%&, &%transport%&, or &%authenticator%& is given,
3131 followed by the name of an appropriate driver instance, the option settings for
3132 that driver are output. For example:
3133 .code
3134 exim -bP transport local_delivery
3135 .endd
3136 The generic driver options are output first, followed by the driver's private
3137 options. A list of the names of drivers of a particular type can be obtained by
3138 using one of the words &%router_list%&, &%transport_list%&, or
3139 &%authenticator_list%&, and a complete list of all drivers with their option
3140 settings can be obtained by using &%routers%&, &%transports%&, or
3141 &%authenticators%&.
3142
3143 .cindex "options" "macro &-- extracting"
3144 If invoked by an admin user, then &%macro%&, &%macro_list%& and &%macros%&
3145 are available, similarly to the drivers.  Because macros are sometimes used
3146 for storing passwords, this option is restricted.
3147 The output format is one item per line.
3148
3149 .vitem &%-bp%&
3150 .oindex "&%-bp%&"
3151 .cindex "queue" "listing messages on"
3152 .cindex "listing" "messages on the queue"
3153 This option requests a listing of the contents of the mail queue on the
3154 standard output. If the &%-bp%& option is followed by a list of message ids,
3155 just those messages are listed. By default, this option can be used only by an
3156 admin user. However, the &%queue_list_requires_admin%& option can be set false
3157 to allow any user to see the queue.
3158
3159 Each message on the queue is displayed as in the following example:
3160 .code
3161 25m  2.9K 0t5C6f-0000c8-00 <alice@wonderland.fict.example>
3162           red.king@looking-glass.fict.example
3163           <other addresses>
3164 .endd
3165 .cindex "message" "size in queue listing"
3166 .cindex "size" "of message"
3167 The first line contains the length of time the message has been on the queue
3168 (in this case 25 minutes), the size of the message (2.9K), the unique local
3169 identifier for the message, and the message sender, as contained in the
3170 envelope. For bounce messages, the sender address is empty, and appears as
3171 &"<>"&. If the message was submitted locally by an untrusted user who overrode
3172 the default sender address, the user's login name is shown in parentheses
3173 before the sender address.
3174
3175 .cindex "frozen messages" "in queue listing"
3176 If the message is frozen (attempts to deliver it are suspended) then the text
3177 &"*** frozen ***"& is displayed at the end of this line.
3178
3179 The recipients of the message (taken from the envelope, not the headers) are
3180 displayed on subsequent lines. Those addresses to which the message has already
3181 been delivered are marked with the letter D. If an original address gets
3182 expanded into several addresses via an alias or forward file, the original is
3183 displayed with a D only when deliveries for all of its child addresses are
3184 complete.
3185
3186
3187 .vitem &%-bpa%&
3188 .oindex "&%-bpa%&"
3189 This option operates like &%-bp%&, but in addition it shows delivered addresses
3190 that were generated from the original top level address(es) in each message by
3191 alias or forwarding operations. These addresses are flagged with &"+D"& instead
3192 of just &"D"&.
3193
3194
3195 .vitem &%-bpc%&
3196 .oindex "&%-bpc%&"
3197 .cindex "queue" "count of messages on"
3198 This option counts the number of messages on the queue, and writes the total
3199 to the standard output. It is restricted to admin users, unless
3200 &%queue_list_requires_admin%& is set false.
3201
3202
3203 .vitem &%-bpr%&
3204 .oindex "&%-bpr%&"
3205 This option operates like &%-bp%&, but the output is not sorted into
3206 chronological order of message arrival. This can speed it up when there are
3207 lots of messages on the queue, and is particularly useful if the output is
3208 going to be post-processed in a way that doesn't need the sorting.
3209
3210 .vitem &%-bpra%&
3211 .oindex "&%-bpra%&"
3212 This option is a combination of &%-bpr%& and &%-bpa%&.
3213
3214 .vitem &%-bpru%&
3215 .oindex "&%-bpru%&"
3216 This option is a combination of &%-bpr%& and &%-bpu%&.
3217
3218
3219 .vitem &%-bpu%&
3220 .oindex "&%-bpu%&"
3221 This option operates like &%-bp%& but shows only undelivered top-level
3222 addresses for each message displayed. Addresses generated by aliasing or
3223 forwarding are not shown, unless the message was deferred after processing by a
3224 router with the &%one_time%& option set.
3225
3226
3227 .vitem &%-brt%&
3228 .oindex "&%-brt%&"
3229 .cindex "testing" "retry configuration"
3230 .cindex "retry" "configuration testing"
3231 This option is for testing retry rules, and it must be followed by up to three
3232 arguments. It causes Exim to look for a retry rule that matches the values
3233 and to write it to the standard output. For example:
3234 .code
3235 exim -brt bach.comp.mus.example
3236 Retry rule: *.comp.mus.example  F,2h,15m; F,4d,30m;
3237 .endd
3238 See chapter &<<CHAPretry>>& for a description of Exim's retry rules. The first
3239 argument, which is required, can be a complete address in the form
3240 &'local_part@domain'&, or it can be just a domain name. If the second argument
3241 contains a dot, it is interpreted as an optional second domain name; if no
3242 retry rule is found for the first argument, the second is tried. This ties in
3243 with Exim's behaviour when looking for retry rules for remote hosts &-- if no
3244 rule is found that matches the host, one that matches the mail domain is
3245 sought. Finally, an argument that is the name of a specific delivery error, as
3246 used in setting up retry rules, can be given. For example:
3247 .code
3248 exim -brt haydn.comp.mus.example quota_3d
3249 Retry rule: *@haydn.comp.mus.example quota_3d  F,1h,15m
3250 .endd
3251
3252 .vitem &%-brw%&
3253 .oindex "&%-brw%&"
3254 .cindex "testing" "rewriting"
3255 .cindex "rewriting" "testing"
3256 This option is for testing address rewriting rules, and it must be followed by
3257 a single argument, consisting of either a local part without a domain, or a
3258 complete address with a fully qualified domain. Exim outputs how this address
3259 would be rewritten for each possible place it might appear. See chapter
3260 &<<CHAPrewrite>>& for further details.
3261
3262 .vitem &%-bS%&
3263 .oindex "&%-bS%&"
3264 .cindex "SMTP" "batched incoming"
3265 .cindex "batched SMTP input"
3266 This option is used for batched SMTP input, which is an alternative interface
3267 for non-interactive local message submission. A number of messages can be
3268 submitted in a single run. However, despite its name, this is not really SMTP
3269 input. Exim reads each message's envelope from SMTP commands on the standard
3270 input, but generates no responses. If the caller is trusted, or
3271 &%untrusted_set_sender%& is set, the senders in the SMTP MAIL commands are
3272 believed; otherwise the sender is always the caller of Exim.
3273
3274 The message itself is read from the standard input, in SMTP format (leading
3275 dots doubled), terminated by a line containing just a single dot. An error is
3276 provoked if the terminating dot is missing. A further message may then follow.
3277
3278 As for other local message submissions, the contents of incoming batch SMTP
3279 messages can be checked using the non-SMTP ACL (see chapter &<<CHAPACL>>&).
3280 Unqualified addresses are automatically qualified using &%qualify_domain%& and
3281 &%qualify_recipient%&, as appropriate, unless the &%-bnq%& option is used.
3282
3283 Some other SMTP commands are recognized in the input. HELO and EHLO act
3284 as RSET; VRFY, EXPN, ETRN, and HELP act as NOOP;
3285 QUIT quits, ignoring the rest of the standard input.
3286
3287 .cindex "return code" "for &%-bS%&"
3288 If any error is encountered, reports are written to the standard output and
3289 error streams, and Exim gives up immediately. The return code is 0 if no error
3290 was detected; it is 1 if one or more messages were accepted before the error
3291 was detected; otherwise it is 2.
3292
3293 More details of input using batched SMTP are given in section
3294 &<<SECTincomingbatchedSMTP>>&.
3295
3296 .vitem &%-bs%&
3297 .oindex "&%-bs%&"
3298 .cindex "SMTP" "local input"
3299 .cindex "local SMTP input"
3300 This option causes Exim to accept one or more messages by reading SMTP commands
3301 on the standard input, and producing SMTP replies on the standard output. SMTP
3302 policy controls, as defined in ACLs (see chapter &<<CHAPACL>>&) are applied.
3303 Some user agents use this interface as a way of passing locally-generated
3304 messages to the MTA.
3305
3306 In
3307 .cindex "sender" "source of"
3308 this usage, if the caller of Exim is trusted, or &%untrusted_set_sender%& is
3309 set, the senders of messages are taken from the SMTP MAIL commands.
3310 Otherwise the content of these commands is ignored and the sender is set up as
3311 the calling user. Unqualified addresses are automatically qualified using
3312 &%qualify_domain%& and &%qualify_recipient%&, as appropriate, unless the
3313 &%-bnq%& option is used.
3314
3315 .cindex "inetd"
3316 The
3317 &%-bs%& option is also used to run Exim from &'inetd'&, as an alternative to
3318 using a listening daemon. Exim can distinguish the two cases by checking
3319 whether the standard input is a TCP/IP socket. When Exim is called from
3320 &'inetd'&, the source of the mail is assumed to be remote, and the comments
3321 above concerning senders and qualification do not apply. In this situation,
3322 Exim behaves in exactly the same way as it does when receiving a message via
3323 the listening daemon.
3324
3325 .vitem &%-bt%&
3326 .oindex "&%-bt%&"
3327 .cindex "testing" "addresses"
3328 .cindex "address" "testing"
3329 This option runs Exim in address testing mode, in which each argument is taken
3330 as a recipient address to be tested for deliverability. The results are
3331 written to the standard output. If a test fails, and the caller is not an admin
3332 user, no details of the failure are output, because these might contain
3333 sensitive information such as usernames and passwords for database lookups.
3334
3335 If no arguments are given, Exim runs in an interactive manner, prompting with a
3336 right angle bracket for addresses to be tested.
3337
3338 Unlike the &%-be%& test option, you cannot arrange for Exim to use the
3339 &[readline()]& function, because it is running as &'root'& and there are
3340 security issues.
3341
3342 Each address is handled as if it were the recipient address of a message
3343 (compare the &%-bv%& option). It is passed to the routers and the result is
3344 written to the standard output. However, any router that has
3345 &%no_address_test%& set is bypassed. This can make &%-bt%& easier to use for
3346 genuine routing tests if your first router passes everything to a scanner
3347 program.
3348
3349 .cindex "return code" "for &%-bt%&"
3350 The return code is 2 if any address failed outright; it is 1 if no address
3351 failed outright but at least one could not be resolved for some reason. Return
3352 code 0 is given only when all addresses succeed.
3353
3354 .cindex "duplicate addresses"
3355 &*Note*&: When actually delivering a message, Exim removes duplicate recipient
3356 addresses after routing is complete, so that only one delivery takes place.
3357 This does not happen when testing with &%-bt%&; the full results of routing are
3358 always shown.
3359
3360 &*Warning*&: &%-bt%& can only do relatively simple testing. If any of the
3361 routers in the configuration makes any tests on the sender address of a
3362 message,
3363 .oindex "&%-f%&" "for address testing"
3364 you can use the &%-f%& option to set an appropriate sender when running
3365 &%-bt%& tests. Without it, the sender is assumed to be the calling user at the
3366 default qualifying domain. However, if you have set up (for example) routers
3367 whose behaviour depends on the contents of an incoming message, you cannot test
3368 those conditions using &%-bt%&. The &%-N%& option provides a possible way of
3369 doing such tests.
3370
3371 .vitem &%-bV%&
3372 .oindex "&%-bV%&"
3373 .cindex "version number of Exim"
3374 This option causes Exim to write the current version number, compilation
3375 number, and compilation date of the &'exim'& binary to the standard output.
3376 It also lists the DBM library that is being used, the optional modules (such as
3377 specific lookup types), the drivers that are included in the binary, and the
3378 name of the run time configuration file that is in use.
3379
3380 As part of its operation, &%-bV%& causes Exim to read and syntax check its
3381 configuration file. However, this is a static check only. It cannot check
3382 values that are to be expanded. For example, although a misspelt ACL verb is
3383 detected, an error in the verb's arguments is not. You cannot rely on &%-bV%&
3384 alone to discover (for example) all the typos in the configuration; some
3385 realistic testing is needed. The &%-bh%& and &%-N%& options provide more
3386 dynamic testing facilities.
3387
3388 .vitem &%-bv%&
3389 .oindex "&%-bv%&"
3390 .cindex "verifying address" "using &%-bv%&"
3391 .cindex "address" "verification"
3392 This option runs Exim in address verification mode, in which each argument is
3393 taken as a recipient address to be verified by the routers. (This does
3394 not involve any verification callouts). During normal operation, verification
3395 happens mostly as a consequence processing a &%verify%& condition in an ACL
3396 (see chapter &<<CHAPACL>>&). If you want to test an entire ACL, possibly
3397 including callouts, see the &%-bh%& and &%-bhc%& options.
3398
3399 If verification fails, and the caller is not an admin user, no details of the
3400 failure are output, because these might contain sensitive information such as
3401 usernames and passwords for database lookups.
3402
3403 If no arguments are given, Exim runs in an interactive manner, prompting with a
3404 right angle bracket for addresses to be verified.
3405
3406 Unlike the &%-be%& test option, you cannot arrange for Exim to use the
3407 &[readline()]& function, because it is running as &'exim'& and there are
3408 security issues.
3409
3410 Verification differs from address testing (the &%-bt%& option) in that routers
3411 that have &%no_verify%& set are skipped, and if the address is accepted by a
3412 router that has &%fail_verify%& set, verification fails. The address is
3413 verified as a recipient if &%-bv%& is used; to test verification for a sender
3414 address, &%-bvs%& should be used.
3415
3416 If the &%-v%& option is not set, the output consists of a single line for each
3417 address, stating whether it was verified or not, and giving a reason in the
3418 latter case. Without &%-v%&, generating more than one address by redirection
3419 causes verification to end successfully, without considering the generated
3420 addresses. However, if just one address is generated, processing continues,
3421 and the generated address must verify successfully for the overall verification
3422 to succeed.
3423
3424 When &%-v%& is set, more details are given of how the address has been handled,
3425 and in the case of address redirection, all the generated addresses are also
3426 considered. Verification may succeed for some and fail for others.
3427
3428 The
3429 .cindex "return code" "for &%-bv%&"
3430 return code is 2 if any address failed outright; it is 1 if no address
3431 failed outright but at least one could not be resolved for some reason. Return
3432 code 0 is given only when all addresses succeed.
3433
3434 If any of the routers in the configuration makes any tests on the sender
3435 address of a message, you should use the &%-f%& option to set an appropriate
3436 sender when running &%-bv%& tests. Without it, the sender is assumed to be the
3437 calling user at the default qualifying domain.
3438
3439 .vitem &%-bvs%&
3440 .oindex "&%-bvs%&"
3441 This option acts like &%-bv%&, but verifies the address as a sender rather
3442 than a recipient address. This affects any rewriting and qualification that
3443 might happen.
3444
3445 .vitem &%-bw%&
3446 .oindex "&%-bw%&"
3447 .cindex "daemon"
3448 .cindex "inetd"
3449 .cindex "inetd" "wait mode"
3450 This option runs Exim as a daemon, awaiting incoming SMTP connections,
3451 similarly to the &%-bd%& option.  All port specifications on the command-line
3452 and in the configuration file are ignored.  Queue-running may not be specified.
3453
3454 In this mode, Exim expects to be passed a socket as fd 0 (stdin) which is
3455 listening for connections.  This permits the system to start up and have
3456 inetd (or equivalent) listen on the SMTP ports, starting an Exim daemon for
3457 each port only when the first connection is received.
3458
3459 If the option is given as &%-bw%&<&'time'&> then the time is a timeout, after
3460 which the daemon will exit, which should cause inetd to listen once more.
3461
3462 .vitem &%-C%&&~<&'filelist'&>
3463 .oindex "&%-C%&"
3464 .cindex "configuration file" "alternate"
3465 .cindex "CONFIGURE_FILE"
3466 .cindex "alternate configuration file"
3467 This option causes Exim to find the run time configuration file from the given
3468 list instead of from the list specified by the CONFIGURE_FILE
3469 compile-time setting. Usually, the list will consist of just a single file
3470 name, but it can be a colon-separated list of names. In this case, the first
3471 file that exists is used. Failure to open an existing file stops Exim from
3472 proceeding any further along the list, and an error is generated.
3473
3474 When this option is used by a caller other than root, and the list is different
3475 from the compiled-in list, Exim gives up its root privilege immediately, and
3476 runs with the real and effective uid and gid set to those of the caller.
3477 However, if a TRUSTED_CONFIG_LIST file is defined in &_Local/Makefile_&, that
3478 file contains a list of full pathnames, one per line, for configuration files
3479 which are trusted. Root privilege is retained for any configuration file so
3480 listed, as long as the caller is the Exim user (or the user specified in the
3481 CONFIGURE_OWNER option, if any), and as long as the configuration file is
3482 not writeable by inappropriate users or groups.
3483
3484 Leaving TRUSTED_CONFIG_LIST unset precludes the possibility of testing a
3485 configuration using &%-C%& right through message reception and delivery,
3486 even if the caller is root. The reception works, but by that time, Exim is
3487 running as the Exim user, so when it re-executes to regain privilege for the
3488 delivery, the use of &%-C%& causes privilege to be lost. However, root can
3489 test reception and delivery using two separate commands (one to put a message
3490 on the queue, using &%-odq%&, and another to do the delivery, using &%-M%&).
3491
3492 If ALT_CONFIG_PREFIX is defined &_in Local/Makefile_&, it specifies a
3493 prefix string with which any file named in a &%-C%& command line option
3494 must start. In addition, the file name must not contain the sequence &`/../`&.
3495 However, if the value of the &%-C%& option is identical to the value of
3496 CONFIGURE_FILE in &_Local/Makefile_&, Exim ignores &%-C%& and proceeds as
3497 usual. There is no default setting for ALT_CONFIG_PREFIX; when it is
3498 unset, any file name can be used with &%-C%&.
3499
3500 ALT_CONFIG_PREFIX can be used to confine alternative configuration files
3501 to a directory to which only root has access. This prevents someone who has
3502 broken into the Exim account from running a privileged Exim with an arbitrary
3503 configuration file.
3504
3505 The &%-C%& facility is useful for ensuring that configuration files are
3506 syntactically correct, but cannot be used for test deliveries, unless the
3507 caller is privileged, or unless it is an exotic configuration that does not
3508 require privilege. No check is made on the owner or group of the files
3509 specified by this option.
3510
3511
3512 .vitem &%-D%&<&'macro'&>=<&'value'&>
3513 .oindex "&%-D%&"
3514 .cindex "macro" "setting on command line"
3515 This option can be used to override macro definitions in the configuration file
3516 (see section &<<SECTmacrodefs>>&). However, like &%-C%&, if it is used by an
3517 unprivileged caller, it causes Exim to give up its root privilege.
3518 If DISABLE_D_OPTION is defined in &_Local/Makefile_&, the use of &%-D%& is
3519 completely disabled, and its use causes an immediate error exit.
3520
3521 If WHITELIST_D_MACROS is defined in &_Local/Makefile_& then it should be a
3522 colon-separated list of macros which are considered safe and, if &%-D%& only
3523 supplies macros from this list, and the values are acceptable, then Exim will
3524 not give up root privilege if the caller is root, the Exim run-time user, or
3525 the CONFIGURE_OWNER, if set.  This is a transition mechanism and is expected
3526 to be removed in the future.  Acceptable values for the macros satisfy the
3527 regexp: &`^[A-Za-z0-9_/.-]*$`&
3528
3529 The entire option (including equals sign if present) must all be within one
3530 command line item. &%-D%& can be used to set the value of a macro to the empty
3531 string, in which case the equals sign is optional. These two commands are
3532 synonymous:
3533 .code
3534 exim -DABC  ...
3535 exim -DABC= ...
3536 .endd
3537 To include spaces in a macro definition item, quotes must be used. If you use
3538 quotes, spaces are permitted around the macro name and the equals sign. For
3539 example:
3540 .code
3541 exim '-D ABC = something' ...
3542 .endd
3543 &%-D%& may be repeated up to 10 times on a command line.
3544
3545
3546 .vitem &%-d%&<&'debug&~options'&>
3547 .oindex "&%-d%&"
3548 .cindex "debugging" "list of selectors"
3549 .cindex "debugging" "&%-d%& option"
3550 This option causes debugging information to be written to the standard
3551 error stream. It is restricted to admin users because debugging output may show
3552 database queries that contain password information. Also, the details of users'
3553 filter files should be protected. If a non-admin user uses &%-d%&, Exim
3554 writes an error message to the standard error stream and exits with a non-zero
3555 return code.
3556
3557 When &%-d%& is used, &%-v%& is assumed. If &%-d%& is given on its own, a lot of
3558 standard debugging data is output. This can be reduced, or increased to include
3559 some more rarely needed information, by directly following &%-d%& with a string
3560 made up of names preceded by plus or minus characters. These add or remove sets
3561 of debugging data, respectively. For example, &%-d+filter%& adds filter
3562 debugging, whereas &%-d-all+filter%& selects only filter debugging. Note that
3563 no spaces are allowed in the debug setting. The available debugging categories
3564 are:
3565 .display
3566 &`acl            `& ACL interpretation
3567 &`auth           `& authenticators
3568 &`deliver        `& general delivery logic
3569 &`dns            `& DNS lookups (see also resolver)
3570 &`dnsbl          `& DNS black list (aka RBL) code
3571 &`exec           `& arguments for &[execv()]& calls
3572 &`expand         `& detailed debugging for string expansions
3573 &`filter         `& filter handling
3574 &`hints_lookup   `& hints data lookups
3575 &`host_lookup    `& all types of name-to-IP address handling
3576 &`ident          `& ident lookup
3577 &`interface      `& lists of local interfaces
3578 &`lists          `& matching things in lists
3579 &`load           `& system load checks
3580 &`local_scan     `& can be used by &[local_scan()]& (see chapter &&&
3581                     &<<CHAPlocalscan>>&)
3582 &`lookup         `& general lookup code and all lookups
3583 &`memory         `& memory handling
3584 &`pid            `& add pid to debug output lines
3585 &`process_info   `& setting info for the process log
3586 &`queue_run      `& queue runs
3587 &`receive        `& general message reception logic
3588 &`resolver       `& turn on the DNS resolver's debugging output
3589 &`retry          `& retry handling
3590 &`rewrite        `& address rewriting
3591 &`route          `& address routing
3592 &`timestamp      `& add timestamp to debug output lines
3593 &`tls            `& TLS logic
3594 &`transport      `& transports
3595 &`uid            `& changes of uid/gid and looking up uid/gid
3596 &`verify         `& address verification logic
3597 &`all            `& almost all of the above (see below), and also &%-v%&
3598 .endd
3599 The &`all`& option excludes &`memory`& when used as &`+all`&, but includes it
3600 for &`-all`&. The reason for this is that &`+all`& is something that people
3601 tend to use when generating debug output for Exim maintainers. If &`+memory`&
3602 is included, an awful lot of output that is very rarely of interest is
3603 generated, so it now has to be explicitly requested. However, &`-all`& does
3604 turn everything off.
3605
3606 .cindex "resolver, debugging output"
3607 .cindex "DNS resolver, debugging output"
3608 The &`resolver`& option produces output only if the DNS resolver was compiled
3609 with DEBUG enabled. This is not the case in some operating systems. Also,
3610 unfortunately, debugging output from the DNS resolver is written to stdout
3611 rather than stderr.
3612
3613 The default (&%-d%& with no argument) omits &`expand`&, &`filter`&,
3614 &`interface`&, &`load`&, &`memory`&, &`pid`&, &`resolver`&, and &`timestamp`&.
3615 However, the &`pid`& selector is forced when debugging is turned on for a
3616 daemon, which then passes it on to any re-executed Exims. Exim also
3617 automatically adds the pid to debug lines when several remote deliveries are
3618 run in parallel.
3619
3620 The &`timestamp`& selector causes the current time to be inserted at the start
3621 of all debug output lines. This can be useful when trying to track down delays
3622 in processing.
3623
3624 If the &%debug_print%& option is set in any driver, it produces output whenever
3625 any debugging is selected, or if &%-v%& is used.
3626
3627 .vitem &%-dd%&<&'debug&~options'&>
3628 .oindex "&%-dd%&"
3629 This option behaves exactly like &%-d%& except when used on a command that
3630 starts a daemon process. In that case, debugging is turned off for the
3631 subprocesses that the daemon creates. Thus, it is useful for monitoring the
3632 behaviour of the daemon without creating as much output as full debugging does.
3633
3634 .vitem &%-dropcr%&
3635 .oindex "&%-dropcr%&"
3636 This is an obsolete option that is now a no-op. It used to affect the way Exim
3637 handled CR and LF characters in incoming messages. What happens now is
3638 described in section &<<SECTlineendings>>&.
3639
3640 .vitem &%-E%&
3641 .oindex "&%-E%&"
3642 .cindex "bounce message" "generating"
3643 This option specifies that an incoming message is a locally-generated delivery
3644 failure report. It is used internally by Exim when handling delivery failures
3645 and is not intended for external use. Its only effect is to stop Exim
3646 generating certain messages to the postmaster, as otherwise message cascades
3647 could occur in some situations. As part of the same option, a message id may
3648 follow the characters &%-E%&. If it does, the log entry for the receipt of the
3649 new message contains the id, following &"R="&, as a cross-reference.
3650
3651 .vitem &%-e%&&'x'&
3652 .oindex "&%-e%&&'x'&"
3653 There are a number of Sendmail options starting with &%-oe%& which seem to be
3654 called by various programs without the leading &%o%& in the option. For
3655 example, the &%vacation%& program uses &%-eq%&. Exim treats all options of the
3656 form &%-e%&&'x'& as synonymous with the corresponding &%-oe%&&'x'& options.
3657
3658 .vitem &%-F%&&~<&'string'&>
3659 .oindex "&%-F%&"
3660 .cindex "sender" "name"
3661 .cindex "name" "of sender"
3662 This option sets the sender's full name for use when a locally-generated
3663 message is being accepted. In the absence of this option, the user's &'gecos'&
3664 entry from the password data is used. As users are generally permitted to alter
3665 their &'gecos'& entries, no security considerations are involved. White space
3666 between &%-F%& and the <&'string'&> is optional.
3667
3668 .vitem &%-f%&&~<&'address'&>
3669 .oindex "&%-f%&"
3670 .cindex "sender" "address"
3671 .cindex "address" "sender"
3672 .cindex "trusted users"
3673 .cindex "envelope sender"
3674 .cindex "user" "trusted"
3675 This option sets the address of the envelope sender of a locally-generated
3676 message (also known as the return path). The option can normally be used only
3677 by a trusted user, but &%untrusted_set_sender%& can be set to allow untrusted
3678 users to use it.
3679
3680 Processes running as root or the Exim user are always trusted. Other
3681 trusted users are defined by the &%trusted_users%& or &%trusted_groups%&
3682 options. In the absence of &%-f%&, or if the caller is not trusted, the sender
3683 of a local message is set to the caller's login name at the default qualify
3684 domain.
3685
3686 There is one exception to the restriction on the use of &%-f%&: an empty sender
3687 can be specified by any user, trusted or not, to create a message that can
3688 never provoke a bounce. An empty sender can be specified either as an empty
3689 string, or as a pair of angle brackets with nothing between them, as in these
3690 examples of shell commands:
3691 .code
3692 exim -f '<>' user@domain
3693 exim -f "" user@domain
3694 .endd
3695 In addition, the use of &%-f%& is not restricted when testing a filter file
3696 with &%-bf%& or when testing or verifying addresses using the &%-bt%& or
3697 &%-bv%& options.
3698
3699 Allowing untrusted users to change the sender address does not of itself make
3700 it possible to send anonymous mail. Exim still checks that the &'From:'& header
3701 refers to the local user, and if it does not, it adds a &'Sender:'& header,
3702 though this can be overridden by setting &%no_local_from_check%&.
3703
3704 White
3705 .cindex "&""From""& line"
3706 space between &%-f%& and the <&'address'&> is optional (that is, they can be
3707 given as two arguments or one combined argument). The sender of a
3708 locally-generated message can also be set (when permitted) by an initial
3709 &"From&~"& line in the message &-- see the description of &%-bm%& above &-- but
3710 if &%-f%& is also present, it overrides &"From&~"&.
3711
3712 .vitem &%-G%&
3713 .oindex "&%-G%&"
3714 .cindex "submission fixups, suppressing (command-line)"
3715 .new
3716 This option is equivalent to an ACL applying:
3717 .code
3718 control = suppress_local_fixups
3719 .endd
3720 for every message received.  Note that Sendmail will complain about such
3721 bad formatting, where Exim silently just does not fix it up.  This may change
3722 in future.
3723
3724 As this affects audit information, the caller must be a trusted user to use
3725 this option.
3726 .wen
3727
3728 .vitem &%-h%&&~<&'number'&>
3729 .oindex "&%-h%&"
3730 .cindex "Sendmail compatibility" "&%-h%& option ignored"
3731 This option is accepted for compatibility with Sendmail, but has no effect. (In
3732 Sendmail it overrides the &"hop count"& obtained by counting &'Received:'&
3733 headers.)
3734
3735 .vitem &%-i%&
3736 .oindex "&%-i%&"
3737 .cindex "Solaris" "&'mail'& command"
3738 .cindex "dot" "in incoming non-SMTP message"
3739 This option, which has the same effect as &%-oi%&, specifies that a dot on a
3740 line by itself should not terminate an incoming, non-SMTP message. I can find
3741 no documentation for this option in Solaris 2.4 Sendmail, but the &'mailx'&
3742 command in Solaris 2.4 uses it. See also &%-ti%&.
3743
3744 .new
3745 .vitem &%-L%&&~<&'tag'&>
3746 .oindex "&%-L%&"
3747 .cindex "syslog" "process name; set with flag"
3748 This option is equivalent to setting &%syslog_processname%& in the config
3749 file and setting &%log_file_path%& to &`syslog`&.
3750 Its use is restricted to administrators.  The configuration file has to be
3751 read and parsed, to determine access rights, before this is set and takes
3752 effect, so early configuration file errors will not honour this flag.
3753
3754 The tag should not be longer than 32 characters.
3755 .wen
3756
3757 .vitem &%-M%&&~<&'message&~id'&>&~<&'message&~id'&>&~...
3758 .oindex "&%-M%&"
3759 .cindex "forcing delivery"
3760 .cindex "delivery" "forcing attempt"
3761 .cindex "frozen messages" "forcing delivery"
3762 This option requests Exim to run a delivery attempt on each message in turn. If
3763 any of the messages are frozen, they are automatically thawed before the
3764 delivery attempt. The settings of &%queue_domains%&, &%queue_smtp_domains%&,
3765 and &%hold_domains%& are ignored.
3766
3767 Retry
3768 .cindex "hints database" "overriding retry hints"
3769 hints for any of the addresses are overridden &-- Exim tries to deliver even if
3770 the normal retry time has not yet been reached. This option requires the caller
3771 to be an admin user. However, there is an option called &%prod_requires_admin%&
3772 which can be set false to relax this restriction (and also the same requirement
3773 for the &%-q%&, &%-R%&, and &%-S%& options).
3774
3775 The deliveries happen synchronously, that is, the original Exim process does
3776 not terminate until all the delivery attempts have finished. No output is
3777 produced unless there is a serious error. If you want to see what is happening,
3778 use the &%-v%& option as well, or inspect Exim's main log.
3779
3780 .vitem &%-Mar%&&~<&'message&~id'&>&~<&'address'&>&~<&'address'&>&~...
3781 .oindex "&%-Mar%&"
3782 .cindex "message" "adding recipients"
3783 .cindex "recipient" "adding"
3784 This option requests Exim to add the addresses to the list of recipients of the
3785 message (&"ar"& for &"add recipients"&). The first argument must be a message
3786 id, and the remaining ones must be email addresses. However, if the message is
3787 active (in the middle of a delivery attempt), it is not altered. This option
3788 can be used only by an admin user.
3789
3790 .vitem "&%-MC%&&~<&'transport'&>&~<&'hostname'&>&~<&'sequence&~number'&>&&&
3791         &~<&'message&~id'&>"
3792 .oindex "&%-MC%&"
3793 .cindex "SMTP" "passed connection"
3794 .cindex "SMTP" "multiple deliveries"
3795 .cindex "multiple SMTP deliveries"
3796 This option is not intended for use by external callers. It is used internally
3797 by Exim to invoke another instance of itself to deliver a waiting message using
3798 an existing SMTP connection, which is passed as the standard input. Details are
3799 given in chapter &<<CHAPSMTP>>&. This must be the final option, and the caller
3800 must be root or the Exim user in order to use it.
3801
3802 .vitem &%-MCA%&
3803 .oindex "&%-MCA%&"
3804 This option is not intended for use by external callers. It is used internally
3805 by Exim in conjunction with the &%-MC%& option. It signifies that the
3806 connection to the remote host has been authenticated.
3807
3808 .vitem &%-MCP%&
3809 .oindex "&%-MCP%&"
3810 This option is not intended for use by external callers. It is used internally
3811 by Exim in conjunction with the &%-MC%& option. It signifies that the server to
3812 which Exim is connected supports pipelining.
3813
3814 .vitem &%-MCQ%&&~<&'process&~id'&>&~<&'pipe&~fd'&>
3815 .oindex "&%-MCQ%&"
3816 This option is not intended for use by external callers. It is used internally
3817 by Exim in conjunction with the &%-MC%& option when the original delivery was
3818 started by a queue runner. It passes on the process id of the queue runner,
3819 together with the file descriptor number of an open pipe. Closure of the pipe
3820 signals the final completion of the sequence of processes that are passing
3821 messages through the same SMTP connection.
3822
3823 .vitem &%-MCS%&
3824 .oindex "&%-MCS%&"
3825 This option is not intended for use by external callers. It is used internally
3826 by Exim in conjunction with the &%-MC%& option, and passes on the fact that the
3827 SMTP SIZE option should be used on messages delivered down the existing
3828 connection.
3829
3830 .vitem &%-MCT%&
3831 .oindex "&%-MCT%&"
3832 This option is not intended for use by external callers. It is used internally
3833 by Exim in conjunction with the &%-MC%& option, and passes on the fact that the
3834 host to which Exim is connected supports TLS encryption.
3835
3836 .vitem &%-Mc%&&~<&'message&~id'&>&~<&'message&~id'&>&~...
3837 .oindex "&%-Mc%&"
3838 .cindex "hints database" "not overridden by &%-Mc%&"
3839 .cindex "delivery" "manually started &-- not forced"
3840 This option requests Exim to run a delivery attempt on each message in turn,
3841 but unlike the &%-M%& option, it does check for retry hints, and respects any
3842 that are found. This option is not very useful to external callers. It is
3843 provided mainly for internal use by Exim when it needs to re-invoke itself in
3844 order to regain root privilege for a delivery (see chapter &<<CHAPsecurity>>&).
3845 However, &%-Mc%& can be useful when testing, in order to run a delivery that
3846 respects retry times and other options such as &%hold_domains%& that are
3847 overridden when &%-M%& is used. Such a delivery does not count as a queue run.
3848 If you want to run a specific delivery as if in a queue run, you should use
3849 &%-q%& with a message id argument. A distinction between queue run deliveries
3850 and other deliveries is made in one or two places.
3851
3852 .vitem &%-Mes%&&~<&'message&~id'&>&~<&'address'&>
3853 .oindex "&%-Mes%&"
3854 .cindex "message" "changing sender"
3855 .cindex "sender" "changing"
3856 This option requests Exim to change the sender address in the message to the
3857 given address, which must be a fully qualified address or &"<>"& (&"es"& for
3858 &"edit sender"&). There must be exactly two arguments. The first argument must
3859 be a message id, and the second one an email address. However, if the message
3860 is active (in the middle of a delivery attempt), its status is not altered.
3861 This option can be used only by an admin user.
3862
3863 .vitem &%-Mf%&&~<&'message&~id'&>&~<&'message&~id'&>&~...
3864 .oindex "&%-Mf%&"
3865 .cindex "freezing messages"
3866 .cindex "message" "manually freezing"
3867 This option requests Exim to mark each listed message as &"frozen"&. This
3868 prevents any delivery attempts taking place until the message is &"thawed"&,
3869 either manually or as a result of the &%auto_thaw%& configuration option.
3870 However, if any of the messages are active (in the middle of a delivery
3871 attempt), their status is not altered. This option can be used only by an admin
3872 user.
3873
3874 .vitem &%-Mg%&&~<&'message&~id'&>&~<&'message&~id'&>&~...
3875 .oindex "&%-Mg%&"
3876 .cindex "giving up on messages"
3877 .cindex "message" "abandoning delivery attempts"
3878 .cindex "delivery" "abandoning further attempts"
3879 This option requests Exim to give up trying to deliver the listed messages,
3880 including any that are frozen. However, if any of the messages are active,
3881 their status is not altered. For non-bounce messages, a delivery error message
3882 is sent to the sender, containing the text &"cancelled by administrator"&.
3883 Bounce messages are just discarded. This option can be used only by an admin
3884 user.
3885
3886 .vitem &%-Mmad%&&~<&'message&~id'&>&~<&'message&~id'&>&~...
3887 .oindex "&%-Mmad%&"
3888 .cindex "delivery" "cancelling all"
3889 This option requests Exim to mark all the recipient addresses in the messages
3890 as already delivered (&"mad"& for &"mark all delivered"&). However, if any
3891 message is active (in the middle of a delivery attempt), its status is not
3892 altered. This option can be used only by an admin user.
3893
3894 .vitem &%-Mmd%&&~<&'message&~id'&>&~<&'address'&>&~<&'address'&>&~...
3895 .oindex "&%-Mmd%&"
3896 .cindex "delivery" "cancelling by address"
3897 .cindex "recipient" "removing"
3898 .cindex "removing recipients"
3899 This option requests Exim to mark the given addresses as already delivered
3900 (&"md"& for &"mark delivered"&). The first argument must be a message id, and
3901 the remaining ones must be email addresses. These are matched to recipient
3902 addresses in the message in a case-sensitive manner. If the message is active
3903 (in the middle of a delivery attempt), its status is not altered. This option
3904 can be used only by an admin user.
3905
3906 .vitem &%-Mrm%&&~<&'message&~id'&>&~<&'message&~id'&>&~...
3907 .oindex "&%-Mrm%&"
3908 .cindex "removing messages"
3909 .cindex "abandoning mail"
3910 .cindex "message" "manually discarding"
3911 This option requests Exim to remove the given messages from the queue. No
3912 bounce messages are sent; each message is simply forgotten. However, if any of
3913 the messages are active, their status is not altered. This option can be used
3914 only by an admin user or by the user who originally caused the message to be
3915 placed on the queue.
3916
3917 .vitem &%-Mset%&&~<&'message&~id'&>
3918 .oindex "&%-Mset%&
3919 .cindex "testing" "string expansion"
3920 .cindex "expansion" "testing"
3921 This option is useful only in conjunction with &%-be%& (that is, when testing
3922 string expansions). Exim loads the given message from its spool before doing
3923 the test expansions, thus setting message-specific variables such as
3924 &$message_size$& and the header variables. The &$recipients$& variable is made
3925 available. This feature is provided to make it easier to test expansions that
3926 make use of these variables. However, this option can be used only by an admin
3927 user. See also &%-bem%&.
3928
3929 .vitem &%-Mt%&&~<&'message&~id'&>&~<&'message&~id'&>&~...
3930 .oindex "&%-Mt%&"
3931 .cindex "thawing messages"
3932 .cindex "unfreezing messages"
3933 .cindex "frozen messages" "thawing"
3934 .cindex "message" "thawing frozen"
3935 This option requests Exim to &"thaw"& any of the listed messages that are
3936 &"frozen"&, so that delivery attempts can resume. However, if any of the
3937 messages are active, their status is not altered. This option can be used only
3938 by an admin user.
3939
3940 .vitem &%-Mvb%&&~<&'message&~id'&>
3941 .oindex "&%-Mvb%&"
3942 .cindex "listing" "message body"
3943 .cindex "message" "listing body of"
3944 This option causes the contents of the message body (-D) spool file to be
3945 written to the standard output. This option can be used only by an admin user.
3946
3947 .vitem &%-Mvc%&&~<&'message&~id'&>
3948 .oindex "&%-Mvc%&"
3949 .cindex "message" "listing in RFC 2822 format"
3950 .cindex "listing" "message in RFC 2822 format"
3951 This option causes a copy of the complete message (header lines plus body) to
3952 be written to the standard output in RFC 2822 format. This option can be used
3953 only by an admin user.
3954
3955 .vitem &%-Mvh%&&~<&'message&~id'&>
3956 .oindex "&%-Mvh%&"
3957 .cindex "listing" "message headers"
3958 .cindex "header lines" "listing"
3959 .cindex "message" "listing header lines"
3960 This option causes the contents of the message headers (-H) spool file to be
3961 written to the standard output. This option can be used only by an admin user.
3962
3963 .vitem &%-Mvl%&&~<&'message&~id'&>
3964 .oindex "&%-Mvl%&"
3965 .cindex "listing" "message log"
3966 .cindex "message" "listing message log"
3967 This option causes the contents of the message log spool file to be written to
3968 the standard output. This option can be used only by an admin user.
3969
3970 .vitem &%-m%&
3971 .oindex "&%-m%&"
3972 This is apparently a synonym for &%-om%& that is accepted by Sendmail, so Exim
3973 treats it that way too.
3974
3975 .vitem &%-N%&
3976 .oindex "&%-N%&"
3977 .cindex "debugging" "&%-N%& option"
3978 .cindex "debugging" "suppressing delivery"
3979 This is a debugging option that inhibits delivery of a message at the transport
3980 level. It implies &%-v%&. Exim goes through many of the motions of delivery &--
3981 it just doesn't actually transport the message, but instead behaves as if it
3982 had successfully done so. However, it does not make any updates to the retry
3983 database, and the log entries for deliveries are flagged with &"*>"& rather
3984 than &"=>"&.
3985
3986 Because &%-N%& discards any message to which it applies, only root or the Exim
3987 user are allowed to use it with &%-bd%&, &%-q%&, &%-R%& or &%-M%&. In other
3988 words, an ordinary user can use it only when supplying an incoming message to
3989 which it will apply. Although transportation never fails when &%-N%& is set, an
3990 address may be deferred because of a configuration problem on a transport, or a
3991 routing problem. Once &%-N%& has been used for a delivery attempt, it sticks to
3992 the message, and applies to any subsequent delivery attempts that may happen
3993 for that message.
3994
3995 .vitem &%-n%&
3996 .oindex "&%-n%&"
3997 This option is interpreted by Sendmail to mean &"no aliasing"&.
3998 For normal modes of operation, it is ignored by Exim.
3999 When combined with &%-bP%& it suppresses the name of an option from being output.
4000
4001 .vitem &%-O%&&~<&'data'&>
4002 .oindex "&%-O%&"
4003 This option is interpreted by Sendmail to mean &`set option`&. It is ignored by
4004 Exim.
4005
4006 .vitem &%-oA%&&~<&'file&~name'&>
4007 .oindex "&%-oA%&"
4008 .cindex "Sendmail compatibility" "&%-oA%& option"
4009 This option is used by Sendmail in conjunction with &%-bi%& to specify an
4010 alternative alias file name. Exim handles &%-bi%& differently; see the
4011 description above.
4012
4013 .vitem &%-oB%&&~<&'n'&>
4014 .oindex "&%-oB%&"
4015 .cindex "SMTP" "passed connection"
4016 .cindex "SMTP" "multiple deliveries"
4017 .cindex "multiple SMTP deliveries"
4018 This is a debugging option which limits the maximum number of messages that can
4019 be delivered down one SMTP connection, overriding the value set in any &(smtp)&
4020 transport. If <&'n'&> is omitted, the limit is set to 1.
4021
4022 .vitem &%-odb%&
4023 .oindex "&%-odb%&"
4024 .cindex "background delivery"
4025 .cindex "delivery" "in the background"
4026 This option applies to all modes in which Exim accepts incoming messages,
4027 including the listening daemon. It requests &"background"& delivery of such
4028 messages, which means that the accepting process automatically starts a
4029 delivery process for each message received, but does not wait for the delivery
4030 processes to finish.
4031
4032 When all the messages have been received, the reception process exits,
4033 leaving the delivery processes to finish in their own time. The standard output
4034 and error streams are closed at the start of each delivery process.
4035 This is the default action if none of the &%-od%& options are present.
4036
4037 If one of the queueing options in the configuration file
4038 (&%queue_only%& or &%queue_only_file%&, for example) is in effect, &%-odb%&
4039 overrides it if &%queue_only_override%& is set true, which is the default
4040 setting. If &%queue_only_override%& is set false, &%-odb%& has no effect.
4041
4042 .vitem &%-odf%&
4043 .oindex "&%-odf%&"
4044 .cindex "foreground delivery"
4045 .cindex "delivery" "in the foreground"
4046 This option requests &"foreground"& (synchronous) delivery when Exim has
4047 accepted a locally-generated message. (For the daemon it is exactly the same as
4048 &%-odb%&.) A delivery process is automatically started to deliver the message,
4049 and Exim waits for it to complete before proceeding.
4050
4051 The original Exim reception process does not finish until the delivery
4052 process for the final message has ended. The standard error stream is left open
4053 during deliveries.
4054
4055 However, like &%-odb%&, this option has no effect if &%queue_only_override%& is
4056 false and one of the queueing options in the configuration file is in effect.
4057
4058 If there is a temporary delivery error during foreground delivery, the
4059 message is left on the queue for later delivery, and the original reception
4060 process exits. See chapter &<<CHAPnonqueueing>>& for a way of setting up a
4061 restricted configuration that never queues messages.
4062
4063
4064 .vitem &%-odi%&
4065 .oindex "&%-odi%&"
4066 This option is synonymous with &%-odf%&. It is provided for compatibility with
4067 Sendmail.
4068
4069 .vitem &%-odq%&
4070 .oindex "&%-odq%&"
4071 .cindex "non-immediate delivery"
4072 .cindex "delivery" "suppressing immediate"
4073 .cindex "queueing incoming messages"
4074 This option applies to all modes in which Exim accepts incoming messages,
4075 including the listening daemon. It specifies that the accepting process should
4076 not automatically start a delivery process for each message received. Messages
4077 are placed on the queue, and remain there until a subsequent queue runner
4078 process encounters them. There are several configuration options (such as
4079 &%queue_only%&) that can be used to queue incoming messages under certain
4080 conditions. This option overrides all of them and also &%-odqs%&. It always
4081 forces queueing.
4082
4083 .vitem &%-odqs%&
4084 .oindex "&%-odqs%&"
4085 .cindex "SMTP" "delaying delivery"
4086 This option is a hybrid between &%-odb%&/&%-odi%& and &%-odq%&.
4087 However, like &%-odb%& and &%-odi%&, this option has no effect if
4088 &%queue_only_override%& is false and one of the queueing options in the
4089 configuration file is in effect.
4090
4091 When &%-odqs%& does operate, a delivery process is started for each incoming
4092 message, in the background by default, but in the foreground if &%-odi%& is
4093 also present. The recipient addresses are routed, and local deliveries are done
4094 in the normal way. However, if any SMTP deliveries are required, they are not
4095 done at this time, so the message remains on the queue until a subsequent queue
4096 runner process encounters it. Because routing was done, Exim knows which
4097 messages are waiting for which hosts, and so a number of messages for the same
4098 host can be sent in a single SMTP connection. The &%queue_smtp_domains%&
4099 configuration option has the same effect for specific domains. See also the
4100 &%-qq%& option.
4101
4102 .vitem &%-oee%&
4103 .oindex "&%-oee%&"
4104 .cindex "error" "reporting"
4105 If an error is detected while a non-SMTP message is being received (for
4106 example, a malformed address), the error is reported to the sender in a mail
4107 message.
4108
4109 .cindex "return code" "for &%-oee%&"
4110 Provided
4111 this error message is successfully sent, the Exim receiving process
4112 exits with a return code of zero. If not, the return code is 2 if the problem
4113 is that the original message has no recipients, or 1 for any other error.
4114 This is the default &%-oe%&&'x'& option if Exim is called as &'rmail'&.
4115
4116 .vitem &%-oem%&
4117 .oindex "&%-oem%&"
4118 .cindex "error" "reporting"
4119 .cindex "return code" "for &%-oem%&"
4120 This is the same as &%-oee%&, except that Exim always exits with a non-zero
4121 return code, whether or not the error message was successfully sent.
4122 This is the default &%-oe%&&'x'& option, unless Exim is called as &'rmail'&.
4123
4124 .vitem &%-oep%&
4125 .oindex "&%-oep%&"
4126 .cindex "error" "reporting"
4127 If an error is detected while a non-SMTP message is being received, the
4128 error is reported by writing a message to the standard error file (stderr).
4129 .cindex "return code" "for &%-oep%&"
4130 The return code is 1 for all errors.
4131
4132 .vitem &%-oeq%&
4133 .oindex "&%-oeq%&"
4134 .cindex "error" "reporting"
4135 This option is supported for compatibility with Sendmail, but has the same
4136 effect as &%-oep%&.
4137
4138 .vitem &%-oew%&
4139 .oindex "&%-oew%&"
4140 .cindex "error" "reporting"
4141 This option is supported for compatibility with Sendmail, but has the same
4142 effect as &%-oem%&.
4143
4144 .vitem &%-oi%&
4145 .oindex "&%-oi%&"
4146 .cindex "dot" "in incoming non-SMTP message"
4147 This option, which has the same effect as &%-i%&, specifies that a dot on a
4148 line by itself should not terminate an incoming, non-SMTP message. Otherwise, a
4149 single dot does terminate, though Exim does no special processing for other
4150 lines that start with a dot. This option is set by default if Exim is called as
4151 &'rmail'&. See also &%-ti%&.
4152
4153 .vitem &%-oitrue%&
4154 .oindex "&%-oitrue%&"
4155 This option is treated as synonymous with &%-oi%&.
4156
4157 .vitem &%-oMa%&&~<&'host&~address'&>
4158 .oindex "&%-oMa%&"
4159 .cindex "sender" "host address, specifying for local message"
4160 A number of options starting with &%-oM%& can be used to set values associated
4161 with remote hosts on locally-submitted messages (that is, messages not received
4162 over TCP/IP). These options can be used by any caller in conjunction with the
4163 &%-bh%&, &%-be%&, &%-bf%&, &%-bF%&, &%-bt%&, or &%-bv%& testing options. In
4164 other circumstances, they are ignored unless the caller is trusted.
4165
4166 The &%-oMa%& option sets the sender host address. This may include a port
4167 number at the end, after a full stop (period). For example:
4168 .code
4169 exim -bs -oMa 10.9.8.7.1234
4170 .endd
4171 An alternative syntax is to enclose the IP address in square brackets,
4172 followed by a colon and the port number:
4173 .code
4174 exim -bs -oMa [10.9.8.7]:1234
4175 .endd
4176 The IP address is placed in the &$sender_host_address$& variable, and the
4177 port, if present, in &$sender_host_port$&. If both &%-oMa%& and &%-bh%&
4178 are present on the command line, the sender host IP address is taken from
4179 whichever one is last.
4180
4181 .vitem &%-oMaa%&&~<&'name'&>
4182 .oindex "&%-oMaa%&"
4183 .cindex "authentication" "name, specifying for local message"
4184 See &%-oMa%& above for general remarks about the &%-oM%& options. The &%-oMaa%&
4185 option sets the value of &$sender_host_authenticated$& (the authenticator
4186 name). See chapter &<<CHAPSMTPAUTH>>& for a discussion of SMTP authentication.
4187 This option can be used with &%-bh%& and &%-bs%& to set up an
4188 authenticated SMTP session without actually using the SMTP AUTH command.
4189
4190 .vitem &%-oMai%&&~<&'string'&>
4191 .oindex "&%-oMai%&"
4192 .cindex "authentication" "id, specifying for local message"
4193 See &%-oMa%& above for general remarks about the &%-oM%& options. The &%-oMai%&
4194 option sets the value of &$authenticated_id$& (the id that was authenticated).
4195 This overrides the default value (the caller's login id, except with &%-bh%&,
4196 where there is no default) for messages from local sources. See chapter
4197 &<<CHAPSMTPAUTH>>& for a discussion of authenticated ids.
4198
4199 .vitem &%-oMas%&&~<&'address'&>
4200 .oindex "&%-oMas%&"
4201 .cindex "authentication" "sender, specifying for local message"
4202 See &%-oMa%& above for general remarks about the &%-oM%& options. The &%-oMas%&
4203 option sets the authenticated sender value in &$authenticated_sender$&. It
4204 overrides the sender address that is created from the caller's login id for
4205 messages from local sources, except when &%-bh%& is used, when there is no
4206 default. For both &%-bh%& and &%-bs%&, an authenticated sender that is
4207 specified on a MAIL command overrides this value. See chapter
4208 &<<CHAPSMTPAUTH>>& for a discussion of authenticated senders.
4209
4210 .vitem &%-oMi%&&~<&'interface&~address'&>
4211 .oindex "&%-oMi%&"
4212 .cindex "interface" "address, specifying for local message"
4213 See &%-oMa%& above for general remarks about the &%-oM%& options. The &%-oMi%&
4214 option sets the IP interface address value. A port number may be included,
4215 using the same syntax as for &%-oMa%&. The interface address is placed in
4216 &$received_ip_address$& and the port number, if present, in &$received_port$&.
4217
4218 .vitem &%-oMr%&&~<&'protocol&~name'&>
4219 .oindex "&%-oMr%&"
4220 .cindex "protocol, specifying for local message"
4221 .vindex "&$received_protocol$&"
4222 See &%-oMa%& above for general remarks about the &%-oM%& options. The &%-oMr%&
4223 option sets the received protocol value that is stored in
4224 &$received_protocol$&. However, it does not apply (and is ignored) when &%-bh%&
4225 or &%-bs%& is used. For &%-bh%&, the protocol is forced to one of the standard
4226 SMTP protocol names (see the description of &$received_protocol$& in section
4227 &<<SECTexpvar>>&). For &%-bs%&, the protocol is always &"local-"& followed by
4228 one of those same names. For &%-bS%& (batched SMTP) however, the protocol can
4229 be set by &%-oMr%&.
4230
4231 .vitem &%-oMs%&&~<&'host&~name'&>
4232 .oindex "&%-oMs%&"
4233 .cindex "sender" "host name, specifying for local message"
4234 See &%-oMa%& above for general remarks about the &%-oM%& options. The &%-oMs%&
4235 option sets the sender host name in &$sender_host_name$&. When this option is
4236 present, Exim does not attempt to look up a host name from an IP address; it
4237 uses the name it is given.
4238
4239 .vitem &%-oMt%&&~<&'ident&~string'&>
4240 .oindex "&%-oMt%&"
4241 .cindex "sender" "ident string, specifying for local message"
4242 See &%-oMa%& above for general remarks about the &%-oM%& options. The &%-oMt%&
4243 option sets the sender ident value in &$sender_ident$&. The default setting for
4244 local callers is the login id of the calling process, except when &%-bh%& is
4245 used, when there is no default.
4246
4247 .vitem &%-om%&
4248 .oindex "&%-om%&"
4249 .cindex "Sendmail compatibility" "&%-om%& option ignored"
4250 In Sendmail, this option means &"me too"&, indicating that the sender of a
4251 message should receive a copy of the message if the sender appears in an alias
4252 expansion. Exim always does this, so the option does nothing.
4253
4254 .vitem &%-oo%&
4255 .oindex "&%-oo%&"
4256 .cindex "Sendmail compatibility" "&%-oo%& option ignored"
4257 This option is ignored. In Sendmail it specifies &"old style headers"&,
4258 whatever that means.
4259
4260 .vitem &%-oP%&&~<&'path'&>
4261 .oindex "&%-oP%&"
4262 .cindex "pid (process id)" "of daemon"
4263 .cindex "daemon" "process id (pid)"
4264 This option is useful only in conjunction with &%-bd%& or &%-q%& with a time
4265 value. The option specifies the file to which the process id of the daemon is
4266 written. When &%-oX%& is used with &%-bd%&, or when &%-q%& with a time is used
4267 without &%-bd%&, this is the only way of causing Exim to write a pid file,
4268 because in those cases, the normal pid file is not used.
4269
4270 .vitem &%-or%&&~<&'time'&>
4271 .oindex "&%-or%&"
4272 .cindex "timeout" "for non-SMTP input"
4273 This option sets a timeout value for incoming non-SMTP messages. If it is not
4274 set, Exim will wait forever for the standard input. The value can also be set
4275 by the &%receive_timeout%& option. The format used for specifying times is
4276 described in section &<<SECTtimeformat>>&.
4277
4278 .vitem &%-os%&&~<&'time'&>
4279 .oindex "&%-os%&"
4280 .cindex "timeout" "for SMTP input"
4281 .cindex "SMTP" "input timeout"
4282 This option sets a timeout value for incoming SMTP messages. The timeout
4283 applies to each SMTP command and block of data. The value can also be set by
4284 the &%smtp_receive_timeout%& option; it defaults to 5 minutes. The format used
4285 for specifying times is described in section &<<SECTtimeformat>>&.
4286
4287 .vitem &%-ov%&
4288 .oindex "&%-ov%&"
4289 This option has exactly the same effect as &%-v%&.
4290
4291 .vitem &%-oX%&&~<&'number&~or&~string'&>
4292 .oindex "&%-oX%&"
4293 .cindex "TCP/IP" "setting listening ports"
4294 .cindex "TCP/IP" "setting listening interfaces"
4295 .cindex "port" "receiving TCP/IP"
4296 This option is relevant only when the &%-bd%& (start listening daemon) option
4297 is also given. It controls which ports and interfaces the daemon uses. Details
4298 of the syntax, and how it interacts with configuration file options, are given
4299 in chapter &<<CHAPinterfaces>>&. When &%-oX%& is used to start a daemon, no pid
4300 file is written unless &%-oP%& is also present to specify a pid file name.
4301
4302 .vitem &%-pd%&
4303 .oindex "&%-pd%&"
4304 .cindex "Perl" "starting the interpreter"
4305 This option applies when an embedded Perl interpreter is linked with Exim (see
4306 chapter &<<CHAPperl>>&). It overrides the setting of the &%perl_at_start%&
4307 option, forcing the starting of the interpreter to be delayed until it is
4308 needed.
4309
4310 .vitem &%-ps%&
4311 .oindex "&%-ps%&"
4312 .cindex "Perl" "starting the interpreter"
4313 This option applies when an embedded Perl interpreter is linked with Exim (see
4314 chapter &<<CHAPperl>>&). It overrides the setting of the &%perl_at_start%&
4315 option, forcing the starting of the interpreter to occur as soon as Exim is
4316 started.
4317
4318 .vitem &%-p%&<&'rval'&>:<&'sval'&>
4319 .oindex "&%-p%&"
4320 For compatibility with Sendmail, this option is equivalent to
4321 .display
4322 &`-oMr`& <&'rval'&> &`-oMs`& <&'sval'&>
4323 .endd
4324 It sets the incoming protocol and host name (for trusted callers). The
4325 host name and its colon can be omitted when only the protocol is to be set.
4326 Note the Exim already has two private options, &%-pd%& and &%-ps%&, that refer
4327 to embedded Perl. It is therefore impossible to set a protocol value of &`p`&
4328 or &`s`& using this option (but that does not seem a real limitation).
4329
4330 .vitem &%-q%&
4331 .oindex "&%-q%&"
4332 .cindex "queue runner" "starting manually"
4333 This option is normally restricted to admin users. However, there is a
4334 configuration option called &%prod_requires_admin%& which can be set false to
4335 relax this restriction (and also the same requirement for the &%-M%&, &%-R%&,
4336 and &%-S%& options).
4337
4338 .cindex "queue runner" "description of operation"
4339 The &%-q%& option starts one queue runner process. This scans the queue of
4340 waiting messages, and runs a delivery process for each one in turn. It waits
4341 for each delivery process to finish before starting the next one. A delivery
4342 process may not actually do any deliveries if the retry times for the addresses
4343 have not been reached. Use &%-qf%& (see below) if you want to override this.
4344
4345 If
4346 .cindex "SMTP" "passed connection"
4347 .cindex "SMTP" "multiple deliveries"
4348 .cindex "multiple SMTP deliveries"
4349 the delivery process spawns other processes to deliver other messages down
4350 passed SMTP connections, the queue runner waits for these to finish before
4351 proceeding.
4352
4353 When all the queued messages have been considered, the original queue runner
4354 process terminates. In other words, a single pass is made over the waiting
4355 mail, one message at a time. Use &%-q%& with a time (see below) if you want
4356 this to be repeated periodically.
4357
4358 Exim processes the waiting messages in an unpredictable order. It isn't very
4359 random, but it is likely to be different each time, which is all that matters.
4360 If one particular message screws up a remote MTA, other messages to the same
4361 MTA have a chance of getting through if they get tried first.
4362
4363 It is possible to cause the messages to be processed in lexical message id
4364 order, which is essentially the order in which they arrived, by setting the
4365 &%queue_run_in_order%& option, but this is not recommended for normal use.
4366
4367 .vitem &%-q%&<&'qflags'&>
4368 The &%-q%& option may be followed by one or more flag letters that change its
4369 behaviour. They are all optional, but if more than one is present, they must
4370 appear in the correct order. Each flag is described in a separate item below.
4371
4372 .vitem &%-qq...%&
4373 .oindex "&%-qq%&"
4374 .cindex "queue" "double scanning"
4375 .cindex "queue" "routing"
4376 .cindex "routing" "whole queue before delivery"
4377 An option starting with &%-qq%& requests a two-stage queue run. In the first
4378 stage, the queue is scanned as if the &%queue_smtp_domains%& option matched
4379 every domain. Addresses are routed, local deliveries happen, but no remote
4380 transports are run.
4381
4382 .cindex "hints database" "remembering routing"
4383 The hints database that remembers which messages are waiting for specific hosts
4384 is updated, as if delivery to those hosts had been deferred. After this is
4385 complete, a second, normal queue scan happens, with routing and delivery taking
4386 place as normal. Messages that are routed to the same host should mostly be
4387 delivered down a single SMTP
4388 .cindex "SMTP" "passed connection"
4389 .cindex "SMTP" "multiple deliveries"
4390 .cindex "multiple SMTP deliveries"
4391 connection because of the hints that were set up during the first queue scan.
4392 This option may be useful for hosts that are connected to the Internet
4393 intermittently.
4394
4395 .vitem &%-q[q]i...%&
4396 .oindex "&%-qi%&"
4397 .cindex "queue" "initial delivery"
4398 If the &'i'& flag is present, the queue runner runs delivery processes only for
4399 those messages that haven't previously been tried. (&'i'& stands for &"initial
4400 delivery"&.) This can be helpful if you are putting messages on the queue using
4401 &%-odq%& and want a queue runner just to process the new messages.
4402
4403 .vitem &%-q[q][i]f...%&
4404 .oindex "&%-qf%&"
4405 .cindex "queue" "forcing delivery"
4406 .cindex "delivery" "forcing in queue run"
4407 If one &'f'& flag is present, a delivery attempt is forced for each non-frozen
4408 message, whereas without &'f'& only those non-frozen addresses that have passed
4409 their retry times are tried.
4410
4411 .vitem &%-q[q][i]ff...%&
4412 .oindex "&%-qff%&"
4413 .cindex "frozen messages" "forcing delivery"
4414 If &'ff'& is present, a delivery attempt is forced for every message, whether
4415 frozen or not.
4416
4417 .vitem &%-q[q][i][f[f]]l%&
4418 .oindex "&%-ql%&"
4419 .cindex "queue" "local deliveries only"
4420 The &'l'& (the letter &"ell"&) flag specifies that only local deliveries are to
4421 be done. If a message requires any remote deliveries, it remains on the queue
4422 for later delivery.
4423
4424 .vitem &%-q%&<&'qflags'&>&~<&'start&~id'&>&~<&'end&~id'&>
4425 .cindex "queue" "delivering specific messages"
4426 When scanning the queue, Exim can be made to skip over messages whose ids are
4427 lexically less than a given value by following the &%-q%& option with a
4428 starting message id. For example:
4429 .code
4430 exim -q 0t5C6f-0000c8-00
4431 .endd
4432 Messages that arrived earlier than &`0t5C6f-0000c8-00`& are not inspected. If a
4433 second message id is given, messages whose ids are lexically greater than it
4434 are also skipped. If the same id is given twice, for example,
4435 .code
4436 exim -q 0t5C6f-0000c8-00 0t5C6f-0000c8-00
4437 .endd
4438 just one delivery process is started, for that message. This differs from
4439 &%-M%& in that retry data is respected, and it also differs from &%-Mc%& in
4440 that it counts as a delivery from a queue run. Note that the selection
4441 mechanism does not affect the order in which the messages are scanned. There
4442 are also other ways of selecting specific sets of messages for delivery in a
4443 queue run &-- see &%-R%& and &%-S%&.
4444
4445 .vitem &%-q%&<&'qflags'&><&'time'&>
4446 .cindex "queue runner" "starting periodically"
4447 .cindex "periodic queue running"
4448 When a time value is present, the &%-q%& option causes Exim to run as a daemon,
4449 starting a queue runner process at intervals specified by the given time value
4450 (whose format is described in section &<<SECTtimeformat>>&). This form of the
4451 &%-q%& option is commonly combined with the &%-bd%& option, in which case a
4452 single daemon process handles both functions. A common way of starting up a
4453 combined daemon at system boot time is to use a command such as
4454 .code
4455 /usr/exim/bin/exim -bd -q30m
4456 .endd
4457 Such a daemon listens for incoming SMTP calls, and also starts a queue runner
4458 process every 30 minutes.
4459
4460 When a daemon is started by &%-q%& with a time value, but without &%-bd%&, no
4461 pid file is written unless one is explicitly requested by the &%-oP%& option.
4462
4463 .vitem &%-qR%&<&'rsflags'&>&~<&'string'&>
4464 .oindex "&%-qR%&"
4465 This option is synonymous with &%-R%&. It is provided for Sendmail
4466 compatibility.
4467
4468 .vitem &%-qS%&<&'rsflags'&>&~<&'string'&>
4469 .oindex "&%-qS%&"
4470 This option is synonymous with &%-S%&.
4471
4472 .vitem &%-R%&<&'rsflags'&>&~<&'string'&>
4473 .oindex "&%-R%&"
4474 .cindex "queue runner" "for specific recipients"
4475 .cindex "delivery" "to given domain"
4476 .cindex "domain" "delivery to"
4477 The <&'rsflags'&> may be empty, in which case the white space before the string
4478 is optional, unless the string is &'f'&, &'ff'&, &'r'&, &'rf'&, or &'rff'&,
4479 which are the possible values for <&'rsflags'&>. White space is required if
4480 <&'rsflags'&> is not empty.
4481
4482 This option is similar to &%-q%& with no time value, that is, it causes Exim to
4483 perform a single queue run, except that, when scanning the messages on the
4484 queue, Exim processes only those that have at least one undelivered recipient
4485 address containing the given string, which is checked in a case-independent
4486 way. If the <&'rsflags'&> start with &'r'&, <&'string'&> is interpreted as a
4487 regular expression; otherwise it is a literal string.
4488
4489 If you want to do periodic queue runs for messages with specific recipients,
4490 you can combine &%-R%& with &%-q%& and a time value. For example:
4491 .code
4492 exim -q25m -R @special.domain.example
4493 .endd
4494 This example does a queue run for messages with recipients in the given domain
4495 every 25 minutes. Any additional flags that are specified with &%-q%& are
4496 applied to each queue run.
4497
4498 Once a message is selected for delivery by this mechanism, all its addresses
4499 are processed. For the first selected message, Exim overrides any retry
4500 information and forces a delivery attempt for each undelivered address. This
4501 means that if delivery of any address in the first message is successful, any
4502 existing retry information is deleted, and so delivery attempts for that
4503 address in subsequently selected messages (which are processed without forcing)
4504 will run. However, if delivery of any address does not succeed, the retry
4505 information is updated, and in subsequently selected messages, the failing
4506 address will be skipped.
4507
4508 .cindex "frozen messages" "forcing delivery"
4509 If the <&'rsflags'&> contain &'f'& or &'ff'&, the delivery forcing applies to
4510 all selected messages, not just the first; frozen messages are included when
4511 &'ff'& is present.
4512
4513 The &%-R%& option makes it straightforward to initiate delivery of all messages
4514 to a given domain after a host has been down for some time. When the SMTP
4515 command ETRN is accepted by its ACL (see chapter &<<CHAPACL>>&), its default
4516 effect is to run Exim with the &%-R%& option, but it can be configured to run
4517 an arbitrary command instead.
4518
4519 .vitem &%-r%&
4520 .oindex "&%-r%&"
4521 This is a documented (for Sendmail) obsolete alternative name for &%-f%&.
4522
4523 .vitem &%-S%&<&'rsflags'&>&~<&'string'&>
4524 .oindex "&%-S%&"
4525 .cindex "delivery" "from given sender"
4526 .cindex "queue runner" "for specific senders"
4527 This option acts like &%-R%& except that it checks the string against each
4528 message's sender instead of against the recipients. If &%-R%& is also set, both
4529 conditions must be met for a message to be selected. If either of the options
4530 has &'f'& or &'ff'& in its flags, the associated action is taken.
4531
4532 .vitem &%-Tqt%&&~<&'times'&>
4533 .oindex "&%-Tqt%&"
4534 This is an option that is exclusively for use by the Exim testing suite. It is not
4535 recognized when Exim is run normally. It allows for the setting up of explicit
4536 &"queue times"& so that various warning/retry features can be tested.
4537
4538 .vitem &%-t%&
4539 .oindex "&%-t%&"
4540 .cindex "recipient" "extracting from header lines"
4541 .cindex "&'Bcc:'& header line"
4542 .cindex "&'Cc:'& header line"
4543 .cindex "&'To:'& header line"
4544 When Exim is receiving a locally-generated, non-SMTP message on its standard
4545 input, the &%-t%& option causes the recipients of the message to be obtained
4546 from the &'To:'&, &'Cc:'&, and &'Bcc:'& header lines in the message instead of
4547 from the command arguments. The addresses are extracted before any rewriting
4548 takes place and the &'Bcc:'& header line, if present, is then removed.
4549
4550 .cindex "Sendmail compatibility" "&%-t%& option"
4551 If the command has any arguments, they specify addresses to which the message
4552 is &'not'& to be delivered. That is, the argument addresses are removed from
4553 the recipients list obtained from the headers. This is compatible with Smail 3
4554 and in accordance with the documented behaviour of several versions of
4555 Sendmail, as described in man pages on a number of operating systems (e.g.
4556 Solaris 8, IRIX 6.5, HP-UX 11). However, some versions of Sendmail &'add'&
4557 argument addresses to those obtained from the headers, and the O'Reilly
4558 Sendmail book documents it that way. Exim can be made to add argument addresses
4559 instead of subtracting them by setting the option
4560 &%extract_addresses_remove_arguments%& false.
4561
4562 .cindex "&%Resent-%& header lines" "with &%-t%&"
4563 If there are any &%Resent-%& header lines in the message, Exim extracts
4564 recipients from all &'Resent-To:'&, &'Resent-Cc:'&, and &'Resent-Bcc:'& header
4565 lines instead of from &'To:'&, &'Cc:'&, and &'Bcc:'&. This is for compatibility
4566 with Sendmail and other MTAs. (Prior to release 4.20, Exim gave an error if
4567 &%-t%& was used in conjunction with &%Resent-%& header lines.)
4568
4569 RFC 2822 talks about different sets of &%Resent-%& header lines (for when a
4570 message is resent several times). The RFC also specifies that they should be
4571 added at the front of the message, and separated by &'Received:'& lines. It is
4572 not at all clear how &%-t%& should operate in the present of multiple sets,
4573 nor indeed exactly what constitutes a &"set"&.
4574 In practice, it seems that MUAs do not follow the RFC. The &%Resent-%& lines
4575 are often added at the end of the header, and if a message is resent more than
4576 once, it is common for the original set of &%Resent-%& headers to be renamed as
4577 &%X-Resent-%& when a new set is added. This removes any possible ambiguity.
4578
4579 .vitem &%-ti%&
4580 .oindex "&%-ti%&"
4581 This option is exactly equivalent to &%-t%& &%-i%&. It is provided for
4582 compatibility with Sendmail.
4583
4584 .vitem &%-tls-on-connect%&
4585 .oindex "&%-tls-on-connect%&"
4586 .cindex "TLS" "use without STARTTLS"
4587 .cindex "TLS" "automatic start"
4588 This option is available when Exim is compiled with TLS support. It forces all
4589 incoming SMTP connections to behave as if the incoming port is listed in the
4590 &%tls_on_connect_ports%& option. See section &<<SECTsupobssmt>>& and chapter
4591 &<<CHAPTLS>>& for further details.
4592
4593
4594 .vitem &%-U%&
4595 .oindex "&%-U%&"
4596 .cindex "Sendmail compatibility" "&%-U%& option ignored"
4597 Sendmail uses this option for &"initial message submission"&, and its
4598 documentation states that in future releases, it may complain about
4599 syntactically invalid messages rather than fixing them when this flag is not
4600 set. Exim ignores this option.
4601
4602 .vitem &%-v%&
4603 .oindex "&%-v%&"
4604 This option causes Exim to write information to the standard error stream,
4605 describing what it is doing. In particular, it shows the log lines for
4606 receiving and delivering a message, and if an SMTP connection is made, the SMTP
4607 dialogue is shown. Some of the log lines shown may not actually be written to
4608 the log if the setting of &%log_selector%& discards them. Any relevant
4609 selectors are shown with each log line. If none are shown, the logging is
4610 unconditional.
4611
4612 .vitem &%-x%&
4613 .oindex "&%-x%&"
4614 AIX uses &%-x%& for a private purpose (&"mail from a local mail program has
4615 National Language Support extended characters in the body of the mail item"&).
4616 It sets &%-x%& when calling the MTA from its &%mail%& command. Exim ignores
4617 this option.
4618
4619 .new
4620 .vitem &%-X%&&~<&'logfile'&>
4621 .oindex "&%-X%&"
4622 This option is interpreted by Sendmail to cause debug information to be sent
4623 to the named file.  It is ignored by Exim.
4624 .wen
4625 .endlist
4626
4627 .ecindex IIDclo1
4628 .ecindex IIDclo2
4629
4630
4631 . ////////////////////////////////////////////////////////////////////////////
4632 . Insert a stylized DocBook comment here, to identify the end of the command
4633 . line options. This is for the benefit of the Perl script that automatically
4634 . creates a man page for the options.
4635 . ////////////////////////////////////////////////////////////////////////////
4636
4637 .literal xml
4638 <!-- === End of command line options === -->
4639 .literal off
4640
4641
4642
4643
4644
4645 . ////////////////////////////////////////////////////////////////////////////
4646 . ////////////////////////////////////////////////////////////////////////////
4647
4648
4649 .chapter "The Exim run time configuration file" "CHAPconf" &&&
4650          "The runtime configuration file"
4651
4652 .cindex "run time configuration"
4653 .cindex "configuration file" "general description"
4654 .cindex "CONFIGURE_FILE"
4655 .cindex "configuration file" "errors in"
4656 .cindex "error" "in configuration file"
4657 .cindex "return code" "for bad configuration"
4658 Exim uses a single run time configuration file that is read whenever an Exim
4659 binary is executed. Note that in normal operation, this happens frequently,
4660 because Exim is designed to operate in a distributed manner, without central
4661 control.
4662
4663 If a syntax error is detected while reading the configuration file, Exim
4664 writes a message on the standard error, and exits with a non-zero return code.
4665 The message is also written to the panic log. &*Note*&: Only simple syntax
4666 errors can be detected at this time. The values of any expanded options are
4667 not checked until the expansion happens, even when the expansion does not
4668 actually alter the string.
4669
4670 The name of the configuration file is compiled into the binary for security
4671 reasons, and is specified by the CONFIGURE_FILE compilation option. In
4672 most configurations, this specifies a single file. However, it is permitted to
4673 give a colon-separated list of file names, in which case Exim uses the first
4674 existing file in the list.
4675
4676 .cindex "EXIM_USER"
4677 .cindex "EXIM_GROUP"
4678 .cindex "CONFIGURE_OWNER"
4679 .cindex "CONFIGURE_GROUP"
4680 .cindex "configuration file" "ownership"
4681 .cindex "ownership" "configuration file"
4682 The run time configuration file must be owned by root or by the user that is
4683 specified at compile time by the CONFIGURE_OWNER option (if set). The
4684 configuration file must not be world-writeable, or group-writeable unless its
4685 group is the root group or the one specified at compile time by the
4686 CONFIGURE_GROUP option.
4687
4688 &*Warning*&: In a conventional configuration, where the Exim binary is setuid
4689 to root, anybody who is able to edit the run time configuration file has an
4690 easy way to run commands as root. If you specify a user or group in the
4691 CONFIGURE_OWNER or CONFIGURE_GROUP options, then that user and/or any users
4692 who are members of that group will trivially be able to obtain root privileges.
4693
4694 Up to Exim version 4.72, the run time configuration file was also permitted to
4695 be writeable by the Exim user and/or group. That has been changed in Exim 4.73
4696 since it offered a simple privilege escalation for any attacker who managed to
4697 compromise the Exim user account.
4698
4699 A default configuration file, which will work correctly in simple situations,
4700 is provided in the file &_src/configure.default_&. If CONFIGURE_FILE
4701 defines just one file name, the installation process copies the default
4702 configuration to a new file of that name if it did not previously exist. If
4703 CONFIGURE_FILE is a list, no default is automatically installed. Chapter
4704 &<<CHAPdefconfil>>& is a &"walk-through"& discussion of the default
4705 configuration.
4706
4707
4708
4709 .section "Using a different configuration file" "SECID40"
4710 .cindex "configuration file" "alternate"
4711 A one-off alternate configuration can be specified by the &%-C%& command line
4712 option, which may specify a single file or a list of files. However, when
4713 &%-C%& is used, Exim gives up its root privilege, unless called by root (or
4714 unless the argument for &%-C%& is identical to the built-in value from
4715 CONFIGURE_FILE), or is listed in the TRUSTED_CONFIG_LIST file and the caller
4716 is the Exim user or the user specified in the CONFIGURE_OWNER setting. &%-C%&
4717 is useful mainly for checking the syntax of configuration files before
4718 installing them. No owner or group checks are done on a configuration file
4719 specified by &%-C%&, if root privilege has been dropped.
4720
4721 Even the Exim user is not trusted to specify an arbitrary configuration file
4722 with the &%-C%& option to be used with root privileges, unless that file is
4723 listed in the TRUSTED_CONFIG_LIST file. This locks out the possibility of
4724 testing a configuration using &%-C%& right through message reception and
4725 delivery, even if the caller is root. The reception works, but by that time,
4726 Exim is running as the Exim user, so when it re-execs to regain privilege for
4727 the delivery, the use of &%-C%& causes privilege to be lost. However, root
4728 can test reception and delivery using two separate commands (one to put a
4729 message on the queue, using &%-odq%&, and another to do the delivery, using
4730 &%-M%&).
4731
4732 If ALT_CONFIG_PREFIX is defined &_in Local/Makefile_&, it specifies a
4733 prefix string with which any file named in a &%-C%& command line option must
4734 start. In addition, the file name must not contain the sequence &"&`/../`&"&.
4735 There is no default setting for ALT_CONFIG_PREFIX; when it is unset, any file
4736 name can be used with &%-C%&.
4737
4738 One-off changes to a configuration can be specified by the &%-D%& command line
4739 option, which defines and overrides values for macros used inside the
4740 configuration file. However, like &%-C%&, the use of this option by a
4741 non-privileged user causes Exim to discard its root privilege.
4742 If DISABLE_D_OPTION is defined in &_Local/Makefile_&, the use of &%-D%& is
4743 completely disabled, and its use causes an immediate error exit.
4744
4745 The WHITELIST_D_MACROS option in &_Local/Makefile_& permits the binary builder
4746 to declare certain macro names trusted, such that root privilege will not
4747 necessarily be discarded.
4748 WHITELIST_D_MACROS defines a colon-separated list of macros which are
4749 considered safe and, if &%-D%& only supplies macros from this list, and the
4750 values are acceptable, then Exim will not give up root privilege if the caller
4751 is root, the Exim run-time user, or the CONFIGURE_OWNER, if set.  This is a
4752 transition mechanism and is expected to be removed in the future.  Acceptable
4753 values for the macros satisfy the regexp: &`^[A-Za-z0-9_/.-]*$`&
4754
4755 Some sites may wish to use the same Exim binary on different machines that
4756 share a file system, but to use different configuration files on each machine.
4757 If CONFIGURE_FILE_USE_NODE is defined in &_Local/Makefile_&, Exim first
4758 looks for a file whose name is the configuration file name followed by a dot
4759 and the machine's node name, as obtained from the &[uname()]& function. If this
4760 file does not exist, the standard name is tried. This processing occurs for
4761 each file name in the list given by CONFIGURE_FILE or &%-C%&.
4762
4763 In some esoteric situations different versions of Exim may be run under
4764 different effective uids and the CONFIGURE_FILE_USE_EUID is defined to
4765 help with this. See the comments in &_src/EDITME_& for details.
4766
4767
4768
4769 .section "Configuration file format" "SECTconffilfor"
4770 .cindex "configuration file" "format of"
4771 .cindex "format" "configuration file"
4772 Exim's configuration file is divided into a number of different parts. General
4773 option settings must always appear at the start of the file. The other parts
4774 are all optional, and may appear in any order. Each part other than the first
4775 is introduced by the word &"begin"& followed by the name of the part. The
4776 optional parts are:
4777
4778 .ilist
4779 &'ACL'&: Access control lists for controlling incoming SMTP mail (see chapter
4780 &<<CHAPACL>>&).
4781 .next
4782 .cindex "AUTH" "configuration"
4783 &'authenticators'&: Configuration settings for the authenticator drivers. These
4784 are concerned with the SMTP AUTH command (see chapter &<<CHAPSMTPAUTH>>&).
4785 .next
4786 &'routers'&: Configuration settings for the router drivers. Routers process
4787 addresses and determine how the message is to be delivered (see chapters
4788 &<<CHAProutergeneric>>&&--&<<CHAPredirect>>&).
4789 .next
4790 &'transports'&: Configuration settings for the transport drivers. Transports
4791 define mechanisms for copying messages to destinations (see chapters
4792 &<<CHAPtransportgeneric>>&&--&<<CHAPsmtptrans>>&).
4793 .next
4794 &'retry'&: Retry rules, for use when a message cannot be delivered immediately.
4795 If there is no retry section, or if it is empty (that is, no retry rules are
4796 defined), Exim will not retry deliveries. In this situation, temporary errors
4797 are treated the same as permanent errors. Retry rules are discussed in chapter
4798 &<<CHAPretry>>&.
4799 .next
4800 &'rewrite'&: Global address rewriting rules, for use when a message arrives and
4801 when new addresses are generated during delivery. Rewriting is discussed in
4802 chapter &<<CHAPrewrite>>&.
4803 .next
4804 &'local_scan'&: Private options for the &[local_scan()]& function. If you
4805 want to use this feature, you must set
4806 .code
4807 LOCAL_SCAN_HAS_OPTIONS=yes
4808 .endd
4809 in &_Local/Makefile_& before building Exim. Details of the &[local_scan()]&
4810 facility are given in chapter &<<CHAPlocalscan>>&.
4811 .endlist
4812
4813 .cindex "configuration file" "leading white space in"
4814 .cindex "configuration file" "trailing white space in"
4815 .cindex "white space" "in configuration file"
4816 Leading and trailing white space in configuration lines is always ignored.
4817
4818 Blank lines in the file, and lines starting with a # character (ignoring
4819 leading white space) are treated as comments and are ignored. &*Note*&: A
4820 # character other than at the beginning of a line is not treated specially,
4821 and does not introduce a comment.
4822
4823 Any non-comment line can be continued by ending it with a backslash. Note that
4824 the general rule for white space means that trailing white space after the
4825 backslash and leading white space at the start of continuation
4826 lines is ignored. Comment lines beginning with # (but not empty lines) may
4827 appear in the middle of a sequence of continuation lines.
4828
4829 A convenient way to create a configuration file is to start from the
4830 default, which is supplied in &_src/configure.default_&, and add, delete, or
4831 change settings as required.
4832
4833 The ACLs, retry rules, and rewriting rules have their own syntax which is
4834 described in chapters &<<CHAPACL>>&, &<<CHAPretry>>&, and &<<CHAPrewrite>>&,
4835 respectively. The other parts of the configuration file have some syntactic
4836 items in common, and these are described below, from section &<<SECTcos>>&
4837 onwards. Before that, the inclusion, macro, and conditional facilities are
4838 described.
4839
4840
4841
4842 .section "File inclusions in the configuration file" "SECID41"
4843 .cindex "inclusions in configuration file"
4844 .cindex "configuration file" "including other files"
4845 .cindex "&`.include`& in configuration file"
4846 .cindex "&`.include_if_exists`& in configuration file"
4847 You can include other files inside Exim's run time configuration file by
4848 using this syntax:
4849 .display
4850 &`.include`& <&'file name'&>
4851 &`.include_if_exists`& <&'file name'&>
4852 .endd
4853 on a line by itself. Double quotes round the file name are optional. If you use
4854 the first form, a configuration error occurs if the file does not exist; the
4855 second form does nothing for non-existent files. In all cases, an absolute file
4856 name is required.
4857
4858 Includes may be nested to any depth, but remember that Exim reads its
4859 configuration file often, so it is a good idea to keep them to a minimum.
4860 If you change the contents of an included file, you must HUP the daemon,
4861 because an included file is read only when the configuration itself is read.
4862
4863 The processing of inclusions happens early, at a physical line level, so, like
4864 comment lines, an inclusion can be used in the middle of an option setting,
4865 for example:
4866 .code
4867 hosts_lookup = a.b.c \
4868                .include /some/file
4869 .endd
4870 Include processing happens after macro processing (see below). Its effect is to
4871 process the lines of the included file as if they occurred inline where the
4872 inclusion appears.
4873
4874
4875
4876 .section "Macros in the configuration file" "SECTmacrodefs"
4877 .cindex "macro" "description of"
4878 .cindex "configuration file" "macros"
4879 If a line in the main part of the configuration (that is, before the first
4880 &"begin"& line) begins with an upper case letter, it is taken as a macro
4881 definition, and must be of the form
4882 .display
4883 <&'name'&> = <&'rest of line'&>
4884 .endd
4885 The name must consist of letters, digits, and underscores, and need not all be
4886 in upper case, though that is recommended. The rest of the line, including any
4887 continuations, is the replacement text, and has leading and trailing white
4888 space removed. Quotes are not removed. The replacement text can never end with
4889 a backslash character, but this doesn't seem to be a serious limitation.
4890
4891 Macros may also be defined between router, transport, authenticator, or ACL
4892 definitions. They may not, however, be defined within an individual driver or
4893 ACL, or in the &%local_scan%&, retry, or rewrite sections of the configuration.
4894
4895 .section "Macro substitution" "SECID42"
4896 Once a macro is defined, all subsequent lines in the file (and any included
4897 files) are scanned for the macro name; if there are several macros, the line is
4898 scanned for each in turn, in the order in which the macros are defined. The
4899 replacement text is not re-scanned for the current macro, though it is scanned
4900 for subsequently defined macros. For this reason, a macro name may not contain
4901 the name of a previously defined macro as a substring. You could, for example,
4902 define
4903 .display
4904 &`ABCD_XYZ = `&<&'something'&>
4905 &`ABCD = `&<&'something else'&>
4906 .endd
4907 but putting the definitions in the opposite order would provoke a configuration
4908 error. Macro expansion is applied to individual physical lines from the file,
4909 before checking for line continuation or file inclusion (see above). If a line
4910 consists solely of a macro name, and the expansion of the macro is empty, the
4911 line is ignored. A macro at the start of a line may turn the line into a
4912 comment line or a &`.include`& line.
4913
4914
4915 .section "Redefining macros" "SECID43"
4916 Once defined, the value of a macro can be redefined later in the configuration
4917 (or in an included file). Redefinition is specified by using &'=='& instead of
4918 &'='&. For example:
4919 .code
4920 MAC =  initial value
4921 ...
4922 MAC == updated value
4923 .endd
4924 Redefinition does not alter the order in which the macros are applied to the
4925 subsequent lines of the configuration file. It is still the same order in which
4926 the macros were originally defined. All that changes is the macro's value.
4927 Redefinition makes it possible to accumulate values. For example:
4928 .code
4929 MAC =  initial value
4930 ...
4931 MAC == MAC and something added
4932 .endd
4933 This can be helpful in situations where the configuration file is built
4934 from a number of other files.
4935
4936 .section "Overriding macro values" "SECID44"
4937 The values set for macros in the configuration file can be overridden by the
4938 &%-D%& command line option, but Exim gives up its root privilege when &%-D%& is
4939 used, unless called by root or the Exim user. A definition on the command line
4940 using the &%-D%& option causes all definitions and redefinitions within the
4941 file to be ignored.
4942
4943
4944
4945 .section "Example of macro usage" "SECID45"
4946 As an example of macro usage, consider a configuration where aliases are looked
4947 up in a MySQL database. It helps to keep the file less cluttered if long
4948 strings such as SQL statements are defined separately as macros, for example:
4949 .code
4950 ALIAS_QUERY = select mailbox from user where \
4951               login='${quote_mysql:$local_part}';
4952 .endd
4953 This can then be used in a &(redirect)& router setting like this:
4954 .code
4955 data = ${lookup mysql{ALIAS_QUERY}}
4956 .endd
4957 In earlier versions of Exim macros were sometimes used for domain, host, or
4958 address lists. In Exim 4 these are handled better by named lists &-- see
4959 section &<<SECTnamedlists>>&.
4960
4961
4962 .section "Conditional skips in the configuration file" "SECID46"
4963 .cindex "configuration file" "conditional skips"
4964 .cindex "&`.ifdef`&"
4965 You can use the directives &`.ifdef`&, &`.ifndef`&, &`.elifdef`&,
4966 &`.elifndef`&, &`.else`&, and &`.endif`& to dynamically include or exclude
4967 portions of the configuration file. The processing happens whenever the file is
4968 read (that is, when an Exim binary starts to run).
4969
4970 The implementation is very simple. Instances of the first four directives must
4971 be followed by text that includes the names of one or macros. The condition
4972 that is tested is whether or not any macro substitution has taken place in the
4973 line. Thus:
4974 .code
4975 .ifdef AAA
4976 message_size_limit = 50M
4977 .else
4978 message_size_limit = 100M
4979 .endif
4980 .endd
4981 sets a message size limit of 50M if the macro &`AAA`& is defined, and 100M
4982 otherwise. If there is more than one macro named on the line, the condition
4983 is true if any of them are defined. That is, it is an &"or"& condition. To
4984 obtain an &"and"& condition, you need to use nested &`.ifdef`&s.
4985
4986 Although you can use a macro expansion to generate one of these directives,
4987 it is not very useful, because the condition &"there was a macro substitution
4988 in this line"& will always be true.
4989
4990 Text following &`.else`& and &`.endif`& is ignored, and can be used as comment
4991 to clarify complicated nestings.
4992
4993
4994
4995 .section "Common option syntax" "SECTcos"
4996 .cindex "common option syntax"
4997 .cindex "syntax of common options"
4998 .cindex "configuration file" "common option syntax"
4999 For the main set of options, driver options, and &[local_scan()]& options,
5000 each setting is on a line by itself, and starts with a name consisting of
5001 lower-case letters and underscores. Many options require a data value, and in
5002 these cases the name must be followed by an equals sign (with optional white
5003 space) and then the value. For example:
5004 .code
5005 qualify_domain = mydomain.example.com
5006 .endd
5007 .cindex "hiding configuration option values"
5008 .cindex "configuration options" "hiding value of"
5009 .cindex "options" "hiding value of"
5010 Some option settings may contain sensitive data, for example, passwords for
5011 accessing databases. To stop non-admin users from using the &%-bP%& command
5012 line option to read these values, you can precede the option settings with the
5013 word &"hide"&. For example:
5014 .code
5015 hide mysql_servers = localhost/users/admin/secret-password
5016 .endd
5017 For non-admin users, such options are displayed like this:
5018 .code
5019 mysql_servers = <value not displayable>
5020 .endd
5021 If &"hide"& is used on a driver option, it hides the value of that option on
5022 all instances of the same driver.
5023
5024 The following sections describe the syntax used for the different data types
5025 that are found in option settings.
5026
5027
5028 .section "Boolean options" "SECID47"
5029 .cindex "format" "boolean"
5030 .cindex "boolean configuration values"
5031 .oindex "&%no_%&&'xxx'&"
5032 .oindex "&%not_%&&'xxx'&"
5033 Options whose type is given as boolean are on/off switches. There are two
5034 different ways of specifying such options: with and without a data value. If
5035 the option name is specified on its own without data, the switch is turned on;
5036 if it is preceded by &"no_"& or &"not_"& the switch is turned off. However,
5037 boolean options may be followed by an equals sign and one of the words
5038 &"true"&, &"false"&, &"yes"&, or &"no"&, as an alternative syntax. For example,
5039 the following two settings have exactly the same effect:
5040 .code
5041 queue_only
5042 queue_only = true
5043 .endd
5044 The following two lines also have the same (opposite) effect:
5045 .code
5046 no_queue_only
5047 queue_only = false
5048 .endd
5049 You can use whichever syntax you prefer.
5050
5051
5052
5053
5054 .section "Integer values" "SECID48"
5055 .cindex "integer configuration values"
5056 .cindex "format" "integer"
5057 If an option's type is given as &"integer"&, the value can be given in decimal,
5058 hexadecimal, or octal. If it starts with a digit greater than zero, a decimal
5059 number is assumed. Otherwise, it is treated as an octal number unless it starts
5060 with the characters &"0x"&, in which case the remainder is interpreted as a
5061 hexadecimal number.
5062
5063 If an integer value is followed by the letter K, it is multiplied by 1024; if
5064 it is followed by the letter M, it is multiplied by 1024x1024. When the values
5065 of integer option settings are output, values which are an exact multiple of
5066 1024 or 1024x1024 are sometimes, but not always, printed using the letters K
5067 and M. The printing style is independent of the actual input format that was
5068 used.
5069
5070
5071 .section "Octal integer values" "SECID49"
5072 .cindex "integer format"
5073 .cindex "format" "octal integer"
5074 If an option's type is given as &"octal integer"&, its value is always
5075 interpreted as an octal number, whether or not it starts with the digit zero.
5076 Such options are always output in octal.
5077
5078
5079 .section "Fixed point numbers" "SECID50"
5080 .cindex "fixed point configuration values"
5081 .cindex "format" "fixed point"
5082 If an option's type is given as &"fixed-point"&, its value must be a decimal
5083 integer, optionally followed by a decimal point and up to three further digits.
5084
5085
5086
5087 .section "Time intervals" "SECTtimeformat"
5088 .cindex "time interval" "specifying in configuration"
5089 .cindex "format" "time interval"
5090 A time interval is specified as a sequence of numbers, each followed by one of
5091 the following letters, with no intervening white space:
5092
5093 .table2 30pt
5094 .irow &%s%& seconds
5095 .irow &%m%& minutes
5096 .irow &%h%& hours
5097 .irow &%d%& days
5098 .irow &%w%& weeks
5099 .endtable
5100
5101 For example, &"3h50m"& specifies 3 hours and 50 minutes. The values of time
5102 intervals are output in the same format. Exim does not restrict the values; it
5103 is perfectly acceptable, for example, to specify &"90m"& instead of &"1h30m"&.
5104
5105
5106
5107 .section "String values" "SECTstrings"
5108 .cindex "string" "format of configuration values"
5109 .cindex "format" "string"
5110 If an option's type is specified as &"string"&, the value can be specified with
5111 or without double-quotes. If it does not start with a double-quote, the value
5112 consists of the remainder of the line plus any continuation lines, starting at
5113 the first character after any leading white space, with trailing white space
5114 removed, and with no interpretation of the characters in the string. Because
5115 Exim removes comment lines (those beginning with #) at an early stage, they can
5116 appear in the middle of a multi-line string. The following two settings are
5117 therefore equivalent:
5118 .code
5119 trusted_users = uucp:mail
5120 trusted_users = uucp:\
5121                 # This comment line is ignored
5122                 mail
5123 .endd
5124 .cindex "string" "quoted"
5125 .cindex "escape characters in quoted strings"
5126 If a string does start with a double-quote, it must end with a closing
5127 double-quote, and any backslash characters other than those used for line
5128 continuation are interpreted as escape characters, as follows:
5129
5130 .table2 100pt
5131 .irow &`\\`&                     "single backslash"
5132 .irow &`\n`&                     "newline"
5133 .irow &`\r`&                     "carriage return"
5134 .irow &`\t`&                     "tab"
5135 .irow "&`\`&<&'octal digits'&>"  "up to 3 octal digits specify one character"
5136 .irow "&`\x`&<&'hex digits'&>"   "up to 2 hexadecimal digits specify one &&&
5137                                    character"
5138 .endtable
5139
5140 If a backslash is followed by some other character, including a double-quote
5141 character, that character replaces the pair.
5142
5143 Quoting is necessary only if you want to make use of the backslash escapes to
5144 insert special characters, or if you need to specify a value with leading or
5145 trailing spaces. These cases are rare, so quoting is almost never needed in
5146 current versions of Exim. In versions of Exim before 3.14, quoting was required
5147 in order to continue lines, so you may come across older configuration files
5148 and examples that apparently quote unnecessarily.
5149
5150
5151 .section "Expanded strings" "SECID51"
5152 .cindex "expansion" "definition of"
5153 Some strings in the configuration file are subjected to &'string expansion'&,
5154 by which means various parts of the string may be changed according to the
5155 circumstances (see chapter &<<CHAPexpand>>&). The input syntax for such strings
5156 is as just described; in particular, the handling of backslashes in quoted
5157 strings is done as part of the input process, before expansion takes place.
5158 However, backslash is also an escape character for the expander, so any
5159 backslashes that are required for that reason must be doubled if they are
5160 within a quoted configuration string.
5161
5162
5163 .section "User and group names" "SECID52"
5164 .cindex "user name" "format of"
5165 .cindex "format" "user name"
5166 .cindex "groups" "name format"
5167 .cindex "format" "group name"
5168 User and group names are specified as strings, using the syntax described
5169 above, but the strings are interpreted specially. A user or group name must
5170 either consist entirely of digits, or be a name that can be looked up using the
5171 &[getpwnam()]& or &[getgrnam()]& function, as appropriate.
5172
5173
5174 .section "List construction" "SECTlistconstruct"
5175 .cindex "list" "syntax of in configuration"
5176 .cindex "format" "list item in configuration"
5177 .cindex "string" "list, definition of"
5178 The data for some configuration options is a list of items, with colon as the
5179 default separator. Many of these options are shown with type &"string list"& in
5180 the descriptions later in this document. Others are listed as &"domain list"&,
5181 &"host list"&, &"address list"&, or &"local part list"&. Syntactically, they
5182 are all the same; however, those other than &"string list"& are subject to
5183 particular kinds of interpretation, as described in chapter
5184 &<<CHAPdomhosaddlists>>&.
5185
5186 In all these cases, the entire list is treated as a single string as far as the
5187 input syntax is concerned. The &%trusted_users%& setting in section
5188 &<<SECTstrings>>& above is an example. If a colon is actually needed in an item
5189 in a list, it must be entered as two colons. Leading and trailing white space
5190 on each item in a list is ignored. This makes it possible to include items that
5191 start with a colon, and in particular, certain forms of IPv6 address. For
5192 example, the list
5193 .code
5194 local_interfaces = 127.0.0.1 : ::::1
5195 .endd
5196 contains two IP addresses, the IPv4 address 127.0.0.1 and the IPv6 address ::1.
5197
5198 &*Note*&: Although leading and trailing white space is ignored in individual
5199 list items, it is not ignored when parsing the list. The space after the first
5200 colon in the example above is necessary. If it were not there, the list would
5201 be interpreted as the two items 127.0.0.1:: and 1.
5202
5203 .section "Changing list separators" "SECID53"
5204 .cindex "list separator" "changing"
5205 .cindex "IPv6" "addresses in lists"
5206 Doubling colons in IPv6 addresses is an unwelcome chore, so a mechanism was
5207 introduced to allow the separator character to be changed. If a list begins
5208 with a left angle bracket, followed by any punctuation character, that
5209 character is used instead of colon as the list separator. For example, the list
5210 above can be rewritten to use a semicolon separator like this:
5211 .code
5212 local_interfaces = <; 127.0.0.1 ; ::1
5213 .endd
5214 This facility applies to all lists, with the exception of the list in
5215 &%log_file_path%&. It is recommended that the use of non-colon separators be
5216 confined to circumstances where they really are needed.
5217
5218 .cindex "list separator" "newline as"
5219 .cindex "newline" "as list separator"
5220 It is also possible to use newline and other control characters (those with
5221 code values less than 32, plus DEL) as separators in lists. Such separators
5222 must be provided literally at the time the list is processed. For options that
5223 are string-expanded, you can write the separator using a normal escape
5224 sequence. This will be processed by the expander before the string is
5225 interpreted as a list. For example, if a newline-separated list of domains is
5226 generated by a lookup, you can process it directly by a line such as this:
5227 .code
5228 domains = <\n ${lookup mysql{.....}}
5229 .endd
5230 This avoids having to change the list separator in such data. You are unlikely
5231 to want to use a control character as a separator in an option that is not
5232 expanded, because the value is literal text. However, it can be done by giving
5233 the value in quotes. For example:
5234 .code
5235 local_interfaces = "<\n 127.0.0.1 \n ::1"
5236 .endd
5237 Unlike printing character separators, which can be included in list items by
5238 doubling, it is not possible to include a control character as data when it is
5239 set as the separator. Two such characters in succession are interpreted as
5240 enclosing an empty list item.
5241
5242
5243
5244 .section "Empty items in lists" "SECTempitelis"
5245 .cindex "list" "empty item in"
5246 An empty item at the end of a list is always ignored. In other words, trailing
5247 separator characters are ignored. Thus, the list in
5248 .code
5249 senders = user@domain :
5250 .endd
5251 contains only a single item. If you want to include an empty string as one item
5252 in a list, it must not be the last item. For example, this list contains three
5253 items, the second of which is empty:
5254 .code
5255 senders = user1@domain : : user2@domain
5256 .endd
5257 &*Note*&: There must be white space between the two colons, as otherwise they
5258 are interpreted as representing a single colon data character (and the list
5259 would then contain just one item). If you want to specify a list that contains
5260 just one, empty item, you can do it as in this example:
5261 .code
5262 senders = :
5263 .endd
5264 In this case, the first item is empty, and the second is discarded because it
5265 is at the end of the list.
5266
5267
5268
5269
5270 .section "Format of driver configurations" "SECTfordricon"
5271 .cindex "drivers" "configuration format"
5272 There are separate parts in the configuration for defining routers, transports,
5273 and authenticators. In each part, you are defining a number of driver
5274 instances, each with its own set of options. Each driver instance is defined by
5275 a sequence of lines like this:
5276 .display
5277 <&'instance name'&>:
5278   <&'option'&>
5279   ...
5280   <&'option'&>
5281 .endd
5282 In the following example, the instance name is &(localuser)&, and it is
5283 followed by three options settings:
5284 .code
5285 localuser:
5286   driver = accept
5287   check_local_user
5288   transport = local_delivery
5289 .endd
5290 For each driver instance, you specify which Exim code module it uses &-- by the
5291 setting of the &%driver%& option &-- and (optionally) some configuration
5292 settings. For example, in the case of transports, if you want a transport to
5293 deliver with SMTP you would use the &(smtp)& driver; if you want to deliver to
5294 a local file you would use the &(appendfile)& driver. Each of the drivers is
5295 described in detail in its own separate chapter later in this manual.
5296
5297 You can have several routers, transports, or authenticators that are based on
5298 the same underlying driver (each must have a different instance name).
5299
5300 The order in which routers are defined is important, because addresses are
5301 passed to individual routers one by one, in order. The order in which
5302 transports are defined does not matter at all. The order in which
5303 authenticators are defined is used only when Exim, as a client, is searching
5304 them to find one that matches an authentication mechanism offered by the
5305 server.
5306
5307 .cindex "generic options"
5308 .cindex "options" "generic &-- definition of"
5309 Within a driver instance definition, there are two kinds of option: &'generic'&
5310 and &'private'&. The generic options are those that apply to all drivers of the
5311 same type (that is, all routers, all transports or all authenticators). The
5312 &%driver%& option is a generic option that must appear in every definition.
5313 .cindex "private options"
5314 The private options are special for each driver, and none need appear, because
5315 they all have default values.
5316
5317 The options may appear in any order, except that the &%driver%& option must
5318 precede any private options, since these depend on the particular driver. For
5319 this reason, it is recommended that &%driver%& always be the first option.
5320
5321 Driver instance names, which are used for reference in log entries and
5322 elsewhere, can be any sequence of letters, digits, and underscores (starting
5323 with a letter) and must be unique among drivers of the same type. A router and
5324 a transport (for example) can each have the same name, but no two router
5325 instances can have the same name. The name of a driver instance should not be
5326 confused with the name of the underlying driver module. For example, the
5327 configuration lines:
5328 .code
5329 remote_smtp:
5330   driver = smtp
5331 .endd
5332 create an instance of the &(smtp)& transport driver whose name is
5333 &(remote_smtp)&. The same driver code can be used more than once, with
5334 different instance names and different option settings each time. A second
5335 instance of the &(smtp)& transport, with different options, might be defined
5336 thus:
5337 .code
5338 special_smtp:
5339   driver = smtp
5340   port = 1234
5341   command_timeout = 10s
5342 .endd
5343 The names &(remote_smtp)& and &(special_smtp)& would be used to reference
5344 these transport instances from routers, and these names would appear in log
5345 lines.
5346
5347 Comment lines may be present in the middle of driver specifications. The full
5348 list of option settings for any particular driver instance, including all the
5349 defaulted values, can be extracted by making use of the &%-bP%& command line
5350 option.
5351
5352
5353
5354
5355
5356
5357 . ////////////////////////////////////////////////////////////////////////////
5358 . ////////////////////////////////////////////////////////////////////////////
5359
5360 .chapter "The default configuration file" "CHAPdefconfil"
5361 .scindex IIDconfiwal "configuration file" "default &""walk through""&"
5362 .cindex "default" "configuration file &""walk through""&"
5363 The default configuration file supplied with Exim as &_src/configure.default_&
5364 is sufficient for a host with simple mail requirements. As an introduction to
5365 the way Exim is configured, this chapter &"walks through"& the default
5366 configuration, giving brief explanations of the settings. Detailed descriptions
5367 of the options are given in subsequent chapters. The default configuration file
5368 itself contains extensive comments about ways you might want to modify the
5369 initial settings. However, note that there are many options that are not
5370 mentioned at all in the default configuration.
5371
5372
5373
5374 .section "Main configuration settings" "SECTdefconfmain"
5375 The main (global) configuration option settings must always come first in the
5376 file. The first thing you'll see in the file, after some initial comments, is
5377 the line
5378 .code
5379 # primary_hostname =
5380 .endd
5381 This is a commented-out setting of the &%primary_hostname%& option. Exim needs
5382 to know the official, fully qualified name of your host, and this is where you
5383 can specify it. However, in most cases you do not need to set this option. When
5384 it is unset, Exim uses the &[uname()]& system function to obtain the host name.
5385
5386 The first three non-comment configuration lines are as follows:
5387 .code
5388 domainlist local_domains    = @
5389 domainlist relay_to_domains =
5390 hostlist   relay_from_hosts = 127.0.0.1
5391 .endd
5392 These are not, in fact, option settings. They are definitions of two named
5393 domain lists and one named host list. Exim allows you to give names to lists of
5394 domains, hosts, and email addresses, in order to make it easier to manage the
5395 configuration file (see section &<<SECTnamedlists>>&).
5396
5397 The first line defines a domain list called &'local_domains'&; this is used
5398 later in the configuration to identify domains that are to be delivered
5399 on the local host.
5400
5401 .cindex "@ in a domain list"
5402 There is just one item in this list, the string &"@"&. This is a special form
5403 of entry which means &"the name of the local host"&. Thus, if the local host is
5404 called &'a.host.example'&, mail to &'any.user@a.host.example'& is expected to
5405 be delivered locally. Because the local host's name is referenced indirectly,
5406 the same configuration file can be used on different hosts.
5407
5408 The second line defines a domain list called &'relay_to_domains'&, but the
5409 list itself is empty. Later in the configuration we will come to the part that
5410 controls mail relaying through the local host; it allows relaying to any
5411 domains in this list. By default, therefore, no relaying on the basis of a mail
5412 domain is permitted.
5413
5414 The third line defines a host list called &'relay_from_hosts'&. This list is
5415 used later in the configuration to permit relaying from any host or IP address
5416 that matches the list. The default contains just the IP address of the IPv4
5417 loopback interface, which means that processes on the local host are able to
5418 submit mail for relaying by sending it over TCP/IP to that interface. No other
5419 hosts are permitted to submit messages for relaying.
5420
5421 Just to be sure there's no misunderstanding: at this point in the configuration
5422 we aren't actually setting up any controls. We are just defining some domains
5423 and hosts that will be used in the controls that are specified later.
5424
5425 The next two configuration lines are genuine option settings:
5426 .code
5427 acl_smtp_rcpt = acl_check_rcpt
5428 acl_smtp_data = acl_check_data
5429 .endd
5430 These options specify &'Access Control Lists'& (ACLs) that are to be used
5431 during an incoming SMTP session for every recipient of a message (every RCPT
5432 command), and after the contents of the message have been received,
5433 respectively. The names of the lists are &'acl_check_rcpt'& and
5434 &'acl_check_data'&, and we will come to their definitions below, in the ACL
5435 section of the configuration. The RCPT ACL controls which recipients are
5436 accepted for an incoming message &-- if a configuration does not provide an ACL
5437 to check recipients, no SMTP mail can be accepted. The DATA ACL allows the
5438 contents of a message to be checked.
5439
5440 Two commented-out option settings are next:
5441 .code
5442 # av_scanner = clamd:/tmp/clamd
5443 # spamd_address = 127.0.0.1 783
5444 .endd
5445 These are example settings that can be used when Exim is compiled with the
5446 content-scanning extension. The first specifies the interface to the virus
5447 scanner, and the second specifies the interface to SpamAssassin. Further
5448 details are given in chapter &<<CHAPexiscan>>&.
5449
5450 Three more commented-out option settings follow:
5451 .code
5452 # tls_advertise_hosts = *
5453 # tls_certificate = /etc/ssl/exim.crt
5454 # tls_privatekey = /etc/ssl/exim.pem
5455 .endd
5456 These are example settings that can be used when Exim is compiled with
5457 support for TLS (aka SSL) as described in section &<<SECTinctlsssl>>&. The
5458 first one specifies the list of clients that are allowed to use TLS when
5459 connecting to this server; in this case the wildcard means all clients. The
5460 other options specify where Exim should find its TLS certificate and private
5461 key, which together prove the server's identity to any clients that connect.
5462 More details are given in chapter &<<CHAPTLS>>&.
5463
5464 Another two commented-out option settings follow:
5465 .code
5466 # daemon_smtp_ports = 25 : 465 : 587
5467 # tls_on_connect_ports = 465
5468 .endd
5469 .cindex "port" "465 and 587"
5470 .cindex "port" "for message submission"
5471 .cindex "message" "submission, ports for"
5472 .cindex "ssmtp protocol"
5473 .cindex "smtps protocol"
5474 .cindex "SMTP" "ssmtp protocol"
5475 .cindex "SMTP" "smtps protocol"
5476 These options provide better support for roaming users who wish to use this
5477 server for message submission. They are not much use unless you have turned on
5478 TLS (as described in the previous paragraph) and authentication (about which
5479 more in section &<<SECTdefconfauth>>&). The usual SMTP port 25 is often blocked
5480 on end-user networks, so RFC 4409 specifies that message submission should use
5481 port 587 instead. However some software (notably Microsoft Outlook) cannot be
5482 configured to use port 587 correctly, so these settings also enable the
5483 non-standard &"smtps"& (aka &"ssmtp"&) port 465 (see section
5484 &<<SECTsupobssmt>>&).
5485
5486 Two more commented-out options settings follow:
5487 .code
5488 # qualify_domain =
5489 # qualify_recipient =
5490 .endd
5491 The first of these specifies a domain that Exim uses when it constructs a
5492 complete email address from a local login name. This is often needed when Exim
5493 receives a message from a local process. If you do not set &%qualify_domain%&,
5494 the value of &%primary_hostname%& is used. If you set both of these options,
5495 you can have different qualification domains for sender and recipient
5496 addresses. If you set only the first one, its value is used in both cases.
5497
5498 .cindex "domain literal" "recognizing format"
5499 The following line must be uncommented if you want Exim to recognize
5500 addresses of the form &'user@[10.11.12.13]'& that is, with a &"domain literal"&
5501 (an IP address within square brackets) instead of a named domain.
5502 .code
5503 # allow_domain_literals
5504 .endd
5505 The RFCs still require this form, but many people think that in the modern
5506 Internet it makes little sense to permit mail to be sent to specific hosts by
5507 quoting their IP addresses. This ancient format has been used by people who
5508 try to abuse hosts by using them for unwanted relaying. However, some
5509 people believe there are circumstances (for example, messages addressed to
5510 &'postmaster'&) where domain literals are still useful.
5511
5512 The next configuration line is a kind of trigger guard:
5513 .code
5514 never_users = root
5515 .endd
5516 It specifies that no delivery must ever be run as the root user. The normal
5517 convention is to set up &'root'& as an alias for the system administrator. This
5518 setting is a guard against slips in the configuration.
5519 The list of users specified by &%never_users%& is not, however, the complete
5520 list; the build-time configuration in &_Local/Makefile_& has an option called
5521 FIXED_NEVER_USERS specifying a list that cannot be overridden. The
5522 contents of &%never_users%& are added to this list. By default
5523 FIXED_NEVER_USERS also specifies root.
5524
5525 When a remote host connects to Exim in order to send mail, the only information
5526 Exim has about the host's identity is its IP address. The next configuration
5527 line,
5528 .code
5529 host_lookup = *
5530 .endd
5531 specifies that Exim should do a reverse DNS lookup on all incoming connections,
5532 in order to get a host name. This improves the quality of the logging
5533 information, but if you feel it is too expensive, you can remove it entirely,
5534 or restrict the lookup to hosts on &"nearby"& networks.
5535 Note that it is not always possible to find a host name from an IP address,
5536 because not all DNS reverse zones are maintained, and sometimes DNS servers are
5537 unreachable.
5538
5539 The next two lines are concerned with &'ident'& callbacks, as defined by RFC
5540 1413 (hence their names):
5541 .code
5542 rfc1413_hosts = *
5543 rfc1413_query_timeout = 5s
5544 .endd
5545 These settings cause Exim to make ident callbacks for all incoming SMTP calls.
5546 You can limit the hosts to which these calls are made, or change the timeout
5547 that is used. If you set the timeout to zero, all ident calls are disabled.
5548 Although they are cheap and can provide useful information for tracing problem
5549 messages, some hosts and firewalls have problems with ident calls. This can
5550 result in a timeout instead of an immediate refused connection, leading to
5551 delays on starting up an incoming SMTP session.
5552
5553 When Exim receives messages over SMTP connections, it expects all addresses to
5554 be fully qualified with a domain, as required by the SMTP definition. However,
5555 if you are running a server to which simple clients submit messages, you may
5556 find that they send unqualified addresses. The two commented-out options:
5557 .code
5558 # sender_unqualified_hosts =
5559 # recipient_unqualified_hosts =
5560 .endd
5561 show how you can specify hosts that are permitted to send unqualified sender
5562 and recipient addresses, respectively.
5563
5564 The &%percent_hack_domains%& option is also commented out:
5565 .code
5566 # percent_hack_domains =
5567 .endd
5568 It provides a list of domains for which the &"percent hack"& is to operate.
5569 This is an almost obsolete form of explicit email routing. If you do not know
5570 anything about it, you can safely ignore this topic.
5571
5572 The last two settings in the main part of the default configuration are
5573 concerned with messages that have been &"frozen"& on Exim's queue. When a
5574 message is frozen, Exim no longer continues to try to deliver it. Freezing
5575 occurs when a bounce message encounters a permanent failure because the sender
5576 address of the original message that caused the bounce is invalid, so the
5577 bounce cannot be delivered. This is probably the most common case, but there
5578 are also other conditions that cause freezing, and frozen messages are not
5579 always bounce messages.
5580 .code
5581 ignore_bounce_errors_after = 2d
5582 timeout_frozen_after = 7d
5583 .endd
5584 The first of these options specifies that failing bounce messages are to be
5585 discarded after 2 days on the queue. The second specifies that any frozen
5586 message (whether a bounce message or not) is to be timed out (and discarded)
5587 after a week. In this configuration, the first setting ensures that no failing
5588 bounce message ever lasts a week.
5589
5590
5591
5592 .section "ACL configuration" "SECID54"
5593 .cindex "default" "ACLs"
5594 .cindex "&ACL;" "default configuration"
5595 In the default configuration, the ACL section follows the main configuration.
5596 It starts with the line
5597 .code
5598 begin acl
5599 .endd
5600 and it contains the definitions of two ACLs, called &'acl_check_rcpt'& and
5601 &'acl_check_data'&, that were referenced in the settings of &%acl_smtp_rcpt%&
5602 and &%acl_smtp_data%& above.
5603
5604 .cindex "RCPT" "ACL for"
5605 The first ACL is used for every RCPT command in an incoming SMTP message. Each
5606 RCPT command specifies one of the message's recipients. The ACL statements
5607 are considered in order, until the recipient address is either accepted or
5608 rejected. The RCPT command is then accepted or rejected, according to the
5609 result of the ACL processing.
5610 .code
5611 acl_check_rcpt:
5612 .endd
5613 This line, consisting of a name terminated by a colon, marks the start of the
5614 ACL, and names it.
5615 .code
5616 accept  hosts = :
5617 .endd
5618 This ACL statement accepts the recipient if the sending host matches the list.
5619 But what does that strange list mean? It doesn't actually contain any host
5620 names or IP addresses. The presence of the colon puts an empty item in the
5621 list; Exim matches this only if the incoming message did not come from a remote
5622 host, because in that case, the remote hostname is empty. The colon is
5623 important. Without it, the list itself is empty, and can never match anything.
5624
5625 What this statement is doing is to accept unconditionally all recipients in
5626 messages that are submitted by SMTP from local processes using the standard
5627 input and output (that is, not using TCP/IP). A number of MUAs operate in this
5628 manner.
5629 .code
5630 deny    message       = Restricted characters in address
5631         domains       = +local_domains
5632         local_parts   = ^[.] : ^.*[@%!/|]
5633
5634 deny    message       = Restricted characters in address
5635         domains       = !+local_domains
5636         local_parts   = ^[./|] : ^.*[@%!] : ^.*/\\.\\./
5637 .endd
5638 These statements are concerned with local parts that contain any of the
5639 characters &"@"&, &"%"&, &"!"&, &"/"&, &"|"&, or dots in unusual places.
5640 Although these characters are entirely legal in local parts (in the case of
5641 &"@"& and leading dots, only if correctly quoted), they do not commonly occur
5642 in Internet mail addresses.
5643
5644 The first three have in the past been associated with explicitly routed
5645 addresses (percent is still sometimes used &-- see the &%percent_hack_domains%&
5646 option). Addresses containing these characters are regularly tried by spammers
5647 in an attempt to bypass relaying restrictions, and also by open relay testing
5648 programs. Unless you really need them it is safest to reject these characters
5649 at this early stage. This configuration is heavy-handed in rejecting these
5650 characters for all messages it accepts from remote hosts. This is a deliberate
5651 policy of being as safe as possible.
5652
5653 The first rule above is stricter, and is applied to messages that are addressed
5654 to one of the local domains handled by this host. This is implemented by the
5655 first condition, which restricts it to domains that are listed in the
5656 &'local_domains'& domain list. The &"+"& character is used to indicate a
5657 reference to a named list. In this configuration, there is just one domain in
5658 &'local_domains'&, but in general there may be many.
5659
5660 The second condition on the first statement uses two regular expressions to
5661 block local parts that begin with a dot or contain &"@"&, &"%"&, &"!"&, &"/"&,
5662 or &"|"&. If you have local accounts that include these characters, you will
5663 have to modify this rule.
5664
5665 Empty components (two dots in a row) are not valid in RFC 2822, but Exim
5666 allows them because they have been encountered in practice. (Consider the
5667 common convention of local parts constructed as
5668 &"&'first-initial.second-initial.family-name'&"& when applied to someone like
5669 the author of Exim, who has no second initial.) However, a local part starting
5670 with a dot or containing &"/../"& can cause trouble if it is used as part of a
5671 file name (for example, for a mailing list). This is also true for local parts
5672 that contain slashes. A pipe symbol can also be troublesome if the local part
5673 is incorporated unthinkingly into a shell command line.
5674
5675 The second rule above applies to all other domains, and is less strict. This
5676 allows your own users to send outgoing messages to sites that use slashes
5677 and vertical bars in their local parts. It blocks local parts that begin
5678 with a dot, slash, or vertical bar, but allows these characters within the
5679 local part. However, the sequence &"/../"& is barred. The use of &"@"&, &"%"&,
5680 and &"!"& is blocked, as before. The motivation here is to prevent your users
5681 (or your users' viruses) from mounting certain kinds of attack on remote sites.
5682 .code
5683 accept  local_parts   = postmaster
5684         domains       = +local_domains
5685 .endd
5686 This statement, which has two conditions, accepts an incoming address if the
5687 local part is &'postmaster'& and the domain is one of those listed in the
5688 &'local_domains'& domain list. The &"+"& character is used to indicate a
5689 reference to a named list. In this configuration, there is just one domain in
5690 &'local_domains'&, but in general there may be many.
5691
5692 The presence of this statement means that mail to postmaster is never blocked
5693 by any of the subsequent tests. This can be helpful while sorting out problems
5694 in cases where the subsequent tests are incorrectly denying access.
5695 .code
5696 require verify        = sender
5697 .endd
5698 This statement requires the sender address to be verified before any subsequent
5699 ACL statement can be used. If verification fails, the incoming recipient
5700 address is refused. Verification consists of trying to route the address, to
5701 see if a bounce message could be delivered to it. In the case of remote
5702 addresses, basic verification checks only the domain, but &'callouts'& can be
5703 used for more verification if required. Section &<<SECTaddressverification>>&
5704 discusses the details of address verification.
5705 .code
5706 accept  hosts         = +relay_from_hosts
5707         control       = submission
5708 .endd
5709 This statement accepts the address if the message is coming from one of the
5710 hosts that are defined as being allowed to relay through this host. Recipient
5711 verification is omitted here, because in many cases the clients are dumb MUAs
5712 that do not cope well with SMTP error responses. For the same reason, the
5713 second line specifies &"submission mode"& for messages that are accepted. This
5714 is described in detail in section &<<SECTsubmodnon>>&; it causes Exim to fix
5715 messages that are deficient in some way, for example, because they lack a
5716 &'Date:'& header line. If you are actually relaying out from MTAs, you should
5717 probably add recipient verification here, and disable submission mode.
5718 .code
5719 accept  authenticated = *
5720         control       = submission
5721 .endd
5722 This statement accepts the address if the client host has authenticated itself.
5723 Submission mode is again specified, on the grounds that such messages are most
5724 likely to come from MUAs. The default configuration does not define any
5725 authenticators, though it does include some nearly complete commented-out
5726 examples described in &<<SECTdefconfauth>>&. This means that no client can in
5727 fact authenticate until you complete the authenticator definitions.
5728 .code
5729 require message = relay not permitted
5730         domains = +local_domains : +relay_to_domains
5731 .endd
5732 This statement rejects the address if its domain is neither a local domain nor
5733 one of the domains for which this host is a relay.
5734 .code
5735 require verify = recipient
5736 .endd
5737 This statement requires the recipient address to be verified; if verification
5738 fails, the address is rejected.
5739 .code
5740 # deny    message     = rejected because $sender_host_address \
5741 #                       is in a black list at $dnslist_domain\n\
5742 #                       $dnslist_text
5743 #         dnslists    = black.list.example
5744 #
5745 # warn    dnslists    = black.list.example
5746 #         add_header  = X-Warning: $sender_host_address is in \
5747 #                       a black list at $dnslist_domain
5748 #         log_message = found in $dnslist_domain
5749 .endd
5750 These commented-out lines are examples of how you could configure Exim to check
5751 sending hosts against a DNS black list. The first statement rejects messages
5752 from blacklisted hosts, whereas the second just inserts a warning header
5753 line.
5754 .code
5755 # require verify = csa
5756 .endd
5757 This commented-out line is an example of how you could turn on client SMTP
5758 authorization (CSA) checking. Such checks do DNS lookups for special SRV
5759 records.
5760 .code
5761 accept
5762 .endd
5763 The final statement in the first ACL unconditionally accepts any recipient
5764 address that has successfully passed all the previous tests.
5765 .code
5766 acl_check_data:
5767 .endd
5768 This line marks the start of the second ACL, and names it. Most of the contents
5769 of this ACL are commented out:
5770 .code
5771 # deny    malware   = *
5772 #         message   = This message contains a virus \
5773 #                     ($malware_name).
5774 .endd
5775 These lines are examples of how to arrange for messages to be scanned for
5776 viruses when Exim has been compiled with the content-scanning extension, and a
5777 suitable virus scanner is installed. If the message is found to contain a
5778 virus, it is rejected with the given custom error message.
5779 .code
5780 # warn    spam      = nobody
5781 #         message   = X-Spam_score: $spam_score\n\
5782 #                     X-Spam_score_int: $spam_score_int\n\
5783 #                     X-Spam_bar: $spam_bar\n\
5784 #                     X-Spam_report: $spam_report
5785 .endd
5786 These lines are an example of how to arrange for messages to be scanned by
5787 SpamAssassin when Exim has been compiled with the content-scanning extension,
5788 and SpamAssassin has been installed. The SpamAssassin check is run with
5789 &`nobody`& as its user parameter, and the results are added to the message as a
5790 series of extra header line. In this case, the message is not rejected,
5791 whatever the spam score.
5792 .code
5793 accept
5794 .endd
5795 This final line in the DATA ACL accepts the message unconditionally.
5796
5797
5798 .section "Router configuration" "SECID55"
5799 .cindex "default" "routers"
5800 .cindex "routers" "default"
5801 The router configuration comes next in the default configuration, introduced
5802 by the line
5803 .code
5804 begin routers
5805 .endd
5806 Routers are the modules in Exim that make decisions about where to send
5807 messages. An address is passed to each router in turn, until it is either
5808 accepted, or failed. This means that the order in which you define the routers
5809 matters. Each router is fully described in its own chapter later in this
5810 manual. Here we give only brief overviews.
5811 .code
5812 # domain_literal:
5813 #   driver = ipliteral
5814 #   domains = !+local_domains
5815 #   transport = remote_smtp
5816 .endd
5817 .cindex "domain literal" "default router"
5818 This router is commented out because the majority of sites do not want to
5819 support domain literal addresses (those of the form &'user@[10.9.8.7]'&). If
5820 you uncomment this router, you also need to uncomment the setting of
5821 &%allow_domain_literals%& in the main part of the configuration.
5822 .code
5823 dnslookup:
5824   driver = dnslookup
5825   domains = ! +local_domains
5826   transport = remote_smtp
5827   ignore_target_hosts = 0.0.0.0 : 127.0.0.0/8
5828   no_more
5829 .endd
5830 The first uncommented router handles addresses that do not involve any local
5831 domains. This is specified by the line
5832 .code
5833 domains = ! +local_domains
5834 .endd
5835 The &%domains%& option lists the domains to which this router applies, but the
5836 exclamation mark is a negation sign, so the router is used only for domains
5837 that are not in the domain list called &'local_domains'& (which was defined at
5838 the start of the configuration). The plus sign before &'local_domains'&
5839 indicates that it is referring to a named list. Addresses in other domains are
5840 passed on to the following routers.
5841
5842 The name of the router driver is &(dnslookup)&,
5843 and is specified by the &%driver%& option. Do not be confused by the fact that
5844 the name of this router instance is the same as the name of the driver. The
5845 instance name is arbitrary, but the name set in the &%driver%& option must be
5846 one of the driver modules that is in the Exim binary.
5847
5848 The &(dnslookup)& router routes addresses by looking up their domains in the
5849 DNS in order to obtain a list of hosts to which the address is routed. If the
5850 router succeeds, the address is queued for the &(remote_smtp)& transport, as
5851 specified by the &%transport%& option. If the router does not find the domain
5852 in the DNS, no further routers are tried because of the &%no_more%& setting, so
5853 the address fails and is bounced.
5854
5855 The &%ignore_target_hosts%& option specifies a list of IP addresses that are to
5856 be entirely ignored. This option is present because a number of cases have been
5857 encountered where MX records in the DNS point to host names
5858 whose IP addresses are 0.0.0.0 or are in the 127 subnet (typically 127.0.0.1).
5859 Completely ignoring these IP addresses causes Exim to fail to route the
5860 email address, so it bounces. Otherwise, Exim would log a routing problem, and
5861 continue to try to deliver the message periodically until the address timed
5862 out.
5863 .code
5864 system_aliases:
5865   driver = redirect
5866   allow_fail
5867   allow_defer
5868   data = ${lookup{$local_part}lsearch{/etc/aliases}}
5869 # user = exim
5870   file_transport = address_file
5871   pipe_transport = address_pipe
5872 .endd
5873 Control reaches this and subsequent routers only for addresses in the local
5874 domains. This router checks to see whether the local part is defined as an
5875 alias in the &_/etc/aliases_& file, and if so, redirects it according to the
5876 data that it looks up from that file. If no data is found for the local part,
5877 the value of the &%data%& option is empty, causing the address to be passed to
5878 the next router.
5879
5880 &_/etc/aliases_& is a conventional name for the system aliases file that is
5881 often used. That is why it is referenced by from the default configuration
5882 file. However, you can change this by setting SYSTEM_ALIASES_FILE in
5883 &_Local/Makefile_& before building Exim.
5884 .code
5885 userforward:
5886   driver = redirect
5887   check_local_user
5888 # local_part_suffix = +* : -*
5889 # local_part_suffix_optional
5890   file = $home/.forward
5891 # allow_filter
5892   no_verify
5893   no_expn
5894   check_ancestor
5895   file_transport = address_file
5896   pipe_transport = address_pipe
5897   reply_transport = address_reply
5898 .endd
5899 This is the most complicated router in the default configuration. It is another
5900 redirection router, but this time it is looking for forwarding data set up by
5901 individual users. The &%check_local_user%& setting specifies a check that the
5902 local part of the address is the login name of a local user. If it is not, the
5903 router is skipped. The two commented options that follow &%check_local_user%&,
5904 namely:
5905 .code
5906 # local_part_suffix = +* : -*
5907 # local_part_suffix_optional
5908 .endd
5909 .vindex "&$local_part_suffix$&"
5910 show how you can specify the recognition of local part suffixes. If the first
5911 is uncommented, a suffix beginning with either a plus or a minus sign, followed
5912 by any sequence of characters, is removed from the local part and placed in the
5913 variable &$local_part_suffix$&. The second suffix option specifies that the
5914 presence of a suffix in the local part is optional. When a suffix is present,
5915 the check for a local login uses the local part with the suffix removed.
5916
5917 When a local user account is found, the file called &_.forward_& in the user's
5918 home directory is consulted. If it does not exist, or is empty, the router
5919 declines. Otherwise, the contents of &_.forward_& are interpreted as
5920 redirection data (see chapter &<<CHAPredirect>>& for more details).
5921
5922 .cindex "Sieve filter" "enabling in default router"
5923 Traditional &_.forward_& files contain just a list of addresses, pipes, or
5924 files. Exim supports this by default. However, if &%allow_filter%& is set (it
5925 is commented out by default), the contents of the file are interpreted as a set
5926 of Exim or Sieve filtering instructions, provided the file begins with &"#Exim
5927 filter"& or &"#Sieve filter"&, respectively. User filtering is discussed in the
5928 separate document entitled &'Exim's interfaces to mail filtering'&.
5929
5930 The &%no_verify%& and &%no_expn%& options mean that this router is skipped when
5931 verifying addresses, or when running as a consequence of an SMTP EXPN command.
5932 There are two reasons for doing this:
5933
5934 .olist
5935 Whether or not a local user has a &_.forward_& file is not really relevant when
5936 checking an address for validity; it makes sense not to waste resources doing
5937 unnecessary work.
5938 .next
5939 More importantly, when Exim is verifying addresses or handling an EXPN
5940 command during an SMTP session, it is running as the Exim user, not as root.
5941 The group is the Exim group, and no additional groups are set up.
5942 It may therefore not be possible for Exim to read users' &_.forward_& files at
5943 this time.
5944 .endlist
5945
5946 The setting of &%check_ancestor%& prevents the router from generating a new
5947 address that is the same as any previous address that was redirected. (This
5948 works round a problem concerning a bad interaction between aliasing and
5949 forwarding &-- see section &<<SECTredlocmai>>&).
5950
5951 The final three option settings specify the transports that are to be used when
5952 forwarding generates a direct delivery to a file, or to a pipe, or sets up an
5953 auto-reply, respectively. For example, if a &_.forward_& file contains
5954 .code
5955 a.nother@elsewhere.example, /home/spqr/archive
5956 .endd
5957 the delivery to &_/home/spqr/archive_& is done by running the &%address_file%&
5958 transport.
5959 .code
5960 localuser:
5961   driver = accept
5962   check_local_user
5963 # local_part_suffix = +* : -*
5964 # local_part_suffix_optional
5965   transport = local_delivery
5966 .endd
5967 The final router sets up delivery into local mailboxes, provided that the local
5968 part is the name of a local login, by accepting the address and assigning it to
5969 the &(local_delivery)& transport. Otherwise, we have reached the end of the
5970 routers, so the address is bounced. The commented suffix settings fulfil the
5971 same purpose as they do for the &(userforward)& router.
5972
5973
5974 .section "Transport configuration" "SECID56"
5975 .cindex "default" "transports"
5976 .cindex "transports" "default"
5977 Transports define mechanisms for actually delivering messages. They operate
5978 only when referenced from routers, so the order in which they are defined does
5979 not matter. The transports section of the configuration starts with
5980 .code
5981 begin transports
5982 .endd
5983 One remote transport and four local transports are defined.
5984 .code
5985 remote_smtp:
5986   driver = smtp
5987 .endd
5988 This transport is used for delivering messages over SMTP connections. All its
5989 options are defaulted. The list of remote hosts comes from the router.
5990 .code
5991 local_delivery:
5992   driver = appendfile
5993   file = /var/mail/$local_part
5994   delivery_date_add
5995   envelope_to_add
5996   return_path_add
5997 # group = mail
5998 # mode = 0660
5999 .endd
6000 This &(appendfile)& transport is used for local delivery to user mailboxes in
6001 traditional BSD mailbox format. By default it runs under the uid and gid of the
6002 local user, which requires the sticky bit to be set on the &_/var/mail_&
6003 directory. Some systems use the alternative approach of running mail deliveries
6004 under a particular group instead of using the sticky bit. The commented options
6005 show how this can be done.
6006
6007 Exim adds three headers to the message as it delivers it: &'Delivery-date:'&,
6008 &'Envelope-to:'& and &'Return-path:'&. This action is requested by the three
6009 similarly-named options above.
6010 .code
6011 address_pipe:
6012   driver = pipe
6013   return_output
6014 .endd
6015 This transport is used for handling deliveries to pipes that are generated by
6016 redirection (aliasing or users' &_.forward_& files). The &%return_output%&
6017 option specifies that any output generated by the pipe is to be returned to the
6018 sender.
6019 .code
6020 address_file:
6021   driver = appendfile
6022   delivery_date_add
6023   envelope_to_add
6024   return_path_add
6025 .endd
6026 This transport is used for handling deliveries to files that are generated by
6027 redirection. The name of the file is not specified in this instance of
6028 &(appendfile)&, because it comes from the &(redirect)& router.
6029 .code
6030 address_reply:
6031   driver = autoreply
6032 .endd
6033 This transport is used for handling automatic replies generated by users'
6034 filter files.
6035
6036
6037
6038 .section "Default retry rule" "SECID57"
6039 .cindex "retry" "default rule"
6040 .cindex "default" "retry rule"
6041 The retry section of the configuration file contains rules which affect the way
6042 Exim retries deliveries that cannot be completed at the first attempt. It is
6043 introduced by the line
6044 .code
6045 begin retry
6046 .endd
6047 In the default configuration, there is just one rule, which applies to all
6048 errors:
6049 .code
6050 *   *   F,2h,15m; G,16h,1h,1.5; F,4d,6h
6051 .endd
6052 This causes any temporarily failing address to be retried every 15 minutes for
6053 2 hours, then at intervals starting at one hour and increasing by a factor of
6054 1.5 until 16 hours have passed, then every 6 hours up to 4 days. If an address
6055 is not delivered after 4 days of temporary failure, it is bounced.
6056
6057 If the retry section is removed from the configuration, or is empty (that is,
6058 if no retry rules are defined), Exim will not retry deliveries. This turns
6059 temporary errors into permanent errors.
6060
6061
6062 .section "Rewriting configuration" "SECID58"
6063 The rewriting section of the configuration, introduced by
6064 .code
6065 begin rewrite
6066 .endd
6067 contains rules for rewriting addresses in messages as they arrive. There are no
6068 rewriting rules in the default configuration file.
6069
6070
6071
6072 .section "Authenticators configuration" "SECTdefconfauth"
6073 .cindex "AUTH" "configuration"
6074 The authenticators section of the configuration, introduced by
6075 .code
6076 begin authenticators
6077 .endd
6078 defines mechanisms for the use of the SMTP AUTH command. The default
6079 configuration file contains two commented-out example authenticators
6080 which support plaintext username/password authentication using the
6081 standard PLAIN mechanism and the traditional but non-standard LOGIN
6082 mechanism, with Exim acting as the server. PLAIN and LOGIN are enough
6083 to support most MUA software.
6084
6085 The example PLAIN authenticator looks like this:
6086 .code
6087 #PLAIN:
6088 #  driver                  = plaintext
6089 #  server_set_id           = $auth2
6090 #  server_prompts          = :
6091 #  server_condition        = Authentication is not yet configured
6092 #  server_advertise_condition = ${if def:tls_in_cipher }
6093 .endd
6094 And the example LOGIN authenticator looks like this:
6095 .code
6096 #LOGIN:
6097 #  driver                  = plaintext
6098 #  server_set_id           = $auth1
6099 #  server_prompts          = <| Username: | Password:
6100 #  server_condition        = Authentication is not yet configured
6101 #  server_advertise_condition = ${if def:tls_in_cipher }
6102 .endd
6103
6104 The &%server_set_id%& option makes Exim remember the authenticated username
6105 in &$authenticated_id$&, which can be used later in ACLs or routers. The
6106 &%server_prompts%& option configures the &(plaintext)& authenticator so
6107 that it implements the details of the specific authentication mechanism,
6108 i.e. PLAIN or LOGIN. The &%server_advertise_condition%& setting controls
6109 when Exim offers authentication to clients; in the examples, this is only
6110 when TLS or SSL has been started, so to enable the authenticators you also
6111 need to add support for TLS as described in section &<<SECTdefconfmain>>&.
6112
6113 The &%server_condition%& setting defines how to verify that the username and
6114 password are correct. In the examples it just produces an error message.
6115 To make the authenticators work, you can use a string expansion
6116 expression like one of the examples in chapter &<<CHAPplaintext>>&.
6117
6118 Beware that the sequence of the parameters to PLAIN and LOGIN differ; the
6119 usercode and password are in different positions.
6120 Chapter &<<CHAPplaintext>>& covers both.
6121
6122 .ecindex IIDconfiwal
6123
6124
6125
6126 . ////////////////////////////////////////////////////////////////////////////
6127 . ////////////////////////////////////////////////////////////////////////////
6128
6129 .chapter "Regular expressions" "CHAPregexp"
6130
6131 .cindex "regular expressions" "library"
6132 .cindex "PCRE"
6133 Exim supports the use of regular expressions in many of its options. It
6134 uses the PCRE regular expression library; this provides regular expression
6135 matching that is compatible with Perl 5. The syntax and semantics of
6136 regular expressions is discussed in many Perl reference books, and also in
6137 Jeffrey Friedl's &'Mastering Regular Expressions'&, which is published by
6138 O'Reilly (see &url(http://www.oreilly.com/catalog/regex2/)).
6139
6140 The documentation for the syntax and semantics of the regular expressions that
6141 are supported by PCRE is included in the PCRE distribution, and no further
6142 description is included here. The PCRE functions are called from Exim using
6143 the default option settings (that is, with no PCRE options set), except that
6144 the PCRE_CASELESS option is set when the matching is required to be
6145 case-insensitive.
6146
6147 In most cases, when a regular expression is required in an Exim configuration,
6148 it has to start with a circumflex, in order to distinguish it from plain text
6149 or an &"ends with"& wildcard. In this example of a configuration setting, the
6150 second item in the colon-separated list is a regular expression.
6151 .code
6152 domains = a.b.c : ^\\d{3} : *.y.z : ...
6153 .endd
6154 The doubling of the backslash is required because of string expansion that
6155 precedes interpretation &-- see section &<<SECTlittext>>& for more discussion
6156 of this issue, and a way of avoiding the need for doubling backslashes. The
6157 regular expression that is eventually used in this example contains just one
6158 backslash. The circumflex is included in the regular expression, and has the
6159 normal effect of &"anchoring"& it to the start of the string that is being
6160 matched.
6161
6162 There are, however, two cases where a circumflex is not required for the
6163 recognition of a regular expression: these are the &%match%& condition in a
6164 string expansion, and the &%matches%& condition in an Exim filter file. In
6165 these cases, the relevant string is always treated as a regular expression; if
6166 it does not start with a circumflex, the expression is not anchored, and can
6167 match anywhere in the subject string.
6168
6169 In all cases, if you want a regular expression to match at the end of a string,
6170 you must code the $ metacharacter to indicate this. For example:
6171 .code
6172 domains = ^\\d{3}\\.example
6173 .endd
6174 matches the domain &'123.example'&, but it also matches &'123.example.com'&.
6175 You need to use:
6176 .code
6177 domains = ^\\d{3}\\.example\$
6178 .endd
6179 if you want &'example'& to be the top-level domain. The backslash before the
6180 $ is needed because string expansion also interprets dollar characters.
6181
6182
6183
6184 . ////////////////////////////////////////////////////////////////////////////
6185 . ////////////////////////////////////////////////////////////////////////////
6186
6187 .chapter "File and database lookups" "CHAPfdlookup"
6188 .scindex IIDfidalo1 "file" "lookups"
6189 .scindex IIDfidalo2 "database" "lookups"
6190 .cindex "lookup" "description of"
6191 Exim can be configured to look up data in files or databases as it processes
6192 messages. Two different kinds of syntax are used:
6193
6194 .olist
6195 A string that is to be expanded may contain explicit lookup requests. These
6196 cause parts of the string to be replaced by data that is obtained from the
6197 lookup. Lookups of this type are conditional expansion items. Different results
6198 can be defined for the cases of lookup success and failure. See chapter
6199 &<<CHAPexpand>>&, where string expansions are described in detail.
6200 .next
6201 Lists of domains, hosts, and email addresses can contain lookup requests as a
6202 way of avoiding excessively long linear lists. In this case, the data that is
6203 returned by the lookup is often (but not always) discarded; whether the lookup
6204 succeeds or fails is what really counts. These kinds of list are described in
6205 chapter &<<CHAPdomhosaddlists>>&.
6206 .endlist
6207
6208 String expansions, lists, and lookups interact with each other in such a way
6209 that there is no order in which to describe any one of them that does not
6210 involve references to the others. Each of these three chapters makes more sense
6211 if you have read the other two first. If you are reading this for the first
6212 time, be aware that some of it will make a lot more sense after you have read
6213 chapters &<<CHAPdomhosaddlists>>& and &<<CHAPexpand>>&.
6214
6215 .section "Examples of different lookup syntax" "SECID60"
6216 It is easy to confuse the two different kinds of lookup, especially as the
6217 lists that may contain the second kind are always expanded before being
6218 processed as lists. Therefore, they may also contain lookups of the first kind.
6219 Be careful to distinguish between the following two examples:
6220 .code
6221 domains = ${lookup{$sender_host_address}lsearch{/some/file}}
6222 domains = lsearch;/some/file
6223 .endd
6224 The first uses a string expansion, the result of which must be a domain list.
6225 No strings have been specified for a successful or a failing lookup; the
6226 defaults in this case are the looked-up data and an empty string, respectively.
6227 The expansion takes place before the string is processed as a list, and the
6228 file that is searched could contain lines like this:
6229 .code
6230 192.168.3.4: domain1:domain2:...
6231 192.168.1.9: domain3:domain4:...
6232 .endd
6233 When the lookup succeeds, the result of the expansion is a list of domains (and
6234 possibly other types of item that are allowed in domain lists).
6235
6236 In the second example, the lookup is a single item in a domain list. It causes
6237 Exim to use a lookup to see if the domain that is being processed can be found
6238 in the file. The file could contains lines like this:
6239 .code
6240 domain1:
6241 domain2:
6242 .endd
6243 Any data that follows the keys is not relevant when checking that the domain
6244 matches the list item.
6245
6246 It is possible, though no doubt confusing, to use both kinds of lookup at once.
6247 Consider a file containing lines like this:
6248 .code
6249 192.168.5.6: lsearch;/another/file
6250 .endd
6251 If the value of &$sender_host_address$& is 192.168.5.6, expansion of the
6252 first &%domains%& setting above generates the second setting, which therefore
6253 causes a second lookup to occur.
6254
6255 The rest of this chapter describes the different lookup types that are
6256 available. Any of them can be used in any part of the configuration where a
6257 lookup is permitted.
6258
6259
6260 .section "Lookup types" "SECID61"
6261 .cindex "lookup" "types of"
6262 .cindex "single-key lookup" "definition of"
6263 Two different types of data lookup are implemented:
6264
6265 .ilist
6266 The &'single-key'& type requires the specification of a file in which to look,
6267 and a single key to search for. The key must be a non-empty string for the
6268 lookup to succeed. The lookup type determines how the file is searched.
6269 .next
6270 .cindex "query-style lookup" "definition of"
6271 The &'query-style'& type accepts a generalized database query. No particular
6272 key value is assumed by Exim for query-style lookups. You can use whichever
6273 Exim variables you need to construct the database query.
6274 .endlist
6275
6276 The code for each lookup type is in a separate source file that is included in
6277 the binary of Exim only if the corresponding compile-time option is set. The
6278 default settings in &_src/EDITME_& are:
6279 .code
6280 LOOKUP_DBM=yes
6281 LOOKUP_LSEARCH=yes
6282 .endd
6283 which means that only linear searching and DBM lookups are included by default.
6284 For some types of lookup (e.g. SQL databases), you need to install appropriate
6285 libraries and header files before building Exim.
6286
6287
6288
6289
6290 .section "Single-key lookup types" "SECTsinglekeylookups"
6291 .cindex "lookup" "single-key types"
6292 .cindex "single-key lookup" "list of types"
6293 The following single-key lookup types are implemented:
6294
6295 .ilist
6296 .cindex "cdb" "description of"
6297 .cindex "lookup" "cdb"
6298 .cindex "binary zero" "in lookup key"
6299 &(cdb)&: The given file is searched as a Constant DataBase file, using the key
6300 string without a terminating binary zero. The cdb format is designed for
6301 indexed files that are read frequently and never updated, except by total
6302 re-creation. As such, it is particularly suitable for large files containing
6303 aliases or other indexed data referenced by an MTA. Information about cdb can
6304 be found in several places:
6305 .display
6306 &url(http://www.pobox.com/~djb/cdb.html)
6307 &url(ftp://ftp.corpit.ru/pub/tinycdb/)
6308 &url(http://packages.debian.org/stable/utils/freecdb.html)
6309 .endd
6310 A cdb distribution is not needed in order to build Exim with cdb support,
6311 because the code for reading cdb files is included directly in Exim itself.
6312 However, no means of building or testing cdb files is provided with Exim, so
6313 you need to obtain a cdb distribution in order to do this.
6314 .next
6315 .cindex "DBM" "lookup type"
6316 .cindex "lookup" "dbm"
6317 .cindex "binary zero" "in lookup key"
6318 &(dbm)&: Calls to DBM library functions are used to extract data from the given
6319 DBM file by looking up the record with the given key. A terminating binary
6320 zero is included in the key that is passed to the DBM library. See section
6321 &<<SECTdb>>& for a discussion of DBM libraries.
6322
6323 .cindex "Berkeley DB library" "file format"
6324 For all versions of Berkeley DB, Exim uses the DB_HASH style of database
6325 when building DBM files using the &%exim_dbmbuild%& utility. However, when
6326 using Berkeley DB versions 3 or 4, it opens existing databases for reading with
6327 the DB_UNKNOWN option. This enables it to handle any of the types of database
6328 that the library supports, and can be useful for accessing DBM files created by
6329 other applications. (For earlier DB versions, DB_HASH is always used.)
6330 .next
6331 .cindex "lookup" "dbmjz"
6332 .cindex "lookup" "dbm &-- embedded NULs"
6333 .cindex "sasldb2"
6334 .cindex "dbmjz lookup type"
6335 &(dbmjz)&: This is the same as &(dbm)&, except that the lookup key is
6336 interpreted as an Exim list; the elements of the list are joined together with
6337 ASCII NUL characters to form the lookup key.  An example usage would be to
6338 authenticate incoming SMTP calls using the passwords from Cyrus SASL's
6339 &_/etc/sasldb2_& file with the &(gsasl)& authenticator or Exim's own
6340 &(cram_md5)& authenticator.
6341 .next
6342 .cindex "lookup" "dbmnz"
6343 .cindex "lookup" "dbm &-- terminating zero"
6344 .cindex "binary zero" "in lookup key"
6345 .cindex "Courier"
6346 .cindex "&_/etc/userdbshadow.dat_&"
6347 .cindex "dbmnz lookup type"
6348 &(dbmnz)&: This is the same as &(dbm)&, except that a terminating binary zero
6349 is not included in the key that is passed to the DBM library. You may need this
6350 if you want to look up data in files that are created by or shared with some
6351 other application that does not use terminating zeros. For example, you need to
6352 use &(dbmnz)& rather than &(dbm)& if you want to authenticate incoming SMTP
6353 calls using the passwords from Courier's &_/etc/userdbshadow.dat_& file. Exim's
6354 utility program for creating DBM files (&'exim_dbmbuild'&) includes the zeros
6355 by default, but has an option to omit them (see section &<<SECTdbmbuild>>&).
6356 .next
6357 .cindex "lookup" "dsearch"
6358 .cindex "dsearch lookup type"
6359 &(dsearch)&: The given file must be a directory; this is searched for an entry
6360 whose name is the key by calling the &[lstat()]& function. The key may not
6361 contain any forward slash characters. If &[lstat()]& succeeds, the result of
6362 the lookup is the name of the entry, which may be a file, directory,
6363 symbolic link, or any other kind of directory entry. An example of how this
6364 lookup can be used to support virtual domains is given in section
6365 &<<SECTvirtualdomains>>&.
6366 .next
6367 .cindex "lookup" "iplsearch"
6368 .cindex "iplsearch lookup type"
6369 &(iplsearch)&: The given file is a text file containing keys and data. A key is
6370 terminated by a colon or white space or the end of the line. The keys in the
6371 file must be IP addresses, or IP addresses with CIDR masks. Keys that involve
6372 IPv6 addresses must be enclosed in quotes to prevent the first internal colon
6373 being interpreted as a key terminator. For example:
6374 .code
6375 1.2.3.4:           data for 1.2.3.4
6376 192.168.0.0/16:    data for 192.168.0.0/16
6377 "abcd::cdab":      data for abcd::cdab
6378 "abcd:abcd::/32"   data for abcd:abcd::/32
6379 .endd
6380 The key for an &(iplsearch)& lookup must be an IP address (without a mask). The
6381 file is searched linearly, using the CIDR masks where present, until a matching
6382 key is found. The first key that matches is used; there is no attempt to find a
6383 &"best"& match. Apart from the way the keys are matched, the processing for
6384 &(iplsearch)& is the same as for &(lsearch)&.
6385
6386 &*Warning 1*&: Unlike most other single-key lookup types, a file of data for
6387 &(iplsearch)& can &'not'& be turned into a DBM or cdb file, because those
6388 lookup types support only literal keys.
6389
6390 &*Warning 2*&: In a host list, you must always use &(net-iplsearch)& so that
6391 the implicit key is the host's IP address rather than its name (see section
6392 &<<SECThoslispatsikey>>&).
6393 .next
6394 .cindex "linear search"
6395 .cindex "lookup" "lsearch"
6396 .cindex "lsearch lookup type"
6397 .cindex "case sensitivity" "in lsearch lookup"
6398 &(lsearch)&: The given file is a text file that is searched linearly for a
6399 line beginning with the search key, terminated by a colon or white space or the
6400 end of the line. The search is case-insensitive; that is, upper and lower case
6401 letters are treated as the same. The first occurrence of the key that is found
6402 in the file is used.
6403
6404 White space between the key and the colon is permitted. The remainder of the
6405 line, with leading and trailing white space removed, is the data. This can be
6406 continued onto subsequent lines by starting them with any amount of white
6407 space, but only a single space character is included in the data at such a
6408 junction. If the data begins with a colon, the key must be terminated by a
6409 colon, for example:
6410 .code
6411 baduser:  :fail:
6412 .endd
6413 Empty lines and lines beginning with # are ignored, even if they occur in the
6414 middle of an item. This is the traditional textual format of alias files. Note
6415 that the keys in an &(lsearch)& file are literal strings. There is no
6416 wildcarding of any kind.
6417
6418 .cindex "lookup" "lsearch &-- colons in keys"
6419 .cindex "white space" "in lsearch key"
6420 In most &(lsearch)& files, keys are not required to contain colons or #
6421 characters, or white space. However, if you need this feature, it is available.
6422 If a key begins with a doublequote character, it is terminated only by a
6423 matching quote (or end of line), and the normal escaping rules apply to its
6424 contents (see section &<<SECTstrings>>&). An optional colon is permitted after
6425 quoted keys (exactly as for unquoted keys). There is no special handling of
6426 quotes for the data part of an &(lsearch)& line.
6427
6428 .next
6429 .cindex "NIS lookup type"
6430 .cindex "lookup" "NIS"
6431 .cindex "binary zero" "in lookup key"
6432 &(nis)&: The given file is the name of a NIS map, and a NIS lookup is done with
6433 the given key, without a terminating binary zero. There is a variant called
6434 &(nis0)& which does include the terminating binary zero in the key. This is
6435 reportedly needed for Sun-style alias files. Exim does not recognize NIS
6436 aliases; the full map names must be used.
6437
6438 .next
6439 .cindex "wildlsearch lookup type"
6440 .cindex "lookup" "wildlsearch"
6441 .cindex "nwildlsearch lookup type"
6442 .cindex "lookup" "nwildlsearch"
6443 &(wildlsearch)& or &(nwildlsearch)&: These search a file linearly, like
6444 &(lsearch)&, but instead of being interpreted as a literal string, each key in
6445 the file may be wildcarded. The difference between these two lookup types is
6446 that for &(wildlsearch)&, each key in the file is string-expanded before being
6447 used, whereas for &(nwildlsearch)&, no expansion takes place.
6448
6449 .cindex "case sensitivity" "in (n)wildlsearch lookup"
6450 Like &(lsearch)&, the testing is done case-insensitively. However, keys in the
6451 file that are regular expressions can be made case-sensitive by the use of
6452 &`(-i)`& within the pattern. The following forms of wildcard are recognized:
6453
6454 . ==== As this is a nested list, any displays it contains must be indented
6455 . ==== as otherwise they are too far to the left.
6456
6457 .olist
6458 The string may begin with an asterisk to mean &"ends with"&. For example:
6459 .code
6460     *.a.b.c       data for anything.a.b.c
6461     *fish         data for anythingfish
6462 .endd
6463 .next
6464 The string may begin with a circumflex to indicate a regular expression. For
6465 example, for &(wildlsearch)&:
6466 .code
6467     ^\N\d+\.a\.b\N    data for <digits>.a.b
6468 .endd
6469 Note the use of &`\N`& to disable expansion of the contents of the regular
6470 expression. If you are using &(nwildlsearch)&, where the keys are not
6471 string-expanded, the equivalent entry is:
6472 .code
6473     ^\d+\.a\.b        data for <digits>.a.b
6474 .endd
6475 The case-insensitive flag is set at the start of compiling the regular
6476 expression, but it can be turned off by using &`(-i)`& at an appropriate point.
6477 For example, to make the entire pattern case-sensitive:
6478 .code
6479     ^(?-i)\d+\.a\.b        data for <digits>.a.b
6480 .endd
6481
6482 If the regular expression contains white space or colon characters, you must
6483 either quote it (see &(lsearch)& above), or represent these characters in other
6484 ways. For example, &`\s`& can be used for white space and &`\x3A`& for a
6485 colon. This may be easier than quoting, because if you quote, you have to
6486 escape all the backslashes inside the quotes.
6487
6488 &*Note*&: It is not possible to capture substrings in a regular expression
6489 match for later use, because the results of all lookups are cached. If a lookup
6490 is repeated, the result is taken from the cache, and no actual pattern matching
6491 takes place. The values of all the numeric variables are unset after a
6492 &((n)wildlsearch)& match.
6493
6494 .next
6495 Although I cannot see it being of much use, the general matching function that
6496 is used to implement &((n)wildlsearch)& means that the string may begin with a
6497 lookup name terminated by a semicolon, and followed by lookup data. For
6498 example:
6499 .code
6500     cdb;/some/file  data for keys that match the file
6501 .endd
6502 The data that is obtained from the nested lookup is discarded.
6503 .endlist olist
6504
6505 Keys that do not match any of these patterns are interpreted literally. The
6506 continuation rules for the data are the same as for &(lsearch)&, and keys may
6507 be followed by optional colons.
6508
6509 &*Warning*&: Unlike most other single-key lookup types, a file of data for
6510 &((n)wildlsearch)& can &'not'& be turned into a DBM or cdb file, because those
6511 lookup types support only literal keys.
6512 .endlist ilist
6513
6514
6515 .section "Query-style lookup types" "SECID62"
6516 .cindex "lookup" "query-style types"
6517 .cindex "query-style lookup" "list of types"
6518 The supported query-style lookup types are listed below. Further details about
6519 many of them are given in later sections.
6520
6521 .ilist
6522 .cindex "DNS" "as a lookup type"
6523 .cindex "lookup" "DNS"
6524 &(dnsdb)&: This does a DNS search for one or more records whose domain names
6525 are given in the supplied query. The resulting data is the contents of the
6526 records. See section &<<SECTdnsdb>>&.
6527 .next
6528 .cindex "InterBase lookup type"
6529 .cindex "lookup" "InterBase"
6530 &(ibase)&: This does a lookup in an InterBase database.
6531 .next
6532 .cindex "LDAP" "lookup type"
6533 .cindex "lookup" "LDAP"
6534 &(ldap)&: This does an LDAP lookup using a query in the form of a URL, and
6535 returns attributes from a single entry. There is a variant called &(ldapm)&
6536 that permits values from multiple entries to be returned. A third variant
6537 called &(ldapdn)& returns the Distinguished Name of a single entry instead of
6538 any attribute values. See section &<<SECTldap>>&.
6539 .next
6540 .cindex "MySQL" "lookup type"
6541 .cindex "lookup" "MySQL"
6542 &(mysql)&: The format of the query is an SQL statement that is passed to a
6543 MySQL database. See section &<<SECTsql>>&.
6544 .next
6545 .cindex "NIS+ lookup type"
6546 .cindex "lookup" "NIS+"
6547 &(nisplus)&: This does a NIS+ lookup using a query that can specify the name of
6548 the field to be returned. See section &<<SECTnisplus>>&.
6549 .next
6550 .cindex "Oracle" "lookup type"
6551 .cindex "lookup" "Oracle"
6552 &(oracle)&: The format of the query is an SQL statement that is passed to an
6553 Oracle database. See section &<<SECTsql>>&.
6554 .next
6555 .cindex "lookup" "passwd"
6556 .cindex "passwd lookup type"
6557 .cindex "&_/etc/passwd_&"
6558 &(passwd)& is a query-style lookup with queries that are just user names. The
6559 lookup calls &[getpwnam()]& to interrogate the system password data, and on
6560 success, the result string is the same as you would get from an &(lsearch)&
6561 lookup on a traditional &_/etc/passwd file_&, though with &`*`& for the
6562 password value. For example:
6563 .code
6564 *:42:42:King Rat:/home/kr:/bin/bash
6565 .endd
6566 .next
6567 .cindex "PostgreSQL lookup type"
6568 .cindex "lookup" "PostgreSQL"
6569 &(pgsql)&: The format of the query is an SQL statement that is passed to a
6570 PostgreSQL database. See section &<<SECTsql>>&.
6571
6572 .next
6573 .cindex "sqlite lookup type"
6574 .cindex "lookup" "sqlite"
6575 &(sqlite)&: The format of the query is a file name followed by an SQL statement
6576 that is passed to an SQLite database. See section &<<SECTsqlite>>&.
6577
6578 .next
6579 &(testdb)&: This is a lookup type that is used for testing Exim. It is
6580 not likely to be useful in normal operation.
6581 .next
6582 .cindex "whoson lookup type"
6583 .cindex "lookup" "whoson"
6584 &(whoson)&: &'Whoson'& (&url(http://whoson.sourceforge.net)) is a protocol that
6585 allows a server to check whether a particular (dynamically allocated) IP
6586 address is currently allocated to a known (trusted) user and, optionally, to
6587 obtain the identity of the said user. For SMTP servers, &'Whoson'& was popular
6588 at one time for &"POP before SMTP"& authentication, but that approach has been
6589 superseded by SMTP authentication. In Exim, &'Whoson'& can be used to implement
6590 &"POP before SMTP"& checking using ACL statements such as
6591 .code
6592 require condition = \
6593   ${lookup whoson {$sender_host_address}{yes}{no}}
6594 .endd
6595 The query consists of a single IP address. The value returned is the name of
6596 the authenticated user, which is stored in the variable &$value$&. However, in
6597 this example, the data in &$value$& is not used; the result of the lookup is
6598 one of the fixed strings &"yes"& or &"no"&.
6599 .endlist
6600
6601
6602
6603 .section "Temporary errors in lookups" "SECID63"
6604 .cindex "lookup" "temporary error in"
6605 Lookup functions can return temporary error codes if the lookup cannot be
6606 completed. For example, an SQL or LDAP database might be unavailable. For this
6607 reason, it is not advisable to use a lookup that might do this for critical
6608 options such as a list of local domains.
6609
6610 When a lookup cannot be completed in a router or transport, delivery
6611 of the message (to the relevant address) is deferred, as for any other
6612 temporary error. In other circumstances Exim may assume the lookup has failed,
6613 or may give up altogether.
6614
6615
6616
6617 .section "Default values in single-key lookups" "SECTdefaultvaluelookups"
6618 .cindex "wildcard lookups"
6619 .cindex "lookup" "default values"
6620 .cindex "lookup" "wildcard"
6621 .cindex "lookup" "* added to type"
6622 .cindex "default" "in single-key lookups"
6623 In this context, a &"default value"& is a value specified by the administrator
6624 that is to be used if a lookup fails.
6625
6626 &*Note:*& This section applies only to single-key lookups. For query-style
6627 lookups, the facilities of the query language must be used. An attempt to
6628 specify a default for a query-style lookup provokes an error.
6629
6630 If &"*"& is added to a single-key lookup type (for example, &%lsearch*%&)
6631 and the initial lookup fails, the key &"*"& is looked up in the file to
6632 provide a default value. See also the section on partial matching below.
6633
6634 .cindex "*@ with single-key lookup"
6635 .cindex "lookup" "*@ added to type"
6636 .cindex "alias file" "per-domain default"
6637 Alternatively, if &"*@"& is added to a single-key lookup type (for example
6638 &%dbm*@%&) then, if the initial lookup fails and the key contains an @
6639 character, a second lookup is done with everything before the last @ replaced
6640 by *. This makes it possible to provide per-domain defaults in alias files
6641 that include the domains in the keys. If the second lookup fails (or doesn't
6642 take place because there is no @ in the key), &"*"& is looked up.
6643 For example, a &(redirect)& router might contain:
6644 .code
6645 data = ${lookup{$local_part@$domain}lsearch*@{/etc/mix-aliases}}
6646 .endd
6647 Suppose the address that is being processed is &'jane@eyre.example'&. Exim
6648 looks up these keys, in this order:
6649 .code
6650 jane@eyre.example
6651 *@eyre.example
6652 *
6653 .endd
6654 The data is taken from whichever key it finds first. &*Note*&: In an
6655 &(lsearch)& file, this does not mean the first of these keys in the file. A
6656 complete scan is done for each key, and only if it is not found at all does
6657 Exim move on to try the next key.
6658
6659
6660
6661 .section "Partial matching in single-key lookups" "SECTpartiallookup"
6662 .cindex "partial matching"
6663 .cindex "wildcard lookups"
6664 .cindex "lookup" "partial matching"
6665 .cindex "lookup" "wildcard"
6666 .cindex "asterisk" "in search type"
6667 The normal operation of a single-key lookup is to search the file for an exact
6668 match with the given key. However, in a number of situations where domains are
6669 being looked up, it is useful to be able to do partial matching. In this case,
6670 information in the file that has a key starting with &"*."& is matched by any
6671 domain that ends with the components that follow the full stop. For example, if
6672 a key in a DBM file is
6673 .code
6674 *.dates.fict.example
6675 .endd
6676 then when partial matching is enabled this is matched by (amongst others)
6677 &'2001.dates.fict.example'& and &'1984.dates.fict.example'&. It is also matched
6678 by &'dates.fict.example'&, if that does not appear as a separate key in the
6679 file.
6680
6681 &*Note*&: Partial matching is not available for query-style lookups. It is
6682 also not available for any lookup items in address lists (see section
6683 &<<SECTaddresslist>>&).
6684
6685 Partial matching is implemented by doing a series of separate lookups using
6686 keys constructed by modifying the original subject key. This means that it can
6687 be used with any of the single-key lookup types, provided that
6688 partial matching keys
6689 beginning with a special prefix (default &"*."&) are included in the data file.
6690 Keys in the file that do not begin with the prefix are matched only by
6691 unmodified subject keys when partial matching is in use.
6692
6693 Partial matching is requested by adding the string &"partial-"& to the front of
6694 the name of a single-key lookup type, for example, &%partial-dbm%&. When this
6695 is done, the subject key is first looked up unmodified; if that fails, &"*."&
6696 is added at the start of the subject key, and it is looked up again. If that
6697 fails, further lookups are tried with dot-separated components removed from the
6698 start of the subject key, one-by-one, and &"*."& added on the front of what
6699 remains.
6700
6701 A minimum number of two non-* components are required. This can be adjusted
6702 by including a number before the hyphen in the search type. For example,
6703 &%partial3-lsearch%& specifies a minimum of three non-* components in the
6704 modified keys. Omitting the number is equivalent to &"partial2-"&. If the
6705 subject key is &'2250.dates.fict.example'& then the following keys are looked
6706 up when the minimum number of non-* components is two:
6707 .code
6708 2250.dates.fict.example
6709 *.2250.dates.fict.example
6710 *.dates.fict.example
6711 *.fict.example
6712 .endd
6713 As soon as one key in the sequence is successfully looked up, the lookup
6714 finishes.
6715
6716 .cindex "lookup" "partial matching &-- changing prefix"
6717 .cindex "prefix" "for partial matching"
6718 The use of &"*."& as the partial matching prefix is a default that can be
6719 changed. The motivation for this feature is to allow Exim to operate with file
6720 formats that are used by other MTAs. A different prefix can be supplied in
6721 parentheses instead of the hyphen after &"partial"&. For example:
6722 .code
6723 domains = partial(.)lsearch;/some/file
6724 .endd
6725 In this example, if the domain is &'a.b.c'&, the sequence of lookups is
6726 &`a.b.c`&, &`.a.b.c`&, and &`.b.c`& (the default minimum of 2 non-wild
6727 components is unchanged). The prefix may consist of any punctuation characters
6728 other than a closing parenthesis. It may be empty, for example:
6729 .code
6730 domains = partial1()cdb;/some/file
6731 .endd
6732 For this example, if the domain is &'a.b.c'&, the sequence of lookups is
6733 &`a.b.c`&, &`b.c`&, and &`c`&.
6734
6735 If &"partial0"& is specified, what happens at the end (when the lookup with
6736 just one non-wild component has failed, and the original key is shortened right
6737 down to the null string) depends on the prefix:
6738
6739 .ilist
6740 If the prefix has zero length, the whole lookup fails.
6741 .next
6742 If the prefix has length 1, a lookup for just the prefix is done. For
6743 example, the final lookup for &"partial0(.)"& is for &`.`& alone.
6744 .next
6745 Otherwise, if the prefix ends in a dot, the dot is removed, and the
6746 remainder is looked up. With the default prefix, therefore, the final lookup is
6747 for &"*"& on its own.
6748 .next
6749 Otherwise, the whole prefix is looked up.
6750 .endlist
6751
6752
6753 If the search type ends in &"*"& or &"*@"& (see section
6754 &<<SECTdefaultvaluelookups>>& above), the search for an ultimate default that
6755 this implies happens after all partial lookups have failed. If &"partial0"& is
6756 specified, adding &"*"& to the search type has no effect with the default
6757 prefix, because the &"*"& key is already included in the sequence of partial
6758 lookups. However, there might be a use for lookup types such as
6759 &"partial0(.)lsearch*"&.
6760
6761 The use of &"*"& in lookup partial matching differs from its use as a wildcard
6762 in domain lists and the like. Partial matching works only in terms of
6763 dot-separated components; a key such as &`*fict.example`&
6764 in a database file is useless, because the asterisk in a partial matching
6765 subject key is always followed by a dot.
6766
6767
6768
6769
6770 .section "Lookup caching" "SECID64"
6771 .cindex "lookup" "caching"
6772 .cindex "caching" "lookup data"
6773 Exim caches all lookup results in order to avoid needless repetition of
6774 lookups. However, because (apart from the daemon) Exim operates as a collection
6775 of independent, short-lived processes, this caching applies only within a
6776 single Exim process. There is no inter-process lookup caching facility.
6777
6778 For single-key lookups, Exim keeps the relevant files open in case there is
6779 another lookup that needs them. In some types of configuration this can lead to
6780 many files being kept open for messages with many recipients. To avoid hitting
6781 the operating system limit on the number of simultaneously open files, Exim
6782 closes the least recently used file when it needs to open more files than its
6783 own internal limit, which can be changed via the &%lookup_open_max%& option.
6784
6785 The single-key lookup files are closed and the lookup caches are flushed at
6786 strategic points during delivery &-- for example, after all routing is
6787 complete.
6788
6789
6790
6791
6792 .section "Quoting lookup data" "SECID65"
6793 .cindex "lookup" "quoting"
6794 .cindex "quoting" "in lookups"
6795 When data from an incoming message is included in a query-style lookup, there
6796 is the possibility of special characters in the data messing up the syntax of
6797 the query. For example, a NIS+ query that contains
6798 .code
6799 [name=$local_part]
6800 .endd
6801 will be broken if the local part happens to contain a closing square bracket.
6802 For NIS+, data can be enclosed in double quotes like this:
6803 .code
6804 [name="$local_part"]
6805 .endd
6806 but this still leaves the problem of a double quote in the data. The rule for
6807 NIS+ is that double quotes must be doubled. Other lookup types have different
6808 rules, and to cope with the differing requirements, an expansion operator
6809 of the following form is provided:
6810 .code
6811 ${quote_<lookup-type>:<string>}
6812 .endd
6813 For example, the safest way to write the NIS+ query is
6814 .code
6815 [name="${quote_nisplus:$local_part}"]
6816 .endd
6817 See chapter &<<CHAPexpand>>& for full coverage of string expansions. The quote
6818 operator can be used for all lookup types, but has no effect for single-key
6819 lookups, since no quoting is ever needed in their key strings.
6820
6821
6822
6823
6824 .section "More about dnsdb" "SECTdnsdb"
6825 .cindex "dnsdb lookup"
6826 .cindex "lookup" "dnsdb"
6827 .cindex "DNS" "as a lookup type"
6828 The &(dnsdb)& lookup type uses the DNS as its database. A simple query consists
6829 of a record type and a domain name, separated by an equals sign. For example,
6830 an expansion string could contain:
6831 .code
6832 ${lookup dnsdb{mx=a.b.example}{$value}fail}
6833 .endd
6834 If the lookup succeeds, the result is placed in &$value$&, which in this case
6835 is used on its own as the result. If the lookup does not succeed, the
6836 &`fail`& keyword causes a &'forced expansion failure'& &-- see section
6837 &<<SECTforexpfai>>& for an explanation of what this means.
6838
6839 The supported DNS record types are A, CNAME, MX, NS, PTR, SPF, SRV, and TXT,
6840 and, when Exim is compiled with IPv6 support, AAAA (and A6 if that is also
6841 configured). If no type is given, TXT is assumed. When the type is PTR,
6842 the data can be an IP address, written as normal; inversion and the addition of
6843 &%in-addr.arpa%& or &%ip6.arpa%& happens automatically. For example:
6844 .code
6845 ${lookup dnsdb{ptr=192.168.4.5}{$value}fail}
6846 .endd
6847 If the data for a PTR record is not a syntactically valid IP address, it is not
6848 altered and nothing is added.
6849
6850 .cindex "MX record" "in &(dnsdb)& lookup"
6851 .cindex "SRV record" "in &(dnsdb)& lookup"
6852 For an MX lookup, both the preference value and the host name are returned for
6853 each record, separated by a space. For an SRV lookup, the priority, weight,
6854 port, and host name are returned for each record, separated by spaces.
6855
6856 For any record type, if multiple records are found (or, for A6 lookups, if a
6857 single record leads to multiple addresses), the data is returned as a
6858 concatenation, with newline as the default separator. The order, of course,
6859 depends on the DNS resolver. You can specify a different separator character
6860 between multiple records by putting a right angle-bracket followed immediately
6861 by the new separator at the start of the query. For example:
6862 .code
6863 ${lookup dnsdb{>: a=host1.example}}
6864 .endd
6865 It is permitted to specify a space as the separator character. Further
6866 white space is ignored.
6867
6868 .cindex "TXT record" "in &(dnsdb)& lookup"
6869 .cindex "SPF record" "in &(dnsdb)& lookup"
6870 For TXT records with multiple items of data, only the first item is returned,
6871 unless a separator for them is specified using a comma after the separator
6872 character followed immediately by the TXT record item separator. To concatenate
6873 items without a separator, use a semicolon instead. For SPF records the
6874 default behaviour is to concatenate multiple items without using a separator.
6875 .code
6876 ${lookup dnsdb{>\n,: txt=a.b.example}}
6877 ${lookup dnsdb{>\n; txt=a.b.example}}
6878 ${lookup dnsdb{spf=example.org}}
6879 .endd
6880 It is permitted to specify a space as the separator character. Further
6881 white space is ignored.
6882
6883 .section "Pseudo dnsdb record types" "SECID66"
6884 .cindex "MX record" "in &(dnsdb)& lookup"
6885 By default, both the preference value and the host name are returned for
6886 each MX record, separated by a space. If you want only host names, you can use
6887 the pseudo-type MXH:
6888 .code
6889 ${lookup dnsdb{mxh=a.b.example}}
6890 .endd
6891 In this case, the preference values are omitted, and just the host names are
6892 returned.
6893
6894 .cindex "name server for enclosing domain"
6895 Another pseudo-type is ZNS (for &"zone NS"&). It performs a lookup for NS
6896 records on the given domain, but if none are found, it removes the first
6897 component of the domain name, and tries again. This process continues until NS
6898 records are found or there are no more components left (or there is a DNS
6899 error). In other words, it may return the name servers for a top-level domain,
6900 but it never returns the root name servers. If there are no NS records for the
6901 top-level domain, the lookup fails. Consider these examples:
6902 .code
6903 ${lookup dnsdb{zns=xxx.quercite.com}}
6904 ${lookup dnsdb{zns=xxx.edu}}
6905 .endd
6906 Assuming that in each case there are no NS records for the full domain name,
6907 the first returns the name servers for &%quercite.com%&, and the second returns
6908 the name servers for &%edu%&.
6909
6910 You should be careful about how you use this lookup because, unless the
6911 top-level domain does not exist, the lookup always returns some host names. The
6912 sort of use to which this might be put is for seeing if the name servers for a
6913 given domain are on a blacklist. You can probably assume that the name servers
6914 for the high-level domains such as &%com%& or &%co.uk%& are not going to be on
6915 such a list.
6916
6917 .cindex "CSA" "in &(dnsdb)& lookup"
6918 A third pseudo-type is CSA (Client SMTP Authorization). This looks up SRV
6919 records according to the CSA rules, which are described in section
6920 &<<SECTverifyCSA>>&. Although &(dnsdb)& supports SRV lookups directly, this is
6921 not sufficient because of the extra parent domain search behaviour of CSA. The
6922 result of a successful lookup such as:
6923 .code
6924 ${lookup dnsdb {csa=$sender_helo_name}}
6925 .endd
6926 has two space-separated fields: an authorization code and a target host name.
6927 The authorization code can be &"Y"& for yes, &"N"& for no, &"X"& for explicit
6928 authorization required but absent, or &"?"& for unknown.
6929
6930 .cindex "A+" "in &(dnsdb)& lookup"
6931 The pseudo-type A+ performs an A6 lookup (if configured) followed by an AAAA
6932 and then an A lookup.  All results are returned; defer processing
6933 (see below) is handled separately for each lookup.  Example:
6934 .code
6935 ${lookup dnsdb {>; a+=$sender_helo_name}}
6936 .endd
6937
6938
6939 .section "Multiple dnsdb lookups" "SECID67"
6940 In the previous sections, &(dnsdb)& lookups for a single domain are described.
6941 However, you can specify a list of domains or IP addresses in a single
6942 &(dnsdb)& lookup. The list is specified in the normal Exim way, with colon as
6943 the default separator, but with the ability to change this. For example:
6944 .code
6945 ${lookup dnsdb{one.domain.com:two.domain.com}}
6946 ${lookup dnsdb{a=one.host.com:two.host.com}}
6947 ${lookup dnsdb{ptr = <; 1.2.3.4 ; 4.5.6.8}}
6948 .endd
6949 In order to retain backwards compatibility, there is one special case: if
6950 the lookup type is PTR and no change of separator is specified, Exim looks
6951 to see if the rest of the string is precisely one IPv6 address. In this
6952 case, it does not treat it as a list.
6953
6954 The data from each lookup is concatenated, with newline separators by default,
6955 in the same way that multiple DNS records for a single item are handled. A
6956 different separator can be specified, as described above.
6957
6958 The &(dnsdb)& lookup fails only if all the DNS lookups fail. If there is a
6959 temporary DNS error for any of them, the behaviour is controlled by
6960 an optional keyword followed by a comma that may appear before the record
6961 type. The possible keywords are &"defer_strict"&, &"defer_never"&, and
6962 &"defer_lax"&. With &"strict"& behaviour, any temporary DNS error causes the
6963 whole lookup to defer. With &"never"& behaviour, a temporary DNS error is
6964 ignored, and the behaviour is as if the DNS lookup failed to find anything.
6965 With &"lax"& behaviour, all the queries are attempted, but a temporary DNS
6966 error causes the whole lookup to defer only if none of the other lookups
6967 succeed. The default is &"lax"&, so the following lookups are equivalent:
6968 .code
6969 ${lookup dnsdb{defer_lax,a=one.host.com:two.host.com}}
6970 ${lookup dnsdb{a=one.host.com:two.host.com}}
6971 .endd
6972 Thus, in the default case, as long as at least one of the DNS lookups
6973 yields some data, the lookup succeeds.
6974
6975
6976
6977
6978 .section "More about LDAP" "SECTldap"
6979 .cindex "LDAP" "lookup, more about"
6980 .cindex "lookup" "LDAP"
6981 .cindex "Solaris" "LDAP"
6982 The original LDAP implementation came from the University of Michigan; this has
6983 become &"Open LDAP"&, and there are now two different releases. Another
6984 implementation comes from Netscape, and Solaris 7 and subsequent releases
6985 contain inbuilt LDAP support. Unfortunately, though these are all compatible at
6986 the lookup function level, their error handling is different. For this reason
6987 it is necessary to set a compile-time variable when building Exim with LDAP, to
6988 indicate which LDAP library is in use. One of the following should appear in
6989 your &_Local/Makefile_&:
6990 .code
6991 LDAP_LIB_TYPE=UMICHIGAN
6992 LDAP_LIB_TYPE=OPENLDAP1
6993 LDAP_LIB_TYPE=OPENLDAP2
6994 LDAP_LIB_TYPE=NETSCAPE
6995 LDAP_LIB_TYPE=SOLARIS
6996 .endd
6997 If LDAP_LIB_TYPE is not set, Exim assumes &`OPENLDAP1`&, which has the
6998 same interface as the University of Michigan version.
6999
7000 There are three LDAP lookup types in Exim. These behave slightly differently in
7001 the way they handle the results of a query:
7002
7003 .ilist
7004 &(ldap)& requires the result to contain just one entry; if there are more, it
7005 gives an error.
7006 .next
7007 &(ldapdn)& also requires the result to contain just one entry, but it is the
7008 Distinguished Name that is returned rather than any attribute values.
7009 .next
7010 &(ldapm)& permits the result to contain more than one entry; the attributes
7011 from all of them are returned.
7012 .endlist
7013
7014
7015 For &(ldap)& and &(ldapm)&, if a query finds only entries with no attributes,
7016 Exim behaves as if the entry did not exist, and the lookup fails. The format of
7017 the data returned by a successful lookup is described in the next section.
7018 First we explain how LDAP queries are coded.
7019
7020
7021 .section "Format of LDAP queries" "SECTforldaque"
7022 .cindex "LDAP" "query format"
7023 An LDAP query takes the form of a URL as defined in RFC 2255. For example, in
7024 the configuration of a &(redirect)& router one might have this setting:
7025 .code
7026 data = ${lookup ldap \
7027   {ldap:///cn=$local_part,o=University%20of%20Cambridge,\
7028   c=UK?mailbox?base?}}
7029 .endd
7030 .cindex "LDAP" "with TLS"
7031 The URL may begin with &`ldap`& or &`ldaps`& if your LDAP library supports
7032 secure (encrypted) LDAP connections. The second of these ensures that an
7033 encrypted TLS connection is used.
7034
7035 With sufficiently modern LDAP libraries, Exim supports forcing TLS over regular
7036 LDAP connections, rather than the SSL-on-connect &`ldaps`&.
7037 See the &%ldap_start_tls%& option.
7038
7039
7040 .section "LDAP quoting" "SECID68"
7041 .cindex "LDAP" "quoting"
7042 Two levels of quoting are required in LDAP queries, the first for LDAP itself
7043 and the second because the LDAP query is represented as a URL. Furthermore,
7044 within an LDAP query, two different kinds of quoting are required. For this
7045 reason, there are two different LDAP-specific quoting operators.
7046
7047 The &%quote_ldap%& operator is designed for use on strings that are part of
7048 filter specifications. Conceptually, it first does the following conversions on
7049 the string:
7050 .code
7051 *   =>   \2A
7052 (   =>   \28
7053 )   =>   \29
7054 \   =>   \5C
7055 .endd
7056 in accordance with RFC 2254. The resulting string is then quoted according
7057 to the rules for URLs, that is, all non-alphanumeric characters except
7058 .code
7059 ! $ ' - . _ ( ) * +
7060 .endd
7061 are converted to their hex values, preceded by a percent sign. For example:
7062 .code
7063 ${quote_ldap: a(bc)*, a<yz>; }
7064 .endd
7065 yields
7066 .code
7067 %20a%5C28bc%5C29%5C2A%2C%20a%3Cyz%3E%3B%20
7068 .endd
7069 Removing the URL quoting, this is (with a leading and a trailing space):
7070 .code
7071 a\28bc\29\2A, a<yz>;
7072 .endd
7073 The &%quote_ldap_dn%& operator is designed for use on strings that are part of
7074 base DN specifications in queries. Conceptually, it first converts the string
7075 by inserting a backslash in front of any of the following characters:
7076 .code
7077 , + " \ < > ;
7078 .endd
7079 It also inserts a backslash before any leading spaces or # characters, and
7080 before any trailing spaces. (These rules are in RFC 2253.) The resulting string
7081 is then quoted according to the rules for URLs. For example:
7082 .code
7083 ${quote_ldap_dn: a(bc)*, a<yz>; }
7084 .endd
7085 yields
7086 .code
7087 %5C%20a(bc)*%5C%2C%20a%5C%3Cyz%5C%3E%5C%3B%5C%20
7088 .endd
7089 Removing the URL quoting, this is (with a trailing space):
7090 .code
7091 \ a(bc)*\, a\<yz\>\;\
7092 .endd
7093 There are some further comments about quoting in the section on LDAP
7094 authentication below.
7095
7096
7097 .section "LDAP connections" "SECID69"
7098 .cindex "LDAP" "connections"
7099 The connection to an LDAP server may either be over TCP/IP, or, when OpenLDAP
7100 is in use, via a Unix domain socket. The example given above does not specify
7101 an LDAP server. A server that is reached by TCP/IP can be specified in a query
7102 by starting it with
7103 .code
7104 ldap://<hostname>:<port>/...
7105 .endd
7106 If the port (and preceding colon) are omitted, the standard LDAP port (389) is
7107 used. When no server is specified in a query, a list of default servers is
7108 taken from the &%ldap_default_servers%& configuration option. This supplies a
7109 colon-separated list of servers which are tried in turn until one successfully
7110 handles a query, or there is a serious error. Successful handling either
7111 returns the requested data, or indicates that it does not exist. Serious errors
7112 are syntactical, or multiple values when only a single value is expected.
7113 Errors which cause the next server to be tried are connection failures, bind
7114 failures, and timeouts.
7115
7116 For each server name in the list, a port number can be given. The standard way
7117 of specifying a host and port is to use a colon separator (RFC 1738). Because
7118 &%ldap_default_servers%& is a colon-separated list, such colons have to be
7119 doubled. For example
7120 .code
7121 ldap_default_servers = ldap1.example.com::145:ldap2.example.com
7122 .endd
7123 If &%ldap_default_servers%& is unset, a URL with no server name is passed
7124 to the LDAP library with no server name, and the library's default (normally
7125 the local host) is used.
7126
7127 If you are using the OpenLDAP library, you can connect to an LDAP server using
7128 a Unix domain socket instead of a TCP/IP connection. This is specified by using
7129 &`ldapi`& instead of &`ldap`& in LDAP queries. What follows here applies only
7130 to OpenLDAP. If Exim is compiled with a different LDAP library, this feature is
7131 not available.
7132
7133 For this type of connection, instead of a host name for the server, a pathname
7134 for the socket is required, and the port number is not relevant. The pathname
7135 can be specified either as an item in &%ldap_default_servers%&, or inline in
7136 the query. In the former case, you can have settings such as
7137 .code
7138 ldap_default_servers = /tmp/ldap.sock : backup.ldap.your.domain
7139 .endd
7140 When the pathname is given in the query, you have to escape the slashes as
7141 &`%2F`& to fit in with the LDAP URL syntax. For example:
7142 .code
7143 ${lookup ldap {ldapi://%2Ftmp%2Fldap.sock/o=...
7144 .endd
7145 When Exim processes an LDAP lookup and finds that the &"hostname"& is really
7146 a pathname, it uses the Unix domain socket code, even if the query actually
7147 specifies &`ldap`& or &`ldaps`&. In particular, no encryption is used for a
7148 socket connection. This behaviour means that you can use a setting of
7149 &%ldap_default_servers%& such as in the example above with traditional &`ldap`&
7150 or &`ldaps`& queries, and it will work. First, Exim tries a connection via
7151 the Unix domain socket; if that fails, it tries a TCP/IP connection to the
7152 backup host.
7153
7154 If an explicit &`ldapi`& type is given in a query when a host name is
7155 specified, an error is diagnosed. However, if there are more items in
7156 &%ldap_default_servers%&, they are tried. In other words:
7157
7158 .ilist
7159 Using a pathname with &`ldap`& or &`ldaps`& forces the use of the Unix domain
7160 interface.
7161 .next
7162 Using &`ldapi`& with a host name causes an error.
7163 .endlist
7164
7165
7166 Using &`ldapi`& with no host or path in the query, and no setting of
7167 &%ldap_default_servers%&, does whatever the library does by default.
7168
7169
7170
7171 .section "LDAP authentication and control information" "SECID70"
7172 .cindex "LDAP" "authentication"
7173 The LDAP URL syntax provides no way of passing authentication and other control
7174 information to the server. To make this possible, the URL in an LDAP query may
7175 be preceded by any number of <&'name'&>=<&'value'&> settings, separated by
7176 spaces. If a value contains spaces it must be enclosed in double quotes, and
7177 when double quotes are used, backslash is interpreted in the usual way inside
7178 them. The following names are recognized:
7179 .display
7180 &`DEREFERENCE`&  set the dereferencing parameter
7181 &`NETTIME    `&  set a timeout for a network operation
7182 &`USER       `&  set the DN, for authenticating the LDAP bind
7183 &`PASS       `&  set the password, likewise
7184 &`REFERRALS  `&  set the referrals parameter
7185 &`SIZE       `&  set the limit for the number of entries returned
7186 &`TIME       `&  set the maximum waiting time for a query
7187 .endd
7188 The value of the DEREFERENCE parameter must be one of the words &"never"&,
7189 &"searching"&, &"finding"&, or &"always"&. The value of the REFERRALS parameter
7190 must be &"follow"& (the default) or &"nofollow"&. The latter stops the LDAP
7191 library from trying to follow referrals issued by the LDAP server.
7192
7193 The name CONNECT is an obsolete name for NETTIME, retained for
7194 backwards compatibility. This timeout (specified as a number of seconds) is
7195 enforced from the client end for operations that can be carried out over a
7196 network. Specifically, it applies to network connections and calls to the
7197 &'ldap_result()'& function. If the value is greater than zero, it is used if
7198 LDAP_OPT_NETWORK_TIMEOUT is defined in the LDAP headers (OpenLDAP), or
7199 if LDAP_X_OPT_CONNECT_TIMEOUT is defined in the LDAP headers (Netscape
7200 SDK 4.1). A value of zero forces an explicit setting of &"no timeout"& for
7201 Netscape SDK; for OpenLDAP no action is taken.
7202
7203 The TIME parameter (also a number of seconds) is passed to the server to
7204 set a server-side limit on the time taken to complete a search.
7205
7206
7207 Here is an example of an LDAP query in an Exim lookup that uses some of these
7208 values. This is a single line, folded to fit on the page:
7209 .code
7210 ${lookup ldap
7211   {user="cn=manager,o=University of Cambridge,c=UK" pass=secret
7212   ldap:///o=University%20of%20Cambridge,c=UK?sn?sub?(cn=foo)}
7213   {$value}fail}
7214 .endd
7215 The encoding of spaces as &`%20`& is a URL thing which should not be done for
7216 any of the auxiliary data. Exim configuration settings that include lookups
7217 which contain password information should be preceded by &"hide"& to prevent
7218 non-admin users from using the &%-bP%& option to see their values.
7219
7220 The auxiliary data items may be given in any order. The default is no
7221 connection timeout (the system timeout is used), no user or password, no limit
7222 on the number of entries returned, and no time limit on queries.
7223
7224 When a DN is quoted in the USER= setting for LDAP authentication, Exim
7225 removes any URL quoting that it may contain before passing it LDAP. Apparently
7226 some libraries do this for themselves, but some do not. Removing the URL
7227 quoting has two advantages:
7228
7229 .ilist
7230 It makes it possible to use the same &%quote_ldap_dn%& expansion for USER=
7231 DNs as with DNs inside actual queries.
7232 .next
7233 It permits spaces inside USER= DNs.
7234 .endlist
7235
7236 For example, a setting such as
7237 .code
7238 USER=cn=${quote_ldap_dn:$1}
7239 .endd
7240 should work even if &$1$& contains spaces.
7241
7242 Expanded data for the PASS= value should be quoted using the &%quote%&
7243 expansion operator, rather than the LDAP quote operators. The only reason this
7244 field needs quoting is to ensure that it conforms to the Exim syntax, which
7245 does not allow unquoted spaces. For example:
7246 .code
7247 PASS=${quote:$3}
7248 .endd
7249 The LDAP authentication mechanism can be used to check passwords as part of
7250 SMTP authentication. See the &%ldapauth%& expansion string condition in chapter
7251 &<<CHAPexpand>>&.
7252
7253
7254
7255 .section "Format of data returned by LDAP" "SECID71"
7256 .cindex "LDAP" "returned data formats"
7257 The &(ldapdn)& lookup type returns the Distinguished Name from a single entry
7258 as a sequence of values, for example
7259 .code
7260 cn=manager, o=University of Cambridge, c=UK
7261 .endd
7262 The &(ldap)& lookup type generates an error if more than one entry matches the
7263 search filter, whereas &(ldapm)& permits this case, and inserts a newline in
7264 the result between the data from different entries. It is possible for multiple
7265 values to be returned for both &(ldap)& and &(ldapm)&, but in the former case
7266 you know that whatever values are returned all came from a single entry in the
7267 directory.
7268
7269 In the common case where you specify a single attribute in your LDAP query, the
7270 result is not quoted, and does not contain the attribute name. If the attribute
7271 has multiple values, they are separated by commas.
7272
7273 If you specify multiple attributes, the result contains space-separated, quoted
7274 strings, each preceded by the attribute name and an equals sign. Within the
7275 quotes, the quote character, backslash, and newline are escaped with
7276 backslashes, and commas are used to separate multiple values for the attribute.
7277 Apart from the escaping, the string within quotes takes the same form as the
7278 output when a single attribute is requested. Specifying no attributes is the
7279 same as specifying all of an entry's attributes.
7280
7281 Here are some examples of the output format. The first line of each pair is an
7282 LDAP query, and the second is the data that is returned. The attribute called
7283 &%attr1%& has two values, whereas &%attr2%& has only one value:
7284 .code
7285 ldap:///o=base?attr1?sub?(uid=fred)
7286 value1.1, value1.2
7287
7288 ldap:///o=base?attr2?sub?(uid=fred)
7289 value two
7290
7291 ldap:///o=base?attr1,attr2?sub?(uid=fred)
7292 attr1="value1.1, value1.2" attr2="value two"
7293
7294 ldap:///o=base??sub?(uid=fred)
7295 objectClass="top" attr1="value1.1, value1.2" attr2="value two"
7296 .endd
7297 The &%extract%& operator in string expansions can be used to pick out
7298 individual fields from data that consists of &'key'&=&'value'& pairs. You can
7299 make use of Exim's &%-be%& option to run expansion tests and thereby check the
7300 results of LDAP lookups.
7301
7302
7303
7304
7305 .section "More about NIS+" "SECTnisplus"
7306 .cindex "NIS+ lookup type"
7307 .cindex "lookup" "NIS+"
7308 NIS+ queries consist of a NIS+ &'indexed name'& followed by an optional colon
7309 and field name. If this is given, the result of a successful query is the
7310 contents of the named field; otherwise the result consists of a concatenation
7311 of &'field-name=field-value'& pairs, separated by spaces. Empty values and
7312 values containing spaces are quoted. For example, the query
7313 .code
7314 [name=mg1456],passwd.org_dir
7315 .endd
7316 might return the string
7317 .code
7318 name=mg1456 passwd="" uid=999 gid=999 gcos="Martin Guerre"
7319 home=/home/mg1456 shell=/bin/bash shadow=""
7320 .endd
7321 (split over two lines here to fit on the page), whereas
7322 .code
7323 [name=mg1456],passwd.org_dir:gcos
7324 .endd
7325 would just return
7326 .code
7327 Martin Guerre
7328 .endd
7329 with no quotes. A NIS+ lookup fails if NIS+ returns more than one table entry
7330 for the given indexed key. The effect of the &%quote_nisplus%& expansion
7331 operator is to double any quote characters within the text.
7332
7333
7334
7335 .section "SQL lookups" "SECTsql"
7336 .cindex "SQL lookup types"
7337 .cindex "MySQL" "lookup type"
7338 .cindex "PostgreSQL lookup type"
7339 .cindex "lookup" "MySQL"
7340 .cindex "lookup" "PostgreSQL"
7341 .cindex "Oracle" "lookup type"
7342 .cindex "lookup" "Oracle"
7343 .cindex "InterBase lookup type"
7344 .cindex "lookup" "InterBase"
7345 Exim can support lookups in InterBase, MySQL, Oracle, PostgreSQL, and SQLite
7346 databases. Queries for these databases contain SQL statements, so an example
7347 might be
7348 .code
7349 ${lookup mysql{select mailbox from users where id='userx'}\
7350   {$value}fail}
7351 .endd
7352 If the result of the query contains more than one field, the data for each
7353 field in the row is returned, preceded by its name, so the result of
7354 .code
7355 ${lookup pgsql{select home,name from users where id='userx'}\
7356   {$value}}
7357 .endd
7358 might be
7359 .code
7360 home=/home/userx name="Mister X"
7361 .endd
7362 Empty values and values containing spaces are double quoted, with embedded
7363 quotes escaped by a backslash. If the result of the query contains just one
7364 field, the value is passed back verbatim, without a field name, for example:
7365 .code
7366 Mister X
7367 .endd
7368 If the result of the query yields more than one row, it is all concatenated,
7369 with a newline between the data for each row.
7370
7371
7372 .section "More about MySQL, PostgreSQL, Oracle, and InterBase" "SECID72"
7373 .cindex "MySQL" "lookup type"
7374 .cindex "PostgreSQL lookup type"
7375 .cindex "lookup" "MySQL"
7376 .cindex "lookup" "PostgreSQL"
7377 .cindex "Oracle" "lookup type"
7378 .cindex "lookup" "Oracle"
7379 .cindex "InterBase lookup type"
7380 .cindex "lookup" "InterBase"
7381 If any MySQL, PostgreSQL, Oracle, or InterBase lookups are used, the
7382 &%mysql_servers%&, &%pgsql_servers%&, &%oracle_servers%&, or &%ibase_servers%&
7383 option (as appropriate) must be set to a colon-separated list of server
7384 information.
7385 (For MySQL and PostgreSQL only, the global option need not be set if all
7386 queries contain their own server information &-- see section
7387 &<<SECTspeserque>>&.) Each item in the list is a slash-separated list of four
7388 items: host name, database name, user name, and password. In the case of
7389 Oracle, the host name field is used for the &"service name"&, and the database
7390 name field is not used and should be empty. For example:
7391 .code
7392 hide oracle_servers = oracle.plc.example//userx/abcdwxyz
7393 .endd
7394 Because password data is sensitive, you should always precede the setting with
7395 &"hide"&, to prevent non-admin users from obtaining the setting via the &%-bP%&
7396 option. Here is an example where two MySQL servers are listed:
7397 .code
7398 hide mysql_servers = localhost/users/root/secret:\
7399                      otherhost/users/root/othersecret
7400 .endd
7401 For MySQL and PostgreSQL, a host may be specified as <&'name'&>:<&'port'&> but
7402 because this is a colon-separated list, the colon has to be doubled. For each
7403 query, these parameter groups are tried in order until a connection is made and
7404 a query is successfully processed. The result of a query may be that no data is
7405 found, but that is still a successful query. In other words, the list of
7406 servers provides a backup facility, not a list of different places to look.
7407
7408 The &%quote_mysql%&, &%quote_pgsql%&, and &%quote_oracle%& expansion operators
7409 convert newline, tab, carriage return, and backspace to \n, \t, \r, and \b
7410 respectively, and the characters single-quote, double-quote, and backslash
7411 itself are escaped with backslashes. The &%quote_pgsql%& expansion operator, in
7412 addition, escapes the percent and underscore characters. This cannot be done
7413 for MySQL because these escapes are not recognized in contexts where these
7414 characters are not special.
7415
7416 .section "Specifying the server in the query" "SECTspeserque"
7417 For MySQL and PostgreSQL lookups (but not currently for Oracle and InterBase),
7418 it is possible to specify a list of servers with an individual query. This is
7419 done by starting the query with
7420 .display
7421 &`servers=`&&'server1:server2:server3:...'&&`;`&
7422 .endd
7423 Each item in the list may take one of two forms:
7424 .olist
7425 If it contains no slashes it is assumed to be just a host name. The appropriate
7426 global option (&%mysql_servers%& or &%pgsql_servers%&) is searched for a host
7427 of the same name, and the remaining parameters (database, user, password) are
7428 taken from there.
7429 .next
7430 If it contains any slashes, it is taken as a complete parameter set.
7431 .endlist
7432 The list of servers is used in exactly the same way as the global list.
7433 Once a connection to a server has happened and a query has been
7434 successfully executed, processing of the lookup ceases.
7435
7436 This feature is intended for use in master/slave situations where updates
7437 are occurring and you want to update the master rather than a slave. If the
7438 master is in the list as a backup for reading, you might have a global setting
7439 like this:
7440 .code
7441 mysql_servers = slave1/db/name/pw:\
7442                 slave2/db/name/pw:\
7443                 master/db/name/pw
7444 .endd
7445 In an updating lookup, you could then write:
7446 .code
7447 ${lookup mysql{servers=master; UPDATE ...} }
7448 .endd
7449 That query would then be sent only to the master server. If, on the other hand,
7450 the master is not to be used for reading, and so is not present in the global
7451 option, you can still update it by a query of this form:
7452 .code
7453 ${lookup pgsql{servers=master/db/name/pw; UPDATE ...} }
7454 .endd
7455
7456
7457 .section "Special MySQL features" "SECID73"
7458 For MySQL, an empty host name or the use of &"localhost"& in &%mysql_servers%&
7459 causes a connection to the server on the local host by means of a Unix domain
7460 socket. An alternate socket can be specified in parentheses. The full syntax of
7461 each item in &%mysql_servers%& is:
7462 .display
7463 <&'hostname'&>::<&'port'&>(<&'socket name'&>)/<&'database'&>/&&&
7464   <&'user'&>/<&'password'&>
7465 .endd
7466 Any of the three sub-parts of the first field can be omitted. For normal use on
7467 the local host it can be left blank or set to just &"localhost"&.
7468
7469 No database need be supplied &-- but if it is absent here, it must be given in
7470 the queries.
7471
7472 If a MySQL query is issued that does not request any data (an insert, update,
7473 or delete command), the result of the lookup is the number of rows affected.
7474
7475 &*Warning*&: This can be misleading. If an update does not actually change
7476 anything (for example, setting a field to the value it already has), the result
7477 is zero because no rows are affected.
7478
7479
7480 .section "Special PostgreSQL features" "SECID74"
7481 PostgreSQL lookups can also use Unix domain socket connections to the database.
7482 This is usually faster and costs less CPU time than a TCP/IP connection.
7483 However it can be used only if the mail server runs on the same machine as the
7484 database server. A configuration line for PostgreSQL via Unix domain sockets
7485 looks like this:
7486 .code
7487 hide pgsql_servers = (/tmp/.s.PGSQL.5432)/db/user/password : ...
7488 .endd
7489 In other words, instead of supplying a host name, a path to the socket is
7490 given. The path name is enclosed in parentheses so that its slashes aren't
7491 visually confused with the delimiters for the other server parameters.
7492
7493 If a PostgreSQL query is issued that does not request any data (an insert,
7494 update, or delete command), the result of the lookup is the number of rows
7495 affected.
7496
7497 .section "More about SQLite" "SECTsqlite"
7498 .cindex "lookup" "SQLite"
7499 .cindex "sqlite lookup type"
7500 SQLite is different to the other SQL lookups because a file name is required in
7501 addition to the SQL query. An SQLite database is a single file, and there is no
7502 daemon as in the other SQL databases. The interface to Exim requires the name
7503 of the file, as an absolute path, to be given at the start of the query. It is
7504 separated from the query by white space. This means that the path name cannot
7505 contain white space. Here is a lookup expansion example:
7506 .code
7507 ${lookup sqlite {/some/thing/sqlitedb \
7508   select name from aliases where id='userx';}}
7509 .endd
7510 In a list, the syntax is similar. For example:
7511 .code
7512 domainlist relay_to_domains = sqlite;/some/thing/sqlitedb \
7513    select * from relays where ip='$sender_host_address';
7514 .endd
7515 The only character affected by the &%quote_sqlite%& operator is a single
7516 quote, which it doubles.
7517
7518 The SQLite library handles multiple simultaneous accesses to the database
7519 internally. Multiple readers are permitted, but only one process can
7520 update at once. Attempts to access the database while it is being updated
7521 are rejected after a timeout period, during which the SQLite library
7522 waits for the lock to be released. In Exim, the default timeout is set
7523 to 5 seconds, but it can be changed by means of the &%sqlite_lock_timeout%&
7524 option.
7525 .ecindex IIDfidalo1
7526 .ecindex IIDfidalo2
7527
7528
7529 . ////////////////////////////////////////////////////////////////////////////
7530 . ////////////////////////////////////////////////////////////////////////////
7531
7532 .chapter "Domain, host, address, and local part lists" &&&
7533          "CHAPdomhosaddlists" &&&
7534          "Domain, host, and address lists"
7535 .scindex IIDdohoadli "lists of domains; hosts; etc."
7536 A number of Exim configuration options contain lists of domains, hosts,
7537 email addresses, or local parts. For example, the &%hold_domains%& option
7538 contains a list of domains whose delivery is currently suspended. These lists
7539 are also used as data in ACL statements (see chapter &<<CHAPACL>>&), and as
7540 arguments to expansion conditions such as &%match_domain%&.
7541
7542 Each item in one of these lists is a pattern to be matched against a domain,
7543 host, email address, or local part, respectively. In the sections below, the
7544 different types of pattern for each case are described, but first we cover some
7545 general facilities that apply to all four kinds of list.
7546
7547
7548
7549 .section "Expansion of lists" "SECID75"
7550 .cindex "expansion" "of lists"
7551 Each list is expanded as a single string before it is used. The result of
7552 expansion must be a list, possibly containing empty items, which is split up
7553 into separate items for matching. By default, colon is the separator character,
7554 but this can be varied if necessary. See sections &<<SECTlistconstruct>>& and
7555 &<<SECTempitelis>>& for details of the list syntax; the second of these
7556 discusses the way to specify empty list items.
7557
7558
7559 If the string expansion is forced to fail, Exim behaves as if the item it is
7560 testing (domain, host, address, or local part) is not in the list. Other
7561 expansion failures cause temporary errors.
7562
7563 If an item in a list is a regular expression, backslashes, dollars and possibly
7564 other special characters in the expression must be protected against
7565 misinterpretation by the string expander. The easiest way to do this is to use
7566 the &`\N`& expansion feature to indicate that the contents of the regular
7567 expression should not be expanded. For example, in an ACL you might have:
7568 .code
7569 deny senders = \N^\d{8}\w@.*\.baddomain\.example$\N : \
7570                ${lookup{$domain}lsearch{/badsenders/bydomain}}
7571 .endd
7572 The first item is a regular expression that is protected from expansion by
7573 &`\N`&, whereas the second uses the expansion to obtain a list of unwanted
7574 senders based on the receiving domain.
7575
7576
7577
7578
7579 .section "Negated items in lists" "SECID76"
7580 .cindex "list" "negation"
7581 .cindex "negation" "in lists"
7582 Items in a list may be positive or negative. Negative items are indicated by a
7583 leading exclamation mark, which may be followed by optional white space. A list
7584 defines a set of items (domains, etc). When Exim processes one of these lists,
7585 it is trying to find out whether a domain, host, address, or local part
7586 (respectively) is in the set that is defined by the list. It works like this:
7587
7588 The list is scanned from left to right. If a positive item is matched, the
7589 subject that is being checked is in the set; if a negative item is matched, the
7590 subject is not in the set. If the end of the list is reached without the
7591 subject having matched any of the patterns, it is in the set if the last item
7592 was a negative one, but not if it was a positive one. For example, the list in
7593 .code
7594 domainlist relay_to_domains = !a.b.c : *.b.c
7595 .endd
7596 matches any domain ending in &'.b.c'& except for &'a.b.c'&. Domains that match
7597 neither &'a.b.c'& nor &'*.b.c'& do not match, because the last item in the
7598 list is positive. However, if the setting were
7599 .code
7600 domainlist relay_to_domains = !a.b.c
7601 .endd
7602 then all domains other than &'a.b.c'& would match because the last item in the
7603 list is negative. In other words, a list that ends with a negative item behaves
7604 as if it had an extra item &`:*`& on the end.
7605
7606 Another way of thinking about positive and negative items in lists is to read
7607 the connector as &"or"& after a positive item and as &"and"& after a negative
7608 item.
7609
7610
7611
7612 .section "File names in lists" "SECTfilnamlis"
7613 .cindex "list" "file name in"
7614 If an item in a domain, host, address, or local part list is an absolute file
7615 name (beginning with a slash character), each line of the file is read and
7616 processed as if it were an independent item in the list, except that further
7617 file names are not allowed,
7618 and no expansion of the data from the file takes place.
7619 Empty lines in the file are ignored, and the file may also contain comment
7620 lines:
7621
7622 .ilist
7623 For domain and host lists, if a # character appears anywhere in a line of the
7624 file, it and all following characters are ignored.
7625 .next
7626 Because local parts may legitimately contain # characters, a comment in an
7627 address list or local part list file is recognized only if # is preceded by
7628 white space or the start of the line. For example:
7629 .code
7630 not#comment@x.y.z   # but this is a comment
7631 .endd
7632 .endlist
7633
7634 Putting a file name in a list has the same effect as inserting each line of the
7635 file as an item in the list (blank lines and comments excepted). However, there
7636 is one important difference: the file is read each time the list is processed,
7637 so if its contents vary over time, Exim's behaviour changes.
7638
7639 If a file name is preceded by an exclamation mark, the sense of any match
7640 within the file is inverted. For example, if
7641 .code
7642 hold_domains = !/etc/nohold-domains
7643 .endd
7644 and the file contains the lines
7645 .code
7646 !a.b.c
7647 *.b.c
7648 .endd
7649 then &'a.b.c'& is in the set of domains defined by &%hold_domains%&, whereas
7650 any domain matching &`*.b.c`& is not.
7651
7652
7653
7654 .section "An lsearch file is not an out-of-line list" "SECID77"
7655 As will be described in the sections that follow, lookups can be used in lists
7656 to provide indexed methods of checking list membership. There has been some
7657 confusion about the way &(lsearch)& lookups work in lists. Because
7658 an &(lsearch)& file contains plain text and is scanned sequentially, it is
7659 sometimes thought that it is allowed to contain wild cards and other kinds of
7660 non-constant pattern. This is not the case. The keys in an &(lsearch)& file are
7661 always fixed strings, just as for any other single-key lookup type.
7662
7663 If you want to use a file to contain wild-card patterns that form part of a
7664 list, just give the file name on its own, without a search type, as described
7665 in the previous section. You could also use the &(wildlsearch)& or
7666 &(nwildlsearch)&, but there is no advantage in doing this.
7667
7668
7669
7670
7671 .section "Named lists" "SECTnamedlists"
7672 .cindex "named lists"
7673 .cindex "list" "named"
7674 A list of domains, hosts, email addresses, or local parts can be given a name
7675 which is then used to refer to the list elsewhere in the configuration. This is
7676 particularly convenient if the same list is required in several different
7677 places. It also allows lists to be given meaningful names, which can improve
7678 the readability of the configuration. For example, it is conventional to define
7679 a domain list called &'local_domains'& for all the domains that are handled
7680 locally on a host, using a configuration line such as
7681 .code
7682 domainlist local_domains = localhost:my.dom.example
7683 .endd
7684 Named lists are referenced by giving their name preceded by a plus sign, so,
7685 for example, a router that is intended to handle local domains would be
7686 configured with the line
7687 .code
7688 domains = +local_domains
7689 .endd
7690 The first router in a configuration is often one that handles all domains
7691 except the local ones, using a configuration with a negated item like this:
7692 .code
7693 dnslookup:
7694   driver = dnslookup
7695   domains = ! +local_domains
7696   transport = remote_smtp
7697   no_more
7698 .endd
7699 The four kinds of named list are created by configuration lines starting with
7700 the words &%domainlist%&, &%hostlist%&, &%addresslist%&, or &%localpartlist%&,
7701 respectively. Then there follows the name that you are defining, followed by an
7702 equals sign and the list itself. For example:
7703 .code
7704 hostlist    relay_from_hosts = 192.168.23.0/24 : my.friend.example
7705 addresslist bad_senders = cdb;/etc/badsenders
7706 .endd
7707 A named list may refer to other named lists:
7708 .code
7709 domainlist  dom1 = first.example : second.example
7710 domainlist  dom2 = +dom1 : third.example
7711 domainlist  dom3 = fourth.example : +dom2 : fifth.example
7712 .endd
7713 &*Warning*&: If the last item in a referenced list is a negative one, the
7714 effect may not be what you intended, because the negation does not propagate
7715 out to the higher level. For example, consider:
7716 .code
7717 domainlist  dom1 = !a.b
7718 domainlist  dom2 = +dom1 : *.b
7719 .endd
7720 The second list specifies &"either in the &%dom1%& list or &'*.b'&"&. The first
7721 list specifies just &"not &'a.b'&"&, so the domain &'x.y'& matches it. That
7722 means it matches the second list as well. The effect is not the same as
7723 .code
7724 domainlist  dom2 = !a.b : *.b
7725 .endd
7726 where &'x.y'& does not match. It's best to avoid negation altogether in
7727 referenced lists if you can.
7728
7729 Named lists may have a performance advantage. When Exim is routing an
7730 address or checking an incoming message, it caches the result of tests on named
7731 lists. So, if you have a setting such as
7732 .code
7733 domains = +local_domains
7734 .endd
7735 on several of your routers
7736 or in several ACL statements,
7737 the actual test is done only for the first one. However, the caching works only
7738 if there are no expansions within the list itself or any sublists that it
7739 references. In other words, caching happens only for lists that are known to be
7740 the same each time they are referenced.
7741
7742 By default, there may be up to 16 named lists of each type. This limit can be
7743 extended by changing a compile-time variable. The use of domain and host lists
7744 is recommended for concepts such as local domains, relay domains, and relay
7745 hosts. The default configuration is set up like this.
7746
7747
7748
7749 .section "Named lists compared with macros" "SECID78"
7750 .cindex "list" "named compared with macro"
7751 .cindex "macro" "compared with named list"
7752 At first sight, named lists might seem to be no different from macros in the
7753 configuration file. However, macros are just textual substitutions. If you
7754 write
7755 .code
7756 ALIST = host1 : host2
7757 auth_advertise_hosts = !ALIST
7758 .endd
7759 it probably won't do what you want, because that is exactly the same as
7760 .code
7761 auth_advertise_hosts = !host1 : host2
7762 .endd
7763 Notice that the second host name is not negated. However, if you use a host
7764 list, and write
7765 .code
7766 hostlist alist = host1 : host2
7767 auth_advertise_hosts = ! +alist
7768 .endd
7769 the negation applies to the whole list, and so that is equivalent to
7770 .code
7771 auth_advertise_hosts = !host1 : !host2
7772 .endd
7773
7774
7775 .section "Named list caching" "SECID79"
7776 .cindex "list" "caching of named"
7777 .cindex "caching" "named lists"
7778 While processing a message, Exim caches the result of checking a named list if
7779 it is sure that the list is the same each time. In practice, this means that
7780 the cache operates only if the list contains no $ characters, which guarantees
7781 that it will not change when it is expanded. Sometimes, however, you may have
7782 an expanded list that you know will be the same each time within a given
7783 message. For example:
7784 .code
7785 domainlist special_domains = \
7786            ${lookup{$sender_host_address}cdb{/some/file}}
7787 .endd
7788 This provides a list of domains that depends only on the sending host's IP
7789 address. If this domain list is referenced a number of times (for example,
7790 in several ACL lines, or in several routers) the result of the check is not
7791 cached by default, because Exim does not know that it is going to be the
7792 same list each time.
7793
7794 By appending &`_cache`& to &`domainlist`& you can tell Exim to go ahead and
7795 cache the result anyway. For example:
7796 .code
7797 domainlist_cache special_domains = ${lookup{...
7798 .endd
7799 If you do this, you should be absolutely sure that caching is going to do
7800 the right thing in all cases. When in doubt, leave it out.
7801
7802
7803
7804 .section "Domain lists" "SECTdomainlist"
7805 .cindex "domain list" "patterns for"
7806 .cindex "list" "domain list"
7807 Domain lists contain patterns that are to be matched against a mail domain.
7808 The following types of item may appear in domain lists:
7809
7810 .ilist
7811 .cindex "primary host name"
7812 .cindex "host name" "matched in domain list"
7813 .oindex "&%primary_hostname%&"
7814 .cindex "domain list" "matching primary host name"
7815 .cindex "@ in a domain list"
7816 If a pattern consists of a single @ character, it matches the local host name,
7817 as set by the &%primary_hostname%& option (or defaulted). This makes it
7818 possible to use the same configuration file on several different hosts that
7819 differ only in their names.
7820 .next
7821 .cindex "@[] in a domain list"
7822 .cindex "domain list" "matching local IP interfaces"
7823 .cindex "domain literal"
7824 If a pattern consists of the string &`@[]`& it matches an IP address enclosed
7825 in square brackets (as in an email address that contains a domain literal), but
7826 only if that IP address is recognized as local for email routing purposes. The
7827 &%local_interfaces%& and &%extra_local_interfaces%& options can be used to
7828 control which of a host's several IP addresses are treated as local.
7829 In today's Internet, the use of domain literals is controversial.
7830 .next
7831 .cindex "@mx_any"
7832 .cindex "@mx_primary"
7833 .cindex "@mx_secondary"
7834 .cindex "domain list" "matching MX pointers to local host"
7835 If a pattern consists of the string &`@mx_any`& it matches any domain that
7836 has an MX record pointing to the local host or to any host that is listed in
7837 .oindex "&%hosts_treat_as_local%&"
7838 &%hosts_treat_as_local%&. The items &`@mx_primary`& and &`@mx_secondary`&
7839 are similar, except that the first matches only when a primary MX target is the
7840 local host, and the second only when no primary MX target is the local host,
7841 but a secondary MX target is. &"Primary"& means an MX record with the lowest
7842 preference value &-- there may of course be more than one of them.
7843
7844 The MX lookup that takes place when matching a pattern of this type is
7845 performed with the resolver options for widening names turned off. Thus, for
7846 example, a single-component domain will &'not'& be expanded by adding the
7847 resolver's default domain. See the &%qualify_single%& and &%search_parents%&
7848 options of the &(dnslookup)& router for a discussion of domain widening.
7849
7850 Sometimes you may want to ignore certain IP addresses when using one of these
7851 patterns. You can specify this by following the pattern with &`/ignore=`&<&'ip
7852 list'&>, where <&'ip list'&> is a list of IP addresses. These addresses are
7853 ignored when processing the pattern (compare the &%ignore_target_hosts%& option
7854 on a router). For example:
7855 .code
7856 domains = @mx_any/ignore=127.0.0.1
7857 .endd
7858 This example matches any domain that has an MX record pointing to one of
7859 the local host's IP addresses other than 127.0.0.1.
7860
7861 The list of IP addresses is in fact processed by the same code that processes
7862 host lists, so it may contain CIDR-coded network specifications and it may also
7863 contain negative items.
7864
7865 Because the list of IP addresses is a sublist within a domain list, you have to
7866 be careful about delimiters if there is more than one address. Like any other
7867 list, the default delimiter can be changed. Thus, you might have:
7868 .code
7869 domains = @mx_any/ignore=<;127.0.0.1;0.0.0.0 : \
7870           an.other.domain : ...
7871 .endd
7872 so that the sublist uses semicolons for delimiters. When IPv6 addresses are
7873 involved, it is easiest to change the delimiter for the main list as well:
7874 .code
7875 domains = <? @mx_any/ignore=<;127.0.0.1;::1 ? \
7876           an.other.domain ? ...
7877 .endd
7878 .next
7879 .cindex "asterisk" "in domain list"
7880 .cindex "domain list" "asterisk in"
7881 .cindex "domain list" "matching &""ends with""&"
7882 If a pattern starts with an asterisk, the remaining characters of the pattern
7883 are compared with the terminating characters of the domain. The use of &"*"& in
7884 domain lists differs from its use in partial matching lookups. In a domain
7885 list, the character following the asterisk need not be a dot, whereas partial
7886 matching works only in terms of dot-separated components. For example, a domain
7887 list item such as &`*key.ex`& matches &'donkey.ex'& as well as
7888 &'cipher.key.ex'&.
7889
7890 .next
7891 .cindex "regular expressions" "in domain list"
7892 .cindex "domain list" "matching regular expression"
7893 If a pattern starts with a circumflex character, it is treated as a regular
7894 expression, and matched against the domain using a regular expression matching
7895 function. The circumflex is treated as part of the regular expression.
7896 Email domains are case-independent, so this regular expression match is by
7897 default case-independent, but you can make it case-dependent by starting it
7898 with &`(?-i)`&. References to descriptions of the syntax of regular expressions
7899 are given in chapter &<<CHAPregexp>>&.
7900
7901 &*Warning*&: Because domain lists are expanded before being processed, you
7902 must escape any backslash and dollar characters in the regular expression, or
7903 use the special &`\N`& sequence (see chapter &<<CHAPexpand>>&) to specify that
7904 it is not to be expanded (unless you really do want to build a regular
7905 expression by expansion, of course).
7906 .next
7907 .cindex "lookup" "in domain list"
7908 .cindex "domain list" "matching by lookup"
7909 If a pattern starts with the name of a single-key lookup type followed by a
7910 semicolon (for example, &"dbm;"& or &"lsearch;"&), the remainder of the pattern
7911 must be a file name in a suitable format for the lookup type. For example, for
7912 &"cdb;"& it must be an absolute path:
7913 .code
7914 domains = cdb;/etc/mail/local_domains.cdb
7915 .endd
7916 The appropriate type of lookup is done on the file using the domain name as the
7917 key. In most cases, the data that is looked up is not used; Exim is interested
7918 only in whether or not the key is present in the file. However, when a lookup
7919 is used for the &%domains%& option on a router
7920 or a &%domains%& condition in an ACL statement, the data is preserved in the
7921 &$domain_data$& variable and can be referred to in other router options or
7922 other statements in the same ACL.
7923
7924 .next
7925 Any of the single-key lookup type names may be preceded by
7926 &`partial`&<&'n'&>&`-`&, where the <&'n'&> is optional, for example,
7927 .code
7928 domains = partial-dbm;/partial/domains
7929 .endd
7930 This causes partial matching logic to be invoked; a description of how this
7931 works is given in section &<<SECTpartiallookup>>&.
7932
7933 .next
7934 .cindex "asterisk" "in lookup type"
7935 Any of the single-key lookup types may be followed by an asterisk. This causes
7936 a default lookup for a key consisting of a single asterisk to be done if the
7937 original lookup fails. This is not a useful feature when using a domain list to
7938 select particular domains (because any domain would match), but it might have
7939 value if the result of the lookup is being used via the &$domain_data$&
7940 expansion variable.
7941 .next
7942 If the pattern starts with the name of a query-style lookup type followed by a
7943 semicolon (for example, &"nisplus;"& or &"ldap;"&), the remainder of the
7944 pattern must be an appropriate query for the lookup type, as described in
7945 chapter &<<CHAPfdlookup>>&. For example:
7946 .code
7947 hold_domains = mysql;select domain from holdlist \
7948   where domain = '${quote_mysql:$domain}';
7949 .endd
7950 In most cases, the data that is looked up is not used (so for an SQL query, for
7951 example, it doesn't matter what field you select). Exim is interested only in
7952 whether or not the query succeeds. However, when a lookup is used for the
7953 &%domains%& option on a router, the data is preserved in the &$domain_data$&
7954 variable and can be referred to in other options.
7955 .next
7956 .cindex "domain list" "matching literal domain name"
7957 If none of the above cases apply, a caseless textual comparison is made
7958 between the pattern and the domain.
7959 .endlist
7960
7961 Here is an example that uses several different kinds of pattern:
7962 .code
7963 domainlist funny_domains = \
7964   @ : \
7965   lib.unseen.edu : \
7966   *.foundation.fict.example : \
7967   \N^[1-2]\d{3}\.fict\.example$\N : \
7968   partial-dbm;/opt/data/penguin/book : \
7969   nis;domains.byname : \
7970   nisplus;[name=$domain,status=local],domains.org_dir
7971 .endd
7972 There are obvious processing trade-offs among the various matching modes. Using
7973 an asterisk is faster than a regular expression, and listing a few names
7974 explicitly probably is too. The use of a file or database lookup is expensive,
7975 but may be the only option if hundreds of names are required. Because the
7976 patterns are tested in order, it makes sense to put the most commonly matched
7977 patterns earlier.
7978
7979
7980
7981 .section "Host lists" "SECThostlist"
7982 .cindex "host list" "patterns in"
7983 .cindex "list" "host list"
7984 Host lists are used to control what remote hosts are allowed to do. For
7985 example, some hosts may be allowed to use the local host as a relay, and some
7986 may be permitted to use the SMTP ETRN command. Hosts can be identified in
7987 two different ways, by name or by IP address. In a host list, some types of
7988 pattern are matched to a host name, and some are matched to an IP address.
7989 You need to be particularly careful with this when single-key lookups are
7990 involved, to ensure that the right value is being used as the key.
7991
7992
7993 .section "Special host list patterns" "SECID80"
7994 .cindex "empty item in hosts list"
7995 .cindex "host list" "empty string in"
7996 If a host list item is the empty string, it matches only when no remote host is
7997 involved. This is the case when a message is being received from a local
7998 process using SMTP on the standard input, that is, when a TCP/IP connection is
7999 not used.
8000
8001 .cindex "asterisk" "in host list"
8002 The special pattern &"*"& in a host list matches any host or no host. Neither
8003 the IP address nor the name is actually inspected.
8004
8005
8006
8007 .section "Host list patterns that match by IP address" "SECThoslispatip"
8008 .cindex "host list" "matching IP addresses"
8009 If an IPv4 host calls an IPv6 host and the call is accepted on an IPv6 socket,
8010 the incoming address actually appears in the IPv6 host as
8011 &`::ffff:`&<&'v4address'&>. When such an address is tested against a host
8012 list, it is converted into a traditional IPv4 address first. (Not all operating
8013 systems accept IPv4 calls on IPv6 sockets, as there have been some security
8014 concerns.)
8015
8016 The following types of pattern in a host list check the remote host by
8017 inspecting its IP address:
8018
8019 .ilist
8020 If the pattern is a plain domain name (not a regular expression, not starting
8021 with *, not a lookup of any kind), Exim calls the operating system function
8022 to find the associated IP address(es). Exim uses the newer
8023 &[getipnodebyname()]& function when available, otherwise &[gethostbyname()]&.
8024 This typically causes a forward DNS lookup of the name. The result is compared
8025 with the IP address of the subject host.
8026
8027 If there is a temporary problem (such as a DNS timeout) with the host name
8028 lookup, a temporary error occurs. For example, if the list is being used in an
8029 ACL condition, the ACL gives a &"defer"& response, usually leading to a
8030 temporary SMTP error code. If no IP address can be found for the host name,
8031 what happens is described in section &<<SECTbehipnot>>& below.
8032
8033 .next
8034 .cindex "@ in a host list"
8035 If the pattern is &"@"&, the primary host name is substituted and used as a
8036 domain name, as just described.
8037
8038 .next
8039 If the pattern is an IP address, it is matched against the IP address of the
8040 subject host. IPv4 addresses are given in the normal &"dotted-quad"& notation.
8041 IPv6 addresses can be given in colon-separated format, but the colons have to
8042 be doubled so as not to be taken as item separators when the default list
8043 separator is used. IPv6 addresses are recognized even when Exim is compiled
8044 without IPv6 support. This means that if they appear in a host list on an
8045 IPv4-only host, Exim will not treat them as host names. They are just addresses
8046 that can never match a client host.
8047
8048 .next
8049 .cindex "@[] in a host list"
8050 If the pattern is &"@[]"&, it matches the IP address of any IP interface on
8051 the local host. For example, if the local host is an IPv4 host with one
8052 interface address 10.45.23.56, these two ACL statements have the same effect:
8053 .code
8054 accept hosts = 127.0.0.1 : 10.45.23.56
8055 accept hosts = @[]
8056 .endd
8057 .next
8058 .cindex "CIDR notation"
8059 If the pattern is an IP address followed by a slash and a mask length (for
8060 example 10.11.42.0/24), it is matched against the IP address of the subject
8061 host under the given mask. This allows, an entire network of hosts to be
8062 included (or excluded) by a single item. The mask uses CIDR notation; it
8063 specifies the number of address bits that must match, starting from the most
8064 significant end of the address.
8065
8066 &*Note*&: The mask is &'not'& a count of addresses, nor is it the high number
8067 of a range of addresses. It is the number of bits in the network portion of the
8068 address. The above example specifies a 24-bit netmask, so it matches all 256
8069 addresses in the 10.11.42.0 network. An item such as
8070 .code
8071 192.168.23.236/31
8072 .endd
8073 matches just two addresses, 192.168.23.236 and 192.168.23.237. A mask value of
8074 32 for an IPv4 address is the same as no mask at all; just a single address
8075 matches.
8076
8077 Here is another example which shows an IPv4 and an IPv6 network:
8078 .code
8079 recipient_unqualified_hosts = 192.168.0.0/16: \
8080                               3ffe::ffff::836f::::/48
8081 .endd
8082 The doubling of list separator characters applies only when these items
8083 appear inline in a host list. It is not required when indirecting via a file.
8084 For example:
8085 .code
8086 recipient_unqualified_hosts = /opt/exim/unqualnets
8087 .endd
8088 could make use of a file containing
8089 .code
8090 172.16.0.0/12
8091 3ffe:ffff:836f::/48
8092 .endd
8093 to have exactly the same effect as the previous example. When listing IPv6
8094 addresses inline, it is usually more convenient to use the facility for
8095 changing separator characters. This list contains the same two networks:
8096 .code
8097 recipient_unqualified_hosts = <; 172.16.0.0/12; \
8098                                  3ffe:ffff:836f::/48
8099 .endd
8100 The separator is changed to semicolon by the leading &"<;"& at the start of the
8101 list.
8102 .endlist
8103
8104
8105
8106 .section "Host list patterns for single-key lookups by host address" &&&
8107          "SECThoslispatsikey"
8108 .cindex "host list" "lookup of IP address"
8109 When a host is to be identified by a single-key lookup of its complete IP
8110 address, the pattern takes this form:
8111 .display
8112 &`net-<`&&'single-key-search-type'&&`>;<`&&'search-data'&&`>`&
8113 .endd
8114 For example:
8115 .code
8116 hosts_lookup = net-cdb;/hosts-by-ip.db
8117 .endd
8118 The text form of the IP address of the subject host is used as the lookup key.
8119 IPv6 addresses are converted to an unabbreviated form, using lower case
8120 letters, with dots as separators because colon is the key terminator in
8121 &(lsearch)& files. [Colons can in fact be used in keys in &(lsearch)& files by
8122 quoting the keys, but this is a facility that was added later.] The data
8123 returned by the lookup is not used.
8124
8125 .cindex "IP address" "masking"
8126 .cindex "host list" "masked IP address"
8127 Single-key lookups can also be performed using masked IP addresses, using
8128 patterns of this form:
8129 .display
8130 &`net<`&&'number'&&`>-<`&&'single-key-search-type'&&`>;<`&&'search-data'&&`>`&
8131 .endd
8132 For example:
8133 .code
8134 net24-dbm;/networks.db
8135 .endd
8136 The IP address of the subject host is masked using <&'number'&> as the mask
8137 length. A textual string is constructed from the masked value, followed by the
8138 mask, and this is used as the lookup key. For example, if the host's IP address
8139 is 192.168.34.6, the key that is looked up for the above example is
8140 &"192.168.34.0/24"&.
8141
8142 When an IPv6 address is converted to a string, dots are normally used instead
8143 of colons, so that keys in &(lsearch)& files need not contain colons (which
8144 terminate &(lsearch)& keys). This was implemented some time before the ability
8145 to quote keys was made available in &(lsearch)& files. However, the more
8146 recently implemented &(iplsearch)& files do require colons in IPv6 keys
8147 (notated using the quoting facility) so as to distinguish them from IPv4 keys.
8148 For this reason, when the lookup type is &(iplsearch)&, IPv6 addresses are
8149 converted using colons and not dots. In all cases, full, unabbreviated IPv6
8150 addresses are always used.
8151
8152 Ideally, it would be nice to tidy up this anomalous situation by changing to
8153 colons in all cases, given that quoting is now available for &(lsearch)&.
8154 However, this would be an incompatible change that might break some existing
8155 configurations.
8156
8157 &*Warning*&: Specifying &%net32-%& (for an IPv4 address) or &%net128-%& (for an
8158 IPv6 address) is not the same as specifying just &%net-%& without a number. In
8159 the former case the key strings include the mask value, whereas in the latter
8160 case the IP address is used on its own.
8161
8162
8163
8164 .section "Host list patterns that match by host name" "SECThoslispatnam"
8165 .cindex "host" "lookup failures"
8166 .cindex "unknown host name"
8167 .cindex "host list" "matching host name"
8168 There are several types of pattern that require Exim to know the name of the
8169 remote host. These are either wildcard patterns or lookups by name. (If a
8170 complete hostname is given without any wildcarding, it is used to find an IP
8171 address to match against, as described in section &<<SECThoslispatip>>&
8172 above.)
8173
8174 If the remote host name is not already known when Exim encounters one of these
8175 patterns, it has to be found from the IP address.
8176 Although many sites on the Internet are conscientious about maintaining reverse
8177 DNS data for their hosts, there are also many that do not do this.
8178 Consequently, a name cannot always be found, and this may lead to unwanted
8179 effects. Take care when configuring host lists with wildcarded name patterns.
8180 Consider what will happen if a name cannot be found.
8181
8182 Because of the problems of determining host names from IP addresses, matching
8183 against host names is not as common as matching against IP addresses.
8184
8185 By default, in order to find a host name, Exim first does a reverse DNS lookup;
8186 if no name is found in the DNS, the system function (&[gethostbyaddr()]& or
8187 &[getipnodebyaddr()]& if available) is tried. The order in which these lookups
8188 are done can be changed by setting the &%host_lookup_order%& option. For
8189 security, once Exim has found one or more names, it looks up the IP addresses
8190 for these names and compares them with the IP address that it started with.
8191 Only those names whose IP addresses match are accepted. Any other names are
8192 discarded. If no names are left, Exim behaves as if the host name cannot be
8193 found. In the most common case there is only one name and one IP address.
8194
8195 There are some options that control what happens if a host name cannot be
8196 found. These are described in section &<<SECTbehipnot>>& below.
8197
8198 .cindex "host" "alias for"
8199 .cindex "alias for host"
8200 As a result of aliasing, hosts may have more than one name. When processing any
8201 of the following types of pattern, all the host's names are checked:
8202
8203 .ilist
8204 .cindex "asterisk" "in host list"
8205 If a pattern starts with &"*"& the remainder of the item must match the end of
8206 the host name. For example, &`*.b.c`& matches all hosts whose names end in
8207 &'.b.c'&. This special simple form is provided because this is a very common
8208 requirement. Other kinds of wildcarding require the use of a regular
8209 expression.
8210 .next
8211 .cindex "regular expressions" "in host list"
8212 .cindex "host list" "regular expression in"
8213 If the item starts with &"^"& it is taken to be a regular expression which is
8214 matched against the host name. Host names are case-independent, so this regular
8215 expression match is by default case-independent, but you can make it
8216 case-dependent by starting it with &`(?-i)`&. References to descriptions of the
8217 syntax of regular expressions are given in chapter &<<CHAPregexp>>&. For
8218 example,
8219 .code
8220 ^(a|b)\.c\.d$
8221 .endd
8222 is a regular expression that matches either of the two hosts &'a.c.d'& or
8223 &'b.c.d'&. When a regular expression is used in a host list, you must take care
8224 that backslash and dollar characters are not misinterpreted as part of the
8225 string expansion. The simplest way to do this is to use &`\N`& to mark that
8226 part of the string as non-expandable. For example:
8227 .code
8228 sender_unqualified_hosts = \N^(a|b)\.c\.d$\N : ....
8229 .endd
8230 &*Warning*&: If you want to match a complete host name, you must include the
8231 &`$`& terminating metacharacter in the regular expression, as in the above
8232 example. Without it, a match at the start of the host name is all that is
8233 required.
8234 .endlist
8235
8236
8237
8238
8239 .section "Behaviour when an IP address or name cannot be found" "SECTbehipnot"
8240 .cindex "host" "lookup failures, permanent"
8241 While processing a host list, Exim may need to look up an IP address from a
8242 name (see section &<<SECThoslispatip>>&), or it may need to look up a host name
8243 from an IP address (see section &<<SECThoslispatnam>>&). In either case, the
8244 behaviour when it fails to find the information it is seeking is the same.
8245
8246 &*Note*&: This section applies to permanent lookup failures. It does &'not'&
8247 apply to temporary DNS errors, whose handling is described in the next section.
8248
8249 .cindex "&`+include_unknown`&"
8250 .cindex "&`+ignore_unknown`&"
8251 By default, Exim behaves as if the host does not match the list. This may not
8252 always be what you want to happen. To change Exim's behaviour, the special
8253 items &`+include_unknown`& or &`+ignore_unknown`& may appear in the list (at
8254 top level &-- they are not recognized in an indirected file).
8255
8256 .ilist
8257 If any item that follows &`+include_unknown`& requires information that
8258 cannot found, Exim behaves as if the host does match the list. For example,
8259 .code
8260 host_reject_connection = +include_unknown:*.enemy.ex
8261 .endd
8262 rejects connections from any host whose name matches &`*.enemy.ex`&, and also
8263 any hosts whose name it cannot find.
8264
8265 .next
8266 If any item that follows &`+ignore_unknown`& requires information that cannot
8267 be found, Exim ignores that item and proceeds to the rest of the list. For
8268 example:
8269 .code
8270 accept hosts = +ignore_unknown : friend.example : \
8271                192.168.4.5
8272 .endd
8273 accepts from any host whose name is &'friend.example'& and from 192.168.4.5,
8274 whether or not its host name can be found. Without &`+ignore_unknown`&, if no
8275 name can be found for 192.168.4.5, it is rejected.
8276 .endlist
8277
8278 Both &`+include_unknown`& and &`+ignore_unknown`& may appear in the same
8279 list. The effect of each one lasts until the next, or until the end of the
8280 list.
8281
8282
8283 .section "Temporary DNS errors when looking up host information" &&&
8284          "SECTtemdnserr"
8285 .cindex "host" "lookup failures, temporary"
8286 .cindex "&`+include_defer`&"
8287 .cindex "&`+ignore_defer`&"
8288 A temporary DNS lookup failure normally causes a defer action (except when
8289 &%dns_again_means_nonexist%& converts it into a permanent error). However,
8290 host lists can include &`+ignore_defer`& and &`+include_defer`&, analagous to
8291 &`+ignore_unknown`& and &`+include_unknown`&, as described in the previous
8292 section. These options should be used with care, probably only in non-critical
8293 host lists such as whitelists.
8294
8295
8296
8297 .section "Host list patterns for single-key lookups by host name" &&&
8298          "SECThoslispatnamsk"
8299 .cindex "unknown host name"
8300 .cindex "host list" "matching host name"
8301 If a pattern is of the form
8302 .display
8303 <&'single-key-search-type'&>;<&'search-data'&>
8304 .endd
8305 for example
8306 .code
8307 dbm;/host/accept/list
8308 .endd
8309 a single-key lookup is performed, using the host name as its key. If the
8310 lookup succeeds, the host matches the item. The actual data that is looked up
8311 is not used.
8312
8313 &*Reminder*&: With this kind of pattern, you must have host &'names'& as
8314 keys in the file, not IP addresses. If you want to do lookups based on IP
8315 addresses, you must precede the search type with &"net-"& (see section
8316 &<<SECThoslispatsikey>>&). There is, however, no reason why you could not use
8317 two items in the same list, one doing an address lookup and one doing a name
8318 lookup, both using the same file.
8319
8320
8321
8322 .section "Host list patterns for query-style lookups" "SECID81"
8323 If a pattern is of the form
8324 .display
8325 <&'query-style-search-type'&>;<&'query'&>
8326 .endd
8327 the query is obeyed, and if it succeeds, the host matches the item. The actual
8328 data that is looked up is not used. The variables &$sender_host_address$& and
8329 &$sender_host_name$& can be used in the query. For example:
8330 .code
8331 hosts_lookup = pgsql;\
8332   select ip from hostlist where ip='$sender_host_address'
8333 .endd
8334 The value of &$sender_host_address$& for an IPv6 address contains colons. You
8335 can use the &%sg%& expansion item to change this if you need to. If you want to
8336 use masked IP addresses in database queries, you can use the &%mask%& expansion
8337 operator.
8338
8339 If the query contains a reference to &$sender_host_name$&, Exim automatically
8340 looks up the host name if it has not already done so. (See section
8341 &<<SECThoslispatnam>>& for comments on finding host names.)
8342
8343 Historical note: prior to release 4.30, Exim would always attempt to find a
8344 host name before running the query, unless the search type was preceded by
8345 &`net-`&. This is no longer the case. For backwards compatibility, &`net-`& is
8346 still recognized for query-style lookups, but its presence or absence has no
8347 effect. (Of course, for single-key lookups, &`net-`& &'is'& important.
8348 See section &<<SECThoslispatsikey>>&.)
8349
8350
8351
8352 .section "Mixing wildcarded host names and addresses in host lists" &&&
8353          "SECTmixwilhos"
8354 .cindex "host list" "mixing names and addresses in"
8355 If you have name lookups or wildcarded host names and IP addresses in the same
8356 host list, you should normally put the IP addresses first. For example, in an
8357 ACL you could have:
8358 .code
8359 accept hosts = 10.9.8.7 : *.friend.example
8360 .endd
8361 The reason for this lies in the left-to-right way that Exim processes lists.
8362 It can test IP addresses without doing any DNS lookups, but when it reaches an
8363 item that requires a host name, it fails if it cannot find a host name to
8364 compare with the pattern. If the above list is given in the opposite order, the
8365 &%accept%& statement fails for a host whose name cannot be found, even if its
8366 IP address is 10.9.8.7.
8367
8368 If you really do want to do the name check first, and still recognize the IP
8369 address, you can rewrite the ACL like this:
8370 .code
8371 accept hosts = *.friend.example
8372 accept hosts = 10.9.8.7
8373 .endd
8374 If the first &%accept%& fails, Exim goes on to try the second one. See chapter
8375 &<<CHAPACL>>& for details of ACLs.
8376
8377
8378
8379
8380
8381 .section "Address lists" "SECTaddresslist"
8382 .cindex "list" "address list"
8383 .cindex "address list" "empty item"
8384 .cindex "address list" "patterns"
8385 Address lists contain patterns that are matched against mail addresses. There
8386 is one special case to be considered: the sender address of a bounce message is
8387 always empty. You can test for this by providing an empty item in an address
8388 list. For example, you can set up a router to process bounce messages by
8389 using this option setting:
8390 .code
8391 senders = :
8392 .endd
8393 The presence of the colon creates an empty item. If you do not provide any
8394 data, the list is empty and matches nothing. The empty sender can also be
8395 detected by a regular expression that matches an empty string,
8396 and by a query-style lookup that succeeds when &$sender_address$& is empty.
8397
8398 Non-empty items in an address list can be straightforward email addresses. For
8399 example:
8400 .code
8401 senders = jbc@askone.example : hs@anacreon.example
8402 .endd
8403 A certain amount of wildcarding is permitted. If a pattern contains an @
8404 character, but is not a regular expression and does not begin with a
8405 semicolon-terminated lookup type (described below), the local part of the
8406 subject address is compared with the local part of the pattern, which may start
8407 with an asterisk. If the local parts match, the domain is checked in exactly
8408 the same way as for a pattern in a domain list. For example, the domain can be
8409 wildcarded, refer to a named list, or be a lookup:
8410 .code
8411 deny senders = *@*.spamming.site:\
8412                *@+hostile_domains:\
8413                bozo@partial-lsearch;/list/of/dodgy/sites:\
8414                *@dbm;/bad/domains.db
8415 .endd
8416 .cindex "local part" "starting with !"
8417 .cindex "address list" "local part starting with !"
8418 If a local part that begins with an exclamation mark is required, it has to be
8419 specified using a regular expression, because otherwise the exclamation mark is
8420 treated as a sign of negation, as is standard in lists.
8421
8422 If a non-empty pattern that is not a regular expression or a lookup does not
8423 contain an @ character, it is matched against the domain part of the subject
8424 address. The only two formats that are recognized this way are a literal
8425 domain, or a domain pattern that starts with *. In both these cases, the effect
8426 is the same as if &`*@`& preceded the pattern. For example:
8427 .code
8428 deny senders = enemy.domain : *.enemy.domain
8429 .endd
8430
8431 The following kinds of more complicated address list pattern can match any
8432 address, including the empty address that is characteristic of bounce message
8433 senders:
8434
8435 .ilist
8436 .cindex "regular expressions" "in address list"
8437 .cindex "address list" "regular expression in"
8438 If (after expansion) a pattern starts with &"^"&, a regular expression match is
8439 done against the complete address, with the pattern as the regular expression.
8440 You must take care that backslash and dollar characters are not misinterpreted
8441 as part of the string expansion. The simplest way to do this is to use &`\N`&
8442 to mark that part of the string as non-expandable. For example:
8443 .code
8444 deny senders = \N^.*this.*@example\.com$\N : \
8445                \N^\d{8}.+@spamhaus.example$\N : ...
8446 .endd
8447 The &`\N`& sequences are removed by the expansion, so these items do indeed
8448 start with &"^"& by the time they are being interpreted as address patterns.
8449
8450 .next
8451 .cindex "address list" "lookup for complete address"
8452 Complete addresses can be looked up by using a pattern that starts with a
8453 lookup type terminated by a semicolon, followed by the data for the lookup. For
8454 example:
8455 .code
8456 deny senders = cdb;/etc/blocked.senders : \
8457   mysql;select address from blocked where \
8458   address='${quote_mysql:$sender_address}'
8459 .endd
8460 Both query-style and single-key lookup types can be used. For a single-key
8461 lookup type, Exim uses the complete address as the key. However, empty keys are
8462 not supported for single-key lookups, so a match against the empty address
8463 always fails. This restriction does not apply to query-style lookups.
8464
8465 Partial matching for single-key lookups (section &<<SECTpartiallookup>>&)
8466 cannot be used, and is ignored if specified, with an entry being written to the
8467 panic log.
8468 .cindex "*@ with single-key lookup"
8469 However, you can configure lookup defaults, as described in section
8470 &<<SECTdefaultvaluelookups>>&, but this is useful only for the &"*@"& type of
8471 default. For example, with this lookup:
8472 .code
8473 accept senders = lsearch*@;/some/file
8474 .endd
8475 the file could contains lines like this:
8476 .code
8477 user1@domain1.example
8478 *@domain2.example
8479 .endd
8480 and for the sender address &'nimrod@jaeger.example'&, the sequence of keys
8481 that are tried is:
8482 .code
8483 nimrod@jaeger.example
8484 *@jaeger.example
8485 *
8486 .endd
8487 &*Warning 1*&: Do not include a line keyed by &"*"& in the file, because that
8488 would mean that every address matches, thus rendering the test useless.
8489
8490 &*Warning 2*&: Do not confuse these two kinds of item:
8491 .code
8492 deny recipients = dbm*@;/some/file
8493 deny recipients = *@dbm;/some/file
8494 .endd
8495 The first does a whole address lookup, with defaulting, as just described,
8496 because it starts with a lookup type. The second matches the local part and
8497 domain independently, as described in a bullet point below.
8498 .endlist
8499
8500
8501 The following kinds of address list pattern can match only non-empty addresses.
8502 If the subject address is empty, a match against any of these pattern types
8503 always fails.
8504
8505
8506 .ilist
8507 .cindex "@@ with single-key lookup"
8508 .cindex "address list" "@@ lookup type"
8509 .cindex "address list" "split local part and domain"
8510 If a pattern starts with &"@@"& followed by a single-key lookup item
8511 (for example, &`@@lsearch;/some/file`&), the address that is being checked is
8512 split into a local part and a domain. The domain is looked up in the file. If
8513 it is not found, there is no match. If it is found, the data that is looked up
8514 from the file is treated as a colon-separated list of local part patterns, each
8515 of which is matched against the subject local part in turn.
8516
8517 .cindex "asterisk" "in address list"
8518 The lookup may be a partial one, and/or one involving a search for a default
8519 keyed by &"*"& (see section &<<SECTdefaultvaluelookups>>&). The local part
8520 patterns that are looked up can be regular expressions or begin with &"*"&, or
8521 even be further lookups. They may also be independently negated. For example,
8522 with
8523 .code
8524 deny senders = @@dbm;/etc/reject-by-domain
8525 .endd
8526 the data from which the DBM file is built could contain lines like
8527 .code
8528 baddomain.com:  !postmaster : *
8529 .endd
8530 to reject all senders except &%postmaster%& from that domain.
8531
8532 .cindex "local part" "starting with !"
8533 If a local part that actually begins with an exclamation mark is required, it
8534 has to be specified using a regular expression. In &(lsearch)& files, an entry
8535 may be split over several lines by indenting the second and subsequent lines,
8536 but the separating colon must still be included at line breaks. White space
8537 surrounding the colons is ignored. For example:
8538 .code
8539 aol.com:  spammer1 : spammer2 : ^[0-9]+$ :
8540   spammer3 : spammer4
8541 .endd
8542 As in all colon-separated lists in Exim, a colon can be included in an item by
8543 doubling.
8544
8545 If the last item in the list starts with a right angle-bracket, the remainder
8546 of the item is taken as a new key to look up in order to obtain a continuation
8547 list of local parts. The new key can be any sequence of characters. Thus one
8548 might have entries like
8549 .code
8550 aol.com: spammer1 : spammer 2 : >*
8551 xyz.com: spammer3 : >*
8552 *:       ^\d{8}$
8553 .endd
8554 in a file that was searched with &%@@dbm*%&, to specify a match for 8-digit
8555 local parts for all domains, in addition to the specific local parts listed for
8556 each domain. Of course, using this feature costs another lookup each time a
8557 chain is followed, but the effort needed to maintain the data is reduced.
8558
8559 .cindex "loop" "in lookups"
8560 It is possible to construct loops using this facility, and in order to catch
8561 them, the chains may be no more than fifty items long.
8562
8563 .next
8564 The @@<&'lookup'&> style of item can also be used with a query-style
8565 lookup, but in this case, the chaining facility is not available. The lookup
8566 can only return a single list of local parts.
8567 .endlist
8568
8569 &*Warning*&: There is an important difference between the address list items
8570 in these two examples:
8571 .code
8572 senders = +my_list
8573 senders = *@+my_list
8574 .endd
8575 In the first one, &`my_list`& is a named address list, whereas in the second
8576 example it is a named domain list.
8577
8578
8579
8580
8581 .section "Case of letters in address lists" "SECTcasletadd"
8582 .cindex "case of local parts"
8583 .cindex "address list" "case forcing"
8584 .cindex "case forcing in address lists"
8585 Domains in email addresses are always handled caselessly, but for local parts
8586 case may be significant on some systems (see &%caseful_local_part%& for how
8587 Exim deals with this when routing addresses). However, RFC 2505 (&'Anti-Spam
8588 Recommendations for SMTP MTAs'&) suggests that matching of addresses to
8589 blocking lists should be done in a case-independent manner. Since most address
8590 lists in Exim are used for this kind of control, Exim attempts to do this by
8591 default.
8592
8593 The domain portion of an address is always lowercased before matching it to an
8594 address list. The local part is lowercased by default, and any string
8595 comparisons that take place are done caselessly. This means that the data in
8596 the address list itself, in files included as plain file names, and in any file
8597 that is looked up using the &"@@"& mechanism, can be in any case. However, the
8598 keys in files that are looked up by a search type other than &(lsearch)& (which
8599 works caselessly) must be in lower case, because these lookups are not
8600 case-independent.
8601
8602 .cindex "&`+caseful`&"
8603 To allow for the possibility of caseful address list matching, if an item in
8604 an address list is the string &"+caseful"&, the original case of the local
8605 part is restored for any comparisons that follow, and string comparisons are no
8606 longer case-independent. This does not affect the domain, which remains in
8607 lower case. However, although independent matches on the domain alone are still
8608 performed caselessly, regular expressions that match against an entire address
8609 become case-sensitive after &"+caseful"& has been seen.
8610
8611
8612
8613 .section "Local part lists" "SECTlocparlis"
8614 .cindex "list" "local part list"
8615 .cindex "local part" "list"
8616 Case-sensitivity in local part lists is handled in the same way as for address
8617 lists, as just described. The &"+caseful"& item can be used if required. In a
8618 setting of the &%local_parts%& option in a router with &%caseful_local_part%&
8619 set false, the subject is lowercased and the matching is initially
8620 case-insensitive. In this case, &"+caseful"& will restore case-sensitive
8621 matching in the local part list, but not elsewhere in the router. If
8622 &%caseful_local_part%& is set true in a router, matching in the &%local_parts%&
8623 option is case-sensitive from the start.
8624
8625 If a local part list is indirected to a file (see section &<<SECTfilnamlis>>&),
8626 comments are handled in the same way as address lists &-- they are recognized
8627 only if the # is preceded by white space or the start of the line.
8628 Otherwise, local part lists are matched in the same way as domain lists, except
8629 that the special items that refer to the local host (&`@`&, &`@[]`&,
8630 &`@mx_any`&, &`@mx_primary`&, and &`@mx_secondary`&) are not recognized.
8631 Refer to section &<<SECTdomainlist>>& for details of the other available item
8632 types.
8633 .ecindex IIDdohoadli
8634
8635
8636
8637
8638 . ////////////////////////////////////////////////////////////////////////////
8639 . ////////////////////////////////////////////////////////////////////////////
8640
8641 .chapter "String expansions" "CHAPexpand"
8642 .scindex IIDstrexp "expansion" "of strings"
8643 Many strings in Exim's run time configuration are expanded before use. Some of
8644 them are expanded every time they are used; others are expanded only once.
8645
8646 When a string is being expanded it is copied verbatim from left to right except
8647 when a dollar or backslash character is encountered. A dollar specifies the
8648 start of a portion of the string that is interpreted and replaced as described
8649 below in section &<<SECTexpansionitems>>& onwards. Backslash is used as an
8650 escape character, as described in the following section.
8651
8652 Whether a string is expanded depends upon the context.  Usually this is solely
8653 dependent upon the option for which a value is sought; in this documentation,
8654 options for which string expansion is performed are marked with &dagger; after
8655 the data type.  ACL rules always expand strings.  A couple of expansion
8656 conditions do not expand some of the brace-delimited branches, for security
8657 reasons.
8658
8659
8660
8661 .section "Literal text in expanded strings" "SECTlittext"
8662 .cindex "expansion" "including literal text"
8663 An uninterpreted dollar can be included in an expanded string by putting a
8664 backslash in front of it. A backslash can be used to prevent any special
8665 character being treated specially in an expansion, including backslash itself.
8666 If the string appears in quotes in the configuration file, two backslashes are
8667 required because the quotes themselves cause interpretation of backslashes when
8668 the string is read in (see section &<<SECTstrings>>&).
8669
8670 .cindex "expansion" "non-expandable substrings"
8671 A portion of the string can specified as non-expandable by placing it between
8672 two occurrences of &`\N`&. This is particularly useful for protecting regular
8673 expressions, which often contain backslashes and dollar signs. For example:
8674 .code
8675 deny senders = \N^\d{8}[a-z]@some\.site\.example$\N
8676 .endd
8677 On encountering the first &`\N`&, the expander copies subsequent characters
8678 without interpretation until it reaches the next &`\N`& or the end of the
8679 string.
8680
8681
8682
8683 .section "Character escape sequences in expanded strings" "SECID82"
8684 .cindex "expansion" "escape sequences"
8685 A backslash followed by one of the letters &"n"&, &"r"&, or &"t"& in an
8686 expanded string is recognized as an escape sequence for the character newline,
8687 carriage return, or tab, respectively. A backslash followed by up to three
8688 octal digits is recognized as an octal encoding for a single character, and a
8689 backslash followed by &"x"& and up to two hexadecimal digits is a hexadecimal
8690 encoding.
8691
8692 These escape sequences are also recognized in quoted strings when they are read
8693 in. Their interpretation in expansions as well is useful for unquoted strings,
8694 and for other cases such as looked-up strings that are then expanded.
8695
8696
8697 .section "Testing string expansions" "SECID83"
8698 .cindex "expansion" "testing"
8699 .cindex "testing" "string expansion"
8700 .oindex "&%-be%&"
8701 Many expansions can be tested by calling Exim with the &%-be%& option. This
8702 takes the command arguments, or lines from the standard input if there are no
8703 arguments, runs them through the string expansion code, and writes the results
8704 to the standard output. Variables based on configuration values are set up, but
8705 since no message is being processed, variables such as &$local_part$& have no
8706 value. Nevertheless the &%-be%& option can be useful for checking out file and
8707 database lookups, and the use of expansion operators such as &%sg%&, &%substr%&
8708 and &%nhash%&.
8709
8710 Exim gives up its root privilege when it is called with the &%-be%& option, and
8711 instead runs under the uid and gid it was called with, to prevent users from
8712 using &%-be%& for reading files to which they do not have access.
8713
8714 .oindex "&%-bem%&"
8715 If you want to test expansions that include variables whose values are taken
8716 from a message, there are two other options that can be used. The &%-bem%&
8717 option is like &%-be%& except that it is followed by a file name. The file is
8718 read as a message before doing the test expansions. For example:
8719 .code
8720 exim -bem /tmp/test.message '$h_subject:'
8721 .endd
8722 The &%-Mset%& option is used in conjunction with &%-be%& and is followed by an
8723 Exim message identifier. For example:
8724 .code
8725 exim -be -Mset 1GrA8W-0004WS-LQ '$recipients'
8726 .endd
8727 This loads the message from Exim's spool before doing the test expansions, and
8728 is therefore restricted to admin users.
8729
8730
8731 .section "Forced expansion failure" "SECTforexpfai"
8732 .cindex "expansion" "forced failure"
8733 A number of expansions that are described in the following section have
8734 alternative &"true"& and &"false"& substrings, enclosed in brace characters
8735 (which are sometimes called &"curly brackets"&). Which of the two strings is
8736 used depends on some condition that is evaluated as part of the expansion. If,
8737 instead of a &"false"& substring, the word &"fail"& is used (not in braces),
8738 the entire string expansion fails in a way that can be detected by the code
8739 that requested the expansion. This is called &"forced expansion failure"&, and
8740 its consequences depend on the circumstances. In some cases it is no different
8741 from any other expansion failure, but in others a different action may be
8742 taken. Such variations are mentioned in the documentation of the option that is
8743 being expanded.
8744
8745
8746
8747
8748 .section "Expansion items" "SECTexpansionitems"
8749 The following items are recognized in expanded strings. White space may be used
8750 between sub-items that are keywords or substrings enclosed in braces inside an
8751 outer set of braces, to improve readability. &*Warning*&: Within braces,
8752 white space is significant.
8753
8754 .vlist
8755 .vitem &*$*&<&'variable&~name'&>&~or&~&*${*&<&'variable&~name'&>&*}*&
8756 .cindex "expansion" "variables"
8757 Substitute the contents of the named variable, for example:
8758 .code
8759 $local_part
8760 ${domain}
8761 .endd
8762 The second form can be used to separate the name from subsequent alphanumeric
8763 characters. This form (using braces) is available only for variables; it does
8764 &'not'& apply to message headers. The names of the variables are given in
8765 section &<<SECTexpvar>>& below. If the name of a non-existent variable is
8766 given, the expansion fails.
8767
8768 .vitem &*${*&<&'op'&>&*:*&<&'string'&>&*}*&
8769 .cindex "expansion" "operators"
8770 The string is first itself expanded, and then the operation specified by
8771 <&'op'&> is applied to it. For example:
8772 .code
8773 ${lc:$local_part}
8774 .endd
8775 The string starts with the first character after the colon, which may be
8776 leading white space. A list of operators is given in section &<<SECTexpop>>&
8777 below. The operator notation is used for simple expansion items that have just
8778 one argument, because it reduces the number of braces and therefore makes the
8779 string easier to understand.
8780
8781 .vitem &*$bheader_*&<&'header&~name'&>&*:*&&~or&~&*$bh_*&<&'header&~name'&>&*:*&
8782 This item inserts &"basic"& header lines. It is described with the &%header%&
8783 expansion item below.
8784
8785
8786 .vitem "&*${acl{*&<&'name'&>&*}{*&<&'arg'&>&*}...}*&"
8787 .cindex "expansion" "calling an acl"
8788 .cindex "&%acl%&" "call from expansion"
8789 The name and zero to nine argument strings are first expanded separately.  The expanded
8790 arguments are assigned to the variables &$acl_arg1$& to &$acl_arg9$& in order.
8791 Any unused are made empty.  The variable &$acl_narg$& is set to the number of
8792 arguments.  The named ACL (see chapter &<<CHAPACL>>&) is called
8793 and may use the variables; if another acl expansion is used the values
8794 are restored after it returns.  If the ACL sets
8795 a value using a "message =" modifier and returns accept or deny, the value becomes
8796 the result of the expansion.
8797 If no message is set and the ACL returns accept or deny
8798 the expansion result is an empty string.
8799 If the ACL returns defer the result is a forced-fail.  Otherwise the expansion fails.
8800
8801
8802 .vitem "&*${dlfunc{*&<&'file'&>&*}{*&<&'function'&>&*}{*&<&'arg'&>&*}&&&
8803        {*&<&'arg'&>&*}...}*&"
8804 .cindex &%dlfunc%&
8805 This expansion dynamically loads and then calls a locally-written C function.
8806 This functionality is available only if Exim is compiled with
8807 .code
8808 EXPAND_DLFUNC=yes
8809 .endd
8810 set in &_Local/Makefile_&. Once loaded, Exim remembers the dynamically loaded
8811 object so that it doesn't reload the same object file in the same Exim process
8812 (but of course Exim does start new processes frequently).
8813
8814 There may be from zero to eight arguments to the function. When compiling
8815 a local function that is to be called in this way, &_local_scan.h_& should be
8816 included. The Exim variables and functions that are defined by that API
8817 are also available for dynamically loaded functions. The function itself
8818 must have the following type:
8819 .code
8820 int dlfunction(uschar **yield, int argc, uschar *argv[])
8821 .endd
8822 Where &`uschar`& is a typedef for &`unsigned char`& in &_local_scan.h_&. The
8823 function should return one of the following values:
8824
8825 &`OK`&: Success. The string that is placed in the variable &'yield'& is put
8826 into the expanded string that is being built.
8827
8828 &`FAIL`&: A non-forced expansion failure occurs, with the error message taken
8829 from &'yield'&, if it is set.
8830
8831 &`FAIL_FORCED`&: A forced expansion failure occurs, with the error message
8832 taken from &'yield'& if it is set.
8833
8834 &`ERROR`&: Same as &`FAIL`&, except that a panic log entry is written.
8835
8836 When compiling a function that is to be used in this way with gcc,
8837 you need to add &%-shared%& to the gcc command. Also, in the Exim build-time
8838 configuration, you must add &%-export-dynamic%& to EXTRALIBS.
8839
8840 .vitem "&*${extract{*&<&'key'&>&*}{*&<&'string1'&>&*}{*&<&'string2'&>&*}&&&
8841        {*&<&'string3'&>&*}}*&"
8842 .cindex "expansion" "extracting substrings by key"
8843 .cindex "&%extract%&" "substrings by key"
8844 The key and <&'string1'&> are first expanded separately. Leading and trailing
8845 white space is removed from the key (but not from any of the strings). The key
8846 must not consist entirely of digits. The expanded <&'string1'&> must be of the
8847 form:
8848 .display
8849 <&'key1'&> = <&'value1'&>  <&'key2'&> = <&'value2'&> ...
8850 .endd
8851 .vindex "&$value$&"
8852 where the equals signs and spaces (but not both) are optional. If any of the
8853 values contain white space, they must be enclosed in double quotes, and any
8854 values that are enclosed in double quotes are subject to escape processing as
8855 described in section &<<SECTstrings>>&. The expanded <&'string1'&> is searched
8856 for the value that corresponds to the key. The search is case-insensitive. If
8857 the key is found, <&'string2'&> is expanded, and replaces the whole item;
8858 otherwise <&'string3'&> is used. During the expansion of <&'string2'&> the
8859 variable &$value$& contains the value that has been extracted. Afterwards, it
8860 is restored to any previous value it might have had.
8861
8862 If {<&'string3'&>} is omitted, the item is replaced by an empty string if the
8863 key is not found. If {<&'string2'&>} is also omitted, the value that was
8864 extracted is used. Thus, for example, these two expansions are identical, and
8865 yield &"2001"&:
8866 .code
8867 ${extract{gid}{uid=1984 gid=2001}}
8868 ${extract{gid}{uid=1984 gid=2001}{$value}}
8869 .endd
8870 Instead of {<&'string3'&>} the word &"fail"& (not in curly brackets) can
8871 appear, for example:
8872 .code
8873 ${extract{Z}{A=... B=...}{$value} fail }
8874 .endd
8875 This forces an expansion failure (see section &<<SECTforexpfai>>&);
8876 {<&'string2'&>} must be present for &"fail"& to be recognized.
8877
8878
8879 .vitem "&*${extract{*&<&'number'&>&*}{*&<&'separators'&>&*}&&&
8880         {*&<&'string1'&>&*}{*&<&'string2'&>&*}{*&<&'string3'&>&*}}*&"
8881 .cindex "expansion" "extracting substrings by number"
8882 .cindex "&%extract%&" "substrings by number"
8883 The <&'number'&> argument must consist entirely of decimal digits,
8884 apart from leading and trailing white space, which is ignored.
8885 This is what distinguishes this form of &%extract%& from the previous kind. It
8886 behaves in the same way, except that, instead of extracting a named field, it
8887 extracts from <&'string1'&> the field whose number is given as the first
8888 argument. You can use &$value$& in <&'string2'&> or &`fail`& instead of
8889 <&'string3'&> as before.
8890
8891 The fields in the string are separated by any one of the characters in the
8892 separator string. These may include space or tab characters.
8893 The first field is numbered one. If the number is negative, the fields are
8894 counted from the end of the string, with the rightmost one numbered -1. If the
8895 number given is zero, the entire string is returned. If the modulus of the
8896 number is greater than the number of fields in the string, the result is the
8897 expansion of <&'string3'&>, or the empty string if <&'string3'&> is not
8898 provided. For example:
8899 .code
8900 ${extract{2}{:}{x:42:99:& Mailer::/bin/bash}}
8901 .endd
8902 yields &"42"&, and
8903 .code
8904 ${extract{-4}{:}{x:42:99:& Mailer::/bin/bash}}
8905 .endd
8906 yields &"99"&. Two successive separators mean that the field between them is
8907 empty (for example, the fifth field above).
8908
8909
8910 .vitem &*${filter{*&<&'string'&>&*}{*&<&'condition'&>&*}}*&
8911 .cindex "list" "selecting by condition"
8912 .cindex "expansion" "selecting from list by condition"
8913 .vindex "&$item$&"
8914 After expansion, <&'string'&> is interpreted as a list, colon-separated by
8915 default, but the separator can be changed in the usual way. For each item
8916 in this list, its value is place in &$item$&, and then the condition is
8917 evaluated. If the condition is true, &$item$& is added to the output as an
8918 item in a new list; if the condition is false, the item is discarded. The
8919 separator used for the output list is the same as the one used for the
8920 input, but a separator setting is not included in the output. For example:
8921 .code
8922 ${filter{a:b:c}{!eq{$item}{b}}
8923 .endd
8924 yields &`a:c`&. At the end of the expansion, the value of &$item$& is restored
8925 to what it was before. See also the &*map*& and &*reduce*& expansion items.
8926
8927
8928 .vitem &*${hash{*&<&'string1'&>&*}{*&<&'string2'&>&*}{*&<&'string3'&>&*}}*&
8929 .cindex "hash function" "textual"
8930 .cindex "expansion" "textual hash"
8931 This is a textual hashing function, and was the first to be implemented in
8932 early versions of Exim. In current releases, there are other hashing functions
8933 (numeric, MD5, and SHA-1), which are described below.
8934
8935 The first two strings, after expansion, must be numbers. Call them <&'m'&> and
8936 <&'n'&>. If you are using fixed values for these numbers, that is, if
8937 <&'string1'&> and <&'string2'&> do not change when they are expanded, you can
8938 use the simpler operator notation that avoids some of the braces:
8939 .code
8940 ${hash_<n>_<m>:<string>}
8941 .endd
8942 The second number is optional (in both notations). If <&'n'&> is greater than
8943 or equal to the length of the string, the expansion item returns the string.
8944 Otherwise it computes a new string of length <&'n'&> by applying a hashing
8945 function to the string. The new string consists of characters taken from the
8946 first <&'m'&> characters of the string
8947 .code
8948 abcdefghijklmnopqrstuvwxyzABCDEFGHIJKLMNOPQWRSTUVWXYZ0123456789
8949 .endd
8950 If <&'m'&> is not present the value 26 is used, so that only lower case
8951 letters appear. For example:
8952 .display
8953 &`$hash{3}{monty}}           `&   yields  &`jmg`&
8954 &`$hash{5}{monty}}           `&   yields  &`monty`&
8955 &`$hash{4}{62}{monty python}}`&   yields  &`fbWx`&
8956 .endd
8957
8958 .vitem "&*$header_*&<&'header&~name'&>&*:*&&~or&~&&&
8959         &*$h_*&<&'header&~name'&>&*:*&" &&&
8960        "&*$bheader_*&<&'header&~name'&>&*:*&&~or&~&&&
8961         &*$bh_*&<&'header&~name'&>&*:*&" &&&
8962        "&*$rheader_*&<&'header&~name'&>&*:*&&~or&~&&&
8963         &*$rh_*&<&'header&~name'&>&*:*&"
8964 .cindex "expansion" "header insertion"
8965 .vindex "&$header_$&"
8966 .vindex "&$bheader_$&"
8967 .vindex "&$rheader_$&"
8968 .cindex "header lines" "in expansion strings"
8969 .cindex "header lines" "character sets"
8970 .cindex "header lines" "decoding"
8971 Substitute the contents of the named message header line, for example
8972 .code
8973 $header_reply-to:
8974 .endd
8975 The newline that terminates a header line is not included in the expansion, but
8976 internal newlines (caused by splitting the header line over several physical
8977 lines) may be present.
8978
8979 The difference between &%rheader%&, &%bheader%&, and &%header%& is in the way
8980 the data in the header line is interpreted.
8981
8982 .ilist
8983 .cindex "white space" "in header lines"
8984 &%rheader%& gives the original &"raw"& content of the header line, with no
8985 processing at all, and without the removal of leading and trailing white space.
8986
8987 .next
8988 .cindex "base64 encoding" "in header lines"
8989 &%bheader%& removes leading and trailing white space, and then decodes base64
8990 or quoted-printable MIME &"words"& within the header text, but does no
8991 character set translation. If decoding of what looks superficially like a MIME
8992 &"word"& fails, the raw string is returned. If decoding
8993 .cindex "binary zero" "in header line"
8994 produces a binary zero character, it is replaced by a question mark &-- this is
8995 what Exim does for binary zeros that are actually received in header lines.
8996
8997 .next
8998 &%header%& tries to translate the string as decoded by &%bheader%& to a
8999 standard character set. This is an attempt to produce the same string as would
9000 be displayed on a user's MUA. If translation fails, the &%bheader%& string is
9001 returned. Translation is attempted only on operating systems that support the
9002 &[iconv()]& function. This is indicated by the compile-time macro HAVE_ICONV in
9003 a system Makefile or in &_Local/Makefile_&.
9004 .endlist ilist
9005
9006 In a filter file, the target character set for &%header%& can be specified by a
9007 command of the following form:
9008 .code
9009 headers charset "UTF-8"
9010 .endd
9011 This command affects all references to &$h_$& (or &$header_$&) expansions in
9012 subsequently obeyed filter commands. In the absence of this command, the target
9013 character set in a filter is taken from the setting of the &%headers_charset%&
9014 option in the runtime configuration. The value of this option defaults to the
9015 value of HEADERS_CHARSET in &_Local/Makefile_&. The ultimate default is
9016 ISO-8859-1.
9017
9018 Header names follow the syntax of RFC 2822, which states that they may contain
9019 any printing characters except space and colon. Consequently, curly brackets
9020 &'do not'& terminate header names, and should not be used to enclose them as
9021 if they were variables. Attempting to do so causes a syntax error.
9022
9023 Only header lines that are common to all copies of a message are visible to
9024 this mechanism. These are the original header lines that are received with the
9025 message, and any that are added by an ACL statement or by a system
9026 filter. Header lines that are added to a particular copy of a message by a
9027 router or transport are not accessible.
9028
9029 For incoming SMTP messages, no header lines are visible in ACLs that are obeyed
9030 before the DATA ACL, because the header structure is not set up until the
9031 message is received. Header lines that are added in a RCPT ACL (for example)
9032 are saved until the message's incoming header lines are available, at which
9033 point they are added. When a DATA ACL is running, however, header lines added
9034 by earlier ACLs are visible.
9035
9036 Upper case and lower case letters are synonymous in header names. If the
9037 following character is white space, the terminating colon may be omitted, but
9038 this is not recommended, because you may then forget it when it is needed. When
9039 white space terminates the header name, it is included in the expanded string.
9040 If the message does not contain the given header, the expansion item is
9041 replaced by an empty string. (See the &%def%& condition in section
9042 &<<SECTexpcond>>& for a means of testing for the existence of a header.)
9043
9044 If there is more than one header with the same name, they are all concatenated
9045 to form the substitution string, up to a maximum length of 64K. Unless
9046 &%rheader%& is being used, leading and trailing white space is removed from
9047 each header before concatenation, and a completely empty header is ignored. A
9048 newline character is then inserted between non-empty headers, but there is no
9049 newline at the very end. For the &%header%& and &%bheader%& expansion, for
9050 those headers that contain lists of addresses, a comma is also inserted at the
9051 junctions between headers. This does not happen for the &%rheader%& expansion.
9052
9053
9054 .vitem &*${hmac{*&<&'hashname'&>&*}{*&<&'secret'&>&*}{*&<&'string'&>&*}}*&
9055 .cindex "expansion" "hmac hashing"
9056 .cindex &%hmac%&
9057 This function uses cryptographic hashing (either MD5 or SHA-1) to convert a
9058 shared secret and some text into a message authentication code, as specified in
9059 RFC 2104. This differs from &`${md5:secret_text...}`& or
9060 &`${sha1:secret_text...}`& in that the hmac step adds a signature to the
9061 cryptographic hash, allowing for authentication that is not possible with MD5
9062 or SHA-1 alone. The hash name must expand to either &`md5`& or &`sha1`& at
9063 present. For example:
9064 .code
9065 ${hmac{md5}{somesecret}{$primary_hostname $tod_log}}
9066 .endd
9067 For the hostname &'mail.example.com'& and time 2002-10-17 11:30:59, this
9068 produces:
9069 .code
9070 dd97e3ba5d1a61b5006108f8c8252953
9071 .endd
9072 As an example of how this might be used, you might put in the main part of
9073 an Exim configuration:
9074 .code
9075 SPAMSCAN_SECRET=cohgheeLei2thahw
9076 .endd
9077 In a router or a transport you could then have:
9078 .code
9079 headers_add = \
9080   X-Spam-Scanned: ${primary_hostname} ${message_exim_id} \
9081   ${hmac{md5}{SPAMSCAN_SECRET}\
9082   {${primary_hostname},${message_exim_id},$h_message-id:}}
9083 .endd
9084 Then given a message, you can check where it was scanned by looking at the
9085 &'X-Spam-Scanned:'& header line. If you know the secret, you can check that
9086 this header line is authentic by recomputing the authentication code from the
9087 host name, message ID and the &'Message-id:'& header line. This can be done
9088 using Exim's &%-be%& option, or by other means, for example by using the
9089 &'hmac_md5_hex()'& function in Perl.
9090
9091
9092 .vitem &*${if&~*&<&'condition'&>&*&~{*&<&'string1'&>&*}{*&<&'string2'&>&*}}*&
9093 .cindex "expansion" "conditional"
9094 .cindex "&%if%&, expansion item"
9095 If <&'condition'&> is true, <&'string1'&> is expanded and replaces the whole
9096 item; otherwise <&'string2'&> is used. The available conditions are described
9097 in section &<<SECTexpcond>>& below. For example:
9098 .code
9099 ${if eq {$local_part}{postmaster} {yes}{no} }
9100 .endd
9101 The second string need not be present; if it is not and the condition is not
9102 true, the item is replaced with nothing. Alternatively, the word &"fail"& may
9103 be present instead of the second string (without any curly brackets). In this
9104 case, the expansion is forced to fail if the condition is not true (see section
9105 &<<SECTforexpfai>>&).
9106
9107 If both strings are omitted, the result is the string &`true`& if the condition
9108 is true, and the empty string if the condition is false. This makes it less
9109 cumbersome to write custom ACL and router conditions. For example, instead of
9110 .code
9111 condition = ${if >{$acl_m4}{3}{true}{false}}
9112 .endd
9113 you can use
9114 .code
9115 condition = ${if >{$acl_m4}{3}}
9116 .endd
9117
9118 .vitem &*${length{*&<&'string1'&>&*}{*&<&'string2'&>&*}}*&
9119 .cindex "expansion" "string truncation"
9120 .cindex "&%length%& expansion item"
9121 The &%length%& item is used to extract the initial portion of a string. Both
9122 strings are expanded, and the first one must yield a number, <&'n'&>, say. If
9123 you are using a fixed value for the number, that is, if <&'string1'&> does not
9124 change when expanded, you can use the simpler operator notation that avoids
9125 some of the braces:
9126 .code
9127 ${length_<n>:<string>}
9128 .endd
9129 The result of this item is either the first <&'n'&> characters or the whole
9130 of <&'string2'&>, whichever is the shorter. Do not confuse &%length%& with
9131 &%strlen%&, which gives the length of a string.
9132
9133
9134 .vitem "&*${lookup{*&<&'key'&>&*}&~*&<&'search&~type'&>&*&~&&&
9135         {*&<&'file'&>&*}&~{*&<&'string1'&>&*}&~{*&<&'string2'&>&*}}*&"
9136 This is the first of one of two different types of lookup item, which are both
9137 described in the next item.
9138
9139 .vitem "&*${lookup&~*&<&'search&~type'&>&*&~{*&<&'query'&>&*}&~&&&
9140         {*&<&'string1'&>&*}&~{*&<&'string2'&>&*}}*&"
9141 .cindex "expansion" "lookup in"
9142 .cindex "file" "lookups"
9143 .cindex "lookup" "in expanded string"
9144 The two forms of lookup item specify data lookups in files and databases, as
9145 discussed in chapter &<<CHAPfdlookup>>&. The first form is used for single-key
9146 lookups, and the second is used for query-style lookups. The <&'key'&>,
9147 <&'file'&>, and <&'query'&> strings are expanded before use.
9148
9149 If there is any white space in a lookup item which is part of a filter command,
9150 a retry or rewrite rule, a routing rule for the &(manualroute)& router, or any
9151 other place where white space is significant, the lookup item must be enclosed
9152 in double quotes. The use of data lookups in users' filter files may be locked
9153 out by the system administrator.
9154
9155 .vindex "&$value$&"
9156 If the lookup succeeds, <&'string1'&> is expanded and replaces the entire item.
9157 During its expansion, the variable &$value$& contains the data returned by the
9158 lookup. Afterwards it reverts to the value it had previously (at the outer
9159 level it is empty). If the lookup fails, <&'string2'&> is expanded and replaces
9160 the entire item. If {<&'string2'&>} is omitted, the replacement is the empty
9161 string on failure. If <&'string2'&> is provided, it can itself be a nested
9162 lookup, thus providing a mechanism for looking up a default value when the
9163 original lookup fails.
9164
9165 If a nested lookup is used as part of <&'string1'&>, &$value$& contains the
9166 data for the outer lookup while the parameters of the second lookup are
9167 expanded, and also while <&'string2'&> of the second lookup is expanded, should
9168 the second lookup fail. Instead of {<&'string2'&>} the word &"fail"& can
9169 appear, and in this case, if the lookup fails, the entire expansion is forced
9170 to fail (see section &<<SECTforexpfai>>&). If both {<&'string1'&>} and
9171 {<&'string2'&>} are omitted, the result is the looked up value in the case of a
9172 successful lookup, and nothing in the case of failure.
9173
9174 For single-key lookups, the string &"partial"& is permitted to precede the
9175 search type in order to do partial matching, and * or *@ may follow a search
9176 type to request default lookups if the key does not match (see sections
9177 &<<SECTdefaultvaluelookups>>& and &<<SECTpartiallookup>>& for details).
9178
9179 .cindex "numerical variables (&$1$& &$2$& etc)" "in lookup expansion"
9180 If a partial search is used, the variables &$1$& and &$2$& contain the wild
9181 and non-wild parts of the key during the expansion of the replacement text.
9182 They return to their previous values at the end of the lookup item.
9183
9184 This example looks up the postmaster alias in the conventional alias file:
9185 .code
9186 ${lookup {postmaster} lsearch {/etc/aliases} {$value}}
9187 .endd
9188 This example uses NIS+ to look up the full name of the user corresponding to
9189 the local part of an address, forcing the expansion to fail if it is not found:
9190 .code
9191 ${lookup nisplus {[name=$local_part],passwd.org_dir:gcos} \
9192   {$value}fail}
9193 .endd
9194
9195
9196 .vitem &*${map{*&<&'string1'&>&*}{*&<&'string2'&>&*}}*&
9197 .cindex "expansion" "list creation"
9198 .vindex "&$item$&"
9199 After expansion, <&'string1'&> is interpreted as a list, colon-separated by
9200 default, but the separator can be changed in the usual way. For each item
9201 in this list, its value is place in &$item$&, and then <&'string2'&> is
9202 expanded and added to the output as an item in a new list. The separator used
9203 for the output list is the same as the one used for the input, but a separator
9204 setting is not included in the output. For example:
9205 .code
9206 ${map{a:b:c}{[$item]}} ${map{<- x-y-z}{($item)}}
9207 .endd
9208 expands to &`[a]:[b]:[c] (x)-(y)-(z)`&. At the end of the expansion, the
9209 value of &$item$& is restored to what it was before. See also the &*filter*&
9210 and &*reduce*& expansion items.
9211
9212 .vitem &*${nhash{*&<&'string1'&>&*}{*&<&'string2'&>&*}{*&<&'string3'&>&*}}*&
9213 .cindex "expansion" "numeric hash"
9214 .cindex "hash function" "numeric"
9215 The three strings are expanded; the first two must yield numbers. Call them
9216 <&'n'&> and <&'m'&>. If you are using fixed values for these numbers, that is,
9217 if <&'string1'&> and <&'string2'&> do not change when they are expanded, you
9218 can use the simpler operator notation that avoids some of the braces:
9219 .code
9220 ${nhash_<n>_<m>:<string>}
9221 .endd
9222 The second number is optional (in both notations). If there is only one number,
9223 the result is a number in the range 0&--<&'n'&>-1. Otherwise, the string is
9224 processed by a div/mod hash function that returns two numbers, separated by a
9225 slash, in the ranges 0 to <&'n'&>-1 and 0 to <&'m'&>-1, respectively. For
9226 example,
9227 .code
9228 ${nhash{8}{64}{supercalifragilisticexpialidocious}}
9229 .endd
9230 returns the string &"6/33"&.
9231
9232
9233
9234 .vitem &*${perl{*&<&'subroutine'&>&*}{*&<&'arg'&>&*}{*&<&'arg'&>&*}...}*&
9235 .cindex "Perl" "use in expanded string"
9236 .cindex "expansion" "calling Perl from"
9237 This item is available only if Exim has been built to include an embedded Perl
9238 interpreter. The subroutine name and the arguments are first separately
9239 expanded, and then the Perl subroutine is called with those arguments. No
9240 additional arguments need be given; the maximum number permitted, including the
9241 name of the subroutine, is nine.
9242
9243 The return value of the subroutine is inserted into the expanded string, unless
9244 the return value is &%undef%&. In that case, the expansion fails in the same
9245 way as an explicit &"fail"& on a lookup item. The return value is a scalar.
9246 Whatever you return is evaluated in a scalar context. For example, if you
9247 return the name of a Perl vector, the return value is the size of the vector,
9248 not its contents.
9249
9250 If the subroutine exits by calling Perl's &%die%& function, the expansion fails
9251 with the error message that was passed to &%die%&. More details of the embedded
9252 Perl facility are given in chapter &<<CHAPperl>>&.
9253
9254 The &(redirect)& router has an option called &%forbid_filter_perl%& which locks
9255 out the use of this expansion item in filter files.
9256
9257
9258 .vitem &*${prvs{*&<&'address'&>&*}{*&<&'secret'&>&*}{*&<&'keynumber'&>&*}}*&
9259 .cindex "&%prvs%& expansion item"
9260 The first argument is a complete email address and the second is secret
9261 keystring. The third argument, specifying a key number, is optional. If absent,
9262 it defaults to 0. The result of the expansion is a prvs-signed email address,
9263 to be typically used with the &%return_path%& option on an &(smtp)& transport
9264 as part of a bounce address tag validation (BATV) scheme. For more discussion
9265 and an example, see section &<<SECTverifyPRVS>>&.
9266
9267 .vitem "&*${prvscheck{*&<&'address'&>&*}{*&<&'secret'&>&*}&&&
9268         {*&<&'string'&>&*}}*&"
9269 .cindex "&%prvscheck%& expansion item"
9270 This expansion item is the complement of the &%prvs%& item. It is used for
9271 checking prvs-signed addresses. If the expansion of the first argument does not
9272 yield a syntactically valid prvs-signed address, the whole item expands to the
9273 empty string. When the first argument does expand to a syntactically valid
9274 prvs-signed address, the second argument is expanded, with the prvs-decoded
9275 version of the address and the key number extracted from the address in the
9276 variables &$prvscheck_address$& and &$prvscheck_keynum$&, respectively.
9277
9278 These two variables can be used in the expansion of the second argument to
9279 retrieve the secret. The validity of the prvs-signed address is then checked
9280 against the secret. The result is stored in the variable &$prvscheck_result$&,
9281 which is empty for failure or &"1"& for success.
9282
9283 The third argument is optional; if it is missing, it defaults to an empty
9284 string. This argument is now expanded. If the result is an empty string, the
9285 result of the expansion is the decoded version of the address. This is the case
9286 whether or not the signature was valid. Otherwise, the result of the expansion
9287 is the expansion of the third argument.
9288
9289 All three variables can be used in the expansion of the third argument.
9290 However, once the expansion is complete, only &$prvscheck_result$& remains set.
9291 For more discussion and an example, see section &<<SECTverifyPRVS>>&.
9292
9293 .vitem &*${readfile{*&<&'file&~name'&>&*}{*&<&'eol&~string'&>&*}}*&
9294 .cindex "expansion" "inserting an entire file"
9295 .cindex "file" "inserting into expansion"
9296 .cindex "&%readfile%& expansion item"
9297 The file name and end-of-line string are first expanded separately. The file is
9298 then read, and its contents replace the entire item. All newline characters in
9299 the file are replaced by the end-of-line string if it is present. Otherwise,
9300 newlines are left in the string.
9301 String expansion is not applied to the contents of the file. If you want this,
9302 you must wrap the item in an &%expand%& operator. If the file cannot be read,
9303 the string expansion fails.
9304
9305 The &(redirect)& router has an option called &%forbid_filter_readfile%& which
9306 locks out the use of this expansion item in filter files.
9307
9308
9309
9310 .vitem "&*${readsocket{*&<&'name'&>&*}{*&<&'request'&>&*}&&&
9311         {*&<&'timeout'&>&*}{*&<&'eol&~string'&>&*}{*&<&'fail&~string'&>&*}}*&"
9312 .cindex "expansion" "inserting from a socket"
9313 .cindex "socket, use of in expansion"
9314 .cindex "&%readsocket%& expansion item"
9315 This item inserts data from a Unix domain or Internet socket into the expanded
9316 string. The minimal way of using it uses just two arguments, as in these
9317 examples:
9318 .code
9319 ${readsocket{/socket/name}{request string}}
9320 ${readsocket{inet:some.host:1234}{request string}}
9321 .endd
9322 For a Unix domain socket, the first substring must be the path to the socket.
9323 For an Internet socket, the first substring must contain &`inet:`& followed by
9324 a host name or IP address, followed by a colon and a port, which can be a
9325 number or the name of a TCP port in &_/etc/services_&. An IP address may
9326 optionally be enclosed in square brackets. This is best for IPv6 addresses. For
9327 example:
9328 .code
9329 ${readsocket{inet:[::1]:1234}{request string}}
9330 .endd
9331 Only a single host name may be given, but if looking it up yields more than
9332 one IP address, they are each tried in turn until a connection is made. For
9333 both kinds of socket, Exim makes a connection, writes the request string
9334 (unless it is an empty string) and reads from the socket until an end-of-file
9335 is read. A timeout of 5 seconds is applied. Additional, optional arguments
9336 extend what can be done. Firstly, you can vary the timeout. For example:
9337 .code
9338 ${readsocket{/socket/name}{request string}{3s}}
9339 .endd
9340 A fourth argument allows you to change any newlines that are in the data
9341 that is read, in the same way as for &%readfile%& (see above). This example
9342 turns them into spaces:
9343 .code
9344 ${readsocket{inet:127.0.0.1:3294}{request string}{3s}{ }}
9345 .endd
9346 As with all expansions, the substrings are expanded before the processing
9347 happens. Errors in these sub-expansions cause the expansion to fail. In
9348 addition, the following errors can occur:
9349
9350 .ilist
9351 Failure to create a socket file descriptor;
9352 .next
9353 Failure to connect the socket;
9354 .next
9355 Failure to write the request string;
9356 .next
9357 Timeout on reading from the socket.
9358 .endlist
9359
9360 By default, any of these errors causes the expansion to fail. However, if
9361 you supply a fifth substring, it is expanded and used when any of the above
9362 errors occurs. For example:
9363 .code
9364 ${readsocket{/socket/name}{request string}{3s}{\n}\
9365   {socket failure}}
9366 .endd
9367 You can test for the existence of a Unix domain socket by wrapping this
9368 expansion in &`${if exists`&, but there is a race condition between that test
9369 and the actual opening of the socket, so it is safer to use the fifth argument
9370 if you want to be absolutely sure of avoiding an expansion error for a
9371 non-existent Unix domain socket, or a failure to connect to an Internet socket.
9372
9373 The &(redirect)& router has an option called &%forbid_filter_readsocket%& which
9374 locks out the use of this expansion item in filter files.
9375
9376
9377 .vitem &*${reduce{*&<&'string1'&>}{<&'string2'&>&*}{*&<&'string3'&>&*}}*&
9378 .cindex "expansion" "reducing a list to a scalar"
9379 .cindex "list" "reducing to a scalar"
9380 .vindex "&$value$&"
9381 .vindex "&$item$&"
9382 This operation reduces a list to a single, scalar string. After expansion,
9383 <&'string1'&> is interpreted as a list, colon-separated by default, but the
9384 separator can be changed in the usual way. Then <&'string2'&> is expanded and
9385 assigned to the &$value$& variable. After this, each item in the <&'string1'&>
9386 list is assigned to &$item$& in turn, and <&'string3'&> is expanded for each of
9387 them. The result of that expansion is assigned to &$value$& before the next
9388 iteration. When the end of the list is reached, the final value of &$value$& is
9389 added to the expansion output. The &*reduce*& expansion item can be used in a
9390 number of ways. For example, to add up a list of numbers:
9391 .code
9392 ${reduce {<, 1,2,3}{0}{${eval:$value+$item}}}
9393 .endd
9394 The result of that expansion would be &`6`&. The maximum of a list of numbers
9395 can be found:
9396 .code
9397 ${reduce {3:0:9:4:6}{0}{${if >{$item}{$value}{$item}{$value}}}}
9398 .endd
9399 At the end of a &*reduce*& expansion, the values of &$item$& and &$value$& are
9400 restored to what they were before. See also the &*filter*& and &*map*&
9401 expansion items.
9402
9403 .vitem &*$rheader_*&<&'header&~name'&>&*:*&&~or&~&*$rh_*&<&'header&~name'&>&*:*&
9404 This item inserts &"raw"& header lines. It is described with the &%header%&
9405 expansion item above.
9406
9407 .vitem "&*${run{*&<&'command'&>&*&~*&<&'args'&>&*}{*&<&'string1'&>&*}&&&
9408         {*&<&'string2'&>&*}}*&"
9409 .cindex "expansion" "running a command"
9410 .cindex "&%run%& expansion item"
9411 The command and its arguments are first expanded separately, and then the
9412 command is run in a separate process, but under the same uid and gid. As in
9413 other command executions from Exim, a shell is not used by default. If you want
9414 a shell, you must explicitly code it.
9415
9416 The standard input for the command exists, but is empty. The standard output
9417 and standard error are set to the same file descriptor.
9418 .cindex "return code" "from &%run%& expansion"
9419 .vindex "&$value$&"
9420 If the command succeeds (gives a zero return code) <&'string1'&> is expanded
9421 and replaces the entire item; during this expansion, the standard output/error
9422 from the command is in the variable &$value$&. If the command fails,
9423 <&'string2'&>, if present, is expanded and used. Once again, during the
9424 expansion, the standard output/error from the command is in the variable
9425 &$value$&.
9426
9427 If <&'string2'&> is absent, the result is empty. Alternatively, <&'string2'&>
9428 can be the word &"fail"& (not in braces) to force expansion failure if the
9429 command does not succeed. If both strings are omitted, the result is contents
9430 of the standard output/error on success, and nothing on failure.
9431
9432 .vindex "&$run_in_acl$&"
9433 The standard output/error of the command is put in the variable &$value$&.
9434 In this ACL example, the output of a command is logged for the admin to
9435 troubleshoot:
9436 .code
9437 warn  condition    = ${run{/usr/bin/id}{yes}{no}}
9438       log_message  = Output of id: $value
9439 .endd
9440 If the command requires shell idioms, such as the > redirect operator, the
9441 shell must be invoked directly, such as with:
9442 .code
9443 ${run{/bin/bash -c "/usr/bin/id >/tmp/id"}{yes}{yes}}
9444 .endd
9445
9446 .vindex "&$runrc$&"
9447 The return code from the command is put in the variable &$runrc$&, and this
9448 remains set afterwards, so in a filter file you can do things like this:
9449 .code
9450 if "${run{x y z}{}}$runrc" is 1 then ...
9451   elif $runrc is 2 then ...
9452   ...
9453 endif
9454 .endd
9455 If execution of the command fails (for example, the command does not exist),
9456 the return code is 127 &-- the same code that shells use for non-existent
9457 commands.
9458
9459 &*Warning*&: In a router or transport, you cannot assume the order in which
9460 option values are expanded, except for those preconditions whose order of
9461 testing is documented. Therefore, you cannot reliably expect to set &$runrc$&
9462 by the expansion of one option, and use it in another.
9463
9464 The &(redirect)& router has an option called &%forbid_filter_run%& which locks
9465 out the use of this expansion item in filter files.
9466
9467
9468 .vitem &*${sg{*&<&'subject'&>&*}{*&<&'regex'&>&*}{*&<&'replacement'&>&*}}*&
9469 .cindex "expansion" "string substitution"
9470 .cindex "&%sg%& expansion item"
9471 This item works like Perl's substitution operator (s) with the global (/g)
9472 option; hence its name. However, unlike the Perl equivalent, Exim does not
9473 modify the subject string; instead it returns the modified string for insertion
9474 into the overall expansion. The item takes three arguments: the subject string,
9475 a regular expression, and a substitution string. For example:
9476 .code
9477 ${sg{abcdefabcdef}{abc}{xyz}}
9478 .endd
9479 yields &"xyzdefxyzdef"&. Because all three arguments are expanded before use,
9480 if any $ or \ characters are required in the regular expression or in the
9481 substitution string, they have to be escaped. For example:
9482 .code
9483 ${sg{abcdef}{^(...)(...)\$}{\$2\$1}}
9484 .endd
9485 yields &"defabc"&, and
9486 .code
9487 ${sg{1=A 4=D 3=C}{\N(\d+)=\N}{K\$1=}}
9488 .endd
9489 yields &"K1=A K4=D K3=C"&. Note the use of &`\N`& to protect the contents of
9490 the regular expression from string expansion.
9491
9492
9493
9494 .vitem &*${substr{*&<&'string1'&>&*}{*&<&'string2'&>&*}{*&<&'string3'&>&*}}*&
9495 .cindex "&%substr%& expansion item"
9496 .cindex "substring extraction"
9497 .cindex "expansion" "substring extraction"
9498 The three strings are expanded; the first two must yield numbers. Call them
9499 <&'n'&> and <&'m'&>. If you are using fixed values for these numbers, that is,
9500 if <&'string1'&> and <&'string2'&> do not change when they are expanded, you
9501 can use the simpler operator notation that avoids some of the braces:
9502 .code
9503 ${substr_<n>_<m>:<string>}
9504 .endd
9505 The second number is optional (in both notations).
9506 If it is absent in the simpler format, the preceding underscore must also be
9507 omitted.
9508
9509 The &%substr%& item can be used to extract more general substrings than
9510 &%length%&. The first number, <&'n'&>, is a starting offset, and <&'m'&> is the
9511 length required. For example
9512 .code
9513 ${substr{3}{2}{$local_part}}
9514 .endd
9515 If the starting offset is greater than the string length the result is the
9516 null string; if the length plus starting offset is greater than the string
9517 length, the result is the right-hand part of the string, starting from the
9518 given offset. The first character in the string has offset zero.
9519
9520 The &%substr%& expansion item can take negative offset values to count
9521 from the right-hand end of its operand. The last character is offset -1, the
9522 second-last is offset -2, and so on. Thus, for example,
9523 .code
9524 ${substr{-5}{2}{1234567}}
9525 .endd
9526 yields &"34"&. If the absolute value of a negative offset is greater than the
9527 length of the string, the substring starts at the beginning of the string, and
9528 the length is reduced by the amount of overshoot. Thus, for example,
9529 .code
9530 ${substr{-5}{2}{12}}
9531 .endd
9532 yields an empty string, but
9533 .code
9534 ${substr{-3}{2}{12}}
9535 .endd
9536 yields &"1"&.
9537
9538 When the second number is omitted from &%substr%&, the remainder of the string
9539 is taken if the offset is positive. If it is negative, all characters in the
9540 string preceding the offset point are taken. For example, an offset of -1 and
9541 no length, as in these semantically identical examples:
9542 .code
9543 ${substr_-1:abcde}
9544 ${substr{-1}{abcde}}
9545 .endd
9546 yields all but the last character of the string, that is, &"abcd"&.
9547
9548
9549
9550 .vitem "&*${tr{*&<&'subject'&>&*}{*&<&'characters'&>&*}&&&
9551         {*&<&'replacements'&>&*}}*&"
9552 .cindex "expansion" "character translation"
9553 .cindex "&%tr%& expansion item"
9554 This item does single-character translation on its subject string. The second
9555 argument is a list of characters to be translated in the subject string. Each
9556 matching character is replaced by the corresponding character from the
9557 replacement list. For example
9558 .code
9559 ${tr{abcdea}{ac}{13}}
9560 .endd
9561 yields &`1b3de1`&. If there are duplicates in the second character string, the
9562 last occurrence is used. If the third string is shorter than the second, its
9563 last character is replicated. However, if it is empty, no translation takes
9564 place.
9565 .endlist
9566
9567
9568
9569 .section "Expansion operators" "SECTexpop"
9570 .cindex "expansion" "operators"
9571 For expansion items that perform transformations on a single argument string,
9572 the &"operator"& notation is used because it is simpler and uses fewer braces.
9573 The substring is first expanded before the operation is applied to it. The
9574 following operations can be performed:
9575
9576 .vlist
9577 .vitem &*${address:*&<&'string'&>&*}*&
9578 .cindex "expansion" "RFC 2822 address handling"
9579 .cindex "&%address%& expansion item"
9580 The string is interpreted as an RFC 2822 address, as it might appear in a
9581 header line, and the effective address is extracted from it. If the string does
9582 not parse successfully, the result is empty.
9583
9584
9585 .vitem &*${addresses:*&<&'string'&>&*}*&
9586 .cindex "expansion" "RFC 2822 address handling"
9587 .cindex "&%addresses%& expansion item"
9588 The string (after expansion) is interpreted as a list of addresses in RFC
9589 2822 format, such as can be found in a &'To:'& or &'Cc:'& header line. The
9590 operative address (&'local-part@domain'&) is extracted from each item, and the
9591 result of the expansion is a colon-separated list, with appropriate
9592 doubling of colons should any happen to be present in the email addresses.
9593 Syntactically invalid RFC2822 address items are omitted from the output.
9594
9595 It is possible to specify a character other than colon for the output
9596 separator by starting the string with > followed by the new separator
9597 character. For example:
9598 .code
9599 ${addresses:>& Chief <ceo@up.stairs>, sec@base.ment (dogsbody)}
9600 .endd
9601 expands to &`ceo@up.stairs&&sec@base.ment`&. Compare the &*address*& (singular)
9602 expansion item, which extracts the working address from a single RFC2822
9603 address. See the &*filter*&, &*map*&, and &*reduce*& items for ways of
9604 processing lists.
9605
9606
9607 .vitem &*${base62:*&<&'digits'&>&*}*&
9608 .cindex "&%base62%& expansion item"
9609 .cindex "expansion" "conversion to base 62"
9610 The string must consist entirely of decimal digits. The number is converted to
9611 base 62 and output as a string of six characters, including leading zeros. In
9612 the few operating environments where Exim uses base 36 instead of base 62 for
9613 its message identifiers (because those systems do not have case-sensitive file
9614 names), base 36 is used by this operator, despite its name. &*Note*&: Just to
9615 be absolutely clear: this is &'not'& base64 encoding.
9616
9617 .vitem &*${base62d:*&<&'base-62&~digits'&>&*}*&
9618 .cindex "&%base62d%& expansion item"
9619 .cindex "expansion" "conversion to base 62"
9620 The string must consist entirely of base-62 digits, or, in operating
9621 environments where Exim uses base 36 instead of base 62 for its message
9622 identifiers, base-36 digits. The number is converted to decimal and output as a
9623 string.
9624
9625
9626 .vitem &*${domain:*&<&'string'&>&*}*&
9627 .cindex "domain" "extraction"
9628 .cindex "expansion" "domain extraction"
9629 The string is interpreted as an RFC 2822 address and the domain is extracted
9630 from it. If the string does not parse successfully, the result is empty.
9631
9632
9633 .vitem &*${escape:*&<&'string'&>&*}*&
9634 .cindex "expansion" "escaping non-printing characters"
9635 .cindex "&%escape%& expansion item"
9636 If the string contains any non-printing characters, they are converted to
9637 escape sequences starting with a backslash. Whether characters with the most
9638 significant bit set (so-called &"8-bit characters"&) count as printing or not
9639 is controlled by the &%print_topbitchars%& option.
9640
9641
9642 .vitem &*${eval:*&<&'string'&>&*}*&&~and&~&*${eval10:*&<&'string'&>&*}*&
9643 .cindex "expansion" "expression evaluation"
9644 .cindex "expansion" "arithmetic expression"
9645 .cindex "&%eval%& expansion item"
9646 These items supports simple arithmetic and bitwise logical operations in
9647 expansion strings. The string (after expansion) must be a conventional
9648 arithmetic expression, but it is limited to basic arithmetic operators, bitwise
9649 logical operators, and parentheses. All operations are carried out using
9650 integer arithmetic. The operator priorities are as follows (the same as in the
9651 C programming language):
9652 .table2 70pt 300pt
9653 .irow &'highest:'& "not (~), negate (-)"
9654 .irow ""   "multiply (*), divide (/), remainder (%)"
9655 .irow ""   "plus (+), minus (-)"
9656 .irow ""   "shift-left (<<), shift-right (>>)"
9657 .irow ""   "and (&&)"
9658 .irow ""   "xor (^)"
9659 .irow &'lowest:'&  "or (|)"
9660 .endtable
9661 Binary operators with the same priority are evaluated from left to right. White
9662 space is permitted before or after operators.
9663
9664 For &%eval%&, numbers may be decimal, octal (starting with &"0"&) or
9665 hexadecimal (starting with &"0x"&). For &%eval10%&, all numbers are taken as
9666 decimal, even if they start with a leading zero; hexadecimal numbers are not
9667 permitted. This can be useful when processing numbers extracted from dates or
9668 times, which often do have leading zeros.
9669
9670 A number may be followed by &"K"&, &"M"& or &"G"& to multiply it by 1024, 1024*1024
9671 or 1024*1024*1024,
9672 respectively. Negative numbers are supported. The result of the computation is
9673 a decimal representation of the answer (without &"K"&, &"M"& or &"G"&). For example:
9674
9675 .display
9676 &`${eval:1+1}            `&  yields 2
9677 &`${eval:1+2*3}          `&  yields 7
9678 &`${eval:(1+2)*3}        `&  yields 9
9679 &`${eval:2+42%5}         `&  yields 4
9680 &`${eval:0xc&amp;5}          `&  yields 4
9681 &`${eval:0xc|5}          `&  yields 13
9682 &`${eval:0xc^5}          `&  yields 9
9683 &`${eval:0xc>>1}         `&  yields 6
9684 &`${eval:0xc<<1}         `&  yields 24
9685 &`${eval:~255&amp;0x1234}    `&  yields 4608
9686 &`${eval:-(~255&amp;0x1234)} `&  yields -4608
9687 .endd
9688
9689 As a more realistic example, in an ACL you might have
9690 .code
9691 deny   message = Too many bad recipients
9692        condition =                    \
9693          ${if and {                   \
9694            {>{$rcpt_count}{10}}       \
9695            {                          \
9696            <                          \
9697              {$recipients_count}      \
9698              {${eval:$rcpt_count/2}}  \
9699            }                          \
9700          }{yes}{no}}
9701 .endd
9702 The condition is true if there have been more than 10 RCPT commands and
9703 fewer than half of them have resulted in a valid recipient.
9704
9705
9706 .vitem &*${expand:*&<&'string'&>&*}*&
9707 .cindex "expansion" "re-expansion of substring"
9708 The &%expand%& operator causes a string to be expanded for a second time. For
9709 example,
9710 .code
9711 ${expand:${lookup{$domain}dbm{/some/file}{$value}}}
9712 .endd
9713 first looks up a string in a file while expanding the operand for &%expand%&,
9714 and then re-expands what it has found.
9715
9716
9717 .vitem &*${from_utf8:*&<&'string'&>&*}*&
9718 .cindex "Unicode"
9719 .cindex "UTF-8" "conversion from"
9720 .cindex "expansion" "UTF-8 conversion"
9721 .cindex "&%from_utf8%& expansion item"
9722 The world is slowly moving towards Unicode, although there are no standards for
9723 email yet. However, other applications (including some databases) are starting
9724 to store data in Unicode, using UTF-8 encoding. This operator converts from a
9725 UTF-8 string to an ISO-8859-1 string. UTF-8 code values greater than 255 are
9726 converted to underscores. The input must be a valid UTF-8 string. If it is not,
9727 the result is an undefined sequence of bytes.
9728
9729 Unicode code points with values less than 256 are compatible with ASCII and
9730 ISO-8859-1 (also known as Latin-1).
9731 For example, character 169 is the copyright symbol in both cases, though the
9732 way it is encoded is different. In UTF-8, more than one byte is needed for
9733 characters with code values greater than 127, whereas ISO-8859-1 is a
9734 single-byte encoding (but thereby limited to 256 characters). This makes
9735 translation from UTF-8 to ISO-8859-1 straightforward.
9736
9737
9738 .vitem &*${hash_*&<&'n'&>&*_*&<&'m'&>&*:*&<&'string'&>&*}*&
9739 .cindex "hash function" "textual"
9740 .cindex "expansion" "textual hash"
9741 The &%hash%& operator is a simpler interface to the hashing function that can
9742 be used when the two parameters are fixed numbers (as opposed to strings that
9743 change when expanded). The effect is the same as
9744 .code
9745 ${hash{<n>}{<m>}{<string>}}
9746 .endd
9747 See the description of the general &%hash%& item above for details. The
9748 abbreviation &%h%& can be used when &%hash%& is used as an operator.
9749
9750
9751
9752 .vitem &*${hex2b64:*&<&'hexstring'&>&*}*&
9753 .cindex "base64 encoding" "conversion from hex"
9754 .cindex "expansion" "hex to base64"
9755 .cindex "&%hex2b64%& expansion item"
9756 This operator converts a hex string into one that is base64 encoded. This can
9757 be useful for processing the output of the MD5 and SHA-1 hashing functions.
9758
9759
9760 .vitem &*${lc:*&<&'string'&>&*}*&
9761 .cindex "case forcing in strings"
9762 .cindex "string" "case forcing"
9763 .cindex "lower casing"
9764 .cindex "expansion" "case forcing"
9765 .cindex "&%lc%& expansion item"
9766 This forces the letters in the string into lower-case, for example:
9767 .code
9768 ${lc:$local_part}
9769 .endd
9770
9771 .vitem &*${length_*&<&'number'&>&*:*&<&'string'&>&*}*&
9772 .cindex "expansion" "string truncation"
9773 .cindex "&%length%& expansion item"
9774 The &%length%& operator is a simpler interface to the &%length%& function that
9775 can be used when the parameter is a fixed number (as opposed to a string that
9776 changes when expanded). The effect is the same as
9777 .code
9778 ${length{<number>}{<string>}}
9779 .endd
9780 See the description of the general &%length%& item above for details. Note that
9781 &%length%& is not the same as &%strlen%&. The abbreviation &%l%& can be used
9782 when &%length%& is used as an operator.
9783
9784
9785 .vitem &*${listcount:*&<&'string'&>&*}*&
9786 .cindex "expansion" "list item count"
9787 .cindex "list" "item count"
9788 .cindex "list" "count of items"
9789 .cindex "&%listcount%& expansion item"
9790 The string is interpreted as a list and the number of items is returned.
9791
9792
9793 .vitem &*${listnamed:*&<&'name'&>&*}*&&~and&~&*${list_*&<&'type'&>&*name*&>&*}*&
9794 .cindex "expansion" "named list"
9795 .cindex "&%listnamed%& expansion item"
9796 The name is interpreted as a named list and the content of the list is returned,
9797 expanding any referenced lists, re-quoting as needed for colon-separation.
9798 If the optional type if given it must be one of "a", "d", "h" or "l"
9799 and selects address-, domain-, host- or localpart- lists to search among respectively.
9800 Otherwise all types are searched in an undefined order and the first
9801 matching list is returned.
9802
9803
9804 .vitem &*${local_part:*&<&'string'&>&*}*&
9805 .cindex "expansion" "local part extraction"
9806 .cindex "&%local_part%& expansion item"
9807 The string is interpreted as an RFC 2822 address and the local part is
9808 extracted from it. If the string does not parse successfully, the result is
9809 empty.
9810
9811
9812 .vitem &*${mask:*&<&'IP&~address'&>&*/*&<&'bit&~count'&>&*}*&
9813 .cindex "masked IP address"
9814 .cindex "IP address" "masking"
9815 .cindex "CIDR notation"
9816 .cindex "expansion" "IP address masking"
9817 .cindex "&%mask%& expansion item"
9818 If the form of the string to be operated on is not an IP address followed by a
9819 slash and an integer (that is, a network address in CIDR notation), the
9820 expansion fails. Otherwise, this operator converts the IP address to binary,
9821 masks off the least significant bits according to the bit count, and converts
9822 the result back to text, with mask appended. For example,
9823 .code
9824 ${mask:10.111.131.206/28}
9825 .endd
9826 returns the string &"10.111.131.192/28"&. Since this operation is expected to
9827 be mostly used for looking up masked addresses in files, the result for an IPv6
9828 address uses dots to separate components instead of colons, because colon
9829 terminates a key string in lsearch files. So, for example,
9830 .code
9831 ${mask:3ffe:ffff:836f:0a00:000a:0800:200a:c031/99}
9832 .endd
9833 returns the string
9834 .code
9835 3ffe.ffff.836f.0a00.000a.0800.2000.0000/99
9836 .endd
9837 Letters in IPv6 addresses are always output in lower case.
9838
9839
9840 .vitem &*${md5:*&<&'string'&>&*}*&
9841 .cindex "MD5 hash"
9842 .cindex "expansion" "MD5 hash"
9843 .cindex "&%md5%& expansion item"
9844 The &%md5%& operator computes the MD5 hash value of the string, and returns it
9845 as a 32-digit hexadecimal number, in which any letters are in lower case.
9846
9847
9848 .vitem &*${nhash_*&<&'n'&>&*_*&<&'m'&>&*:*&<&'string'&>&*}*&
9849 .cindex "expansion" "numeric hash"
9850 .cindex "hash function" "numeric"
9851 The &%nhash%& operator is a simpler interface to the numeric hashing function
9852 that can be used when the two parameters are fixed numbers (as opposed to
9853 strings that change when expanded). The effect is the same as
9854 .code
9855 ${nhash{<n>}{<m>}{<string>}}
9856 .endd
9857 See the description of the general &%nhash%& item above for details.
9858
9859
9860 .vitem &*${quote:*&<&'string'&>&*}*&
9861 .cindex "quoting" "in string expansions"
9862 .cindex "expansion" "quoting"
9863 .cindex "&%quote%& expansion item"
9864 The &%quote%& operator puts its argument into double quotes if it
9865 is an empty string or
9866 contains anything other than letters, digits, underscores, dots, and hyphens.
9867 Any occurrences of double quotes and backslashes are escaped with a backslash.
9868 Newlines and carriage returns are converted to &`\n`& and &`\r`&,
9869 respectively For example,
9870 .code
9871 ${quote:ab"*"cd}
9872 .endd
9873 becomes
9874 .code
9875 "ab\"*\"cd"
9876 .endd
9877 The place where this is useful is when the argument is a substitution from a
9878 variable or a message header.
9879
9880 .vitem &*${quote_local_part:*&<&'string'&>&*}*&
9881 .cindex "&%quote_local_part%& expansion item"
9882 This operator is like &%quote%&, except that it quotes the string only if
9883 required to do so by the rules of RFC 2822 for quoting local parts. For
9884 example, a plus sign would not cause quoting (but it would for &%quote%&).
9885 If you are creating a new email address from the contents of &$local_part$&
9886 (or any other unknown data), you should always use this operator.
9887
9888
9889 .vitem &*${quote_*&<&'lookup-type'&>&*:*&<&'string'&>&*}*&
9890 .cindex "quoting" "lookup-specific"
9891 This operator applies lookup-specific quoting rules to the string. Each
9892 query-style lookup type has its own quoting rules which are described with
9893 the lookups in chapter &<<CHAPfdlookup>>&. For example,
9894 .code
9895 ${quote_ldap:two * two}
9896 .endd
9897 returns
9898 .code
9899 two%20%5C2A%20two
9900 .endd
9901 For single-key lookup types, no quoting is ever necessary and this operator
9902 yields an unchanged string.
9903
9904
9905 .vitem &*${randint:*&<&'n'&>&*}*&
9906 .cindex "random number"
9907 This operator returns a somewhat random number which is less than the
9908 supplied number and is at least 0.  The quality of this randomness depends
9909 on how Exim was built; the values are not suitable for keying material.
9910 If Exim is linked against OpenSSL then RAND_pseudo_bytes() is used.
9911 If Exim is linked against GnuTLS then gnutls_rnd(GNUTLS_RND_NONCE) is used,
9912 for versions of GnuTLS with that function.
9913 Otherwise, the implementation may be arc4random(), random() seeded by
9914 srandomdev() or srandom(), or a custom implementation even weaker than
9915 random().
9916
9917
9918 .vitem &*${reverse_ip:*&<&'ipaddr'&>&*}*&
9919 .cindex "expansion" "IP address"
9920 This operator reverses an IP address; for IPv4 addresses, the result is in
9921 dotted-quad decimal form, while for IPv6 addreses the result is in
9922 dotted-nibble hexadecimal form.  In both cases, this is the "natural" form
9923 for DNS.  For example,
9924 .code
9925 ${reverse_ip:192.0.2.4}
9926 ${reverse_ip:2001:0db8:c42:9:1:abcd:192.0.2.127}
9927 .endd
9928 returns
9929 .code
9930 4.2.0.192
9931 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
9932 .endd
9933
9934
9935 .vitem &*${rfc2047:*&<&'string'&>&*}*&
9936 .cindex "expansion" "RFC 2047"
9937 .cindex "RFC 2047" "expansion operator"
9938 .cindex "&%rfc2047%& expansion item"
9939 This operator encodes text according to the rules of RFC 2047. This is an
9940 encoding that is used in header lines to encode non-ASCII characters. It is
9941 assumed that the input string is in the encoding specified by the
9942 &%headers_charset%& option, which defaults to ISO-8859-1. If the string
9943 contains only characters in the range 33&--126, and no instances of the
9944 characters
9945 .code
9946 ? = ( ) < > @ , ; : \ " . [ ] _
9947 .endd
9948 it is not modified. Otherwise, the result is the RFC 2047 encoding of the
9949 string, using as many &"encoded words"& as necessary to encode all the
9950 characters.
9951
9952
9953 .vitem &*${rfc2047d:*&<&'string'&>&*}*&
9954 .cindex "expansion" "RFC 2047"
9955 .cindex "RFC 2047" "decoding"
9956 .cindex "&%rfc2047d%& expansion item"
9957 This operator decodes strings that are encoded as per RFC 2047. Binary zero
9958 bytes are replaced by question marks. Characters are converted into the
9959 character set defined by &%headers_charset%&. Overlong RFC 2047 &"words"& are
9960 not recognized unless &%check_rfc2047_length%& is set false.
9961
9962 &*Note*&: If you use &%$header%&_&'xxx'&&*:*& (or &%$h%&_&'xxx'&&*:*&) to
9963 access a header line, RFC 2047 decoding is done automatically. You do not need
9964 to use this operator as well.
9965
9966
9967
9968 .vitem &*${rxquote:*&<&'string'&>&*}*&
9969 .cindex "quoting" "in regular expressions"
9970 .cindex "regular expressions" "quoting"
9971 .cindex "&%rxquote%& expansion item"
9972 The &%rxquote%& operator inserts a backslash before any non-alphanumeric
9973 characters in its argument. This is useful when substituting the values of
9974 variables or headers inside regular expressions.
9975
9976
9977 .vitem &*${sha1:*&<&'string'&>&*}*&
9978 .cindex "SHA-1 hash"
9979 .cindex "expansion" "SHA-1 hashing"
9980 .cindex "&%sha2%& expansion item"
9981 The &%sha1%& operator computes the SHA-1 hash value of the string, and returns
9982 it as a 40-digit hexadecimal number, in which any letters are in upper case.
9983
9984
9985 .vitem &*${stat:*&<&'string'&>&*}*&
9986 .cindex "expansion" "statting a file"
9987 .cindex "file" "extracting characteristics"
9988 .cindex "&%stat%& expansion item"
9989 The string, after expansion, must be a file path. A call to the &[stat()]&
9990 function is made for this path. If &[stat()]& fails, an error occurs and the
9991 expansion fails. If it succeeds, the data from the stat replaces the item, as a
9992 series of <&'name'&>=<&'value'&> pairs, where the values are all numerical,
9993 except for the value of &"smode"&. The names are: &"mode"& (giving the mode as
9994 a 4-digit octal number), &"smode"& (giving the mode in symbolic format as a
9995 10-character string, as for the &'ls'& command), &"inode"&, &"device"&,
9996 &"links"&, &"uid"&, &"gid"&, &"size"&, &"atime"&, &"mtime"&, and &"ctime"&. You
9997 can extract individual fields using the &%extract%& expansion item.
9998
9999 The use of the &%stat%& expansion in users' filter files can be locked out by
10000 the system administrator. &*Warning*&: The file size may be incorrect on 32-bit
10001 systems for files larger than 2GB.
10002
10003 .vitem &*${str2b64:*&<&'string'&>&*}*&
10004 .cindex "expansion" "base64 encoding"
10005 .cindex "base64 encoding" "in string expansion"
10006 .cindex "&%str2b64%& expansion item"
10007 This operator converts a string into one that is base64 encoded.
10008
10009
10010
10011 .vitem &*${strlen:*&<&'string'&>&*}*&
10012 .cindex "expansion" "string length"
10013 .cindex "string" "length in expansion"
10014 .cindex "&%strlen%& expansion item"
10015 The item is replace by the length of the expanded string, expressed as a
10016 decimal number. &*Note*&: Do not confuse &%strlen%& with &%length%&.
10017
10018
10019 .vitem &*${substr_*&<&'start'&>&*_*&<&'length'&>&*:*&<&'string'&>&*}*&
10020 .cindex "&%substr%& expansion item"
10021 .cindex "substring extraction"
10022 .cindex "expansion" "substring expansion"
10023 The &%substr%& operator is a simpler interface to the &%substr%& function that
10024 can be used when the two parameters are fixed numbers (as opposed to strings
10025 that change when expanded). The effect is the same as
10026 .code
10027 ${substr{<start>}{<length>}{<string>}}
10028 .endd
10029 See the description of the general &%substr%& item above for details. The
10030 abbreviation &%s%& can be used when &%substr%& is used as an operator.
10031
10032 .vitem &*${time_eval:*&<&'string'&>&*}*&
10033 .cindex "&%time_eval%& expansion item"
10034 .cindex "time interval" "decoding"
10035 This item converts an Exim time interval such as &`2d4h5m`& into a number of
10036 seconds.
10037
10038 .vitem &*${time_interval:*&<&'string'&>&*}*&
10039 .cindex "&%time_interval%& expansion item"
10040 .cindex "time interval" "formatting"
10041 The argument (after sub-expansion) must be a sequence of decimal digits that
10042 represents an interval of time as a number of seconds. It is converted into a
10043 number of larger units and output in Exim's normal time format, for example,
10044 &`1w3d4h2m6s`&.
10045
10046 .vitem &*${uc:*&<&'string'&>&*}*&
10047 .cindex "case forcing in strings"
10048 .cindex "string" "case forcing"
10049 .cindex "upper casing"
10050 .cindex "expansion" "case forcing"
10051 .cindex "&%uc%& expansion item"
10052 This forces the letters in the string into upper-case.
10053 .endlist
10054
10055
10056
10057
10058
10059
10060 .section "Expansion conditions" "SECTexpcond"
10061 .scindex IIDexpcond "expansion" "conditions"
10062 The following conditions are available for testing by the &%${if%& construct
10063 while expanding strings:
10064
10065 .vlist
10066 .vitem &*!*&<&'condition'&>
10067 .cindex "expansion" "negating a condition"
10068 .cindex "negation" "in expansion condition"
10069 Preceding any condition with an exclamation mark negates the result of the
10070 condition.
10071
10072 .vitem <&'symbolic&~operator'&>&~&*{*&<&'string1'&>&*}{*&<&'string2'&>&*}*&
10073 .cindex "numeric comparison"
10074 .cindex "expansion" "numeric comparison"
10075 There are a number of symbolic operators for doing numeric comparisons. They
10076 are:
10077 .display
10078 &`=   `&   equal
10079 &`==  `&   equal
10080 &`>   `&   greater
10081 &`>=  `&   greater or equal
10082 &`<   `&   less
10083 &`<=  `&   less or equal
10084 .endd
10085 For example:
10086 .code
10087 ${if >{$message_size}{10M} ...
10088 .endd
10089 Note that the general negation operator provides for inequality testing. The
10090 two strings must take the form of optionally signed decimal integers,
10091 optionally followed by one of the letters &"K"&, &"M"& or &"G"& (in either upper or
10092 lower case), signifying multiplication by 1024, 1024*1024 or 1024*1024*1024, respectively.
10093 As a special case, the numerical value of an empty string is taken as
10094 zero.
10095
10096 In all cases, a relative comparator OP is testing if <&'string1'&> OP
10097 <&'string2'&>; the above example is checking if &$message_size$& is larger than
10098 10M, not if 10M is larger than &$message_size$&.
10099
10100
10101 .vitem &*acl&~{{*&<&'name'&>&*}{*&<&'arg1'&>&*}&&&
10102         {*&<&'arg2'&>&*}...}*&
10103 .cindex "expansion" "calling an acl"
10104 .cindex "&%acl%&" "expansion condition"
10105 The name and zero to nine argument strings are first expanded separately.  The expanded
10106 arguments are assigned to the variables &$acl_arg1$& to &$acl_arg9$& in order.
10107 Any unused are made empty.  The variable &$acl_narg$& is set to the number of
10108 arguments.  The named ACL (see chapter &<<CHAPACL>>&) is called
10109 and may use the variables; if another acl expansion is used the values
10110 are restored after it returns.  If the ACL sets
10111 a value using a "message =" modifier the variable $value becomes
10112 the result of the expansion, otherwise it is empty.
10113 If the ACL returns accept the condition is true; if deny, false.
10114 If the ACL returns defer the result is a forced-fail.
10115
10116 .vitem &*bool&~{*&<&'string'&>&*}*&
10117 .cindex "expansion" "boolean parsing"
10118 .cindex "&%bool%& expansion condition"
10119 This condition turns a string holding a true or false representation into
10120 a boolean state.  It parses &"true"&, &"false"&, &"yes"& and &"no"&
10121 (case-insensitively); also positive integer numbers map to true if non-zero,
10122 false if zero.
10123 An empty string is treated as false.
10124 Leading and trailing whitespace is ignored;
10125 thus a string consisting only of whitespace is false.
10126 All other string values will result in expansion failure.
10127
10128 When combined with ACL variables, this expansion condition will let you
10129 make decisions in one place and act on those decisions in another place.
10130 For example:
10131 .code
10132 ${if bool{$acl_m_privileged_sender} ...
10133 .endd
10134
10135
10136 .vitem &*bool_lax&~{*&<&'string'&>&*}*&
10137 .cindex "expansion" "boolean parsing"
10138 .cindex "&%bool_lax%& expansion condition"
10139 Like &%bool%&, this condition turns a string into a boolean state.  But
10140 where &%bool%& accepts a strict set of strings, &%bool_lax%& uses the same
10141 loose definition that the Router &%condition%& option uses.  The empty string
10142 and the values &"false"&, &"no"& and &"0"& map to false, all others map to
10143 true.  Leading and trailing whitespace is ignored.
10144
10145 Note that where &"bool{00}"& is false, &"bool_lax{00}"& is true.
10146
10147 .vitem &*crypteq&~{*&<&'string1'&>&*}{*&<&'string2'&>&*}*&
10148 .cindex "expansion" "encrypted comparison"
10149 .cindex "encrypted strings, comparing"
10150 .cindex "&%crypteq%& expansion condition"
10151 This condition is included in the Exim binary if it is built to support any
10152 authentication mechanisms (see chapter &<<CHAPSMTPAUTH>>&). Otherwise, it is
10153 necessary to define SUPPORT_CRYPTEQ in &_Local/Makefile_& to get &%crypteq%&
10154 included in the binary.
10155
10156 The &%crypteq%& condition has two arguments. The first is encrypted and
10157 compared against the second, which is already encrypted. The second string may
10158 be in the LDAP form for storing encrypted strings, which starts with the
10159 encryption type in curly brackets, followed by the data. If the second string
10160 does not begin with &"{"& it is assumed to be encrypted with &[crypt()]& or
10161 &[crypt16()]& (see below), since such strings cannot begin with &"{"&.
10162 Typically this will be a field from a password file. An example of an encrypted
10163 string in LDAP form is:
10164 .code
10165 {md5}CY9rzUYh03PK3k6DJie09g==
10166 .endd
10167 If such a string appears directly in an expansion, the curly brackets have to
10168 be quoted, because they are part of the expansion syntax. For example:
10169 .code
10170 ${if crypteq {test}{\{md5\}CY9rzUYh03PK3k6DJie09g==}{yes}{no}}
10171 .endd
10172 The following encryption types (whose names are matched case-independently) are
10173 supported:
10174
10175 .ilist
10176 .cindex "MD5 hash"
10177 .cindex "base64 encoding" "in encrypted password"
10178 &%{md5}%& computes the MD5 digest of the first string, and expresses this as
10179 printable characters to compare with the remainder of the second string. If the
10180 length of the comparison string is 24, Exim assumes that it is base64 encoded
10181 (as in the above example). If the length is 32, Exim assumes that it is a
10182 hexadecimal encoding of the MD5 digest. If the length not 24 or 32, the
10183 comparison fails.
10184
10185 .next
10186 .cindex "SHA-1 hash"
10187 &%{sha1}%& computes the SHA-1 digest of the first string, and expresses this as
10188 printable characters to compare with the remainder of the second string. If the
10189 length of the comparison string is 28, Exim assumes that it is base64 encoded.
10190 If the length is 40, Exim assumes that it is a hexadecimal encoding of the
10191 SHA-1 digest. If the length is not 28 or 40, the comparison fails.
10192
10193 .next
10194 .cindex "&[crypt()]&"
10195 &%{crypt}%& calls the &[crypt()]& function, which traditionally used to use
10196 only the first eight characters of the password. However, in modern operating
10197 systems this is no longer true, and in many cases the entire password is used,
10198 whatever its length.
10199
10200 .next
10201 .cindex "&[crypt16()]&"
10202 &%{crypt16}%& calls the &[crypt16()]& function, which was originally created to
10203 use up to 16 characters of the password in some operating systems. Again, in
10204 modern operating systems, more characters may be used.
10205 .endlist
10206 Exim has its own version of &[crypt16()]&, which is just a double call to
10207 &[crypt()]&. For operating systems that have their own version, setting
10208 HAVE_CRYPT16 in &_Local/Makefile_& when building Exim causes it to use the
10209 operating system version instead of its own. This option is set by default in
10210 the OS-dependent &_Makefile_& for those operating systems that are known to
10211 support &[crypt16()]&.
10212
10213 Some years after Exim's &[crypt16()]& was implemented, a user discovered that
10214 it was not using the same algorithm as some operating systems' versions. It
10215 turns out that as well as &[crypt16()]& there is a function called
10216 &[bigcrypt()]& in some operating systems. This may or may not use the same
10217 algorithm, and both of them may be different to Exim's built-in &[crypt16()]&.
10218
10219 However, since there is now a move away from the traditional &[crypt()]&
10220 functions towards using SHA1 and other algorithms, tidying up this area of
10221 Exim is seen as very low priority.
10222
10223 If you do not put a encryption type (in curly brackets) in a &%crypteq%&
10224 comparison, the default is usually either &`{crypt}`& or &`{crypt16}`&, as
10225 determined by the setting of DEFAULT_CRYPT in &_Local/Makefile_&. The default
10226 default is &`{crypt}`&. Whatever the default, you can always use either
10227 function by specifying it explicitly in curly brackets.
10228
10229 .vitem &*def:*&<&'variable&~name'&>
10230 .cindex "expansion" "checking for empty variable"
10231 .cindex "&%def%& expansion condition"
10232 The &%def%& condition must be followed by the name of one of the expansion
10233 variables defined in section &<<SECTexpvar>>&. The condition is true if the
10234 variable does not contain the empty string. For example:
10235 .code
10236 ${if def:sender_ident {from $sender_ident}}
10237 .endd
10238 Note that the variable name is given without a leading &%$%& character. If the
10239 variable does not exist, the expansion fails.
10240
10241 .vitem "&*def:header_*&<&'header&~name'&>&*:*&&~&~or&~&&&
10242         &~&*def:h_*&<&'header&~name'&>&*:*&"
10243 .cindex "expansion" "checking header line existence"
10244 This condition is true if a message is being processed and the named header
10245 exists in the message. For example,
10246 .code
10247 ${if def:header_reply-to:{$h_reply-to:}{$h_from:}}
10248 .endd
10249 &*Note*&: No &%$%& appears before &%header_%& or &%h_%& in the condition, and
10250 the header name must be terminated by a colon if white space does not follow.
10251
10252 .vitem &*eq&~{*&<&'string1'&>&*}{*&<&'string2'&>&*}*& &&&
10253        &*eqi&~{*&<&'string1'&>&*}{*&<&'string2'&>&*}*&
10254 .cindex "string" "comparison"
10255 .cindex "expansion" "string comparison"
10256 .cindex "&%eq%& expansion condition"
10257 .cindex "&%eqi%& expansion condition"
10258 The two substrings are first expanded. The condition is true if the two
10259 resulting strings are identical. For &%eq%& the comparison includes the case of
10260 letters, whereas for &%eqi%& the comparison is case-independent.
10261
10262 .vitem &*exists&~{*&<&'file&~name'&>&*}*&
10263 .cindex "expansion" "file existence test"
10264 .cindex "file" "existence test"
10265 .cindex "&%exists%&, expansion condition"
10266 The substring is first expanded and then interpreted as an absolute path. The
10267 condition is true if the named file (or directory) exists. The existence test
10268 is done by calling the &[stat()]& function. The use of the &%exists%& test in
10269 users' filter files may be locked out by the system administrator.
10270
10271 .vitem &*first_delivery*&
10272 .cindex "delivery" "first"
10273 .cindex "first delivery"
10274 .cindex "expansion" "first delivery test"
10275 .cindex "&%first_delivery%& expansion condition"
10276 This condition, which has no data, is true during a message's first delivery
10277 attempt. It is false during any subsequent delivery attempts.
10278
10279
10280 .vitem "&*forall{*&<&'a list'&>&*}{*&<&'a condition'&>&*}*&" &&&
10281        "&*forany{*&<&'a list'&>&*}{*&<&'a condition'&>&*}*&"
10282 .cindex "list" "iterative conditions"
10283 .cindex "expansion" "&*forall*& condition"
10284 .cindex "expansion" "&*forany*& condition"
10285 .vindex "&$item$&"
10286 These conditions iterate over a list. The first argument is expanded to form
10287 the list. By default, the list separator is a colon, but it can be changed by
10288 the normal method. The second argument is interpreted as a condition that is to
10289 be applied to each item in the list in turn. During the interpretation of the
10290 condition, the current list item is placed in a variable called &$item$&.
10291 .ilist
10292 For &*forany*&, interpretation stops if the condition is true for any item, and
10293 the result of the whole condition is true. If the condition is false for all
10294 items in the list, the overall condition is false.
10295 .next
10296 For &*forall*&, interpretation stops if the condition is false for any item,
10297 and the result of the whole condition is false. If the condition is true for
10298 all items in the list, the overall condition is true.
10299 .endlist
10300 Note that negation of &*forany*& means that the condition must be false for all
10301 items for the overall condition to succeed, and negation of &*forall*& means
10302 that the condition must be false for at least one item. In this example, the
10303 list separator is changed to a comma:
10304 .code
10305 ${if forany{<, $recipients}{match{$item}{^user3@}}{yes}{no}}
10306 .endd
10307 The value of &$item$& is saved and restored while &*forany*& or &*forall*& is
10308 being processed, to enable these expansion items to be nested.
10309
10310
10311 .vitem &*ge&~{*&<&'string1'&>&*}{*&<&'string2'&>&*}*& &&&
10312        &*gei&~{*&<&'string1'&>&*}{*&<&'string2'&>&*}*&
10313 .cindex "string" "comparison"
10314 .cindex "expansion" "string comparison"
10315 .cindex "&%ge%& expansion condition"
10316 .cindex "&%gei%& expansion condition"
10317 The two substrings are first expanded. The condition is true if the first
10318 string is lexically greater than or equal to the second string. For &%ge%& the
10319 comparison includes the case of letters, whereas for &%gei%& the comparison is
10320 case-independent.
10321
10322 .vitem &*gt&~{*&<&'string1'&>&*}{*&<&'string2'&>&*}*& &&&
10323        &*gti&~{*&<&'string1'&>&*}{*&<&'string2'&>&*}*&
10324 .cindex "string" "comparison"
10325 .cindex "expansion" "string comparison"
10326 .cindex "&%gt%& expansion condition"
10327 .cindex "&%gti%& expansion condition"
10328 The two substrings are first expanded. The condition is true if the first
10329 string is lexically greater than the second string. For &%gt%& the comparison
10330 includes the case of letters, whereas for &%gti%& the comparison is
10331 case-independent.
10332
10333 .vitem &*inlist&~{*&<&'string1'&>&*}{*&<&'string2'&>&*}*& &&&
10334        &*inlisti&~{*&<&'string1'&>&*}{*&<&'string2'&>&*}*&
10335 .cindex "string" "comparison"
10336 .cindex "list" "iterative conditions"
10337 Both strings are expanded; the second string is treated as a list of simple
10338 strings; if the first string is a member of the second, then the condition
10339 is true.
10340
10341 These are simpler to use versions of the more powerful &*forany*& condition.
10342 Examples, and the &*forany*& equivalents:
10343 .code
10344 ${if inlist{needle}{foo:needle:bar}}
10345   ${if forany{foo:needle:bar}{eq{$item}{needle}}}
10346 ${if inlisti{Needle}{fOo:NeeDLE:bAr}}
10347   ${if forany{fOo:NeeDLE:bAr}{eqi{$item}{Needle}}}
10348 .endd
10349
10350 .vitem &*isip&~{*&<&'string'&>&*}*&  &&&
10351        &*isip4&~{*&<&'string'&>&*}*& &&&
10352        &*isip6&~{*&<&'string'&>&*}*&
10353 .cindex "IP address" "testing string format"
10354 .cindex "string" "testing for IP address"
10355 .cindex "&%isip%& expansion condition"
10356 .cindex "&%isip4%& expansion condition"
10357 .cindex "&%isip6%& expansion condition"
10358 The substring is first expanded, and then tested to see if it has the form of
10359 an IP address. Both IPv4 and IPv6 addresses are valid for &%isip%&, whereas
10360 &%isip4%& and &%isip6%& test specifically for IPv4 or IPv6 addresses.
10361
10362 For an IPv4 address, the test is for four dot-separated components, each of
10363 which consists of from one to three digits. For an IPv6 address, up to eight
10364 colon-separated components are permitted, each containing from one to four
10365 hexadecimal digits. There may be fewer than eight components if an empty
10366 component (adjacent colons) is present. Only one empty component is permitted.
10367
10368 &*Note*&: The checks are just on the form of the address; actual numerical
10369 values are not considered. Thus, for example, 999.999.999.999 passes the IPv4
10370 check. The main use of these tests is to distinguish between IP addresses and
10371 host names, or between IPv4 and IPv6 addresses. For example, you could use
10372 .code
10373 ${if isip4{$sender_host_address}...
10374 .endd
10375 to test which IP version an incoming SMTP connection is using.
10376
10377 .vitem &*ldapauth&~{*&<&'ldap&~query'&>&*}*&
10378 .cindex "LDAP" "use for authentication"
10379 .cindex "expansion" "LDAP authentication test"
10380 .cindex "&%ldapauth%& expansion condition"
10381 This condition supports user authentication using LDAP. See section
10382 &<<SECTldap>>& for details of how to use LDAP in lookups and the syntax of
10383 queries. For this use, the query must contain a user name and password. The
10384 query itself is not used, and can be empty. The condition is true if the
10385 password is not empty, and the user name and password are accepted by the LDAP
10386 server. An empty password is rejected without calling LDAP because LDAP binds
10387 with an empty password are considered anonymous regardless of the username, and
10388 will succeed in most configurations. See chapter &<<CHAPSMTPAUTH>>& for details
10389 of SMTP authentication, and chapter &<<CHAPplaintext>>& for an example of how
10390 this can be used.
10391
10392
10393 .vitem &*le&~{*&<&'string1'&>&*}{*&<&'string2'&>&*}*& &&&
10394        &*lei&~{*&<&'string1'&>&*}{*&<&'string2'&>&*}*&
10395 .cindex "string" "comparison"
10396 .cindex "expansion" "string comparison"
10397 .cindex "&%le%& expansion condition"
10398 .cindex "&%lei%& expansion condition"
10399 The two substrings are first expanded. The condition is true if the first
10400 string is lexically less than or equal to the second string. For &%le%& the
10401 comparison includes the case of letters, whereas for &%lei%& the comparison is
10402 case-independent.
10403
10404 .vitem &*lt&~{*&<&'string1'&>&*}{*&<&'string2'&>&*}*& &&&
10405        &*lti&~{*&<&'string1'&>&*}{*&<&'string2'&>&*}*&
10406 .cindex "string" "comparison"
10407 .cindex "expansion" "string comparison"
10408 .cindex "&%lt%& expansion condition"
10409 .cindex "&%lti%& expansion condition"
10410 The two substrings are first expanded. The condition is true if the first
10411 string is lexically less than the second string. For &%lt%& the comparison
10412 includes the case of letters, whereas for &%lti%& the comparison is
10413 case-independent.
10414
10415
10416 .vitem &*match&~{*&<&'string1'&>&*}{*&<&'string2'&>&*}*&
10417 .cindex "expansion" "regular expression comparison"
10418 .cindex "regular expressions" "match in expanded string"
10419 .cindex "&%match%& expansion condition"
10420 The two substrings are first expanded. The second is then treated as a regular
10421 expression and applied to the first. Because of the pre-expansion, if the
10422 regular expression contains dollar, or backslash characters, they must be
10423 escaped. Care must also be taken if the regular expression contains braces
10424 (curly brackets). A closing brace must be escaped so that it is not taken as a
10425 premature termination of <&'string2'&>. The easiest approach is to use the
10426 &`\N`& feature to disable expansion of the regular expression.
10427 For example,
10428 .code
10429 ${if match {$local_part}{\N^\d{3}\N} ...
10430 .endd
10431 If the whole expansion string is in double quotes, further escaping of
10432 backslashes is also required.
10433
10434 The condition is true if the regular expression match succeeds.
10435 The regular expression is not required to begin with a circumflex
10436 metacharacter, but if there is no circumflex, the expression is not anchored,
10437 and it may match anywhere in the subject, not just at the start. If you want
10438 the pattern to match at the end of the subject, you must include the &`$`&
10439 metacharacter at an appropriate point.
10440
10441 .cindex "numerical variables (&$1$& &$2$& etc)" "in &%if%& expansion"
10442 At the start of an &%if%& expansion the values of the numeric variable
10443 substitutions &$1$& etc. are remembered. Obeying a &%match%& condition that
10444 succeeds causes them to be reset to the substrings of that condition and they
10445 will have these values during the expansion of the success string. At the end
10446 of the &%if%& expansion, the previous values are restored. After testing a
10447 combination of conditions using &%or%&, the subsequent values of the numeric
10448 variables are those of the condition that succeeded.
10449
10450 .vitem &*match_address&~{*&<&'string1'&>&*}{*&<&'string2'&>&*}*&
10451 .cindex "&%match_address%& expansion condition"
10452 See &*match_local_part*&.
10453
10454 .vitem &*match_domain&~{*&<&'string1'&>&*}{*&<&'string2'&>&*}*&
10455 .cindex "&%match_domain%& expansion condition"
10456 See &*match_local_part*&.
10457
10458 .vitem &*match_ip&~{*&<&'string1'&>&*}{*&<&'string2'&>&*}*&
10459 .cindex "&%match_ip%& expansion condition"
10460 This condition matches an IP address to a list of IP address patterns. It must
10461 be followed by two argument strings. The first (after expansion) must be an IP
10462 address or an empty string. The second (not expanded) is a restricted host
10463 list that can match only an IP address, not a host name. For example:
10464 .code
10465 ${if match_ip{$sender_host_address}{1.2.3.4:5.6.7.8}{...}{...}}
10466 .endd
10467 The specific types of host list item that are permitted in the list are:
10468
10469 .ilist
10470 An IP address, optionally with a CIDR mask.
10471 .next
10472 A single asterisk, which matches any IP address.
10473 .next
10474 An empty item, which matches only if the IP address is empty. This could be
10475 useful for testing for a locally submitted message or one from specific hosts
10476 in a single test such as
10477 . ==== As this is a nested list, any displays it contains must be indented
10478 . ==== as otherwise they are too far to the left. This comment applies to
10479 . ==== the use of xmlto plus fop. There's no problem when formatting with
10480 . ==== sdop, with or without the extra indent.
10481 .code
10482   ${if match_ip{$sender_host_address}{:4.3.2.1:...}{...}{...}}
10483 .endd
10484 where the first item in the list is the empty string.
10485 .next
10486 The item @[] matches any of the local host's interface addresses.
10487 .next
10488 Single-key lookups are assumed to be like &"net-"& style lookups in host lists,
10489 even if &`net-`& is not specified. There is never any attempt to turn the IP
10490 address into a host name. The most common type of linear search for
10491 &*match_ip*& is likely to be &*iplsearch*&, in which the file can contain CIDR
10492 masks. For example:
10493 .code
10494   ${if match_ip{$sender_host_address}{iplsearch;/some/file}...
10495 .endd
10496 It is of course possible to use other kinds of lookup, and in such a case, you
10497 do need to specify the &`net-`& prefix if you want to specify a specific
10498 address mask, for example:
10499 .code
10500   ${if match_ip{$sender_host_address}{net24-dbm;/some/file}...
10501 .endd
10502 However, unless you are combining a &%match_ip%& condition with others, it is
10503 just as easy to use the fact that a lookup is itself a condition, and write:
10504 .code
10505   ${lookup{${mask:$sender_host_address/24}}dbm{/a/file}...
10506 .endd
10507 .endlist ilist
10508
10509 Note that <&'string2'&> is not itself subject to string expansion, unless
10510 Exim was built with the EXPAND_LISTMATCH_RHS option.
10511
10512 Consult section &<<SECThoslispatip>>& for further details of these patterns.
10513
10514 .vitem &*match_local_part&~{*&<&'string1'&>&*}{*&<&'string2'&>&*}*&
10515 .cindex "domain list" "in expansion condition"
10516 .cindex "address list" "in expansion condition"
10517 .cindex "local part" "list, in expansion condition"
10518 .cindex "&%match_local_part%& expansion condition"
10519 This condition, together with &%match_address%& and &%match_domain%&, make it
10520 possible to test domain, address, and local part lists within expansions. Each
10521 condition requires two arguments: an item and a list to match. A trivial
10522 example is:
10523 .code
10524 ${if match_domain{a.b.c}{x.y.z:a.b.c:p.q.r}{yes}{no}}
10525 .endd
10526 In each case, the second argument may contain any of the allowable items for a
10527 list of the appropriate type. Also, because the second argument (after
10528 expansion) is a standard form of list, it is possible to refer to a named list.
10529 Thus, you can use conditions like this:
10530 .code
10531 ${if match_domain{$domain}{+local_domains}{...
10532 .endd
10533 .cindex "&`+caseful`&"
10534 For address lists, the matching starts off caselessly, but the &`+caseful`&
10535 item can be used, as in all address lists, to cause subsequent items to
10536 have their local parts matched casefully. Domains are always matched
10537 caselessly.
10538
10539 Note that <&'string2'&> is not itself subject to string expansion, unless
10540 Exim was built with the EXPAND_LISTMATCH_RHS option.
10541
10542 &*Note*&: Host lists are &'not'& supported in this way. This is because
10543 hosts have two identities: a name and an IP address, and it is not clear
10544 how to specify cleanly how such a test would work. However, IP addresses can be
10545 matched using &%match_ip%&.
10546
10547 .vitem &*pam&~{*&<&'string1'&>&*:*&<&'string2'&>&*:...}*&
10548 .cindex "PAM authentication"
10549 .cindex "AUTH" "with PAM"
10550 .cindex "Solaris" "PAM support"
10551 .cindex "expansion" "PAM authentication test"
10552 .cindex "&%pam%& expansion condition"
10553 &'Pluggable Authentication Modules'&
10554 (&url(http://www.kernel.org/pub/linux/libs/pam/)) are a facility that is
10555 available in the latest releases of Solaris and in some GNU/Linux
10556 distributions. The Exim support, which is intended for use in conjunction with
10557 the SMTP AUTH command, is available only if Exim is compiled with
10558 .code
10559 SUPPORT_PAM=yes
10560 .endd
10561 in &_Local/Makefile_&. You probably need to add &%-lpam%& to EXTRALIBS, and
10562 in some releases of GNU/Linux &%-ldl%& is also needed.
10563
10564 The argument string is first expanded, and the result must be a
10565 colon-separated list of strings. Leading and trailing white space is ignored.
10566 The PAM module is initialized with the service name &"exim"& and the user name
10567 taken from the first item in the colon-separated data string (<&'string1'&>).
10568 The remaining items in the data string are passed over in response to requests
10569 from the authentication function. In the simple case there will only be one
10570 request, for a password, so the data consists of just two strings.
10571
10572 There can be problems if any of the strings are permitted to contain colon
10573 characters. In the usual way, these have to be doubled to avoid being taken as
10574 separators. If the data is being inserted from a variable, the &%sg%& expansion
10575 item can be used to double any existing colons. For example, the configuration
10576 of a LOGIN authenticator might contain this setting:
10577 .code
10578 server_condition = ${if pam{$auth1:${sg{$auth2}{:}{::}}}}
10579 .endd
10580 For a PLAIN authenticator you could use:
10581 .code
10582 server_condition = ${if pam{$auth2:${sg{$auth3}{:}{::}}}}
10583 .endd
10584 In some operating systems, PAM authentication can be done only from a process
10585 running as root. Since Exim is running as the Exim user when receiving
10586 messages, this means that PAM cannot be used directly in those systems.
10587 A patched version of the &'pam_unix'& module that comes with the
10588 Linux PAM package is available from &url(http://www.e-admin.de/pam_exim/).
10589 The patched module allows one special uid/gid combination, in addition to root,
10590 to authenticate. If you build the patched module to allow the Exim user and
10591 group, PAM can then be used from an Exim authenticator.
10592
10593
10594 .vitem &*pwcheck&~{*&<&'string1'&>&*:*&<&'string2'&>&*}*&
10595 .cindex "&'pwcheck'& daemon"
10596 .cindex "Cyrus"
10597 .cindex "expansion" "&'pwcheck'& authentication test"
10598 .cindex "&%pwcheck%& expansion condition"
10599 This condition supports user authentication using the Cyrus &'pwcheck'& daemon.
10600 This is one way of making it possible for passwords to be checked by a process
10601 that is not running as root. &*Note*&: The use of &'pwcheck'& is now
10602 deprecated. Its replacement is &'saslauthd'& (see below).
10603
10604 The pwcheck support is not included in Exim by default. You need to specify
10605 the location of the pwcheck daemon's socket in &_Local/Makefile_& before
10606 building Exim. For example:
10607 .code
10608 CYRUS_PWCHECK_SOCKET=/var/pwcheck/pwcheck
10609 .endd
10610 You do not need to install the full Cyrus software suite in order to use
10611 the pwcheck daemon. You can compile and install just the daemon alone
10612 from the Cyrus SASL library. Ensure that &'exim'& is the only user that has
10613 access to the &_/var/pwcheck_& directory.
10614
10615 The &%pwcheck%& condition takes one argument, which must be the user name and
10616 password, separated by a colon. For example, in a LOGIN authenticator
10617 configuration, you might have this:
10618 .code
10619 server_condition = ${if pwcheck{$auth1:$auth2}}
10620 .endd
10621 Again, for a PLAIN authenticator configuration, this would be:
10622 .code
10623 server_condition = ${if pwcheck{$auth2:$auth3}}
10624 .endd
10625 .vitem &*queue_running*&
10626 .cindex "queue runner" "detecting when delivering from"
10627 .cindex "expansion" "queue runner test"
10628 .cindex "&%queue_running%& expansion condition"
10629 This condition, which has no data, is true during delivery attempts that are
10630 initiated by queue runner processes, and false otherwise.
10631
10632
10633 .vitem &*radius&~{*&<&'authentication&~string'&>&*}*&
10634 .cindex "Radius"
10635 .cindex "expansion" "Radius authentication"
10636 .cindex "&%radius%& expansion condition"
10637 Radius authentication (RFC 2865) is supported in a similar way to PAM. You must
10638 set RADIUS_CONFIG_FILE in &_Local/Makefile_& to specify the location of
10639 the Radius client configuration file in order to build Exim with Radius
10640 support.
10641
10642 With just that one setting, Exim expects to be linked with the &%radiusclient%&
10643 library, using the original API. If you are using release 0.4.0 or later of
10644 this library, you need to set
10645 .code
10646 RADIUS_LIB_TYPE=RADIUSCLIENTNEW
10647 .endd
10648 in &_Local/Makefile_& when building Exim. You can also link Exim with the
10649 &%libradius%& library that comes with FreeBSD. To do this, set
10650 .code
10651 RADIUS_LIB_TYPE=RADLIB
10652 .endd
10653 in &_Local/Makefile_&, in addition to setting RADIUS_CONFIGURE_FILE.
10654 You may also have to supply a suitable setting in EXTRALIBS so that the
10655 Radius library can be found when Exim is linked.
10656
10657 The string specified by RADIUS_CONFIG_FILE is expanded and passed to the
10658 Radius client library, which calls the Radius server. The condition is true if
10659 the authentication is successful. For example:
10660 .code
10661 server_condition = ${if radius{<arguments>}}
10662 .endd
10663
10664
10665 .vitem "&*saslauthd&~{{*&<&'user'&>&*}{*&<&'password'&>&*}&&&
10666         {*&<&'service'&>&*}{*&<&'realm'&>&*}}*&"
10667 .cindex "&'saslauthd'& daemon"
10668 .cindex "Cyrus"
10669 .cindex "expansion" "&'saslauthd'& authentication test"
10670 .cindex "&%saslauthd%& expansion condition"
10671 This condition supports user authentication using the Cyrus &'saslauthd'&
10672 daemon. This replaces the older &'pwcheck'& daemon, which is now deprecated.
10673 Using this daemon is one way of making it possible for passwords to be checked
10674 by a process that is not running as root.
10675
10676 The saslauthd support is not included in Exim by default. You need to specify
10677 the location of the saslauthd daemon's socket in &_Local/Makefile_& before
10678 building Exim. For example:
10679 .code
10680 CYRUS_SASLAUTHD_SOCKET=/var/state/saslauthd/mux
10681 .endd
10682 You do not need to install the full Cyrus software suite in order to use
10683 the saslauthd daemon. You can compile and install just the daemon alone
10684 from the Cyrus SASL library.
10685
10686 Up to four arguments can be supplied to the &%saslauthd%& condition, but only
10687 two are mandatory. For example:
10688 .code
10689 server_condition = ${if saslauthd{{$auth1}{$auth2}}}
10690 .endd
10691 The service and the realm are optional (which is why the arguments are enclosed
10692 in their own set of braces). For details of the meaning of the service and
10693 realm, and how to run the daemon, consult the Cyrus documentation.
10694 .endlist vlist
10695
10696
10697
10698 .section "Combining expansion conditions" "SECID84"
10699 .cindex "expansion" "combining conditions"
10700 Several conditions can be tested at once by combining them using the &%and%&
10701 and &%or%& combination conditions. Note that &%and%& and &%or%& are complete
10702 conditions on their own, and precede their lists of sub-conditions. Each
10703 sub-condition must be enclosed in braces within the overall braces that contain
10704 the list. No repetition of &%if%& is used.
10705
10706
10707 .vlist
10708 .vitem &*or&~{{*&<&'cond1'&>&*}{*&<&'cond2'&>&*}...}*&
10709 .cindex "&""or""& expansion condition"
10710 .cindex "expansion" "&""or""& of conditions"
10711 The sub-conditions are evaluated from left to right. The condition is true if
10712 any one of the sub-conditions is true.
10713 For example,
10714 .code
10715 ${if or {{eq{$local_part}{spqr}}{eq{$domain}{testing.com}}}...
10716 .endd
10717 When a true sub-condition is found, the following ones are parsed but not
10718 evaluated. If there are several &"match"& sub-conditions the values of the
10719 numeric variables afterwards are taken from the first one that succeeds.
10720
10721 .vitem &*and&~{{*&<&'cond1'&>&*}{*&<&'cond2'&>&*}...}*&
10722 .cindex "&""and""& expansion condition"
10723 .cindex "expansion" "&""and""& of conditions"
10724 The sub-conditions are evaluated from left to right. The condition is true if
10725 all of the sub-conditions are true. If there are several &"match"&
10726 sub-conditions, the values of the numeric variables afterwards are taken from
10727 the last one. When a false sub-condition is found, the following ones are
10728 parsed but not evaluated.
10729 .endlist
10730 .ecindex IIDexpcond
10731
10732
10733
10734
10735 .section "Expansion variables" "SECTexpvar"
10736 .cindex "expansion" "variables, list of"
10737 This section contains an alphabetical list of all the expansion variables. Some
10738 of them are available only when Exim is compiled with specific options such as
10739 support for TLS or the content scanning extension.
10740
10741 .vlist
10742 .vitem "&$0$&, &$1$&, etc"
10743 .cindex "numerical variables (&$1$& &$2$& etc)"
10744 When a &%match%& expansion condition succeeds, these variables contain the
10745 captured substrings identified by the regular expression during subsequent
10746 processing of the success string of the containing &%if%& expansion item.
10747 However, they do not retain their values afterwards; in fact, their previous
10748 values are restored at the end of processing an &%if%& item. The numerical
10749 variables may also be set externally by some other matching process which
10750 precedes the expansion of the string. For example, the commands available in
10751 Exim filter files include an &%if%& command with its own regular expression
10752 matching condition.
10753
10754 .vitem "&$acl_c...$&"
10755 Values can be placed in these variables by the &%set%& modifier in an ACL. They
10756 can be given any name that starts with &$acl_c$& and is at least six characters
10757 long, but the sixth character must be either a digit or an underscore. For
10758 example: &$acl_c5$&, &$acl_c_mycount$&. The values of the &$acl_c...$&
10759 variables persist throughout the lifetime of an SMTP connection. They can be
10760 used to pass information between ACLs and between different invocations of the
10761 same ACL. When a message is received, the values of these variables are saved
10762 with the message, and can be accessed by filters, routers, and transports
10763 during subsequent delivery.
10764
10765 .vitem "&$acl_m...$&"
10766 These variables are like the &$acl_c...$& variables, except that their values
10767 are reset after a message has been received. Thus, if several messages are
10768 received in one SMTP connection, &$acl_m...$& values are not passed on from one
10769 message to the next, as &$acl_c...$& values are. The &$acl_m...$& variables are
10770 also reset by MAIL, RSET, EHLO, HELO, and after starting a TLS session. When a
10771 message is received, the values of these variables are saved with the message,
10772 and can be accessed by filters, routers, and transports during subsequent
10773 delivery.
10774
10775 .vitem &$acl_verify_message$&
10776 .vindex "&$acl_verify_message$&"
10777 After an address verification has failed, this variable contains the failure
10778 message. It retains its value for use in subsequent modifiers. The message can
10779 be preserved by coding like this:
10780 .code
10781 warn !verify = sender
10782      set acl_m0 = $acl_verify_message
10783 .endd
10784 You can use &$acl_verify_message$& during the expansion of the &%message%& or
10785 &%log_message%& modifiers, to include information about the verification
10786 failure.
10787
10788 .vitem &$address_data$&
10789 .vindex "&$address_data$&"
10790 This variable is set by means of the &%address_data%& option in routers. The
10791 value then remains with the address while it is processed by subsequent routers
10792 and eventually a transport. If the transport is handling multiple addresses,
10793 the value from the first address is used. See chapter &<<CHAProutergeneric>>&
10794 for more details. &*Note*&: The contents of &$address_data$& are visible in
10795 user filter files.
10796
10797 If &$address_data$& is set when the routers are called from an ACL to verify
10798 a recipient address, the final value is still in the variable for subsequent
10799 conditions and modifiers of the ACL statement. If routing the address caused it
10800 to be redirected to just one address, the child address is also routed as part
10801 of the verification, and in this case the final value of &$address_data$& is
10802 from the child's routing.
10803
10804 If &$address_data$& is set when the routers are called from an ACL to verify a
10805 sender address, the final value is also preserved, but this time in
10806 &$sender_address_data$&, to distinguish it from data from a recipient
10807 address.
10808
10809 In both cases (recipient and sender verification), the value does not persist
10810 after the end of the current ACL statement. If you want to preserve
10811 these values for longer, you can save them in ACL variables.
10812
10813 .vitem &$address_file$&
10814 .vindex "&$address_file$&"
10815 When, as a result of aliasing, forwarding, or filtering, a message is directed
10816 to a specific file, this variable holds the name of the file when the transport
10817 is running. At other times, the variable is empty. For example, using the
10818 default configuration, if user &%r2d2%& has a &_.forward_& file containing
10819 .code
10820 /home/r2d2/savemail
10821 .endd
10822 then when the &(address_file)& transport is running, &$address_file$&
10823 contains the text string &`/home/r2d2/savemail`&.
10824 .cindex "Sieve filter" "value of &$address_file$&"
10825 For Sieve filters, the value may be &"inbox"& or a relative folder name. It is
10826 then up to the transport configuration to generate an appropriate absolute path
10827 to the relevant file.
10828
10829 .vitem &$address_pipe$&
10830 .vindex "&$address_pipe$&"
10831 When, as a result of aliasing or forwarding, a message is directed to a pipe,
10832 this variable holds the pipe command when the transport is running.
10833
10834 .vitem "&$auth1$& &-- &$auth3$&"
10835 .vindex "&$auth1$&, &$auth2$&, etc"
10836 These variables are used in SMTP authenticators (see chapters
10837 &<<CHAPplaintext>>&&--&<<CHAPspa>>&). Elsewhere, they are empty.
10838
10839 .vitem &$authenticated_id$&
10840 .cindex "authentication" "id"
10841 .vindex "&$authenticated_id$&"
10842 When a server successfully authenticates a client it may be configured to
10843 preserve some of the authentication information in the variable
10844 &$authenticated_id$& (see chapter &<<CHAPSMTPAUTH>>&). For example, a
10845 user/password authenticator configuration might preserve the user name for use
10846 in the routers. Note that this is not the same information that is saved in
10847 &$sender_host_authenticated$&.
10848 When a message is submitted locally (that is, not over a TCP connection)
10849 the value of &$authenticated_id$& is normally the login name of the calling
10850 process. However, a trusted user can override this by means of the &%-oMai%&
10851 command line option.
10852
10853
10854
10855
10856 .vitem &$authenticated_sender$&
10857 .cindex "sender" "authenticated"
10858 .cindex "authentication" "sender"
10859 .cindex "AUTH" "on MAIL command"
10860 .vindex "&$authenticated_sender$&"
10861 When acting as a server, Exim takes note of the AUTH= parameter on an incoming
10862 SMTP MAIL command if it believes the sender is sufficiently trusted, as
10863 described in section &<<SECTauthparamail>>&. Unless the data is the string
10864 &"<>"&, it is set as the authenticated sender of the message, and the value is
10865 available during delivery in the &$authenticated_sender$& variable. If the
10866 sender is not trusted, Exim accepts the syntax of AUTH=, but ignores the data.
10867
10868 .vindex "&$qualify_domain$&"
10869 When a message is submitted locally (that is, not over a TCP connection), the
10870 value of &$authenticated_sender$& is an address constructed from the login
10871 name of the calling process and &$qualify_domain$&, except that a trusted user
10872 can override this by means of the &%-oMas%& command line option.
10873
10874
10875 .vitem &$authentication_failed$&
10876 .cindex "authentication" "failure"
10877 .vindex "&$authentication_failed$&"
10878 This variable is set to &"1"& in an Exim server if a client issues an AUTH
10879 command that does not succeed. Otherwise it is set to &"0"&. This makes it
10880 possible to distinguish between &"did not try to authenticate"&
10881 (&$sender_host_authenticated$& is empty and &$authentication_failed$& is set to
10882 &"0"&) and &"tried to authenticate but failed"& (&$sender_host_authenticated$&
10883 is empty and &$authentication_failed$& is set to &"1"&). Failure includes any
10884 negative response to an AUTH command, including (for example) an attempt to use
10885 an undefined mechanism.
10886
10887 .vitem &$av_failed$&
10888 .cindex "content scanning" "AV scanner failure"
10889 This variable is available when Exim is compiled with the content-scanning
10890 extension. It is set to &"0"& by default, but will be set to &"1"& if any
10891 problem occurs with the virus scanner (specified by &%av_scanner%&) during
10892 the ACL malware condition.
10893
10894 .vitem &$body_linecount$&
10895 .cindex "message body" "line count"
10896 .cindex "body of message" "line count"
10897 .vindex "&$body_linecount$&"
10898 When a message is being received or delivered, this variable contains the
10899 number of lines in the message's body. See also &$message_linecount$&.
10900
10901 .vitem &$body_zerocount$&
10902 .cindex "message body" "binary zero count"
10903 .cindex "body of message" "binary zero count"
10904 .cindex "binary zero" "in message body"
10905 .vindex "&$body_zerocount$&"
10906 When a message is being received or delivered, this variable contains the
10907 number of binary zero bytes (ASCII NULs) in the message's body.
10908
10909 .vitem &$bounce_recipient$&
10910 .vindex "&$bounce_recipient$&"
10911 This is set to the recipient address of a bounce message while Exim is creating
10912 it. It is useful if a customized bounce message text file is in use (see
10913 chapter &<<CHAPemsgcust>>&).
10914
10915 .vitem &$bounce_return_size_limit$&
10916 .vindex "&$bounce_return_size_limit$&"
10917 This contains the value set in the &%bounce_return_size_limit%& option, rounded
10918 up to a multiple of 1000. It is useful when a customized error message text
10919 file is in use (see chapter &<<CHAPemsgcust>>&).
10920
10921 .vitem &$caller_gid$&
10922 .cindex "gid (group id)" "caller"
10923 .vindex "&$caller_gid$&"
10924 The real group id under which the process that called Exim was running. This is
10925 not the same as the group id of the originator of a message (see
10926 &$originator_gid$&). If Exim re-execs itself, this variable in the new
10927 incarnation normally contains the Exim gid.
10928
10929 .vitem &$caller_uid$&
10930 .cindex "uid (user id)" "caller"
10931 .vindex "&$caller_uid$&"
10932 The real user id under which the process that called Exim was running. This is
10933 not the same as the user id of the originator of a message (see
10934 &$originator_uid$&). If Exim re-execs itself, this variable in the new
10935 incarnation normally contains the Exim uid.
10936
10937 .vitem &$compile_date$&
10938 .vindex "&$compile_date$&"
10939 The date on which the Exim binary was compiled.
10940
10941 .vitem &$compile_number$&
10942 .vindex "&$compile_number$&"
10943 The building process for Exim keeps a count of the number
10944 of times it has been compiled. This serves to distinguish different
10945 compilations of the same version of the program.
10946
10947 .vitem &$demime_errorlevel$&
10948 .vindex "&$demime_errorlevel$&"
10949 This variable is available when Exim is compiled with
10950 the content-scanning extension and the obsolete &%demime%& condition. For
10951 details, see section &<<SECTdemimecond>>&.
10952
10953 .vitem &$demime_reason$&
10954 .vindex "&$demime_reason$&"
10955 This variable is available when Exim is compiled with the
10956 content-scanning extension and the obsolete &%demime%& condition. For details,
10957 see section &<<SECTdemimecond>>&.
10958
10959 .vitem &$dnslist_domain$& &&&
10960        &$dnslist_matched$& &&&
10961        &$dnslist_text$& &&&
10962        &$dnslist_value$&
10963 .vindex "&$dnslist_domain$&"
10964 .vindex "&$dnslist_matched$&"
10965 .vindex "&$dnslist_text$&"
10966 .vindex "&$dnslist_value$&"
10967 .cindex "black list (DNS)"
10968 When a DNS (black) list lookup succeeds, these variables are set to contain
10969 the following data from the lookup: the list's domain name, the key that was
10970 looked up, the contents of any associated TXT record, and the value from the
10971 main A record. See section &<<SECID204>>& for more details.
10972
10973 .vitem &$domain$&
10974 .vindex "&$domain$&"
10975 When an address is being routed, or delivered on its own, this variable
10976 contains the domain. Uppercase letters in the domain are converted into lower
10977 case for &$domain$&.
10978
10979 Global address rewriting happens when a message is received, so the value of
10980 &$domain$& during routing and delivery is the value after rewriting. &$domain$&
10981 is set during user filtering, but not during system filtering, because a
10982 message may have many recipients and the system filter is called just once.
10983
10984 When more than one address is being delivered at once (for example, several
10985 RCPT commands in one SMTP delivery), &$domain$& is set only if they all
10986 have the same domain. Transports can be restricted to handling only one domain
10987 at a time if the value of &$domain$& is required at transport time &-- this is
10988 the default for local transports. For further details of the environment in
10989 which local transports are run, see chapter &<<CHAPenvironment>>&.
10990
10991 .oindex "&%delay_warning_condition%&"
10992 At the end of a delivery, if all deferred addresses have the same domain, it is
10993 set in &$domain$& during the expansion of &%delay_warning_condition%&.
10994
10995 The &$domain$& variable is also used in some other circumstances:
10996
10997 .ilist
10998 When an ACL is running for a RCPT command, &$domain$& contains the domain of
10999 the recipient address. The domain of the &'sender'& address is in
11000 &$sender_address_domain$& at both MAIL time and at RCPT time. &$domain$& is not
11001 normally set during the running of the MAIL ACL. However, if the sender address
11002 is verified with a callout during the MAIL ACL, the sender domain is placed in
11003 &$domain$& during the expansions of &%hosts%&, &%interface%&, and &%port%& in
11004 the &(smtp)& transport.
11005
11006 .next
11007 When a rewrite item is being processed (see chapter &<<CHAPrewrite>>&),
11008 &$domain$& contains the domain portion of the address that is being rewritten;
11009 it can be used in the expansion of the replacement address, for example, to
11010 rewrite domains by file lookup.
11011
11012 .next
11013 With one important exception, whenever a domain list is being scanned,
11014 &$domain$& contains the subject domain. &*Exception*&: When a domain list in
11015 a &%sender_domains%& condition in an ACL is being processed, the subject domain
11016 is in &$sender_address_domain$& and not in &$domain$&. It works this way so
11017 that, in a RCPT ACL, the sender domain list can be dependent on the
11018 recipient domain (which is what is in &$domain$& at this time).
11019
11020 .next
11021 .cindex "ETRN" "value of &$domain$&"
11022 .oindex "&%smtp_etrn_command%&"
11023 When the &%smtp_etrn_command%& option is being expanded, &$domain$& contains
11024 the complete argument of the ETRN command (see section &<<SECTETRN>>&).
11025 .endlist
11026
11027
11028 .vitem &$domain_data$&
11029 .vindex "&$domain_data$&"
11030 When the &%domains%& option on a router matches a domain by
11031 means of a lookup, the data read by the lookup is available during the running
11032 of the router as &$domain_data$&. In addition, if the driver routes the
11033 address to a transport, the value is available in that transport. If the
11034 transport is handling multiple addresses, the value from the first address is
11035 used.
11036
11037 &$domain_data$& is also set when the &%domains%& condition in an ACL matches a
11038 domain by means of a lookup. The data read by the lookup is available during
11039 the rest of the ACL statement. In all other situations, this variable expands
11040 to nothing.
11041
11042 .vitem &$exim_gid$&
11043 .vindex "&$exim_gid$&"
11044 This variable contains the numerical value of the Exim group id.
11045
11046 .vitem &$exim_path$&
11047 .vindex "&$exim_path$&"
11048 This variable contains the path to the Exim binary.
11049
11050 .vitem &$exim_uid$&
11051 .vindex "&$exim_uid$&"
11052 This variable contains the numerical value of the Exim user id.
11053
11054 .vitem &$found_extension$&
11055 .vindex "&$found_extension$&"
11056 This variable is available when Exim is compiled with the
11057 content-scanning extension and the obsolete &%demime%& condition. For details,
11058 see section &<<SECTdemimecond>>&.
11059
11060 .vitem &$header_$&<&'name'&>
11061 This is not strictly an expansion variable. It is expansion syntax for
11062 inserting the message header line with the given name. Note that the name must
11063 be terminated by colon or white space, because it may contain a wide variety of
11064 characters. Note also that braces must &'not'& be used.
11065
11066 .vitem &$headers_added$&
11067 .vindex "&$headers_added$&"
11068 Within an ACL this variable contains the headers added so far by
11069 the ACL modifier add_header (section &<<SECTaddheadacl>>&).
11070 The headers are a newline-separated list.
11071
11072 .vitem &$home$&
11073 .vindex "&$home$&"
11074 When the &%check_local_user%& option is set for a router, the user's home
11075 directory is placed in &$home$& when the check succeeds. In particular, this
11076 means it is set during the running of users' filter files. A router may also
11077 explicitly set a home directory for use by a transport; this can be overridden
11078 by a setting on the transport itself.
11079
11080 When running a filter test via the &%-bf%& option, &$home$& is set to the value
11081 of the environment variable HOME.
11082
11083 .vitem &$host$&
11084 .vindex "&$host$&"
11085 If a router assigns an address to a transport (any transport), and passes a
11086 list of hosts with the address, the value of &$host$& when the transport starts
11087 to run is the name of the first host on the list. Note that this applies both
11088 to local and remote transports.
11089
11090 .cindex "transport" "filter"
11091 .cindex "filter" "transport filter"
11092 For the &(smtp)& transport, if there is more than one host, the value of
11093 &$host$& changes as the transport works its way through the list. In
11094 particular, when the &(smtp)& transport is expanding its options for encryption
11095 using TLS, or for specifying a transport filter (see chapter
11096 &<<CHAPtransportgeneric>>&), &$host$& contains the name of the host to which it
11097 is connected.
11098
11099 When used in the client part of an authenticator configuration (see chapter
11100 &<<CHAPSMTPAUTH>>&), &$host$& contains the name of the server to which the
11101 client is connected.
11102
11103
11104 .vitem &$host_address$&
11105 .vindex "&$host_address$&"
11106 This variable is set to the remote host's IP address whenever &$host$& is set
11107 for a remote connection. It is also set to the IP address that is being checked
11108 when the &%ignore_target_hosts%& option is being processed.
11109
11110 .vitem &$host_data$&
11111 .vindex "&$host_data$&"
11112 If a &%hosts%& condition in an ACL is satisfied by means of a lookup, the
11113 result of the lookup is made available in the &$host_data$& variable. This
11114 allows you, for example, to do things like this:
11115 .code
11116 deny  hosts = net-lsearch;/some/file
11117 message = $host_data
11118 .endd
11119 .vitem &$host_lookup_deferred$&
11120 .cindex "host name" "lookup, failure of"
11121 .vindex "&$host_lookup_deferred$&"
11122 This variable normally contains &"0"&, as does &$host_lookup_failed$&. When a
11123 message comes from a remote host and there is an attempt to look up the host's
11124 name from its IP address, and the attempt is not successful, one of these
11125 variables is set to &"1"&.
11126
11127 .ilist
11128 If the lookup receives a definite negative response (for example, a DNS lookup
11129 succeeded, but no records were found), &$host_lookup_failed$& is set to &"1"&.
11130
11131 .next
11132 If there is any kind of problem during the lookup, such that Exim cannot
11133 tell whether or not the host name is defined (for example, a timeout for a DNS
11134 lookup), &$host_lookup_deferred$& is set to &"1"&.
11135 .endlist ilist
11136
11137 Looking up a host's name from its IP address consists of more than just a
11138 single reverse lookup. Exim checks that a forward lookup of at least one of the
11139 names it receives from a reverse lookup yields the original IP address. If this
11140 is not the case, Exim does not accept the looked up name(s), and
11141 &$host_lookup_failed$& is set to &"1"&. Thus, being able to find a name from an
11142 IP address (for example, the existence of a PTR record in the DNS) is not
11143 sufficient on its own for the success of a host name lookup. If the reverse
11144 lookup succeeds, but there is a lookup problem such as a timeout when checking
11145 the result, the name is not accepted, and &$host_lookup_deferred$& is set to
11146 &"1"&. See also &$sender_host_name$&.
11147
11148 .vitem &$host_lookup_failed$&
11149 .vindex "&$host_lookup_failed$&"
11150 See &$host_lookup_deferred$&.
11151
11152
11153 .vitem &$inode$&
11154 .vindex "&$inode$&"
11155 The only time this variable is set is while expanding the &%directory_file%&
11156 option in the &(appendfile)& transport. The variable contains the inode number
11157 of the temporary file which is about to be renamed. It can be used to construct
11158 a unique name for the file.
11159
11160 .vitem &$interface_address$&
11161 .vindex "&$interface_address$&"
11162 This is an obsolete name for &$received_ip_address$&.
11163
11164 .vitem &$interface_port$&
11165 .vindex "&$interface_port$&"
11166 This is an obsolete name for &$received_port$&.
11167
11168 .vitem &$item$&
11169 .vindex "&$item$&"
11170 This variable is used during the expansion of &*forall*& and &*forany*&
11171 conditions (see section &<<SECTexpcond>>&), and &*filter*&, &*map*&, and
11172 &*reduce*& items (see section &<<SECTexpcond>>&). In other circumstances, it is
11173 empty.
11174
11175 .vitem &$ldap_dn$&
11176 .vindex "&$ldap_dn$&"
11177 This variable, which is available only when Exim is compiled with LDAP support,
11178 contains the DN from the last entry in the most recently successful LDAP
11179 lookup.
11180
11181 .vitem &$load_average$&
11182 .vindex "&$load_average$&"
11183 This variable contains the system load average, multiplied by 1000 so that it
11184 is an integer. For example, if the load average is 0.21, the value of the
11185 variable is 210. The value is recomputed every time the variable is referenced.
11186
11187 .vitem &$local_part$&
11188 .vindex "&$local_part$&"
11189 When an address is being routed, or delivered on its own, this
11190 variable contains the local part. When a number of addresses are being
11191 delivered together (for example, multiple RCPT commands in an SMTP
11192 session), &$local_part$& is not set.
11193
11194 Global address rewriting happens when a message is received, so the value of
11195 &$local_part$& during routing and delivery is the value after rewriting.
11196 &$local_part$& is set during user filtering, but not during system filtering,
11197 because a message may have many recipients and the system filter is called just
11198 once.
11199
11200 .vindex "&$local_part_prefix$&"
11201 .vindex "&$local_part_suffix$&"
11202 If a local part prefix or suffix has been recognized, it is not included in the
11203 value of &$local_part$& during routing and subsequent delivery. The values of
11204 any prefix or suffix are in &$local_part_prefix$& and
11205 &$local_part_suffix$&, respectively.
11206
11207 When a message is being delivered to a file, pipe, or autoreply transport as a
11208 result of aliasing or forwarding, &$local_part$& is set to the local part of
11209 the parent address, not to the file name or command (see &$address_file$& and
11210 &$address_pipe$&).
11211
11212 When an ACL is running for a RCPT command, &$local_part$& contains the
11213 local part of the recipient address.
11214
11215 When a rewrite item is being processed (see chapter &<<CHAPrewrite>>&),
11216 &$local_part$& contains the local part of the address that is being rewritten;
11217 it can be used in the expansion of the replacement address, for example.
11218
11219 In all cases, all quoting is removed from the local part. For example, for both
11220 the addresses
11221 .code
11222 "abc:xyz"@test.example
11223 abc\:xyz@test.example
11224 .endd
11225 the value of &$local_part$& is
11226 .code
11227 abc:xyz
11228 .endd
11229 If you use &$local_part$& to create another address, you should always wrap it
11230 inside a quoting operator. For example, in a &(redirect)& router you could
11231 have:
11232 .code
11233 data = ${quote_local_part:$local_part}@new.domain.example
11234 .endd
11235 &*Note*&: The value of &$local_part$& is normally lower cased. If you want
11236 to process local parts in a case-dependent manner in a router, you can set the
11237 &%caseful_local_part%& option (see chapter &<<CHAProutergeneric>>&).
11238
11239 .vitem &$local_part_data$&
11240 .vindex "&$local_part_data$&"
11241 When the &%local_parts%& option on a router matches a local part by means of a
11242 lookup, the data read by the lookup is available during the running of the
11243 router as &$local_part_data$&. In addition, if the driver routes the address
11244 to a transport, the value is available in that transport. If the transport is
11245 handling multiple addresses, the value from the first address is used.
11246
11247 &$local_part_data$& is also set when the &%local_parts%& condition in an ACL
11248 matches a local part by means of a lookup. The data read by the lookup is
11249 available during the rest of the ACL statement. In all other situations, this
11250 variable expands to nothing.
11251
11252 .vitem &$local_part_prefix$&
11253 .vindex "&$local_part_prefix$&"
11254 When an address is being routed or delivered, and a
11255 specific prefix for the local part was recognized, it is available in this
11256 variable, having been removed from &$local_part$&.
11257
11258 .vitem &$local_part_suffix$&
11259 .vindex "&$local_part_suffix$&"
11260 When an address is being routed or delivered, and a
11261 specific suffix for the local part was recognized, it is available in this
11262 variable, having been removed from &$local_part$&.
11263
11264 .vitem &$local_scan_data$&
11265 .vindex "&$local_scan_data$&"
11266 This variable contains the text returned by the &[local_scan()]& function when
11267 a message is received. See chapter &<<CHAPlocalscan>>& for more details.
11268
11269 .vitem &$local_user_gid$&
11270 .vindex "&$local_user_gid$&"
11271 See &$local_user_uid$&.
11272
11273 .vitem &$local_user_uid$&
11274 .vindex "&$local_user_uid$&"
11275 This variable and &$local_user_gid$& are set to the uid and gid after the
11276 &%check_local_user%& router precondition succeeds. This means that their values
11277 are available for the remaining preconditions (&%senders%&, &%require_files%&,
11278 and &%condition%&), for the &%address_data%& expansion, and for any
11279 router-specific expansions. At all other times, the values in these variables
11280 are &`(uid_t)(-1)`& and &`(gid_t)(-1)`&, respectively.
11281
11282 .vitem &$localhost_number$&
11283 .vindex "&$localhost_number$&"
11284 This contains the expanded value of the
11285 &%localhost_number%& option. The expansion happens after the main options have
11286 been read.
11287
11288 .vitem &$log_inodes$&
11289 .vindex "&$log_inodes$&"
11290 The number of free inodes in the disk partition where Exim's
11291 log files are being written. The value is recalculated whenever the variable is
11292 referenced. If the relevant file system does not have the concept of inodes,
11293 the value of is -1. See also the &%check_log_inodes%& option.
11294
11295 .vitem &$log_space$&
11296 .vindex "&$log_space$&"
11297 The amount of free space (as a number of kilobytes) in the disk
11298 partition where Exim's log files are being written. The value is recalculated
11299 whenever the variable is referenced. If the operating system does not have the
11300 ability to find the amount of free space (only true for experimental systems),
11301 the space value is -1. See also the &%check_log_space%& option.
11302
11303
11304 .vitem &$mailstore_basename$&
11305 .vindex "&$mailstore_basename$&"
11306 This variable is set only when doing deliveries in &"mailstore"& format in the
11307 &(appendfile)& transport. During the expansion of the &%mailstore_prefix%&,
11308 &%mailstore_suffix%&, &%message_prefix%&, and &%message_suffix%& options, it
11309 contains the basename of the files that are being written, that is, the name
11310 without the &".tmp"&, &".env"&, or &".msg"& suffix. At all other times, this
11311 variable is empty.
11312
11313 .vitem &$malware_name$&
11314 .vindex "&$malware_name$&"
11315 This variable is available when Exim is compiled with the
11316 content-scanning extension. It is set to the name of the virus that was found
11317 when the ACL &%malware%& condition is true (see section &<<SECTscanvirus>>&).
11318
11319 .vitem &$max_received_linelength$&
11320 .vindex "&$max_received_linelength$&"
11321 .cindex "maximum" "line length"
11322 .cindex "line length" "maximum"
11323 This variable contains the number of bytes in the longest line that was
11324 received as part of the message, not counting the line termination
11325 character(s).
11326
11327 .vitem &$message_age$&
11328 .cindex "message" "age of"
11329 .vindex "&$message_age$&"
11330 This variable is set at the start of a delivery attempt to contain the number
11331 of seconds since the message was received. It does not change during a single
11332 delivery attempt.
11333
11334 .vitem &$message_body$&
11335 .cindex "body of message" "expansion variable"
11336 .cindex "message body" "in expansion"
11337 .cindex "binary zero" "in message body"
11338 .vindex "&$message_body$&"
11339 .oindex "&%message_body_visible%&"
11340 This variable contains the initial portion of a message's body while it is
11341 being delivered, and is intended mainly for use in filter files. The maximum
11342 number of characters of the body that are put into the variable is set by the
11343 &%message_body_visible%& configuration option; the default is 500.
11344
11345 .oindex "&%message_body_newlines%&"
11346 By default, newlines are converted into spaces in &$message_body$&, to make it
11347 easier to search for phrases that might be split over a line break. However,
11348 this can be disabled by setting &%message_body_newlines%& to be true. Binary
11349 zeros are always converted into spaces.
11350
11351 .vitem &$message_body_end$&
11352 .cindex "body of message" "expansion variable"
11353 .cindex "message body" "in expansion"
11354 .vindex "&$message_body_end$&"
11355 This variable contains the final portion of a message's
11356 body while it is being delivered. The format and maximum size are as for
11357 &$message_body$&.
11358
11359 .vitem &$message_body_size$&
11360 .cindex "body of message" "size"
11361 .cindex "message body" "size"
11362 .vindex "&$message_body_size$&"
11363 When a message is being delivered, this variable contains the size of the body
11364 in bytes. The count starts from the character after the blank line that
11365 separates the body from the header. Newlines are included in the count. See
11366 also &$message_size$&, &$body_linecount$&, and &$body_zerocount$&.
11367
11368 .vitem &$message_exim_id$&
11369 .vindex "&$message_exim_id$&"
11370 When a message is being received or delivered, this variable contains the
11371 unique message id that is generated and used by Exim to identify the message.
11372 An id is not created for a message until after its header has been successfully
11373 received. &*Note*&: This is &'not'& the contents of the &'Message-ID:'& header
11374 line; it is the local id that Exim assigns to the message, for example:
11375 &`1BXTIK-0001yO-VA`&.
11376
11377 .vitem &$message_headers$&
11378 .vindex &$message_headers$&
11379 This variable contains a concatenation of all the header lines when a message
11380 is being processed, except for lines added by routers or transports. The header
11381 lines are separated by newline characters. Their contents are decoded in the
11382 same way as a header line that is inserted by &%bheader%&.
11383
11384 .vitem &$message_headers_raw$&
11385 .vindex &$message_headers_raw$&
11386 This variable is like &$message_headers$& except that no processing of the
11387 contents of header lines is done.
11388
11389 .vitem &$message_id$&
11390 This is an old name for &$message_exim_id$&, which is now deprecated.
11391
11392 .vitem &$message_linecount$&
11393 .vindex "&$message_linecount$&"
11394 This variable contains the total number of lines in the header and body of the
11395 message. Compare &$body_linecount$&, which is the count for the body only.
11396 During the DATA and content-scanning ACLs, &$message_linecount$& contains the
11397 number of lines received. Before delivery happens (that is, before filters,
11398 routers, and transports run) the count is increased to include the
11399 &'Received:'& header line that Exim standardly adds, and also any other header
11400 lines that are added by ACLs. The blank line that separates the message header
11401 from the body is not counted.
11402
11403 As with the special case of &$message_size$&, during the expansion of the
11404 appendfile transport's maildir_tag option in maildir format, the value of
11405 &$message_linecount$& is the precise size of the number of newlines in the
11406 file that has been written (minus one for the blank line between the
11407 header and the body).
11408
11409 Here is an example of the use of this variable in a DATA ACL:
11410 .code
11411 deny message   = Too many lines in message header
11412      condition = \
11413       ${if <{250}{${eval:$message_linecount - $body_linecount}}}
11414 .endd
11415 In the MAIL and RCPT ACLs, the value is zero because at that stage the
11416 message has not yet been received.
11417
11418 .vitem &$message_size$&
11419 .cindex "size" "of message"
11420 .cindex "message" "size"
11421 .vindex "&$message_size$&"
11422 When a message is being processed, this variable contains its size in bytes. In
11423 most cases, the size includes those headers that were received with the
11424 message, but not those (such as &'Envelope-to:'&) that are added to individual
11425 deliveries as they are written. However, there is one special case: during the
11426 expansion of the &%maildir_tag%& option in the &(appendfile)& transport while
11427 doing a delivery in maildir format, the value of &$message_size$& is the
11428 precise size of the file that has been written. See also
11429 &$message_body_size$&, &$body_linecount$&, and &$body_zerocount$&.
11430
11431 .cindex "RCPT" "value of &$message_size$&"
11432 While running a per message ACL (mail/rcpt/predata), &$message_size$&
11433 contains the size supplied on the MAIL command, or -1 if no size was given. The
11434 value may not, of course, be truthful.
11435
11436 .vitem &$mime_$&&'xxx'&
11437 A number of variables whose names start with &$mime$& are
11438 available when Exim is compiled with the content-scanning extension. For
11439 details, see section &<<SECTscanmimepart>>&.
11440
11441 .vitem "&$n0$& &-- &$n9$&"
11442 These variables are counters that can be incremented by means
11443 of the &%add%& command in filter files.
11444
11445 .vitem &$original_domain$&
11446 .vindex "&$domain$&"
11447 .vindex "&$original_domain$&"
11448 When a top-level address is being processed for delivery, this contains the
11449 same value as &$domain$&. However, if a &"child"& address (for example,
11450 generated by an alias, forward, or filter file) is being processed, this
11451 variable contains the domain of the original address (lower cased). This
11452 differs from &$parent_domain$& only when there is more than one level of
11453 aliasing or forwarding. When more than one address is being delivered in a
11454 single transport run, &$original_domain$& is not set.
11455
11456 If a new address is created by means of a &%deliver%& command in a system
11457 filter, it is set up with an artificial &"parent"& address. This has the local
11458 part &'system-filter'& and the default qualify domain.
11459
11460 .vitem &$original_local_part$&
11461 .vindex "&$local_part$&"
11462 .vindex "&$original_local_part$&"
11463 When a top-level address is being processed for delivery, this contains the
11464 same value as &$local_part$&, unless a prefix or suffix was removed from the
11465 local part, because &$original_local_part$& always contains the full local
11466 part. When a &"child"& address (for example, generated by an alias, forward, or
11467 filter file) is being processed, this variable contains the full local part of
11468 the original address.
11469
11470 If the router that did the redirection processed the local part
11471 case-insensitively, the value in &$original_local_part$& is in lower case.
11472 This variable differs from &$parent_local_part$& only when there is more than
11473 one level of aliasing or forwarding. When more than one address is being
11474 delivered in a single transport run, &$original_local_part$& is not set.
11475
11476 If a new address is created by means of a &%deliver%& command in a system
11477 filter, it is set up with an artificial &"parent"& address. This has the local
11478 part &'system-filter'& and the default qualify domain.
11479
11480 .vitem &$originator_gid$&
11481 .cindex "gid (group id)" "of originating user"
11482 .cindex "sender" "gid"
11483 .vindex "&$caller_gid$&"
11484 .vindex "&$originator_gid$&"
11485 This variable contains the value of &$caller_gid$& that was set when the
11486 message was received. For messages received via the command line, this is the
11487 gid of the sending user. For messages received by SMTP over TCP/IP, this is
11488 normally the gid of the Exim user.
11489
11490 .vitem &$originator_uid$&
11491 .cindex "uid (user id)" "of originating user"
11492 .cindex "sender" "uid"
11493 .vindex "&$caller_uid$&"
11494 .vindex "&$originaltor_uid$&"
11495 The value of &$caller_uid$& that was set when the message was received. For
11496 messages received via the command line, this is the uid of the sending user.
11497 For messages received by SMTP over TCP/IP, this is normally the uid of the Exim
11498 user.
11499
11500 .vitem &$parent_domain$&
11501 .vindex "&$parent_domain$&"
11502 This variable is similar to &$original_domain$& (see
11503 above), except that it refers to the immediately preceding parent address.
11504
11505 .vitem &$parent_local_part$&
11506 .vindex "&$parent_local_part$&"
11507 This variable is similar to &$original_local_part$&
11508 (see above), except that it refers to the immediately preceding parent address.
11509
11510 .vitem &$pid$&
11511 .cindex "pid (process id)" "of current process"
11512 .vindex "&$pid$&"
11513 This variable contains the current process id.
11514
11515 .vitem &$pipe_addresses$&
11516 .cindex "filter" "transport filter"
11517 .cindex "transport" "filter"
11518 .vindex "&$pipe_addresses$&"
11519 This is not an expansion variable, but is mentioned here because the string
11520 &`$pipe_addresses`& is handled specially in the command specification for the
11521 &(pipe)& transport (chapter &<<CHAPpipetransport>>&) and in transport filters
11522 (described under &%transport_filter%& in chapter &<<CHAPtransportgeneric>>&).
11523 It cannot be used in general expansion strings, and provokes an &"unknown
11524 variable"& error if encountered.
11525
11526 .vitem &$primary_hostname$&
11527 .vindex "&$primary_hostname$&"
11528 This variable contains the value set by &%primary_hostname%& in the
11529 configuration file, or read by the &[uname()]& function. If &[uname()]& returns
11530 a single-component name, Exim calls &[gethostbyname()]& (or
11531 &[getipnodebyname()]& where available) in an attempt to acquire a fully
11532 qualified host name. See also &$smtp_active_hostname$&.
11533
11534
11535 .vitem &$prvscheck_address$&
11536 This variable is used in conjunction with the &%prvscheck%& expansion item,
11537 which is described in sections &<<SECTexpansionitems>>& and
11538 &<<SECTverifyPRVS>>&.
11539
11540 .vitem &$prvscheck_keynum$&
11541 This variable is used in conjunction with the &%prvscheck%& expansion item,
11542 which is described in sections &<<SECTexpansionitems>>& and
11543 &<<SECTverifyPRVS>>&.
11544
11545 .vitem &$prvscheck_result$&
11546 This variable is used in conjunction with the &%prvscheck%& expansion item,
11547 which is described in sections &<<SECTexpansionitems>>& and
11548 &<<SECTverifyPRVS>>&.
11549
11550 .vitem &$qualify_domain$&
11551 .vindex "&$qualify_domain$&"
11552 The value set for the &%qualify_domain%& option in the configuration file.
11553
11554 .vitem &$qualify_recipient$&
11555 .vindex "&$qualify_recipient$&"
11556 The value set for the &%qualify_recipient%& option in the configuration file,
11557 or if not set, the value of &$qualify_domain$&.
11558
11559 .vitem &$rcpt_count$&
11560 .vindex "&$rcpt_count$&"
11561 When a message is being received by SMTP, this variable contains the number of
11562 RCPT commands received for the current message. If this variable is used in a
11563 RCPT ACL, its value includes the current command.
11564
11565 .vitem &$rcpt_defer_count$&
11566 .vindex "&$rcpt_defer_count$&"
11567 .cindex "4&'xx'& responses" "count of"
11568 When a message is being received by SMTP, this variable contains the number of
11569 RCPT commands in the current message that have previously been rejected with a
11570 temporary (4&'xx'&) response.
11571
11572 .vitem &$rcpt_fail_count$&
11573 .vindex "&$rcpt_fail_count$&"
11574 When a message is being received by SMTP, this variable contains the number of
11575 RCPT commands in the current message that have previously been rejected with a
11576 permanent (5&'xx'&) response.
11577
11578 .vitem &$received_count$&
11579 .vindex "&$received_count$&"
11580 This variable contains the number of &'Received:'& header lines in the message,
11581 including the one added by Exim (so its value is always greater than zero). It
11582 is available in the DATA ACL, the non-SMTP ACL, and while routing and
11583 delivering.
11584
11585 .vitem &$received_for$&
11586 .vindex "&$received_for$&"
11587 If there is only a single recipient address in an incoming message, this
11588 variable contains that address when the &'Received:'& header line is being
11589 built. The value is copied after recipient rewriting has happened, but before
11590 the &[local_scan()]& function is run.
11591
11592 .vitem &$received_ip_address$&
11593 .vindex "&$received_ip_address$&"
11594 As soon as an Exim server starts processing an incoming TCP/IP connection, this
11595 variable is set to the address of the local IP interface, and &$received_port$&
11596 is set to the local port number. (The remote IP address and port are in
11597 &$sender_host_address$& and &$sender_host_port$&.) When testing with &%-bh%&,
11598 the port value is -1 unless it has been set using the &%-oMi%& command line
11599 option.
11600
11601 As well as being useful in ACLs (including the &"connect"& ACL), these variable
11602 could be used, for example, to make the file name for a TLS certificate depend
11603 on which interface and/or port is being used for the incoming connection. The
11604 values of &$received_ip_address$& and &$received_port$& are saved with any
11605 messages that are received, thus making these variables available at delivery
11606 time.
11607
11608 &*Note:*& There are no equivalent variables for outgoing connections, because
11609 the values are unknown (unless they are explicitly set by options of the
11610 &(smtp)& transport).
11611
11612 .vitem &$received_port$&
11613 .vindex "&$received_port$&"
11614 See &$received_ip_address$&.
11615
11616 .vitem &$received_protocol$&
11617 .vindex "&$received_protocol$&"
11618 When a message is being processed, this variable contains the name of the
11619 protocol by which it was received. Most of the names used by Exim are defined
11620 by RFCs 821, 2821, and 3848. They start with &"smtp"& (the client used HELO) or
11621 &"esmtp"& (the client used EHLO). This can be followed by &"s"& for secure
11622 (encrypted) and/or &"a"& for authenticated. Thus, for example, if the protocol
11623 is set to &"esmtpsa"&, the message was received over an encrypted SMTP
11624 connection and the client was successfully authenticated.
11625
11626 Exim uses the protocol name &"smtps"& for the case when encryption is
11627 automatically set up on connection without the use of STARTTLS (see
11628 &%tls_on_connect_ports%&), and the client uses HELO to initiate the
11629 encrypted SMTP session. The name &"smtps"& is also used for the rare situation
11630 where the client initially uses EHLO, sets up an encrypted connection using
11631 STARTTLS, and then uses HELO afterwards.
11632
11633 The &%-oMr%& option provides a way of specifying a custom protocol name for
11634 messages that are injected locally by trusted callers. This is commonly used to
11635 identify messages that are being re-injected after some kind of scanning.
11636
11637 .vitem &$received_time$&
11638 .vindex "&$received_time$&"
11639 This variable contains the date and time when the current message was received,
11640 as a number of seconds since the start of the Unix epoch.
11641
11642 .vitem &$recipient_data$&
11643 .vindex "&$recipient_data$&"
11644 This variable is set after an indexing lookup success in an ACL &%recipients%&
11645 condition. It contains the data from the lookup, and the value remains set
11646 until the next &%recipients%& test. Thus, you can do things like this:
11647 .display
11648 &`require recipients  = cdb*@;/some/file`&
11649 &`deny    `&&'some further test involving'& &`$recipient_data`&
11650 .endd
11651 &*Warning*&: This variable is set only when a lookup is used as an indexing
11652 method in the address list, using the semicolon syntax as in the example above.
11653 The variable is not set for a lookup that is used as part of the string
11654 expansion that all such lists undergo before being interpreted.
11655
11656 .vitem &$recipient_verify_failure$&
11657 .vindex "&$recipient_verify_failure$&"
11658 In an ACL, when a recipient verification fails, this variable contains
11659 information about the failure. It is set to one of the following words:
11660
11661 .ilist
11662 &"qualify"&: The address was unqualified (no domain), and the message
11663 was neither local nor came from an exempted host.
11664
11665 .next
11666 &"route"&: Routing failed.
11667
11668 .next
11669 &"mail"&: Routing succeeded, and a callout was attempted; rejection occurred at
11670 or before the MAIL command (that is, on initial connection, HELO, or
11671 MAIL).
11672
11673 .next
11674 &"recipient"&: The RCPT command in a callout was rejected.
11675 .next
11676
11677 &"postmaster"&: The postmaster check in a callout was rejected.
11678 .endlist
11679
11680 The main use of this variable is expected to be to distinguish between
11681 rejections of MAIL and rejections of RCPT.
11682
11683 .vitem &$recipients$&
11684 .vindex "&$recipients$&"
11685 This variable contains a list of envelope recipients for a message. A comma and
11686 a space separate the addresses in the replacement text. However, the variable
11687 is not generally available, to prevent exposure of Bcc recipients in
11688 unprivileged users' filter files. You can use &$recipients$& only in these
11689 cases:
11690
11691 .olist
11692 In a system filter file.
11693 .next
11694 In the ACLs associated with the DATA command and with non-SMTP messages, that
11695 is, the ACLs defined by &%acl_smtp_predata%&, &%acl_smtp_data%&,
11696 &%acl_smtp_mime%&, &%acl_not_smtp_start%&, &%acl_not_smtp%&, and
11697 &%acl_not_smtp_mime%&.
11698 .next
11699 From within a &[local_scan()]& function.
11700 .endlist
11701
11702
11703 .vitem &$recipients_count$&
11704 .vindex "&$recipients_count$&"
11705 When a message is being processed, this variable contains the number of
11706 envelope recipients that came with the message. Duplicates are not excluded
11707 from the count. While a message is being received over SMTP, the number
11708 increases for each accepted recipient. It can be referenced in an ACL.
11709
11710
11711 .vitem &$regex_match_string$&
11712 .vindex "&$regex_match_string$&"
11713 This variable is set to contain the matching regular expression after a
11714 &%regex%& ACL condition has matched (see section &<<SECTscanregex>>&).
11715
11716
11717 .vitem &$reply_address$&
11718 .vindex "&$reply_address$&"
11719 When a message is being processed, this variable contains the contents of the
11720 &'Reply-To:'& header line if one exists and it is not empty, or otherwise the
11721 contents of the &'From:'& header line. Apart from the removal of leading
11722 white space, the value is not processed in any way. In particular, no RFC 2047
11723 decoding or character code translation takes place.
11724
11725 .vitem &$return_path$&
11726 .vindex "&$return_path$&"
11727 When a message is being delivered, this variable contains the return path &--
11728 the sender field that will be sent as part of the envelope. It is not enclosed
11729 in <> characters. At the start of routing an address, &$return_path$& has the
11730 same value as &$sender_address$&, but if, for example, an incoming message to a
11731 mailing list has been expanded by a router which specifies a different address
11732 for bounce messages, &$return_path$& subsequently contains the new bounce
11733 address, whereas &$sender_address$& always contains the original sender address
11734 that was received with the message. In other words, &$sender_address$& contains
11735 the incoming envelope sender, and &$return_path$& contains the outgoing
11736 envelope sender.
11737
11738 .vitem &$return_size_limit$&
11739 .vindex "&$return_size_limit$&"
11740 This is an obsolete name for &$bounce_return_size_limit$&.
11741
11742 .vitem &$runrc$&
11743 .cindex "return code" "from &%run%& expansion"
11744 .vindex "&$runrc$&"
11745 This variable contains the return code from a command that is run by the
11746 &%${run...}%& expansion item. &*Warning*&: In a router or transport, you cannot
11747 assume the order in which option values are expanded, except for those
11748 preconditions whose order of testing is documented. Therefore, you cannot
11749 reliably expect to set &$runrc$& by the expansion of one option, and use it in
11750 another.
11751
11752 .vitem &$self_hostname$&
11753 .oindex "&%self%&" "value of host name"
11754 .vindex "&$self_hostname$&"
11755 When an address is routed to a supposedly remote host that turns out to be the
11756 local host, what happens is controlled by the &%self%& generic router option.
11757 One of its values causes the address to be passed to another router. When this
11758 happens, &$self_hostname$& is set to the name of the local host that the
11759 original router encountered. In other circumstances its contents are null.
11760
11761 .vitem &$sender_address$&
11762 .vindex "&$sender_address$&"
11763 When a message is being processed, this variable contains the sender's address
11764 that was received in the message's envelope. The case of letters in the address
11765 is retained, in both the local part and the domain. For bounce messages, the
11766 value of this variable is the empty string. See also &$return_path$&.
11767
11768 .vitem &$sender_address_data$&
11769 .vindex "&$address_data$&"
11770 .vindex "&$sender_address_data$&"
11771 If &$address_data$& is set when the routers are called from an ACL to verify a
11772 sender address, the final value is preserved in &$sender_address_data$&, to
11773 distinguish it from data from a recipient address. The value does not persist
11774 after the end of the current ACL statement. If you want to preserve it for
11775 longer, you can save it in an ACL variable.
11776
11777 .vitem &$sender_address_domain$&
11778 .vindex "&$sender_address_domain$&"
11779 The domain portion of &$sender_address$&.
11780
11781 .vitem &$sender_address_local_part$&
11782 .vindex "&$sender_address_local_part$&"
11783 The local part portion of &$sender_address$&.
11784
11785 .vitem &$sender_data$&
11786 .vindex "&$sender_data$&"
11787 This variable is set after a lookup success in an ACL &%senders%& condition or
11788 in a router &%senders%& option. It contains the data from the lookup, and the
11789 value remains set until the next &%senders%& test. Thus, you can do things like
11790 this:
11791 .display
11792 &`require senders      = cdb*@;/some/file`&
11793 &`deny    `&&'some further test involving'& &`$sender_data`&
11794 .endd
11795 &*Warning*&: This variable is set only when a lookup is used as an indexing
11796 method in the address list, using the semicolon syntax as in the example above.
11797 The variable is not set for a lookup that is used as part of the string
11798 expansion that all such lists undergo before being interpreted.
11799
11800 .vitem &$sender_fullhost$&
11801 .vindex "&$sender_fullhost$&"
11802 When a message is received from a remote host, this variable contains the host
11803 name and IP address in a single string. It ends with the IP address in square
11804 brackets, followed by a colon and a port number if the logging of ports is
11805 enabled. The format of the rest of the string depends on whether the host
11806 issued a HELO or EHLO SMTP command, and whether the host name was verified by
11807 looking up its IP address. (Looking up the IP address can be forced by the
11808 &%host_lookup%& option, independent of verification.) A plain host name at the
11809 start of the string is a verified host name; if this is not present,
11810 verification either failed or was not requested. A host name in parentheses is
11811 the argument of a HELO or EHLO command. This is omitted if it is identical to
11812 the verified host name or to the host's IP address in square brackets.
11813
11814 .vitem &$sender_helo_name$&
11815 .vindex "&$sender_helo_name$&"
11816 When a message is received from a remote host that has issued a HELO or EHLO
11817 command, the argument of that command is placed in this variable. It is also
11818 set if HELO or EHLO is used when a message is received using SMTP locally via
11819 the &%-bs%& or &%-bS%& options.
11820
11821 .vitem &$sender_host_address$&
11822 .vindex "&$sender_host_address$&"
11823 When a message is received from a remote host, this variable contains that
11824 host's IP address. For locally submitted messages, it is empty.
11825
11826 .vitem &$sender_host_authenticated$&
11827 .vindex "&$sender_host_authenticated$&"
11828 This variable contains the name (not the public name) of the authenticator
11829 driver that successfully authenticated the client from which the message was
11830 received. It is empty if there was no successful authentication. See also
11831 &$authenticated_id$&.
11832
11833 .new
11834 .vitem &$sender_host_dnssec$&
11835 .vindex "&$sender_host_dnssec$&"
11836 If &$sender_host_name$& has been populated (by reference, &%hosts_lookup%& or
11837 otherwise) then this boolean will have been set true if, and only if, the
11838 resolver library states that the reverse DNS was authenticated data.  At all
11839 other times, this variable is false.
11840
11841 It is likely that you will need to coerce DNSSEC support on in the resolver
11842 library, by setting:
11843 .code
11844 dns_use_dnssec = 1
11845 .endd
11846
11847 Exim does not perform DNSSEC validation itself, instead leaving that to a
11848 validating resolver (eg, unbound, or bind with suitable configuration).
11849
11850 Exim does not (currently) check to see if the forward DNS was also secured
11851 with DNSSEC, only the reverse DNS.
11852
11853 If you have changed &%host_lookup_order%& so that &`bydns`& is not the first
11854 mechanism in the list, then this variable will be false.
11855 .wen
11856
11857
11858 .vitem &$sender_host_name$&
11859 .vindex "&$sender_host_name$&"
11860 When a message is received from a remote host, this variable contains the
11861 host's name as obtained by looking up its IP address. For messages received by
11862 other means, this variable is empty.
11863
11864 .vindex "&$host_lookup_failed$&"
11865 If the host name has not previously been looked up, a reference to
11866 &$sender_host_name$& triggers a lookup (for messages from remote hosts).
11867 A looked up name is accepted only if it leads back to the original IP address
11868 via a forward lookup. If either the reverse or the forward lookup fails to find
11869 any data, or if the forward lookup does not yield the original IP address,
11870 &$sender_host_name$& remains empty, and &$host_lookup_failed$& is set to &"1"&.
11871
11872 .vindex "&$host_lookup_deferred$&"
11873 However, if either of the lookups cannot be completed (for example, there is a
11874 DNS timeout), &$host_lookup_deferred$& is set to &"1"&, and
11875 &$host_lookup_failed$& remains set to &"0"&.
11876
11877 Once &$host_lookup_failed$& is set to &"1"&, Exim does not try to look up the
11878 host name again if there is a subsequent reference to &$sender_host_name$&
11879 in the same Exim process, but it does try again if &$host_lookup_deferred$&
11880 is set to &"1"&.
11881
11882 Exim does not automatically look up every calling host's name. If you want
11883 maximum efficiency, you should arrange your configuration so that it avoids
11884 these lookups altogether. The lookup happens only if one or more of the
11885 following are true:
11886
11887 .ilist
11888 A string containing &$sender_host_name$& is expanded.
11889 .next
11890 The calling host matches the list in &%host_lookup%&. In the default
11891 configuration, this option is set to *, so it must be changed if lookups are
11892 to be avoided. (In the code, the default for &%host_lookup%& is unset.)
11893 .next
11894 Exim needs the host name in order to test an item in a host list. The items
11895 that require this are described in sections &<<SECThoslispatnam>>& and
11896 &<<SECThoslispatnamsk>>&.
11897 .next
11898 The calling host matches &%helo_try_verify_hosts%& or &%helo_verify_hosts%&.
11899 In this case, the host name is required to compare with the name quoted in any
11900 EHLO or HELO commands that the client issues.
11901 .next
11902 The remote host issues a EHLO or HELO command that quotes one of the
11903 domains in &%helo_lookup_domains%&. The default value of this option is
11904 . ==== As this is a nested list, any displays it contains must be indented
11905 . ==== as otherwise they are too far to the left.
11906 .code
11907   helo_lookup_domains = @ : @[]
11908 .endd
11909 which causes a lookup if a remote host (incorrectly) gives the server's name or
11910 IP address in an EHLO or HELO command.
11911 .endlist
11912
11913
11914 .vitem &$sender_host_port$&
11915 .vindex "&$sender_host_port$&"
11916 When a message is received from a remote host, this variable contains the port
11917 number that was used on the remote host.
11918
11919 .vitem &$sender_ident$&
11920 .vindex "&$sender_ident$&"
11921 When a message is received from a remote host, this variable contains the
11922 identification received in response to an RFC 1413 request. When a message has
11923 been received locally, this variable contains the login name of the user that
11924 called Exim.
11925
11926 .vitem &$sender_rate_$&&'xxx'&
11927 A number of variables whose names begin &$sender_rate_$& are set as part of the
11928 &%ratelimit%& ACL condition. Details are given in section
11929 &<<SECTratelimiting>>&.
11930
11931 .vitem &$sender_rcvhost$&
11932 .cindex "DNS" "reverse lookup"
11933 .cindex "reverse DNS lookup"
11934 .vindex "&$sender_rcvhost$&"
11935 This is provided specifically for use in &'Received:'& headers. It starts with
11936 either the verified host name (as obtained from a reverse DNS lookup) or, if
11937 there is no verified host name, the IP address in square brackets. After that
11938 there may be text in parentheses. When the first item is a verified host name,
11939 the first thing in the parentheses is the IP address in square brackets,
11940 followed by a colon and a port number if port logging is enabled. When the
11941 first item is an IP address, the port is recorded as &"port=&'xxxx'&"& inside
11942 the parentheses.
11943
11944 There may also be items of the form &"helo=&'xxxx'&"& if HELO or EHLO
11945 was used and its argument was not identical to the real host name or IP
11946 address, and &"ident=&'xxxx'&"& if an RFC 1413 ident string is available. If
11947 all three items are present in the parentheses, a newline and tab are inserted
11948 into the string, to improve the formatting of the &'Received:'& header.
11949
11950 .vitem &$sender_verify_failure$&
11951 .vindex "&$sender_verify_failure$&"
11952 In an ACL, when a sender verification fails, this variable contains information
11953 about the failure. The details are the same as for
11954 &$recipient_verify_failure$&.
11955
11956 .vitem &$sending_ip_address$&
11957 .vindex "&$sending_ip_address$&"
11958 This variable is set whenever an outgoing SMTP connection to another host has
11959 been set up. It contains the IP address of the local interface that is being
11960 used. This is useful if a host that has more than one IP address wants to take
11961 on different personalities depending on which one is being used. For incoming
11962 connections, see &$received_ip_address$&.
11963
11964 .vitem &$sending_port$&
11965 .vindex "&$sending_port$&"
11966 This variable is set whenever an outgoing SMTP connection to another host has
11967 been set up. It contains the local port that is being used. For incoming
11968 connections, see &$received_port$&.
11969
11970 .vitem &$smtp_active_hostname$&
11971 .vindex "&$smtp_active_hostname$&"
11972 During an incoming SMTP session, this variable contains the value of the active
11973 host name, as specified by the &%smtp_active_hostname%& option. The value of
11974 &$smtp_active_hostname$& is saved with any message that is received, so its
11975 value can be consulted during routing and delivery.
11976
11977 .vitem &$smtp_command$&
11978 .vindex "&$smtp_command$&"
11979 During the processing of an incoming SMTP command, this variable contains the
11980 entire command. This makes it possible to distinguish between HELO and EHLO in
11981 the HELO ACL, and also to distinguish between commands such as these:
11982 .code
11983 MAIL FROM:<>
11984 MAIL FROM: <>
11985 .endd
11986 For a MAIL command, extra parameters such as SIZE can be inspected. For a RCPT
11987 command, the address in &$smtp_command$& is the original address before any
11988 rewriting, whereas the values in &$local_part$& and &$domain$& are taken from
11989 the address after SMTP-time rewriting.
11990
11991 .vitem &$smtp_command_argument$&
11992 .cindex "SMTP" "command, argument for"
11993 .vindex "&$smtp_command_argument$&"
11994 While an ACL is running to check an SMTP command, this variable contains the
11995 argument, that is, the text that follows the command name, with leading white
11996 space removed. Following the introduction of &$smtp_command$&, this variable is
11997 somewhat redundant, but is retained for backwards compatibility.
11998
11999 .vitem &$smtp_count_at_connection_start$&
12000 .vindex "&$smtp_count_at_connection_start$&"
12001 This variable is set greater than zero only in processes spawned by the Exim
12002 daemon for handling incoming SMTP connections. The name is deliberately long,
12003 in order to emphasize what the contents are. When the daemon accepts a new
12004 connection, it increments this variable. A copy of the variable is passed to
12005 the child process that handles the connection, but its value is fixed, and
12006 never changes. It is only an approximation of how many incoming connections
12007 there actually are, because many other connections may come and go while a
12008 single connection is being processed. When a child process terminates, the
12009 daemon decrements its copy of the variable.
12010
12011 .vitem "&$sn0$& &-- &$sn9$&"
12012 These variables are copies of the values of the &$n0$& &-- &$n9$& accumulators
12013 that were current at the end of the system filter file. This allows a system
12014 filter file to set values that can be tested in users' filter files. For
12015 example, a system filter could set a value indicating how likely it is that a
12016 message is junk mail.
12017
12018 .vitem &$spam_$&&'xxx'&
12019 A number of variables whose names start with &$spam$& are available when Exim
12020 is compiled with the content-scanning extension. For details, see section
12021 &<<SECTscanspamass>>&.
12022
12023
12024 .vitem &$spool_directory$&
12025 .vindex "&$spool_directory$&"
12026 The name of Exim's spool directory.
12027
12028 .vitem &$spool_inodes$&
12029 .vindex "&$spool_inodes$&"
12030 The number of free inodes in the disk partition where Exim's spool files are
12031 being written. The value is recalculated whenever the variable is referenced.
12032 If the relevant file system does not have the concept of inodes, the value of
12033 is -1. See also the &%check_spool_inodes%& option.
12034
12035 .vitem &$spool_space$&
12036 .vindex "&$spool_space$&"
12037 The amount of free space (as a number of kilobytes) in the disk partition where
12038 Exim's spool files are being written. The value is recalculated whenever the
12039 variable is referenced. If the operating system does not have the ability to
12040 find the amount of free space (only true for experimental systems), the space
12041 value is -1. For example, to check in an ACL that there is at least 50
12042 megabytes free on the spool, you could write:
12043 .code
12044 condition = ${if > {$spool_space}{50000}}
12045 .endd
12046 See also the &%check_spool_space%& option.
12047
12048
12049 .vitem &$thisaddress$&
12050 .vindex "&$thisaddress$&"
12051 This variable is set only during the processing of the &%foranyaddress%&
12052 command in a filter file. Its use is explained in the description of that
12053 command, which can be found in the separate document entitled &'Exim's
12054 interfaces to mail filtering'&.
12055
12056 .vitem &$tls_in_bits$&
12057 .vindex "&$tls_in_bits$&"
12058 Contains an approximation of the TLS cipher's bit-strength
12059 on the inbound connection; the meaning of
12060 this depends upon the TLS implementation used.
12061 If TLS has not been negotiated, the value will be 0.
12062 The value of this is automatically fed into the Cyrus SASL authenticator
12063 when acting as a server, to specify the "external SSF" (a SASL term).
12064
12065 The deprecated &$tls_bits$& variable refers to the inbound side
12066 except when used in the context of an outbound SMTP delivery, when it refers to
12067 the outbound.
12068
12069 .vitem &$tls_out_bits$&
12070 .vindex "&$tls_out_bits$&"
12071 Contains an approximation of the TLS cipher's bit-strength
12072 on an outbound SMTP connection; the meaning of
12073 this depends upon the TLS implementation used.
12074 If TLS has not been negotiated, the value will be 0.
12075
12076 .vitem &$tls_in_certificate_verified$&
12077 .vindex "&$tls_in_certificate_verified$&"
12078 This variable is set to &"1"& if a TLS certificate was verified when the
12079 message was received, and &"0"& otherwise.
12080
12081 The deprecated &$tls_certificate_verfied$& variable refers to the inbound side
12082 except when used in the context of an outbound SMTP delivery, when it refers to
12083 the outbound.
12084
12085 .vitem &$tls_out_certificate_verified$&
12086 .vindex "&$tls_out_certificate_verified$&"
12087 This variable is set to &"1"& if a TLS certificate was verified when an
12088 outbound SMTP connection was made,
12089 and &"0"& otherwise.
12090
12091 .vitem &$tls_in_cipher$&
12092 .vindex "&$tls_in_cipher$&"
12093 .vindex "&$tls_cipher$&"
12094 When a message is received from a remote host over an encrypted SMTP
12095 connection, this variable is set to the cipher suite that was negotiated, for
12096 example DES-CBC3-SHA. In other circumstances, in particular, for message
12097 received over unencrypted connections, the variable is empty. Testing
12098 &$tls_cipher$& for emptiness is one way of distinguishing between encrypted and
12099 non-encrypted connections during ACL processing.
12100
12101 The deprecated &$tls_cipher$& variable is the same as &$tls_in_cipher$& during message reception,
12102 but in the context of an outward SMTP delivery taking place via the &(smtp)& transport
12103 becomes the same as &$tls_out_cipher$&.
12104
12105 .vitem &$tls_out_cipher$&
12106 .vindex "&$tls_out_cipher$&"
12107 This variable is
12108 cleared before any outgoing SMTP connection is made,
12109 and then set to the outgoing cipher suite if one is negotiated. See chapter
12110 &<<CHAPTLS>>& for details of TLS support and chapter &<<CHAPsmtptrans>>& for
12111 details of the &(smtp)& transport.
12112
12113 .vitem &$tls_in_peerdn$&
12114 .vindex "&$tls_in_peerdn$&"
12115 .vindex "&$tls_peerdn$&"
12116 When a message is received from a remote host over an encrypted SMTP
12117 connection, and Exim is configured to request a certificate from the client,
12118 the value of the Distinguished Name of the certificate is made available in the
12119 &$tls_in_peerdn$& during subsequent processing.
12120
12121 The deprecated &$tls_peerdn$& variable refers to the inbound side
12122 except when used in the context of an outbound SMTP delivery, when it refers to
12123 the outbound.
12124
12125 .vitem &$tls_out_peerdn$&
12126 .vindex "&$tls_out_peerdn$&"
12127 When a message is being delivered to a remote host over an encrypted SMTP
12128 connection, and Exim is configured to request a certificate from the server,
12129 the value of the Distinguished Name of the certificate is made available in the
12130 &$tls_out_peerdn$& during subsequent processing.
12131
12132 .vitem &$tls_in_sni$&
12133 .vindex "&$tls_in_sni$&"
12134 .vindex "&$tls_sni$&"
12135 .cindex "TLS" "Server Name Indication"
12136 When a TLS session is being established, if the client sends the Server
12137 Name Indication extension, the value will be placed in this variable.
12138 If the variable appears in &%tls_certificate%& then this option and
12139 some others, described in &<<SECTtlssni>>&,
12140 will be re-expanded early in the TLS session, to permit
12141 a different certificate to be presented (and optionally a different key to be
12142 used) to the client, based upon the value of the SNI extension.
12143
12144 The deprecated &$tls_sni$& variable refers to the inbound side
12145 except when used in the context of an outbound SMTP delivery, when it refers to
12146 the outbound.
12147
12148 .vitem &$tls_out_sni$&
12149 .vindex "&$tls_out_sni$&"
12150 .cindex "TLS" "Server Name Indication"
12151 During outbound
12152 SMTP deliveries, this variable reflects the value of the &%tls_sni%& option on
12153 the transport.
12154
12155 .vitem &$tod_bsdinbox$&
12156 .vindex "&$tod_bsdinbox$&"
12157 The time of day and the date, in the format required for BSD-style mailbox
12158 files, for example: Thu Oct 17 17:14:09 1995.
12159
12160 .vitem &$tod_epoch$&
12161 .vindex "&$tod_epoch$&"
12162 The time and date as a number of seconds since the start of the Unix epoch.
12163
12164 .vitem &$tod_epoch_l$&
12165 .vindex "&$tod_epoch_l$&"
12166 The time and date as a number of microseconds since the start of the Unix epoch.
12167
12168 .vitem &$tod_full$&
12169 .vindex "&$tod_full$&"
12170 A full version of the time and date, for example: Wed, 16 Oct 1995 09:51:40
12171 +0100. The timezone is always given as a numerical offset from UTC, with
12172 positive values used for timezones that are ahead (east) of UTC, and negative
12173 values for those that are behind (west).
12174
12175 .vitem &$tod_log$&
12176 .vindex "&$tod_log$&"
12177 The time and date in the format used for writing Exim's log files, for example:
12178 1995-10-12 15:32:29, but without a timezone.
12179
12180 .vitem &$tod_logfile$&
12181 .vindex "&$tod_logfile$&"
12182 This variable contains the date in the format yyyymmdd. This is the format that
12183 is used for datestamping log files when &%log_file_path%& contains the &`%D`&
12184 flag.
12185
12186 .vitem &$tod_zone$&
12187 .vindex "&$tod_zone$&"
12188 This variable contains the numerical value of the local timezone, for example:
12189 -0500.
12190
12191 .vitem &$tod_zulu$&
12192 .vindex "&$tod_zulu$&"
12193 This variable contains the UTC date and time in &"Zulu"& format, as specified
12194 by ISO 8601, for example: 20030221154023Z.
12195
12196 .vitem &$value$&
12197 .vindex "&$value$&"
12198 This variable contains the result of an expansion lookup, extraction operation,
12199 or external command, as described above. It is also used during a
12200 &*reduce*& expansion.
12201
12202 .vitem &$version_number$&
12203 .vindex "&$version_number$&"
12204 The version number of Exim.
12205
12206 .vitem &$warn_message_delay$&
12207 .vindex "&$warn_message_delay$&"
12208 This variable is set only during the creation of a message warning about a
12209 delivery delay. Details of its use are explained in section &<<SECTcustwarn>>&.
12210
12211 .vitem &$warn_message_recipients$&
12212 .vindex "&$warn_message_recipients$&"
12213 This variable is set only during the creation of a message warning about a
12214 delivery delay. Details of its use are explained in section &<<SECTcustwarn>>&.
12215 .endlist
12216 .ecindex IIDstrexp
12217
12218
12219
12220 . ////////////////////////////////////////////////////////////////////////////
12221 . ////////////////////////////////////////////////////////////////////////////
12222
12223 .chapter "Embedded Perl" "CHAPperl"
12224 .scindex IIDperl "Perl" "calling from Exim"
12225 Exim can be built to include an embedded Perl interpreter. When this is done,
12226 Perl subroutines can be called as part of the string expansion process. To make
12227 use of the Perl support, you need version 5.004 or later of Perl installed on
12228 your system. To include the embedded interpreter in the Exim binary, include
12229 the line
12230 .code
12231 EXIM_PERL = perl.o
12232 .endd
12233 in your &_Local/Makefile_& and then build Exim in the normal way.
12234
12235
12236 .section "Setting up so Perl can be used" "SECID85"
12237 .oindex "&%perl_startup%&"
12238 Access to Perl subroutines is via a global configuration option called
12239 &%perl_startup%& and an expansion string operator &%${perl ...}%&. If there is
12240 no &%perl_startup%& option in the Exim configuration file then no Perl
12241 interpreter is started and there is almost no overhead for Exim (since none of
12242 the Perl library will be paged in unless used). If there is a &%perl_startup%&
12243 option then the associated value is taken to be Perl code which is executed in
12244 a newly created Perl interpreter.
12245
12246 The value of &%perl_startup%& is not expanded in the Exim sense, so you do not
12247 need backslashes before any characters to escape special meanings. The option
12248 should usually be something like
12249 .code
12250 perl_startup = do '/etc/exim.pl'
12251 .endd
12252 where &_/etc/exim.pl_& is Perl code which defines any subroutines you want to
12253 use from Exim. Exim can be configured either to start up a Perl interpreter as
12254 soon as it is entered, or to wait until the first time it is needed. Starting
12255 the interpreter at the beginning ensures that it is done while Exim still has
12256 its setuid privilege, but can impose an unnecessary overhead if Perl is not in
12257 fact used in a particular run. Also, note that this does not mean that Exim is
12258 necessarily running as root when Perl is called at a later time. By default,
12259 the interpreter is started only when it is needed, but this can be changed in
12260 two ways:
12261
12262 .ilist
12263 .oindex "&%perl_at_start%&"
12264 Setting &%perl_at_start%& (a boolean option) in the configuration requests
12265 a startup when Exim is entered.
12266 .next
12267 The command line option &%-ps%& also requests a startup when Exim is entered,
12268 overriding the setting of &%perl_at_start%&.
12269 .endlist
12270
12271 There is also a command line option &%-pd%& (for delay) which suppresses the
12272 initial startup, even if &%perl_at_start%& is set.
12273
12274
12275 .section "Calling Perl subroutines" "SECID86"
12276 When the configuration file includes a &%perl_startup%& option you can make use
12277 of the string expansion item to call the Perl subroutines that are defined
12278 by the &%perl_startup%& code. The operator is used in any of the following
12279 forms:
12280 .code
12281 ${perl{foo}}
12282 ${perl{foo}{argument}}
12283 ${perl{foo}{argument1}{argument2} ... }
12284 .endd
12285 which calls the subroutine &%foo%& with the given arguments. A maximum of eight
12286 arguments may be passed. Passing more than this results in an expansion failure
12287 with an error message of the form
12288 .code
12289 Too many arguments passed to Perl subroutine "foo" (max is 8)
12290 .endd
12291 The return value of the Perl subroutine is evaluated in a scalar context before
12292 it is passed back to Exim to be inserted into the expanded string. If the
12293 return value is &'undef'&, the expansion is forced to fail in the same way as
12294 an explicit &"fail"& on an &%if%& or &%lookup%& item. If the subroutine aborts
12295 by obeying Perl's &%die%& function, the expansion fails with the error message
12296 that was passed to &%die%&.
12297
12298
12299 .section "Calling Exim functions from Perl" "SECID87"
12300 Within any Perl code called from Exim, the function &'Exim::expand_string()'&
12301 is available to call back into Exim's string expansion function. For example,
12302 the Perl code
12303 .code
12304 my $lp = Exim::expand_string('$local_part');
12305 .endd
12306 makes the current Exim &$local_part$& available in the Perl variable &$lp$&.
12307 Note those are single quotes and not double quotes to protect against
12308 &$local_part$& being interpolated as a Perl variable.
12309
12310 If the string expansion is forced to fail by a &"fail"& item, the result of
12311 &'Exim::expand_string()'& is &%undef%&. If there is a syntax error in the
12312 expansion string, the Perl call from the original expansion string fails with
12313 an appropriate error message, in the same way as if &%die%& were used.
12314
12315 .cindex "debugging" "from embedded Perl"
12316 .cindex "log" "writing from embedded Perl"
12317 Two other Exim functions are available for use from within Perl code.
12318 &'Exim::debug_write()'& writes a string to the standard error stream if Exim's
12319 debugging is enabled. If you want a newline at the end, you must supply it.
12320 &'Exim::log_write()'& writes a string to Exim's main log, adding a leading
12321 timestamp. In this case, you should not supply a terminating newline.
12322
12323
12324 .section "Use of standard output and error by Perl" "SECID88"
12325 .cindex "Perl" "standard output and error"
12326 You should not write to the standard error or output streams from within your
12327 Perl code, as it is not defined how these are set up. In versions of Exim
12328 before 4.50, it is possible for the standard output or error to refer to the
12329 SMTP connection during message reception via the daemon. Writing to this stream
12330 is certain to cause chaos. From Exim 4.50 onwards, the standard output and
12331 error streams are connected to &_/dev/null_& in the daemon. The chaos is
12332 avoided, but the output is lost.
12333
12334 .cindex "Perl" "use of &%warn%&"
12335 The Perl &%warn%& statement writes to the standard error stream by default.
12336 Calls to &%warn%& may be embedded in Perl modules that you use, but over which
12337 you have no control. When Exim starts up the Perl interpreter, it arranges for
12338 output from the &%warn%& statement to be written to the Exim main log. You can
12339 change this by including appropriate Perl magic somewhere in your Perl code.
12340 For example, to discard &%warn%& output completely, you need this:
12341 .code
12342 $SIG{__WARN__} = sub { };
12343 .endd
12344 Whenever a &%warn%& is obeyed, the anonymous subroutine is called. In this
12345 example, the code for the subroutine is empty, so it does nothing, but you can
12346 include any Perl code that you like. The text of the &%warn%& message is passed
12347 as the first subroutine argument.
12348 .ecindex IIDperl
12349
12350
12351 . ////////////////////////////////////////////////////////////////////////////
12352 . ////////////////////////////////////////////////////////////////////////////
12353
12354 .chapter "Starting the daemon and the use of network interfaces" &&&
12355          "CHAPinterfaces" &&&
12356          "Starting the daemon"
12357 .cindex "daemon" "starting"
12358 .cindex "interface" "listening"
12359 .cindex "network interface"
12360 .cindex "interface" "network"
12361 .cindex "IP address" "for listening"
12362 .cindex "daemon" "listening IP addresses"
12363 .cindex "TCP/IP" "setting listening interfaces"
12364 .cindex "TCP/IP" "setting listening ports"
12365 A host that is connected to a TCP/IP network may have one or more physical
12366 hardware network interfaces. Each of these interfaces may be configured as one
12367 or more &"logical"& interfaces, which are the entities that a program actually
12368 works with. Each of these logical interfaces is associated with an IP address.
12369 In addition, TCP/IP software supports &"loopback"& interfaces (127.0.0.1 in
12370 IPv4 and ::1 in IPv6), which do not use any physical hardware. Exim requires
12371 knowledge about the host's interfaces for use in three different circumstances:
12372
12373 .olist
12374 When a listening daemon is started, Exim needs to know which interfaces
12375 and ports to listen on.
12376 .next
12377 When Exim is routing an address, it needs to know which IP addresses
12378 are associated with local interfaces. This is required for the correct
12379 processing of MX lists by removing the local host and others with the
12380 same or higher priority values. Also, Exim needs to detect cases
12381 when an address is routed to an IP address that in fact belongs to the
12382 local host. Unless the &%self%& router option or the &%allow_localhost%&
12383 option of the smtp transport is set (as appropriate), this is treated
12384 as an error situation.
12385 .next
12386 When Exim connects to a remote host, it may need to know which interface to use
12387 for the outgoing connection.
12388 .endlist
12389
12390
12391 Exim's default behaviour is likely to be appropriate in the vast majority
12392 of cases. If your host has only one interface, and you want all its IP
12393 addresses to be treated in the same way, and you are using only the
12394 standard SMTP port, you should not need to take any special action. The
12395 rest of this chapter does not apply to you.
12396
12397 In a more complicated situation you may want to listen only on certain
12398 interfaces, or on different ports, and for this reason there are a number of
12399 options that can be used to influence Exim's behaviour. The rest of this
12400 chapter describes how they operate.
12401
12402 When a message is received over TCP/IP, the interface and port that were
12403 actually used are set in &$received_ip_address$& and &$received_port$&.
12404
12405
12406
12407 .section "Starting a listening daemon" "SECID89"
12408 When a listening daemon is started (by means of the &%-bd%& command line
12409 option), the interfaces and ports on which it listens are controlled by the
12410 following options:
12411
12412 .ilist
12413 &%daemon_smtp_ports%& contains a list of default ports. (For backward
12414 compatibility, this option can also be specified in the singular.)
12415 .next
12416 &%local_interfaces%& contains list of interface IP addresses on which to
12417 listen. Each item may optionally also specify a port.
12418 .endlist
12419
12420 The default list separator in both cases is a colon, but this can be changed as
12421 described in section &<<SECTlistconstruct>>&. When IPv6 addresses are involved,
12422 it is usually best to change the separator to avoid having to double all the
12423 colons. For example:
12424 .code
12425 local_interfaces = <; 127.0.0.1 ; \
12426                       192.168.23.65 ; \
12427                       ::1 ; \
12428                       3ffe:ffff:836f::fe86:a061
12429 .endd
12430 There are two different formats for specifying a port along with an IP address
12431 in &%local_interfaces%&:
12432
12433 .olist
12434 The port is added onto the address with a dot separator. For example, to listen
12435 on port 1234 on two different IP addresses:
12436 .code
12437 local_interfaces = <; 192.168.23.65.1234 ; \
12438                       3ffe:ffff:836f::fe86:a061.1234
12439 .endd
12440 .next
12441 The IP address is enclosed in square brackets, and the port is added
12442 with a colon separator, for example:
12443 .code
12444 local_interfaces = <; [192.168.23.65]:1234 ; \
12445                       [3ffe:ffff:836f::fe86:a061]:1234
12446 .endd
12447 .endlist
12448
12449 When a port is not specified, the value of &%daemon_smtp_ports%& is used. The
12450 default setting contains just one port:
12451 .code
12452 daemon_smtp_ports = smtp
12453 .endd
12454 If more than one port is listed, each interface that does not have its own port
12455 specified listens on all of them. Ports that are listed in
12456 &%daemon_smtp_ports%& can be identified either by name (defined in
12457 &_/etc/services_&) or by number. However, when ports are given with individual
12458 IP addresses in &%local_interfaces%&, only numbers (not names) can be used.
12459
12460
12461
12462 .section "Special IP listening addresses" "SECID90"
12463 The addresses 0.0.0.0 and ::0 are treated specially. They are interpreted
12464 as &"all IPv4 interfaces"& and &"all IPv6 interfaces"&, respectively. In each
12465 case, Exim tells the TCP/IP stack to &"listen on all IPv&'x'& interfaces"&
12466 instead of setting up separate listening sockets for each interface. The
12467 default value of &%local_interfaces%& is
12468 .code
12469 local_interfaces = 0.0.0.0
12470 .endd
12471 when Exim is built without IPv6 support; otherwise it is:
12472 .code
12473 local_interfaces = <; ::0 ; 0.0.0.0
12474 .endd
12475 Thus, by default, Exim listens on all available interfaces, on the SMTP port.
12476
12477
12478
12479 .section "Overriding local_interfaces and daemon_smtp_ports" "SECID91"
12480 The &%-oX%& command line option can be used to override the values of
12481 &%daemon_smtp_ports%& and/or &%local_interfaces%& for a particular daemon
12482 instance. Another way of doing this would be to use macros and the &%-D%&
12483 option. However, &%-oX%& can be used by any admin user, whereas modification of
12484 the runtime configuration by &%-D%& is allowed only when the caller is root or
12485 exim.
12486
12487 The value of &%-oX%& is a list of items. The default colon separator can be
12488 changed in the usual way if required. If there are any items that do not
12489 contain dots or colons (that is, are not IP addresses), the value of
12490 &%daemon_smtp_ports%& is replaced by the list of those items. If there are any
12491 items that do contain dots or colons, the value of &%local_interfaces%& is
12492 replaced by those items. Thus, for example,
12493 .code
12494 -oX 1225
12495 .endd
12496 overrides &%daemon_smtp_ports%&, but leaves &%local_interfaces%& unchanged,
12497 whereas
12498 .code
12499 -oX 192.168.34.5.1125
12500 .endd
12501 overrides &%local_interfaces%&, leaving &%daemon_smtp_ports%& unchanged.
12502 (However, since &%local_interfaces%& now contains no items without ports, the
12503 value of &%daemon_smtp_ports%& is no longer relevant in this example.)
12504
12505
12506
12507 .section "Support for the obsolete SSMTP (or SMTPS) protocol" "SECTsupobssmt"
12508 .cindex "ssmtp protocol"
12509 .cindex "smtps protocol"
12510 .cindex "SMTP" "ssmtp protocol"
12511 .cindex "SMTP" "smtps protocol"
12512 Exim supports the obsolete SSMTP protocol (also known as SMTPS) that was used
12513 before the STARTTLS command was standardized for SMTP. Some legacy clients
12514 still use this protocol. If the &%tls_on_connect_ports%& option is set to a
12515 list of port numbers, connections to those ports must use SSMTP. The most
12516 common use of this option is expected to be
12517 .code
12518 tls_on_connect_ports = 465
12519 .endd
12520 because 465 is the usual port number used by the legacy clients. There is also
12521 a command line option &%-tls-on-connect%&, which forces all ports to behave in
12522 this way when a daemon is started.
12523
12524 &*Warning*&: Setting &%tls_on_connect_ports%& does not of itself cause the
12525 daemon to listen on those ports. You must still specify them in
12526 &%daemon_smtp_ports%&, &%local_interfaces%&, or the &%-oX%& option. (This is
12527 because &%tls_on_connect_ports%& applies to &%inetd%& connections as well as to
12528 connections via the daemon.)
12529
12530
12531
12532
12533 .section "IPv6 address scopes" "SECID92"
12534 .cindex "IPv6" "address scopes"
12535 IPv6 addresses have &"scopes"&, and a host with multiple hardware interfaces
12536 can, in principle, have the same link-local IPv6 address on different
12537 interfaces. Thus, additional information is needed, over and above the IP
12538 address, to distinguish individual interfaces. A convention of using a
12539 percent sign followed by something (often the interface name) has been
12540 adopted in some cases, leading to addresses like this:
12541 .code
12542 fe80::202:b3ff:fe03:45c1%eth0
12543 .endd
12544 To accommodate this usage, a percent sign followed by an arbitrary string is
12545 allowed at the end of an IPv6 address. By default, Exim calls &[getaddrinfo()]&
12546 to convert a textual IPv6 address for actual use. This function recognizes the
12547 percent convention in operating systems that support it, and it processes the
12548 address appropriately. Unfortunately, some older libraries have problems with
12549 &[getaddrinfo()]&. If
12550 .code
12551 IPV6_USE_INET_PTON=yes
12552 .endd
12553 is set in &_Local/Makefile_& (or an OS-dependent Makefile) when Exim is built,
12554 Exim uses &'inet_pton()'& to convert a textual IPv6 address for actual use,
12555 instead of &[getaddrinfo()]&. (Before version 4.14, it always used this
12556 function.) Of course, this means that the additional functionality of
12557 &[getaddrinfo()]& &-- recognizing scoped addresses &-- is lost.
12558
12559 .section "Disabling IPv6" "SECID93"
12560 .cindex "IPv6" "disabling"
12561 Sometimes it happens that an Exim binary that was compiled with IPv6 support is
12562 run on a host whose kernel does not support IPv6. The binary will fall back to
12563 using IPv4, but it may waste resources looking up AAAA records, and trying to
12564 connect to IPv6 addresses, causing delays to mail delivery. If you set the
12565 .oindex "&%disable_ipv6%&"
12566 &%disable_ipv6%& option true, even if the Exim binary has IPv6 support, no IPv6
12567 activities take place. AAAA records are never looked up, and any IPv6 addresses
12568 that are listed in &%local_interfaces%&, data for the &(manualroute)& router,
12569 etc. are ignored. If IP literals are enabled, the &(ipliteral)& router declines
12570 to handle IPv6 literal addresses.
12571
12572 On the other hand, when IPv6 is in use, there may be times when you want to
12573 disable it for certain hosts or domains. You can use the &%dns_ipv4_lookup%&
12574 option to globally suppress the lookup of AAAA records for specified domains,
12575 and you can use the &%ignore_target_hosts%& generic router option to ignore
12576 IPv6 addresses in an individual router.
12577
12578
12579
12580 .section "Examples of starting a listening daemon" "SECID94"
12581 The default case in an IPv6 environment is
12582 .code
12583 daemon_smtp_ports = smtp
12584 local_interfaces = <; ::0 ; 0.0.0.0
12585 .endd
12586 This specifies listening on the smtp port on all IPv6 and IPv4 interfaces.
12587 Either one or two sockets may be used, depending on the characteristics of
12588 the TCP/IP stack. (This is complicated and messy; for more information,
12589 read the comments in the &_daemon.c_& source file.)
12590
12591 To specify listening on ports 25 and 26 on all interfaces:
12592 .code
12593 daemon_smtp_ports = 25 : 26
12594 .endd
12595 (leaving &%local_interfaces%& at the default setting) or, more explicitly:
12596 .code
12597 local_interfaces = <; ::0.25     ; ::0.26 \
12598                       0.0.0.0.25 ; 0.0.0.0.26
12599 .endd
12600 To listen on the default port on all IPv4 interfaces, and on port 26 on the
12601 IPv4 loopback address only:
12602 .code
12603 local_interfaces = 0.0.0.0 : 127.0.0.1.26
12604 .endd
12605 To specify listening on the default port on specific interfaces only:
12606 .code
12607 local_interfaces = 10.0.0.67 : 192.168.34.67
12608 .endd
12609 &*Warning*&: Such a setting excludes listening on the loopback interfaces.
12610
12611
12612
12613 .section "Recognizing the local host" "SECTreclocipadd"
12614 The &%local_interfaces%& option is also used when Exim needs to determine
12615 whether or not an IP address refers to the local host. That is, the IP
12616 addresses of all the interfaces on which a daemon is listening are always
12617 treated as local.
12618
12619 For this usage, port numbers in &%local_interfaces%& are ignored. If either of
12620 the items 0.0.0.0 or ::0 are encountered, Exim gets a complete list of
12621 available interfaces from the operating system, and extracts the relevant
12622 (that is, IPv4 or IPv6) addresses to use for checking.
12623
12624 Some systems set up large numbers of virtual interfaces in order to provide
12625 many virtual web servers. In this situation, you may want to listen for
12626 email on only a few of the available interfaces, but nevertheless treat all
12627 interfaces as local when routing. You can do this by setting
12628 &%extra_local_interfaces%& to a list of IP addresses, possibly including the
12629 &"all"& wildcard values. These addresses are recognized as local, but are not
12630 used for listening. Consider this example:
12631 .code
12632 local_interfaces = <; 127.0.0.1 ; ::1 ; \
12633                       192.168.53.235 ; \
12634                       3ffe:2101:12:1:a00:20ff:fe86:a061
12635
12636 extra_local_interfaces = <; ::0 ; 0.0.0.0
12637 .endd
12638 The daemon listens on the loopback interfaces and just one IPv4 and one IPv6
12639 address, but all available interface addresses are treated as local when
12640 Exim is routing.
12641
12642 In some environments the local host name may be in an MX list, but with an IP
12643 address that is not assigned to any local interface. In other cases it may be
12644 desirable to treat other host names as if they referred to the local host. Both
12645 these cases can be handled by setting the &%hosts_treat_as_local%& option.
12646 This contains host names rather than IP addresses. When a host is referenced
12647 during routing, either via an MX record or directly, it is treated as the local
12648 host if its name matches &%hosts_treat_as_local%&, or if any of its IP
12649 addresses match &%local_interfaces%& or &%extra_local_interfaces%&.
12650
12651
12652
12653 .section "Delivering to a remote host" "SECID95"
12654 Delivery to a remote host is handled by the smtp transport. By default, it
12655 allows the system's TCP/IP functions to choose which interface to use (if
12656 there is more than one) when connecting to a remote host. However, the
12657 &%interface%& option can be set to specify which interface is used. See the
12658 description of the smtp transport in chapter &<<CHAPsmtptrans>>& for more
12659 details.
12660
12661
12662
12663
12664 . ////////////////////////////////////////////////////////////////////////////
12665 . ////////////////////////////////////////////////////////////////////////////
12666
12667 .chapter "Main configuration" "CHAPmainconfig"
12668 .scindex IIDconfima "configuration file" "main section"
12669 .scindex IIDmaiconf "main configuration"
12670 The first part of the run time configuration file contains three types of item:
12671
12672 .ilist
12673 Macro definitions: These lines start with an upper case letter. See section
12674 &<<SECTmacrodefs>>& for details of macro processing.
12675 .next
12676 Named list definitions: These lines start with one of the words &"domainlist"&,
12677 &"hostlist"&, &"addresslist"&, or &"localpartlist"&. Their use is described in
12678 section &<<SECTnamedlists>>&.
12679 .next
12680 Main configuration settings: Each setting occupies one line of the file
12681 (with possible continuations). If any setting is preceded by the word
12682 &"hide"&, the &%-bP%& command line option displays its value to admin users
12683 only. See section &<<SECTcos>>& for a description of the syntax of these option
12684 settings.
12685 .endlist
12686
12687 This chapter specifies all the main configuration options, along with their
12688 types and default values. For ease of finding a particular option, they appear
12689 in alphabetical order in section &<<SECTalomo>>& below. However, because there
12690 are now so many options, they are first listed briefly in functional groups, as
12691 an aid to finding the name of the option you are looking for. Some options are
12692 listed in more than one group.
12693
12694 .section "Miscellaneous" "SECID96"
12695 .table2
12696 .row &%bi_command%&                  "to run for &%-bi%& command line option"
12697 .row &%disable_ipv6%&                "do no IPv6 processing"
12698 .row &%keep_malformed%&              "for broken files &-- should not happen"
12699 .row &%localhost_number%&            "for unique message ids in clusters"
12700 .row &%message_body_newlines%&       "retain newlines in &$message_body$&"
12701 .row &%message_body_visible%&        "how much to show in &$message_body$&"
12702 .row &%mua_wrapper%&                 "run in &""MUA wrapper""& mode"
12703 .row &%print_topbitchars%&           "top-bit characters are printing"
12704 .row &%timezone%&                    "force time zone"
12705 .endtable
12706
12707
12708 .section "Exim parameters" "SECID97"
12709 .table2
12710 .row &%exim_group%&                  "override compiled-in value"
12711 .row &%exim_path%&                   "override compiled-in value"
12712 .row &%exim_user%&                   "override compiled-in value"
12713 .row &%primary_hostname%&            "default from &[uname()]&"
12714 .row &%split_spool_directory%&       "use multiple directories"
12715 .row &%spool_directory%&             "override compiled-in value"
12716 .endtable
12717
12718
12719
12720 .section "Privilege controls" "SECID98"
12721 .table2
12722 .row &%admin_groups%&                "groups that are Exim admin users"
12723 .row &%deliver_drop_privilege%&      "drop root for delivery processes"
12724 .row &%local_from_check%&            "insert &'Sender:'& if necessary"
12725 .row &%local_from_prefix%&           "for testing &'From:'& for local sender"
12726 .row &%local_from_suffix%&           "for testing &'From:'& for local sender"
12727 .row &%local_sender_retain%&         "keep &'Sender:'& from untrusted user"
12728 .row &%never_users%&                 "do not run deliveries as these"
12729 .row &%prod_requires_admin%&         "forced delivery requires admin user"
12730 .row &%queue_list_requires_admin%&   "queue listing requires admin user"
12731 .row &%trusted_groups%&              "groups that are trusted"
12732 .row &%trusted_users%&               "users that are trusted"
12733 .endtable
12734
12735
12736
12737 .section "Logging" "SECID99"
12738 .table2
12739 .row &%hosts_connection_nolog%&      "exemption from connect logging"
12740 .row &%log_file_path%&               "override compiled-in value"
12741 .row &%log_selector%&                "set/unset optional logging"
12742 .row &%log_timezone%&                "add timezone to log lines"
12743 .row &%message_logs%&                "create per-message logs"
12744 .row &%preserve_message_logs%&       "after message completion"
12745 .row &%process_log_path%&            "for SIGUSR1 and &'exiwhat'&"
12746 .row &%syslog_duplication%&          "controls duplicate log lines on syslog"
12747 .row &%syslog_facility%&             "set syslog &""facility""& field"
12748 .row &%syslog_processname%&          "set syslog &""ident""& field"
12749 .row &%syslog_timestamp%&            "timestamp syslog lines"
12750 .row &%write_rejectlog%&             "control use of message log"
12751 .endtable
12752
12753
12754
12755 .section "Frozen messages" "SECID100"
12756 .table2
12757 .row &%auto_thaw%&                   "sets time for retrying frozen messages"
12758 .row &%freeze_tell%&                 "send message when freezing"
12759 .row &%move_frozen_messages%&        "to another directory"
12760 .row &%timeout_frozen_after%&        "keep frozen messages only so long"
12761 .endtable
12762
12763
12764
12765 .section "Data lookups" "SECID101"
12766 .table2
12767 .row &%ibase_servers%&               "InterBase servers"
12768 .row &%ldap_ca_cert_dir%&            "dir of CA certs to verify LDAP server's"
12769 .row &%ldap_ca_cert_file%&           "file of CA certs to verify LDAP server's"
12770 .row &%ldap_cert_file%&              "client cert file for LDAP"
12771 .row &%ldap_cert_key%&               "client key file for LDAP"
12772 .row &%ldap_cipher_suite%&           "TLS negotiation preference control"
12773 .row &%ldap_default_servers%&        "used if no server in query"
12774 .row &%ldap_require_cert%&           "action to take without LDAP server cert"
12775 .row &%ldap_start_tls%&              "require TLS within LDAP"
12776 .row &%ldap_version%&                "set protocol version"
12777 .row &%lookup_open_max%&             "lookup files held open"
12778 .row &%mysql_servers%&               "default MySQL servers"
12779 .row &%oracle_servers%&              "Oracle servers"
12780 .row &%pgsql_servers%&               "default PostgreSQL servers"
12781 .row &%sqlite_lock_timeout%&         "as it says"
12782 .endtable
12783
12784
12785
12786 .section "Message ids" "SECID102"
12787 .table2
12788 .row &%message_id_header_domain%&    "used to build &'Message-ID:'& header"
12789 .row &%message_id_header_text%&      "ditto"
12790 .endtable
12791
12792
12793
12794 .section "Embedded Perl Startup" "SECID103"
12795 .table2
12796 .row &%perl_at_start%&               "always start the interpreter"
12797 .row &%perl_startup%&                "code to obey when starting Perl"
12798 .endtable
12799
12800
12801
12802 .section "Daemon" "SECID104"
12803 .table2
12804 .row &%daemon_smtp_ports%&           "default ports"
12805 .row &%daemon_startup_retries%&      "number of times to retry"
12806 .row &%daemon_startup_sleep%&        "time to sleep between tries"
12807 .row &%extra_local_interfaces%&      "not necessarily listened on"
12808 .row &%local_interfaces%&            "on which to listen, with optional ports"
12809 .row &%pid_file_path%&               "override compiled-in value"
12810 .row &%queue_run_max%&               "maximum simultaneous queue runners"
12811 .endtable
12812
12813
12814
12815 .section "Resource control" "SECID105"
12816 .table2
12817 .row &%check_log_inodes%&            "before accepting a message"
12818 .row &%check_log_space%&             "before accepting a message"
12819 .row &%check_spool_inodes%&          "before accepting a message"
12820 .row &%check_spool_space%&           "before accepting a message"
12821 .row &%deliver_queue_load_max%&      "no queue deliveries if load high"
12822 .row &%queue_only_load%&             "queue incoming if load high"
12823 .row &%queue_only_load_latch%&       "don't re-evaluate load for each message"
12824 .row &%queue_run_max%&               "maximum simultaneous queue runners"
12825 .row &%remote_max_parallel%&         "parallel SMTP delivery per message"
12826 .row &%smtp_accept_max%&             "simultaneous incoming connections"
12827 .row &%smtp_accept_max_nonmail%&     "non-mail commands"
12828 .row &%smtp_accept_max_nonmail_hosts%& "hosts to which the limit applies"
12829 .row &%smtp_accept_max_per_connection%& "messages per connection"
12830 .row &%smtp_accept_max_per_host%&    "connections from one host"
12831 .row &%smtp_accept_queue%&           "queue mail if more connections"
12832 .row &%smtp_accept_queue_per_connection%& "queue if more messages per &&&
12833                                            connection"
12834 .row &%smtp_accept_reserve%&         "only reserve hosts if more connections"
12835 .row &%smtp_check_spool_space%&      "from SIZE on MAIL command"
12836 .row &%smtp_connect_backlog%&        "passed to TCP/IP stack"
12837 .row &%smtp_load_reserve%&           "SMTP from reserved hosts if load high"
12838 .row &%smtp_reserve_hosts%&          "these are the reserve hosts"
12839 .endtable
12840
12841
12842
12843 .section "Policy controls" "SECID106"
12844 .table2
12845 .row &%acl_not_smtp%&                "ACL for non-SMTP messages"
12846 .row &%acl_not_smtp_mime%&           "ACL for non-SMTP MIME parts"
12847 .row &%acl_not_smtp_start%&          "ACL for start of non-SMTP message"
12848 .row &%acl_smtp_auth%&               "ACL for AUTH"
12849 .row &%acl_smtp_connect%&            "ACL for connection"
12850 .row &%acl_smtp_data%&               "ACL for DATA"
12851 .row &%acl_smtp_dkim%&               "ACL for DKIM verification"
12852 .row &%acl_smtp_etrn%&               "ACL for ETRN"
12853 .row &%acl_smtp_expn%&               "ACL for EXPN"
12854 .row &%acl_smtp_helo%&               "ACL for EHLO or HELO"
12855 .row &%acl_smtp_mail%&               "ACL for MAIL"
12856 .row &%acl_smtp_mailauth%&           "ACL for AUTH on MAIL command"
12857 .row &%acl_smtp_mime%&               "ACL for MIME parts"
12858 .row &%acl_smtp_predata%&            "ACL for start of data"
12859 .row &%acl_smtp_quit%&               "ACL for QUIT"
12860 .row &%acl_smtp_rcpt%&               "ACL for RCPT"
12861 .row &%acl_smtp_starttls%&           "ACL for STARTTLS"
12862 .row &%acl_smtp_vrfy%&               "ACL for VRFY"
12863 .row &%av_scanner%&                  "specify virus scanner"
12864 .row &%check_rfc2047_length%&        "check length of RFC 2047 &""encoded &&&
12865                                       words""&"
12866 .row &%dns_csa_search_limit%&        "control CSA parent search depth"
12867 .row &%dns_csa_use_reverse%&         "en/disable CSA IP reverse search"
12868 .row &%header_maxsize%&              "total size of message header"
12869 .row &%header_line_maxsize%&         "individual header line limit"
12870 .row &%helo_accept_junk_hosts%&      "allow syntactic junk from these hosts"
12871 .row &%helo_allow_chars%&            "allow illegal chars in HELO names"
12872 .row &%helo_lookup_domains%&         "lookup hostname for these HELO names"
12873 .row &%helo_try_verify_hosts%&       "HELO soft-checked for these hosts"
12874 .row &%helo_verify_hosts%&           "HELO hard-checked for these hosts"
12875 .row &%host_lookup%&                 "host name looked up for these hosts"
12876 .row &%host_lookup_order%&           "order of DNS and local name lookups"
12877 .row &%host_reject_connection%&      "reject connection from these hosts"
12878 .row &%hosts_treat_as_local%&        "useful in some cluster configurations"
12879 .row &%local_scan_timeout%&          "timeout for &[local_scan()]&"
12880 .row &%message_size_limit%&          "for all messages"
12881 .row &%percent_hack_domains%&        "recognize %-hack for these domains"
12882 .row &%spamd_address%&               "set interface to SpamAssassin"
12883 .row &%strict_acl_vars%&             "object to unset ACL variables"
12884 .endtable
12885
12886
12887
12888 .section "Callout cache" "SECID107"
12889 .table2
12890 .row &%callout_domain_negative_expire%& "timeout for negative domain cache &&&
12891                                          item"
12892 .row &%callout_domain_positive_expire%& "timeout for positive domain cache &&&
12893                                          item"
12894 .row &%callout_negative_expire%&     "timeout for negative address cache item"
12895 .row &%callout_positive_expire%&     "timeout for positive address cache item"
12896 .row &%callout_random_local_part%&   "string to use for &""random""& testing"
12897 .endtable
12898
12899
12900
12901 .section "TLS" "SECID108"
12902 .table2
12903 .row &%gnutls_compat_mode%&          "use GnuTLS compatibility mode"
12904 .row &%gnutls_enable_pkcs11%&        "allow GnuTLS to autoload PKCS11 modules"
12905 .row &%openssl_options%&             "adjust OpenSSL compatibility options"
12906 .row &%tls_advertise_hosts%&         "advertise TLS to these hosts"
12907 .row &%tls_certificate%&             "location of server certificate"
12908 .row &%tls_crl%&                     "certificate revocation list"
12909 .row &%tls_dh_max_bits%&             "clamp D-H bit count suggestion"
12910 .row &%tls_dhparam%&                 "DH parameters for server"
12911 .row &%tls_on_connect_ports%&        "specify SSMTP (SMTPS) ports"
12912 .row &%tls_privatekey%&              "location of server private key"
12913 .row &%tls_remember_esmtp%&          "don't reset after starting TLS"
12914 .row &%tls_require_ciphers%&         "specify acceptable ciphers"
12915 .row &%tls_try_verify_hosts%&        "try to verify client certificate"
12916 .row &%tls_verify_certificates%&     "expected client certificates"
12917 .row &%tls_verify_hosts%&            "insist on client certificate verify"
12918 .endtable
12919
12920
12921
12922 .section "Local user handling" "SECID109"
12923 .table2
12924 .row &%finduser_retries%&            "useful in NIS environments"
12925 .row &%gecos_name%&                  "used when creating &'Sender:'&"
12926 .row &%gecos_pattern%&               "ditto"
12927 .row &%max_username_length%&         "for systems that truncate"
12928 .row &%unknown_login%&               "used when no login name found"
12929 .row &%unknown_username%&            "ditto"
12930 .row &%uucp_from_pattern%&           "for recognizing &""From ""& lines"
12931 .row &%uucp_from_sender%&            "ditto"
12932 .endtable
12933
12934
12935
12936 .section "All incoming messages (SMTP and non-SMTP)" "SECID110"
12937 .table2
12938 .row &%header_maxsize%&              "total size of message header"
12939 .row &%header_line_maxsize%&         "individual header line limit"
12940 .row &%message_size_limit%&          "applies to all messages"
12941 .row &%percent_hack_domains%&        "recognize %-hack for these domains"
12942 .row &%received_header_text%&        "expanded to make &'Received:'&"
12943 .row &%received_headers_max%&        "for mail loop detection"
12944 .row &%recipients_max%&              "limit per message"
12945 .row &%recipients_max_reject%&       "permanently reject excess recipients"
12946 .endtable
12947
12948
12949
12950
12951 .section "Non-SMTP incoming messages" "SECID111"
12952 .table2
12953 .row &%receive_timeout%&             "for non-SMTP messages"
12954 .endtable
12955
12956
12957
12958
12959
12960 .section "Incoming SMTP messages" "SECID112"
12961 See also the &'Policy controls'& section above.
12962
12963 .table2
12964 .row &%host_lookup%&                 "host name looked up for these hosts"
12965 .row &%host_lookup_order%&           "order of DNS and local name lookups"
12966 .row &%recipient_unqualified_hosts%& "may send unqualified recipients"
12967 .row &%rfc1413_hosts%&               "make ident calls to these hosts"
12968 .row &%rfc1413_query_timeout%&       "zero disables ident calls"
12969 .row &%sender_unqualified_hosts%&    "may send unqualified senders"
12970 .row &%smtp_accept_keepalive%&       "some TCP/IP magic"
12971 .row &%smtp_accept_max%&             "simultaneous incoming connections"
12972 .row &%smtp_accept_max_nonmail%&     "non-mail commands"
12973 .row &%smtp_accept_max_nonmail_hosts%& "hosts to which the limit applies"
12974 .row &%smtp_accept_max_per_connection%& "messages per connection"
12975 .row &%smtp_accept_max_per_host%&    "connections from one host"
12976 .row &%smtp_accept_queue%&           "queue mail if more connections"
12977 .row &%smtp_accept_queue_per_connection%& "queue if more messages per &&&
12978                                            connection"
12979 .row &%smtp_accept_reserve%&         "only reserve hosts if more connections"
12980 .row &%smtp_active_hostname%&        "host name to use in messages"
12981 .row &%smtp_banner%&                 "text for welcome banner"
12982 .row &%smtp_check_spool_space%&      "from SIZE on MAIL command"
12983 .row &%smtp_connect_backlog%&        "passed to TCP/IP stack"
12984 .row &%smtp_enforce_sync%&           "of SMTP command/responses"
12985 .row &%smtp_etrn_command%&           "what to run for ETRN"
12986 .row &%smtp_etrn_serialize%&         "only one at once"
12987 .row &%smtp_load_reserve%&           "only reserve hosts if this load"
12988 .row &%smtp_max_unknown_commands%&   "before dropping connection"
12989 .row &%smtp_ratelimit_hosts%&        "apply ratelimiting to these hosts"
12990 .row &%smtp_ratelimit_mail%&         "ratelimit for MAIL commands"
12991 .row &%smtp_ratelimit_rcpt%&         "ratelimit for RCPT commands"
12992 .row &%smtp_receive_timeout%&        "per command or data line"
12993 .row &%smtp_reserve_hosts%&          "these are the reserve hosts"
12994 .row &%smtp_return_error_details%&   "give detail on rejections"
12995 .endtable
12996
12997
12998
12999 .section "SMTP extensions" "SECID113"
13000 .table2
13001 .row &%accept_8bitmime%&             "advertise 8BITMIME"
13002 .row &%auth_advertise_hosts%&        "advertise AUTH to these hosts"
13003 .row &%ignore_fromline_hosts%&       "allow &""From ""& from these hosts"
13004 .row &%ignore_fromline_local%&       "allow &""From ""& from local SMTP"
13005 .row &%pipelining_advertise_hosts%&  "advertise pipelining to these hosts"
13006 .row &%tls_advertise_hosts%&         "advertise TLS to these hosts"
13007 .endtable
13008
13009
13010
13011 .section "Processing messages" "SECID114"
13012 .table2
13013 .row &%allow_domain_literals%&       "recognize domain literal syntax"
13014 .row &%allow_mx_to_ip%&              "allow MX to point to IP address"
13015 .row &%allow_utf8_domains%&          "in addresses"
13016 .row &%check_rfc2047_length%&        "check length of RFC 2047 &""encoded &&&
13017                                       words""&"
13018 .row &%delivery_date_remove%&        "from incoming messages"
13019 .row &%envelope_to_remove%&          "from incoming messages"
13020 .row &%extract_addresses_remove_arguments%& "affects &%-t%& processing"
13021 .row &%headers_charset%&             "default for translations"
13022 .row &%qualify_domain%&              "default for senders"
13023 .row &%qualify_recipient%&           "default for recipients"
13024 .row &%return_path_remove%&          "from incoming messages"
13025 .row &%strip_excess_angle_brackets%& "in addresses"
13026 .row &%strip_trailing_dot%&          "at end of addresses"
13027 .row &%untrusted_set_sender%&        "untrusted can set envelope sender"
13028 .endtable
13029
13030
13031
13032 .section "System filter" "SECID115"
13033 .table2
13034 .row &%system_filter%&               "locate system filter"
13035 .row &%system_filter_directory_transport%& "transport for delivery to a &&&
13036                                             directory"
13037 .row &%system_filter_file_transport%& "transport for delivery to a file"
13038 .row &%system_filter_group%&         "group for filter running"
13039 .row &%system_filter_pipe_transport%& "transport for delivery to a pipe"
13040 .row &%system_filter_reply_transport%& "transport for autoreply delivery"
13041 .row &%system_filter_user%&          "user for filter running"
13042 .endtable
13043
13044
13045
13046 .section "Routing and delivery" "SECID116"
13047 .table2
13048 .row &%disable_ipv6%&                "do no IPv6 processing"
13049 .row &%dns_again_means_nonexist%&    "for broken domains"
13050 .row &%dns_check_names_pattern%&     "pre-DNS syntax check"
13051 .row &%dns_ipv4_lookup%&             "only v4 lookup for these domains"
13052 .row &%dns_retrans%&                 "parameter for resolver"
13053 .row &%dns_retry%&                   "parameter for resolver"
13054 .row &%dns_use_dnssec%&              "parameter for resolver"
13055 .row &%dns_use_edns0%&               "parameter for resolver"
13056 .row &%hold_domains%&                "hold delivery for these domains"
13057 .row &%local_interfaces%&            "for routing checks"
13058 .row &%queue_domains%&               "no immediate delivery for these"
13059 .row &%queue_only%&                  "no immediate delivery at all"
13060 .row &%queue_only_file%&             "no immediate delivery if file exists"
13061 .row &%queue_only_load%&             "no immediate delivery if load is high"
13062 .row &%queue_only_load_latch%&       "don't re-evaluate load for each message"
13063 .row &%queue_only_override%&         "allow command line to override"
13064 .row &%queue_run_in_order%&          "order of arrival"
13065 .row &%queue_run_max%&               "of simultaneous queue runners"
13066 .row &%queue_smtp_domains%&          "no immediate SMTP delivery for these"
13067 .row &%remote_max_parallel%&         "parallel SMTP delivery per message"
13068 .row &%remote_sort_domains%&         "order of remote deliveries"
13069 .row &%retry_data_expire%&           "timeout for retry data"
13070 .row &%retry_interval_max%&          "safety net for retry rules"
13071 .endtable
13072
13073
13074
13075 .section "Bounce and warning messages" "SECID117"
13076 .table2
13077 .row &%bounce_message_file%&         "content of bounce"
13078 .row &%bounce_message_text%&         "content of bounce"
13079 .row &%bounce_return_body%&          "include body if returning message"
13080 .row &%bounce_return_message%&       "include original message in bounce"
13081 .row &%bounce_return_size_limit%&    "limit on returned message"
13082 .row &%bounce_sender_authentication%& "send authenticated sender with bounce"
13083 .row &%dsn_from%&                    "set &'From:'& contents in bounces"
13084 .row &%errors_copy%&                 "copy bounce messages"
13085 .row &%errors_reply_to%&             "&'Reply-to:'& in bounces"
13086 .row &%delay_warning%&               "time schedule"
13087 .row &%delay_warning_condition%&     "condition for warning messages"
13088 .row &%ignore_bounce_errors_after%&  "discard undeliverable bounces"
13089 .row &%smtp_return_error_details%&   "give detail on rejections"
13090 .row &%warn_message_file%&           "content of warning message"
13091 .endtable
13092
13093
13094
13095 .section "Alphabetical list of main options" "SECTalomo"
13096 Those options that undergo string expansion before use are marked with
13097 &dagger;.
13098
13099 .option accept_8bitmime main boolean true
13100 .cindex "8BITMIME"
13101 .cindex "8-bit characters"
13102 .cindex "log" "selectors"
13103 .cindex "log" "8BITMIME"
13104 This option causes Exim to send 8BITMIME in its response to an SMTP
13105 EHLO command, and to accept the BODY= parameter on MAIL commands.
13106 However, though Exim is 8-bit clean, it is not a protocol converter, and it
13107 takes no steps to do anything special with messages received by this route.
13108
13109 Historically Exim kept this option off by default, but the maintainers
13110 feel that in today's Internet, this causes more problems than it solves.
13111 It now defaults to true.
13112 A more detailed analysis of the issues is provided by Dan Bernstein:
13113 .display
13114 &url(http://cr.yp.to/smtp/8bitmime.html)
13115 .endd
13116
13117 To log received 8BITMIME status use
13118 .code
13119 log_selector = +8bitmime
13120 .endd
13121
13122 .option acl_not_smtp main string&!! unset
13123 .cindex "&ACL;" "for non-SMTP messages"
13124 .cindex "non-SMTP messages" "ACLs for"
13125 This option defines the ACL that is run when a non-SMTP message has been
13126 read and is on the point of being accepted. See chapter &<<CHAPACL>>& for
13127 further details.
13128
13129 .option acl_not_smtp_mime main string&!! unset
13130 This option defines the ACL that is run for individual MIME parts of non-SMTP
13131 messages. It operates in exactly the same way as &%acl_smtp_mime%& operates for
13132 SMTP messages.
13133
13134 .option acl_not_smtp_start main string&!! unset
13135 .cindex "&ACL;" "at start of non-SMTP message"
13136 .cindex "non-SMTP messages" "ACLs for"
13137 This option defines the ACL that is run before Exim starts reading a
13138 non-SMTP message. See chapter &<<CHAPACL>>& for further details.
13139
13140 .option acl_smtp_auth main string&!! unset
13141 .cindex "&ACL;" "setting up for SMTP commands"
13142 .cindex "AUTH" "ACL for"
13143 This option defines the ACL that is run when an SMTP AUTH command is
13144 received. See chapter &<<CHAPACL>>& for further details.
13145
13146 .option acl_smtp_connect main string&!! unset
13147 .cindex "&ACL;" "on SMTP connection"
13148 This option defines the ACL that is run when an SMTP connection is received.
13149 See chapter &<<CHAPACL>>& for further details.
13150
13151 .option acl_smtp_data main string&!! unset
13152 .cindex "DATA" "ACL for"
13153 This option defines the ACL that is run after an SMTP DATA command has been
13154 processed and the message itself has been received, but before the final
13155 acknowledgment is sent. See chapter &<<CHAPACL>>& for further details.
13156
13157 .option acl_smtp_etrn main string&!! unset
13158 .cindex "ETRN" "ACL for"
13159 This option defines the ACL that is run when an SMTP ETRN command is
13160 received. See chapter &<<CHAPACL>>& for further details.
13161
13162 .option acl_smtp_expn main string&!! unset
13163 .cindex "EXPN" "ACL for"
13164 This option defines the ACL that is run when an SMTP EXPN command is
13165 received. See chapter &<<CHAPACL>>& for further details.
13166
13167 .option acl_smtp_helo main string&!! unset
13168 .cindex "EHLO" "ACL for"
13169 .cindex "HELO" "ACL for"
13170 This option defines the ACL that is run when an SMTP EHLO or HELO
13171 command is received. See chapter &<<CHAPACL>>& for further details.
13172
13173
13174 .option acl_smtp_mail main string&!! unset
13175 .cindex "MAIL" "ACL for"
13176 This option defines the ACL that is run when an SMTP MAIL command is
13177 received. See chapter &<<CHAPACL>>& for further details.
13178
13179 .option acl_smtp_mailauth main string&!! unset
13180 .cindex "AUTH" "on MAIL command"
13181 This option defines the ACL that is run when there is an AUTH parameter on
13182 a MAIL command. See chapter &<<CHAPACL>>& for details of ACLs, and chapter
13183 &<<CHAPSMTPAUTH>>& for details of authentication.
13184
13185 .option acl_smtp_mime main string&!! unset
13186 .cindex "MIME content scanning" "ACL for"
13187 This option is available when Exim is built with the content-scanning
13188 extension. It defines the ACL that is run for each MIME part in a message. See
13189 section &<<SECTscanmimepart>>& for details.
13190
13191 .option acl_smtp_predata main string&!! unset
13192 This option defines the ACL that is run when an SMTP DATA command is
13193 received, before the message itself is received. See chapter &<<CHAPACL>>& for
13194 further details.
13195
13196 .option acl_smtp_quit main string&!! unset
13197 .cindex "QUIT, ACL for"
13198 This option defines the ACL that is run when an SMTP QUIT command is
13199 received. See chapter &<<CHAPACL>>& for further details.
13200
13201 .option acl_smtp_rcpt main string&!! unset
13202 .cindex "RCPT" "ACL for"
13203 This option defines the ACL that is run when an SMTP RCPT command is
13204 received. See chapter &<<CHAPACL>>& for further details.
13205
13206 .option acl_smtp_starttls main string&!! unset
13207 .cindex "STARTTLS, ACL for"
13208 This option defines the ACL that is run when an SMTP STARTTLS command is
13209 received. See chapter &<<CHAPACL>>& for further details.
13210
13211 .option acl_smtp_vrfy main string&!! unset
13212 .cindex "VRFY" "ACL for"
13213 This option defines the ACL that is run when an SMTP VRFY command is
13214 received. See chapter &<<CHAPACL>>& for further details.
13215
13216 .option admin_groups main "string list&!!" unset
13217 .cindex "admin user"
13218 This option is expanded just once, at the start of Exim's processing. If the
13219 current group or any of the supplementary groups of an Exim caller is in this
13220 colon-separated list, the caller has admin privileges. If all your system
13221 programmers are in a specific group, for example, you can give them all Exim
13222 admin privileges by putting that group in &%admin_groups%&. However, this does
13223 not permit them to read Exim's spool files (whose group owner is the Exim gid).
13224 To permit this, you have to add individuals to the Exim group.
13225
13226 .option allow_domain_literals main boolean false
13227 .cindex "domain literal"
13228 If this option is set, the RFC 2822 domain literal format is permitted in
13229 email addresses. The option is not set by default, because the domain literal
13230 format is not normally required these days, and few people know about it. It
13231 has, however, been exploited by mail abusers.
13232
13233 Unfortunately, it seems that some DNS black list maintainers are using this
13234 format to report black listing to postmasters. If you want to accept messages
13235 addressed to your hosts by IP address, you need to set
13236 &%allow_domain_literals%& true, and also to add &`@[]`& to the list of local
13237 domains (defined in the named domain list &%local_domains%& in the default
13238 configuration). This &"magic string"& matches the domain literal form of all
13239 the local host's IP addresses.
13240
13241
13242 .option allow_mx_to_ip main boolean false
13243 .cindex "MX record" "pointing to IP address"
13244 It appears that more and more DNS zone administrators are breaking the rules
13245 and putting domain names that look like IP addresses on the right hand side of
13246 MX records. Exim follows the rules and rejects this, giving an error message
13247 that explains the mis-configuration. However, some other MTAs support this
13248 practice, so to avoid &"Why can't Exim do this?"& complaints,
13249 &%allow_mx_to_ip%& exists, in order to enable this heinous activity. It is not
13250 recommended, except when you have no other choice.
13251
13252 .option allow_utf8_domains main boolean false
13253 .cindex "domain" "UTF-8 characters in"
13254 .cindex "UTF-8" "in domain name"
13255 Lots of discussion is going on about internationalized domain names. One
13256 camp is strongly in favour of just using UTF-8 characters, and it seems
13257 that at least two other MTAs permit this. This option allows Exim users to
13258 experiment if they wish.
13259
13260 If it is set true, Exim's domain parsing function allows valid
13261 UTF-8 multicharacters to appear in domain name components, in addition to
13262 letters, digits, and hyphens. However, just setting this option is not
13263 enough; if you want to look up these domain names in the DNS, you must also
13264 adjust the value of &%dns_check_names_pattern%& to match the extended form. A
13265 suitable setting is:
13266 .code
13267 dns_check_names_pattern = (?i)^(?>(?(1)\.|())[a-z0-9\xc0-\xff]\
13268   (?>[-a-z0-9\x80-\xff]*[a-z0-9\x80-\xbf])?)+$
13269 .endd
13270 Alternatively, you can just disable this feature by setting
13271 .code
13272 dns_check_names_pattern =
13273 .endd
13274 That is, set the option to an empty string so that no check is done.
13275
13276
13277 .option auth_advertise_hosts main "host list&!!" *
13278 .cindex "authentication" "advertising"
13279 .cindex "AUTH" "advertising"
13280 If any server authentication mechanisms are configured, Exim advertises them in
13281 response to an EHLO command only if the calling host matches this list.
13282 Otherwise, Exim does not advertise AUTH.
13283 Exim does not accept AUTH commands from clients to which it has not
13284 advertised the availability of AUTH. The advertising of individual
13285 authentication mechanisms can be controlled by the use of the
13286 &%server_advertise_condition%& generic authenticator option on the individual
13287 authenticators. See chapter &<<CHAPSMTPAUTH>>& for further details.
13288
13289 Certain mail clients (for example, Netscape) require the user to provide a name
13290 and password for authentication if AUTH is advertised, even though it may
13291 not be needed (the host may accept messages from hosts on its local LAN without
13292 authentication, for example). The &%auth_advertise_hosts%& option can be used
13293 to make these clients more friendly by excluding them from the set of hosts to
13294 which Exim advertises AUTH.
13295
13296 .cindex "AUTH" "advertising when encrypted"
13297 If you want to advertise the availability of AUTH only when the connection
13298 is encrypted using TLS, you can make use of the fact that the value of this
13299 option is expanded, with a setting like this:
13300 .code
13301 auth_advertise_hosts = ${if eq{$tls_in_cipher}{}{}{*}}
13302 .endd
13303 .vindex "&$tls_in_cipher$&"
13304 If &$tls_in_cipher$& is empty, the session is not encrypted, and the result of
13305 the expansion is empty, thus matching no hosts. Otherwise, the result of the
13306 expansion is *, which matches all hosts.
13307
13308
13309 .option auto_thaw main time 0s
13310 .cindex "thawing messages"
13311 .cindex "unfreezing messages"
13312 If this option is set to a time greater than zero, a queue runner will try a
13313 new delivery attempt on any frozen message, other than a bounce message, if
13314 this much time has passed since it was frozen. This may result in the message
13315 being re-frozen if nothing has changed since the last attempt. It is a way of
13316 saying &"keep on trying, even though there are big problems"&.
13317
13318 &*Note*&: This is an old option, which predates &%timeout_frozen_after%& and
13319 &%ignore_bounce_errors_after%&. It is retained for compatibility, but it is not
13320 thought to be very useful any more, and its use should probably be avoided.
13321
13322
13323 .option av_scanner main string "see below"
13324 This option is available if Exim is built with the content-scanning extension.
13325 It specifies which anti-virus scanner to use. The default value is:
13326 .code
13327 sophie:/var/run/sophie
13328 .endd
13329 If the value of &%av_scanner%& starts with a dollar character, it is expanded
13330 before use. See section &<<SECTscanvirus>>& for further details.
13331
13332
13333 .option bi_command main string unset
13334 .oindex "&%-bi%&"
13335 This option supplies the name of a command that is run when Exim is called with
13336 the &%-bi%& option (see chapter &<<CHAPcommandline>>&). The string value is
13337 just the command name, it is not a complete command line. If an argument is
13338 required, it must come from the &%-oA%& command line option.
13339
13340
13341 .option bounce_message_file main string unset
13342 .cindex "bounce message" "customizing"
13343 .cindex "customizing" "bounce message"
13344 This option defines a template file containing paragraphs of text to be used
13345 for constructing bounce messages.  Details of the file's contents are given in
13346 chapter &<<CHAPemsgcust>>&. See also &%warn_message_file%&.
13347
13348
13349 .option bounce_message_text main string unset
13350 When this option is set, its contents are included in the default bounce
13351 message immediately after &"This message was created automatically by mail
13352 delivery software."& It is not used if &%bounce_message_file%& is set.
13353
13354 .option bounce_return_body main boolean true
13355 .cindex "bounce message" "including body"
13356 This option controls whether the body of an incoming message is included in a
13357 bounce message when &%bounce_return_message%& is true. The default setting
13358 causes the entire message, both header and body, to be returned (subject to the
13359 value of &%bounce_return_size_limit%&). If this option is false, only the
13360 message header is included. In the case of a non-SMTP message containing an
13361 error that is detected during reception, only those header lines preceding the
13362 point at which the error was detected are returned.
13363 .cindex "bounce message" "including original"
13364
13365 .option bounce_return_message main boolean true
13366 If this option is set false, none of the original message is included in
13367 bounce messages generated by Exim. See also &%bounce_return_size_limit%& and
13368 &%bounce_return_body%&.
13369
13370
13371 .option bounce_return_size_limit main integer 100K
13372 .cindex "size" "of bounce, limit"
13373 .cindex "bounce message" "size limit"
13374 .cindex "limit" "bounce message size"
13375 This option sets a limit in bytes on the size of messages that are returned to
13376 senders as part of bounce messages when &%bounce_return_message%& is true. The
13377 limit should be less than the value of the global &%message_size_limit%& and of
13378 any &%message_size_limit%& settings on transports, to allow for the bounce text
13379 that Exim generates. If this option is set to zero there is no limit.
13380
13381 When the body of any message that is to be included in a bounce message is
13382 greater than the limit, it is truncated, and a comment pointing this out is
13383 added at the top. The actual cutoff may be greater than the value given, owing
13384 to the use of buffering for transferring the message in chunks (typically 8K in
13385 size). The idea is to save bandwidth on those undeliverable 15-megabyte
13386 messages.
13387
13388 .option bounce_sender_authentication main string unset
13389 .cindex "bounce message" "sender authentication"
13390 .cindex "authentication" "bounce message"
13391 .cindex "AUTH" "on bounce message"
13392 This option provides an authenticated sender address that is sent with any
13393 bounce messages generated by Exim that are sent over an authenticated SMTP
13394 connection. A typical setting might be:
13395 .code
13396 bounce_sender_authentication = mailer-daemon@my.domain.example
13397 .endd
13398 which would cause bounce messages to be sent using the SMTP command:
13399 .code
13400 MAIL FROM:<> AUTH=mailer-daemon@my.domain.example
13401 .endd
13402 The value of &%bounce_sender_authentication%& must always be a complete email
13403 address.
13404
13405 .option callout_domain_negative_expire main time 3h
13406 .cindex "caching" "callout timeouts"
13407 .cindex "callout" "caching timeouts"
13408 This option specifies the expiry time for negative callout cache data for a
13409 domain. See section &<<SECTcallver>>& for details of callout verification, and
13410 section &<<SECTcallvercache>>& for details of the caching.
13411
13412
13413 .option callout_domain_positive_expire main time 7d
13414 This option specifies the expiry time for positive callout cache data for a
13415 domain. See section &<<SECTcallver>>& for details of callout verification, and
13416 section &<<SECTcallvercache>>& for details of the caching.
13417
13418
13419 .option callout_negative_expire main time 2h
13420 This option specifies the expiry time for negative callout cache data for an
13421 address. See section &<<SECTcallver>>& for details of callout verification, and
13422 section &<<SECTcallvercache>>& for details of the caching.
13423
13424
13425 .option callout_positive_expire main time 24h
13426 This option specifies the expiry time for positive callout cache data for an
13427 address. See section &<<SECTcallver>>& for details of callout verification, and
13428 section &<<SECTcallvercache>>& for details of the caching.
13429
13430
13431 .option callout_random_local_part main string&!! "see below"
13432 This option defines the &"random"& local part that can be used as part of
13433 callout verification. The default value is
13434 .code
13435 $primary_hostname-$tod_epoch-testing
13436 .endd
13437 See section &<<CALLaddparcall>>& for details of how this value is used.
13438
13439
13440 .option check_log_inodes main integer 0
13441 See &%check_spool_space%& below.
13442
13443
13444 .option check_log_space main integer 0
13445 See &%check_spool_space%& below.
13446
13447 .oindex "&%check_rfc2047_length%&"
13448 .cindex "RFC 2047" "disabling length check"
13449 .option check_rfc2047_length main boolean true
13450 RFC 2047 defines a way of encoding non-ASCII characters in headers using a
13451 system of &"encoded words"&. The RFC specifies a maximum length for an encoded
13452 word; strings to be encoded that exceed this length are supposed to use
13453 multiple encoded words. By default, Exim does not recognize encoded words that
13454 exceed the maximum length. However, it seems that some software, in violation
13455 of the RFC, generates overlong encoded words. If &%check_rfc2047_length%& is
13456 set false, Exim recognizes encoded words of any length.
13457
13458
13459 .option check_spool_inodes main integer 0
13460 See &%check_spool_space%& below.
13461
13462
13463 .option check_spool_space main integer 0
13464 .cindex "checking disk space"
13465 .cindex "disk space, checking"
13466 .cindex "spool directory" "checking space"
13467 The four &%check_...%& options allow for checking of disk resources before a
13468 message is accepted.
13469
13470 .vindex "&$log_inodes$&"
13471 .vindex "&$log_space$&"
13472 .vindex "&$spool_inodes$&"
13473 .vindex "&$spool_space$&"
13474 When any of these options are set, they apply to all incoming messages. If you
13475 want to apply different checks to different kinds of message, you can do so by
13476 testing the variables &$log_inodes$&, &$log_space$&, &$spool_inodes$&, and
13477 &$spool_space$& in an ACL with appropriate additional conditions.
13478
13479
13480 &%check_spool_space%& and &%check_spool_inodes%& check the spool partition if
13481 either value is greater than zero, for example:
13482 .code
13483 check_spool_space = 10M
13484 check_spool_inodes = 100
13485 .endd
13486 The spool partition is the one that contains the directory defined by
13487 SPOOL_DIRECTORY in &_Local/Makefile_&. It is used for holding messages in
13488 transit.
13489
13490 &%check_log_space%& and &%check_log_inodes%&  check the partition in which log
13491 files are written if either is greater than zero. These should be set only if
13492 &%log_file_path%& and &%spool_directory%& refer to different partitions.
13493
13494 If there is less space or fewer inodes than requested, Exim refuses to accept
13495 incoming mail. In the case of SMTP input this is done by giving a 452 temporary
13496 error response to the MAIL command. If ESMTP is in use and there was a
13497 SIZE parameter on the MAIL command, its value is added to the
13498 &%check_spool_space%& value, and the check is performed even if
13499 &%check_spool_space%& is zero, unless &%no_smtp_check_spool_space%& is set.
13500
13501 The values for &%check_spool_space%& and &%check_log_space%& are held as a
13502 number of kilobytes. If a non-multiple of 1024 is specified, it is rounded up.
13503
13504 For non-SMTP input and for batched SMTP input, the test is done at start-up; on
13505 failure a message is written to stderr and Exim exits with a non-zero code, as
13506 it obviously cannot send an error message of any kind.
13507
13508 .option daemon_smtp_ports main string &`smtp`&
13509 .cindex "port" "for daemon"
13510 .cindex "TCP/IP" "setting listening ports"
13511 This option specifies one or more default SMTP ports on which the Exim daemon
13512 listens. See chapter &<<CHAPinterfaces>>& for details of how it is used. For
13513 backward compatibility, &%daemon_smtp_port%& (singular) is a synonym.
13514
13515 .option daemon_startup_retries main integer 9
13516 .cindex "daemon startup, retrying"
13517 This option, along with &%daemon_startup_sleep%&, controls the retrying done by
13518 the daemon at startup when it cannot immediately bind a listening socket
13519 (typically because the socket is already in use): &%daemon_startup_retries%&
13520 defines the number of retries after the first failure, and
13521 &%daemon_startup_sleep%& defines the length of time to wait between retries.
13522
13523 .option daemon_startup_sleep main time 30s
13524 See &%daemon_startup_retries%&.
13525
13526 .option delay_warning main "time list" 24h
13527 .cindex "warning of delay"
13528 .cindex "delay warning, specifying"
13529 When a message is delayed, Exim sends a warning message to the sender at
13530 intervals specified by this option. The data is a colon-separated list of times
13531 after which to send warning messages. If the value of the option is an empty
13532 string or a zero time, no warnings are sent. Up to 10 times may be given. If a
13533 message has been on the queue for longer than the last time, the last interval
13534 between the times is used to compute subsequent warning times. For example,
13535 with
13536 .code
13537 delay_warning = 4h:8h:24h
13538 .endd
13539 the first message is sent after 4 hours, the second after 8 hours, and
13540 the third one after 24 hours. After that, messages are sent every 16 hours,
13541 because that is the interval between the last two times on the list. If you set
13542 just one time, it specifies the repeat interval. For example, with:
13543 .code
13544 delay_warning = 6h
13545 .endd
13546 messages are repeated every six hours. To stop warnings after a given time, set
13547 a very large time at the end of the list. For example:
13548 .code
13549 delay_warning = 2h:12h:99d
13550 .endd
13551
13552 .option delay_warning_condition main string&!! "see below"
13553 .vindex "&$domain$&"
13554 The string is expanded at the time a warning message might be sent. If all the
13555 deferred addresses have the same domain, it is set in &$domain$& during the
13556 expansion. Otherwise &$domain$& is empty. If the result of the expansion is a
13557 forced failure, an empty string, or a string matching any of &"0"&, &"no"& or
13558 &"false"& (the comparison being done caselessly) then the warning message is
13559 not sent. The default is:
13560 .code
13561 delay_warning_condition = ${if or {\
13562   { !eq{$h_list-id:$h_list-post:$h_list-subscribe:}{} }\
13563   { match{$h_precedence:}{(?i)bulk|list|junk} }\
13564   { match{$h_auto-submitted:}{(?i)auto-generated|auto-replied} }\
13565   } {no}{yes}}
13566 .endd
13567 This suppresses the sending of warnings for messages that contain &'List-ID:'&,
13568 &'List-Post:'&, or &'List-Subscribe:'& headers, or have &"bulk"&, &"list"& or
13569 &"junk"& in a &'Precedence:'& header, or have &"auto-generated"& or
13570 &"auto-replied"& in an &'Auto-Submitted:'& header.
13571
13572 .option deliver_drop_privilege main boolean false
13573 .cindex "unprivileged delivery"
13574 .cindex "delivery" "unprivileged"
13575 If this option is set true, Exim drops its root privilege at the start of a
13576 delivery process, and runs as the Exim user throughout. This severely restricts
13577 the kinds of local delivery that are possible, but is viable in certain types
13578 of configuration. There is a discussion about the use of root privilege in
13579 chapter &<<CHAPsecurity>>&.
13580
13581 .option deliver_queue_load_max main fixed-point unset
13582 .cindex "load average"
13583 .cindex "queue runner" "abandoning"
13584 When this option is set, a queue run is abandoned if the system load average
13585 becomes greater than the value of the option. The option has no effect on
13586 ancient operating systems on which Exim cannot determine the load average.
13587 See also &%queue_only_load%& and &%smtp_load_reserve%&.
13588
13589
13590 .option delivery_date_remove main boolean true
13591 .cindex "&'Delivery-date:'& header line"
13592 Exim's transports have an option for adding a &'Delivery-date:'& header to a
13593 message when it is delivered, in exactly the same way as &'Return-path:'& is
13594 handled. &'Delivery-date:'& records the actual time of delivery. Such headers
13595 should not be present in incoming messages, and this option causes them to be
13596 removed at the time the message is received, to avoid any problems that might
13597 occur when a delivered message is subsequently sent on to some other recipient.
13598
13599 .option disable_fsync main boolean false
13600 .cindex "&[fsync()]&, disabling"
13601 This option is available only if Exim was built with the compile-time option
13602 ENABLE_DISABLE_FSYNC. When this is not set, a reference to &%disable_fsync%& in
13603 a runtime configuration generates an &"unknown option"& error. You should not
13604 build Exim with ENABLE_DISABLE_FSYNC or set &%disable_fsync%& unless you
13605 really, really, really understand what you are doing. &'No pre-compiled
13606 distributions of Exim should ever make this option available.'&
13607
13608 When &%disable_fsync%& is set true, Exim no longer calls &[fsync()]& to force
13609 updated files' data to be written to disc before continuing. Unexpected events
13610 such as crashes and power outages may cause data to be lost or scrambled.
13611 Here be Dragons. &*Beware.*&
13612
13613
13614 .option disable_ipv6 main boolean false
13615 .cindex "IPv6" "disabling"
13616 If this option is set true, even if the Exim binary has IPv6 support, no IPv6
13617 activities take place. AAAA records are never looked up, and any IPv6 addresses
13618 that are listed in &%local_interfaces%&, data for the &%manualroute%& router,
13619 etc. are ignored. If IP literals are enabled, the &(ipliteral)& router declines
13620 to handle IPv6 literal addresses.
13621
13622
13623 .option dns_again_means_nonexist main "domain list&!!" unset
13624 .cindex "DNS" "&""try again""& response; overriding"
13625 DNS lookups give a &"try again"& response for the DNS errors
13626 &"non-authoritative host not found"& and &"SERVERFAIL"&. This can cause Exim to
13627 keep trying to deliver a message, or to give repeated temporary errors to
13628 incoming mail. Sometimes the effect is caused by a badly set up name server and
13629 may persist for a long time. If a domain which exhibits this problem matches
13630 anything in &%dns_again_means_nonexist%&, it is treated as if it did not exist.
13631 This option should be used with care. You can make it apply to reverse lookups
13632 by a setting such as this:
13633 .code
13634 dns_again_means_nonexist = *.in-addr.arpa
13635 .endd
13636 This option applies to all DNS lookups that Exim does. It also applies when the
13637 &[gethostbyname()]& or &[getipnodebyname()]& functions give temporary errors,
13638 since these are most likely to be caused by DNS lookup problems. The
13639 &(dnslookup)& router has some options of its own for controlling what happens
13640 when lookups for MX or SRV records give temporary errors. These more specific
13641 options are applied after this global option.
13642
13643 .option dns_check_names_pattern main string "see below"
13644 .cindex "DNS" "pre-check of name syntax"
13645 When this option is set to a non-empty string, it causes Exim to check domain
13646 names for characters that are not allowed in host names before handing them to
13647 the DNS resolver, because some resolvers give temporary errors for names that
13648 contain unusual characters. If a domain name contains any unwanted characters,
13649 a &"not found"& result is forced, and the resolver is not called. The check is
13650 done by matching the domain name against a regular expression, which is the
13651 value of this option. The default pattern is
13652 .code
13653 dns_check_names_pattern = \
13654   (?i)^(?>(?(1)\.|())[^\W_](?>[a-z0-9/-]*[^\W_])?)+$
13655 .endd
13656 which permits only letters, digits, slashes, and hyphens in components, but
13657 they must start and end with a letter or digit. Slashes are not, in fact,
13658 permitted in host names, but they are found in certain NS records (which can be
13659 accessed in Exim by using a &%dnsdb%& lookup). If you set
13660 &%allow_utf8_domains%&, you must modify this pattern, or set the option to an
13661 empty string.
13662
13663 .option dns_csa_search_limit main integer 5
13664 This option controls the depth of parental searching for CSA SRV records in the
13665 DNS, as described in more detail in section &<<SECTverifyCSA>>&.
13666
13667 .option dns_csa_use_reverse main boolean true
13668 This option controls whether or not an IP address, given as a CSA domain, is
13669 reversed and looked up in the reverse DNS, as described in more detail in
13670 section &<<SECTverifyCSA>>&.
13671
13672 .option dns_ipv4_lookup main "domain list&!!" unset
13673 .cindex "IPv6" "DNS lookup for AAAA records"
13674 .cindex "DNS" "IPv6 lookup for AAAA records"
13675 When Exim is compiled with IPv6 support and &%disable_ipv6%& is not set, it
13676 looks for IPv6 address records (AAAA records) as well as IPv4 address records
13677 (A records) when trying to find IP addresses for hosts, unless the host's
13678 domain matches this list.
13679
13680 This is a fudge to help with name servers that give big delays or otherwise do
13681 not work for the AAAA record type. In due course, when the world's name
13682 servers have all been upgraded, there should be no need for this option.
13683
13684
13685 .option dns_retrans main time 0s
13686 .cindex "DNS" "resolver options"
13687 The options &%dns_retrans%& and &%dns_retry%& can be used to set the
13688 retransmission and retry parameters for DNS lookups. Values of zero (the
13689 defaults) leave the system default settings unchanged. The first value is the
13690 time between retries, and the second is the number of retries. It isn't
13691 totally clear exactly how these settings affect the total time a DNS lookup may
13692 take. I haven't found any documentation about timeouts on DNS lookups; these
13693 parameter values are available in the external resolver interface structure,
13694 but nowhere does it seem to describe how they are used or what you might want
13695 to set in them.
13696
13697
13698 .option dns_retry main integer 0
13699 See &%dns_retrans%& above.
13700
13701
13702 .new
13703 .option dns_use_dnssec main integer -1
13704 .cindex "DNS" "resolver options"
13705 .cindex "DNS" "DNSSEC"
13706 If this option is set to a non-negative number then Exim will initialise the
13707 DNS resolver library to either use or not use DNSSEC, overriding the system
13708 default. A value of 0 coerces DNSSEC off, a value of 1 coerces DNSSEC on.
13709
13710 If the resolver library does not support DNSSEC then this option has no effect.
13711 .wen
13712
13713
13714 .option dns_use_edns0 main integer -1
13715 .cindex "DNS" "resolver options"
13716 .cindex "DNS" "EDNS0"
13717 If this option is set to a non-negative number then Exim will initialise the
13718 DNS resolver library to either use or not use EDNS0 extensions, overriding
13719 the system default. A value of 0 coerces EDNS0 off, a value of 1 coerces EDNS0
13720 on.
13721
13722 If the resolver library does not support EDNS0 then this option has no effect.
13723
13724
13725 .option drop_cr main boolean false
13726 This is an obsolete option that is now a no-op. It used to affect the way Exim
13727 handled CR and LF characters in incoming messages. What happens now is
13728 described in section &<<SECTlineendings>>&.
13729
13730 .option dsn_from main "string&!!" "see below"
13731 .cindex "&'From:'& header line" "in bounces"
13732 .cindex "bounce messages" "&'From:'& line, specifying"
13733 This option can be used to vary the contents of &'From:'& header lines in
13734 bounces and other automatically generated messages (&"Delivery Status
13735 Notifications"& &-- hence the name of the option). The default setting is:
13736 .code
13737 dsn_from = Mail Delivery System <Mailer-Daemon@$qualify_domain>
13738 .endd
13739 The value is expanded every time it is needed. If the expansion fails, a
13740 panic is logged, and the default value is used.
13741
13742 .option envelope_to_remove main boolean true
13743 .cindex "&'Envelope-to:'& header line"
13744 Exim's transports have an option for adding an &'Envelope-to:'& header to a
13745 message when it is delivered, in exactly the same way as &'Return-path:'& is
13746 handled. &'Envelope-to:'& records the original recipient address from the
13747 messages's envelope that caused the delivery to happen. Such headers should not
13748 be present in incoming messages, and this option causes them to be removed at
13749 the time the message is received, to avoid any problems that might occur when a
13750 delivered message is subsequently sent on to some other recipient.
13751
13752
13753 .option errors_copy main "string list&!!" unset
13754 .cindex "bounce message" "copy to other address"
13755 .cindex "copy of bounce message"
13756 Setting this option causes Exim to send bcc copies of bounce messages that it
13757 generates to other addresses. &*Note*&: This does not apply to bounce messages
13758 coming from elsewhere. The value of the option is a colon-separated list of
13759 items. Each item consists of a pattern, terminated by white space, followed by
13760 a comma-separated list of email addresses. If a pattern contains spaces, it
13761 must be enclosed in double quotes.
13762
13763 Each pattern is processed in the same way as a single item in an address list
13764 (see section &<<SECTaddresslist>>&). When a pattern matches the recipient of
13765 the bounce message, the message is copied to the addresses on the list. The
13766 items are scanned in order, and once a matching one is found, no further items
13767 are examined. For example:
13768 .code
13769 errors_copy = spqr@mydomain   postmaster@mydomain.example :\
13770               rqps@mydomain   hostmaster@mydomain.example,\
13771                               postmaster@mydomain.example
13772 .endd
13773 .vindex "&$domain$&"
13774 .vindex "&$local_part$&"
13775 The address list is expanded before use. The expansion variables &$local_part$&
13776 and &$domain$& are set from the original recipient of the error message, and if
13777 there was any wildcard matching in the pattern, the expansion
13778 .cindex "numerical variables (&$1$& &$2$& etc)" "in &%errors_copy%&"
13779 variables &$0$&, &$1$&, etc. are set in the normal way.
13780
13781
13782 .option errors_reply_to main string unset
13783 .cindex "bounce message" "&'Reply-to:'& in"
13784 By default, Exim's bounce and delivery warning messages contain the header line
13785 .display
13786 &`From: Mail Delivery System <Mailer-Daemon@`&&'qualify-domain'&&`>`&
13787 .endd
13788 .oindex &%quota_warn_message%&
13789 where &'qualify-domain'& is the value of the &%qualify_domain%& option.
13790 A warning message that is generated by the &%quota_warn_message%& option in an
13791 &(appendfile)& transport may contain its own &'From:'& header line that
13792 overrides the default.
13793
13794 Experience shows that people reply to bounce messages. If the
13795 &%errors_reply_to%& option is set, a &'Reply-To:'& header is added to bounce
13796 and warning messages. For example:
13797 .code
13798 errors_reply_to = postmaster@my.domain.example
13799 .endd
13800 The value of the option is not expanded. It must specify a valid RFC 2822
13801 address. However, if a warning message that is generated by the
13802 &%quota_warn_message%& option in an &(appendfile)& transport contain its
13803 own &'Reply-To:'& header line, the value of the &%errors_reply_to%& option is
13804 not used.
13805
13806
13807 .option exim_group main string "compile-time configured"
13808 .cindex "gid (group id)" "Exim's own"
13809 .cindex "Exim group"
13810 This option changes the gid under which Exim runs when it gives up root
13811 privilege. The default value is compiled into the binary. The value of this
13812 option is used only when &%exim_user%& is also set. Unless it consists entirely
13813 of digits, the string is looked up using &[getgrnam()]&, and failure causes a
13814 configuration error. See chapter &<<CHAPsecurity>>& for a discussion of
13815 security issues.
13816
13817
13818 .option exim_path main string "see below"
13819 .cindex "Exim binary, path name"
13820 This option specifies the path name of the Exim binary, which is used when Exim
13821 needs to re-exec itself. The default is set up to point to the file &'exim'& in
13822 the directory configured at compile time by the BIN_DIRECTORY setting. It
13823 is necessary to change &%exim_path%& if, exceptionally, Exim is run from some
13824 other place.
13825 &*Warning*&: Do not use a macro to define the value of this option, because
13826 you will break those Exim utilities that scan the configuration file to find
13827 where the binary is. (They then use the &%-bP%& option to extract option
13828 settings such as the value of &%spool_directory%&.)
13829
13830
13831 .option exim_user main string "compile-time configured"
13832 .cindex "uid (user id)" "Exim's own"
13833 .cindex "Exim user"
13834 This option changes the uid under which Exim runs when it gives up root
13835 privilege. The default value is compiled into the binary. Ownership of the run
13836 time configuration file and the use of the &%-C%& and &%-D%& command line
13837 options is checked against the values in the binary, not what is set here.
13838
13839 Unless it consists entirely of digits, the string is looked up using
13840 &[getpwnam()]&, and failure causes a configuration error. If &%exim_group%& is
13841 not also supplied, the gid is taken from the result of &[getpwnam()]& if it is
13842 used. See chapter &<<CHAPsecurity>>& for a discussion of security issues.
13843
13844
13845 .option extra_local_interfaces main "string list" unset
13846 This option defines network interfaces that are to be considered local when
13847 routing, but which are not used for listening by the daemon. See section
13848 &<<SECTreclocipadd>>& for details.
13849
13850
13851 . Allow this long option name to split; give it unsplit as a fifth argument
13852 . for the automatic .oindex that is generated by .option.
13853
13854 .option "extract_addresses_remove_ &~&~arguments" main boolean true &&&
13855          extract_addresses_remove_arguments
13856 .oindex "&%-t%&"
13857 .cindex "command line" "addresses with &%-t%&"
13858 .cindex "Sendmail compatibility" "&%-t%& option"
13859 According to some Sendmail documentation (Sun, IRIX, HP-UX), if any addresses
13860 are present on the command line when the &%-t%& option is used to build an
13861 envelope from a message's &'To:'&, &'Cc:'& and &'Bcc:'& headers, the command
13862 line addresses are removed from the recipients list. This is also how Smail
13863 behaves. However, other Sendmail documentation (the O'Reilly book) states that
13864 command line addresses are added to those obtained from the header lines. When
13865 &%extract_addresses_remove_arguments%& is true (the default), Exim subtracts
13866 argument headers. If it is set false, Exim adds rather than removes argument
13867 addresses.
13868
13869
13870 .option finduser_retries main integer 0
13871 .cindex "NIS, retrying user lookups"
13872 On systems running NIS or other schemes in which user and group information is
13873 distributed from a remote system, there can be times when &[getpwnam()]& and
13874 related functions fail, even when given valid data, because things time out.
13875 Unfortunately these failures cannot be distinguished from genuine &"not found"&
13876 errors. If &%finduser_retries%& is set greater than zero, Exim will try that
13877 many extra times to find a user or a group, waiting for one second between
13878 retries.
13879
13880 .cindex "&_/etc/passwd_&" "multiple reading of"
13881 You should not set this option greater than zero if your user information is in
13882 a traditional &_/etc/passwd_& file, because it will cause Exim needlessly to
13883 search the file multiple times for non-existent users, and also cause delay.
13884
13885
13886
13887 .option freeze_tell main "string list, comma separated" unset
13888 .cindex "freezing messages" "sending a message when freezing"
13889 On encountering certain errors, or when configured to do so in a system filter,
13890 ACL, or special router, Exim freezes a message. This means that no further
13891 delivery attempts take place until an administrator thaws the message, or the
13892 &%auto_thaw%&, &%ignore_bounce_errors_after%&, or &%timeout_frozen_after%&
13893 feature cause it to be processed. If &%freeze_tell%& is set, Exim generates a
13894 warning message whenever it freezes something, unless the message it is
13895 freezing is a locally-generated bounce message. (Without this exception there
13896 is the possibility of looping.) The warning message is sent to the addresses
13897 supplied as the comma-separated value of this option. If several of the
13898 message's addresses cause freezing, only a single message is sent. If the
13899 freezing was automatic, the reason(s) for freezing can be found in the message
13900 log. If you configure freezing in a filter or ACL, you must arrange for any
13901 logging that you require.
13902
13903
13904 .option gecos_name main string&!! unset
13905 .cindex "HP-UX"
13906 .cindex "&""gecos""& field, parsing"
13907 Some operating systems, notably HP-UX, use the &"gecos"& field in the system
13908 password file to hold other information in addition to users' real names. Exim
13909 looks up this field for use when it is creating &'Sender:'& or &'From:'&
13910 headers. If either &%gecos_pattern%& or &%gecos_name%& are unset, the contents
13911 of the field are used unchanged, except that, if an ampersand is encountered,
13912 it is replaced by the user's login name with the first character forced to
13913 upper case, since this is a convention that is observed on many systems.
13914
13915 When these options are set, &%gecos_pattern%& is treated as a regular
13916 expression that is to be applied to the field (again with && replaced by the
13917 login name), and if it matches, &%gecos_name%& is expanded and used as the
13918 user's name.
13919
13920 .cindex "numerical variables (&$1$& &$2$& etc)" "in &%gecos_name%&"
13921 Numeric variables such as &$1$&, &$2$&, etc. can be used in the expansion to
13922 pick up sub-fields that were matched by the pattern. In HP-UX, where the user's
13923 name terminates at the first comma, the following can be used:
13924 .code
13925 gecos_pattern = ([^,]*)
13926 gecos_name = $1
13927 .endd
13928
13929 .option gecos_pattern main string unset
13930 See &%gecos_name%& above.
13931
13932
13933 .option gnutls_compat_mode main boolean unset
13934 This option controls whether GnuTLS is used in compatibility mode in an Exim
13935 server. This reduces security slightly, but improves interworking with older
13936 implementations of TLS.
13937
13938
13939 .new
13940 option gnutls_enable_pkcs11 main boolean unset
13941 This option will let GnuTLS (2.12.0 or later) autoload PKCS11 modules with
13942 the p11-kit configuration files in &_/etc/pkcs11/modules/_&.
13943
13944 See
13945 &url(http://www.gnu.org/software/gnutls/manual/gnutls.html#Smart-cards-and-HSMs)
13946 for documentation.
13947 .wen
13948
13949
13950
13951 .option headers_charset main string "see below"
13952 This option sets a default character set for translating from encoded MIME
13953 &"words"& in header lines, when referenced by an &$h_xxx$& expansion item. The
13954 default is the value of HEADERS_CHARSET in &_Local/Makefile_&. The
13955 ultimate default is ISO-8859-1. For more details see the description of header
13956 insertions in section &<<SECTexpansionitems>>&.
13957
13958
13959
13960 .option header_maxsize main integer "see below"
13961 .cindex "header section" "maximum size of"
13962 .cindex "limit" "size of message header section"
13963 This option controls the overall maximum size of a message's header
13964 section. The default is the value of HEADER_MAXSIZE in
13965 &_Local/Makefile_&; the default for that is 1M. Messages with larger header
13966 sections are rejected.
13967
13968
13969 .option header_line_maxsize main integer 0
13970 .cindex "header lines" "maximum size of"
13971 .cindex "limit" "size of one header line"
13972 This option limits the length of any individual header line in a message, after
13973 all the continuations have been joined together. Messages with individual
13974 header lines that are longer than the limit are rejected. The default value of
13975 zero means &"no limit"&.
13976
13977
13978
13979
13980 .option helo_accept_junk_hosts main "host list&!!" unset
13981 .cindex "HELO" "accepting junk data"
13982 .cindex "EHLO" "accepting junk data"
13983 Exim checks the syntax of HELO and EHLO commands for incoming SMTP
13984 mail, and gives an error response for invalid data. Unfortunately, there are
13985 some SMTP clients that send syntactic junk. They can be accommodated by setting
13986 this option. Note that this is a syntax check only. See &%helo_verify_hosts%&
13987 if you want to do semantic checking.
13988 See also &%helo_allow_chars%& for a way of extending the permitted character
13989 set.
13990
13991
13992 .option helo_allow_chars main string unset
13993 .cindex "HELO" "underscores in"
13994 .cindex "EHLO" "underscores in"
13995 .cindex "underscore in EHLO/HELO"
13996 This option can be set to a string of rogue characters that are permitted in
13997 all EHLO and HELO names in addition to the standard letters, digits,
13998 hyphens, and dots. If you really must allow underscores, you can set
13999 .code
14000 helo_allow_chars = _
14001 .endd
14002 Note that the value is one string, not a list.
14003
14004
14005 .option helo_lookup_domains main "domain list&!!" &`@:@[]`&
14006 .cindex "HELO" "forcing reverse lookup"
14007 .cindex "EHLO" "forcing reverse lookup"
14008 If the domain given by a client in a HELO or EHLO command matches this
14009 list, a reverse lookup is done in order to establish the host's true name. The
14010 default forces a lookup if the client host gives the server's name or any of
14011 its IP addresses (in brackets), something that broken clients have been seen to
14012 do.
14013
14014
14015 .option helo_try_verify_hosts main "host list&!!" unset
14016 .cindex "HELO verifying" "optional"
14017 .cindex "EHLO" "verifying, optional"
14018 By default, Exim just checks the syntax of HELO and EHLO commands (see
14019 &%helo_accept_junk_hosts%& and &%helo_allow_chars%&). However, some sites like
14020 to do more extensive checking of the data supplied by these commands. The ACL
14021 condition &`verify = helo`& is provided to make this possible.
14022 Formerly, it was necessary also to set this option (&%helo_try_verify_hosts%&)
14023 to force the check to occur. From release 4.53 onwards, this is no longer
14024 necessary. If the check has not been done before &`verify = helo`& is
14025 encountered, it is done at that time. Consequently, this option is obsolete.
14026 Its specification is retained here for backwards compatibility.
14027
14028 When an EHLO or HELO command is received, if the calling host matches
14029 &%helo_try_verify_hosts%&, Exim checks that the host name given in the HELO or
14030 EHLO command either:
14031
14032 .ilist
14033 is an IP literal matching the calling address of the host, or
14034 .next
14035 .cindex "DNS" "reverse lookup"
14036 .cindex "reverse DNS lookup"
14037 matches the host name that Exim obtains by doing a reverse lookup of the
14038 calling host address, or
14039 .next
14040 when looked up using &[gethostbyname()]& (or &[getipnodebyname()]& when
14041 available) yields the calling host address.
14042 .endlist
14043
14044 However, the EHLO or HELO command is not rejected if any of the checks
14045 fail. Processing continues, but the result of the check is remembered, and can
14046 be detected later in an ACL by the &`verify = helo`& condition.
14047
14048 .option helo_verify_hosts main "host list&!!" unset
14049 .cindex "HELO verifying" "mandatory"
14050 .cindex "EHLO" "verifying, mandatory"
14051 Like &%helo_try_verify_hosts%&, this option is obsolete, and retained only for
14052 backwards compatibility. For hosts that match this option, Exim checks the host
14053 name given in the HELO or EHLO in the same way as for
14054 &%helo_try_verify_hosts%&. If the check fails, the HELO or EHLO command is
14055 rejected with a 550 error, and entries are written to the main and reject logs.
14056 If a MAIL command is received before EHLO or HELO, it is rejected with a 503
14057 error.
14058
14059 .option hold_domains main "domain list&!!" unset
14060 .cindex "domain" "delaying delivery"
14061 .cindex "delivery" "delaying certain domains"
14062 This option allows mail for particular domains to be held on the queue
14063 manually. The option is overridden if a message delivery is forced with the
14064 &%-M%&, &%-qf%&, &%-Rf%& or &%-Sf%& options, and also while testing or
14065 verifying addresses using &%-bt%& or &%-bv%&. Otherwise, if a domain matches an
14066 item in &%hold_domains%&, no routing or delivery for that address is done, and
14067 it is deferred every time the message is looked at.
14068
14069 This option is intended as a temporary operational measure for delaying the
14070 delivery of mail while some problem is being sorted out, or some new
14071 configuration tested. If you just want to delay the processing of some
14072 domains until a queue run occurs, you should use &%queue_domains%& or
14073 &%queue_smtp_domains%&, not &%hold_domains%&.
14074
14075 A setting of &%hold_domains%& does not override Exim's code for removing
14076 messages from the queue if they have been there longer than the longest retry
14077 time in any retry rule. If you want to hold messages for longer than the normal
14078 retry times, insert a dummy retry rule with a long retry time.
14079
14080
14081 .option host_lookup main "host list&!!" unset
14082 .cindex "host name" "lookup, forcing"
14083 Exim does not look up the name of a calling host from its IP address unless it
14084 is required to compare against some host list, or the host matches
14085 &%helo_try_verify_hosts%& or &%helo_verify_hosts%&, or the host matches this
14086 option (which normally contains IP addresses rather than host names). The
14087 default configuration file contains
14088 .code
14089 host_lookup = *
14090 .endd
14091 which causes a lookup to happen for all hosts. If the expense of these lookups
14092 is felt to be too great, the setting can be changed or removed.
14093
14094 After a successful reverse lookup, Exim does a forward lookup on the name it
14095 has obtained, to verify that it yields the IP address that it started with. If
14096 this check fails, Exim behaves as if the name lookup failed.
14097
14098 .vindex "&$host_lookup_failed$&"
14099 .vindex "&$sender_host_name$&"
14100 After any kind of failure, the host name (in &$sender_host_name$&) remains
14101 unset, and &$host_lookup_failed$& is set to the string &"1"&. See also
14102 &%dns_again_means_nonexist%&, &%helo_lookup_domains%&, and
14103 &`verify = reverse_host_lookup`& in ACLs.
14104
14105
14106 .option host_lookup_order main "string list" &`bydns:byaddr`&
14107 This option specifies the order of different lookup methods when Exim is trying
14108 to find a host name from an IP address. The default is to do a DNS lookup
14109 first, and then to try a local lookup (using &[gethostbyaddr()]& or equivalent)
14110 if that fails. You can change the order of these lookups, or omit one entirely,
14111 if you want.
14112
14113 &*Warning*&: The &"byaddr"& method does not always yield aliases when there are
14114 multiple PTR records in the DNS and the IP address is not listed in
14115 &_/etc/hosts_&. Different operating systems give different results in this
14116 case. That is why the default tries a DNS lookup first.
14117
14118
14119
14120 .option host_reject_connection main "host list&!!" unset
14121 .cindex "host" "rejecting connections from"
14122 If this option is set, incoming SMTP calls from the hosts listed are rejected
14123 as soon as the connection is made.
14124 This option is obsolete, and retained only for backward compatibility, because
14125 nowadays the ACL specified by &%acl_smtp_connect%& can also reject incoming
14126 connections immediately.
14127
14128 The ability to give an immediate rejection (either by this option or using an
14129 ACL) is provided for use in unusual cases. Many hosts will just try again,
14130 sometimes without much delay. Normally, it is better to use an ACL to reject
14131 incoming messages at a later stage, such as after RCPT commands. See
14132 chapter &<<CHAPACL>>&.
14133
14134
14135 .option hosts_connection_nolog main "host list&!!" unset
14136 .cindex "host" "not logging connections from"
14137 This option defines a list of hosts for which connection logging does not
14138 happen, even though the &%smtp_connection%& log selector is set. For example,
14139 you might want not to log SMTP connections from local processes, or from
14140 127.0.0.1, or from your local LAN. This option is consulted in the main loop of
14141 the daemon; you should therefore strive to restrict its value to a short inline
14142 list of IP addresses and networks. To disable logging SMTP connections from
14143 local processes, you must create a host list with an empty item. For example:
14144 .code
14145 hosts_connection_nolog = :
14146 .endd
14147 If the &%smtp_connection%& log selector is not set, this option has no effect.
14148
14149
14150
14151 .option hosts_treat_as_local main "domain list&!!" unset
14152 .cindex "local host" "domains treated as"
14153 .cindex "host" "treated as local"
14154 If this option is set, any host names that match the domain list are treated as
14155 if they were the local host when Exim is scanning host lists obtained from MX
14156 records
14157 or other sources. Note that the value of this option is a domain list, not a
14158 host list, because it is always used to check host names, not IP addresses.
14159
14160 This option also applies when Exim is matching the special items
14161 &`@mx_any`&, &`@mx_primary`&, and &`@mx_secondary`& in a domain list (see
14162 section &<<SECTdomainlist>>&), and when checking the &%hosts%& option in the
14163 &(smtp)& transport for the local host (see the &%allow_localhost%& option in
14164 that transport). See also &%local_interfaces%&, &%extra_local_interfaces%&, and
14165 chapter &<<CHAPinterfaces>>&, which contains a discussion about local network
14166 interfaces and recognizing the local host.
14167
14168
14169 .option ibase_servers main "string list" unset
14170 .cindex "InterBase" "server list"
14171 This option provides a list of InterBase servers and associated connection data,
14172 to be used in conjunction with &(ibase)& lookups (see section &<<SECID72>>&).
14173 The option is available only if Exim has been built with InterBase support.
14174
14175
14176
14177 .option ignore_bounce_errors_after main time 10w
14178 .cindex "bounce message" "discarding"
14179 .cindex "discarding bounce message"
14180 This option affects the processing of bounce messages that cannot be delivered,
14181 that is, those that suffer a permanent delivery failure. (Bounce messages that
14182 suffer temporary delivery failures are of course retried in the usual way.)
14183
14184 After a permanent delivery failure, bounce messages are frozen,
14185 because there is no sender to whom they can be returned. When a frozen bounce
14186 message has been on the queue for more than the given time, it is unfrozen at
14187 the next queue run, and a further delivery is attempted. If delivery fails
14188 again, the bounce message is discarded. This makes it possible to keep failed
14189 bounce messages around for a shorter time than the normal maximum retry time
14190 for frozen messages. For example,
14191 .code
14192 ignore_bounce_errors_after = 12h
14193 .endd
14194 retries failed bounce message deliveries after 12 hours, discarding any further
14195 failures. If the value of this option is set to a zero time period, bounce
14196 failures are discarded immediately. Setting a very long time (as in the default
14197 value) has the effect of disabling this option. For ways of automatically
14198 dealing with other kinds of frozen message, see &%auto_thaw%& and
14199 &%timeout_frozen_after%&.
14200
14201
14202 .option ignore_fromline_hosts main "host list&!!" unset
14203 .cindex "&""From""& line"
14204 .cindex "UUCP" "&""From""& line"
14205 Some broken SMTP clients insist on sending a UUCP-like &"From&~"& line before
14206 the headers of a message. By default this is treated as the start of the
14207 message's body, which means that any following headers are not recognized as
14208 such. Exim can be made to ignore it by setting &%ignore_fromline_hosts%& to
14209 match those hosts that insist on sending it. If the sender is actually a local
14210 process rather than a remote host, and is using &%-bs%& to inject the messages,
14211 &%ignore_fromline_local%& must be set to achieve this effect.
14212
14213
14214 .option ignore_fromline_local main boolean false
14215 See &%ignore_fromline_hosts%& above.
14216
14217
14218 .option keep_malformed main time 4d
14219 This option specifies the length of time to keep messages whose spool files
14220 have been corrupted in some way. This should, of course, never happen. At the
14221 next attempt to deliver such a message, it gets removed. The incident is
14222 logged.
14223
14224
14225 .option ldap_ca_cert_dir main string unset
14226 .cindex "LDAP", "TLS CA certificate directory"
14227 This option indicates which directory contains CA certificates for verifying
14228 a TLS certificate presented by an LDAP server.
14229 While Exim does not provide a default value, your SSL library may.
14230 Analogous to &%tls_verify_certificates%& but as a client-side option for LDAP
14231 and constrained to be a directory.
14232
14233
14234 .option ldap_ca_cert_file main string unset
14235 .cindex "LDAP", "TLS CA certificate file"
14236 This option indicates which file contains CA certificates for verifying
14237 a TLS certificate presented by an LDAP server.
14238 While Exim does not provide a default value, your SSL library may.
14239 Analogous to &%tls_verify_certificates%& but as a client-side option for LDAP
14240 and constrained to be a file.
14241
14242
14243 .option ldap_cert_file main string unset
14244 .cindex "LDAP" "TLS client certificate file"
14245 This option indicates which file contains an TLS client certificate which
14246 Exim should present to the LDAP server during TLS negotiation.
14247 Should be used together with &%ldap_cert_key%&.
14248
14249
14250 .option ldap_cert_key main string unset
14251 .cindex "LDAP" "TLS client key file"
14252 This option indicates which file contains the secret/private key to use
14253 to prove identity to the LDAP server during TLS negotiation.
14254 Should be used together with &%ldap_cert_file%&, which contains the
14255 identity to be proven.
14256
14257
14258 .option ldap_cipher_suite main string unset
14259 .cindex "LDAP" "TLS cipher suite"
14260 This controls the TLS cipher-suite negotiation during TLS negotiation with
14261 the LDAP server.  See &<<SECTreqciphssl>>& for more details of the format of
14262 cipher-suite options with OpenSSL (as used by LDAP client libraries).
14263
14264
14265 .option ldap_default_servers main "string list" unset
14266 .cindex "LDAP" "default servers"
14267 This option provides a list of LDAP servers which are tried in turn when an
14268 LDAP query does not contain a server. See section &<<SECTforldaque>>& for
14269 details of LDAP queries. This option is available only when Exim has been built
14270 with LDAP support.
14271
14272
14273 .option ldap_require_cert main string unset.
14274 .cindex "LDAP" "policy for LDAP server TLS cert presentation"
14275 This should be one of the values "hard", "demand", "allow", "try" or "never".
14276 A value other than one of these is interpreted as "never".
14277 See the entry "TLS_REQCERT" in your system man page for ldap.conf(5).
14278 Although Exim does not set a default, the LDAP library probably defaults
14279 to hard/demand.
14280
14281
14282 .option ldap_start_tls main boolean false
14283 .cindex "LDAP" "whether or not to negotiate TLS"
14284 If set, Exim will attempt to negotiate TLS with the LDAP server when
14285 connecting on a regular LDAP port.  This is the LDAP equivalent of SMTP's
14286 "STARTTLS".  This is distinct from using "ldaps", which is the LDAP form
14287 of SSL-on-connect.
14288 In the event of failure to negotiate TLS, the action taken is controlled
14289 by &%ldap_require_cert%&.
14290
14291
14292 .option ldap_version main integer unset
14293 .cindex "LDAP" "protocol version, forcing"
14294 This option can be used to force Exim to set a specific protocol version for
14295 LDAP. If it option is unset, it is shown by the &%-bP%& command line option as
14296 -1. When this is the case, the default is 3 if LDAP_VERSION3 is defined in
14297 the LDAP headers; otherwise it is 2. This option is available only when Exim
14298 has been built with LDAP support.
14299
14300
14301
14302 .option local_from_check main boolean true
14303 .cindex "&'Sender:'& header line" "disabling addition of"
14304 .cindex "&'From:'& header line" "disabling checking of"
14305 When a message is submitted locally (that is, not over a TCP/IP connection) by
14306 an untrusted user, Exim removes any existing &'Sender:'& header line, and
14307 checks that the &'From:'& header line matches the login of the calling user and
14308 the domain specified by &%qualify_domain%&.
14309
14310 &*Note*&: An unqualified address (no domain) in the &'From:'& header in a
14311 locally submitted message is automatically qualified by Exim, unless the
14312 &%-bnq%& command line option is used.
14313
14314 You can use &%local_from_prefix%& and &%local_from_suffix%& to permit affixes
14315 on the local part. If the &'From:'& header line does not match, Exim adds a
14316 &'Sender:'& header with an address constructed from the calling user's login
14317 and the default qualify domain.
14318
14319 If &%local_from_check%& is set false, the &'From:'& header check is disabled,
14320 and no &'Sender:'& header is ever added. If, in addition, you want to retain
14321 &'Sender:'& header lines supplied by untrusted users, you must also set
14322 &%local_sender_retain%& to be true.
14323
14324 .cindex "envelope sender"
14325 These options affect only the header lines in the message. The envelope sender
14326 is still forced to be the login id at the qualify domain unless
14327 &%untrusted_set_sender%& permits the user to supply an envelope sender.
14328
14329 For messages received over TCP/IP, an ACL can specify &"submission mode"& to
14330 request similar header line checking. See section &<<SECTthesenhea>>&, which
14331 has more details about &'Sender:'& processing.
14332
14333
14334
14335
14336 .option local_from_prefix main string unset
14337 When Exim checks the &'From:'& header line of locally submitted messages for
14338 matching the login id (see &%local_from_check%& above), it can be configured to
14339 ignore certain prefixes and suffixes in the local part of the address. This is
14340 done by setting &%local_from_prefix%& and/or &%local_from_suffix%& to
14341 appropriate lists, in the same form as the &%local_part_prefix%& and
14342 &%local_part_suffix%& router options (see chapter &<<CHAProutergeneric>>&). For
14343 example, if
14344 .code
14345 local_from_prefix = *-
14346 .endd
14347 is set, a &'From:'& line containing
14348 .code
14349 From: anything-user@your.domain.example
14350 .endd
14351 will not cause a &'Sender:'& header to be added if &'user@your.domain.example'&
14352 matches the actual sender address that is constructed from the login name and
14353 qualify domain.
14354
14355
14356 .option local_from_suffix main string unset
14357 See &%local_from_prefix%& above.
14358
14359
14360 .option local_interfaces main "string list" "see below"
14361 This option controls which network interfaces are used by the daemon for
14362 listening; they are also used to identify the local host when routing. Chapter
14363 &<<CHAPinterfaces>>& contains a full description of this option and the related
14364 options &%daemon_smtp_ports%&, &%extra_local_interfaces%&,
14365 &%hosts_treat_as_local%&, and &%tls_on_connect_ports%&. The default value for
14366 &%local_interfaces%& is
14367 .code
14368 local_interfaces = 0.0.0.0
14369 .endd
14370 when Exim is built without IPv6 support; otherwise it is
14371 .code
14372 local_interfaces = <; ::0 ; 0.0.0.0
14373 .endd
14374
14375 .option local_scan_timeout main time 5m
14376 .cindex "timeout" "for &[local_scan()]& function"
14377 .cindex "&[local_scan()]& function" "timeout"
14378 This timeout applies to the &[local_scan()]& function (see chapter
14379 &<<CHAPlocalscan>>&). Zero means &"no timeout"&. If the timeout is exceeded,
14380 the incoming message is rejected with a temporary error if it is an SMTP
14381 message. For a non-SMTP message, the message is dropped and Exim ends with a
14382 non-zero code. The incident is logged on the main and reject logs.
14383
14384
14385
14386 .option local_sender_retain main boolean false
14387 .cindex "&'Sender:'& header line" "retaining from local submission"
14388 When a message is submitted locally (that is, not over a TCP/IP connection) by
14389 an untrusted user, Exim removes any existing &'Sender:'& header line. If you
14390 do not want this to happen, you must set &%local_sender_retain%&, and you must
14391 also set &%local_from_check%& to be false (Exim will complain if you do not).
14392 See also the ACL modifier &`control = suppress_local_fixups`&. Section
14393 &<<SECTthesenhea>>& has more details about &'Sender:'& processing.
14394
14395
14396
14397
14398 .option localhost_number main string&!! unset
14399 .cindex "host" "locally unique number for"
14400 .cindex "message ids" "with multiple hosts"
14401 .vindex "&$localhost_number$&"
14402 Exim's message ids are normally unique only within the local host. If
14403 uniqueness among a set of hosts is required, each host must set a different
14404 value for the &%localhost_number%& option. The string is expanded immediately
14405 after reading the configuration file (so that a number can be computed from the
14406 host name, for example) and the result of the expansion must be a number in the
14407 range 0&--16 (or 0&--10 on operating systems with case-insensitive file
14408 systems). This is available in subsequent string expansions via the variable
14409 &$localhost_number$&. When &%localhost_number is set%&, the final two
14410 characters of the message id, instead of just being a fractional part of the
14411 time, are computed from the time and the local host number as described in
14412 section &<<SECTmessiden>>&.
14413
14414
14415
14416 .option log_file_path main "string list&!!" "set at compile time"
14417 .cindex "log" "file path for"
14418 This option sets the path which is used to determine the names of Exim's log
14419 files, or indicates that logging is to be to syslog, or both. It is expanded
14420 when Exim is entered, so it can, for example, contain a reference to the host
14421 name. If no specific path is set for the log files at compile or run time, they
14422 are written in a sub-directory called &_log_& in Exim's spool directory.
14423 Chapter &<<CHAPlog>>& contains further details about Exim's logging, and
14424 section &<<SECTwhelogwri>>& describes how the contents of &%log_file_path%& are
14425 used. If this string is fixed at your installation (contains no expansion
14426 variables) it is recommended that you do not set this option in the
14427 configuration file, but instead supply the path using LOG_FILE_PATH in
14428 &_Local/Makefile_& so that it is available to Exim for logging errors detected
14429 early on &-- in particular, failure to read the configuration file.
14430
14431
14432 .option log_selector main string unset
14433 .cindex "log" "selectors"
14434 This option can be used to reduce or increase the number of things that Exim
14435 writes to its log files. Its argument is made up of names preceded by plus or
14436 minus characters. For example:
14437 .code
14438 log_selector = +arguments -retry_defer
14439 .endd
14440 A list of possible names and what they control is given in the chapter on
14441 logging, in section &<<SECTlogselector>>&.
14442
14443
14444 .option log_timezone main boolean false
14445 .cindex "log" "timezone for entries"
14446 .vindex "&$tod_log$&"
14447 .vindex "&$tod_zone$&"
14448 By default, the timestamps on log lines are in local time without the
14449 timezone. This means that if your timezone changes twice a year, the timestamps
14450 in log lines are ambiguous for an hour when the clocks go back. One way of
14451 avoiding this problem is to set the timezone to UTC. An alternative is to set
14452 &%log_timezone%& true. This turns on the addition of the timezone offset to
14453 timestamps in log lines. Turning on this option can add quite a lot to the size
14454 of log files because each line is extended by 6 characters. Note that the
14455 &$tod_log$& variable contains the log timestamp without the zone, but there is
14456 another variable called &$tod_zone$& that contains just the timezone offset.
14457
14458
14459 .option lookup_open_max main integer 25
14460 .cindex "too many open files"
14461 .cindex "open files, too many"
14462 .cindex "file" "too many open"
14463 .cindex "lookup" "maximum open files"
14464 .cindex "limit" "open files for lookups"
14465 This option limits the number of simultaneously open files for single-key
14466 lookups that use regular files (that is, &(lsearch)&, &(dbm)&, and &(cdb)&).
14467 Exim normally keeps these files open during routing, because often the same
14468 file is required several times. If the limit is reached, Exim closes the least
14469 recently used file. Note that if you are using the &'ndbm'& library, it
14470 actually opens two files for each logical DBM database, though it still counts
14471 as one for the purposes of &%lookup_open_max%&. If you are getting &"too many
14472 open files"& errors with NDBM, you need to reduce the value of
14473 &%lookup_open_max%&.
14474
14475
14476 .option max_username_length main integer 0
14477 .cindex "length of login name"
14478 .cindex "user name" "maximum length"
14479 .cindex "limit" "user name length"
14480 Some operating systems are broken in that they truncate long arguments to
14481 &[getpwnam()]& to eight characters, instead of returning &"no such user"&. If
14482 this option is set greater than zero, any attempt to call &[getpwnam()]& with
14483 an argument that is longer behaves as if &[getpwnam()]& failed.
14484
14485
14486 .option message_body_newlines main bool false
14487 .cindex "message body" "newlines in variables"
14488 .cindex "newline" "in message body variables"
14489 .vindex "&$message_body$&"
14490 .vindex "&$message_body_end$&"
14491 By default, newlines in the message body are replaced by spaces when setting
14492 the &$message_body$& and &$message_body_end$& expansion variables. If this
14493 option is set true, this no longer happens.
14494
14495
14496 .option message_body_visible main integer 500
14497 .cindex "body of message" "visible size"
14498 .cindex "message body" "visible size"
14499 .vindex "&$message_body$&"
14500 .vindex "&$message_body_end$&"
14501 This option specifies how much of a message's body is to be included in the
14502 &$message_body$& and &$message_body_end$& expansion variables.
14503
14504
14505 .option message_id_header_domain main string&!! unset
14506 .cindex "&'Message-ID:'& header line"
14507 If this option is set, the string is expanded and used as the right hand side
14508 (domain) of the &'Message-ID:'& header that Exim creates if a
14509 locally-originated incoming message does not have one. &"Locally-originated"&
14510 means &"not received over TCP/IP."&
14511 Otherwise, the primary host name is used.
14512 Only letters, digits, dot and hyphen are accepted; any other characters are
14513 replaced by hyphens. If the expansion is forced to fail, or if the result is an
14514 empty string, the option is ignored.
14515
14516
14517 .option message_id_header_text main string&!! unset
14518 If this variable is set, the string is expanded and used to augment the text of
14519 the &'Message-id:'& header that Exim creates if a locally-originated incoming
14520 message does not have one. The text of this header is required by RFC 2822 to
14521 take the form of an address. By default, Exim uses its internal message id as
14522 the local part, and the primary host name as the domain. If this option is set,
14523 it is expanded, and provided the expansion is not forced to fail, and does not
14524 yield an empty string, the result is inserted into the header immediately
14525 before the @, separated from the internal message id by a dot. Any characters
14526 that are illegal in an address are automatically converted into hyphens. This
14527 means that variables such as &$tod_log$& can be used, because the spaces and
14528 colons will become hyphens.
14529
14530
14531 .option message_logs main boolean true
14532 .cindex "message logs" "disabling"
14533 .cindex "log" "message log; disabling"
14534 If this option is turned off, per-message log files are not created in the
14535 &_msglog_& spool sub-directory. This reduces the amount of disk I/O required by
14536 Exim, by reducing the number of files involved in handling a message from a
14537 minimum of four (header spool file, body spool file, delivery journal, and
14538 per-message log) to three. The other major I/O activity is Exim's main log,
14539 which is not affected by this option.
14540
14541
14542 .option message_size_limit main string&!! 50M
14543 .cindex "message" "size limit"
14544 .cindex "limit" "message size"
14545 .cindex "size" "of message, limit"
14546 This option limits the maximum size of message that Exim will process. The
14547 value is expanded for each incoming connection so, for example, it can be made
14548 to depend on the IP address of the remote host for messages arriving via
14549 TCP/IP. After expansion, the value must be a sequence of decimal digits,
14550 optionally followed by K or M.
14551
14552 &*Note*&: This limit cannot be made to depend on a message's sender or any
14553 other properties of an individual message, because it has to be advertised in
14554 the server's response to EHLO. String expansion failure causes a temporary
14555 error. A value of zero means no limit, but its use is not recommended. See also
14556 &%bounce_return_size_limit%&.
14557
14558 Incoming SMTP messages are failed with a 552 error if the limit is
14559 exceeded; locally-generated messages either get a stderr message or a delivery
14560 failure message to the sender, depending on the &%-oe%& setting. Rejection of
14561 an oversized message is logged in both the main and the reject logs. See also
14562 the generic transport option &%message_size_limit%&, which limits the size of
14563 message that an individual transport can process.
14564
14565 If you use a virus-scanner and set this option to to a value larger than the
14566 maximum size that your virus-scanner is configured to support, you may get
14567 failures triggered by large mails.  The right size to configure for the
14568 virus-scanner depends upon what data is passed and the options in use but it's
14569 probably safest to just set it to a little larger than this value.  Eg, with a
14570 default Exim message size of 50M and a default ClamAV StreamMaxLength of 10M,
14571 some problems may result.
14572
14573 A value of 0 will disable size limit checking; Exim will still advertise the
14574 SIZE extension in an EHLO response, but without a limit, so as to permit
14575 SMTP clients to still indicate the message size along with the MAIL verb.
14576
14577
14578 .option move_frozen_messages main boolean false
14579 .cindex "frozen messages" "moving"
14580 This option, which is available only if Exim has been built with the setting
14581 .code
14582 SUPPORT_MOVE_FROZEN_MESSAGES=yes
14583 .endd
14584 in &_Local/Makefile_&, causes frozen messages and their message logs to be
14585 moved from the &_input_& and &_msglog_& directories on the spool to &_Finput_&
14586 and &_Fmsglog_&, respectively. There is currently no support in Exim or the
14587 standard utilities for handling such moved messages, and they do not show up in
14588 lists generated by &%-bp%& or by the Exim monitor.
14589
14590
14591 .option mua_wrapper main boolean false
14592 Setting this option true causes Exim to run in a very restrictive mode in which
14593 it passes messages synchronously to a smart host. Chapter &<<CHAPnonqueueing>>&
14594 contains a full description of this facility.
14595
14596
14597
14598 .option mysql_servers main "string list" unset
14599 .cindex "MySQL" "server list"
14600 This option provides a list of MySQL servers and associated connection data, to
14601 be used in conjunction with &(mysql)& lookups (see section &<<SECID72>>&). The
14602 option is available only if Exim has been built with MySQL support.
14603
14604
14605 .option never_users main "string list&!!" unset
14606 This option is expanded just once, at the start of Exim's processing. Local
14607 message deliveries are normally run in processes that are setuid to the
14608 recipient, and remote deliveries are normally run under Exim's own uid and gid.
14609 It is usually desirable to prevent any deliveries from running as root, as a
14610 safety precaution.
14611
14612 When Exim is built, an option called FIXED_NEVER_USERS can be set to a
14613 list of users that must not be used for local deliveries. This list is fixed in
14614 the binary and cannot be overridden by the configuration file. By default, it
14615 contains just the single user name &"root"&. The &%never_users%& runtime option
14616 can be used to add more users to the fixed list.
14617
14618 If a message is to be delivered as one of the users on the fixed list or the
14619 &%never_users%& list, an error occurs, and delivery is deferred. A common
14620 example is
14621 .code
14622 never_users = root:daemon:bin
14623 .endd
14624 Including root is redundant if it is also on the fixed list, but it does no
14625 harm. This option overrides the &%pipe_as_creator%& option of the &(pipe)&
14626 transport driver.
14627
14628
14629 .option openssl_options main "string list" "+no_sslv2"
14630 .cindex "OpenSSL "compatibility options"
14631 This option allows an administrator to adjust the SSL options applied
14632 by OpenSSL to connections.  It is given as a space-separated list of items,
14633 each one to be +added or -subtracted from the current value.
14634
14635 This option is only available if Exim is built against OpenSSL.  The values
14636 available for this option vary according to the age of your OpenSSL install.
14637 The &"all"& value controls a subset of flags which are available, typically
14638 the bug workaround options.  The &'SSL_CTX_set_options'& man page will
14639 list the values known on your system and Exim should support all the
14640 &"bug workaround"& options and many of the &"modifying"& options.  The Exim
14641 names lose the leading &"SSL_OP_"& and are lower-cased.
14642
14643 Note that adjusting the options can have severe impact upon the security of
14644 SSL as used by Exim.  It is possible to disable safety checks and shoot
14645 yourself in the foot in various unpleasant ways.  This option should not be
14646 adjusted lightly.  An unrecognised item will be detected at startup, by
14647 invoking Exim with the &%-bV%& flag.
14648
14649 Historical note: prior to release 4.80, Exim defaulted this value to
14650 "+dont_insert_empty_fragments", which may still be needed for compatibility
14651 with some clients, but which lowers security by increasing exposure to
14652 some now infamous attacks.
14653
14654 An example:
14655 .code
14656 # Make both old MS and old Eudora happy:
14657 openssl_options = -all +microsoft_big_sslv3_buffer \
14658                        +dont_insert_empty_fragments
14659 .endd
14660
14661 Possible options may include:
14662 .ilist
14663 &`all`&
14664 .next
14665 &`allow_unsafe_legacy_renegotiation`&
14666 .next
14667 &`cipher_server_preference`&
14668 .next
14669 &`dont_insert_empty_fragments`&
14670 .next
14671 &`ephemeral_rsa`&
14672 .next
14673 &`legacy_server_connect`&
14674 .next
14675 &`microsoft_big_sslv3_buffer`&
14676 .next
14677 &`microsoft_sess_id_bug`&
14678 .next
14679 &`msie_sslv2_rsa_padding`&
14680 .next
14681 &`netscape_challenge_bug`&
14682 .next
14683 &`netscape_reuse_cipher_change_bug`&
14684 .next
14685 &`no_compression`&
14686 .next
14687 &`no_session_resumption_on_renegotiation`&
14688 .next
14689 &`no_sslv2`&
14690 .next
14691 &`no_sslv3`&
14692 .next
14693 &`no_ticket`&
14694 .next
14695 &`no_tlsv1`&
14696 .next
14697 &`no_tlsv1_1`&
14698 .next
14699 &`no_tlsv1_2`&
14700 .next
14701 &`single_dh_use`&
14702 .next
14703 &`single_ecdh_use`&
14704 .next
14705 &`ssleay_080_client_dh_bug`&
14706 .next
14707 &`sslref2_reuse_cert_type_bug`&
14708 .next
14709 &`tls_block_padding_bug`&
14710 .next
14711 &`tls_d5_bug`&
14712 .next
14713 &`tls_rollback_bug`&
14714 .endlist
14715
14716
14717 .option oracle_servers main "string list" unset
14718 .cindex "Oracle" "server list"
14719 This option provides a list of Oracle servers and associated connection data,
14720 to be used in conjunction with &(oracle)& lookups (see section &<<SECID72>>&).
14721 The option is available only if Exim has been built with Oracle support.
14722
14723
14724 .option percent_hack_domains main "domain list&!!" unset
14725 .cindex "&""percent hack""&"
14726 .cindex "source routing" "in email address"
14727 .cindex "address" "source-routed"
14728 The &"percent hack"& is the convention whereby a local part containing a
14729 percent sign is re-interpreted as a new email address, with the percent
14730 replaced by @. This is sometimes called &"source routing"&, though that term is
14731 also applied to RFC 2822 addresses that begin with an @ character. If this
14732 option is set, Exim implements the percent facility for those domains listed,
14733 but no others. This happens before an incoming SMTP address is tested against
14734 an ACL.
14735
14736 &*Warning*&: The &"percent hack"& has often been abused by people who are
14737 trying to get round relaying restrictions. For this reason, it is best avoided
14738 if at all possible. Unfortunately, a number of less security-conscious MTAs
14739 implement it unconditionally. If you are running Exim on a gateway host, and
14740 routing mail through to internal MTAs without processing the local parts, it is
14741 a good idea to reject recipient addresses with percent characters in their
14742 local parts. Exim's default configuration does this.
14743
14744
14745 .option perl_at_start main boolean false
14746 This option is available only when Exim is built with an embedded Perl
14747 interpreter. See chapter &<<CHAPperl>>& for details of its use.
14748
14749
14750 .option perl_startup main string unset
14751 This option is available only when Exim is built with an embedded Perl
14752 interpreter. See chapter &<<CHAPperl>>& for details of its use.
14753
14754
14755 .option pgsql_servers main "string list" unset
14756 .cindex "PostgreSQL lookup type" "server list"
14757 This option provides a list of PostgreSQL servers and associated connection
14758 data, to be used in conjunction with &(pgsql)& lookups (see section
14759 &<<SECID72>>&). The option is available only if Exim has been built with
14760 PostgreSQL support.
14761
14762
14763 .option pid_file_path main string&!! "set at compile time"
14764 .cindex "daemon" "pid file path"
14765 .cindex "pid file, path for"
14766 This option sets the name of the file to which the Exim daemon writes its
14767 process id. The string is expanded, so it can contain, for example, references
14768 to the host name:
14769 .code
14770 pid_file_path = /var/log/$primary_hostname/exim.pid
14771 .endd
14772 If no path is set, the pid is written to the file &_exim-daemon.pid_& in Exim's
14773 spool directory.
14774 The value set by the option can be overridden by the &%-oP%& command line
14775 option. A pid file is not written if a &"non-standard"& daemon is run by means
14776 of the &%-oX%& option, unless a path is explicitly supplied by &%-oP%&.
14777
14778
14779 .option pipelining_advertise_hosts main "host list&!!" *
14780 .cindex "PIPELINING" "suppressing advertising"
14781 This option can be used to suppress the advertisement of the SMTP
14782 PIPELINING extension to specific hosts. See also the &*no_pipelining*&
14783 control in section &<<SECTcontrols>>&. When PIPELINING is not advertised and
14784 &%smtp_enforce_sync%& is true, an Exim server enforces strict synchronization
14785 for each SMTP command and response. When PIPELINING is advertised, Exim assumes
14786 that clients will use it; &"out of order"& commands that are &"expected"& do
14787 not count as protocol errors (see &%smtp_max_synprot_errors%&).
14788
14789
14790 .option preserve_message_logs main boolean false
14791 .cindex "message logs" "preserving"
14792 If this option is set, message log files are not deleted when messages are
14793 completed. Instead, they are moved to a sub-directory of the spool directory
14794 called &_msglog.OLD_&, where they remain available for statistical or debugging
14795 purposes. This is a dangerous option to set on systems with any appreciable
14796 volume of mail. Use with care!
14797
14798
14799 .option primary_hostname main string "see below"
14800 .cindex "name" "of local host"
14801 .cindex "host" "name of local"
14802 .cindex "local host" "name of"
14803 .vindex "&$primary_hostname$&"
14804 This specifies the name of the current host. It is used in the default EHLO or
14805 HELO command for outgoing SMTP messages (changeable via the &%helo_data%&
14806 option in the &(smtp)& transport), and as the default for &%qualify_domain%&.
14807 The value is also used by default in some SMTP response messages from an Exim
14808 server. This can be changed dynamically by setting &%smtp_active_hostname%&.
14809
14810 If &%primary_hostname%& is not set, Exim calls &[uname()]& to find the host
14811 name. If this fails, Exim panics and dies. If the name returned by &[uname()]&
14812 contains only one component, Exim passes it to &[gethostbyname()]& (or
14813 &[getipnodebyname()]& when available) in order to obtain the fully qualified
14814 version. The variable &$primary_hostname$& contains the host name, whether set
14815 explicitly by this option, or defaulted.
14816
14817
14818 .option print_topbitchars main boolean false
14819 .cindex "printing characters"
14820 .cindex "8-bit characters"
14821 By default, Exim considers only those characters whose codes lie in the range
14822 32&--126 to be printing characters. In a number of circumstances (for example,
14823 when writing log entries) non-printing characters are converted into escape
14824 sequences, primarily to avoid messing up the layout. If &%print_topbitchars%&
14825 is set, code values of 128 and above are also considered to be printing
14826 characters.
14827
14828 This option also affects the header syntax checks performed by the
14829 &(autoreply)& transport, and whether Exim uses RFC 2047 encoding of
14830 the user's full name when constructing From: and Sender: addresses (as
14831 described in section &<<SECTconstr>>&). Setting this option can cause
14832 Exim to generate eight bit message headers that do not conform to the
14833 standards.
14834
14835
14836 .option process_log_path main string unset
14837 .cindex "process log path"
14838 .cindex "log" "process log"
14839 .cindex "&'exiwhat'&"
14840 This option sets the name of the file to which an Exim process writes its
14841 &"process log"& when sent a USR1 signal. This is used by the &'exiwhat'&
14842 utility script. If this option is unset, the file called &_exim-process.info_&
14843 in Exim's spool directory is used. The ability to specify the name explicitly
14844 can be useful in environments where two different Exims are running, using
14845 different spool directories.
14846
14847
14848 .option prod_requires_admin main boolean true
14849 .oindex "&%-M%&"
14850 .oindex "&%-R%&"
14851 .oindex "&%-q%&"
14852 The &%-M%&, &%-R%&, and &%-q%& command-line options require the caller to be an
14853 admin user unless &%prod_requires_admin%& is set false. See also
14854 &%queue_list_requires_admin%&.
14855
14856
14857 .option qualify_domain main string "see below"
14858 .cindex "domain" "for qualifying addresses"
14859 .cindex "address" "qualification"
14860 This option specifies the domain name that is added to any envelope sender
14861 addresses that do not have a domain qualification. It also applies to
14862 recipient addresses if &%qualify_recipient%& is not set. Unqualified addresses
14863 are accepted by default only for locally-generated messages. Qualification is
14864 also applied to addresses in header lines such as &'From:'& and &'To:'& for
14865 locally-generated messages, unless the &%-bnq%& command line option is used.
14866
14867 Messages from external sources must always contain fully qualified addresses,
14868 unless the sending host matches &%sender_unqualified_hosts%& or
14869 &%recipient_unqualified_hosts%& (as appropriate), in which case incoming
14870 addresses are qualified with &%qualify_domain%& or &%qualify_recipient%& as
14871 necessary. Internally, Exim always works with fully qualified envelope
14872 addresses. If &%qualify_domain%& is not set, it defaults to the
14873 &%primary_hostname%& value.
14874
14875
14876 .option qualify_recipient main string "see below"
14877 This option allows you to specify a different domain for qualifying recipient
14878 addresses to the one that is used for senders. See &%qualify_domain%& above.
14879
14880
14881
14882 .option queue_domains main "domain list&!!" unset
14883 .cindex "domain" "specifying non-immediate delivery"
14884 .cindex "queueing incoming messages"
14885 .cindex "message" "queueing certain domains"
14886 This option lists domains for which immediate delivery is not required.
14887 A delivery process is started whenever a message is received, but only those
14888 domains that do not match are processed. All other deliveries wait until the
14889 next queue run. See also &%hold_domains%& and &%queue_smtp_domains%&.
14890
14891
14892 .option queue_list_requires_admin main boolean true
14893 .oindex "&%-bp%&"
14894 The &%-bp%& command-line option, which lists the messages that are on the
14895 queue, requires the caller to be an admin user unless
14896 &%queue_list_requires_admin%& is set false. See also &%prod_requires_admin%&.
14897
14898
14899 .option queue_only main boolean false
14900 .cindex "queueing incoming messages"
14901 .cindex "message" "queueing unconditionally"
14902 If &%queue_only%& is set, a delivery process is not automatically started
14903 whenever a message is received. Instead, the message waits on the queue for the
14904 next queue run. Even if &%queue_only%& is false, incoming messages may not get
14905 delivered immediately when certain conditions (such as heavy load) occur.
14906
14907 The &%-odq%& command line has the same effect as &%queue_only%&. The &%-odb%&
14908 and &%-odi%& command line options override &%queue_only%& unless
14909 &%queue_only_override%& is set false. See also &%queue_only_file%&,
14910 &%queue_only_load%&, and &%smtp_accept_queue%&.
14911
14912
14913 .option queue_only_file main string unset
14914 .cindex "queueing incoming messages"
14915 .cindex "message" "queueing by file existence"
14916 This option can be set to a colon-separated list of absolute path names, each
14917 one optionally preceded by &"smtp"&. When Exim is receiving a message,
14918 it tests for the existence of each listed path using a call to &[stat()]&. For
14919 each path that exists, the corresponding queueing option is set.
14920 For paths with no prefix, &%queue_only%& is set; for paths prefixed by
14921 &"smtp"&, &%queue_smtp_domains%& is set to match all domains. So, for example,
14922 .code
14923 queue_only_file = smtp/some/file
14924 .endd
14925 causes Exim to behave as if &%queue_smtp_domains%& were set to &"*"& whenever
14926 &_/some/file_& exists.
14927
14928
14929 .option queue_only_load main fixed-point unset
14930 .cindex "load average"
14931 .cindex "queueing incoming messages"
14932 .cindex "message" "queueing by load"
14933 If the system load average is higher than this value, incoming messages from
14934 all sources are queued, and no automatic deliveries are started. If this
14935 happens during local or remote SMTP input, all subsequent messages received on
14936 the same SMTP connection are queued by default, whatever happens to the load in
14937 the meantime, but this can be changed by setting &%queue_only_load_latch%&
14938 false.
14939
14940 Deliveries will subsequently be performed by queue runner processes. This
14941 option has no effect on ancient operating systems on which Exim cannot
14942 determine the load average. See also &%deliver_queue_load_max%& and
14943 &%smtp_load_reserve%&.
14944
14945
14946 .option queue_only_load_latch main boolean true
14947 .cindex "load average" "re-evaluating per message"
14948 When this option is true (the default), once one message has been queued
14949 because the load average is higher than the value set by &%queue_only_load%&,
14950 all subsequent messages received on the same SMTP connection are also queued.
14951 This is a deliberate choice; even though the load average may fall below the
14952 threshold, it doesn't seem right to deliver later messages on the same
14953 connection when not delivering earlier ones. However, there are special
14954 circumstances such as very long-lived connections from scanning appliances
14955 where this is not the best strategy. In such cases, &%queue_only_load_latch%&
14956 should be set false. This causes the value of the load average to be
14957 re-evaluated for each message.
14958
14959
14960 .option queue_only_override main boolean true
14961 .cindex "queueing incoming messages"
14962 When this option is true, the &%-od%&&'x'& command line options override the
14963 setting of &%queue_only%& or &%queue_only_file%& in the configuration file. If
14964 &%queue_only_override%& is set false, the &%-od%&&'x'& options cannot be used
14965 to override; they are accepted, but ignored.
14966
14967
14968 .option queue_run_in_order main boolean false
14969 .cindex "queue runner" "processing messages in order"
14970 If this option is set, queue runs happen in order of message arrival instead of
14971 in an arbitrary order. For this to happen, a complete list of the entire queue
14972 must be set up before the deliveries start. When the queue is all held in a
14973 single directory (the default), a single list is created for both the ordered
14974 and the non-ordered cases. However, if &%split_spool_directory%& is set, a
14975 single list is not created when &%queue_run_in_order%& is false. In this case,
14976 the sub-directories are processed one at a time (in a random order), and this
14977 avoids setting up one huge list for the whole queue. Thus, setting
14978 &%queue_run_in_order%& with &%split_spool_directory%& may degrade performance
14979 when the queue is large, because of the extra work in setting up the single,
14980 large list. In most situations, &%queue_run_in_order%& should not be set.
14981
14982
14983
14984 .option queue_run_max main integer 5
14985 .cindex "queue runner" "maximum number of"
14986 This controls the maximum number of queue runner processes that an Exim daemon
14987 can run simultaneously. This does not mean that it starts them all at once,
14988 but rather that if the maximum number are still running when the time comes to
14989 start another one, it refrains from starting another one. This can happen with
14990 very large queues and/or very sluggish deliveries. This option does not,
14991 however, interlock with other processes, so additional queue runners can be
14992 started by other means, or by killing and restarting the daemon.
14993
14994 Setting this option to zero does not suppress queue runs; rather, it disables
14995 the limit, allowing any number of simultaneous queue runner processes to be
14996 run. If you do not want queue runs to occur, omit the &%-q%&&'xx'& setting on
14997 the daemon's command line.
14998
14999 .option queue_smtp_domains main "domain list&!!" unset
15000 .cindex "queueing incoming messages"
15001 .cindex "message" "queueing remote deliveries"
15002 When this option is set, a delivery process is started whenever a message is
15003 received, routing is performed, and local deliveries take place.
15004 However, if any SMTP deliveries are required for domains that match
15005 &%queue_smtp_domains%&, they are not immediately delivered, but instead the
15006 message waits on the queue for the next queue run. Since routing of the message
15007 has taken place, Exim knows to which remote hosts it must be delivered, and so
15008 when the queue run happens, multiple messages for the same host are delivered
15009 over a single SMTP connection. The &%-odqs%& command line option causes all
15010 SMTP deliveries to be queued in this way, and is equivalent to setting
15011 &%queue_smtp_domains%& to &"*"&. See also &%hold_domains%& and
15012 &%queue_domains%&.
15013
15014
15015 .option receive_timeout main time 0s
15016 .cindex "timeout" "for non-SMTP input"
15017 This option sets the timeout for accepting a non-SMTP message, that is, the
15018 maximum time that Exim waits when reading a message on the standard input. If
15019 the value is zero, it will wait for ever. This setting is overridden by the
15020 &%-or%& command line option. The timeout for incoming SMTP messages is
15021 controlled by &%smtp_receive_timeout%&.
15022
15023 .option received_header_text main string&!! "see below"
15024 .cindex "customizing" "&'Received:'& header"
15025 .cindex "&'Received:'& header line" "customizing"
15026 This string defines the contents of the &'Received:'& message header that is
15027 added to each message, except for the timestamp, which is automatically added
15028 on at the end (preceded by a semicolon). The string is expanded each time it is
15029 used. If the expansion yields an empty string, no &'Received:'& header line is
15030 added to the message. Otherwise, the string should start with the text
15031 &"Received:"& and conform to the RFC 2822 specification for &'Received:'&
15032 header lines. The default setting is:
15033
15034 .code
15035 received_header_text = Received: \
15036   ${if def:sender_rcvhost {from $sender_rcvhost\n\t}\
15037   {${if def:sender_ident \
15038   {from ${quote_local_part:$sender_ident} }}\
15039   ${if def:sender_helo_name {(helo=$sender_helo_name)\n\t}}}}\
15040   by $primary_hostname \
15041   ${if def:received_protocol {with $received_protocol}} \
15042   ${if def:tls_in_cipher {($tls_in_cipher)\n\t}}\
15043   (Exim $version_number)\n\t\
15044   ${if def:sender_address \
15045   {(envelope-from <$sender_address>)\n\t}}\
15046   id $message_exim_id\
15047   ${if def:received_for {\n\tfor $received_for}}
15048 .endd
15049
15050 The reference to the TLS cipher is omitted when Exim is built without TLS
15051 support. The use of conditional expansions ensures that this works for both
15052 locally generated messages and messages received from remote hosts, giving
15053 header lines such as the following:
15054 .code
15055 Received: from scrooge.carol.example ([192.168.12.25] ident=root)
15056 by marley.carol.example with esmtp (Exim 4.00)
15057 (envelope-from <bob@carol.example>)
15058 id 16IOWa-00019l-00
15059 for chas@dickens.example; Tue, 25 Dec 2001 14:43:44 +0000
15060 Received: by scrooge.carol.example with local (Exim 4.00)
15061 id 16IOWW-000083-00; Tue, 25 Dec 2001 14:43:41 +0000
15062 .endd
15063 Until the body of the message has been received, the timestamp is the time when
15064 the message started to be received. Once the body has arrived, and all policy
15065 checks have taken place, the timestamp is updated to the time at which the
15066 message was accepted.
15067
15068
15069 .option received_headers_max main integer 30
15070 .cindex "loop" "prevention"
15071 .cindex "mail loop prevention"
15072 .cindex "&'Received:'& header line" "counting"
15073 When a message is to be delivered, the number of &'Received:'& headers is
15074 counted, and if it is greater than this parameter, a mail loop is assumed to
15075 have occurred, the delivery is abandoned, and an error message is generated.
15076 This applies to both local and remote deliveries.
15077
15078
15079 .option recipient_unqualified_hosts main "host list&!!" unset
15080 .cindex "unqualified addresses"
15081 .cindex "host" "unqualified addresses from"
15082 This option lists those hosts from which Exim is prepared to accept unqualified
15083 recipient addresses in message envelopes. The addresses are made fully
15084 qualified by the addition of the &%qualify_recipient%& value. This option also
15085 affects message header lines. Exim does not reject unqualified recipient
15086 addresses in headers, but it qualifies them only if the message came from a
15087 host that matches &%recipient_unqualified_hosts%&,
15088 or if the message was submitted locally (not using TCP/IP), and the &%-bnq%&
15089 option was not set.
15090
15091
15092 .option recipients_max main integer 0
15093 .cindex "limit" "number of recipients"
15094 .cindex "recipient" "maximum number"
15095 If this option is set greater than zero, it specifies the maximum number of
15096 original recipients for any message. Additional recipients that are generated
15097 by aliasing or forwarding do not count. SMTP messages get a 452 response for
15098 all recipients over the limit; earlier recipients are delivered as normal.
15099 Non-SMTP messages with too many recipients are failed, and no deliveries are
15100 done.
15101
15102 .cindex "RCPT" "maximum number of incoming"
15103 &*Note*&: The RFCs specify that an SMTP server should accept at least 100
15104 RCPT commands in a single message.
15105
15106
15107 .option recipients_max_reject main boolean false
15108 If this option is set true, Exim rejects SMTP messages containing too many
15109 recipients by giving 552 errors to the surplus RCPT commands, and a 554
15110 error to the eventual DATA command. Otherwise (the default) it gives a 452
15111 error to the surplus RCPT commands and accepts the message on behalf of the
15112 initial set of recipients. The remote server should then re-send the message
15113 for the remaining recipients at a later time.
15114
15115
15116 .option remote_max_parallel main integer 2
15117 .cindex "delivery" "parallelism for remote"
15118 This option controls parallel delivery of one message to a number of remote
15119 hosts. If the value is less than 2, parallel delivery is disabled, and Exim
15120 does all the remote deliveries for a message one by one. Otherwise, if a single
15121 message has to be delivered to more than one remote host, or if several copies
15122 have to be sent to the same remote host, up to &%remote_max_parallel%&
15123 deliveries are done simultaneously. If more than &%remote_max_parallel%&
15124 deliveries are required, the maximum number of processes are started, and as
15125 each one finishes, another is begun. The order of starting processes is the
15126 same as if sequential delivery were being done, and can be controlled by the
15127 &%remote_sort_domains%& option. If parallel delivery takes place while running
15128 with debugging turned on, the debugging output from each delivery process is
15129 tagged with its process id.
15130
15131 This option controls only the maximum number of parallel deliveries for one
15132 message in one Exim delivery process. Because Exim has no central queue
15133 manager, there is no way of controlling the total number of simultaneous
15134 deliveries if the configuration allows a delivery attempt as soon as a message
15135 is received.
15136
15137 .cindex "number of deliveries"
15138 .cindex "delivery" "maximum number of"
15139 If you want to control the total number of deliveries on the system, you
15140 need to set the &%queue_only%& option. This ensures that all incoming messages
15141 are added to the queue without starting a delivery process. Then set up an Exim
15142 daemon to start queue runner processes at appropriate intervals (probably
15143 fairly often, for example, every minute), and limit the total number of queue
15144 runners by setting the &%queue_run_max%& parameter. Because each queue runner
15145 delivers only one message at a time, the maximum number of deliveries that can
15146 then take place at once is &%queue_run_max%& multiplied by
15147 &%remote_max_parallel%&.
15148
15149 If it is purely remote deliveries you want to control, use
15150 &%queue_smtp_domains%& instead of &%queue_only%&. This has the added benefit of
15151 doing the SMTP routing before queueing, so that several messages for the same
15152 host will eventually get delivered down the same connection.
15153
15154
15155 .option remote_sort_domains main "domain list&!!" unset
15156 .cindex "sorting remote deliveries"
15157 .cindex "delivery" "sorting remote"
15158 When there are a number of remote deliveries for a message, they are sorted by
15159 domain into the order given by this list. For example,
15160 .code
15161 remote_sort_domains = *.cam.ac.uk:*.uk
15162 .endd
15163 would attempt to deliver to all addresses in the &'cam.ac.uk'& domain first,
15164 then to those in the &%uk%& domain, then to any others.
15165
15166
15167 .option retry_data_expire main time 7d
15168 .cindex "hints database" "data expiry"
15169 This option sets a &"use before"& time on retry information in Exim's hints
15170 database. Any older retry data is ignored. This means that, for example, once a
15171 host has not been tried for 7 days, Exim behaves as if it has no knowledge of
15172 past failures.
15173
15174
15175 .option retry_interval_max main time 24h
15176 .cindex "retry" "limit on interval"
15177 .cindex "limit" "on retry interval"
15178 Chapter &<<CHAPretry>>& describes Exim's mechanisms for controlling the
15179 intervals between delivery attempts for messages that cannot be delivered
15180 straight away. This option sets an overall limit to the length of time between
15181 retries. It cannot be set greater than 24 hours; any attempt to do so forces
15182 the default value.
15183
15184
15185 .option return_path_remove main boolean true
15186 .cindex "&'Return-path:'& header line" "removing"
15187 RFC 2821, section 4.4, states that an SMTP server must insert a
15188 &'Return-path:'& header line into a message when it makes a &"final delivery"&.
15189 The &'Return-path:'& header preserves the sender address as received in the
15190 MAIL command. This description implies that this header should not be present
15191 in an incoming message. If &%return_path_remove%& is true, any existing
15192 &'Return-path:'& headers are removed from messages at the time they are
15193 received. Exim's transports have options for adding &'Return-path:'& headers at
15194 the time of delivery. They are normally used only for final local deliveries.
15195
15196
15197 .option return_size_limit main integer 100K
15198 This option is an obsolete synonym for &%bounce_return_size_limit%&.
15199
15200
15201 .option rfc1413_hosts main "host list&!!" *
15202 .cindex "RFC 1413"
15203 .cindex "host" "for RFC 1413 calls"
15204 RFC 1413 identification calls are made to any client host which matches an item
15205 in the list.
15206
15207 .option rfc1413_query_timeout main time 5s
15208 .cindex "RFC 1413" "query timeout"
15209 .cindex "timeout" "for RFC 1413 call"
15210 This sets the timeout on RFC 1413 identification calls. If it is set to zero,
15211 no RFC 1413 calls are ever made.
15212
15213
15214 .option sender_unqualified_hosts main "host list&!!" unset
15215 .cindex "unqualified addresses"
15216 .cindex "host" "unqualified addresses from"
15217 This option lists those hosts from which Exim is prepared to accept unqualified
15218 sender addresses. The addresses are made fully qualified by the addition of
15219 &%qualify_domain%&. This option also affects message header lines. Exim does
15220 not reject unqualified addresses in headers that contain sender addresses, but
15221 it qualifies them only if the message came from a host that matches
15222 &%sender_unqualified_hosts%&, or if the message was submitted locally (not
15223 using TCP/IP), and the &%-bnq%& option was not set.
15224
15225
15226 .option smtp_accept_keepalive main boolean true
15227 .cindex "keepalive" "on incoming connection"
15228 This option controls the setting of the SO_KEEPALIVE option on incoming
15229 TCP/IP socket connections. When set, it causes the kernel to probe idle
15230 connections periodically, by sending packets with &"old"& sequence numbers. The
15231 other end of the connection should send an acknowledgment if the connection is
15232 still okay or a reset if the connection has been aborted. The reason for doing
15233 this is that it has the beneficial effect of freeing up certain types of
15234 connection that can get stuck when the remote host is disconnected without
15235 tidying up the TCP/IP call properly. The keepalive mechanism takes several
15236 hours to detect unreachable hosts.
15237
15238
15239
15240 .option smtp_accept_max main integer 20
15241 .cindex "limit" "incoming SMTP connections"
15242 .cindex "SMTP" "incoming connection count"
15243 .cindex "inetd"
15244 This option specifies the maximum number of simultaneous incoming SMTP calls
15245 that Exim will accept. It applies only to the listening daemon; there is no
15246 control (in Exim) when incoming SMTP is being handled by &'inetd'&. If the
15247 value is set to zero, no limit is applied. However, it is required to be
15248 non-zero if either &%smtp_accept_max_per_host%& or &%smtp_accept_queue%& is
15249 set. See also &%smtp_accept_reserve%& and &%smtp_load_reserve%&.
15250
15251 A new SMTP connection is immediately rejected if the &%smtp_accept_max%& limit
15252 has been reached. If not, Exim first checks &%smtp_accept_max_per_host%&. If
15253 that limit has not been reached for the client host, &%smtp_accept_reserve%&
15254 and &%smtp_load_reserve%& are then checked before accepting the connection.
15255
15256
15257 .option smtp_accept_max_nonmail main integer 10
15258 .cindex "limit" "non-mail SMTP commands"
15259 .cindex "SMTP" "limiting non-mail commands"
15260 Exim counts the number of &"non-mail"& commands in an SMTP session, and drops
15261 the connection if there are too many. This option defines &"too many"&. The
15262 check catches some denial-of-service attacks, repeated failing AUTHs, or a mad
15263 client looping sending EHLO, for example. The check is applied only if the
15264 client host matches &%smtp_accept_max_nonmail_hosts%&.
15265
15266 When a new message is expected, one occurrence of RSET is not counted. This
15267 allows a client to send one RSET between messages (this is not necessary,
15268 but some clients do it). Exim also allows one uncounted occurrence of HELO
15269 or EHLO, and one occurrence of STARTTLS between messages. After
15270 starting up a TLS session, another EHLO is expected, and so it too is not
15271 counted. The first occurrence of AUTH in a connection, or immediately
15272 following STARTTLS is not counted. Otherwise, all commands other than
15273 MAIL, RCPT, DATA, and QUIT are counted.
15274
15275
15276 .option smtp_accept_max_nonmail_hosts main "host list&!!" *
15277 You can control which hosts are subject to the &%smtp_accept_max_nonmail%&
15278 check by setting this option. The default value makes it apply to all hosts. By
15279 changing the value, you can exclude any badly-behaved hosts that you have to
15280 live with.
15281
15282
15283 . Allow this long option name to split; give it unsplit as a fifth argument
15284 . for the automatic .oindex that is generated by .option.
15285
15286 .option "smtp_accept_max_per_connection" main integer 1000 &&&
15287          smtp_accept_max_per_connection
15288 .cindex "SMTP" "limiting incoming message count"
15289 .cindex "limit" "messages per SMTP connection"
15290 The value of this option limits the number of MAIL commands that Exim is
15291 prepared to accept over a single SMTP connection, whether or not each command
15292 results in the transfer of a message. After the limit is reached, a 421
15293 response is given to subsequent MAIL commands. This limit is a safety
15294 precaution against a client that goes mad (incidents of this type have been
15295 seen).
15296
15297
15298 .option smtp_accept_max_per_host main string&!! unset
15299 .cindex "limit" "SMTP connections from one host"
15300 .cindex "host" "limiting SMTP connections from"
15301 This option restricts the number of simultaneous IP connections from a single
15302 host (strictly, from a single IP address) to the Exim daemon. The option is
15303 expanded, to enable different limits to be applied to different hosts by
15304 reference to &$sender_host_address$&. Once the limit is reached, additional
15305 connection attempts from the same host are rejected with error code 421. This
15306 is entirely independent of &%smtp_accept_reserve%&. The option's default value
15307 of zero imposes no limit. If this option is set greater than zero, it is
15308 required that &%smtp_accept_max%& be non-zero.
15309
15310 &*Warning*&: When setting this option you should not use any expansion
15311 constructions that take an appreciable amount of time. The expansion and test
15312 happen in the main daemon loop, in order to reject additional connections
15313 without forking additional processes (otherwise a denial-of-service attack
15314 could cause a vast number or processes to be created). While the daemon is
15315 doing this processing, it cannot accept any other incoming connections.
15316
15317
15318
15319 .option smtp_accept_queue main integer 0
15320 .cindex "SMTP" "incoming connection count"
15321 .cindex "queueing incoming messages"
15322 .cindex "message" "queueing by SMTP connection count"
15323 If the number of simultaneous incoming SMTP connections being handled via the
15324 listening daemon exceeds this value, messages received by SMTP are just placed
15325 on the queue; no delivery processes are started automatically. The count is
15326 fixed at the start of an SMTP connection. It cannot be updated in the
15327 subprocess that receives messages, and so the queueing or not queueing applies
15328 to all messages received in the same connection.
15329
15330 A value of zero implies no limit, and clearly any non-zero value is useful only
15331 if it is less than the &%smtp_accept_max%& value (unless that is zero). See
15332 also &%queue_only%&, &%queue_only_load%&, &%queue_smtp_domains%&, and the
15333 various &%-od%&&'x'& command line options.
15334
15335
15336 . Allow this long option name to split; give it unsplit as a fifth argument
15337 . for the automatic .oindex that is generated by .option.
15338
15339 .option "smtp_accept_queue_per_ &~&~connection" main integer 10 &&&
15340          smtp_accept_queue_per_connection
15341 .cindex "queueing incoming messages"
15342 .cindex "message" "queueing by message count"
15343 This option limits the number of delivery processes that Exim starts
15344 automatically when receiving messages via SMTP, whether via the daemon or by
15345 the use of &%-bs%& or &%-bS%&. If the value of the option is greater than zero,
15346 and the number of messages received in a single SMTP session exceeds this
15347 number, subsequent messages are placed on the queue, but no delivery processes
15348 are started. This helps to limit the number of Exim processes when a server
15349 restarts after downtime and there is a lot of mail waiting for it on other
15350 systems. On large systems, the default should probably be increased, and on
15351 dial-in client systems it should probably be set to zero (that is, disabled).
15352
15353
15354 .option smtp_accept_reserve main integer 0
15355 .cindex "SMTP" "incoming call count"
15356 .cindex "host" "reserved"
15357 When &%smtp_accept_max%& is set greater than zero, this option specifies a
15358 number of SMTP connections that are reserved for connections from the hosts
15359 that are specified in &%smtp_reserve_hosts%&. The value set in
15360 &%smtp_accept_max%& includes this reserve pool. The specified hosts are not
15361 restricted to this number of connections; the option specifies a minimum number
15362 of connection slots for them, not a maximum. It is a guarantee that this group
15363 of hosts can always get at least &%smtp_accept_reserve%& connections. However,
15364 the limit specified by &%smtp_accept_max_per_host%& is still applied to each
15365 individual host.
15366
15367 For example, if &%smtp_accept_max%& is set to 50 and &%smtp_accept_reserve%& is
15368 set to 5, once there are 45 active connections (from any hosts), new
15369 connections are accepted only from hosts listed in &%smtp_reserve_hosts%&,
15370 provided the other criteria for acceptance are met.
15371
15372
15373 .option smtp_active_hostname main string&!! unset
15374 .cindex "host" "name in SMTP responses"
15375 .cindex "SMTP" "host name in responses"
15376 .vindex "&$primary_hostname$&"
15377 This option is provided for multi-homed servers that want to masquerade as
15378 several different hosts. At the start of an incoming SMTP connection, its value
15379 is expanded and used instead of the value of &$primary_hostname$& in SMTP
15380 responses. For example, it is used as domain name in the response to an
15381 incoming HELO or EHLO command.
15382
15383 .vindex "&$smtp_active_hostname$&"
15384 The active hostname is placed in the &$smtp_active_hostname$& variable, which
15385 is saved with any messages that are received. It is therefore available for use
15386 in routers and transports when the message is later delivered.
15387
15388 If this option is unset, or if its expansion is forced to fail, or if the
15389 expansion results in an empty string, the value of &$primary_hostname$& is
15390 used. Other expansion failures cause a message to be written to the main and
15391 panic logs, and the SMTP command receives a temporary error. Typically, the
15392 value of &%smtp_active_hostname%& depends on the incoming interface address.
15393 For example:
15394 .code
15395 smtp_active_hostname = ${if eq{$received_ip_address}{10.0.0.1}\
15396   {cox.mydomain}{box.mydomain}}
15397 .endd
15398
15399 Although &$smtp_active_hostname$& is primarily concerned with incoming
15400 messages, it is also used as the default for HELO commands in callout
15401 verification if there is no remote transport from which to obtain a
15402 &%helo_data%& value.
15403
15404 .option smtp_banner main string&!! "see below"
15405 .cindex "SMTP" "welcome banner"
15406 .cindex "banner for SMTP"
15407 .cindex "welcome banner for SMTP"
15408 .cindex "customizing" "SMTP banner"
15409 This string, which is expanded every time it is used, is output as the initial
15410 positive response to an SMTP connection. The default setting is:
15411 .code
15412 smtp_banner = $smtp_active_hostname ESMTP Exim \
15413   $version_number $tod_full
15414 .endd
15415 Failure to expand the string causes a panic error. If you want to create a
15416 multiline response to the initial SMTP connection, use &"\n"& in the string at
15417 appropriate points, but not at the end. Note that the 220 code is not included
15418 in this string. Exim adds it automatically (several times in the case of a
15419 multiline response).
15420
15421
15422 .option smtp_check_spool_space main boolean true
15423 .cindex "checking disk space"
15424 .cindex "disk space, checking"
15425 .cindex "spool directory" "checking space"
15426 When this option is set, if an incoming SMTP session encounters the SIZE
15427 option on a MAIL command, it checks that there is enough space in the
15428 spool directory's partition to accept a message of that size, while still
15429 leaving free the amount specified by &%check_spool_space%& (even if that value
15430 is zero). If there isn't enough space, a temporary error code is returned.
15431
15432
15433 .option smtp_connect_backlog main integer 20
15434 .cindex "connection backlog"
15435 .cindex "SMTP" "connection backlog"
15436 .cindex "backlog of connections"
15437 This option specifies a maximum number of waiting SMTP connections. Exim passes
15438 this value to the TCP/IP system when it sets up its listener. Once this number
15439 of connections are waiting for the daemon's attention, subsequent connection
15440 attempts are refused at the TCP/IP level. At least, that is what the manuals
15441 say; in some circumstances such connection attempts have been observed to time
15442 out instead. For large systems it is probably a good idea to increase the
15443 value (to 50, say). It also gives some protection against denial-of-service
15444 attacks by SYN flooding.
15445
15446
15447 .option smtp_enforce_sync main boolean true
15448 .cindex "SMTP" "synchronization checking"
15449 .cindex "synchronization checking in SMTP"
15450 The SMTP protocol specification requires the client to wait for a response from
15451 the server at certain points in the dialogue. Without PIPELINING these
15452 synchronization points are after every command; with PIPELINING they are
15453 fewer, but they still exist.
15454
15455 Some spamming sites send out a complete set of SMTP commands without waiting
15456 for any response. Exim protects against this by rejecting a message if the
15457 client has sent further input when it should not have. The error response &"554
15458 SMTP synchronization error"& is sent, and the connection is dropped. Testing
15459 for this error cannot be perfect because of transmission delays (unexpected
15460 input may be on its way but not yet received when Exim checks). However, it
15461 does detect many instances.
15462
15463 The check can be globally disabled by setting &%smtp_enforce_sync%& false.
15464 If you want to disable the check selectively (for example, only for certain
15465 hosts), you can do so by an appropriate use of a &%control%& modifier in an ACL
15466 (see section &<<SECTcontrols>>&). See also &%pipelining_advertise_hosts%&.
15467
15468
15469
15470 .option smtp_etrn_command main string&!! unset
15471 .cindex "ETRN" "command to be run"
15472 .vindex "&$domain$&"
15473 If this option is set, the given command is run whenever an SMTP ETRN
15474 command is received from a host that is permitted to issue such commands (see
15475 chapter &<<CHAPACL>>&). The string is split up into separate arguments which
15476 are independently expanded. The expansion variable &$domain$& is set to the
15477 argument of the ETRN command, and no syntax checking is done on it. For
15478 example:
15479 .code
15480 smtp_etrn_command = /etc/etrn_command $domain \
15481                     $sender_host_address
15482 .endd
15483 A new process is created to run the command, but Exim does not wait for it to
15484 complete. Consequently, its status cannot be checked. If the command cannot be
15485 run, a line is written to the panic log, but the ETRN caller still receives
15486 a 250 success response. Exim is normally running under its own uid when
15487 receiving SMTP, so it is not possible for it to change the uid before running
15488 the command.
15489
15490
15491 .option smtp_etrn_serialize main boolean true
15492 .cindex "ETRN" "serializing"
15493 When this option is set, it prevents the simultaneous execution of more than
15494 one identical command as a result of ETRN in an SMTP connection. See
15495 section &<<SECTETRN>>& for details.
15496
15497
15498 .option smtp_load_reserve main fixed-point unset
15499 .cindex "load average"
15500 If the system load average ever gets higher than this, incoming SMTP calls are
15501 accepted only from those hosts that match an entry in &%smtp_reserve_hosts%&.
15502 If &%smtp_reserve_hosts%& is not set, no incoming SMTP calls are accepted when
15503 the load is over the limit. The option has no effect on ancient operating
15504 systems on which Exim cannot determine the load average. See also
15505 &%deliver_queue_load_max%& and &%queue_only_load%&.
15506
15507
15508
15509 .option smtp_max_synprot_errors main integer 3
15510 .cindex "SMTP" "limiting syntax and protocol errors"
15511 .cindex "limit" "SMTP syntax and protocol errors"
15512 Exim rejects SMTP commands that contain syntax or protocol errors. In
15513 particular, a syntactically invalid email address, as in this command:
15514 .code
15515 RCPT TO:<abc xyz@a.b.c>
15516 .endd
15517 causes immediate rejection of the command, before any other tests are done.
15518 (The ACL cannot be run if there is no valid address to set up for it.) An
15519 example of a protocol error is receiving RCPT before MAIL. If there are
15520 too many syntax or protocol errors in one SMTP session, the connection is
15521 dropped. The limit is set by this option.
15522
15523 .cindex "PIPELINING" "expected errors"
15524 When the PIPELINING extension to SMTP is in use, some protocol errors are
15525 &"expected"&, for instance, a RCPT command after a rejected MAIL command.
15526 Exim assumes that PIPELINING will be used if it advertises it (see
15527 &%pipelining_advertise_hosts%&), and in this situation, &"expected"& errors do
15528 not count towards the limit.
15529
15530
15531
15532 .option smtp_max_unknown_commands main integer 3
15533 .cindex "SMTP" "limiting unknown commands"
15534 .cindex "limit" "unknown SMTP commands"
15535 If there are too many unrecognized commands in an incoming SMTP session, an
15536 Exim server drops the connection. This is a defence against some kinds of abuse
15537 that subvert web
15538 clients
15539 into making connections to SMTP ports; in these circumstances, a number of
15540 non-SMTP command lines are sent first.
15541
15542
15543
15544 .option smtp_ratelimit_hosts main "host list&!!" unset
15545 .cindex "SMTP" "rate limiting"
15546 .cindex "limit" "rate of message arrival"
15547 .cindex "RCPT" "rate limiting"
15548 Some sites find it helpful to be able to limit the rate at which certain hosts
15549 can send them messages, and the rate at which an individual message can specify
15550 recipients.
15551
15552 Exim has two rate-limiting facilities. This section describes the older
15553 facility, which can limit rates within a single connection. The newer
15554 &%ratelimit%& ACL condition can limit rates across all connections. See section
15555 &<<SECTratelimiting>>& for details of the newer facility.
15556
15557 When a host matches &%smtp_ratelimit_hosts%&, the values of
15558 &%smtp_ratelimit_mail%& and &%smtp_ratelimit_rcpt%& are used to control the
15559 rate of acceptance of MAIL and RCPT commands in a single SMTP session,
15560 respectively. Each option, if set, must contain a set of four comma-separated
15561 values:
15562
15563 .ilist
15564 A threshold, before which there is no rate limiting.
15565 .next
15566 An initial time delay. Unlike other times in Exim, numbers with decimal
15567 fractional parts are allowed here.
15568 .next
15569 A factor by which to increase the delay each time.
15570 .next
15571 A maximum value for the delay. This should normally be less than 5 minutes,
15572 because after that time, the client is liable to timeout the SMTP command.
15573 .endlist
15574
15575 For example, these settings have been used successfully at the site which
15576 first suggested this feature, for controlling mail from their customers:
15577 .code
15578 smtp_ratelimit_mail = 2,0.5s,1.05,4m
15579 smtp_ratelimit_rcpt = 4,0.25s,1.015,4m
15580 .endd
15581 The first setting specifies delays that are applied to MAIL commands after
15582 two have been received over a single connection. The initial delay is 0.5
15583 seconds, increasing by a factor of 1.05 each time. The second setting applies
15584 delays to RCPT commands when more than four occur in a single message.
15585
15586
15587 .option smtp_ratelimit_mail main string unset
15588 See &%smtp_ratelimit_hosts%& above.
15589
15590
15591 .option smtp_ratelimit_rcpt main string unset
15592 See &%smtp_ratelimit_hosts%& above.
15593
15594
15595 .option smtp_receive_timeout main time 5m
15596 .cindex "timeout" "for SMTP input"
15597 .cindex "SMTP" "input timeout"
15598 This sets a timeout value for SMTP reception. It applies to all forms of SMTP
15599 input, including batch SMTP. If a line of input (either an SMTP command or a
15600 data line) is not received within this time, the SMTP connection is dropped and
15601 the message is abandoned.
15602 A line is written to the log containing one of the following messages:
15603 .code
15604 SMTP command timeout on connection from...
15605 SMTP data timeout on connection from...
15606 .endd
15607 The former means that Exim was expecting to read an SMTP command; the latter
15608 means that it was in the DATA phase, reading the contents of a message.
15609
15610
15611 .oindex "&%-os%&"
15612 The value set by this option can be overridden by the
15613 &%-os%& command-line option. A setting of zero time disables the timeout, but
15614 this should never be used for SMTP over TCP/IP. (It can be useful in some cases
15615 of local input using &%-bs%& or &%-bS%&.) For non-SMTP input, the reception
15616 timeout is controlled by &%receive_timeout%& and &%-or%&.
15617
15618
15619 .option smtp_reserve_hosts main "host list&!!" unset
15620 This option defines hosts for which SMTP connections are reserved; see
15621 &%smtp_accept_reserve%& and &%smtp_load_reserve%& above.
15622
15623
15624 .option smtp_return_error_details main boolean false
15625 .cindex "SMTP" "details policy failures"
15626 .cindex "policy control" "rejection, returning details"
15627 In the default state, Exim uses bland messages such as
15628 &"Administrative prohibition"& when it rejects SMTP commands for policy
15629 reasons. Many sysadmins like this because it gives away little information
15630 to spammers. However, some other sysadmins who are applying strict checking
15631 policies want to give out much fuller information about failures. Setting
15632 &%smtp_return_error_details%& true causes Exim to be more forthcoming. For
15633 example, instead of &"Administrative prohibition"&, it might give:
15634 .code
15635 550-Rejected after DATA: '>' missing at end of address:
15636 550 failing address in "From" header is: <user@dom.ain
15637 .endd
15638
15639 .option spamd_address main string "see below"
15640 This option is available when Exim is compiled with the content-scanning
15641 extension. It specifies how Exim connects to SpamAssassin's &%spamd%& daemon.
15642 The default value is
15643 .code
15644 127.0.0.1 783
15645 .endd
15646 See section &<<SECTscanspamass>>& for more details.
15647
15648
15649
15650 .option split_spool_directory main boolean false
15651 .cindex "multiple spool directories"
15652 .cindex "spool directory" "split"
15653 .cindex "directories, multiple"
15654 If this option is set, it causes Exim to split its input directory into 62
15655 subdirectories, each with a single alphanumeric character as its name. The
15656 sixth character of the message id is used to allocate messages to
15657 subdirectories; this is the least significant base-62 digit of the time of
15658 arrival of the message.
15659
15660 Splitting up the spool in this way may provide better performance on systems
15661 where there are long mail queues, by reducing the number of files in any one
15662 directory. The msglog directory is also split up in a similar way to the input
15663 directory; however, if &%preserve_message_logs%& is set, all old msglog files
15664 are still placed in the single directory &_msglog.OLD_&.
15665
15666 It is not necessary to take any special action for existing messages when
15667 changing &%split_spool_directory%&. Exim notices messages that are in the
15668 &"wrong"& place, and continues to process them. If the option is turned off
15669 after a period of being on, the subdirectories will eventually empty and be
15670 automatically deleted.
15671
15672 When &%split_spool_directory%& is set, the behaviour of queue runner processes
15673 changes. Instead of creating a list of all messages in the queue, and then
15674 trying to deliver each one in turn, it constructs a list of those in one
15675 sub-directory and tries to deliver them, before moving on to the next
15676 sub-directory. The sub-directories are processed in a random order. This
15677 spreads out the scanning of the input directories, and uses less memory. It is
15678 particularly beneficial when there are lots of messages on the queue. However,
15679 if &%queue_run_in_order%& is set, none of this new processing happens. The
15680 entire queue has to be scanned and sorted before any deliveries can start.
15681
15682
15683 .option spool_directory main string&!! "set at compile time"
15684 .cindex "spool directory" "path to"
15685 This defines the directory in which Exim keeps its spool, that is, the messages
15686 it is waiting to deliver. The default value is taken from the compile-time
15687 configuration setting, if there is one. If not, this option must be set. The
15688 string is expanded, so it can contain, for example, a reference to
15689 &$primary_hostname$&.
15690
15691 If the spool directory name is fixed on your installation, it is recommended
15692 that you set it at build time rather than from this option, particularly if the
15693 log files are being written to the spool directory (see &%log_file_path%&).
15694 Otherwise log files cannot be used for errors that are detected early on, such
15695 as failures in the configuration file.
15696
15697 By using this option to override the compiled-in path, it is possible to run
15698 tests of Exim without using the standard spool.
15699
15700 .option sqlite_lock_timeout main time 5s
15701 .cindex "sqlite lookup type" "lock timeout"
15702 This option controls the timeout that the &(sqlite)& lookup uses when trying to
15703 access an SQLite database. See section &<<SECTsqlite>>& for more details.
15704
15705 .option strict_acl_vars main boolean false
15706 .cindex "&ACL;" "variables, handling unset"
15707 This option controls what happens if a syntactically valid but undefined ACL
15708 variable is referenced. If it is false (the default), an empty string
15709 is substituted; if it is true, an error is generated. See section
15710 &<<SECTaclvariables>>& for details of ACL variables.
15711
15712 .option strip_excess_angle_brackets main boolean false
15713 .cindex "angle brackets, excess"
15714 If this option is set, redundant pairs of angle brackets round &"route-addr"&
15715 items in addresses are stripped. For example, &'<<xxx@a.b.c.d>>'& is
15716 treated as &'<xxx@a.b.c.d>'&. If this is in the envelope and the message is
15717 passed on to another MTA, the excess angle brackets are not passed on. If this
15718 option is not set, multiple pairs of angle brackets cause a syntax error.
15719
15720
15721 .option strip_trailing_dot main boolean false
15722 .cindex "trailing dot on domain"
15723 .cindex "dot" "trailing on domain"
15724 If this option is set, a trailing dot at the end of a domain in an address is
15725 ignored. If this is in the envelope and the message is passed on to another
15726 MTA, the dot is not passed on. If this option is not set, a dot at the end of a
15727 domain causes a syntax error.
15728 However, addresses in header lines are checked only when an ACL requests header
15729 syntax checking.
15730
15731
15732 .option syslog_duplication main boolean true
15733 .cindex "syslog" "duplicate log lines; suppressing"
15734 When Exim is logging to syslog, it writes the log lines for its three
15735 separate logs at different syslog priorities so that they can in principle
15736 be separated on the logging hosts. Some installations do not require this
15737 separation, and in those cases, the duplication of certain log lines is a
15738 nuisance. If &%syslog_duplication%& is set false, only one copy of any
15739 particular log line is written to syslog. For lines that normally go to
15740 both the main log and the reject log, the reject log version (possibly
15741 containing message header lines) is written, at LOG_NOTICE priority.
15742 Lines that normally go to both the main and the panic log are written at
15743 the LOG_ALERT priority.
15744
15745
15746 .option syslog_facility main string unset
15747 .cindex "syslog" "facility; setting"
15748 This option sets the syslog &"facility"& name, used when Exim is logging to
15749 syslog. The value must be one of the strings &"mail"&, &"user"&, &"news"&,
15750 &"uucp"&, &"daemon"&, or &"local&'x'&"& where &'x'& is a digit between 0 and 7.
15751 If this option is unset, &"mail"& is used. See chapter &<<CHAPlog>>& for
15752 details of Exim's logging.
15753
15754
15755
15756 .option syslog_processname main string &`exim`&
15757 .cindex "syslog" "process name; setting"
15758 This option sets the syslog &"ident"& name, used when Exim is logging to
15759 syslog. The value must be no longer than 32 characters. See chapter
15760 &<<CHAPlog>>& for details of Exim's logging.
15761
15762
15763
15764 .option syslog_timestamp main boolean true
15765 .cindex "syslog" "timestamps"
15766 If &%syslog_timestamp%& is set false, the timestamps on Exim's log lines are
15767 omitted when these lines are sent to syslog. See chapter &<<CHAPlog>>& for
15768 details of Exim's logging.
15769
15770
15771 .option system_filter main string&!! unset
15772 .cindex "filter" "system filter"
15773 .cindex "system filter" "specifying"
15774 .cindex "Sieve filter" "not available for system filter"
15775 This option specifies an Exim filter file that is applied to all messages at
15776 the start of each delivery attempt, before any routing is done. System filters
15777 must be Exim filters; they cannot be Sieve filters. If the system filter
15778 generates any deliveries to files or pipes, or any new mail messages, the
15779 appropriate &%system_filter_..._transport%& option(s) must be set, to define
15780 which transports are to be used. Details of this facility are given in chapter
15781 &<<CHAPsystemfilter>>&.
15782
15783
15784 .option system_filter_directory_transport main string&!! unset
15785 .vindex "&$address_file$&"
15786 This sets the name of the transport driver that is to be used when the
15787 &%save%& command in a system message filter specifies a path ending in &"/"&,
15788 implying delivery of each message into a separate file in some directory.
15789 During the delivery, the variable &$address_file$& contains the path name.
15790
15791
15792 .option system_filter_file_transport main string&!! unset
15793 .cindex "file" "transport for system filter"
15794 This sets the name of the transport driver that is to be used when the &%save%&
15795 command in a system message filter specifies a path not ending in &"/"&. During
15796 the delivery, the variable &$address_file$& contains the path name.
15797
15798 .option system_filter_group main string unset
15799 .cindex "gid (group id)" "system filter"
15800 This option is used only when &%system_filter_user%& is also set. It sets the
15801 gid under which the system filter is run, overriding any gid that is associated
15802 with the user. The value may be numerical or symbolic.
15803
15804 .option system_filter_pipe_transport main string&!! unset
15805 .cindex "&(pipe)& transport" "for system filter"
15806 .vindex "&$address_pipe$&"
15807 This specifies the transport driver that is to be used when a &%pipe%& command
15808 is used in a system filter. During the delivery, the variable &$address_pipe$&
15809 contains the pipe command.
15810
15811
15812 .option system_filter_reply_transport main string&!! unset
15813 .cindex "&(autoreply)& transport" "for system filter"
15814 This specifies the transport driver that is to be used when a &%mail%& command
15815 is used in a system filter.
15816
15817
15818 .option system_filter_user main string unset
15819 .cindex "uid (user id)" "system filter"
15820 If this option is set to root, the system filter is run in the main Exim
15821 delivery process, as root.  Otherwise, the system filter runs in a separate
15822 process, as the given user, defaulting to the Exim run-time user.
15823 Unless the string consists entirely of digits, it
15824 is looked up in the password data. Failure to find the named user causes a
15825 configuration error. The gid is either taken from the password data, or
15826 specified by &%system_filter_group%&. When the uid is specified numerically,
15827 &%system_filter_group%& is required to be set.
15828
15829 If the system filter generates any pipe, file, or reply deliveries, the uid
15830 under which the filter is run is used when transporting them, unless a
15831 transport option overrides.
15832
15833
15834 .option tcp_nodelay main boolean true
15835 .cindex "daemon" "TCP_NODELAY on sockets"
15836 .cindex "Nagle algorithm"
15837 .cindex "TCP_NODELAY on listening sockets"
15838 If this option is set false, it stops the Exim daemon setting the
15839 TCP_NODELAY option on its listening sockets. Setting TCP_NODELAY
15840 turns off the &"Nagle algorithm"&, which is a way of improving network
15841 performance in interactive (character-by-character) situations. Turning it off
15842 should improve Exim's performance a bit, so that is what happens by default.
15843 However, it appears that some broken clients cannot cope, and time out. Hence
15844 this option. It affects only those sockets that are set up for listening by the
15845 daemon. Sockets created by the smtp transport for delivering mail always set
15846 TCP_NODELAY.
15847
15848
15849 .option timeout_frozen_after main time 0s
15850 .cindex "frozen messages" "timing out"
15851 .cindex "timeout" "frozen messages"
15852 If &%timeout_frozen_after%& is set to a time greater than zero, a frozen
15853 message of any kind that has been on the queue for longer than the given time
15854 is automatically cancelled at the next queue run. If the frozen message is a
15855 bounce message, it is just discarded; otherwise, a bounce is sent to the
15856 sender, in a similar manner to cancellation by the &%-Mg%& command line option.
15857 If you want to timeout frozen bounce messages earlier than other kinds of
15858 frozen message, see &%ignore_bounce_errors_after%&.
15859
15860 &*Note:*& the default value of zero means no timeouts; with this setting,
15861 frozen messages remain on the queue forever (except for any frozen bounce
15862 messages that are released by &%ignore_bounce_errors_after%&).
15863
15864
15865 .option timezone main string unset
15866 .cindex "timezone, setting"
15867 The value of &%timezone%& is used to set the environment variable TZ while
15868 running Exim (if it is different on entry). This ensures that all timestamps
15869 created by Exim are in the required timezone. If you want all your timestamps
15870 to be in UTC (aka GMT) you should set
15871 .code
15872 timezone = UTC
15873 .endd
15874 The default value is taken from TIMEZONE_DEFAULT in &_Local/Makefile_&,
15875 or, if that is not set, from the value of the TZ environment variable when Exim
15876 is built. If &%timezone%& is set to the empty string, either at build or run
15877 time, any existing TZ variable is removed from the environment when Exim
15878 runs. This is appropriate behaviour for obtaining wall-clock time on some, but
15879 unfortunately not all, operating systems.
15880
15881
15882 .option tls_advertise_hosts main "host list&!!" unset
15883 .cindex "TLS" "advertising"
15884 .cindex "encryption" "on SMTP connection"
15885 .cindex "SMTP" "encrypted connection"
15886 When Exim is built with support for TLS encrypted connections, the availability
15887 of the STARTTLS command to set up an encrypted session is advertised in
15888 response to EHLO only to those client hosts that match this option. See
15889 chapter &<<CHAPTLS>>& for details of Exim's support for TLS.
15890
15891
15892 .option tls_certificate main string&!! unset
15893 .cindex "TLS" "server certificate; location of"
15894 .cindex "certificate" "server, location of"
15895 The value of this option is expanded, and must then be the absolute path to a
15896 file which contains the server's certificates. The server's private key is also
15897 assumed to be in this file if &%tls_privatekey%& is unset. See chapter
15898 &<<CHAPTLS>>& for further details.
15899
15900 &*Note*&: The certificates defined by this option are used only when Exim is
15901 receiving incoming messages as a server. If you want to supply certificates for
15902 use when sending messages as a client, you must set the &%tls_certificate%&
15903 option in the relevant &(smtp)& transport.
15904
15905 If the option contains &$tls_out_sni$& and Exim is built against OpenSSL, then
15906 if the OpenSSL build supports TLS extensions and the TLS client sends the
15907 Server Name Indication extension, then this option and others documented in
15908 &<<SECTtlssni>>& will be re-expanded.
15909
15910 .option tls_crl main string&!! unset
15911 .cindex "TLS" "server certificate revocation list"
15912 .cindex "certificate" "revocation list for server"
15913 This option specifies a certificate revocation list. The expanded value must
15914 be the name of a file that contains a CRL in PEM format.
15915
15916 See &<<SECTtlssni>>& for discussion of when this option might be re-expanded.
15917
15918
15919 .option tls_dh_max_bits main integer 2236
15920 .cindex "TLS" "D-H bit count"
15921 The number of bits used for Diffie-Hellman key-exchange may be suggested by
15922 the chosen TLS library.  That value might prove to be too high for
15923 interoperability.  This option provides a maximum clamp on the value
15924 suggested, trading off security for interoperability.
15925
15926 The value must be at least 1024.
15927
15928 The value 2236 was chosen because, at time of adding the option, it was the
15929 hard-coded maximum value supported by the NSS cryptographic library, as used
15930 by Thunderbird, while GnuTLS was suggesting 2432 bits as normal.
15931
15932 If you prefer more security and are willing to break some clients, raise this
15933 number.
15934
15935 Note that the value passed to GnuTLS for *generating* a new prime may be a
15936 little less than this figure, because GnuTLS is inexact and may produce a
15937 larger prime than requested.
15938
15939
15940 .option tls_dhparam main string&!! unset
15941 .cindex "TLS" "D-H parameters for server"
15942 The value of this option is expanded and indicates the source of DH parameters
15943 to be used by Exim.
15944
15945 If it is a filename starting with a &`/`&, then it names a file from which DH
15946 parameters should be loaded.  If the file exists, it should hold a PEM-encoded
15947 PKCS#3 representation of the DH prime.  If the file does not exist, for
15948 OpenSSL it is an error.  For GnuTLS, Exim will attempt to create the file and
15949 fill it with a generated DH prime.  For OpenSSL, if the DH bit-count from
15950 loading the file is greater than &%tls_dh_max_bits%& then it will be ignored,
15951 and treated as though the &%tls_dhparam%& were set to "none".
15952
15953 If this option expands to the string "none", then no DH parameters will be
15954 loaded by Exim.
15955
15956 If this option expands to the string "historic" and Exim is using GnuTLS, then
15957 Exim will attempt to load a file from inside the spool directory.  If the file
15958 does not exist, Exim will attempt to create it.
15959 See section &<<SECTgnutlsparam>>& for further details.
15960
15961 If Exim is using OpenSSL and this option is empty or unset, then Exim will load
15962 a default DH prime; the default is the 2048 bit prime described in section
15963 2.2 of RFC 5114, "2048-bit MODP Group with 224-bit Prime Order Subgroup", which
15964 in IKE is assigned number 23.
15965
15966 Otherwise, the option must expand to the name used by Exim for any of a number
15967 of DH primes specified in RFC 2409, RFC 3526 and RFC 5114.  As names, Exim uses
15968 "ike" followed by the number used by IKE, of "default" which corresponds to
15969 "ike23".
15970
15971 The available primes are:
15972 &`ike1`&, &`ike2`&, &`ike5`&,
15973 &`ike14`&, &`ike15`&, &`ike16`&, &`ike17`&, &`ike18`&,
15974 &`ike22`&, &`ike23`& (aka &`default`&) and &`ike24`&.
15975
15976 Some of these will be too small to be accepted by clients.
15977 Some may be too large to be accepted by clients.
15978
15979
15980 .option tls_on_connect_ports main "string list" unset
15981 This option specifies a list of incoming SSMTP (aka SMTPS) ports that should
15982 operate the obsolete SSMTP (SMTPS) protocol, where a TLS session is immediately
15983 set up without waiting for the client to issue a STARTTLS command. For
15984 further details, see section &<<SECTsupobssmt>>&.
15985
15986
15987
15988 .option tls_privatekey main string&!! unset
15989 .cindex "TLS" "server private key; location of"
15990 The value of this option is expanded, and must then be the absolute path to a
15991 file which contains the server's private key. If this option is unset, or if
15992 the expansion is forced to fail, or the result is an empty string, the private
15993 key is assumed to be in the same file as the server's certificates. See chapter
15994 &<<CHAPTLS>>& for further details.
15995
15996 See &<<SECTtlssni>>& for discussion of when this option might be re-expanded.
15997
15998
15999 .option tls_remember_esmtp main boolean false
16000 .cindex "TLS" "esmtp state; remembering"
16001 .cindex "TLS" "broken clients"
16002 If this option is set true, Exim violates the RFCs by remembering that it is in
16003 &"esmtp"& state after successfully negotiating a TLS session. This provides
16004 support for broken clients that fail to send a new EHLO after starting a
16005 TLS session.
16006
16007
16008 .option tls_require_ciphers main string&!! unset
16009 .cindex "TLS" "requiring specific ciphers"
16010 .cindex "cipher" "requiring specific"
16011 This option controls which ciphers can be used for incoming TLS connections.
16012 The &(smtp)& transport has an option of the same name for controlling outgoing
16013 connections. This option is expanded for each connection, so can be varied for
16014 different clients if required. The value of this option must be a list of
16015 permitted cipher suites. The OpenSSL and GnuTLS libraries handle cipher control
16016 in somewhat different ways. If GnuTLS is being used, the client controls the
16017 preference order of the available ciphers. Details are given in sections
16018 &<<SECTreqciphssl>>& and &<<SECTreqciphgnu>>&.
16019
16020
16021 .option tls_try_verify_hosts main "host list&!!" unset
16022 .cindex "TLS" "client certificate verification"
16023 .cindex "certificate" "verification of client"
16024 See &%tls_verify_hosts%& below.
16025
16026
16027 .option tls_verify_certificates main string&!! unset
16028 .cindex "TLS" "client certificate verification"
16029 .cindex "certificate" "verification of client"
16030 The value of this option is expanded, and must then be the absolute path to
16031 a file containing permitted certificates for clients that
16032 match &%tls_verify_hosts%& or &%tls_try_verify_hosts%&. Alternatively, if you
16033 are using OpenSSL, you can set &%tls_verify_certificates%& to the name of a
16034 directory containing certificate files. This does not work with GnuTLS; the
16035 option must be set to the name of a single file if you are using GnuTLS.
16036
16037 These certificates should be for the certificate authorities trusted, rather
16038 than the public cert of individual clients.  With both OpenSSL and GnuTLS, if
16039 the value is a file then the certificates are sent by Exim as a server to
16040 connecting clients, defining the list of accepted certificate authorities.
16041 Thus the values defined should be considered public data.  To avoid this,
16042 use OpenSSL with a directory.
16043
16044 See &<<SECTtlssni>>& for discussion of when this option might be re-expanded.
16045
16046
16047 .option tls_verify_hosts main "host list&!!" unset
16048 .cindex "TLS" "client certificate verification"
16049 .cindex "certificate" "verification of client"
16050 This option, along with &%tls_try_verify_hosts%&, controls the checking of
16051 certificates from clients. The expected certificates are defined by
16052 &%tls_verify_certificates%&, which must be set. A configuration error occurs if
16053 either &%tls_verify_hosts%& or &%tls_try_verify_hosts%& is set and
16054 &%tls_verify_certificates%& is not set.
16055
16056 Any client that matches &%tls_verify_hosts%& is constrained by
16057 &%tls_verify_certificates%&. When the client initiates a TLS session, it must
16058 present one of the listed certificates. If it does not, the connection is
16059 aborted. &*Warning*&: Including a host in &%tls_verify_hosts%& does not require
16060 the host to use TLS. It can still send SMTP commands through unencrypted
16061 connections. Forcing a client to use TLS has to be done separately using an
16062 ACL to reject inappropriate commands when the connection is not encrypted.
16063
16064 A weaker form of checking is provided by &%tls_try_verify_hosts%&. If a client
16065 matches this option (but not &%tls_verify_hosts%&), Exim requests a
16066 certificate and checks it against &%tls_verify_certificates%&, but does not
16067 abort the connection if there is no certificate or if it does not match. This
16068 state can be detected in an ACL, which makes it possible to implement policies
16069 such as &"accept for relay only if a verified certificate has been received,
16070 but accept for local delivery if encrypted, even without a verified
16071 certificate"&.
16072
16073 Client hosts that match neither of these lists are not asked to present
16074 certificates.
16075
16076
16077 .option trusted_groups main "string list&!!" unset
16078 .cindex "trusted groups"
16079 .cindex "groups" "trusted"
16080 This option is expanded just once, at the start of Exim's processing. If this
16081 option is set, any process that is running in one of the listed groups, or
16082 which has one of them as a supplementary group, is trusted. The groups can be
16083 specified numerically or by name. See section &<<SECTtrustedadmin>>& for
16084 details of what trusted callers are permitted to do. If neither
16085 &%trusted_groups%& nor &%trusted_users%& is set, only root and the Exim user
16086 are trusted.
16087
16088 .option trusted_users main "string list&!!" unset
16089 .cindex "trusted users"
16090 .cindex "user" "trusted"
16091 This option is expanded just once, at the start of Exim's processing. If this
16092 option is set, any process that is running as one of the listed users is
16093 trusted. The users can be specified numerically or by name. See section
16094 &<<SECTtrustedadmin>>& for details of what trusted callers are permitted to do.
16095 If neither &%trusted_groups%& nor &%trusted_users%& is set, only root and the
16096 Exim user are trusted.
16097
16098 .option unknown_login main string&!! unset
16099 .cindex "uid (user id)" "unknown caller"
16100 .vindex "&$caller_uid$&"
16101 This is a specialized feature for use in unusual configurations. By default, if
16102 the uid of the caller of Exim cannot be looked up using &[getpwuid()]&, Exim
16103 gives up. The &%unknown_login%& option can be used to set a login name to be
16104 used in this circumstance. It is expanded, so values like &%user$caller_uid%&
16105 can be set. When &%unknown_login%& is used, the value of &%unknown_username%&
16106 is used for the user's real name (gecos field), unless this has been set by the
16107 &%-F%& option.
16108
16109 .option unknown_username main string unset
16110 See &%unknown_login%&.
16111
16112 .option untrusted_set_sender main "address list&!!" unset
16113 .cindex "trusted users"
16114 .cindex "sender" "setting by untrusted user"
16115 .cindex "untrusted user setting sender"
16116 .cindex "user" "untrusted setting sender"
16117 .cindex "envelope sender"
16118 When an untrusted user submits a message to Exim using the standard input, Exim
16119 normally creates an envelope sender address from the user's login and the
16120 default qualification domain. Data from the &%-f%& option (for setting envelope
16121 senders on non-SMTP messages) or the SMTP MAIL command (if &%-bs%& or &%-bS%&
16122 is used) is ignored.
16123
16124 However, untrusted users are permitted to set an empty envelope sender address,
16125 to declare that a message should never generate any bounces. For example:
16126 .code
16127 exim -f '<>' user@domain.example
16128 .endd
16129 .vindex "&$sender_ident$&"
16130 The &%untrusted_set_sender%& option allows you to permit untrusted users to set
16131 other envelope sender addresses in a controlled way. When it is set, untrusted
16132 users are allowed to set envelope sender addresses that match any of the
16133 patterns in the list. Like all address lists, the string is expanded. The
16134 identity of the user is in &$sender_ident$&, so you can, for example, restrict
16135 users to setting senders that start with their login ids
16136 followed by a hyphen
16137 by a setting like this:
16138 .code
16139 untrusted_set_sender = ^$sender_ident-
16140 .endd
16141 If you want to allow untrusted users to set envelope sender addresses without
16142 restriction, you can use
16143 .code
16144 untrusted_set_sender = *
16145 .endd
16146 The &%untrusted_set_sender%& option applies to all forms of local input, but
16147 only to the setting of the envelope sender. It does not permit untrusted users
16148 to use the other options which trusted user can use to override message
16149 parameters. Furthermore, it does not stop Exim from removing an existing
16150 &'Sender:'& header in the message, or from adding a &'Sender:'& header if
16151 necessary. See &%local_sender_retain%& and &%local_from_check%& for ways of
16152 overriding these actions. The handling of the &'Sender:'& header is also
16153 described in section &<<SECTthesenhea>>&.
16154
16155 The log line for a message's arrival shows the envelope sender following
16156 &"<="&. For local messages, the user's login always follows, after &"U="&. In
16157 &%-bp%& displays, and in the Exim monitor, if an untrusted user sets an
16158 envelope sender address, the user's login is shown in parentheses after the
16159 sender address.
16160
16161
16162 .option uucp_from_pattern main string "see below"
16163 .cindex "&""From""& line"
16164 .cindex "UUCP" "&""From""& line"
16165 Some applications that pass messages to an MTA via a command line interface use
16166 an initial line starting with &"From&~"& to pass the envelope sender. In
16167 particular, this is used by UUCP software. Exim recognizes such a line by means
16168 of a regular expression that is set in &%uucp_from_pattern%&. When the pattern
16169 matches, the sender address is constructed by expanding the contents of
16170 &%uucp_from_sender%&, provided that the caller of Exim is a trusted user. The
16171 default pattern recognizes lines in the following two forms:
16172 .code
16173 From ph10 Fri Jan  5 12:35 GMT 1996
16174 From ph10 Fri, 7 Jan 97 14:00:00 GMT
16175 .endd
16176 The pattern can be seen by running
16177 .code
16178 exim -bP uucp_from_pattern
16179 .endd
16180 It checks only up to the hours and minutes, and allows for a 2-digit or 4-digit
16181 year in the second case. The first word after &"From&~"& is matched in the
16182 regular expression by a parenthesized subpattern. The default value for
16183 &%uucp_from_sender%& is &"$1"&, which therefore just uses this first word
16184 (&"ph10"& in the example above) as the message's sender. See also
16185 &%ignore_fromline_hosts%&.
16186
16187
16188 .option uucp_from_sender main string&!! &`$1`&
16189 See &%uucp_from_pattern%& above.
16190
16191
16192 .option warn_message_file main string unset
16193 .cindex "warning of delay" "customizing the message"
16194 .cindex "customizing" "warning message"
16195 This option defines a template file containing paragraphs of text to be used
16196 for constructing the warning message which is sent by Exim when a message has
16197 been on the queue for a specified amount of time, as specified by
16198 &%delay_warning%&. Details of the file's contents are given in chapter
16199 &<<CHAPemsgcust>>&. See also &%bounce_message_file%&.
16200
16201
16202 .option write_rejectlog main boolean true
16203 .cindex "reject log" "disabling"
16204 If this option is set false, Exim no longer writes anything to the reject log.
16205 See chapter &<<CHAPlog>>& for details of what Exim writes to its logs.
16206 .ecindex IIDconfima
16207 .ecindex IIDmaiconf
16208
16209
16210
16211
16212 . ////////////////////////////////////////////////////////////////////////////
16213 . ////////////////////////////////////////////////////////////////////////////
16214
16215 .chapter "Generic options for routers" "CHAProutergeneric"
16216 .scindex IIDgenoprou1 "options" "generic; for routers"
16217 .scindex IIDgenoprou2 "generic options" "router"
16218 This chapter describes the generic options that apply to all routers.
16219 Those that are preconditions are marked with &Dagger; in the &"use"& field.
16220
16221 For a general description of how a router operates, see sections
16222 &<<SECTrunindrou>>& and &<<SECTrouprecon>>&. The latter specifies the order in
16223 which the preconditions are tested. The order of expansion of the options that
16224 provide data for a transport is: &%errors_to%&, &%headers_add%&,
16225 &%headers_remove%&, &%transport%&.
16226
16227
16228
16229 .option address_data routers string&!! unset
16230 .cindex "router" "data attached to address"
16231 The string is expanded just before the router is run, that is, after all the
16232 precondition tests have succeeded. If the expansion is forced to fail, the
16233 router declines, the value of &%address_data%& remains unchanged, and the
16234 &%more%& option controls what happens next. Other expansion failures cause
16235 delivery of the address to be deferred.
16236
16237 .vindex "&$address_data$&"
16238 When the expansion succeeds, the value is retained with the address, and can be
16239 accessed using the variable &$address_data$& in the current router, subsequent
16240 routers, and the eventual transport.
16241
16242 &*Warning*&: If the current or any subsequent router is a &(redirect)& router
16243 that runs a user's filter file, the contents of &$address_data$& are accessible
16244 in the filter. This is not normally a problem, because such data is usually
16245 either not confidential or it &"belongs"& to the current user, but if you do
16246 put confidential data into &$address_data$& you need to remember this point.
16247
16248 Even if the router declines or passes, the value of &$address_data$& remains
16249 with the address, though it can be changed by another &%address_data%& setting
16250 on a subsequent router. If a router generates child addresses, the value of
16251 &$address_data$& propagates to them. This also applies to the special kind of
16252 &"child"& that is generated by a router with the &%unseen%& option.
16253
16254 The idea of &%address_data%& is that you can use it to look up a lot of data
16255 for the address once, and then pick out parts of the data later. For example,
16256 you could use a single LDAP lookup to return a string of the form
16257 .code
16258 uid=1234 gid=5678 mailbox=/mail/xyz forward=/home/xyz/.forward
16259 .endd
16260 In the transport you could pick out the mailbox by a setting such as
16261 .code
16262 file = ${extract{mailbox}{$address_data}}
16263 .endd
16264 This makes the configuration file less messy, and also reduces the number of
16265 lookups (though Exim does cache lookups).
16266
16267 .vindex "&$sender_address_data$&"
16268 .vindex "&$address_data$&"
16269 The &%address_data%& facility is also useful as a means of passing information
16270 from one router to another, and from a router to a transport. In addition, if
16271 &$address_data$& is set by a router when verifying a recipient address from an
16272 ACL, it remains available for use in the rest of the ACL statement. After
16273 verifying a sender, the value is transferred to &$sender_address_data$&.
16274
16275
16276
16277 .option address_test routers&!? boolean true
16278 .oindex "&%-bt%&"
16279 .cindex "router" "skipping when address testing"
16280 If this option is set false, the router is skipped when routing is being tested
16281 by means of the &%-bt%& command line option. This can be a convenience when
16282 your first router sends messages to an external scanner, because it saves you
16283 having to set the &"already scanned"& indicator when testing real address
16284 routing.
16285
16286
16287
16288 .option cannot_route_message routers string&!! unset
16289 .cindex "router" "customizing &""cannot route""& message"
16290 .cindex "customizing" "&""cannot route""& message"
16291 This option specifies a text message that is used when an address cannot be
16292 routed because Exim has run out of routers. The default message is
16293 &"Unrouteable address"&. This option is useful only on routers that have
16294 &%more%& set false, or on the very last router in a configuration, because the
16295 value that is used is taken from the last router that is considered. This
16296 includes a router that is skipped because its preconditions are not met, as
16297 well as a router that declines. For example, using the default configuration,
16298 you could put:
16299 .code
16300 cannot_route_message = Remote domain not found in DNS
16301 .endd
16302 on the first router, which is a &(dnslookup)& router with &%more%& set false,
16303 and
16304 .code
16305 cannot_route_message = Unknown local user
16306 .endd
16307 on the final router that checks for local users. If string expansion fails for
16308 this option, the default message is used. Unless the expansion failure was
16309 explicitly forced, a message about the failure is written to the main and panic
16310 logs, in addition to the normal message about the routing failure.
16311
16312
16313 .option caseful_local_part routers boolean false
16314 .cindex "case of local parts"
16315 .cindex "router" "case of local parts"
16316 By default, routers handle the local parts of addresses in a case-insensitive
16317 manner, though the actual case is preserved for transmission with the message.
16318 If you want the case of letters to be significant in a router, you must set
16319 this option true. For individual router options that contain address or local
16320 part lists (for example, &%local_parts%&), case-sensitive matching can be
16321 turned on by &"+caseful"& as a list item. See section &<<SECTcasletadd>>& for
16322 more details.
16323
16324 .vindex "&$local_part$&"
16325 .vindex "&$original_local_part$&"
16326 .vindex "&$parent_local_part$&"
16327 The value of the &$local_part$& variable is forced to lower case while a
16328 router is running unless &%caseful_local_part%& is set. When a router assigns
16329 an address to a transport, the value of &$local_part$& when the transport runs
16330 is the same as it was in the router. Similarly, when a router generates child
16331 addresses by aliasing or forwarding, the values of &$original_local_part$&
16332 and &$parent_local_part$& are those that were used by the redirecting router.
16333
16334 This option applies to the processing of an address by a router. When a
16335 recipient address is being processed in an ACL, there is a separate &%control%&
16336 modifier that can be used to specify case-sensitive processing within the ACL
16337 (see section &<<SECTcontrols>>&).
16338
16339
16340
16341 .option check_local_user routers&!? boolean false
16342 .cindex "local user, checking in router"
16343 .cindex "router" "checking for local user"
16344 .cindex "&_/etc/passwd_&"
16345 .vindex "&$home$&"
16346 When this option is true, Exim checks that the local part of the recipient
16347 address (with affixes removed if relevant) is the name of an account on the
16348 local system. The check is done by calling the &[getpwnam()]& function rather
16349 than trying to read &_/etc/passwd_& directly. This means that other methods of
16350 holding password data (such as NIS) are supported. If the local part is a local
16351 user, &$home$& is set from the password data, and can be tested in other
16352 preconditions that are evaluated after this one (the order of evaluation is
16353 given in section &<<SECTrouprecon>>&). However, the value of &$home$& can be
16354 overridden by &%router_home_directory%&. If the local part is not a local user,
16355 the router is skipped.
16356
16357 If you want to check that the local part is either the name of a local user
16358 or matches something else, you cannot combine &%check_local_user%& with a
16359 setting of &%local_parts%&, because that specifies the logical &'and'& of the
16360 two conditions. However, you can use a &(passwd)& lookup in a &%local_parts%&
16361 setting to achieve this. For example:
16362 .code
16363 local_parts = passwd;$local_part : lsearch;/etc/other/users
16364 .endd
16365 Note, however, that the side effects of &%check_local_user%& (such as setting
16366 up a home directory) do not occur when a &(passwd)& lookup is used in a
16367 &%local_parts%& (or any other) precondition.
16368
16369
16370
16371 .option condition routers&!? string&!! unset
16372 .cindex "router" "customized precondition"
16373 This option specifies a general precondition test that has to succeed for the
16374 router to be called. The &%condition%& option is the last precondition to be
16375 evaluated (see section &<<SECTrouprecon>>&). The string is expanded, and if the
16376 result is a forced failure, or an empty string, or one of the strings &"0"& or
16377 &"no"& or &"false"& (checked without regard to the case of the letters), the
16378 router is skipped, and the address is offered to the next one.
16379
16380 If the result is any other value, the router is run (as this is the last
16381 precondition to be evaluated, all the other preconditions must be true).
16382
16383 This option is unusual in that multiple &%condition%& options may be present.
16384 All &%condition%& options must succeed.
16385
16386 The &%condition%& option provides a means of applying custom conditions to the
16387 running of routers. Note that in the case of a simple conditional expansion,
16388 the default expansion values are exactly what is wanted. For example:
16389 .code
16390 condition = ${if >{$message_age}{600}}
16391 .endd
16392 Because of the default behaviour of the string expansion, this is equivalent to
16393 .code
16394 condition = ${if >{$message_age}{600}{true}{}}
16395 .endd
16396
16397 A multiple condition example, which succeeds:
16398 .code
16399 condition = ${if >{$message_age}{600}}
16400 condition = ${if !eq{${lc:$local_part}}{postmaster}}
16401 condition = foobar
16402 .endd
16403
16404 If the expansion fails (other than forced failure) delivery is deferred. Some
16405 of the other precondition options are common special cases that could in fact
16406 be specified using &%condition%&.
16407
16408
16409 .option debug_print routers string&!! unset
16410 .cindex "testing" "variables in drivers"
16411 If this option is set and debugging is enabled (see the &%-d%& command line
16412 option), the string is expanded and included in the debugging output.
16413 If expansion of the string fails, the error message is written to the debugging
16414 output, and Exim carries on processing.
16415 This option is provided to help with checking out the values of variables and
16416 so on when debugging router configurations. For example, if a &%condition%&
16417 option appears not to be working, &%debug_print%& can be used to output the
16418 variables it references. The output happens after checks for &%domains%&,
16419 &%local_parts%&, and &%check_local_user%& but before any other preconditions
16420 are tested. A newline is added to the text if it does not end with one.
16421
16422
16423
16424 .option disable_logging routers boolean false
16425 If this option is set true, nothing is logged for any routing errors
16426 or for any deliveries caused by this router. You should not set this option
16427 unless you really, really know what you are doing. See also the generic
16428 transport option of the same name.
16429
16430
16431 .option domains routers&!? "domain list&!!" unset
16432 .cindex "router" "restricting to specific domains"
16433 .vindex "&$domain_data$&"
16434 If this option is set, the router is skipped unless the current domain matches
16435 the list. If the match is achieved by means of a file lookup, the data that the
16436 lookup returned for the domain is placed in &$domain_data$& for use in string
16437 expansions of the driver's private options. See section &<<SECTrouprecon>>& for
16438 a list of the order in which preconditions are evaluated.
16439
16440
16441
16442 .option driver routers string unset
16443 This option must always be set. It specifies which of the available routers is
16444 to be used.
16445
16446
16447
16448 .option errors_to routers string&!! unset
16449 .cindex "envelope sender"
16450 .cindex "router" "changing address for errors"
16451 If a router successfully handles an address, it may assign the address to a
16452 transport for delivery or it may generate child addresses. In both cases, if
16453 there is a delivery problem during later processing, the resulting bounce
16454 message is sent to the address that results from expanding this string,
16455 provided that the address verifies successfully. The &%errors_to%& option is
16456 expanded before &%headers_add%&, &%headers_remove%&, and &%transport%&.
16457
16458 The &%errors_to%& setting associated with an address can be overridden if it
16459 subsequently passes through other routers that have their own &%errors_to%&
16460 settings, or if the message is delivered by a transport with a &%return_path%&
16461 setting.
16462
16463 If &%errors_to%& is unset, or the expansion is forced to fail, or the result of
16464 the expansion fails to verify, the errors address associated with the incoming
16465 address is used. At top level, this is the envelope sender. A non-forced
16466 expansion failure causes delivery to be deferred.
16467
16468 If an address for which &%errors_to%& has been set ends up being delivered over
16469 SMTP, the envelope sender for that delivery is the &%errors_to%& value, so that
16470 any bounces that are generated by other MTAs on the delivery route are also
16471 sent there. You can set &%errors_to%& to the empty string by either of these
16472 settings:
16473 .code
16474 errors_to =
16475 errors_to = ""
16476 .endd
16477 An expansion item that yields an empty string has the same effect. If you do
16478 this, a locally detected delivery error for addresses processed by this router
16479 no longer gives rise to a bounce message; the error is discarded. If the
16480 address is delivered to a remote host, the return path is set to &`<>`&, unless
16481 overridden by the &%return_path%& option on the transport.
16482
16483 .vindex "&$address_data$&"
16484 If for some reason you want to discard local errors, but use a non-empty
16485 MAIL command for remote delivery, you can preserve the original return
16486 path in &$address_data$& in the router, and reinstate it in the transport by
16487 setting &%return_path%&.
16488
16489 The most common use of &%errors_to%& is to direct mailing list bounces to the
16490 manager of the list, as described in section &<<SECTmailinglists>>&, or to
16491 implement VERP (Variable Envelope Return Paths) (see section &<<SECTverp>>&).
16492
16493
16494
16495 .option expn routers&!? boolean true
16496 .cindex "address" "testing"
16497 .cindex "testing" "addresses"
16498 .cindex "EXPN" "router skipping"
16499 .cindex "router" "skipping for EXPN"
16500 If this option is turned off, the router is skipped when testing an address
16501 as a result of processing an SMTP EXPN command. You might, for example,
16502 want to turn it off on a router for users' &_.forward_& files, while leaving it
16503 on for the system alias file.
16504 See section &<<SECTrouprecon>>& for a list of the order in which preconditions
16505 are evaluated.
16506
16507 The use of the SMTP EXPN command is controlled by an ACL (see chapter
16508 &<<CHAPACL>>&). When Exim is running an EXPN command, it is similar to testing
16509 an address with &%-bt%&. Compare VRFY, whose counterpart is &%-bv%&.
16510
16511
16512
16513 .option fail_verify routers boolean false
16514 .cindex "router" "forcing verification failure"
16515 Setting this option has the effect of setting both &%fail_verify_sender%& and
16516 &%fail_verify_recipient%& to the same value.
16517
16518
16519
16520 .option fail_verify_recipient routers boolean false
16521 If this option is true and an address is accepted by this router when
16522 verifying a recipient, verification fails.
16523
16524
16525
16526 .option fail_verify_sender routers boolean false
16527 If this option is true and an address is accepted by this router when
16528 verifying a sender, verification fails.
16529
16530
16531
16532 .option fallback_hosts routers "string list" unset
16533 .cindex "router" "fallback hosts"
16534 .cindex "fallback" "hosts specified on router"
16535 String expansion is not applied to this option. The argument must be a
16536 colon-separated list of host names or IP addresses. The list separator can be
16537 changed (see section &<<SECTlistconstruct>>&), and a port can be specified with
16538 each name or address. In fact, the format of each item is exactly the same as
16539 defined for the list of hosts in a &(manualroute)& router (see section
16540 &<<SECTformatonehostitem>>&).
16541
16542 If a router queues an address for a remote transport, this host list is
16543 associated with the address, and used instead of the transport's fallback host
16544 list. If &%hosts_randomize%& is set on the transport, the order of the list is
16545 randomized for each use. See the &%fallback_hosts%& option of the &(smtp)&
16546 transport for further details.
16547
16548
16549 .option group routers string&!! "see below"
16550 .cindex "gid (group id)" "local delivery"
16551 .cindex "local transports" "uid and gid"
16552 .cindex "transport" "local"
16553 .cindex "router" "setting group"
16554 When a router queues an address for a transport, and the transport does not
16555 specify a group, the group given here is used when running the delivery
16556 process.
16557 The group may be specified numerically or by name. If expansion fails, the
16558 error is logged and delivery is deferred.
16559 The default is unset, unless &%check_local_user%& is set, when the default
16560 is taken from the password information. See also &%initgroups%& and &%user%&
16561 and the discussion in chapter &<<CHAPenvironment>>&.
16562
16563
16564
16565 .option headers_add routers string&!! unset
16566 .cindex "header lines" "adding"
16567 .cindex "router" "adding header lines"
16568 This option specifies a string of text that is expanded at routing time, and
16569 associated with any addresses that are accepted by the router. However, this
16570 option has no effect when an address is just being verified. The way in which
16571 the text is used to add header lines at transport time is described in section
16572 &<<SECTheadersaddrem>>&. New header lines are not actually added until the
16573 message is in the process of being transported. This means that references to
16574 header lines in string expansions in the transport's configuration do not
16575 &"see"& the added header lines.
16576
16577 The &%headers_add%& option is expanded after &%errors_to%&, but before
16578 &%headers_remove%& and &%transport%&. If the expanded string is empty, or if
16579 the expansion is forced to fail, the option has no effect. Other expansion
16580 failures are treated as configuration errors.
16581
16582 Unlike most options, &%headers_add%& can be specified multiple times
16583 for a router; all listed headers are added.
16584
16585 &*Warning 1*&: The &%headers_add%& option cannot be used for a &(redirect)&
16586 router that has the &%one_time%& option set.
16587
16588 .cindex "duplicate addresses"
16589 .oindex "&%unseen%&"
16590 &*Warning 2*&: If the &%unseen%& option is set on the router, all header
16591 additions are deleted when the address is passed on to subsequent routers.
16592 For a &%redirect%& router, if a generated address is the same as the incoming
16593 address, this can lead to duplicate addresses with different header
16594 modifications. Exim does not do duplicate deliveries (except, in certain
16595 circumstances, to pipes -- see section &<<SECTdupaddr>>&), but it is undefined
16596 which of the duplicates is discarded, so this ambiguous situation should be
16597 avoided. The &%repeat_use%& option of the &%redirect%& router may be of help.
16598
16599
16600
16601 .option headers_remove routers string&!! unset
16602 .cindex "header lines" "removing"
16603 .cindex "router" "removing header lines"
16604 This option specifies a string of text that is expanded at routing time, and
16605 associated with any addresses that are accepted by the router. However, this
16606 option has no effect when an address is just being verified. The way in which
16607 the text is used to remove header lines at transport time is described in
16608 section &<<SECTheadersaddrem>>&. Header lines are not actually removed until
16609 the message is in the process of being transported. This means that references
16610 to header lines in string expansions in the transport's configuration still
16611 &"see"& the original header lines.
16612
16613 The &%headers_remove%& option is expanded after &%errors_to%& and
16614 &%headers_add%&, but before &%transport%&. If the expansion is forced to fail,
16615 the option has no effect. Other expansion failures are treated as configuration
16616 errors.
16617
16618 Unlike most options, &%headers_remove%& can be specified multiple times
16619 for a router; all listed headers are removed.
16620
16621 &*Warning 1*&: The &%headers_remove%& option cannot be used for a &(redirect)&
16622 router that has the &%one_time%& option set.
16623
16624 &*Warning 2*&: If the &%unseen%& option is set on the router, all header
16625 removal requests are deleted when the address is passed on to subsequent
16626 routers, and this can lead to problems with duplicates -- see the similar
16627 warning for &%headers_add%& above.
16628
16629
16630 .option ignore_target_hosts routers "host list&!!" unset
16631 .cindex "IP address" "discarding"
16632 .cindex "router" "discarding IP addresses"
16633 Although this option is a host list, it should normally contain IP address
16634 entries rather than names. If any host that is looked up by the router has an
16635 IP address that matches an item in this list, Exim behaves as if that IP
16636 address did not exist. This option allows you to cope with rogue DNS entries
16637 like
16638 .code
16639 remote.domain.example.  A  127.0.0.1
16640 .endd
16641 by setting
16642 .code
16643 ignore_target_hosts = 127.0.0.1
16644 .endd
16645 on the relevant router. If all the hosts found by a &(dnslookup)& router are
16646 discarded in this way, the router declines. In a conventional configuration, an
16647 attempt to mail to such a domain would normally provoke the &"unrouteable
16648 domain"& error, and an attempt to verify an address in the domain would fail.
16649 Similarly, if &%ignore_target_hosts%& is set on an &(ipliteral)& router, the
16650 router declines if presented with one of the listed addresses.
16651
16652 You can use this option to disable the use of IPv4 or IPv6 for mail delivery by
16653 means of the first or the second of the following settings, respectively:
16654 .code
16655 ignore_target_hosts = 0.0.0.0/0
16656 ignore_target_hosts = <; 0::0/0
16657 .endd
16658 The pattern in the first line matches all IPv4 addresses, whereas the pattern
16659 in the second line matches all IPv6 addresses.
16660
16661 This option may also be useful for ignoring link-local and site-local IPv6
16662 addresses. Because, like all host lists, the value of &%ignore_target_hosts%&
16663 is expanded before use as a list, it is possible to make it dependent on the
16664 domain that is being routed.
16665
16666 .vindex "&$host_address$&"
16667 During its expansion, &$host_address$& is set to the IP address that is being
16668 checked.
16669
16670 .option initgroups routers boolean false
16671 .cindex "additional groups"
16672 .cindex "groups" "additional"
16673 .cindex "local transports" "uid and gid"
16674 .cindex "transport" "local"
16675 If the router queues an address for a transport, and this option is true, and
16676 the uid supplied by the router is not overridden by the transport, the
16677 &[initgroups()]& function is called when running the transport to ensure that
16678 any additional groups associated with the uid are set up. See also &%group%&
16679 and &%user%& and the discussion in chapter &<<CHAPenvironment>>&.
16680
16681
16682
16683 .option local_part_prefix routers&!? "string list" unset
16684 .cindex "router" "prefix for local part"
16685 .cindex "prefix" "for local part, used in router"
16686 If this option is set, the router is skipped unless the local part starts with
16687 one of the given strings, or &%local_part_prefix_optional%& is true. See
16688 section &<<SECTrouprecon>>& for a list of the order in which preconditions are
16689 evaluated.
16690
16691 The list is scanned from left to right, and the first prefix that matches is
16692 used. A limited form of wildcard is available; if the prefix begins with an
16693 asterisk, it matches the longest possible sequence of arbitrary characters at
16694 the start of the local part. An asterisk should therefore always be followed by
16695 some character that does not occur in normal local parts.
16696 .cindex "multiple mailboxes"
16697 .cindex "mailbox" "multiple"
16698 Wildcarding can be used to set up multiple user mailboxes, as described in
16699 section &<<SECTmulbox>>&.
16700
16701 .vindex "&$local_part$&"
16702 .vindex "&$local_part_prefix$&"
16703 During the testing of the &%local_parts%& option, and while the router is
16704 running, the prefix is removed from the local part, and is available in the
16705 expansion variable &$local_part_prefix$&. When a message is being delivered, if
16706 the router accepts the address, this remains true during subsequent delivery by
16707 a transport. In particular, the local part that is transmitted in the RCPT
16708 command for LMTP, SMTP, and BSMTP deliveries has the prefix removed by default.
16709 This behaviour can be overridden by setting &%rcpt_include_affixes%& true on
16710 the relevant transport.
16711
16712 When an address is being verified, &%local_part_prefix%& affects only the
16713 behaviour of the router. If the callout feature of verification is in use, this
16714 means that the full address, including the prefix, will be used during the
16715 callout.
16716
16717 The prefix facility is commonly used to handle local parts of the form
16718 &%owner-something%&. Another common use is to support local parts of the form
16719 &%real-username%& to bypass a user's &_.forward_& file &-- helpful when trying
16720 to tell a user their forwarding is broken &-- by placing a router like this one
16721 immediately before the router that handles &_.forward_& files:
16722 .code
16723 real_localuser:
16724   driver = accept
16725   local_part_prefix = real-
16726   check_local_user
16727   transport = local_delivery
16728 .endd
16729 For security, it would probably be a good idea to restrict the use of this
16730 router to locally-generated messages, using a condition such as this:
16731 .code
16732   condition = ${if match {$sender_host_address}\
16733                          {\N^(|127\.0\.0\.1)$\N}}
16734 .endd
16735
16736 If both &%local_part_prefix%& and &%local_part_suffix%& are set for a router,
16737 both conditions must be met if not optional. Care must be taken if wildcards
16738 are used in both a prefix and a suffix on the same router. Different
16739 separator characters must be used to avoid ambiguity.
16740
16741
16742 .option local_part_prefix_optional routers boolean false
16743 See &%local_part_prefix%& above.
16744
16745
16746
16747 .option local_part_suffix routers&!? "string list" unset
16748 .cindex "router" "suffix for local part"
16749 .cindex "suffix for local part" "used in router"
16750 This option operates in the same way as &%local_part_prefix%&, except that the
16751 local part must end (rather than start) with the given string, the
16752 &%local_part_suffix_optional%& option determines whether the suffix is
16753 mandatory, and the wildcard * character, if present, must be the last
16754 character of the suffix. This option facility is commonly used to handle local
16755 parts of the form &%something-request%& and multiple user mailboxes of the form
16756 &%username-foo%&.
16757
16758
16759 .option local_part_suffix_optional routers boolean false
16760 See &%local_part_suffix%& above.
16761
16762
16763
16764 .option local_parts routers&!? "local part list&!!" unset
16765 .cindex "router" "restricting to specific local parts"
16766 .cindex "local part" "checking in router"
16767 The router is run only if the local part of the address matches the list.
16768 See section &<<SECTrouprecon>>& for a list of the order in which preconditions
16769 are evaluated, and
16770 section &<<SECTlocparlis>>& for a discussion of local part lists. Because the
16771 string is expanded, it is possible to make it depend on the domain, for
16772 example:
16773 .code
16774 local_parts = dbm;/usr/local/specials/$domain
16775 .endd
16776 .vindex "&$local_part_data$&"
16777 If the match is achieved by a lookup, the data that the lookup returned
16778 for the local part is placed in the variable &$local_part_data$& for use in
16779 expansions of the router's private options. You might use this option, for
16780 example, if you have a large number of local virtual domains, and you want to
16781 send all postmaster mail to the same place without having to set up an alias in
16782 each virtual domain:
16783 .code
16784 postmaster:
16785   driver = redirect
16786   local_parts = postmaster
16787   data = postmaster@real.domain.example
16788 .endd
16789
16790
16791 .option log_as_local routers boolean "see below"
16792 .cindex "log" "delivery line"
16793 .cindex "delivery" "log line format"
16794 Exim has two logging styles for delivery, the idea being to make local
16795 deliveries stand out more visibly from remote ones. In the &"local"& style, the
16796 recipient address is given just as the local part, without a domain. The use of
16797 this style is controlled by this option. It defaults to true for the &(accept)&
16798 router, and false for all the others. This option applies only when a
16799 router assigns an address to a transport. It has no effect on routers that
16800 redirect addresses.
16801
16802
16803
16804 .option more routers boolean&!! true
16805 The result of string expansion for this option must be a valid boolean value,
16806 that is, one of the strings &"yes"&, &"no"&, &"true"&, or &"false"&. Any other
16807 result causes an error, and delivery is deferred. If the expansion is forced to
16808 fail, the default value for the option (true) is used. Other failures cause
16809 delivery to be deferred.
16810
16811 If this option is set false, and the router declines to handle the address, no
16812 further routers are tried, routing fails, and the address is bounced.
16813 .oindex "&%self%&"
16814 However, if the router explicitly passes an address to the following router by
16815 means of the setting
16816 .code
16817 self = pass
16818 .endd
16819 or otherwise, the setting of &%more%& is ignored. Also, the setting of &%more%&
16820 does not affect the behaviour if one of the precondition tests fails. In that
16821 case, the address is always passed to the next router.
16822
16823 Note that &%address_data%& is not considered to be a precondition. If its
16824 expansion is forced to fail, the router declines, and the value of &%more%&
16825 controls what happens next.
16826
16827
16828 .option pass_on_timeout routers boolean false
16829 .cindex "timeout" "of router"
16830 .cindex "router" "timeout"
16831 If a router times out during a host lookup, it normally causes deferral of the
16832 address. If &%pass_on_timeout%& is set, the address is passed on to the next
16833 router, overriding &%no_more%&. This may be helpful for systems that are
16834 intermittently connected to the Internet, or those that want to pass to a smart
16835 host any messages that cannot immediately be delivered.
16836
16837 There are occasional other temporary errors that can occur while doing DNS
16838 lookups. They are treated in the same way as a timeout, and this option
16839 applies to all of them.
16840
16841
16842
16843 .option pass_router routers string unset
16844 .cindex "router" "go to after &""pass""&"
16845 Routers that recognize the generic &%self%& option (&(dnslookup)&,
16846 &(ipliteral)&, and &(manualroute)&) are able to return &"pass"&, forcing
16847 routing to continue, and overriding a false setting of &%more%&. When one of
16848 these routers returns &"pass"&, the address is normally handed on to the next
16849 router in sequence. This can be changed by setting &%pass_router%& to the name
16850 of another router. However (unlike &%redirect_router%&) the named router must
16851 be below the current router, to avoid loops. Note that this option applies only
16852 to the special case of &"pass"&. It does not apply when a router returns
16853 &"decline"& because it cannot handle an address.
16854
16855
16856
16857 .option redirect_router routers string unset
16858 .cindex "router" "start at after redirection"
16859 Sometimes an administrator knows that it is pointless to reprocess addresses
16860 generated from alias or forward files with the same router again. For
16861 example, if an alias file translates real names into login ids there is no
16862 point searching the alias file a second time, especially if it is a large file.
16863
16864 The &%redirect_router%& option can be set to the name of any router instance.
16865 It causes the routing of any generated addresses to start at the named router
16866 instead of at the first router. This option has no effect if the router in
16867 which it is set does not generate new addresses.
16868
16869
16870
16871 .option require_files routers&!? "string list&!!" unset
16872 .cindex "file" "requiring for router"
16873 .cindex "router" "requiring file existence"
16874 This option provides a general mechanism for predicating the running of a
16875 router on the existence or non-existence of certain files or directories.
16876 Before running a router, as one of its precondition tests, Exim works its way
16877 through the &%require_files%& list, expanding each item separately.
16878
16879 Because the list is split before expansion, any colons in expansion items must
16880 be doubled, or the facility for using a different list separator must be used.
16881 If any expansion is forced to fail, the item is ignored. Other expansion
16882 failures cause routing of the address to be deferred.
16883
16884 If any expanded string is empty, it is ignored. Otherwise, except as described
16885 below, each string must be a fully qualified file path, optionally preceded by
16886 &"!"&. The paths are passed to the &[stat()]& function to test for the
16887 existence of the files or directories. The router is skipped if any paths not
16888 preceded by &"!"& do not exist, or if any paths preceded by &"!"& do exist.
16889
16890 .cindex "NFS"
16891 If &[stat()]& cannot determine whether a file exists or not, delivery of
16892 the message is deferred. This can happen when NFS-mounted filesystems are
16893 unavailable.
16894
16895 This option is checked after the &%domains%&, &%local_parts%&, and &%senders%&
16896 options, so you cannot use it to check for the existence of a file in which to
16897 look up a domain, local part, or sender. (See section &<<SECTrouprecon>>& for a
16898 full list of the order in which preconditions are evaluated.) However, as
16899 these options are all expanded, you can use the &%exists%& expansion condition
16900 to make such tests. The &%require_files%& option is intended for checking files
16901 that the router may be going to use internally, or which are needed by a
16902 transport (for example &_.procmailrc_&).
16903
16904 During delivery, the &[stat()]& function is run as root, but there is a
16905 facility for some checking of the accessibility of a file by another user.
16906 This is not a proper permissions check, but just a &"rough"& check that
16907 operates as follows:
16908
16909 If an item in a &%require_files%& list does not contain any forward slash
16910 characters, it is taken to be the user (and optional group, separated by a
16911 comma) to be checked for subsequent files in the list. If no group is specified
16912 but the user is specified symbolically, the gid associated with the uid is
16913 used. For example:
16914 .code
16915 require_files = mail:/some/file
16916 require_files = $local_part:$home/.procmailrc
16917 .endd
16918 If a user or group name in a &%require_files%& list does not exist, the
16919 &%require_files%& condition fails.
16920
16921 Exim performs the check by scanning along the components of the file path, and
16922 checking the access for the given uid and gid. It checks for &"x"& access on
16923 directories, and &"r"& access on the final file. Note that this means that file
16924 access control lists, if the operating system has them, are ignored.
16925
16926 &*Warning 1*&: When the router is being run to verify addresses for an
16927 incoming SMTP message, Exim is not running as root, but under its own uid. This
16928 may affect the result of a &%require_files%& check. In particular, &[stat()]&
16929 may yield the error EACCES (&"Permission denied"&). This means that the Exim
16930 user is not permitted to read one of the directories on the file's path.
16931
16932 &*Warning 2*&: Even when Exim is running as root while delivering a message,
16933 &[stat()]& can yield EACCES for a file in an NFS directory that is mounted
16934 without root access. In this case, if a check for access by a particular user
16935 is requested, Exim creates a subprocess that runs as that user, and tries the
16936 check again in that process.
16937
16938 The default action for handling an unresolved EACCES is to consider it to
16939 be caused by a configuration error, and routing is deferred because the
16940 existence or non-existence of the file cannot be determined. However, in some
16941 circumstances it may be desirable to treat this condition as if the file did
16942 not exist. If the file name (or the exclamation mark that precedes the file
16943 name for non-existence) is preceded by a plus sign, the EACCES error is treated
16944 as if the file did not exist. For example:
16945 .code
16946 require_files = +/some/file
16947 .endd
16948 If the router is not an essential part of verification (for example, it
16949 handles users' &_.forward_& files), another solution is to set the &%verify%&
16950 option false so that the router is skipped when verifying.
16951
16952
16953
16954 .option retry_use_local_part routers boolean "see below"
16955 .cindex "hints database" "retry keys"
16956 .cindex "local part" "in retry keys"
16957 When a delivery suffers a temporary routing failure, a retry record is created
16958 in Exim's hints database. For addresses whose routing depends only on the
16959 domain, the key for the retry record should not involve the local part, but for
16960 other addresses, both the domain and the local part should be included.
16961 Usually, remote routing is of the former kind, and local routing is of the
16962 latter kind.
16963
16964 This option controls whether the local part is used to form the key for retry
16965 hints for addresses that suffer temporary errors while being handled by this
16966 router. The default value is true for any router that has &%check_local_user%&
16967 set, and false otherwise. Note that this option does not apply to hints keys
16968 for transport delays; they are controlled by a generic transport option of the
16969 same name.
16970
16971 The setting of &%retry_use_local_part%& applies only to the router on which it
16972 appears. If the router generates child addresses, they are routed
16973 independently; this setting does not become attached to them.
16974
16975
16976
16977 .option router_home_directory routers string&!! unset
16978 .cindex "router" "home directory for"
16979 .cindex "home directory" "for router"
16980 .vindex "&$home$&"
16981 This option sets a home directory for use while the router is running. (Compare
16982 &%transport_home_directory%&, which sets a home directory for later
16983 transporting.) In particular, if used on a &(redirect)& router, this option
16984 sets a value for &$home$& while a filter is running. The value is expanded;
16985 forced expansion failure causes the option to be ignored &-- other failures
16986 cause the router to defer.
16987
16988 Expansion of &%router_home_directory%& happens immediately after the
16989 &%check_local_user%& test (if configured), before any further expansions take
16990 place.
16991 (See section &<<SECTrouprecon>>& for a list of the order in which preconditions
16992 are evaluated.)
16993 While the router is running, &%router_home_directory%& overrides the value of
16994 &$home$& that came from &%check_local_user%&.
16995
16996 When a router accepts an address and assigns it to a local transport (including
16997 the cases when a &(redirect)& router generates a pipe, file, or autoreply
16998 delivery), the home directory setting for the transport is taken from the first
16999 of these values that is set:
17000
17001 .ilist
17002 The &%home_directory%& option on the transport;
17003 .next
17004 The &%transport_home_directory%& option on the router;
17005 .next
17006 The password data if &%check_local_user%& is set on the router;
17007 .next
17008 The &%router_home_directory%& option on the router.
17009 .endlist
17010
17011 In other words, &%router_home_directory%& overrides the password data for the
17012 router, but not for the transport.
17013
17014
17015
17016 .option self routers string freeze
17017 .cindex "MX record" "pointing to local host"
17018 .cindex "local host" "MX pointing to"
17019 This option applies to those routers that use a recipient address to find a
17020 list of remote hosts. Currently, these are the &(dnslookup)&, &(ipliteral)&,
17021 and &(manualroute)& routers.
17022 Certain configurations of the &(queryprogram)& router can also specify a list
17023 of remote hosts.
17024 Usually such routers are configured to send the message to a remote host via an
17025 &(smtp)& transport. The &%self%& option specifies what happens when the first
17026 host on the list turns out to be the local host.
17027 The way in which Exim checks for the local host is described in section
17028 &<<SECTreclocipadd>>&.
17029
17030 Normally this situation indicates either an error in Exim's configuration (for
17031 example, the router should be configured not to process this domain), or an
17032 error in the DNS (for example, the MX should not point to this host). For this
17033 reason, the default action is to log the incident, defer the address, and
17034 freeze the message. The following alternatives are provided for use in special
17035 cases:
17036
17037 .vlist
17038 .vitem &%defer%&
17039 Delivery of the message is tried again later, but the message is not frozen.
17040
17041 .vitem "&%reroute%&: <&'domain'&>"
17042 The domain is changed to the given domain, and the address is passed back to
17043 be reprocessed by the routers. No rewriting of headers takes place. This
17044 behaviour is essentially a redirection.
17045
17046 .vitem "&%reroute: rewrite:%& <&'domain'&>"
17047 The domain is changed to the given domain, and the address is passed back to be
17048 reprocessed by the routers. Any headers that contain the original domain are
17049 rewritten.
17050
17051 .vitem &%pass%&
17052 .oindex "&%more%&"
17053 .vindex "&$self_hostname$&"
17054 The router passes the address to the next router, or to the router named in the
17055 &%pass_router%& option if it is set. This overrides &%no_more%&. During
17056 subsequent routing and delivery, the variable &$self_hostname$& contains the
17057 name of the local host that the router encountered. This can be used to
17058 distinguish between different cases for hosts with multiple names. The
17059 combination
17060 .code
17061 self = pass
17062 no_more
17063 .endd
17064 ensures that only those addresses that routed to the local host are passed on.
17065 Without &%no_more%&, addresses that were declined for other reasons would also
17066 be passed to the next router.
17067
17068 .vitem &%fail%&
17069 Delivery fails and an error report is generated.
17070
17071 .vitem &%send%&
17072 .cindex "local host" "sending to"
17073 The anomaly is ignored and the address is queued for the transport. This
17074 setting should be used with extreme caution. For an &(smtp)& transport, it
17075 makes sense only in cases where the program that is listening on the SMTP port
17076 is not this version of Exim. That is, it must be some other MTA, or Exim with a
17077 different configuration file that handles the domain in another way.
17078 .endlist
17079
17080
17081
17082 .option senders routers&!? "address list&!!" unset
17083 .cindex "router" "checking senders"
17084 If this option is set, the router is skipped unless the message's sender
17085 address matches something on the list.
17086 See section &<<SECTrouprecon>>& for a list of the order in which preconditions
17087 are evaluated.
17088
17089 There are issues concerning verification when the running of routers is
17090 dependent on the sender. When Exim is verifying the address in an &%errors_to%&
17091 setting, it sets the sender to the null string. When using the &%-bt%& option
17092 to check a configuration file, it is necessary also to use the &%-f%& option to
17093 set an appropriate sender. For incoming mail, the sender is unset when
17094 verifying the sender, but is available when verifying any recipients. If the
17095 SMTP VRFY command is enabled, it must be used after MAIL if the sender address
17096 matters.
17097
17098
17099 .option translate_ip_address routers string&!! unset
17100 .cindex "IP address" "translating"
17101 .cindex "packet radio"
17102 .cindex "router" "IP address translation"
17103 There exist some rare networking situations (for example, packet radio) where
17104 it is helpful to be able to translate IP addresses generated by normal routing
17105 mechanisms into other IP addresses, thus performing a kind of manual IP
17106 routing. This should be done only if the normal IP routing of the TCP/IP stack
17107 is inadequate or broken. Because this is an extremely uncommon requirement, the
17108 code to support this option is not included in the Exim binary unless
17109 SUPPORT_TRANSLATE_IP_ADDRESS=yes is set in &_Local/Makefile_&.
17110
17111 .vindex "&$host_address$&"
17112 The &%translate_ip_address%& string is expanded for every IP address generated
17113 by the router, with the generated address set in &$host_address$&. If the
17114 expansion is forced to fail, no action is taken.
17115 For any other expansion error, delivery of the message is deferred.
17116 If the result of the expansion is an IP address, that replaces the original
17117 address; otherwise the result is assumed to be a host name &-- this is looked
17118 up using &[gethostbyname()]& (or &[getipnodebyname()]& when available) to
17119 produce one or more replacement IP addresses. For example, to subvert all IP
17120 addresses in some specific networks, this could be added to a router:
17121 .code
17122 translate_ip_address = \
17123   ${lookup{${mask:$host_address/26}}lsearch{/some/file}\
17124     {$value}fail}}
17125 .endd
17126 The file would contain lines like
17127 .code
17128 10.2.3.128/26    some.host
17129 10.8.4.34/26     10.44.8.15
17130 .endd
17131 You should not make use of this facility unless you really understand what you
17132 are doing.
17133
17134
17135
17136 .option transport routers string&!! unset
17137 This option specifies the transport to be used when a router accepts an address
17138 and sets it up for delivery. A transport is never needed if a router is used
17139 only for verification. The value of the option is expanded at routing time,
17140 after the expansion of &%errors_to%&, &%headers_add%&, and &%headers_remove%&,
17141 and result must be the name of one of the configured transports. If it is not,
17142 delivery is deferred.
17143
17144 The &%transport%& option is not used by the &(redirect)& router, but it does
17145 have some private options that set up transports for pipe and file deliveries
17146 (see chapter &<<CHAPredirect>>&).
17147
17148
17149
17150 .option transport_current_directory routers string&!! unset
17151 .cindex "current directory for local transport"
17152 This option associates a current directory with any address that is routed
17153 to a local transport. This can happen either because a transport is
17154 explicitly configured for the router, or because it generates a delivery to a
17155 file or a pipe. During the delivery process (that is, at transport time), this
17156 option string is expanded and is set as the current directory, unless
17157 overridden by a setting on the transport.
17158 If the expansion fails for any reason, including forced failure, an error is
17159 logged, and delivery is deferred.
17160 See chapter &<<CHAPenvironment>>& for details of the local delivery
17161 environment.
17162
17163
17164
17165
17166 .option transport_home_directory routers string&!! "see below"
17167 .cindex "home directory" "for local transport"
17168 This option associates a home directory with any address that is routed to a
17169 local transport. This can happen either because a transport is explicitly
17170 configured for the router, or because it generates a delivery to a file or a
17171 pipe. During the delivery process (that is, at transport time), the option
17172 string is expanded and is set as the home directory, unless overridden by a
17173 setting of &%home_directory%& on the transport.
17174 If the expansion fails for any reason, including forced failure, an error is
17175 logged, and delivery is deferred.
17176
17177 If the transport does not specify a home directory, and
17178 &%transport_home_directory%& is not set for the router, the home directory for
17179 the transport is taken from the password data if &%check_local_user%& is set for
17180 the router. Otherwise it is taken from &%router_home_directory%& if that option
17181 is set; if not, no home directory is set for the transport.
17182
17183 See chapter &<<CHAPenvironment>>& for further details of the local delivery
17184 environment.
17185
17186
17187
17188
17189 .option unseen routers boolean&!! false
17190 .cindex "router" "carrying on after success"
17191 The result of string expansion for this option must be a valid boolean value,
17192 that is, one of the strings &"yes"&, &"no"&, &"true"&, or &"false"&. Any other
17193 result causes an error, and delivery is deferred. If the expansion is forced to
17194 fail, the default value for the option (false) is used. Other failures cause
17195 delivery to be deferred.
17196
17197 When this option is set true, routing does not cease if the router accepts the
17198 address. Instead, a copy of the incoming address is passed to the next router,
17199 overriding a false setting of &%more%&. There is little point in setting
17200 &%more%& false if &%unseen%& is always true, but it may be useful in cases when
17201 the value of &%unseen%& contains expansion items (and therefore, presumably, is
17202 sometimes true and sometimes false).
17203
17204 .cindex "copy of message (&%unseen%& option)"
17205 Setting the &%unseen%& option has a similar effect to the &%unseen%& command
17206 qualifier in filter files. It can be used to cause copies of messages to be
17207 delivered to some other destination, while also carrying out a normal delivery.
17208 In effect, the current address is made into a &"parent"& that has two children
17209 &-- one that is delivered as specified by this router, and a clone that goes on
17210 to be routed further. For this reason, &%unseen%& may not be combined with the
17211 &%one_time%& option in a &(redirect)& router.
17212
17213 &*Warning*&: Header lines added to the address (or specified for removal) by
17214 this router or by previous routers affect the &"unseen"& copy of the message
17215 only. The clone that continues to be processed by further routers starts with
17216 no added headers and none specified for removal. For a &%redirect%& router, if
17217 a generated address is the same as the incoming address, this can lead to
17218 duplicate addresses with different header modifications. Exim does not do
17219 duplicate deliveries (except, in certain circumstances, to pipes -- see section
17220 &<<SECTdupaddr>>&), but it is undefined which of the duplicates is discarded,
17221 so this ambiguous situation should be avoided. The &%repeat_use%& option of the
17222 &%redirect%& router may be of help.
17223
17224 Unlike the handling of header modifications, any data that was set by the
17225 &%address_data%& option in the current or previous routers &'is'& passed on to
17226 subsequent routers.
17227
17228
17229 .option user routers string&!! "see below"
17230 .cindex "uid (user id)" "local delivery"
17231 .cindex "local transports" "uid and gid"
17232 .cindex "transport" "local"
17233 .cindex "router" "user for filter processing"
17234 .cindex "filter" "user for processing"
17235 When a router queues an address for a transport, and the transport does not
17236 specify a user, the user given here is used when running the delivery process.
17237 The user may be specified numerically or by name. If expansion fails, the
17238 error is logged and delivery is deferred.
17239 This user is also used by the &(redirect)& router when running a filter file.
17240 The default is unset, except when &%check_local_user%& is set. In this case,
17241 the default is taken from the password information. If the user is specified as
17242 a name, and &%group%& is not set, the group associated with the user is used.
17243 See also &%initgroups%& and &%group%& and the discussion in chapter
17244 &<<CHAPenvironment>>&.
17245
17246
17247
17248 .option verify routers&!? boolean true
17249 Setting this option has the effect of setting &%verify_sender%& and
17250 &%verify_recipient%& to the same value.
17251
17252
17253 .option verify_only routers&!? boolean false
17254 .cindex "EXPN" "with &%verify_only%&"
17255 .oindex "&%-bv%&"
17256 .cindex "router" "used only when verifying"
17257 If this option is set, the router is used only when verifying an address,
17258 delivering in cutthrough mode or
17259 testing with the &%-bv%& option, not when actually doing a delivery, testing
17260 with the &%-bt%& option, or running the SMTP EXPN command. It can be further
17261 restricted to verifying only senders or recipients by means of
17262 &%verify_sender%& and &%verify_recipient%&.
17263
17264 &*Warning*&: When the router is being run to verify addresses for an incoming
17265 SMTP message, Exim is not running as root, but under its own uid. If the router
17266 accesses any files, you need to make sure that they are accessible to the Exim
17267 user or group.
17268
17269
17270 .option verify_recipient routers&!? boolean true
17271 If this option is false, the router is skipped when verifying recipient
17272 addresses,
17273 delivering in cutthrough mode
17274 or testing recipient verification using &%-bv%&.
17275 See section &<<SECTrouprecon>>& for a list of the order in which preconditions
17276 are evaluated.
17277
17278
17279 .option verify_sender routers&!? boolean true
17280 If this option is false, the router is skipped when verifying sender addresses
17281 or testing sender verification using &%-bvs%&.
17282 See section &<<SECTrouprecon>>& for a list of the order in which preconditions
17283 are evaluated.
17284 .ecindex IIDgenoprou1
17285 .ecindex IIDgenoprou2
17286
17287
17288
17289
17290
17291
17292 . ////////////////////////////////////////////////////////////////////////////
17293 . ////////////////////////////////////////////////////////////////////////////
17294
17295 .chapter "The accept router" "CHID4"
17296 .cindex "&(accept)& router"
17297 .cindex "routers" "&(accept)&"
17298 The &(accept)& router has no private options of its own. Unless it is being
17299 used purely for verification (see &%verify_only%&) a transport is required to
17300 be defined by the generic &%transport%& option. If the preconditions that are
17301 specified by generic options are met, the router accepts the address and queues
17302 it for the given transport. The most common use of this router is for setting
17303 up deliveries to local mailboxes. For example:
17304 .code
17305 localusers:
17306   driver = accept
17307   domains = mydomain.example
17308   check_local_user
17309   transport = local_delivery
17310 .endd
17311 The &%domains%& condition in this example checks the domain of the address, and
17312 &%check_local_user%& checks that the local part is the login of a local user.
17313 When both preconditions are met, the &(accept)& router runs, and queues the
17314 address for the &(local_delivery)& transport.
17315
17316
17317
17318
17319
17320
17321 . ////////////////////////////////////////////////////////////////////////////
17322 . ////////////////////////////////////////////////////////////////////////////
17323
17324 .chapter "The dnslookup router" "CHAPdnslookup"
17325 .scindex IIDdnsrou1 "&(dnslookup)& router"
17326 .scindex IIDdnsrou2 "routers" "&(dnslookup)&"
17327 The &(dnslookup)& router looks up the hosts that handle mail for the
17328 recipient's domain in the DNS. A transport must always be set for this router,
17329 unless &%verify_only%& is set.
17330
17331 If SRV support is configured (see &%check_srv%& below), Exim first searches for
17332 SRV records. If none are found, or if SRV support is not configured,
17333 MX records are looked up. If no MX records exist, address records are sought.
17334 However, &%mx_domains%& can be set to disable the direct use of address
17335 records.
17336
17337 MX records of equal priority are sorted by Exim into a random order. Exim then
17338 looks for address records for the host names obtained from MX or SRV records.
17339 When a host has more than one IP address, they are sorted into a random order,
17340 except that IPv6 addresses are always sorted before IPv4 addresses. If all the
17341 IP addresses found are discarded by a setting of the &%ignore_target_hosts%&
17342 generic option, the router declines.
17343
17344 Unless they have the highest priority (lowest MX value), MX records that point
17345 to the local host, or to any host name that matches &%hosts_treat_as_local%&,
17346 are discarded, together with any other MX records of equal or lower priority.
17347
17348 .cindex "MX record" "pointing to local host"
17349 .cindex "local host" "MX pointing to"
17350 .oindex "&%self%&" "in &(dnslookup)& router"
17351 If the host pointed to by the highest priority MX record, or looked up as an
17352 address record, is the local host, or matches &%hosts_treat_as_local%&, what
17353 happens is controlled by the generic &%self%& option.
17354
17355
17356 .section "Problems with DNS lookups" "SECTprowitdnsloo"
17357 There have been problems with DNS servers when SRV records are looked up.
17358 Some mis-behaving servers return a DNS error or timeout when a non-existent
17359 SRV record is sought. Similar problems have in the past been reported for
17360 MX records. The global &%dns_again_means_nonexist%& option can help with this
17361 problem, but it is heavy-handed because it is a global option.
17362
17363 For this reason, there are two options, &%srv_fail_domains%& and
17364 &%mx_fail_domains%&, that control what happens when a DNS lookup in a
17365 &(dnslookup)& router results in a DNS failure or a &"try again"& response. If
17366 an attempt to look up an SRV or MX record causes one of these results, and the
17367 domain matches the relevant list, Exim behaves as if the DNS had responded &"no
17368 such record"&. In the case of an SRV lookup, this means that the router
17369 proceeds to look for MX records; in the case of an MX lookup, it proceeds to
17370 look for A or AAAA records, unless the domain matches &%mx_domains%&, in which
17371 case routing fails.
17372
17373
17374 .section "Declining addresses by dnslookup" "SECTdnslookupdecline"
17375 .cindex "&(dnslookup)& router" "declines"
17376 There are a few cases where a &(dnslookup)& router will decline to accept
17377 an address; if such a router is expected to handle "all remaining non-local
17378 domains", then it is important to set &%no_more%&.
17379
17380 Reasons for a &(dnslookup)& router to decline currently include:
17381 .ilist
17382 The domain does not exist in DNS
17383 .next
17384 The domain exists but the MX record's host part is just "."; this is a common
17385 convention (borrowed from SRV) used to indicate that there is no such service
17386 for this domain and to not fall back to trying A/AAAA records.
17387 .next
17388 Ditto, but for SRV records, when &%check_srv%& is set on this router.
17389 .next
17390 MX record points to a non-existent host.
17391 .next
17392 MX record points to an IP address and the main section option
17393 &%allow_mx_to_ip%& is not set.
17394 .next
17395 MX records exist and point to valid hosts, but all hosts resolve only to
17396 addresses blocked by the &%ignore_target_hosts%& generic option on this router.
17397 .next
17398 The domain is not syntactically valid (see also &%allow_utf8_domains%& and
17399 &%dns_check_names_pattern%& for handling one variant of this)
17400 .next
17401 &%check_secondary_mx%& is set on this router but the local host can
17402 not be found in the MX records (see below)
17403 .endlist
17404
17405
17406
17407
17408 .section "Private options for dnslookup" "SECID118"
17409 .cindex "options" "&(dnslookup)& router"
17410 The private options for the &(dnslookup)& router are as follows:
17411
17412 .option check_secondary_mx dnslookup boolean false
17413 .cindex "MX record" "checking for secondary"
17414 If this option is set, the router declines unless the local host is found in
17415 (and removed from) the list of hosts obtained by MX lookup. This can be used to
17416 process domains for which the local host is a secondary mail exchanger
17417 differently to other domains. The way in which Exim decides whether a host is
17418 the local host is described in section &<<SECTreclocipadd>>&.
17419
17420
17421 .option check_srv dnslookup string&!! unset
17422 .cindex "SRV record" "enabling use of"
17423 The &(dnslookup)& router supports the use of SRV records (see RFC 2782) in
17424 addition to MX and address records. The support is disabled by default. To
17425 enable SRV support, set the &%check_srv%& option to the name of the service
17426 required. For example,
17427 .code
17428 check_srv = smtp
17429 .endd
17430 looks for SRV records that refer to the normal smtp service. The option is
17431 expanded, so the service name can vary from message to message or address
17432 to address. This might be helpful if SRV records are being used for a
17433 submission service. If the expansion is forced to fail, the &%check_srv%&
17434 option is ignored, and the router proceeds to look for MX records in the
17435 normal way.
17436
17437 When the expansion succeeds, the router searches first for SRV records for
17438 the given service (it assumes TCP protocol). A single SRV record with a
17439 host name that consists of just a single dot indicates &"no such service for
17440 this domain"&; if this is encountered, the router declines. If other kinds of
17441 SRV record are found, they are used to construct a host list for delivery
17442 according to the rules of RFC 2782. MX records are not sought in this case.
17443
17444 When no SRV records are found, MX records (and address records) are sought in
17445 the traditional way. In other words, SRV records take precedence over MX
17446 records, just as MX records take precedence over address records. Note that
17447 this behaviour is not sanctioned by RFC 2782, though a previous draft RFC
17448 defined it. It is apparently believed that MX records are sufficient for email
17449 and that SRV records should not be used for this purpose. However, SRV records
17450 have an additional &"weight"& feature which some people might find useful when
17451 trying to split an SMTP load between hosts of different power.
17452
17453 See section &<<SECTprowitdnsloo>>& above for a discussion of Exim's behaviour
17454 when there is a DNS lookup error.
17455
17456
17457
17458 .option mx_domains dnslookup "domain list&!!" unset
17459 .cindex "MX record" "required to exist"
17460 .cindex "SRV record" "required to exist"
17461 A domain that matches &%mx_domains%& is required to have either an MX or an SRV
17462 record in order to be recognized. (The name of this option could be improved.)
17463 For example, if all the mail hosts in &'fict.example'& are known to have MX
17464 records, except for those in &'discworld.fict.example'&, you could use this
17465 setting:
17466 .code
17467 mx_domains = ! *.discworld.fict.example : *.fict.example
17468 .endd
17469 This specifies that messages addressed to a domain that matches the list but
17470 has no MX record should be bounced immediately instead of being routed using
17471 the address record.
17472
17473
17474 .option mx_fail_domains dnslookup "domain list&!!" unset
17475 If the DNS lookup for MX records for one of the domains in this list causes a
17476 DNS lookup error, Exim behaves as if no MX records were found. See section
17477 &<<SECTprowitdnsloo>>& for more discussion.
17478
17479
17480
17481
17482 .option qualify_single dnslookup boolean true
17483 .cindex "DNS" "resolver options"
17484 .cindex "DNS" "qualifying single-component names"
17485 When this option is true, the resolver option RES_DEFNAMES is set for DNS
17486 lookups. Typically, but not standardly, this causes the resolver to qualify
17487 single-component names with the default domain. For example, on a machine
17488 called &'dictionary.ref.example'&, the domain &'thesaurus'& would be changed to
17489 &'thesaurus.ref.example'& inside the resolver. For details of what your
17490 resolver actually does, consult your man pages for &'resolver'& and
17491 &'resolv.conf'&.
17492
17493
17494
17495 .option rewrite_headers dnslookup boolean true
17496 .cindex "rewriting" "header lines"
17497 .cindex "header lines" "rewriting"
17498 If the domain name in the address that is being processed is not fully
17499 qualified, it may be expanded to its full form by a DNS lookup. For example, if
17500 an address is specified as &'dormouse@teaparty'&, the domain might be
17501 expanded to &'teaparty.wonderland.fict.example'&. Domain expansion can also
17502 occur as a result of setting the &%widen_domains%& option. If
17503 &%rewrite_headers%& is true, all occurrences of the abbreviated domain name in
17504 any &'Bcc:'&, &'Cc:'&, &'From:'&, &'Reply-to:'&, &'Sender:'&, and &'To:'&
17505 header lines of the message are rewritten with the full domain name.
17506
17507 This option should be turned off only when it is known that no message is
17508 ever going to be sent outside an environment where the abbreviation makes
17509 sense.
17510
17511 When an MX record is looked up in the DNS and matches a wildcard record, name
17512 servers normally return a record containing the name that has been looked up,
17513 making it impossible to detect whether a wildcard was present or not. However,
17514 some name servers have recently been seen to return the wildcard entry. If the
17515 name returned by a DNS lookup begins with an asterisk, it is not used for
17516 header rewriting.
17517
17518
17519 .option same_domain_copy_routing dnslookup boolean false
17520 .cindex "address" "copying routing"
17521 Addresses with the same domain are normally routed by the &(dnslookup)& router
17522 to the same list of hosts. However, this cannot be presumed, because the router
17523 options and preconditions may refer to the local part of the address. By
17524 default, therefore, Exim routes each address in a message independently. DNS
17525 servers run caches, so repeated DNS lookups are not normally expensive, and in
17526 any case, personal messages rarely have more than a few recipients.
17527
17528 If you are running mailing lists with large numbers of subscribers at the same
17529 domain, and you are using a &(dnslookup)& router which is independent of the
17530 local part, you can set &%same_domain_copy_routing%& to bypass repeated DNS
17531 lookups for identical domains in one message. In this case, when &(dnslookup)&
17532 routes an address to a remote transport, any other unrouted addresses in the
17533 message that have the same domain are automatically given the same routing
17534 without processing them independently,
17535 provided the following conditions are met:
17536
17537 .ilist
17538 No router that processed the address specified &%headers_add%& or
17539 &%headers_remove%&.
17540 .next
17541 The router did not change the address in any way, for example, by &"widening"&
17542 the domain.
17543 .endlist
17544
17545
17546
17547
17548 .option search_parents dnslookup boolean false
17549 .cindex "DNS" "resolver options"
17550 When this option is true, the resolver option RES_DNSRCH is set for DNS
17551 lookups. This is different from the &%qualify_single%& option in that it
17552 applies to domains containing dots. Typically, but not standardly, it causes
17553 the resolver to search for the name in the current domain and in parent
17554 domains. For example, on a machine in the &'fict.example'& domain, if looking
17555 up &'teaparty.wonderland'& failed, the resolver would try
17556 &'teaparty.wonderland.fict.example'&. For details of what your resolver
17557 actually does, consult your man pages for &'resolver'& and &'resolv.conf'&.
17558
17559 Setting this option true can cause problems in domains that have a wildcard MX
17560 record, because any domain that does not have its own MX record matches the
17561 local wildcard.
17562
17563
17564
17565 .option srv_fail_domains dnslookup "domain list&!!" unset
17566 If the DNS lookup for SRV records for one of the domains in this list causes a
17567 DNS lookup error, Exim behaves as if no SRV records were found. See section
17568 &<<SECTprowitdnsloo>>& for more discussion.
17569
17570
17571
17572
17573 .option widen_domains dnslookup "string list" unset
17574 .cindex "domain" "partial; widening"
17575 If a DNS lookup fails and this option is set, each of its strings in turn is
17576 added onto the end of the domain, and the lookup is tried again. For example,
17577 if
17578 .code
17579 widen_domains = fict.example:ref.example
17580 .endd
17581 is set and a lookup of &'klingon.dictionary'& fails,
17582 &'klingon.dictionary.fict.example'& is looked up, and if this fails,
17583 &'klingon.dictionary.ref.example'& is tried. Note that the &%qualify_single%&
17584 and &%search_parents%& options can cause some widening to be undertaken inside
17585 the DNS resolver. &%widen_domains%& is not applied to sender addresses
17586 when verifying, unless &%rewrite_headers%& is false (not the default).
17587
17588
17589 .section "Effect of qualify_single and search_parents" "SECID119"
17590 When a domain from an envelope recipient is changed by the resolver as a result
17591 of the &%qualify_single%& or &%search_parents%& options, Exim rewrites the
17592 corresponding address in the message's header lines unless &%rewrite_headers%&
17593 is set false. Exim then re-routes the address, using the full domain.
17594
17595 These two options affect only the DNS lookup that takes place inside the router
17596 for the domain of the address that is being routed. They do not affect lookups
17597 such as that implied by
17598 .code
17599 domains = @mx_any
17600 .endd
17601 that may happen while processing a router precondition before the router is
17602 entered. No widening ever takes place for these lookups.
17603 .ecindex IIDdnsrou1
17604 .ecindex IIDdnsrou2
17605
17606
17607
17608
17609
17610
17611
17612
17613
17614 . ////////////////////////////////////////////////////////////////////////////
17615 . ////////////////////////////////////////////////////////////////////////////
17616
17617 .chapter "The ipliteral router" "CHID5"
17618 .cindex "&(ipliteral)& router"
17619 .cindex "domain literal" "routing"
17620 .cindex "routers" "&(ipliteral)&"
17621 This router has no private options. Unless it is being used purely for
17622 verification (see &%verify_only%&) a transport is required to be defined by the
17623 generic &%transport%& option. The router accepts the address if its domain part
17624 takes the form of an RFC 2822 domain literal. For example, the &(ipliteral)&
17625 router handles the address
17626 .code
17627 root@[192.168.1.1]
17628 .endd
17629 by setting up delivery to the host with that IP address. IPv4 domain literals
17630 consist of an IPv4 address enclosed in square brackets. IPv6 domain literals
17631 are similar, but the address is preceded by &`ipv6:`&. For example:
17632 .code
17633 postmaster@[ipv6:fe80::a00:20ff:fe86:a061.5678]
17634 .endd
17635 Exim allows &`ipv4:`& before IPv4 addresses, for consistency, and on the
17636 grounds that sooner or later somebody will try it.
17637
17638 .oindex "&%self%&" "in &(ipliteral)& router"
17639 If the IP address matches something in &%ignore_target_hosts%&, the router
17640 declines. If an IP literal turns out to refer to the local host, the generic
17641 &%self%& option determines what happens.
17642
17643 The RFCs require support for domain literals; however, their use is
17644 controversial in today's Internet. If you want to use this router, you must
17645 also set the main configuration option &%allow_domain_literals%&. Otherwise,
17646 Exim will not recognize the domain literal syntax in addresses.
17647
17648
17649
17650 . ////////////////////////////////////////////////////////////////////////////
17651 . ////////////////////////////////////////////////////////////////////////////
17652
17653 .chapter "The iplookup router" "CHID6"
17654 .cindex "&(iplookup)& router"
17655 .cindex "routers" "&(iplookup)&"
17656 The &(iplookup)& router was written to fulfil a specific requirement in
17657 Cambridge University (which in fact no longer exists). For this reason, it is
17658 not included in the binary of Exim by default. If you want to include it, you
17659 must set
17660 .code
17661 ROUTER_IPLOOKUP=yes
17662 .endd
17663 in your &_Local/Makefile_& configuration file.
17664
17665 The &(iplookup)& router routes an address by sending it over a TCP or UDP
17666 connection to one or more specific hosts. The host can then return the same or
17667 a different address &-- in effect rewriting the recipient address in the
17668 message's envelope. The new address is then passed on to subsequent routers. If
17669 this process fails, the address can be passed on to other routers, or delivery
17670 can be deferred. Since &(iplookup)& is just a rewriting router, a transport
17671 must not be specified for it.
17672
17673 .cindex "options" "&(iplookup)& router"
17674 .option hosts iplookup string unset
17675 This option must be supplied. Its value is a colon-separated list of host
17676 names. The hosts are looked up using &[gethostbyname()]&
17677 (or &[getipnodebyname()]& when available)
17678 and are tried in order until one responds to the query. If none respond, what
17679 happens is controlled by &%optional%&.
17680
17681
17682 .option optional iplookup boolean false
17683 If &%optional%& is true, if no response is obtained from any host, the address
17684 is passed to the next router, overriding &%no_more%&. If &%optional%& is false,
17685 delivery to the address is deferred.
17686
17687
17688 .option port iplookup integer 0
17689 .cindex "port" "&(iplookup)& router"
17690 This option must be supplied. It specifies the port number for the TCP or UDP
17691 call.
17692
17693
17694 .option protocol iplookup string udp
17695 This option can be set to &"udp"& or &"tcp"& to specify which of the two
17696 protocols is to be used.
17697
17698
17699 .option query iplookup string&!! "see below"
17700 This defines the content of the query that is sent to the remote hosts. The
17701 default value is:
17702 .code
17703 $local_part@$domain $local_part@$domain
17704 .endd
17705 The repetition serves as a way of checking that a response is to the correct
17706 query in the default case (see &%response_pattern%& below).
17707
17708
17709 .option reroute iplookup string&!! unset
17710 If this option is not set, the rerouted address is precisely the byte string
17711 returned by the remote host, up to the first white space, if any. If set, the
17712 string is expanded to form the rerouted address. It can include parts matched
17713 in the response by &%response_pattern%& by means of numeric variables such as
17714 &$1$&, &$2$&, etc. The variable &$0$& refers to the entire input string,
17715 whether or not a pattern is in use. In all cases, the rerouted address must end
17716 up in the form &'local_part@domain'&.
17717
17718
17719 .option response_pattern iplookup string unset
17720 This option can be set to a regular expression that is applied to the string
17721 returned from the remote host. If the pattern does not match the response, the
17722 router declines. If &%response_pattern%& is not set, no checking of the
17723 response is done, unless the query was defaulted, in which case there is a
17724 check that the text returned after the first white space is the original
17725 address. This checks that the answer that has been received is in response to
17726 the correct question. For example, if the response is just a new domain, the
17727 following could be used:
17728 .code
17729 response_pattern = ^([^@]+)$
17730 reroute = $local_part@$1
17731 .endd
17732
17733 .option timeout iplookup time 5s
17734 This specifies the amount of time to wait for a response from the remote
17735 machine. The same timeout is used for the &[connect()]& function for a TCP
17736 call. It does not apply to UDP.
17737
17738
17739
17740
17741 . ////////////////////////////////////////////////////////////////////////////
17742 . ////////////////////////////////////////////////////////////////////////////
17743
17744 .chapter "The manualroute router" "CHID7"
17745 .scindex IIDmanrou1 "&(manualroute)& router"
17746 .scindex IIDmanrou2 "routers" "&(manualroute)&"
17747 .cindex "domain" "manually routing"
17748 The &(manualroute)& router is so-called because it provides a way of manually
17749 routing an address according to its domain. It is mainly used when you want to
17750 route addresses to remote hosts according to your own rules, bypassing the
17751 normal DNS routing that looks up MX records. However, &(manualroute)& can also
17752 route to local transports, a facility that may be useful if you want to save
17753 messages for dial-in hosts in local files.
17754
17755 The &(manualroute)& router compares a list of domain patterns with the domain
17756 it is trying to route. If there is no match, the router declines. Each pattern
17757 has associated with it a list of hosts and some other optional data, which may
17758 include a transport. The combination of a pattern and its data is called a
17759 &"routing rule"&. For patterns that do not have an associated transport, the
17760 generic &%transport%& option must specify a transport, unless the router is
17761 being used purely for verification (see &%verify_only%&).
17762
17763 .vindex "&$host$&"
17764 In the case of verification, matching the domain pattern is sufficient for the
17765 router to accept the address. When actually routing an address for delivery,
17766 an address that matches a domain pattern is queued for the associated
17767 transport. If the transport is not a local one, a host list must be associated
17768 with the pattern; IP addresses are looked up for the hosts, and these are
17769 passed to the transport along with the mail address. For local transports, a
17770 host list is optional. If it is present, it is passed in &$host$& as a single
17771 text string.
17772
17773 The list of routing rules can be provided as an inline string in
17774 &%route_list%&, or the data can be obtained by looking up the domain in a file
17775 or database by setting &%route_data%&. Only one of these settings may appear in
17776 any one instance of &(manualroute)&. The format of routing rules is described
17777 below, following the list of private options.
17778
17779
17780 .section "Private options for manualroute" "SECTprioptman"
17781
17782 .cindex "options" "&(manualroute)& router"
17783 The private options for the &(manualroute)& router are as follows:
17784
17785 .option host_all_ignored manualroute string defer
17786 See &%host_find_failed%&.
17787
17788 .option host_find_failed manualroute string freeze
17789 This option controls what happens when &(manualroute)& tries to find an IP
17790 address for a host, and the host does not exist. The option can be set to one
17791 of the following values:
17792 .code
17793 decline
17794 defer
17795 fail
17796 freeze
17797 ignore
17798 pass
17799 .endd
17800 The default (&"freeze"&) assumes that this state is a serious configuration
17801 error. The difference between &"pass"& and &"decline"& is that the former
17802 forces the address to be passed to the next router (or the router defined by
17803 &%pass_router%&),
17804 .oindex "&%more%&"
17805 overriding &%no_more%&, whereas the latter passes the address to the next
17806 router only if &%more%& is true.
17807
17808 The value &"ignore"& causes Exim to completely ignore a host whose IP address
17809 cannot be found. If all the hosts in the list are ignored, the behaviour is
17810 controlled by the &%host_all_ignored%& option. This takes the same values
17811 as &%host_find_failed%&, except that it cannot be set to &"ignore"&.
17812
17813 The &%host_find_failed%& option applies only to a definite &"does not exist"&
17814 state; if a host lookup gets a temporary error, delivery is deferred unless the
17815 generic &%pass_on_timeout%& option is set.
17816
17817
17818 .option hosts_randomize manualroute boolean false
17819 .cindex "randomized host list"
17820 .cindex "host" "list of; randomized"
17821 If this option is set, the order of the items in a host list in a routing rule
17822 is randomized each time the list is used, unless an option in the routing rule
17823 overrides (see below). Randomizing the order of a host list can be used to do
17824 crude load sharing. However, if more than one mail address is routed by the
17825 same router to the same host list, the host lists are considered to be the same
17826 (even though they may be randomized into different orders) for the purpose of
17827 deciding whether to batch the deliveries into a single SMTP transaction.
17828
17829 When &%hosts_randomize%& is true, a host list may be split
17830 into groups whose order is separately randomized. This makes it possible to
17831 set up MX-like behaviour. The boundaries between groups are indicated by an
17832 item that is just &`+`& in the host list. For example:
17833 .code
17834 route_list = * host1:host2:host3:+:host4:host5
17835 .endd
17836 The order of the first three hosts and the order of the last two hosts is
17837 randomized for each use, but the first three always end up before the last two.
17838 If &%hosts_randomize%& is not set, a &`+`& item in the list is ignored. If a
17839 randomized host list is passed to an &(smtp)& transport that also has
17840 &%hosts_randomize set%&, the list is not re-randomized.
17841
17842
17843 .option route_data manualroute string&!! unset
17844 If this option is set, it must expand to yield the data part of a routing rule.
17845 Typically, the expansion string includes a lookup based on the domain. For
17846 example:
17847 .code
17848 route_data = ${lookup{$domain}dbm{/etc/routes}}
17849 .endd
17850 If the expansion is forced to fail, or the result is an empty string, the
17851 router declines. Other kinds of expansion failure cause delivery to be
17852 deferred.
17853
17854
17855 .option route_list manualroute "string list" unset
17856 This string is a list of routing rules, in the form defined below. Note that,
17857 unlike most string lists, the items are separated by semicolons. This is so
17858 that they may contain colon-separated host lists.
17859
17860
17861 .option same_domain_copy_routing manualroute boolean false
17862 .cindex "address" "copying routing"
17863 Addresses with the same domain are normally routed by the &(manualroute)&
17864 router to the same list of hosts. However, this cannot be presumed, because the
17865 router options and preconditions may refer to the local part of the address. By
17866 default, therefore, Exim routes each address in a message independently. DNS
17867 servers run caches, so repeated DNS lookups are not normally expensive, and in
17868 any case, personal messages rarely have more than a few recipients.
17869
17870 If you are running mailing lists with large numbers of subscribers at the same
17871 domain, and you are using a &(manualroute)& router which is independent of the
17872 local part, you can set &%same_domain_copy_routing%& to bypass repeated DNS
17873 lookups for identical domains in one message. In this case, when
17874 &(manualroute)& routes an address to a remote transport, any other unrouted
17875 addresses in the message that have the same domain are automatically given the
17876 same routing without processing them independently. However, this is only done
17877 if &%headers_add%& and &%headers_remove%& are unset.
17878
17879
17880
17881
17882 .section "Routing rules in route_list" "SECID120"
17883 The value of &%route_list%& is a string consisting of a sequence of routing
17884 rules, separated by semicolons. If a semicolon is needed in a rule, it can be
17885 entered as two semicolons. Alternatively, the list separator can be changed as
17886 described (for colon-separated lists) in section &<<SECTlistconstruct>>&.
17887 Empty rules are ignored. The format of each rule is
17888 .display
17889 <&'domain pattern'&>  <&'list of hosts'&>  <&'options'&>
17890 .endd
17891 The following example contains two rules, each with a simple domain pattern and
17892 no options:
17893 .code
17894 route_list = \
17895   dict.ref.example  mail-1.ref.example:mail-2.ref.example ; \
17896   thes.ref.example  mail-3.ref.example:mail-4.ref.example
17897 .endd
17898 The three parts of a rule are separated by white space. The pattern and the
17899 list of hosts can be enclosed in quotes if necessary, and if they are, the
17900 usual quoting rules apply. Each rule in a &%route_list%& must start with a
17901 single domain pattern, which is the only mandatory item in the rule. The
17902 pattern is in the same format as one item in a domain list (see section
17903 &<<SECTdomainlist>>&),
17904 except that it may not be the name of an interpolated file.
17905 That is, it may be wildcarded, or a regular expression, or a file or database
17906 lookup (with semicolons doubled, because of the use of semicolon as a separator
17907 in a &%route_list%&).
17908
17909 The rules in &%route_list%& are searched in order until one of the patterns
17910 matches the domain that is being routed. The list of hosts and then options are
17911 then used as described below. If there is no match, the router declines. When
17912 &%route_list%& is set, &%route_data%& must not be set.
17913
17914
17915
17916 .section "Routing rules in route_data" "SECID121"
17917 The use of &%route_list%& is convenient when there are only a small number of
17918 routing rules. For larger numbers, it is easier to use a file or database to
17919 hold the routing information, and use the &%route_data%& option instead.
17920 The value of &%route_data%& is a list of hosts, followed by (optional) options.
17921 Most commonly, &%route_data%& is set as a string that contains an
17922 expansion lookup. For example, suppose we place two routing rules in a file
17923 like this:
17924 .code
17925 dict.ref.example:  mail-1.ref.example:mail-2.ref.example
17926 thes.ref.example:  mail-3.ref.example:mail-4.ref.example
17927 .endd
17928 This data can be accessed by setting
17929 .code
17930 route_data = ${lookup{$domain}lsearch{/the/file/name}}
17931 .endd
17932 Failure of the lookup results in an empty string, causing the router to
17933 decline. However, you do not have to use a lookup in &%route_data%&. The only
17934 requirement is that the result of expanding the string is a list of hosts,
17935 possibly followed by options, separated by white space. The list of hosts must
17936 be enclosed in quotes if it contains white space.
17937
17938
17939
17940
17941 .section "Format of the list of hosts" "SECID122"
17942 A list of hosts, whether obtained via &%route_data%& or &%route_list%&, is
17943 always separately expanded before use. If the expansion fails, the router
17944 declines. The result of the expansion must be a colon-separated list of names
17945 and/or IP addresses, optionally also including ports. The format of each item
17946 in the list is described in the next section. The list separator can be changed
17947 as described in section &<<SECTlistconstruct>>&.
17948
17949 If the list of hosts was obtained from a &%route_list%& item, the following
17950 variables are set during its expansion:
17951
17952 .ilist
17953 .cindex "numerical variables (&$1$& &$2$&  etc)" "in &(manualroute)& router"
17954 If the domain was matched against a regular expression, the numeric variables
17955 &$1$&, &$2$&, etc. may be set. For example:
17956 .code
17957 route_list = ^domain(\d+)   host-$1.text.example
17958 .endd
17959 .next
17960 &$0$& is always set to the entire domain.
17961 .next
17962 &$1$& is also set when partial matching is done in a file lookup.
17963
17964 .next
17965 .vindex "&$value$&"
17966 If the pattern that matched the domain was a lookup item, the data that was
17967 looked up is available in the expansion variable &$value$&. For example:
17968 .code
17969 route_list = lsearch;;/some/file.routes  $value
17970 .endd
17971 .endlist
17972
17973 Note the doubling of the semicolon in the pattern that is necessary because
17974 semicolon is the default route list separator.
17975
17976
17977
17978 .section "Format of one host item" "SECTformatonehostitem"
17979 Each item in the list of hosts is either a host name or an IP address,
17980 optionally with an attached port number. When no port is given, an IP address
17981 is not enclosed in brackets. When a port is specified, it overrides the port
17982 specification on the transport. The port is separated from the name or address
17983 by a colon. This leads to some complications:
17984
17985 .ilist
17986 Because colon is the default separator for the list of hosts, either
17987 the colon that specifies a port must be doubled, or the list separator must
17988 be changed. The following two examples have the same effect:
17989 .code
17990 route_list = * "host1.tld::1225 : host2.tld::1226"
17991 route_list = * "<+ host1.tld:1225 + host2.tld:1226"
17992 .endd
17993 .next
17994 When IPv6 addresses are involved, it gets worse, because they contain
17995 colons of their own. To make this case easier, it is permitted to
17996 enclose an IP address (either v4 or v6) in square brackets if a port
17997 number follows. For example:
17998 .code
17999 route_list = * "</ [10.1.1.1]:1225 / [::1]:1226"
18000 .endd
18001 .endlist
18002
18003 .section "How the list of hosts is used" "SECThostshowused"
18004 When an address is routed to an &(smtp)& transport by &(manualroute)&, each of
18005 the hosts is tried, in the order specified, when carrying out the SMTP
18006 delivery. However, the order can be changed by setting the &%hosts_randomize%&
18007 option, either on the router (see section &<<SECTprioptman>>& above), or on the
18008 transport.
18009
18010 Hosts may be listed by name or by IP address. An unadorned name in the list of
18011 hosts is interpreted as a host name. A name that is followed by &`/MX`& is
18012 interpreted as an indirection to a sublist of hosts obtained by looking up MX
18013 records in the DNS. For example:
18014 .code
18015 route_list = *  x.y.z:p.q.r/MX:e.f.g
18016 .endd
18017 If this feature is used with a port specifier, the port must come last. For
18018 example:
18019 .code
18020 route_list = *  dom1.tld/mx::1225
18021 .endd
18022 If the &%hosts_randomize%& option is set, the order of the items in the list is
18023 randomized before any lookups are done. Exim then scans the list; for any name
18024 that is not followed by &`/MX`& it looks up an IP address. If this turns out to
18025 be an interface on the local host and the item is not the first in the list,
18026 Exim discards it and any subsequent items. If it is the first item, what
18027 happens is controlled by the
18028 .oindex "&%self%&" "in &(manualroute)& router"
18029 &%self%& option of the router.
18030
18031 A name on the list that is followed by &`/MX`& is replaced with the list of
18032 hosts obtained by looking up MX records for the name. This is always a DNS
18033 lookup; the &%bydns%& and &%byname%& options (see section &<<SECThowoptused>>&
18034 below) are not relevant here. The order of these hosts is determined by the
18035 preference values in the MX records, according to the usual rules. Because
18036 randomizing happens before the MX lookup, it does not affect the order that is
18037 defined by MX preferences.
18038
18039 If the local host is present in the sublist obtained from MX records, but is
18040 not the most preferred host in that list, it and any equally or less
18041 preferred hosts are removed before the sublist is inserted into the main list.
18042
18043 If the local host is the most preferred host in the MX list, what happens
18044 depends on where in the original list of hosts the &`/MX`& item appears. If it
18045 is not the first item (that is, there are previous hosts in the main list),
18046 Exim discards this name and any subsequent items in the main list.
18047
18048 If the MX item is first in the list of hosts, and the local host is the
18049 most preferred host, what happens is controlled by the &%self%& option of the
18050 router.
18051
18052 DNS failures when lookup up the MX records are treated in the same way as DNS
18053 failures when looking up IP addresses: &%pass_on_timeout%& and
18054 &%host_find_failed%& are used when relevant.
18055
18056 The generic &%ignore_target_hosts%& option applies to all hosts in the list,
18057 whether obtained from an MX lookup or not.
18058
18059
18060
18061 .section "How the options are used" "SECThowoptused"
18062 The options are a sequence of words; in practice no more than three are ever
18063 present. One of the words can be the name of a transport; this overrides the
18064 &%transport%& option on the router for this particular routing rule only. The
18065 other words (if present) control randomization of the list of hosts on a
18066 per-rule basis, and how the IP addresses of the hosts are to be found when
18067 routing to a remote transport. These options are as follows:
18068
18069 .ilist
18070 &%randomize%&: randomize the order of the hosts in this list, overriding the
18071 setting of &%hosts_randomize%& for this routing rule only.
18072 .next
18073 &%no_randomize%&: do not randomize the order of the hosts in this list,
18074 overriding the setting of &%hosts_randomize%& for this routing rule only.
18075 .next
18076 &%byname%&: use &[getipnodebyname()]& (&[gethostbyname()]& on older systems) to
18077 find IP addresses. This function may ultimately cause a DNS lookup, but it may
18078 also look in &_/etc/hosts_& or other sources of information.
18079 .next
18080 &%bydns%&: look up address records for the hosts directly in the DNS; fail if
18081 no address records are found. If there is a temporary DNS error (such as a
18082 timeout), delivery is deferred.
18083 .endlist
18084
18085 For example:
18086 .code
18087 route_list = domain1  host1:host2:host3  randomize bydns;\
18088              domain2  host4:host5
18089 .endd
18090 If neither &%byname%& nor &%bydns%& is given, Exim behaves as follows: First, a
18091 DNS lookup is done. If this yields anything other than HOST_NOT_FOUND, that
18092 result is used. Otherwise, Exim goes on to try a call to &[getipnodebyname()]&
18093 or &[gethostbyname()]&, and the result of the lookup is the result of that
18094 call.
18095
18096 &*Warning*&: It has been discovered that on some systems, if a DNS lookup
18097 called via &[getipnodebyname()]& times out, HOST_NOT_FOUND is returned
18098 instead of TRY_AGAIN. That is why the default action is to try a DNS
18099 lookup first. Only if that gives a definite &"no such host"& is the local
18100 function called.
18101
18102
18103
18104 If no IP address for a host can be found, what happens is controlled by the
18105 &%host_find_failed%& option.
18106
18107 .vindex "&$host$&"
18108 When an address is routed to a local transport, IP addresses are not looked up.
18109 The host list is passed to the transport in the &$host$& variable.
18110
18111
18112
18113 .section "Manualroute examples" "SECID123"
18114 In some of the examples that follow, the presence of the &%remote_smtp%&
18115 transport, as defined in the default configuration file, is assumed:
18116
18117 .ilist
18118 .cindex "smart host" "example router"
18119 The &(manualroute)& router can be used to forward all external mail to a
18120 &'smart host'&. If you have set up, in the main part of the configuration, a
18121 named domain list that contains your local domains, for example:
18122 .code
18123 domainlist local_domains = my.domain.example
18124 .endd
18125 You can arrange for all other domains to be routed to a smart host by making
18126 your first router something like this:
18127 .code
18128 smart_route:
18129   driver = manualroute
18130   domains = !+local_domains
18131   transport = remote_smtp
18132   route_list = * smarthost.ref.example
18133 .endd
18134 This causes all non-local addresses to be sent to the single host
18135 &'smarthost.ref.example'&. If a colon-separated list of smart hosts is given,
18136 they are tried in order
18137 (but you can use &%hosts_randomize%& to vary the order each time).
18138 Another way of configuring the same thing is this:
18139 .code
18140 smart_route:
18141   driver = manualroute
18142   transport = remote_smtp
18143   route_list = !+local_domains  smarthost.ref.example
18144 .endd
18145 There is no difference in behaviour between these two routers as they stand.
18146 However, they behave differently if &%no_more%& is added to them. In the first
18147 example, the router is skipped if the domain does not match the &%domains%&
18148 precondition; the following router is always tried. If the router runs, it
18149 always matches the domain and so can never decline. Therefore, &%no_more%&
18150 would have no effect. In the second case, the router is never skipped; it
18151 always runs. However, if it doesn't match the domain, it declines. In this case
18152 &%no_more%& would prevent subsequent routers from running.
18153
18154 .next
18155 .cindex "mail hub example"
18156 A &'mail hub'& is a host which receives mail for a number of domains via MX
18157 records in the DNS and delivers it via its own private routing mechanism. Often
18158 the final destinations are behind a firewall, with the mail hub being the one
18159 machine that can connect to machines both inside and outside the firewall. The
18160 &(manualroute)& router is usually used on a mail hub to route incoming messages
18161 to the correct hosts. For a small number of domains, the routing can be inline,
18162 using the &%route_list%& option, but for a larger number a file or database
18163 lookup is easier to manage.
18164
18165 If the domain names are in fact the names of the machines to which the mail is
18166 to be sent by the mail hub, the configuration can be quite simple. For
18167 example:
18168 .code
18169 hub_route:
18170   driver = manualroute
18171   transport = remote_smtp
18172   route_list = *.rhodes.tvs.example  $domain
18173 .endd
18174 This configuration routes domains that match &`*.rhodes.tvs.example`& to hosts
18175 whose names are the same as the mail domains. A similar approach can be taken
18176 if the host name can be obtained from the domain name by a string manipulation
18177 that the expansion facilities can handle. Otherwise, a lookup based on the
18178 domain can be used to find the host:
18179 .code
18180 through_firewall:
18181   driver = manualroute
18182   transport = remote_smtp
18183   route_data = ${lookup {$domain} cdb {/internal/host/routes}}
18184 .endd
18185 The result of the lookup must be the name or IP address of the host (or
18186 hosts) to which the address is to be routed. If the lookup fails, the route
18187 data is empty, causing the router to decline. The address then passes to the
18188 next router.
18189
18190 .next
18191 .cindex "batched SMTP output example"
18192 .cindex "SMTP" "batched outgoing; example"
18193 You can use &(manualroute)& to deliver messages to pipes or files in batched
18194 SMTP format for onward transportation by some other means. This is one way of
18195 storing mail for a dial-up host when it is not connected. The route list entry
18196 can be as simple as a single domain name in a configuration like this:
18197 .code
18198 save_in_file:
18199   driver = manualroute
18200   transport = batchsmtp_appendfile
18201   route_list = saved.domain.example
18202 .endd
18203 though often a pattern is used to pick up more than one domain. If there are
18204 several domains or groups of domains with different transport requirements,
18205 different transports can be listed in the routing information:
18206 .code
18207 save_in_file:
18208   driver = manualroute
18209   route_list = \
18210     *.saved.domain1.example  $domain  batch_appendfile; \
18211     *.saved.domain2.example  \
18212       ${lookup{$domain}dbm{/domain2/hosts}{$value}fail} \
18213       batch_pipe
18214 .endd
18215 .vindex "&$domain$&"
18216 .vindex "&$host$&"
18217 The first of these just passes the domain in the &$host$& variable, which
18218 doesn't achieve much (since it is also in &$domain$&), but the second does a
18219 file lookup to find a value to pass, causing the router to decline to handle
18220 the address if the lookup fails.
18221
18222 .next
18223 .cindex "UUCP" "example of router for"
18224 Routing mail directly to UUCP software is a specific case of the use of
18225 &(manualroute)& in a gateway to another mail environment. This is an example of
18226 one way it can be done:
18227 .code
18228 # Transport
18229 uucp:
18230   driver = pipe
18231   user = nobody
18232   command = /usr/local/bin/uux -r - \
18233     ${substr_-5:$host}!rmail ${local_part}
18234   return_fail_output = true
18235
18236 # Router
18237 uucphost:
18238   transport = uucp
18239   driver = manualroute
18240   route_data = \
18241     ${lookup{$domain}lsearch{/usr/local/exim/uucphosts}}
18242 .endd
18243 The file &_/usr/local/exim/uucphosts_& contains entries like
18244 .code
18245 darksite.ethereal.example:           darksite.UUCP
18246 .endd
18247 It can be set up more simply without adding and removing &".UUCP"& but this way
18248 makes clear the distinction between the domain name
18249 &'darksite.ethereal.example'& and the UUCP host name &'darksite'&.
18250 .endlist
18251 .ecindex IIDmanrou1
18252 .ecindex IIDmanrou2
18253
18254
18255
18256
18257
18258
18259
18260
18261 . ////////////////////////////////////////////////////////////////////////////
18262 . ////////////////////////////////////////////////////////////////////////////
18263
18264 .chapter "The queryprogram router" "CHAPdriverlast"
18265 .scindex IIDquerou1 "&(queryprogram)& router"
18266 .scindex IIDquerou2 "routers" "&(queryprogram)&"
18267 .cindex "routing" "by external program"
18268 The &(queryprogram)& router routes an address by running an external command
18269 and acting on its output. This is an expensive way to route, and is intended
18270 mainly for use in lightly-loaded systems, or for performing experiments.
18271 However, if it is possible to use the precondition options (&%domains%&,
18272 &%local_parts%&, etc) to skip this router for most addresses, it could sensibly
18273 be used in special cases, even on a busy host. There are the following private
18274 options:
18275 .cindex "options" "&(queryprogram)& router"
18276
18277 .option command queryprogram string&!! unset
18278 This option must be set. It specifies the command that is to be run. The
18279 command is split up into a command name and arguments, and then each is
18280 expanded separately (exactly as for a &(pipe)& transport, described in chapter
18281 &<<CHAPpipetransport>>&).
18282
18283
18284 .option command_group queryprogram string unset
18285 .cindex "gid (group id)" "in &(queryprogram)& router"
18286 This option specifies a gid to be set when running the command while routing an
18287 address for deliver. It must be set if &%command_user%& specifies a numerical
18288 uid. If it begins with a digit, it is interpreted as the numerical value of the
18289 gid. Otherwise it is looked up using &[getgrnam()]&.
18290
18291
18292 .option command_user queryprogram string unset
18293 .cindex "uid (user id)" "for &(queryprogram)&"
18294 This option must be set. It specifies the uid which is set when running the
18295 command while routing an address for delivery. If the value begins with a digit,
18296 it is interpreted as the numerical value of the uid. Otherwise, it is looked up
18297 using &[getpwnam()]& to obtain a value for the uid and, if &%command_group%& is
18298 not set, a value for the gid also.
18299
18300 &*Warning:*& Changing uid and gid is possible only when Exim is running as
18301 root, which it does during a normal delivery in a conventional configuration.
18302 However, when an address is being verified during message reception, Exim is
18303 usually running as the Exim user, not as root. If the &(queryprogram)& router
18304 is called from a non-root process, Exim cannot change uid or gid before running
18305 the command. In this circumstance the command runs under the current uid and
18306 gid.
18307
18308
18309 .option current_directory queryprogram string /
18310 This option specifies an absolute path which is made the current directory
18311 before running the command.
18312
18313
18314 .option timeout queryprogram time 1h
18315 If the command does not complete within the timeout period, its process group
18316 is killed and the message is frozen. A value of zero time specifies no
18317 timeout.
18318
18319
18320 The standard output of the command is connected to a pipe, which is read when
18321 the command terminates. It should consist of a single line of output,
18322 containing up to five fields, separated by white space. The maximum length of
18323 the line is 1023 characters. Longer lines are silently truncated. The first
18324 field is one of the following words (case-insensitive):
18325
18326 .ilist
18327 &'Accept'&: routing succeeded; the remaining fields specify what to do (see
18328 below).
18329 .next
18330 &'Decline'&: the router declines; pass the address to the next router, unless
18331 &%no_more%& is set.
18332 .next
18333 &'Fail'&: routing failed; do not pass the address to any more routers. Any
18334 subsequent text on the line is an error message. If the router is run as part
18335 of address verification during an incoming SMTP message, the message is
18336 included in the SMTP response.
18337 .next
18338 &'Defer'&: routing could not be completed at this time; try again later. Any
18339 subsequent text on the line is an error message which is logged. It is not
18340 included in any SMTP response.
18341 .next
18342 &'Freeze'&: the same as &'defer'&, except that the message is frozen.
18343 .next
18344 &'Pass'&: pass the address to the next router (or the router specified by
18345 &%pass_router%&), overriding &%no_more%&.
18346 .next
18347 &'Redirect'&: the message is redirected. The remainder of the line is a list of
18348 new addresses, which are routed independently, starting with the first router,
18349 or the router specified by &%redirect_router%&, if set.
18350 .endlist
18351
18352 When the first word is &'accept'&, the remainder of the line consists of a
18353 number of keyed data values, as follows (split into two lines here, to fit on
18354 the page):
18355 .code
18356 ACCEPT TRANSPORT=<transport> HOSTS=<list of hosts>
18357 LOOKUP=byname|bydns DATA=<text>
18358 .endd
18359 The data items can be given in any order, and all are optional. If no transport
18360 is included, the transport specified by the generic &%transport%& option is
18361 used. The list of hosts and the lookup type are needed only if the transport is
18362 an &(smtp)& transport that does not itself supply a list of hosts.
18363
18364 The format of the list of hosts is the same as for the &(manualroute)& router.
18365 As well as host names and IP addresses with optional port numbers, as described
18366 in section &<<SECTformatonehostitem>>&, it may contain names followed by
18367 &`/MX`& to specify sublists of hosts that are obtained by looking up MX records
18368 (see section &<<SECThostshowused>>&).
18369
18370 If the lookup type is not specified, Exim behaves as follows when trying to
18371 find an IP address for each host: First, a DNS lookup is done. If this yields
18372 anything other than HOST_NOT_FOUND, that result is used. Otherwise, Exim
18373 goes on to try a call to &[getipnodebyname()]& or &[gethostbyname()]&, and the
18374 result of the lookup is the result of that call.
18375
18376 .vindex "&$address_data$&"
18377 If the DATA field is set, its value is placed in the &$address_data$&
18378 variable. For example, this return line
18379 .code
18380 accept hosts=x1.y.example:x2.y.example data="rule1"
18381 .endd
18382 routes the address to the default transport, passing a list of two hosts. When
18383 the transport runs, the string &"rule1"& is in &$address_data$&.
18384 .ecindex IIDquerou1
18385 .ecindex IIDquerou2
18386
18387
18388
18389
18390 . ////////////////////////////////////////////////////////////////////////////
18391 . ////////////////////////////////////////////////////////////////////////////
18392
18393 .chapter "The redirect router" "CHAPredirect"
18394 .scindex IIDredrou1 "&(redirect)& router"
18395 .scindex IIDredrou2 "routers" "&(redirect)&"
18396 .cindex "alias file" "in a &(redirect)& router"
18397 .cindex "address redirection" "&(redirect)& router"
18398 The &(redirect)& router handles several kinds of address redirection. Its most
18399 common uses are for resolving local part aliases from a central alias file
18400 (usually called &_/etc/aliases_&) and for handling users' personal &_.forward_&
18401 files, but it has many other potential uses. The incoming address can be
18402 redirected in several different ways:
18403
18404 .ilist
18405 It can be replaced by one or more new addresses which are themselves routed
18406 independently.
18407 .next
18408 It can be routed to be delivered to a given file or directory.
18409 .next
18410 It can be routed to be delivered to a specified pipe command.
18411 .next
18412 It can cause an automatic reply to be generated.
18413 .next
18414 It can be forced to fail, optionally with a custom error message.
18415 .next
18416 It can be temporarily deferred, optionally with a custom message.
18417 .next
18418 It can be discarded.
18419 .endlist
18420
18421 The generic &%transport%& option must not be set for &(redirect)& routers.
18422 However, there are some private options which define transports for delivery to
18423 files and pipes, and for generating autoreplies. See the &%file_transport%&,
18424 &%pipe_transport%& and &%reply_transport%& descriptions below.
18425
18426
18427
18428 .section "Redirection data" "SECID124"
18429 The router operates by interpreting a text string which it obtains either by
18430 expanding the contents of the &%data%& option, or by reading the entire
18431 contents of a file whose name is given in the &%file%& option. These two
18432 options are mutually exclusive. The first is commonly used for handling system
18433 aliases, in a configuration like this:
18434 .code
18435 system_aliases:
18436   driver = redirect
18437   data = ${lookup{$local_part}lsearch{/etc/aliases}}
18438 .endd
18439 If the lookup fails, the expanded string in this example is empty. When the
18440 expansion of &%data%& results in an empty string, the router declines. A forced
18441 expansion failure also causes the router to decline; other expansion failures
18442 cause delivery to be deferred.
18443
18444 A configuration using &%file%& is commonly used for handling users'
18445 &_.forward_& files, like this:
18446 .code
18447 userforward:
18448   driver = redirect
18449   check_local_user
18450   file = $home/.forward
18451   no_verify
18452 .endd
18453 If the file does not exist, or causes no action to be taken (for example, it is
18454 empty or consists only of comments), the router declines. &*Warning*&: This
18455 is not the case when the file contains syntactically valid items that happen to
18456 yield empty addresses, for example, items containing only RFC 2822 address
18457 comments.
18458
18459
18460
18461 .section "Forward files and address verification" "SECID125"
18462 .cindex "address redirection" "while verifying"
18463 It is usual to set &%no_verify%& on &(redirect)& routers which handle users'
18464 &_.forward_& files, as in the example above. There are two reasons for this:
18465
18466 .ilist
18467 When Exim is receiving an incoming SMTP message from a remote host, it is
18468 running under the Exim uid, not as root. Exim is unable to change uid to read
18469 the file as the user, and it may not be able to read it as the Exim user. So in
18470 practice the router may not be able to operate.
18471 .next
18472 However, even when the router can operate, the existence of a &_.forward_& file
18473 is unimportant when verifying an address. What should be checked is whether the
18474 local part is a valid user name or not. Cutting out the redirection processing
18475 saves some resources.
18476 .endlist
18477
18478
18479
18480
18481
18482
18483 .section "Interpreting redirection data" "SECID126"
18484 .cindex "Sieve filter" "specifying in redirection data"
18485 .cindex "filter" "specifying in redirection data"
18486 The contents of the data string, whether obtained from &%data%& or &%file%&,
18487 can be interpreted in two different ways:
18488
18489 .ilist
18490 If the &%allow_filter%& option is set true, and the data begins with the text
18491 &"#Exim filter"& or &"#Sieve filter"&, it is interpreted as a list of
18492 &'filtering'& instructions in the form of an Exim or Sieve filter file,
18493 respectively. Details of the syntax and semantics of filter files are described
18494 in a separate document entitled &'Exim's interfaces to mail filtering'&; this
18495 document is intended for use by end users.
18496 .next
18497 Otherwise, the data must be a comma-separated list of redirection items, as
18498 described in the next section.
18499 .endlist
18500
18501 When a message is redirected to a file (a &"mail folder"&), the file name given
18502 in a non-filter redirection list must always be an absolute path. A filter may
18503 generate a relative path &-- how this is handled depends on the transport's
18504 configuration. See section &<<SECTfildiropt>>& for a discussion of this issue
18505 for the &(appendfile)& transport.
18506
18507
18508
18509 .section "Items in a non-filter redirection list" "SECTitenonfilred"
18510 .cindex "address redirection" "non-filter list items"
18511 When the redirection data is not an Exim or Sieve filter, for example, if it
18512 comes from a conventional alias or forward file, it consists of a list of
18513 addresses, file names, pipe commands, or certain special items (see section
18514 &<<SECTspecitredli>>& below). The special items can be individually enabled or
18515 disabled by means of options whose names begin with &%allow_%& or &%forbid_%&,
18516 depending on their default values. The items in the list are separated by
18517 commas or newlines.
18518 If a comma is required in an item, the entire item must be enclosed in double
18519 quotes.
18520
18521 Lines starting with a # character are comments, and are ignored, and # may
18522 also appear following a comma, in which case everything between the # and the
18523 next newline character is ignored.
18524
18525 If an item is entirely enclosed in double quotes, these are removed. Otherwise
18526 double quotes are retained because some forms of mail address require their use
18527 (but never to enclose the entire address). In the following description,
18528 &"item"& refers to what remains after any surrounding double quotes have been
18529 removed.
18530
18531 .vindex "&$local_part$&"
18532 &*Warning*&: If you use an Exim expansion to construct a redirection address,
18533 and the expansion contains a reference to &$local_part$&, you should make use
18534 of the &%quote_local_part%& expansion operator, in case the local part contains
18535 special characters. For example, to redirect all mail for the domain
18536 &'obsolete.example'&, retaining the existing local part, you could use this
18537 setting:
18538 .code
18539 data = ${quote_local_part:$local_part}@newdomain.example
18540 .endd
18541
18542
18543 .section "Redirecting to a local mailbox" "SECTredlocmai"
18544 .cindex "routing" "loops in"
18545 .cindex "loop" "while routing, avoidance of"
18546 .cindex "address redirection" "to local mailbox"
18547 A redirection item may safely be the same as the address currently under
18548 consideration. This does not cause a routing loop, because a router is
18549 automatically skipped if any ancestor of the address that is being processed
18550 is the same as the current address and was processed by the current router.
18551 Such an address is therefore passed to the following routers, so it is handled
18552 as if there were no redirection. When making this loop-avoidance test, the
18553 complete local part, including any prefix or suffix, is used.
18554
18555 .cindex "address redirection" "local part without domain"
18556 Specifying the same local part without a domain is a common usage in personal
18557 filter files when the user wants to have messages delivered to the local
18558 mailbox and also forwarded elsewhere. For example, the user whose login is
18559 &'cleo'& might have a &_.forward_& file containing this:
18560 .code
18561 cleo, cleopatra@egypt.example
18562 .endd
18563 .cindex "backslash in alias file"
18564 .cindex "alias file" "backslash in"
18565 For compatibility with other MTAs, such unqualified local parts may be
18566 preceded by &"\"&, but this is not a requirement for loop prevention. However,
18567 it does make a difference if more than one domain is being handled
18568 synonymously.
18569
18570 If an item begins with &"\"& and the rest of the item parses as a valid RFC
18571 2822 address that does not include a domain, the item is qualified using the
18572 domain of the incoming address. In the absence of a leading &"\"&, unqualified
18573 addresses are qualified using the value in &%qualify_recipient%&, but you can
18574 force the incoming domain to be used by setting &%qualify_preserve_domain%&.
18575
18576 Care must be taken if there are alias names for local users.
18577 Consider an MTA handling a single local domain where the system alias file
18578 contains:
18579 .code
18580 Sam.Reman: spqr
18581 .endd
18582 Now suppose that Sam (whose login id is &'spqr'&) wants to save copies of
18583 messages in the local mailbox, and also forward copies elsewhere. He creates
18584 this forward file:
18585 .code
18586 Sam.Reman, spqr@reme.elsewhere.example
18587 .endd
18588 With these settings, an incoming message addressed to &'Sam.Reman'& fails. The
18589 &(redirect)& router for system aliases does not process &'Sam.Reman'& the
18590 second time round, because it has previously routed it,
18591 and the following routers presumably cannot handle the alias. The forward file
18592 should really contain
18593 .code
18594 spqr, spqr@reme.elsewhere.example
18595 .endd
18596 but because this is such a common error, the &%check_ancestor%& option (see
18597 below) exists to provide a way to get round it. This is normally set on a
18598 &(redirect)& router that is handling users' &_.forward_& files.
18599
18600
18601
18602 .section "Special items in redirection lists" "SECTspecitredli"
18603 In addition to addresses, the following types of item may appear in redirection
18604 lists (that is, in non-filter redirection data):
18605
18606 .ilist
18607 .cindex "pipe" "in redirection list"
18608 .cindex "address redirection" "to pipe"
18609 An item is treated as a pipe command if it begins with &"|"& and does not parse
18610 as a valid RFC 2822 address that includes a domain. A transport for running the
18611 command must be specified by the &%pipe_transport%& option.
18612 Normally, either the router or the transport specifies a user and a group under
18613 which to run the delivery. The default is to use the Exim user and group.
18614
18615 Single or double quotes can be used for enclosing the individual arguments of
18616 the pipe command; no interpretation of escapes is done for single quotes. If
18617 the command contains a comma character, it is necessary to put the whole item
18618 in double quotes, for example:
18619 .code
18620 "|/some/command ready,steady,go"
18621 .endd
18622 since items in redirection lists are terminated by commas. Do not, however,
18623 quote just the command. An item such as
18624 .code
18625 |"/some/command ready,steady,go"
18626 .endd
18627 is interpreted as a pipe with a rather strange command name, and no arguments.
18628
18629 .new
18630 Note that the above example assumes that the text comes from a lookup source
18631 of some sort, so that the quotes are part of the data.  If composing a
18632 redirect router with a &%data%& option directly specifying this command, the
18633 quotes will be used by the configuration parser to define the extent of one
18634 string, but will not be passed down into the redirect router itself.  There
18635 are two main approaches to get around this: escape quotes to be part of the
18636 data itself, or avoid using this mechanism and instead create a custom
18637 transport with the &%command%& option set and reference that transport from
18638 an &%accept%& router.
18639 .wen
18640
18641 .next
18642 .cindex "file" "in redirection list"
18643 .cindex "address redirection" "to file"
18644 An item is interpreted as a path name if it begins with &"/"& and does not
18645 parse as a valid RFC 2822 address that includes a domain. For example,
18646 .code
18647 /home/world/minbari
18648 .endd
18649 is treated as a file name, but
18650 .code
18651 /s=molari/o=babylon/@x400gate.way
18652 .endd
18653 is treated as an address. For a file name, a transport must be specified using
18654 the &%file_transport%& option. However, if the generated path name ends with a
18655 forward slash character, it is interpreted as a directory name rather than a
18656 file name, and &%directory_transport%& is used instead.
18657
18658 Normally, either the router or the transport specifies a user and a group under
18659 which to run the delivery. The default is to use the Exim user and group.
18660
18661 .cindex "&_/dev/null_&"
18662 However, if a redirection item is the path &_/dev/null_&, delivery to it is
18663 bypassed at a high level, and the log entry shows &"**bypassed**"&
18664 instead of a transport name. In this case the user and group are not used.
18665
18666 .next
18667 .cindex "included address list"
18668 .cindex "address redirection" "included external list"
18669 If an item is of the form
18670 .code
18671 :include:<path name>
18672 .endd
18673 a list of further items is taken from the given file and included at that
18674 point. &*Note*&: Such a file can not be a filter file; it is just an
18675 out-of-line addition to the list. The items in the included list are separated
18676 by commas or newlines and are not subject to expansion. If this is the first
18677 item in an alias list in an &(lsearch)& file, a colon must be used to terminate
18678 the alias name. This example is incorrect:
18679 .code
18680 list1    :include:/opt/lists/list1
18681 .endd
18682 It must be given as
18683 .code
18684 list1:   :include:/opt/lists/list1
18685 .endd
18686 .next
18687 .cindex "address redirection" "to black hole"
18688 Sometimes you want to throw away mail to a particular local part. Making the
18689 &%data%& option expand to an empty string does not work, because that causes
18690 the router to decline. Instead, the alias item
18691 .cindex "black hole"
18692 .cindex "abandoning mail"
18693 &':blackhole:'& can be used. It does what its name implies. No delivery is
18694 done, and no error message is generated. This has the same effect as specifing
18695 &_/dev/null_& as a destination, but it can be independently disabled.
18696
18697 &*Warning*&: If &':blackhole:'& appears anywhere in a redirection list, no
18698 delivery is done for the original local part, even if other redirection items
18699 are present. If you are generating a multi-item list (for example, by reading a
18700 database) and need the ability to provide a no-op item, you must use
18701 &_/dev/null_&.
18702
18703 .next
18704 .cindex "delivery" "forcing failure"
18705 .cindex "delivery" "forcing deferral"
18706 .cindex "failing delivery" "forcing"
18707 .cindex "deferred delivery, forcing"
18708 .cindex "customizing" "failure message"
18709 An attempt to deliver a particular address can be deferred or forced to fail by
18710 redirection items of the form
18711 .code
18712 :defer:
18713 :fail:
18714 .endd
18715 respectively. When a redirection list contains such an item, it applies
18716 to the entire redirection; any other items in the list are ignored. Any
18717 text following &':fail:'& or &':defer:'& is placed in the error text
18718 associated with the failure. For example, an alias file might contain:
18719 .code
18720 X.Employee:  :fail: Gone away, no forwarding address
18721 .endd
18722 In the case of an address that is being verified from an ACL or as the subject
18723 of a
18724 .cindex "VRFY" "error text, display of"
18725 VRFY command, the text is included in the SMTP error response by
18726 default.
18727 .cindex "EXPN" "error text, display of"
18728 The text is not included in the response to an EXPN command. In non-SMTP cases
18729 the text is included in the error message that Exim generates.
18730
18731 .cindex "SMTP" "error codes"
18732 By default, Exim sends a 451 SMTP code for a &':defer:'&, and 550 for
18733 &':fail:'&. However, if the message starts with three digits followed by a
18734 space, optionally followed by an extended code of the form &'n.n.n'&, also
18735 followed by a space, and the very first digit is the same as the default error
18736 code, the code from the message is used instead. If the very first digit is
18737 incorrect, a panic error is logged, and the default code is used. You can
18738 suppress the use of the supplied code in a redirect router by setting the
18739 &%forbid_smtp_code%& option true. In this case, any SMTP code is quietly
18740 ignored.
18741
18742 .vindex "&$acl_verify_message$&"
18743 In an ACL, an explicitly provided message overrides the default, but the
18744 default message is available in the variable &$acl_verify_message$& and can
18745 therefore be included in a custom message if this is desired.
18746
18747 Normally the error text is the rest of the redirection list &-- a comma does
18748 not terminate it &-- but a newline does act as a terminator. Newlines are not
18749 normally present in alias expansions. In &(lsearch)& lookups they are removed
18750 as part of the continuation process, but they may exist in other kinds of
18751 lookup and in &':include:'& files.
18752
18753 During routing for message delivery (as opposed to verification), a redirection
18754 containing &':fail:'& causes an immediate failure of the incoming address,
18755 whereas &':defer:'& causes the message to remain on the queue so that a
18756 subsequent delivery attempt can happen at a later time. If an address is
18757 deferred for too long, it will ultimately fail, because the normal retry
18758 rules still apply.
18759
18760 .next
18761 .cindex "alias file" "exception to default"
18762 Sometimes it is useful to use a single-key search type with a default (see
18763 chapter &<<CHAPfdlookup>>&) to look up aliases. However, there may be a need
18764 for exceptions to the default. These can be handled by aliasing them to
18765 &':unknown:'&. This differs from &':fail:'& in that it causes the &(redirect)&
18766 router to decline, whereas &':fail:'& forces routing to fail. A lookup which
18767 results in an empty redirection list has the same effect.
18768 .endlist
18769
18770
18771 .section "Duplicate addresses" "SECTdupaddr"
18772 .cindex "duplicate addresses"
18773 .cindex "address duplicate, discarding"
18774 .cindex "pipe" "duplicated"
18775 Exim removes duplicate addresses from the list to which it is delivering, so as
18776 to deliver just one copy to each address. This does not apply to deliveries
18777 routed to pipes by different immediate parent addresses, but an indirect
18778 aliasing scheme of the type
18779 .code
18780 pipe:       |/some/command $local_part
18781 localpart1: pipe
18782 localpart2: pipe
18783 .endd
18784 does not work with a message that is addressed to both local parts, because
18785 when the second is aliased to the intermediate local part &"pipe"& it gets
18786 discarded as being the same as a previously handled address. However, a scheme
18787 such as
18788 .code
18789 localpart1: |/some/command $local_part
18790 localpart2: |/some/command $local_part
18791 .endd
18792 does result in two different pipe deliveries, because the immediate parents of
18793 the pipes are distinct.
18794
18795
18796
18797 .section "Repeated redirection expansion" "SECID128"
18798 .cindex "repeated redirection expansion"
18799 .cindex "address redirection" "repeated for each delivery attempt"
18800 When a message cannot be delivered to all of its recipients immediately,
18801 leading to two or more delivery attempts, redirection expansion is carried out
18802 afresh each time for those addresses whose children were not all previously
18803 delivered. If redirection is being used as a mailing list, this can lead to new
18804 members of the list receiving copies of old messages. The &%one_time%& option
18805 can be used to avoid this.
18806
18807
18808 .section "Errors in redirection lists" "SECID129"
18809 .cindex "address redirection" "errors"
18810 If &%skip_syntax_errors%& is set, a malformed address that causes a parsing
18811 error is skipped, and an entry is written to the main log. This may be useful
18812 for mailing lists that are automatically managed. Otherwise, if an error is
18813 detected while generating the list of new addresses, the original address is
18814 deferred. See also &%syntax_errors_to%&.
18815
18816
18817
18818 .section "Private options for the redirect router" "SECID130"
18819
18820 .cindex "options" "&(redirect)& router"
18821 The private options for the &(redirect)& router are as follows:
18822
18823
18824 .option allow_defer redirect boolean false
18825 Setting this option allows the use of &':defer:'& in non-filter redirection
18826 data, or the &%defer%& command in an Exim filter file.
18827
18828
18829 .option allow_fail redirect boolean false
18830 .cindex "failing delivery" "from filter"
18831 If this option is true, the &':fail:'& item can be used in a redirection list,
18832 and the &%fail%& command may be used in an Exim filter file.
18833
18834
18835 .option allow_filter redirect boolean false
18836 .cindex "filter" "enabling use of"
18837 .cindex "Sieve filter" "enabling use of"
18838 Setting this option allows Exim to interpret redirection data that starts with
18839 &"#Exim filter"& or &"#Sieve filter"& as a set of filtering instructions. There
18840 are some features of Exim filter files that some administrators may wish to
18841 lock out; see the &%forbid_filter_%&&'xxx'& options below.
18842
18843 It is also possible to lock out Exim filters or Sieve filters while allowing
18844 the other type; see &%forbid_exim_filter%& and &%forbid_sieve_filter%&.
18845
18846
18847 The filter is run using the uid and gid set by the generic &%user%& and
18848 &%group%& options. These take their defaults from the password data if
18849 &%check_local_user%& is set, so in the normal case of users' personal filter
18850 files, the filter is run as the relevant user. When &%allow_filter%& is set
18851 true, Exim insists that either &%check_local_user%& or &%user%& is set.
18852
18853
18854
18855 .option allow_freeze redirect boolean false
18856 .cindex "freezing messages" "allowing in filter"
18857 Setting this option allows the use of the &%freeze%& command in an Exim filter.
18858 This command is more normally encountered in system filters, and is disabled by
18859 default for redirection filters because it isn't something you usually want to
18860 let ordinary users do.
18861
18862
18863
18864 .option check_ancestor redirect boolean false
18865 This option is concerned with handling generated addresses that are the same
18866 as some address in the list of redirection ancestors of the current address.
18867 Although it is turned off by default in the code, it is set in the default
18868 configuration file for handling users' &_.forward_& files. It is recommended
18869 for this use of the &(redirect)& router.
18870
18871 When &%check_ancestor%& is set, if a generated address (including the domain)
18872 is the same as any ancestor of the current address, it is replaced by a copy of
18873 the current address. This helps in the case where local part A is aliased to B,
18874 and B has a &_.forward_& file pointing back to A. For example, within a single
18875 domain, the local part &"Joe.Bloggs"& is aliased to &"jb"& and
18876 &_&~jb/.forward_& contains:
18877 .code
18878 \Joe.Bloggs, <other item(s)>
18879 .endd
18880 Without the &%check_ancestor%& setting, either local part (&"jb"& or
18881 &"joe.bloggs"&) gets processed once by each router and so ends up as it was
18882 originally. If &"jb"& is the real mailbox name, mail to &"jb"& gets delivered
18883 (having been turned into &"joe.bloggs"& by the &_.forward_& file and back to
18884 &"jb"& by the alias), but mail to &"joe.bloggs"& fails. Setting
18885 &%check_ancestor%& on the &(redirect)& router that handles the &_.forward_&
18886 file prevents it from turning &"jb"& back into &"joe.bloggs"& when that was the
18887 original address. See also the &%repeat_use%& option below.
18888
18889
18890 .option check_group redirect boolean "see below"
18891 When the &%file%& option is used, the group owner of the file is checked only
18892 when this option is set. The permitted groups are those listed in the
18893 &%owngroups%& option, together with the user's default group if
18894 &%check_local_user%& is set. If the file has the wrong group, routing is
18895 deferred. The default setting for this option is true if &%check_local_user%&
18896 is set and the &%modemask%& option permits the group write bit, or if the
18897 &%owngroups%& option is set. Otherwise it is false, and no group check occurs.
18898
18899
18900
18901 .option check_owner redirect boolean "see below"
18902 When the &%file%& option is used, the owner of the file is checked only when
18903 this option is set. If &%check_local_user%& is set, the local user is
18904 permitted; otherwise the owner must be one of those listed in the &%owners%&
18905 option. The default value for this option is true if &%check_local_user%& or
18906 &%owners%& is set. Otherwise the default is false, and no owner check occurs.
18907
18908
18909 .option data redirect string&!! unset
18910 This option is mutually exclusive with &%file%&. One or other of them must be
18911 set, but not both. The contents of &%data%& are expanded, and then used as the
18912 list of forwarding items, or as a set of filtering instructions. If the
18913 expansion is forced to fail, or the result is an empty string or a string that
18914 has no effect (consists entirely of comments), the router declines.
18915
18916 When filtering instructions are used, the string must begin with &"#Exim
18917 filter"&, and all comments in the string, including this initial one, must be
18918 terminated with newline characters. For example:
18919 .code
18920 data = #Exim filter\n\
18921        if $h_to: contains Exim then save $home/mail/exim endif
18922 .endd
18923 If you are reading the data from a database where newlines cannot be included,
18924 you can use the &${sg}$& expansion item to turn the escape string of your
18925 choice into a newline.
18926
18927
18928 .option directory_transport redirect string&!! unset
18929 A &(redirect)& router sets up a direct delivery to a directory when a path name
18930 ending with a slash is specified as a new &"address"&. The transport used is
18931 specified by this option, which, after expansion, must be the name of a
18932 configured transport. This should normally be an &(appendfile)& transport.
18933
18934
18935 .option file redirect string&!! unset
18936 This option specifies the name of a file that contains the redirection data. It
18937 is mutually exclusive with the &%data%& option. The string is expanded before
18938 use; if the expansion is forced to fail, the router declines. Other expansion
18939 failures cause delivery to be deferred. The result of a successful expansion
18940 must be an absolute path. The entire file is read and used as the redirection
18941 data. If the data is an empty string or a string that has no effect (consists
18942 entirely of comments), the router declines.
18943
18944 .cindex "NFS" "checking for file existence"
18945 If the attempt to open the file fails with a &"does not exist"& error, Exim
18946 runs a check on the containing directory,
18947 unless &%ignore_enotdir%& is true (see below).
18948 If the directory does not appear to exist, delivery is deferred. This can
18949 happen when users' &_.forward_& files are in NFS-mounted directories, and there
18950 is a mount problem. If the containing directory does exist, but the file does
18951 not, the router declines.
18952
18953
18954 .option file_transport redirect string&!! unset
18955 .vindex "&$address_file$&"
18956 A &(redirect)& router sets up a direct delivery to a file when a path name not
18957 ending in a slash is specified as a new &"address"&. The transport used is
18958 specified by this option, which, after expansion, must be the name of a
18959 configured transport. This should normally be an &(appendfile)& transport. When
18960 it is running, the file name is in &$address_file$&.
18961
18962
18963 .option filter_prepend_home redirect boolean true
18964 When this option is true, if a &(save)& command in an Exim filter specifies a
18965 relative path, and &$home$& is defined, it is automatically prepended to the
18966 relative path. If this option is set false, this action does not happen. The
18967 relative path is then passed to the transport unmodified.
18968
18969
18970 .option forbid_blackhole redirect boolean false
18971 If this option is true, the &':blackhole:'& item may not appear in a
18972 redirection list.
18973
18974
18975 .option forbid_exim_filter redirect boolean false
18976 If this option is set true, only Sieve filters are permitted when
18977 &%allow_filter%& is true.
18978
18979
18980
18981
18982 .option forbid_file redirect boolean false
18983 .cindex "delivery" "to file; forbidding"
18984 .cindex "Sieve filter" "forbidding delivery to a file"
18985 .cindex "Sieve filter" "&""keep""& facility; disabling"
18986 If this option is true, this router may not generate a new address that
18987 specifies delivery to a local file or directory, either from a filter or from a
18988 conventional forward file. This option is forced to be true if &%one_time%& is
18989 set. It applies to Sieve filters as well as to Exim filters, but if true, it
18990 locks out the Sieve's &"keep"& facility.
18991
18992
18993 .option forbid_filter_dlfunc redirect boolean false
18994 .cindex "filter" "locking out certain features"
18995 If this option is true, string expansions in Exim filters are not allowed to
18996 make use of the &%dlfunc%& expansion facility to run dynamically loaded
18997 functions.
18998
18999 .option forbid_filter_existstest redirect boolean false
19000 .cindex "expansion" "statting a file"
19001 If this option is true, string expansions in Exim filters are not allowed to
19002 make use of the &%exists%& condition or the &%stat%& expansion item.
19003
19004 .option forbid_filter_logwrite redirect boolean false
19005 If this option is true, use of the logging facility in Exim filters is not
19006 permitted. Logging is in any case available only if the filter is being run
19007 under some unprivileged uid (which is normally the case for ordinary users'
19008 &_.forward_& files).
19009
19010
19011 .option forbid_filter_lookup redirect boolean false
19012 If this option is true, string expansions in Exim filter files are not allowed
19013 to make use of &%lookup%& items.
19014
19015
19016 .option forbid_filter_perl redirect boolean false
19017 This option has an effect only if Exim is built with embedded Perl support. If
19018 it is true, string expansions in Exim filter files are not allowed to make use
19019 of the embedded Perl support.
19020
19021
19022 .option forbid_filter_readfile redirect boolean false
19023 If this option is true, string expansions in Exim filter files are not allowed
19024 to make use of &%readfile%& items.
19025
19026
19027 .option forbid_filter_readsocket redirect boolean false
19028 If this option is true, string expansions in Exim filter files are not allowed
19029 to make use of &%readsocket%& items.
19030
19031
19032 .option forbid_filter_reply redirect boolean false
19033 If this option is true, this router may not generate an automatic reply
19034 message. Automatic replies can be generated only from Exim or Sieve filter
19035 files, not from traditional forward files. This option is forced to be true if
19036 &%one_time%& is set.
19037
19038
19039 .option forbid_filter_run redirect boolean false
19040 If this option is true, string expansions in Exim filter files are not allowed
19041 to make use of &%run%& items.
19042
19043
19044 .option forbid_include redirect boolean false
19045 If this option is true, items of the form
19046 .code
19047 :include:<path name>
19048 .endd
19049 are not permitted in non-filter redirection lists.
19050
19051
19052 .option forbid_pipe redirect boolean false
19053 .cindex "delivery" "to pipe; forbidding"
19054 If this option is true, this router may not generate a new address which
19055 specifies delivery to a pipe, either from an Exim filter or from a conventional
19056 forward file. This option is forced to be true if &%one_time%& is set.
19057
19058
19059 .option forbid_sieve_filter redirect boolean false
19060 If this option is set true, only Exim filters are permitted when
19061 &%allow_filter%& is true.
19062
19063
19064 .cindex "SMTP" "error codes"
19065 .option forbid_smtp_code redirect boolean false
19066 If this option is set true, any SMTP error codes that are present at the start
19067 of messages specified for &`:defer:`& or &`:fail:`& are quietly ignored, and
19068 the default codes (451 and 550, respectively) are always used.
19069
19070
19071
19072
19073 .option hide_child_in_errmsg redirect boolean false
19074 .cindex "bounce message" "redirection details; suppressing"
19075 If this option is true, it prevents Exim from quoting a child address if it
19076 generates a bounce or delay message for it. Instead it says &"an address
19077 generated from <&'the top level address'&>"&. Of course, this applies only to
19078 bounces generated locally. If a message is forwarded to another host, &'its'&
19079 bounce may well quote the generated address.
19080
19081
19082 .option ignore_eacces redirect boolean false
19083 .cindex "EACCES"
19084 If this option is set and an attempt to open a redirection file yields the
19085 EACCES error (permission denied), the &(redirect)& router behaves as if the
19086 file did not exist.
19087
19088
19089 .option ignore_enotdir redirect boolean false
19090 .cindex "ENOTDIR"
19091 If this option is set and an attempt to open a redirection file yields the
19092 ENOTDIR error (something on the path is not a directory), the &(redirect)&
19093 router behaves as if the file did not exist.
19094
19095 Setting &%ignore_enotdir%& has another effect as well: When a &(redirect)&
19096 router that has the &%file%& option set discovers that the file does not exist
19097 (the ENOENT error), it tries to &[stat()]& the parent directory, as a check
19098 against unmounted NFS directories. If the parent can not be statted, delivery
19099 is deferred. However, it seems wrong to do this check when &%ignore_enotdir%&
19100 is set, because that option tells Exim to ignore &"something on the path is not
19101 a directory"& (the ENOTDIR error). This is a confusing area, because it seems
19102 that some operating systems give ENOENT where others give ENOTDIR.
19103
19104
19105
19106 .option include_directory redirect string unset
19107 If this option is set, the path names of any &':include:'& items in a
19108 redirection list must start with this directory.
19109
19110
19111 .option modemask redirect "octal integer" 022
19112 This specifies mode bits which must not be set for a file specified by the
19113 &%file%& option. If any of the forbidden bits are set, delivery is deferred.
19114
19115
19116 .option one_time redirect boolean false
19117 .cindex "one-time aliasing/forwarding expansion"
19118 .cindex "alias file" "one-time expansion"
19119 .cindex "forward file" "one-time expansion"
19120 .cindex "mailing lists" "one-time expansion"
19121 .cindex "address redirection" "one-time expansion"
19122 Sometimes the fact that Exim re-evaluates aliases and reprocesses redirection
19123 files each time it tries to deliver a message causes a problem when one or more
19124 of the generated addresses fails be delivered at the first attempt. The problem
19125 is not one of duplicate delivery &-- Exim is clever enough to handle that &--
19126 but of what happens when the redirection list changes during the time that the
19127 message is on Exim's queue. This is particularly true in the case of mailing
19128 lists, where new subscribers might receive copies of messages that were posted
19129 before they subscribed.
19130
19131 If &%one_time%& is set and any addresses generated by the router fail to
19132 deliver at the first attempt, the failing addresses are added to the message as
19133 &"top level"& addresses, and the parent address that generated them is marked
19134 &"delivered"&. Thus, redirection does not happen again at the next delivery
19135 attempt.
19136
19137 &*Warning 1*&: Any header line addition or removal that is specified by this
19138 router would be lost if delivery did not succeed at the first attempt. For this
19139 reason, the &%headers_add%& and &%headers_remove%& generic options are not
19140 permitted when &%one_time%& is set.
19141
19142 &*Warning 2*&: To ensure that the router generates only addresses (as opposed
19143 to pipe or file deliveries or auto-replies) &%forbid_file%&, &%forbid_pipe%&,
19144 and &%forbid_filter_reply%& are forced to be true when &%one_time%& is set.
19145
19146 &*Warning 3*&: The &%unseen%& generic router option may not be set with
19147 &%one_time%&.
19148
19149 The original top-level address is remembered with each of the generated
19150 addresses, and is output in any log messages. However, any intermediate parent
19151 addresses are not recorded. This makes a difference to the log only if
19152 &%all_parents%& log selector is set. It is expected that &%one_time%& will
19153 typically be used for mailing lists, where there is normally just one level of
19154 expansion.
19155
19156
19157 .option owners redirect "string list" unset
19158 .cindex "ownership" "alias file"
19159 .cindex "ownership" "forward file"
19160 .cindex "alias file" "ownership"
19161 .cindex "forward file" "ownership"
19162 This specifies a list of permitted owners for the file specified by &%file%&.
19163 This list is in addition to the local user when &%check_local_user%& is set.
19164 See &%check_owner%& above.
19165
19166
19167 .option owngroups redirect "string list" unset
19168 This specifies a list of permitted groups for the file specified by &%file%&.
19169 The list is in addition to the local user's primary group when
19170 &%check_local_user%& is set. See &%check_group%& above.
19171
19172
19173 .option pipe_transport redirect string&!! unset
19174 .vindex "&$address_pipe$&"
19175 A &(redirect)& router sets up a direct delivery to a pipe when a string
19176 starting with a vertical bar character is specified as a new &"address"&. The
19177 transport used is specified by this option, which, after expansion, must be the
19178 name of a configured transport. This should normally be a &(pipe)& transport.
19179 When the transport is run, the pipe command is in &$address_pipe$&.
19180
19181
19182 .option qualify_domain redirect string&!! unset
19183 .vindex "&$qualify_recipient$&"
19184 If this option is set, and an unqualified address (one without a domain) is
19185 generated, and that address would normally be qualified by the global setting
19186 in &%qualify_recipient%&, it is instead qualified with the domain specified by
19187 expanding this string. If the expansion fails, the router declines. If you want
19188 to revert to the default, you can have the expansion generate
19189 &$qualify_recipient$&.
19190
19191 This option applies to all unqualified addresses generated by Exim filters,
19192 but for traditional &_.forward_& files, it applies only to addresses that are
19193 not preceded by a backslash. Sieve filters cannot generate unqualified
19194 addresses.
19195
19196 .option qualify_preserve_domain redirect boolean false
19197 .cindex "domain" "in redirection; preserving"
19198 .cindex "preserving domain in redirection"
19199 .cindex "address redirection" "domain; preserving"
19200 If this option is set, the router's local &%qualify_domain%& option must not be
19201 set (a configuration error occurs if it is). If an unqualified address (one
19202 without a domain) is generated, it is qualified with the domain of the parent
19203 address (the immediately preceding ancestor) instead of the global
19204 &%qualify_recipient%& value. In the case of a traditional &_.forward_& file,
19205 this applies whether or not the address is preceded by a backslash.
19206
19207
19208 .option repeat_use redirect boolean true
19209 If this option is set false, the router is skipped for a child address that has
19210 any ancestor that was routed by this router. This test happens before any of
19211 the other preconditions are tested. Exim's default anti-looping rules skip
19212 only when the ancestor is the same as the current address. See also
19213 &%check_ancestor%& above and the generic &%redirect_router%& option.
19214
19215
19216 .option reply_transport redirect string&!! unset
19217 A &(redirect)& router sets up an automatic reply when a &%mail%& or
19218 &%vacation%& command is used in a filter file. The transport used is specified
19219 by this option, which, after expansion, must be the name of a configured
19220 transport. This should normally be an &(autoreply)& transport. Other transports
19221 are unlikely to do anything sensible or useful.
19222
19223
19224 .option rewrite redirect boolean true
19225 .cindex "address redirection" "disabling rewriting"
19226 If this option is set false, addresses generated by the router are not
19227 subject to address rewriting. Otherwise, they are treated like new addresses
19228 and are rewritten according to the global rewriting rules.
19229
19230
19231 .option sieve_subaddress redirect string&!! unset
19232 The value of this option is passed to a Sieve filter to specify the
19233 :subaddress part of an address.
19234
19235 .option sieve_useraddress redirect string&!! unset
19236 The value of this option is passed to a Sieve filter to specify the :user part
19237 of an address. However, if it is unset, the entire original local part
19238 (including any prefix or suffix) is used for :user.
19239
19240
19241 .option sieve_vacation_directory redirect string&!! unset
19242 .cindex "Sieve filter" "vacation directory"
19243 To enable the &"vacation"& extension for Sieve filters, you must set
19244 &%sieve_vacation_directory%& to the directory where vacation databases are held
19245 (do not put anything else in that directory), and ensure that the
19246 &%reply_transport%& option refers to an &(autoreply)& transport. Each user
19247 needs their own directory; Exim will create it if necessary.
19248
19249
19250
19251 .option skip_syntax_errors redirect boolean false
19252 .cindex "forward file" "broken"
19253 .cindex "address redirection" "broken files"
19254 .cindex "alias file" "broken"
19255 .cindex "broken alias or forward files"
19256 .cindex "ignoring faulty addresses"
19257 .cindex "skipping faulty addresses"
19258 .cindex "error" "skipping bad syntax"
19259 If &%skip_syntax_errors%& is set, syntactically malformed addresses in
19260 non-filter redirection data are skipped, and each failing address is logged. If
19261 &%syntax_errors_to%& is set, a message is sent to the address it defines,
19262 giving details of the failures. If &%syntax_errors_text%& is set, its contents
19263 are expanded and placed at the head of the error message generated by
19264 &%syntax_errors_to%&. Usually it is appropriate to set &%syntax_errors_to%& to
19265 be the same address as the generic &%errors_to%& option. The
19266 &%skip_syntax_errors%& option is often used when handling mailing lists.
19267
19268 If all the addresses in a redirection list are skipped because of syntax
19269 errors, the router declines to handle the original address, and it is passed to
19270 the following routers.
19271
19272 If &%skip_syntax_errors%& is set when an Exim filter is interpreted, any syntax
19273 error in the filter causes filtering to be abandoned without any action being
19274 taken. The incident is logged, and the router declines to handle the address,
19275 so it is passed to the following routers.
19276
19277 .cindex "Sieve filter" "syntax errors in"
19278 Syntax errors in a Sieve filter file cause the &"keep"& action to occur. This
19279 action is specified by RFC 3028. The values of &%skip_syntax_errors%&,
19280 &%syntax_errors_to%&, and &%syntax_errors_text%& are not used.
19281
19282 &%skip_syntax_errors%& can be used to specify that errors in users' forward
19283 lists or filter files should not prevent delivery. The &%syntax_errors_to%&
19284 option, used with an address that does not get redirected, can be used to
19285 notify users of these errors, by means of a router like this:
19286 .code
19287 userforward:
19288   driver = redirect
19289   allow_filter
19290   check_local_user
19291   file = $home/.forward
19292   file_transport = address_file
19293   pipe_transport = address_pipe
19294   reply_transport = address_reply
19295   no_verify
19296   skip_syntax_errors
19297   syntax_errors_to = real-$local_part@$domain
19298   syntax_errors_text = \
19299    This is an automatically generated message. An error has\n\
19300    been found in your .forward file. Details of the error are\n\
19301    reported below. While this error persists, you will receive\n\
19302    a copy of this message for every message that is addressed\n\
19303    to you. If your .forward file is a filter file, or if it is\n\
19304    a non-filter file containing no valid forwarding addresses,\n\
19305    a copy of each incoming message will be put in your normal\n\
19306    mailbox. If a non-filter file contains at least one valid\n\
19307    forwarding address, forwarding to the valid addresses will\n\
19308    happen, and those will be the only deliveries that occur.
19309 .endd
19310 You also need a router to ensure that local addresses that are prefixed by
19311 &`real-`& are recognized, but not forwarded or filtered. For example, you could
19312 put this immediately before the &(userforward)& router:
19313 .code
19314 real_localuser:
19315   driver = accept
19316   check_local_user
19317   local_part_prefix = real-
19318   transport = local_delivery
19319 .endd
19320 For security, it would probably be a good idea to restrict the use of this
19321 router to locally-generated messages, using a condition such as this:
19322 .code
19323   condition = ${if match {$sender_host_address}\
19324                          {\N^(|127\.0\.0\.1)$\N}}
19325 .endd
19326
19327
19328 .option syntax_errors_text redirect string&!! unset
19329 See &%skip_syntax_errors%& above.
19330
19331
19332 .option syntax_errors_to redirect string unset
19333 See &%skip_syntax_errors%& above.
19334 .ecindex IIDredrou1
19335 .ecindex IIDredrou2
19336
19337
19338
19339
19340
19341
19342 . ////////////////////////////////////////////////////////////////////////////
19343 . ////////////////////////////////////////////////////////////////////////////
19344
19345 .chapter "Environment for running local transports" "CHAPenvironment" &&&
19346          "Environment for local transports"
19347 .scindex IIDenvlotra1 "local transports" "environment for"
19348 .scindex IIDenvlotra2 "environment for local transports"
19349 .scindex IIDenvlotra3 "transport" "local; environment for"
19350 Local transports handle deliveries to files and pipes. (The &(autoreply)&
19351 transport can be thought of as similar to a pipe.) Exim always runs transports
19352 in subprocesses, under specified uids and gids. Typical deliveries to local
19353 mailboxes run under the uid and gid of the local user.
19354
19355 Exim also sets a specific current directory while running the transport; for
19356 some transports a home directory setting is also relevant. The &(pipe)&
19357 transport is the only one that sets up environment variables; see section
19358 &<<SECTpipeenv>>& for details.
19359
19360 The values used for the uid, gid, and the directories may come from several
19361 different places. In many cases, the router that handles the address associates
19362 settings with that address as a result of its &%check_local_user%&, &%group%&,
19363 or &%user%& options. However, values may also be given in the transport's own
19364 configuration, and these override anything that comes from the router.
19365
19366
19367
19368 .section "Concurrent deliveries" "SECID131"
19369 .cindex "concurrent deliveries"
19370 .cindex "simultaneous deliveries"
19371 If two different messages for the same local recipient arrive more or less
19372 simultaneously, the two delivery processes are likely to run concurrently. When
19373 the &(appendfile)& transport is used to write to a file, Exim applies locking
19374 rules to stop concurrent processes from writing to the same file at the same
19375 time.
19376
19377 However, when you use a &(pipe)& transport, it is up to you to arrange any
19378 locking that is needed. Here is a silly example:
19379 .code
19380 my_transport:
19381   driver = pipe
19382   command = /bin/sh -c 'cat >>/some/file'
19383 .endd
19384 This is supposed to write the message at the end of the file. However, if two
19385 messages arrive at the same time, the file will be scrambled. You can use the
19386 &%exim_lock%& utility program (see section &<<SECTmailboxmaint>>&) to lock a
19387 file using the same algorithm that Exim itself uses.
19388
19389
19390
19391
19392 .section "Uids and gids" "SECTenvuidgid"
19393 .cindex "local transports" "uid and gid"
19394 .cindex "transport" "local; uid and gid"
19395 All transports have the options &%group%& and &%user%&. If &%group%& is set, it
19396 overrides any group that the router set in the address, even if &%user%& is not
19397 set for the transport. This makes it possible, for example, to run local mail
19398 delivery under the uid of the recipient (set by the router), but in a special
19399 group (set by the transport). For example:
19400 .code
19401 # Routers ...
19402 # User/group are set by check_local_user in this router
19403 local_users:
19404   driver = accept
19405   check_local_user
19406   transport = group_delivery
19407
19408 # Transports ...
19409 # This transport overrides the group
19410 group_delivery:
19411   driver = appendfile
19412   file = /var/spool/mail/$local_part
19413   group = mail
19414 .endd
19415 If &%user%& is set for a transport, its value overrides what is set in the
19416 address by the router. If &%user%& is non-numeric and &%group%& is not set, the
19417 gid associated with the user is used. If &%user%& is numeric, &%group%& must be
19418 set.
19419
19420 .oindex "&%initgroups%&"
19421 When the uid is taken from the transport's configuration, the &[initgroups()]&
19422 function is called for the groups associated with that uid if the
19423 &%initgroups%& option is set for the transport. When the uid is not specified
19424 by the transport, but is associated with the address by a router, the option
19425 for calling &[initgroups()]& is taken from the router configuration.
19426
19427 .cindex "&(pipe)& transport" "uid for"
19428 The &(pipe)& transport contains the special option &%pipe_as_creator%&. If this
19429 is set and &%user%& is not set, the uid of the process that called Exim to
19430 receive the message is used, and if &%group%& is not set, the corresponding
19431 original gid is also used.
19432
19433 This is the detailed preference order for obtaining a gid; the first of the
19434 following that is set is used:
19435
19436 .ilist
19437 A &%group%& setting of the transport;
19438 .next
19439 A &%group%& setting of the router;
19440 .next
19441 A gid associated with a user setting of the router, either as a result of
19442 &%check_local_user%& or an explicit non-numeric &%user%& setting;
19443 .next
19444 The group associated with a non-numeric &%user%& setting of the transport;
19445 .next
19446 In a &(pipe)& transport, the creator's gid if &%deliver_as_creator%& is set and
19447 the uid is the creator's uid;
19448 .next
19449 The Exim gid if the Exim uid is being used as a default.
19450 .endlist
19451
19452 If, for example, the user is specified numerically on the router and there are
19453 no group settings, no gid is available. In this situation, an error occurs.
19454 This is different for the uid, for which there always is an ultimate default.
19455 The first of the following that is set is used:
19456
19457 .ilist
19458 A &%user%& setting of the transport;
19459 .next
19460 In a &(pipe)& transport, the creator's uid if &%deliver_as_creator%& is set;
19461 .next
19462 A &%user%& setting of the router;
19463 .next
19464 A &%check_local_user%& setting of the router;
19465 .next
19466 The Exim uid.
19467 .endlist
19468
19469 Of course, an error will still occur if the uid that is chosen is on the
19470 &%never_users%& list.
19471
19472
19473
19474
19475
19476 .section "Current and home directories" "SECID132"
19477 .cindex "current directory for local transport"
19478 .cindex "home directory" "for local transport"
19479 .cindex "transport" "local; home directory for"
19480 .cindex "transport" "local; current directory for"
19481 Routers may set current and home directories for local transports by means of
19482 the &%transport_current_directory%& and &%transport_home_directory%& options.
19483 However, if the transport's &%current_directory%& or &%home_directory%& options
19484 are set, they override the router's values. In detail, the home directory
19485 for a local transport is taken from the first of these values that is set:
19486
19487 .ilist
19488 The &%home_directory%& option on the transport;
19489 .next
19490 The &%transport_home_directory%& option on the router;
19491 .next
19492 The password data if &%check_local_user%& is set on the router;
19493 .next
19494 The &%router_home_directory%& option on the router.
19495 .endlist
19496
19497 The current directory is taken from the first of these values that is set:
19498
19499 .ilist
19500 The &%current_directory%& option on the transport;
19501 .next
19502 The &%transport_current_directory%& option on the router.
19503 .endlist
19504
19505
19506 If neither the router nor the transport sets a current directory, Exim uses the
19507 value of the home directory, if it is set. Otherwise it sets the current
19508 directory to &_/_& before running a local transport.
19509
19510
19511
19512 .section "Expansion variables derived from the address" "SECID133"
19513 .vindex "&$domain$&"
19514 .vindex "&$local_part$&"
19515 .vindex "&$original_domain$&"
19516 Normally a local delivery is handling a single address, and in that case the
19517 variables such as &$domain$& and &$local_part$& are set during local
19518 deliveries. However, in some circumstances more than one address may be handled
19519 at once (for example, while writing batch SMTP for onward transmission by some
19520 other means). In this case, the variables associated with the local part are
19521 never set, &$domain$& is set only if all the addresses have the same domain,
19522 and &$original_domain$& is never set.
19523 .ecindex IIDenvlotra1
19524 .ecindex IIDenvlotra2
19525 .ecindex IIDenvlotra3
19526
19527
19528
19529
19530
19531
19532
19533 . ////////////////////////////////////////////////////////////////////////////
19534 . ////////////////////////////////////////////////////////////////////////////
19535
19536 .chapter "Generic options for transports" "CHAPtransportgeneric"
19537 .scindex IIDgenoptra1 "generic options" "transport"
19538 .scindex IIDgenoptra2 "options" "generic; for transports"
19539 .scindex IIDgenoptra3 "transport" "generic options for"
19540 The following generic options apply to all transports:
19541
19542
19543 .option body_only transports boolean false
19544 .cindex "transport" "body only"
19545 .cindex "message" "transporting body only"
19546 .cindex "body of message" "transporting"
19547 If this option is set, the message's headers are not transported. It is
19548 mutually exclusive with &%headers_only%&. If it is used with the &(appendfile)&
19549 or &(pipe)& transports, the settings of &%message_prefix%& and
19550 &%message_suffix%& should be checked, because this option does not
19551 automatically suppress them.
19552
19553
19554 .option current_directory transports string&!! unset
19555 .cindex "transport" "current directory for"
19556 This specifies the current directory that is to be set while running the
19557 transport, overriding any value that may have been set by the router.
19558 If the expansion fails for any reason, including forced failure, an error is
19559 logged, and delivery is deferred.
19560
19561
19562 .option disable_logging transports boolean false
19563 If this option is set true, nothing is logged for any
19564 deliveries by the transport or for any
19565 transport errors. You should not set this option unless you really, really know
19566 what you are doing.
19567
19568
19569 .option debug_print transports string&!! unset
19570 .cindex "testing" "variables in drivers"
19571 If this option is set and debugging is enabled (see the &%-d%& command line
19572 option), the string is expanded and included in the debugging output when the
19573 transport is run.
19574 If expansion of the string fails, the error message is written to the debugging
19575 output, and Exim carries on processing.
19576 This facility is provided to help with checking out the values of variables and
19577 so on when debugging driver configurations. For example, if a &%headers_add%&
19578 option is not working properly, &%debug_print%& could be used to output the
19579 variables it references. A newline is added to the text if it does not end with
19580 one.
19581
19582
19583 .option delivery_date_add transports boolean false
19584 .cindex "&'Delivery-date:'& header line"
19585 If this option is true, a &'Delivery-date:'& header is added to the message.
19586 This gives the actual time the delivery was made. As this is not a standard
19587 header, Exim has a configuration option (&%delivery_date_remove%&) which
19588 requests its removal from incoming messages, so that delivered messages can
19589 safely be resent to other recipients.
19590
19591
19592 .option driver transports string unset
19593 This specifies which of the available transport drivers is to be used.
19594 There is no default, and this option must be set for every transport.
19595
19596
19597 .option envelope_to_add transports boolean false
19598 .cindex "&'Envelope-to:'& header line"
19599 If this option is true, an &'Envelope-to:'& header is added to the message.
19600 This gives the original address(es) in the incoming envelope that caused this
19601 delivery to happen. More than one address may be present if the transport is
19602 configured to handle several addresses at once, or if more than one original
19603 address was redirected to the same final address. As this is not a standard
19604 header, Exim has a configuration option (&%envelope_to_remove%&) which requests
19605 its removal from incoming messages, so that delivered messages can safely be
19606 resent to other recipients.
19607
19608
19609 .option group transports string&!! "Exim group"
19610 .cindex "transport" "group; specifying"
19611 This option specifies a gid for running the transport process, overriding any
19612 value that the router supplies, and also overriding any value associated with
19613 &%user%& (see below).
19614
19615
19616 .option headers_add transports string&!! unset
19617 .cindex "header lines" "adding in transport"
19618 .cindex "transport" "header lines; adding"
19619 This option specifies a string of text that is expanded and added to the header
19620 portion of a message as it is transported, as described in section
19621 &<<SECTheadersaddrem>>&. Additional header lines can also be specified by
19622 routers. If the result of the expansion is an empty string, or if the expansion
19623 is forced to fail, no action is taken. Other expansion failures are treated as
19624 errors and cause the delivery to be deferred.
19625
19626 Unlike most options, &%headers_add%& can be specified multiple times
19627 for a transport; all listed headers are added.
19628
19629
19630
19631 .option headers_only transports boolean false
19632 .cindex "transport" "header lines only"
19633 .cindex "message" "transporting headers only"
19634 .cindex "header lines" "transporting"
19635 If this option is set, the message's body is not transported. It is mutually
19636 exclusive with &%body_only%&. If it is used with the &(appendfile)& or &(pipe)&
19637 transports, the settings of &%message_prefix%& and &%message_suffix%& should be
19638 checked, since this option does not automatically suppress them.
19639
19640
19641 .option headers_remove transports string&!! unset
19642 .cindex "header lines" "removing"
19643 .cindex "transport" "header lines; removing"
19644 This option specifies a string that is expanded into a list of header names;
19645 these headers are omitted from the message as it is transported, as described
19646 in section &<<SECTheadersaddrem>>&. Header removal can also be specified by
19647 routers. If the result of the expansion is an empty string, or if the expansion
19648 is forced to fail, no action is taken. Other expansion failures are treated as
19649 errors and cause the delivery to be deferred.
19650
19651 Unlike most options, &%headers_remove%& can be specified multiple times
19652 for a router; all listed headers are added.
19653
19654
19655
19656 .option headers_rewrite transports string unset
19657 .cindex "transport" "header lines; rewriting"
19658 .cindex "rewriting" "at transport time"
19659 This option allows addresses in header lines to be rewritten at transport time,
19660 that is, as the message is being copied to its destination. The contents of the
19661 option are a colon-separated list of rewriting rules. Each rule is in exactly
19662 the same form as one of the general rewriting rules that are applied when a
19663 message is received. These are described in chapter &<<CHAPrewrite>>&. For
19664 example,
19665 .code
19666 headers_rewrite = a@b c@d f : \
19667                   x@y w@z
19668 .endd
19669 changes &'a@b'& into &'c@d'& in &'From:'& header lines, and &'x@y'& into
19670 &'w@z'& in all address-bearing header lines. The rules are applied to the
19671 header lines just before they are written out at transport time, so they affect
19672 only those copies of the message that pass through the transport. However, only
19673 the message's original header lines, and any that were added by a system
19674 filter, are rewritten. If a router or transport adds header lines, they are not
19675 affected by this option. These rewriting rules are &'not'& applied to the
19676 envelope. You can change the return path using &%return_path%&, but you cannot
19677 change envelope recipients at this time.
19678
19679
19680 .option home_directory transports string&!! unset
19681 .cindex "transport" "home directory for"
19682 .vindex "&$home$&"
19683 This option specifies a home directory setting for a local transport,
19684 overriding any value that may be set by the router. The home directory is
19685 placed in &$home$& while expanding the transport's private options. It is also
19686 used as the current directory if no current directory is set by the
19687 &%current_directory%& option on the transport or the
19688 &%transport_current_directory%& option on the router. If the expansion fails
19689 for any reason, including forced failure, an error is logged, and delivery is
19690 deferred.
19691
19692
19693 .option initgroups transports boolean false
19694 .cindex "additional groups"
19695 .cindex "groups" "additional"
19696 .cindex "transport" "group; additional"
19697 If this option is true and the uid for the delivery process is provided by the
19698 transport, the &[initgroups()]& function is called when running the transport
19699 to ensure that any additional groups associated with the uid are set up.
19700
19701
19702 .option message_size_limit transports string&!! 0
19703 .cindex "limit" "message size per transport"
19704 .cindex "size" "of message, limit"
19705 .cindex "transport" "message size; limiting"
19706 This option controls the size of messages passed through the transport. It is
19707 expanded before use; the result of the expansion must be a sequence of decimal
19708 digits, optionally followed by K or M. If the expansion fails for any reason,
19709 including forced failure, or if the result is not of the required form,
19710 delivery is deferred. If the value is greater than zero and the size of a
19711 message exceeds this limit, the address is failed. If there is any chance that
19712 the resulting bounce message could be routed to the same transport, you should
19713 ensure that &%return_size_limit%& is less than the transport's
19714 &%message_size_limit%&, as otherwise the bounce message will fail to get
19715 delivered.
19716
19717
19718
19719 .option rcpt_include_affixes transports boolean false
19720 .cindex "prefix" "for local part, including in envelope"
19721 .cindex "suffix for local part" "including in envelope"
19722 .cindex "local part" "prefix"
19723 .cindex "local part" "suffix"
19724 When this option is false (the default), and an address that has had any
19725 affixes (prefixes or suffixes) removed from the local part is delivered by any
19726 form of SMTP or LMTP, the affixes are not included. For example, if a router
19727 that contains
19728 .code
19729 local_part_prefix = *-
19730 .endd
19731 routes the address &'abc-xyz@some.domain'& to an SMTP transport, the envelope
19732 is delivered with
19733 .code
19734 RCPT TO:<xyz@some.domain>
19735 .endd
19736 This is also the case when an ACL-time callout is being used to verify a
19737 recipient address. However, if &%rcpt_include_affixes%& is set true, the
19738 whole local part is included in the RCPT command. This option applies to BSMTP
19739 deliveries by the &(appendfile)& and &(pipe)& transports as well as to the
19740 &(lmtp)& and &(smtp)& transports.
19741
19742
19743 .option retry_use_local_part transports boolean "see below"
19744 .cindex "hints database" "retry keys"
19745 When a delivery suffers a temporary failure, a retry record is created
19746 in Exim's hints database. For remote deliveries, the key for the retry record
19747 is based on the name and/or IP address of the failing remote host. For local
19748 deliveries, the key is normally the entire address, including both the local
19749 part and the domain. This is suitable for most common cases of local delivery
19750 temporary failure &-- for example, exceeding a mailbox quota should delay only
19751 deliveries to that mailbox, not to the whole domain.
19752
19753 However, in some special cases you may want to treat a temporary local delivery
19754 as a failure associated with the domain, and not with a particular local part.
19755 (For example, if you are storing all mail for some domain in files.) You can do
19756 this by setting &%retry_use_local_part%& false.
19757
19758 For all the local transports, its default value is true. For remote transports,
19759 the default value is false for tidiness, but changing the value has no effect
19760 on a remote transport in the current implementation.
19761
19762
19763 .option return_path transports string&!! unset
19764 .cindex "envelope sender"
19765 .cindex "transport" "return path; changing"
19766 .cindex "return path" "changing in transport"
19767 If this option is set, the string is expanded at transport time and replaces
19768 the existing return path (envelope sender) value in the copy of the message
19769 that is being delivered. An empty return path is permitted. This feature is
19770 designed for remote deliveries, where the value of this option is used in the
19771 SMTP MAIL command. If you set &%return_path%& for a local transport, the
19772 only effect is to change the address that is placed in the &'Return-path:'&
19773 header line, if one is added to the message (see the next option).
19774
19775 &*Note:*& A changed return path is not logged unless you add
19776 &%return_path_on_delivery%& to the log selector.
19777
19778 .vindex "&$return_path$&"
19779 The expansion can refer to the existing value via &$return_path$&. This is
19780 either the message's envelope sender, or an address set by the
19781 &%errors_to%& option on a router. If the expansion is forced to fail, no
19782 replacement occurs; if it fails for another reason, delivery is deferred. This
19783 option can be used to support VERP (Variable Envelope Return Paths) &-- see
19784 section &<<SECTverp>>&.
19785
19786 &*Note*&: If a delivery error is detected locally, including the case when a
19787 remote server rejects a message at SMTP time, the bounce message is not sent to
19788 the value of this option. It is sent to the previously set errors address.
19789 This defaults to the incoming sender address, but can be changed by setting
19790 &%errors_to%& in a router.
19791
19792
19793
19794 .option return_path_add transports boolean false
19795 .cindex "&'Return-path:'& header line"
19796 If this option is true, a &'Return-path:'& header is added to the message.
19797 Although the return path is normally available in the prefix line of BSD
19798 mailboxes, this is commonly not displayed by MUAs, and so the user does not
19799 have easy access to it.
19800
19801 RFC 2821 states that the &'Return-path:'& header is added to a message &"when
19802 the delivery SMTP server makes the final delivery"&. This implies that this
19803 header should not be present in incoming messages. Exim has a configuration
19804 option, &%return_path_remove%&, which requests removal of this header from
19805 incoming messages, so that delivered messages can safely be resent to other
19806 recipients.
19807
19808
19809 .option shadow_condition transports string&!! unset
19810 See &%shadow_transport%& below.
19811
19812
19813 .option shadow_transport transports string unset
19814 .cindex "shadow transport"
19815 .cindex "transport" "shadow"
19816 A local transport may set the &%shadow_transport%& option to the name of
19817 another local transport. Shadow remote transports are not supported.
19818
19819 Whenever a delivery to the main transport succeeds, and either
19820 &%shadow_condition%& is unset, or its expansion does not result in the empty
19821 string or one of the strings &"0"& or &"no"& or &"false"&, the message is also
19822 passed to the shadow transport, with the same delivery address or addresses. If
19823 expansion fails, no action is taken except that non-forced expansion failures
19824 cause a log line to be written.
19825
19826 The result of the shadow transport is discarded and does not affect the
19827 subsequent processing of the message. Only a single level of shadowing is
19828 provided; the &%shadow_transport%& option is ignored on any transport when it
19829 is running as a shadow. Options concerned with output from pipes are also
19830 ignored. The log line for the successful delivery has an item added on the end,
19831 of the form
19832 .code
19833 ST=<shadow transport name>
19834 .endd
19835 If the shadow transport did not succeed, the error message is put in
19836 parentheses afterwards. Shadow transports can be used for a number of different
19837 purposes, including keeping more detailed log information than Exim normally
19838 provides, and implementing automatic acknowledgment policies based on message
19839 headers that some sites insist on.
19840
19841
19842 .option transport_filter transports string&!! unset
19843 .cindex "transport" "filter"
19844 .cindex "filter" "transport filter"
19845 This option sets up a filtering (in the Unix shell sense) process for messages
19846 at transport time. It should not be confused with mail filtering as set up by
19847 individual users or via a system filter.
19848
19849 When the message is about to be written out, the command specified by
19850 &%transport_filter%& is started up in a separate, parallel process, and
19851 the entire message, including the header lines, is passed to it on its standard
19852 input (this in fact is done from a third process, to avoid deadlock). The
19853 command must be specified as an absolute path.
19854
19855 The lines of the message that are written to the transport filter are
19856 terminated by newline (&"\n"&). The message is passed to the filter before any
19857 SMTP-specific processing, such as turning &"\n"& into &"\r\n"& and escaping
19858 lines beginning with a dot, and also before any processing implied by the
19859 settings of &%check_string%& and &%escape_string%& in the &(appendfile)& or
19860 &(pipe)& transports.
19861
19862 The standard error for the filter process is set to the same destination as its
19863 standard output; this is read and written to the message's ultimate
19864 destination. The process that writes the message to the filter, the
19865 filter itself, and the original process that reads the result and delivers it
19866 are all run in parallel, like a shell pipeline.
19867
19868 The filter can perform any transformations it likes, but of course should take
19869 care not to break RFC 2822 syntax. Exim does not check the result, except to
19870 test for a final newline when SMTP is in use. All messages transmitted over
19871 SMTP must end with a newline, so Exim supplies one if it is missing.
19872
19873 .cindex "content scanning" "per user"
19874 A transport filter can be used to provide content-scanning on a per-user basis
19875 at delivery time if the only required effect of the scan is to modify the
19876 message. For example, a content scan could insert a new header line containing
19877 a spam score. This could be interpreted by a filter in the user's MUA. It is
19878 not possible to discard a message at this stage.
19879
19880 .cindex "SMTP" "SIZE"
19881 A problem might arise if the filter increases the size of a message that is
19882 being sent down an SMTP connection. If the receiving SMTP server has indicated
19883 support for the SIZE parameter, Exim will have sent the size of the message
19884 at the start of the SMTP session. If what is actually sent is substantially
19885 more, the server might reject the message. This can be worked round by setting
19886 the &%size_addition%& option on the &(smtp)& transport, either to allow for
19887 additions to the message, or to disable the use of SIZE altogether.
19888
19889 .vindex "&$pipe_addresses$&"
19890 The value of the &%transport_filter%& option is the command string for starting
19891 the filter, which is run directly from Exim, not under a shell. The string is
19892 parsed by Exim in the same way as a command string for the &(pipe)& transport:
19893 Exim breaks it up into arguments and then expands each argument separately (see
19894 section &<<SECThowcommandrun>>&). Any kind of expansion failure causes delivery
19895 to be deferred. The special argument &$pipe_addresses$& is replaced by a number
19896 of arguments, one for each address that applies to this delivery. (This isn't
19897 an ideal name for this feature here, but as it was already implemented for the
19898 &(pipe)& transport, it seemed sensible not to change it.)
19899
19900 .vindex "&$host$&"
19901 .vindex "&$host_address$&"
19902 The expansion variables &$host$& and &$host_address$& are available when the
19903 transport is a remote one. They contain the name and IP address of the host to
19904 which the message is being sent. For example:
19905 .code
19906 transport_filter = /some/directory/transport-filter.pl \
19907   $host $host_address $sender_address $pipe_addresses
19908 .endd
19909
19910 Two problems arise if you want to use more complicated expansion items to
19911 generate transport filter commands, both of which due to the fact that the
19912 command is split up &'before'& expansion.
19913 .ilist
19914 If an expansion item contains white space, you must quote it, so that it is all
19915 part of the same command item. If the entire option setting is one such
19916 expansion item, you have to take care what kind of quoting you use. For
19917 example:
19918 .code
19919 transport_filter = '/bin/cmd${if eq{$host}{a.b.c}{1}{2}}'
19920 .endd
19921 This runs the command &(/bin/cmd1)& if the host name is &'a.b.c'&, and
19922 &(/bin/cmd2)& otherwise. If double quotes had been used, they would have been
19923 stripped by Exim when it read the option's value. When the value is used, if
19924 the single quotes were missing, the line would be split into two items,
19925 &`/bin/cmd${if`& and &`eq{$host}{a.b.c}{1}{2}`&, and an error would occur when
19926 Exim tried to expand the first one.
19927 .next
19928 Except for the special case of &$pipe_addresses$& that is mentioned above, an
19929 expansion cannot generate multiple arguments, or a command name followed by
19930 arguments. Consider this example:
19931 .code
19932 transport_filter = ${lookup{$host}lsearch{/a/file}\
19933                     {$value}{/bin/cat}}
19934 .endd
19935 The result of the lookup is interpreted as the name of the command, even
19936 if it contains white space. The simplest way round this is to use a shell:
19937 .code
19938 transport_filter = /bin/sh -c ${lookup{$host}lsearch{/a/file}\
19939                                {$value}{/bin/cat}}
19940 .endd
19941 .endlist
19942
19943 The filter process is run under the same uid and gid as the normal delivery.
19944 For remote deliveries this is the Exim uid/gid by default. The command should
19945 normally yield a zero return code. Transport filters are not supposed to fail.
19946 A non-zero code is taken to mean that the transport filter encountered some
19947 serious problem. Delivery of the message is deferred; the message remains on
19948 the queue and is tried again later. It is not possible to cause a message to be
19949 bounced from a transport filter.
19950
19951 If a transport filter is set on an autoreply transport, the original message is
19952 passed through the filter as it is being copied into the newly generated
19953 message, which happens if the &%return_message%& option is set.
19954
19955
19956 .option transport_filter_timeout transports time 5m
19957 .cindex "transport" "filter, timeout"
19958 When Exim is reading the output of a transport filter, it applies a timeout
19959 that can be set by this option. Exceeding the timeout is normally treated as a
19960 temporary delivery failure. However, if a transport filter is used with a
19961 &(pipe)& transport, a timeout in the transport filter is treated in the same
19962 way as a timeout in the pipe command itself. By default, a timeout is a hard
19963 error, but if the &(pipe)& transport's &%timeout_defer%& option is set true, it
19964 becomes a temporary error.
19965
19966
19967 .option user transports string&!! "Exim user"
19968 .cindex "uid (user id)" "local delivery"
19969 .cindex "transport" "user, specifying"
19970 This option specifies the user under whose uid the delivery process is to be
19971 run, overriding any uid that may have been set by the router. If the user is
19972 given as a name, the uid is looked up from the password data, and the
19973 associated group is taken as the value of the gid to be used if the &%group%&
19974 option is not set.
19975
19976 For deliveries that use local transports, a user and group are normally
19977 specified explicitly or implicitly (for example, as a result of
19978 &%check_local_user%&) by the router or transport.
19979
19980 .cindex "hints database" "access by remote transport"
19981 For remote transports, you should leave this option unset unless you really are
19982 sure you know what you are doing. When a remote transport is running, it needs
19983 to be able to access Exim's hints databases, because each host may have its own
19984 retry data.
19985 .ecindex IIDgenoptra1
19986 .ecindex IIDgenoptra2
19987 .ecindex IIDgenoptra3
19988
19989
19990
19991
19992
19993
19994 . ////////////////////////////////////////////////////////////////////////////
19995 . ////////////////////////////////////////////////////////////////////////////
19996
19997 .chapter "Address batching in local transports" "CHAPbatching" &&&
19998          "Address batching"
19999 .cindex "transport" "local; address batching in"
20000 The only remote transport (&(smtp)&) is normally configured to handle more than
20001 one address at a time, so that when several addresses are routed to the same
20002 remote host, just one copy of the message is sent. Local transports, however,
20003 normally handle one address at a time. That is, a separate instance of the
20004 transport is run for each address that is routed to the transport. A separate
20005 copy of the message is delivered each time.
20006
20007 .cindex "batched local delivery"
20008 .oindex "&%batch_max%&"
20009 .oindex "&%batch_id%&"
20010 In special cases, it may be desirable to handle several addresses at once in a
20011 local transport, for example:
20012
20013 .ilist
20014 In an &(appendfile)& transport, when storing messages in files for later
20015 delivery by some other means, a single copy of the message with multiple
20016 recipients saves space.
20017 .next
20018 In an &(lmtp)& transport, when delivering over &"local SMTP"& to some process,
20019 a single copy saves time, and is the normal way LMTP is expected to work.
20020 .next
20021 In a &(pipe)& transport, when passing the message
20022 to a scanner program or
20023 to some other delivery mechanism such as UUCP, multiple recipients may be
20024 acceptable.
20025 .endlist
20026
20027 These three local transports all have the same options for controlling multiple
20028 (&"batched"&) deliveries, namely &%batch_max%& and &%batch_id%&. To save
20029 repeating the information for each transport, these options are described here.
20030
20031 The &%batch_max%& option specifies the maximum number of addresses that can be
20032 delivered together in a single run of the transport. Its default value is one
20033 (no batching). When more than one address is routed to a transport that has a
20034 &%batch_max%& value greater than one, the addresses are delivered in a batch
20035 (that is, in a single run of the transport with multiple recipients), subject
20036 to certain conditions:
20037
20038 .ilist
20039 .vindex "&$local_part$&"
20040 If any of the transport's options contain a reference to &$local_part$&, no
20041 batching is possible.
20042 .next
20043 .vindex "&$domain$&"
20044 If any of the transport's options contain a reference to &$domain$&, only
20045 addresses with the same domain are batched.
20046 .next
20047 .cindex "customizing" "batching condition"
20048 If &%batch_id%& is set, it is expanded for each address, and only those
20049 addresses with the same expanded value are batched. This allows you to specify
20050 customized batching conditions. Failure of the expansion for any reason,
20051 including forced failure, disables batching, but it does not stop the delivery
20052 from taking place.
20053 .next
20054 Batched addresses must also have the same errors address (where to send
20055 delivery errors), the same header additions and removals, the same user and
20056 group for the transport, and if a host list is present, the first host must
20057 be the same.
20058 .endlist
20059
20060 In the case of the &(appendfile)& and &(pipe)& transports, batching applies
20061 both when the file or pipe command is specified in the transport, and when it
20062 is specified by a &(redirect)& router, but all the batched addresses must of
20063 course be routed to the same file or pipe command. These two transports have an
20064 option called &%use_bsmtp%&, which causes them to deliver the message in
20065 &"batched SMTP"& format, with the envelope represented as SMTP commands. The
20066 &%check_string%& and &%escape_string%& options are forced to the values
20067 .code
20068 check_string = "."
20069 escape_string = ".."
20070 .endd
20071 when batched SMTP is in use. A full description of the batch SMTP mechanism is
20072 given in section &<<SECTbatchSMTP>>&. The &(lmtp)& transport does not have a
20073 &%use_bsmtp%& option, because it always delivers using the SMTP protocol.
20074
20075 .cindex "&'Envelope-to:'& header line"
20076 If the generic &%envelope_to_add%& option is set for a batching transport, the
20077 &'Envelope-to:'& header that is added to the message contains all the addresses
20078 that are being processed together. If you are using a batching &(appendfile)&
20079 transport without &%use_bsmtp%&, the only way to preserve the recipient
20080 addresses is to set the &%envelope_to_add%& option.
20081
20082 .cindex "&(pipe)& transport" "with multiple addresses"
20083 .vindex "&$pipe_addresses$&"
20084 If you are using a &(pipe)& transport without BSMTP, and setting the
20085 transport's &%command%& option, you can include &$pipe_addresses$& as part of
20086 the command. This is not a true variable; it is a bit of magic that causes each
20087 of the recipient addresses to be inserted into the command as a separate
20088 argument. This provides a way of accessing all the addresses that are being
20089 delivered in the batch. &*Note:*& This is not possible for pipe commands that
20090 are specified by a &(redirect)& router.
20091
20092
20093
20094
20095 . ////////////////////////////////////////////////////////////////////////////
20096 . ////////////////////////////////////////////////////////////////////////////
20097
20098 .chapter "The appendfile transport" "CHAPappendfile"
20099 .scindex IIDapptra1 "&(appendfile)& transport"
20100 .scindex IIDapptra2 "transports" "&(appendfile)&"
20101 .cindex "directory creation"
20102 .cindex "creating directories"
20103 The &(appendfile)& transport delivers a message by appending it to an existing
20104 file, or by creating an entirely new file in a specified directory. Single
20105 files to which messages are appended can be in the traditional Unix mailbox
20106 format, or optionally in the MBX format supported by the Pine MUA and
20107 University of Washington IMAP daemon, &'inter alia'&. When each message is
20108 being delivered as a separate file, &"maildir"& format can optionally be used
20109 to give added protection against failures that happen part-way through the
20110 delivery. A third form of separate-file delivery known as &"mailstore"& is also
20111 supported. For all file formats, Exim attempts to create as many levels of
20112 directory as necessary, provided that &%create_directory%& is set.
20113
20114 The code for the optional formats is not included in the Exim binary by
20115 default. It is necessary to set SUPPORT_MBX, SUPPORT_MAILDIR and/or
20116 SUPPORT_MAILSTORE in &_Local/Makefile_& to have the appropriate code
20117 included.
20118
20119 .cindex "quota" "system"
20120 Exim recognizes system quota errors, and generates an appropriate message. Exim
20121 also supports its own quota control within the transport, for use when the
20122 system facility is unavailable or cannot be used for some reason.
20123
20124 If there is an error while appending to a file (for example, quota exceeded or
20125 partition filled), Exim attempts to reset the file's length and last
20126 modification time back to what they were before. If there is an error while
20127 creating an entirely new file, the new file is removed.
20128
20129 Before appending to a file, a number of security checks are made, and the
20130 file is locked. A detailed description is given below, after the list of
20131 private options.
20132
20133 The &(appendfile)& transport is most commonly used for local deliveries to
20134 users' mailboxes. However, it can also be used as a pseudo-remote transport for
20135 putting messages into files for remote delivery by some means other than Exim.
20136 &"Batch SMTP"& format is often used in this case (see the &%use_bsmtp%&
20137 option).
20138
20139
20140
20141 .section "The file and directory options" "SECTfildiropt"
20142 The &%file%& option specifies a single file, to which the message is appended;
20143 the &%directory%& option specifies a directory, in which a new file containing
20144 the message is created. Only one of these two options can be set, and for
20145 normal deliveries to mailboxes, one of them &'must'& be set.
20146
20147 .vindex "&$address_file$&"
20148 .vindex "&$local_part$&"
20149 However, &(appendfile)& is also used for delivering messages to files or
20150 directories whose names (or parts of names) are obtained from alias,
20151 forwarding, or filtering operations (for example, a &%save%& command in a
20152 user's Exim filter). When such a transport is running, &$local_part$& contains
20153 the local part that was aliased or forwarded, and &$address_file$& contains the
20154 name (or partial name) of the file or directory generated by the redirection
20155 operation. There are two cases:
20156
20157 .ilist
20158 If neither &%file%& nor &%directory%& is set, the redirection operation
20159 must specify an absolute path (one that begins with &`/`&). This is the most
20160 common case when users with local accounts use filtering to sort mail into
20161 different folders. See for example, the &(address_file)& transport in the
20162 default configuration. If the path ends with a slash, it is assumed to be the
20163 name of a directory. A delivery to a directory can also be forced by setting
20164 &%maildir_format%& or &%mailstore_format%&.
20165 .next
20166 If &%file%& or &%directory%& is set for a delivery from a redirection, it is
20167 used to determine the file or directory name for the delivery. Normally, the
20168 contents of &$address_file$& are used in some way in the string expansion.
20169 .endlist
20170
20171
20172 .cindex "Sieve filter" "configuring &(appendfile)&"
20173 .cindex "Sieve filter" "relative mailbox path handling"
20174 As an example of the second case, consider an environment where users do not
20175 have home directories. They may be permitted to use Exim filter commands of the
20176 form:
20177 .code
20178 save folder23
20179 .endd
20180 or Sieve filter commands of the form:
20181 .code
20182 require "fileinto";
20183 fileinto "folder23";
20184 .endd
20185 In this situation, the expansion of &%file%& or &%directory%& in the transport
20186 must transform the relative path into an appropriate absolute file name. In the
20187 case of Sieve filters, the name &'inbox'& must be handled. It is the name that
20188 is used as a result of a &"keep"& action in the filter. This example shows one
20189 way of handling this requirement:
20190 .code
20191 file = ${if eq{$address_file}{inbox} \
20192             {/var/mail/$local_part} \
20193             {${if eq{${substr_0_1:$address_file}}{/} \
20194                   {$address_file} \
20195                   {$home/mail/$address_file} \
20196             }} \
20197        }
20198 .endd
20199 With this setting of &%file%&, &'inbox'& refers to the standard mailbox
20200 location, absolute paths are used without change, and other folders are in the
20201 &_mail_& directory within the home directory.
20202
20203 &*Note 1*&: While processing an Exim filter, a relative path such as
20204 &_folder23_& is turned into an absolute path if a home directory is known to
20205 the router. In particular, this is the case if &%check_local_user%& is set. If
20206 you want to prevent this happening at routing time, you can set
20207 &%router_home_directory%& empty. This forces the router to pass the relative
20208 path to the transport.
20209
20210 &*Note 2*&: An absolute path in &$address_file$& is not treated specially;
20211 the &%file%& or &%directory%& option is still used if it is set.
20212
20213
20214
20215
20216 .section "Private options for appendfile" "SECID134"
20217 .cindex "options" "&(appendfile)& transport"
20218
20219
20220
20221 .option allow_fifo appendfile boolean false
20222 .cindex "fifo (named pipe)"
20223 .cindex "named pipe (fifo)"
20224 .cindex "pipe" "named (fifo)"
20225 Setting this option permits delivery to named pipes (FIFOs) as well as to
20226 regular files. If no process is reading the named pipe at delivery time, the
20227 delivery is deferred.
20228
20229
20230 .option allow_symlink appendfile boolean false
20231 .cindex "symbolic link" "to mailbox"
20232 .cindex "mailbox" "symbolic link"
20233 By default, &(appendfile)& will not deliver if the path name for the file is
20234 that of a symbolic link. Setting this option relaxes that constraint, but there
20235 are security issues involved in the use of symbolic links. Be sure you know
20236 what you are doing if you set this. Details of exactly what this option affects
20237 are included in the discussion which follows this list of options.
20238
20239
20240 .option batch_id appendfile string&!! unset
20241 See the description of local delivery batching in chapter &<<CHAPbatching>>&.
20242 However, batching is automatically disabled for &(appendfile)& deliveries that
20243 happen as a result of forwarding or aliasing or other redirection directly to a
20244 file.
20245
20246
20247 .option batch_max appendfile integer 1
20248 See the description of local delivery batching in chapter &<<CHAPbatching>>&.
20249
20250
20251 .option check_group appendfile boolean false
20252 When this option is set, the group owner of the file defined by the &%file%&
20253 option is checked to see that it is the same as the group under which the
20254 delivery process is running. The default setting is false because the default
20255 file mode is 0600, which means that the group is irrelevant.
20256
20257
20258 .option check_owner appendfile boolean true
20259 When this option is set, the owner of the file defined by the &%file%& option
20260 is checked to ensure that it is the same as the user under which the delivery
20261 process is running.
20262
20263
20264 .option check_string appendfile string "see below"
20265 .cindex "&""From""& line"
20266 As &(appendfile)& writes the message, the start of each line is tested for
20267 matching &%check_string%&, and if it does, the initial matching characters are
20268 replaced by the contents of &%escape_string%&. The value of &%check_string%& is
20269 a literal string, not a regular expression, and the case of any letters it
20270 contains is significant.
20271
20272 If &%use_bsmtp%& is set the values of &%check_string%& and &%escape_string%&
20273 are forced to &"."& and &".."& respectively, and any settings in the
20274 configuration are ignored. Otherwise, they default to &"From&~"& and
20275 &">From&~"& when the &%file%& option is set, and unset when any of the
20276 &%directory%&, &%maildir%&, or &%mailstore%& options are set.
20277
20278 The default settings, along with &%message_prefix%& and &%message_suffix%&, are
20279 suitable for traditional &"BSD"& mailboxes, where a line beginning with
20280 &"From&~"& indicates the start of a new message. All four options need changing
20281 if another format is used. For example, to deliver to mailboxes in MMDF format:
20282 .cindex "MMDF format mailbox"
20283 .cindex "mailbox" "MMDF format"
20284 .code
20285 check_string = "\1\1\1\1\n"
20286 escape_string = "\1\1\1\1 \n"
20287 message_prefix = "\1\1\1\1\n"
20288 message_suffix = "\1\1\1\1\n"
20289 .endd
20290 .option create_directory appendfile boolean true
20291 .cindex "directory creation"
20292 When this option is true, Exim attempts to create any missing superior
20293 directories for the file that it is about to write. A created directory's mode
20294 is given by the &%directory_mode%& option.
20295
20296 The group ownership of a newly created directory is highly dependent on the
20297 operating system (and possibly the file system) that is being used. For
20298 example, in Solaris, if the parent directory has the setgid bit set, its group
20299 is propagated to the child; if not, the currently set group is used. However,
20300 in FreeBSD, the parent's group is always used.
20301
20302
20303
20304 .option create_file appendfile string anywhere
20305 This option constrains the location of files and directories that are created
20306 by this transport. It applies to files defined by the &%file%& option and
20307 directories defined by the &%directory%& option. In the case of maildir
20308 delivery, it applies to the top level directory, not the maildir directories
20309 beneath.
20310
20311 The option must be set to one of the words &"anywhere"&, &"inhome"&, or
20312 &"belowhome"&. In the second and third cases, a home directory must have been
20313 set for the transport. This option is not useful when an explicit file name is
20314 given for normal mailbox deliveries. It is intended for the case when file
20315 names are generated from users' &_.forward_& files. These are usually handled
20316 by an &(appendfile)& transport called &%address_file%&. See also
20317 &%file_must_exist%&.
20318
20319
20320 .option directory appendfile string&!! unset
20321 This option is mutually exclusive with the &%file%& option, but one of &%file%&
20322 or &%directory%& must be set, unless the delivery is the direct result of a
20323 redirection (see section &<<SECTfildiropt>>&).
20324
20325 When &%directory%& is set, the string is expanded, and the message is delivered
20326 into a new file or files in or below the given directory, instead of being
20327 appended to a single mailbox file. A number of different formats are provided
20328 (see &%maildir_format%& and &%mailstore_format%&), and see section
20329 &<<SECTopdir>>& for further details of this form of delivery.
20330
20331
20332 .option directory_file appendfile string&!! "see below"
20333 .cindex "base62"
20334 .vindex "&$inode$&"
20335 When &%directory%& is set, but neither &%maildir_format%& nor
20336 &%mailstore_format%& is set, &(appendfile)& delivers each message into a file
20337 whose name is obtained by expanding this string. The default value is:
20338 .code
20339 q${base62:$tod_epoch}-$inode
20340 .endd
20341 This generates a unique name from the current time, in base 62 form, and the
20342 inode of the file. The variable &$inode$& is available only when expanding this
20343 option.
20344
20345
20346 .option directory_mode appendfile "octal integer" 0700
20347 If &(appendfile)& creates any directories as a result of the
20348 &%create_directory%& option, their mode is specified by this option.
20349
20350
20351 .option escape_string appendfile string "see description"
20352 See &%check_string%& above.
20353
20354
20355 .option file appendfile string&!! unset
20356 This option is mutually exclusive with the &%directory%& option, but one of
20357 &%file%& or &%directory%& must be set, unless the delivery is the direct result
20358 of a redirection (see section &<<SECTfildiropt>>&). The &%file%& option
20359 specifies a single file, to which the message is appended. One or more of
20360 &%use_fcntl_lock%&, &%use_flock_lock%&, or &%use_lockfile%& must be set with
20361 &%file%&.
20362
20363 .cindex "NFS" "lock file"
20364 .cindex "locking files"
20365 .cindex "lock files"
20366 If you are using more than one host to deliver over NFS into the same
20367 mailboxes, you should always use lock files.
20368
20369 The string value is expanded for each delivery, and must yield an absolute
20370 path. The most common settings of this option are variations on one of these
20371 examples:
20372 .code
20373 file = /var/spool/mail/$local_part
20374 file = /home/$local_part/inbox
20375 file = $home/inbox
20376 .endd
20377 .cindex "&""sticky""& bit"
20378 In the first example, all deliveries are done into the same directory. If Exim
20379 is configured to use lock files (see &%use_lockfile%& below) it must be able to
20380 create a file in the directory, so the &"sticky"& bit must be turned on for
20381 deliveries to be possible, or alternatively the &%group%& option can be used to
20382 run the delivery under a group id which has write access to the directory.
20383
20384
20385
20386 .option file_format appendfile string unset
20387 .cindex "file" "mailbox; checking existing format"
20388 This option requests the transport to check the format of an existing file
20389 before adding to it. The check consists of matching a specific string at the
20390 start of the file. The value of the option consists of an even number of
20391 colon-separated strings. The first of each pair is the test string, and the
20392 second is the name of a transport. If the transport associated with a matched
20393 string is not the current transport, control is passed over to the other
20394 transport. For example, suppose the standard &(local_delivery)& transport has
20395 this added to it:
20396 .code
20397 file_format = "From       : local_delivery :\
20398                \1\1\1\1\n : local_mmdf_delivery"
20399 .endd
20400 Mailboxes that begin with &"From"& are still handled by this transport, but if
20401 a mailbox begins with four binary ones followed by a newline, control is passed
20402 to a transport called &%local_mmdf_delivery%&, which presumably is configured
20403 to do the delivery in MMDF format. If a mailbox does not exist or is empty, it
20404 is assumed to match the current transport. If the start of a mailbox doesn't
20405 match any string, or if the transport named for a given string is not defined,
20406 delivery is deferred.
20407
20408
20409 .option file_must_exist appendfile boolean false
20410 If this option is true, the file specified by the &%file%& option must exist.
20411 A temporary error occurs if it does not, causing delivery to be deferred.
20412 If this option is false, the file is created if it does not exist.
20413
20414
20415 .option lock_fcntl_timeout appendfile time 0s
20416 .cindex "timeout" "mailbox locking"
20417 .cindex "mailbox" "locking, blocking and non-blocking"
20418 .cindex "locking files"
20419 By default, the &(appendfile)& transport uses non-blocking calls to &[fcntl()]&
20420 when locking an open mailbox file. If the call fails, the delivery process
20421 sleeps for &%lock_interval%& and tries again, up to &%lock_retries%& times.
20422 Non-blocking calls are used so that the file is not kept open during the wait
20423 for the lock; the reason for this is to make it as safe as possible for
20424 deliveries over NFS in the case when processes might be accessing an NFS
20425 mailbox without using a lock file. This should not be done, but
20426 misunderstandings and hence misconfigurations are not unknown.
20427
20428 On a busy system, however, the performance of a non-blocking lock approach is
20429 not as good as using a blocking lock with a timeout. In this case, the waiting
20430 is done inside the system call, and Exim's delivery process acquires the lock
20431 and can proceed as soon as the previous lock holder releases it.
20432
20433 If &%lock_fcntl_timeout%& is set to a non-zero time, blocking locks, with that
20434 timeout, are used. There may still be some retrying: the maximum number of
20435 retries is
20436 .code
20437 (lock_retries * lock_interval) / lock_fcntl_timeout
20438 .endd
20439 rounded up to the next whole number. In other words, the total time during
20440 which &(appendfile)& is trying to get a lock is roughly the same, unless
20441 &%lock_fcntl_timeout%& is set very large.
20442
20443 You should consider setting this option if you are getting a lot of delayed
20444 local deliveries because of errors of the form
20445 .code
20446 failed to lock mailbox /some/file (fcntl)
20447 .endd
20448
20449 .option lock_flock_timeout appendfile time 0s
20450 This timeout applies to file locking when using &[flock()]& (see
20451 &%use_flock%&); the timeout operates in a similar manner to
20452 &%lock_fcntl_timeout%&.
20453
20454
20455 .option lock_interval appendfile time 3s
20456 This specifies the time to wait between attempts to lock the file. See below
20457 for details of locking.
20458
20459
20460 .option lock_retries appendfile integer 10
20461 This specifies the maximum number of attempts to lock the file. A value of zero
20462 is treated as 1. See below for details of locking.
20463
20464
20465 .option lockfile_mode appendfile "octal integer" 0600
20466 This specifies the mode of the created lock file, when a lock file is being
20467 used (see &%use_lockfile%& and &%use_mbx_lock%&).
20468
20469
20470 .option lockfile_timeout appendfile time 30m
20471 .cindex "timeout" "mailbox locking"
20472 When a lock file is being used (see &%use_lockfile%&), if a lock file already
20473 exists and is older than this value, it is assumed to have been left behind by
20474 accident, and Exim attempts to remove it.
20475
20476
20477 .option mailbox_filecount appendfile string&!! unset
20478 .cindex "mailbox" "specifying size of"
20479 .cindex "size" "of mailbox"
20480 If this option is set, it is expanded, and the result is taken as the current
20481 number of files in the mailbox. It must be a decimal number, optionally
20482 followed by K or M. This provides a way of obtaining this information from an
20483 external source that maintains the data.
20484
20485
20486 .option mailbox_size appendfile string&!! unset
20487 .cindex "mailbox" "specifying size of"
20488 .cindex "size" "of mailbox"
20489 If this option is set, it is expanded, and the result is taken as the current
20490 size the mailbox. It must be a decimal number, optionally followed by K or M.
20491 This provides a way of obtaining this information from an external source that
20492 maintains the data. This is likely to be helpful for maildir deliveries where
20493 it is computationally expensive to compute the size of a mailbox.
20494
20495
20496
20497 .option maildir_format appendfile boolean false
20498 .cindex "maildir format" "specifying"
20499 If this option is set with the &%directory%& option, the delivery is into a new
20500 file, in the &"maildir"& format that is used by other mail software. When the
20501 transport is activated directly from a &(redirect)& router (for example, the
20502 &(address_file)& transport in the default configuration), setting
20503 &%maildir_format%& causes the path received from the router to be treated as a
20504 directory, whether or not it ends with &`/`&. This option is available only if
20505 SUPPORT_MAILDIR is present in &_Local/Makefile_&. See section
20506 &<<SECTmaildirdelivery>>& below for further details.
20507
20508
20509 .option maildir_quota_directory_regex appendfile string "See below"
20510 .cindex "maildir format" "quota; directories included in"
20511 .cindex "quota" "maildir; directories included in"
20512 This option is relevant only when &%maildir_use_size_file%& is set. It defines
20513 a regular expression for specifying directories, relative to the quota
20514 directory (see &%quota_directory%&), that should be included in the quota
20515 calculation. The default value is:
20516 .code
20517 maildir_quota_directory_regex = ^(?:cur|new|\..*)$
20518 .endd
20519 This includes the &_cur_& and &_new_& directories, and any maildir++ folders
20520 (directories whose names begin with a dot). If you want to exclude the
20521 &_Trash_&
20522 folder from the count (as some sites do), you need to change this setting to
20523 .code
20524 maildir_quota_directory_regex = ^(?:cur|new|\.(?!Trash).*)$
20525 .endd
20526 This uses a negative lookahead in the regular expression to exclude the
20527 directory whose name is &_.Trash_&. When a directory is excluded from quota
20528 calculations, quota processing is bypassed for any messages that are delivered
20529 directly into that directory.
20530
20531
20532 .option maildir_retries appendfile integer 10
20533 This option specifies the number of times to retry when writing a file in
20534 &"maildir"& format. See section &<<SECTmaildirdelivery>>& below.
20535
20536
20537 .option maildir_tag appendfile string&!! unset
20538 This option applies only to deliveries in maildir format, and is described in
20539 section &<<SECTmaildirdelivery>>& below.
20540
20541
20542 .option maildir_use_size_file appendfile&!! boolean false
20543 .cindex "maildir format" "&_maildirsize_& file"
20544 The result of string expansion for this option must be a valid boolean value.
20545 If it is true, it enables support for &_maildirsize_& files. Exim
20546 creates a &_maildirsize_& file in a maildir if one does not exist, taking the
20547 quota from the &%quota%& option of the transport. If &%quota%& is unset, the
20548 value is zero. See &%maildir_quota_directory_regex%& above and section
20549 &<<SECTmaildirdelivery>>& below for further details.
20550
20551 .option maildirfolder_create_regex appendfile string unset
20552 .cindex "maildir format" "&_maildirfolder_& file"
20553 .cindex "&_maildirfolder_&, creating"
20554 The value of this option is a regular expression. If it is unset, it has no
20555 effect. Otherwise, before a maildir delivery takes place, the pattern is
20556 matched against the name of the maildir directory, that is, the directory
20557 containing the &_new_& and &_tmp_& subdirectories that will be used for the
20558 delivery. If there is a match, Exim checks for the existence of a file called
20559 &_maildirfolder_& in the directory, and creates it if it does not exist.
20560 See section &<<SECTmaildirdelivery>>& for more details.
20561
20562
20563 .option mailstore_format appendfile boolean false
20564 .cindex "mailstore format" "specifying"
20565 If this option is set with the &%directory%& option, the delivery is into two
20566 new files in  &"mailstore"& format. The option is available only if
20567 SUPPORT_MAILSTORE is present in &_Local/Makefile_&. See section &<<SECTopdir>>&
20568 below for further details.
20569
20570
20571 .option mailstore_prefix appendfile string&!! unset
20572 This option applies only to deliveries in mailstore format, and is described in
20573 section &<<SECTopdir>>& below.
20574
20575
20576 .option mailstore_suffix appendfile string&!! unset
20577 This option applies only to deliveries in mailstore format, and is described in
20578 section &<<SECTopdir>>& below.
20579
20580
20581 .option mbx_format appendfile boolean false
20582 .cindex "locking files"
20583 .cindex "file" "locking"
20584 .cindex "file" "MBX format"
20585 .cindex "MBX format, specifying"
20586 This option is available only if Exim has been compiled with SUPPORT_MBX
20587 set in &_Local/Makefile_&. If &%mbx_format%& is set with the &%file%& option,
20588 the message is appended to the mailbox file in MBX format instead of
20589 traditional Unix format. This format is supported by Pine4 and its associated
20590 IMAP and POP daemons, by means of the &'c-client'& library that they all use.
20591
20592 &*Note*&: The &%message_prefix%& and &%message_suffix%& options are not
20593 automatically changed by the use of &%mbx_format%&. They should normally be set
20594 empty when using MBX format, so this option almost always appears in this
20595 combination:
20596 .code
20597 mbx_format = true
20598 message_prefix =
20599 message_suffix =
20600 .endd
20601 If none of the locking options are mentioned in the configuration,
20602 &%use_mbx_lock%& is assumed and the other locking options default to false. It
20603 is possible to specify the other kinds of locking with &%mbx_format%&, but
20604 &%use_fcntl_lock%& and &%use_mbx_lock%& are mutually exclusive. MBX locking
20605 interworks with &'c-client'&, providing for shared access to the mailbox. It
20606 should not be used if any program that does not use this form of locking is
20607 going to access the mailbox, nor should it be used if the mailbox file is NFS
20608 mounted, because it works only when the mailbox is accessed from a single host.
20609
20610 If you set &%use_fcntl_lock%& with an MBX-format mailbox, you cannot use
20611 the standard version of &'c-client'&, because as long as it has a mailbox open
20612 (this means for the whole of a Pine or IMAP session), Exim will not be able to
20613 append messages to it.
20614
20615
20616 .option message_prefix appendfile string&!! "see below"
20617 .cindex "&""From""& line"
20618 The string specified here is expanded and output at the start of every message.
20619 The default is unset unless &%file%& is specified and &%use_bsmtp%& is not set,
20620 in which case it is:
20621 .code
20622 message_prefix = "From ${if def:return_path{$return_path}\
20623   {MAILER-DAEMON}} $tod_bsdinbox\n"
20624 .endd
20625 &*Note:*& If you set &%use_crlf%& true, you must change any occurrences of
20626 &`\n`& to &`\r\n`& in &%message_prefix%&.
20627
20628 .option message_suffix appendfile string&!! "see below"
20629 The string specified here is expanded and output at the end of every message.
20630 The default is unset unless &%file%& is specified and &%use_bsmtp%& is not set,
20631 in which case it is a single newline character. The suffix can be suppressed by
20632 setting
20633 .code
20634 message_suffix =
20635 .endd
20636 &*Note:*& If you set &%use_crlf%& true, you must change any occurrences of
20637 &`\n`& to &`\r\n`& in &%message_suffix%&.
20638
20639 .option mode appendfile "octal integer" 0600
20640 If the output file is created, it is given this mode. If it already exists and
20641 has wider permissions, they are reduced to this mode. If it has narrower
20642 permissions, an error occurs unless &%mode_fail_narrower%& is false. However,
20643 if the delivery is the result of a &%save%& command in a filter file specifying
20644 a particular mode, the mode of the output file is always forced to take that
20645 value, and this option is ignored.
20646
20647
20648 .option mode_fail_narrower appendfile boolean true
20649 This option applies in the case when an existing mailbox file has a narrower
20650 mode than that specified by the &%mode%& option. If &%mode_fail_narrower%& is
20651 true, the delivery is deferred (&"mailbox has the wrong mode"&); otherwise Exim
20652 continues with the delivery attempt, using the existing mode of the file.
20653
20654
20655 .option notify_comsat appendfile boolean false
20656 If this option is true, the &'comsat'& daemon is notified after every
20657 successful delivery to a user mailbox. This is the daemon that notifies logged
20658 on users about incoming mail.
20659
20660
20661 .option quota appendfile string&!! unset
20662 .cindex "quota" "imposed by Exim"
20663 This option imposes a limit on the size of the file to which Exim is appending,
20664 or to the total space used in the directory tree when the &%directory%& option
20665 is set. In the latter case, computation of the space used is expensive, because
20666 all the files in the directory (and any sub-directories) have to be
20667 individually inspected and their sizes summed. (See &%quota_size_regex%& and
20668 &%maildir_use_size_file%& for ways to avoid this in environments where users
20669 have no shell access to their mailboxes).
20670
20671 As there is no interlock against two simultaneous deliveries into a
20672 multi-file mailbox, it is possible for the quota to be overrun in this case.
20673 For single-file mailboxes, of course, an interlock is a necessity.
20674
20675 A file's size is taken as its &'used'& value. Because of blocking effects, this
20676 may be a lot less than the actual amount of disk space allocated to the file.
20677 If the sizes of a number of files are being added up, the rounding effect can
20678 become quite noticeable, especially on systems that have large block sizes.
20679 Nevertheless, it seems best to stick to the &'used'& figure, because this is
20680 the obvious value which users understand most easily.
20681
20682 The value of the option is expanded, and must then be a numerical value
20683 (decimal point allowed), optionally followed by one of the letters K, M, or G,
20684 for kilobytes, megabytes, or gigabytes. If Exim is running on a system with
20685 large file support (Linux and FreeBSD have this), mailboxes larger than 2G can
20686 be handled.
20687
20688 &*Note*&: A value of zero is interpreted as &"no quota"&.
20689
20690 The expansion happens while Exim is running as root, before it changes uid for
20691 the delivery. This means that files that are inaccessible to the end user can
20692 be used to hold quota values that are looked up in the expansion. When delivery
20693 fails because this quota is exceeded, the handling of the error is as for
20694 system quota failures.
20695
20696 By default, Exim's quota checking mimics system quotas, and restricts the
20697 mailbox to the specified maximum size, though the value is not accurate to the
20698 last byte, owing to separator lines and additional headers that may get added
20699 during message delivery. When a mailbox is nearly full, large messages may get
20700 refused even though small ones are accepted, because the size of the current
20701 message is added to the quota when the check is made. This behaviour can be
20702 changed by setting &%quota_is_inclusive%& false. When this is done, the check
20703 for exceeding the quota does not include the current message. Thus, deliveries
20704 continue until the quota has been exceeded; thereafter, no further messages are
20705 delivered. See also &%quota_warn_threshold%&.
20706
20707
20708 .option quota_directory appendfile string&!! unset
20709 This option defines the directory to check for quota purposes when delivering
20710 into individual files. The default is the delivery directory, or, if a file
20711 called &_maildirfolder_& exists in a maildir directory, the parent of the
20712 delivery directory.
20713
20714
20715 .option quota_filecount appendfile string&!! 0
20716 This option applies when the &%directory%& option is set. It limits the total
20717 number of files in the directory (compare the inode limit in system quotas). It
20718 can only be used if &%quota%& is also set. The value is expanded; an expansion
20719 failure causes delivery to be deferred. A value of zero is interpreted as
20720 &"no quota"&.
20721
20722
20723 .option quota_is_inclusive appendfile boolean true
20724 See &%quota%& above.
20725
20726
20727 .option quota_size_regex appendfile string unset
20728 This option applies when one of the delivery modes that writes a separate file
20729 for each message is being used. When Exim wants to find the size of one of
20730 these files in order to test the quota, it first checks &%quota_size_regex%&.
20731 If this is set to a regular expression that matches the file name, and it
20732 captures one string, that string is interpreted as a representation of the
20733 file's size. The value of &%quota_size_regex%& is not expanded.
20734
20735 This feature is useful only when users have no shell access to their mailboxes
20736 &-- otherwise they could defeat the quota simply by renaming the files. This
20737 facility can be used with maildir deliveries, by setting &%maildir_tag%& to add
20738 the file length to the file name. For example:
20739 .code
20740 maildir_tag = ,S=$message_size
20741 quota_size_regex = ,S=(\d+)
20742 .endd
20743 An alternative to &$message_size$& is &$message_linecount$&, which contains the
20744 number of lines in the message.
20745
20746 The regular expression should not assume that the length is at the end of the
20747 file name (even though &%maildir_tag%& puts it there) because maildir MUAs
20748 sometimes add other information onto the ends of message file names.
20749
20750 Section &<<SECID136>>& contains further information.
20751
20752
20753 .option quota_warn_message appendfile string&!! "see below"
20754 See below for the use of this option. If it is not set when
20755 &%quota_warn_threshold%& is set, it defaults to
20756 .code
20757 quota_warn_message = "\
20758   To: $local_part@$domain\n\
20759   Subject: Your mailbox\n\n\
20760   This message is automatically created \
20761   by mail delivery software.\n\n\
20762   The size of your mailbox has exceeded \
20763   a warning threshold that is\n\
20764   set by the system administrator.\n"
20765 .endd
20766
20767
20768 .option quota_warn_threshold appendfile string&!! 0
20769 .cindex "quota" "warning threshold"
20770 .cindex "mailbox" "size warning"
20771 .cindex "size" "of mailbox"
20772 This option is expanded in the same way as &%quota%& (see above). If the
20773 resulting value is greater than zero, and delivery of the message causes the
20774 size of the file or total space in the directory tree to cross the given
20775 threshold, a warning message is sent. If &%quota%& is also set, the threshold
20776 may be specified as a percentage of it by following the value with a percent
20777 sign. For example:
20778 .code
20779 quota = 10M
20780 quota_warn_threshold = 75%
20781 .endd
20782 If &%quota%& is not set, a setting of &%quota_warn_threshold%& that ends with a
20783 percent sign is ignored.
20784
20785 The warning message itself is specified by the &%quota_warn_message%& option,
20786 and it must start with a &'To:'& header line containing the recipient(s) of the
20787 warning message. These do not necessarily have to include the recipient(s) of
20788 the original message. A &'Subject:'& line should also normally be supplied. You
20789 can include any other header lines that you want. If you do not include a
20790 &'From:'& line, the default is:
20791 .code
20792 From: Mail Delivery System <mailer-daemon@$qualify_domain_sender>
20793 .endd
20794 .oindex &%errors_reply_to%&
20795 If you supply a &'Reply-To:'& line, it overrides the global &%errors_reply_to%&
20796 option.
20797
20798 The &%quota%& option does not have to be set in order to use this option; they
20799 are independent of one another except when the threshold is specified as a
20800 percentage.
20801
20802
20803 .option use_bsmtp appendfile boolean false
20804 .cindex "envelope sender"
20805 If this option is set true, &(appendfile)& writes messages in &"batch SMTP"&
20806 format, with the envelope sender and recipient(s) included as SMTP commands. If
20807 you want to include a leading HELO command with such messages, you can do
20808 so by setting the &%message_prefix%& option. See section &<<SECTbatchSMTP>>&
20809 for details of batch SMTP.
20810
20811
20812 .option use_crlf appendfile boolean false
20813 .cindex "carriage return"
20814 .cindex "linefeed"
20815 This option causes lines to be terminated with the two-character CRLF sequence
20816 (carriage return, linefeed) instead of just a linefeed character. In the case
20817 of batched SMTP, the byte sequence written to the file is then an exact image
20818 of what would be sent down a real SMTP connection.
20819
20820 &*Note:*& The contents of the &%message_prefix%& and &%message_suffix%& options
20821 (which are used to supply the traditional &"From&~"& and blank line separators
20822 in Berkeley-style mailboxes) are written verbatim, so must contain their own
20823 carriage return characters if these are needed. In cases where these options
20824 have non-empty defaults, the values end with a single linefeed, so they must be
20825 changed to end with &`\r\n`& if &%use_crlf%& is set.
20826
20827
20828 .option use_fcntl_lock appendfile boolean "see below"
20829 This option controls the use of the &[fcntl()]& function to lock a file for
20830 exclusive use when a message is being appended. It is set by default unless
20831 &%use_flock_lock%& is set. Otherwise, it should be turned off only if you know
20832 that all your MUAs use lock file locking. When both &%use_fcntl_lock%& and
20833 &%use_flock_lock%& are unset, &%use_lockfile%& must be set.
20834
20835
20836 .option use_flock_lock appendfile boolean false
20837 This option is provided to support the use of &[flock()]& for file locking, for
20838 the few situations where it is needed. Most modern operating systems support
20839 &[fcntl()]& and &[lockf()]& locking, and these two functions interwork with
20840 each other. Exim uses &[fcntl()]& locking by default.
20841
20842 This option is required only if you are using an operating system where
20843 &[flock()]& is used by programs that access mailboxes (typically MUAs), and
20844 where &[flock()]& does not correctly interwork with &[fcntl()]&. You can use
20845 both &[fcntl()]& and &[flock()]& locking simultaneously if you want.
20846
20847 .cindex "Solaris" "&[flock()]& support"
20848 Not all operating systems provide &[flock()]&. Some versions of Solaris do not
20849 have it (and some, I think, provide a not quite right version built on top of
20850 &[lockf()]&). If the OS does not have &[flock()]&, Exim will be built without
20851 the ability to use it, and any attempt to do so will cause a configuration
20852 error.
20853
20854 &*Warning*&: &[flock()]& locks do not work on NFS files (unless &[flock()]&
20855 is just being mapped onto &[fcntl()]& by the OS).
20856
20857
20858 .option use_lockfile appendfile boolean "see below"
20859 If this option is turned off, Exim does not attempt to create a lock file when
20860 appending to a mailbox file. In this situation, the only locking is by
20861 &[fcntl()]&. You should only turn &%use_lockfile%& off if you are absolutely
20862 sure that every MUA that is ever going to look at your users' mailboxes uses
20863 &[fcntl()]& rather than a lock file, and even then only when you are not
20864 delivering over NFS from more than one host.
20865
20866 .cindex "NFS" "lock file"
20867 In order to append to an NFS file safely from more than one host, it is
20868 necessary to take out a lock &'before'& opening the file, and the lock file
20869 achieves this. Otherwise, even with &[fcntl()]& locking, there is a risk of
20870 file corruption.
20871
20872 The &%use_lockfile%& option is set by default unless &%use_mbx_lock%& is set.
20873 It is not possible to turn both &%use_lockfile%& and &%use_fcntl_lock%& off,
20874 except when &%mbx_format%& is set.
20875
20876
20877 .option use_mbx_lock appendfile boolean "see below"
20878 This option is available only if Exim has been compiled with SUPPORT_MBX
20879 set in &_Local/Makefile_&. Setting the option specifies that special MBX
20880 locking rules be used. It is set by default if &%mbx_format%& is set and none
20881 of the locking options are mentioned in the configuration. The locking rules
20882 are the same as are used by the &'c-client'& library that underlies Pine and
20883 the IMAP4 and POP daemons that come with it (see the discussion below). The
20884 rules allow for shared access to the mailbox. However, this kind of locking
20885 does not work when the mailbox is NFS mounted.
20886
20887 You can set &%use_mbx_lock%& with either (or both) of &%use_fcntl_lock%& and
20888 &%use_flock_lock%& to control what kind of locking is used in implementing the
20889 MBX locking rules. The default is to use &[fcntl()]& if &%use_mbx_lock%& is set
20890 without &%use_fcntl_lock%& or &%use_flock_lock%&.
20891
20892
20893
20894
20895 .section "Operational details for appending" "SECTopappend"
20896 .cindex "appending to a file"
20897 .cindex "file" "appending"
20898 Before appending to a file, the following preparations are made:
20899
20900 .ilist
20901 If the name of the file is &_/dev/null_&, no action is taken, and a success
20902 return is given.
20903
20904 .next
20905 .cindex "directory creation"
20906 If any directories on the file's path are missing, Exim creates them if the
20907 &%create_directory%& option is set. A created directory's mode is given by the
20908 &%directory_mode%& option.
20909
20910 .next
20911 If &%file_format%& is set, the format of an existing file is checked. If this
20912 indicates that a different transport should be used, control is passed to that
20913 transport.
20914
20915 .next
20916 .cindex "file" "locking"
20917 .cindex "locking files"
20918 .cindex "NFS" "lock file"
20919 If &%use_lockfile%& is set, a lock file is built in a way that will work
20920 reliably over NFS, as follows:
20921
20922 .olist
20923 Create a &"hitching post"& file whose name is that of the lock file with the
20924 current time, primary host name, and process id added, by opening for writing
20925 as a new file. If this fails with an access error, delivery is deferred.
20926 .next
20927 Close the hitching post file, and hard link it to the lock file name.
20928 .next
20929 If the call to &[link()]& succeeds, creation of the lock file has succeeded.
20930 Unlink the hitching post name.
20931 .next
20932 Otherwise, use &[stat()]& to get information about the hitching post file, and
20933 then unlink hitching post name. If the number of links is exactly two, creation
20934 of the lock file succeeded but something (for example, an NFS server crash and
20935 restart) caused this fact not to be communicated to the &[link()]& call.
20936 .next
20937 If creation of the lock file failed, wait for &%lock_interval%& and try again,
20938 up to &%lock_retries%& times. However, since any program that writes to a
20939 mailbox should complete its task very quickly, it is reasonable to time out old
20940 lock files that are normally the result of user agent and system crashes. If an
20941 existing lock file is older than &%lockfile_timeout%& Exim attempts to unlink
20942 it before trying again.
20943 .endlist olist
20944
20945 .next
20946 A call is made to &[lstat()]& to discover whether the main file exists, and if
20947 so, what its characteristics are. If &[lstat()]& fails for any reason other
20948 than non-existence, delivery is deferred.
20949
20950 .next
20951 .cindex "symbolic link" "to mailbox"
20952 .cindex "mailbox" "symbolic link"
20953 If the file does exist and is a symbolic link, delivery is deferred, unless the
20954 &%allow_symlink%& option is set, in which case the ownership of the link is
20955 checked, and then &[stat()]& is called to find out about the real file, which
20956 is then subjected to the checks below. The check on the top-level link
20957 ownership prevents one user creating a link for another's mailbox in a sticky
20958 directory, though allowing symbolic links in this case is definitely not a good
20959 idea. If there is a chain of symbolic links, the intermediate ones are not
20960 checked.
20961
20962 .next
20963 If the file already exists but is not a regular file, or if the file's owner
20964 and group (if the group is being checked &-- see &%check_group%& above) are
20965 different from the user and group under which the delivery is running,
20966 delivery is deferred.
20967
20968 .next
20969 If the file's permissions are more generous than specified, they are reduced.
20970 If they are insufficient, delivery is deferred, unless &%mode_fail_narrower%&
20971 is set false, in which case the delivery is tried using the existing
20972 permissions.
20973
20974 .next
20975 The file's inode number is saved, and the file is then opened for appending.
20976 If this fails because the file has vanished, &(appendfile)& behaves as if it
20977 hadn't existed (see below). For any other failures, delivery is deferred.
20978
20979 .next
20980 If the file is opened successfully, check that the inode number hasn't
20981 changed, that it is still a regular file, and that the owner and permissions
20982 have not changed. If anything is wrong, defer delivery and freeze the message.
20983
20984 .next
20985 If the file did not exist originally, defer delivery if the &%file_must_exist%&
20986 option is set. Otherwise, check that the file is being created in a permitted
20987 directory if the &%create_file%& option is set (deferring on failure), and then
20988 open for writing as a new file, with the O_EXCL and O_CREAT options,
20989 except when dealing with a symbolic link (the &%allow_symlink%& option must be
20990 set). In this case, which can happen if the link points to a non-existent file,
20991 the file is opened for writing using O_CREAT but not O_EXCL, because
20992 that prevents link following.
20993
20994 .next
20995 .cindex "loop" "while file testing"
20996 If opening fails because the file exists, obey the tests given above for
20997 existing files. However, to avoid looping in a situation where the file is
20998 being continuously created and destroyed, the exists/not-exists loop is broken
20999 after 10 repetitions, and the message is then frozen.
21000
21001 .next
21002 If opening fails with any other error, defer delivery.
21003
21004 .next
21005 .cindex "file" "locking"
21006 .cindex "locking files"
21007 Once the file is open, unless both &%use_fcntl_lock%& and &%use_flock_lock%&
21008 are false, it is locked using &[fcntl()]& or &[flock()]& or both. If
21009 &%use_mbx_lock%& is false, an exclusive lock is requested in each case.
21010 However, if &%use_mbx_lock%& is true, Exim takes out a shared lock on the open
21011 file, and an exclusive lock on the file whose name is
21012 .code
21013 /tmp/.<device-number>.<inode-number>
21014 .endd
21015 using the device and inode numbers of the open mailbox file, in accordance with
21016 the MBX locking rules. This file is created with a mode that is specified by
21017 the &%lockfile_mode%& option.
21018
21019 If Exim fails to lock the file, there are two possible courses of action,
21020 depending on the value of the locking timeout. This is obtained from
21021 &%lock_fcntl_timeout%& or &%lock_flock_timeout%&, as appropriate.
21022
21023 If the timeout value is zero, the file is closed, Exim waits for
21024 &%lock_interval%&, and then goes back and re-opens the file as above and tries
21025 to lock it again. This happens up to &%lock_retries%& times, after which the
21026 delivery is deferred.
21027
21028 If the timeout has a value greater than zero, blocking calls to &[fcntl()]& or
21029 &[flock()]& are used (with the given timeout), so there has already been some
21030 waiting involved by the time locking fails. Nevertheless, Exim does not give up
21031 immediately. It retries up to
21032 .code
21033 (lock_retries * lock_interval) / <timeout>
21034 .endd
21035 times (rounded up).
21036 .endlist
21037
21038 At the end of delivery, Exim closes the file (which releases the &[fcntl()]&
21039 and/or &[flock()]& locks) and then deletes the lock file if one was created.
21040
21041
21042 .section "Operational details for delivery to a new file" "SECTopdir"
21043 .cindex "delivery" "to single file"
21044 .cindex "&""From""& line"
21045 When the &%directory%& option is set instead of &%file%&, each message is
21046 delivered into a newly-created file or set of files. When &(appendfile)& is
21047 activated directly from a &(redirect)& router, neither &%file%& nor
21048 &%directory%& is normally set, because the path for delivery is supplied by the
21049 router. (See for example, the &(address_file)& transport in the default
21050 configuration.) In this case, delivery is to a new file if either the path name
21051 ends in &`/`&, or the &%maildir_format%& or &%mailstore_format%& option is set.
21052
21053 No locking is required while writing the message to a new file, so the various
21054 locking options of the transport are ignored. The &"From"& line that by default
21055 separates messages in a single file is not normally needed, nor is the escaping
21056 of message lines that start with &"From"&, and there is no need to ensure a
21057 newline at the end of each message. Consequently, the default values for
21058 &%check_string%&, &%message_prefix%&, and &%message_suffix%& are all unset when
21059 any of &%directory%&, &%maildir_format%&, or &%mailstore_format%& is set.
21060
21061 If Exim is required to check a &%quota%& setting, it adds up the sizes of all
21062 the files in the delivery directory by default. However, you can specify a
21063 different directory by setting &%quota_directory%&. Also, for maildir
21064 deliveries (see below) the &_maildirfolder_& convention is honoured.
21065
21066
21067 .cindex "maildir format"
21068 .cindex "mailstore format"
21069 There are three different ways in which delivery to individual files can be
21070 done, controlled by the settings of the &%maildir_format%& and
21071 &%mailstore_format%& options. Note that code to support maildir or mailstore
21072 formats is not included in the binary unless SUPPORT_MAILDIR or
21073 SUPPORT_MAILSTORE, respectively, is set in &_Local/Makefile_&.
21074
21075 .cindex "directory creation"
21076 In all three cases an attempt is made to create the directory and any necessary
21077 sub-directories if they do not exist, provided that the &%create_directory%&
21078 option is set (the default). The location of a created directory can be
21079 constrained by setting &%create_file%&. A created directory's mode is given by
21080 the &%directory_mode%& option. If creation fails, or if the
21081 &%create_directory%& option is not set when creation is required, delivery is
21082 deferred.
21083
21084
21085
21086 .section "Maildir delivery" "SECTmaildirdelivery"
21087 .cindex "maildir format" "description of"
21088 If the &%maildir_format%& option is true, Exim delivers each message by writing
21089 it to a file whose name is &_tmp/<stime>.H<mtime>P<pid>.<host>_& in the
21090 directory that is defined by the &%directory%& option (the &"delivery
21091 directory"&). If the delivery is successful, the file is renamed into the
21092 &_new_& subdirectory.
21093
21094 In the file name, <&'stime'&> is the current time of day in seconds, and
21095 <&'mtime'&> is the microsecond fraction of the time. After a maildir delivery,
21096 Exim checks that the time-of-day clock has moved on by at least one microsecond
21097 before terminating the delivery process. This guarantees uniqueness for the
21098 file name. However, as a precaution, Exim calls &[stat()]& for the file before
21099 opening it. If any response other than ENOENT (does not exist) is given,
21100 Exim waits 2 seconds and tries again, up to &%maildir_retries%& times.
21101
21102 Before Exim carries out a maildir delivery, it ensures that subdirectories
21103 called &_new_&, &_cur_&, and &_tmp_& exist in the delivery directory. If they
21104 do not exist, Exim tries to create them and any superior directories in their
21105 path, subject to the &%create_directory%& and &%create_file%& options. If the
21106 &%maildirfolder_create_regex%& option is set, and the regular expression it
21107 contains matches the delivery directory, Exim also ensures that a file called
21108 &_maildirfolder_& exists in the delivery directory. If a missing directory or
21109 &_maildirfolder_& file cannot be created, delivery is deferred.
21110
21111 These features make it possible to use Exim to create all the necessary files
21112 and directories in a maildir mailbox, including subdirectories for maildir++
21113 folders. Consider this example:
21114 .code
21115 maildir_format = true
21116 directory = /var/mail/$local_part\
21117            ${if eq{$local_part_suffix}{}{}\
21118            {/.${substr_1:$local_part_suffix}}}
21119 maildirfolder_create_regex = /\.[^/]+$
21120 .endd
21121 If &$local_part_suffix$& is empty (there was no suffix for the local part),
21122 delivery is into a toplevel maildir with a name like &_/var/mail/pimbo_& (for
21123 the user called &'pimbo'&). The pattern in &%maildirfolder_create_regex%& does
21124 not match this name, so Exim will not look for or create the file
21125 &_/var/mail/pimbo/maildirfolder_&, though it will create
21126 &_/var/mail/pimbo/{cur,new,tmp}_& if necessary.
21127
21128 However, if &$local_part_suffix$& contains &`-eximusers`& (for example),
21129 delivery is into the maildir++ folder &_/var/mail/pimbo/.eximusers_&, which
21130 does match &%maildirfolder_create_regex%&. In this case, Exim will create
21131 &_/var/mail/pimbo/.eximusers/maildirfolder_& as well as the three maildir
21132 directories &_/var/mail/pimbo/.eximusers/{cur,new,tmp}_&.
21133
21134 &*Warning:*& Take care when setting &%maildirfolder_create_regex%& that it does
21135 not inadvertently match the toplevel maildir directory, because a
21136 &_maildirfolder_& file at top level would completely break quota calculations.
21137
21138 .cindex "quota" "in maildir delivery"
21139 .cindex "maildir++"
21140 If Exim is required to check a &%quota%& setting before a maildir delivery, and
21141 &%quota_directory%& is not set, it looks for a file called &_maildirfolder_& in
21142 the maildir directory (alongside &_new_&, &_cur_&, &_tmp_&). If this exists,
21143 Exim assumes the directory is a maildir++ folder directory, which is one level
21144 down from the user's top level mailbox directory. This causes it to start at
21145 the parent directory instead of the current directory when calculating the
21146 amount of space used.
21147
21148 One problem with delivering into a multi-file mailbox is that it is
21149 computationally expensive to compute the size of the mailbox for quota
21150 checking. Various approaches have been taken to reduce the amount of work
21151 needed. The next two sections describe two of them. A third alternative is to
21152 use some external process for maintaining the size data, and use the expansion
21153 of the &%mailbox_size%& option as a way of importing it into Exim.
21154
21155
21156
21157
21158 .section "Using tags to record message sizes" "SECID135"
21159 If &%maildir_tag%& is set, the string is expanded for each delivery.
21160 When the maildir file is renamed into the &_new_& sub-directory, the
21161 tag is added to its name. However, if adding the tag takes the length of the
21162 name to the point where the test &[stat()]& call fails with ENAMETOOLONG,
21163 the tag is dropped and the maildir file is created with no tag.
21164
21165
21166 .vindex "&$message_size$&"
21167 Tags can be used to encode the size of files in their names; see
21168 &%quota_size_regex%& above for an example. The expansion of &%maildir_tag%&
21169 happens after the message has been written. The value of the &$message_size$&
21170 variable is set to the number of bytes actually written. If the expansion is
21171 forced to fail, the tag is ignored, but a non-forced failure causes delivery to
21172 be deferred. The expanded tag may contain any printing characters except &"/"&.
21173 Non-printing characters in the string are ignored; if the resulting string is
21174 empty, it is ignored. If it starts with an alphanumeric character, a leading
21175 colon is inserted; this default has not proven to be the path that popular
21176 maildir implementations have chosen (but changing it in Exim would break
21177 backwards compatibility).
21178
21179 For one common implementation, you might set:
21180 .code
21181 maildir_tag = ,S=${message_size}
21182 .endd
21183 but you should check the documentation of the other software to be sure.
21184
21185 It is advisable to also set &%quota_size_regex%& when setting &%maildir_tag%&
21186 as this allows Exim to extract the size from your tag, instead of having to
21187 &[stat()]& each message file.
21188
21189
21190 .section "Using a maildirsize file" "SECID136"
21191 .cindex "quota" "in maildir delivery"
21192 .cindex "maildir format" "&_maildirsize_& file"
21193 If &%maildir_use_size_file%& is true, Exim implements the maildir++ rules for
21194 storing quota and message size information in a file called &_maildirsize_&
21195 within the toplevel maildir directory. If this file does not exist, Exim
21196 creates it, setting the quota from the &%quota%& option of the transport. If
21197 the maildir directory itself does not exist, it is created before any attempt
21198 to write a &_maildirsize_& file.
21199
21200 The &_maildirsize_& file is used to hold information about the sizes of
21201 messages in the maildir, thus speeding up quota calculations. The quota value
21202 in the file is just a cache; if the quota is changed in the transport, the new
21203 value overrides the cached value when the next message is delivered. The cache
21204 is maintained for the benefit of other programs that access the maildir and
21205 need to know the quota.
21206
21207 If the &%quota%& option in the transport is unset or zero, the &_maildirsize_&
21208 file is maintained (with a zero quota setting), but no quota is imposed.
21209
21210 A regular expression is available for controlling which directories in the
21211 maildir participate in quota calculations when a &_maildirsizefile_& is in use.
21212 See the description of the &%maildir_quota_directory_regex%& option above for
21213 details.
21214
21215
21216 .section "Mailstore delivery" "SECID137"
21217 .cindex "mailstore format" "description of"
21218 If the &%mailstore_format%& option is true, each message is written as two
21219 files in the given directory. A unique base name is constructed from the
21220 message id and the current delivery process, and the files that are written use
21221 this base name plus the suffixes &_.env_& and &_.msg_&. The &_.env_& file
21222 contains the message's envelope, and the &_.msg_& file contains the message
21223 itself. The base name is placed in the variable &$mailstore_basename$&.
21224
21225 During delivery, the envelope is first written to a file with the suffix
21226 &_.tmp_&. The &_.msg_& file is then written, and when it is complete, the
21227 &_.tmp_& file is renamed as the &_.env_& file. Programs that access messages in
21228 mailstore format should wait for the presence of both a &_.msg_& and a &_.env_&
21229 file before accessing either of them. An alternative approach is to wait for
21230 the absence of a &_.tmp_& file.
21231
21232 The envelope file starts with any text defined by the &%mailstore_prefix%&
21233 option, expanded and terminated by a newline if there isn't one. Then follows
21234 the sender address on one line, then all the recipient addresses, one per line.
21235 There can be more than one recipient only if the &%batch_max%& option is set
21236 greater than one. Finally, &%mailstore_suffix%& is expanded and the result
21237 appended to the file, followed by a newline if it does not end with one.
21238
21239 If expansion of &%mailstore_prefix%& or &%mailstore_suffix%& ends with a forced
21240 failure, it is ignored. Other expansion errors are treated as serious
21241 configuration errors, and delivery is deferred. The variable
21242 &$mailstore_basename$& is available for use during these expansions.
21243
21244
21245 .section "Non-special new file delivery" "SECID138"
21246 If neither &%maildir_format%& nor &%mailstore_format%& is set, a single new
21247 file is created directly in the named directory. For example, when delivering
21248 messages into files in batched SMTP format for later delivery to some host (see
21249 section &<<SECTbatchSMTP>>&), a setting such as
21250 .code
21251 directory = /var/bsmtp/$host
21252 .endd
21253 might be used. A message is written to a file with a temporary name, which is
21254 then renamed when the delivery is complete. The final name is obtained by
21255 expanding the contents of the &%directory_file%& option.
21256 .ecindex IIDapptra1
21257 .ecindex IIDapptra2
21258
21259
21260
21261
21262
21263
21264 . ////////////////////////////////////////////////////////////////////////////
21265 . ////////////////////////////////////////////////////////////////////////////
21266
21267 .chapter "The autoreply transport" "CHID8"
21268 .scindex IIDauttra1 "transports" "&(autoreply)&"
21269 .scindex IIDauttra2 "&(autoreply)& transport"
21270 The &(autoreply)& transport is not a true transport in that it does not cause
21271 the message to be transmitted. Instead, it generates a new mail message as an
21272 automatic reply to the incoming message. &'References:'& and
21273 &'Auto-Submitted:'& header lines are included. These are constructed according
21274 to the rules in RFCs 2822 and 3834, respectively.
21275
21276 If the router that passes the message to this transport does not have the
21277 &%unseen%& option set, the original message (for the current recipient) is not
21278 delivered anywhere. However, when the &%unseen%& option is set on the router
21279 that passes the message to this transport, routing of the address continues, so
21280 another router can set up a normal message delivery.
21281
21282
21283 The &(autoreply)& transport is usually run as the result of mail filtering, a
21284 &"vacation"& message being the standard example. However, it can also be run
21285 directly from a router like any other transport. To reduce the possibility of
21286 message cascades, messages created by the &(autoreply)& transport always have
21287 empty envelope sender addresses, like bounce messages.
21288
21289 The parameters of the message to be sent can be specified in the configuration
21290 by options described below. However, these are used only when the address
21291 passed to the transport does not contain its own reply information. When the
21292 transport is run as a consequence of a
21293 &%mail%&
21294 or &%vacation%& command in a filter file, the parameters of the message are
21295 supplied by the filter, and passed with the address. The transport's options
21296 that define the message are then ignored (so they are not usually set in this
21297 case). The message is specified entirely by the filter or by the transport; it
21298 is never built from a mixture of options. However, the &%file_optional%&,
21299 &%mode%&, and &%return_message%& options apply in all cases.
21300
21301 &(Autoreply)& is implemented as a local transport. When used as a result of a
21302 command in a user's filter file, &(autoreply)& normally runs under the uid and
21303 gid of the user, and with appropriate current and home directories (see chapter
21304 &<<CHAPenvironment>>&).
21305
21306 There is a subtle difference between routing a message to a &(pipe)& transport
21307 that generates some text to be returned to the sender, and routing it to an
21308 &(autoreply)& transport. This difference is noticeable only if more than one
21309 address from the same message is so handled. In the case of a pipe, the
21310 separate outputs from the different addresses are gathered up and returned to
21311 the sender in a single message, whereas if &(autoreply)& is used, a separate
21312 message is generated for each address that is passed to it.
21313
21314 Non-printing characters are not permitted in the header lines generated for the
21315 message that &(autoreply)& creates, with the exception of newlines that are
21316 immediately followed by white space. If any non-printing characters are found,
21317 the transport defers.
21318 Whether characters with the top bit set count as printing characters or not is
21319 controlled by the &%print_topbitchars%& global option.
21320
21321 If any of the generic options for manipulating headers (for example,
21322 &%headers_add%&) are set on an &(autoreply)& transport, they apply to the copy
21323 of the original message that is included in the generated message when
21324 &%return_message%& is set. They do not apply to the generated message itself.
21325
21326 .vindex "&$sender_address$&"
21327 If the &(autoreply)& transport receives return code 2 from Exim when it submits
21328 the message, indicating that there were no recipients, it does not treat this
21329 as an error. This means that autoreplies sent to &$sender_address$& when this
21330 is empty (because the incoming message is a bounce message) do not cause
21331 problems. They are just discarded.
21332
21333
21334
21335 .section "Private options for autoreply" "SECID139"
21336 .cindex "options" "&(autoreply)& transport"
21337
21338 .option bcc autoreply string&!! unset
21339 This specifies the addresses that are to receive &"blind carbon copies"& of the
21340 message when the message is specified by the transport.
21341
21342
21343 .option cc autoreply string&!! unset
21344 This specifies recipients of the message and the contents of the &'Cc:'& header
21345 when the message is specified by the transport.
21346
21347
21348 .option file autoreply string&!! unset
21349 The contents of the file are sent as the body of the message when the message
21350 is specified by the transport. If both &%file%& and &%text%& are set, the text
21351 string comes first.
21352
21353
21354 .option file_expand autoreply boolean false
21355 If this is set, the contents of the file named by the &%file%& option are
21356 subjected to string expansion as they are added to the message.
21357
21358
21359 .option file_optional autoreply boolean false
21360 If this option is true, no error is generated if the file named by the &%file%&
21361 option or passed with the address does not exist or cannot be read.
21362
21363
21364 .option from autoreply string&!! unset
21365 This specifies the contents of the &'From:'& header when the message is
21366 specified by the transport.
21367
21368
21369 .option headers autoreply string&!! unset
21370 This specifies additional RFC 2822 headers that are to be added to the message
21371 when the message is specified by the transport. Several can be given by using
21372 &"\n"& to separate them. There is no check on the format.
21373
21374
21375 .option log autoreply string&!! unset
21376 This option names a file in which a record of every message sent is logged when
21377 the message is specified by the transport.
21378
21379
21380 .option mode autoreply "octal integer" 0600
21381 If either the log file or the &"once"& file has to be created, this mode is
21382 used.
21383
21384
21385 .option never_mail autoreply "address list&!!" unset
21386 If any run of the transport creates a message with a recipient that matches any
21387 item in the list, that recipient is quietly discarded. If all recipients are
21388 discarded, no message is created. This applies both when the recipients are
21389 generated by a filter and when they are specified in the transport.
21390
21391
21392
21393 .option once autoreply string&!! unset
21394 This option names a file or DBM database in which a record of each &'To:'&
21395 recipient is kept when the message is specified by the transport. &*Note*&:
21396 This does not apply to &'Cc:'& or &'Bcc:'& recipients.
21397
21398 If &%once%& is unset, or is set to an empty string, the message is always sent.
21399 By default, if &%once%& is set to a non-empty file name, the message
21400 is not sent if a potential recipient is already listed in the database.
21401 However, if the &%once_repeat%& option specifies a time greater than zero, the
21402 message is sent if that much time has elapsed since a message was last sent to
21403 this recipient. A setting of zero time for &%once_repeat%& (the default)
21404 prevents a message from being sent a second time &-- in this case, zero means
21405 infinity.
21406
21407 If &%once_file_size%& is zero, a DBM database is used to remember recipients,
21408 and it is allowed to grow as large as necessary. If &%once_file_size%& is set
21409 greater than zero, it changes the way Exim implements the &%once%& option.
21410 Instead of using a DBM file to record every recipient it sends to, it uses a
21411 regular file, whose size will never get larger than the given value.
21412
21413 In the file, Exim keeps a linear list of recipient addresses and the times at
21414 which they were sent messages. If the file is full when a new address needs to
21415 be added, the oldest address is dropped. If &%once_repeat%& is not set, this
21416 means that a given recipient may receive multiple messages, but at
21417 unpredictable intervals that depend on the rate of turnover of addresses in the
21418 file. If &%once_repeat%& is set, it specifies a maximum time between repeats.
21419
21420
21421 .option once_file_size autoreply integer 0
21422 See &%once%& above.
21423
21424
21425 .option once_repeat autoreply time&!! 0s
21426 See &%once%& above.
21427 After expansion, the value of this option must be a valid time value.
21428
21429
21430 .option reply_to autoreply string&!! unset
21431 This specifies the contents of the &'Reply-To:'& header when the message is
21432 specified by the transport.
21433
21434
21435 .option return_message autoreply boolean false
21436 If this is set, a copy of the original message is returned with the new
21437 message, subject to the maximum size set in the &%return_size_limit%& global
21438 configuration option.
21439
21440
21441 .option subject autoreply string&!! unset
21442 This specifies the contents of the &'Subject:'& header when the message is
21443 specified by the transport. It is tempting to quote the original subject in
21444 automatic responses. For example:
21445 .code
21446 subject = Re: $h_subject:
21447 .endd
21448 There is a danger in doing this, however. It may allow a third party to
21449 subscribe your users to an opt-in mailing list, provided that the list accepts
21450 bounce messages as subscription confirmations. Well-managed lists require a
21451 non-bounce message to confirm a subscription, so the danger is relatively
21452 small.
21453
21454
21455
21456 .option text autoreply string&!! unset
21457 This specifies a single string to be used as the body of the message when the
21458 message is specified by the transport. If both &%text%& and &%file%& are set,
21459 the text comes first.
21460
21461
21462 .option to autoreply string&!! unset
21463 This specifies recipients of the message and the contents of the &'To:'& header
21464 when the message is specified by the transport.
21465 .ecindex IIDauttra1
21466 .ecindex IIDauttra2
21467
21468
21469
21470
21471 . ////////////////////////////////////////////////////////////////////////////
21472 . ////////////////////////////////////////////////////////////////////////////
21473
21474 .chapter "The lmtp transport" "CHAPLMTP"
21475 .cindex "transports" "&(lmtp)&"
21476 .cindex "&(lmtp)& transport"
21477 .cindex "LMTP" "over a pipe"
21478 .cindex "LMTP" "over a socket"
21479 The &(lmtp)& transport runs the LMTP protocol (RFC 2033) over a pipe to a
21480 specified command
21481 or by interacting with a Unix domain socket.
21482 This transport is something of a cross between the &(pipe)& and &(smtp)&
21483 transports. Exim also has support for using LMTP over TCP/IP; this is
21484 implemented as an option for the &(smtp)& transport. Because LMTP is expected
21485 to be of minority interest, the default build-time configure in &_src/EDITME_&
21486 has it commented out. You need to ensure that
21487 .code
21488 TRANSPORT_LMTP=yes
21489 .endd
21490 .cindex "options" "&(lmtp)& transport"
21491 is present in your &_Local/Makefile_& in order to have the &(lmtp)& transport
21492 included in the Exim binary. The private options of the &(lmtp)& transport are
21493 as follows:
21494
21495 .option batch_id lmtp string&!! unset
21496 See the description of local delivery batching in chapter &<<CHAPbatching>>&.
21497
21498
21499 .option batch_max lmtp integer 1
21500 This limits the number of addresses that can be handled in a single delivery.
21501 Most LMTP servers can handle several addresses at once, so it is normally a
21502 good idea to increase this value. See the description of local delivery
21503 batching in chapter &<<CHAPbatching>>&.
21504
21505
21506 .option command lmtp string&!! unset
21507 This option must be set if &%socket%& is not set. The string is a command which
21508 is run in a separate process. It is split up into a command name and list of
21509 arguments, each of which is separately expanded (so expansion cannot change the
21510 number of arguments). The command is run directly, not via a shell. The message
21511 is passed to the new process using the standard input and output to operate the
21512 LMTP protocol.
21513
21514 .option ignore_quota lmtp boolean false
21515 .cindex "LMTP" "ignoring quota errors"
21516 If this option is set true, the string &`IGNOREQUOTA`& is added to RCPT
21517 commands, provided that the LMTP server has advertised support for IGNOREQUOTA
21518 in its response to the LHLO command.
21519
21520 .option socket lmtp string&!! unset
21521 This option must be set if &%command%& is not set. The result of expansion must
21522 be the name of a Unix domain socket. The transport connects to the socket and
21523 delivers the message to it using the LMTP protocol.
21524
21525
21526 .option timeout lmtp time 5m
21527 The transport is aborted if the created process or Unix domain socket does not
21528 respond to LMTP commands or message input within this timeout. Delivery
21529 is deferred, and will be tried again later. Here is an example of a typical
21530 LMTP transport:
21531 .code
21532 lmtp:
21533   driver = lmtp
21534   command = /some/local/lmtp/delivery/program
21535   batch_max = 20
21536   user = exim
21537 .endd
21538 This delivers up to 20 addresses at a time, in a mixture of domains if
21539 necessary, running as the user &'exim'&.
21540
21541
21542
21543 . ////////////////////////////////////////////////////////////////////////////
21544 . ////////////////////////////////////////////////////////////////////////////
21545
21546 .chapter "The pipe transport" "CHAPpipetransport"
21547 .scindex IIDpiptra1 "transports" "&(pipe)&"
21548 .scindex IIDpiptra2 "&(pipe)& transport"
21549 The &(pipe)& transport is used to deliver messages via a pipe to a command
21550 running in another process. One example is the use of &(pipe)& as a
21551 pseudo-remote transport for passing messages to some other delivery mechanism
21552 (such as UUCP). Another is the use by individual users to automatically process
21553 their incoming messages. The &(pipe)& transport can be used in one of the
21554 following ways:
21555
21556 .ilist
21557 .vindex "&$local_part$&"
21558 A router routes one address to a transport in the normal way, and the
21559 transport is configured as a &(pipe)& transport. In this case, &$local_part$&
21560 contains the local part of the address (as usual), and the command that is run
21561 is specified by the &%command%& option on the transport.
21562 .next
21563 .vindex "&$pipe_addresses$&"
21564 If the &%batch_max%& option is set greater than 1 (the default is 1), the
21565 transport can handle more than one address in a single run. In this case, when
21566 more than one address is routed to the transport, &$local_part$& is not set
21567 (because it is not unique). However, the pseudo-variable &$pipe_addresses$&
21568 (described in section &<<SECThowcommandrun>>& below) contains all the addresses
21569 that are routed to the transport.
21570 .next
21571 .vindex "&$address_pipe$&"
21572 A router redirects an address directly to a pipe command (for example, from an
21573 alias or forward file). In this case, &$address_pipe$& contains the text of the
21574 pipe command, and the &%command%& option on the transport is ignored. If only
21575 one address is being transported (&%batch_max%& is not greater than one, or
21576 only one address was redirected to this pipe command), &$local_part$& contains
21577 the local part that was redirected.
21578 .endlist
21579
21580
21581 The &(pipe)& transport is a non-interactive delivery method. Exim can also
21582 deliver messages over pipes using the LMTP interactive protocol. This is
21583 implemented by the &(lmtp)& transport.
21584
21585 In the case when &(pipe)& is run as a consequence of an entry in a local user's
21586 &_.forward_& file, the command runs under the uid and gid of that user. In
21587 other cases, the uid and gid have to be specified explicitly, either on the
21588 transport or on the router that handles the address. Current and &"home"&
21589 directories are also controllable. See chapter &<<CHAPenvironment>>& for
21590 details of the local delivery environment and chapter &<<CHAPbatching>>&
21591 for a discussion of local delivery batching.
21592
21593
21594 .section "Concurrent delivery" "SECID140"
21595 If two messages arrive at almost the same time, and both are routed to a pipe
21596 delivery, the two pipe transports may be run concurrently. You must ensure that
21597 any pipe commands you set up are robust against this happening. If the commands
21598 write to a file, the &%exim_lock%& utility might be of use.
21599
21600
21601
21602
21603 .section "Returned status and data" "SECID141"
21604 .cindex "&(pipe)& transport" "returned data"
21605 If the command exits with a non-zero return code, the delivery is deemed to
21606 have failed, unless either the &%ignore_status%& option is set (in which case
21607 the return code is treated as zero), or the return code is one of those listed
21608 in the &%temp_errors%& option, which are interpreted as meaning &"try again
21609 later"&. In this case, delivery is deferred. Details of a permanent failure are
21610 logged, but are not included in the bounce message, which merely contains
21611 &"local delivery failed"&.
21612
21613 If the command exits on a signal and the &%freeze_signal%& option is set then
21614 the message will be frozen in the queue. If that option is not set, a bounce
21615 will be sent as normal.
21616
21617 If the return code is greater than 128 and the command being run is a shell
21618 script, it normally means that the script was terminated by a signal whose
21619 value is the return code minus 128. The &%freeze_signal%& option does not
21620 apply in this case.
21621
21622 If Exim is unable to run the command (that is, if &[execve()]& fails), the
21623 return code is set to 127. This is the value that a shell returns if it is
21624 asked to run a non-existent command. The wording for the log line suggests that
21625 a non-existent command may be the problem.
21626
21627 The &%return_output%& option can affect the result of a pipe delivery. If it is
21628 set and the command produces any output on its standard output or standard
21629 error streams, the command is considered to have failed, even if it gave a zero
21630 return code or if &%ignore_status%& is set. The output from the command is
21631 included as part of the bounce message. The &%return_fail_output%& option is
21632 similar, except that output is returned only when the command exits with a
21633 failure return code, that is, a value other than zero or a code that matches
21634 &%temp_errors%&.
21635
21636
21637
21638 .section "How the command is run" "SECThowcommandrun"
21639 .cindex "&(pipe)& transport" "path for command"
21640 The command line is (by default) broken down into a command name and arguments
21641 by the &(pipe)& transport itself. The &%allow_commands%& and
21642 &%restrict_to_path%& options can be used to restrict the commands that may be
21643 run.
21644
21645 .cindex "quoting" "in pipe command"
21646 Unquoted arguments are delimited by white space. If an argument appears in
21647 double quotes, backslash is interpreted as an escape character in the usual
21648 way. If an argument appears in single quotes, no escaping is done.
21649
21650 String expansion is applied to the command line except when it comes from a
21651 traditional &_.forward_& file (commands from a filter file are expanded). The
21652 expansion is applied to each argument in turn rather than to the whole line.
21653 For this reason, any string expansion item that contains white space must be
21654 quoted so as to be contained within a single argument. A setting such as
21655 .code
21656 command = /some/path ${if eq{$local_part}{postmaster}{xx}{yy}}
21657 .endd
21658 will not work, because the expansion item gets split between several
21659 arguments. You have to write
21660 .code
21661 command = /some/path "${if eq{$local_part}{postmaster}{xx}{yy}}"
21662 .endd
21663 to ensure that it is all in one argument. The expansion is done in this way,
21664 argument by argument, so that the number of arguments cannot be changed as a
21665 result of expansion, and quotes or backslashes in inserted variables do not
21666 interact with external quoting. However, this leads to problems if you want to
21667 generate multiple arguments (or the command name plus arguments) from a single
21668 expansion. In this situation, the simplest solution is to use a shell. For
21669 example:
21670 .code
21671 command = /bin/sh -c ${lookup{$local_part}lsearch{/some/file}}
21672 .endd
21673
21674 .cindex "transport" "filter"
21675 .cindex "filter" "transport filter"
21676 .vindex "&$pipe_addresses$&"
21677 Special handling takes place when an argument consists of precisely the text
21678 &`$pipe_addresses`&. This is not a general expansion variable; the only
21679 place this string is recognized is when it appears as an argument for a pipe or
21680 transport filter command. It causes each address that is being handled to be
21681 inserted in the argument list at that point &'as a separate argument'&. This
21682 avoids any problems with spaces or shell metacharacters, and is of use when a
21683 &(pipe)& transport is handling groups of addresses in a batch.
21684
21685 After splitting up into arguments and expansion, the resulting command is run
21686 in a subprocess directly from the transport, &'not'& under a shell. The
21687 message that is being delivered is supplied on the standard input, and the
21688 standard output and standard error are both connected to a single pipe that is
21689 read by Exim. The &%max_output%& option controls how much output the command
21690 may produce, and the &%return_output%& and &%return_fail_output%& options
21691 control what is done with it.
21692
21693 Not running the command under a shell (by default) lessens the security risks
21694 in cases when a command from a user's filter file is built out of data that was
21695 taken from an incoming message. If a shell is required, it can of course be
21696 explicitly specified as the command to be run. However, there are circumstances
21697 where existing commands (for example, in &_.forward_& files) expect to be run
21698 under a shell and cannot easily be modified. To allow for these cases, there is
21699 an option called &%use_shell%&, which changes the way the &(pipe)& transport
21700 works. Instead of breaking up the command line as just described, it expands it
21701 as a single string and passes the result to &_/bin/sh_&. The
21702 &%restrict_to_path%& option and the &$pipe_addresses$& facility cannot be used
21703 with &%use_shell%&, and the whole mechanism is inherently less secure.
21704
21705
21706
21707 .section "Environment variables" "SECTpipeenv"
21708 .cindex "&(pipe)& transport" "environment for command"
21709 .cindex "environment for pipe transport"
21710 The environment variables listed below are set up when the command is invoked.
21711 This list is a compromise for maximum compatibility with other MTAs. Note that
21712 the &%environment%& option can be used to add additional variables to this
21713 environment.
21714 .display
21715 &`DOMAIN            `&   the domain of the address
21716 &`HOME              `&   the home directory, if set
21717 &`HOST              `&   the host name when called from a router (see below)
21718 &`LOCAL_PART        `&   see below
21719 &`LOCAL_PART_PREFIX `&   see below
21720 &`LOCAL_PART_SUFFIX `&   see below
21721 &`LOGNAME           `&   see below
21722 &`MESSAGE_ID        `&   Exim's local ID for the message
21723 &`PATH              `&   as specified by the &%path%& option below
21724 &`QUALIFY_DOMAIN    `&   the sender qualification domain
21725 &`RECIPIENT         `&   the complete recipient address
21726 &`SENDER            `&   the sender of the message (empty if a bounce)
21727 &`SHELL             `&   &`/bin/sh`&
21728 &`TZ                `&   the value of the &%timezone%& option, if set
21729 &`USER              `&   see below
21730 .endd
21731 When a &(pipe)& transport is called directly from (for example) an &(accept)&
21732 router, LOCAL_PART is set to the local part of the address. When it is
21733 called as a result of a forward or alias expansion, LOCAL_PART is set to
21734 the local part of the address that was expanded. In both cases, any affixes are
21735 removed from the local part, and made available in LOCAL_PART_PREFIX and
21736 LOCAL_PART_SUFFIX, respectively. LOGNAME and USER are set to the
21737 same value as LOCAL_PART for compatibility with other MTAs.
21738
21739 .cindex "HOST"
21740 HOST is set only when a &(pipe)& transport is called from a router that
21741 associates hosts with an address, typically when using &(pipe)& as a
21742 pseudo-remote transport. HOST is set to the first host name specified by
21743 the router.
21744
21745 .cindex "HOME"
21746 If the transport's generic &%home_directory%& option is set, its value is used
21747 for the HOME environment variable. Otherwise, a home directory may be set
21748 by the router's &%transport_home_directory%& option, which defaults to the
21749 user's home directory if &%check_local_user%& is set.
21750
21751
21752 .section "Private options for pipe" "SECID142"
21753 .cindex "options" "&(pipe)& transport"
21754
21755
21756
21757 .option allow_commands pipe "string list&!!" unset
21758 .cindex "&(pipe)& transport" "permitted commands"
21759 The string is expanded, and is then interpreted as a colon-separated list of
21760 permitted commands. If &%restrict_to_path%& is not set, the only commands
21761 permitted are those in the &%allow_commands%& list. They need not be absolute
21762 paths; the &%path%& option is still used for relative paths. If
21763 &%restrict_to_path%& is set with &%allow_commands%&, the command must either be
21764 in the &%allow_commands%& list, or a name without any slashes that is found on
21765 the path. In other words, if neither &%allow_commands%& nor
21766 &%restrict_to_path%& is set, there is no restriction on the command, but
21767 otherwise only commands that are permitted by one or the other are allowed. For
21768 example, if
21769 .code
21770 allow_commands = /usr/bin/vacation
21771 .endd
21772 and &%restrict_to_path%& is not set, the only permitted command is
21773 &_/usr/bin/vacation_&. The &%allow_commands%& option may not be set if
21774 &%use_shell%& is set.
21775
21776
21777 .option batch_id pipe string&!! unset
21778 See the description of local delivery batching in chapter &<<CHAPbatching>>&.
21779
21780
21781 .option batch_max pipe integer 1
21782 This limits the number of addresses that can be handled in a single delivery.
21783 See the description of local delivery batching in chapter &<<CHAPbatching>>&.
21784
21785
21786 .option check_string pipe string unset
21787 As &(pipe)& writes the message, the start of each line is tested for matching
21788 &%check_string%&, and if it does, the initial matching characters are replaced
21789 by the contents of &%escape_string%&, provided both are set. The value of
21790 &%check_string%& is a literal string, not a regular expression, and the case of
21791 any letters it contains is significant. When &%use_bsmtp%& is set, the contents
21792 of &%check_string%& and &%escape_string%& are forced to values that implement
21793 the SMTP escaping protocol. Any settings made in the configuration file are
21794 ignored.
21795
21796
21797 .option command pipe string&!! unset
21798 This option need not be set when &(pipe)& is being used to deliver to pipes
21799 obtained directly from address redirections. In other cases, the option must be
21800 set, to provide a command to be run. It need not yield an absolute path (see
21801 the &%path%& option below). The command is split up into separate arguments by
21802 Exim, and each argument is separately expanded, as described in section
21803 &<<SECThowcommandrun>>& above.
21804
21805
21806 .option environment pipe string&!! unset
21807 .cindex "&(pipe)& transport" "environment for command"
21808 .cindex "environment for &(pipe)& transport"
21809 This option is used to add additional variables to the environment in which the
21810 command runs (see section &<<SECTpipeenv>>& for the default list). Its value is
21811 a string which is expanded, and then interpreted as a colon-separated list of
21812 environment settings of the form <&'name'&>=<&'value'&>.
21813
21814
21815 .option escape_string pipe string unset
21816 See &%check_string%& above.
21817
21818
21819 .option freeze_exec_fail pipe boolean false
21820 .cindex "exec failure"
21821 .cindex "failure of exec"
21822 .cindex "&(pipe)& transport" "failure of exec"
21823 Failure to exec the command in a pipe transport is by default treated like
21824 any other failure while running the command. However, if &%freeze_exec_fail%&
21825 is set, failure to exec is treated specially, and causes the message to be
21826 frozen, whatever the setting of &%ignore_status%&.
21827
21828
21829 .option freeze_signal pipe boolean false
21830 .cindex "signal exit"
21831 .cindex "&(pipe)& transport", "signal exit"
21832 Normally if the process run by a command in a pipe transport exits on a signal,
21833 a bounce message is sent. If &%freeze_signal%& is set, the message will be
21834 frozen in Exim's queue instead.
21835
21836
21837 .option ignore_status pipe boolean false
21838 If this option is true, the status returned by the subprocess that is set up to
21839 run the command is ignored, and Exim behaves as if zero had been returned.
21840 Otherwise, a non-zero status or termination by signal causes an error return
21841 from the transport unless the status value is one of those listed in
21842 &%temp_errors%&; these cause the delivery to be deferred and tried again later.
21843
21844 &*Note*&: This option does not apply to timeouts, which do not return a status.
21845 See the &%timeout_defer%& option for how timeouts are handled.
21846
21847 .option log_defer_output pipe boolean false
21848 .cindex "&(pipe)& transport" "logging output"
21849 If this option is set, and the status returned by the command is
21850 one of the codes listed in &%temp_errors%& (that is, delivery was deferred),
21851 and any output was produced, the first line of it is written to the main log.
21852
21853
21854 .option log_fail_output pipe boolean false
21855 If this option is set, and the command returns any output, and also ends with a
21856 return code that is neither zero nor one of the return codes listed in
21857 &%temp_errors%& (that is, the delivery failed), the first line of output is
21858 written to the main log. This option and &%log_output%& are mutually exclusive.
21859 Only one of them may be set.
21860
21861
21862
21863 .option log_output pipe boolean false
21864 If this option is set and the command returns any output, the first line of
21865 output is written to the main log, whatever the return code. This option and
21866 &%log_fail_output%& are mutually exclusive. Only one of them may be set.
21867
21868
21869
21870 .option max_output pipe integer 20K
21871 This specifies the maximum amount of output that the command may produce on its
21872 standard output and standard error file combined. If the limit is exceeded, the
21873 process running the command is killed. This is intended as a safety measure to
21874 catch runaway processes. The limit is applied independently of the settings of
21875 the options that control what is done with such output (for example,
21876 &%return_output%&). Because of buffering effects, the amount of output may
21877 exceed the limit by a small amount before Exim notices.
21878
21879
21880 .option message_prefix pipe string&!! "see below"
21881 The string specified here is expanded and output at the start of every message.
21882 The default is unset if &%use_bsmtp%& is set. Otherwise it is
21883 .code
21884 message_prefix = \
21885   From ${if def:return_path{$return_path}{MAILER-DAEMON}}\
21886   ${tod_bsdinbox}\n
21887 .endd
21888 .cindex "Cyrus"
21889 .cindex "&%tmail%&"
21890 .cindex "&""From""& line"
21891 This is required by the commonly used &_/usr/bin/vacation_& program.
21892 However, it must &'not'& be present if delivery is to the Cyrus IMAP server,
21893 or to the &%tmail%& local delivery agent. The prefix can be suppressed by
21894 setting
21895 .code
21896 message_prefix =
21897 .endd
21898 &*Note:*& If you set &%use_crlf%& true, you must change any occurrences of
21899 &`\n`& to &`\r\n`& in &%message_prefix%&.
21900
21901
21902 .option message_suffix pipe string&!! "see below"
21903 The string specified here is expanded and output at the end of every message.
21904 The default is unset if &%use_bsmtp%& is set. Otherwise it is a single newline.
21905 The suffix can be suppressed by setting
21906 .code
21907 message_suffix =
21908 .endd
21909 &*Note:*& If you set &%use_crlf%& true, you must change any occurrences of
21910 &`\n`& to &`\r\n`& in &%message_suffix%&.
21911
21912
21913 .option path pipe string "see below"
21914 This option specifies the string that is set up in the PATH environment
21915 variable of the subprocess. The default is:
21916 .code
21917 /bin:/usr/bin
21918 .endd
21919 If the &%command%& option does not yield an absolute path name, the command is
21920 sought in the PATH directories, in the usual way. &*Warning*&: This does not
21921 apply to a command specified as a transport filter.
21922
21923
21924 .option permit_coredump pipe boolean false
21925 Normally Exim inhibits core-dumps during delivery.  If you have a need to get
21926 a core-dump of a pipe command, enable this command.  This enables core-dumps
21927 during delivery and affects both the Exim binary and the pipe command run.
21928 It is recommended that this option remain off unless and until you have a need
21929 for it and that this only be enabled when needed, as the risk of excessive
21930 resource consumption can be quite high.  Note also that Exim is typically
21931 installed as a setuid binary and most operating systems will inhibit coredumps
21932 of these by default, so further OS-specific action may be required.
21933
21934
21935 .option pipe_as_creator pipe boolean false
21936 .cindex "uid (user id)" "local delivery"
21937 If the generic &%user%& option is not set and this option is true, the delivery
21938 process is run under the uid that was in force when Exim was originally called
21939 to accept the message. If the group id is not otherwise set (via the generic
21940 &%group%& option), the gid that was in force when Exim was originally called to
21941 accept the message is used.
21942
21943
21944 .option restrict_to_path pipe boolean false
21945 When this option is set, any command name not listed in &%allow_commands%& must
21946 contain no slashes. The command is searched for only in the directories listed
21947 in the &%path%& option. This option is intended for use in the case when a pipe
21948 command has been generated from a user's &_.forward_& file. This is usually
21949 handled by a &(pipe)& transport called &%address_pipe%&.
21950
21951
21952 .option return_fail_output pipe boolean false
21953 If this option is true, and the command produced any output and ended with a
21954 return code other than zero or one of the codes listed in &%temp_errors%& (that
21955 is, the delivery failed), the output is returned in the bounce message.
21956 However, if the message has a null sender (that is, it is itself a bounce
21957 message), output from the command is discarded. This option and
21958 &%return_output%& are mutually exclusive. Only one of them may be set.
21959
21960
21961
21962 .option return_output pipe boolean false
21963 If this option is true, and the command produced any output, the delivery is
21964 deemed to have failed whatever the return code from the command, and the output
21965 is returned in the bounce message. Otherwise, the output is just discarded.
21966 However, if the message has a null sender (that is, it is a bounce message),
21967 output from the command is always discarded, whatever the setting of this
21968 option. This option and &%return_fail_output%& are mutually exclusive. Only one
21969 of them may be set.
21970
21971
21972
21973 .option temp_errors pipe "string list" "see below"
21974 .cindex "&(pipe)& transport" "temporary failure"
21975 This option contains either a colon-separated list of numbers, or a single
21976 asterisk. If &%ignore_status%& is false
21977 and &%return_output%& is not set,
21978 and the command exits with a non-zero return code, the failure is treated as
21979 temporary and the delivery is deferred if the return code matches one of the
21980 numbers, or if the setting is a single asterisk. Otherwise, non-zero return
21981 codes are treated as permanent errors. The default setting contains the codes
21982 defined by EX_TEMPFAIL and EX_CANTCREAT in &_sysexits.h_&. If Exim is
21983 compiled on a system that does not define these macros, it assumes values of 75
21984 and 73, respectively.
21985
21986
21987 .option timeout pipe time 1h
21988 If the command fails to complete within this time, it is killed. This normally
21989 causes the delivery to fail (but see &%timeout_defer%&). A zero time interval
21990 specifies no timeout. In order to ensure that any subprocesses created by the
21991 command are also killed, Exim makes the initial process a process group leader,
21992 and kills the whole process group on a timeout. However, this can be defeated
21993 if one of the processes starts a new process group.
21994
21995 .option timeout_defer pipe boolean false
21996 A timeout in a &(pipe)& transport, either in the command that the transport
21997 runs, or in a transport filter that is associated with it, is by default
21998 treated as a hard error, and the delivery fails. However, if &%timeout_defer%&
21999 is set true, both kinds of timeout become temporary errors, causing the
22000 delivery to be deferred.
22001
22002 .option umask pipe "octal integer" 022
22003 This specifies the umask setting for the subprocess that runs the command.
22004
22005
22006 .option use_bsmtp pipe boolean false
22007 .cindex "envelope sender"
22008 If this option is set true, the &(pipe)& transport writes messages in &"batch
22009 SMTP"& format, with the envelope sender and recipient(s) included as SMTP
22010 commands. If you want to include a leading HELO command with such messages,
22011 you can do so by setting the &%message_prefix%& option. See section
22012 &<<SECTbatchSMTP>>& for details of batch SMTP.
22013
22014 .option use_classresources pipe boolean false
22015 .cindex "class resources (BSD)"
22016 This option is available only when Exim is running on FreeBSD, NetBSD, or
22017 BSD/OS. If it is set true, the &[setclassresources()]& function is used to set
22018 resource limits when a &(pipe)& transport is run to perform a delivery. The
22019 limits for the uid under which the pipe is to run are obtained from the login
22020 class database.
22021
22022
22023 .option use_crlf pipe boolean false
22024 .cindex "carriage return"
22025 .cindex "linefeed"
22026 This option causes lines to be terminated with the two-character CRLF sequence
22027 (carriage return, linefeed) instead of just a linefeed character. In the case
22028 of batched SMTP, the byte sequence written to the pipe is then an exact image
22029 of what would be sent down a real SMTP connection.
22030
22031 The contents of the &%message_prefix%& and &%message_suffix%& options are
22032 written verbatim, so must contain their own carriage return characters if these
22033 are needed. When &%use_bsmtp%& is not set, the default values for both
22034 &%message_prefix%& and &%message_suffix%& end with a single linefeed, so their
22035 values must be changed to end with &`\r\n`& if &%use_crlf%& is set.
22036
22037
22038 .option use_shell pipe boolean false
22039 .vindex "&$pipe_addresses$&"
22040 If this option is set, it causes the command to be passed to &_/bin/sh_&
22041 instead of being run directly from the transport, as described in section
22042 &<<SECThowcommandrun>>&. This is less secure, but is needed in some situations
22043 where the command is expected to be run under a shell and cannot easily be
22044 modified. The &%allow_commands%& and &%restrict_to_path%& options, and the
22045 &`$pipe_addresses`& facility are incompatible with &%use_shell%&. The
22046 command is expanded as a single string, and handed to &_/bin/sh_& as data for
22047 its &%-c%& option.
22048
22049
22050
22051 .section "Using an external local delivery agent" "SECID143"
22052 .cindex "local delivery" "using an external agent"
22053 .cindex "&'procmail'&"
22054 .cindex "external local delivery"
22055 .cindex "delivery" "&'procmail'&"
22056 .cindex "delivery" "by external agent"
22057 The &(pipe)& transport can be used to pass all messages that require local
22058 delivery to a separate local delivery agent such as &%procmail%&. When doing
22059 this, care must be taken to ensure that the pipe is run under an appropriate
22060 uid and gid. In some configurations one wants this to be a uid that is trusted
22061 by the delivery agent to supply the correct sender of the message. It may be
22062 necessary to recompile or reconfigure the delivery agent so that it trusts an
22063 appropriate user. The following is an example transport and router
22064 configuration for &%procmail%&:
22065 .code
22066 # transport
22067 procmail_pipe:
22068   driver = pipe
22069   command = /usr/local/bin/procmail -d $local_part
22070   return_path_add
22071   delivery_date_add
22072   envelope_to_add
22073   check_string = "From "
22074   escape_string = ">From "
22075   umask = 077
22076   user = $local_part
22077   group = mail
22078
22079 # router
22080 procmail:
22081   driver = accept
22082   check_local_user
22083   transport = procmail_pipe
22084 .endd
22085 In this example, the pipe is run as the local user, but with the group set to
22086 &'mail'&. An alternative is to run the pipe as a specific user such as &'mail'&
22087 or &'exim'&, but in this case you must arrange for &%procmail%& to trust that
22088 user to supply a correct sender address. If you do not specify either a
22089 &%group%& or a &%user%& option, the pipe command is run as the local user. The
22090 home directory is the user's home directory by default.
22091
22092 &*Note*&: The command that the pipe transport runs does &'not'& begin with
22093 .code
22094 IFS=" "
22095 .endd
22096 as shown in some &%procmail%& documentation, because Exim does not by default
22097 use a shell to run pipe commands.
22098
22099 .cindex "Cyrus"
22100 The next example shows a transport and a router for a system where local
22101 deliveries are handled by the Cyrus IMAP server.
22102 .code
22103 # transport
22104 local_delivery_cyrus:
22105   driver = pipe
22106   command = /usr/cyrus/bin/deliver \
22107             -m ${substr_1:$local_part_suffix} -- $local_part
22108   user = cyrus
22109   group = mail
22110   return_output
22111   log_output
22112   message_prefix =
22113   message_suffix =
22114
22115 # router
22116 local_user_cyrus:
22117   driver = accept
22118   check_local_user
22119   local_part_suffix = .*
22120   transport = local_delivery_cyrus
22121 .endd
22122 Note the unsetting of &%message_prefix%& and &%message_suffix%&, and the use of
22123 &%return_output%& to cause any text written by Cyrus to be returned to the
22124 sender.
22125 .ecindex IIDpiptra1
22126 .ecindex IIDpiptra2
22127
22128
22129 . ////////////////////////////////////////////////////////////////////////////
22130 . ////////////////////////////////////////////////////////////////////////////
22131
22132 .chapter "The smtp transport" "CHAPsmtptrans"
22133 .scindex IIDsmttra1 "transports" "&(smtp)&"
22134 .scindex IIDsmttra2 "&(smtp)& transport"
22135 The &(smtp)& transport delivers messages over TCP/IP connections using the SMTP
22136 or LMTP protocol. The list of hosts to try can either be taken from the address
22137 that is being processed (having been set up by the router), or specified
22138 explicitly for the transport. Timeout and retry processing (see chapter
22139 &<<CHAPretry>>&) is applied to each IP address independently.
22140
22141
22142 .section "Multiple messages on a single connection" "SECID144"
22143 The sending of multiple messages over a single TCP/IP connection can arise in
22144 two ways:
22145
22146 .ilist
22147 If a message contains more than &%max_rcpt%& (see below) addresses that are
22148 routed to the same host, more than one copy of the message has to be sent to
22149 that host. In this situation, multiple copies may be sent in a single run of
22150 the &(smtp)& transport over a single TCP/IP connection. (What Exim actually
22151 does when it has too many addresses to send in one message also depends on the
22152 value of the global &%remote_max_parallel%& option. Details are given in
22153 section &<<SECToutSMTPTCP>>&.)
22154 .next
22155 .cindex "hints database" "remembering routing"
22156 When a message has been successfully delivered over a TCP/IP connection, Exim
22157 looks in its hints database to see if there are any other messages awaiting a
22158 connection to the same host. If there are, a new delivery process is started
22159 for one of them, and the current TCP/IP connection is passed on to it. The new
22160 process may in turn send multiple copies and possibly create yet another
22161 process.
22162 .endlist
22163
22164
22165 For each copy sent over the same TCP/IP connection, a sequence counter is
22166 incremented, and if it ever gets to the value of &%connection_max_messages%&,
22167 no further messages are sent over that connection.
22168
22169
22170
22171 .section "Use of the $host and $host_address variables" "SECID145"
22172 .vindex "&$host$&"
22173 .vindex "&$host_address$&"
22174 At the start of a run of the &(smtp)& transport, the values of &$host$& and
22175 &$host_address$& are the name and IP address of the first host on the host list
22176 passed by the router. However, when the transport is about to connect to a
22177 specific host, and while it is connected to that host, &$host$& and
22178 &$host_address$& are set to the values for that host. These are the values
22179 that are in force when the &%helo_data%&, &%hosts_try_auth%&, &%interface%&,
22180 &%serialize_hosts%&, and the various TLS options are expanded.
22181
22182
22183 .section "Use of $tls_cipher and $tls_peerdn" "usecippeer"
22184 .vindex &$tls_bits$&
22185 .vindex &$tls_cipher$&
22186 .vindex &$tls_peerdn$&
22187 .vindex &$tls_sni$&
22188 At the start of a run of the &(smtp)& transport, the values of &$tls_bits$&,
22189 &$tls_cipher$&, &$tls_peerdn$& and &$tls_sni$&
22190 are the values that were set when the message was received.
22191 These are the values that are used for options that are expanded before any
22192 SMTP connections are made. Just before each connection is made, these four
22193 variables are emptied. If TLS is subsequently started, they are set to the
22194 appropriate values for the outgoing connection, and these are the values that
22195 are in force when any authenticators are run and when the
22196 &%authenticated_sender%& option is expanded.
22197
22198 These variables are deprecated in favour of &$tls_in_cipher$& et. al.
22199 and will be removed in a future release.
22200
22201
22202 .section "Private options for smtp" "SECID146"
22203 .cindex "options" "&(smtp)& transport"
22204 The private options of the &(smtp)& transport are as follows:
22205
22206
22207 .option address_retry_include_sender smtp boolean true
22208 .cindex "4&'xx'& responses" "retrying after"
22209 When an address is delayed because of a 4&'xx'& response to a RCPT command, it
22210 is the combination of sender and recipient that is delayed in subsequent queue
22211 runs until the retry time is reached. You can delay the recipient without
22212 reference to the sender (which is what earlier versions of Exim did), by
22213 setting &%address_retry_include_sender%& false. However, this can lead to
22214 problems with servers that regularly issue 4&'xx'& responses to RCPT commands.
22215
22216 .option allow_localhost smtp boolean false
22217 .cindex "local host" "sending to"
22218 .cindex "fallback" "hosts specified on transport"
22219 When a host specified in &%hosts%& or &%fallback_hosts%& (see below) turns out
22220 to be the local host, or is listed in &%hosts_treat_as_local%&, delivery is
22221 deferred by default. However, if &%allow_localhost%& is set, Exim goes on to do
22222 the delivery anyway. This should be used only in special cases when the
22223 configuration ensures that no looping will result (for example, a differently
22224 configured Exim is listening on the port to which the message is sent).
22225
22226
22227 .option authenticated_sender smtp string&!! unset
22228 .cindex "Cyrus"
22229 When Exim has authenticated as a client, or if &%authenticated_sender_force%&
22230 is true, this option sets a value for the AUTH= item on outgoing MAIL commands,
22231 overriding any existing authenticated sender value. If the string expansion is
22232 forced to fail, the option is ignored. Other expansion failures cause delivery
22233 to be deferred. If the result of expansion is an empty string, that is also
22234 ignored.
22235
22236 The expansion happens after the outgoing connection has been made and TLS
22237 started, if required. This means that the &$host$&, &$host_address$&,
22238 &$tls_out_cipher$&, and &$tls_out_peerdn$& variables are set according to the
22239 particular connection.
22240
22241 If the SMTP session is not authenticated, the expansion of
22242 &%authenticated_sender%& still happens (and can cause the delivery to be
22243 deferred if it fails), but no AUTH= item is added to MAIL commands
22244 unless &%authenticated_sender_force%& is true.
22245
22246 This option allows you to use the &(smtp)& transport in LMTP mode to
22247 deliver mail to Cyrus IMAP and provide the proper local part as the
22248 &"authenticated sender"&, via a setting such as:
22249 .code
22250 authenticated_sender = $local_part
22251 .endd
22252 This removes the need for IMAP subfolders to be assigned special ACLs to
22253 allow direct delivery to those subfolders.
22254
22255 Because of expected uses such as that just described for Cyrus (when no
22256 domain is involved), there is no checking on the syntax of the provided
22257 value.
22258
22259
22260 .option authenticated_sender_force smtp boolean false
22261 If this option is set true, the &%authenticated_sender%& option's value
22262 is used for the AUTH= item on outgoing MAIL commands, even if Exim has not
22263 authenticated as a client.
22264
22265
22266 .option command_timeout smtp time 5m
22267 This sets a timeout for receiving a response to an SMTP command that has been
22268 sent out. It is also used when waiting for the initial banner line from the
22269 remote host. Its value must not be zero.
22270
22271
22272 .option connect_timeout smtp time 5m
22273 This sets a timeout for the &[connect()]& function, which sets up a TCP/IP call
22274 to a remote host. A setting of zero allows the system timeout (typically
22275 several minutes) to act. To have any effect, the value of this option must be
22276 less than the system timeout. However, it has been observed that on some
22277 systems there is no system timeout, which is why the default value for this
22278 option is 5 minutes, a value recommended by RFC 1123.
22279
22280
22281 .option connection_max_messages smtp integer 500
22282 .cindex "SMTP" "passed connection"
22283 .cindex "SMTP" "multiple deliveries"
22284 .cindex "multiple SMTP deliveries"
22285 This controls the maximum number of separate message deliveries that are sent
22286 over a single TCP/IP connection. If the value is zero, there is no limit.
22287 For testing purposes, this value can be overridden by the &%-oB%& command line
22288 option.
22289
22290
22291 .option data_timeout smtp time 5m
22292 This sets a timeout for the transmission of each block in the data portion of
22293 the message. As a result, the overall timeout for a message depends on the size
22294 of the message. Its value must not be zero. See also &%final_timeout%&.
22295
22296
22297 .option delay_after_cutoff smtp boolean true
22298 This option controls what happens when all remote IP addresses for a given
22299 domain have been inaccessible for so long that they have passed their retry
22300 cutoff times.
22301
22302 In the default state, if the next retry time has not been reached for any of
22303 them, the address is bounced without trying any deliveries. In other words,
22304 Exim delays retrying an IP address after the final cutoff time until a new
22305 retry time is reached, and can therefore bounce an address without ever trying
22306 a delivery, when machines have been down for a long time. Some people are
22307 unhappy at this prospect, so...
22308
22309 If &%delay_after_cutoff%& is set false, Exim behaves differently. If all IP
22310 addresses are past their final cutoff time, Exim tries to deliver to those
22311 IP addresses that have not been tried since the message arrived. If there are
22312 none, of if they all fail, the address is bounced. In other words, it does not
22313 delay when a new message arrives, but immediately tries those expired IP
22314 addresses that haven't been tried since the message arrived. If there is a
22315 continuous stream of messages for the dead hosts, unsetting
22316 &%delay_after_cutoff%& means that there will be many more attempts to deliver
22317 to them.
22318
22319
22320 .option dns_qualify_single smtp boolean true
22321 If the &%hosts%& or &%fallback_hosts%& option is being used,
22322 and the &%gethostbyname%& option is false,
22323 the RES_DEFNAMES resolver option is set. See the &%qualify_single%& option
22324 in chapter &<<CHAPdnslookup>>& for more details.
22325
22326
22327 .option dns_search_parents smtp boolean false
22328 If the &%hosts%& or &%fallback_hosts%& option is being used, and the
22329 &%gethostbyname%& option is false, the RES_DNSRCH resolver option is set.
22330 See the &%search_parents%& option in chapter &<<CHAPdnslookup>>& for more
22331 details.
22332
22333
22334 .new
22335 .option dscp smtp string&!! unset
22336 .cindex "DCSP" "outbound"
22337 This option causes the DSCP value associated with a socket to be set to one
22338 of a number of fixed strings or to numeric value.
22339 The &%-bI:dscp%& option may be used to ask Exim which names it knows of.
22340 Common values include &`throughput`&, &`mincost`&, and on newer systems
22341 &`ef`&, &`af41`&, etc.  Numeric values may be in the range 0 to 0x3F.
22342
22343 The outbound packets from Exim will be marked with this value in the header
22344 (for IPv4, the TOS field; for IPv6, the TCLASS field); there is no guarantee
22345 that these values will have any effect, not be stripped by networking
22346 equipment, or do much of anything without cooperation with your Network
22347 Engineer and those of all network operators between the source and destination.
22348 .wen
22349
22350
22351 .option fallback_hosts smtp "string list" unset
22352 .cindex "fallback" "hosts specified on transport"
22353 String expansion is not applied to this option. The argument must be a
22354 colon-separated list of host names or IP addresses, optionally also including
22355 port numbers, though the separator can be changed, as described in section
22356 &<<SECTlistconstruct>>&. Each individual item in the list is the same as an
22357 item in a &%route_list%& setting for the &(manualroute)& router, as described
22358 in section &<<SECTformatonehostitem>>&.
22359
22360 Fallback hosts can also be specified on routers, which associate them with the
22361 addresses they process. As for the &%hosts%& option without &%hosts_override%&,
22362 &%fallback_hosts%& specified on the transport is used only if the address does
22363 not have its own associated fallback host list. Unlike &%hosts%&, a setting of
22364 &%fallback_hosts%& on an address is not overridden by &%hosts_override%&.
22365 However, &%hosts_randomize%& does apply to fallback host lists.
22366
22367 If Exim is unable to deliver to any of the hosts for a particular address, and
22368 the errors are not permanent rejections, the address is put on a separate
22369 transport queue with its host list replaced by the fallback hosts, unless the
22370 address was routed via MX records and the current host was in the original MX
22371 list. In that situation, the fallback host list is not used.
22372
22373 Once normal deliveries are complete, the fallback queue is delivered by
22374 re-running the same transports with the new host lists. If several failing
22375 addresses have the same fallback hosts (and &%max_rcpt%& permits it), a single
22376 copy of the message is sent.
22377
22378 The resolution of the host names on the fallback list is controlled by the
22379 &%gethostbyname%& option, as for the &%hosts%& option. Fallback hosts apply
22380 both to cases when the host list comes with the address and when it is taken
22381 from &%hosts%&. This option provides a &"use a smart host only if delivery
22382 fails"& facility.
22383
22384
22385 .option final_timeout smtp time 10m
22386 This is the timeout that applies while waiting for the response to the final
22387 line containing just &"."& that terminates a message. Its value must not be
22388 zero.
22389
22390 .option gethostbyname smtp boolean false
22391 If this option is true when the &%hosts%& and/or &%fallback_hosts%& options are
22392 being used, names are looked up using &[gethostbyname()]&
22393 (or &[getipnodebyname()]& when available)
22394 instead of using the DNS. Of course, that function may in fact use the DNS, but
22395 it may also consult other sources of information such as &_/etc/hosts_&.
22396
22397 .option gnutls_compat_mode smtp boolean unset
22398 This option controls whether GnuTLS is used in compatibility mode in an Exim
22399 server. This reduces security slightly, but improves interworking with older
22400 implementations of TLS.
22401
22402 .option helo_data smtp string&!! "see below"
22403 .cindex "HELO" "argument, setting"
22404 .cindex "EHLO" "argument, setting"
22405 .cindex "LHLO argument setting"
22406 The value of this option is expanded after a connection to a another host has
22407 been set up. The result is used as the argument for the EHLO, HELO, or LHLO
22408 command that starts the outgoing SMTP or LMTP session. The default value of the
22409 option is:
22410 .code
22411 $primary_hostname
22412 .endd
22413 During the expansion, the variables &$host$& and &$host_address$& are set to
22414 the identity of the remote host, and the variables &$sending_ip_address$& and
22415 &$sending_port$& are set to the local IP address and port number that are being
22416 used. These variables can be used to generate different values for different
22417 servers or different local IP addresses. For example, if you want the string
22418 that is used for &%helo_data%& to be obtained by a DNS lookup of the outgoing
22419 interface address, you could use this:
22420 .code
22421 helo_data = ${lookup dnsdb{ptr=$sending_ip_address}{$value}\
22422   {$primary_hostname}}
22423 .endd
22424 The use of &%helo_data%& applies both to sending messages and when doing
22425 callouts.
22426
22427 .option hosts smtp "string list&!!" unset
22428 Hosts are associated with an address by a router such as &(dnslookup)&, which
22429 finds the hosts by looking up the address domain in the DNS, or by
22430 &(manualroute)&, which has lists of hosts in its configuration. However,
22431 email addresses can be passed to the &(smtp)& transport by any router, and not
22432 all of them can provide an associated list of hosts.
22433
22434 The &%hosts%& option specifies a list of hosts to be used if the address being
22435 processed does not have any hosts associated with it. The hosts specified by
22436 &%hosts%& are also used, whether or not the address has its own hosts, if
22437 &%hosts_override%& is set.
22438
22439 The string is first expanded, before being interpreted as a colon-separated
22440 list of host names or IP addresses, possibly including port numbers. The
22441 separator may be changed to something other than colon, as described in section
22442 &<<SECTlistconstruct>>&. Each individual item in the list is the same as an
22443 item in a &%route_list%& setting for the &(manualroute)& router, as described
22444 in section &<<SECTformatonehostitem>>&. However, note that the &`/MX`& facility
22445 of the &(manualroute)& router is not available here.
22446
22447 If the expansion fails, delivery is deferred. Unless the failure was caused by
22448 the inability to complete a lookup, the error is logged to the panic log as
22449 well as the main log. Host names are looked up either by searching directly for
22450 address records in the DNS or by calling &[gethostbyname()]& (or
22451 &[getipnodebyname()]& when available), depending on the setting of the
22452 &%gethostbyname%& option. When Exim is compiled with IPv6 support, if a host
22453 that is looked up in the DNS has both IPv4 and IPv6 addresses, both types of
22454 address are used.
22455
22456 During delivery, the hosts are tried in order, subject to their retry status,
22457 unless &%hosts_randomize%& is set.
22458
22459
22460 .option hosts_avoid_esmtp smtp "host list&!!" unset
22461 .cindex "ESMTP, avoiding use of"
22462 .cindex "HELO" "forcing use of"
22463 .cindex "EHLO" "avoiding use of"
22464 .cindex "PIPELINING" "avoiding the use of"
22465 This option is for use with broken hosts that announce ESMTP facilities (for
22466 example, PIPELINING) and then fail to implement them properly. When a host
22467 matches &%hosts_avoid_esmtp%&, Exim sends HELO rather than EHLO at the
22468 start of the SMTP session. This means that it cannot use any of the ESMTP
22469 facilities such as AUTH, PIPELINING, SIZE, and STARTTLS.
22470
22471
22472 .option hosts_avoid_pipelining smtp "host list&!!" unset
22473 .cindex "PIPELINING" "avoiding the use of"
22474 Exim will not use the SMTP PIPELINING extension when delivering to any host
22475 that matches this list, even if the server host advertises PIPELINING support.
22476
22477
22478 .option hosts_avoid_tls smtp "host list&!!" unset
22479 .cindex "TLS" "avoiding for certain hosts"
22480 Exim will not try to start a TLS session when delivering to any host that
22481 matches this list. See chapter &<<CHAPTLS>>& for details of TLS.
22482
22483 .option hosts_verify_avoid_tls smtp "host list&!!" *
22484 .cindex "TLS" "avoiding for certain hosts"
22485 Exim will not try to start a TLS session for a verify callout,
22486 or when delivering in cutthrough mode,
22487 to any host that matches this list.
22488 Note that the default is to not use TLS.
22489
22490
22491 .option hosts_max_try smtp integer 5
22492 .cindex "host" "maximum number to try"
22493 .cindex "limit" "number of hosts tried"
22494 .cindex "limit" "number of MX tried"
22495 .cindex "MX record" "maximum tried"
22496 This option limits the number of IP addresses that are tried for any one
22497 delivery in cases where there are temporary delivery errors. Section
22498 &<<SECTvalhosmax>>& describes in detail how the value of this option is used.
22499
22500
22501 .option hosts_max_try_hardlimit smtp integer 50
22502 This is an additional check on the maximum number of IP addresses that Exim
22503 tries for any one delivery. Section &<<SECTvalhosmax>>& describes its use and
22504 why it exists.
22505
22506
22507
22508 .option hosts_nopass_tls smtp "host list&!!" unset
22509 .cindex "TLS" "passing connection"
22510 .cindex "multiple SMTP deliveries"
22511 .cindex "TLS" "multiple message deliveries"
22512 For any host that matches this list, a connection on which a TLS session has
22513 been started will not be passed to a new delivery process for sending another
22514 message on the same connection. See section &<<SECTmulmessam>>& for an
22515 explanation of when this might be needed.
22516
22517
22518 .option hosts_override smtp boolean false
22519 If this option is set and the &%hosts%& option is also set, any hosts that are
22520 attached to the address are ignored, and instead the hosts specified by the
22521 &%hosts%& option are always used. This option does not apply to
22522 &%fallback_hosts%&.
22523
22524
22525 .option hosts_randomize smtp boolean false
22526 .cindex "randomized host list"
22527 .cindex "host" "list of; randomized"
22528 .cindex "fallback" "randomized hosts"
22529 If this option is set, and either the list of hosts is taken from the
22530 &%hosts%& or the &%fallback_hosts%& option, or the hosts supplied by the router
22531 were not obtained from MX records (this includes fallback hosts from the
22532 router), and were not randomized by the router, the order of trying the hosts
22533 is randomized each time the transport runs. Randomizing the order of a host
22534 list can be used to do crude load sharing.
22535
22536 When &%hosts_randomize%& is true, a host list may be split into groups whose
22537 order is separately randomized. This makes it possible to set up MX-like
22538 behaviour. The boundaries between groups are indicated by an item that is just
22539 &`+`& in the host list. For example:
22540 .code
22541 hosts = host1:host2:host3:+:host4:host5
22542 .endd
22543 The order of the first three hosts and the order of the last two hosts is
22544 randomized for each use, but the first three always end up before the last two.
22545 If &%hosts_randomize%& is not set, a &`+`& item in the list is ignored.
22546
22547 .option hosts_require_auth smtp "host list&!!" unset
22548 .cindex "authentication" "required by client"
22549 This option provides a list of servers for which authentication must succeed
22550 before Exim will try to transfer a message. If authentication fails for
22551 servers which are not in this list, Exim tries to send unauthenticated. If
22552 authentication fails for one of these servers, delivery is deferred. This
22553 temporary error is detectable in the retry rules, so it can be turned into a
22554 hard failure if required. See also &%hosts_try_auth%&, and chapter
22555 &<<CHAPSMTPAUTH>>& for details of authentication.
22556
22557
22558 .option hosts_require_tls smtp "host list&!!" unset
22559 .cindex "TLS" "requiring for certain servers"
22560 Exim will insist on using a TLS session when delivering to any host that
22561 matches this list. See chapter &<<CHAPTLS>>& for details of TLS.
22562 &*Note*&: This option affects outgoing mail only. To insist on TLS for
22563 incoming messages, use an appropriate ACL.
22564
22565 .option hosts_try_auth smtp "host list&!!" unset
22566 .cindex "authentication" "optional in client"
22567 This option provides a list of servers to which, provided they announce
22568 authentication support, Exim will attempt to authenticate as a client when it
22569 connects. If authentication fails, Exim will try to transfer the message
22570 unauthenticated. See also &%hosts_require_auth%&, and chapter
22571 &<<CHAPSMTPAUTH>>& for details of authentication.
22572
22573 .option interface smtp "string list&!!" unset
22574 .cindex "bind IP address"
22575 .cindex "IP address" "binding"
22576 .vindex "&$host$&"
22577 .vindex "&$host_address$&"
22578 This option specifies which interface to bind to when making an outgoing SMTP
22579 call. The value is an IP address, not an interface name such as
22580 &`eth0`&. Do not confuse this with the interface address that was used when a
22581 message was received, which is in &$received_ip_address$&, formerly known as
22582 &$interface_address$&. The name was changed to minimize confusion with the
22583 outgoing interface address. There is no variable that contains an outgoing
22584 interface address because, unless it is set by this option, its value is
22585 unknown.
22586
22587 During the expansion of the &%interface%& option the variables &$host$& and
22588 &$host_address$& refer to the host to which a connection is about to be made
22589 during the expansion of the string. Forced expansion failure, or an empty
22590 string result causes the option to be ignored. Otherwise, after expansion, the
22591 string must be a list of IP addresses, colon-separated by default, but the
22592 separator can be changed in the usual way. For example:
22593 .code
22594 interface = <; 192.168.123.123 ; 3ffe:ffff:836f::fe86:a061
22595 .endd
22596 The first interface of the correct type (IPv4 or IPv6) is used for the outgoing
22597 connection. If none of them are the correct type, the option is ignored. If
22598 &%interface%& is not set, or is ignored, the system's IP functions choose which
22599 interface to use if the host has more than one.
22600
22601
22602 .option keepalive smtp boolean true
22603 .cindex "keepalive" "on outgoing connection"
22604 This option controls the setting of SO_KEEPALIVE on outgoing TCP/IP socket
22605 connections. When set, it causes the kernel to probe idle connections
22606 periodically, by sending packets with &"old"& sequence numbers. The other end
22607 of the connection should send a acknowledgment if the connection is still okay
22608 or a reset if the connection has been aborted. The reason for doing this is
22609 that it has the beneficial effect of freeing up certain types of connection
22610 that can get stuck when the remote host is disconnected without tidying up the
22611 TCP/IP call properly. The keepalive mechanism takes several hours to detect
22612 unreachable hosts.
22613
22614
22615 .option lmtp_ignore_quota smtp boolean false
22616 .cindex "LMTP" "ignoring quota errors"
22617 If this option is set true when the &%protocol%& option is set to &"lmtp"&, the
22618 string &`IGNOREQUOTA`& is added to RCPT commands, provided that the LMTP server
22619 has advertised support for IGNOREQUOTA in its response to the LHLO command.
22620
22621 .option max_rcpt smtp integer 100
22622 .cindex "RCPT" "maximum number of outgoing"
22623 This option limits the number of RCPT commands that are sent in a single
22624 SMTP message transaction. Each set of addresses is treated independently, and
22625 so can cause parallel connections to the same host if &%remote_max_parallel%&
22626 permits this.
22627
22628
22629 .option multi_domain smtp boolean true
22630 .vindex "&$domain$&"
22631 When this option is set, the &(smtp)& transport can handle a number of
22632 addresses containing a mixture of different domains provided they all resolve
22633 to the same list of hosts. Turning the option off restricts the transport to
22634 handling only one domain at a time. This is useful if you want to use
22635 &$domain$& in an expansion for the transport, because it is set only when there
22636 is a single domain involved in a remote delivery.
22637
22638
22639 .option port smtp string&!! "see below"
22640 .cindex "port" "sending TCP/IP"
22641 .cindex "TCP/IP" "setting outgoing port"
22642 This option specifies the TCP/IP port on the server to which Exim connects.
22643 &*Note:*& Do not confuse this with the port that was used when a message was
22644 received, which is in &$received_port$&, formerly known as &$interface_port$&.
22645 The name was changed to minimize confusion with the outgoing port. There is no
22646 variable that contains an outgoing port.
22647
22648 If the value of this option begins with a digit it is taken as a port number;
22649 otherwise it is looked up using &[getservbyname()]&. The default value is
22650 normally &"smtp"&, but if &%protocol%& is set to &"lmtp"&, the default is
22651 &"lmtp"&. If the expansion fails, or if a port number cannot be found, delivery
22652 is deferred.
22653
22654
22655
22656 .option protocol smtp string smtp
22657 .cindex "LMTP" "over TCP/IP"
22658 .cindex "ssmtp protocol" "outbound"
22659 .cindex "TLS" "SSL-on-connect outbound"
22660 .vindex "&$port$&"
22661 If this option is set to &"lmtp"& instead of &"smtp"&, the default value for
22662 the &%port%& option changes to &"lmtp"&, and the transport operates the LMTP
22663 protocol (RFC 2033) instead of SMTP. This protocol is sometimes used for local
22664 deliveries into closed message stores. Exim also has support for running LMTP
22665 over a pipe to a local process &-- see chapter &<<CHAPLMTP>>&.
22666
22667 If this option is set to &"smtps"&, the default vaule for the &%port%& option
22668 changes to &"smtps"&, and the transport initiates TLS immediately after
22669 connecting, as an outbound SSL-on-connect, instead of using STARTTLS to upgrade.
22670 The Internet standards bodies strongly discourage use of this mode.
22671
22672
22673 .option retry_include_ip_address smtp boolean true
22674 Exim normally includes both the host name and the IP address in the key it
22675 constructs for indexing retry data after a temporary delivery failure. This
22676 means that when one of several IP addresses for a host is failing, it gets
22677 tried periodically (controlled by the retry rules), but use of the other IP
22678 addresses is not affected.
22679
22680 However, in some dialup environments hosts are assigned a different IP address
22681 each time they connect. In this situation the use of the IP address as part of
22682 the retry key leads to undesirable behaviour. Setting this option false causes
22683 Exim to use only the host name. This should normally be done on a separate
22684 instance of the &(smtp)& transport, set up specially to handle the dialup
22685 hosts.
22686
22687
22688 .option serialize_hosts smtp "host list&!!" unset
22689 .cindex "serializing connections"
22690 .cindex "host" "serializing connections"
22691 Because Exim operates in a distributed manner, if several messages for the same
22692 host arrive at around the same time, more than one simultaneous connection to
22693 the remote host can occur. This is not usually a problem except when there is a
22694 slow link between the hosts. In that situation it may be helpful to restrict
22695 Exim to one connection at a time. This can be done by setting
22696 &%serialize_hosts%& to match the relevant hosts.
22697
22698 .cindex "hints database" "serializing deliveries to a host"
22699 Exim implements serialization by means of a hints database in which a record is
22700 written whenever a process connects to one of the restricted hosts. The record
22701 is deleted when the connection is completed. Obviously there is scope for
22702 records to get left lying around if there is a system or program crash. To
22703 guard against this, Exim ignores any records that are more than six hours old.
22704
22705 If you set up this kind of serialization, you should also arrange to delete the
22706 relevant hints database whenever your system reboots. The names of the files
22707 start with &_misc_& and they are kept in the &_spool/db_& directory. There
22708 may be one or two files, depending on the type of DBM in use. The same files
22709 are used for ETRN serialization.
22710
22711
22712 .option size_addition smtp integer 1024
22713 .cindex "SMTP" "SIZE"
22714 .cindex "message" "size issue for transport filter"
22715 .cindex "size" "of message"
22716 .cindex "transport" "filter"
22717 .cindex "filter" "transport filter"
22718 If a remote SMTP server indicates that it supports the SIZE option of the
22719 MAIL command, Exim uses this to pass over the message size at the start of
22720 an SMTP transaction. It adds the value of &%size_addition%& to the value it
22721 sends, to allow for headers and other text that may be added during delivery by
22722 configuration options or in a transport filter. It may be necessary to increase
22723 this if a lot of text is added to messages.
22724
22725 Alternatively, if the value of &%size_addition%& is set negative, it disables
22726 the use of the SIZE option altogether.
22727
22728
22729 .option tls_certificate smtp string&!! unset
22730 .cindex "TLS" "client certificate, location of"
22731 .cindex "certificate" "client, location of"
22732 .vindex "&$host$&"
22733 .vindex "&$host_address$&"
22734 The value of this option must be the absolute path to a file which contains the
22735 client's certificate, for possible use when sending a message over an encrypted
22736 connection. The values of &$host$& and &$host_address$& are set to the name and
22737 address of the server during the expansion. See chapter &<<CHAPTLS>>& for
22738 details of TLS.
22739
22740 &*Note*&: This option must be set if you want Exim to be able to use a TLS
22741 certificate when sending messages as a client. The global option of the same
22742 name specifies the certificate for Exim as a server; it is not automatically
22743 assumed that the same certificate should be used when Exim is operating as a
22744 client.
22745
22746
22747 .option tls_crl smtp string&!! unset
22748 .cindex "TLS" "client certificate revocation list"
22749 .cindex "certificate" "revocation list for client"
22750 This option specifies a certificate revocation list. The expanded value must
22751 be the name of a file that contains a CRL in PEM format.
22752
22753
22754 .new
22755 .option tls_dh_min_bits smtp integer 1024
22756 .cindex "TLS" "Diffie-Hellman minimum acceptable size"
22757 When establishing a TLS session, if a ciphersuite which uses Diffie-Hellman
22758 key agreement is negotiated, the server will provide a large prime number
22759 for use.  This option establishes the minimum acceptable size of that number.
22760 If the parameter offered by the server is too small, then the TLS handshake
22761 will fail.
22762
22763 Only supported when using GnuTLS.
22764 .wen
22765
22766
22767 .option tls_privatekey smtp string&!! unset
22768 .cindex "TLS" "client private key, location of"
22769 .vindex "&$host$&"
22770 .vindex "&$host_address$&"
22771 The value of this option must be the absolute path to a file which contains the
22772 client's private key. This is used when sending a message over an encrypted
22773 connection using a client certificate. The values of &$host$& and
22774 &$host_address$& are set to the name and address of the server during the
22775 expansion. If this option is unset, or the expansion is forced to fail, or the
22776 result is an empty string, the private key is assumed to be in the same file as
22777 the certificate. See chapter &<<CHAPTLS>>& for details of TLS.
22778
22779
22780 .option tls_require_ciphers smtp string&!! unset
22781 .cindex "TLS" "requiring specific ciphers"
22782 .cindex "cipher" "requiring specific"
22783 .vindex "&$host$&"
22784 .vindex "&$host_address$&"
22785 The value of this option must be a list of permitted cipher suites, for use
22786 when setting up an outgoing encrypted connection. (There is a global option of
22787 the same name for controlling incoming connections.) The values of &$host$& and
22788 &$host_address$& are set to the name and address of the server during the
22789 expansion. See chapter &<<CHAPTLS>>& for details of TLS; note that this option
22790 is used in different ways by OpenSSL and GnuTLS (see sections
22791 &<<SECTreqciphssl>>& and &<<SECTreqciphgnu>>&). For GnuTLS, the order of the
22792 ciphers is a preference order.
22793
22794
22795
22796 .option tls_sni smtp string&!! unset
22797 .cindex "TLS" "Server Name Indication"
22798 .vindex "&$tls_sni$&"
22799 If this option is set then it sets the $tls_out_sni variable and causes any
22800 TLS session to pass this value as the Server Name Indication extension to
22801 the remote side, which can be used by the remote side to select an appropriate
22802 certificate and private key for the session.
22803
22804 See &<<SECTtlssni>>& for more information.
22805
22806 Note that for OpenSSL, this feature requires a build of OpenSSL that supports
22807 TLS extensions.
22808
22809
22810
22811
22812 .option tls_tempfail_tryclear smtp boolean true
22813 .cindex "4&'xx'& responses" "to STARTTLS"
22814 When the server host is not in &%hosts_require_tls%&, and there is a problem in
22815 setting up a TLS session, this option determines whether or not Exim should try
22816 to deliver the message unencrypted. If it is set false, delivery to the
22817 current host is deferred; if there are other hosts, they are tried. If this
22818 option is set true, Exim attempts to deliver unencrypted after a 4&'xx'&
22819 response to STARTTLS. Also, if STARTTLS is accepted, but the subsequent
22820 TLS negotiation fails, Exim closes the current connection (because it is in an
22821 unknown state), opens a new one to the same host, and then tries the delivery
22822 in clear.
22823
22824
22825 .option tls_verify_certificates smtp string&!! unset
22826 .cindex "TLS" "server certificate verification"
22827 .cindex "certificate" "verification of server"
22828 .vindex "&$host$&"
22829 .vindex "&$host_address$&"
22830 The value of this option must be the absolute path to a file containing
22831 permitted server certificates, for use when setting up an encrypted connection.
22832 Alternatively, if you are using OpenSSL, you can set
22833 &%tls_verify_certificates%& to the name of a directory containing certificate
22834 files. This does not work with GnuTLS; the option must be set to the name of a
22835 single file if you are using GnuTLS. The values of &$host$& and
22836 &$host_address$& are set to the name and address of the server during the
22837 expansion of this option. See chapter &<<CHAPTLS>>& for details of TLS.
22838
22839
22840
22841
22842 .section "How the limits for the number of hosts to try are used" &&&
22843          "SECTvalhosmax"
22844 .cindex "host" "maximum number to try"
22845 .cindex "limit" "hosts; maximum number tried"
22846 There are two options that are concerned with the number of hosts that are
22847 tried when an SMTP delivery takes place. They are &%hosts_max_try%& and
22848 &%hosts_max_try_hardlimit%&.
22849
22850
22851 The &%hosts_max_try%& option limits the number of hosts that are tried
22852 for a single delivery. However, despite the term &"host"& in its name, the
22853 option actually applies to each IP address independently. In other words, a
22854 multihomed host is treated as several independent hosts, just as it is for
22855 retrying.
22856
22857 Many of the larger ISPs have multiple MX records which often point to
22858 multihomed hosts. As a result, a list of a dozen or more IP addresses may be
22859 created as a result of routing one of these domains.
22860
22861 Trying every single IP address on such a long list does not seem sensible; if
22862 several at the top of the list fail, it is reasonable to assume there is some
22863 problem that is likely to affect all of them. Roughly speaking, the value of
22864 &%hosts_max_try%& is the maximum number that are tried before deferring the
22865 delivery. However, the logic cannot be quite that simple.
22866
22867 Firstly, IP addresses that are skipped because their retry times have not
22868 arrived do not count, and in addition, addresses that are past their retry
22869 limits are also not counted, even when they are tried. This means that when
22870 some IP addresses are past their retry limits, more than the value of
22871 &%hosts_max_retry%& may be tried. The reason for this behaviour is to ensure
22872 that all IP addresses are considered before timing out an email address (but
22873 see below for an exception).
22874
22875 Secondly, when the &%hosts_max_try%& limit is reached, Exim looks down the host
22876 list to see if there is a subsequent host with a different (higher valued) MX.
22877 If there is, that host is considered next, and the current IP address is used
22878 but not counted. This behaviour helps in the case of a domain with a retry rule
22879 that hardly ever delays any hosts, as is now explained:
22880
22881 Consider the case of a long list of hosts with one MX value, and a few with a
22882 higher MX value. If &%hosts_max_try%& is small (the default is 5) only a few
22883 hosts at the top of the list are tried at first. With the default retry rule,
22884 which specifies increasing retry times, the higher MX hosts are eventually
22885 tried when those at the top of the list are skipped because they have not
22886 reached their retry times.
22887
22888 However, it is common practice to put a fixed short retry time on domains for
22889 large ISPs, on the grounds that their servers are rarely down for very long.
22890 Unfortunately, these are exactly the domains that tend to resolve to long lists
22891 of hosts. The short retry time means that the lowest MX hosts are tried every
22892 time. The attempts may be in a different order because of random sorting, but
22893 without the special MX check, the higher MX hosts would never be tried until
22894 all the lower MX hosts had timed out (which might be several days), because
22895 there are always some lower MX hosts that have reached their retry times. With
22896 the special check, Exim considers at least one IP address from each MX value at
22897 every delivery attempt, even if the &%hosts_max_try%& limit has already been
22898 reached.
22899
22900 The above logic means that &%hosts_max_try%& is not a hard limit, and in
22901 particular, Exim normally eventually tries all the IP addresses before timing
22902 out an email address. When &%hosts_max_try%& was implemented, this seemed a
22903 reasonable thing to do. Recently, however, some lunatic DNS configurations have
22904 been set up with hundreds of IP addresses for some domains. It can
22905 take a very long time indeed for an address to time out in these cases.
22906
22907 The &%hosts_max_try_hardlimit%& option was added to help with this problem.
22908 Exim never tries more than this number of IP addresses; if it hits this limit
22909 and they are all timed out, the email address is bounced, even though not all
22910 possible IP addresses have been tried.
22911 .ecindex IIDsmttra1
22912 .ecindex IIDsmttra2
22913
22914
22915
22916
22917
22918 . ////////////////////////////////////////////////////////////////////////////
22919 . ////////////////////////////////////////////////////////////////////////////
22920
22921 .chapter "Address rewriting" "CHAPrewrite"
22922 .scindex IIDaddrew "rewriting" "addresses"
22923 There are some circumstances in which Exim automatically rewrites domains in
22924 addresses. The two most common are when an address is given without a domain
22925 (referred to as an &"unqualified address"&) or when an address contains an
22926 abbreviated domain that is expanded by DNS lookup.
22927
22928 Unqualified envelope addresses are accepted only for locally submitted
22929 messages, or for messages that are received from hosts matching
22930 &%sender_unqualified_hosts%& or &%recipient_unqualified_hosts%&, as
22931 appropriate. Unqualified addresses in header lines are qualified if they are in
22932 locally submitted messages, or messages from hosts that are permitted to send
22933 unqualified envelope addresses. Otherwise, unqualified addresses in header
22934 lines are neither qualified nor rewritten.
22935
22936 One situation in which Exim does &'not'& automatically rewrite a domain is
22937 when it is the name of a CNAME record in the DNS. The older RFCs suggest that
22938 such a domain should be rewritten using the &"canonical"& name, and some MTAs
22939 do this. The new RFCs do not contain this suggestion.
22940
22941
22942 .section "Explicitly configured address rewriting" "SECID147"
22943 This chapter describes the rewriting rules that can be used in the
22944 main rewrite section of the configuration file, and also in the generic
22945 &%headers_rewrite%& option that can be set on any transport.
22946
22947 Some people believe that configured address rewriting is a Mortal Sin.
22948 Others believe that life is not possible without it. Exim provides the
22949 facility; you do not have to use it.
22950
22951 The main rewriting rules that appear in the &"rewrite"& section of the
22952 configuration file are applied to addresses in incoming messages, both envelope
22953 addresses and addresses in header lines. Each rule specifies the types of
22954 address to which it applies.
22955
22956 Whether or not addresses in header lines are rewritten depends on the origin of
22957 the headers and the type of rewriting. Global rewriting, that is, rewriting
22958 rules from the rewrite section of the configuration file, is applied only to
22959 those headers that were received with the message. Header lines that are added
22960 by ACLs or by a system filter or by individual routers or transports (which
22961 are specific to individual recipient addresses) are not rewritten by the global
22962 rules.
22963
22964 Rewriting at transport time, by means of the &%headers_rewrite%& option,
22965 applies all headers except those added by routers and transports. That is, as
22966 well as the headers that were received with the message, it also applies to
22967 headers that were added by an ACL or a system filter.
22968
22969
22970 In general, rewriting addresses from your own system or domain has some
22971 legitimacy. Rewriting other addresses should be done only with great care and
22972 in special circumstances. The author of Exim believes that rewriting should be
22973 used sparingly, and mainly for &"regularizing"& addresses in your own domains.
22974 Although it can sometimes be used as a routing tool, this is very strongly
22975 discouraged.
22976
22977 There are two commonly encountered circumstances where rewriting is used, as
22978 illustrated by these examples:
22979
22980 .ilist
22981 The company whose domain is &'hitch.fict.example'& has a number of hosts that
22982 exchange mail with each other behind a firewall, but there is only a single
22983 gateway to the outer world. The gateway rewrites &'*.hitch.fict.example'& as
22984 &'hitch.fict.example'& when sending mail off-site.
22985 .next
22986 A host rewrites the local parts of its own users so that, for example,
22987 &'fp42@hitch.fict.example'& becomes &'Ford.Prefect@hitch.fict.example'&.
22988 .endlist
22989
22990
22991
22992 .section "When does rewriting happen?" "SECID148"
22993 .cindex "rewriting" "timing of"
22994 .cindex "&ACL;" "rewriting addresses in"
22995 Configured address rewriting can take place at several different stages of a
22996 message's processing.
22997
22998 .vindex "&$sender_address$&"
22999 At the start of an ACL for MAIL, the sender address may have been rewritten
23000 by a special SMTP-time rewrite rule (see section &<<SECTrewriteS>>&), but no
23001 ordinary rewrite rules have yet been applied. If, however, the sender address
23002 is verified in the ACL, it is rewritten before verification, and remains
23003 rewritten thereafter. The subsequent value of &$sender_address$& is the
23004 rewritten address. This also applies if sender verification happens in a
23005 RCPT ACL. Otherwise, when the sender address is not verified, it is
23006 rewritten as soon as a message's header lines have been received.
23007
23008 .vindex "&$domain$&"
23009 .vindex "&$local_part$&"
23010 Similarly, at the start of an ACL for RCPT, the current recipient's address
23011 may have been rewritten by a special SMTP-time rewrite rule, but no ordinary
23012 rewrite rules have yet been applied to it. However, the behaviour is different
23013 from the sender address when a recipient is verified. The address is rewritten
23014 for the verification, but the rewriting is not remembered at this stage. The
23015 value of &$local_part$& and &$domain$& after verification are always the same
23016 as they were before (that is, they contain the unrewritten &-- except for
23017 SMTP-time rewriting &-- address).
23018
23019 As soon as a message's header lines have been received, all the envelope
23020 recipient addresses are permanently rewritten, and rewriting is also applied to
23021 the addresses in the header lines (if configured). This happens before adding
23022 any header lines that were specified in MAIL or RCPT ACLs, and
23023 .cindex "&[local_scan()]& function" "address rewriting; timing of"
23024 before the DATA ACL and &[local_scan()]& functions are run.
23025
23026 When an address is being routed, either for delivery or for verification,
23027 rewriting is applied immediately to child addresses that are generated by
23028 redirection, unless &%no_rewrite%& is set on the router.
23029
23030 .cindex "envelope sender" "rewriting at transport time"
23031 .cindex "rewriting" "at transport time"
23032 .cindex "header lines" "rewriting at transport time"
23033 At transport time, additional rewriting of addresses in header lines can be
23034 specified by setting the generic &%headers_rewrite%& option on a transport.
23035 This option contains rules that are identical in form to those in the rewrite
23036 section of the configuration file. They are applied to the original message
23037 header lines and any that were added by ACLs or a system filter. They are not
23038 applied to header lines that are added by routers or the transport.
23039
23040 The outgoing envelope sender can be rewritten by means of the &%return_path%&
23041 transport option. However, it is not possible to rewrite envelope recipients at
23042 transport time.
23043
23044
23045
23046
23047 .section "Testing the rewriting rules that apply on input" "SECID149"
23048 .cindex "rewriting" "testing"
23049 .cindex "testing" "rewriting"
23050 Exim's input rewriting configuration appears in a part of the run time
23051 configuration file headed by &"begin rewrite"&. It can be tested by the
23052 &%-brw%& command line option. This takes an address (which can be a full RFC
23053 2822 address) as its argument. The output is a list of how the address would be
23054 transformed by the rewriting rules for each of the different places it might
23055 appear in an incoming message, that is, for each different header and for the
23056 envelope sender and recipient fields. For example,
23057 .code
23058 exim -brw ph10@exim.workshop.example
23059 .endd
23060 might produce the output
23061 .code
23062 sender: Philip.Hazel@exim.workshop.example
23063 from: Philip.Hazel@exim.workshop.example
23064 to: ph10@exim.workshop.example
23065 cc: ph10@exim.workshop.example
23066 bcc: ph10@exim.workshop.example
23067 reply-to: Philip.Hazel@exim.workshop.example
23068 env-from: Philip.Hazel@exim.workshop.example
23069 env-to: ph10@exim.workshop.example
23070 .endd
23071 which shows that rewriting has been set up for that address when used in any of
23072 the source fields, but not when it appears as a recipient address. At the
23073 present time, there is no equivalent way of testing rewriting rules that are
23074 set for a particular transport.
23075
23076
23077 .section "Rewriting rules" "SECID150"
23078 .cindex "rewriting" "rules"
23079 The rewrite section of the configuration file consists of lines of rewriting
23080 rules in the form
23081 .display
23082 <&'source pattern'&>  <&'replacement'&>  <&'flags'&>
23083 .endd
23084 Rewriting rules that are specified for the &%headers_rewrite%& generic
23085 transport option are given as a colon-separated list. Each item in the list
23086 takes the same form as a line in the main rewriting configuration (except that
23087 any colons must be doubled, of course).
23088
23089 The formats of source patterns and replacement strings are described below.
23090 Each is terminated by white space, unless enclosed in double quotes, in which
23091 case normal quoting conventions apply inside the quotes. The flags are single
23092 characters which may appear in any order. Spaces and tabs between them are
23093 ignored.
23094
23095 For each address that could potentially be rewritten, the rules are scanned in
23096 order, and replacements for the address from earlier rules can themselves be
23097 replaced by later rules (but see the &"q"& and &"R"& flags).
23098
23099 The order in which addresses are rewritten is undefined, may change between
23100 releases, and must not be relied on, with one exception: when a message is
23101 received, the envelope sender is always rewritten first, before any header
23102 lines are rewritten. For example, the replacement string for a rewrite of an
23103 address in &'To:'& must not assume that the message's address in &'From:'& has
23104 (or has not) already been rewritten. However, a rewrite of &'From:'& may assume
23105 that the envelope sender has already been rewritten.
23106
23107 .vindex "&$domain$&"
23108 .vindex "&$local_part$&"
23109 The variables &$local_part$& and &$domain$& can be used in the replacement
23110 string to refer to the address that is being rewritten. Note that lookup-driven
23111 rewriting can be done by a rule of the form
23112 .code
23113 *@*   ${lookup ...
23114 .endd
23115 where the lookup key uses &$1$& and &$2$& or &$local_part$& and &$domain$& to
23116 refer to the address that is being rewritten.
23117
23118
23119 .section "Rewriting patterns" "SECID151"
23120 .cindex "rewriting" "patterns"
23121 .cindex "address list" "in a rewriting pattern"
23122 The source pattern in a rewriting rule is any item which may appear in an
23123 address list (see section &<<SECTaddresslist>>&). It is in fact processed as a
23124 single-item address list, which means that it is expanded before being tested
23125 against the address. As always, if you use a regular expression as a pattern,
23126 you must take care to escape dollar and backslash characters, or use the &`\N`&
23127 facility to suppress string expansion within the regular expression.
23128
23129 Domains in patterns should be given in lower case. Local parts in patterns are
23130 case-sensitive. If you want to do case-insensitive matching of local parts, you
23131 can use a regular expression that starts with &`^(?i)`&.
23132
23133 .cindex "numerical variables (&$1$& &$2$& etc)" "in rewriting rules"
23134 After matching, the numerical variables &$1$&, &$2$&, etc. may be set,
23135 depending on the type of match which occurred. These can be used in the
23136 replacement string to insert portions of the incoming address. &$0$& always
23137 refers to the complete incoming address. When a regular expression is used, the
23138 numerical variables are set from its capturing subexpressions. For other types
23139 of pattern they are set as follows:
23140
23141 .ilist
23142 If a local part or domain starts with an asterisk, the numerical variables
23143 refer to the character strings matched by asterisks, with &$1$& associated with
23144 the first asterisk, and &$2$& with the second, if present. For example, if the
23145 pattern
23146 .code
23147 *queen@*.fict.example
23148 .endd
23149 is matched against the address &'hearts-queen@wonderland.fict.example'& then
23150 .code
23151 $0 = hearts-queen@wonderland.fict.example
23152 $1 = hearts-
23153 $2 = wonderland
23154 .endd
23155 Note that if the local part does not start with an asterisk, but the domain
23156 does, it is &$1$& that contains the wild part of the domain.
23157
23158 .next
23159 If the domain part of the pattern is a partial lookup, the wild and fixed parts
23160 of the domain are placed in the next available numerical variables. Suppose,
23161 for example, that the address &'foo@bar.baz.example'& is processed by a
23162 rewriting rule of the form
23163 .display
23164 &`*@partial-dbm;/some/dbm/file`&    <&'replacement string'&>
23165 .endd
23166 and the key in the file that matches the domain is &`*.baz.example`&. Then
23167 .code
23168 $1 = foo
23169 $2 = bar
23170 $3 = baz.example
23171 .endd
23172 If the address &'foo@baz.example'& is looked up, this matches the same
23173 wildcard file entry, and in this case &$2$& is set to the empty string, but
23174 &$3$& is still set to &'baz.example'&. If a non-wild key is matched in a
23175 partial lookup, &$2$& is again set to the empty string and &$3$& is set to the
23176 whole domain. For non-partial domain lookups, no numerical variables are set.
23177 .endlist
23178
23179
23180 .section "Rewriting replacements" "SECID152"
23181 .cindex "rewriting" "replacements"
23182 If the replacement string for a rule is a single asterisk, addresses that
23183 match the pattern and the flags are &'not'& rewritten, and no subsequent
23184 rewriting rules are scanned. For example,
23185 .code
23186 hatta@lookingglass.fict.example  *  f
23187 .endd
23188 specifies that &'hatta@lookingglass.fict.example'& is never to be rewritten in
23189 &'From:'& headers.
23190
23191 .vindex "&$domain$&"
23192 .vindex "&$local_part$&"
23193 If the replacement string is not a single asterisk, it is expanded, and must
23194 yield a fully qualified address. Within the expansion, the variables
23195 &$local_part$& and &$domain$& refer to the address that is being rewritten.
23196 Any letters they contain retain their original case &-- they are not lower
23197 cased. The numerical variables are set up according to the type of pattern that
23198 matched the address, as described above. If the expansion is forced to fail by
23199 the presence of &"fail"& in a conditional or lookup item, rewriting by the
23200 current rule is abandoned, but subsequent rules may take effect. Any other
23201 expansion failure causes the entire rewriting operation to be abandoned, and an
23202 entry written to the panic log.
23203
23204
23205
23206 .section "Rewriting flags" "SECID153"
23207 There are three different kinds of flag that may appear on rewriting rules:
23208
23209 .ilist
23210 Flags that specify which headers and envelope addresses to rewrite: E, F, T, b,
23211 c, f, h, r, s, t.
23212 .next
23213 A flag that specifies rewriting at SMTP time: S.
23214 .next
23215 Flags that control the rewriting process: Q, q, R, w.
23216 .endlist
23217
23218 For rules that are part of the &%headers_rewrite%& generic transport option,
23219 E, F, T, and S are not permitted.
23220
23221
23222
23223 .section "Flags specifying which headers and envelope addresses to rewrite" &&&
23224          "SECID154"
23225 .cindex "rewriting" "flags"
23226 If none of the following flag letters, nor the &"S"& flag (see section
23227 &<<SECTrewriteS>>&) are present, a main rewriting rule applies to all headers
23228 and to both the sender and recipient fields of the envelope, whereas a
23229 transport-time rewriting rule just applies to all headers. Otherwise, the
23230 rewriting rule is skipped unless the relevant addresses are being processed.
23231 .display
23232 &`E`&       rewrite all envelope fields
23233 &`F`&       rewrite the envelope From field
23234 &`T`&       rewrite the envelope To field
23235 &`b`&       rewrite the &'Bcc:'& header
23236 &`c`&       rewrite the &'Cc:'& header
23237 &`f`&       rewrite the &'From:'& header
23238 &`h`&       rewrite all headers
23239 &`r`&       rewrite the &'Reply-To:'& header
23240 &`s`&       rewrite the &'Sender:'& header
23241 &`t`&       rewrite the &'To:'& header
23242 .endd
23243 "All headers" means all of the headers listed above that can be selected
23244 individually, plus their &'Resent-'& versions. It does not include
23245 other headers such as &'Subject:'& etc.
23246
23247 You should be particularly careful about rewriting &'Sender:'& headers, and
23248 restrict this to special known cases in your own domains.
23249
23250
23251 .section "The SMTP-time rewriting flag" "SECTrewriteS"
23252 .cindex "SMTP" "rewriting malformed addresses"
23253 .cindex "RCPT" "rewriting argument of"
23254 .cindex "MAIL" "rewriting argument of"
23255 The rewrite flag &"S"& specifies a rewrite of incoming envelope addresses at
23256 SMTP time, as soon as an address is received in a MAIL or RCPT command, and
23257 before any other processing; even before syntax checking. The pattern is
23258 required to be a regular expression, and it is matched against the whole of the
23259 data for the command, including any surrounding angle brackets.
23260
23261 .vindex "&$domain$&"
23262 .vindex "&$local_part$&"
23263 This form of rewrite rule allows for the handling of addresses that are not
23264 compliant with RFCs 2821 and 2822 (for example, &"bang paths"& in batched SMTP
23265 input). Because the input is not required to be a syntactically valid address,
23266 the variables &$local_part$& and &$domain$& are not available during the
23267 expansion of the replacement string. The result of rewriting replaces the
23268 original address in the MAIL or RCPT command.
23269
23270
23271 .section "Flags controlling the rewriting process" "SECID155"
23272 There are four flags which control the way the rewriting process works. These
23273 take effect only when a rule is invoked, that is, when the address is of the
23274 correct type (matches the flags) and matches the pattern:
23275
23276 .ilist
23277 If the &"Q"& flag is set on a rule, the rewritten address is permitted to be an
23278 unqualified local part. It is qualified with &%qualify_recipient%&. In the
23279 absence of &"Q"& the rewritten address must always include a domain.
23280 .next
23281 If the &"q"& flag is set on a rule, no further rewriting rules are considered,
23282 even if no rewriting actually takes place because of a &"fail"& in the
23283 expansion. The &"q"& flag is not effective if the address is of the wrong type
23284 (does not match the flags) or does not match the pattern.
23285 .next
23286 The &"R"& flag causes a successful rewriting rule to be re-applied to the new
23287 address, up to ten times. It can be combined with the &"q"& flag, to stop
23288 rewriting once it fails to match (after at least one successful rewrite).
23289 .next
23290 .cindex "rewriting" "whole addresses"
23291 When an address in a header is rewritten, the rewriting normally applies only
23292 to the working part of the address, with any comments and RFC 2822 &"phrase"&
23293 left unchanged. For example, rewriting might change
23294 .code
23295 From: Ford Prefect <fp42@restaurant.hitch.fict.example>
23296 .endd
23297 into
23298 .code
23299 From: Ford Prefect <prefectf@hitch.fict.example>
23300 .endd
23301 .cindex "RFC 2047"
23302 Sometimes there is a need to replace the whole address item, and this can be
23303 done by adding the flag letter &"w"& to a rule. If this is set on a rule that
23304 causes an address in a header line to be rewritten, the entire address is
23305 replaced, not just the working part. The replacement must be a complete RFC
23306 2822 address, including the angle brackets if necessary. If text outside angle
23307 brackets contains a character whose value is greater than 126 or less than 32
23308 (except for tab), the text is encoded according to RFC 2047. The character set
23309 is taken from &%headers_charset%&, which defaults to ISO-8859-1.
23310
23311 When the &"w"& flag is set on a rule that causes an envelope address to be
23312 rewritten, all but the working part of the replacement address is discarded.
23313 .endlist
23314
23315
23316 .section "Rewriting examples" "SECID156"
23317 Here is an example of the two common rewriting paradigms:
23318 .code
23319 *@*.hitch.fict.example  $1@hitch.fict.example
23320 *@hitch.fict.example    ${lookup{$1}dbm{/etc/realnames}\
23321                      {$value}fail}@hitch.fict.example bctfrF
23322 .endd
23323 Note the use of &"fail"& in the lookup expansion in the second rule, forcing
23324 the string expansion to fail if the lookup does not succeed. In this context it
23325 has the effect of leaving the original address unchanged, but Exim goes on to
23326 consider subsequent rewriting rules, if any, because the &"q"& flag is not
23327 present in that rule. An alternative to &"fail"& would be to supply &$1$&
23328 explicitly, which would cause the rewritten address to be the same as before,
23329 at the cost of a small bit of processing. Not supplying either of these is an
23330 error, since the rewritten address would then contain no local part.
23331
23332 The first example above replaces the domain with a superior, more general
23333 domain. This may not be desirable for certain local parts. If the rule
23334 .code
23335 root@*.hitch.fict.example  *
23336 .endd
23337 were inserted before the first rule, rewriting would be suppressed for the
23338 local part &'root'& at any domain ending in &'hitch.fict.example'&.
23339
23340 Rewriting can be made conditional on a number of tests, by making use of
23341 &${if$& in the expansion item. For example, to apply a rewriting rule only to
23342 messages that originate outside the local host:
23343 .code
23344 *@*.hitch.fict.example  "${if !eq {$sender_host_address}{}\
23345                          {$1@hitch.fict.example}fail}"
23346 .endd
23347 The replacement string is quoted in this example because it contains white
23348 space.
23349
23350 .cindex "rewriting" "bang paths"
23351 .cindex "bang paths" "rewriting"
23352 Exim does not handle addresses in the form of &"bang paths"&. If it sees such
23353 an address it treats it as an unqualified local part which it qualifies with
23354 the local qualification domain (if the source of the message is local or if the
23355 remote host is permitted to send unqualified addresses). Rewriting can
23356 sometimes be used to handle simple bang paths with a fixed number of
23357 components. For example, the rule
23358 .code
23359 \N^([^!]+)!(.*)@your.domain.example$\N   $2@$1
23360 .endd
23361 rewrites a two-component bang path &'host.name!user'& as the domain address
23362 &'user@host.name'&. However, there is a security implication in using this as
23363 a global rewriting rule for envelope addresses. It can provide a backdoor
23364 method for using your system as a relay, because the incoming addresses appear
23365 to be local. If the bang path addresses are received via SMTP, it is safer to
23366 use the &"S"& flag to rewrite them as they are received, so that relay checking
23367 can be done on the rewritten addresses.
23368 .ecindex IIDaddrew
23369
23370
23371
23372
23373
23374 . ////////////////////////////////////////////////////////////////////////////
23375 . ////////////////////////////////////////////////////////////////////////////
23376
23377 .chapter "Retry configuration" "CHAPretry"
23378 .scindex IIDretconf1 "retry" "configuration, description of"
23379 .scindex IIDregconf2 "configuration file" "retry section"
23380 The &"retry"& section of the runtime configuration file contains a list of
23381 retry rules that control how often Exim tries to deliver messages that cannot
23382 be delivered at the first attempt. If there are no retry rules (the section is
23383 empty or not present), there are no retries. In this situation, temporary
23384 errors are treated as permanent. The default configuration contains a single,
23385 general-purpose retry rule (see section &<<SECID57>>&). The &%-brt%& command
23386 line option can be used to test which retry rule will be used for a given
23387 address, domain and error.
23388
23389 The most common cause of retries is temporary failure to deliver to a remote
23390 host because the host is down, or inaccessible because of a network problem.
23391 Exim's retry processing in this case is applied on a per-host (strictly, per IP
23392 address) basis, not on a per-message basis. Thus, if one message has recently
23393 been delayed, delivery of a new message to the same host is not immediately
23394 tried, but waits for the host's retry time to arrive. If the &%retry_defer%&
23395 log selector is set, the message
23396 .cindex "retry" "time not reached"
23397 &"retry time not reached"& is written to the main log whenever a delivery is
23398 skipped for this reason. Section &<<SECToutSMTPerr>>& contains more details of
23399 the handling of errors during remote deliveries.
23400
23401 Retry processing applies to routing as well as to delivering, except as covered
23402 in the next paragraph. The retry rules do not distinguish between these
23403 actions. It is not possible, for example, to specify different behaviour for
23404 failures to route the domain &'snark.fict.example'& and failures to deliver to
23405 the host &'snark.fict.example'&. I didn't think anyone would ever need this
23406 added complication, so did not implement it. However, although they share the
23407 same retry rule, the actual retry times for routing and transporting a given
23408 domain are maintained independently.
23409
23410 When a delivery is not part of a queue run (typically an immediate delivery on
23411 receipt of a message), the routers are always run, and local deliveries are
23412 always attempted, even if retry times are set for them. This makes for better
23413 behaviour if one particular message is causing problems (for example, causing
23414 quota overflow, or provoking an error in a filter file). If such a delivery
23415 suffers a temporary failure, the retry data is updated as normal, and
23416 subsequent delivery attempts from queue runs occur only when the retry time for
23417 the local address is reached.
23418
23419 .section "Changing retry rules" "SECID157"
23420 If you change the retry rules in your configuration, you should consider
23421 whether or not to delete the retry data that is stored in Exim's spool area in
23422 files with names like &_db/retry_&. Deleting any of Exim's hints files is
23423 always safe; that is why they are called &"hints"&.
23424
23425 The hints retry data contains suggested retry times based on the previous
23426 rules. In the case of a long-running problem with a remote host, it might
23427 record the fact that the host has timed out. If your new rules increase the
23428 timeout time for such a host, you should definitely remove the old retry data
23429 and let Exim recreate it, based on the new rules. Otherwise Exim might bounce
23430 messages that it should now be retaining.
23431
23432
23433
23434 .section "Format of retry rules" "SECID158"
23435 .cindex "retry" "rules"
23436 Each retry rule occupies one line and consists of three or four parts,
23437 separated by white space: a pattern, an error name, an optional list of sender
23438 addresses, and a list of retry parameters. The pattern and sender lists must be
23439 enclosed in double quotes if they contain white space. The rules are searched
23440 in order until one is found where the pattern, error name, and sender list (if
23441 present) match the failing host or address, the error that occurred, and the
23442 message's sender, respectively.
23443
23444
23445 The pattern is any single item that may appear in an address list (see section
23446 &<<SECTaddresslist>>&). It is in fact processed as a one-item address list,
23447 which means that it is expanded before being tested against the address that
23448 has been delayed. A negated address list item is permitted. Address
23449 list processing treats a plain domain name as if it were preceded by &"*@"&,
23450 which makes it possible for many retry rules to start with just a domain. For
23451 example,
23452 .code
23453 lookingglass.fict.example        *  F,24h,30m;
23454 .endd
23455 provides a rule for any address in the &'lookingglass.fict.example'& domain,
23456 whereas
23457 .code
23458 alice@lookingglass.fict.example  *  F,24h,30m;
23459 .endd
23460 applies only to temporary failures involving the local part &%alice%&.
23461 In practice, almost all rules start with a domain name pattern without a local
23462 part.
23463
23464 .cindex "regular expressions" "in retry rules"
23465 &*Warning*&: If you use a regular expression in a routing rule pattern, it
23466 must match a complete address, not just a domain, because that is how regular
23467 expressions work in address lists.
23468 .display
23469 &`^\Nxyz\d+\.abc\.example$\N        *  G,1h,10m,2`&     &%Wrong%&
23470 &`^\N[^@]+@xyz\d+\.abc\.example$\N  *  G,1h,10m,2`&     &%Right%&
23471 .endd
23472
23473
23474 .section "Choosing which retry rule to use for address errors" "SECID159"
23475 When Exim is looking for a retry rule after a routing attempt has failed (for
23476 example, after a DNS timeout), each line in the retry configuration is tested
23477 against the complete address only if &%retry_use_local_part%& is set for the
23478 router. Otherwise, only the domain is used, except when matching against a
23479 regular expression, when the local part of the address is replaced with &"*"&.
23480 A domain on its own can match a domain pattern, or a pattern that starts with
23481 &"*@"&. By default, &%retry_use_local_part%& is true for routers where
23482 &%check_local_user%& is true, and false for other routers.
23483
23484 Similarly, when Exim is looking for a retry rule after a local delivery has
23485 failed (for example, after a mailbox full error), each line in the retry
23486 configuration is tested against the complete address only if
23487 &%retry_use_local_part%& is set for the transport (it defaults true for all
23488 local transports).
23489
23490 .cindex "4&'xx'& responses" "retry rules for"
23491 However, when Exim is looking for a retry rule after a remote delivery attempt
23492 suffers an address error (a 4&'xx'& SMTP response for a recipient address), the
23493 whole address is always used as the key when searching the retry rules. The
23494 rule that is found is used to create a retry time for the combination of the
23495 failing address and the message's sender. It is the combination of sender and
23496 recipient that is delayed in subsequent queue runs until its retry time is
23497 reached. You can delay the recipient without regard to the sender by setting
23498 &%address_retry_include_sender%& false in the &(smtp)& transport but this can
23499 lead to problems with servers that regularly issue 4&'xx'& responses to RCPT
23500 commands.
23501
23502
23503
23504 .section "Choosing which retry rule to use for host and message errors" &&&
23505          "SECID160"
23506 For a temporary error that is not related to an individual address (for
23507 example, a connection timeout), each line in the retry configuration is checked
23508 twice. First, the name of the remote host is used as a domain name (preceded by
23509 &"*@"& when matching a regular expression). If this does not match the line,
23510 the domain from the email address is tried in a similar fashion. For example,
23511 suppose the MX records for &'a.b.c.example'& are
23512 .code
23513 a.b.c.example  MX  5  x.y.z.example
23514                MX  6  p.q.r.example
23515                MX  7  m.n.o.example
23516 .endd
23517 and the retry rules are
23518 .code
23519 p.q.r.example    *      F,24h,30m;
23520 a.b.c.example    *      F,4d,45m;
23521 .endd
23522 and a delivery to the host &'x.y.z.example'& suffers a connection failure. The
23523 first rule matches neither the host nor the domain, so Exim looks at the second
23524 rule. This does not match the host, but it does match the domain, so it is used
23525 to calculate the retry time for the host &'x.y.z.example'&. Meanwhile, Exim
23526 tries to deliver to &'p.q.r.example'&. If this also suffers a host error, the
23527 first retry rule is used, because it matches the host.
23528
23529 In other words, temporary failures to deliver to host &'p.q.r.example'& use the
23530 first rule to determine retry times, but for all the other hosts for the domain
23531 &'a.b.c.example'&, the second rule is used. The second rule is also used if
23532 routing to &'a.b.c.example'& suffers a temporary failure.
23533
23534 &*Note*&: The host name is used when matching the patterns, not its IP address.
23535 However, if a message is routed directly to an IP address without the use of a
23536 host name, for example, if a &(manualroute)& router contains a setting such as:
23537 .code
23538 route_list = *.a.example  192.168.34.23
23539 .endd
23540 then the &"host name"& that is used when searching for a retry rule is the
23541 textual form of the IP address.
23542
23543 .section "Retry rules for specific errors" "SECID161"
23544 .cindex "retry" "specific errors; specifying"
23545 The second field in a retry rule is the name of a particular error, or an
23546 asterisk, which matches any error. The errors that can be tested for are:
23547
23548 .vlist
23549 .vitem &%auth_failed%&
23550 Authentication failed when trying to send to a host in the
23551 &%hosts_require_auth%& list in an &(smtp)& transport.
23552
23553 .vitem &%data_4xx%&
23554 A 4&'xx'& error was received for an outgoing DATA command, either immediately
23555 after the command, or after sending the message's data.
23556
23557 .vitem &%mail_4xx%&
23558 A 4&'xx'& error was received for an outgoing MAIL command.
23559
23560 .vitem &%rcpt_4xx%&
23561 A 4&'xx'& error was received for an outgoing RCPT command.
23562 .endlist
23563
23564 For the three 4&'xx'& errors, either the first or both of the x's can be given
23565 as specific digits, for example: &`mail_45x`& or &`rcpt_436`&. For example, to
23566 recognize 452 errors given to RCPT commands for addresses in a certain domain,
23567 and have retries every ten minutes with a one-hour timeout, you could set up a
23568 retry rule of this form:
23569 .code
23570 the.domain.name  rcpt_452   F,1h,10m
23571 .endd
23572 These errors apply to both outgoing SMTP (the &(smtp)& transport) and outgoing
23573 LMTP (either the &(lmtp)& transport, or the &(smtp)& transport in LMTP mode).
23574
23575 .vlist
23576 .vitem &%lost_connection%&
23577 A server unexpectedly closed the SMTP connection. There may, of course,
23578 legitimate reasons for this (host died, network died), but if it repeats a lot
23579 for the same host, it indicates something odd.
23580
23581 .vitem &%refused_MX%&
23582 A connection to a host obtained from an MX record was refused.
23583
23584 .vitem &%refused_A%&
23585 A connection to a host not obtained from an MX record was refused.
23586
23587 .vitem &%refused%&
23588 A connection was refused.
23589
23590 .vitem &%timeout_connect_MX%&
23591 A connection attempt to a host obtained from an MX record timed out.
23592
23593 .vitem &%timeout_connect_A%&
23594 A connection attempt to a host not obtained from an MX record timed out.
23595
23596 .vitem &%timeout_connect%&
23597 A connection attempt timed out.
23598
23599 .vitem &%timeout_MX%&
23600 There was a timeout while connecting or during an SMTP session with a host
23601 obtained from an MX record.
23602
23603 .vitem &%timeout_A%&
23604 There was a timeout while connecting or during an SMTP session with a host not
23605 obtained from an MX record.
23606
23607 .vitem &%timeout%&
23608 There was a timeout while connecting or during an SMTP session.
23609
23610 .vitem &%tls_required%&
23611 The server was required to use TLS (it matched &%hosts_require_tls%& in the
23612 &(smtp)& transport), but either did not offer TLS, or it responded with 4&'xx'&
23613 to STARTTLS, or there was a problem setting up the TLS connection.
23614
23615 .vitem &%quota%&
23616 A mailbox quota was exceeded in a local delivery by the &(appendfile)&
23617 transport.
23618
23619 .vitem &%quota_%&<&'time'&>
23620 .cindex "quota" "error testing in retry rule"
23621 .cindex "retry" "quota error testing"
23622 A mailbox quota was exceeded in a local delivery by the &(appendfile)&
23623 transport, and the mailbox has not been accessed for <&'time'&>. For example,
23624 &'quota_4d'& applies to a quota error when the mailbox has not been accessed
23625 for four days.
23626 .endlist
23627
23628 .cindex "mailbox" "time of last read"
23629 The idea of &%quota_%&<&'time'&> is to make it possible to have shorter
23630 timeouts when the mailbox is full and is not being read by its owner. Ideally,
23631 it should be based on the last time that the user accessed the mailbox.
23632 However, it is not always possible to determine this. Exim uses the following
23633 heuristic rules:
23634
23635 .ilist
23636 If the mailbox is a single file, the time of last access (the &"atime"&) is
23637 used. As no new messages are being delivered (because the mailbox is over
23638 quota), Exim does not access the file, so this is the time of last user access.
23639 .next
23640 .cindex "maildir format" "time of last read"
23641 For a maildir delivery, the time of last modification of the &_new_&
23642 subdirectory is used. As the mailbox is over quota, no new files are created in
23643 the &_new_& subdirectory, because no new messages are being delivered. Any
23644 change to the &_new_& subdirectory is therefore assumed to be the result of an
23645 MUA moving a new message to the &_cur_& directory when it is first read. The
23646 time that is used is therefore the last time that the user read a new message.
23647 .next
23648 For other kinds of multi-file mailbox, the time of last access cannot be
23649 obtained, so a retry rule that uses this type of error field is never matched.
23650 .endlist
23651
23652 The quota errors apply both to system-enforced quotas and to Exim's own quota
23653 mechanism in the &(appendfile)& transport. The &'quota'& error also applies
23654 when a local delivery is deferred because a partition is full (the ENOSPC
23655 error).
23656
23657
23658
23659 .section "Retry rules for specified senders" "SECID162"
23660 .cindex "retry" "rules; sender-specific"
23661 You can specify retry rules that apply only when the failing message has a
23662 specific sender. In particular, this can be used to define retry rules that
23663 apply only to bounce messages. The third item in a retry rule can be of this
23664 form:
23665 .display
23666 &`senders=`&<&'address list'&>
23667 .endd
23668 The retry timings themselves are then the fourth item. For example:
23669 .code
23670 *   rcpt_4xx   senders=:   F,1h,30m
23671 .endd
23672 matches recipient 4&'xx'& errors for bounce messages sent to any address at any
23673 host. If the address list contains white space, it must be enclosed in quotes.
23674 For example:
23675 .code
23676 a.domain  rcpt_452  senders="xb.dom : yc.dom"  G,8h,10m,1.5
23677 .endd
23678 &*Warning*&: This facility can be unhelpful if it is used for host errors
23679 (which do not depend on the recipient). The reason is that the sender is used
23680 only to match the retry rule. Once the rule has been found for a host error,
23681 its contents are used to set a retry time for the host, and this will apply to
23682 all messages, not just those with specific senders.
23683
23684 When testing retry rules using &%-brt%&, you can supply a sender using the
23685 &%-f%& command line option, like this:
23686 .code
23687 exim -f "" -brt user@dom.ain
23688 .endd
23689 If you do not set &%-f%& with &%-brt%&, a retry rule that contains a senders
23690 list is never matched.
23691
23692
23693
23694
23695
23696 .section "Retry parameters" "SECID163"
23697 .cindex "retry" "parameters in rules"
23698 The third (or fourth, if a senders list is present) field in a retry rule is a
23699 sequence of retry parameter sets, separated by semicolons. Each set consists of
23700 .display
23701 <&'letter'&>,<&'cutoff time'&>,<&'arguments'&>
23702 .endd
23703 The letter identifies the algorithm for computing a new retry time; the cutoff
23704 time is the time beyond which this algorithm no longer applies, and the
23705 arguments vary the algorithm's action. The cutoff time is measured from the
23706 time that the first failure for the domain (combined with the local part if
23707 relevant) was detected, not from the time the message was received.
23708
23709 .cindex "retry" "algorithms"
23710 .cindex "retry" "fixed intervals"
23711 .cindex "retry" "increasing intervals"
23712 .cindex "retry" "random intervals"
23713 The available algorithms are:
23714
23715 .ilist
23716 &'F'&: retry at fixed intervals. There is a single time parameter specifying
23717 the interval.
23718 .next
23719 &'G'&: retry at geometrically increasing intervals. The first argument
23720 specifies a starting value for the interval, and the second a multiplier, which
23721 is used to increase the size of the interval at each retry.
23722 .next
23723 &'H'&: retry at randomized intervals. The arguments are as for &'G'&. For each
23724 retry, the previous interval is multiplied by the factor in order to get a
23725 maximum for the next interval. The minimum interval is the first argument of
23726 the parameter, and an actual interval is chosen randomly between them. Such a
23727 rule has been found to be helpful in cluster configurations when all the
23728 members of the cluster restart at once, and may therefore synchronize their
23729 queue processing times.
23730 .endlist
23731
23732 When computing the next retry time, the algorithm definitions are scanned in
23733 order until one whose cutoff time has not yet passed is reached. This is then
23734 used to compute a new retry time that is later than the current time. In the
23735 case of fixed interval retries, this simply means adding the interval to the
23736 current time. For geometrically increasing intervals, retry intervals are
23737 computed from the rule's parameters until one that is greater than the previous
23738 interval is found. The main configuration variable
23739 .cindex "limit" "retry interval"
23740 .cindex "retry" "interval, maximum"
23741 .oindex "&%retry_interval_max%&"
23742 &%retry_interval_max%& limits the maximum interval between retries. It
23743 cannot be set greater than &`24h`&, which is its default value.
23744
23745 A single remote domain may have a number of hosts associated with it, and each
23746 host may have more than one IP address. Retry algorithms are selected on the
23747 basis of the domain name, but are applied to each IP address independently. If,
23748 for example, a host has two IP addresses and one is unusable, Exim will
23749 generate retry times for it and will not try to use it until its next retry
23750 time comes. Thus the good IP address is likely to be tried first most of the
23751 time.
23752
23753 .cindex "hints database" "use for retrying"
23754 Retry times are hints rather than promises. Exim does not make any attempt to
23755 run deliveries exactly at the computed times. Instead, a queue runner process
23756 starts delivery processes for delayed messages periodically, and these attempt
23757 new deliveries only for those addresses that have passed their next retry time.
23758 If a new message arrives for a deferred address, an immediate delivery attempt
23759 occurs only if the address has passed its retry time. In the absence of new
23760 messages, the minimum time between retries is the interval between queue runner
23761 processes. There is not much point in setting retry times of five minutes if
23762 your queue runners happen only once an hour, unless there are a significant
23763 number of incoming messages (which might be the case on a system that is
23764 sending everything to a smart host, for example).
23765
23766 The data in the retry hints database can be inspected by using the
23767 &'exim_dumpdb'& or &'exim_fixdb'& utility programs (see chapter
23768 &<<CHAPutils>>&). The latter utility can also be used to change the data. The
23769 &'exinext'& utility script can be used to find out what the next retry times
23770 are for the hosts associated with a particular mail domain, and also for local
23771 deliveries that have been deferred.
23772
23773
23774 .section "Retry rule examples" "SECID164"
23775 Here are some example retry rules:
23776 .code
23777 alice@wonderland.fict.example quota_5d  F,7d,3h
23778 wonderland.fict.example       quota_5d
23779 wonderland.fict.example       *         F,1h,15m; G,2d,1h,2;
23780 lookingglass.fict.example     *         F,24h,30m;
23781 *                 refused_A   F,2h,20m;
23782 *                 *           F,2h,15m; G,16h,1h,1.5; F,5d,8h
23783 .endd
23784 The first rule sets up special handling for mail to
23785 &'alice@wonderland.fict.example'& when there is an over-quota error and the
23786 mailbox has not been read for at least 5 days. Retries continue every three
23787 hours for 7 days. The second rule handles over-quota errors for all other local
23788 parts at &'wonderland.fict.example'&; the absence of a local part has the same
23789 effect as supplying &"*@"&. As no retry algorithms are supplied, messages that
23790 fail are bounced immediately if the mailbox has not been read for at least 5
23791 days.
23792
23793 The third rule handles all other errors at &'wonderland.fict.example'&; retries
23794 happen every 15 minutes for an hour, then with geometrically increasing
23795 intervals until two days have passed since a delivery first failed. After the
23796 first hour there is a delay of one hour, then two hours, then four hours, and
23797 so on (this is a rather extreme example).
23798
23799 The fourth rule controls retries for the domain &'lookingglass.fict.example'&.
23800 They happen every 30 minutes for 24 hours only. The remaining two rules handle
23801 all other domains, with special action for connection refusal from hosts that
23802 were not obtained from an MX record.
23803
23804 The final rule in a retry configuration should always have asterisks in the
23805 first two fields so as to provide a general catch-all for any addresses that do
23806 not have their own special handling. This example tries every 15 minutes for 2
23807 hours, then with intervals starting at one hour and increasing by a factor of
23808 1.5 up to 16 hours, then every 8 hours up to 5 days.
23809
23810
23811
23812 .section "Timeout of retry data" "SECID165"
23813 .cindex "timeout" "of retry data"
23814 .oindex "&%retry_data_expire%&"
23815 .cindex "hints database" "data expiry"
23816 .cindex "retry" "timeout of data"
23817 Exim timestamps the data that it writes to its retry hints database. When it
23818 consults the data during a delivery it ignores any that is older than the value
23819 set in &%retry_data_expire%& (default 7 days). If, for example, a host hasn't
23820 been tried for 7 days, Exim will try to deliver to it immediately a message
23821 arrives, and if that fails, it will calculate a retry time as if it were
23822 failing for the first time.
23823
23824 This improves the behaviour for messages routed to rarely-used hosts such as MX
23825 backups. If such a host was down at one time, and happens to be down again when
23826 Exim tries a month later, using the old retry data would imply that it had been
23827 down all the time, which is not a justified assumption.
23828
23829 If a host really is permanently dead, this behaviour causes a burst of retries
23830 every now and again, but only if messages routed to it are rare. If there is a
23831 message at least once every 7 days the retry data never expires.
23832
23833
23834
23835
23836 .section "Long-term failures" "SECID166"
23837 .cindex "delivery failure, long-term"
23838 .cindex "retry" "after long-term failure"
23839 Special processing happens when an email address has been failing for so long
23840 that the cutoff time for the last algorithm is reached. For example, using the
23841 default retry rule:
23842 .code
23843 * * F,2h,15m; G,16h,1h,1.5; F,4d,6h
23844 .endd
23845 the cutoff time is four days. Reaching the retry cutoff is independent of how
23846 long any specific message has been failing; it is the length of continuous
23847 failure for the recipient address that counts.
23848
23849 When the cutoff time is reached for a local delivery, or for all the IP
23850 addresses associated with a remote delivery, a subsequent delivery failure
23851 causes Exim to give up on the address, and a bounce message is generated.
23852 In order to cater for new messages that use the failing address, a next retry
23853 time is still computed from the final algorithm, and is used as follows:
23854
23855 For local deliveries, one delivery attempt is always made for any subsequent
23856 messages. If this delivery fails, the address fails immediately. The
23857 post-cutoff retry time is not used.
23858
23859 If the delivery is remote, there are two possibilities, controlled by the
23860 .oindex "&%delay_after_cutoff%&"
23861 &%delay_after_cutoff%& option of the &(smtp)& transport. The option is true by
23862 default. Until the post-cutoff retry time for one of the IP addresses is
23863 reached, the failing email address is bounced immediately, without a delivery
23864 attempt taking place. After that time, one new delivery attempt is made to
23865 those IP addresses that are past their retry times, and if that still fails,
23866 the address is bounced and new retry times are computed.
23867
23868 In other words, when all the hosts for a given email address have been failing
23869 for a long time, Exim bounces rather then defers until one of the hosts' retry
23870 times is reached. Then it tries once, and bounces if that attempt fails. This
23871 behaviour ensures that few resources are wasted in repeatedly trying to deliver
23872 to a broken destination, but if the host does recover, Exim will eventually
23873 notice.
23874
23875 If &%delay_after_cutoff%& is set false, Exim behaves differently. If all IP
23876 addresses are past their final cutoff time, Exim tries to deliver to those IP
23877 addresses that have not been tried since the message arrived. If there are
23878 no suitable IP addresses, or if they all fail, the address is bounced. In other
23879 words, it does not delay when a new message arrives, but tries the expired
23880 addresses immediately, unless they have been tried since the message arrived.
23881 If there is a continuous stream of messages for the failing domains, setting
23882 &%delay_after_cutoff%& false means that there will be many more attempts to
23883 deliver to permanently failing IP addresses than when &%delay_after_cutoff%& is
23884 true.
23885
23886 .section "Deliveries that work intermittently" "SECID167"
23887 .cindex "retry" "intermittently working deliveries"
23888 Some additional logic is needed to cope with cases where a host is
23889 intermittently available, or when a message has some attribute that prevents
23890 its delivery when others to the same address get through. In this situation,
23891 because some messages are successfully delivered, the &"retry clock"& for the
23892 host or address keeps getting reset by the successful deliveries, and so
23893 failing messages remain on the queue for ever because the cutoff time is never
23894 reached.
23895
23896 Two exceptional actions are applied to prevent this happening. The first
23897 applies to errors that are related to a message rather than a remote host.
23898 Section &<<SECToutSMTPerr>>& has a discussion of the different kinds of error;
23899 examples of message-related errors are 4&'xx'& responses to MAIL or DATA
23900 commands, and quota failures. For this type of error, if a message's arrival
23901 time is earlier than the &"first failed"& time for the error, the earlier time
23902 is used when scanning the retry rules to decide when to try next and when to
23903 time out the address.
23904
23905 The exceptional second action applies in all cases. If a message has been on
23906 the queue for longer than the cutoff time of any applicable retry rule for a
23907 given address, a delivery is attempted for that address, even if it is not yet
23908 time, and if this delivery fails, the address is timed out. A new retry time is
23909 not computed in this case, so that other messages for the same address are
23910 considered immediately.
23911 .ecindex IIDretconf1
23912 .ecindex IIDregconf2
23913
23914
23915
23916
23917
23918
23919 . ////////////////////////////////////////////////////////////////////////////
23920 . ////////////////////////////////////////////////////////////////////////////
23921
23922 .chapter "SMTP authentication" "CHAPSMTPAUTH"
23923 .scindex IIDauthconf1 "SMTP" "authentication configuration"
23924 .scindex IIDauthconf2 "authentication"
23925 The &"authenticators"& section of Exim's run time configuration is concerned
23926 with SMTP authentication. This facility is an extension to the SMTP protocol,
23927 described in RFC 2554, which allows a client SMTP host to authenticate itself
23928 to a server. This is a common way for a server to recognize clients that are
23929 permitted to use it as a relay. SMTP authentication is not of relevance to the
23930 transfer of mail between servers that have no managerial connection with each
23931 other.
23932
23933 .cindex "AUTH" "description of"
23934 Very briefly, the way SMTP authentication works is as follows:
23935
23936 .ilist
23937 The server advertises a number of authentication &'mechanisms'& in response to
23938 the client's EHLO command.
23939 .next
23940 The client issues an AUTH command, naming a specific mechanism. The command
23941 may, optionally, contain some authentication data.
23942 .next
23943 The server may issue one or more &'challenges'&, to which the client must send
23944 appropriate responses. In simple authentication mechanisms, the challenges are
23945 just prompts for user names and passwords. The server does not have to issue
23946 any challenges &-- in some mechanisms the relevant data may all be transmitted
23947 with the AUTH command.
23948 .next
23949 The server either accepts or denies authentication.
23950 .next
23951 If authentication succeeds, the client may optionally make use of the AUTH
23952 option on the MAIL command to pass an authenticated sender in subsequent
23953 mail transactions. Authentication lasts for the remainder of the SMTP
23954 connection.
23955 .next
23956 If authentication fails, the client may give up, or it may try a different
23957 authentication mechanism, or it may try transferring mail over the
23958 unauthenticated connection.
23959 .endlist
23960
23961 If you are setting up a client, and want to know which authentication
23962 mechanisms the server supports, you can use Telnet to connect to port 25 (the
23963 SMTP port) on the server, and issue an EHLO command. The response to this
23964 includes the list of supported mechanisms. For example:
23965 .display
23966 &`$ `&&*&`telnet server.example 25`&*&
23967 &`Trying 192.168.34.25...`&
23968 &`Connected to server.example.`&
23969 &`Escape character is &#x0027;^]&#x0027;.`&
23970 &`220 server.example ESMTP Exim 4.20 ...`&
23971 &*&`ehlo client.example`&*&
23972 &`250-server.example Hello client.example [10.8.4.5]`&
23973 &`250-SIZE 52428800`&
23974 &`250-PIPELINING`&
23975 &`250-AUTH PLAIN`&
23976 &`250 HELP`&
23977 .endd
23978 The second-last line of this example output shows that the server supports
23979 authentication using the PLAIN mechanism. In Exim, the different authentication
23980 mechanisms are configured by specifying &'authenticator'& drivers. Like the
23981 routers and transports, which authenticators are included in the binary is
23982 controlled by build-time definitions. The following are currently available,
23983 included by setting
23984 .code
23985 AUTH_CRAM_MD5=yes
23986 AUTH_CYRUS_SASL=yes
23987 AUTH_DOVECOT=yes
23988 AUTH_GSASL=yes
23989 AUTH_HEIMDAL_GSSAPI=yes
23990 AUTH_PLAINTEXT=yes
23991 AUTH_SPA=yes
23992 .endd
23993 in &_Local/Makefile_&, respectively. The first of these supports the CRAM-MD5
23994 authentication mechanism (RFC 2195), and the second provides an interface to
23995 the Cyrus SASL authentication library.
23996 The third is an interface to Dovecot's authentication system, delegating the
23997 work via a socket interface.
23998 The fourth provides an interface to the GNU SASL authentication library, which
23999 provides mechanisms but typically not data sources.
24000 The fifth provides direct access to Heimdal GSSAPI, geared for Kerberos, but
24001 supporting setting a server keytab.
24002 The sixth can be configured to support
24003 the PLAIN authentication mechanism (RFC 2595) or the LOGIN mechanism, which is
24004 not formally documented, but used by several MUAs. The seventh authenticator
24005 supports Microsoft's &'Secure Password Authentication'& mechanism.
24006
24007 The authenticators are configured using the same syntax as other drivers (see
24008 section &<<SECTfordricon>>&). If no authenticators are required, no
24009 authentication section need be present in the configuration file. Each
24010 authenticator can in principle have both server and client functions. When Exim
24011 is receiving SMTP mail, it is acting as a server; when it is sending out
24012 messages over SMTP, it is acting as a client. Authenticator configuration
24013 options are provided for use in both these circumstances.
24014
24015 To make it clear which options apply to which situation, the prefixes
24016 &%server_%& and &%client_%& are used on option names that are specific to
24017 either the server or the client function, respectively. Server and client
24018 functions are disabled if none of their options are set. If an authenticator is
24019 to be used for both server and client functions, a single definition, using
24020 both sets of options, is required. For example:
24021 .code
24022 cram:
24023   driver = cram_md5
24024   public_name = CRAM-MD5
24025   server_secret = ${if eq{$auth1}{ph10}{secret1}fail}
24026   client_name = ph10
24027   client_secret = secret2
24028 .endd
24029 The &%server_%& option is used when Exim is acting as a server, and the
24030 &%client_%& options when it is acting as a client.
24031
24032 Descriptions of the individual authenticators are given in subsequent chapters.
24033 The remainder of this chapter covers the generic options for the
24034 authenticators, followed by general discussion of the way authentication works
24035 in Exim.
24036
24037 &*Beware:*& the meaning of &$auth1$&, &$auth2$&, ... varies on a per-driver and
24038 per-mechanism basis.  Please read carefully to determine which variables hold
24039 account labels such as usercodes and which hold passwords or other
24040 authenticating data.
24041
24042 Note that some mechanisms support two different identifiers for accounts: the
24043 &'authentication id'& and the &'authorization id'&.  The contractions &'authn'&
24044 and &'authz'& are commonly encountered.  The American spelling is standard here.
24045 Conceptually, authentication data such as passwords are tied to the identifier
24046 used to authenticate; servers may have rules to permit one user to act as a
24047 second user, so that after login the session is treated as though that second
24048 user had logged in.  That second user is the &'authorization id'&.  A robust
24049 configuration might confirm that the &'authz'& field is empty or matches the
24050 &'authn'& field.  Often this is just ignored.  The &'authn'& can be considered
24051 as verified data, the &'authz'& as an unverified request which the server might
24052 choose to honour.
24053
24054 A &'realm'& is a text string, typically a domain name, presented by a server
24055 to a client to help it select an account and credentials to use.  In some
24056 mechanisms, the client and server provably agree on the realm, but clients
24057 typically can not treat the realm as secure data to be blindly trusted.
24058
24059
24060
24061 .section "Generic options for authenticators" "SECID168"
24062 .cindex "authentication" "generic options"
24063 .cindex "options" "generic; for authenticators"
24064
24065 .option client_condition authenticators string&!! unset
24066 When Exim is authenticating as a client, it skips any authenticator whose
24067 &%client_condition%& expansion yields &"0"&, &"no"&, or &"false"&. This can be
24068 used, for example, to skip plain text authenticators when the connection is not
24069 encrypted by a setting such as:
24070 .code
24071 client_condition = ${if !eq{$tls_out_cipher}{}}
24072 .endd
24073
24074
24075 .option client_set_id authenticators string&!! unset
24076 When client authentication succeeds, this condition is expanded; the
24077 result is used in the log lines for outbound messasges.
24078 Typically it will be the user name used for authentication.
24079
24080
24081 .option driver authenticators string unset
24082 This option must always be set. It specifies which of the available
24083 authenticators is to be used.
24084
24085
24086 .option public_name authenticators string unset
24087 This option specifies the name of the authentication mechanism that the driver
24088 implements, and by which it is known to the outside world. These names should
24089 contain only upper case letters, digits, underscores, and hyphens (RFC 2222),
24090 but Exim in fact matches them caselessly. If &%public_name%& is not set, it
24091 defaults to the driver's instance name.
24092
24093
24094 .option server_advertise_condition authenticators string&!! unset
24095 When a server is about to advertise an authentication mechanism, the condition
24096 is expanded. If it yields the empty string, &"0"&, &"no"&, or &"false"&, the
24097 mechanism is not advertised.
24098 If the expansion fails, the mechanism is not advertised. If the failure was not
24099 forced, and was not caused by a lookup defer, the incident is logged.
24100 See section &<<SECTauthexiser>>& below for further discussion.
24101
24102
24103 .option server_condition authenticators string&!! unset
24104 This option must be set for a &%plaintext%& server authenticator, where it
24105 is used directly to control authentication. See section &<<SECTplainserver>>&
24106 for details.
24107
24108 For the &(gsasl)& authenticator, this option is required for various
24109 mechanisms; see chapter &<<CHAPgsasl>>& for details.
24110
24111 For the other authenticators, &%server_condition%& can be used as an additional
24112 authentication or authorization mechanism that is applied after the other
24113 authenticator conditions succeed. If it is set, it is expanded when the
24114 authenticator would otherwise return a success code. If the expansion is forced
24115 to fail, authentication fails. Any other expansion failure causes a temporary
24116 error code to be returned. If the result of a successful expansion is an empty
24117 string, &"0"&, &"no"&, or &"false"&, authentication fails. If the result of the
24118 expansion is &"1"&, &"yes"&, or &"true"&, authentication succeeds. For any
24119 other result, a temporary error code is returned, with the expanded string as
24120 the error text.
24121
24122
24123 .option server_debug_print authenticators string&!! unset
24124 If this option is set and authentication debugging is enabled (see the &%-d%&
24125 command line option), the string is expanded and included in the debugging
24126 output when the authenticator is run as a server. This can help with checking
24127 out the values of variables.
24128 If expansion of the string fails, the error message is written to the debugging
24129 output, and Exim carries on processing.
24130
24131
24132 .option server_set_id authenticators string&!! unset
24133 .vindex "&$authenticated_id$&"
24134 When an Exim server successfully authenticates a client, this string is
24135 expanded using data from the authentication, and preserved for any incoming
24136 messages in the variable &$authenticated_id$&. It is also included in the log
24137 lines for incoming messages. For example, a user/password authenticator
24138 configuration might preserve the user name that was used to authenticate, and
24139 refer to it subsequently during delivery of the message.
24140 If expansion fails, the option is ignored.
24141
24142
24143 .option server_mail_auth_condition authenticators string&!! unset
24144 This option allows a server to discard authenticated sender addresses supplied
24145 as part of MAIL commands in SMTP connections that are authenticated by the
24146 driver on which &%server_mail_auth_condition%& is set. The option is not used
24147 as part of the authentication process; instead its (unexpanded) value is
24148 remembered for later use.
24149 How it is used is described in the following section.
24150
24151
24152
24153
24154
24155 .section "The AUTH parameter on MAIL commands" "SECTauthparamail"
24156 .cindex "authentication" "sender; authenticated"
24157 .cindex "AUTH" "on MAIL command"
24158 When a client supplied an AUTH= item on a MAIL command, Exim applies
24159 the following checks before accepting it as the authenticated sender of the
24160 message:
24161
24162 .ilist
24163 If the connection is not using extended SMTP (that is, HELO was used rather
24164 than EHLO), the use of AUTH= is a syntax error.
24165 .next
24166 If the value of the AUTH= parameter is &"<>"&, it is ignored.
24167 .next
24168 .vindex "&$authenticated_sender$&"
24169 If &%acl_smtp_mailauth%& is defined, the ACL it specifies is run. While it is
24170 running, the value of &$authenticated_sender$& is set to the value obtained
24171 from the AUTH= parameter. If the ACL does not yield &"accept"&, the value of
24172 &$authenticated_sender$& is deleted. The &%acl_smtp_mailauth%& ACL may not
24173 return &"drop"& or &"discard"&. If it defers, a temporary error code (451) is
24174 given for the MAIL command.
24175 .next
24176 If &%acl_smtp_mailauth%& is not defined, the value of the AUTH= parameter
24177 is accepted and placed in &$authenticated_sender$& only if the client has
24178 authenticated.
24179 .next
24180 If the AUTH= value was accepted by either of the two previous rules, and
24181 the client has authenticated, and the authenticator has a setting for the
24182 &%server_mail_auth_condition%&, the condition is checked at this point. The
24183 valued that was saved from the authenticator is expanded. If the expansion
24184 fails, or yields an empty string, &"0"&, &"no"&, or &"false"&, the value of
24185 &$authenticated_sender$& is deleted. If the expansion yields any other value,
24186 the value of &$authenticated_sender$& is retained and passed on with the
24187 message.
24188 .endlist
24189
24190
24191 When &$authenticated_sender$& is set for a message, it is passed on to other
24192 hosts to which Exim authenticates as a client. Do not confuse this value with
24193 &$authenticated_id$&, which is a string obtained from the authentication
24194 process, and which is not usually a complete email address.
24195
24196 .vindex "&$sender_address$&"
24197 Whenever an AUTH= value is ignored, the incident is logged. The ACL for
24198 MAIL, if defined, is run after AUTH= is accepted or ignored. It can
24199 therefore make use of &$authenticated_sender$&. The converse is not true: the
24200 value of &$sender_address$& is not yet set up when the &%acl_smtp_mailauth%&
24201 ACL is run.
24202
24203
24204
24205 .section "Authentication on an Exim server" "SECTauthexiser"
24206 .cindex "authentication" "on an Exim server"
24207 When Exim receives an EHLO command, it advertises the public names of those
24208 authenticators that are configured as servers, subject to the following
24209 conditions:
24210
24211 .ilist
24212 The client host must match &%auth_advertise_hosts%& (default *).
24213 .next
24214 It the &%server_advertise_condition%& option is set, its expansion must not
24215 yield the empty string, &"0"&, &"no"&, or &"false"&.
24216 .endlist
24217
24218 The order in which the authenticators are defined controls the order in which
24219 the mechanisms are advertised.
24220
24221 Some mail clients (for example, some versions of Netscape) require the user to
24222 provide a name and password for authentication whenever AUTH is advertised,
24223 even though authentication may not in fact be needed (for example, Exim may be
24224 set up to allow unconditional relaying from the client by an IP address check).
24225 You can make such clients more friendly by not advertising AUTH to them.
24226 For example, if clients on the 10.9.8.0/24 network are permitted (by the ACL
24227 that runs for RCPT) to relay without authentication, you should set
24228 .code
24229 auth_advertise_hosts = ! 10.9.8.0/24
24230 .endd
24231 so that no authentication mechanisms are advertised to them.
24232
24233 The &%server_advertise_condition%& controls the advertisement of individual
24234 authentication mechanisms. For example, it can be used to restrict the
24235 advertisement of a particular mechanism to encrypted connections, by a setting
24236 such as:
24237 .code
24238 server_advertise_condition = ${if eq{$tls_in_cipher}{}{no}{yes}}
24239 .endd
24240 .vindex "&$tls_in_cipher$&"
24241 If the session is encrypted, &$tls_in_cipher$& is not empty, and so the expansion
24242 yields &"yes"&, which allows the advertisement to happen.
24243
24244 When an Exim server receives an AUTH command from a client, it rejects it
24245 immediately if AUTH was not advertised in response to an earlier EHLO
24246 command. This is the case if
24247
24248 .ilist
24249 The client host does not match &%auth_advertise_hosts%&; or
24250 .next
24251 No authenticators are configured with server options; or
24252 .next
24253 Expansion of &%server_advertise_condition%& blocked the advertising of all the
24254 server authenticators.
24255 .endlist
24256
24257
24258 Otherwise, Exim runs the ACL specified by &%acl_smtp_auth%& in order
24259 to decide whether to accept the command. If &%acl_smtp_auth%& is not set,
24260 AUTH is accepted from any client host.
24261
24262 If AUTH is not rejected by the ACL, Exim searches its configuration for a
24263 server authentication mechanism that was advertised in response to EHLO and
24264 that matches the one named in the AUTH command. If it finds one, it runs
24265 the appropriate authentication protocol, and authentication either succeeds or
24266 fails. If there is no matching advertised mechanism, the AUTH command is
24267 rejected with a 504 error.
24268
24269 .vindex "&$received_protocol$&"
24270 .vindex "&$sender_host_authenticated$&"
24271 When a message is received from an authenticated host, the value of
24272 &$received_protocol$& is set to &"esmtpa"& or &"esmtpsa"& instead of &"esmtp"&
24273 or &"esmtps"&, and &$sender_host_authenticated$& contains the name (not the
24274 public name) of the authenticator driver that successfully authenticated the
24275 client from which the message was received. This variable is empty if there was
24276 no successful authentication.
24277
24278
24279
24280
24281 .section "Testing server authentication" "SECID169"
24282 .cindex "authentication" "testing a server"
24283 .cindex "AUTH" "testing a server"
24284 .cindex "base64 encoding" "creating authentication test data"
24285 Exim's &%-bh%& option can be useful for testing server authentication
24286 configurations. The data for the AUTH command has to be sent using base64
24287 encoding. A quick way to produce such data for testing is the following Perl
24288 script:
24289 .code
24290 use MIME::Base64;
24291 printf ("%s", encode_base64(eval "\"$ARGV[0]\""));
24292 .endd
24293 .cindex "binary zero" "in authentication data"
24294 This interprets its argument as a Perl string, and then encodes it. The
24295 interpretation as a Perl string allows binary zeros, which are required for
24296 some kinds of authentication, to be included in the data. For example, a
24297 command line to run this script on such data might be
24298 .code
24299 encode '\0user\0password'
24300 .endd
24301 Note the use of single quotes to prevent the shell interpreting the
24302 backslashes, so that they can be interpreted by Perl to specify characters
24303 whose code value is zero.
24304
24305 &*Warning 1*&: If either of the user or password strings starts with an octal
24306 digit, you must use three zeros instead of one after the leading backslash. If
24307 you do not, the octal digit that starts your string will be incorrectly
24308 interpreted as part of the code for the first character.
24309
24310 &*Warning 2*&: If there are characters in the strings that Perl interprets
24311 specially, you must use a Perl escape to prevent them being misinterpreted. For
24312 example, a command such as
24313 .code
24314 encode '\0user@domain.com\0pas$$word'
24315 .endd
24316 gives an incorrect answer because of the unescaped &"@"& and &"$"& characters.
24317
24318 If you have the &%mimencode%& command installed, another way to do produce
24319 base64-encoded strings is to run the command
24320 .code
24321 echo -e -n `\0user\0password' | mimencode
24322 .endd
24323 The &%-e%& option of &%echo%& enables the interpretation of backslash escapes
24324 in the argument, and the &%-n%& option specifies no newline at the end of its
24325 output. However, not all versions of &%echo%& recognize these options, so you
24326 should check your version before relying on this suggestion.
24327
24328
24329
24330 .section "Authentication by an Exim client" "SECID170"
24331 .cindex "authentication" "on an Exim client"
24332 The &(smtp)& transport has two options called &%hosts_require_auth%& and
24333 &%hosts_try_auth%&. When the &(smtp)& transport connects to a server that
24334 announces support for authentication, and the host matches an entry in either
24335 of these options, Exim (as a client) tries to authenticate as follows:
24336
24337 .ilist
24338 For each authenticator that is configured as a client, in the order in which
24339 they are defined in the configuration, it searches the authentication
24340 mechanisms announced by the server for one whose name matches the public name
24341 of the authenticator.
24342 .next
24343 .vindex "&$host$&"
24344 .vindex "&$host_address$&"
24345 When it finds one that matches, it runs the authenticator's client code. The
24346 variables &$host$& and &$host_address$& are available for any string expansions
24347 that the client might do. They are set to the server's name and IP address. If
24348 any expansion is forced to fail, the authentication attempt is abandoned, and
24349 Exim moves on to the next authenticator. Otherwise an expansion failure causes
24350 delivery to be deferred.
24351 .next
24352 If the result of the authentication attempt is a temporary error or a timeout,
24353 Exim abandons trying to send the message to the host for the moment. It will
24354 try again later. If there are any backup hosts available, they are tried in the
24355 usual way.
24356 .next
24357 If the response to authentication is a permanent error (5&'xx'& code), Exim
24358 carries on searching the list of authenticators and tries another one if
24359 possible. If all authentication attempts give permanent errors, or if there are
24360 no attempts because no mechanisms match (or option expansions force failure),
24361 what happens depends on whether the host matches &%hosts_require_auth%& or
24362 &%hosts_try_auth%&. In the first case, a temporary error is generated, and
24363 delivery is deferred. The error can be detected in the retry rules, and thereby
24364 turned into a permanent error if you wish. In the second case, Exim tries to
24365 deliver the message unauthenticated.
24366 .endlist
24367
24368 .cindex "AUTH" "on MAIL command"
24369 When Exim has authenticated itself to a remote server, it adds the AUTH
24370 parameter to the MAIL commands it sends, if it has an authenticated sender for
24371 the message. If the message came from a remote host, the authenticated sender
24372 is the one that was receiving on an incoming MAIL command, provided that the
24373 incoming connection was authenticated and the &%server_mail_auth%& condition
24374 allowed the authenticated sender to be retained. If a local process calls Exim
24375 to send a message, the sender address that is built from the login name and
24376 &%qualify_domain%& is treated as authenticated. However, if the
24377 &%authenticated_sender%& option is set on the &(smtp)& transport, it overrides
24378 the authenticated sender that was received with the message.
24379 .ecindex IIDauthconf1
24380 .ecindex IIDauthconf2
24381
24382
24383
24384
24385
24386
24387 . ////////////////////////////////////////////////////////////////////////////
24388 . ////////////////////////////////////////////////////////////////////////////
24389
24390 .chapter "The plaintext authenticator" "CHAPplaintext"
24391 .scindex IIDplaiauth1 "&(plaintext)& authenticator"
24392 .scindex IIDplaiauth2 "authenticators" "&(plaintext)&"
24393 The &(plaintext)& authenticator can be configured to support the PLAIN and
24394 LOGIN authentication mechanisms, both of which transfer authentication data as
24395 plain (unencrypted) text (though base64 encoded). The use of plain text is a
24396 security risk; you are strongly advised to insist on the use of SMTP encryption
24397 (see chapter &<<CHAPTLS>>&) if you use the PLAIN or LOGIN mechanisms. If you do
24398 use unencrypted plain text, you should not use the same passwords for SMTP
24399 connections as you do for login accounts.
24400
24401 .section "Plaintext options" "SECID171"
24402 .cindex "options" "&(plaintext)& authenticator (server)"
24403 When configured as a server, &(plaintext)& uses the following options:
24404
24405 .option server_condition authenticators string&!! unset
24406 This is actually a global authentication option, but it must be set in order to
24407 configure the &(plaintext)& driver as a server. Its use is described below.
24408
24409 .option server_prompts plaintext string&!! unset
24410 The contents of this option, after expansion, must be a colon-separated list of
24411 prompt strings. If expansion fails, a temporary authentication rejection is
24412 given.
24413
24414 .section "Using plaintext in a server" "SECTplainserver"
24415 .cindex "AUTH" "in &(plaintext)& authenticator"
24416 .cindex "binary zero" "in &(plaintext)& authenticator"
24417 .cindex "numerical variables (&$1$& &$2$& etc)" &&&
24418         "in &(plaintext)& authenticator"
24419 .vindex "&$auth1$&, &$auth2$&, etc"
24420 .cindex "base64 encoding" "in &(plaintext)& authenticator"
24421
24422 When running as a server, &(plaintext)& performs the authentication test by
24423 expanding a string. The data sent by the client with the AUTH command, or in
24424 response to subsequent prompts, is base64 encoded, and so may contain any byte
24425 values when decoded. If any data is supplied with the command, it is treated as
24426 a list of strings, separated by NULs (binary zeros), the first three of which
24427 are placed in the expansion variables &$auth1$&, &$auth2$&, and &$auth3$&
24428 (neither LOGIN nor PLAIN uses more than three strings).
24429
24430 For compatibility with previous releases of Exim, the values are also placed in
24431 the expansion variables &$1$&, &$2$&, and &$3$&. However, the use of these
24432 variables for this purpose is now deprecated, as it can lead to confusion in
24433 string expansions that also use them for other things.
24434
24435 If there are more strings in &%server_prompts%& than the number of strings
24436 supplied with the AUTH command, the remaining prompts are used to obtain more
24437 data. Each response from the client may be a list of NUL-separated strings.
24438
24439 .vindex "&$authenticated_id$&"
24440 Once a sufficient number of data strings have been received,
24441 &%server_condition%& is expanded. If the expansion is forced to fail,
24442 authentication fails. Any other expansion failure causes a temporary error code
24443 to be returned. If the result of a successful expansion is an empty string,
24444 &"0"&, &"no"&, or &"false"&, authentication fails. If the result of the
24445 expansion is &"1"&, &"yes"&, or &"true"&, authentication succeeds and the
24446 generic &%server_set_id%& option is expanded and saved in &$authenticated_id$&.
24447 For any other result, a temporary error code is returned, with the expanded
24448 string as the error text.
24449
24450 &*Warning*&: If you use a lookup in the expansion to find the user's
24451 password, be sure to make the authentication fail if the user is unknown.
24452 There are good and bad examples at the end of the next section.
24453
24454
24455
24456 .section "The PLAIN authentication mechanism" "SECID172"
24457 .cindex "PLAIN authentication mechanism"
24458 .cindex "authentication" "PLAIN mechanism"
24459 .cindex "binary zero" "in &(plaintext)& authenticator"
24460 The PLAIN authentication mechanism (RFC 2595) specifies that three strings be
24461 sent as one item of data (that is, one combined string containing two NUL
24462 separators). The data is sent either as part of the AUTH command, or
24463 subsequently in response to an empty prompt from the server.
24464
24465 The second and third strings are a user name and a corresponding password.
24466 Using a single fixed user name and password as an example, this could be
24467 configured as follows:
24468 .code
24469 fixed_plain:
24470   driver = plaintext
24471   public_name = PLAIN
24472   server_prompts = :
24473   server_condition = \
24474     ${if and {{eq{$auth2}{username}}{eq{$auth3}{mysecret}}}}
24475   server_set_id = $auth2
24476 .endd
24477 Note that the default result strings from &%if%& (&"true"& or an empty string)
24478 are exactly what we want here, so they need not be specified. Obviously, if the
24479 password contains expansion-significant characters such as dollar, backslash,
24480 or closing brace, they have to be escaped.
24481
24482 The &%server_prompts%& setting specifies a single, empty prompt (empty items at
24483 the end of a string list are ignored). If all the data comes as part of the
24484 AUTH command, as is commonly the case, the prompt is not used. This
24485 authenticator is advertised in the response to EHLO as
24486 .code
24487 250-AUTH PLAIN
24488 .endd
24489 and a client host can authenticate itself by sending the command
24490 .code
24491 AUTH PLAIN AHVzZXJuYW1lAG15c2VjcmV0
24492 .endd
24493 As this contains three strings (more than the number of prompts), no further
24494 data is required from the client. Alternatively, the client may just send
24495 .code
24496 AUTH PLAIN
24497 .endd
24498 to initiate authentication, in which case the server replies with an empty
24499 prompt. The client must respond with the combined data string.
24500
24501 The data string is base64 encoded, as required by the RFC. This example,
24502 when decoded, is <&'NUL'&>&`username`&<&'NUL'&>&`mysecret`&, where <&'NUL'&>
24503 represents a zero byte. This is split up into three strings, the first of which
24504 is empty. The &%server_condition%& option in the authenticator checks that the
24505 second two are &`username`& and &`mysecret`& respectively.
24506
24507 Having just one fixed user name and password, as in this example, is not very
24508 realistic, though for a small organization with only a handful of
24509 authenticating clients it could make sense.
24510
24511 A more sophisticated instance of this authenticator could use the user name in
24512 &$auth2$& to look up a password in a file or database, and maybe do an encrypted
24513 comparison (see &%crypteq%& in chapter &<<CHAPexpand>>&). Here is a example of
24514 this approach, where the passwords are looked up in a DBM file. &*Warning*&:
24515 This is an incorrect example:
24516 .code
24517 server_condition = \
24518   ${if eq{$auth3}{${lookup{$auth2}dbm{/etc/authpwd}}}}
24519 .endd
24520 The expansion uses the user name (&$auth2$&) as the key to look up a password,
24521 which it then compares to the supplied password (&$auth3$&). Why is this example
24522 incorrect? It works fine for existing users, but consider what happens if a
24523 non-existent user name is given. The lookup fails, but as no success/failure
24524 strings are given for the lookup, it yields an empty string. Thus, to defeat
24525 the authentication, all a client has to do is to supply a non-existent user
24526 name and an empty password. The correct way of writing this test is:
24527 .code
24528 server_condition = ${lookup{$auth2}dbm{/etc/authpwd}\
24529   {${if eq{$value}{$auth3}}} {false}}
24530 .endd
24531 In this case, if the lookup succeeds, the result is checked; if the lookup
24532 fails, &"false"& is returned and authentication fails. If &%crypteq%& is being
24533 used instead of &%eq%&, the first example is in fact safe, because &%crypteq%&
24534 always fails if its second argument is empty. However, the second way of
24535 writing the test makes the logic clearer.
24536
24537
24538 .section "The LOGIN authentication mechanism" "SECID173"
24539 .cindex "LOGIN authentication mechanism"
24540 .cindex "authentication" "LOGIN mechanism"
24541 The LOGIN authentication mechanism is not documented in any RFC, but is in use
24542 in a number of programs. No data is sent with the AUTH command. Instead, a
24543 user name and password are supplied separately, in response to prompts. The
24544 plaintext authenticator can be configured to support this as in this example:
24545 .code
24546 fixed_login:
24547   driver = plaintext
24548   public_name = LOGIN
24549   server_prompts = User Name : Password
24550   server_condition = \
24551     ${if and {{eq{$auth1}{username}}{eq{$auth2}{mysecret}}}}
24552   server_set_id = $auth1
24553 .endd
24554 Because of the way plaintext operates, this authenticator accepts data supplied
24555 with the AUTH command (in contravention of the specification of LOGIN), but
24556 if the client does not supply it (as is the case for LOGIN clients), the prompt
24557 strings are used to obtain two data items.
24558
24559 Some clients are very particular about the precise text of the prompts. For
24560 example, Outlook Express is reported to recognize only &"Username:"& and
24561 &"Password:"&. Here is an example of a LOGIN authenticator that uses those
24562 strings. It uses the &%ldapauth%& expansion condition to check the user
24563 name and password by binding to an LDAP server:
24564 .code
24565 login:
24566   driver = plaintext
24567   public_name = LOGIN
24568   server_prompts = Username:: : Password::
24569   server_condition = ${if and{{ \
24570     !eq{}{$auth1} }{ \
24571     ldapauth{\
24572       user="uid=${quote_ldap_dn:$auth1},ou=people,o=example.org" \
24573       pass=${quote:$auth2} \
24574       ldap://ldap.example.org/} }} }
24575   server_set_id = uid=$auth1,ou=people,o=example.org
24576 .endd
24577 We have to check that the username is not empty before using it, because LDAP
24578 does not permit empty DN components. We must also use the &%quote_ldap_dn%&
24579 operator to correctly quote the DN for authentication. However, the basic
24580 &%quote%& operator, rather than any of the LDAP quoting operators, is the
24581 correct one to use for the password, because quoting is needed only to make
24582 the password conform to the Exim syntax. At the LDAP level, the password is an
24583 uninterpreted string.
24584
24585
24586 .section "Support for different kinds of authentication" "SECID174"
24587 A number of string expansion features are provided for the purpose of
24588 interfacing to different ways of user authentication. These include checking
24589 traditionally encrypted passwords from &_/etc/passwd_& (or equivalent), PAM,
24590 Radius, &%ldapauth%&, &'pwcheck'&, and &'saslauthd'&. For details see section
24591 &<<SECTexpcond>>&.
24592
24593
24594
24595
24596 .section "Using plaintext in a client" "SECID175"
24597 .cindex "options" "&(plaintext)& authenticator (client)"
24598 The &(plaintext)& authenticator has two client options:
24599
24600 .option client_ignore_invalid_base64 plaintext boolean false
24601 If the client receives a server prompt that is not a valid base64 string,
24602 authentication is abandoned by default. However, if this option is set true,
24603 the error in the challenge is ignored and the client sends the response as
24604 usual.
24605
24606 .option client_send plaintext string&!! unset
24607 The string is a colon-separated list of authentication data strings. Each
24608 string is independently expanded before being sent to the server. The first
24609 string is sent with the AUTH command; any more strings are sent in response
24610 to prompts from the server. Before each string is expanded, the value of the
24611 most recent prompt is placed in the next &$auth$&<&'n'&> variable, starting
24612 with &$auth1$& for the first prompt. Up to three prompts are stored in this
24613 way. Thus, the prompt that is received in response to sending the first string
24614 (with the AUTH command) can be used in the expansion of the second string, and
24615 so on. If an invalid base64 string is received when
24616 &%client_ignore_invalid_base64%& is set, an empty string is put in the
24617 &$auth$&<&'n'&> variable.
24618
24619 &*Note*&: You cannot use expansion to create multiple strings, because
24620 splitting takes priority and happens first.
24621
24622 Because the PLAIN authentication mechanism requires NUL (binary zero) bytes in
24623 the data, further processing is applied to each string before it is sent. If
24624 there are any single circumflex characters in the string, they are converted to
24625 NULs. Should an actual circumflex be required as data, it must be doubled in
24626 the string.
24627
24628 This is an example of a client configuration that implements the PLAIN
24629 authentication mechanism with a fixed user name and password:
24630 .code
24631 fixed_plain:
24632   driver = plaintext
24633   public_name = PLAIN
24634   client_send = ^username^mysecret
24635 .endd
24636 The lack of colons means that the entire text is sent with the AUTH
24637 command, with the circumflex characters converted to NULs. A similar example
24638 that uses the LOGIN mechanism is:
24639 .code
24640 fixed_login:
24641   driver = plaintext
24642   public_name = LOGIN
24643   client_send = : username : mysecret
24644 .endd
24645 The initial colon means that the first string is empty, so no data is sent with
24646 the AUTH command itself. The remaining strings are sent in response to
24647 prompts.
24648 .ecindex IIDplaiauth1
24649 .ecindex IIDplaiauth2
24650
24651
24652
24653
24654 . ////////////////////////////////////////////////////////////////////////////
24655 . ////////////////////////////////////////////////////////////////////////////
24656
24657 .chapter "The cram_md5 authenticator" "CHID9"
24658 .scindex IIDcramauth1 "&(cram_md5)& authenticator"
24659 .scindex IIDcramauth2 "authenticators" "&(cram_md5)&"
24660 .cindex "CRAM-MD5 authentication mechanism"
24661 .cindex "authentication" "CRAM-MD5 mechanism"
24662 The CRAM-MD5 authentication mechanism is described in RFC 2195. The server
24663 sends a challenge string to the client, and the response consists of a user
24664 name and the CRAM-MD5 digest of the challenge string combined with a secret
24665 string (password) which is known to both server and client. Thus, the secret
24666 is not sent over the network as plain text, which makes this authenticator more
24667 secure than &(plaintext)&. However, the downside is that the secret has to be
24668 available in plain text at either end.
24669
24670
24671 .section "Using cram_md5 as a server" "SECID176"
24672 .cindex "options" "&(cram_md5)& authenticator (server)"
24673 This authenticator has one server option, which must be set to configure the
24674 authenticator as a server:
24675
24676 .option server_secret cram_md5 string&!! unset
24677 .cindex "numerical variables (&$1$& &$2$& etc)" "in &(cram_md5)& authenticator"
24678 When the server receives the client's response, the user name is placed in
24679 the expansion variable &$auth1$&, and &%server_secret%& is expanded to
24680 obtain the password for that user. The server then computes the CRAM-MD5 digest
24681 that the client should have sent, and checks that it received the correct
24682 string. If the expansion of &%server_secret%& is forced to fail, authentication
24683 fails. If the expansion fails for some other reason, a temporary error code is
24684 returned to the client.
24685
24686 For compatibility with previous releases of Exim, the user name is also placed
24687 in &$1$&. However, the use of this variables for this purpose is now
24688 deprecated, as it can lead to confusion in string expansions that also use
24689 numeric variables for other things.
24690
24691 For example, the following authenticator checks that the user name given by the
24692 client is &"ph10"&, and if so, uses &"secret"& as the password. For any other
24693 user name, authentication fails.
24694 .code
24695 fixed_cram:
24696   driver = cram_md5
24697   public_name = CRAM-MD5
24698   server_secret = ${if eq{$auth1}{ph10}{secret}fail}
24699   server_set_id = $auth1
24700 .endd
24701 .vindex "&$authenticated_id$&"
24702 If authentication succeeds, the setting of &%server_set_id%& preserves the user
24703 name in &$authenticated_id$&. A more typical configuration might look up the
24704 secret string in a file, using the user name as the key. For example:
24705 .code
24706 lookup_cram:
24707   driver = cram_md5
24708   public_name = CRAM-MD5
24709   server_secret = ${lookup{$auth1}lsearch{/etc/authpwd}\
24710                   {$value}fail}
24711   server_set_id = $auth1
24712 .endd
24713 Note that this expansion explicitly forces failure if the lookup fails
24714 because &$auth1$& contains an unknown user name.
24715
24716 As another example, if you wish to re-use a Cyrus SASL sasldb2 file without
24717 using the relevant libraries, you need to know the realm to specify in the
24718 lookup and then ask for the &"userPassword"& attribute for that user in that
24719 realm, with:
24720 .code
24721 cyrusless_crammd5:
24722   driver = cram_md5
24723   public_name = CRAM-MD5
24724   server_secret = ${lookup{$auth1:mail.example.org:userPassword}\
24725                   dbmjz{/etc/sasldb2}}
24726   server_set_id = $auth1
24727 .endd
24728
24729 .section "Using cram_md5 as a client" "SECID177"
24730 .cindex "options" "&(cram_md5)& authenticator (client)"
24731 When used as a client, the &(cram_md5)& authenticator has two options:
24732
24733
24734
24735 .option client_name cram_md5 string&!! "the primary host name"
24736 This string is expanded, and the result used as the user name data when
24737 computing the response to the server's challenge.
24738
24739
24740 .option client_secret cram_md5 string&!! unset
24741 This option must be set for the authenticator to work as a client. Its value is
24742 expanded and the result used as the secret string when computing the response.
24743
24744
24745 .vindex "&$host$&"
24746 .vindex "&$host_address$&"
24747 Different user names and secrets can be used for different servers by referring
24748 to &$host$& or &$host_address$& in the options. Forced failure of either
24749 expansion string is treated as an indication that this authenticator is not
24750 prepared to handle this case. Exim moves on to the next configured client
24751 authenticator. Any other expansion failure causes Exim to give up trying to
24752 send the message to the current server.
24753
24754 A simple example configuration of a &(cram_md5)& authenticator, using fixed
24755 strings, is:
24756 .code
24757 fixed_cram:
24758   driver = cram_md5
24759   public_name = CRAM-MD5
24760   client_name = ph10
24761   client_secret = secret
24762 .endd
24763 .ecindex IIDcramauth1
24764 .ecindex IIDcramauth2
24765
24766
24767
24768 . ////////////////////////////////////////////////////////////////////////////
24769 . ////////////////////////////////////////////////////////////////////////////
24770
24771 .chapter "The cyrus_sasl authenticator" "CHID10"
24772 .scindex IIDcyrauth1 "&(cyrus_sasl)& authenticator"
24773 .scindex IIDcyrauth2 "authenticators" "&(cyrus_sasl)&"
24774 .cindex "Cyrus" "SASL library"
24775 .cindex "Kerberos"
24776 The code for this authenticator was provided by Matthew Byng-Maddick of A L
24777 Digital Ltd (&url(http://www.aldigital.co.uk)).
24778
24779 The &(cyrus_sasl)& authenticator provides server support for the Cyrus SASL
24780 library implementation of the RFC 2222 (&"Simple Authentication and Security
24781 Layer"&). This library supports a number of authentication mechanisms,
24782 including PLAIN and LOGIN, but also several others that Exim does not support
24783 directly. In particular, there is support for Kerberos authentication.
24784
24785 The &(cyrus_sasl)& authenticator provides a gatewaying mechanism directly to
24786 the Cyrus interface, so if your Cyrus library can do, for example, CRAM-MD5,
24787 then so can the &(cyrus_sasl)& authenticator. By default it uses the public
24788 name of the driver to determine which mechanism to support.
24789
24790 Where access to some kind of secret file is required, for example in GSSAPI
24791 or CRAM-MD5, it is worth noting that the authenticator runs as the Exim
24792 user, and that the Cyrus SASL library has no way of escalating privileges
24793 by default. You may also find you need to set environment variables,
24794 depending on the driver you are using.
24795
24796 The application name provided by Exim is &"exim"&, so various SASL options may
24797 be set in &_exim.conf_& in your SASL directory. If you are using GSSAPI for
24798 Kerberos, note that because of limitations in the GSSAPI interface,
24799 changing the server keytab might need to be communicated down to the Kerberos
24800 layer independently. The mechanism for doing so is dependent upon the Kerberos
24801 implementation.
24802
24803 For example, for older releases of Heimdal, the environment variable KRB5_KTNAME
24804 may be set to point to an alternative keytab file. Exim will pass this
24805 variable through from its own inherited environment when started as root or the
24806 Exim user. The keytab file needs to be readable by the Exim user.
24807 With newer releases of Heimdal, a setuid Exim may cause Heimdal to discard the
24808 environment variable.  In practice, for those releases, the Cyrus authenticator
24809 is not a suitable interface for GSSAPI (Kerberos) support.  Instead, consider
24810 the &(heimdal_gssapi)& authenticator, described in chapter &<<CHAPheimdalgss>>&
24811
24812
24813 .section "Using cyrus_sasl as a server" "SECID178"
24814 The &(cyrus_sasl)& authenticator has four private options. It puts the username
24815 (on a successful authentication) into &$auth1$&. For compatibility with
24816 previous releases of Exim, the username is also placed in &$1$&. However, the
24817 use of this variable for this purpose is now deprecated, as it can lead to
24818 confusion in string expansions that also use numeric variables for other
24819 things.
24820
24821
24822 .option server_hostname cyrus_sasl string&!! "see below"
24823 This option selects the hostname that is used when communicating with the
24824 library. The default value is &`$primary_hostname`&. It is up to the underlying
24825 SASL plug-in what it does with this data.
24826
24827
24828 .option server_mech cyrus_sasl string "see below"
24829 This option selects the authentication mechanism this driver should use. The
24830 default is the value of the generic &%public_name%& option. This option allows
24831 you to use a different underlying mechanism from the advertised name. For
24832 example:
24833 .code
24834 sasl:
24835   driver = cyrus_sasl
24836   public_name = X-ANYTHING
24837   server_mech = CRAM-MD5
24838   server_set_id = $auth1
24839 .endd
24840
24841 .option server_realm cyrus_sasl string&!! unset
24842 This specifies the SASL realm that the server claims to be in.
24843
24844
24845 .option server_service cyrus_sasl string &`smtp`&
24846 This is the SASL service that the server claims to implement.
24847
24848
24849 For straightforward cases, you do not need to set any of the authenticator's
24850 private options. All you need to do is to specify an appropriate mechanism as
24851 the public name. Thus, if you have a SASL library that supports CRAM-MD5 and
24852 PLAIN, you could have two authenticators as follows:
24853 .code
24854 sasl_cram_md5:
24855   driver = cyrus_sasl
24856   public_name = CRAM-MD5
24857   server_set_id = $auth1
24858
24859 sasl_plain:
24860   driver = cyrus_sasl
24861   public_name = PLAIN
24862   server_set_id = $auth2
24863 .endd
24864 Cyrus SASL does implement the LOGIN authentication method, even though it is
24865 not a standard method. It is disabled by default in the source distribution,
24866 but it is present in many binary distributions.
24867 .ecindex IIDcyrauth1
24868 .ecindex IIDcyrauth2
24869
24870
24871
24872
24873 . ////////////////////////////////////////////////////////////////////////////
24874 . ////////////////////////////////////////////////////////////////////////////
24875 .chapter "The dovecot authenticator" "CHAPdovecot"
24876 .scindex IIDdcotauth1 "&(dovecot)& authenticator"
24877 .scindex IIDdcotauth2 "authenticators" "&(dovecot)&"
24878 This authenticator is an interface to the authentication facility of the
24879 Dovecot POP/IMAP server, which can support a number of authentication methods.
24880 If you are using Dovecot to authenticate POP/IMAP clients, it might be helpful
24881 to use the same mechanisms for SMTP authentication. This is a server
24882 authenticator only. There is only one option:
24883
24884 .option server_socket dovecot string unset
24885
24886 This option must specify the socket that is the interface to Dovecot
24887 authentication. The &%public_name%& option must specify an authentication
24888 mechanism that Dovecot is configured to support. You can have several
24889 authenticators for different mechanisms. For example:
24890 .code
24891 dovecot_plain:
24892   driver = dovecot
24893   public_name = PLAIN
24894   server_socket = /var/run/dovecot/auth-client
24895   server_set_id = $auth2
24896
24897 dovecot_ntlm:
24898   driver = dovecot
24899   public_name = NTLM
24900   server_socket = /var/run/dovecot/auth-client
24901   server_set_id = $auth1
24902 .endd
24903 If the SMTP connection is encrypted, or if &$sender_host_address$& is equal to
24904 &$received_ip_address$& (that is, the connection is local), the &"secured"&
24905 option is passed in the Dovecot authentication command. If, for a TLS
24906 connection, a client certificate has been verified, the &"valid-client-cert"&
24907 option is passed. When authentication succeeds, the identity of the user
24908 who authenticated is placed in &$auth1$&.
24909 .ecindex IIDdcotauth1
24910 .ecindex IIDdcotauth2
24911
24912
24913 . ////////////////////////////////////////////////////////////////////////////
24914 . ////////////////////////////////////////////////////////////////////////////
24915 .chapter "The gsasl authenticator" "CHAPgsasl"
24916 .scindex IIDgsaslauth1 "&(gsasl)& authenticator"
24917 .scindex IIDgsaslauth2 "authenticators" "&(gsasl)&"
24918 .cindex "authentication" "GNU SASL"
24919 .cindex "authentication" "SASL"
24920 .cindex "authentication" "EXTERNAL"
24921 .cindex "authentication" "ANONYMOUS"
24922 .cindex "authentication" "PLAIN"
24923 .cindex "authentication" "LOGIN"
24924 .cindex "authentication" "DIGEST-MD5"
24925 .cindex "authentication" "CRAM-MD5"
24926 .cindex "authentication" "SCRAM-SHA-1"
24927 The &(gsasl)& authenticator provides server integration for the GNU SASL
24928 library and the mechanisms it provides.  This is new as of the 4.80 release
24929 and there are a few areas where the library does not let Exim smoothly
24930 scale to handle future authentication mechanisms, so no guarantee can be
24931 made that any particular new authentication mechanism will be supported
24932 without code changes in Exim.
24933
24934
24935 .option server_channelbinding gsasl boolean false
24936 Some authentication mechanisms are able to use external context at both ends
24937 of the session to bind the authentication to that context, and fail the
24938 authentication process if that context differs.  Specifically, some TLS
24939 ciphersuites can provide identifying information about the cryptographic
24940 context.
24941
24942 This means that certificate identity and verification becomes a non-issue,
24943 as a man-in-the-middle attack will cause the correct client and server to
24944 see different identifiers and authentication will fail.
24945
24946 This is currently only supported when using the GnuTLS library.  This is
24947 only usable by mechanisms which support "channel binding"; at time of
24948 writing, that's the SCRAM family.
24949
24950 This defaults off to ensure smooth upgrade across Exim releases, in case
24951 this option causes some clients to start failing.  Some future release
24952 of Exim may switch the default to be true.
24953
24954
24955 .option server_hostname gsasl string&!! "see below"
24956 This option selects the hostname that is used when communicating with the
24957 library. The default value is &`$primary_hostname`&.
24958 Some mechanisms will use this data.
24959
24960
24961 .option server_mech gsasl string "see below"
24962 This option selects the authentication mechanism this driver should use. The
24963 default is the value of the generic &%public_name%& option. This option allows
24964 you to use a different underlying mechanism from the advertised name. For
24965 example:
24966 .code
24967 sasl:
24968   driver = gsasl
24969   public_name = X-ANYTHING
24970   server_mech = CRAM-MD5
24971   server_set_id = $auth1
24972 .endd
24973
24974
24975 .option server_password gsasl string&!! unset
24976 Various mechanisms need access to the cleartext password on the server, so
24977 that proof-of-possession can be demonstrated on the wire, without sending
24978 the password itself.
24979
24980 The data available for lookup varies per mechanism.
24981 In all cases, &$auth1$& is set to the &'authentication id'&.
24982 The &$auth2$& variable will always be the &'authorization id'& (&'authz'&)
24983 if available, else the empty string.
24984 The &$auth3$& variable will always be the &'realm'& if available,
24985 else the empty string.
24986
24987 A forced failure will cause authentication to defer.
24988
24989 If using this option, it may make sense to set the &%server_condition%&
24990 option to be simply "true".
24991
24992
24993 .option server_realm gsasl string&!! unset
24994 This specifies the SASL realm that the server claims to be in.
24995 Some mechanisms will use this data.
24996
24997
24998 .option server_scram_iter gsasl string&!! unset
24999 This option provides data for the SCRAM family of mechanisms.
25000 &$auth1$& is not available at evaluation time.
25001 (This may change, as we receive feedback on use)
25002
25003
25004 .option server_scram_salt gsasl string&!! unset
25005 This option provides data for the SCRAM family of mechanisms.
25006 &$auth1$& is not available at evaluation time.
25007 (This may change, as we receive feedback on use)
25008
25009
25010 .option server_service gsasl string &`smtp`&
25011 This is the SASL service that the server claims to implement.
25012 Some mechanisms will use this data.
25013
25014
25015 .section "&(gsasl)& auth variables" "SECTgsaslauthvar"
25016 .vindex "&$auth1$&, &$auth2$&, etc"
25017 These may be set when evaluating specific options, as detailed above.
25018 They will also be set when evaluating &%server_condition%&.
25019
25020 Unless otherwise stated below, the &(gsasl)& integration will use the following
25021 meanings for these variables:
25022
25023 .ilist
25024 .vindex "&$auth1$&"
25025 &$auth1$&: the &'authentication id'&
25026 .next
25027 .vindex "&$auth2$&"
25028 &$auth2$&: the &'authorization id'&
25029 .next
25030 .vindex "&$auth3$&"
25031 &$auth3$&: the &'realm'&
25032 .endlist
25033
25034 On a per-mechanism basis:
25035
25036 .ilist
25037 .cindex "authentication" "EXTERNAL"
25038 EXTERNAL: only &$auth1$& is set, to the possibly empty &'authorization id'&;
25039 the &%server_condition%& option must be present.
25040 .next
25041 .cindex "authentication" "ANONYMOUS"
25042 ANONYMOUS: only &$auth1$& is set, to the possibly empty &'anonymous token'&;
25043 the &%server_condition%& option must be present.
25044 .next
25045 .cindex "authentication" "GSSAPI"
25046 GSSAPI: &$auth1$& will be set to the &'GSSAPI Display Name'&;
25047 &$auth2$& will be set to the &'authorization id'&,
25048 the &%server_condition%& option must be present.
25049 .endlist
25050
25051 An &'anonymous token'& is something passed along as an unauthenticated
25052 identifier; this is analogous to FTP anonymous authentication passing an
25053 email address, or software-identifier@, as the "password".
25054
25055
25056 An example showing the password having the realm specified in the callback
25057 and demonstrating a Cyrus SASL to GSASL migration approach is:
25058 .code
25059 gsasl_cyrusless_crammd5:
25060   driver = gsasl
25061   public_name = CRAM-MD5
25062   server_realm = imap.example.org
25063   server_password = ${lookup{$auth1:$auth3:userPassword}\
25064                     dbmjz{/etc/sasldb2}{$value}fail}
25065   server_set_id = ${quote:$auth1}
25066   server_condition = yes
25067 .endd
25068
25069
25070 . ////////////////////////////////////////////////////////////////////////////
25071 . ////////////////////////////////////////////////////////////////////////////
25072
25073 .chapter "The heimdal_gssapi authenticator" "CHAPheimdalgss"
25074 .scindex IIDheimdalgssauth1 "&(heimdal_gssapi)& authenticator"
25075 .scindex IIDheimdalgssauth2 "authenticators" "&(heimdal_gssapi)&"
25076 .cindex "authentication" "GSSAPI"
25077 .cindex "authentication" "Kerberos"
25078 The &(heimdal_gssapi)& authenticator provides server integration for the
25079 Heimdal GSSAPI/Kerberos library, permitting Exim to set a keytab pathname
25080 reliably.
25081
25082 .option server_hostname heimdal_gssapi string&!! "see below"
25083 This option selects the hostname that is used, with &%server_service%&,
25084 for constructing the GSS server name, as a &'GSS_C_NT_HOSTBASED_SERVICE'&
25085 identifier.  The default value is &`$primary_hostname`&.
25086
25087 .option server_keytab heimdal_gssapi string&!! unset
25088 If set, then Heimdal will not use the system default keytab (typically
25089 &_/etc/krb5.keytab_&) but instead the pathname given in this option.
25090 The value should be a pathname, with no &"file:"& prefix.
25091
25092 .option server_service heimdal_gssapi string&!! "smtp"
25093 This option specifies the service identifier used, in conjunction with
25094 &%server_hostname%&, for building the identifer for finding credentials
25095 from the keytab.
25096
25097
25098 .section "&(heimdal_gssapi)& auth variables" "SECTheimdalgssauthvar"
25099 Beware that these variables will typically include a realm, thus will appear
25100 to be roughly like an email address already.  The &'authzid'& in &$auth2$& is
25101 not verified, so a malicious client can set it to anything.
25102
25103 The &$auth1$& field should be safely trustable as a value from the Key
25104 Distribution Center.  Note that these are not quite email addresses.
25105 Each identifier is for a role, and so the left-hand-side may include a
25106 role suffix.  For instance, &"joe/admin@EXAMPLE.ORG"&.
25107
25108 .vindex "&$auth1$&, &$auth2$&, etc"
25109 .ilist
25110 .vindex "&$auth1$&"
25111 &$auth1$&: the &'authentication id'&, set to the GSS Display Name.
25112 .next
25113 .vindex "&$auth2$&"
25114 &$auth2$&: the &'authorization id'&, sent within SASL encapsulation after
25115 authentication.  If that was empty, this will also be set to the
25116 GSS Display Name.
25117 .endlist
25118
25119
25120 . ////////////////////////////////////////////////////////////////////////////
25121 . ////////////////////////////////////////////////////////////////////////////
25122
25123 .chapter "The spa authenticator" "CHAPspa"
25124 .scindex IIDspaauth1 "&(spa)& authenticator"
25125 .scindex IIDspaauth2 "authenticators" "&(spa)&"
25126 .cindex "authentication" "Microsoft Secure Password"
25127 .cindex "authentication" "NTLM"
25128 .cindex "Microsoft Secure Password Authentication"
25129 .cindex "NTLM authentication"
25130 The &(spa)& authenticator provides client support for Microsoft's &'Secure
25131 Password Authentication'& mechanism,
25132 which is also sometimes known as NTLM (NT LanMan). The code for client side of
25133 this authenticator was contributed by Marc Prud'hommeaux, and much of it is
25134 taken from the Samba project (&url(http://www.samba.org)). The code for the
25135 server side was subsequently contributed by Tom Kistner. The mechanism works as
25136 follows:
25137
25138 .ilist
25139 After the AUTH command has been accepted, the client sends an SPA
25140 authentication request based on the user name and optional domain.
25141 .next
25142 The server sends back a challenge.
25143 .next
25144 The client builds a challenge response which makes use of the user's password
25145 and sends it to the server, which then accepts or rejects it.
25146 .endlist
25147
25148 Encryption is used to protect the password in transit.
25149
25150
25151
25152 .section "Using spa as a server" "SECID179"
25153 .cindex "options" "&(spa)& authenticator (server)"
25154 The &(spa)& authenticator has just one server option:
25155
25156 .option server_password spa string&!! unset
25157 .cindex "numerical variables (&$1$& &$2$& etc)" "in &(spa)& authenticator"
25158 This option is expanded, and the result must be the cleartext password for the
25159 authenticating user, whose name is at this point in &$auth1$&. For
25160 compatibility with previous releases of Exim, the user name is also placed in
25161 &$1$&. However, the use of this variable for this purpose is now deprecated, as
25162 it can lead to confusion in string expansions that also use numeric variables
25163 for other things. For example:
25164 .code
25165 spa:
25166   driver = spa
25167   public_name = NTLM
25168   server_password = \
25169     ${lookup{$auth1}lsearch{/etc/exim/spa_clearpass}{$value}fail}
25170 .endd
25171 If the expansion is forced to fail, authentication fails. Any other expansion
25172 failure causes a temporary error code to be returned.
25173
25174
25175
25176
25177
25178 .section "Using spa as a client" "SECID180"
25179 .cindex "options" "&(spa)& authenticator (client)"
25180 The &(spa)& authenticator has the following client options:
25181
25182
25183
25184 .option client_domain spa string&!! unset
25185 This option specifies an optional domain for the authentication.
25186
25187
25188 .option client_password spa string&!! unset
25189 This option specifies the user's password, and must be set.
25190
25191
25192 .option client_username spa string&!! unset
25193 This option specifies the user name, and must be set. Here is an example of a
25194 configuration of this authenticator for use with the mail servers at
25195 &'msn.com'&:
25196 .code
25197 msn:
25198   driver = spa
25199   public_name = MSN
25200   client_username = msn/msn_username
25201   client_password = msn_plaintext_password
25202   client_domain = DOMAIN_OR_UNSET
25203 .endd
25204 .ecindex IIDspaauth1
25205 .ecindex IIDspaauth2
25206
25207
25208
25209
25210
25211 . ////////////////////////////////////////////////////////////////////////////
25212 . ////////////////////////////////////////////////////////////////////////////
25213
25214 .chapter "Encrypted SMTP connections using TLS/SSL" "CHAPTLS" &&&
25215          "Encrypted SMTP connections"
25216 .scindex IIDencsmtp1 "encryption" "on SMTP connection"
25217 .scindex IIDencsmtp2 "SMTP" "encryption"
25218 .cindex "TLS" "on SMTP connection"
25219 .cindex "OpenSSL"
25220 .cindex "GnuTLS"
25221 Support for TLS (Transport Layer Security), formerly known as SSL (Secure
25222 Sockets Layer), is implemented by making use of the OpenSSL library or the
25223 GnuTLS library (Exim requires GnuTLS release 1.0 or later). There is no
25224 cryptographic code in the Exim distribution itself for implementing TLS. In
25225 order to use this feature you must install OpenSSL or GnuTLS, and then build a
25226 version of Exim that includes TLS support (see section &<<SECTinctlsssl>>&).
25227 You also need to understand the basic concepts of encryption at a managerial
25228 level, and in particular, the way that public keys, private keys, and
25229 certificates are used.
25230
25231 RFC 3207 defines how SMTP connections can make use of encryption. Once a
25232 connection is established, the client issues a STARTTLS command. If the
25233 server accepts this, the client and the server negotiate an encryption
25234 mechanism. If the negotiation succeeds, the data that subsequently passes
25235 between them is encrypted.
25236
25237 Exim's ACLs can detect whether the current SMTP session is encrypted or not,
25238 and if so, what cipher suite is in use, whether the client supplied a
25239 certificate, and whether or not that certificate was verified. This makes it
25240 possible for an Exim server to deny or accept certain commands based on the
25241 encryption state.
25242
25243 &*Warning*&: Certain types of firewall and certain anti-virus products can
25244 disrupt TLS connections. You need to turn off SMTP scanning for these products
25245 in order to get TLS to work.
25246
25247
25248
25249 .section "Support for the legacy &""ssmtp""& (aka &""smtps""&) protocol" &&&
25250          "SECID284"
25251 .cindex "ssmtp protocol"
25252 .cindex "smtps protocol"
25253 .cindex "SMTP" "ssmtp protocol"
25254 .cindex "SMTP" "smtps protocol"
25255 Early implementations of encrypted SMTP used a different TCP port from normal
25256 SMTP, and expected an encryption negotiation to start immediately, instead of
25257 waiting for a STARTTLS command from the client using the standard SMTP
25258 port. The protocol was called &"ssmtp"& or &"smtps"&, and port 465 was
25259 allocated for this purpose.
25260
25261 This approach was abandoned when encrypted SMTP was standardized, but there are
25262 still some legacy clients that use it. Exim supports these clients by means of
25263 the &%tls_on_connect_ports%& global option. Its value must be a list of port
25264 numbers; the most common use is expected to be:
25265 .code
25266 tls_on_connect_ports = 465
25267 .endd
25268 The port numbers specified by this option apply to all SMTP connections, both
25269 via the daemon and via &'inetd'&. You still need to specify all the ports that
25270 the daemon uses (by setting &%daemon_smtp_ports%& or &%local_interfaces%& or
25271 the &%-oX%& command line option) because &%tls_on_connect_ports%& does not add
25272 an extra port &-- rather, it specifies different behaviour on a port that is
25273 defined elsewhere.
25274
25275 There is also a &%-tls-on-connect%& command line option. This overrides
25276 &%tls_on_connect_ports%&; it forces the legacy behaviour for all ports.
25277
25278
25279
25280
25281
25282
25283 .section "OpenSSL vs GnuTLS" "SECTopenvsgnu"
25284 .cindex "TLS" "OpenSSL &'vs'& GnuTLS"
25285 The first TLS support in Exim was implemented using OpenSSL. Support for GnuTLS
25286 followed later, when the first versions of GnuTLS were released. To build Exim
25287 to use GnuTLS, you need to set
25288 .code
25289 USE_GNUTLS=yes
25290 .endd
25291 in Local/Makefile, in addition to
25292 .code
25293 SUPPORT_TLS=yes
25294 .endd
25295 You must also set TLS_LIBS and TLS_INCLUDE appropriately, so that the
25296 include files and libraries for GnuTLS can be found.
25297
25298 There are some differences in usage when using GnuTLS instead of OpenSSL:
25299
25300 .ilist
25301 The &%tls_verify_certificates%& option must contain the name of a file, not the
25302 name of a directory (for OpenSSL it can be either).
25303 .next
25304 The default value for &%tls_dhparam%& differs for historical reasons.
25305 .next
25306 .vindex "&$tls_in_peerdn$&"
25307 .vindex "&$tls_out_peerdn$&"
25308 Distinguished Name (DN) strings reported by the OpenSSL library use a slash for
25309 separating fields; GnuTLS uses commas, in accordance with RFC 2253. This
25310 affects the value of the &$tls_in_peerdn$& and &$tls_out_peerdn$& variables.
25311 .next
25312 OpenSSL identifies cipher suites using hyphens as separators, for example:
25313 DES-CBC3-SHA. GnuTLS historically used underscores, for example:
25314 RSA_ARCFOUR_SHA. What is more, OpenSSL complains if underscores are present
25315 in a cipher list. To make life simpler, Exim changes underscores to hyphens
25316 for OpenSSL and passes the string unchanged to GnuTLS (expecting the library
25317 to handle its own older variants) when processing lists of cipher suites in the
25318 &%tls_require_ciphers%& options (the global option and the &(smtp)& transport
25319 option).
25320 .next
25321 The &%tls_require_ciphers%& options operate differently, as described in the
25322 sections &<<SECTreqciphssl>>& and &<<SECTreqciphgnu>>&.
25323 .next
25324 .new
25325 The &%tls_dh_min_bits%& SMTP transport option is only honoured by GnuTLS.
25326 When using OpenSSL, this option is ignored.
25327 (If an API is found to let OpenSSL be configured in this way,
25328 let the Exim Maintainers know and we'll likely use it).
25329 .wen
25330 .next
25331 Some other recently added features may only be available in one or the other.
25332 This should be documented with the feature.  If the documentation does not
25333 explicitly state that the feature is infeasible in the other TLS
25334 implementation, then patches are welcome.
25335 .endlist
25336
25337
25338 .section "GnuTLS parameter computation" "SECTgnutlsparam"
25339 This section only applies if &%tls_dhparam%& is set to &`historic`& or to
25340 an explicit path; if the latter, then the text about generation still applies,
25341 but not the chosen filename.
25342 By default, as of Exim 4.80 a hard-coded D-H prime is used.
25343 See the documentation of &%tls_dhparam%& for more information.
25344
25345 GnuTLS uses D-H parameters that may take a substantial amount of time
25346 to compute. It is unreasonable to re-compute them for every TLS session.
25347 Therefore, Exim keeps this data in a file in its spool directory, called
25348 &_gnutls-params-NNNN_& for some value of NNNN, corresponding to the number
25349 of bits requested.
25350 The file is owned by the Exim user and is readable only by
25351 its owner. Every Exim process that start up GnuTLS reads the D-H
25352 parameters from this file. If the file does not exist, the first Exim process
25353 that needs it computes the data and writes it to a temporary file which is
25354 renamed once it is complete. It does not matter if several Exim processes do
25355 this simultaneously (apart from wasting a few resources). Once a file is in
25356 place, new Exim processes immediately start using it.
25357
25358 For maximum security, the parameters that are stored in this file should be
25359 recalculated periodically, the frequency depending on your paranoia level.
25360 If you are avoiding using the fixed D-H primes published in RFCs, then you
25361 are concerned about some advanced attacks and will wish to do this; if you do
25362 not regenerate then you might as well stick to the standard primes.
25363
25364 Arranging this is easy in principle; just delete the file when you want new
25365 values to be computed. However, there may be a problem. The calculation of new
25366 parameters needs random numbers, and these are obtained from &_/dev/random_&.
25367 If the system is not very active, &_/dev/random_& may delay returning data
25368 until enough randomness (entropy) is available. This may cause Exim to hang for
25369 a substantial amount of time, causing timeouts on incoming connections.
25370
25371 The solution is to generate the parameters externally to Exim. They are stored
25372 in &_gnutls-params-N_& in PEM format, which means that they can be
25373 generated externally using the &(certtool)& command that is part of GnuTLS.
25374
25375 To replace the parameters with new ones, instead of deleting the file
25376 and letting Exim re-create it, you can generate new parameters using
25377 &(certtool)& and, when this has been done, replace Exim's cache file by
25378 renaming. The relevant commands are something like this:
25379 .code
25380 # ls
25381 [ look for file; assume gnutls-params-2236 is the most recent ]
25382 # rm -f new-params
25383 # touch new-params
25384 # chown exim:exim new-params
25385 # chmod 0600 new-params
25386 # certtool --generate-dh-params --bits 2236 >>new-params
25387 # openssl dhparam -noout -text -in new-params | head
25388 [ check the first line, make sure it's not more than 2236;
25389   if it is, then go back to the start ("rm") and repeat
25390   until the size generated is at most the size requested ]
25391 # chmod 0400 new-params
25392 # mv new-params gnutls-params-2236
25393 .endd
25394 If Exim never has to generate the parameters itself, the possibility of
25395 stalling is removed.
25396
25397 The filename changed in Exim 4.80, to gain the -bits suffix.  The value which
25398 Exim will choose depends upon the version of GnuTLS in use.  For older GnuTLS,
25399 the value remains hard-coded in Exim as 1024.  As of GnuTLS 2.12.x, there is
25400 a way for Exim to ask for the "normal" number of bits for D-H public-key usage,
25401 and Exim does so.  This attempt to remove Exim from TLS policy decisions
25402 failed, as GnuTLS 2.12 returns a value higher than the current hard-coded limit
25403 of the NSS library.  Thus Exim gains the &%tls_dh_max_bits%& global option,
25404 which applies to all D-H usage, client or server.  If the value returned by
25405 GnuTLS is greater than &%tls_dh_max_bits%& then the value will be clamped down
25406 to &%tls_dh_max_bits%&.  The default value has been set at the current NSS
25407 limit, which is still much higher than Exim historically used.
25408
25409 The filename and bits used will change as the GnuTLS maintainers change the
25410 value for their parameter &`GNUTLS_SEC_PARAM_NORMAL`&, as clamped by
25411 &%tls_dh_max_bits%&.  At the time of writing (mid 2012), GnuTLS 2.12 recommends
25412 2432 bits, while NSS is limited to 2236 bits.
25413
25414 In fact, the requested value will be *lower* than &%tls_dh_max_bits%&, to
25415 increase the chance of the generated prime actually being within acceptable
25416 bounds, as GnuTLS has been observed to overshoot.  Note the check step in the
25417 procedure above.  There is no sane procedure available to Exim to double-check
25418 the size of the generated prime, so it might still be too large.
25419
25420
25421 .section "Requiring specific ciphers in OpenSSL" "SECTreqciphssl"
25422 .cindex "TLS" "requiring specific ciphers (OpenSSL)"
25423 .oindex "&%tls_require_ciphers%&" "OpenSSL"
25424 There is a function in the OpenSSL library that can be passed a list of cipher
25425 suites before the cipher negotiation takes place. This specifies which ciphers
25426 are acceptable. The list is colon separated and may contain names like
25427 DES-CBC3-SHA. Exim passes the expanded value of &%tls_require_ciphers%&
25428 directly to this function call.
25429 Many systems will install the OpenSSL manual-pages, so you may have
25430 &'ciphers(1)'& available to you.
25431 The following quotation from the OpenSSL
25432 documentation specifies what forms of item are allowed in the cipher string:
25433
25434 .ilist
25435 It can consist of a single cipher suite such as RC4-SHA.
25436 .next
25437 It can represent a list of cipher suites containing a certain algorithm,
25438 or cipher suites of a certain type. For example SHA1 represents all
25439 ciphers suites using the digest algorithm SHA1 and SSLv3 represents all
25440 SSL v3 algorithms.
25441 .next
25442 Lists of cipher suites can be combined in a single cipher string using
25443 the + character. This is used as a logical and operation. For example
25444 SHA1+DES represents all cipher suites containing the SHA1 and the DES
25445 algorithms.
25446 .endlist
25447
25448 Each cipher string can be optionally preceded by one of the characters &`!`&,
25449 &`-`& or &`+`&.
25450 .ilist
25451 If &`!`& is used, the ciphers are permanently deleted from the list. The
25452 ciphers deleted can never reappear in the list even if they are explicitly
25453 stated.
25454 .next
25455 If &`-`& is used, the ciphers are deleted from the list, but some or all
25456 of the ciphers can be added again by later options.
25457 .next
25458 If &`+`& is used, the ciphers are moved to the end of the list. This
25459 option does not add any new ciphers; it just moves matching existing ones.
25460 .endlist
25461
25462 If none of these characters is present, the string is interpreted as
25463 a list of ciphers to be appended to the current preference list. If the list
25464 includes any ciphers already present they will be ignored: that is, they will
25465 not be moved to the end of the list.
25466 .endlist
25467
25468 The OpenSSL &'ciphers(1)'& command may be used to test the results of a given
25469 string:
25470 .code
25471 # note single-quotes to get ! past any shell history expansion
25472 $ openssl ciphers 'HIGH:!MD5:!SHA1'
25473 .endd
25474
25475 This example will let the library defaults be permitted on the MX port, where
25476 there's probably no identity verification anyway, but ups the ante on the
25477 submission ports where the administrator might have some influence on the
25478 choice of clients used:
25479 .code
25480 # OpenSSL variant; see man ciphers(1)
25481 tls_require_ciphers = ${if =={$received_port}{25}\
25482                            {DEFAULT}\
25483                            {HIGH:!MD5:!SHA1}}
25484 .endd
25485
25486
25487
25488 .section "Requiring specific ciphers or other parameters in GnuTLS" &&&
25489          "SECTreqciphgnu"
25490 .cindex "GnuTLS" "specifying parameters for"
25491 .cindex "TLS" "specifying ciphers (GnuTLS)"
25492 .cindex "TLS" "specifying key exchange methods (GnuTLS)"
25493 .cindex "TLS" "specifying MAC algorithms (GnuTLS)"
25494 .cindex "TLS" "specifying protocols (GnuTLS)"
25495 .cindex "TLS" "specifying priority string (GnuTLS)"
25496 .oindex "&%tls_require_ciphers%&" "GnuTLS"
25497 The GnuTLS library allows the caller to provide a "priority string", documented
25498 as part of the &[gnutls_priority_init]& function.  This is very similar to the
25499 ciphersuite specification in OpenSSL.
25500
25501 The &%tls_require_ciphers%& option is treated as the GnuTLS priority string.
25502
25503 The &%tls_require_ciphers%& option is available both as an global option,
25504 controlling how Exim behaves as a server, and also as an option of the
25505 &(smtp)& transport, controlling how Exim behaves as a client.  In both cases
25506 the value is string expanded.  The resulting string is not an Exim list and
25507 the string is given to the GnuTLS library, so that Exim does not need to be
25508 aware of future feature enhancements of GnuTLS.
25509
25510 Documentation of the strings accepted may be found in the GnuTLS manual, under
25511 "Priority strings".  This is online as
25512 &url(http://www.gnu.org/software/gnutls/manual/html_node/Priority-Strings.html),
25513 but beware that this relates to GnuTLS 3, which may be newer than the version
25514 installed on your system.  If you are using GnuTLS 3,
25515 &url(http://www.gnu.org/software/gnutls/manual/html_node/Listing-the-ciphersuites-in-a-priority-string.html, then the example code)
25516 on that site can be used to test a given string.
25517
25518 Prior to Exim 4.80, an older API of GnuTLS was used, and Exim supported three
25519 additional options, "&%gnutls_require_kx%&", "&%gnutls_require_mac%&" and
25520 "&%gnutls_require_protocols%&".  &%tls_require_ciphers%& was an Exim list.
25521
25522 This example will let the library defaults be permitted on the MX port, where
25523 there's probably no identity verification anyway, and lowers security further
25524 by increasing compatibility; but this ups the ante on the submission ports
25525 where the administrator might have some influence on the choice of clients
25526 used:
25527 .code
25528 # GnuTLS variant
25529 tls_require_ciphers = ${if =={$received_port}{25}\
25530                            {NORMAL:%COMPAT}\
25531                            {SECURE128}}
25532 .endd
25533
25534
25535 .section "Configuring an Exim server to use TLS" "SECID182"
25536 .cindex "TLS" "configuring an Exim server"
25537 When Exim has been built with TLS support, it advertises the availability of
25538 the STARTTLS command to client hosts that match &%tls_advertise_hosts%&,
25539 but not to any others. The default value of this option is unset, which means
25540 that STARTTLS is not advertised at all. This default is chosen because you
25541 need to set some other options in order to make TLS available, and also it is
25542 sensible for systems that want to use TLS only as a client.
25543
25544 If a client issues a STARTTLS command and there is some configuration
25545 problem in the server, the command is rejected with a 454 error. If the client
25546 persists in trying to issue SMTP commands, all except QUIT are rejected
25547 with the error
25548 .code
25549 554 Security failure
25550 .endd
25551 If a STARTTLS command is issued within an existing TLS session, it is
25552 rejected with a 554 error code.
25553
25554 To enable TLS operations on a server, you must set &%tls_advertise_hosts%& to
25555 match some hosts. You can, of course, set it to * to match all hosts.
25556 However, this is not all you need to do. TLS sessions to a server won't work
25557 without some further configuration at the server end.
25558
25559 It is rumoured that all existing clients that support TLS/SSL use RSA
25560 encryption. To make this work you need to set, in the server,
25561 .code
25562 tls_certificate = /some/file/name
25563 tls_privatekey = /some/file/name
25564 .endd
25565 These options are, in fact, expanded strings, so you can make them depend on
25566 the identity of the client that is connected if you wish. The first file
25567 contains the server's X509 certificate, and the second contains the private key
25568 that goes with it. These files need to be readable by the Exim user, and must
25569 always be given as full path names. They can be the same file if both the
25570 certificate and the key are contained within it. If &%tls_privatekey%& is not
25571 set, or if its expansion is forced to fail or results in an empty string, this
25572 is assumed to be the case. The certificate file may also contain intermediate
25573 certificates that need to be sent to the client to enable it to authenticate
25574 the server's certificate.
25575
25576 If you do not understand about certificates and keys, please try to find a
25577 source of this background information, which is not Exim-specific. (There are a
25578 few comments below in section &<<SECTcerandall>>&.)
25579
25580 &*Note*&: These options do not apply when Exim is operating as a client &--
25581 they apply only in the case of a server. If you need to use a certificate in an
25582 Exim client, you must set the options of the same names in an &(smtp)&
25583 transport.
25584
25585 With just these options, an Exim server will be able to use TLS. It does not
25586 require the client to have a certificate (but see below for how to insist on
25587 this). There is one other option that may be needed in other situations. If
25588 .code
25589 tls_dhparam = /some/file/name
25590 .endd
25591 is set, the SSL library is initialized for the use of Diffie-Hellman ciphers
25592 with the parameters contained in the file.
25593 Set this to &`none`& to disable use of DH entirely, by making no prime
25594 available:
25595 .code
25596 tls_dhparam = none
25597 .endd
25598 This may also be set to a string identifying a standard prime to be used for
25599 DH; if it is set to &`default`& or, for OpenSSL, is unset, then the prime
25600 used is &`ike23`&.  There are a few standard primes available, see the
25601 documetnation for &%tls_dhparam%& for the complete list.
25602
25603 See the command
25604 .code
25605 openssl dhparam
25606 .endd
25607 for a way of generating file data.
25608
25609 The strings supplied for these three options are expanded every time a client
25610 host connects. It is therefore possible to use different certificates and keys
25611 for different hosts, if you so wish, by making use of the client's IP address
25612 in &$sender_host_address$& to control the expansion. If a string expansion is
25613 forced to fail, Exim behaves as if the option is not set.
25614
25615 .cindex "cipher" "logging"
25616 .cindex "log" "TLS cipher"
25617 .vindex "&$tls_in_cipher$&"
25618 The variable &$tls_in_cipher$& is set to the cipher suite that was negotiated for
25619 an incoming TLS connection. It is included in the &'Received:'& header of an
25620 incoming message (by default &-- you can, of course, change this), and it is
25621 also included in the log line that records a message's arrival, keyed by
25622 &"X="&, unless the &%tls_cipher%& log selector is turned off. The &%encrypted%&
25623 condition can be used to test for specific cipher suites in ACLs.
25624
25625 Once TLS has been established, the ACLs that run for subsequent SMTP commands
25626 can check the name of the cipher suite and vary their actions accordingly. The
25627 cipher suite names vary, depending on which TLS library is being used. For
25628 example, OpenSSL uses the name DES-CBC3-SHA for the cipher suite which in other
25629 contexts is known as TLS_RSA_WITH_3DES_EDE_CBC_SHA. Check the OpenSSL or GnuTLS
25630 documentation for more details.
25631
25632 For outgoing SMTP deliveries, &$tls_out_cipher$& is used and logged
25633 (again depending on the &%tls_cipher%& log selector).
25634
25635
25636 .section "Requesting and verifying client certificates" "SECID183"
25637 .cindex "certificate" "verification of client"
25638 .cindex "TLS" "client certificate verification"
25639 If you want an Exim server to request a certificate when negotiating a TLS
25640 session with a client, you must set either &%tls_verify_hosts%& or
25641 &%tls_try_verify_hosts%&. You can, of course, set either of them to * to
25642 apply to all TLS connections. For any host that matches one of these options,
25643 Exim requests a certificate as part of the setup of the TLS session. The
25644 contents of the certificate are verified by comparing it with a list of
25645 expected certificates. These must be available in a file or,
25646 for OpenSSL only (not GnuTLS), a directory, identified by
25647 &%tls_verify_certificates%&.
25648
25649 A file can contain multiple certificates, concatenated end to end. If a
25650 directory is used
25651 (OpenSSL only),
25652 each certificate must be in a separate file, with a name (or a symbolic link)
25653 of the form <&'hash'&>.0, where <&'hash'&> is a hash value constructed from the
25654 certificate. You can compute the relevant hash by running the command
25655 .code
25656 openssl x509 -hash -noout -in /cert/file
25657 .endd
25658 where &_/cert/file_& contains a single certificate.
25659
25660 The difference between &%tls_verify_hosts%& and &%tls_try_verify_hosts%& is
25661 what happens if the client does not supply a certificate, or if the certificate
25662 does not match any of the certificates in the collection named by
25663 &%tls_verify_certificates%&. If the client matches &%tls_verify_hosts%&, the
25664 attempt to set up a TLS session is aborted, and the incoming connection is
25665 dropped. If the client matches &%tls_try_verify_hosts%&, the (encrypted) SMTP
25666 session continues. ACLs that run for subsequent SMTP commands can detect the
25667 fact that no certificate was verified, and vary their actions accordingly. For
25668 example, you can insist on a certificate before accepting a message for
25669 relaying, but not when the message is destined for local delivery.
25670
25671 .vindex "&$tls_in_peerdn$&"
25672 When a client supplies a certificate (whether it verifies or not), the value of
25673 the Distinguished Name of the certificate is made available in the variable
25674 &$tls_in_peerdn$& during subsequent processing of the message.
25675
25676 .cindex "log" "distinguished name"
25677 Because it is often a long text string, it is not included in the log line or
25678 &'Received:'& header by default. You can arrange for it to be logged, keyed by
25679 &"DN="&, by setting the &%tls_peerdn%& log selector, and you can use
25680 &%received_header_text%& to change the &'Received:'& header. When no
25681 certificate is supplied, &$tls_in_peerdn$& is empty.
25682
25683
25684 .section "Revoked certificates" "SECID184"
25685 .cindex "TLS" "revoked certificates"
25686 .cindex "revocation list"
25687 .cindex "certificate" "revocation list"
25688 Certificate issuing authorities issue Certificate Revocation Lists (CRLs) when
25689 certificates are revoked. If you have such a list, you can pass it to an Exim
25690 server using the global option called &%tls_crl%& and to an Exim client using
25691 an identically named option for the &(smtp)& transport. In each case, the value
25692 of the option is expanded and must then be the name of a file that contains a
25693 CRL in PEM format.
25694
25695
25696 .section "Configuring an Exim client to use TLS" "SECID185"
25697 .cindex "cipher" "logging"
25698 .cindex "log" "TLS cipher"
25699 .cindex "log" "distinguished name"
25700 .cindex "TLS" "configuring an Exim client"
25701 The &%tls_cipher%& and &%tls_peerdn%& log selectors apply to outgoing SMTP
25702 deliveries as well as to incoming, the latter one causing logging of the
25703 server certificate's DN. The remaining client configuration for TLS is all
25704 within the &(smtp)& transport.
25705
25706 It is not necessary to set any options to have TLS work in the &(smtp)&
25707 transport. If Exim is built with TLS support, and TLS is advertised by a
25708 server, the &(smtp)& transport always tries to start a TLS session. However,
25709 this can be prevented by setting &%hosts_avoid_tls%& (an option of the
25710 transport) to a list of server hosts for which TLS should not be used.
25711
25712 If you do not want Exim to attempt to send messages unencrypted when an attempt
25713 to set up an encrypted connection fails in any way, you can set
25714 &%hosts_require_tls%& to a list of hosts for which encryption is mandatory. For
25715 those hosts, delivery is always deferred if an encrypted connection cannot be
25716 set up. If there are any other hosts for the address, they are tried in the
25717 usual way.
25718
25719 When the server host is not in &%hosts_require_tls%&, Exim may try to deliver
25720 the message unencrypted. It always does this if the response to STARTTLS is
25721 a 5&'xx'& code. For a temporary error code, or for a failure to negotiate a TLS
25722 session after a success response code, what happens is controlled by the
25723 &%tls_tempfail_tryclear%& option of the &(smtp)& transport. If it is false,
25724 delivery to this host is deferred, and other hosts (if available) are tried. If
25725 it is true, Exim attempts to deliver unencrypted after a 4&'xx'& response to
25726 STARTTLS, and if STARTTLS is accepted, but the subsequent TLS
25727 negotiation fails, Exim closes the current connection (because it is in an
25728 unknown state), opens a new one to the same host, and then tries the delivery
25729 unencrypted.
25730
25731 The &%tls_certificate%& and &%tls_privatekey%& options of the &(smtp)&
25732 transport provide the client with a certificate, which is passed to the server
25733 if it requests it. If the server is Exim, it will request a certificate only if
25734 &%tls_verify_hosts%& or &%tls_try_verify_hosts%& matches the client.
25735
25736 If the &%tls_verify_certificates%& option is set on the &(smtp)& transport, it
25737 must name a file or,
25738 for OpenSSL only (not GnuTLS), a directory, that contains a collection of
25739 expected server certificates. The client verifies the server's certificate
25740 against this collection, taking into account any revoked certificates that are
25741 in the list defined by &%tls_crl%&.
25742
25743 If
25744 &%tls_require_ciphers%& is set on the &(smtp)& transport, it must contain a
25745 list of permitted cipher suites. If either of these checks fails, delivery to
25746 the current host is abandoned, and the &(smtp)& transport tries to deliver to
25747 alternative hosts, if any.
25748
25749  &*Note*&:
25750 These options must be set in the &(smtp)& transport for Exim to use TLS when it
25751 is operating as a client. Exim does not assume that a server certificate (set
25752 by the global options of the same name) should also be used when operating as a
25753 client.
25754
25755 .vindex "&$host$&"
25756 .vindex "&$host_address$&"
25757 All the TLS options in the &(smtp)& transport are expanded before use, with
25758 &$host$& and &$host_address$& containing the name and address of the server to
25759 which the client is connected. Forced failure of an expansion causes Exim to
25760 behave as if the relevant option were unset.
25761
25762 .vindex &$tls_out_bits$&
25763 .vindex &$tls_out_cipher$&
25764 .vindex &$tls_out_peerdn$&
25765 .vindex &$tls_out_sni$&
25766 Before an SMTP connection is established, the
25767 &$tls_out_bits$&, &$tls_out_cipher$&, &$tls_out_peerdn$& and &$tls_out_sni$&
25768 variables are emptied. (Until the first connection, they contain the values
25769 that were set when the message was received.) If STARTTLS is subsequently
25770 successfully obeyed, these variables are set to the relevant values for the
25771 outgoing connection.
25772
25773
25774
25775 .section "Use of TLS Server Name Indication" "SECTtlssni"
25776 .cindex "TLS" "Server Name Indication"
25777 .vindex "&$tls_in_sni$&"
25778 .oindex "&%tls_in_sni%&"
25779 With TLS1.0 or above, there is an extension mechanism by which extra
25780 information can be included at various points in the protocol.  One of these
25781 extensions, documented in RFC 6066 (and before that RFC 4366) is
25782 &"Server Name Indication"&, commonly &"SNI"&.  This extension is sent by the
25783 client in the initial handshake, so that the server can examine the servername
25784 within and possibly choose to use different certificates and keys (and more)
25785 for this session.
25786
25787 This is analagous to HTTP's &"Host:"& header, and is the main mechanism by
25788 which HTTPS-enabled web-sites can be virtual-hosted, many sites to one IP
25789 address.
25790
25791 With SMTP to MX, there are the same problems here as in choosing the identity
25792 against which to validate a certificate: you can't rely on insecure DNS to
25793 provide the identity which you then cryptographically verify.  So this will
25794 be of limited use in that environment.
25795
25796 With SMTP to Submission, there is a well-defined hostname which clients are
25797 connecting to and can validate certificates against.  Thus clients &*can*&
25798 choose to include this information in the TLS negotiation.  If this becomes
25799 wide-spread, then hosters can choose to present different certificates to
25800 different clients.  Or even negotiate different cipher suites.
25801
25802 The &%tls_sni%& option on an SMTP transport is an expanded string; the result,
25803 if not empty, will be sent on a TLS session as part of the handshake.  There's
25804 nothing more to it.  Choosing a sensible value not derived insecurely is the
25805 only point of caution.  The &$tls_out_sni$& variable will be set to this string
25806 for the lifetime of the client connection (including during authentication).
25807
25808 Except during SMTP client sessions, if &$tls_in_sni$& is set then it is a string
25809 received from a client.
25810 It can be logged with the &%log_selector%& item &`+tls_sni`&.
25811
25812 If the string &`tls_in_sni`& appears in the main section's &%tls_certificate%&
25813 option (prior to expansion) then the following options will be re-expanded
25814 during TLS session handshake, to permit alternative values to be chosen:
25815
25816 .ilist
25817 .vindex "&%tls_certificate%&"
25818 &%tls_certificate%&
25819 .next
25820 .vindex "&%tls_crl%&"
25821 &%tls_crl%&
25822 .next
25823 .vindex "&%tls_privatekey%&"
25824 &%tls_privatekey%&
25825 .next
25826 .vindex "&%tls_verify_certificates%&"
25827 &%tls_verify_certificates%&
25828 .endlist
25829
25830 Great care should be taken to deal with matters of case, various injection
25831 attacks in the string (&`../`& or SQL), and ensuring that a valid filename
25832 can always be referenced; it is important to remember that &$tls_sni$& is
25833 arbitrary unverified data provided prior to authentication.
25834
25835 The Exim developers are proceeding cautiously and so far no other TLS options
25836 are re-expanded.
25837
25838 When Exim is built againt OpenSSL, OpenSSL must have been built with support
25839 for TLS Extensions.  This holds true for OpenSSL 1.0.0+ and 0.9.8+ with
25840 enable-tlsext in EXTRACONFIGURE.  If you invoke &(openssl s_client -h)& and
25841 see &`-servername`& in the output, then OpenSSL has support.
25842
25843 When Exim is built against GnuTLS, SNI support is available as of GnuTLS
25844 0.5.10.  (Its presence predates the current API which Exim uses, so if Exim
25845 built, then you have SNI support).
25846
25847
25848
25849 .section "Multiple messages on the same encrypted TCP/IP connection" &&&
25850          "SECTmulmessam"
25851 .cindex "multiple SMTP deliveries with TLS"
25852 .cindex "TLS" "multiple message deliveries"
25853 Exim sends multiple messages down the same TCP/IP connection by starting up
25854 an entirely new delivery process for each message, passing the socket from
25855 one process to the next. This implementation does not fit well with the use
25856 of TLS, because there is quite a lot of state information associated with a TLS
25857 connection, not just a socket identification. Passing all the state information
25858 to a new process is not feasible. Consequently, Exim shuts down an existing TLS
25859 session before passing the socket to a new process. The new process may then
25860 try to start a new TLS session, and if successful, may try to re-authenticate
25861 if AUTH is in use, before sending the next message.
25862
25863 The RFC is not clear as to whether or not an SMTP session continues in clear
25864 after TLS has been shut down, or whether TLS may be restarted again later, as
25865 just described. However, if the server is Exim, this shutdown and
25866 reinitialization works. It is not known which (if any) other servers operate
25867 successfully if the client closes a TLS session and continues with unencrypted
25868 SMTP, but there are certainly some that do not work. For such servers, Exim
25869 should not pass the socket to another process, because the failure of the
25870 subsequent attempt to use it would cause Exim to record a temporary host error,
25871 and delay other deliveries to that host.
25872
25873 To test for this case, Exim sends an EHLO command to the server after
25874 closing down the TLS session. If this fails in any way, the connection is
25875 closed instead of being passed to a new delivery process, but no retry
25876 information is recorded.
25877
25878 There is also a manual override; you can set &%hosts_nopass_tls%& on the
25879 &(smtp)& transport to match those hosts for which Exim should not pass
25880 connections to new processes if TLS has been used.
25881
25882
25883
25884
25885 .section "Certificates and all that" "SECTcerandall"
25886 .cindex "certificate" "references to discussion"
25887 In order to understand fully how TLS works, you need to know about
25888 certificates, certificate signing, and certificate authorities. This is not the
25889 place to give a tutorial, especially as I do not know very much about it
25890 myself. Some helpful introduction can be found in the FAQ for the SSL addition
25891 to Apache, currently at
25892 .display
25893 &url(http://www.modssl.org/docs/2.7/ssl_faq.html#ToC24)
25894 .endd
25895 Other parts of the &'modssl'& documentation are also helpful, and have
25896 links to further files.
25897 Eric Rescorla's book, &'SSL and TLS'&, published by Addison-Wesley (ISBN
25898 0-201-61598-3), contains both introductory and more in-depth descriptions.
25899 Some sample programs taken from the book are available from
25900 .display
25901 &url(http://www.rtfm.com/openssl-examples/)
25902 .endd
25903
25904
25905 .section "Certificate chains" "SECID186"
25906 The file named by &%tls_certificate%& may contain more than one
25907 certificate. This is useful in the case where the certificate that is being
25908 sent is validated by an intermediate certificate which the other end does
25909 not have. Multiple certificates must be in the correct order in the file.
25910 First the host's certificate itself, then the first intermediate
25911 certificate to validate the issuer of the host certificate, then the next
25912 intermediate certificate to validate the issuer of the first intermediate
25913 certificate, and so on, until finally (optionally) the root certificate.
25914 The root certificate must already be trusted by the recipient for
25915 validation to succeed, of course, but if it's not preinstalled, sending the
25916 root certificate along with the rest makes it available for the user to
25917 install if the receiving end is a client MUA that can interact with a user.
25918
25919
25920 .section "Self-signed certificates" "SECID187"
25921 .cindex "certificate" "self-signed"
25922 You can create a self-signed certificate using the &'req'& command provided
25923 with OpenSSL, like this:
25924 . ==== Do not shorten the duration here without reading and considering
25925 . ==== the text below.  Please leave it at 9999 days.
25926 .code
25927 openssl req -x509 -newkey rsa:1024 -keyout file1 -out file2 \
25928             -days 9999 -nodes
25929 .endd
25930 &_file1_& and &_file2_& can be the same file; the key and the certificate are
25931 delimited and so can be identified independently. The &%-days%& option
25932 specifies a period for which the certificate is valid. The &%-nodes%& option is
25933 important: if you do not set it, the key is encrypted with a passphrase
25934 that you are prompted for, and any use that is made of the key causes more
25935 prompting for the passphrase. This is not helpful if you are going to use
25936 this certificate and key in an MTA, where prompting is not possible.
25937
25938 . ==== I expect to still be working 26 years from now.  The less technical
25939 . ==== debt I create, in terms of storing up trouble for my later years, the
25940 . ==== happier I will be then.  We really have reached the point where we
25941 . ==== should start, at the very least, provoking thought and making folks
25942 . ==== pause before proceeding, instead of leaving all the fixes until two
25943 . ==== years before 2^31 seconds after the 1970 Unix epoch.
25944 . ==== -pdp, 2012
25945 NB: we are now past the point where 9999 days takes us past the 32-bit Unix
25946 epoch.  If your system uses unsigned time_t (most do) and is 32-bit, then
25947 the above command might produce a date in the past.  Think carefully about
25948 the lifetime of the systems you're deploying, and either reduce the duration
25949 of the certificate or reconsider your platform deployment.  (At time of
25950 writing, reducing the duration is the most likely choice, but the inexorable
25951 progression of time takes us steadily towards an era where this will not
25952 be a sensible resolution).
25953
25954 A self-signed certificate made in this way is sufficient for testing, and
25955 may be adequate for all your requirements if you are mainly interested in
25956 encrypting transfers, and not in secure identification.
25957
25958 However, many clients require that the certificate presented by the server be a
25959 user (also called &"leaf"& or &"site"&) certificate, and not a self-signed
25960 certificate. In this situation, the self-signed certificate described above
25961 must be installed on the client host as a trusted root &'certification
25962 authority'& (CA), and the certificate used by Exim must be a user certificate
25963 signed with that self-signed certificate.
25964
25965 For information on creating self-signed CA certificates and using them to sign
25966 user certificates, see the &'General implementation overview'& chapter of the
25967 Open-source PKI book, available online at
25968 &url(http://ospkibook.sourceforge.net/).
25969 .ecindex IIDencsmtp1
25970 .ecindex IIDencsmtp2
25971
25972
25973
25974 . ////////////////////////////////////////////////////////////////////////////
25975 . ////////////////////////////////////////////////////////////////////////////
25976
25977 .chapter "Access control lists" "CHAPACL"
25978 .scindex IIDacl "&ACL;" "description"
25979 .cindex "control of incoming mail"
25980 .cindex "message" "controlling incoming"
25981 .cindex "policy control" "access control lists"
25982 Access Control Lists (ACLs) are defined in a separate section of the run time
25983 configuration file, headed by &"begin acl"&. Each ACL definition starts with a
25984 name, terminated by a colon. Here is a complete ACL section that contains just
25985 one very small ACL:
25986 .code
25987 begin acl
25988 small_acl:
25989   accept   hosts = one.host.only
25990 .endd
25991 You can have as many lists as you like in the ACL section, and the order in
25992 which they appear does not matter. The lists are self-terminating.
25993
25994 The majority of ACLs are used to control Exim's behaviour when it receives
25995 certain SMTP commands. This applies both to incoming TCP/IP connections, and
25996 when a local process submits a message using SMTP by specifying the &%-bs%&
25997 option. The most common use is for controlling which recipients are accepted
25998 in incoming messages. In addition, you can define an ACL that is used to check
25999 local non-SMTP messages. The default configuration file contains an example of
26000 a realistic ACL for checking RCPT commands. This is discussed in chapter
26001 &<<CHAPdefconfil>>&.
26002
26003
26004 .section "Testing ACLs" "SECID188"
26005 The &%-bh%& command line option provides a way of testing your ACL
26006 configuration locally by running a fake SMTP session with which you interact.
26007 The host &'relay-test.mail-abuse.org'& provides a service for checking your
26008 relaying configuration (see section &<<SECTcheralcon>>& for more details).
26009
26010
26011
26012 .section "Specifying when ACLs are used" "SECID189"
26013 .cindex "&ACL;" "options for specifying"
26014 In order to cause an ACL to be used, you have to name it in one of the relevant
26015 options in the main part of the configuration. These options are:
26016 .cindex "AUTH" "ACL for"
26017 .cindex "DATA" "ACLs for"
26018 .cindex "ETRN" "ACL for"
26019 .cindex "EXPN" "ACL for"
26020 .cindex "HELO" "ACL for"
26021 .cindex "EHLO" "ACL for"
26022 .cindex "MAIL" "ACL for"
26023 .cindex "QUIT, ACL for"
26024 .cindex "RCPT" "ACL for"
26025 .cindex "STARTTLS, ACL for"
26026 .cindex "VRFY" "ACL for"
26027 .cindex "SMTP" "connection, ACL for"
26028 .cindex "non-SMTP messages" "ACLs for"
26029 .cindex "MIME content scanning" "ACL for"
26030
26031 .table2 140pt
26032 .irow &%acl_not_smtp%&         "ACL for non-SMTP messages"
26033 .irow &%acl_not_smtp_mime%&    "ACL for non-SMTP MIME parts"
26034 .irow &%acl_not_smtp_start%&   "ACL at start of non-SMTP message"
26035 .irow &%acl_smtp_auth%&        "ACL for AUTH"
26036 .irow &%acl_smtp_connect%&     "ACL for start of SMTP connection"
26037 .irow &%acl_smtp_data%&        "ACL after DATA is complete"
26038 .irow &%acl_smtp_etrn%&        "ACL for ETRN"
26039 .irow &%acl_smtp_expn%&        "ACL for EXPN"
26040 .irow &%acl_smtp_helo%&        "ACL for HELO or EHLO"
26041 .irow &%acl_smtp_mail%&        "ACL for MAIL"
26042 .irow &%acl_smtp_mailauth%&    "ACL for the AUTH parameter of MAIL"
26043 .irow &%acl_smtp_mime%&        "ACL for content-scanning MIME parts"
26044 .irow &%acl_smtp_notquit%&     "ACL for non-QUIT terminations"
26045 .irow &%acl_smtp_predata%&     "ACL at start of DATA command"
26046 .irow &%acl_smtp_quit%&        "ACL for QUIT"
26047 .irow &%acl_smtp_rcpt%&        "ACL for RCPT"
26048 .irow &%acl_smtp_starttls%&    "ACL for STARTTLS"
26049 .irow &%acl_smtp_vrfy%&        "ACL for VRFY"
26050 .endtable
26051
26052 For example, if you set
26053 .code
26054 acl_smtp_rcpt = small_acl
26055 .endd
26056 the little ACL defined above is used whenever Exim receives a RCPT command
26057 in an SMTP dialogue. The majority of policy tests on incoming messages can be
26058 done when RCPT commands arrive. A rejection of RCPT should cause the
26059 sending MTA to give up on the recipient address contained in the RCPT
26060 command, whereas rejection at other times may cause the client MTA to keep on
26061 trying to deliver the message. It is therefore recommended that you do as much
26062 testing as possible at RCPT time.
26063
26064
26065 .section "The non-SMTP ACLs" "SECID190"
26066 .cindex "non-SMTP messages" "ACLs for"
26067 The non-SMTP ACLs apply to all non-interactive incoming messages, that is, they
26068 apply to batched SMTP as well as to non-SMTP messages. (Batched SMTP is not
26069 really SMTP.) Many of the ACL conditions (for example, host tests, and tests on
26070 the state of the SMTP connection such as encryption and authentication) are not
26071 relevant and are forbidden in these ACLs. However, the sender and recipients
26072 are known, so the &%senders%& and &%sender_domains%& conditions and the
26073 &$sender_address$& and &$recipients$& variables can be used. Variables such as
26074 &$authenticated_sender$& are also available. You can specify added header lines
26075 in any of these ACLs.
26076
26077 The &%acl_not_smtp_start%& ACL is run right at the start of receiving a
26078 non-SMTP message, before any of the message has been read. (This is the
26079 analogue of the &%acl_smtp_predata%& ACL for SMTP input.) In the case of
26080 batched SMTP input, it runs after the DATA command has been reached. The
26081 result of this ACL is ignored; it cannot be used to reject a message. If you
26082 really need to, you could set a value in an ACL variable here and reject based
26083 on that in the &%acl_not_smtp%& ACL. However, this ACL can be used to set
26084 controls, and in particular, it can be used to set
26085 .code
26086 control = suppress_local_fixups
26087 .endd
26088 This cannot be used in the other non-SMTP ACLs because by the time they are
26089 run, it is too late.
26090
26091 The &%acl_not_smtp_mime%& ACL is available only when Exim is compiled with the
26092 content-scanning extension. For details, see chapter &<<CHAPexiscan>>&.
26093
26094 The &%acl_not_smtp%& ACL is run just before the &[local_scan()]& function. Any
26095 kind of rejection is treated as permanent, because there is no way of sending a
26096 temporary error for these kinds of message.
26097
26098
26099 .section "The SMTP connect ACL" "SECID191"
26100 .cindex "SMTP" "connection, ACL for"
26101 .oindex &%smtp_banner%&
26102 The ACL test specified by &%acl_smtp_connect%& happens at the start of an SMTP
26103 session, after the test specified by &%host_reject_connection%& (which is now
26104 an anomaly) and any TCP Wrappers testing (if configured). If the connection is
26105 accepted by an &%accept%& verb that has a &%message%& modifier, the contents of
26106 the message override the banner message that is otherwise specified by the
26107 &%smtp_banner%& option.
26108
26109
26110 .section "The EHLO/HELO ACL" "SECID192"
26111 .cindex "EHLO" "ACL for"
26112 .cindex "HELO" "ACL for"
26113 The ACL test specified by &%acl_smtp_helo%& happens when the client issues an
26114 EHLO or HELO command, after the tests specified by &%helo_accept_junk_hosts%&,
26115 &%helo_allow_chars%&, &%helo_verify_hosts%&, and &%helo_try_verify_hosts%&.
26116 Note that a client may issue more than one EHLO or HELO command in an SMTP
26117 session, and indeed is required to issue a new EHLO or HELO after successfully
26118 setting up encryption following a STARTTLS command.
26119
26120 If the command is accepted by an &%accept%& verb that has a &%message%&
26121 modifier, the message may not contain more than one line (it will be truncated
26122 at the first newline and a panic logged if it does). Such a message cannot
26123 affect the EHLO options that are listed on the second and subsequent lines of
26124 an EHLO response.
26125
26126
26127 .section "The DATA ACLs" "SECID193"
26128 .cindex "DATA" "ACLs for"
26129 Two ACLs are associated with the DATA command, because it is two-stage
26130 command, with two responses being sent to the client.
26131 When the DATA command is received, the ACL defined by &%acl_smtp_predata%&
26132 is obeyed. This gives you control after all the RCPT commands, but before
26133 the message itself is received. It offers the opportunity to give a negative
26134 response to the DATA command before the data is transmitted. Header lines
26135 added by MAIL or RCPT ACLs are not visible at this time, but any that
26136 are defined here are visible when the &%acl_smtp_data%& ACL is run.
26137
26138 You cannot test the contents of the message, for example, to verify addresses
26139 in the headers, at RCPT time or when the DATA command is received. Such
26140 tests have to appear in the ACL that is run after the message itself has been
26141 received, before the final response to the DATA command is sent. This is
26142 the ACL specified by &%acl_smtp_data%&, which is the second ACL that is
26143 associated with the DATA command.
26144
26145 For both of these ACLs, it is not possible to reject individual recipients. An
26146 error response rejects the entire message. Unfortunately, it is known that some
26147 MTAs do not treat hard (5&'xx'&) responses to the DATA command (either
26148 before or after the data) correctly &-- they keep the message on their queues
26149 and try again later, but that is their problem, though it does waste some of
26150 your resources.
26151
26152 The &%acl_smtp_data%& ACL is run after both the &%acl_smtp_dkim%& and
26153 the &%acl_smtp_mime%& ACLs.
26154
26155
26156 .section "The SMTP DKIM ACL" "SECTDKIMACL"
26157 The &%acl_smtp_dkim%& ACL is available only when Exim is compiled with DKIM support
26158 enabled (which is the default).
26159
26160 The ACL test specified by &%acl_smtp_dkim%& happens after a message has been
26161 received, and is executed for each DKIM signature found in a message.  If not
26162 otherwise specified, the default action is to accept.
26163
26164 This ACL is evaluated before &%acl_smtp_mime%& and &%acl_smtp_data%&.
26165
26166 For details on the operation of DKIM, see chapter &<<CHAPdkim>>&.
26167
26168
26169 .section "The SMTP MIME ACL" "SECID194"
26170 The &%acl_smtp_mime%& option is available only when Exim is compiled with the
26171 content-scanning extension. For details, see chapter &<<CHAPexiscan>>&.
26172
26173 This ACL is evaluated after &%acl_smtp_dkim%& but before &%acl_smtp_data%&.
26174
26175
26176 .section "The QUIT ACL" "SECTQUITACL"
26177 .cindex "QUIT, ACL for"
26178 The ACL for the SMTP QUIT command is anomalous, in that the outcome of the ACL
26179 does not affect the response code to QUIT, which is always 221. Thus, the ACL
26180 does not in fact control any access. For this reason, the only verbs that are
26181 permitted are &%accept%& and &%warn%&.
26182
26183 This ACL can be used for tasks such as custom logging at the end of an SMTP
26184 session. For example, you can use ACL variables in other ACLs to count
26185 messages, recipients, etc., and log the totals at QUIT time using one or
26186 more &%logwrite%& modifiers on a &%warn%& verb.
26187
26188 &*Warning*&: Only the &$acl_c$&&'x'& variables can be used for this, because
26189 the &$acl_m$&&'x'& variables are reset at the end of each incoming message.
26190
26191 You do not need to have a final &%accept%&, but if you do, you can use a
26192 &%message%& modifier to specify custom text that is sent as part of the 221
26193 response to QUIT.
26194
26195 This ACL is run only for a &"normal"& QUIT. For certain kinds of disastrous
26196 failure (for example, failure to open a log file, or when Exim is bombing out
26197 because it has detected an unrecoverable error), all SMTP commands from the
26198 client are given temporary error responses until QUIT is received or the
26199 connection is closed. In these special cases, the QUIT ACL does not run.
26200
26201
26202 .section "The not-QUIT ACL" "SECTNOTQUITACL"
26203 .vindex &$acl_smtp_notquit$&
26204 The not-QUIT ACL, specified by &%acl_smtp_notquit%&, is run in most cases when
26205 an SMTP session ends without sending QUIT. However, when Exim itself is in bad
26206 trouble, such as being unable to write to its log files, this ACL is not run,
26207 because it might try to do things (such as write to log files) that make the
26208 situation even worse.
26209
26210 Like the QUIT ACL, this ACL is provided to make it possible to do customized
26211 logging or to gather statistics, and its outcome is ignored. The &%delay%&
26212 modifier is forbidden in this ACL, and the only permitted verbs are &%accept%&
26213 and &%warn%&.
26214
26215 .vindex &$smtp_notquit_reason$&
26216 When the not-QUIT ACL is running, the variable &$smtp_notquit_reason$& is set
26217 to a string that indicates the reason for the termination of the SMTP
26218 connection. The possible values are:
26219 .table2
26220 .irow &`acl-drop`&                 "Another ACL issued a &%drop%& command"
26221 .irow &`bad-commands`&             "Too many unknown or non-mail commands"
26222 .irow &`command-timeout`&          "Timeout while reading SMTP commands"
26223 .irow &`connection-lost`&          "The SMTP connection has been lost"
26224 .irow &`data-timeout`&             "Timeout while reading message data"
26225 .irow &`local-scan-error`&         "The &[local_scan()]& function crashed"
26226 .irow &`local-scan-timeout`&       "The &[local_scan()]& function timed out"
26227 .irow &`signal-exit`&              "SIGTERM or SIGINT"
26228 .irow &`synchronization-error`&    "SMTP synchronization error"
26229 .irow &`tls-failed`&               "TLS failed to start"
26230 .endtable
26231 In most cases when an SMTP connection is closed without having received QUIT,
26232 Exim sends an SMTP response message before actually closing the connection.
26233 With the exception of the &`acl-drop`& case, the default message can be
26234 overridden by the &%message%& modifier in the not-QUIT ACL. In the case of a
26235 &%drop%& verb in another ACL, it is the message from the other ACL that is
26236 used.
26237
26238
26239 .section "Finding an ACL to use" "SECID195"
26240 .cindex "&ACL;" "finding which to use"
26241 The value of an &%acl_smtp_%&&'xxx'& option is expanded before use, so
26242 you can use different ACLs in different circumstances. For example,
26243 .code
26244 acl_smtp_rcpt = ${if ={25}{$interface_port} \
26245                      {acl_check_rcpt} {acl_check_rcpt_submit} }
26246 .endd
26247 In the default configuration file there are some example settings for
26248 providing an RFC 4409 message submission service on port 587 and a
26249 non-standard &"smtps"& service on port 465. You can use a string
26250 expansion like this to choose an ACL for MUAs on these ports which is
26251 more appropriate for this purpose than the default ACL on port 25.
26252
26253 The expanded string does not have to be the name of an ACL in the
26254 configuration file; there are other possibilities. Having expanded the
26255 string, Exim searches for an ACL as follows:
26256
26257 .ilist
26258 If the string begins with a slash, Exim uses it as a file name, and reads its
26259 contents as an ACL. The lines are processed in the same way as lines in the
26260 Exim configuration file. In particular, continuation lines are supported, blank
26261 lines are ignored, as are lines whose first non-whitespace character is &"#"&.
26262 If the file does not exist or cannot be read, an error occurs (typically
26263 causing a temporary failure of whatever caused the ACL to be run). For example:
26264 .code
26265 acl_smtp_data = /etc/acls/\
26266   ${lookup{$sender_host_address}lsearch\
26267   {/etc/acllist}{$value}{default}}
26268 .endd
26269 This looks up an ACL file to use on the basis of the host's IP address, falling
26270 back to a default if the lookup fails. If an ACL is successfully read from a
26271 file, it is retained in memory for the duration of the Exim process, so that it
26272 can be re-used without having to re-read the file.
26273 .next
26274 If the string does not start with a slash, and does not contain any spaces,
26275 Exim searches the ACL section of the configuration for an ACL whose name
26276 matches the string.
26277 .next
26278 If no named ACL is found, or if the string contains spaces, Exim parses
26279 the string as an inline ACL. This can save typing in cases where you just
26280 want to have something like
26281 .code
26282 acl_smtp_vrfy = accept
26283 .endd
26284 in order to allow free use of the VRFY command. Such a string may contain
26285 newlines; it is processed in the same way as an ACL that is read from a file.
26286 .endlist
26287
26288
26289
26290
26291 .section "ACL return codes" "SECID196"
26292 .cindex "&ACL;" "return codes"
26293 Except for the QUIT ACL, which does not affect the SMTP return code (see
26294 section &<<SECTQUITACL>>& above), the result of running an ACL is either
26295 &"accept"& or &"deny"&, or, if some test cannot be completed (for example, if a
26296 database is down), &"defer"&. These results cause 2&'xx'&, 5&'xx'&, and 4&'xx'&
26297 return codes, respectively, to be used in the SMTP dialogue. A fourth return,
26298 &"error"&, occurs when there is an error such as invalid syntax in the ACL.
26299 This also causes a 4&'xx'& return code.
26300
26301 For the non-SMTP ACL, &"defer"& and &"error"& are treated in the same way as
26302 &"deny"&, because there is no mechanism for passing temporary errors to the
26303 submitters of non-SMTP messages.
26304
26305
26306 ACLs that are relevant to message reception may also return &"discard"&. This
26307 has the effect of &"accept"&, but causes either the entire message or an
26308 individual recipient address to be discarded. In other words, it is a
26309 blackholing facility. Use it with care.
26310
26311 If the ACL for MAIL returns &"discard"&, all recipients are discarded, and no
26312 ACL is run for subsequent RCPT commands. The effect of &"discard"& in a
26313 RCPT ACL is to discard just the one recipient address. If there are no
26314 recipients left when the message's data is received, the DATA ACL is not
26315 run. A &"discard"& return from the DATA or the non-SMTP ACL discards all the
26316 remaining recipients. The &"discard"& return is not permitted for the
26317 &%acl_smtp_predata%& ACL.
26318
26319
26320 .cindex "&[local_scan()]& function" "when all recipients discarded"
26321 The &[local_scan()]& function is always run, even if there are no remaining
26322 recipients; it may create new recipients.
26323
26324
26325
26326 .section "Unset ACL options" "SECID197"
26327 .cindex "&ACL;" "unset options"
26328 The default actions when any of the &%acl_%&&'xxx'& options are unset are not
26329 all the same. &*Note*&: These defaults apply only when the relevant ACL is
26330 not defined at all. For any defined ACL, the default action when control
26331 reaches the end of the ACL statements is &"deny"&.
26332
26333 For &%acl_smtp_quit%& and &%acl_not_smtp_start%& there is no default because
26334 these two are ACLs that are used only for their side effects. They cannot be
26335 used to accept or reject anything.
26336
26337 For &%acl_not_smtp%&, &%acl_smtp_auth%&, &%acl_smtp_connect%&,
26338 &%acl_smtp_data%&, &%acl_smtp_helo%&, &%acl_smtp_mail%&, &%acl_smtp_mailauth%&,
26339 &%acl_smtp_mime%&, &%acl_smtp_predata%&, and &%acl_smtp_starttls%&, the action
26340 when the ACL is not defined is &"accept"&.
26341
26342 For the others (&%acl_smtp_etrn%&, &%acl_smtp_expn%&, &%acl_smtp_rcpt%&, and
26343 &%acl_smtp_vrfy%&), the action when the ACL is not defined is &"deny"&.
26344 This means that &%acl_smtp_rcpt%& must be defined in order to receive any
26345 messages over an SMTP connection. For an example, see the ACL in the default
26346 configuration file.
26347
26348
26349
26350
26351 .section "Data for message ACLs" "SECID198"
26352 .cindex "&ACL;" "data for message ACL"
26353 .vindex &$domain$&
26354 .vindex &$local_part$&
26355 .vindex &$sender_address$&
26356 .vindex &$sender_host_address$&
26357 .vindex &$smtp_command$&
26358 When a MAIL or RCPT ACL, or either of the DATA ACLs, is running, the variables
26359 that contain information about the host and the message's sender (for example,
26360 &$sender_host_address$& and &$sender_address$&) are set, and can be used in ACL
26361 statements. In the case of RCPT (but not MAIL or DATA), &$domain$& and
26362 &$local_part$& are set from the argument address. The entire SMTP command
26363 is available in &$smtp_command$&.
26364
26365 When an ACL for the AUTH parameter of MAIL is running, the variables that
26366 contain information about the host are set, but &$sender_address$& is not yet
26367 set. Section &<<SECTauthparamail>>& contains a discussion of this parameter and
26368 how it is used.
26369
26370 .vindex "&$message_size$&"
26371 The &$message_size$& variable is set to the value of the SIZE parameter on
26372 the MAIL command at MAIL, RCPT and pre-data time, or to -1 if
26373 that parameter is not given. The value is updated to the true message size by
26374 the time the final DATA ACL is run (after the message data has been
26375 received).
26376
26377 .vindex "&$rcpt_count$&"
26378 .vindex "&$recipients_count$&"
26379 The &$rcpt_count$& variable increases by one for each RCPT command received.
26380 The &$recipients_count$& variable increases by one each time a RCPT command is
26381 accepted, so while an ACL for RCPT is being processed, it contains the number
26382 of previously accepted recipients. At DATA time (for both the DATA ACLs),
26383 &$rcpt_count$& contains the total number of RCPT commands, and
26384 &$recipients_count$& contains the total number of accepted recipients.
26385
26386
26387
26388
26389
26390 .section "Data for non-message ACLs" "SECTdatfornon"
26391 .cindex "&ACL;" "data for non-message ACL"
26392 .vindex &$smtp_command_argument$&
26393 .vindex &$smtp_command$&
26394 When an ACL is being run for AUTH, EHLO, ETRN, EXPN, HELO, STARTTLS, or VRFY,
26395 the remainder of the SMTP command line is placed in &$smtp_command_argument$&,
26396 and the entire SMTP command is available in &$smtp_command$&.
26397 These variables can be tested using a &%condition%& condition. For example,
26398 here is an ACL for use with AUTH, which insists that either the session is
26399 encrypted, or the CRAM-MD5 authentication method is used. In other words, it
26400 does not permit authentication methods that use cleartext passwords on
26401 unencrypted connections.
26402 .code
26403 acl_check_auth:
26404   accept encrypted = *
26405   accept condition = ${if eq{${uc:$smtp_command_argument}}\
26406                      {CRAM-MD5}}
26407   deny   message   = TLS encryption or CRAM-MD5 required
26408 .endd
26409 (Another way of applying this restriction is to arrange for the authenticators
26410 that use cleartext passwords not to be advertised when the connection is not
26411 encrypted. You can use the generic &%server_advertise_condition%& authenticator
26412 option to do this.)
26413
26414
26415
26416 .section "Format of an ACL" "SECID199"
26417 .cindex "&ACL;" "format of"
26418 .cindex "&ACL;" "verbs, definition of"
26419 An individual ACL consists of a number of statements. Each statement starts
26420 with a verb, optionally followed by a number of conditions and &"modifiers"&.
26421 Modifiers can change the way the verb operates, define error and log messages,
26422 set variables, insert delays, and vary the processing of accepted messages.
26423
26424 If all the conditions are met, the verb is obeyed. The same condition may be
26425 used (with different arguments) more than once in the same statement. This
26426 provides a means of specifying an &"and"& conjunction between conditions. For
26427 example:
26428 .code
26429 deny  dnslists = list1.example
26430 dnslists = list2.example
26431 .endd
26432 If there are no conditions, the verb is always obeyed. Exim stops evaluating
26433 the conditions and modifiers when it reaches a condition that fails. What
26434 happens then depends on the verb (and in one case, on a special modifier). Not
26435 all the conditions make sense at every testing point. For example, you cannot
26436 test a sender address in the ACL that is run for a VRFY command.
26437
26438
26439 .section "ACL verbs" "SECID200"
26440 The ACL verbs are as follows:
26441
26442 .ilist
26443 .cindex "&%accept%& ACL verb"
26444 &%accept%&: If all the conditions are met, the ACL returns &"accept"&. If any
26445 of the conditions are not met, what happens depends on whether &%endpass%&
26446 appears among the conditions (for syntax see below). If the failing condition
26447 is before &%endpass%&, control is passed to the next ACL statement; if it is
26448 after &%endpass%&, the ACL returns &"deny"&. Consider this statement, used to
26449 check a RCPT command:
26450 .code
26451 accept domains = +local_domains
26452 endpass
26453 verify = recipient
26454 .endd
26455 If the recipient domain does not match the &%domains%& condition, control
26456 passes to the next statement. If it does match, the recipient is verified, and
26457 the command is accepted if verification succeeds. However, if verification
26458 fails, the ACL yields &"deny"&, because the failing condition is after
26459 &%endpass%&.
26460
26461 The &%endpass%& feature has turned out to be confusing to many people, so its
26462 use is not recommended nowadays. It is always possible to rewrite an ACL so
26463 that &%endpass%& is not needed, and it is no longer used in the default
26464 configuration.
26465
26466 .cindex "&%message%& ACL modifier" "with &%accept%&"
26467 If a &%message%& modifier appears on an &%accept%& statement, its action
26468 depends on whether or not &%endpass%& is present. In the absence of &%endpass%&
26469 (when an &%accept%& verb either accepts or passes control to the next
26470 statement), &%message%& can be used to vary the message that is sent when an
26471 SMTP command is accepted. For example, in a RCPT ACL you could have:
26472 .display
26473 &`accept  `&<&'some conditions'&>
26474 &`        message = OK, I will allow you through today`&
26475 .endd
26476 You can specify an SMTP response code, optionally followed by an &"extended
26477 response code"& at the start of the message, but the first digit must be the
26478 same as would be sent by default, which is 2 for an &%accept%& verb.
26479
26480 If &%endpass%& is present in an &%accept%& statement, &%message%& specifies
26481 an error message that is used when access is denied. This behaviour is retained
26482 for backward compatibility, but current &"best practice"& is to avoid the use
26483 of &%endpass%&.
26484
26485
26486 .next
26487 .cindex "&%defer%& ACL verb"
26488 &%defer%&: If all the conditions are true, the ACL returns &"defer"& which, in
26489 an SMTP session, causes a 4&'xx'& response to be given. For a non-SMTP ACL,
26490 &%defer%& is the same as &%deny%&, because there is no way of sending a
26491 temporary error. For a RCPT command, &%defer%& is much the same as using a
26492 &(redirect)& router and &`:defer:`& while verifying, but the &%defer%& verb can
26493 be used in any ACL, and even for a recipient it might be a simpler approach.
26494
26495
26496 .next
26497 .cindex "&%deny%& ACL verb"
26498 &%deny%&: If all the conditions are met, the ACL returns &"deny"&. If any of
26499 the conditions are not met, control is passed to the next ACL statement. For
26500 example,
26501 .code
26502 deny dnslists = blackholes.mail-abuse.org
26503 .endd
26504 rejects commands from hosts that are on a DNS black list.
26505
26506
26507 .next
26508 .cindex "&%discard%& ACL verb"
26509 &%discard%&: This verb behaves like &%accept%&, except that it returns
26510 &"discard"& from the ACL instead of &"accept"&. It is permitted only on ACLs
26511 that are concerned with receiving messages. When all the conditions are true,
26512 the sending entity receives a &"success"& response. However, &%discard%& causes
26513 recipients to be discarded. If it is used in an ACL for RCPT, just the one
26514 recipient is discarded; if used for MAIL, DATA or in the non-SMTP ACL, all the
26515 message's recipients are discarded. Recipients that are discarded before DATA
26516 do not appear in the log line when the &%received_recipients%& log selector is set.
26517
26518 If the &%log_message%& modifier is set when &%discard%& operates,
26519 its contents are added to the line that is automatically written to the log.
26520 The &%message%& modifier operates exactly as it does for &%accept%&.
26521
26522
26523 .next
26524 .cindex "&%drop%& ACL verb"
26525 &%drop%&: This verb behaves like &%deny%&, except that an SMTP connection is
26526 forcibly closed after the 5&'xx'& error message has been sent. For example:
26527 .code
26528 drop   message   = I don't take more than 20 RCPTs
26529        condition = ${if > {$rcpt_count}{20}}
26530 .endd
26531 There is no difference between &%deny%& and &%drop%& for the connect-time ACL.
26532 The connection is always dropped after sending a 550 response.
26533
26534 .next
26535 .cindex "&%require%& ACL verb"
26536 &%require%&: If all the conditions are met, control is passed to the next ACL
26537 statement. If any of the conditions are not met, the ACL returns &"deny"&. For
26538 example, when checking a RCPT command,
26539 .code
26540 require message = Sender did not verify
26541         verify  = sender
26542 .endd
26543 passes control to subsequent statements only if the message's sender can be
26544 verified. Otherwise, it rejects the command. Note the positioning of the
26545 &%message%& modifier, before the &%verify%& condition. The reason for this is
26546 discussed in section &<<SECTcondmodproc>>&.
26547
26548 .next
26549 .cindex "&%warn%& ACL verb"
26550 &%warn%&: If all the conditions are true, a line specified by the
26551 &%log_message%& modifier is written to Exim's main log. Control always passes
26552 to the next ACL statement. If any condition is false, the log line is not
26553 written. If an identical log line is requested several times in the same
26554 message, only one copy is actually written to the log. If you want to force
26555 duplicates to be written, use the &%logwrite%& modifier instead.
26556
26557 If &%log_message%& is not present, a &%warn%& verb just checks its conditions
26558 and obeys any &"immediate"& modifiers (such as &%control%&, &%set%&,
26559 &%logwrite%&, &%add_header%&, and &%remove_header%&) that appear before the
26560 first failing condition. There is more about adding header lines in section
26561 &<<SECTaddheadacl>>&.
26562
26563 If any condition on a &%warn%& statement cannot be completed (that is, there is
26564 some sort of defer), the log line specified by &%log_message%& is not written.
26565 This does not include the case of a forced failure from a lookup, which
26566 is considered to be a successful completion. After a defer, no further
26567 conditions or modifiers in the &%warn%& statement are processed. The incident
26568 is logged, and the ACL continues to be processed, from the next statement
26569 onwards.
26570
26571
26572 .vindex "&$acl_verify_message$&"
26573 When one of the &%warn%& conditions is an address verification that fails, the
26574 text of the verification failure message is in &$acl_verify_message$&. If you
26575 want this logged, you must set it up explicitly. For example:
26576 .code
26577 warn   !verify = sender
26578        log_message = sender verify failed: $acl_verify_message
26579 .endd
26580 .endlist
26581
26582 At the end of each ACL there is an implicit unconditional &%deny%&.
26583
26584 As you can see from the examples above, the conditions and modifiers are
26585 written one to a line, with the first one on the same line as the verb, and
26586 subsequent ones on following lines. If you have a very long condition, you can
26587 continue it onto several physical lines by the usual backslash continuation
26588 mechanism. It is conventional to align the conditions vertically.
26589
26590
26591
26592 .section "ACL variables" "SECTaclvariables"
26593 .cindex "&ACL;" "variables"
26594 There are some special variables that can be set during ACL processing. They
26595 can be used to pass information between different ACLs, different invocations
26596 of the same ACL in the same SMTP connection, and between ACLs and the routers,
26597 transports, and filters that are used to deliver a message. The names of these
26598 variables must begin with &$acl_c$& or &$acl_m$&, followed either by a digit or
26599 an underscore, but the remainder of the name can be any sequence of
26600 alphanumeric characters and underscores that you choose. There is no limit on
26601 the number of ACL variables. The two sets act as follows:
26602 .ilist
26603 The values of those variables whose names begin with &$acl_c$& persist
26604 throughout an SMTP connection. They are never reset. Thus, a value that is set
26605 while receiving one message is still available when receiving the next message
26606 on the same SMTP connection.
26607 .next
26608 The values of those variables whose names begin with &$acl_m$& persist only
26609 while a message is being received. They are reset afterwards. They are also
26610 reset by MAIL, RSET, EHLO, HELO, and after starting up a TLS session.
26611 .endlist
26612
26613 When a message is accepted, the current values of all the ACL variables are
26614 preserved with the message and are subsequently made available at delivery
26615 time. The ACL variables are set by a modifier called &%set%&. For example:
26616 .code
26617 accept hosts = whatever
26618        set acl_m4 = some value
26619 accept authenticated = *
26620        set acl_c_auth = yes
26621 .endd
26622 &*Note*&: A leading dollar sign is not used when naming a variable that is to
26623 be set. If you want to set a variable without taking any action, you can use a
26624 &%warn%& verb without any other modifiers or conditions.
26625
26626 .oindex &%strict_acl_vars%&
26627 What happens if a syntactically valid but undefined ACL variable is
26628 referenced depends on the setting of the &%strict_acl_vars%& option. If it is
26629 false (the default), an empty string is substituted; if it is true, an
26630 error is generated.
26631
26632 Versions of Exim before 4.64 have a limited set of numbered variables, but
26633 their names are compatible, so there is no problem with upgrading.
26634
26635
26636 .section "Condition and modifier processing" "SECTcondmodproc"
26637 .cindex "&ACL;" "conditions; processing"
26638 .cindex "&ACL;" "modifiers; processing"
26639 An exclamation mark preceding a condition negates its result. For example:
26640 .code
26641 deny   domains = *.dom.example
26642       !verify  = recipient
26643 .endd
26644 causes the ACL to return &"deny"& if the recipient domain ends in
26645 &'dom.example'& and the recipient address cannot be verified. Sometimes
26646 negation can be used on the right-hand side of a condition. For example, these
26647 two statements are equivalent:
26648 .code
26649 deny  hosts = !192.168.3.4
26650 deny !hosts =  192.168.3.4
26651 .endd
26652 However, for many conditions (&%verify%& being a good example), only left-hand
26653 side negation of the whole condition is possible.
26654
26655 The arguments of conditions and modifiers are expanded. A forced failure
26656 of an expansion causes a condition to be ignored, that is, it behaves as if the
26657 condition is true. Consider these two statements:
26658 .code
26659 accept  senders = ${lookup{$host_name}lsearch\
26660                   {/some/file}{$value}fail}
26661 accept  senders = ${lookup{$host_name}lsearch\
26662                   {/some/file}{$value}{}}
26663 .endd
26664 Each attempts to look up a list of acceptable senders. If the lookup succeeds,
26665 the returned list is searched, but if the lookup fails the behaviour is
26666 different in the two cases. The &%fail%& in the first statement causes the
26667 condition to be ignored, leaving no further conditions. The &%accept%& verb
26668 therefore succeeds. The second statement, however, generates an empty list when
26669 the lookup fails. No sender can match an empty list, so the condition fails,
26670 and therefore the &%accept%& also fails.
26671
26672 ACL modifiers appear mixed in with conditions in ACL statements. Some of them
26673 specify actions that are taken as the conditions for a statement are checked;
26674 others specify text for messages that are used when access is denied or a
26675 warning is generated. The &%control%& modifier affects the way an incoming
26676 message is handled.
26677
26678 The positioning of the modifiers in an ACL statement is important, because the
26679 processing of a verb ceases as soon as its outcome is known. Only those
26680 modifiers that have already been encountered will take effect. For example,
26681 consider this use of the &%message%& modifier:
26682 .code
26683 require message = Can't verify sender
26684         verify  = sender
26685         message = Can't verify recipient
26686         verify  = recipient
26687         message = This message cannot be used
26688 .endd
26689 If sender verification fails, Exim knows that the result of the statement is
26690 &"deny"&, so it goes no further. The first &%message%& modifier has been seen,
26691 so its text is used as the error message. If sender verification succeeds, but
26692 recipient verification fails, the second message is used. If recipient
26693 verification succeeds, the third message becomes &"current"&, but is never used
26694 because there are no more conditions to cause failure.
26695
26696 For the &%deny%& verb, on the other hand, it is always the last &%message%&
26697 modifier that is used, because all the conditions must be true for rejection to
26698 happen. Specifying more than one &%message%& modifier does not make sense, and
26699 the message can even be specified after all the conditions. For example:
26700 .code
26701 deny   hosts = ...
26702       !senders = *@my.domain.example
26703        message = Invalid sender from client host
26704 .endd
26705 The &"deny"& result does not happen until the end of the statement is reached,
26706 by which time Exim has set up the message.
26707
26708
26709
26710 .section "ACL modifiers" "SECTACLmodi"
26711 .cindex "&ACL;" "modifiers; list of"
26712 The ACL modifiers are as follows:
26713
26714 .vlist
26715 .vitem &*add_header*&&~=&~<&'text'&>
26716 This modifier specifies one or more header lines that are to be added to an
26717 incoming message, assuming, of course, that the message is ultimately
26718 accepted. For details, see section &<<SECTaddheadacl>>&.
26719
26720 .vitem &*continue*&&~=&~<&'text'&>
26721 .cindex "&%continue%& ACL modifier"
26722 .cindex "database" "updating in ACL"
26723 This modifier does nothing of itself, and processing of the ACL always
26724 continues with the next condition or modifier. The value of &%continue%& is in
26725 the side effects of expanding its argument. Typically this could be used to
26726 update a database. It is really just a syntactic tidiness, to avoid having to
26727 write rather ugly lines like this:
26728 .display
26729 &`condition = ${if eq{0}{`&<&'some expansion'&>&`}{true}{true}}`&
26730 .endd
26731 Instead, all you need is
26732 .display
26733 &`continue = `&<&'some expansion'&>
26734 .endd
26735
26736 .vitem &*control*&&~=&~<&'text'&>
26737 .cindex "&%control%& ACL modifier"
26738 This modifier affects the subsequent processing of the SMTP connection or of an
26739 incoming message that is accepted. The effect of the first type of control
26740 lasts for the duration of the connection, whereas the effect of the second type
26741 lasts only until the current message has been received. The message-specific
26742 controls always apply to the whole message, not to individual recipients,
26743 even if the &%control%& modifier appears in a RCPT ACL.
26744
26745 As there are now quite a few controls that can be applied, they are described
26746 separately in section &<<SECTcontrols>>&. The &%control%& modifier can be used
26747 in several different ways. For example:
26748
26749 . ==== As this is a nested list, any displays it contains must be indented
26750 . ==== as otherwise they are too far to the left. That comment applies only
26751 . ==== when xmlto and fop are used; formatting with sdop gets it right either
26752 . ==== way.
26753
26754 .ilist
26755 It can be at the end of an &%accept%& statement:
26756 .code
26757     accept  ...some conditions
26758             control = queue_only
26759 .endd
26760 In this case, the control is applied when this statement yields &"accept"&, in
26761 other words, when the conditions are all true.
26762
26763 .next
26764 It can be in the middle of an &%accept%& statement:
26765 .code
26766     accept  ...some conditions...
26767             control = queue_only
26768             ...some more conditions...
26769 .endd
26770 If the first set of conditions are true, the control is applied, even if the
26771 statement does not accept because one of the second set of conditions is false.
26772 In this case, some subsequent statement must yield &"accept"& for the control
26773 to be relevant.
26774
26775 .next
26776 It can be used with &%warn%& to apply the control, leaving the
26777 decision about accepting or denying to a subsequent verb. For
26778 example:
26779 .code
26780     warn    ...some conditions...
26781             control = freeze
26782     accept  ...
26783 .endd
26784 This example of &%warn%& does not contain &%message%&, &%log_message%&, or
26785 &%logwrite%&, so it does not add anything to the message and does not write a
26786 log entry.
26787
26788 .next
26789 If you want to apply a control unconditionally, you can use it with a
26790 &%require%& verb. For example:
26791 .code
26792     require  control = no_multiline_responses
26793 .endd
26794 .endlist
26795
26796 .vitem &*delay*&&~=&~<&'time'&>
26797 .cindex "&%delay%& ACL modifier"
26798 .oindex "&%-bh%&"
26799 This modifier may appear in any ACL except notquit. It causes Exim to wait for
26800 the time interval before proceeding. However, when testing Exim using the
26801 &%-bh%& option, the delay is not actually imposed (an appropriate message is
26802 output instead). The time is given in the usual Exim notation, and the delay
26803 happens as soon as the modifier is processed. In an SMTP session, pending
26804 output is flushed before the delay is imposed.
26805
26806 Like &%control%&, &%delay%& can be used with &%accept%& or &%deny%&, for
26807 example:
26808 .code
26809 deny    ...some conditions...
26810         delay = 30s
26811 .endd
26812 The delay happens if all the conditions are true, before the statement returns
26813 &"deny"&. Compare this with:
26814 .code
26815 deny    delay = 30s
26816         ...some conditions...
26817 .endd
26818 which waits for 30s before processing the conditions. The &%delay%& modifier
26819 can also be used with &%warn%& and together with &%control%&:
26820 .code
26821 warn    ...some conditions...
26822         delay = 2m
26823         control = freeze
26824 accept  ...
26825 .endd
26826
26827 If &%delay%& is encountered when the SMTP PIPELINING extension is in use,
26828 responses to several commands are no longer buffered and sent in one packet (as
26829 they would normally be) because all output is flushed before imposing the
26830 delay. This optimization is disabled so that a number of small delays do not
26831 appear to the client as one large aggregated delay that might provoke an
26832 unwanted timeout. You can, however, disable output flushing for &%delay%& by
26833 using a &%control%& modifier to set &%no_delay_flush%&.
26834
26835
26836 .vitem &*endpass*&
26837 .cindex "&%endpass%& ACL modifier"
26838 This modifier, which has no argument, is recognized only in &%accept%& and
26839 &%discard%& statements. It marks the boundary between the conditions whose
26840 failure causes control to pass to the next statement, and the conditions whose
26841 failure causes the ACL to return &"deny"&. This concept has proved to be
26842 confusing to some people, so the use of &%endpass%& is no longer recommended as
26843 &"best practice"&. See the description of &%accept%& above for more details.
26844
26845
26846 .vitem &*log_message*&&~=&~<&'text'&>
26847 .cindex "&%log_message%& ACL modifier"
26848 This modifier sets up a message that is used as part of the log message if the
26849 ACL denies access or a &%warn%& statement's conditions are true. For example:
26850 .code
26851 require log_message = wrong cipher suite $tls_in_cipher
26852         encrypted   = DES-CBC3-SHA
26853 .endd
26854 &%log_message%& is also used when recipients are discarded by &%discard%&. For
26855 example:
26856 .display
26857 &`discard `&<&'some conditions'&>
26858 &`        log_message = Discarded $local_part@$domain because...`&
26859 .endd
26860 When access is denied, &%log_message%& adds to any underlying error message
26861 that may exist because of a condition failure. For example, while verifying a
26862 recipient address, a &':fail:'& redirection might have already set up a
26863 message.
26864
26865 The message may be defined before the conditions to which it applies, because
26866 the string expansion does not happen until Exim decides that access is to be
26867 denied. This means that any variables that are set by the condition are
26868 available for inclusion in the message. For example, the &$dnslist_$&<&'xxx'&>
26869 variables are set after a DNS black list lookup succeeds. If the expansion of
26870 &%log_message%& fails, or if the result is an empty string, the modifier is
26871 ignored.
26872
26873 .vindex "&$acl_verify_message$&"
26874 If you want to use a &%warn%& statement to log the result of an address
26875 verification, you can use &$acl_verify_message$& to include the verification
26876 error message.
26877
26878 If &%log_message%& is used with a &%warn%& statement, &"Warning:"& is added to
26879 the start of the logged message. If the same warning log message is requested
26880 more than once while receiving  a single email message, only one copy is
26881 actually logged. If you want to log multiple copies, use &%logwrite%& instead
26882 of &%log_message%&. In the absence of &%log_message%& and &%logwrite%&, nothing
26883 is logged for a successful &%warn%& statement.
26884
26885 If &%log_message%& is not present and there is no underlying error message (for
26886 example, from the failure of address verification), but &%message%& is present,
26887 the &%message%& text is used for logging rejections. However, if any text for
26888 logging contains newlines, only the first line is logged. In the absence of
26889 both &%log_message%& and &%message%&, a default built-in message is used for
26890 logging rejections.
26891
26892
26893 .vitem "&*log_reject_target*&&~=&~<&'log name list'&>"
26894 .cindex "&%log_reject_target%& ACL modifier"
26895 .cindex "logging in ACL" "specifying which log"
26896 This modifier makes it possible to specify which logs are used for messages
26897 about ACL rejections. Its argument is a colon-separated list of words that can
26898 be &"main"&, &"reject"&, or &"panic"&. The default is &`main:reject`&. The list
26899 may be empty, in which case a rejection is not logged at all. For example, this
26900 ACL fragment writes no logging information when access is denied:
26901 .display
26902 &`deny `&<&'some conditions'&>
26903 &`     log_reject_target =`&
26904 .endd
26905 This modifier can be used in SMTP and non-SMTP ACLs. It applies to both
26906 permanent and temporary rejections. Its effect lasts for the rest of the
26907 current ACL.
26908
26909
26910 .vitem &*logwrite*&&~=&~<&'text'&>
26911 .cindex "&%logwrite%& ACL modifier"
26912 .cindex "logging in ACL" "immediate"
26913 This modifier writes a message to a log file as soon as it is encountered when
26914 processing an ACL. (Compare &%log_message%&, which, except in the case of
26915 &%warn%& and &%discard%&, is used only if the ACL statement denies
26916 access.) The &%logwrite%& modifier can be used to log special incidents in
26917 ACLs. For example:
26918 .display
26919 &`accept `&<&'some special conditions'&>
26920 &`       control  = freeze`&
26921 &`       logwrite = froze message because ...`&
26922 .endd
26923 By default, the message is written to the main log. However, it may begin
26924 with a colon, followed by a comma-separated list of log names, and then
26925 another colon, to specify exactly which logs are to be written. For
26926 example:
26927 .code
26928 logwrite = :main,reject: text for main and reject logs
26929 logwrite = :panic: text for panic log only
26930 .endd
26931
26932
26933 .vitem &*message*&&~=&~<&'text'&>
26934 .cindex "&%message%& ACL modifier"
26935 This modifier sets up a text string that is expanded and used as a response
26936 message when an ACL statement terminates the ACL with an &"accept"&, &"deny"&,
26937 or &"defer"& response. (In the case of the &%accept%& and &%discard%& verbs,
26938 there is some complication if &%endpass%& is involved; see the description of
26939 &%accept%& for details.)
26940
26941 The expansion of the message happens at the time Exim decides that the ACL is
26942 to end, not at the time it processes &%message%&. If the expansion fails, or
26943 generates an empty string, the modifier is ignored. Here is an example where
26944 &%message%& must be specified first, because the ACL ends with a rejection if
26945 the &%hosts%& condition fails:
26946 .code
26947 require  message = Host not recognized
26948          hosts = 10.0.0.0/8
26949 .endd
26950 (Once a condition has failed, no further conditions or modifiers are
26951 processed.)
26952
26953 .cindex "SMTP" "error codes"
26954 .oindex "&%smtp_banner%&
26955 For ACLs that are triggered by SMTP commands, the message is returned as part
26956 of the SMTP response. The use of &%message%& with &%accept%& (or &%discard%&)
26957 is meaningful only for SMTP, as no message is returned when a non-SMTP message
26958 is accepted. In the case of the connect ACL, accepting with a message modifier
26959 overrides the value of &%smtp_banner%&. For the EHLO/HELO ACL, a customized
26960 accept message may not contain more than one line (otherwise it will be
26961 truncated at the first newline and a panic logged), and it cannot affect the
26962 EHLO options.
26963
26964 When SMTP is involved, the message may begin with an overriding response code,
26965 consisting of three digits optionally followed by an &"extended response code"&
26966 of the form &'n.n.n'&, each code being followed by a space. For example:
26967 .code
26968 deny  message = 599 1.2.3 Host not welcome
26969       hosts = 192.168.34.0/24
26970 .endd
26971 The first digit of the supplied response code must be the same as would be sent
26972 by default. A panic occurs if it is not. Exim uses a 550 code when it denies
26973 access, but for the predata ACL, note that the default success code is 354, not
26974 2&'xx'&.
26975
26976 Notwithstanding the previous paragraph, for the QUIT ACL, unlike the others,
26977 the message modifier cannot override the 221 response code.
26978
26979 The text in a &%message%& modifier is literal; any quotes are taken as
26980 literals, but because the string is expanded, backslash escapes are processed
26981 anyway. If the message contains newlines, this gives rise to a multi-line SMTP
26982 response.
26983
26984 .vindex "&$acl_verify_message$&"
26985 If &%message%& is used on a statement that verifies an address, the message
26986 specified overrides any message that is generated by the verification process.
26987 However, the original message is available in the variable
26988 &$acl_verify_message$&, so you can incorporate it into your message if you
26989 wish. In particular, if you want the text from &%:fail:%& items in &(redirect)&
26990 routers to be passed back as part of the SMTP response, you should either not
26991 use a &%message%& modifier, or make use of &$acl_verify_message$&.
26992
26993 For compatibility with previous releases of Exim, a &%message%& modifier that
26994 is used with a &%warn%& verb behaves in a similar way to the &%add_header%&
26995 modifier, but this usage is now deprecated. However, &%message%& acts only when
26996 all the conditions are true, wherever it appears in an ACL command, whereas
26997 &%add_header%& acts as soon as it is encountered. If &%message%& is used with
26998 &%warn%& in an ACL that is not concerned with receiving a message, it has no
26999 effect.
27000
27001
27002 .vitem &*remove_header*&&~=&~<&'text'&>
27003 This modifier specifies one or more header names in a colon-separated list
27004  that are to be removed from an incoming message, assuming, of course, that
27005 the message is ultimately accepted. For details, see section &<<SECTremoveheadacl>>&.
27006
27007
27008 .vitem &*set*&&~<&'acl_name'&>&~=&~<&'value'&>
27009 .cindex "&%set%& ACL modifier"
27010 This modifier puts a value into one of the ACL variables (see section
27011 &<<SECTaclvariables>>&).
27012 .endlist
27013
27014
27015
27016
27017
27018 .section "Use of the control modifier" "SECTcontrols"
27019 .cindex "&%control%& ACL modifier"
27020 The &%control%& modifier supports the following settings:
27021
27022 .vlist
27023 .vitem &*control&~=&~allow_auth_unadvertised*&
27024 This modifier allows a client host to use the SMTP AUTH command even when it
27025 has not been advertised in response to EHLO. Furthermore, because there are
27026 apparently some really broken clients that do this, Exim will accept AUTH after
27027 HELO (rather than EHLO) when this control is set. It should be used only if you
27028 really need it, and you should limit its use to those broken clients that do
27029 not work without it. For example:
27030 .code
27031 warn hosts   = 192.168.34.25
27032      control = allow_auth_unadvertised
27033 .endd
27034 Normally, when an Exim server receives an AUTH command, it checks the name of
27035 the authentication mechanism that is given in the command to ensure that it
27036 matches an advertised mechanism. When this control is set, the check that a
27037 mechanism has been advertised is bypassed. Any configured mechanism can be used
27038 by the client. This control is permitted only in the connection and HELO ACLs.
27039
27040
27041 .vitem &*control&~=&~caseful_local_part*& &&&
27042        &*control&~=&~caselower_local_part*&
27043 .cindex "&ACL;" "case of local part in"
27044 .cindex "case of local parts"
27045 .vindex "&$local_part$&"
27046 These two controls are permitted only in the ACL specified by &%acl_smtp_rcpt%&
27047 (that is, during RCPT processing). By default, the contents of &$local_part$&
27048 are lower cased before ACL processing. If &"caseful_local_part"& is specified,
27049 any uppercase letters in the original local part are restored in &$local_part$&
27050 for the rest of the ACL, or until a control that sets &"caselower_local_part"&
27051 is encountered.
27052
27053 These controls affect only the current recipient. Moreover, they apply only to
27054 local part handling that takes place directly in the ACL (for example, as a key
27055 in lookups). If a test to verify the recipient is obeyed, the case-related
27056 handling of the local part during the verification is controlled by the router
27057 configuration (see the &%caseful_local_part%& generic router option).
27058
27059 This facility could be used, for example, to add a spam score to local parts
27060 containing upper case letters. For example, using &$acl_m4$& to accumulate the
27061 spam score:
27062 .code
27063 warn  control = caseful_local_part
27064       set acl_m4 = ${eval:\
27065                      $acl_m4 + \
27066                      ${if match{$local_part}{[A-Z]}{1}{0}}\
27067                     }
27068       control = caselower_local_part
27069 .endd
27070 Notice that we put back the lower cased version afterwards, assuming that
27071 is what is wanted for subsequent tests.
27072
27073
27074 .new
27075 .vitem &*control&~=&~cutthrough_delivery*&
27076 .cindex "&ACL;" "cutthrough routing"
27077 .cindex "cutthrough" "requesting"
27078 This option requests delivery be attempted while the item is being received.
27079 It is usable in the RCPT ACL and valid only for single-recipient mails forwarded
27080 from one SMTP connection to another.  If a recipient-verify callout connection is
27081 requested in the same ACL it is held open and used for the data, otherwise one is made
27082 after the ACL completes.  Note that routers are used in verify mode.
27083
27084 Should the ultimate destination system positively accept or reject the mail,
27085 a corresponding indication is given to the source system and nothing is queued.
27086 If there is a temporary error the item is queued for later delivery in the
27087 usual fashion. If the item is successfully delivered in cutthrough mode the log line
27088 is tagged with ">>" rather than "=>" and appears before the acceptance "<="
27089 line.
27090
27091 Delivery in this mode avoids the generation of a bounce mail to a (possibly faked)
27092 sender when the destination system is doing content-scan based rejection.
27093 .wen
27094
27095
27096 .new
27097 .vitem &*control&~=&~debug/*&<&'options'&>
27098 .cindex "&ACL;" "enabling debug logging"
27099 .cindex "debugging" "enabling from an ACL"
27100 This control turns on debug logging, almost as though Exim had been invoked
27101 with &`-d`&, with the output going to a new logfile, by default called
27102 &'debuglog'&.  The filename can be adjusted with the &'tag'& option, which
27103 may access any variables already defined.  The logging may be adjusted with
27104 the &'opts'& option, which takes the same values as the &`-d`& command-line
27105 option.  Some examples (which depend on variables that don't exist in all
27106 contexts):
27107 .code
27108       control = debug
27109       control = debug/tag=.$sender_host_address
27110       control = debug/opts=+expand+acl
27111       control = debug/tag=.$message_exim_id/opts=+expand
27112 .endd
27113 .wen
27114
27115
27116 .new
27117 .vitem &*control&~=&~dkim_disable_verify*&
27118 .cindex "disable DKIM verify"
27119 .cindex "DKIM" "disable verify"
27120 This control turns off DKIM verification processing entirely.  For details on
27121 the operation and configuration of DKIM, see chapter &<<CHAPdkim>>&.
27122 .wen
27123
27124
27125 .new
27126 .vitem &*control&~=&~dscp/*&<&'value'&>
27127 .cindex "&ACL;" "setting DSCP value"
27128 .cindex "DSCP" "inbound"
27129 This option causes the DSCP value associated with the socket for the inbound
27130 connection to be adjusted to a given value, given as one of a number of fixed
27131 strings or to numeric value.
27132 The &%-bI:dscp%& option may be used to ask Exim which names it knows of.
27133 Common values include &`throughput`&, &`mincost`&, and on newer systems
27134 &`ef`&, &`af41`&, etc.  Numeric values may be in the range 0 to 0x3F.
27135
27136 The outbound packets from Exim will be marked with this value in the header
27137 (for IPv4, the TOS field; for IPv6, the TCLASS field); there is no guarantee
27138 that these values will have any effect, not be stripped by networking
27139 equipment, or do much of anything without cooperation with your Network
27140 Engineer and those of all network operators between the source and destination.
27141 .wen
27142
27143
27144 .vitem &*control&~=&~enforce_sync*& &&&
27145        &*control&~=&~no_enforce_sync*&
27146 .cindex "SMTP" "synchronization checking"
27147 .cindex "synchronization checking in SMTP"
27148 These controls make it possible to be selective about when SMTP synchronization
27149 is enforced. The global option &%smtp_enforce_sync%& specifies the initial
27150 state of the switch (it is true by default). See the description of this option
27151 in chapter &<<CHAPmainconfig>>& for details of SMTP synchronization checking.
27152
27153 The effect of these two controls lasts for the remainder of the SMTP
27154 connection. They can appear in any ACL except the one for the non-SMTP
27155 messages. The most straightforward place to put them is in the ACL defined by
27156 &%acl_smtp_connect%&, which is run at the start of an incoming SMTP connection,
27157 before the first synchronization check. The expected use is to turn off the
27158 synchronization checks for badly-behaved hosts that you nevertheless need to
27159 work with.
27160
27161
27162 .vitem &*control&~=&~fakedefer/*&<&'message'&>
27163 .cindex "fake defer"
27164 .cindex "defer, fake"
27165 This control works in exactly the same way as &%fakereject%& (described below)
27166 except that it causes an SMTP 450 response after the message data instead of a
27167 550 response. You must take care when using &%fakedefer%& because it causes the
27168 messages to be duplicated when the sender retries. Therefore, you should not
27169 use &%fakedefer%& if the message is to be delivered normally.
27170
27171 .vitem &*control&~=&~fakereject/*&<&'message'&>
27172 .cindex "fake rejection"
27173 .cindex "rejection, fake"
27174 This control is permitted only for the MAIL, RCPT, and DATA ACLs, in other
27175 words, only when an SMTP message is being received. If Exim accepts the
27176 message, instead the final 250 response, a 550 rejection message is sent.
27177 However, Exim proceeds to deliver the message as normal. The control applies
27178 only to the current message, not to any subsequent ones that may be received in
27179 the same SMTP connection.
27180
27181 The text for the 550 response is taken from the &%control%& modifier. If no
27182 message is supplied, the following is used:
27183 .code
27184 550-Your message has been rejected but is being
27185 550-kept for evaluation.
27186 550-If it was a legitimate message, it may still be
27187 550 delivered to the target recipient(s).
27188 .endd
27189 This facility should be used with extreme caution.
27190
27191 .vitem &*control&~=&~freeze*&
27192 .cindex "frozen messages" "forcing in ACL"
27193 This control is permitted only for the MAIL, RCPT, DATA, and non-SMTP ACLs, in
27194 other words, only when a message is being received. If the message is accepted,
27195 it is placed on Exim's queue and frozen. The control applies only to the
27196 current message, not to any subsequent ones that may be received in the same
27197 SMTP connection.
27198
27199 This modifier can optionally be followed by &`/no_tell`&. If the global option
27200 &%freeze_tell%& is set, it is ignored for the current message (that is, nobody
27201 is told about the freezing), provided all the &*control=freeze*& modifiers that
27202 are obeyed for the current message have the &`/no_tell`& option.
27203
27204 .vitem &*control&~=&~no_delay_flush*&
27205 .cindex "SMTP" "output flushing, disabling for delay"
27206 Exim normally flushes SMTP output before implementing a delay in an ACL, to
27207 avoid unexpected timeouts in clients when the SMTP PIPELINING extension is in
27208 use. This control, as long as it is encountered before the &%delay%& modifier,
27209 disables such output flushing.
27210
27211 .vitem &*control&~=&~no_callout_flush*&
27212 .cindex "SMTP" "output flushing, disabling for callout"
27213 Exim normally flushes SMTP output before performing a callout in an ACL, to
27214 avoid unexpected timeouts in clients when the SMTP PIPELINING extension is in
27215 use. This control, as long as it is encountered before the &%verify%& condition
27216 that causes the callout, disables such output flushing.
27217
27218 .vitem &*control&~=&~no_mbox_unspool*&
27219 This control is available when Exim is compiled with the content scanning
27220 extension. Content scanning may require a copy of the current message, or parts
27221 of it, to be written in &"mbox format"& to a spool file, for passing to a virus
27222 or spam scanner. Normally, such copies are deleted when they are no longer
27223 needed. If this control is set, the copies are not deleted. The control applies
27224 only to the current message, not to any subsequent ones that may be received in
27225 the same SMTP connection. It is provided for debugging purposes and is unlikely
27226 to be useful in production.
27227
27228 .vitem &*control&~=&~no_multiline_responses*&
27229 .cindex "multiline responses, suppressing"
27230 This control is permitted for any ACL except the one for non-SMTP messages.
27231 It seems that there are broken clients in use that cannot handle multiline
27232 SMTP responses, despite the fact that RFC 821 defined them over 20 years ago.
27233
27234 If this control is set, multiline SMTP responses from ACL rejections are
27235 suppressed. One way of doing this would have been to put out these responses as
27236 one long line. However, RFC 2821 specifies a maximum of 512 bytes per response
27237 (&"use multiline responses for more"& it says &-- ha!), and some of the
27238 responses might get close to that. So this facility, which is after all only a
27239 sop to broken clients, is implemented by doing two very easy things:
27240
27241 .ilist
27242 Extra information that is normally output as part of a rejection caused by
27243 sender verification failure is omitted. Only the final line (typically &"sender
27244 verification failed"&) is sent.
27245 .next
27246 If a &%message%& modifier supplies a multiline response, only the first
27247 line is output.
27248 .endlist
27249
27250 The setting of the switch can, of course, be made conditional on the
27251 calling host. Its effect lasts until the end of the SMTP connection.
27252
27253 .vitem &*control&~=&~no_pipelining*&
27254 .cindex "PIPELINING" "suppressing advertising"
27255 This control turns off the advertising of the PIPELINING extension to SMTP in
27256 the current session. To be useful, it must be obeyed before Exim sends its
27257 response to an EHLO command. Therefore, it should normally appear in an ACL
27258 controlled by &%acl_smtp_connect%& or &%acl_smtp_helo%&. See also
27259 &%pipelining_advertise_hosts%&.
27260
27261 .vitem &*control&~=&~queue_only*&
27262 .oindex "&%queue_only%&"
27263 .cindex "queueing incoming messages"
27264 This control is permitted only for the MAIL, RCPT, DATA, and non-SMTP ACLs, in
27265 other words, only when a message is being received. If the message is accepted,
27266 it is placed on Exim's queue and left there for delivery by a subsequent queue
27267 runner. No immediate delivery process is started. In other words, it has the
27268 effect as the &%queue_only%& global option. However, the control applies only
27269 to the current message, not to any subsequent ones that may be received in the
27270 same SMTP connection.
27271
27272 .vitem &*control&~=&~submission/*&<&'options'&>
27273 .cindex "message" "submission"
27274 .cindex "submission mode"
27275 This control is permitted only for the MAIL, RCPT, and start of data ACLs (the
27276 latter is the one defined by &%acl_smtp_predata%&). Setting it tells Exim that
27277 the current message is a submission from a local MUA. In this case, Exim
27278 operates in &"submission mode"&, and applies certain fixups to the message if
27279 necessary. For example, it adds a &'Date:'& header line if one is not present.
27280 This control is not permitted in the &%acl_smtp_data%& ACL, because that is too
27281 late (the message has already been created).
27282
27283 Chapter &<<CHAPmsgproc>>& describes the processing that Exim applies to
27284 messages. Section &<<SECTsubmodnon>>& covers the processing that happens in
27285 submission mode; the available options for this control are described there.
27286 The control applies only to the current message, not to any subsequent ones
27287 that may be received in the same SMTP connection.
27288
27289 .vitem &*control&~=&~suppress_local_fixups*&
27290 .cindex "submission fixups, suppressing"
27291 This control applies to locally submitted (non TCP/IP) messages, and is the
27292 complement of &`control = submission`&. It disables the fixups that are
27293 normally applied to locally-submitted messages. Specifically:
27294
27295 .ilist
27296 Any &'Sender:'& header line is left alone (in this respect, it is a
27297 dynamic version of &%local_sender_retain%&).
27298 .next
27299 No &'Message-ID:'&, &'From:'&, or &'Date:'& header lines are added.
27300 .next
27301 There is no check that &'From:'& corresponds to the actual sender.
27302 .endlist ilist
27303
27304 This control may be useful when a remotely-originated message is accepted,
27305 passed to some scanning program, and then re-submitted for delivery. It can be
27306 used only in the &%acl_smtp_mail%&, &%acl_smtp_rcpt%&, &%acl_smtp_predata%&,
27307 and &%acl_not_smtp_start%& ACLs, because it has to be set before the message's
27308 data is read.
27309
27310 &*Note:*& This control applies only to the current message, not to any others
27311 that are being submitted at the same time using &%-bs%& or &%-bS%&.
27312 .endlist vlist
27313
27314
27315 .section "Summary of message fixup control" "SECTsummesfix"
27316 All four possibilities for message fixups can be specified:
27317
27318 .ilist
27319 Locally submitted, fixups applied: the default.
27320 .next
27321 Locally submitted, no fixups applied: use
27322 &`control = suppress_local_fixups`&.
27323 .next
27324 Remotely submitted, no fixups applied: the default.
27325 .next
27326 Remotely submitted, fixups applied: use &`control = submission`&.
27327 .endlist
27328
27329
27330
27331 .section "Adding header lines in ACLs" "SECTaddheadacl"
27332 .cindex "header lines" "adding in an ACL"
27333 .cindex "header lines" "position of added lines"
27334 .cindex "&%add_header%& ACL modifier"
27335 The &%add_header%& modifier can be used to add one or more extra header lines
27336 to an incoming message, as in this example:
27337 .code
27338 warn dnslists = sbl.spamhaus.org : \
27339                 dialup.mail-abuse.org
27340      add_header = X-blacklisted-at: $dnslist_domain
27341 .endd
27342 The &%add_header%& modifier is permitted in the MAIL, RCPT, PREDATA, DATA,
27343 MIME, and non-SMTP ACLs (in other words, those that are concerned with
27344 receiving a message). The message must ultimately be accepted for
27345 &%add_header%& to have any significant effect. You can use &%add_header%& with
27346 any ACL verb, including &%deny%& (though this is potentially useful only in a
27347 RCPT ACL).
27348
27349 Leading and trailing newlines are removed from
27350 the data for the &%add_header%& modifier; if it then
27351 contains one or more newlines that
27352 are not followed by a space or a tab, it is assumed to contain multiple header
27353 lines. Each one is checked for valid syntax; &`X-ACL-Warn:`& is added to the
27354 front of any line that is not a valid header line.
27355
27356 Added header lines are accumulated during the MAIL, RCPT, and predata ACLs.
27357 They are added to the message before processing the DATA and MIME ACLs.
27358 However, if an identical header line is requested more than once, only one copy
27359 is actually added to the message. Further header lines may be accumulated
27360 during the DATA and MIME ACLs, after which they are added to the message, again
27361 with duplicates suppressed. Thus, it is possible to add two identical header
27362 lines to an SMTP message, but only if one is added before DATA and one after.
27363 In the case of non-SMTP messages, new headers are accumulated during the
27364 non-SMTP ACLs, and are added to the message after all the ACLs have run. If a
27365 message is rejected after DATA or by the non-SMTP ACL, all added header lines
27366 are included in the entry that is written to the reject log.
27367
27368 .cindex "header lines" "added; visibility of"
27369 Header lines are not visible in string expansions
27370 of message headers
27371 until they are added to the
27372 message. It follows that header lines defined in the MAIL, RCPT, and predata
27373 ACLs are not visible until the DATA ACL and MIME ACLs are run. Similarly,
27374 header lines that are added by the DATA or MIME ACLs are not visible in those
27375 ACLs. Because of this restriction, you cannot use header lines as a way of
27376 passing data between (for example) the MAIL and RCPT ACLs. If you want to do
27377 this, you can use ACL variables, as described in section
27378 &<<SECTaclvariables>>&.
27379
27380 The list of headers yet to be added is given by the &%$headers_added%& variable.
27381
27382 The &%add_header%& modifier acts immediately as it is encountered during the
27383 processing of an ACL. Notice the difference between these two cases:
27384 .display
27385 &`accept add_header = ADDED: some text`&
27386 &`       `&<&'some condition'&>
27387
27388 &`accept `&<&'some condition'&>
27389 &`       add_header = ADDED: some text`&
27390 .endd
27391 In the first case, the header line is always added, whether or not the
27392 condition is true. In the second case, the header line is added only if the
27393 condition is true. Multiple occurrences of &%add_header%& may occur in the same
27394 ACL statement. All those that are encountered before a condition fails are
27395 honoured.
27396
27397 .cindex "&%warn%& ACL verb"
27398 For compatibility with previous versions of Exim, a &%message%& modifier for a
27399 &%warn%& verb acts in the same way as &%add_header%&, except that it takes
27400 effect only if all the conditions are true, even if it appears before some of
27401 them. Furthermore, only the last occurrence of &%message%& is honoured. This
27402 usage of &%message%& is now deprecated. If both &%add_header%& and &%message%&
27403 are present on a &%warn%& verb, both are processed according to their
27404 specifications.
27405
27406 By default, new header lines are added to a message at the end of the existing
27407 header lines. However, you can specify that any particular header line should
27408 be added right at the start (before all the &'Received:'& lines), immediately
27409 after the first block of &'Received:'& lines, or immediately before any line
27410 that is not a &'Received:'& or &'Resent-something:'& header.
27411
27412 This is done by specifying &":at_start:"&, &":after_received:"&, or
27413 &":at_start_rfc:"& (or, for completeness, &":at_end:"&) before the text of the
27414 header line, respectively. (Header text cannot start with a colon, as there has
27415 to be a header name first.) For example:
27416 .code
27417 warn add_header = \
27418        :after_received:X-My-Header: something or other...
27419 .endd
27420 If more than one header line is supplied in a single &%add_header%& modifier,
27421 each one is treated independently and can therefore be placed differently. If
27422 you add more than one line at the start, or after the Received: block, they end
27423 up in reverse order.
27424
27425 &*Warning*&: This facility currently applies only to header lines that are
27426 added in an ACL. It does NOT work for header lines that are added in a
27427 system filter or in a router or transport.
27428
27429
27430
27431 .section "Removing header lines in ACLs" "SECTremoveheadacl"
27432 .cindex "header lines" "removing in an ACL"
27433 .cindex "header lines" "position of removed lines"
27434 .cindex "&%remove_header%& ACL modifier"
27435 The &%remove_header%& modifier can be used to remove one or more header lines
27436 from an incoming message, as in this example:
27437 .code
27438 warn   message        = Remove internal headers
27439        remove_header  = x-route-mail1 : x-route-mail2
27440 .endd
27441 The &%remove_header%& modifier is permitted in the MAIL, RCPT, PREDATA, DATA,
27442 MIME, and non-SMTP ACLs (in other words, those that are concerned with
27443 receiving a message). The message must ultimately be accepted for
27444 &%remove_header%& to have any significant effect. You can use &%remove_header%&
27445 with any ACL verb, including &%deny%&, though this is really not useful for
27446 any verb that doesn't result in a delivered message.
27447
27448 More than one header can be removed at the same time by using a colon separated
27449 list of header names. The header matching is case insensitive. Wildcards are
27450 not permitted, nor is list expansion performed, so you cannot use hostlists to
27451 create a list of headers, however both connection and message variable expansion
27452 are performed (&%$acl_c_*%& and &%$acl_m_*%&), illustrated in this example:
27453 .code
27454 warn   hosts           = +internal_hosts
27455        set acl_c_ihdrs = x-route-mail1 : x-route-mail2
27456 warn   message         = Remove internal headers
27457        remove_header   = $acl_c_ihdrs
27458 .endd
27459 Removed header lines are accumulated during the MAIL, RCPT, and predata ACLs.
27460 They are removed from the message before processing the DATA and MIME ACLs.
27461 There is no harm in attempting to remove the same header twice nor is removing
27462 a non-existent header. Further header lines to be removed may be accumulated
27463 during the DATA and MIME ACLs, after which they are removed from the message,
27464 if present. In the case of non-SMTP messages, headers to be removed are
27465 accumulated during the non-SMTP ACLs, and are removed from the message after
27466 all the ACLs have run. If a message is rejected after DATA or by the non-SMTP
27467 ACL, there really is no effect because there is no logging of what headers
27468 would have been removed.
27469
27470 .cindex "header lines" "removed; visibility of"
27471 Header lines are not visible in string expansions until the DATA phase when it
27472 is received. Any header lines removed in the MAIL, RCPT, and predata ACLs are
27473 not visible in the DATA ACL and MIME ACLs. Similarly, header lines that are
27474 removed by the DATA or MIME ACLs are still visible in those ACLs. Because of
27475 this restriction, you cannot use header lines as a way of controlling data
27476 passed between (for example) the MAIL and RCPT ACLs. If you want to do this,
27477 you should instead use ACL variables, as described in section
27478 &<<SECTaclvariables>>&.
27479
27480 The &%remove_header%& modifier acts immediately as it is encountered during the
27481 processing of an ACL. Notice the difference between these two cases:
27482 .display
27483 &`accept remove_header = X-Internal`&
27484 &`       `&<&'some condition'&>
27485
27486 &`accept `&<&'some condition'&>
27487 &`       remove_header = X-Internal`&
27488 .endd
27489 In the first case, the header line is always removed, whether or not the
27490 condition is true. In the second case, the header line is removed only if the
27491 condition is true. Multiple occurrences of &%remove_header%& may occur in the
27492 same ACL statement. All those that are encountered before a condition fails
27493 are honoured.
27494
27495 &*Warning*&: This facility currently applies only to header lines that are
27496 present during ACL processing. It does NOT remove header lines that are added
27497 in a system filter or in a router or transport.
27498
27499
27500
27501
27502
27503 .section "ACL conditions" "SECTaclconditions"
27504 .cindex "&ACL;" "conditions; list of"
27505 Some of the conditions listed in this section are available only when Exim is
27506 compiled with the content-scanning extension. They are included here briefly
27507 for completeness. More detailed descriptions can be found in the discussion on
27508 content scanning in chapter &<<CHAPexiscan>>&.
27509
27510 Not all conditions are relevant in all circumstances. For example, testing
27511 senders and recipients does not make sense in an ACL that is being run as the
27512 result of the arrival of an ETRN command, and checks on message headers can be
27513 done only in the ACLs specified by &%acl_smtp_data%& and &%acl_not_smtp%&. You
27514 can use the same condition (with different parameters) more than once in the
27515 same ACL statement. This provides a way of specifying an &"and"& conjunction.
27516 The conditions are as follows:
27517
27518
27519 .vlist
27520 .vitem &*acl&~=&~*&<&'name&~of&~acl&~or&~ACL&~string&~or&~file&~name&~'&>
27521 .cindex "&ACL;" "nested"
27522 .cindex "&ACL;" "indirect"
27523 .cindex "&ACL;" "arguments"
27524 .cindex "&%acl%& ACL condition"
27525 The possible values of the argument are the same as for the
27526 &%acl_smtp_%&&'xxx'& options. The named or inline ACL is run. If it returns
27527 &"accept"& the condition is true; if it returns &"deny"& the condition is
27528 false. If it returns &"defer"&, the current ACL returns &"defer"& unless the
27529 condition is on a &%warn%& verb. In that case, a &"defer"& return makes the
27530 condition false. This means that further processing of the &%warn%& verb
27531 ceases, but processing of the ACL continues.
27532
27533 If the argument is a named ACL, up to nine space-separated optional values
27534 can be appended; they appear within the called ACL in $acl_arg1 to $acl_arg9,
27535 and $acl_narg is set to the count of values.
27536 Previous values of these variables are restored after the call returns.
27537 The name and values are expanded separately.
27538
27539 If the nested &%acl%& returns &"drop"& and the outer condition denies access,
27540 the connection is dropped. If it returns &"discard"&, the verb must be
27541 &%accept%& or &%discard%&, and the action is taken immediately &-- no further
27542 conditions are tested.
27543
27544 ACLs may be nested up to 20 deep; the limit exists purely to catch runaway
27545 loops. This condition allows you to use different ACLs in different
27546 circumstances. For example, different ACLs can be used to handle RCPT commands
27547 for different local users or different local domains.
27548
27549 .vitem &*authenticated&~=&~*&<&'string&~list'&>
27550 .cindex "&%authenticated%& ACL condition"
27551 .cindex "authentication" "ACL checking"
27552 .cindex "&ACL;" "testing for authentication"
27553 If the SMTP connection is not authenticated, the condition is false. Otherwise,
27554 the name of the authenticator is tested against the list. To test for
27555 authentication by any authenticator, you can set
27556 .code
27557 authenticated = *
27558 .endd
27559
27560 .vitem &*condition&~=&~*&<&'string'&>
27561 .cindex "&%condition%& ACL condition"
27562 .cindex "customizing" "ACL condition"
27563 .cindex "&ACL;" "customized test"
27564 .cindex "&ACL;" "testing, customized"
27565 This feature allows you to make up custom conditions. If the result of
27566 expanding the string is an empty string, the number zero, or one of the strings
27567 &"no"& or &"false"&, the condition is false. If the result is any non-zero
27568 number, or one of the strings &"yes"& or &"true"&, the condition is true. For
27569 any other value, some error is assumed to have occurred, and the ACL returns
27570 &"defer"&. However, if the expansion is forced to fail, the condition is
27571 ignored. The effect is to treat it as true, whether it is positive or
27572 negative.
27573
27574 .vitem &*decode&~=&~*&<&'location'&>
27575 .cindex "&%decode%& ACL condition"
27576 This condition is available only when Exim is compiled with the
27577 content-scanning extension, and it is allowed only in the ACL defined by
27578 &%acl_smtp_mime%&. It causes the current MIME part to be decoded into a file.
27579 If all goes well, the condition is true. It is false only if there are
27580 problems such as a syntax error or a memory shortage. For more details, see
27581 chapter &<<CHAPexiscan>>&.
27582
27583 .vitem &*demime&~=&~*&<&'extension&~list'&>
27584 .cindex "&%demime%& ACL condition"
27585 This condition is available only when Exim is compiled with the
27586 content-scanning extension. Its use is described in section
27587 &<<SECTdemimecond>>&.
27588
27589 .vitem &*dnslists&~=&~*&<&'list&~of&~domain&~names&~and&~other&~data'&>
27590 .cindex "&%dnslists%& ACL condition"
27591 .cindex "DNS list" "in ACL"
27592 .cindex "black list (DNS)"
27593 .cindex "&ACL;" "testing a DNS list"
27594 This condition checks for entries in DNS black lists. These are also known as
27595 &"RBL lists"&, after the original Realtime Blackhole List, but note that the
27596 use of the lists at &'mail-abuse.org'& now carries a charge. There are too many
27597 different variants of this condition to describe briefly here. See sections
27598 &<<SECTmorednslists>>&&--&<<SECTmorednslistslast>>& for details.
27599
27600 .vitem &*domains&~=&~*&<&'domain&~list'&>
27601 .cindex "&%domains%& ACL condition"
27602 .cindex "domain" "ACL checking"
27603 .cindex "&ACL;" "testing a recipient domain"
27604 .vindex "&$domain_data$&"
27605 This condition is relevant only after a RCPT command. It checks that the domain
27606 of the recipient address is in the domain list. If percent-hack processing is
27607 enabled, it is done before this test is done. If the check succeeds with a
27608 lookup, the result of the lookup is placed in &$domain_data$& until the next
27609 &%domains%& test.
27610
27611 &*Note carefully*& (because many people seem to fall foul of this): you cannot
27612 use &%domains%& in a DATA ACL.
27613
27614
27615 .vitem &*encrypted&~=&~*&<&'string&~list'&>
27616 .cindex "&%encrypted%& ACL condition"
27617 .cindex "encryption" "checking in an ACL"
27618 .cindex "&ACL;" "testing for encryption"
27619 If the SMTP connection is not encrypted, the condition is false. Otherwise, the
27620 name of the cipher suite in use is tested against the list. To test for
27621 encryption without testing for any specific cipher suite(s), set
27622 .code
27623 encrypted = *
27624 .endd
27625
27626
27627 .vitem &*hosts&~=&~*&<&'host&~list'&>
27628 .cindex "&%hosts%& ACL condition"
27629 .cindex "host" "ACL checking"
27630 .cindex "&ACL;" "testing the client host"
27631 This condition tests that the calling host matches the host list. If you have
27632 name lookups or wildcarded host names and IP addresses in the same host list,
27633 you should normally put the IP addresses first. For example, you could have:
27634 .code
27635 accept hosts = 10.9.8.7 : dbm;/etc/friendly/hosts
27636 .endd
27637 The lookup in this example uses the host name for its key. This is implied by
27638 the lookup type &"dbm"&. (For a host address lookup you would use &"net-dbm"&
27639 and it wouldn't matter which way round you had these two items.)
27640
27641 The reason for the problem with host names lies in the left-to-right way that
27642 Exim processes lists. It can test IP addresses without doing any DNS lookups,
27643 but when it reaches an item that requires a host name, it fails if it cannot
27644 find a host name to compare with the pattern. If the above list is given in the
27645 opposite order, the &%accept%& statement fails for a host whose name cannot be
27646 found, even if its IP address is 10.9.8.7.
27647
27648 If you really do want to do the name check first, and still recognize the IP
27649 address even if the name lookup fails, you can rewrite the ACL like this:
27650 .code
27651 accept hosts = dbm;/etc/friendly/hosts
27652 accept hosts = 10.9.8.7
27653 .endd
27654 The default action on failing to find the host name is to assume that the host
27655 is not in the list, so the first &%accept%& statement fails. The second
27656 statement can then check the IP address.
27657
27658 .vindex "&$host_data$&"
27659 If a &%hosts%& condition is satisfied by means of a lookup, the result
27660 of the lookup is made available in the &$host_data$& variable. This
27661 allows you, for example, to set up a statement like this:
27662 .code
27663 deny  hosts = net-lsearch;/some/file
27664 message = $host_data
27665 .endd
27666 which gives a custom error message for each denied host.
27667
27668 .vitem &*local_parts&~=&~*&<&'local&~part&~list'&>
27669 .cindex "&%local_parts%& ACL condition"
27670 .cindex "local part" "ACL checking"
27671 .cindex "&ACL;" "testing a local part"
27672 .vindex "&$local_part_data$&"
27673 This condition is relevant only after a RCPT command. It checks that the local
27674 part of the recipient address is in the list. If percent-hack processing is
27675 enabled, it is done before this test. If the check succeeds with a lookup, the
27676 result of the lookup is placed in &$local_part_data$&, which remains set until
27677 the next &%local_parts%& test.
27678
27679 .vitem &*malware&~=&~*&<&'option'&>
27680 .cindex "&%malware%& ACL condition"
27681 .cindex "&ACL;" "virus scanning"
27682 .cindex "&ACL;" "scanning for viruses"
27683 This condition is available only when Exim is compiled with the
27684 content-scanning extension. It causes the incoming message to be scanned for
27685 viruses. For details, see chapter &<<CHAPexiscan>>&.
27686
27687 .vitem &*mime_regex&~=&~*&<&'list&~of&~regular&~expressions'&>
27688 .cindex "&%mime_regex%& ACL condition"
27689 .cindex "&ACL;" "testing by regex matching"
27690 This condition is available only when Exim is compiled with the
27691 content-scanning extension, and it is allowed only in the ACL defined by
27692 &%acl_smtp_mime%&. It causes the current MIME part to be scanned for a match
27693 with any of the regular expressions. For details, see chapter
27694 &<<CHAPexiscan>>&.
27695
27696 .vitem &*ratelimit&~=&~*&<&'parameters'&>
27697 .cindex "rate limiting"
27698 This condition can be used to limit the rate at which a user or host submits
27699 messages. Details are given in section &<<SECTratelimiting>>&.
27700
27701 .vitem &*recipients&~=&~*&<&'address&~list'&>
27702 .cindex "&%recipients%& ACL condition"
27703 .cindex "recipient" "ACL checking"
27704 .cindex "&ACL;" "testing a recipient"
27705 This condition is relevant only after a RCPT command. It checks the entire
27706 recipient address against a list of recipients.
27707
27708 .vitem &*regex&~=&~*&<&'list&~of&~regular&~expressions'&>
27709 .cindex "&%regex%& ACL condition"
27710 .cindex "&ACL;" "testing by regex matching"
27711 This condition is available only when Exim is compiled with the
27712 content-scanning extension, and is available only in the DATA, MIME, and
27713 non-SMTP ACLs. It causes the incoming message to be scanned for a match with
27714 any of the regular expressions. For details, see chapter &<<CHAPexiscan>>&.
27715
27716 .vitem &*sender_domains&~=&~*&<&'domain&~list'&>
27717 .cindex "&%sender_domains%& ACL condition"
27718 .cindex "sender" "ACL checking"
27719 .cindex "&ACL;" "testing a sender domain"
27720 .vindex "&$domain$&"
27721 .vindex "&$sender_address_domain$&"
27722 This condition tests the domain of the sender of the message against the given
27723 domain list. &*Note*&: The domain of the sender address is in
27724 &$sender_address_domain$&. It is &'not'& put in &$domain$& during the testing
27725 of this condition. This is an exception to the general rule for testing domain
27726 lists. It is done this way so that, if this condition is used in an ACL for a
27727 RCPT command, the recipient's domain (which is in &$domain$&) can be used to
27728 influence the sender checking.
27729
27730 &*Warning*&: It is a bad idea to use this condition on its own as a control on
27731 relaying, because sender addresses are easily, and commonly, forged.
27732
27733 .vitem &*senders&~=&~*&<&'address&~list'&>
27734 .cindex "&%senders%& ACL condition"
27735 .cindex "sender" "ACL checking"
27736 .cindex "&ACL;" "testing a sender"
27737 This condition tests the sender of the message against the given list. To test
27738 for a bounce message, which has an empty sender, set
27739 .code
27740 senders = :
27741 .endd
27742 &*Warning*&: It is a bad idea to use this condition on its own as a control on
27743 relaying, because sender addresses are easily, and commonly, forged.
27744
27745 .vitem &*spam&~=&~*&<&'username'&>
27746 .cindex "&%spam%& ACL condition"
27747 .cindex "&ACL;" "scanning for spam"
27748 This condition is available only when Exim is compiled with the
27749 content-scanning extension. It causes the incoming message to be scanned by
27750 SpamAssassin. For details, see chapter &<<CHAPexiscan>>&.
27751
27752 .vitem &*verify&~=&~certificate*&
27753 .cindex "&%verify%& ACL condition"
27754 .cindex "TLS" "client certificate verification"
27755 .cindex "certificate" "verification of client"
27756 .cindex "&ACL;" "certificate verification"
27757 .cindex "&ACL;" "testing a TLS certificate"
27758 This condition is true in an SMTP session if the session is encrypted, and a
27759 certificate was received from the client, and the certificate was verified. The
27760 server requests a certificate only if the client matches &%tls_verify_hosts%&
27761 or &%tls_try_verify_hosts%& (see chapter &<<CHAPTLS>>&).
27762
27763 .vitem &*verify&~=&~csa*&
27764 .cindex "CSA verification"
27765 This condition checks whether the sending host (the client) is authorized to
27766 send email. Details of how this works are given in section
27767 &<<SECTverifyCSA>>&.
27768
27769 .vitem &*verify&~=&~header_sender/*&<&'options'&>
27770 .cindex "&%verify%& ACL condition"
27771 .cindex "&ACL;" "verifying sender in the header"
27772 .cindex "header lines" "verifying the sender in"
27773 .cindex "sender" "verifying in header"
27774 .cindex "verifying" "sender in header"
27775 This condition is relevant only in an ACL that is run after a message has been
27776 received, that is, in an ACL specified by &%acl_smtp_data%& or
27777 &%acl_not_smtp%&. It checks that there is a verifiable address in at least one
27778 of the &'Sender:'&, &'Reply-To:'&, or &'From:'& header lines. Such an address
27779 is loosely thought of as a &"sender"& address (hence the name of the test).
27780 However, an address that appears in one of these headers need not be an address
27781 that accepts bounce messages; only sender addresses in envelopes are required
27782 to accept bounces. Therefore, if you use the callout option on this check, you
27783 might want to arrange for a non-empty address in the MAIL command.
27784
27785 Details of address verification and the options are given later, starting at
27786 section &<<SECTaddressverification>>& (callouts are described in section
27787 &<<SECTcallver>>&). You can combine this condition with the &%senders%&
27788 condition to restrict it to bounce messages only:
27789 .code
27790 deny    senders = :
27791         message = A valid sender header is required for bounces
27792        !verify  = header_sender
27793 .endd
27794
27795 .vitem &*verify&~=&~header_syntax*&
27796 .cindex "&%verify%& ACL condition"
27797 .cindex "&ACL;" "verifying header syntax"
27798 .cindex "header lines" "verifying syntax"
27799 .cindex "verifying" "header syntax"
27800 This condition is relevant only in an ACL that is run after a message has been
27801 received, that is, in an ACL specified by &%acl_smtp_data%& or
27802 &%acl_not_smtp%&. It checks the syntax of all header lines that can contain
27803 lists of addresses (&'Sender:'&, &'From:'&, &'Reply-To:'&, &'To:'&, &'Cc:'&,
27804 and &'Bcc:'&). Unqualified addresses (local parts without domains) are
27805 permitted only in locally generated messages and from hosts that match
27806 &%sender_unqualified_hosts%& or &%recipient_unqualified_hosts%&, as
27807 appropriate.
27808
27809 Note that this condition is a syntax check only. However, a common spamming
27810 ploy used to be to send syntactically invalid headers such as
27811 .code
27812 To: @
27813 .endd
27814 and this condition can be used to reject such messages, though they are not as
27815 common as they used to be.
27816
27817 .vitem &*verify&~=&~helo*&
27818 .cindex "&%verify%& ACL condition"
27819 .cindex "&ACL;" "verifying HELO/EHLO"
27820 .cindex "HELO" "verifying"
27821 .cindex "EHLO" "verifying"
27822 .cindex "verifying" "EHLO"
27823 .cindex "verifying" "HELO"
27824 This condition is true if a HELO or EHLO command has been received from the
27825 client host, and its contents have been verified. If there has been no previous
27826 attempt to verify the HELO/EHLO contents, it is carried out when this
27827 condition is encountered. See the description of the &%helo_verify_hosts%& and
27828 &%helo_try_verify_hosts%& options for details of how to request verification
27829 independently of this condition.
27830
27831 For SMTP input that does not come over TCP/IP (the &%-bs%& command line
27832 option), this condition is always true.
27833
27834
27835 .vitem &*verify&~=&~not_blind*&
27836 .cindex "verifying" "not blind"
27837 .cindex "bcc recipients, verifying none"
27838 This condition checks that there are no blind (bcc) recipients in the message.
27839 Every envelope recipient must appear either in a &'To:'& header line or in a
27840 &'Cc:'& header line for this condition to be true. Local parts are checked
27841 case-sensitively; domains are checked case-insensitively. If &'Resent-To:'& or
27842 &'Resent-Cc:'& header lines exist, they are also checked. This condition can be
27843 used only in a DATA or non-SMTP ACL.
27844
27845 There are, of course, many legitimate messages that make use of blind (bcc)
27846 recipients. This check should not be used on its own for blocking messages.
27847
27848
27849 .vitem &*verify&~=&~recipient/*&<&'options'&>
27850 .cindex "&%verify%& ACL condition"
27851 .cindex "&ACL;" "verifying recipient"
27852 .cindex "recipient" "verifying"
27853 .cindex "verifying" "recipient"
27854 .vindex "&$address_data$&"
27855 This condition is relevant only after a RCPT command. It verifies the current
27856 recipient. Details of address verification are given later, starting at section
27857 &<<SECTaddressverification>>&. After a recipient has been verified, the value
27858 of &$address_data$& is the last value that was set while routing the address.
27859 This applies even if the verification fails. When an address that is being
27860 verified is redirected to a single address, verification continues with the new
27861 address, and in that case, the subsequent value of &$address_data$& is the
27862 value for the child address.
27863
27864 .vitem &*verify&~=&~reverse_host_lookup*&
27865 .cindex "&%verify%& ACL condition"
27866 .cindex "&ACL;" "verifying host reverse lookup"
27867 .cindex "host" "verifying reverse lookup"
27868 This condition ensures that a verified host name has been looked up from the IP
27869 address of the client host. (This may have happened already if the host name
27870 was needed for checking a host list, or if the host matched &%host_lookup%&.)
27871 Verification ensures that the host name obtained from a reverse DNS lookup, or
27872 one of its aliases, does, when it is itself looked up in the DNS, yield the
27873 original IP address.
27874
27875 If this condition is used for a locally generated message (that is, when there
27876 is no client host involved), it always succeeds.
27877
27878 .vitem &*verify&~=&~sender/*&<&'options'&>
27879 .cindex "&%verify%& ACL condition"
27880 .cindex "&ACL;" "verifying sender"
27881 .cindex "sender" "verifying"
27882 .cindex "verifying" "sender"
27883 This condition is relevant only after a MAIL or RCPT command, or after a
27884 message has been received (the &%acl_smtp_data%& or &%acl_not_smtp%& ACLs). If
27885 the message's sender is empty (that is, this is a bounce message), the
27886 condition is true. Otherwise, the sender address is verified.
27887
27888 .vindex "&$address_data$&"
27889 .vindex "&$sender_address_data$&"
27890 If there is data in the &$address_data$& variable at the end of routing, its
27891 value is placed in &$sender_address_data$& at the end of verification. This
27892 value can be used in subsequent conditions and modifiers in the same ACL
27893 statement. It does not persist after the end of the current statement. If you
27894 want to preserve the value for longer, you can save it in an ACL variable.
27895
27896 Details of verification are given later, starting at section
27897 &<<SECTaddressverification>>&. Exim caches the result of sender verification,
27898 to avoid doing it more than once per message.
27899
27900 .vitem &*verify&~=&~sender=*&<&'address'&>&*/*&<&'options'&>
27901 .cindex "&%verify%& ACL condition"
27902 This is a variation of the previous option, in which a modified address is
27903 verified as a sender.
27904 .endlist
27905
27906
27907
27908 .section "Using DNS lists" "SECTmorednslists"
27909 .cindex "DNS list" "in ACL"
27910 .cindex "black list (DNS)"
27911 .cindex "&ACL;" "testing a DNS list"
27912 In its simplest form, the &%dnslists%& condition tests whether the calling host
27913 is on at least one of a number of DNS lists by looking up the inverted IP
27914 address in one or more DNS domains. (Note that DNS list domains are not mail
27915 domains, so the &`+`& syntax for named lists doesn't work - it is used for
27916 special options instead.) For example, if the calling host's IP
27917 address is 192.168.62.43, and the ACL statement is
27918 .code
27919 deny dnslists = blackholes.mail-abuse.org : \
27920                 dialups.mail-abuse.org
27921 .endd
27922 the following records are looked up:
27923 .code
27924 43.62.168.192.blackholes.mail-abuse.org
27925 43.62.168.192.dialups.mail-abuse.org
27926 .endd
27927 As soon as Exim finds an existing DNS record, processing of the list stops.
27928 Thus, multiple entries on the list provide an &"or"& conjunction. If you want
27929 to test that a host is on more than one list (an &"and"& conjunction), you can
27930 use two separate conditions:
27931 .code
27932 deny dnslists = blackholes.mail-abuse.org
27933      dnslists = dialups.mail-abuse.org
27934 .endd
27935 If a DNS lookup times out or otherwise fails to give a decisive answer, Exim
27936 behaves as if the host does not match the list item, that is, as if the DNS
27937 record does not exist. If there are further items in the DNS list, they are
27938 processed.
27939
27940 This is usually the required action when &%dnslists%& is used with &%deny%&
27941 (which is the most common usage), because it prevents a DNS failure from
27942 blocking mail. However, you can change this behaviour by putting one of the
27943 following special items in the list:
27944 .display
27945 &`+include_unknown `&   behave as if the item is on the list
27946 &`+exclude_unknown `&   behave as if the item is not on the list (default)
27947 &`+defer_unknown   `&   give a temporary error
27948 .endd
27949 .cindex "&`+include_unknown`&"
27950 .cindex "&`+exclude_unknown`&"
27951 .cindex "&`+defer_unknown`&"
27952 Each of these applies to any subsequent items on the list. For example:
27953 .code
27954 deny dnslists = +defer_unknown : foo.bar.example
27955 .endd
27956 Testing the list of domains stops as soon as a match is found. If you want to
27957 warn for one list and block for another, you can use two different statements:
27958 .code
27959 deny  dnslists = blackholes.mail-abuse.org
27960 warn  message  = X-Warn: sending host is on dialups list
27961       dnslists = dialups.mail-abuse.org
27962 .endd
27963 DNS list lookups are cached by Exim for the duration of the SMTP session,
27964 so a lookup based on the IP address is done at most once for any incoming
27965 connection. Exim does not share information between multiple incoming
27966 connections (but your local name server cache should be active).
27967
27968
27969
27970 .section "Specifying the IP address for a DNS list lookup" "SECID201"
27971 .cindex "DNS list" "keyed by explicit IP address"
27972 By default, the IP address that is used in a DNS list lookup is the IP address
27973 of the calling host. However, you can specify another IP address by listing it
27974 after the domain name, introduced by a slash. For example:
27975 .code
27976 deny dnslists = black.list.tld/192.168.1.2
27977 .endd
27978 This feature is not very helpful with explicit IP addresses; it is intended for
27979 use with IP addresses that are looked up, for example, the IP addresses of the
27980 MX hosts or nameservers of an email sender address. For an example, see section
27981 &<<SECTmulkeyfor>>& below.
27982
27983
27984
27985
27986 .section "DNS lists keyed on domain names" "SECID202"
27987 .cindex "DNS list" "keyed by domain name"
27988 There are some lists that are keyed on domain names rather than inverted IP
27989 addresses (see for example the &'domain based zones'& link at
27990 &url(http://www.rfc-ignorant.org/)). No reversing of components is used
27991 with these lists. You can change the name that is looked up in a DNS list by
27992 listing it after the domain name, introduced by a slash. For example,
27993 .code
27994 deny  message  = Sender's domain is listed at $dnslist_domain
27995       dnslists = dsn.rfc-ignorant.org/$sender_address_domain
27996 .endd
27997 This particular example is useful only in ACLs that are obeyed after the
27998 RCPT or DATA commands, when a sender address is available. If (for
27999 example) the message's sender is &'user@tld.example'& the name that is looked
28000 up by this example is
28001 .code
28002 tld.example.dsn.rfc-ignorant.org
28003 .endd
28004 A single &%dnslists%& condition can contain entries for both names and IP
28005 addresses. For example:
28006 .code
28007 deny dnslists = sbl.spamhaus.org : \
28008                 dsn.rfc-ignorant.org/$sender_address_domain
28009 .endd
28010 The first item checks the sending host's IP address; the second checks a domain
28011 name. The whole condition is true if either of the DNS lookups succeeds.
28012
28013
28014
28015
28016 .section "Multiple explicit keys for a DNS list" "SECTmulkeyfor"
28017 .cindex "DNS list" "multiple keys for"
28018 The syntax described above for looking up explicitly-defined values (either
28019 names or IP addresses) in a DNS blacklist is a simplification. After the domain
28020 name for the DNS list, what follows the slash can in fact be a list of items.
28021 As with all lists in Exim, the default separator is a colon. However, because
28022 this is a sublist within the list of DNS blacklist domains, it is necessary
28023 either to double the separators like this:
28024 .code
28025 dnslists = black.list.tld/name.1::name.2
28026 .endd
28027 or to change the separator character, like this:
28028 .code
28029 dnslists = black.list.tld/<;name.1;name.2
28030 .endd
28031 If an item in the list is an IP address, it is inverted before the DNS
28032 blacklist domain is appended. If it is not an IP address, no inversion
28033 occurs. Consider this condition:
28034 .code
28035 dnslists = black.list.tld/<;192.168.1.2;a.domain
28036 .endd
28037 The DNS lookups that occur are:
28038 .code
28039 2.1.168.192.black.list.tld
28040 a.domain.black.list.tld
28041 .endd
28042 Once a DNS record has been found (that matches a specific IP return
28043 address, if specified &-- see section &<<SECTaddmatcon>>&), no further lookups
28044 are done. If there is a temporary DNS error, the rest of the sublist of domains
28045 or IP addresses is tried. A temporary error for the whole dnslists item occurs
28046 only if no other DNS lookup in this sublist succeeds. In other words, a
28047 successful lookup for any of the items in the sublist overrides a temporary
28048 error for a previous item.
28049
28050 The ability to supply a list of items after the slash is in some sense just a
28051 syntactic convenience. These two examples have the same effect:
28052 .code
28053 dnslists = black.list.tld/a.domain : black.list.tld/b.domain
28054 dnslists = black.list.tld/a.domain::b.domain
28055 .endd
28056 However, when the data for the list is obtained from a lookup, the second form
28057 is usually much more convenient. Consider this example:
28058 .code
28059 deny message  = The mail servers for the domain \
28060                 $sender_address_domain \
28061                 are listed at $dnslist_domain ($dnslist_value); \
28062                 see $dnslist_text.
28063      dnslists = sbl.spamhaus.org/<|${lookup dnsdb {>|a=<|\
28064                                    ${lookup dnsdb {>|mxh=\
28065                                    $sender_address_domain} }} }
28066 .endd
28067 Note the use of &`>|`& in the dnsdb lookup to specify the separator for
28068 multiple DNS records. The inner dnsdb lookup produces a list of MX hosts
28069 and the outer dnsdb lookup finds the IP addresses for these hosts. The result
28070 of expanding the condition might be something like this:
28071 .code
28072 dnslists = sbl.spahmaus.org/<|192.168.2.3|192.168.5.6|...
28073 .endd
28074 Thus, this example checks whether or not the IP addresses of the sender
28075 domain's mail servers are on the Spamhaus black list.
28076
28077 The key that was used for a successful DNS list lookup is put into the variable
28078 &$dnslist_matched$& (see section &<<SECID204>>&).
28079
28080
28081
28082
28083 .section "Data returned by DNS lists" "SECID203"
28084 .cindex "DNS list" "data returned from"
28085 DNS lists are constructed using address records in the DNS. The original RBL
28086 just used the address 127.0.0.1 on the right hand side of each record, but the
28087 RBL+ list and some other lists use a number of values with different meanings.
28088 The values used on the RBL+ list are:
28089 .display
28090 127.1.0.1  RBL
28091 127.1.0.2  DUL
28092 127.1.0.3  DUL and RBL
28093 127.1.0.4  RSS
28094 127.1.0.5  RSS and RBL
28095 127.1.0.6  RSS and DUL
28096 127.1.0.7  RSS and DUL and RBL
28097 .endd
28098 Section &<<SECTaddmatcon>>& below describes how you can distinguish between
28099 different values. Some DNS lists may return more than one address record;
28100 see section &<<SECThanmuldnsrec>>& for details of how they are checked.
28101
28102
28103 .section "Variables set from DNS lists" "SECID204"
28104 .cindex "expansion" "variables, set from DNS list"
28105 .cindex "DNS list" "variables set from"
28106 .vindex "&$dnslist_domain$&"
28107 .vindex "&$dnslist_matched$&"
28108 .vindex "&$dnslist_text$&"
28109 .vindex "&$dnslist_value$&"
28110 When an entry is found in a DNS list, the variable &$dnslist_domain$& contains
28111 the name of the overall domain that matched (for example,
28112 &`spamhaus.example`&), &$dnslist_matched$& contains the key within that domain
28113 (for example, &`192.168.5.3`&), and &$dnslist_value$& contains the data from
28114 the DNS record. When the key is an IP address, it is not reversed in
28115 &$dnslist_matched$& (though it is, of course, in the actual lookup). In simple
28116 cases, for example:
28117 .code
28118 deny dnslists = spamhaus.example
28119 .endd
28120 the key is also available in another variable (in this case,
28121 &$sender_host_address$&). In more complicated cases, however, this is not true.
28122 For example, using a data lookup (as described in section &<<SECTmulkeyfor>>&)
28123 might generate a dnslists lookup like this:
28124 .code
28125 deny dnslists = spamhaus.example/<|192.168.1.2|192.168.6.7|...
28126 .endd
28127 If this condition succeeds, the value in &$dnslist_matched$& might be
28128 &`192.168.6.7`& (for example).
28129
28130 If more than one address record is returned by the DNS lookup, all the IP
28131 addresses are included in &$dnslist_value$&, separated by commas and spaces.
28132 The variable &$dnslist_text$& contains the contents of any associated TXT
28133 record. For lists such as RBL+ the TXT record for a merged entry is often not
28134 very meaningful. See section &<<SECTmordetinf>>& for a way of obtaining more
28135 information.
28136
28137 You can use the DNS list variables in &%message%& or &%log_message%& modifiers
28138 &-- although these appear before the condition in the ACL, they are not
28139 expanded until after it has failed. For example:
28140 .code
28141 deny    hosts = !+local_networks
28142         message = $sender_host_address is listed \
28143                   at $dnslist_domain
28144         dnslists = rbl-plus.mail-abuse.example
28145 .endd
28146
28147
28148
28149 .section "Additional matching conditions for DNS lists" "SECTaddmatcon"
28150 .cindex "DNS list" "matching specific returned data"
28151 You can add an equals sign and an IP address after a &%dnslists%& domain name
28152 in order to restrict its action to DNS records with a matching right hand side.
28153 For example,
28154 .code
28155 deny dnslists = rblplus.mail-abuse.org=127.0.0.2
28156 .endd
28157 rejects only those hosts that yield 127.0.0.2. Without this additional data,
28158 any address record is considered to be a match. For the moment, we assume
28159 that the DNS lookup returns just one record. Section &<<SECThanmuldnsrec>>&
28160 describes how multiple records are handled.
28161
28162 More than one IP address may be given for checking, using a comma as a
28163 separator. These are alternatives &-- if any one of them matches, the
28164 &%dnslists%& condition is true. For example:
28165 .code
28166 deny  dnslists = a.b.c=127.0.0.2,127.0.0.3
28167 .endd
28168 If you want to specify a constraining address list and also specify names or IP
28169 addresses to be looked up, the constraining address list must be specified
28170 first. For example:
28171 .code
28172 deny dnslists = dsn.rfc-ignorant.org\
28173                 =127.0.0.2/$sender_address_domain
28174 .endd
28175
28176 If the character &`&&`& is used instead of &`=`&, the comparison for each
28177 listed IP address is done by a bitwise &"and"& instead of by an equality test.
28178 In other words, the listed addresses are used as bit masks. The comparison is
28179 true if all the bits in the mask are present in the address that is being
28180 tested. For example:
28181 .code
28182 dnslists = a.b.c&0.0.0.3
28183 .endd
28184 matches if the address is &'x.x.x.'&3, &'x.x.x.'&7, &'x.x.x.'&11, etc. If you
28185 want to test whether one bit or another bit is present (as opposed to both
28186 being present), you must use multiple values. For example:
28187 .code
28188 dnslists = a.b.c&0.0.0.1,0.0.0.2
28189 .endd
28190 matches if the final component of the address is an odd number or two times
28191 an odd number.
28192
28193
28194
28195 .section "Negated DNS matching conditions" "SECID205"
28196 You can supply a negative list of IP addresses as part of a &%dnslists%&
28197 condition. Whereas
28198 .code
28199 deny  dnslists = a.b.c=127.0.0.2,127.0.0.3
28200 .endd
28201 means &"deny if the host is in the black list at the domain &'a.b.c'& and the
28202 IP address yielded by the list is either 127.0.0.2 or 127.0.0.3"&,
28203 .code
28204 deny  dnslists = a.b.c!=127.0.0.2,127.0.0.3
28205 .endd
28206 means &"deny if the host is in the black list at the domain &'a.b.c'& and the
28207 IP address yielded by the list is not 127.0.0.2 and not 127.0.0.3"&. In other
28208 words, the result of the test is inverted if an exclamation mark appears before
28209 the &`=`& (or the &`&&`&) sign.
28210
28211 &*Note*&: This kind of negation is not the same as negation in a domain,
28212 host, or address list (which is why the syntax is different).
28213
28214 If you are using just one list, the negation syntax does not gain you much. The
28215 previous example is precisely equivalent to
28216 .code
28217 deny  dnslists = a.b.c
28218      !dnslists = a.b.c=127.0.0.2,127.0.0.3
28219 .endd
28220 However, if you are using multiple lists, the negation syntax is clearer.
28221 Consider this example:
28222 .code
28223 deny  dnslists = sbl.spamhaus.org : \
28224                  list.dsbl.org : \
28225                  dnsbl.njabl.org!=127.0.0.3 : \
28226                  relays.ordb.org
28227 .endd
28228 Using only positive lists, this would have to be:
28229 .code
28230 deny  dnslists = sbl.spamhaus.org : \
28231                  list.dsbl.org
28232 deny  dnslists = dnsbl.njabl.org
28233      !dnslists = dnsbl.njabl.org=127.0.0.3
28234 deny  dnslists = relays.ordb.org
28235 .endd
28236 which is less clear, and harder to maintain.
28237
28238
28239
28240
28241 .section "Handling multiple DNS records from a DNS list" "SECThanmuldnsrec"
28242 A DNS lookup for a &%dnslists%& condition may return more than one DNS record,
28243 thereby providing more than one IP address. When an item in a &%dnslists%& list
28244 is followed by &`=`& or &`&&`& and a list of IP addresses, in order to restrict
28245 the match to specific results from the DNS lookup, there are two ways in which
28246 the checking can be handled. For example, consider the condition:
28247 .code
28248 dnslists = a.b.c=127.0.0.1
28249 .endd
28250 What happens if the DNS lookup for the incoming IP address yields both
28251 127.0.0.1 and 127.0.0.2 by means of two separate DNS records? Is the
28252 condition true because at least one given value was found, or is it false
28253 because at least one of the found values was not listed? And how does this
28254 affect negated conditions? Both possibilities are provided for with the help of
28255 additional separators &`==`& and &`=&&`&.
28256
28257 .ilist
28258 If &`=`& or &`&&`& is used, the condition is true if any one of the looked up
28259 IP addresses matches one of the listed addresses. For the example above, the
28260 condition is true because 127.0.0.1 matches.
28261 .next
28262 If &`==`& or &`=&&`& is used, the condition is true only if every one of the
28263 looked up IP addresses matches one of the listed addresses. If the condition is
28264 changed to:
28265 .code
28266 dnslists = a.b.c==127.0.0.1
28267 .endd
28268 and the DNS lookup yields both 127.0.0.1 and 127.0.0.2, the condition is
28269 false because 127.0.0.2 is not listed. You would need to have:
28270 .code
28271 dnslists = a.b.c==127.0.0.1,127.0.0.2
28272 .endd
28273 for the condition to be true.
28274 .endlist
28275
28276 When &`!`& is used to negate IP address matching, it inverts the result, giving
28277 the precise opposite of the behaviour above. Thus:
28278 .ilist
28279 If &`!=`& or &`!&&`& is used, the condition is true if none of the looked up IP
28280 addresses matches one of the listed addresses. Consider:
28281 .code
28282 dnslists = a.b.c!&0.0.0.1
28283 .endd
28284 If the DNS lookup yields both 127.0.0.1 and 127.0.0.2, the condition is
28285 false because 127.0.0.1 matches.
28286 .next
28287 If &`!==`& or &`!=&&`& is used, the condition is true if there is at least one
28288 looked up IP address that does not match. Consider:
28289 .code
28290 dnslists = a.b.c!=&0.0.0.1
28291 .endd
28292 If the DNS lookup yields both 127.0.0.1 and 127.0.0.2, the condition is
28293 true, because 127.0.0.2 does not match. You would need to have:
28294 .code
28295 dnslists = a.b.c!=&0.0.0.1,0.0.0.2
28296 .endd
28297 for the condition to be false.
28298 .endlist
28299 When the DNS lookup yields only a single IP address, there is no difference
28300 between &`=`& and &`==`& and between &`&&`& and &`=&&`&.
28301
28302
28303
28304
28305 .section "Detailed information from merged DNS lists" "SECTmordetinf"
28306 .cindex "DNS list" "information from merged"
28307 When the facility for restricting the matching IP values in a DNS list is used,
28308 the text from the TXT record that is set in &$dnslist_text$& may not reflect
28309 the true reason for rejection. This happens when lists are merged and the IP
28310 address in the A record is used to distinguish them; unfortunately there is
28311 only one TXT record. One way round this is not to use merged lists, but that
28312 can be inefficient because it requires multiple DNS lookups where one would do
28313 in the vast majority of cases when the host of interest is not on any of the
28314 lists.
28315
28316 A less inefficient way of solving this problem is available. If
28317 two domain names, comma-separated, are given, the second is used first to
28318 do an initial check, making use of any IP value restrictions that are set.
28319 If there is a match, the first domain is used, without any IP value
28320 restrictions, to get the TXT record. As a byproduct of this, there is also
28321 a check that the IP being tested is indeed on the first list. The first
28322 domain is the one that is put in &$dnslist_domain$&. For example:
28323 .code
28324 reject message  = \
28325          rejected because $sender_host_address is blacklisted \
28326          at $dnslist_domain\n$dnslist_text
28327        dnslists = \
28328          sbl.spamhaus.org,sbl-xbl.spamhaus.org=127.0.0.2 : \
28329          dul.dnsbl.sorbs.net,dnsbl.sorbs.net=127.0.0.10
28330 .endd
28331 For the first blacklist item, this starts by doing a lookup in
28332 &'sbl-xbl.spamhaus.org'& and testing for a 127.0.0.2 return. If there is a
28333 match, it then looks in &'sbl.spamhaus.org'&, without checking the return
28334 value, and as long as something is found, it looks for the corresponding TXT
28335 record. If there is no match in &'sbl-xbl.spamhaus.org'&, nothing more is done.
28336 The second blacklist item is processed similarly.
28337
28338 If you are interested in more than one merged list, the same list must be
28339 given several times, but because the results of the DNS lookups are cached,
28340 the DNS calls themselves are not repeated. For example:
28341 .code
28342 reject dnslists = \
28343          http.dnsbl.sorbs.net,dnsbl.sorbs.net=127.0.0.2 : \
28344          socks.dnsbl.sorbs.net,dnsbl.sorbs.net=127.0.0.3 : \
28345          misc.dnsbl.sorbs.net,dnsbl.sorbs.net=127.0.0.4 : \
28346          dul.dnsbl.sorbs.net,dnsbl.sorbs.net=127.0.0.10
28347 .endd
28348 In this case there is one lookup in &'dnsbl.sorbs.net'&, and if none of the IP
28349 values matches (or if no record is found), this is the only lookup that is
28350 done. Only if there is a match is one of the more specific lists consulted.
28351
28352
28353
28354 .section "DNS lists and IPv6" "SECTmorednslistslast"
28355 .cindex "IPv6" "DNS black lists"
28356 .cindex "DNS list" "IPv6 usage"
28357 If Exim is asked to do a dnslist lookup for an IPv6 address, it inverts it
28358 nibble by nibble. For example, if the calling host's IP address is
28359 3ffe:ffff:836f:0a00:000a:0800:200a:c031, Exim might look up
28360 .code
28361 1.3.0.c.a.0.0.2.0.0.8.0.a.0.0.0.0.0.a.0.f.6.3.8.
28362   f.f.f.f.e.f.f.3.blackholes.mail-abuse.org
28363 .endd
28364 (split over two lines here to fit on the page). Unfortunately, some of the DNS
28365 lists contain wildcard records, intended for IPv4, that interact badly with
28366 IPv6. For example, the DNS entry
28367 .code
28368 *.3.some.list.example.    A    127.0.0.1
28369 .endd
28370 is probably intended to put the entire 3.0.0.0/8 IPv4 network on the list.
28371 Unfortunately, it also matches the entire 3::/4 IPv6 network.
28372
28373 You can exclude IPv6 addresses from DNS lookups by making use of a suitable
28374 &%condition%& condition, as in this example:
28375 .code
28376 deny   condition = ${if isip4{$sender_host_address}}
28377        dnslists  = some.list.example
28378 .endd
28379
28380 .section "Rate limiting incoming messages" "SECTratelimiting"
28381 .cindex "rate limiting" "client sending"
28382 .cindex "limiting client sending rates"
28383 .oindex "&%smtp_ratelimit_*%&"
28384 The &%ratelimit%& ACL condition can be used to measure and control the rate at
28385 which clients can send email. This is more powerful than the
28386 &%smtp_ratelimit_*%& options, because those options control the rate of
28387 commands in a single SMTP session only, whereas the &%ratelimit%& condition
28388 works across all connections (concurrent and sequential) from the same client
28389 host. The syntax of the &%ratelimit%& condition is:
28390 .display
28391 &`ratelimit =`& <&'m'&> &`/`& <&'p'&> &`/`& <&'options'&> &`/`& <&'key'&>
28392 .endd
28393 If the average client sending rate is less than &'m'& messages per time
28394 period &'p'& then the condition is false; otherwise it is true.
28395
28396 As a side-effect, the &%ratelimit%& condition sets the expansion variable
28397 &$sender_rate$& to the client's computed rate, &$sender_rate_limit$& to the
28398 configured value of &'m'&, and &$sender_rate_period$& to the configured value
28399 of &'p'&.
28400
28401 The parameter &'p'& is the smoothing time constant, in the form of an Exim
28402 time interval, for example, &`8h`& for eight hours. A larger time constant
28403 means that it takes Exim longer to forget a client's past behaviour. The
28404 parameter &'m'& is the maximum number of messages that a client is permitted to
28405 send in each time interval. It also specifies the number of messages permitted
28406 in a fast burst. By increasing both &'m'& and &'p'& but keeping &'m/p'&
28407 constant, you can allow a client to send more messages in a burst without
28408 changing its long-term sending rate limit. Conversely, if &'m'& and &'p'& are
28409 both small, messages must be sent at an even rate.
28410
28411 There is a script in &_util/ratelimit.pl_& which extracts sending rates from
28412 log files, to assist with choosing appropriate settings for &'m'& and &'p'&
28413 when deploying the &%ratelimit%& ACL condition. The script prints usage
28414 instructions when it is run with no arguments.
28415
28416 The key is used to look up the data for calculating the client's average
28417 sending rate. This data is stored in Exim's spool directory, alongside the
28418 retry and other hints databases. The default key is &$sender_host_address$&,
28419 which means Exim computes the sending rate of each client host IP address.
28420 By changing the key you can change how Exim identifies clients for the purpose
28421 of ratelimiting. For example, to limit the sending rate of each authenticated
28422 user, independent of the computer they are sending from, set the key to
28423 &$authenticated_id$&. You must ensure that the lookup key is meaningful; for
28424 example, &$authenticated_id$& is only meaningful if the client has
28425 authenticated (which you can check with the &%authenticated%& ACL condition).
28426
28427 The lookup key does not have to identify clients: If you want to limit the
28428 rate at which a recipient receives messages, you can use the key
28429 &`$local_part@$domain`& with the &%per_rcpt%& option (see below) in a RCPT
28430 ACL.
28431
28432 Each &%ratelimit%& condition can have up to four options. A &%per_*%& option
28433 specifies what Exim measures the rate of, for example messages or recipients
28434 or bytes. You can adjust the measurement using the &%unique=%& and/or
28435 &%count=%& options. You can also control when Exim updates the recorded rate
28436 using a &%strict%&, &%leaky%&, or &%readonly%& option. The options are
28437 separated by a slash, like the other parameters. They may appear in any order.
28438
28439 Internally, Exim appends the smoothing constant &'p'& onto the lookup key with
28440 any options that alter the meaning of the stored data. The limit &'m'& is not
28441 stored, so you can alter the configured maximum rate and Exim will still
28442 remember clients' past behaviour. If you change the &%per_*%& mode or add or
28443 remove the &%unique=%& option, the lookup key changes so Exim will forget past
28444 behaviour. The lookup key is not affected by changes to the update mode and
28445 the &%count=%& option.
28446
28447
28448 .section "Ratelimit options for what is being measured" "ratoptmea"
28449 .cindex "rate limiting" "per_* options"
28450 The &%per_conn%& option limits the client's connection rate. It is not
28451 normally used in the &%acl_not_smtp%&, &%acl_not_smtp_mime%&, or
28452 &%acl_not_smtp_start%& ACLs.
28453
28454 The &%per_mail%& option limits the client's rate of sending messages. This is
28455 the default if none of the &%per_*%& options is specified. It can be used in
28456 &%acl_smtp_mail%&, &%acl_smtp_rcpt%&, &%acl_smtp_predata%&, &%acl_smtp_mime%&,
28457 &%acl_smtp_data%&, or &%acl_not_smtp%&.
28458
28459 The &%per_byte%& option limits the sender's email bandwidth. It can be used in
28460 the same ACLs as the &%per_mail%& option, though it is best to use this option
28461 in the &%acl_smtp_mime%&, &%acl_smtp_data%& or &%acl_not_smtp%& ACLs; if it is
28462 used in an earlier ACL, Exim relies on the SIZE parameter given by the client
28463 in its MAIL command, which may be inaccurate or completely missing. You can
28464 follow the limit &'m'& in the configuration with K, M, or G to specify limits
28465 in kilobytes, megabytes, or gigabytes, respectively.
28466
28467 The &%per_rcpt%& option causes Exim to limit the rate at which recipients are
28468 accepted. It can be used in the &%acl_smtp_rcpt%&, &%acl_smtp_predata%&,
28469 &%acl_smtp_mime%&, &%acl_smtp_data%&, or &%acl_smtp_rcpt%& ACLs. In
28470 &%acl_smtp_rcpt%& the rate is updated one recipient at a time; in the other
28471 ACLs the rate is updated with the total recipient count in one go. Note that
28472 in either case the rate limiting engine will see a message with many
28473 recipients as a large high-speed burst.
28474
28475 The &%per_addr%& option is like the &%per_rcpt%& option, except it counts the
28476 number of different recipients that the client has sent messages to in the
28477 last time period. That is, if the client repeatedly sends messages to the same
28478 recipient, its measured rate is not increased. This option can only be used in
28479 &%acl_smtp_rcpt%&.
28480
28481 The &%per_cmd%& option causes Exim to recompute the rate every time the
28482 condition is processed. This can be used to limit the rate of any SMTP
28483 command. If it is used in multiple ACLs it can limit the aggregate rate of
28484 multiple different commands.
28485
28486 The &%count=%& option can be used to alter how much Exim adds to the client's
28487 measured rate. For example, the &%per_byte%& option is equivalent to
28488 &`per_mail/count=$message_size`&. If there is no &%count=%& option, Exim
28489 increases the measured rate by one (except for the &%per_rcpt%& option in ACLs
28490 other than &%acl_smtp_rcpt%&). The count does not have to be an integer.
28491
28492 The &%unique=%& option is described in section &<<ratoptuniq>>& below.
28493
28494
28495 .section "Ratelimit update modes" "ratoptupd"
28496 .cindex "rate limiting" "reading data without updating"
28497 You can specify one of three options with the &%ratelimit%& condition to
28498 control when its database is updated. This section describes the &%readonly%&
28499 mode, and the next section describes the &%strict%& and &%leaky%& modes.
28500
28501 If the &%ratelimit%& condition is used in &%readonly%& mode, Exim looks up a
28502 previously-computed rate to check against the limit.
28503
28504 For example, you can test the client's sending rate and deny it access (when
28505 it is too fast) in the connect ACL. If the client passes this check then it
28506 can go on to send a message, in which case its recorded rate will be updated
28507 in the MAIL ACL. Subsequent connections from the same client will check this
28508 new rate.
28509 .code
28510 acl_check_connect:
28511  deny ratelimit = 100 / 5m / readonly
28512     log_message = RATE CHECK: $sender_rate/$sender_rate_period \
28513                   (max $sender_rate_limit)
28514 # ...
28515 acl_check_mail:
28516  warn ratelimit = 100 / 5m / strict
28517     log_message = RATE UPDATE: $sender_rate/$sender_rate_period \
28518                   (max $sender_rate_limit)
28519 .endd
28520
28521 If Exim encounters multiple &%ratelimit%& conditions with the same key when
28522 processing a message then it may increase the client's measured rate more than
28523 it should. For example, this will happen if you check the &%per_rcpt%& option
28524 in both &%acl_smtp_rcpt%& and &%acl_smtp_data%&. However it's OK to check the
28525 same &%ratelimit%& condition multiple times in the same ACL. You can avoid any
28526 multiple update problems by using the &%readonly%& option on later ratelimit
28527 checks.
28528
28529 The &%per_*%& options described above do not make sense in some ACLs. If you
28530 use a &%per_*%& option in an ACL where it is not normally permitted then the
28531 update mode defaults to &%readonly%& and you cannot specify the &%strict%& or
28532 &%leaky%& modes. In other ACLs the default update mode is &%leaky%& (see the
28533 next section) so you must specify the &%readonly%& option explicitly.
28534
28535
28536 .section "Ratelimit options for handling fast clients" "ratoptfast"
28537 .cindex "rate limiting" "strict and leaky modes"
28538 If a client's average rate is greater than the maximum, the rate limiting
28539 engine can react in two possible ways, depending on the presence of the
28540 &%strict%& or &%leaky%& update modes. This is independent of the other
28541 counter-measures (such as rejecting the message) that may be specified by the
28542 rest of the ACL.
28543
28544 The &%leaky%& (default) option means that the client's recorded rate is not
28545 updated if it is above the limit. The effect of this is that Exim measures the
28546 client's average rate of successfully sent email, which cannot be greater than
28547 the maximum allowed. If the client is over the limit it may suffer some
28548 counter-measures (as specified in the ACL), but it will still be able to send
28549 email at the configured maximum rate, whatever the rate of its attempts. This
28550 is generally the better choice if you have clients that retry automatically.
28551 For example, it does not prevent a sender with an over-aggressive retry rate
28552 from getting any email through.
28553
28554 The &%strict%& option means that the client's recorded rate is always
28555 updated. The effect of this is that Exim measures the client's average rate
28556 of attempts to send email, which can be much higher than the maximum it is
28557 actually allowed. If the client is over the limit it may be subjected to
28558 counter-measures by the ACL. It must slow down and allow sufficient time to
28559 pass that its computed rate falls below the maximum before it can send email
28560 again. The time (the number of smoothing periods) it must wait and not
28561 attempt to send mail can be calculated with this formula:
28562 .code
28563         ln(peakrate/maxrate)
28564 .endd
28565
28566
28567 .section "Limiting the rate of different events" "ratoptuniq"
28568 .cindex "rate limiting" "counting unique events"
28569 The &%ratelimit%& &%unique=%& option controls a mechanism for counting the
28570 rate of different events. For example, the &%per_addr%& option uses this
28571 mechanism to count the number of different recipients that the client has
28572 sent messages to in the last time period; it is equivalent to
28573 &`per_rcpt/unique=$local_part@$domain`&. You could use this feature to
28574 measure the rate that a client uses different sender addresses with the
28575 options &`per_mail/unique=$sender_address`&.
28576
28577 For each &%ratelimit%& key Exim stores the set of &%unique=%& values that it
28578 has seen for that key. The whole set is thrown away when it is older than the
28579 rate smoothing period &'p'&, so each different event is counted at most once
28580 per period. In the &%leaky%& update mode, an event that causes the client to
28581 go over the limit is not added to the set, in the same way that the client's
28582 recorded rate is not updated in the same situation.
28583
28584 When you combine the &%unique=%& and &%readonly%& options, the specific
28585 &%unique=%& value is ignored, and Exim just retrieves the client's stored
28586 rate.
28587
28588 The &%unique=%& mechanism needs more space in the ratelimit database than the
28589 other &%ratelimit%& options in order to store the event set. The number of
28590 unique values is potentially as large as the rate limit, so the extra space
28591 required increases with larger limits.
28592
28593 The uniqueification is not perfect: there is a small probability that Exim
28594 will think a new event has happened before. If the sender's rate is less than
28595 the limit, Exim should be more than 99.9% correct. However in &%strict%& mode
28596 the measured rate can go above the limit, in which case Exim may under-count
28597 events by a significant margin. Fortunately, if the rate is high enough (2.7
28598 times the limit) that the false positive rate goes above 9%, then Exim will
28599 throw away the over-full event set before the measured rate falls below the
28600 limit. Therefore the only harm should be that exceptionally high sending rates
28601 are logged incorrectly; any countermeasures you configure will be as effective
28602 as intended.
28603
28604
28605 .section "Using rate limiting" "useratlim"
28606 Exim's other ACL facilities are used to define what counter-measures are taken
28607 when the rate limit is exceeded. This might be anything from logging a warning
28608 (for example, while measuring existing sending rates in order to define
28609 policy), through time delays to slow down fast senders, up to rejecting the
28610 message. For example:
28611 .code
28612 # Log all senders' rates
28613 warn ratelimit = 0 / 1h / strict
28614      log_message = Sender rate $sender_rate / $sender_rate_period
28615
28616 # Slow down fast senders; note the need to truncate $sender_rate
28617 # at the decimal point.
28618 warn ratelimit = 100 / 1h / per_rcpt / strict
28619      delay     = ${eval: ${sg{$sender_rate}{[.].*}{}} - \
28620                    $sender_rate_limit }s
28621
28622 # Keep authenticated users under control
28623 deny authenticated = *
28624      ratelimit = 100 / 1d / strict / $authenticated_id
28625
28626 # System-wide rate limit
28627 defer message = Sorry, too busy. Try again later.
28628      ratelimit = 10 / 1s / $primary_hostname
28629
28630 # Restrict incoming rate from each host, with a default
28631 # set using a macro and special cases looked up in a table.
28632 defer message = Sender rate exceeds $sender_rate_limit \
28633                messages per $sender_rate_period
28634      ratelimit = ${lookup {$sender_host_address} \
28635                    cdb {DB/ratelimits.cdb} \
28636                    {$value} {RATELIMIT} }
28637 .endd
28638 &*Warning*&: If you have a busy server with a lot of &%ratelimit%& tests,
28639 especially with the &%per_rcpt%& option, you may suffer from a performance
28640 bottleneck caused by locking on the ratelimit hints database. Apart from
28641 making your ACLs less complicated, you can reduce the problem by using a
28642 RAM disk for Exim's hints directory (usually &_/var/spool/exim/db/_&). However
28643 this means that Exim will lose its hints data after a reboot (including retry
28644 hints, the callout cache, and ratelimit data).
28645
28646
28647
28648 .section "Address verification" "SECTaddressverification"
28649 .cindex "verifying address" "options for"
28650 .cindex "policy control" "address verification"
28651 Several of the &%verify%& conditions described in section
28652 &<<SECTaclconditions>>& cause addresses to be verified. Section
28653 &<<SECTsenaddver>>& discusses the reporting of sender verification failures.
28654 The verification conditions can be followed by options that modify the
28655 verification process. The options are separated from the keyword and from each
28656 other by slashes, and some of them contain parameters. For example:
28657 .code
28658 verify = sender/callout
28659 verify = recipient/defer_ok/callout=10s,defer_ok
28660 .endd
28661 The first stage of address verification, which always happens, is to run the
28662 address through the routers, in &"verify mode"&. Routers can detect the
28663 difference between verification and routing for delivery, and their actions can
28664 be varied by a number of generic options such as &%verify%& and &%verify_only%&
28665 (see chapter &<<CHAProutergeneric>>&). If routing fails, verification fails.
28666 The available options are as follows:
28667
28668 .ilist
28669 If the &%callout%& option is specified, successful routing to one or more
28670 remote hosts is followed by a &"callout"& to those hosts as an additional
28671 check. Callouts and their sub-options are discussed in the next section.
28672 .next
28673 If there is a defer error while doing verification routing, the ACL
28674 normally returns &"defer"&. However, if you include &%defer_ok%& in the
28675 options, the condition is forced to be true instead. Note that this is a main
28676 verification option as well as a suboption for callouts.
28677 .next
28678 The &%no_details%& option is covered in section &<<SECTsenaddver>>&, which
28679 discusses the reporting of sender address verification failures.
28680 .next
28681 The &%success_on_redirect%& option causes verification always to succeed
28682 immediately after a successful redirection. By default, if a redirection
28683 generates just one address, that address is also verified. See further
28684 discussion in section &<<SECTredirwhilveri>>&.
28685 .endlist
28686
28687 .cindex "verifying address" "differentiating failures"
28688 .vindex "&$recipient_verify_failure$&"
28689 .vindex "&$sender_verify_failure$&"
28690 .vindex "&$acl_verify_message$&"
28691 After an address verification failure, &$acl_verify_message$& contains the
28692 error message that is associated with the failure. It can be preserved by
28693 coding like this:
28694 .code
28695 warn  !verify = sender
28696        set acl_m0 = $acl_verify_message
28697 .endd
28698 If you are writing your own custom rejection message or log message when
28699 denying access, you can use this variable to include information about the
28700 verification failure.
28701
28702 In addition, &$sender_verify_failure$& or &$recipient_verify_failure$& (as
28703 appropriate) contains one of the following words:
28704
28705 .ilist
28706 &%qualify%&: The address was unqualified (no domain), and the message
28707 was neither local nor came from an exempted host.
28708 .next
28709 &%route%&: Routing failed.
28710 .next
28711 &%mail%&: Routing succeeded, and a callout was attempted; rejection
28712 occurred at or before the MAIL command (that is, on initial
28713 connection, HELO, or MAIL).
28714 .next
28715 &%recipient%&: The RCPT command in a callout was rejected.
28716 .next
28717 &%postmaster%&: The postmaster check in a callout was rejected.
28718 .endlist
28719
28720 The main use of these variables is expected to be to distinguish between
28721 rejections of MAIL and rejections of RCPT in callouts.
28722
28723
28724
28725
28726 .section "Callout verification" "SECTcallver"
28727 .cindex "verifying address" "by callout"
28728 .cindex "callout" "verification"
28729 .cindex "SMTP" "callout verification"
28730 For non-local addresses, routing verifies the domain, but is unable to do any
28731 checking of the local part. There are situations where some means of verifying
28732 the local part is desirable. One way this can be done is to make an SMTP
28733 &'callback'& to a delivery host for the sender address or a &'callforward'& to
28734 a subsequent host for a recipient address, to see if the host accepts the
28735 address. We use the term &'callout'& to cover both cases. Note that for a
28736 sender address, the callback is not to the client host that is trying to
28737 deliver the message, but to one of the hosts that accepts incoming mail for the
28738 sender's domain.
28739
28740 Exim does not do callouts by default. If you want them to happen, you must
28741 request them by setting appropriate options on the &%verify%& condition, as
28742 described below. This facility should be used with care, because it can add a
28743 lot of resource usage to the cost of verifying an address. However, Exim does
28744 cache the results of callouts, which helps to reduce the cost. Details of
28745 caching are in section &<<SECTcallvercache>>&.
28746
28747 Recipient callouts are usually used only between hosts that are controlled by
28748 the same administration. For example, a corporate gateway host could use
28749 callouts to check for valid recipients on an internal mailserver. A successful
28750 callout does not guarantee that a real delivery to the address would succeed;
28751 on the other hand, a failing callout does guarantee that a delivery would fail.
28752
28753 If the &%callout%& option is present on a condition that verifies an address, a
28754 second stage of verification occurs if the address is successfully routed to
28755 one or more remote hosts. The usual case is routing by a &(dnslookup)& or a
28756 &(manualroute)& router, where the router specifies the hosts. However, if a
28757 router that does not set up hosts routes to an &(smtp)& transport with a
28758 &%hosts%& setting, the transport's hosts are used. If an &(smtp)& transport has
28759 &%hosts_override%& set, its hosts are always used, whether or not the router
28760 supplies a host list.
28761
28762 The port that is used is taken from the transport, if it is specified and is a
28763 remote transport. (For routers that do verification only, no transport need be
28764 specified.) Otherwise, the default SMTP port is used. If a remote transport
28765 specifies an outgoing interface, this is used; otherwise the interface is not
28766 specified. Likewise, the text that is used for the HELO command is taken from
28767 the transport's &%helo_data%& option; if there is no transport, the value of
28768 &$smtp_active_hostname$& is used.
28769
28770 For a sender callout check, Exim makes SMTP connections to the remote hosts, to
28771 test whether a bounce message could be delivered to the sender address. The
28772 following SMTP commands are sent:
28773 .display
28774 &`HELO `&<&'local host name'&>
28775 &`MAIL FROM:<>`&
28776 &`RCPT TO:`&<&'the address to be tested'&>
28777 &`QUIT`&
28778 .endd
28779 LHLO is used instead of HELO if the transport's &%protocol%& option is
28780 set to &"lmtp"&.
28781
28782 A recipient callout check is similar. By default, it also uses an empty address
28783 for the sender. This default is chosen because most hosts do not make use of
28784 the sender address when verifying a recipient. Using the same address means
28785 that a single cache entry can be used for each recipient. Some sites, however,
28786 do make use of the sender address when verifying. These are catered for by the
28787 &%use_sender%& and &%use_postmaster%& options, described in the next section.
28788
28789 If the response to the RCPT command is a 2&'xx'& code, the verification
28790 succeeds. If it is 5&'xx'&, the verification fails. For any other condition,
28791 Exim tries the next host, if any. If there is a problem with all the remote
28792 hosts, the ACL yields &"defer"&, unless the &%defer_ok%& parameter of the
28793 &%callout%& option is given, in which case the condition is forced to succeed.
28794
28795 .cindex "SMTP" "output flushing, disabling for callout"
28796 A callout may take a little time. For this reason, Exim normally flushes SMTP
28797 output before performing a callout in an ACL, to avoid unexpected timeouts in
28798 clients when the SMTP PIPELINING extension is in use. The flushing can be
28799 disabled by using a &%control%& modifier to set &%no_callout_flush%&.
28800
28801
28802
28803
28804 .section "Additional parameters for callouts" "CALLaddparcall"
28805 .cindex "callout" "additional parameters for"
28806 The &%callout%& option can be followed by an equals sign and a number of
28807 optional parameters, separated by commas. For example:
28808 .code
28809 verify = recipient/callout=10s,defer_ok
28810 .endd
28811 The old syntax, which had &%callout_defer_ok%& and &%check_postmaster%& as
28812 separate verify options, is retained for backwards compatibility, but is now
28813 deprecated. The additional parameters for &%callout%& are as follows:
28814
28815
28816 .vlist
28817 .vitem <&'a&~time&~interval'&>
28818 .cindex "callout" "timeout, specifying"
28819 This specifies the timeout that applies for the callout attempt to each host.
28820 For example:
28821 .code
28822 verify = sender/callout=5s
28823 .endd
28824 The default is 30 seconds. The timeout is used for each response from the
28825 remote host. It is also used for the initial connection, unless overridden by
28826 the &%connect%& parameter.
28827
28828
28829 .vitem &*connect&~=&~*&<&'time&~interval'&>
28830 .cindex "callout" "connection timeout, specifying"
28831 This parameter makes it possible to set a different (usually smaller) timeout
28832 for making the SMTP connection. For example:
28833 .code
28834 verify = sender/callout=5s,connect=1s
28835 .endd
28836 If not specified, this timeout defaults to the general timeout value.
28837
28838 .vitem &*defer_ok*&
28839 .cindex "callout" "defer, action on"
28840 When this parameter is present, failure to contact any host, or any other kind
28841 of temporary error, is treated as success by the ACL. However, the cache is not
28842 updated in this circumstance.
28843
28844 .vitem &*fullpostmaster*&
28845 .cindex "callout" "full postmaster check"
28846 This operates like the &%postmaster%& option (see below), but if the check for
28847 &'postmaster@domain'& fails, it tries just &'postmaster'&, without a domain, in
28848 accordance with the specification in RFC 2821. The RFC states that the
28849 unqualified address &'postmaster'& should be accepted.
28850
28851
28852 .vitem &*mailfrom&~=&~*&<&'email&~address'&>
28853 .cindex "callout" "sender when verifying header"
28854 When verifying addresses in header lines using the &%header_sender%&
28855 verification option, Exim behaves by default as if the addresses are envelope
28856 sender addresses from a message. Callout verification therefore tests to see
28857 whether a bounce message could be delivered, by using an empty address in the
28858 MAIL command. However, it is arguable that these addresses might never be used
28859 as envelope senders, and could therefore justifiably reject bounce messages
28860 (empty senders). The &%mailfrom%& callout parameter allows you to specify what
28861 address to use in the MAIL command. For example:
28862 .code
28863 require  verify = header_sender/callout=mailfrom=abcd@x.y.z
28864 .endd
28865 This parameter is available only for the &%header_sender%& verification option.
28866
28867
28868 .vitem &*maxwait&~=&~*&<&'time&~interval'&>
28869 .cindex "callout" "overall timeout, specifying"
28870 This parameter sets an overall timeout for performing a callout verification.
28871 For example:
28872 .code
28873 verify = sender/callout=5s,maxwait=30s
28874 .endd
28875 This timeout defaults to four times the callout timeout for individual SMTP
28876 commands. The overall timeout applies when there is more than one host that can
28877 be tried. The timeout is checked before trying the next host. This prevents
28878 very long delays if there are a large number of hosts and all are timing out
28879 (for example, when network connections are timing out).
28880
28881
28882 .vitem &*no_cache*&
28883 .cindex "callout" "cache, suppressing"
28884 .cindex "caching callout, suppressing"
28885 When this parameter is given, the callout cache is neither read nor updated.
28886
28887 .vitem &*postmaster*&
28888 .cindex "callout" "postmaster; checking"
28889 When this parameter is set, a successful callout check is followed by a similar
28890 check for the local part &'postmaster'& at the same domain. If this address is
28891 rejected, the callout fails (but see &%fullpostmaster%& above). The result of
28892 the postmaster check is recorded in a cache record; if it is a failure, this is
28893 used to fail subsequent callouts for the domain without a connection being
28894 made, until the cache record expires.
28895
28896 .vitem &*postmaster_mailfrom&~=&~*&<&'email&~address'&>
28897 The postmaster check uses an empty sender in the MAIL command by default.
28898 You can use this parameter to do a postmaster check using a different address.
28899 For example:
28900 .code
28901 require  verify = sender/callout=postmaster_mailfrom=abc@x.y.z
28902 .endd
28903 If both &%postmaster%& and &%postmaster_mailfrom%& are present, the rightmost
28904 one overrides. The &%postmaster%& parameter is equivalent to this example:
28905 .code
28906 require  verify = sender/callout=postmaster_mailfrom=
28907 .endd
28908 &*Warning*&: The caching arrangements for postmaster checking do not take
28909 account of the sender address. It is assumed that either the empty address or
28910 a fixed non-empty address will be used. All that Exim remembers is that the
28911 postmaster check for the domain succeeded or failed.
28912
28913
28914 .vitem &*random*&
28915 .cindex "callout" "&""random""& check"
28916 When this parameter is set, before doing the normal callout check, Exim does a
28917 check for a &"random"& local part at the same domain. The local part is not
28918 really random &-- it is defined by the expansion of the option
28919 &%callout_random_local_part%&, which defaults to
28920 .code
28921 $primary_hostname-$tod_epoch-testing
28922 .endd
28923 The idea here is to try to determine whether the remote host accepts all local
28924 parts without checking. If it does, there is no point in doing callouts for
28925 specific local parts. If the &"random"& check succeeds, the result is saved in
28926 a cache record, and used to force the current and subsequent callout checks to
28927 succeed without a connection being made, until the cache record expires.
28928
28929 .vitem &*use_postmaster*&
28930 .cindex "callout" "sender for recipient check"
28931 This parameter applies to recipient callouts only. For example:
28932 .code
28933 deny  !verify = recipient/callout=use_postmaster
28934 .endd
28935 .vindex "&$qualify_domain$&"
28936 It causes a non-empty postmaster address to be used in the MAIL command when
28937 performing the callout for the recipient, and also for a &"random"& check if
28938 that is configured. The local part of the address is &`postmaster`& and the
28939 domain is the contents of &$qualify_domain$&.
28940
28941 .vitem &*use_sender*&
28942 This option applies to recipient callouts only. For example:
28943 .code
28944 require  verify = recipient/callout=use_sender
28945 .endd
28946 It causes the message's actual sender address to be used in the MAIL
28947 command when performing the callout, instead of an empty address. There is no
28948 need to use this option unless you know that the called hosts make use of the
28949 sender when checking recipients. If used indiscriminately, it reduces the
28950 usefulness of callout caching.
28951 .endlist
28952
28953 If you use any of the parameters that set a non-empty sender for the MAIL
28954 command (&%mailfrom%&, &%postmaster_mailfrom%&, &%use_postmaster%&, or
28955 &%use_sender%&), you should think about possible loops. Recipient checking is
28956 usually done between two hosts that are under the same management, and the host
28957 that receives the callouts is not normally configured to do callouts itself.
28958 Therefore, it is normally safe to use &%use_postmaster%& or &%use_sender%& in
28959 these circumstances.
28960
28961 However, if you use a non-empty sender address for a callout to an arbitrary
28962 host, there is the likelihood that the remote host will itself initiate a
28963 callout check back to your host. As it is checking what appears to be a message
28964 sender, it is likely to use an empty address in MAIL, thus avoiding a
28965 callout loop. However, to be on the safe side it would be best to set up your
28966 own ACLs so that they do not do sender verification checks when the recipient
28967 is the address you use for header sender or postmaster callout checking.
28968
28969 Another issue to think about when using non-empty senders for callouts is
28970 caching. When you set &%mailfrom%& or &%use_sender%&, the cache record is keyed
28971 by the sender/recipient combination; thus, for any given recipient, many more
28972 actual callouts are performed than when an empty sender or postmaster is used.
28973
28974
28975
28976
28977 .section "Callout caching" "SECTcallvercache"
28978 .cindex "hints database" "callout cache"
28979 .cindex "callout" "cache, description of"
28980 .cindex "caching" "callout"
28981 Exim caches the results of callouts in order to reduce the amount of resources
28982 used, unless you specify the &%no_cache%& parameter with the &%callout%&
28983 option. A hints database called &"callout"& is used for the cache. Two
28984 different record types are used: one records the result of a callout check for
28985 a specific address, and the other records information that applies to the
28986 entire domain (for example, that it accepts the local part &'postmaster'&).
28987
28988 When an original callout fails, a detailed SMTP error message is given about
28989 the failure. However, for subsequent failures use the cache data, this message
28990 is not available.
28991
28992 The expiry times for negative and positive address cache records are
28993 independent, and can be set by the global options &%callout_negative_expire%&
28994 (default 2h) and &%callout_positive_expire%& (default 24h), respectively.
28995
28996 If a host gives a negative response to an SMTP connection, or rejects any
28997 commands up to and including
28998 .code
28999 MAIL FROM:<>
29000 .endd
29001 (but not including the MAIL command with a non-empty address),
29002 any callout attempt is bound to fail. Exim remembers such failures in a
29003 domain cache record, which it uses to fail callouts for the domain without
29004 making new connections, until the domain record times out. There are two
29005 separate expiry times for domain cache records:
29006 &%callout_domain_negative_expire%& (default 3h) and
29007 &%callout_domain_positive_expire%& (default 7d).
29008
29009 Domain records expire when the negative expiry time is reached if callouts
29010 cannot be made for the domain, or if the postmaster check failed.
29011 Otherwise, they expire when the positive expiry time is reached. This
29012 ensures that, for example, a host that stops accepting &"random"& local parts
29013 will eventually be noticed.
29014
29015 The callout caching mechanism is based on the domain of the address that is
29016 being tested. If the domain routes to several hosts, it is assumed that their
29017 behaviour will be the same.
29018
29019
29020
29021 .section "Sender address verification reporting" "SECTsenaddver"
29022 .cindex "verifying" "suppressing error details"
29023 See section &<<SECTaddressverification>>& for a general discussion of
29024 verification. When sender verification fails in an ACL, the details of the
29025 failure are given as additional output lines before the 550 response to the
29026 relevant SMTP command (RCPT or DATA). For example, if sender callout is in use,
29027 you might see:
29028 .code
29029 MAIL FROM:<xyz@abc.example>
29030 250 OK
29031 RCPT TO:<pqr@def.example>
29032 550-Verification failed for <xyz@abc.example>
29033 550-Called:   192.168.34.43
29034 550-Sent:     RCPT TO:<xyz@abc.example>
29035 550-Response: 550 Unknown local part xyz in <xyz@abc.example>
29036 550 Sender verification failed
29037 .endd
29038 If more than one RCPT command fails in the same way, the details are given
29039 only for the first of them. However, some administrators do not want to send
29040 out this much information. You can suppress the details by adding
29041 &`/no_details`& to the ACL statement that requests sender verification. For
29042 example:
29043 .code
29044 verify = sender/no_details
29045 .endd
29046
29047 .section "Redirection while verifying" "SECTredirwhilveri"
29048 .cindex "verifying" "redirection while"
29049 .cindex "address redirection" "while verifying"
29050 A dilemma arises when a local address is redirected by aliasing or forwarding
29051 during verification: should the generated addresses themselves be verified,
29052 or should the successful expansion of the original address be enough to verify
29053 it? By default, Exim takes the following pragmatic approach:
29054
29055 .ilist
29056 When an incoming address is redirected to just one child address, verification
29057 continues with the child address, and if that fails to verify, the original
29058 verification also fails.
29059 .next
29060 When an incoming address is redirected to more than one child address,
29061 verification does not continue. A success result is returned.
29062 .endlist
29063
29064 This seems the most reasonable behaviour for the common use of aliasing as a
29065 way of redirecting different local parts to the same mailbox. It means, for
29066 example, that a pair of alias entries of the form
29067 .code
29068 A.Wol:   aw123
29069 aw123:   :fail: Gone away, no forwarding address
29070 .endd
29071 work as expected, with both local parts causing verification failure. When a
29072 redirection generates more than one address, the behaviour is more like a
29073 mailing list, where the existence of the alias itself is sufficient for
29074 verification to succeed.
29075
29076 It is possible, however, to change the default behaviour so that all successful
29077 redirections count as successful verifications, however many new addresses are
29078 generated. This is specified by the &%success_on_redirect%& verification
29079 option. For example:
29080 .code
29081 require verify = recipient/success_on_redirect/callout=10s
29082 .endd
29083 In this example, verification succeeds if a router generates a new address, and
29084 the callout does not occur, because no address was routed to a remote host.
29085
29086 When verification is being tested via the &%-bv%& option, the treatment of
29087 redirections is as just described, unless the &%-v%& or any debugging option is
29088 also specified. In that case, full verification is done for every generated
29089 address and a report is output for each of them.
29090
29091
29092
29093 .section "Client SMTP authorization (CSA)" "SECTverifyCSA"
29094 .cindex "CSA" "verifying"
29095 Client SMTP Authorization is a system that allows a site to advertise
29096 which machines are and are not permitted to send email. This is done by placing
29097 special SRV records in the DNS; these are looked up using the client's HELO
29098 domain. At the time of writing, CSA is still an Internet Draft. Client SMTP
29099 Authorization checks in Exim are performed by the ACL condition:
29100 .code
29101 verify = csa
29102 .endd
29103 This fails if the client is not authorized. If there is a DNS problem, or if no
29104 valid CSA SRV record is found, or if the client is authorized, the condition
29105 succeeds. These three cases can be distinguished using the expansion variable
29106 &$csa_status$&, which can take one of the values &"fail"&, &"defer"&,
29107 &"unknown"&, or &"ok"&. The condition does not itself defer because that would
29108 be likely to cause problems for legitimate email.
29109
29110 The error messages produced by the CSA code include slightly more
29111 detail. If &$csa_status$& is &"defer"&, this may be because of problems
29112 looking up the CSA SRV record, or problems looking up the CSA target
29113 address record. There are four reasons for &$csa_status$& being &"fail"&:
29114
29115 .ilist
29116 The client's host name is explicitly not authorized.
29117 .next
29118 The client's IP address does not match any of the CSA target IP addresses.
29119 .next
29120 The client's host name is authorized but it has no valid target IP addresses
29121 (for example, the target's addresses are IPv6 and the client is using IPv4).
29122 .next
29123 The client's host name has no CSA SRV record but a parent domain has asserted
29124 that all subdomains must be explicitly authorized.
29125 .endlist
29126
29127 The &%csa%& verification condition can take an argument which is the domain to
29128 use for the DNS query. The default is:
29129 .code
29130 verify = csa/$sender_helo_name
29131 .endd
29132 This implementation includes an extension to CSA. If the query domain
29133 is an address literal such as [192.0.2.95], or if it is a bare IP
29134 address, Exim searches for CSA SRV records in the reverse DNS as if
29135 the HELO domain was (for example) &'95.2.0.192.in-addr.arpa'&. Therefore it is
29136 meaningful to say:
29137 .code
29138 verify = csa/$sender_host_address
29139 .endd
29140 In fact, this is the check that Exim performs if the client does not say HELO.
29141 This extension can be turned off by setting the main configuration option
29142 &%dns_csa_use_reverse%& to be false.
29143
29144 If a CSA SRV record is not found for the domain itself, a search
29145 is performed through its parent domains for a record which might be
29146 making assertions about subdomains. The maximum depth of this search is limited
29147 using the main configuration option &%dns_csa_search_limit%&, which is 5 by
29148 default. Exim does not look for CSA SRV records in a top level domain, so the
29149 default settings handle HELO domains as long as seven
29150 (&'hostname.five.four.three.two.one.com'&). This encompasses the vast majority
29151 of legitimate HELO domains.
29152
29153 The &'dnsdb'& lookup also has support for CSA. Although &'dnsdb'& also supports
29154 direct SRV lookups, this is not sufficient because of the extra parent domain
29155 search behaviour of CSA, and (as with PTR lookups) &'dnsdb'& also turns IP
29156 addresses into lookups in the reverse DNS space. The result of a successful
29157 lookup such as:
29158 .code
29159 ${lookup dnsdb {csa=$sender_helo_name}}
29160 .endd
29161 has two space-separated fields: an authorization code and a target host name.
29162 The authorization code can be &"Y"& for yes, &"N"& for no, &"X"& for explicit
29163 authorization required but absent, or &"?"& for unknown.
29164
29165
29166
29167
29168 .section "Bounce address tag validation" "SECTverifyPRVS"
29169 .cindex "BATV, verifying"
29170 Bounce address tag validation (BATV) is a scheme whereby the envelope senders
29171 of outgoing messages have a cryptographic, timestamped &"tag"& added to them.
29172 Genuine incoming bounce messages should therefore always be addressed to
29173 recipients that have a valid tag. This scheme is a way of detecting unwanted
29174 bounce messages caused by sender address forgeries (often called &"collateral
29175 spam"&), because the recipients of such messages do not include valid tags.
29176
29177 There are two expansion items to help with the implementation of the BATV
29178 &"prvs"& (private signature) scheme in an Exim configuration. This scheme signs
29179 the original envelope sender address by using a simple key to add a hash of the
29180 address and some time-based randomizing information. The &%prvs%& expansion
29181 item creates a signed address, and the &%prvscheck%& expansion item checks one.
29182 The syntax of these expansion items is described in section
29183 &<<SECTexpansionitems>>&.
29184
29185 As an example, suppose the secret per-address keys are stored in an MySQL
29186 database. A query to look up the key for an address could be defined as a macro
29187 like this:
29188 .code
29189 PRVSCHECK_SQL = ${lookup mysql{SELECT secret FROM batv_prvs \
29190                 WHERE sender='${quote_mysql:$prvscheck_address}'\
29191                 }{$value}}
29192 .endd
29193 Suppose also that the senders who make use of BATV are defined by an address
29194 list called &%batv_senders%&. Then, in the ACL for RCPT commands, you could
29195 use this:
29196 .code
29197 # Bounces: drop unsigned addresses for BATV senders
29198 deny message = This address does not send an unsigned reverse path
29199      senders = :
29200      recipients = +batv_senders
29201
29202 # Bounces: In case of prvs-signed address, check signature.
29203 deny message = Invalid reverse path signature.
29204      senders = :
29205      condition  = ${prvscheck {$local_part@$domain}\
29206                   {PRVSCHECK_SQL}{1}}
29207      !condition = $prvscheck_result
29208 .endd
29209 The first statement rejects recipients for bounce messages that are addressed
29210 to plain BATV sender addresses, because it is known that BATV senders do not
29211 send out messages with plain sender addresses. The second statement rejects
29212 recipients that are prvs-signed, but with invalid signatures (either because
29213 the key is wrong, or the signature has timed out).
29214
29215 A non-prvs-signed address is not rejected by the second statement, because the
29216 &%prvscheck%& expansion yields an empty string if its first argument is not a
29217 prvs-signed address, thus causing the &%condition%& condition to be false. If
29218 the first argument is a syntactically valid prvs-signed address, the yield is
29219 the third string (in this case &"1"&), whether or not the cryptographic and
29220 timeout checks succeed. The &$prvscheck_result$& variable contains the result
29221 of the checks (empty for failure, &"1"& for success).
29222
29223 There is one more issue you must consider when implementing prvs-signing:
29224 you have to ensure that the routers accept prvs-signed addresses and
29225 deliver them correctly. The easiest way to handle this is to use a &(redirect)&
29226 router to remove the signature with a configuration along these lines:
29227 .code
29228 batv_redirect:
29229   driver = redirect
29230   data = ${prvscheck {$local_part@$domain}{PRVSCHECK_SQL}}
29231 .endd
29232 This works because, if the third argument of &%prvscheck%& is empty, the result
29233 of the expansion of a prvs-signed address is the decoded value of the original
29234 address. This router should probably be the first of your routers that handles
29235 local addresses.
29236
29237 To create BATV-signed addresses in the first place, a transport of this form
29238 can be used:
29239 .code
29240 external_smtp_batv:
29241   driver = smtp
29242   return_path = ${prvs {$return_path} \
29243                        {${lookup mysql{SELECT \
29244                        secret FROM batv_prvs WHERE \
29245                        sender='${quote_mysql:$sender_address}'} \
29246                        {$value}fail}}}
29247 .endd
29248 If no key can be found for the existing return path, no signing takes place.
29249
29250
29251
29252 .section "Using an ACL to control relaying" "SECTrelaycontrol"
29253 .cindex "&ACL;" "relay control"
29254 .cindex "relaying" "control by ACL"
29255 .cindex "policy control" "relay control"
29256 An MTA is said to &'relay'& a message if it receives it from some host and
29257 delivers it directly to another host as a result of a remote address contained
29258 within it. Redirecting a local address via an alias or forward file and then
29259 passing the message on to another host is not relaying,
29260 .cindex "&""percent hack""&"
29261 but a redirection as a result of the &"percent hack"& is.
29262
29263 Two kinds of relaying exist, which are termed &"incoming"& and &"outgoing"&.
29264 A host which is acting as a gateway or an MX backup is concerned with incoming
29265 relaying from arbitrary hosts to a specific set of domains. On the other hand,
29266 a host which is acting as a smart host for a number of clients is concerned
29267 with outgoing relaying from those clients to the Internet at large. Often the
29268 same host is fulfilling both functions,
29269 . ///
29270 . as illustrated in the diagram below,
29271 . ///
29272 but in principle these two kinds of relaying are entirely independent. What is
29273 not wanted is the transmission of mail from arbitrary remote hosts through your
29274 system to arbitrary domains.
29275
29276
29277 You can implement relay control by means of suitable statements in the ACL that
29278 runs for each RCPT command. For convenience, it is often easiest to use
29279 Exim's named list facility to define the domains and hosts involved. For
29280 example, suppose you want to do the following:
29281
29282 .ilist
29283 Deliver a number of domains to mailboxes on the local host (or process them
29284 locally in some other way). Let's say these are &'my.dom1.example'& and
29285 &'my.dom2.example'&.
29286 .next
29287 Relay mail for a number of other domains for which you are the secondary MX.
29288 These might be &'friend1.example'& and &'friend2.example'&.
29289 .next
29290 Relay mail from the hosts on your local LAN, to whatever domains are involved.
29291 Suppose your LAN is 192.168.45.0/24.
29292 .endlist
29293
29294
29295 In the main part of the configuration, you put the following definitions:
29296 .code
29297 domainlist local_domains    = my.dom1.example : my.dom2.example
29298 domainlist relay_to_domains = friend1.example : friend2.example
29299 hostlist   relay_from_hosts = 192.168.45.0/24
29300 .endd
29301 Now you can use these definitions in the ACL that is run for every RCPT
29302 command:
29303 .code
29304 acl_check_rcpt:
29305   accept domains = +local_domains : +relay_to_domains
29306   accept hosts   = +relay_from_hosts
29307 .endd
29308 The first statement accepts any RCPT command that contains an address in
29309 the local or relay domains. For any other domain, control passes to the second
29310 statement, which accepts the command only if it comes from one of the relay
29311 hosts. In practice, you will probably want to make your ACL more sophisticated
29312 than this, for example, by including sender and recipient verification. The
29313 default configuration includes a more comprehensive example, which is described
29314 in chapter &<<CHAPdefconfil>>&.
29315
29316
29317
29318 .section "Checking a relay configuration" "SECTcheralcon"
29319 .cindex "relaying" "checking control of"
29320 You can check the relay characteristics of your configuration in the same way
29321 that you can test any ACL behaviour for an incoming SMTP connection, by using
29322 the &%-bh%& option to run a fake SMTP session with which you interact.
29323
29324 For specifically testing for unwanted relaying, the host
29325 &'relay-test.mail-abuse.org'& provides a useful service. If you telnet to this
29326 host from the host on which Exim is running, using the normal telnet port, you
29327 will see a normal telnet connection message and then quite a long delay. Be
29328 patient. The remote host is making an SMTP connection back to your host, and
29329 trying a number of common probes to test for open relay vulnerability. The
29330 results of the tests will eventually appear on your terminal.
29331 .ecindex IIDacl
29332
29333
29334
29335 . ////////////////////////////////////////////////////////////////////////////
29336 . ////////////////////////////////////////////////////////////////////////////
29337
29338 .chapter "Content scanning at ACL time" "CHAPexiscan"
29339 .scindex IIDcosca "content scanning" "at ACL time"
29340 The extension of Exim to include content scanning at ACL time, formerly known
29341 as &"exiscan"&, was originally implemented as a patch by Tom Kistner. The code
29342 was integrated into the main source for Exim release 4.50, and Tom continues to
29343 maintain it. Most of the wording of this chapter is taken from Tom's
29344 specification.
29345
29346 It is also possible to scan the content of messages at other times. The
29347 &[local_scan()]& function (see chapter &<<CHAPlocalscan>>&) allows for content
29348 scanning after all the ACLs have run. A transport filter can be used to scan
29349 messages at delivery time (see the &%transport_filter%& option, described in
29350 chapter &<<CHAPtransportgeneric>>&).
29351
29352 If you want to include the ACL-time content-scanning features when you compile
29353 Exim, you need to arrange for WITH_CONTENT_SCAN to be defined in your
29354 &_Local/Makefile_&. When you do that, the Exim binary is built with:
29355
29356 .ilist
29357 Two additional ACLs (&%acl_smtp_mime%& and &%acl_not_smtp_mime%&) that are run
29358 for all MIME parts for SMTP and non-SMTP messages, respectively.
29359 .next
29360 Additional ACL conditions and modifiers: &%decode%&, &%malware%&,
29361 &%mime_regex%&, &%regex%&, and &%spam%&. These can be used in the ACL that is
29362 run at the end of message reception (the &%acl_smtp_data%& ACL).
29363 .next
29364 An additional control feature (&"no_mbox_unspool"&) that saves spooled copies
29365 of messages, or parts of messages, for debugging purposes.
29366 .next
29367 Additional expansion variables that are set in the new ACL and by the new
29368 conditions.
29369 .next
29370 Two new main configuration options: &%av_scanner%& and &%spamd_address%&.
29371 .endlist
29372
29373 There is another content-scanning configuration option for &_Local/Makefile_&,
29374 called WITH_OLD_DEMIME. If this is set, the old, deprecated &%demime%& ACL
29375 condition is compiled, in addition to all the other content-scanning features.
29376
29377 Content-scanning is continually evolving, and new features are still being
29378 added. While such features are still unstable and liable to incompatible
29379 changes, they are made available in Exim by setting options whose names begin
29380 EXPERIMENTAL_ in &_Local/Makefile_&. Such features are not documented in
29381 this manual. You can find out about them by reading the file called
29382 &_doc/experimental.txt_&.
29383
29384 All the content-scanning facilities work on a MBOX copy of the message that is
29385 temporarily created in a file called:
29386 .display
29387 <&'spool_directory'&>&`/scan/`&<&'message_id'&>/<&'message_id'&>&`.eml`&
29388 .endd
29389 The &_.eml_& extension is a friendly hint to virus scanners that they can
29390 expect an MBOX-like structure inside that file. The file is created when the
29391 first content scanning facility is called. Subsequent calls to content
29392 scanning conditions open the same file again. The directory is recursively
29393 removed when the &%acl_smtp_data%& ACL has finished running, unless
29394 .code
29395 control = no_mbox_unspool
29396 .endd
29397 has been encountered. When the MIME ACL decodes files, they are put into the
29398 same directory by default.
29399
29400
29401
29402 .section "Scanning for viruses" "SECTscanvirus"
29403 .cindex "virus scanning"
29404 .cindex "content scanning" "for viruses"
29405 .cindex "content scanning" "the &%malware%& condition"
29406 The &%malware%& ACL condition lets you connect virus scanner software to Exim.
29407 It supports a &"generic"& interface to scanners called via the shell, and
29408 specialized interfaces for &"daemon"& type virus scanners, which are resident
29409 in memory and thus are much faster.
29410
29411
29412 .oindex "&%av_scanner%&"
29413 You can set the &%av_scanner%& option in first part of the Exim configuration
29414 file to specify which scanner to use, together with any additional options that
29415 are needed. The basic syntax is as follows:
29416 .display
29417 &`av_scanner = <`&&'scanner-type'&&`>:<`&&'option1'&&`>:<`&&'option2'&&`>:[...]`&
29418 .endd
29419 If you do not set &%av_scanner%&, it defaults to
29420 .code
29421 av_scanner = sophie:/var/run/sophie
29422 .endd
29423 If the value of &%av_scanner%& starts with a dollar character, it is expanded
29424 before use. The following scanner types are supported in this release:
29425
29426 .vlist
29427 .vitem &%aveserver%&
29428 .cindex "virus scanners" "Kaspersky"
29429 This is the scanner daemon of Kaspersky Version 5. You can get a trial version
29430 at &url(http://www.kaspersky.com). This scanner type takes one option,
29431 which is the path to the daemon's UNIX socket. The default is shown in this
29432 example:
29433 .code
29434 av_scanner = aveserver:/var/run/aveserver
29435 .endd
29436
29437
29438 .vitem &%clamd%&
29439 .cindex "virus scanners" "clamd"
29440 This daemon-type scanner is GPL and free. You can get it at
29441 &url(http://www.clamav.net/). Some older versions of clamd do not seem to
29442 unpack MIME containers, so it used to be recommended to unpack MIME attachments
29443 in the MIME ACL. This no longer believed to be necessary. One option is
29444 required: either the path and name of a UNIX socket file, or a hostname or IP
29445 number, and a port, separated by space, as in the second of these examples:
29446 .code
29447 av_scanner = clamd:/opt/clamd/socket
29448 av_scanner = clamd:192.0.2.3 1234
29449 av_scanner = clamd:192.0.2.3 1234:local
29450 .endd
29451 If the value of av_scanner points to a UNIX socket file or contains the local
29452 keyword, then the ClamAV interface will pass a filename containing the data
29453 to be scanned, which will should normally result in less I/O happening and be
29454 more efficient.  Normally in the TCP case, the data is streamed to ClamAV as
29455 Exim does not assume that there is a common filesystem with the remote host.
29456 There is an option WITH_OLD_CLAMAV_STREAM in &_src/EDITME_& available, should
29457 you be running a version of ClamAV prior to 0.95.
29458 If the option is unset, the default is &_/tmp/clamd_&. Thanks to David Saez for
29459 contributing the code for this scanner.
29460
29461 .vitem &%cmdline%&
29462 .cindex "virus scanners" "command line interface"
29463 This is the keyword for the generic command line scanner interface. It can be
29464 used to attach virus scanners that are invoked from the shell. This scanner
29465 type takes 3 mandatory options:
29466
29467 .olist
29468 The full path and name of the scanner binary, with all command line options,
29469 and a placeholder (&`%s`&) for the directory to scan.
29470
29471 .next
29472 A regular expression to match against the STDOUT and STDERR output of the
29473 virus scanner. If the expression matches, a virus was found. You must make
29474 absolutely sure that this expression matches on &"virus found"&. This is called
29475 the &"trigger"& expression.
29476
29477 .next
29478 Another regular expression, containing exactly one pair of parentheses, to
29479 match the name of the virus found in the scanners output. This is called the
29480 &"name"& expression.
29481 .endlist olist
29482
29483 For example, Sophos Sweep reports a virus on a line like this:
29484 .code
29485 Virus 'W32/Magistr-B' found in file ./those.bat
29486 .endd
29487 For the trigger expression, we can match the phrase &"found in file"&. For the
29488 name expression, we want to extract the W32/Magistr-B string, so we can match
29489 for the single quotes left and right of it. Altogether, this makes the
29490 configuration setting:
29491 .code
29492 av_scanner = cmdline:\
29493              /path/to/sweep -ss -all -rec -archive %s:\
29494              found in file:'(.+)'
29495 .endd
29496 .vitem &%drweb%&
29497 .cindex "virus scanners" "DrWeb"
29498 The DrWeb daemon scanner (&url(http://www.sald.com/)) interface takes one
29499 argument, either a full path to a UNIX socket, or an IP address and port
29500 separated by white space, as in these examples:
29501 .code
29502 av_scanner = drweb:/var/run/drwebd.sock
29503 av_scanner = drweb:192.168.2.20 31337
29504 .endd
29505 If you omit the argument, the default path &_/usr/local/drweb/run/drwebd.sock_&
29506 is used. Thanks to Alex Miller for contributing the code for this scanner.
29507
29508 .vitem &%fsecure%&
29509 .cindex "virus scanners" "F-Secure"
29510 The F-Secure daemon scanner (&url(http://www.f-secure.com)) takes one
29511 argument which is the path to a UNIX socket. For example:
29512 .code
29513 av_scanner = fsecure:/path/to/.fsav
29514 .endd
29515 If no argument is given, the default is &_/var/run/.fsav_&. Thanks to Johan
29516 Thelmen for contributing the code for this scanner.
29517
29518 .vitem &%kavdaemon%&
29519 .cindex "virus scanners" "Kaspersky"
29520 This is the scanner daemon of Kaspersky Version 4. This version of the
29521 Kaspersky scanner is outdated. Please upgrade (see &%aveserver%& above). This
29522 scanner type takes one option, which is the path to the daemon's UNIX socket.
29523 For example:
29524 .code
29525 av_scanner = kavdaemon:/opt/AVP/AvpCtl
29526 .endd
29527 The default path is &_/var/run/AvpCtl_&.
29528
29529 .vitem &%mksd%&
29530 .cindex "virus scanners" "mksd"
29531 This is a daemon type scanner that is aimed mainly at Polish users, though some
29532 parts of documentation are now available in English. You can get it at
29533 &url(http://linux.mks.com.pl/). The only option for this scanner type is
29534 the maximum number of processes used simultaneously to scan the attachments,
29535 provided that the demime facility is employed and also provided that mksd has
29536 been run with at least the same number of child processes. For example:
29537 .code
29538 av_scanner = mksd:2
29539 .endd
29540 You can safely omit this option (the default value is 1).
29541
29542 .vitem &%sophie%&
29543 .cindex "virus scanners" "Sophos and Sophie"
29544 Sophie is a daemon that uses Sophos' &%libsavi%& library to scan for viruses.
29545 You can get Sophie at &url(http://www.clanfield.info/sophie/). The only option
29546 for this scanner type is the path to the UNIX socket that Sophie uses for
29547 client communication. For example:
29548 .code
29549 av_scanner = sophie:/tmp/sophie
29550 .endd
29551 The default path is &_/var/run/sophie_&, so if you are using this, you can omit
29552 the option.
29553 .endlist
29554
29555 When &%av_scanner%& is correctly set, you can use the &%malware%& condition in
29556 the DATA ACL. &*Note*&: You cannot use the &%malware%& condition in the MIME
29557 ACL.
29558
29559 The &%av_scanner%& option is expanded each time &%malware%& is called. This
29560 makes it possible to use different scanners. See further below for an example.
29561 The &%malware%& condition caches its results, so when you use it multiple times
29562 for the same message, the actual scanning process is only carried out once.
29563 However, using expandable items in &%av_scanner%& disables this caching, in
29564 which case each use of the &%malware%& condition causes a new scan of the
29565 message.
29566
29567 The &%malware%& condition takes a right-hand argument that is expanded before
29568 use. It can then be one of
29569
29570 .ilist
29571 &"true"&, &"*"&, or &"1"&, in which case the message is scanned for viruses.
29572 The condition succeeds if a virus was found, and fail otherwise. This is the
29573 recommended usage.
29574 .next
29575 &"false"& or &"0"& or an empty string, in which case no scanning is done and
29576 the condition fails immediately.
29577 .next
29578 A regular expression, in which case the message is scanned for viruses. The
29579 condition succeeds if a virus is found and its name matches the regular
29580 expression. This allows you to take special actions on certain types of virus.
29581 .endlist
29582
29583 You can append &`/defer_ok`& to the &%malware%& condition to accept messages
29584 even if there is a problem with the virus scanner. Otherwise, such a problem
29585 causes the ACL to defer.
29586
29587 .vindex "&$malware_name$&"
29588 When a virus is found, the condition sets up an expansion variable called
29589 &$malware_name$& that contains the name of the virus. You can use it in a
29590 &%message%& modifier that specifies the error returned to the sender, and/or in
29591 logging data.
29592
29593 If your virus scanner cannot unpack MIME and TNEF containers itself, you should
29594 use the &%demime%& condition (see section &<<SECTdemimecond>>&) before the
29595 &%malware%& condition.
29596
29597 Beware the interaction of Exim's &%message_size_limit%& with any size limits
29598 imposed by your anti-virus scanner.
29599
29600 Here is a very simple scanning example:
29601 .code
29602 deny message = This message contains malware ($malware_name)
29603      demime = *
29604      malware = *
29605 .endd
29606 The next example accepts messages when there is a problem with the scanner:
29607 .code
29608 deny message = This message contains malware ($malware_name)
29609      demime = *
29610      malware = */defer_ok
29611 .endd
29612 The next example shows how to use an ACL variable to scan with both sophie and
29613 aveserver. It assumes you have set:
29614 .code
29615 av_scanner = $acl_m0
29616 .endd
29617 in the main Exim configuration.
29618 .code
29619 deny message = This message contains malware ($malware_name)
29620      set acl_m0 = sophie
29621      malware = *
29622
29623 deny message = This message contains malware ($malware_name)
29624      set acl_m0 = aveserver
29625      malware = *
29626 .endd
29627
29628
29629 .section "Scanning with SpamAssassin" "SECTscanspamass"
29630 .cindex "content scanning" "for spam"
29631 .cindex "spam scanning"
29632 .cindex "SpamAssassin"
29633 The &%spam%& ACL condition calls SpamAssassin's &%spamd%& daemon to get a spam
29634 score and a report for the message. You can get SpamAssassin at
29635 &url(http://www.spamassassin.org), or, if you have a working Perl
29636 installation, you can use CPAN by running:
29637 .code
29638 perl -MCPAN -e 'install Mail::SpamAssassin'
29639 .endd
29640 SpamAssassin has its own set of configuration files. Please review its
29641 documentation to see how you can tweak it. The default installation should work
29642 nicely, however.
29643
29644 .oindex "&%spamd_address%&"
29645 After having installed and configured SpamAssassin, start the &%spamd%& daemon.
29646 By default, it listens on 127.0.0.1, TCP port 783. If you use another host or
29647 port for &%spamd%&, you must set the &%spamd_address%& option in the global
29648 part of the Exim configuration as follows (example):
29649 .code
29650 spamd_address = 192.168.99.45 387
29651 .endd
29652 You do not need to set this option if you use the default. As of version 2.60,
29653 &%spamd%& also supports communication over UNIX sockets. If you want to use
29654 these, supply &%spamd_address%& with an absolute file name instead of a
29655 address/port pair:
29656 .code
29657 spamd_address = /var/run/spamd_socket
29658 .endd
29659 You can have multiple &%spamd%& servers to improve scalability. These can
29660 reside on other hardware reachable over the network. To specify multiple
29661 &%spamd%& servers, put multiple address/port pairs in the &%spamd_address%&
29662 option, separated with colons:
29663 .code
29664 spamd_address = 192.168.2.10 783 : \
29665                 192.168.2.11 783 : \
29666                 192.168.2.12 783
29667 .endd
29668 Up to 32 &%spamd%& servers are supported. The servers are queried in a random
29669 fashion. When a server fails to respond to the connection attempt, all other
29670 servers are tried until one succeeds. If no server responds, the &%spam%&
29671 condition defers.
29672
29673 &*Warning*&: It is not possible to use the UNIX socket connection method with
29674 multiple &%spamd%& servers.
29675
29676 The &%spamd_address%& variable is expanded before use if it starts with
29677 a dollar sign. In this case, the expansion may return a string that is
29678 used as the list so that multiple spamd servers can be the result of an
29679 expansion.
29680
29681 .section "Calling SpamAssassin from an Exim ACL" "SECID206"
29682 Here is a simple example of the use of the &%spam%& condition in a DATA ACL:
29683 .code
29684 deny message = This message was classified as SPAM
29685      spam = joe
29686 .endd
29687 The right-hand side of the &%spam%& condition specifies a name. This is
29688 relevant if you have set up multiple SpamAssassin profiles. If you do not want
29689 to scan using a specific profile, but rather use the SpamAssassin system-wide
29690 default profile, you can scan for an unknown name, or simply use &"nobody"&.
29691 However, you must put something on the right-hand side.
29692
29693 The name allows you to use per-domain or per-user antispam profiles in
29694 principle, but this is not straightforward in practice, because a message may
29695 have multiple recipients, not necessarily all in the same domain. Because the
29696 &%spam%& condition has to be called from a DATA ACL in order to be able to
29697 read the contents of the message, the variables &$local_part$& and &$domain$&
29698 are not set.
29699
29700 The right-hand side of the &%spam%& condition is expanded before being used, so
29701 you can put lookups or conditions there. When the right-hand side evaluates to
29702 &"0"& or &"false"&, no scanning is done and the condition fails immediately.
29703
29704
29705 Scanning with SpamAssassin uses a lot of resources. If you scan every message,
29706 large ones may cause significant performance degradation. As most spam messages
29707 are quite small, it is recommended that you do not scan the big ones. For
29708 example:
29709 .code
29710 deny message = This message was classified as SPAM
29711      condition = ${if < {$message_size}{10K}}
29712      spam = nobody
29713 .endd
29714
29715 The &%spam%& condition returns true if the threshold specified in the user's
29716 SpamAssassin profile has been matched or exceeded. If you want to use the
29717 &%spam%& condition for its side effects (see the variables below), you can make
29718 it always return &"true"& by appending &`:true`& to the username.
29719
29720 .cindex "spam scanning" "returned variables"
29721 When the &%spam%& condition is run, it sets up a number of expansion
29722 variables. These variables are saved with the received message, thus they are
29723 available for use at delivery time.
29724
29725 .vlist
29726 .vitem &$spam_score$&
29727 The spam score of the message, for example &"3.4"& or &"30.5"&. This is useful
29728 for inclusion in log or reject messages.
29729
29730 .vitem &$spam_score_int$&
29731 The spam score of the message, multiplied by ten, as an integer value. For
29732 example &"34"& or &"305"&. It may appear to disagree with &$spam_score$&
29733 because &$spam_score$& is rounded and &$spam_score_int$& is truncated.
29734 The integer value is useful for numeric comparisons in conditions.
29735
29736 .vitem &$spam_bar$&
29737 A string consisting of a number of &"+"& or &"-"& characters, representing the
29738 integer part of the spam score value. A spam score of 4.4 would have a
29739 &$spam_bar$& value of &"++++"&. This is useful for inclusion in warning
29740 headers, since MUAs can match on such strings.
29741
29742 .vitem &$spam_report$&
29743 A multiline text table, containing the full SpamAssassin report for the
29744 message. Useful for inclusion in headers or reject messages.
29745 .endlist
29746
29747 The &%spam%& condition caches its results unless expansion in
29748 spamd_address was used. If you call it again with the same user name, it
29749 does not scan again, but rather returns the same values as before.
29750
29751 The &%spam%& condition returns DEFER if there is any error while running
29752 the message through SpamAssassin or if the expansion of spamd_address
29753 failed. If you want to treat DEFER as FAIL (to pass on to the next ACL
29754 statement block), append &`/defer_ok`& to the right-hand side of the
29755 spam condition, like this:
29756 .code
29757 deny message = This message was classified as SPAM
29758      spam    = joe/defer_ok
29759 .endd
29760 This causes messages to be accepted even if there is a problem with &%spamd%&.
29761
29762 Here is a longer, commented example of the use of the &%spam%&
29763 condition:
29764 .code
29765 # put headers in all messages (no matter if spam or not)
29766 warn  spam = nobody:true
29767       add_header = X-Spam-Score: $spam_score ($spam_bar)
29768       add_header = X-Spam-Report: $spam_report
29769
29770 # add second subject line with *SPAM* marker when message
29771 # is over threshold
29772 warn  spam = nobody
29773       add_header = Subject: *SPAM* $h_Subject:
29774
29775 # reject spam at high scores (> 12)
29776 deny  message = This message scored $spam_score spam points.
29777       spam = nobody:true
29778       condition = ${if >{$spam_score_int}{120}{1}{0}}
29779 .endd
29780
29781
29782
29783 .section "Scanning MIME parts" "SECTscanmimepart"
29784 .cindex "content scanning" "MIME parts"
29785 .cindex "MIME content scanning"
29786 .oindex "&%acl_smtp_mime%&"
29787 .oindex "&%acl_not_smtp_mime%&"
29788 The &%acl_smtp_mime%& global option specifies an ACL that is called once for
29789 each MIME part of an SMTP message, including multipart types, in the sequence
29790 of their position in the message. Similarly, the &%acl_not_smtp_mime%& option
29791 specifies an ACL that is used for the MIME parts of non-SMTP messages. These
29792 options may both refer to the same ACL if you want the same processing in both
29793 cases.
29794
29795 These ACLs are called (possibly many times) just before the &%acl_smtp_data%&
29796 ACL in the case of an SMTP message, or just before the &%acl_not_smtp%& ACL in
29797 the case of a non-SMTP message. However, a MIME ACL is called only if the
29798 message contains a &'Content-Type:'& header line. When a call to a MIME
29799 ACL does not yield &"accept"&, ACL processing is aborted and the appropriate
29800 result code is sent to the client. In the case of an SMTP message, the
29801 &%acl_smtp_data%& ACL is not called when this happens.
29802
29803 You cannot use the &%malware%& or &%spam%& conditions in a MIME ACL; these can
29804 only be used in the DATA or non-SMTP ACLs. However, you can use the &%regex%&
29805 condition to match against the raw MIME part. You can also use the
29806 &%mime_regex%& condition to match against the decoded MIME part (see section
29807 &<<SECTscanregex>>&).
29808
29809 At the start of a MIME ACL, a number of variables are set from the header
29810 information for the relevant MIME part. These are described below. The contents
29811 of the MIME part are not by default decoded into a disk file except for MIME
29812 parts whose content-type is &"message/rfc822"&. If you want to decode a MIME
29813 part into a disk file, you can use the &%decode%& condition. The general
29814 syntax is:
29815 .display
29816 &`decode = [/`&<&'path'&>&`/]`&<&'filename'&>
29817 .endd
29818 The right hand side is expanded before use. After expansion,
29819 the value can be:
29820
29821 .olist
29822 &"0"& or &"false"&, in which case no decoding is done.
29823 .next
29824 The string &"default"&. In that case, the file is put in the temporary
29825 &"default"& directory <&'spool_directory'&>&_/scan/_&<&'message_id'&>&_/_& with
29826 a sequential file name consisting of the message id and a sequence number. The
29827 full path and name is available in &$mime_decoded_filename$& after decoding.
29828 .next
29829 A full path name starting with a slash. If the full name is an existing
29830 directory, it is used as a replacement for the default directory. The filename
29831 is then sequentially assigned. If the path does not exist, it is used as
29832 the full path and file name.
29833 .next
29834 If the string does not start with a slash, it is used as the
29835 filename, and the default path is then used.
29836 .endlist
29837 The &%decode%& condition normally succeeds. It is only false for syntax
29838 errors or unusual circumstances such as memory shortages. You can easily decode
29839 a file with its original, proposed filename using
29840 .code
29841 decode = $mime_filename
29842 .endd
29843 However, you should keep in mind that &$mime_filename$& might contain
29844 anything. If you place files outside of the default path, they are not
29845 automatically unlinked.
29846
29847 For RFC822 attachments (these are messages attached to messages, with a
29848 content-type of &"message/rfc822"&), the ACL is called again in the same manner
29849 as for the primary message, only that the &$mime_is_rfc822$& expansion
29850 variable is set (see below). Attached messages are always decoded to disk
29851 before being checked, and the files are unlinked once the check is done.
29852
29853 The MIME ACL supports the &%regex%& and &%mime_regex%& conditions. These can be
29854 used to match regular expressions against raw and decoded MIME parts,
29855 respectively. They are described in section &<<SECTscanregex>>&.
29856
29857 .cindex "MIME content scanning" "returned variables"
29858 The following list describes all expansion variables that are
29859 available in the MIME ACL:
29860
29861 .vlist
29862 .vitem &$mime_boundary$&
29863 If the current part is a multipart (see &$mime_is_multipart$&) below, it should
29864 have a boundary string, which is stored in this variable. If the current part
29865 has no boundary parameter in the &'Content-Type:'& header, this variable
29866 contains the empty string.
29867
29868 .vitem &$mime_charset$&
29869 This variable contains the character set identifier, if one was found in the
29870 &'Content-Type:'& header. Examples for charset identifiers are:
29871 .code
29872 us-ascii
29873 gb2312 (Chinese)
29874 iso-8859-1
29875 .endd
29876 Please note that this value is not normalized, so you should do matches
29877 case-insensitively.
29878
29879 .vitem &$mime_content_description$&
29880 This variable contains the normalized content of the &'Content-Description:'&
29881 header. It can contain a human-readable description of the parts content. Some
29882 implementations repeat the filename for attachments here, but they are usually
29883 only used for display purposes.
29884
29885 .vitem &$mime_content_disposition$&
29886 This variable contains the normalized content of the &'Content-Disposition:'&
29887 header. You can expect strings like &"attachment"& or &"inline"& here.
29888
29889 .vitem &$mime_content_id$&
29890 This variable contains the normalized content of the &'Content-ID:'& header.
29891 This is a unique ID that can be used to reference a part from another part.
29892
29893 .vitem &$mime_content_size$&
29894 This variable is set only after the &%decode%& modifier (see above) has been
29895 successfully run. It contains the size of the decoded part in kilobytes. The
29896 size is always rounded up to full kilobytes, so only a completely empty part
29897 has a &$mime_content_size$& of zero.
29898
29899 .vitem &$mime_content_transfer_encoding$&
29900 This variable contains the normalized content of the
29901 &'Content-transfer-encoding:'& header. This is a symbolic name for an encoding
29902 type. Typical values are &"base64"& and &"quoted-printable"&.
29903
29904 .vitem &$mime_content_type$&
29905 If the MIME part has a &'Content-Type:'& header, this variable contains its
29906 value, lowercased, and without any options (like &"name"& or &"charset"&). Here
29907 are some examples of popular MIME types, as they may appear in this variable:
29908 .code
29909 text/plain
29910 text/html
29911 application/octet-stream
29912 image/jpeg
29913 audio/midi
29914 .endd
29915 If the MIME part has no &'Content-Type:'& header, this variable contains the
29916 empty string.
29917
29918 .vitem &$mime_decoded_filename$&
29919 This variable is set only after the &%decode%& modifier (see above) has been
29920 successfully run. It contains the full path and file name of the file
29921 containing the decoded data.
29922 .endlist
29923
29924 .cindex "RFC 2047"
29925 .vlist
29926 .vitem &$mime_filename$&
29927 This is perhaps the most important of the MIME variables. It contains a
29928 proposed filename for an attachment, if one was found in either the
29929 &'Content-Type:'& or &'Content-Disposition:'& headers. The filename will be
29930 RFC2047 decoded, but no additional sanity checks are done. If no filename was
29931 found, this variable contains the empty string.
29932
29933 .vitem &$mime_is_coverletter$&
29934 This variable attempts to differentiate the &"cover letter"& of an e-mail from
29935 attached data. It can be used to clamp down on flashy or unnecessarily encoded
29936 content in the cover letter, while not restricting attachments at all.
29937
29938 The variable contains 1 (true) for a MIME part believed to be part of the
29939 cover letter, and 0 (false) for an attachment. At present, the algorithm is as
29940 follows:
29941
29942 .olist
29943 The outermost MIME part of a message is always a cover letter.
29944
29945 .next
29946 If a multipart/alternative or multipart/related MIME part is a cover letter,
29947 so are all MIME subparts within that multipart.
29948
29949 .next
29950 If any other multipart is a cover letter, the first subpart is a cover letter,
29951 and the rest are attachments.
29952
29953 .next
29954 All parts contained within an attachment multipart are attachments.
29955 .endlist olist
29956
29957 As an example, the following will ban &"HTML mail"& (including that sent with
29958 alternative plain text), while allowing HTML files to be attached. HTML
29959 coverletter mail attached to non-HMTL coverletter mail will also be allowed:
29960 .code
29961 deny message = HTML mail is not accepted here
29962 !condition = $mime_is_rfc822
29963 condition = $mime_is_coverletter
29964 condition = ${if eq{$mime_content_type}{text/html}{1}{0}}
29965 .endd
29966 .vitem &$mime_is_multipart$&
29967 This variable has the value 1 (true) when the current part has the main type
29968 &"multipart"&, for example &"multipart/alternative"& or &"multipart/mixed"&.
29969 Since multipart entities only serve as containers for other parts, you may not
29970 want to carry out specific actions on them.
29971
29972 .vitem &$mime_is_rfc822$&
29973 This variable has the value 1 (true) if the current part is not a part of the
29974 checked message itself, but part of an attached message. Attached message
29975 decoding is fully recursive.
29976
29977 .vitem &$mime_part_count$&
29978 This variable is a counter that is raised for each processed MIME part. It
29979 starts at zero for the very first part (which is usually a multipart). The
29980 counter is per-message, so it is reset when processing RFC822 attachments (see
29981 &$mime_is_rfc822$&). The counter stays set after &%acl_smtp_mime%& is
29982 complete, so you can use it in the DATA ACL to determine the number of MIME
29983 parts of a message. For non-MIME messages, this variable contains the value -1.
29984 .endlist
29985
29986
29987
29988 .section "Scanning with regular expressions" "SECTscanregex"
29989 .cindex "content scanning" "with regular expressions"
29990 .cindex "regular expressions" "content scanning with"
29991 You can specify your own custom regular expression matches on the full body of
29992 the message, or on individual MIME parts.
29993
29994 The &%regex%& condition takes one or more regular expressions as arguments and
29995 matches them against the full message (when called in the DATA ACL) or a raw
29996 MIME part (when called in the MIME ACL). The &%regex%& condition matches
29997 linewise, with a maximum line length of 32K characters. That means you cannot
29998 have multiline matches with the &%regex%& condition.
29999
30000 The &%mime_regex%& condition can be called only in the MIME ACL. It matches up
30001 to 32K of decoded content (the whole content at once, not linewise). If the
30002 part has not been decoded with the &%decode%& modifier earlier in the ACL, it
30003 is decoded automatically when &%mime_regex%& is executed (using default path
30004 and filename values). If the decoded data is larger than  32K, only the first
30005 32K characters are checked.
30006
30007 The regular expressions are passed as a colon-separated list. To include a
30008 literal colon, you must double it. Since the whole right-hand side string is
30009 expanded before being used, you must also escape dollar signs and backslashes
30010 with more backslashes, or use the &`\N`& facility to disable expansion.
30011 Here is a simple example that contains two regular expressions:
30012 .code
30013 deny message = contains blacklisted regex ($regex_match_string)
30014      regex = [Mm]ortgage : URGENT BUSINESS PROPOSAL
30015 .endd
30016 The conditions returns true if any one of the regular expressions matches. The
30017 &$regex_match_string$& expansion variable is then set up and contains the
30018 matching regular expression.
30019
30020 &*Warning*&: With large messages, these conditions can be fairly
30021 CPU-intensive.
30022
30023
30024
30025
30026 .section "The demime condition" "SECTdemimecond"
30027 .cindex "content scanning" "MIME checking"
30028 .cindex "MIME content scanning"
30029 The &%demime%& ACL condition provides MIME unpacking, sanity checking and file
30030 extension blocking. It is usable only in the DATA and non-SMTP ACLs. The
30031 &%demime%& condition uses a simpler interface to MIME decoding than the MIME
30032 ACL functionality, but provides no additional facilities. Please note that this
30033 condition is deprecated and kept only for backward compatibility. You must set
30034 the WITH_OLD_DEMIME option in &_Local/Makefile_& at build time to be able to
30035 use the &%demime%& condition.
30036
30037 The &%demime%& condition unpacks MIME containers in the message. It detects
30038 errors in MIME containers and can match file extensions found in the message
30039 against a list. Using this facility produces files containing the unpacked MIME
30040 parts of the message in the temporary scan directory. If you do antivirus
30041 scanning, it is recommended that you use the &%demime%& condition before the
30042 antivirus (&%malware%&) condition.
30043
30044 On the right-hand side of the &%demime%& condition you can pass a
30045 colon-separated list of file extensions that it should match against. For
30046 example:
30047 .code
30048 deny message = Found blacklisted file attachment
30049      demime  = vbs:com:bat:pif:prf:lnk
30050 .endd
30051 If one of the file extensions is found, the condition is true, otherwise it is
30052 false. If there is a temporary error while demimeing (for example, &"disk
30053 full"&), the condition defers, and the message is temporarily rejected (unless
30054 the condition is on a &%warn%& verb).
30055
30056 The right-hand side is expanded before being treated as a list, so you can have
30057 conditions and lookups there. If it expands to an empty string, &"false"&, or
30058 zero (&"0"&), no demimeing is done and the condition is false.
30059
30060 The &%demime%& condition set the following variables:
30061
30062 .vlist
30063 .vitem &$demime_errorlevel$&
30064 .vindex "&$demime_errorlevel$&"
30065 When an error is detected in a MIME container, this variable contains the
30066 severity of the error, as an integer number. The higher the value, the more
30067 severe the error (the current maximum value is 3). If this variable is unset or
30068 zero, no error occurred.
30069
30070 .vitem &$demime_reason$&
30071 .vindex "&$demime_reason$&"
30072 When &$demime_errorlevel$& is greater than zero, this variable contains a
30073 human-readable text string describing the MIME error that occurred.
30074 .endlist
30075
30076 .vlist
30077 .vitem &$found_extension$&
30078 .vindex "&$found_extension$&"
30079 When the &%demime%& condition is true, this variable contains the file
30080 extension it found.
30081 .endlist
30082
30083 Both &$demime_errorlevel$& and &$demime_reason$& are set by the first call of
30084 the &%demime%& condition, and are not changed on subsequent calls.
30085
30086 If you do not want to check for file extensions, but rather use the &%demime%&
30087 condition for unpacking or error checking purposes, pass &"*"& as the
30088 right-hand side value. Here is a more elaborate example of how to use this
30089 facility:
30090 .code
30091 # Reject messages with serious MIME container errors
30092 deny  message = Found MIME error ($demime_reason).
30093       demime = *
30094       condition = ${if >{$demime_errorlevel}{2}{1}{0}}
30095
30096 # Reject known virus spreading file extensions.
30097 # Accepting these is pretty much braindead.
30098 deny  message = contains $found_extension file (blacklisted).
30099       demime  = com:vbs:bat:pif:scr
30100
30101 # Freeze .exe and .doc files. Postmaster can
30102 # examine them and eventually thaw them.
30103 deny  log_message = Another $found_extension file.
30104       demime = exe:doc
30105       control = freeze
30106 .endd
30107 .ecindex IIDcosca
30108
30109
30110
30111
30112 . ////////////////////////////////////////////////////////////////////////////
30113 . ////////////////////////////////////////////////////////////////////////////
30114
30115 .chapter "Adding a local scan function to Exim" "CHAPlocalscan" &&&
30116          "Local scan function"
30117 .scindex IIDlosca "&[local_scan()]& function" "description of"
30118 .cindex "customizing" "input scan using C function"
30119 .cindex "policy control" "by local scan function"
30120 In these days of email worms, viruses, and ever-increasing spam, some sites
30121 want to apply a lot of checking to messages before accepting them.
30122
30123 The content scanning extension (chapter &<<CHAPexiscan>>&) has facilities for
30124 passing messages to external virus and spam scanning software. You can also do
30125 a certain amount in Exim itself through string expansions and the &%condition%&
30126 condition in the ACL that runs after the SMTP DATA command or the ACL for
30127 non-SMTP messages (see chapter &<<CHAPACL>>&), but this has its limitations.
30128
30129 To allow for further customization to a site's own requirements, there is the
30130 possibility of linking Exim with a private message scanning function, written
30131 in C. If you want to run code that is written in something other than C, you
30132 can of course use a little C stub to call it.
30133
30134 The local scan function is run once for every incoming message, at the point
30135 when Exim is just about to accept the message.
30136 It can therefore be used to control non-SMTP messages from local processes as
30137 well as messages arriving via SMTP.
30138
30139 Exim applies a timeout to calls of the local scan function, and there is an
30140 option called &%local_scan_timeout%& for setting it. The default is 5 minutes.
30141 Zero means &"no timeout"&.
30142 Exim also sets up signal handlers for SIGSEGV, SIGILL, SIGFPE, and SIGBUS
30143 before calling the local scan function, so that the most common types of crash
30144 are caught. If the timeout is exceeded or one of those signals is caught, the
30145 incoming message is rejected with a temporary error if it is an SMTP message.
30146 For a non-SMTP message, the message is dropped and Exim ends with a non-zero
30147 code. The incident is logged on the main and reject logs.
30148
30149
30150
30151 .section "Building Exim to use a local scan function" "SECID207"
30152 .cindex "&[local_scan()]& function" "building Exim to use"
30153 To make use of the local scan function feature, you must tell Exim where your
30154 function is before building Exim, by setting LOCAL_SCAN_SOURCE in your
30155 &_Local/Makefile_&. A recommended place to put it is in the &_Local_&
30156 directory, so you might set
30157 .code
30158 LOCAL_SCAN_SOURCE=Local/local_scan.c
30159 .endd
30160 for example. The function must be called &[local_scan()]&. It is called by
30161 Exim after it has received a message, when the success return code is about to
30162 be sent. This is after all the ACLs have been run. The return code from your
30163 function controls whether the message is actually accepted or not. There is a
30164 commented template function (that just accepts the message) in the file
30165 _src/local_scan.c_.
30166
30167 If you want to make use of Exim's run time configuration file to set options
30168 for your &[local_scan()]& function, you must also set
30169 .code
30170 LOCAL_SCAN_HAS_OPTIONS=yes
30171 .endd
30172 in &_Local/Makefile_& (see section &<<SECTconoptloc>>& below).
30173
30174
30175
30176
30177 .section "API for local_scan()" "SECTapiforloc"
30178 .cindex "&[local_scan()]& function" "API description"
30179 You must include this line near the start of your code:
30180 .code
30181 #include "local_scan.h"
30182 .endd
30183 This header file defines a number of variables and other values, and the
30184 prototype for the function itself. Exim is coded to use unsigned char values
30185 almost exclusively, and one of the things this header defines is a shorthand
30186 for &`unsigned char`& called &`uschar`&.
30187 It also contains the following macro definitions, to simplify casting character
30188 strings and pointers to character strings:
30189 .code
30190 #define CS   (char *)
30191 #define CCS  (const char *)
30192 #define CSS  (char **)
30193 #define US   (unsigned char *)
30194 #define CUS  (const unsigned char *)
30195 #define USS  (unsigned char **)
30196 .endd
30197 The function prototype for &[local_scan()]& is:
30198 .code
30199 extern int local_scan(int fd, uschar **return_text);
30200 .endd
30201 The arguments are as follows:
30202
30203 .ilist
30204 &%fd%& is a file descriptor for the file that contains the body of the message
30205 (the -D file). The file is open for reading and writing, but updating it is not
30206 recommended. &*Warning*&: You must &'not'& close this file descriptor.
30207
30208 The descriptor is positioned at character 19 of the file, which is the first
30209 character of the body itself, because the first 19 characters are the message
30210 id followed by &`-D`& and a newline. If you rewind the file, you should use the
30211 macro SPOOL_DATA_START_OFFSET to reset to the start of the data, just in
30212 case this changes in some future version.
30213 .next
30214 &%return_text%& is an address which you can use to return a pointer to a text
30215 string at the end of the function. The value it points to on entry is NULL.
30216 .endlist
30217
30218 The function must return an &%int%& value which is one of the following macros:
30219
30220 .vlist
30221 .vitem &`LOCAL_SCAN_ACCEPT`&
30222 .vindex "&$local_scan_data$&"
30223 The message is accepted. If you pass back a string of text, it is saved with
30224 the message, and made available in the variable &$local_scan_data$&. No
30225 newlines are permitted (if there are any, they are turned into spaces) and the
30226 maximum length of text is 1000 characters.
30227
30228 .vitem &`LOCAL_SCAN_ACCEPT_FREEZE`&
30229 This behaves as LOCAL_SCAN_ACCEPT, except that the accepted message is
30230 queued without immediate delivery, and is frozen.
30231
30232 .vitem &`LOCAL_SCAN_ACCEPT_QUEUE`&
30233 This behaves as LOCAL_SCAN_ACCEPT, except that the accepted message is
30234 queued without immediate delivery.
30235
30236 .vitem &`LOCAL_SCAN_REJECT`&
30237 The message is rejected; the returned text is used as an error message which is
30238 passed back to the sender and which is also logged. Newlines are permitted &--
30239 they cause a multiline response for SMTP rejections, but are converted to
30240 &`\n`& in log lines. If no message is given, &"Administrative prohibition"& is
30241 used.
30242
30243 .vitem &`LOCAL_SCAN_TEMPREJECT`&
30244 The message is temporarily rejected; the returned text is used as an error
30245 message as for LOCAL_SCAN_REJECT. If no message is given, &"Temporary local
30246 problem"& is used.
30247
30248 .vitem &`LOCAL_SCAN_REJECT_NOLOGHDR`&
30249 This behaves as LOCAL_SCAN_REJECT, except that the header of the rejected
30250 message is not written to the reject log. It has the effect of unsetting the
30251 &%rejected_header%& log selector for just this rejection. If
30252 &%rejected_header%& is already unset (see the discussion of the
30253 &%log_selection%& option in section &<<SECTlogselector>>&), this code is the
30254 same as LOCAL_SCAN_REJECT.
30255
30256 .vitem &`LOCAL_SCAN_TEMPREJECT_NOLOGHDR`&
30257 This code is a variation of LOCAL_SCAN_TEMPREJECT in the same way that
30258 LOCAL_SCAN_REJECT_NOLOGHDR is a variation of LOCAL_SCAN_REJECT.
30259 .endlist
30260
30261 If the message is not being received by interactive SMTP, rejections are
30262 reported by writing to &%stderr%& or by sending an email, as configured by the
30263 &%-oe%& command line options.
30264
30265
30266
30267 .section "Configuration options for local_scan()" "SECTconoptloc"
30268 .cindex "&[local_scan()]& function" "configuration options"
30269 It is possible to have option settings in the main configuration file
30270 that set values in static variables in the &[local_scan()]& module. If you
30271 want to do this, you must have the line
30272 .code
30273 LOCAL_SCAN_HAS_OPTIONS=yes
30274 .endd
30275 in your &_Local/Makefile_& when you build Exim. (This line is in
30276 &_OS/Makefile-Default_&, commented out). Then, in the &[local_scan()]& source
30277 file, you must define static variables to hold the option values, and a table
30278 to define them.
30279
30280 The table must be a vector called &%local_scan_options%&, of type
30281 &`optionlist`&. Each entry is a triplet, consisting of a name, an option type,
30282 and a pointer to the variable that holds the value. The entries must appear in
30283 alphabetical order. Following &%local_scan_options%& you must also define a
30284 variable called &%local_scan_options_count%& that contains the number of
30285 entries in the table. Here is a short example, showing two kinds of option:
30286 .code
30287 static int my_integer_option = 42;
30288 static uschar *my_string_option = US"a default string";
30289
30290 optionlist local_scan_options[] = {
30291   { "my_integer", opt_int,       &my_integer_option },
30292   { "my_string",  opt_stringptr, &my_string_option }
30293 };
30294
30295 int local_scan_options_count =
30296   sizeof(local_scan_options)/sizeof(optionlist);
30297 .endd
30298 The values of the variables can now be changed from Exim's runtime
30299 configuration file by including a local scan section as in this example:
30300 .code
30301 begin local_scan
30302 my_integer = 99
30303 my_string = some string of text...
30304 .endd
30305 The available types of option data are as follows:
30306
30307 .vlist
30308 .vitem &*opt_bool*&
30309 This specifies a boolean (true/false) option. The address should point to a
30310 variable of type &`BOOL`&, which will be set to TRUE or FALSE, which are macros
30311 that are defined as &"1"& and &"0"&, respectively. If you want to detect
30312 whether such a variable has been set at all, you can initialize it to
30313 TRUE_UNSET. (BOOL variables are integers underneath, so can hold more than two
30314 values.)
30315
30316 .vitem &*opt_fixed*&
30317 This specifies a fixed point number, such as is used for load averages.
30318 The address should point to a variable of type &`int`&. The value is stored
30319 multiplied by 1000, so, for example, 1.4142 is truncated and stored as 1414.
30320
30321 .vitem &*opt_int*&
30322 This specifies an integer; the address should point to a variable of type
30323 &`int`&. The value may be specified in any of the integer formats accepted by
30324 Exim.
30325
30326 .vitem &*opt_mkint*&
30327 This is the same as &%opt_int%&, except that when such a value is output in a
30328 &%-bP%& listing, if it is an exact number of kilobytes or megabytes, it is
30329 printed with the suffix K or M.
30330
30331 .vitem &*opt_octint*&
30332 This also specifies an integer, but the value is always interpreted as an
30333 octal integer, whether or not it starts with the digit zero, and it is
30334 always output in octal.
30335
30336 .vitem &*opt_stringptr*&
30337 This specifies a string value; the address must be a pointer to a
30338 variable that points to a string (for example, of type &`uschar *`&).
30339
30340 .vitem &*opt_time*&
30341 This specifies a time interval value. The address must point to a variable of
30342 type &`int`&. The value that is placed there is a number of seconds.
30343 .endlist
30344
30345 If the &%-bP%& command line option is followed by &`local_scan`&, Exim prints
30346 out the values of all the &[local_scan()]& options.
30347
30348
30349
30350 .section "Available Exim variables" "SECID208"
30351 .cindex "&[local_scan()]& function" "available Exim variables"
30352 The header &_local_scan.h_& gives you access to a number of C variables. These
30353 are the only ones that are guaranteed to be maintained from release to release.
30354 Note, however, that you can obtain the value of any Exim expansion variable,
30355 including &$recipients$&, by calling &'expand_string()'&. The exported
30356 C variables are as follows:
30357
30358 .vlist
30359 .vitem &*int&~body_linecount*&
30360 This variable contains the number of lines in the message's body.
30361
30362 .vitem &*int&~body_zerocount*&
30363 This variable contains the number of binary zero bytes in the message's body.
30364
30365 .vitem &*unsigned&~int&~debug_selector*&
30366 This variable is set to zero when no debugging is taking place. Otherwise, it
30367 is a bitmap of debugging selectors. Two bits are identified for use in
30368 &[local_scan()]&; they are defined as macros:
30369
30370 .ilist
30371 The &`D_v`& bit is set when &%-v%& was present on the command line. This is a
30372 testing option that is not privileged &-- any caller may set it. All the
30373 other selector bits can be set only by admin users.
30374
30375 .next
30376 The &`D_local_scan`& bit is provided for use by &[local_scan()]&; it is set
30377 by the &`+local_scan`& debug selector. It is not included in the default set
30378 of debugging bits.
30379 .endlist ilist
30380
30381 Thus, to write to the debugging output only when &`+local_scan`& has been
30382 selected, you should use code like this:
30383 .code
30384 if ((debug_selector & D_local_scan) != 0)
30385   debug_printf("xxx", ...);
30386 .endd
30387 .vitem &*uschar&~*expand_string_message*&
30388 After a failing call to &'expand_string()'& (returned value NULL), the
30389 variable &%expand_string_message%& contains the error message, zero-terminated.
30390
30391 .vitem &*header_line&~*header_list*&
30392 A pointer to a chain of header lines. The &%header_line%& structure is
30393 discussed below.
30394
30395 .vitem &*header_line&~*header_last*&
30396 A pointer to the last of the header lines.
30397
30398 .vitem &*uschar&~*headers_charset*&
30399 The value of the &%headers_charset%& configuration option.
30400
30401 .vitem &*BOOL&~host_checking*&
30402 This variable is TRUE during a host checking session that is initiated by the
30403 &%-bh%& command line option.
30404
30405 .vitem &*uschar&~*interface_address*&
30406 The IP address of the interface that received the message, as a string. This
30407 is NULL for locally submitted messages.
30408
30409 .vitem &*int&~interface_port*&
30410 The port on which this message was received. When testing with the &%-bh%&
30411 command line option, the value of this variable is -1 unless a port has been
30412 specified via the &%-oMi%& option.
30413
30414 .vitem &*uschar&~*message_id*&
30415 This variable contains Exim's message id for the incoming message (the value of
30416 &$message_exim_id$&) as a zero-terminated string.
30417
30418 .vitem &*uschar&~*received_protocol*&
30419 The name of the protocol by which the message was received.
30420
30421 .vitem &*int&~recipients_count*&
30422 The number of accepted recipients.
30423
30424 .vitem &*recipient_item&~*recipients_list*&
30425 .cindex "recipient" "adding in local scan"
30426 .cindex "recipient" "removing in local scan"
30427 The list of accepted recipients, held in a vector of length
30428 &%recipients_count%&. The &%recipient_item%& structure is discussed below. You
30429 can add additional recipients by calling &'receive_add_recipient()'& (see
30430 below). You can delete recipients by removing them from the vector and
30431 adjusting the value in &%recipients_count%&. In particular, by setting
30432 &%recipients_count%& to zero you remove all recipients. If you then return the
30433 value &`LOCAL_SCAN_ACCEPT`&, the message is accepted, but immediately
30434 blackholed. To replace the recipients, you can set &%recipients_count%& to zero
30435 and then call &'receive_add_recipient()'& as often as needed.
30436
30437 .vitem &*uschar&~*sender_address*&
30438 The envelope sender address. For bounce messages this is the empty string.
30439
30440 .vitem &*uschar&~*sender_host_address*&
30441 The IP address of the sending host, as a string. This is NULL for
30442 locally-submitted messages.
30443
30444 .vitem &*uschar&~*sender_host_authenticated*&
30445 The name of the authentication mechanism that was used, or NULL if the message
30446 was not received over an authenticated SMTP connection.
30447
30448 .vitem &*uschar&~*sender_host_name*&
30449 The name of the sending host, if known.
30450
30451 .vitem &*int&~sender_host_port*&
30452 The port on the sending host.
30453
30454 .vitem &*BOOL&~smtp_input*&
30455 This variable is TRUE for all SMTP input, including BSMTP.
30456
30457 .vitem &*BOOL&~smtp_batched_input*&
30458 This variable is TRUE for BSMTP input.
30459
30460 .vitem &*int&~store_pool*&
30461 The contents of this variable control which pool of memory is used for new
30462 requests. See section &<<SECTmemhanloc>>& for details.
30463 .endlist
30464
30465
30466 .section "Structure of header lines" "SECID209"
30467 The &%header_line%& structure contains the members listed below.
30468 You can add additional header lines by calling the &'header_add()'& function
30469 (see below). You can cause header lines to be ignored (deleted) by setting
30470 their type to *.
30471
30472
30473 .vlist
30474 .vitem &*struct&~header_line&~*next*&
30475 A pointer to the next header line, or NULL for the last line.
30476
30477 .vitem &*int&~type*&
30478 A code identifying certain headers that Exim recognizes. The codes are printing
30479 characters, and are documented in chapter &<<CHAPspool>>& of this manual.
30480 Notice in particular that any header line whose type is * is not transmitted
30481 with the message. This flagging is used for header lines that have been
30482 rewritten, or are to be removed (for example, &'Envelope-sender:'& header
30483 lines.) Effectively, * means &"deleted"&.
30484
30485 .vitem &*int&~slen*&
30486 The number of characters in the header line, including the terminating and any
30487 internal newlines.
30488
30489 .vitem &*uschar&~*text*&
30490 A pointer to the text of the header. It always ends with a newline, followed by
30491 a zero byte. Internal newlines are preserved.
30492 .endlist
30493
30494
30495
30496 .section "Structure of recipient items" "SECID210"
30497 The &%recipient_item%& structure contains these members:
30498
30499 .vlist
30500 .vitem &*uschar&~*address*&
30501 This is a pointer to the recipient address as it was received.
30502
30503 .vitem &*int&~pno*&
30504 This is used in later Exim processing when top level addresses are created by
30505 the &%one_time%& option. It is not relevant at the time &[local_scan()]& is run
30506 and must always contain -1 at this stage.
30507
30508 .vitem &*uschar&~*errors_to*&
30509 If this value is not NULL, bounce messages caused by failing to deliver to the
30510 recipient are sent to the address it contains. In other words, it overrides the
30511 envelope sender for this one recipient. (Compare the &%errors_to%& generic
30512 router option.) If a &[local_scan()]& function sets an &%errors_to%& field to
30513 an unqualified address, Exim qualifies it using the domain from
30514 &%qualify_recipient%&. When &[local_scan()]& is called, the &%errors_to%& field
30515 is NULL for all recipients.
30516 .endlist
30517
30518
30519
30520 .section "Available Exim functions" "SECID211"
30521 .cindex "&[local_scan()]& function" "available Exim functions"
30522 The header &_local_scan.h_& gives you access to a number of Exim functions.
30523 These are the only ones that are guaranteed to be maintained from release to
30524 release:
30525
30526 .vlist
30527 .vitem "&*pid_t&~child_open(uschar&~**argv,&~uschar&~**envp,&~int&~newumask,&&&
30528        &~int&~*infdptr,&~int&~*outfdptr, &~&~BOOL&~make_leader)*&"
30529
30530 This function creates a child process that runs the command specified by
30531 &%argv%&. The environment for the process is specified by &%envp%&, which can
30532 be NULL if no environment variables are to be passed. A new umask is supplied
30533 for the process in &%newumask%&.
30534
30535 Pipes to the standard input and output of the new process are set up
30536 and returned to the caller via the &%infdptr%& and &%outfdptr%& arguments. The
30537 standard error is cloned to the standard output. If there are any file
30538 descriptors &"in the way"& in the new process, they are closed. If the final
30539 argument is TRUE, the new process is made into a process group leader.
30540
30541 The function returns the pid of the new process, or -1 if things go wrong.
30542
30543 .vitem &*int&~child_close(pid_t&~pid,&~int&~timeout)*&
30544 This function waits for a child process to terminate, or for a timeout (in
30545 seconds) to expire. A timeout value of zero means wait as long as it takes. The
30546 return value is as follows:
30547
30548 .ilist
30549 >= 0
30550
30551 The process terminated by a normal exit and the value is the process
30552 ending status.
30553
30554 .next
30555 < 0 and > &--256
30556
30557 The process was terminated by a signal and the value is the negation of the
30558 signal number.
30559
30560 .next
30561 &--256
30562
30563 The process timed out.
30564 .next
30565 &--257
30566
30567 The was some other error in wait(); &%errno%& is still set.
30568 .endlist
30569
30570 .vitem &*pid_t&~child_open_exim(int&~*fd)*&
30571 This function provide you with a means of submitting a new message to
30572 Exim. (Of course, you can also call &_/usr/sbin/sendmail_& yourself if you
30573 want, but this packages it all up for you.) The function creates a pipe,
30574 forks a subprocess that is running
30575 .code
30576 exim -t -oem -oi -f <>
30577 .endd
30578 and returns to you (via the &`int *`& argument) a file descriptor for the pipe
30579 that is connected to the standard input. The yield of the function is the PID
30580 of the subprocess. You can then write a message to the file descriptor, with
30581 recipients in &'To:'&, &'Cc:'&, and/or &'Bcc:'& header lines.
30582
30583 When you have finished, call &'child_close()'& to wait for the process to
30584 finish and to collect its ending status. A timeout value of zero is usually
30585 fine in this circumstance. Unless you have made a mistake with the recipient
30586 addresses, you should get a return code of zero.
30587
30588
30589 .vitem &*pid_t&~child_open_exim2(int&~*fd,&~uschar&~*sender,&~uschar&~&&&
30590        *sender_authentication)*&
30591 This function is a more sophisticated version of &'child_open()'&. The command
30592 that it runs is:
30593 .display
30594 &`exim -t -oem -oi -f `&&'sender'&&` -oMas `&&'sender_authentication'&
30595 .endd
30596 The third argument may be NULL, in which case the &%-oMas%& option is omitted.
30597
30598
30599 .vitem &*void&~debug_printf(char&~*,&~...)*&
30600 This is Exim's debugging function, with arguments as for &'(printf()'&. The
30601 output is written to the standard error stream. If no debugging is selected,
30602 calls to &'debug_printf()'& have no effect. Normally, you should make calls
30603 conditional on the &`local_scan`& debug selector by coding like this:
30604 .code
30605 if ((debug_selector & D_local_scan) != 0)
30606   debug_printf("xxx", ...);
30607 .endd
30608
30609 .vitem &*uschar&~*expand_string(uschar&~*string)*&
30610 This is an interface to Exim's string expansion code. The return value is the
30611 expanded string, or NULL if there was an expansion failure.
30612 The C variable &%expand_string_message%& contains an error message after an
30613 expansion failure. If expansion does not change the string, the return value is
30614 the pointer to the input string. Otherwise, the return value points to a new
30615 block of memory that was obtained by a call to &'store_get()'&. See section
30616 &<<SECTmemhanloc>>& below for a discussion of memory handling.
30617
30618 .vitem &*void&~header_add(int&~type,&~char&~*format,&~...)*&
30619 This function allows you to an add additional header line at the end of the
30620 existing ones. The first argument is the type, and should normally be a space
30621 character. The second argument is a format string and any number of
30622 substitution arguments as for &[sprintf()]&. You may include internal newlines
30623 if you want, and you must ensure that the string ends with a newline.
30624
30625 .vitem "&*void&~header_add_at_position(BOOL&~after,&~uschar&~*name,&~&&&
30626         BOOL&~topnot,&~int&~type,&~char&~*format, &~&~...)*&"
30627 This function adds a new header line at a specified point in the header
30628 chain. The header itself is specified as for &'header_add()'&.
30629
30630 If &%name%& is NULL, the new header is added at the end of the chain if
30631 &%after%& is true, or at the start if &%after%& is false. If &%name%& is not
30632 NULL, the header lines are searched for the first non-deleted header that
30633 matches the name. If one is found, the new header is added before it if
30634 &%after%& is false. If &%after%& is true, the new header is added after the
30635 found header and any adjacent subsequent ones with the same name (even if
30636 marked &"deleted"&). If no matching non-deleted header is found, the &%topnot%&
30637 option controls where the header is added. If it is true, addition is at the
30638 top; otherwise at the bottom. Thus, to add a header after all the &'Received:'&
30639 headers, or at the top if there are no &'Received:'& headers, you could use
30640 .code
30641 header_add_at_position(TRUE, US"Received", TRUE,
30642   ' ', "X-xxx: ...");
30643 .endd
30644 Normally, there is always at least one non-deleted &'Received:'& header, but
30645 there may not be if &%received_header_text%& expands to an empty string.
30646
30647
30648 .vitem &*void&~header_remove(int&~occurrence,&~uschar&~*name)*&
30649 This function removes header lines. If &%occurrence%& is zero or negative, all
30650 occurrences of the header are removed. If occurrence is greater than zero, that
30651 particular instance of the header is removed. If no header(s) can be found that
30652 match the specification, the function does nothing.
30653
30654
30655 .vitem "&*BOOL&~header_testname(header_line&~*hdr,&~uschar&~*name,&~&&&
30656         int&~length,&~BOOL&~notdel)*&"
30657 This function tests whether the given header has the given name. It is not just
30658 a string comparison, because white space is permitted between the name and the
30659 colon. If the &%notdel%& argument is true, a false return is forced for all
30660 &"deleted"& headers; otherwise they are not treated specially. For example:
30661 .code
30662 if (header_testname(h, US"X-Spam", 6, TRUE)) ...
30663 .endd
30664 .vitem &*uschar&~*lss_b64encode(uschar&~*cleartext,&~int&~length)*&
30665 .cindex "base64 encoding" "functions for &[local_scan()]& use"
30666 This function base64-encodes a string, which is passed by address and length.
30667 The text may contain bytes of any value, including zero. The result is passed
30668 back in dynamic memory that is obtained by calling &'store_get()'&. It is
30669 zero-terminated.
30670
30671 .vitem &*int&~lss_b64decode(uschar&~*codetext,&~uschar&~**cleartext)*&
30672 This function decodes a base64-encoded string. Its arguments are a
30673 zero-terminated base64-encoded string and the address of a variable that is set
30674 to point to the result, which is in dynamic memory. The length of the decoded
30675 string is the yield of the function. If the input is invalid base64 data, the
30676 yield is -1. A zero byte is added to the end of the output string to make it
30677 easy to interpret as a C string (assuming it contains no zeros of its own). The
30678 added zero byte is not included in the returned count.
30679
30680 .vitem &*int&~lss_match_domain(uschar&~*domain,&~uschar&~*list)*&
30681 This function checks for a match in a domain list. Domains are always
30682 matched caselessly. The return value is one of the following:
30683 .display
30684 &`OK     `& match succeeded
30685 &`FAIL   `& match failed
30686 &`DEFER  `& match deferred
30687 .endd
30688 DEFER is usually caused by some kind of lookup defer, such as the
30689 inability to contact a database.
30690
30691 .vitem "&*int&~lss_match_local_part(uschar&~*localpart,&~uschar&~*list,&~&&&
30692         BOOL&~caseless)*&"
30693 This function checks for a match in a local part list. The third argument
30694 controls case-sensitivity. The return values are as for
30695 &'lss_match_domain()'&.
30696
30697 .vitem "&*int&~lss_match_address(uschar&~*address,&~uschar&~*list,&~&&&
30698         BOOL&~caseless)*&"
30699 This function checks for a match in an address list. The third argument
30700 controls the case-sensitivity of the local part match. The domain is always
30701 matched caselessly. The return values are as for &'lss_match_domain()'&.
30702
30703 .vitem "&*int&~lss_match_host(uschar&~*host_name,&~uschar&~*host_address,&~&&&
30704         uschar&~*list)*&"
30705 This function checks for a match in a host list. The most common usage is
30706 expected to be
30707 .code
30708 lss_match_host(sender_host_name, sender_host_address, ...)
30709 .endd
30710 .vindex "&$sender_host_address$&"
30711 An empty address field matches an empty item in the host list. If the host name
30712 is NULL, the name corresponding to &$sender_host_address$& is automatically
30713 looked up if a host name is required to match an item in the list. The return
30714 values are as for &'lss_match_domain()'&, but in addition, &'lss_match_host()'&
30715 returns ERROR in the case when it had to look up a host name, but the lookup
30716 failed.
30717
30718 .vitem "&*void&~log_write(unsigned&~int&~selector,&~int&~which,&~char&~&&&
30719         *format,&~...)*&"
30720 This function writes to Exim's log files. The first argument should be zero (it
30721 is concerned with &%log_selector%&). The second argument can be &`LOG_MAIN`& or
30722 &`LOG_REJECT`& or &`LOG_PANIC`& or the inclusive &"or"& of any combination of
30723 them. It specifies to which log or logs the message is written. The remaining
30724 arguments are a format and relevant insertion arguments. The string should not
30725 contain any newlines, not even at the end.
30726
30727
30728 .vitem &*void&~receive_add_recipient(uschar&~*address,&~int&~pno)*&
30729 This function adds an additional recipient to the message. The first argument
30730 is the recipient address. If it is unqualified (has no domain), it is qualified
30731 with the &%qualify_recipient%& domain. The second argument must always be -1.
30732
30733 This function does not allow you to specify a private &%errors_to%& address (as
30734 described with the structure of &%recipient_item%& above), because it pre-dates
30735 the addition of that field to the structure. However, it is easy to add such a
30736 value afterwards. For example:
30737 .code
30738  receive_add_recipient(US"monitor@mydom.example", -1);
30739  recipients_list[recipients_count-1].errors_to =
30740    US"postmaster@mydom.example";
30741 .endd
30742
30743 .vitem &*BOOL&~receive_remove_recipient(uschar&~*recipient)*&
30744 This is a convenience function to remove a named recipient from the list of
30745 recipients. It returns true if a recipient was removed, and false if no
30746 matching recipient could be found. The argument must be a complete email
30747 address.
30748 .endlist
30749
30750
30751 .cindex "RFC 2047"
30752 .vlist
30753 .vitem "&*uschar&~rfc2047_decode(uschar&~*string,&~BOOL&~lencheck,&&&
30754   &~uschar&~*target,&~int&~zeroval,&~int&~*lenptr, &~&~uschar&~**error)*&"
30755 This function decodes strings that are encoded according to RFC 2047. Typically
30756 these are the contents of header lines. First, each &"encoded word"& is decoded
30757 from the Q or B encoding into a byte-string. Then, if provided with the name of
30758 a charset encoding, and if the &[iconv()]& function is available, an attempt is
30759 made  to translate the result to the named character set. If this fails, the
30760 binary string is returned with an error message.
30761
30762 The first argument is the string to be decoded. If &%lencheck%& is TRUE, the
30763 maximum MIME word length is enforced. The third argument is the target
30764 encoding, or NULL if no translation is wanted.
30765
30766 .cindex "binary zero" "in RFC 2047 decoding"
30767 .cindex "RFC 2047" "binary zero in"
30768 If a binary zero is encountered in the decoded string, it is replaced by the
30769 contents of the &%zeroval%& argument. For use with Exim headers, the value must
30770 not be 0 because header lines are handled as zero-terminated strings.
30771
30772 The function returns the result of processing the string, zero-terminated; if
30773 &%lenptr%& is not NULL, the length of the result is set in the variable to
30774 which it points. When &%zeroval%& is 0, &%lenptr%& should not be NULL.
30775
30776 If an error is encountered, the function returns NULL and uses the &%error%&
30777 argument to return an error message. The variable pointed to by &%error%& is
30778 set to NULL if there is no error; it may be set non-NULL even when the function
30779 returns a non-NULL value if decoding was successful, but there was a problem
30780 with translation.
30781
30782
30783 .vitem &*int&~smtp_fflush(void)*&
30784 This function is used in conjunction with &'smtp_printf()'&, as described
30785 below.
30786
30787 .vitem &*void&~smtp_printf(char&~*,&~...)*&
30788 The arguments of this function are like &[printf()]&; it writes to the SMTP
30789 output stream. You should use this function only when there is an SMTP output
30790 stream, that is, when the incoming message is being received via interactive
30791 SMTP. This is the case when &%smtp_input%& is TRUE and &%smtp_batched_input%&
30792 is FALSE. If you want to test for an incoming message from another host (as
30793 opposed to a local process that used the &%-bs%& command line option), you can
30794 test the value of &%sender_host_address%&, which is non-NULL when a remote host
30795 is involved.
30796
30797 If an SMTP TLS connection is established, &'smtp_printf()'& uses the TLS
30798 output function, so it can be used for all forms of SMTP connection.
30799
30800 Strings that are written by &'smtp_printf()'& from within &[local_scan()]&
30801 must start with an appropriate response code: 550 if you are going to return
30802 LOCAL_SCAN_REJECT, 451 if you are going to return
30803 LOCAL_SCAN_TEMPREJECT, and 250 otherwise. Because you are writing the
30804 initial lines of a multi-line response, the code must be followed by a hyphen
30805 to indicate that the line is not the final response line. You must also ensure
30806 that the lines you write terminate with CRLF. For example:
30807 .code
30808 smtp_printf("550-this is some extra info\r\n");
30809 return LOCAL_SCAN_REJECT;
30810 .endd
30811 Note that you can also create multi-line responses by including newlines in
30812 the data returned via the &%return_text%& argument. The added value of using
30813 &'smtp_printf()'& is that, for instance, you could introduce delays between
30814 multiple output lines.
30815
30816 The &'smtp_printf()'& function does not return any error indication, because it
30817 does not automatically flush pending output, and therefore does not test
30818 the state of the stream. (In the main code of Exim, flushing and error
30819 detection is done when Exim is ready for the next SMTP input command.) If
30820 you want to flush the output and check for an error (for example, the
30821 dropping of a TCP/IP connection), you can call &'smtp_fflush()'&, which has no
30822 arguments. It flushes the output stream, and returns a non-zero value if there
30823 is an error.
30824
30825 .vitem &*void&~*store_get(int)*&
30826 This function accesses Exim's internal store (memory) manager. It gets a new
30827 chunk of memory whose size is given by the argument. Exim bombs out if it ever
30828 runs out of memory. See the next section for a discussion of memory handling.
30829
30830 .vitem &*void&~*store_get_perm(int)*&
30831 This function is like &'store_get()'&, but it always gets memory from the
30832 permanent pool. See the next section for a discussion of memory handling.
30833
30834 .vitem &*uschar&~*string_copy(uschar&~*string)*&
30835 See below.
30836
30837 .vitem &*uschar&~*string_copyn(uschar&~*string,&~int&~length)*&
30838 See below.
30839
30840 .vitem &*uschar&~*string_sprintf(char&~*format,&~...)*&
30841 These three functions create strings using Exim's dynamic memory facilities.
30842 The first makes a copy of an entire string. The second copies up to a maximum
30843 number of characters, indicated by the second argument. The third uses a format
30844 and insertion arguments to create a new string. In each case, the result is a
30845 pointer to a new string in the current memory pool. See the next section for
30846 more discussion.
30847 .endlist
30848
30849
30850
30851 .section "More about Exim's memory handling" "SECTmemhanloc"
30852 .cindex "&[local_scan()]& function" "memory handling"
30853 No function is provided for freeing memory, because that is never needed.
30854 The dynamic memory that Exim uses when receiving a message is automatically
30855 recycled if another message is received by the same process (this applies only
30856 to incoming SMTP connections &-- other input methods can supply only one
30857 message at a time). After receiving the last message, a reception process
30858 terminates.
30859
30860 Because it is recycled, the normal dynamic memory cannot be used for holding
30861 data that must be preserved over a number of incoming messages on the same SMTP
30862 connection. However, Exim in fact uses two pools of dynamic memory; the second
30863 one is not recycled, and can be used for this purpose.
30864
30865 If you want to allocate memory that remains available for subsequent messages
30866 in the same SMTP connection, you should set
30867 .code
30868 store_pool = POOL_PERM
30869 .endd
30870 before calling the function that does the allocation. There is no need to
30871 restore the value if you do not need to; however, if you do want to revert to
30872 the normal pool, you can either restore the previous value of &%store_pool%& or
30873 set it explicitly to POOL_MAIN.
30874
30875 The pool setting applies to all functions that get dynamic memory, including
30876 &'expand_string()'&, &'store_get()'&, and the &'string_xxx()'& functions.
30877 There is also a convenience function called &'store_get_perm()'& that gets a
30878 block of memory from the permanent pool while preserving the value of
30879 &%store_pool%&.
30880 .ecindex IIDlosca
30881
30882
30883
30884
30885 . ////////////////////////////////////////////////////////////////////////////
30886 . ////////////////////////////////////////////////////////////////////////////
30887
30888 .chapter "System-wide message filtering" "CHAPsystemfilter"
30889 .scindex IIDsysfil1 "filter" "system filter"
30890 .scindex IIDsysfil2 "filtering all mail"
30891 .scindex IIDsysfil3 "system filter"
30892 The previous chapters (on ACLs and the local scan function) describe checks
30893 that can be applied to messages before they are accepted by a host. There is
30894 also a mechanism for checking messages once they have been received, but before
30895 they are delivered. This is called the &'system filter'&.
30896
30897 The system filter operates in a similar manner to users' filter files, but it
30898 is run just once per message (however many recipients the message has).
30899 It should not normally be used as a substitute for routing, because &%deliver%&
30900 commands in a system router provide new envelope recipient addresses.
30901 The system filter must be an Exim filter. It cannot be a Sieve filter.
30902
30903 The system filter is run at the start of a delivery attempt, before any routing
30904 is done. If a message fails to be completely delivered at the first attempt,
30905 the system filter is run again at the start of every retry.
30906 If you want your filter to do something only once per message, you can make use
30907 of the &%first_delivery%& condition in an &%if%& command in the filter to
30908 prevent it happening on retries.
30909
30910 .vindex "&$domain$&"
30911 .vindex "&$local_part$&"
30912 &*Warning*&: Because the system filter runs just once, variables that are
30913 specific to individual recipient addresses, such as &$local_part$& and
30914 &$domain$&, are not set, and the &"personal"& condition is not meaningful. If
30915 you want to run a centrally-specified filter for each recipient address
30916 independently, you can do so by setting up a suitable &(redirect)& router, as
30917 described in section &<<SECTperaddfil>>& below.
30918
30919
30920 .section "Specifying a system filter" "SECID212"
30921 .cindex "uid (user id)" "system filter"
30922 .cindex "gid (group id)" "system filter"
30923 The name of the file that contains the system filter must be specified by
30924 setting &%system_filter%&. If you want the filter to run under a uid and gid
30925 other than root, you must also set &%system_filter_user%& and
30926 &%system_filter_group%& as appropriate. For example:
30927 .code
30928 system_filter = /etc/mail/exim.filter
30929 system_filter_user = exim
30930 .endd
30931 If a system filter generates any deliveries directly to files or pipes (via the
30932 &%save%& or &%pipe%& commands), transports to handle these deliveries must be
30933 specified by setting &%system_filter_file_transport%& and
30934 &%system_filter_pipe_transport%&, respectively. Similarly,
30935 &%system_filter_reply_transport%& must be set to handle any messages generated
30936 by the &%reply%& command.
30937
30938
30939 .section "Testing a system filter" "SECID213"
30940 You can run simple tests of a system filter in the same way as for a user
30941 filter, but you should use &%-bF%& rather than &%-bf%&, so that features that
30942 are permitted only in system filters are recognized.
30943
30944 If you want to test the combined effect of a system filter and a user filter,
30945 you can use both &%-bF%& and &%-bf%& on the same command line.
30946
30947
30948
30949 .section "Contents of a system filter" "SECID214"
30950 The language used to specify system filters is the same as for users' filter
30951 files. It is described in the separate end-user document &'Exim's interface to
30952 mail filtering'&. However, there are some additional features that are
30953 available only in system filters; these are described in subsequent sections.
30954 If they are encountered in a user's filter file or when testing with &%-bf%&,
30955 they cause errors.
30956
30957 .cindex "frozen messages" "manual thaw; testing in filter"
30958 There are two special conditions which, though available in users' filter
30959 files, are designed for use in system filters. The condition &%first_delivery%&
30960 is true only for the first attempt at delivering a message, and
30961 &%manually_thawed%& is true only if the message has been frozen, and
30962 subsequently thawed by an admin user. An explicit forced delivery counts as a
30963 manual thaw, but thawing as a result of the &%auto_thaw%& setting does not.
30964
30965 &*Warning*&: If a system filter uses the &%first_delivery%& condition to
30966 specify an &"unseen"& (non-significant) delivery, and that delivery does not
30967 succeed, it will not be tried again.
30968 If you want Exim to retry an unseen delivery until it succeeds, you should
30969 arrange to set it up every time the filter runs.
30970
30971 When a system filter finishes running, the values of the variables &$n0$& &--
30972 &$n9$& are copied into &$sn0$& &-- &$sn9$& and are thereby made available to
30973 users' filter files. Thus a system filter can, for example, set up &"scores"&
30974 to which users' filter files can refer.
30975
30976
30977
30978 .section "Additional variable for system filters" "SECID215"
30979 .vindex "&$recipients$&"
30980 The expansion variable &$recipients$&, containing a list of all the recipients
30981 of the message (separated by commas and white space), is available in system
30982 filters. It is not available in users' filters for privacy reasons.
30983
30984
30985
30986 .section "Defer, freeze, and fail commands for system filters" "SECID216"
30987 .cindex "freezing messages"
30988 .cindex "message" "freezing"
30989 .cindex "message" "forced failure"
30990 .cindex "&%fail%&" "in system filter"
30991 .cindex "&%freeze%& in system filter"
30992 .cindex "&%defer%& in system filter"
30993 There are three extra commands (&%defer%&, &%freeze%& and &%fail%&) which are
30994 always available in system filters, but are not normally enabled in users'
30995 filters. (See the &%allow_defer%&, &%allow_freeze%& and &%allow_fail%& options
30996 for the &(redirect)& router.) These commands can optionally be followed by the
30997 word &%text%& and a string containing an error message, for example:
30998 .code
30999 fail text "this message looks like spam to me"
31000 .endd
31001 The keyword &%text%& is optional if the next character is a double quote.
31002
31003 The &%defer%& command defers delivery of the original recipients of the
31004 message. The &%fail%& command causes all the original recipients to be failed,
31005 and a bounce message to be created. The &%freeze%& command suspends all
31006 delivery attempts for the original recipients. In all cases, any new deliveries
31007 that are specified by the filter are attempted as normal after the filter has
31008 run.
31009
31010 The &%freeze%& command is ignored if the message has been manually unfrozen and
31011 not manually frozen since. This means that automatic freezing by a system
31012 filter can be used as a way of checking out suspicious messages. If a message
31013 is found to be all right, manually unfreezing it allows it to be delivered.
31014
31015 .cindex "log" "&%fail%& command log line"
31016 .cindex "&%fail%&" "log line; reducing"
31017 The text given with a fail command is used as part of the bounce message as
31018 well as being written to the log. If the message is quite long, this can fill
31019 up a lot of log space when such failures are common. To reduce the size of the
31020 log message, Exim interprets the text in a special way if it starts with the
31021 two characters &`<<`& and contains &`>>`& later. The text between these two
31022 strings is written to the log, and the rest of the text is used in the bounce
31023 message. For example:
31024 .code
31025 fail "<<filter test 1>>Your message is rejected \
31026      because it contains attachments that we are \
31027      not prepared to receive."
31028 .endd
31029
31030 .cindex "loop" "caused by &%fail%&"
31031 Take great care with the &%fail%& command when basing the decision to fail on
31032 the contents of the message, because the bounce message will of course include
31033 the contents of the original message and will therefore trigger the &%fail%&
31034 command again (causing a mail loop) unless steps are taken to prevent this.
31035 Testing the &%error_message%& condition is one way to prevent this. You could
31036 use, for example
31037 .code
31038 if $message_body contains "this is spam" and not error_message
31039 then fail text "spam is not wanted here" endif
31040 .endd
31041 though of course that might let through unwanted bounce messages. The
31042 alternative is clever checking of the body and/or headers to detect bounces
31043 generated by the filter.
31044
31045 The interpretation of a system filter file ceases after a
31046 &%defer%&,
31047 &%freeze%&, or &%fail%& command is obeyed. However, any deliveries that were
31048 set up earlier in the filter file are honoured, so you can use a sequence such
31049 as
31050 .code
31051 mail ...
31052 freeze
31053 .endd
31054 to send a specified message when the system filter is freezing (or deferring or
31055 failing) a message. The normal deliveries for the message do not, of course,
31056 take place.
31057
31058
31059
31060 .section "Adding and removing headers in a system filter" "SECTaddremheasys"
31061 .cindex "header lines" "adding; in system filter"
31062 .cindex "header lines" "removing; in system filter"
31063 .cindex "filter" "header lines; adding/removing"
31064 Two filter commands that are available only in system filters are:
31065 .code
31066 headers add <string>
31067 headers remove <string>
31068 .endd
31069 The argument for the &%headers add%& is a string that is expanded and then
31070 added to the end of the message's headers. It is the responsibility of the
31071 filter maintainer to make sure it conforms to RFC 2822 syntax. Leading white
31072 space is ignored, and if the string is otherwise empty, or if the expansion is
31073 forced to fail, the command has no effect.
31074
31075 You can use &"\n"& within the string, followed by white space, to specify
31076 continued header lines. More than one header may be added in one command by
31077 including &"\n"& within the string without any following white space. For
31078 example:
31079 .code
31080 headers add "X-header-1: ....\n  \
31081              continuation of X-header-1 ...\n\
31082              X-header-2: ...."
31083 .endd
31084 Note that the header line continuation white space after the first newline must
31085 be placed before the backslash that continues the input string, because white
31086 space after input continuations is ignored.
31087
31088 The argument for &%headers remove%& is a colon-separated list of header names.
31089 This command applies only to those headers that are stored with the message;
31090 those that are added at delivery time (such as &'Envelope-To:'& and
31091 &'Return-Path:'&) cannot be removed by this means. If there is more than one
31092 header with the same name, they are all removed.
31093
31094 The &%headers%& command in a system filter makes an immediate change to the set
31095 of header lines that was received with the message (with possible additions
31096 from ACL processing). Subsequent commands in the system filter operate on the
31097 modified set, which also forms the basis for subsequent message delivery.
31098 Unless further modified during routing or transporting, this set of headers is
31099 used for all recipients of the message.
31100
31101 During routing and transporting, the variables that refer to the contents of
31102 header lines refer only to those lines that are in this set. Thus, header lines
31103 that are added by a system filter are visible to users' filter files and to all
31104 routers and transports. This contrasts with the manipulation of header lines by
31105 routers and transports, which is not immediate, but which instead is saved up
31106 until the message is actually being written (see section
31107 &<<SECTheadersaddrem>>&).
31108
31109 If the message is not delivered at the first attempt, header lines that were
31110 added by the system filter are stored with the message, and so are still
31111 present at the next delivery attempt. Header lines that were removed are still
31112 present, but marked &"deleted"& so that they are not transported with the
31113 message. For this reason, it is usual to make the &%headers%& command
31114 conditional on &%first_delivery%& so that the set of header lines is not
31115 modified more than once.
31116
31117 Because header modification in a system filter acts immediately, you have to
31118 use an indirect approach if you want to modify the contents of a header line.
31119 For example:
31120 .code
31121 headers add "Old-Subject: $h_subject:"
31122 headers remove "Subject"
31123 headers add "Subject: new subject (was: $h_old-subject:)"
31124 headers remove "Old-Subject"
31125 .endd
31126
31127
31128
31129 .section "Setting an errors address in a system filter" "SECID217"
31130 .cindex "envelope sender"
31131 In a system filter, if a &%deliver%& command is followed by
31132 .code
31133 errors_to <some address>
31134 .endd
31135 in order to change the envelope sender (and hence the error reporting) for that
31136 delivery, any address may be specified. (In a user filter, only the current
31137 user's address can be set.) For example, if some mail is being monitored, you
31138 might use
31139 .code
31140 unseen deliver monitor@spying.example errors_to root@local.example
31141 .endd
31142 to take a copy which would not be sent back to the normal error reporting
31143 address if its delivery failed.
31144
31145
31146
31147 .section "Per-address filtering" "SECTperaddfil"
31148 .vindex "&$domain$&"
31149 .vindex "&$local_part$&"
31150 In contrast to the system filter, which is run just once per message for each
31151 delivery attempt, it is also possible to set up a system-wide filtering
31152 operation that runs once for each recipient address. In this case, variables
31153 such as &$local_part$& and &$domain$& can be used, and indeed, the choice of
31154 filter file could be made dependent on them. This is an example of a router
31155 which implements such a filter:
31156 .code
31157 central_filter:
31158   check_local_user
31159   driver = redirect
31160   domains = +local_domains
31161   file = /central/filters/$local_part
31162   no_verify
31163   allow_filter
31164   allow_freeze
31165 .endd
31166 The filter is run in a separate process under its own uid. Therefore, either
31167 &%check_local_user%& must be set (as above), in which case the filter is run as
31168 the local user, or the &%user%& option must be used to specify which user to
31169 use. If both are set, &%user%& overrides.
31170
31171 Care should be taken to ensure that none of the commands in the filter file
31172 specify a significant delivery if the message is to go on to be delivered to
31173 its intended recipient. The router will not then claim to have dealt with the
31174 address, so it will be passed on to subsequent routers to be delivered in the
31175 normal way.
31176 .ecindex IIDsysfil1
31177 .ecindex IIDsysfil2
31178 .ecindex IIDsysfil3
31179
31180
31181
31182
31183
31184
31185 . ////////////////////////////////////////////////////////////////////////////
31186 . ////////////////////////////////////////////////////////////////////////////
31187
31188 .chapter "Message processing" "CHAPmsgproc"
31189 .scindex IIDmesproc "message" "general processing"
31190 Exim performs various transformations on the sender and recipient addresses of
31191 all messages that it handles, and also on the messages' header lines. Some of
31192 these are optional and configurable, while others always take place. All of
31193 this processing, except rewriting as a result of routing, and the addition or
31194 removal of header lines while delivering, happens when a message is received,
31195 before it is placed on Exim's queue.
31196
31197 Some of the automatic processing takes place by default only for
31198 &"locally-originated"& messages. This adjective is used to describe messages
31199 that are not received over TCP/IP, but instead are passed to an Exim process on
31200 its standard input. This includes the interactive &"local SMTP"& case that is
31201 set up by the &%-bs%& command line option.
31202
31203 &*Note*&: Messages received over TCP/IP on the loopback interface (127.0.0.1
31204 or ::1) are not considered to be locally-originated. Exim does not treat the
31205 loopback interface specially in any way.
31206
31207 If you want the loopback interface to be treated specially, you must ensure
31208 that there are appropriate entries in your ACLs.
31209
31210
31211
31212
31213 .section "Submission mode for non-local messages" "SECTsubmodnon"
31214 .cindex "message" "submission"
31215 .cindex "submission mode"
31216 Processing that happens automatically for locally-originated messages (unless
31217 &%suppress_local_fixups%& is set) can also be requested for messages that are
31218 received over TCP/IP. The term &"submission mode"& is used to describe this
31219 state. Submission mode is set by the modifier
31220 .code
31221 control = submission
31222 .endd
31223 in a MAIL, RCPT, or pre-data ACL for an incoming message (see sections
31224 &<<SECTACLmodi>>& and &<<SECTcontrols>>&). This makes Exim treat the message as
31225 a local submission, and is normally used when the source of the message is
31226 known to be an MUA running on a client host (as opposed to an MTA). For
31227 example, to set submission mode for messages originating on the IPv4 loopback
31228 interface, you could include the following in the MAIL ACL:
31229 .code
31230 warn  hosts = 127.0.0.1
31231       control = submission
31232 .endd
31233 .cindex "&%sender_retain%& submission option"
31234 There are some options that can be used when setting submission mode. A slash
31235 is used to separate options. For example:
31236 .code
31237 control = submission/sender_retain
31238 .endd
31239 Specifying &%sender_retain%& has the effect of setting &%local_sender_retain%&
31240 true and &%local_from_check%& false for the current incoming message. The first
31241 of these allows an existing &'Sender:'& header in the message to remain, and
31242 the second suppresses the check to ensure that &'From:'& matches the
31243 authenticated sender. With this setting, Exim still fixes up messages by adding
31244 &'Date:'& and &'Message-ID:'& header lines if they are missing, but makes no
31245 attempt to check sender authenticity in header lines.
31246
31247 When &%sender_retain%& is not set, a submission mode setting may specify a
31248 domain to be used when generating a &'From:'& or &'Sender:'& header line. For
31249 example:
31250 .code
31251 control = submission/domain=some.domain
31252 .endd
31253 The domain may be empty. How this value is used is described in sections
31254 &<<SECTthefrohea>>& and &<<SECTthesenhea>>&. There is also a &%name%& option
31255 that allows you to specify the user's full name for inclusion in a created
31256 &'Sender:'& or &'From:'& header line. For example:
31257 .code
31258 accept authenticated = *
31259        control = submission/domain=wonderland.example/\
31260                             name=${lookup {$authenticated_id} \
31261                                    lsearch {/etc/exim/namelist}}
31262 .endd
31263 Because the name may contain any characters, including slashes, the &%name%&
31264 option must be given last. The remainder of the string is used as the name. For
31265 the example above, if &_/etc/exim/namelist_& contains:
31266 .code
31267 bigegg:  Humpty Dumpty
31268 .endd
31269 then when the sender has authenticated as &'bigegg'&, the generated &'Sender:'&
31270 line would be:
31271 .code
31272 Sender: Humpty Dumpty <bigegg@wonderland.example>
31273 .endd
31274 .cindex "return path" "in submission mode"
31275 By default, submission mode forces the return path to the same address as is
31276 used to create the &'Sender:'& header. However, if &%sender_retain%& is
31277 specified, the return path is also left unchanged.
31278
31279 &*Note*&: The changes caused by submission mode take effect after the predata
31280 ACL. This means that any sender checks performed before the fix-ups use the
31281 untrusted sender address specified by the user, not the trusted sender address
31282 specified by submission mode. Although this might be slightly unexpected, it
31283 does mean that you can configure ACL checks to spot that a user is trying to
31284 spoof another's address.
31285
31286 .section "Line endings" "SECTlineendings"
31287 .cindex "line endings"
31288 .cindex "carriage return"
31289 .cindex "linefeed"
31290 RFC 2821 specifies that CRLF (two characters: carriage-return, followed by
31291 linefeed) is the line ending for messages transmitted over the Internet using
31292 SMTP over TCP/IP. However, within individual operating systems, different
31293 conventions are used. For example, Unix-like systems use just LF, but others
31294 use CRLF or just CR.
31295
31296 Exim was designed for Unix-like systems, and internally, it stores messages
31297 using the system's convention of a single LF as a line terminator. When
31298 receiving a message, all line endings are translated to this standard format.
31299 Originally, it was thought that programs that passed messages directly to an
31300 MTA within an operating system would use that system's convention. Experience
31301 has shown that this is not the case; for example, there are Unix applications
31302 that use CRLF in this circumstance. For this reason, and for compatibility with
31303 other MTAs, the way Exim handles line endings for all messages is now as
31304 follows:
31305
31306 .ilist
31307 LF not preceded by CR is treated as a line ending.
31308 .next
31309 CR is treated as a line ending; if it is immediately followed by LF, the LF
31310 is ignored.
31311 .next
31312 The sequence &"CR, dot, CR"& does not terminate an incoming SMTP message,
31313 nor a local message in the state where a line containing only a dot is a
31314 terminator.
31315 .next
31316 If a bare CR is encountered within a header line, an extra space is added after
31317 the line terminator so as not to end the header line. The reasoning behind this
31318 is that bare CRs in header lines are most likely either to be mistakes, or
31319 people trying to play silly games.
31320 .next
31321 If the first header line received in a message ends with CRLF, a subsequent
31322 bare LF in a header line is treated in the same way as a bare CR in a header
31323 line.
31324 .endlist
31325
31326
31327
31328
31329
31330 .section "Unqualified addresses" "SECID218"
31331 .cindex "unqualified addresses"
31332 .cindex "address" "qualification"
31333 By default, Exim expects every envelope address it receives from an external
31334 host to be fully qualified. Unqualified addresses cause negative responses to
31335 SMTP commands. However, because SMTP is used as a means of transporting
31336 messages from MUAs running on personal workstations, there is sometimes a
31337 requirement to accept unqualified addresses from specific hosts or IP networks.
31338
31339 Exim has two options that separately control which hosts may send unqualified
31340 sender or recipient addresses in SMTP commands, namely
31341 &%sender_unqualified_hosts%& and &%recipient_unqualified_hosts%&. In both
31342 cases, if an unqualified address is accepted, it is qualified by adding the
31343 value of &%qualify_domain%& or &%qualify_recipient%&, as appropriate.
31344
31345 .oindex "&%qualify_domain%&"
31346 .oindex "&%qualify_recipient%&"
31347 Unqualified addresses in header lines are automatically qualified for messages
31348 that are locally originated, unless the &%-bnq%& option is given on the command
31349 line. For messages received over SMTP, unqualified addresses in header lines
31350 are qualified only if unqualified addresses are permitted in SMTP commands. In
31351 other words, such qualification is also controlled by
31352 &%sender_unqualified_hosts%& and &%recipient_unqualified_hosts%&,
31353
31354
31355
31356
31357 .section "The UUCP From line" "SECID219"
31358 .cindex "&""From""& line"
31359 .cindex "UUCP" "&""From""& line"
31360 .cindex "sender" "address"
31361 .oindex "&%uucp_from_pattern%&"
31362 .oindex "&%uucp_from_sender%&"
31363 .cindex "envelope sender"
31364 .cindex "Sendmail compatibility" "&""From""& line"
31365 Messages that have come from UUCP (and some other applications) often begin
31366 with a line containing the envelope sender and a timestamp, following the word
31367 &"From"&. Examples of two common formats are:
31368 .code
31369 From a.oakley@berlin.mus Fri Jan  5 12:35 GMT 1996
31370 From f.butler@berlin.mus Fri, 7 Jan 97 14:00:00 GMT
31371 .endd
31372 This line precedes the RFC 2822 header lines. For compatibility with Sendmail,
31373 Exim recognizes such lines at the start of messages that are submitted to it
31374 via the command line (that is, on the standard input). It does not recognize
31375 such lines in incoming SMTP messages, unless the sending host matches
31376 &%ignore_fromline_hosts%& or the &%-bs%& option was used for a local message
31377 and &%ignore_fromline_local%& is set. The recognition is controlled by a
31378 regular expression that is defined by the &%uucp_from_pattern%& option, whose
31379 default value matches the two common cases shown above and puts the address
31380 that follows &"From"& into &$1$&.
31381
31382 .cindex "numerical variables (&$1$& &$2$& etc)" "in &""From ""& line handling"
31383 When the caller of Exim for a non-SMTP message that contains a &"From"& line is
31384 a trusted user, the message's sender address is constructed by expanding the
31385 contents of &%uucp_sender_address%&, whose default value is &"$1"&. This is
31386 then parsed as an RFC 2822 address. If there is no domain, the local part is
31387 qualified with &%qualify_domain%& unless it is the empty string. However, if
31388 the command line &%-f%& option is used, it overrides the &"From"& line.
31389
31390 If the caller of Exim is not trusted, the &"From"& line is recognized, but the
31391 sender address is not changed. This is also the case for incoming SMTP messages
31392 that are permitted to contain &"From"& lines.
31393
31394 Only one &"From"& line is recognized. If there is more than one, the second is
31395 treated as a data line that starts the body of the message, as it is not valid
31396 as a header line. This also happens if a &"From"& line is present in an
31397 incoming SMTP message from a source that is not permitted to send them.
31398
31399
31400
31401 .section "Resent- header lines" "SECID220"
31402 .cindex "&%Resent-%& header lines"
31403 RFC 2822 makes provision for sets of header lines starting with the string
31404 &`Resent-`& to be added to a message when it is resent by the original
31405 recipient to somebody else. These headers are &'Resent-Date:'&,
31406 &'Resent-From:'&, &'Resent-Sender:'&, &'Resent-To:'&, &'Resent-Cc:'&,
31407 &'Resent-Bcc:'& and &'Resent-Message-ID:'&. The RFC says:
31408
31409 .blockquote
31410 &'Resent fields are strictly informational. They MUST NOT be used in the normal
31411 processing of replies or other such automatic actions on messages.'&
31412 .endblockquote
31413
31414 This leaves things a bit vague as far as other processing actions such as
31415 address rewriting are concerned. Exim treats &%Resent-%& header lines as
31416 follows:
31417
31418 .ilist
31419 A &'Resent-From:'& line that just contains the login id of the submitting user
31420 is automatically rewritten in the same way as &'From:'& (see below).
31421 .next
31422 If there's a rewriting rule for a particular header line, it is also applied to
31423 &%Resent-%& header lines of the same type. For example, a rule that rewrites
31424 &'From:'& also rewrites &'Resent-From:'&.
31425 .next
31426 For local messages, if &'Sender:'& is removed on input, &'Resent-Sender:'& is
31427 also removed.
31428 .next
31429 For a locally-submitted message,
31430 if there are any &%Resent-%& header lines but no &'Resent-Date:'&,
31431 &'Resent-From:'&, or &'Resent-Message-Id:'&, they are added as necessary. It is
31432 the contents of &'Resent-Message-Id:'& (rather than &'Message-Id:'&) which are
31433 included in log lines in this case.
31434 .next
31435 The logic for adding &'Sender:'& is duplicated for &'Resent-Sender:'& when any
31436 &%Resent-%& header lines are present.
31437 .endlist
31438
31439
31440
31441
31442 .section "The Auto-Submitted: header line" "SECID221"
31443 Whenever Exim generates an autoreply, a bounce, or a delay warning message, it
31444 includes the header line:
31445 .code
31446 Auto-Submitted: auto-replied
31447 .endd
31448
31449 .section "The Bcc: header line" "SECID222"
31450 .cindex "&'Bcc:'& header line"
31451 If Exim is called with the &%-t%& option, to take recipient addresses from a
31452 message's header, it removes any &'Bcc:'& header line that may exist (after
31453 extracting its addresses). If &%-t%& is not present on the command line, any
31454 existing &'Bcc:'& is not removed.
31455
31456
31457 .section "The Date: header line" "SECID223"
31458 .cindex "&'Date:'& header line"
31459 If a locally-generated or submission-mode message has no &'Date:'& header line,
31460 Exim adds one, using the current date and time, unless the
31461 &%suppress_local_fixups%& control has been specified.
31462
31463 .section "The Delivery-date: header line" "SECID224"
31464 .cindex "&'Delivery-date:'& header line"
31465 .oindex "&%delivery_date_remove%&"
31466 &'Delivery-date:'& header lines are not part of the standard RFC 2822 header
31467 set. Exim can be configured to add them to the final delivery of messages. (See
31468 the generic &%delivery_date_add%& transport option.) They should not be present
31469 in messages in transit. If the &%delivery_date_remove%& configuration option is
31470 set (the default), Exim removes &'Delivery-date:'& header lines from incoming
31471 messages.
31472
31473
31474 .section "The Envelope-to: header line" "SECID225"
31475 .cindex "&'Envelope-to:'& header line"
31476 .oindex "&%envelope_to_remove%&"
31477 &'Envelope-to:'& header lines are not part of the standard RFC 2822 header set.
31478 Exim can be configured to add them to the final delivery of messages. (See the
31479 generic &%envelope_to_add%& transport option.) They should not be present in
31480 messages in transit. If the &%envelope_to_remove%& configuration option is set
31481 (the default), Exim removes &'Envelope-to:'& header lines from incoming
31482 messages.
31483
31484
31485 .section "The From: header line" "SECTthefrohea"
31486 .cindex "&'From:'& header line"
31487 .cindex "Sendmail compatibility" "&""From""& line"
31488 .cindex "message" "submission"
31489 .cindex "submission mode"
31490 If a submission-mode message does not contain a &'From:'& header line, Exim
31491 adds one if either of the following conditions is true:
31492
31493 .ilist
31494 The envelope sender address is not empty (that is, this is not a bounce
31495 message). The added header line copies the envelope sender address.
31496 .next
31497 .vindex "&$authenticated_id$&"
31498 The SMTP session is authenticated and &$authenticated_id$& is not empty.
31499 .olist
31500 .vindex "&$qualify_domain$&"
31501 If no domain is specified by the submission control, the local part is
31502 &$authenticated_id$& and the domain is &$qualify_domain$&.
31503 .next
31504 If a non-empty domain is specified by the submission control, the local
31505 part is &$authenticated_id$&, and the domain is the specified domain.
31506 .next
31507 If an empty domain is specified by the submission control,
31508 &$authenticated_id$& is assumed to be the complete address.
31509 .endlist
31510 .endlist
31511
31512 A non-empty envelope sender takes precedence.
31513
31514 If a locally-generated incoming message does not contain a &'From:'& header
31515 line, and the &%suppress_local_fixups%& control is not set, Exim adds one
31516 containing the sender's address. The calling user's login name and full name
31517 are used to construct the address, as described in section &<<SECTconstr>>&.
31518 They are obtained from the password data by calling &[getpwuid()]& (but see the
31519 &%unknown_login%& configuration option). The address is qualified with
31520 &%qualify_domain%&.
31521
31522 For compatibility with Sendmail, if an incoming, non-SMTP message has a
31523 &'From:'& header line containing just the unqualified login name of the calling
31524 user, this is replaced by an address containing the user's login name and full
31525 name as described in section &<<SECTconstr>>&.
31526
31527
31528 .section "The Message-ID: header line" "SECID226"
31529 .cindex "&'Message-ID:'& header line"
31530 .cindex "message" "submission"
31531 .oindex "&%message_id_header_text%&"
31532 If a locally-generated or submission-mode incoming message does not contain a
31533 &'Message-ID:'& or &'Resent-Message-ID:'& header line, and the
31534 &%suppress_local_fixups%& control is not set, Exim adds a suitable header line
31535 to the message. If there are any &'Resent-:'& headers in the message, it
31536 creates &'Resent-Message-ID:'&. The id is constructed from Exim's internal
31537 message id, preceded by the letter E to ensure it starts with a letter, and
31538 followed by @ and the primary host name. Additional information can be included
31539 in this header line by setting the &%message_id_header_text%& and/or
31540 &%message_id_header_domain%& options.
31541
31542
31543 .section "The Received: header line" "SECID227"
31544 .cindex "&'Received:'& header line"
31545 A &'Received:'& header line is added at the start of every message. The
31546 contents are defined by the &%received_header_text%& configuration option, and
31547 Exim automatically adds a semicolon and a timestamp to the configured string.
31548
31549 The &'Received:'& header is generated as soon as the message's header lines
31550 have been received. At this stage, the timestamp in the &'Received:'& header
31551 line is the time that the message started to be received. This is the value
31552 that is seen by the DATA ACL and by the &[local_scan()]& function.
31553
31554 Once a message is accepted, the timestamp in the &'Received:'& header line is
31555 changed to the time of acceptance, which is (apart from a small delay while the
31556 -H spool file is written) the earliest time at which delivery could start.
31557
31558
31559 .section "The References: header line" "SECID228"
31560 .cindex "&'References:'& header line"
31561 Messages created by the &(autoreply)& transport include a &'References:'&
31562 header line. This is constructed according to the rules that are described in
31563 section 3.64 of RFC 2822 (which states that replies should contain such a
31564 header line), and section 3.14 of RFC 3834 (which states that automatic
31565 responses are not different in this respect). However, because some mail
31566 processing software does not cope well with very long header lines, no more
31567 than 12 message IDs are copied from the &'References:'& header line in the
31568 incoming message. If there are more than 12, the first one and then the final
31569 11 are copied, before adding the message ID of the incoming message.
31570
31571
31572
31573 .section "The Return-path: header line" "SECID229"
31574 .cindex "&'Return-path:'& header line"
31575 .oindex "&%return_path_remove%&"
31576 &'Return-path:'& header lines are defined as something an MTA may insert when
31577 it does the final delivery of messages. (See the generic &%return_path_add%&
31578 transport option.) Therefore, they should not be present in messages in
31579 transit. If the &%return_path_remove%& configuration option is set (the
31580 default), Exim removes &'Return-path:'& header lines from incoming messages.
31581
31582
31583
31584 .section "The Sender: header line" "SECTthesenhea"
31585 .cindex "&'Sender:'& header line"
31586 .cindex "message" "submission"
31587 For a locally-originated message from an untrusted user, Exim may remove an
31588 existing &'Sender:'& header line, and it may add a new one. You can modify
31589 these actions by setting the &%local_sender_retain%& option true, the
31590 &%local_from_check%& option false, or by using the &%suppress_local_fixups%&
31591 control setting.
31592
31593 When a local message is received from an untrusted user and
31594 &%local_from_check%& is true (the default), and the &%suppress_local_fixups%&
31595 control has not been set, a check is made to see if the address given in the
31596 &'From:'& header line is the correct (local) sender of the message. The address
31597 that is expected has the login name as the local part and the value of
31598 &%qualify_domain%& as the domain. Prefixes and suffixes for the local part can
31599 be permitted by setting &%local_from_prefix%& and &%local_from_suffix%&
31600 appropriately. If &'From:'& does not contain the correct sender, a &'Sender:'&
31601 line is added to the message.
31602
31603 If you set &%local_from_check%& false, this checking does not occur. However,
31604 the removal of an existing &'Sender:'& line still happens, unless you also set
31605 &%local_sender_retain%& to be true. It is not possible to set both of these
31606 options true at the same time.
31607
31608 .cindex "submission mode"
31609 By default, no processing of &'Sender:'& header lines is done for messages
31610 received over TCP/IP or for messages submitted by trusted users. However, when
31611 a message is received over TCP/IP in submission mode, and &%sender_retain%& is
31612 not specified on the submission control, the following processing takes place:
31613
31614 .vindex "&$authenticated_id$&"
31615 First, any existing &'Sender:'& lines are removed. Then, if the SMTP session is
31616 authenticated, and &$authenticated_id$& is not empty, a sender address is
31617 created as follows:
31618
31619 .ilist
31620 .vindex "&$qualify_domain$&"
31621 If no domain is specified by the submission control, the local part is
31622 &$authenticated_id$& and the domain is &$qualify_domain$&.
31623 .next
31624 If a non-empty domain is specified by the submission control, the local part
31625 is &$authenticated_id$&, and the domain is the specified domain.
31626 .next
31627 If an empty domain is specified by the submission control,
31628 &$authenticated_id$& is assumed to be the complete address.
31629 .endlist
31630
31631 This address is compared with the address in the &'From:'& header line. If they
31632 are different, a &'Sender:'& header line containing the created address is
31633 added. Prefixes and suffixes for the local part in &'From:'& can be permitted
31634 by setting &%local_from_prefix%& and &%local_from_suffix%& appropriately.
31635
31636 .cindex "return path" "created from &'Sender:'&"
31637 &*Note*&: Whenever a &'Sender:'& header line is created, the return path for
31638 the message (the envelope sender address) is changed to be the same address,
31639 except in the case of submission mode when &%sender_retain%& is specified.
31640
31641
31642
31643 .section "Adding and removing header lines in routers and transports" &&&
31644          "SECTheadersaddrem"
31645 .cindex "header lines" "adding; in router or transport"
31646 .cindex "header lines" "removing; in router or transport"
31647 When a message is delivered, the addition and removal of header lines can be
31648 specified in a system filter, or on any of the routers and transports that
31649 process the message. Section &<<SECTaddremheasys>>& contains details about
31650 modifying headers in a system filter. Header lines can also be added in an ACL
31651 as a message is received (see section &<<SECTaddheadacl>>&).
31652
31653 In contrast to what happens in a system filter, header modifications that are
31654 specified on routers and transports apply only to the particular recipient
31655 addresses that are being processed by those routers and transports. These
31656 changes do not actually take place until a copy of the message is being
31657 transported. Therefore, they do not affect the basic set of header lines, and
31658 they do not affect the values of the variables that refer to header lines.
31659
31660 &*Note*&: In particular, this means that any expansions in the configuration of
31661 the transport cannot refer to the modified header lines, because such
31662 expansions all occur before the message is actually transported.
31663
31664 For both routers and transports, the result of expanding a &%headers_add%&
31665 option must be in the form of one or more RFC 2822 header lines, separated by
31666 newlines (coded as &"\n"&). For example:
31667 .code
31668 headers_add = X-added-header: added by $primary_hostname\n\
31669               X-added-second: another added header line
31670 .endd
31671 Exim does not check the syntax of these added header lines.
31672
31673 Multiple &%headers_add%& options for a single router or transport can be
31674 specified; the values will be concatenated (with a separating newline
31675 added) before expansion.
31676
31677 The result of expanding &%headers_remove%& must consist of a colon-separated
31678 list of header names. This is confusing, because header names themselves are
31679 often terminated by colons. In this case, the colons are the list separators,
31680 not part of the names. For example:
31681 .code
31682 headers_remove = return-receipt-to:acknowledge-to
31683 .endd
31684
31685 Multiple &%headers_remove%& options for a single router or transport can be
31686 specified; the values will be concatenated (with a separating colon
31687 added) before expansion.
31688
31689 When &%headers_add%& or &%headers_remove%& is specified on a router, its value
31690 is expanded at routing time, and then associated with all addresses that are
31691 accepted by that router, and also with any new addresses that it generates. If
31692 an address passes through several routers as a result of aliasing or
31693 forwarding, the changes are cumulative.
31694
31695 .oindex "&%unseen%&"
31696 However, this does not apply to multiple routers that result from the use of
31697 the &%unseen%& option. Any header modifications that were specified by the
31698 &"unseen"& router or its predecessors apply only to the &"unseen"& delivery.
31699
31700 Addresses that end up with different &%headers_add%& or &%headers_remove%&
31701 settings cannot be delivered together in a batch, so a transport is always
31702 dealing with a set of addresses that have the same header-processing
31703 requirements.
31704
31705 The transport starts by writing the original set of header lines that arrived
31706 with the message, possibly modified by the system filter. As it writes out
31707 these lines, it consults the list of header names that were attached to the
31708 recipient address(es) by &%headers_remove%& options in routers, and it also
31709 consults the transport's own &%headers_remove%& option. Header lines whose
31710 names are on either of these lists are not written out. If there are multiple
31711 instances of any listed header, they are all skipped.
31712
31713 After the remaining original header lines have been written, new header
31714 lines that were specified by routers' &%headers_add%& options are written, in
31715 the order in which they were attached to the address. These are followed by any
31716 header lines specified by the transport's &%headers_add%& option.
31717
31718 This way of handling header line modifications in routers and transports has
31719 the following consequences:
31720
31721 .ilist
31722 The original set of header lines, possibly modified by the system filter,
31723 remains &"visible"&, in the sense that the &$header_$&&'xxx'& variables refer
31724 to it, at all times.
31725 .next
31726 Header lines that are added by a router's
31727 &%headers_add%& option are not accessible by means of the &$header_$&&'xxx'&
31728 expansion syntax in subsequent routers or the transport.
31729 .next
31730 Conversely, header lines that are specified for removal by &%headers_remove%&
31731 in a router remain visible to subsequent routers and the transport.
31732 .next
31733 Headers added to an address by &%headers_add%& in a router cannot be removed by
31734 a later router or by a transport.
31735 .next
31736 An added header can refer to the contents of an original header that is to be
31737 removed, even it has the same name as the added header. For example:
31738 .code
31739 headers_remove = subject
31740 headers_add = Subject: new subject (was: $h_subject:)
31741 .endd
31742 .endlist
31743
31744 &*Warning*&: The &%headers_add%& and &%headers_remove%& options cannot be used
31745 for a &(redirect)& router that has the &%one_time%& option set.
31746
31747
31748
31749
31750
31751 .section "Constructed addresses" "SECTconstr"
31752 .cindex "address" "constructed"
31753 .cindex "constructed address"
31754 When Exim constructs a sender address for a locally-generated message, it uses
31755 the form
31756 .display
31757 <&'user name'&>&~&~<&'login'&&`@`&&'qualify_domain'&>
31758 .endd
31759 For example:
31760 .code
31761 Zaphod Beeblebrox <zaphod@end.univ.example>
31762 .endd
31763 The user name is obtained from the &%-F%& command line option if set, or
31764 otherwise by looking up the calling user by &[getpwuid()]& and extracting the
31765 &"gecos"& field from the password entry. If the &"gecos"& field contains an
31766 ampersand character, this is replaced by the login name with the first letter
31767 upper cased, as is conventional in a number of operating systems. See the
31768 &%gecos_name%& option for a way to tailor the handling of the &"gecos"& field.
31769 The &%unknown_username%& option can be used to specify user names in cases when
31770 there is no password file entry.
31771
31772 .cindex "RFC 2047"
31773 In all cases, the user name is made to conform to RFC 2822 by quoting all or
31774 parts of it if necessary. In addition, if it contains any non-printing
31775 characters, it is encoded as described in RFC 2047, which defines a way of
31776 including non-ASCII characters in header lines. The value of the
31777 &%headers_charset%& option specifies the name of the encoding that is used (the
31778 characters are assumed to be in this encoding). The setting of
31779 &%print_topbitchars%& controls whether characters with the top bit set (that
31780 is, with codes greater than 127) count as printing characters or not.
31781
31782
31783
31784 .section "Case of local parts" "SECID230"
31785 .cindex "case of local parts"
31786 .cindex "local part" "case of"
31787 RFC 2822 states that the case of letters in the local parts of addresses cannot
31788 be assumed to be non-significant. Exim preserves the case of local parts of
31789 addresses, but by default it uses a lower-cased form when it is routing,
31790 because on most Unix systems, usernames are in lower case and case-insensitive
31791 routing is required. However, any particular router can be made to use the
31792 original case for local parts by setting the &%caseful_local_part%& generic
31793 router option.
31794
31795 .cindex "mixed-case login names"
31796 If you must have mixed-case user names on your system, the best way to proceed,
31797 assuming you want case-independent handling of incoming email, is to set up
31798 your first router to convert incoming local parts in your domains to the
31799 correct case by means of a file lookup. For example:
31800 .code
31801 correct_case:
31802   driver = redirect
31803   domains = +local_domains
31804   data = ${lookup{$local_part}cdb\
31805               {/etc/usercased.cdb}{$value}fail}\
31806               @$domain
31807 .endd
31808 For this router, the local part is forced to lower case by the default action
31809 (&%caseful_local_part%& is not set). The lower-cased local part is used to look
31810 up a new local part in the correct case. If you then set &%caseful_local_part%&
31811 on any subsequent routers which process your domains, they will operate on
31812 local parts with the correct case in a case-sensitive manner.
31813
31814
31815
31816 .section "Dots in local parts" "SECID231"
31817 .cindex "dot" "in local part"
31818 .cindex "local part" "dots in"
31819 RFC 2822 forbids empty components in local parts. That is, an unquoted local
31820 part may not begin or end with a dot, nor have two consecutive dots in the
31821 middle. However, it seems that many MTAs do not enforce this, so Exim permits
31822 empty components for compatibility.
31823
31824
31825
31826 .section "Rewriting addresses" "SECID232"
31827 .cindex "rewriting" "addresses"
31828 Rewriting of sender and recipient addresses, and addresses in headers, can
31829 happen automatically, or as the result of configuration options, as described
31830 in chapter &<<CHAPrewrite>>&. The headers that may be affected by this are
31831 &'Bcc:'&, &'Cc:'&, &'From:'&, &'Reply-To:'&, &'Sender:'&, and &'To:'&.
31832
31833 Automatic rewriting includes qualification, as mentioned above. The other case
31834 in which it can happen is when an incomplete non-local domain is given. The
31835 routing process may cause this to be expanded into the full domain name. For
31836 example, a header such as
31837 .code
31838 To: hare@teaparty
31839 .endd
31840 might get rewritten as
31841 .code
31842 To: hare@teaparty.wonderland.fict.example
31843 .endd
31844 Rewriting as a result of routing is the one kind of message processing that
31845 does not happen at input time, as it cannot be done until the address has
31846 been routed.
31847
31848 Strictly, one should not do &'any'& deliveries of a message until all its
31849 addresses have been routed, in case any of the headers get changed as a
31850 result of routing. However, doing this in practice would hold up many
31851 deliveries for unreasonable amounts of time, just because one address could not
31852 immediately be routed. Exim therefore does not delay other deliveries when
31853 routing of one or more addresses is deferred.
31854 .ecindex IIDmesproc
31855
31856
31857
31858 . ////////////////////////////////////////////////////////////////////////////
31859 . ////////////////////////////////////////////////////////////////////////////
31860
31861 .chapter "SMTP processing" "CHAPSMTP"
31862 .scindex IIDsmtpproc1 "SMTP" "processing details"
31863 .scindex IIDsmtpproc2 "LMTP" "processing details"
31864 Exim supports a number of different ways of using the SMTP protocol, and its
31865 LMTP variant, which is an interactive protocol for transferring messages into a
31866 closed mail store application. This chapter contains details of how SMTP is
31867 processed. For incoming mail, the following are available:
31868
31869 .ilist
31870 SMTP over TCP/IP (Exim daemon or &'inetd'&);
31871 .next
31872 SMTP over the standard input and output (the &%-bs%& option);
31873 .next
31874 Batched SMTP on the standard input (the &%-bS%& option).
31875 .endlist
31876
31877 For mail delivery, the following are available:
31878
31879 .ilist
31880 SMTP over TCP/IP (the &(smtp)& transport);
31881 .next
31882 LMTP over TCP/IP (the &(smtp)& transport with the &%protocol%& option set to
31883 &"lmtp"&);
31884 .next
31885 LMTP over a pipe to a process running in the local host (the &(lmtp)&
31886 transport);
31887 .next
31888 Batched SMTP to a file or pipe (the &(appendfile)& and &(pipe)& transports with
31889 the &%use_bsmtp%& option set).
31890 .endlist
31891
31892 &'Batched SMTP'& is the name for a process in which batches of messages are
31893 stored in or read from files (or pipes), in a format in which SMTP commands are
31894 used to contain the envelope information.
31895
31896
31897
31898 .section "Outgoing SMTP and LMTP over TCP/IP" "SECToutSMTPTCP"
31899 .cindex "SMTP" "outgoing over TCP/IP"
31900 .cindex "outgoing SMTP over TCP/IP"
31901 .cindex "LMTP" "over TCP/IP"
31902 .cindex "outgoing LMTP over TCP/IP"
31903 .cindex "EHLO"
31904 .cindex "HELO"
31905 .cindex "SIZE option on MAIL command"
31906 Outgoing SMTP and LMTP over TCP/IP is implemented by the &(smtp)& transport.
31907 The &%protocol%& option selects which protocol is to be used, but the actual
31908 processing is the same in both cases.
31909
31910 If, in response to its EHLO command, Exim is told that the SIZE
31911 parameter is supported, it adds SIZE=<&'n'&> to each subsequent MAIL
31912 command. The value of <&'n'&> is the message size plus the value of the
31913 &%size_addition%& option (default 1024) to allow for additions to the message
31914 such as per-transport header lines, or changes made in a
31915 .cindex "transport" "filter"
31916 .cindex "filter" "transport filter"
31917 transport filter. If &%size_addition%& is set negative, the use of SIZE is
31918 suppressed.
31919
31920 If the remote server advertises support for PIPELINING, Exim uses the
31921 pipelining extension to SMTP (RFC 2197) to reduce the number of TCP/IP packets
31922 required for the transaction.
31923
31924 If the remote server advertises support for the STARTTLS command, and Exim
31925 was built to support TLS encryption, it tries to start a TLS session unless the
31926 server matches &%hosts_avoid_tls%&. See chapter &<<CHAPTLS>>& for more details.
31927 Either a match in that or &%hosts_verify_avoid_tls%& apply when the transport
31928 is called for verification.
31929
31930 If the remote server advertises support for the AUTH command, Exim scans
31931 the authenticators configuration for any suitable client settings, as described
31932 in chapter &<<CHAPSMTPAUTH>>&.
31933
31934 .cindex "carriage return"
31935 .cindex "linefeed"
31936 Responses from the remote host are supposed to be terminated by CR followed by
31937 LF. However, there are known to be hosts that do not send CR characters, so in
31938 order to be able to interwork with such hosts, Exim treats LF on its own as a
31939 line terminator.
31940
31941 If a message contains a number of different addresses, all those with the same
31942 characteristics (for example, the same envelope sender) that resolve to the
31943 same set of hosts, in the same order, are sent in a single SMTP transaction,
31944 even if they are for different domains, unless there are more than the setting
31945 of the &%max_rcpt%&s option in the &(smtp)& transport allows, in which case
31946 they are split into groups containing no more than &%max_rcpt%&s addresses
31947 each. If &%remote_max_parallel%& is greater than one, such groups may be sent
31948 in parallel sessions. The order of hosts with identical MX values is not
31949 significant when checking whether addresses can be batched in this way.
31950
31951 When the &(smtp)& transport suffers a temporary failure that is not
31952 message-related, Exim updates its transport-specific database, which contains
31953 records indexed by host name that remember which messages are waiting for each
31954 particular host. It also updates the retry database with new retry times.
31955
31956 .cindex "hints database" "retry keys"
31957 Exim's retry hints are based on host name plus IP address, so if one address of
31958 a multi-homed host is broken, it will soon be skipped most of the time.
31959 See the next section for more detail about error handling.
31960
31961 .cindex "SMTP" "passed connection"
31962 .cindex "SMTP" "batching over TCP/IP"
31963 When a message is successfully delivered over a TCP/IP SMTP connection, Exim
31964 looks in the hints database for the transport to see if there are any queued
31965 messages waiting for the host to which it is connected. If it finds one, it
31966 creates a new Exim process using the &%-MC%& option (which can only be used by
31967 a process running as root or the Exim user) and passes the TCP/IP socket to it
31968 so that it can deliver another message using the same socket. The new process
31969 does only those deliveries that are routed to the connected host, and may in
31970 turn pass the socket on to a third process, and so on.
31971
31972 The &%connection_max_messages%& option of the &(smtp)& transport can be used to
31973 limit the number of messages sent down a single TCP/IP connection.
31974
31975 .cindex "asterisk" "after IP address"
31976 The second and subsequent messages delivered down an existing connection are
31977 identified in the main log by the addition of an asterisk after the closing
31978 square bracket of the IP address.
31979
31980
31981
31982
31983 .section "Errors in outgoing SMTP" "SECToutSMTPerr"
31984 .cindex "error" "in outgoing SMTP"
31985 .cindex "SMTP" "errors in outgoing"
31986 .cindex "host" "error"
31987 Three different kinds of error are recognized for outgoing SMTP: host errors,
31988 message errors, and recipient errors.
31989
31990 .vlist
31991 .vitem "&*Host errors*&"
31992 A host error is not associated with a particular message or with a
31993 particular recipient of a message. The host errors are:
31994
31995 .ilist
31996 Connection refused or timed out,
31997 .next
31998 Any error response code on connection,
31999 .next
32000 Any error response code to EHLO or HELO,
32001 .next
32002 Loss of connection at any time, except after &"."&,
32003 .next
32004 I/O errors at any time,
32005 .next
32006 Timeouts during the session, other than in response to MAIL, RCPT or
32007 the &"."& at the end of the data.
32008 .endlist ilist
32009
32010 For a host error, a permanent error response on connection, or in response to
32011 EHLO, causes all addresses routed to the host to be failed. Any other host
32012 error causes all addresses to be deferred, and retry data to be created for the
32013 host. It is not tried again, for any message, until its retry time arrives. If
32014 the current set of addresses are not all delivered in this run (to some
32015 alternative host), the message is added to the list of those waiting for this
32016 host, so if it is still undelivered when a subsequent successful delivery is
32017 made to the host, it will be sent down the same SMTP connection.
32018
32019 .vitem "&*Message errors*&"
32020 .cindex "message" "error"
32021 A message error is associated with a particular message when sent to a
32022 particular host, but not with a particular recipient of the message. The
32023 message errors are:
32024
32025 .ilist
32026 Any error response code to MAIL, DATA, or the &"."& that terminates
32027 the data,
32028 .next
32029 Timeout after MAIL,
32030 .next
32031 Timeout or loss of connection after the &"."& that terminates the data. A
32032 timeout after the DATA command itself is treated as a host error, as is loss of
32033 connection at any other time.
32034 .endlist ilist
32035
32036 For a message error, a permanent error response (5&'xx'&) causes all addresses
32037 to be failed, and a delivery error report to be returned to the sender. A
32038 temporary error response (4&'xx'&), or one of the timeouts, causes all
32039 addresses to be deferred. Retry data is not created for the host, but instead,
32040 a retry record for the combination of host plus message id is created. The
32041 message is not added to the list of those waiting for this host. This ensures
32042 that the failing message will not be sent to this host again until the retry
32043 time arrives. However, other messages that are routed to the host are not
32044 affected, so if it is some property of the message that is causing the error,
32045 it will not stop the delivery of other mail.
32046
32047 If the remote host specified support for the SIZE parameter in its response
32048 to EHLO, Exim adds SIZE=&'nnn'& to the MAIL command, so an
32049 over-large message will cause a message error because the error arrives as a
32050 response to MAIL.
32051
32052 .vitem "&*Recipient errors*&"
32053 .cindex "recipient" "error"
32054 A recipient error is associated with a particular recipient of a message. The
32055 recipient errors are:
32056
32057 .ilist
32058 Any error response to RCPT,
32059 .next
32060 Timeout after RCPT.
32061 .endlist
32062
32063 For a recipient error, a permanent error response (5&'xx'&) causes the
32064 recipient address to be failed, and a bounce message to be returned to the
32065 sender. A temporary error response (4&'xx'&) or a timeout causes the failing
32066 address to be deferred, and routing retry data to be created for it. This is
32067 used to delay processing of the address in subsequent queue runs, until its
32068 routing retry time arrives. This applies to all messages, but because it
32069 operates only in queue runs, one attempt will be made to deliver a new message
32070 to the failing address before the delay starts to operate. This ensures that,
32071 if the failure is really related to the message rather than the recipient
32072 (&"message too big for this recipient"& is a possible example), other messages
32073 have a chance of getting delivered. If a delivery to the address does succeed,
32074 the retry information gets cleared, so all stuck messages get tried again, and
32075 the retry clock is reset.
32076
32077 The message is not added to the list of those waiting for this host. Use of the
32078 host for other messages is unaffected, and except in the case of a timeout,
32079 other recipients are processed independently, and may be successfully delivered
32080 in the current SMTP session. After a timeout it is of course impossible to
32081 proceed with the session, so all addresses get deferred. However, those other
32082 than the one that failed do not suffer any subsequent retry delays. Therefore,
32083 if one recipient is causing trouble, the others have a chance of getting
32084 through when a subsequent delivery attempt occurs before the failing
32085 recipient's retry time.
32086 .endlist
32087
32088 In all cases, if there are other hosts (or IP addresses) available for the
32089 current set of addresses (for example, from multiple MX records), they are
32090 tried in this run for any undelivered addresses, subject of course to their
32091 own retry data. In other words, recipient error retry data does not take effect
32092 until the next delivery attempt.
32093
32094 Some hosts have been observed to give temporary error responses to every
32095 MAIL command at certain times (&"insufficient space"& has been seen). It
32096 would be nice if such circumstances could be recognized, and defer data for the
32097 host itself created, but this is not possible within the current Exim design.
32098 What actually happens is that retry data for every (host, message) combination
32099 is created.
32100
32101 The reason that timeouts after MAIL and RCPT are treated specially is that
32102 these can sometimes arise as a result of the remote host's verification
32103 procedures. Exim makes this assumption, and treats them as if a temporary error
32104 response had been received. A timeout after &"."& is treated specially because
32105 it is known that some broken implementations fail to recognize the end of the
32106 message if the last character of the last line is a binary zero. Thus, it is
32107 helpful to treat this case as a message error.
32108
32109 Timeouts at other times are treated as host errors, assuming a problem with the
32110 host, or the connection to it. If a timeout after MAIL, RCPT,
32111 or &"."& is really a connection problem, the assumption is that at the next try
32112 the timeout is likely to occur at some other point in the dialogue, causing it
32113 then to be treated as a host error.
32114
32115 There is experimental evidence that some MTAs drop the connection after the
32116 terminating &"."& if they do not like the contents of the message for some
32117 reason, in contravention of the RFC, which indicates that a 5&'xx'& response
32118 should be given. That is why Exim treats this case as a message rather than a
32119 host error, in order not to delay other messages to the same host.
32120
32121
32122
32123
32124 .section "Incoming SMTP messages over TCP/IP" "SECID233"
32125 .cindex "SMTP" "incoming over TCP/IP"
32126 .cindex "incoming SMTP over TCP/IP"
32127 .cindex "inetd"
32128 .cindex "daemon"
32129 Incoming SMTP messages can be accepted in one of two ways: by running a
32130 listening daemon, or by using &'inetd'&. In the latter case, the entry in
32131 &_/etc/inetd.conf_& should be like this:
32132 .code
32133 smtp stream tcp nowait exim /opt/exim/bin/exim in.exim -bs
32134 .endd
32135 Exim distinguishes between this case and the case of a locally running user
32136 agent using the &%-bs%& option by checking whether or not the standard input is
32137 a socket. When it is, either the port must be privileged (less than 1024), or
32138 the caller must be root or the Exim user. If any other user passes a socket
32139 with an unprivileged port number, Exim prints a message on the standard error
32140 stream and exits with an error code.
32141
32142 By default, Exim does not make a log entry when a remote host connects or
32143 disconnects (either via the daemon or &'inetd'&), unless the disconnection is
32144 unexpected. It can be made to write such log entries by setting the
32145 &%smtp_connection%& log selector.
32146
32147 .cindex "carriage return"
32148 .cindex "linefeed"
32149 Commands from the remote host are supposed to be terminated by CR followed by
32150 LF. However, there are known to be hosts that do not send CR characters. In
32151 order to be able to interwork with such hosts, Exim treats LF on its own as a
32152 line terminator.
32153 Furthermore, because common code is used for receiving messages from all
32154 sources, a CR on its own is also interpreted as a line terminator. However, the
32155 sequence &"CR, dot, CR"& does not terminate incoming SMTP data.
32156
32157 .cindex "EHLO" "invalid data"
32158 .cindex "HELO" "invalid data"
32159 One area that sometimes gives rise to problems concerns the EHLO or
32160 HELO commands. Some clients send syntactically invalid versions of these
32161 commands, which Exim rejects by default. (This is nothing to do with verifying
32162 the data that is sent, so &%helo_verify_hosts%& is not relevant.) You can tell
32163 Exim not to apply a syntax check by setting &%helo_accept_junk_hosts%& to
32164 match the broken hosts that send invalid commands.
32165
32166 .cindex "SIZE option on MAIL command"
32167 .cindex "MAIL" "SIZE option"
32168 The amount of disk space available is checked whenever SIZE is received on
32169 a MAIL command, independently of whether &%message_size_limit%& or
32170 &%check_spool_space%& is configured, unless &%smtp_check_spool_space%& is set
32171 false. A temporary error is given if there is not enough space. If
32172 &%check_spool_space%& is set, the check is for that amount of space plus the
32173 value given with SIZE, that is, it checks that the addition of the incoming
32174 message will not reduce the space below the threshold.
32175
32176 When a message is successfully received, Exim includes the local message id in
32177 its response to the final &"."& that terminates the data. If the remote host
32178 logs this text it can help with tracing what has happened to a message.
32179
32180 The Exim daemon can limit the number of simultaneous incoming connections it is
32181 prepared to handle (see the &%smtp_accept_max%& option). It can also limit the
32182 number of simultaneous incoming connections from a single remote host (see the
32183 &%smtp_accept_max_per_host%& option). Additional connection attempts are
32184 rejected using the SMTP temporary error code 421.
32185
32186 The Exim daemon does not rely on the SIGCHLD signal to detect when a
32187 subprocess has finished, as this can get lost at busy times. Instead, it looks
32188 for completed subprocesses every time it wakes up. Provided there are other
32189 things happening (new incoming calls, starts of queue runs), completed
32190 processes will be noticed and tidied away. On very quiet systems you may
32191 sometimes see a &"defunct"& Exim process hanging about. This is not a problem;
32192 it will be noticed when the daemon next wakes up.
32193
32194 When running as a daemon, Exim can reserve some SMTP slots for specific hosts,
32195 and can also be set up to reject SMTP calls from non-reserved hosts at times of
32196 high system load &-- for details see the &%smtp_accept_reserve%&,
32197 &%smtp_load_reserve%&, and &%smtp_reserve_hosts%& options. The load check
32198 applies in both the daemon and &'inetd'& cases.
32199
32200 Exim normally starts a delivery process for each message received, though this
32201 can be varied by means of the &%-odq%& command line option and the
32202 &%queue_only%&, &%queue_only_file%&, and &%queue_only_load%& options. The
32203 number of simultaneously running delivery processes started in this way from
32204 SMTP input can be limited by the &%smtp_accept_queue%& and
32205 &%smtp_accept_queue_per_connection%& options. When either limit is reached,
32206 subsequently received messages are just put on the input queue without starting
32207 a delivery process.
32208
32209 The controls that involve counts of incoming SMTP calls (&%smtp_accept_max%&,
32210 &%smtp_accept_queue%&, &%smtp_accept_reserve%&) are not available when Exim is
32211 started up from the &'inetd'& daemon, because in that case each connection is
32212 handled by an entirely independent Exim process. Control by load average is,
32213 however, available with &'inetd'&.
32214
32215 Exim can be configured to verify addresses in incoming SMTP commands as they
32216 are received. See chapter &<<CHAPACL>>& for details. It can also be configured
32217 to rewrite addresses at this time &-- before any syntax checking is done. See
32218 section &<<SECTrewriteS>>&.
32219
32220 Exim can also be configured to limit the rate at which a client host submits
32221 MAIL and RCPT commands in a single SMTP session. See the
32222 &%smtp_ratelimit_hosts%& option.
32223
32224
32225
32226 .section "Unrecognized SMTP commands" "SECID234"
32227 .cindex "SMTP" "unrecognized commands"
32228 If Exim receives more than &%smtp_max_unknown_commands%& unrecognized SMTP
32229 commands during a single SMTP connection, it drops the connection after sending
32230 the error response to the last command. The default value for
32231 &%smtp_max_unknown_commands%& is 3. This is a defence against some kinds of
32232 abuse that subvert web servers into making connections to SMTP ports; in these
32233 circumstances, a number of non-SMTP lines are sent first.
32234
32235
32236 .section "Syntax and protocol errors in SMTP commands" "SECID235"
32237 .cindex "SMTP" "syntax errors"
32238 .cindex "SMTP" "protocol errors"
32239 A syntax error is detected if an SMTP command is recognized, but there is
32240 something syntactically wrong with its data, for example, a malformed email
32241 address in a RCPT command. Protocol errors include invalid command
32242 sequencing such as RCPT before MAIL. If Exim receives more than
32243 &%smtp_max_synprot_errors%& such commands during a single SMTP connection, it
32244 drops the connection after sending the error response to the last command. The
32245 default value for &%smtp_max_synprot_errors%& is 3. This is a defence against
32246 broken clients that loop sending bad commands (yes, it has been seen).
32247
32248
32249
32250 .section "Use of non-mail SMTP commands" "SECID236"
32251 .cindex "SMTP" "non-mail commands"
32252 The &"non-mail"& SMTP commands are those other than MAIL, RCPT, and
32253 DATA. Exim counts such commands, and drops the connection if there are too
32254 many of them in a single SMTP session. This action catches some
32255 denial-of-service attempts and things like repeated failing AUTHs, or a mad
32256 client looping sending EHLO. The global option &%smtp_accept_max_nonmail%&
32257 defines what &"too many"& means. Its default value is 10.
32258
32259 When a new message is expected, one occurrence of RSET is not counted. This
32260 allows a client to send one RSET between messages (this is not necessary,
32261 but some clients do it). Exim also allows one uncounted occurrence of HELO
32262 or EHLO, and one occurrence of STARTTLS between messages. After
32263 starting up a TLS session, another EHLO is expected, and so it too is not
32264 counted.
32265
32266 The first occurrence of AUTH in a connection, or immediately following
32267 STARTTLS is also not counted. Otherwise, all commands other than MAIL,
32268 RCPT, DATA, and QUIT are counted.
32269
32270 You can control which hosts are subject to the limit set by
32271 &%smtp_accept_max_nonmail%& by setting
32272 &%smtp_accept_max_nonmail_hosts%&. The default value is &`*`&, which makes
32273 the limit apply to all hosts. This option means that you can exclude any
32274 specific badly-behaved hosts that you have to live with.
32275
32276
32277
32278
32279 .section "The VRFY and EXPN commands" "SECID237"
32280 When Exim receives a VRFY or EXPN command on a TCP/IP connection, it
32281 runs the ACL specified by &%acl_smtp_vrfy%& or &%acl_smtp_expn%& (as
32282 appropriate) in order to decide whether the command should be accepted or not.
32283 If no ACL is defined, the command is rejected.
32284
32285 .cindex "VRFY" "processing"
32286 When VRFY is accepted, it runs exactly the same code as when Exim is
32287 called with the &%-bv%& option.
32288
32289 .cindex "EXPN" "processing"
32290 When EXPN is accepted, a single-level expansion of the address is done.
32291 EXPN is treated as an &"address test"& (similar to the &%-bt%& option) rather
32292 than a verification (the &%-bv%& option). If an unqualified local part is given
32293 as the argument to EXPN, it is qualified with &%qualify_domain%&. Rejections
32294 of VRFY and EXPN commands are logged on the main and reject logs, and
32295 VRFY verification failures are logged on the main log for consistency with
32296 RCPT failures.
32297
32298
32299
32300 .section "The ETRN command" "SECTETRN"
32301 .cindex "ETRN" "processing"
32302 RFC 1985 describes an SMTP command called ETRN that is designed to
32303 overcome the security problems of the TURN command (which has fallen into
32304 disuse). When Exim receives an ETRN command on a TCP/IP connection, it runs
32305 the ACL specified by &%acl_smtp_etrn%& in order to decide whether the command
32306 should be accepted or not. If no ACL is defined, the command is rejected.
32307
32308 The ETRN command is concerned with &"releasing"& messages that are awaiting
32309 delivery to certain hosts. As Exim does not organize its message queue by host,
32310 the only form of ETRN that is supported by default is the one where the
32311 text starts with the &"#"& prefix, in which case the remainder of the text is
32312 specific to the SMTP server. A valid ETRN command causes a run of Exim with
32313 the &%-R%& option to happen, with the remainder of the ETRN text as its
32314 argument. For example,
32315 .code
32316 ETRN #brigadoon
32317 .endd
32318 runs the command
32319 .code
32320 exim -R brigadoon
32321 .endd
32322 which causes a delivery attempt on all messages with undelivered addresses
32323 containing the text &"brigadoon"&. When &%smtp_etrn_serialize%& is set (the
32324 default), Exim prevents the simultaneous execution of more than one queue run
32325 for the same argument string as a result of an ETRN command. This stops
32326 a misbehaving client from starting more than one queue runner at once.
32327
32328 .cindex "hints database" "ETRN serialization"
32329 Exim implements the serialization by means of a hints database in which a
32330 record is written whenever a process is started by ETRN, and deleted when
32331 the process completes. However, Exim does not keep the SMTP session waiting for
32332 the ETRN process to complete. Once ETRN is accepted, the client is sent
32333 a &"success"& return code. Obviously there is scope for hints records to get
32334 left lying around if there is a system or program crash. To guard against this,
32335 Exim ignores any records that are more than six hours old.
32336
32337 .oindex "&%smtp_etrn_command%&"
32338 For more control over what ETRN does, the &%smtp_etrn_command%& option can
32339 used. This specifies a command that is run whenever ETRN is received,
32340 whatever the form of its argument. For
32341 example:
32342 .code
32343 smtp_etrn_command = /etc/etrn_command $domain \
32344                     $sender_host_address
32345 .endd
32346 .vindex "&$domain$&"
32347 The string is split up into arguments which are independently expanded. The
32348 expansion variable &$domain$& is set to the argument of the ETRN command,
32349 and no syntax checking is done on the contents of this argument. Exim does not
32350 wait for the command to complete, so its status code is not checked. Exim runs
32351 under its own uid and gid when receiving incoming SMTP, so it is not possible
32352 for it to change them before running the command.
32353
32354
32355
32356 .section "Incoming local SMTP" "SECID238"
32357 .cindex "SMTP" "local incoming"
32358 Some user agents use SMTP to pass messages to their local MTA using the
32359 standard input and output, as opposed to passing the envelope on the command
32360 line and writing the message to the standard input. This is supported by the
32361 &%-bs%& option. This form of SMTP is handled in the same way as incoming
32362 messages over TCP/IP (including the use of ACLs), except that the envelope
32363 sender given in a MAIL command is ignored unless the caller is trusted. In
32364 an ACL you can detect this form of SMTP input by testing for an empty host
32365 identification. It is common to have this as the first line in the ACL that
32366 runs for RCPT commands:
32367 .code
32368 accept hosts = :
32369 .endd
32370 This accepts SMTP messages from local processes without doing any other tests.
32371
32372
32373
32374 .section "Outgoing batched SMTP" "SECTbatchSMTP"
32375 .cindex "SMTP" "batched outgoing"
32376 .cindex "batched SMTP output"
32377 Both the &(appendfile)& and &(pipe)& transports can be used for handling
32378 batched SMTP. Each has an option called &%use_bsmtp%& which causes messages to
32379 be output in BSMTP format. No SMTP responses are possible for this form of
32380 delivery. All it is doing is using SMTP commands as a way of transmitting the
32381 envelope along with the message.
32382
32383 The message is written to the file or pipe preceded by the SMTP commands
32384 MAIL and RCPT, and followed by a line containing a single dot. Lines in
32385 the message that start with a dot have an extra dot added. The SMTP command
32386 HELO is not normally used. If it is required, the &%message_prefix%& option
32387 can be used to specify it.
32388
32389 Because &(appendfile)& and &(pipe)& are both local transports, they accept only
32390 one recipient address at a time by default. However, you can arrange for them
32391 to handle several addresses at once by setting the &%batch_max%& option. When
32392 this is done for BSMTP, messages may contain multiple RCPT commands. See
32393 chapter &<<CHAPbatching>>& for more details.
32394
32395 .vindex "&$host$&"
32396 When one or more addresses are routed to a BSMTP transport by a router that
32397 sets up a host list, the name of the first host on the list is available to the
32398 transport in the variable &$host$&. Here is an example of such a transport and
32399 router:
32400 .code
32401 begin routers
32402 route_append:
32403   driver = manualroute
32404   transport = smtp_appendfile
32405   route_list = domain.example  batch.host.example
32406
32407 begin transports
32408 smtp_appendfile:
32409   driver = appendfile
32410   directory = /var/bsmtp/$host
32411   batch_max = 1000
32412   use_bsmtp
32413   user = exim
32414 .endd
32415 This causes messages addressed to &'domain.example'& to be written in BSMTP
32416 format to &_/var/bsmtp/batch.host.example_&, with only a single copy of each
32417 message (unless there are more than 1000 recipients).
32418
32419
32420
32421 .section "Incoming batched SMTP" "SECTincomingbatchedSMTP"
32422 .cindex "SMTP" "batched incoming"
32423 .cindex "batched SMTP input"
32424 The &%-bS%& command line option causes Exim to accept one or more messages by
32425 reading SMTP on the standard input, but to generate no responses. If the caller
32426 is trusted, the senders in the MAIL commands are believed; otherwise the
32427 sender is always the caller of Exim. Unqualified senders and receivers are not
32428 rejected (there seems little point) but instead just get qualified. HELO
32429 and EHLO act as RSET; VRFY, EXPN, ETRN and  HELP, act
32430 as NOOP; QUIT quits.
32431
32432 Minimal policy checking is done for BSMTP input. Only the non-SMTP
32433 ACL is run in the same way as for non-SMTP local input.
32434
32435 If an error is detected while reading a message, including a missing &"."& at
32436 the end, Exim gives up immediately. It writes details of the error to the
32437 standard output in a stylized way that the calling program should be able to
32438 make some use of automatically, for example:
32439 .code
32440 554 Unexpected end of file
32441 Transaction started in line 10
32442 Error detected in line 14
32443 .endd
32444 It writes a more verbose version, for human consumption, to the standard error
32445 file, for example:
32446 .code
32447 An error was detected while processing a file of BSMTP input.
32448 The error message was:
32449
32450 501 '>' missing at end of address
32451
32452 The SMTP transaction started in line 10.
32453 The error was detected in line 12.
32454 The SMTP command at fault was:
32455
32456 rcpt to:<malformed@in.com.plete
32457
32458 1 previous message was successfully processed.
32459 The rest of the batch was abandoned.
32460 .endd
32461 The return code from Exim is zero only if there were no errors. It is 1 if some
32462 messages were accepted before an error was detected, and 2 if no messages were
32463 accepted.
32464 .ecindex IIDsmtpproc1
32465 .ecindex IIDsmtpproc2
32466
32467
32468
32469 . ////////////////////////////////////////////////////////////////////////////
32470 . ////////////////////////////////////////////////////////////////////////////
32471
32472 .chapter "Customizing bounce and warning messages" "CHAPemsgcust" &&&
32473          "Customizing messages"
32474 When a message fails to be delivered, or remains on the queue for more than a
32475 configured amount of time, Exim sends a message to the original sender, or
32476 to an alternative configured address. The text of these messages is built into
32477 the code of Exim, but it is possible to change it, either by adding a single
32478 string, or by replacing each of the paragraphs by text supplied in a file.
32479
32480 The &'From:'& and &'To:'& header lines are automatically generated; you can
32481 cause a &'Reply-To:'& line to be added by setting the &%errors_reply_to%&
32482 option. Exim also adds the line
32483 .code
32484 Auto-Submitted: auto-generated
32485 .endd
32486 to all warning and bounce messages,
32487
32488
32489 .section "Customizing bounce messages" "SECID239"
32490 .cindex "customizing" "bounce message"
32491 .cindex "bounce message" "customizing"
32492 If &%bounce_message_text%& is set, its contents are included in the default
32493 message immediately after &"This message was created automatically by mail
32494 delivery software."& The string is not expanded. It is not used if
32495 &%bounce_message_file%& is set.
32496
32497 When &%bounce_message_file%& is set, it must point to a template file for
32498 constructing error messages. The file consists of a series of text items,
32499 separated by lines consisting of exactly four asterisks. If the file cannot be
32500 opened, default text is used and a message is written to the main and panic
32501 logs. If any text item in the file is empty, default text is used for that
32502 item.
32503
32504 .vindex "&$bounce_recipient$&"
32505 .vindex "&$bounce_return_size_limit$&"
32506 Each item of text that is read from the file is expanded, and there are two
32507 expansion variables which can be of use here: &$bounce_recipient$& is set to
32508 the recipient of an error message while it is being created, and
32509 &$bounce_return_size_limit$& contains the value of the &%return_size_limit%&
32510 option, rounded to a whole number.
32511
32512 The items must appear in the file in the following order:
32513
32514 .ilist
32515 The first item is included in the headers, and should include at least a
32516 &'Subject:'& header. Exim does not check the syntax of these headers.
32517 .next
32518 The second item forms the start of the error message. After it, Exim lists the
32519 failing addresses with their error messages.
32520 .next
32521 The third item is used to introduce any text from pipe transports that is to be
32522 returned to the sender. It is omitted if there is no such text.
32523 .next
32524 The fourth item is used to introduce the copy of the message that is returned
32525 as part of the error report.
32526 .next
32527 The fifth item is added after the fourth one if the returned message is
32528 truncated because it is bigger than &%return_size_limit%&.
32529 .next
32530 The sixth item is added after the copy of the original message.
32531 .endlist
32532
32533 The default state (&%bounce_message_file%& unset) is equivalent to the
32534 following file, in which the sixth item is empty. The &'Subject:'& and some
32535 other lines have been split in order to fit them on the page:
32536 .code
32537 Subject: Mail delivery failed
32538   ${if eq{$sender_address}{$bounce_recipient}
32539   {: returning message to sender}}
32540 ****
32541 This message was created automatically by mail delivery software.
32542
32543 A message ${if eq{$sender_address}{$bounce_recipient}
32544   {that you sent }{sent by
32545
32546 <$sender_address>
32547
32548 }}could not be delivered to all of its recipients.
32549 This is a permanent error. The following address(es) failed:
32550 ****
32551 The following text was generated during the delivery attempt(s):
32552 ****
32553 ------ This is a copy of the message, including all the headers.
32554   ------
32555 ****
32556 ------ The body of the message is $message_size characters long;
32557   only the first
32558 ------ $bounce_return_size_limit or so are included here.
32559 ****
32560 .endd
32561 .section "Customizing warning messages" "SECTcustwarn"
32562 .cindex "customizing" "warning message"
32563 .cindex "warning of delay" "customizing the message"
32564 The option &%warn_message_file%& can be pointed at a template file for use when
32565 warnings about message delays are created. In this case there are only three
32566 text sections:
32567
32568 .ilist
32569 The first item is included in the headers, and should include at least a
32570 &'Subject:'& header. Exim does not check the syntax of these headers.
32571 .next
32572 The second item forms the start of the warning message. After it, Exim lists
32573 the delayed addresses.
32574 .next
32575 The third item then ends the message.
32576 .endlist
32577
32578 The default state is equivalent to the following file, except that some lines
32579 have been split here, in order to fit them on the page:
32580 .code
32581 Subject: Warning: message $message_exim_id delayed
32582   $warn_message_delay
32583 ****
32584 This message was created automatically by mail delivery software.
32585
32586 A message ${if eq{$sender_address}{$warn_message_recipients}
32587 {that you sent }{sent by
32588
32589 <$sender_address>
32590
32591 }}has not been delivered to all of its recipients after
32592 more than $warn_message_delay on the queue on $primary_hostname.
32593
32594 The message identifier is:     $message_exim_id
32595 The subject of the message is: $h_subject
32596 The date of the message is:    $h_date
32597
32598 The following address(es) have not yet been delivered:
32599 ****
32600 No action is required on your part. Delivery attempts will
32601 continue for some time, and this warning may be repeated at
32602 intervals if the message remains undelivered. Eventually the
32603 mail delivery software will give up, and when that happens,
32604 the message will be returned to you.
32605 .endd
32606 .vindex "&$warn_message_delay$&"
32607 .vindex "&$warn_message_recipients$&"
32608 However, in the default state the subject and date lines are omitted if no
32609 appropriate headers exist. During the expansion of this file,
32610 &$warn_message_delay$& is set to the delay time in one of the forms &"<&'n'&>
32611 minutes"& or &"<&'n'&> hours"&, and &$warn_message_recipients$& contains a list
32612 of recipients for the warning message. There may be more than one if there are
32613 multiple addresses with different &%errors_to%& settings on the routers that
32614 handled them.
32615
32616
32617
32618
32619 . ////////////////////////////////////////////////////////////////////////////
32620 . ////////////////////////////////////////////////////////////////////////////
32621
32622 .chapter "Some common configuration settings" "CHAPcomconreq"
32623 This chapter discusses some configuration settings that seem to be fairly
32624 common. More examples and discussion can be found in the Exim book.
32625
32626
32627
32628 .section "Sending mail to a smart host" "SECID240"
32629 .cindex "smart host" "example router"
32630 If you want to send all mail for non-local domains to a &"smart host"&, you
32631 should replace the default &(dnslookup)& router with a router which does the
32632 routing explicitly:
32633 .code
32634 send_to_smart_host:
32635   driver = manualroute
32636   route_list = !+local_domains smart.host.name
32637   transport = remote_smtp
32638 .endd
32639 You can use the smart host's IP address instead of the name if you wish.
32640 If you are using Exim only to submit messages to a smart host, and not for
32641 receiving incoming messages, you can arrange for it to do the submission
32642 synchronously by setting the &%mua_wrapper%& option (see chapter
32643 &<<CHAPnonqueueing>>&).
32644
32645
32646
32647
32648 .section "Using Exim to handle mailing lists" "SECTmailinglists"
32649 .cindex "mailing lists"
32650 Exim can be used to run simple mailing lists, but for large and/or complicated
32651 requirements, the use of additional specialized mailing list software such as
32652 Majordomo or Mailman is recommended.
32653
32654 The &(redirect)& router can be used to handle mailing lists where each list
32655 is maintained in a separate file, which can therefore be managed by an
32656 independent manager. The &%domains%& router option can be used to run these
32657 lists in a separate domain from normal mail. For example:
32658 .code
32659 lists:
32660   driver = redirect
32661   domains = lists.example
32662   file = /usr/lists/$local_part
32663   forbid_pipe
32664   forbid_file
32665   errors_to = $local_part-request@lists.example
32666   no_more
32667 .endd
32668 This router is skipped for domains other than &'lists.example'&. For addresses
32669 in that domain, it looks for a file that matches the local part. If there is no
32670 such file, the router declines, but because &%no_more%& is set, no subsequent
32671 routers are tried, and so the whole delivery fails.
32672
32673 The &%forbid_pipe%& and &%forbid_file%& options prevent a local part from being
32674 expanded into a file name or a pipe delivery, which is usually inappropriate in
32675 a mailing list.
32676
32677 .oindex "&%errors_to%&"
32678 The &%errors_to%& option specifies that any delivery errors caused by addresses
32679 taken from a mailing list are to be sent to the given address rather than the
32680 original sender of the message. However, before acting on this, Exim verifies
32681 the error address, and ignores it if verification fails.
32682
32683 For example, using the configuration above, mail sent to
32684 &'dicts@lists.example'& is passed on to those addresses contained in
32685 &_/usr/lists/dicts_&, with error reports directed to
32686 &'dicts-request@lists.example'&, provided that this address can be verified.
32687 There could be a file called &_/usr/lists/dicts-request_& containing
32688 the address(es) of this particular list's manager(s), but other approaches,
32689 such as setting up an earlier router (possibly using the &%local_part_prefix%&
32690 or &%local_part_suffix%& options) to handle addresses of the form
32691 &%owner-%&&'xxx'& or &%xxx-%&&'request'&, are also possible.
32692
32693
32694
32695 .section "Syntax errors in mailing lists" "SECID241"
32696 .cindex "mailing lists" "syntax errors in"
32697 If an entry in redirection data contains a syntax error, Exim normally defers
32698 delivery of the original address. That means that a syntax error in a mailing
32699 list holds up all deliveries to the list. This may not be appropriate when a
32700 list is being maintained automatically from data supplied by users, and the
32701 addresses are not rigorously checked.
32702
32703 If the &%skip_syntax_errors%& option is set, the &(redirect)& router just skips
32704 entries that fail to parse, noting the incident in the log. If in addition
32705 &%syntax_errors_to%& is set to a verifiable address, a message is sent to it
32706 whenever a broken address is skipped. It is usually appropriate to set
32707 &%syntax_errors_to%& to the same address as &%errors_to%&.
32708
32709
32710
32711 .section "Re-expansion of mailing lists" "SECID242"
32712 .cindex "mailing lists" "re-expansion of"
32713 Exim remembers every individual address to which a message has been delivered,
32714 in order to avoid duplication, but it normally stores only the original
32715 recipient addresses with a message. If all the deliveries to a mailing list
32716 cannot be done at the first attempt, the mailing list is re-expanded when the
32717 delivery is next tried. This means that alterations to the list are taken into
32718 account at each delivery attempt, so addresses that have been added to
32719 the list since the message arrived will therefore receive a copy of the
32720 message, even though it pre-dates their subscription.
32721
32722 If this behaviour is felt to be undesirable, the &%one_time%& option can be set
32723 on the &(redirect)& router. If this is done, any addresses generated by the
32724 router that fail to deliver at the first attempt are added to the message as
32725 &"top level"& addresses, and the parent address that generated them is marked
32726 &"delivered"&. Thus, expansion of the mailing list does not happen again at the
32727 subsequent delivery attempts. The disadvantage of this is that if any of the
32728 failing addresses are incorrect, correcting them in the file has no effect on
32729 pre-existing messages.
32730
32731 The original top-level address is remembered with each of the generated
32732 addresses, and is output in any log messages. However, any intermediate parent
32733 addresses are not recorded. This makes a difference to the log only if the
32734 &%all_parents%& selector is set, but for mailing lists there is normally only
32735 one level of expansion anyway.
32736
32737
32738
32739 .section "Closed mailing lists" "SECID243"
32740 .cindex "mailing lists" "closed"
32741 The examples so far have assumed open mailing lists, to which anybody may
32742 send mail. It is also possible to set up closed lists, where mail is accepted
32743 from specified senders only. This is done by making use of the generic
32744 &%senders%& option to restrict the router that handles the list.
32745
32746 The following example uses the same file as a list of recipients and as a list
32747 of permitted senders. It requires three routers:
32748 .code
32749 lists_request:
32750   driver = redirect
32751   domains = lists.example
32752   local_part_suffix = -request
32753   file = /usr/lists/$local_part$local_part_suffix
32754   no_more
32755
32756 lists_post:
32757   driver = redirect
32758   domains = lists.example
32759   senders = ${if exists {/usr/lists/$local_part}\
32760              {lsearch;/usr/lists/$local_part}{*}}
32761   file = /usr/lists/$local_part
32762   forbid_pipe
32763   forbid_file
32764   errors_to = $local_part-request@lists.example
32765   no_more
32766
32767 lists_closed:
32768   driver = redirect
32769   domains = lists.example
32770   allow_fail
32771   data = :fail: $local_part@lists.example is a closed mailing list
32772 .endd
32773 All three routers have the same &%domains%& setting, so for any other domains,
32774 they are all skipped. The first router runs only if the local part ends in
32775 &%-request%&. It handles messages to the list manager(s) by means of an open
32776 mailing list.
32777
32778 The second router runs only if the &%senders%& precondition is satisfied. It
32779 checks for the existence of a list that corresponds to the local part, and then
32780 checks that the sender is on the list by means of a linear search. It is
32781 necessary to check for the existence of the file before trying to search it,
32782 because otherwise Exim thinks there is a configuration error. If the file does
32783 not exist, the expansion of &%senders%& is *, which matches all senders. This
32784 means that the router runs, but because there is no list, declines, and
32785 &%no_more%& ensures that no further routers are run. The address fails with an
32786 &"unrouteable address"& error.
32787
32788 The third router runs only if the second router is skipped, which happens when
32789 a mailing list exists, but the sender is not on it. This router forcibly fails
32790 the address, giving a suitable error message.
32791
32792
32793
32794
32795 .section "Variable Envelope Return Paths (VERP)" "SECTverp"
32796 .cindex "VERP"
32797 .cindex "Variable Envelope Return Paths"
32798 .cindex "envelope sender"
32799 Variable Envelope Return Paths &-- see &url(http://cr.yp.to/proto/verp.txt) &--
32800 are a way of helping mailing list administrators discover which subscription
32801 address is the cause of a particular delivery failure. The idea is to encode
32802 the original recipient address in the outgoing envelope sender address, so that
32803 if the message is forwarded by another host and then subsequently bounces, the
32804 original recipient can be extracted from the recipient address of the bounce.
32805
32806 .oindex &%errors_to%&
32807 .oindex &%return_path%&
32808 Envelope sender addresses can be modified by Exim using two different
32809 facilities: the &%errors_to%& option on a router (as shown in previous mailing
32810 list examples), or the &%return_path%& option on a transport. The second of
32811 these is effective only if the message is successfully delivered to another
32812 host; it is not used for errors detected on the local host (see the description
32813 of &%return_path%& in chapter &<<CHAPtransportgeneric>>&). Here is an example
32814 of the use of &%return_path%& to implement VERP on an &(smtp)& transport:
32815 .code
32816 verp_smtp:
32817   driver = smtp
32818   max_rcpt = 1
32819   return_path = \
32820     ${if match {$return_path}{^(.+?)-request@your.dom.example\$}\
32821       {$1-request+$local_part=$domain@your.dom.example}fail}
32822 .endd
32823 This has the effect of rewriting the return path (envelope sender) on outgoing
32824 SMTP messages, if the local part of the original return path ends in
32825 &"-request"&, and the domain is &'your.dom.example'&. The rewriting inserts the
32826 local part and domain of the recipient into the return path. Suppose, for
32827 example, that a message whose return path has been set to
32828 &'somelist-request@your.dom.example'& is sent to
32829 &'subscriber@other.dom.example'&. In the transport, the return path is
32830 rewritten as
32831 .code
32832 somelist-request+subscriber=other.dom.example@your.dom.example
32833 .endd
32834 .vindex "&$local_part$&"
32835 For this to work, you must tell Exim to send multiple copies of messages that
32836 have more than one recipient, so that each copy has just one recipient. This is
32837 achieved by setting &%max_rcpt%& to 1. Without this, a single copy of a message
32838 might be sent to several different recipients in the same domain, in which case
32839 &$local_part$& is not available in the transport, because it is not unique.
32840
32841 Unless your host is doing nothing but mailing list deliveries, you should
32842 probably use a separate transport for the VERP deliveries, so as not to use
32843 extra resources in making one-per-recipient copies for other deliveries. This
32844 can easily be done by expanding the &%transport%& option in the router:
32845 .code
32846 dnslookup:
32847   driver = dnslookup
32848   domains = ! +local_domains
32849   transport = \
32850     ${if match {$return_path}{^(.+?)-request@your.dom.example\$}\
32851       {verp_smtp}{remote_smtp}}
32852   no_more
32853 .endd
32854 If you want to change the return path using &%errors_to%& in a router instead
32855 of using &%return_path%& in the transport, you need to set &%errors_to%& on all
32856 routers that handle mailing list addresses. This will ensure that all delivery
32857 errors, including those detected on the local host, are sent to the VERP
32858 address.
32859
32860 On a host that does no local deliveries and has no manual routing, only the
32861 &(dnslookup)& router needs to be changed. A special transport is not needed for
32862 SMTP deliveries. Every mailing list recipient has its own return path value,
32863 and so Exim must hand them to the transport one at a time. Here is an example
32864 of a &(dnslookup)& router that implements VERP:
32865 .code
32866 verp_dnslookup:
32867   driver = dnslookup
32868   domains = ! +local_domains
32869   transport = remote_smtp
32870   errors_to = \
32871     ${if match {$return_path}{^(.+?)-request@your.dom.example\$}}
32872      {$1-request+$local_part=$domain@your.dom.example}fail}
32873   no_more
32874 .endd
32875 Before you start sending out messages with VERPed return paths, you must also
32876 configure Exim to accept the bounce messages that come back to those paths.
32877 Typically this is done by setting a &%local_part_suffix%& option for a
32878 router, and using this to route the messages to wherever you want to handle
32879 them.
32880
32881 The overhead incurred in using VERP depends very much on the size of the
32882 message, the number of recipient addresses that resolve to the same remote
32883 host, and the speed of the connection over which the message is being sent. If
32884 a lot of addresses resolve to the same host and the connection is slow, sending
32885 a separate copy of the message for each address may take substantially longer
32886 than sending a single copy with many recipients (for which VERP cannot be
32887 used).
32888
32889
32890
32891
32892
32893
32894 .section "Virtual domains" "SECTvirtualdomains"
32895 .cindex "virtual domains"
32896 .cindex "domain" "virtual"
32897 The phrase &'virtual domain'& is unfortunately used with two rather different
32898 meanings:
32899
32900 .ilist
32901 A domain for which there are no real mailboxes; all valid local parts are
32902 aliases for other email addresses. Common examples are organizational
32903 top-level domains and &"vanity"& domains.
32904 .next
32905 One of a number of independent domains that are all handled by the same host,
32906 with mailboxes on that host, but where the mailbox owners do not necessarily
32907 have login accounts on that host.
32908 .endlist
32909
32910 The first usage is probably more common, and does seem more &"virtual"& than
32911 the second. This kind of domain can be handled in Exim with a straightforward
32912 aliasing router. One approach is to create a separate alias file for each
32913 virtual domain. Exim can test for the existence of the alias file to determine
32914 whether the domain exists. The &(dsearch)& lookup type is useful here, leading
32915 to a router of this form:
32916 .code
32917 virtual:
32918   driver = redirect
32919   domains = dsearch;/etc/mail/virtual
32920   data = ${lookup{$local_part}lsearch{/etc/mail/virtual/$domain}}
32921   no_more
32922 .endd
32923 The &%domains%& option specifies that the router is to be skipped, unless there
32924 is a file in the &_/etc/mail/virtual_& directory whose name is the same as the
32925 domain that is being processed. When the router runs, it looks up the local
32926 part in the file to find a new address (or list of addresses). The &%no_more%&
32927 setting ensures that if the lookup fails (leading to &%data%& being an empty
32928 string), Exim gives up on the address without trying any subsequent routers.
32929
32930 This one router can handle all the virtual domains because the alias file names
32931 follow a fixed pattern. Permissions can be arranged so that appropriate people
32932 can edit the different alias files. A successful aliasing operation results in
32933 a new envelope recipient address, which is then routed from scratch.
32934
32935 The other kind of &"virtual"& domain can also be handled in a straightforward
32936 way. One approach is to create a file for each domain containing a list of
32937 valid local parts, and use it in a router like this:
32938 .code
32939 my_domains:
32940   driver = accept
32941   domains = dsearch;/etc/mail/domains
32942   local_parts = lsearch;/etc/mail/domains/$domain
32943   transport = my_mailboxes
32944 .endd
32945 The address is accepted if there is a file for the domain, and the local part
32946 can be found in the file. The &%domains%& option is used to check for the
32947 file's existence because &%domains%& is tested before the &%local_parts%&
32948 option (see section &<<SECTrouprecon>>&). You cannot use &%require_files%&,
32949 because that option is tested after &%local_parts%&. The transport is as
32950 follows:
32951 .code
32952 my_mailboxes:
32953   driver = appendfile
32954   file = /var/mail/$domain/$local_part
32955   user = mail
32956 .endd
32957 This uses a directory of mailboxes for each domain. The &%user%& setting is
32958 required, to specify which uid is to be used for writing to the mailboxes.
32959
32960 The configuration shown here is just one example of how you might support this
32961 requirement. There are many other ways this kind of configuration can be set
32962 up, for example, by using a database instead of separate files to hold all the
32963 information about the domains.
32964
32965
32966
32967 .section "Multiple user mailboxes" "SECTmulbox"
32968 .cindex "multiple mailboxes"
32969 .cindex "mailbox" "multiple"
32970 .cindex "local part" "prefix"
32971 .cindex "local part" "suffix"
32972 Heavy email users often want to operate with multiple mailboxes, into which
32973 incoming mail is automatically sorted. A popular way of handling this is to
32974 allow users to use multiple sender addresses, so that replies can easily be
32975 identified. Users are permitted to add prefixes or suffixes to their local
32976 parts for this purpose. The wildcard facility of the generic router options
32977 &%local_part_prefix%& and &%local_part_suffix%& can be used for this. For
32978 example, consider this router:
32979 .code
32980 userforward:
32981   driver = redirect
32982   check_local_user
32983   file = $home/.forward
32984   local_part_suffix = -*
32985   local_part_suffix_optional
32986   allow_filter
32987 .endd
32988 .vindex "&$local_part_suffix$&"
32989 It runs a user's &_.forward_& file for all local parts of the form
32990 &'username-*'&. Within the filter file the user can distinguish different
32991 cases by testing the variable &$local_part_suffix$&. For example:
32992 .code
32993 if $local_part_suffix contains -special then
32994 save /home/$local_part/Mail/special
32995 endif
32996 .endd
32997 If the filter file does not exist, or does not deal with such addresses, they
32998 fall through to subsequent routers, and, assuming no subsequent use of the
32999 &%local_part_suffix%& option is made, they presumably fail. Thus, users have
33000 control over which suffixes are valid.
33001
33002 Alternatively, a suffix can be used to trigger the use of a different
33003 &_.forward_& file &-- which is the way a similar facility is implemented in
33004 another MTA:
33005 .code
33006 userforward:
33007   driver = redirect
33008   check_local_user
33009   file = $home/.forward$local_part_suffix
33010   local_part_suffix = -*
33011   local_part_suffix_optional
33012   allow_filter
33013 .endd
33014 If there is no suffix, &_.forward_& is used; if the suffix is &'-special'&, for
33015 example, &_.forward-special_& is used. Once again, if the appropriate file
33016 does not exist, or does not deal with the address, it is passed on to
33017 subsequent routers, which could, if required, look for an unqualified
33018 &_.forward_& file to use as a default.
33019
33020
33021
33022 .section "Simplified vacation processing" "SECID244"
33023 .cindex "vacation processing"
33024 The traditional way of running the &'vacation'& program is for a user to set up
33025 a pipe command in a &_.forward_& file
33026 (see section &<<SECTspecitredli>>& for syntax details).
33027 This is prone to error by inexperienced users. There are two features of Exim
33028 that can be used to make this process simpler for users:
33029
33030 .ilist
33031 A local part prefix such as &"vacation-"& can be specified on a router which
33032 can cause the message to be delivered directly to the &'vacation'& program, or
33033 alternatively can use Exim's &(autoreply)& transport. The contents of a user's
33034 &_.forward_& file are then much simpler. For example:
33035 .code
33036 spqr, vacation-spqr
33037 .endd
33038 .next
33039 The &%require_files%& generic router option can be used to trigger a
33040 vacation delivery by checking for the existence of a certain file in the
33041 user's home directory. The &%unseen%& generic option should also be used, to
33042 ensure that the original delivery also proceeds. In this case, all the user has
33043 to do is to create a file called, say, &_.vacation_&, containing a vacation
33044 message.
33045 .endlist
33046
33047 Another advantage of both these methods is that they both work even when the
33048 use of arbitrary pipes by users is locked out.
33049
33050
33051
33052 .section "Taking copies of mail" "SECID245"
33053 .cindex "message" "copying every"
33054 Some installations have policies that require archive copies of all messages to
33055 be made. A single copy of each message can easily be taken by an appropriate
33056 command in a system filter, which could, for example, use a different file for
33057 each day's messages.
33058
33059 There is also a shadow transport mechanism that can be used to take copies of
33060 messages that are successfully delivered by local transports, one copy per
33061 delivery. This could be used, &'inter alia'&, to implement automatic
33062 notification of delivery by sites that insist on doing such things.
33063
33064
33065
33066 .section "Intermittently connected hosts" "SECID246"
33067 .cindex "intermittently connected hosts"
33068 It has become quite common (because it is cheaper) for hosts to connect to the
33069 Internet periodically rather than remain connected all the time. The normal
33070 arrangement is that mail for such hosts accumulates on a system that is
33071 permanently connected.
33072
33073 Exim was designed for use on permanently connected hosts, and so it is not
33074 particularly well-suited to use in an intermittently connected environment.
33075 Nevertheless there are some features that can be used.
33076
33077
33078 .section "Exim on the upstream server host" "SECID247"
33079 It is tempting to arrange for incoming mail for the intermittently connected
33080 host to remain on Exim's queue until the client connects. However, this
33081 approach does not scale very well. Two different kinds of waiting message are
33082 being mixed up in the same queue &-- those that cannot be delivered because of
33083 some temporary problem, and those that are waiting for their destination host
33084 to connect. This makes it hard to manage the queue, as well as wasting
33085 resources, because each queue runner scans the entire queue.
33086
33087 A better approach is to separate off those messages that are waiting for an
33088 intermittently connected host. This can be done by delivering these messages
33089 into local files in batch SMTP, &"mailstore"&, or other envelope-preserving
33090 format, from where they are transmitted by other software when their
33091 destination connects. This makes it easy to collect all the mail for one host
33092 in a single directory, and to apply local timeout rules on a per-message basis
33093 if required.
33094
33095 On a very small scale, leaving the mail on Exim's queue can be made to work. If
33096 you are doing this, you should configure Exim with a long retry period for the
33097 intermittent host. For example:
33098 .code
33099 cheshire.wonderland.fict.example    *   F,5d,24h
33100 .endd
33101 This stops a lot of failed delivery attempts from occurring, but Exim remembers
33102 which messages it has queued up for that host. Once the intermittent host comes
33103 online, forcing delivery of one message (either by using the &%-M%& or &%-R%&
33104 options, or by using the ETRN SMTP command (see section &<<SECTETRN>>&)
33105 causes all the queued up messages to be delivered, often down a single SMTP
33106 connection. While the host remains connected, any new messages get delivered
33107 immediately.
33108
33109 If the connecting hosts do not have fixed IP addresses, that is, if a host is
33110 issued with a different IP address each time it connects, Exim's retry
33111 mechanisms on the holding host get confused, because the IP address is normally
33112 used as part of the key string for holding retry information. This can be
33113 avoided by unsetting &%retry_include_ip_address%& on the &(smtp)& transport.
33114 Since this has disadvantages for permanently connected hosts, it is best to
33115 arrange a separate transport for the intermittently connected ones.
33116
33117
33118
33119 .section "Exim on the intermittently connected client host" "SECID248"
33120 The value of &%smtp_accept_queue_per_connection%& should probably be
33121 increased, or even set to zero (that is, disabled) on the intermittently
33122 connected host, so that all incoming messages down a single connection get
33123 delivered immediately.
33124
33125 .cindex "SMTP" "passed connection"
33126 .cindex "SMTP" "multiple deliveries"
33127 .cindex "multiple SMTP deliveries"
33128 Mail waiting to be sent from an intermittently connected host will probably
33129 not have been routed, because without a connection DNS lookups are not
33130 possible. This means that if a normal queue run is done at connection time,
33131 each message is likely to be sent in a separate SMTP session. This can be
33132 avoided by starting the queue run with a command line option beginning with
33133 &%-qq%& instead of &%-q%&. In this case, the queue is scanned twice. In the
33134 first pass, routing is done but no deliveries take place. The second pass is a
33135 normal queue run; since all the messages have been previously routed, those
33136 destined for the same host are likely to get sent as multiple deliveries in a
33137 single SMTP connection.
33138
33139
33140
33141 . ////////////////////////////////////////////////////////////////////////////
33142 . ////////////////////////////////////////////////////////////////////////////
33143
33144 .chapter "Using Exim as a non-queueing client" "CHAPnonqueueing" &&&
33145          "Exim as a non-queueing client"
33146 .cindex "client, non-queueing"
33147 .cindex "smart host" "suppressing queueing"
33148 On a personal computer, it is a common requirement for all
33149 email to be sent to a &"smart host"&. There are plenty of MUAs that can be
33150 configured to operate that way, for all the popular operating systems.
33151 However, there are some MUAs for Unix-like systems that cannot be so
33152 configured: they submit messages using the command line interface of
33153 &_/usr/sbin/sendmail_&. Furthermore, utility programs such as &'cron'& submit
33154 messages this way.
33155
33156 If the personal computer runs continuously, there is no problem, because it can
33157 run a conventional MTA that handles delivery to the smart host, and deal with
33158 any delays via its queueing mechanism. However, if the computer does not run
33159 continuously or runs different operating systems at different times, queueing
33160 email is not desirable.
33161
33162 There is therefore a requirement for something that can provide the
33163 &_/usr/sbin/sendmail_& interface but deliver messages to a smart host without
33164 any queueing or retrying facilities. Furthermore, the delivery to the smart
33165 host should be synchronous, so that if it fails, the sending MUA is immediately
33166 informed. In other words, we want something that extends an MUA that submits
33167 to a local MTA via the command line so that it behaves like one that submits
33168 to a remote smart host using TCP/SMTP.
33169
33170 There are a number of applications (for example, there is one called &'ssmtp'&)
33171 that do this job. However, people have found them to be lacking in various
33172 ways. For instance, you might want to allow aliasing and forwarding to be done
33173 before sending a message to the smart host.
33174
33175 Exim already had the necessary infrastructure for doing this job. Just a few
33176 tweaks were needed to make it behave as required, though it is somewhat of an
33177 overkill to use a fully-featured MTA for this purpose.
33178
33179 .oindex "&%mua_wrapper%&"
33180 There is a Boolean global option called &%mua_wrapper%&, defaulting false.
33181 Setting &%mua_wrapper%& true causes Exim to run in a special mode where it
33182 assumes that it is being used to &"wrap"& a command-line MUA in the manner
33183 just described. As well as setting &%mua_wrapper%&, you also need to provide a
33184 compatible router and transport configuration. Typically there will be just one
33185 router and one transport, sending everything to a smart host.
33186
33187 When run in MUA wrapping mode, the behaviour of Exim changes in the
33188 following ways:
33189
33190 .ilist
33191 A daemon cannot be run, nor will Exim accept incoming messages from &'inetd'&.
33192 In other words, the only way to submit messages is via the command line.
33193 .next
33194 Each message is synchronously delivered as soon as it is received (&%-odi%& is
33195 assumed). All queueing options (&%queue_only%&, &%queue_smtp_domains%&,
33196 &%control%& in an ACL, etc.) are quietly ignored. The Exim reception process
33197 does not finish until the delivery attempt is complete. If the delivery is
33198 successful, a zero return code is given.
33199 .next
33200 Address redirection is permitted, but the final routing for all addresses must
33201 be to the same remote transport, and to the same list of hosts. Furthermore,
33202 the return address (envelope sender) must be the same for all recipients, as
33203 must any added or deleted header lines. In other words, it must be possible to
33204 deliver the message in a single SMTP transaction, however many recipients there
33205 are.
33206 .next
33207 If these conditions are not met, or if routing any address results in a
33208 failure or defer status, or if Exim is unable to deliver all the recipients
33209 successfully to one of the smart hosts, delivery of the entire message fails.
33210 .next
33211 Because no queueing is allowed, all failures are treated as permanent; there
33212 is no distinction between 4&'xx'& and 5&'xx'& SMTP response codes from the
33213 smart host. Furthermore, because only a single yes/no response can be given to
33214 the caller, it is not possible to deliver to some recipients and not others. If
33215 there is an error (temporary or permanent) for any recipient, all are failed.
33216 .next
33217 If more than one smart host is listed, Exim will try another host after a
33218 connection failure or a timeout, in the normal way. However, if this kind of
33219 failure happens for all the hosts, the delivery fails.
33220 .next
33221 When delivery fails, an error message is written to the standard error stream
33222 (as well as to Exim's log), and Exim exits to the caller with a return code
33223 value 1. The message is expunged from Exim's spool files. No bounce messages
33224 are ever generated.
33225 .next
33226 No retry data is maintained, and any retry rules are ignored.
33227 .next
33228 A number of Exim options are overridden: &%deliver_drop_privilege%& is forced
33229 true, &%max_rcpt%& in the &(smtp)& transport is forced to &"unlimited"&,
33230 &%remote_max_parallel%& is forced to one, and fallback hosts are ignored.
33231 .endlist
33232
33233 The overall effect is that Exim makes a single synchronous attempt to deliver
33234 the message, failing if there is any kind of problem. Because no local
33235 deliveries are done and no daemon can be run, Exim does not need root
33236 privilege. It should be possible to run it setuid to &'exim'& instead of setuid
33237 to &'root'&. See section &<<SECTrunexiwitpri>>& for a general discussion about
33238 the advantages and disadvantages of running without root privilege.
33239
33240
33241
33242
33243 . ////////////////////////////////////////////////////////////////////////////
33244 . ////////////////////////////////////////////////////////////////////////////
33245
33246 .chapter "Log files" "CHAPlog"
33247 .scindex IIDloggen "log" "general description"
33248 .cindex "log" "types of"
33249 Exim writes three different logs, referred to as the main log, the reject log,
33250 and the panic log:
33251
33252 .ilist
33253 .cindex "main log"
33254 The main log records the arrival of each message and each delivery in a single
33255 line in each case. The format is as compact as possible, in an attempt to keep
33256 down the size of log files. Two-character flag sequences make it easy to pick
33257 out these lines. A number of other events are recorded in the main log. Some of
33258 them are optional, in which case the &%log_selector%& option controls whether
33259 they are included or not. A Perl script called &'eximstats'&, which does simple
33260 analysis of main log files, is provided in the Exim distribution (see section
33261 &<<SECTmailstat>>&).
33262 .next
33263 .cindex "reject log"
33264 The reject log records information from messages that are rejected as a result
33265 of a configuration option (that is, for policy reasons).
33266 The first line of each rejection is a copy of the line that is also written to
33267 the main log. Then, if the message's header has been read at the time the log
33268 is written, its contents are written to this log. Only the original header
33269 lines are available; header lines added by ACLs are not logged. You can use the
33270 reject log to check that your policy controls are working correctly; on a busy
33271 host this may be easier than scanning the main log for rejection messages. You
33272 can suppress the writing of the reject log by setting &%write_rejectlog%&
33273 false.
33274 .next
33275 .cindex "panic log"
33276 .cindex "system log"
33277 When certain serious errors occur, Exim writes entries to its panic log. If the
33278 error is sufficiently disastrous, Exim bombs out afterwards. Panic log entries
33279 are usually written to the main log as well, but can get lost amid the mass of
33280 other entries. The panic log should be empty under normal circumstances. It is
33281 therefore a good idea to check it (or to have a &'cron'& script check it)
33282 regularly, in order to become aware of any problems. When Exim cannot open its
33283 panic log, it tries as a last resort to write to the system log (syslog). This
33284 is opened with LOG_PID+LOG_CONS and the facility code of LOG_MAIL. The
33285 message itself is written at priority LOG_CRIT.
33286 .endlist
33287
33288 Every log line starts with a timestamp, in the format shown in the following
33289 example. Note that many of the examples shown in this chapter are line-wrapped.
33290 In the log file, this would be all on one line:
33291 .code
33292 2001-09-16 16:09:47 SMTP connection from [127.0.0.1] closed
33293   by QUIT
33294 .endd
33295 By default, the timestamps are in the local timezone. There are two
33296 ways of changing this:
33297
33298 .ilist
33299 You can set the &%timezone%& option to a different time zone; in particular, if
33300 you set
33301 .code
33302 timezone = UTC
33303 .endd
33304 the timestamps will be in UTC (aka GMT).
33305 .next
33306 If you set &%log_timezone%& true, the time zone is added to the timestamp, for
33307 example:
33308 .code
33309 2003-04-25 11:17:07 +0100 Start queue run: pid=12762
33310 .endd
33311 .endlist
33312
33313 .cindex "log" "process ids in"
33314 .cindex "pid (process id)" "in log lines"
33315 Exim does not include its process id in log lines by default, but you can
33316 request that it does so by specifying the &`pid`& log selector (see section
33317 &<<SECTlogselector>>&). When this is set, the process id is output, in square
33318 brackets, immediately after the time and date.
33319
33320
33321
33322
33323 .section "Where the logs are written" "SECTwhelogwri"
33324 .cindex "log" "destination"
33325 .cindex "log" "to file"
33326 .cindex "log" "to syslog"
33327 .cindex "syslog"
33328 The logs may be written to local files, or to syslog, or both. However, it
33329 should be noted that many syslog implementations use UDP as a transport, and
33330 are therefore unreliable in the sense that messages are not guaranteed to
33331 arrive at the loghost, nor is the ordering of messages necessarily maintained.
33332 It has also been reported that on large log files (tens of megabytes) you may
33333 need to tweak syslog to prevent it syncing the file with each write &-- on
33334 Linux this has been seen to make syslog take 90% plus of CPU time.
33335
33336 The destination for Exim's logs is configured by setting LOG_FILE_PATH in
33337 &_Local/Makefile_& or by setting &%log_file_path%& in the run time
33338 configuration. This latter string is expanded, so it can contain, for example,
33339 references to the host name:
33340 .code
33341 log_file_path = /var/log/$primary_hostname/exim_%slog
33342 .endd
33343 It is generally advisable, however, to set the string in &_Local/Makefile_&
33344 rather than at run time, because then the setting is available right from the
33345 start of Exim's execution. Otherwise, if there's something it wants to log
33346 before it has read the configuration file (for example, an error in the
33347 configuration file) it will not use the path you want, and may not be able to
33348 log at all.
33349
33350 The value of LOG_FILE_PATH or &%log_file_path%& is a colon-separated
33351 list, currently limited to at most two items. This is one option where the
33352 facility for changing a list separator may not be used. The list must always be
33353 colon-separated. If an item in the list is &"syslog"& then syslog is used;
33354 otherwise the item must either be an absolute path, containing &`%s`& at the
33355 point where &"main"&, &"reject"&, or &"panic"& is to be inserted, or be empty,
33356 implying the use of a default path.
33357
33358 When Exim encounters an empty item in the list, it searches the list defined by
33359 LOG_FILE_PATH, and uses the first item it finds that is neither empty nor
33360 &"syslog"&. This means that an empty item in &%log_file_path%& can be used to
33361 mean &"use the path specified at build time"&. It no such item exists, log
33362 files are written in the &_log_& subdirectory of the spool directory. This is
33363 equivalent to the setting:
33364 .code
33365 log_file_path = $spool_directory/log/%slog
33366 .endd
33367 If you do not specify anything at build time or run time, that is where the
33368 logs are written.
33369
33370 A log file path may also contain &`%D`& or &`%M`& if datestamped log file names
33371 are in use &-- see section &<<SECTdatlogfil>>& below.
33372
33373 Here are some examples of possible settings:
33374 .display
33375 &`LOG_FILE_PATH=syslog                    `& syslog only
33376 &`LOG_FILE_PATH=:syslog                   `& syslog and default path
33377 &`LOG_FILE_PATH=syslog : /usr/log/exim_%s `& syslog and specified path
33378 &`LOG_FILE_PATH=/usr/log/exim_%s          `& specified path only
33379 .endd
33380 If there are more than two paths in the list, the first is used and a panic
33381 error is logged.
33382
33383
33384
33385 .section "Logging to local files that are periodically &""cycled""&" "SECID285"
33386 .cindex "log" "cycling local files"
33387 .cindex "cycling logs"
33388 .cindex "&'exicyclog'&"
33389 .cindex "log" "local files; writing to"
33390 Some operating systems provide centralized and standardized methods for cycling
33391 log files. For those that do not, a utility script called &'exicyclog'& is
33392 provided (see section &<<SECTcyclogfil>>&). This renames and compresses the
33393 main and reject logs each time it is called. The maximum number of old logs to
33394 keep can be set. It is suggested this script is run as a daily &'cron'& job.
33395
33396 An Exim delivery process opens the main log when it first needs to write to it,
33397 and it keeps the file open in case subsequent entries are required &-- for
33398 example, if a number of different deliveries are being done for the same
33399 message. However, remote SMTP deliveries can take a long time, and this means
33400 that the file may be kept open long after it is renamed if &'exicyclog'& or
33401 something similar is being used to rename log files on a regular basis. To
33402 ensure that a switch of log files is noticed as soon as possible, Exim calls
33403 &[stat()]& on the main log's name before reusing an open file, and if the file
33404 does not exist, or its inode has changed, the old file is closed and Exim
33405 tries to open the main log from scratch. Thus, an old log file may remain open
33406 for quite some time, but no Exim processes should write to it once it has been
33407 renamed.
33408
33409
33410
33411 .section "Datestamped log files" "SECTdatlogfil"
33412 .cindex "log" "datestamped files"
33413 Instead of cycling the main and reject log files by renaming them
33414 periodically, some sites like to use files whose names contain a datestamp,
33415 for example, &_mainlog-20031225_&. The datestamp is in the form &_yyyymmdd_& or
33416 &_yyyymm_&. Exim has support for this way of working. It is enabled by setting
33417 the &%log_file_path%& option to a path that includes &`%D`& or &`%M`& at the
33418 point where the datestamp is required. For example:
33419 .code
33420 log_file_path = /var/spool/exim/log/%slog-%D
33421 log_file_path = /var/log/exim-%s-%D.log
33422 log_file_path = /var/spool/exim/log/%D-%slog
33423 log_file_path = /var/log/exim/%s.%M
33424 .endd
33425 As before, &`%s`& is replaced by &"main"& or &"reject"&; the following are
33426 examples of names generated by the above examples:
33427 .code
33428 /var/spool/exim/log/mainlog-20021225
33429 /var/log/exim-reject-20021225.log
33430 /var/spool/exim/log/20021225-mainlog
33431 /var/log/exim/main.200212
33432 .endd
33433 When this form of log file is specified, Exim automatically switches to new
33434 files at midnight. It does not make any attempt to compress old logs; you
33435 will need to write your own script if you require this. You should not
33436 run &'exicyclog'& with this form of logging.
33437
33438 The location of the panic log is also determined by &%log_file_path%&, but it
33439 is not datestamped, because rotation of the panic log does not make sense.
33440 When generating the name of the panic log, &`%D`& or &`%M`& are removed from
33441 the string. In addition, if it immediately follows a slash, a following
33442 non-alphanumeric character is removed; otherwise a preceding non-alphanumeric
33443 character is removed. Thus, the four examples above would give these panic
33444 log names:
33445 .code
33446 /var/spool/exim/log/paniclog
33447 /var/log/exim-panic.log
33448 /var/spool/exim/log/paniclog
33449 /var/log/exim/panic
33450 .endd
33451
33452
33453 .section "Logging to syslog" "SECID249"
33454 .cindex "log" "syslog; writing to"
33455 The use of syslog does not change what Exim logs or the format of its messages,
33456 except in one respect. If &%syslog_timestamp%& is set false, the timestamps on
33457 Exim's log lines are omitted when these lines are sent to syslog. Apart from
33458 that, the same strings are written to syslog as to log files. The syslog
33459 &"facility"& is set to LOG_MAIL, and the program name to &"exim"&
33460 by default, but you can change these by setting the &%syslog_facility%& and
33461 &%syslog_processname%& options, respectively. If Exim was compiled with
33462 SYSLOG_LOG_PID set in &_Local/Makefile_& (this is the default in
33463 &_src/EDITME_&), then, on systems that permit it (all except ULTRIX), the
33464 LOG_PID flag is set so that the &[syslog()]& call adds the pid as well as
33465 the time and host name to each line.
33466 The three log streams are mapped onto syslog priorities as follows:
33467
33468 .ilist
33469 &'mainlog'& is mapped to LOG_INFO
33470 .next
33471 &'rejectlog'& is mapped to LOG_NOTICE
33472 .next
33473 &'paniclog'& is mapped to LOG_ALERT
33474 .endlist
33475
33476 Many log lines are written to both &'mainlog'& and &'rejectlog'&, and some are
33477 written to both &'mainlog'& and &'paniclog'&, so there will be duplicates if
33478 these are routed by syslog to the same place. You can suppress this duplication
33479 by setting &%syslog_duplication%& false.
33480
33481 Exim's log lines can sometimes be very long, and some of its &'rejectlog'&
33482 entries contain multiple lines when headers are included. To cope with both
33483 these cases, entries written to syslog are split into separate &[syslog()]&
33484 calls at each internal newline, and also after a maximum of
33485 870 data characters. (This allows for a total syslog line length of 1024, when
33486 additions such as timestamps are added.) If you are running a syslog
33487 replacement that can handle lines longer than the 1024 characters allowed by
33488 RFC 3164, you should set
33489 .code
33490 SYSLOG_LONG_LINES=yes
33491 .endd
33492 in &_Local/Makefile_& before building Exim. That stops Exim from splitting long
33493 lines, but it still splits at internal newlines in &'reject'& log entries.
33494
33495 To make it easy to re-assemble split lines later, each component of a split
33496 entry starts with a string of the form [<&'n'&>/<&'m'&>] or [<&'n'&>\<&'m'&>]
33497 where <&'n'&> is the component number and <&'m'&> is the total number of
33498 components in the entry. The / delimiter is used when the line was split
33499 because it was too long; if it was split because of an internal newline, the \
33500 delimiter is used. For example, supposing the length limit to be 50 instead of
33501 870, the following would be the result of a typical rejection message to
33502 &'mainlog'& (LOG_INFO), each line in addition being preceded by the time, host
33503 name, and pid as added by syslog:
33504 .code
33505 [1/5] 2002-09-16 16:09:43 16RdAL-0006pc-00 rejected from
33506 [2/5]  [127.0.0.1] (ph10): syntax error in 'From' header
33507 [3/5]  when scanning for sender: missing or malformed lo
33508 [4/5] cal part in "<>" (envelope sender is <ph10@cam.exa
33509 [5/5] mple>)
33510 .endd
33511 The same error might cause the following lines to be written to &"rejectlog"&
33512 (LOG_NOTICE):
33513 .code
33514 [1/18] 2002-09-16 16:09:43 16RdAL-0006pc-00 rejected fro
33515 [2/18] m [127.0.0.1] (ph10): syntax error in 'From' head
33516 [3/18] er when scanning for sender: missing or malformed
33517 [4/18]  local part in "<>" (envelope sender is <ph10@cam
33518 [5\18] .example>)
33519 [6\18] Recipients: ph10@some.domain.cam.example
33520 [7\18] P Received: from [127.0.0.1] (ident=ph10)
33521 [8\18]        by xxxxx.cam.example with smtp (Exim 4.00)
33522 [9\18]        id 16RdAL-0006pc-00
33523 [10/18]        for ph10@cam.example; Mon, 16 Sep 2002 16:
33524 [11\18] 09:43 +0100
33525 [12\18] F From: <>
33526 [13\18]   Subject: this is a test header
33527 [18\18]   X-something: this is another header
33528 [15/18] I Message-Id: <E16RdAL-0006pc-00@xxxxx.cam.examp
33529 [16\18] le>
33530 [17\18] B Bcc:
33531 [18/18]   Date: Mon, 16 Sep 2002 16:09:43 +0100
33532 .endd
33533 Log lines that are neither too long nor contain newlines are written to syslog
33534 without modification.
33535
33536 If only syslog is being used, the Exim monitor is unable to provide a log tail
33537 display, unless syslog is routing &'mainlog'& to a file on the local host and
33538 the environment variable EXIMON_LOG_FILE_PATH is set to tell the monitor
33539 where it is.
33540
33541
33542
33543 .section "Log line flags" "SECID250"
33544 One line is written to the main log for each message received, and for each
33545 successful, unsuccessful, and delayed delivery. These lines can readily be
33546 picked out by the distinctive two-character flags that immediately follow the
33547 timestamp. The flags are:
33548 .display
33549 &`<=`&     message arrival
33550 &`=>`&     normal message delivery
33551 &`->`&     additional address in same delivery
33552 &`>>`&     cutthrough message delivery
33553 &`*>`&     delivery suppressed by &%-N%&
33554 &`**`&     delivery failed; address bounced
33555 &`==`&     delivery deferred; temporary problem
33556 .endd
33557
33558
33559 .section "Logging message reception" "SECID251"
33560 .cindex "log" "reception line"
33561 The format of the single-line entry in the main log that is written for every
33562 message received is shown in the basic example below, which is split over
33563 several lines in order to fit it on the page:
33564 .code
33565 2002-10-31 08:57:53 16ZCW1-0005MB-00 <= kryten@dwarf.fict.example
33566   H=mailer.fict.example [192.168.123.123] U=exim
33567   P=smtp S=5678 id=<incoming message id>
33568 .endd
33569 The address immediately following &"<="& is the envelope sender address. A
33570 bounce message is shown with the sender address &"<>"&, and if it is locally
33571 generated, this is followed by an item of the form
33572 .code
33573 R=<message id>
33574 .endd
33575 which is a reference to the message that caused the bounce to be sent.
33576
33577 .cindex "HELO"
33578 .cindex "EHLO"
33579 For messages from other hosts, the H and U fields identify the remote host and
33580 record the RFC 1413 identity of the user that sent the message, if one was
33581 received. The number given in square brackets is the IP address of the sending
33582 host. If there is a single, unparenthesized  host name in the H field, as
33583 above, it has been verified to correspond to the IP address (see the
33584 &%host_lookup%& option). If the name is in parentheses, it was the name quoted
33585 by the remote host in the SMTP HELO or EHLO command, and has not been
33586 verified. If verification yields a different name to that given for HELO or
33587 EHLO, the verified name appears first, followed by the HELO or EHLO
33588 name in parentheses.
33589
33590 Misconfigured hosts (and mail forgers) sometimes put an IP address, with or
33591 without brackets, in the HELO or EHLO command, leading to entries in
33592 the log containing text like these examples:
33593 .code
33594 H=(10.21.32.43) [192.168.8.34]
33595 H=([10.21.32.43]) [192.168.8.34]
33596 .endd
33597 This can be confusing. Only the final address in square brackets can be relied
33598 on.
33599
33600 For locally generated messages (that is, messages not received over TCP/IP),
33601 the H field is omitted, and the U field contains the login name of the caller
33602 of Exim.
33603
33604 .cindex "authentication" "logging"
33605 .cindex "AUTH" "logging"
33606 For all messages, the P field specifies the protocol used to receive the
33607 message. This is the value that is stored in &$received_protocol$&. In the case
33608 of incoming SMTP messages, the value indicates whether or not any SMTP
33609 extensions (ESMTP), encryption, or authentication were used. If the SMTP
33610 session was encrypted, there is an additional X field that records the cipher
33611 suite that was used.
33612
33613 The protocol is set to &"esmtpsa"& or &"esmtpa"& for messages received from
33614 hosts that have authenticated themselves using the SMTP AUTH command. The first
33615 value is used when the SMTP connection was encrypted (&"secure"&). In this case
33616 there is an additional item A= followed by the name of the authenticator that
33617 was used. If an authenticated identification was set up by the authenticator's
33618 &%server_set_id%& option, this is logged too, separated by a colon from the
33619 authenticator name.
33620
33621 .cindex "size" "of message"
33622 The id field records the existing message id, if present. The size of the
33623 received message is given by the S field. When the message is delivered,
33624 headers may be removed or added, so that the size of delivered copies of the
33625 message may not correspond with this value (and indeed may be different to each
33626 other).
33627
33628 The &%log_selector%& option can be used to request the logging of additional
33629 data when a message is received. See section &<<SECTlogselector>>& below.
33630
33631
33632
33633 .section "Logging deliveries" "SECID252"
33634 .cindex "log" "delivery line"
33635 The format of the single-line entry in the main log that is written for every
33636 delivery is shown in one of the examples below, for local and remote
33637 deliveries, respectively. Each example has been split into two lines in order
33638 to fit it on the page:
33639 .code
33640 2002-10-31 08:59:13 16ZCW1-0005MB-00 => marv
33641   <marv@hitch.fict.example> R=localuser T=local_delivery
33642 2002-10-31 09:00:10 16ZCW1-0005MB-00 =>
33643   monk@holistic.fict.example R=dnslookup T=remote_smtp
33644   H=holistic.fict.example [192.168.234.234]
33645 .endd
33646 For ordinary local deliveries, the original address is given in angle brackets
33647 after the final delivery address, which might be a pipe or a file. If
33648 intermediate address(es) exist between the original and the final address, the
33649 last of these is given in parentheses after the final address. The R and T
33650 fields record the router and transport that were used to process the address.
33651
33652 If SMTP AUTH was used for the delivery there is an additional item A=
33653 followed by the name of the authenticator that was used.
33654 If an authenticated identification was set up by the authenticator's &%client_set_id%&
33655 option, this is logged too, separated by a colon from the authenticator name.
33656
33657 If a shadow transport was run after a successful local delivery, the log line
33658 for the successful delivery has an item added on the end, of the form
33659 .display
33660 &`ST=<`&&'shadow transport name'&&`>`&
33661 .endd
33662 If the shadow transport did not succeed, the error message is put in
33663 parentheses afterwards.
33664
33665 .cindex "asterisk" "after IP address"
33666 When more than one address is included in a single delivery (for example, two
33667 SMTP RCPT commands in one transaction) the second and subsequent addresses are
33668 flagged with &`->`& instead of &`=>`&. When two or more messages are delivered
33669 down a single SMTP connection, an asterisk follows the IP address in the log
33670 lines for the second and subsequent messages.
33671
33672 .cindex "delivery" "cutthrough; logging"
33673 .cindex "cutthrough" "logging"
33674 When delivery is done in cutthrough mode it is flagged with &`>>`& and the log
33675 line precedes the reception line, since cutthrough waits for a possible
33676 rejection from the destination in case it can reject the sourced item.
33677
33678 The generation of a reply message by a filter file gets logged as a
33679 &"delivery"& to the addressee, preceded by &">"&.
33680
33681 The &%log_selector%& option can be used to request the logging of additional
33682 data when a message is delivered. See section &<<SECTlogselector>>& below.
33683
33684
33685 .section "Discarded deliveries" "SECID253"
33686 .cindex "discarded messages"
33687 .cindex "message" "discarded"
33688 .cindex "delivery" "discarded; logging"
33689 When a message is discarded as a result of the command &"seen finish"& being
33690 obeyed in a filter file which generates no deliveries, a log entry of the form
33691 .code
33692 2002-12-10 00:50:49 16auJc-0001UB-00 => discarded
33693   <low.club@bridge.example> R=userforward
33694 .endd
33695 is written, to record why no deliveries are logged. When a message is discarded
33696 because it is aliased to &":blackhole:"& the log line is like this:
33697 .code
33698 1999-03-02 09:44:33 10HmaX-0005vi-00 => :blackhole:
33699   <hole@nowhere.example> R=blackhole_router
33700 .endd
33701
33702
33703 .section "Deferred deliveries" "SECID254"
33704 When a delivery is deferred, a line of the following form is logged:
33705 .code
33706 2002-12-19 16:20:23 16aiQz-0002Q5-00 == marvin@endrest.example
33707   R=dnslookup T=smtp defer (146): Connection refused
33708 .endd
33709 In the case of remote deliveries, the error is the one that was given for the
33710 last IP address that was tried. Details of individual SMTP failures are also
33711 written to the log, so the above line would be preceded by something like
33712 .code
33713 2002-12-19 16:20:23 16aiQz-0002Q5-00 Failed to connect to
33714   mail1.endrest.example [192.168.239.239]: Connection refused
33715 .endd
33716 When a deferred address is skipped because its retry time has not been reached,
33717 a message is written to the log, but this can be suppressed by setting an
33718 appropriate value in &%log_selector%&.
33719
33720
33721
33722 .section "Delivery failures" "SECID255"
33723 .cindex "delivery" "failure; logging"
33724 If a delivery fails because an address cannot be routed, a line of the
33725 following form is logged:
33726 .code
33727 1995-12-19 16:20:23 0tRiQz-0002Q5-00 ** jim@trek99.example
33728   <jim@trek99.example>: unknown mail domain
33729 .endd
33730 If a delivery fails at transport time, the router and transport are shown, and
33731 the response from the remote host is included, as in this example:
33732 .code
33733 2002-07-11 07:14:17 17SXDU-000189-00 ** ace400@pb.example
33734   R=dnslookup T=remote_smtp: SMTP error from remote mailer
33735   after pipelined RCPT TO:<ace400@pb.example>: host
33736   pbmail3.py.example [192.168.63.111]: 553 5.3.0
33737   <ace400@pb.example>...Addressee unknown
33738 .endd
33739 The word &"pipelined"& indicates that the SMTP PIPELINING extension was being
33740 used. See &%hosts_avoid_esmtp%& in the &(smtp)& transport for a way of
33741 disabling PIPELINING. The log lines for all forms of delivery failure are
33742 flagged with &`**`&.
33743
33744
33745
33746 .section "Fake deliveries" "SECID256"
33747 .cindex "delivery" "fake; logging"
33748 If a delivery does not actually take place because the &%-N%& option has been
33749 used to suppress it, a normal delivery line is written to the log, except that
33750 &"=>"& is replaced by &"*>"&.
33751
33752
33753
33754 .section "Completion" "SECID257"
33755 A line of the form
33756 .code
33757 2002-10-31 09:00:11 16ZCW1-0005MB-00 Completed
33758 .endd
33759 is written to the main log when a message is about to be removed from the spool
33760 at the end of its processing.
33761
33762
33763
33764
33765 .section "Summary of Fields in Log Lines" "SECID258"
33766 .cindex "log" "summary of fields"
33767 A summary of the field identifiers that are used in log lines is shown in
33768 the following table:
33769 .display
33770 &`A   `&        authenticator name (and optional id and sender)
33771 &`C   `&        SMTP confirmation on delivery
33772 &`    `&        command list for &"no mail in SMTP session"&
33773 &`CV  `&        certificate verification status
33774 &`D   `&        duration of &"no mail in SMTP session"&
33775 &`DN  `&        distinguished name from peer certificate
33776 &`DT  `&        on &`=>`& lines: time taken for a delivery
33777 &`F   `&        sender address (on delivery lines)
33778 &`H   `&        host name and IP address
33779 &`I   `&        local interface used
33780 &`id  `&        message id for incoming message
33781 &`P   `&        on &`<=`& lines: protocol used
33782 &`    `&        on &`=>`& and &`**`& lines: return path
33783 &`QT  `&        on &`=>`& lines: time spent on queue so far
33784 &`    `&        on &"Completed"& lines: time spent on queue
33785 &`R   `&        on &`<=`& lines: reference for local bounce
33786 &`    `&        on &`=>`&  &`**`& and &`==`& lines: router name
33787 &`S   `&        size of message
33788 &`ST  `&        shadow transport name
33789 &`T   `&        on &`<=`& lines: message subject (topic)
33790 &`    `&        on &`=>`& &`**`& and &`==`& lines: transport name
33791 &`U   `&        local user or RFC 1413 identity
33792 &`X   `&        TLS cipher suite
33793 .endd
33794
33795
33796 .section "Other log entries" "SECID259"
33797 Various other types of log entry are written from time to time. Most should be
33798 self-explanatory. Among the more common are:
33799
33800 .ilist
33801 .cindex "retry" "time not reached"
33802 &'retry time not reached'&&~&~An address previously suffered a temporary error
33803 during routing or local delivery, and the time to retry has not yet arrived.
33804 This message is not written to an individual message log file unless it happens
33805 during the first delivery attempt.
33806 .next
33807 &'retry time not reached for any host'&&~&~An address previously suffered
33808 temporary errors during remote delivery, and the retry time has not yet arrived
33809 for any of the hosts to which it is routed.
33810 .next
33811 .cindex "spool directory" "file locked"
33812 &'spool file locked'&&~&~An attempt to deliver a message cannot proceed because
33813 some other Exim process is already working on the message. This can be quite
33814 common if queue running processes are started at frequent intervals. The
33815 &'exiwhat'& utility script can be used to find out what Exim processes are
33816 doing.
33817 .next
33818 .cindex "error" "ignored"
33819 &'error ignored'&&~&~There are several circumstances that give rise to this
33820 message:
33821 .olist
33822 Exim failed to deliver a bounce message whose age was greater than
33823 &%ignore_bounce_errors_after%&. The bounce was discarded.
33824 .next
33825 A filter file set up a delivery using the &"noerror"& option, and the delivery
33826 failed. The delivery was discarded.
33827 .next
33828 A delivery set up by a router configured with
33829 . ==== As this is a nested list, any displays it contains must be indented
33830 . ==== as otherwise they are too far to the left.
33831 .code
33832     errors_to = <>
33833 .endd
33834 failed. The delivery was discarded.
33835 .endlist olist
33836 .endlist ilist
33837
33838
33839
33840
33841
33842 .section "Reducing or increasing what is logged" "SECTlogselector"
33843 .cindex "log" "selectors"
33844 By setting the &%log_selector%& global option, you can disable some of Exim's
33845 default logging, or you can request additional logging. The value of
33846 &%log_selector%& is made up of names preceded by plus or minus characters. For
33847 example:
33848 .code
33849 log_selector = +arguments -retry_defer
33850 .endd
33851 The list of optional log items is in the following table, with the default
33852 selection marked by asterisks:
33853 .display
33854 &` 8bitmime                   `&  received 8BITMIME status
33855 &`*acl_warn_skipped           `&  skipped &%warn%& statement in ACL
33856 &` address_rewrite            `&  address rewriting
33857 &` all_parents                `&  all parents in => lines
33858 &` arguments                  `&  command line arguments
33859 &`*connection_reject          `&  connection rejections
33860 &`*delay_delivery             `&  immediate delivery delayed
33861 &` deliver_time               `&  time taken to perform delivery
33862 &` delivery_size              `&  add &`S=`&&'nnn'& to => lines
33863 &`*dnslist_defer              `&  defers of DNS list (aka RBL) lookups
33864 &`*etrn                       `&  ETRN commands
33865 &`*host_lookup_failed         `&  as it says
33866 &` ident_timeout              `&  timeout for ident connection
33867 &` incoming_interface         `&  incoming interface on <= lines
33868 &` incoming_port              `&  incoming port on <= lines
33869 &`*lost_incoming_connection   `&  as it says (includes timeouts)
33870 &` outgoing_port              `&  add remote port to => lines
33871 &`*queue_run                  `&  start and end queue runs
33872 &` queue_time                 `&  time on queue for one recipient
33873 &` queue_time_overall         `&  time on queue for whole message
33874 &` pid                        `&  Exim process id
33875 &` received_recipients        `&  recipients on <= lines
33876 &` received_sender            `&  sender on <= lines
33877 &`*rejected_header            `&  header contents on reject log
33878 &`*retry_defer                `&  &"retry time not reached"&
33879 &` return_path_on_delivery    `&  put return path on => and ** lines
33880 &` sender_on_delivery         `&  add sender to => lines
33881 &`*sender_verify_fail         `&  sender verification failures
33882 &`*size_reject                `&  rejection because too big
33883 &`*skip_delivery              `&  delivery skipped in a queue run
33884 &`*smtp_confirmation          `&  SMTP confirmation on => lines
33885 &` smtp_connection            `&  SMTP connections
33886 &` smtp_incomplete_transaction`&  incomplete SMTP transactions
33887 &` smtp_mailauth              `&  AUTH argument to MAIL commands
33888 &` smtp_no_mail               `&  session with no MAIL commands
33889 &` smtp_protocol_error        `&  SMTP protocol errors
33890 &` smtp_syntax_error          `&  SMTP syntax errors
33891 &` subject                    `&  contents of &'Subject:'& on <= lines
33892 &` tls_certificate_verified   `&  certificate verification status
33893 &`*tls_cipher                 `&  TLS cipher suite on <= and => lines
33894 &` tls_peerdn                 `&  TLS peer DN on <= and => lines
33895 &` tls_sni                    `&  TLS SNI on <= lines
33896 &` unknown_in_list            `&  DNS lookup failed in list match
33897
33898 &` all                        `&  all of the above
33899 .endd
33900 More details on each of these items follows:
33901
33902 .ilist
33903 .cindex "8BITMIME"
33904 .cindex "log" "8BITMIME"
33905 &%8bitmime%&: This causes Exim to log any 8BITMIME status of received messages,
33906 which may help in tracking down interoperability issues with ancient MTAs
33907 that are not 8bit clean.  This is added to the &"<="& line, tagged with
33908 &`M8S=`& and a value of &`0`&, &`7`& or &`8`&, corresponding to "not given",
33909 &`7BIT`& and &`8BITMIME`& respectively.
33910 .next
33911 .cindex "&%warn%& ACL verb" "log when skipping"
33912 &%acl_warn_skipped%&: When an ACL &%warn%& statement is skipped because one of
33913 its conditions cannot be evaluated, a log line to this effect is written if
33914 this log selector is set.
33915 .next
33916 .cindex "log" "rewriting"
33917 .cindex "rewriting" "logging"
33918 &%address_rewrite%&: This applies both to global rewrites and per-transport
33919 rewrites, but not to rewrites in filters run as an unprivileged user (because
33920 such users cannot access the log).
33921 .next
33922 .cindex "log" "full parentage"
33923 &%all_parents%&: Normally only the original and final addresses are logged on
33924 delivery lines; with this selector, intermediate parents are given in
33925 parentheses between them.
33926 .next
33927 .cindex "log" "Exim arguments"
33928 .cindex "Exim arguments, logging"
33929 &%arguments%&: This causes Exim to write the arguments with which it was called
33930 to the main log, preceded by the current working directory. This is a debugging
33931 feature, added to make it easier to find out how certain MUAs call
33932 &_/usr/sbin/sendmail_&. The logging does not happen if Exim has given up root
33933 privilege because it was called with the &%-C%& or &%-D%& options. Arguments
33934 that are empty or that contain white space are quoted. Non-printing characters
33935 are shown as escape sequences. This facility cannot log unrecognized arguments,
33936 because the arguments are checked before the configuration file is read. The
33937 only way to log such cases is to interpose a script such as &_util/logargs.sh_&
33938 between the caller and Exim.
33939 .next
33940 .cindex "log" "connection rejections"
33941 &%connection_reject%&: A log entry is written whenever an incoming SMTP
33942 connection is rejected, for whatever reason.
33943 .next
33944 .cindex "log" "delayed delivery"
33945 .cindex "delayed delivery, logging"
33946 &%delay_delivery%&: A log entry is written whenever a delivery process is not
33947 started for an incoming message because the load is too high or too many
33948 messages were received on one connection. Logging does not occur if no delivery
33949 process is started because &%queue_only%& is set or &%-odq%& was used.
33950 .next
33951 .cindex "log" "delivery duration"
33952 &%deliver_time%&: For each delivery, the amount of real time it has taken to
33953 perform the actual delivery is logged as DT=<&'time'&>, for example, &`DT=1s`&.
33954 .next
33955 .cindex "log" "message size on delivery"
33956 .cindex "size" "of message"
33957 &%delivery_size%&: For each delivery, the size of message delivered is added to
33958 the &"=>"& line, tagged with S=.
33959 .next
33960 .cindex "log" "dnslist defer"
33961 .cindex "DNS list" "logging defer"
33962 .cindex "black list (DNS)"
33963 &%dnslist_defer%&: A log entry is written if an attempt to look up a host in a
33964 DNS black list suffers a temporary error.
33965 .next
33966 .cindex "log" "ETRN commands"
33967 .cindex "ETRN" "logging"
33968 &%etrn%&: Every valid ETRN command that is received is logged, before the ACL
33969 is run to determine whether or not it is actually accepted. An invalid ETRN
33970 command, or one received within a message transaction is not logged by this
33971 selector (see &%smtp_syntax_error%& and &%smtp_protocol_error%&).
33972 .next
33973 .cindex "log" "host lookup failure"
33974 &%host_lookup_failed%&: When a lookup of a host's IP addresses fails to find
33975 any addresses, or when a lookup of an IP address fails to find a host name, a
33976 log line is written. This logging does not apply to direct DNS lookups when
33977 routing email addresses, but it does apply to &"byname"& lookups.
33978 .next
33979 .cindex "log" "ident timeout"
33980 .cindex "RFC 1413" "logging timeout"
33981 &%ident_timeout%&: A log line is written whenever an attempt to connect to a
33982 client's ident port times out.
33983 .next
33984 .cindex "log" "incoming interface"
33985 .cindex "interface" "logging"
33986 &%incoming_interface%&: The interface on which a message was received is added
33987 to the &"<="& line as an IP address in square brackets, tagged by I= and
33988 followed by a colon and the port number. The local interface and port are also
33989 added to other SMTP log lines, for example &"SMTP connection from"&, and to
33990 rejection lines.
33991 .next
33992 .cindex "log" "incoming remote port"
33993 .cindex "port" "logging remote"
33994 .cindex "TCP/IP" "logging incoming remote port"
33995 .vindex "&$sender_fullhost$&"
33996 .vindex "&$sender_rcvhost$&"
33997 &%incoming_port%&: The remote port number from which a message was received is
33998 added to log entries and &'Received:'& header lines, following the IP address
33999 in square brackets, and separated from it by a colon. This is implemented by
34000 changing the value that is put in the &$sender_fullhost$& and
34001 &$sender_rcvhost$& variables. Recording the remote port number has become more
34002 important with the widening use of NAT (see RFC 2505).
34003 .next
34004 .cindex "log" "dropped connection"
34005 &%lost_incoming_connection%&: A log line is written when an incoming SMTP
34006 connection is unexpectedly dropped.
34007 .next
34008 .cindex "log" "outgoing remote port"
34009 .cindex "port" "logging outgoint remote"
34010 .cindex "TCP/IP" "logging ougtoing remote port"
34011 &%outgoing_port%&: The remote port number is added to delivery log lines (those
34012 containing => tags) following the IP address. This option is not included in
34013 the default setting, because for most ordinary configurations, the remote port
34014 number is always 25 (the SMTP port).
34015 .next
34016 .cindex "log" "process ids in"
34017 .cindex "pid (process id)" "in log lines"
34018 &%pid%&: The current process id is added to every log line, in square brackets,
34019 immediately after the time and date.
34020 .next
34021 .cindex "log" "queue run"
34022 .cindex "queue runner" "logging"
34023 &%queue_run%&: The start and end of every queue run are logged.
34024 .next
34025 .cindex "log" "queue time"
34026 &%queue_time%&: The amount of time the message has been in the queue on the
34027 local host is logged as QT=<&'time'&> on delivery (&`=>`&) lines, for example,
34028 &`QT=3m45s`&. The clock starts when Exim starts to receive the message, so it
34029 includes reception time as well as the delivery time for the current address.
34030 This means that it may be longer than the difference between the arrival and
34031 delivery log line times, because the arrival log line is not written until the
34032 message has been successfully received.
34033 .next
34034 &%queue_time_overall%&: The amount of time the message has been in the queue on
34035 the local host is logged as QT=<&'time'&> on &"Completed"& lines, for
34036 example, &`QT=3m45s`&. The clock starts when Exim starts to receive the
34037 message, so it includes reception time as well as the total delivery time.
34038 .next
34039 .cindex "log" "recipients"
34040 &%received_recipients%&: The recipients of a message are listed in the main log
34041 as soon as the message is received. The list appears at the end of the log line
34042 that is written when a message is received, preceded by the word &"for"&. The
34043 addresses are listed after they have been qualified, but before any rewriting
34044 has taken place.
34045 Recipients that were discarded by an ACL for MAIL or RCPT do not appear
34046 in the list.
34047 .next
34048 .cindex "log" "sender reception"
34049 &%received_sender%&: The unrewritten original sender of a message is added to
34050 the end of the log line that records the message's arrival, after the word
34051 &"from"& (before the recipients if &%received_recipients%& is also set).
34052 .next
34053 .cindex "log" "header lines for rejection"
34054 &%rejected_header%&: If a message's header has been received at the time a
34055 rejection is written to the reject log, the complete header is added to the
34056 log. Header logging can be turned off individually for messages that are
34057 rejected by the &[local_scan()]& function (see section &<<SECTapiforloc>>&).
34058 .next
34059 .cindex "log" "retry defer"
34060 &%retry_defer%&: A log line is written if a delivery is deferred because a
34061 retry time has not yet been reached. However, this &"retry time not reached"&
34062 message is always omitted from individual message logs after the first delivery
34063 attempt.
34064 .next
34065 .cindex "log" "return path"
34066 &%return_path_on_delivery%&: The return path that is being transmitted with
34067 the message is included in delivery and bounce lines, using the tag P=.
34068 This is omitted if no delivery actually happens, for example, if routing fails,
34069 or if delivery is to &_/dev/null_& or to &`:blackhole:`&.
34070 .next
34071 .cindex "log" "sender on delivery"
34072 &%sender_on_delivery%&: The message's sender address is added to every delivery
34073 and bounce line, tagged by F= (for &"from"&).
34074 This is the original sender that was received with the message; it is not
34075 necessarily the same as the outgoing return path.
34076 .next
34077 .cindex "log" "sender verify failure"
34078 &%sender_verify_fail%&: If this selector is unset, the separate log line that
34079 gives details of a sender verification failure is not written. Log lines for
34080 the rejection of SMTP commands contain just &"sender verify failed"&, so some
34081 detail is lost.
34082 .next
34083 .cindex "log" "size rejection"
34084 &%size_reject%&: A log line is written whenever a message is rejected because
34085 it is too big.
34086 .next
34087 .cindex "log" "frozen messages; skipped"
34088 .cindex "frozen messages" "logging skipping"
34089 &%skip_delivery%&: A log line is written whenever a message is skipped during a
34090 queue run because it is frozen or because another process is already delivering
34091 it.
34092 .cindex "&""spool file is locked""&"
34093 The message that is written is &"spool file is locked"&.
34094 .next
34095 .cindex "log" "smtp confirmation"
34096 .cindex "SMTP" "logging confirmation"
34097 &%smtp_confirmation%&: The response to the final &"."& in the SMTP dialogue for
34098 outgoing messages is added to delivery log lines in the form &`C=`&<&'text'&>.
34099 A number of MTAs (including Exim) return an identifying string in this
34100 response.
34101 .next
34102 .cindex "log" "SMTP connections"
34103 .cindex "SMTP" "logging connections"
34104 &%smtp_connection%&: A log line is written whenever an SMTP connection is
34105 established or closed, unless the connection is from a host that matches
34106 &%hosts_connection_nolog%&. (In contrast, &%lost_incoming_connection%& applies
34107 only when the closure is unexpected.) This applies to connections from local
34108 processes that use &%-bs%& as well as to TCP/IP connections. If a connection is
34109 dropped in the middle of a message, a log line is always written, whether or
34110 not this selector is set, but otherwise nothing is written at the start and end
34111 of connections unless this selector is enabled.
34112
34113 For TCP/IP connections to an Exim daemon, the current number of connections is
34114 included in the log message for each new connection, but note that the count is
34115 reset if the daemon is restarted.
34116 Also, because connections are closed (and the closure is logged) in
34117 subprocesses, the count may not include connections that have been closed but
34118 whose termination the daemon has not yet noticed. Thus, while it is possible to
34119 match up the opening and closing of connections in the log, the value of the
34120 logged counts may not be entirely accurate.
34121 .next
34122 .cindex "log" "SMTP transaction; incomplete"
34123 .cindex "SMTP" "logging incomplete transactions"
34124 &%smtp_incomplete_transaction%&: When a mail transaction is aborted by
34125 RSET, QUIT, loss of connection, or otherwise, the incident is logged,
34126 and the message sender plus any accepted recipients are included in the log
34127 line. This can provide evidence of dictionary attacks.
34128 .next
34129 .cindex "log" "non-MAIL SMTP sessions"
34130 .cindex "MAIL" "logging session without"
34131 &%smtp_no_mail%&: A line is written to the main log whenever an accepted SMTP
34132 connection terminates without having issued a MAIL command. This includes both
34133 the case when the connection is dropped, and the case when QUIT is used. It
34134 does not include cases where the connection is rejected right at the start (by
34135 an ACL, or because there are too many connections, or whatever). These cases
34136 already have their own log lines.
34137
34138 The log line that is written contains the identity of the client in the usual
34139 way, followed by D= and a time, which records the duration of the connection.
34140 If the connection was authenticated, this fact is logged exactly as it is for
34141 an incoming message, with an A= item. If the connection was encrypted, CV=,
34142 DN=, and X= items may appear as they do for an incoming message, controlled by
34143 the same logging options.
34144
34145 Finally, if any SMTP commands were issued during the connection, a C= item
34146 is added to the line, listing the commands that were used. For example,
34147 .code
34148 C=EHLO,QUIT
34149 .endd
34150 shows that the client issued QUIT straight after EHLO. If there were fewer
34151 than 20 commands, they are all listed. If there were more than 20 commands,
34152 the last 20 are listed, preceded by &"..."&. However, with the default
34153 setting of 10 for &%smtp_accep_max_nonmail%&, the connection will in any case
34154 have been aborted before 20 non-mail commands are processed.
34155 .next
34156 &%smtp_mailauth%&: A third subfield with the authenticated sender,
34157 colon-separated, is appended to the A= item for a message arrival or delivery
34158 log line, if an AUTH argument to the SMTP MAIL command (see &<<SECTauthparamail>>&)
34159 was accepted or used.
34160 .next
34161 .cindex "log" "SMTP protocol error"
34162 .cindex "SMTP" "logging protocol error"
34163 &%smtp_protocol_error%&: A log line is written for every SMTP protocol error
34164 encountered. Exim does not have perfect detection of all protocol errors
34165 because of transmission delays and the use of pipelining. If PIPELINING has
34166 been advertised to a client, an Exim server assumes that the client will use
34167 it, and therefore it does not count &"expected"& errors (for example, RCPT
34168 received after rejecting MAIL) as protocol errors.
34169 .next
34170 .cindex "SMTP" "logging syntax errors"
34171 .cindex "SMTP" "syntax errors; logging"
34172 .cindex "SMTP" "unknown command; logging"
34173 .cindex "log" "unknown SMTP command"
34174 .cindex "log" "SMTP syntax error"
34175 &%smtp_syntax_error%&: A log line is written for every SMTP syntax error
34176 encountered. An unrecognized command is treated as a syntax error. For an
34177 external connection, the host identity is given; for an internal connection
34178 using &%-bs%& the sender identification (normally the calling user) is given.
34179 .next
34180 .cindex "log" "subject"
34181 .cindex "subject, logging"
34182 &%subject%&: The subject of the message is added to the arrival log line,
34183 preceded by &"T="& (T for &"topic"&, since S is already used for &"size"&).
34184 Any MIME &"words"& in the subject are decoded. The &%print_topbitchars%& option
34185 specifies whether characters with values greater than 127 should be logged
34186 unchanged, or whether they should be rendered as escape sequences.
34187 .next
34188 .cindex "log" "certificate verification"
34189 &%tls_certificate_verified%&: An extra item is added to <= and => log lines
34190 when TLS is in use. The item is &`CV=yes`& if the peer's certificate was
34191 verified, and &`CV=no`& if not.
34192 .next
34193 .cindex "log" "TLS cipher"
34194 .cindex "TLS" "logging cipher"
34195 &%tls_cipher%&: When a message is sent or received over an encrypted
34196 connection, the cipher suite used is added to the log line, preceded by X=.
34197 .next
34198 .cindex "log" "TLS peer DN"
34199 .cindex "TLS" "logging peer DN"
34200 &%tls_peerdn%&: When a message is sent or received over an encrypted
34201 connection, and a certificate is supplied by the remote host, the peer DN is
34202 added to the log line, preceded by DN=.
34203 .next
34204 .cindex "log" "TLS SNI"
34205 .cindex "TLS" "logging SNI"
34206 &%tls_sni%&: When a message is received over an encrypted connection, and
34207 the remote host provided the Server Name Indication extension, the SNI is
34208 added to the log line, preceded by SNI=.
34209 .next
34210 .cindex "log" "DNS failure in list"
34211 &%unknown_in_list%&: This setting causes a log entry to be written when the
34212 result of a list match is failure because a DNS lookup failed.
34213 .endlist
34214
34215
34216 .section "Message log" "SECID260"
34217 .cindex "message" "log file for"
34218 .cindex "log" "message log; description of"
34219 .cindex "&_msglog_& directory"
34220 .oindex "&%preserve_message_logs%&"
34221 In addition to the general log files, Exim writes a log file for each message
34222 that it handles. The names of these per-message logs are the message ids, and
34223 they are kept in the &_msglog_& sub-directory of the spool directory. Each
34224 message log contains copies of the log lines that apply to the message. This
34225 makes it easier to inspect the status of an individual message without having
34226 to search the main log. A message log is deleted when processing of the message
34227 is complete, unless &%preserve_message_logs%& is set, but this should be used
34228 only with great care because they can fill up your disk very quickly.
34229
34230 On a heavily loaded system, it may be desirable to disable the use of
34231 per-message logs, in order to reduce disk I/O. This can be done by setting the
34232 &%message_logs%& option false.
34233 .ecindex IIDloggen
34234
34235
34236
34237
34238 . ////////////////////////////////////////////////////////////////////////////
34239 . ////////////////////////////////////////////////////////////////////////////
34240
34241 .chapter "Exim utilities" "CHAPutils"
34242 .scindex IIDutils "utilities"
34243 A number of utility scripts and programs are supplied with Exim and are
34244 described in this chapter. There is also the Exim Monitor, which is covered in
34245 the next chapter. The utilities described here are:
34246
34247 .itable none 0 0 3  7* left  15* left  40* left
34248 .irow &<<SECTfinoutwha>>&     &'exiwhat'&       &&&
34249   "list what Exim processes are doing"
34250 .irow &<<SECTgreptheque>>&    &'exiqgrep'&      "grep the queue"
34251 .irow &<<SECTsumtheque>>&     &'exiqsumm'&      "summarize the queue"
34252 .irow &<<SECTextspeinf>>&     &'exigrep'&       "search the main log"
34253 .irow &<<SECTexipick>>&       &'exipick'&       "select messages on &&&
34254                                                 various criteria"
34255 .irow &<<SECTcyclogfil>>&     &'exicyclog'&     "cycle (rotate) log files"
34256 .irow &<<SECTmailstat>>&      &'eximstats'&     &&&
34257   "extract statistics from the log"
34258 .irow &<<SECTcheckaccess>>&   &'exim_checkaccess'& &&&
34259   "check address acceptance from given IP"
34260 .irow &<<SECTdbmbuild>>&      &'exim_dbmbuild'& "build a DBM file"
34261 .irow &<<SECTfinindret>>&     &'exinext'&       "extract retry information"
34262 .irow &<<SECThindatmai>>&     &'exim_dumpdb'&   "dump a hints database"
34263 .irow &<<SECThindatmai>>&     &'exim_tidydb'&   "clean up a hints database"
34264 .irow &<<SECThindatmai>>&     &'exim_fixdb'&    "patch a hints database"
34265 .irow &<<SECTmailboxmaint>>&  &'exim_lock'&     "lock a mailbox file"
34266 .endtable
34267
34268 Another utility that might be of use to sites with many MTAs is Tom Kistner's
34269 &'exilog'&. It provides log visualizations across multiple Exim servers. See
34270 &url(http://duncanthrax.net/exilog/) for details.
34271
34272
34273
34274
34275 .section "Finding out what Exim processes are doing (exiwhat)" "SECTfinoutwha"
34276 .cindex "&'exiwhat'&"
34277 .cindex "process, querying"
34278 .cindex "SIGUSR1"
34279 On operating systems that can restart a system call after receiving a signal
34280 (most modern OS), an Exim process responds to the SIGUSR1 signal by writing
34281 a line describing what it is doing to the file &_exim-process.info_& in the
34282 Exim spool directory. The &'exiwhat'& script sends the signal to all Exim
34283 processes it can find, having first emptied the file. It then waits for one
34284 second to allow the Exim processes to react before displaying the results. In
34285 order to run &'exiwhat'& successfully you have to have sufficient privilege to
34286 send the signal to the Exim processes, so it is normally run as root.
34287
34288 &*Warning*&: This is not an efficient process. It is intended for occasional
34289 use by system administrators. It is not sensible, for example, to set up a
34290 script that sends SIGUSR1 signals to Exim processes at short intervals.
34291
34292
34293 Unfortunately, the &'ps'& command that &'exiwhat'& uses to find Exim processes
34294 varies in different operating systems. Not only are different options used,
34295 but the format of the output is different. For this reason, there are some
34296 system configuration options that configure exactly how &'exiwhat'& works. If
34297 it doesn't seem to be working for you, check the following compile-time
34298 options:
34299 .display
34300 &`EXIWHAT_PS_CMD    `& the command for running &'ps'&
34301 &`EXIWHAT_PS_ARG    `& the argument for &'ps'&
34302 &`EXIWHAT_EGREP_ARG `& the argument for &'egrep'& to select from &'ps'& output
34303 &`EXIWHAT_KILL_ARG  `& the argument for the &'kill'& command
34304 .endd
34305 An example of typical output from &'exiwhat'& is
34306 .code
34307 164 daemon: -q1h, listening on port 25
34308 10483 running queue: waiting for 0tAycK-0002ij-00 (10492)
34309 10492 delivering 0tAycK-0002ij-00 to mail.ref.example
34310   [10.19.42.42] (editor@ref.example)
34311 10592 handling incoming call from [192.168.243.242]
34312 10628 accepting a local non-SMTP message
34313 .endd
34314 The first number in the output line is the process number. The third line has
34315 been split here, in order to fit it on the page.
34316
34317
34318
34319 .section "Selective queue listing (exiqgrep)" "SECTgreptheque"
34320 .cindex "&'exiqgrep'&"
34321 .cindex "queue" "grepping"
34322 This utility is a Perl script contributed by Matt Hubbard. It runs
34323 .code
34324 exim -bpu
34325 .endd
34326 to obtain a queue listing with undelivered recipients only, and then greps the
34327 output to select messages that match given criteria. The following selection
34328 options are available:
34329
34330 .vlist
34331 .vitem &*-f*&&~<&'regex'&>
34332 Match the sender address. The field that is tested is enclosed in angle
34333 brackets, so you can test for bounce messages with
34334 .code
34335 exiqgrep -f '^<>$'
34336 .endd
34337 .vitem &*-r*&&~<&'regex'&>
34338 Match a recipient address. The field that is tested is not enclosed in angle
34339 brackets.
34340
34341 .vitem &*-s*&&~<&'regex'&>
34342 Match against the size field.
34343
34344 .vitem &*-y*&&~<&'seconds'&>
34345 Match messages that are younger than the given time.
34346
34347 .vitem &*-o*&&~<&'seconds'&>
34348 Match messages that are older than the given time.
34349
34350 .vitem &*-z*&
34351 Match only frozen messages.
34352
34353 .vitem &*-x*&
34354 Match only non-frozen messages.
34355 .endlist
34356
34357 The following options control the format of the output:
34358
34359 .vlist
34360 .vitem &*-c*&
34361 Display only the count of matching messages.
34362
34363 .vitem &*-l*&
34364 Long format &-- display the full message information as output by Exim. This is
34365 the default.
34366
34367 .vitem &*-i*&
34368 Display message ids only.
34369
34370 .vitem &*-b*&
34371 Brief format &-- one line per message.
34372
34373 .vitem &*-R*&
34374 Display messages in reverse order.
34375 .endlist
34376
34377 There is one more option, &%-h%&, which outputs a list of options.
34378
34379
34380
34381 .section "Summarizing the queue (exiqsumm)" "SECTsumtheque"
34382 .cindex "&'exiqsumm'&"
34383 .cindex "queue" "summary"
34384 The &'exiqsumm'& utility is a Perl script which reads the output of &`exim
34385 -bp`& and produces a summary of the messages on the queue. Thus, you use it by
34386 running a command such as
34387 .code
34388 exim -bp | exiqsumm
34389 .endd
34390 The output consists of one line for each domain that has messages waiting for
34391 it, as in the following example:
34392 .code
34393 3   2322   74m   66m  msn.com.example
34394 .endd
34395 Each line lists the number of pending deliveries for a domain, their total
34396 volume, and the length of time that the oldest and the newest messages have
34397 been waiting. Note that the number of pending deliveries is greater than the
34398 number of messages when messages have more than one recipient.
34399
34400 A summary line is output at the end. By default the output is sorted on the
34401 domain name, but &'exiqsumm'& has the options &%-a%& and &%-c%&, which cause
34402 the output to be sorted by oldest message and by count of messages,
34403 respectively. There are also three options that split the messages for each
34404 domain into two or more subcounts: &%-b%& separates bounce messages, &%-f%&
34405 separates frozen messages, and &%-s%& separates messages according to their
34406 sender.
34407
34408 The output of &'exim -bp'& contains the original addresses in the message, so
34409 this also applies to the output from &'exiqsumm'&. No domains from addresses
34410 generated by aliasing or forwarding are included (unless the &%one_time%&
34411 option of the &(redirect)& router has been used to convert them into &"top
34412 level"& addresses).
34413
34414
34415
34416
34417 .section "Extracting specific information from the log (exigrep)" &&&
34418          "SECTextspeinf"
34419 .cindex "&'exigrep'&"
34420 .cindex "log" "extracts; grepping for"
34421 The &'exigrep'& utility is a Perl script that searches one or more main log
34422 files for entries that match a given pattern. When it finds a match, it
34423 extracts all the log entries for the relevant message, not just those that
34424 match the pattern. Thus, &'exigrep'& can extract complete log entries for a
34425 given message, or all mail for a given user, or for a given host, for example.
34426 The input files can be in Exim log format or syslog format.
34427 If a matching log line is not associated with a specific message, it is
34428 included in &'exigrep'&'s output without any additional lines. The usage is:
34429 .display
34430 &`exigrep [-t<`&&'n'&&`>] [-I] [-l] [-v] <`&&'pattern'&&`> [<`&&'log file'&&`>] ...`&
34431 .endd
34432 If no log file names are given on the command line, the standard input is read.
34433
34434 The &%-t%& argument specifies a number of seconds. It adds an additional
34435 condition for message selection. Messages that are complete are shown only if
34436 they spent more than <&'n'&> seconds on the queue.
34437
34438 By default, &'exigrep'& does case-insensitive matching. The &%-I%& option
34439 makes it case-sensitive. This may give a performance improvement when searching
34440 large log files. Without &%-I%&, the Perl pattern matches use Perl's &`/i`&
34441 option; with &%-I%& they do not. In both cases it is possible to change the
34442 case sensitivity within the pattern by using &`(?i)`& or &`(?-i)`&.
34443
34444 The &%-l%& option means &"literal"&, that is, treat all characters in the
34445 pattern as standing for themselves. Otherwise the pattern must be a Perl
34446 regular expression.
34447
34448 The &%-v%& option inverts the matching condition. That is, a line is selected
34449 if it does &'not'& match the pattern.
34450
34451 If the location of a &'zcat'& command is known from the definition of
34452 ZCAT_COMMAND in &_Local/Makefile_&, &'exigrep'& automatically passes any file
34453 whose name ends in COMPRESS_SUFFIX through &'zcat'& as it searches it.
34454
34455
34456 .section "Selecting messages by various criteria (exipick)" "SECTexipick"
34457 .cindex "&'exipick'&"
34458 John Jetmore's &'exipick'& utility is included in the Exim distribution. It
34459 lists messages from the queue according to a variety of criteria. For details
34460 of &'exipick'&'s facilities, visit the web page at
34461 &url(http://www.exim.org/eximwiki/ToolExipickManPage) or run &'exipick'& with
34462 the &%--help%& option.
34463
34464
34465 .section "Cycling log files (exicyclog)" "SECTcyclogfil"
34466 .cindex "log" "cycling local files"
34467 .cindex "cycling logs"
34468 .cindex "&'exicyclog'&"
34469 The &'exicyclog'& script can be used to cycle (rotate) &'mainlog'& and
34470 &'rejectlog'& files. This is not necessary if only syslog is being used, or if
34471 you are using log files with datestamps in their names (see section
34472 &<<SECTdatlogfil>>&). Some operating systems have their own standard mechanisms
34473 for log cycling, and these can be used instead of &'exicyclog'& if preferred.
34474 There are two command line options for &'exicyclog'&:
34475 .ilist
34476 &%-k%& <&'count'&> specifies the number of log files to keep, overriding the
34477 default that is set when Exim is built. The default default is 10.
34478 .next
34479 &%-l%& <&'path'&> specifies the log file path, in the same format as Exim's
34480 &%log_file_path%& option (for example, &`/var/log/exim_%slog`&), again
34481 overriding the script's default, which is to find the setting from Exim's
34482 configuration.
34483 .endlist
34484
34485 Each time &'exicyclog'& is run the file names get &"shuffled down"& by one. If
34486 the main log file name is &_mainlog_& (the default) then when &'exicyclog'& is
34487 run &_mainlog_& becomes &_mainlog.01_&, the previous &_mainlog.01_& becomes
34488 &_mainlog.02_& and so on, up to the limit that is set in the script or by the
34489 &%-k%& option. Log files whose numbers exceed the limit are discarded. Reject
34490 logs are handled similarly.
34491
34492 If the limit is greater than 99, the script uses 3-digit numbers such as
34493 &_mainlog.001_&, &_mainlog.002_&, etc. If you change from a number less than 99
34494 to one that is greater, or &'vice versa'&, you will have to fix the names of
34495 any existing log files.
34496
34497 If no &_mainlog_& file exists, the script does nothing. Files that &"drop off"&
34498 the end are deleted. All files with numbers greater than 01 are compressed,
34499 using a compression command which is configured by the COMPRESS_COMMAND
34500 setting in &_Local/Makefile_&. It is usual to run &'exicyclog'& daily from a
34501 root &%crontab%& entry of the form
34502 .code
34503 1 0 * * * su exim -c /usr/exim/bin/exicyclog
34504 .endd
34505 assuming you have used the name &"exim"& for the Exim user. You can run
34506 &'exicyclog'& as root if you wish, but there is no need.
34507
34508
34509
34510 .section "Mail statistics (eximstats)" "SECTmailstat"
34511 .cindex "statistics"
34512 .cindex "&'eximstats'&"
34513 A Perl script called &'eximstats'& is provided for extracting statistical
34514 information from log files. The output is either plain text, or HTML.
34515 Exim log files are also supported by the &'Lire'& system produced by the
34516 LogReport Foundation &url(http://www.logreport.org).
34517
34518 The &'eximstats'& script has been hacked about quite a bit over time. The
34519 latest version is the result of some extensive revision by Steve Campbell. A
34520 lot of information is given by default, but there are options for suppressing
34521 various parts of it. Following any options, the arguments to the script are a
34522 list of files, which should be main log files. For example:
34523 .code
34524 eximstats -nr /var/spool/exim/log/mainlog.01
34525 .endd
34526 By default, &'eximstats'& extracts information about the number and volume of
34527 messages received from or delivered to various hosts. The information is sorted
34528 both by message count and by volume, and the top fifty hosts in each category
34529 are listed on the standard output. Similar information, based on email
34530 addresses or domains instead of hosts can be requested by means of various
34531 options. For messages delivered and received locally, similar statistics are
34532 also produced per user.
34533
34534 The output also includes total counts and statistics about delivery errors, and
34535 histograms showing the number of messages received and deliveries made in each
34536 hour of the day. A delivery with more than one address in its envelope (for
34537 example, an SMTP transaction with more than one RCPT command) is counted
34538 as a single delivery by &'eximstats'&.
34539
34540 Though normally more deliveries than receipts are reported (as messages may
34541 have multiple recipients), it is possible for &'eximstats'& to report more
34542 messages received than delivered, even though the queue is empty at the start
34543 and end of the period in question. If an incoming message contains no valid
34544 recipients, no deliveries are recorded for it. A bounce message is handled as
34545 an entirely separate message.
34546
34547 &'eximstats'& always outputs a grand total summary giving the volume and number
34548 of messages received and deliveries made, and the number of hosts involved in
34549 each case. It also outputs the number of messages that were delayed (that is,
34550 not completely delivered at the first attempt), and the number that had at
34551 least one address that failed.
34552
34553 The remainder of the output is in sections that can be independently disabled
34554 or modified by various options. It consists of a summary of deliveries by
34555 transport, histograms of messages received and delivered per time interval
34556 (default per hour), information about the time messages spent on the queue,
34557 a list of relayed messages, lists of the top fifty sending hosts, local
34558 senders, destination hosts, and destination local users by count and by volume,
34559 and a list of delivery errors that occurred.
34560
34561 The relay information lists messages that were actually relayed, that is, they
34562 came from a remote host and were directly delivered to some other remote host,
34563 without being processed (for example, for aliasing or forwarding) locally.
34564
34565 There are quite a few options for &'eximstats'& to control exactly what it
34566 outputs. These are documented in the Perl script itself, and can be extracted
34567 by running the command &(perldoc)& on the script. For example:
34568 .code
34569 perldoc /usr/exim/bin/eximstats
34570 .endd
34571
34572 .section "Checking access policy (exim_checkaccess)" "SECTcheckaccess"
34573 .cindex "&'exim_checkaccess'&"
34574 .cindex "policy control" "checking access"
34575 .cindex "checking access"
34576 The &%-bh%& command line argument allows you to run a fake SMTP session with
34577 debugging output, in order to check what Exim is doing when it is applying
34578 policy controls to incoming SMTP mail. However, not everybody is sufficiently
34579 familiar with the SMTP protocol to be able to make full use of &%-bh%&, and
34580 sometimes you just want to answer the question &"Does this address have
34581 access?"& without bothering with any further details.
34582
34583 The &'exim_checkaccess'& utility is a &"packaged"& version of &%-bh%&. It takes
34584 two arguments, an IP address and an email address:
34585 .code
34586 exim_checkaccess 10.9.8.7 A.User@a.domain.example
34587 .endd
34588 The utility runs a call to Exim with the &%-bh%& option, to test whether the
34589 given email address would be accepted in a RCPT command in a TCP/IP
34590 connection from the host with the given IP address. The output of the utility
34591 is either the word &"accepted"&, or the SMTP error response, for example:
34592 .code
34593 Rejected:
34594 550 Relay not permitted
34595 .endd
34596 When running this test, the utility uses &`<>`& as the envelope sender address
34597 for the MAIL command, but you can change this by providing additional
34598 options. These are passed directly to the Exim command. For example, to specify
34599 that the test is to be run with the sender address &'himself@there.example'&
34600 you can use:
34601 .code
34602 exim_checkaccess 10.9.8.7 A.User@a.domain.example \
34603                  -f himself@there.example
34604 .endd
34605 Note that these additional Exim command line items must be given after the two
34606 mandatory arguments.
34607
34608 Because the &%exim_checkaccess%& uses &%-bh%&, it does not perform callouts
34609 while running its checks. You can run checks that include callouts by using
34610 &%-bhc%&, but this is not yet available in a &"packaged"& form.
34611
34612
34613
34614 .section "Making DBM files (exim_dbmbuild)" "SECTdbmbuild"
34615 .cindex "DBM" "building dbm files"
34616 .cindex "building DBM files"
34617 .cindex "&'exim_dbmbuild'&"
34618 .cindex "lower casing"
34619 .cindex "binary zero" "in lookup key"
34620 The &'exim_dbmbuild'& program reads an input file containing keys and data in
34621 the format used by the &(lsearch)& lookup (see section
34622 &<<SECTsinglekeylookups>>&). It writes a DBM file using the lower-cased alias
34623 names as keys and the remainder of the information as data. The lower-casing
34624 can be prevented by calling the program with the &%-nolc%& option.
34625
34626 A terminating zero is included as part of the key string. This is expected by
34627 the &(dbm)& lookup type. However, if the option &%-nozero%& is given,
34628 &'exim_dbmbuild'& creates files without terminating zeroes in either the key
34629 strings or the data strings. The &(dbmnz)& lookup type can be used with such
34630 files.
34631
34632 The program requires two arguments: the name of the input file (which can be a
34633 single hyphen to indicate the standard input), and the name of the output file.
34634 It creates the output under a temporary name, and then renames it if all went
34635 well.
34636
34637 .cindex "USE_DB"
34638 If the native DB interface is in use (USE_DB is set in a compile-time
34639 configuration file &-- this is common in free versions of Unix) the two file
34640 names must be different, because in this mode the Berkeley DB functions create
34641 a single output file using exactly the name given. For example,
34642 .code
34643 exim_dbmbuild /etc/aliases /etc/aliases.db
34644 .endd
34645 reads the system alias file and creates a DBM version of it in
34646 &_/etc/aliases.db_&.
34647
34648 In systems that use the &'ndbm'& routines (mostly proprietary versions of
34649 Unix), two files are used, with the suffixes &_.dir_& and &_.pag_&. In this
34650 environment, the suffixes are added to the second argument of
34651 &'exim_dbmbuild'&, so it can be the same as the first. This is also the case
34652 when the Berkeley functions are used in compatibility mode (though this is not
34653 recommended), because in that case it adds a &_.db_& suffix to the file name.
34654
34655 If a duplicate key is encountered, the program outputs a warning, and when it
34656 finishes, its return code is 1 rather than zero, unless the &%-noduperr%&
34657 option is used. By default, only the first of a set of duplicates is used &--
34658 this makes it compatible with &(lsearch)& lookups. There is an option
34659 &%-lastdup%& which causes it to use the data for the last duplicate instead.
34660 There is also an option &%-nowarn%&, which stops it listing duplicate keys to
34661 &%stderr%&. For other errors, where it doesn't actually make a new file, the
34662 return code is 2.
34663
34664
34665
34666
34667 .section "Finding individual retry times (exinext)" "SECTfinindret"
34668 .cindex "retry" "times"
34669 .cindex "&'exinext'&"
34670 A utility called &'exinext'& (mostly a Perl script) provides the ability to
34671 fish specific information out of the retry database. Given a mail domain (or a
34672 complete address), it looks up the hosts for that domain, and outputs any retry
34673 information for the hosts or for the domain. At present, the retry information
34674 is obtained by running &'exim_dumpdb'& (see below) and post-processing the
34675 output. For example:
34676 .code
34677 $ exinext piglet@milne.fict.example
34678 kanga.milne.example:192.168.8.1 error 146: Connection refused
34679   first failed: 21-Feb-1996 14:57:34
34680   last tried:   21-Feb-1996 14:57:34
34681   next try at:  21-Feb-1996 15:02:34
34682 roo.milne.example:192.168.8.3 error 146: Connection refused
34683   first failed: 20-Jan-1996 13:12:08
34684   last tried:   21-Feb-1996 11:42:03
34685   next try at:  21-Feb-1996 19:42:03
34686   past final cutoff time
34687 .endd
34688 You can also give &'exinext'& a local part, without a domain, and it
34689 will give any retry information for that local part in your default domain.
34690 A message id can be used to obtain retry information pertaining to a specific
34691 message. This exists only when an attempt to deliver a message to a remote host
34692 suffers a message-specific error (see section &<<SECToutSMTPerr>>&).
34693 &'exinext'& is not particularly efficient, but then it is not expected to be
34694 run very often.
34695
34696 The &'exinext'& utility calls Exim to find out information such as the location
34697 of the spool directory. The utility has &%-C%& and &%-D%& options, which are
34698 passed on to the &'exim'& commands. The first specifies an alternate Exim
34699 configuration file, and the second sets macros for use within the configuration
34700 file. These features are mainly to help in testing, but might also be useful in
34701 environments where more than one configuration file is in use.
34702
34703
34704
34705 .section "Hints database maintenance" "SECThindatmai"
34706 .cindex "hints database" "maintenance"
34707 .cindex "maintaining Exim's hints database"
34708 Three utility programs are provided for maintaining the DBM files that Exim
34709 uses to contain its delivery hint information. Each program requires two
34710 arguments. The first specifies the name of Exim's spool directory, and the
34711 second is the name of the database it is to operate on. These are as follows:
34712
34713 .ilist
34714 &'retry'&: the database of retry information
34715 .next
34716 &'wait-'&<&'transport name'&>: databases of information about messages waiting
34717 for remote hosts
34718 .next
34719 &'callout'&: the callout cache
34720 .next
34721 &'ratelimit'&: the data for implementing the ratelimit ACL condition
34722 .next
34723 &'misc'&: other hints data
34724 .endlist
34725
34726 The &'misc'& database is used for
34727
34728 .ilist
34729 Serializing ETRN runs (when &%smtp_etrn_serialize%& is set)
34730 .next
34731 Serializing delivery to a specific host (when &%serialize_hosts%& is set in an
34732 &(smtp)& transport)
34733 .endlist
34734
34735
34736
34737 .section "exim_dumpdb" "SECID261"
34738 .cindex "&'exim_dumpdb'&"
34739 The entire contents of a database are written to the standard output by the
34740 &'exim_dumpdb'& program, which has no options or arguments other than the
34741 spool and database names. For example, to dump the retry database:
34742 .code
34743 exim_dumpdb /var/spool/exim retry
34744 .endd
34745 Two lines of output are produced for each entry:
34746 .code
34747 T:mail.ref.example:192.168.242.242 146 77 Connection refused
34748 31-Oct-1995 12:00:12 02-Nov-1995 12:21:39 02-Nov-1995 20:21:39 *
34749 .endd
34750 The first item on the first line is the key of the record. It starts with one
34751 of the letters R, or T, depending on whether it refers to a routing or
34752 transport retry. For a local delivery, the next part is the local address; for
34753 a remote delivery it is the name of the remote host, followed by its failing IP
34754 address (unless &%retry_include_ip_address%& is set false on the &(smtp)&
34755 transport). If the remote port is not the standard one (port 25), it is added
34756 to the IP address. Then there follows an error code, an additional error code,
34757 and a textual description of the error.
34758
34759 The three times on the second line are the time of first failure, the time of
34760 the last delivery attempt, and the computed time for the next attempt. The line
34761 ends with an asterisk if the cutoff time for the last retry rule has been
34762 exceeded.
34763
34764 Each output line from &'exim_dumpdb'& for the &'wait-xxx'& databases
34765 consists of a host name followed by a list of ids for messages that are or were
34766 waiting to be delivered to that host. If there are a very large number for any
34767 one host, continuation records, with a sequence number added to the host name,
34768 may be seen. The data in these records is often out of date, because a message
34769 may be routed to several alternative hosts, and Exim makes no effort to keep
34770 cross-references.
34771
34772
34773
34774 .section "exim_tidydb" "SECID262"
34775 .cindex "&'exim_tidydb'&"
34776 The &'exim_tidydb'& utility program is used to tidy up the contents of a hints
34777 database. If run with no options, it removes all records that are more than 30
34778 days old. The age is calculated from the date and time that the record was last
34779 updated. Note that, in the case of the retry database, it is &'not'& the time
34780 since the first delivery failure. Information about a host that has been down
34781 for more than 30 days will remain in the database, provided that the record is
34782 updated sufficiently often.
34783
34784 The cutoff date can be altered by means of the &%-t%& option, which must be
34785 followed by a time. For example, to remove all records older than a week from
34786 the retry database:
34787 .code
34788 exim_tidydb -t 7d /var/spool/exim retry
34789 .endd
34790 Both the &'wait-xxx'& and &'retry'& databases contain items that involve
34791 message ids. In the former these appear as data in records keyed by host &--
34792 they were messages that were waiting for that host &-- and in the latter they
34793 are the keys for retry information for messages that have suffered certain
34794 types of error. When &'exim_tidydb'& is run, a check is made to ensure that
34795 message ids in database records are those of messages that are still on the
34796 queue. Message ids for messages that no longer exist are removed from
34797 &'wait-xxx'& records, and if this leaves any records empty, they are deleted.
34798 For the &'retry'& database, records whose keys are non-existent message ids are
34799 removed. The &'exim_tidydb'& utility outputs comments on the standard output
34800 whenever it removes information from the database.
34801
34802 Certain records are automatically removed by Exim when they are no longer
34803 needed, but others are not. For example, if all the MX hosts for a domain are
34804 down, a retry record is created for each one. If the primary MX host comes back
34805 first, its record is removed when Exim successfully delivers to it, but the
34806 records for the others remain because Exim has not tried to use those hosts.
34807
34808 It is important, therefore, to run &'exim_tidydb'& periodically on all the
34809 hints databases. You should do this at a quiet time of day, because it requires
34810 a database to be locked (and therefore inaccessible to Exim) while it does its
34811 work. Removing records from a DBM file does not normally make the file smaller,
34812 but all the common DBM libraries are able to re-use the space that is released.
34813 After an initial phase of increasing in size, the databases normally reach a
34814 point at which they no longer get any bigger, as long as they are regularly
34815 tidied.
34816
34817 &*Warning*&: If you never run &'exim_tidydb'&, the space used by the hints
34818 databases is likely to keep on increasing.
34819
34820
34821
34822
34823 .section "exim_fixdb" "SECID263"
34824 .cindex "&'exim_fixdb'&"
34825 The &'exim_fixdb'& program is a utility for interactively modifying databases.
34826 Its main use is for testing Exim, but it might also be occasionally useful for
34827 getting round problems in a live system. It has no options, and its interface
34828 is somewhat crude. On entry, it prompts for input with a right angle-bracket. A
34829 key of a database record can then be entered, and the data for that record is
34830 displayed.
34831
34832 If &"d"& is typed at the next prompt, the entire record is deleted. For all
34833 except the &'retry'& database, that is the only operation that can be carried
34834 out. For the &'retry'& database, each field is output preceded by a number, and
34835 data for individual fields can be changed by typing the field number followed
34836 by new data, for example:
34837 .code
34838 > 4 951102:1000
34839 .endd
34840 resets the time of the next delivery attempt. Time values are given as a
34841 sequence of digit pairs for year, month, day, hour, and minute. Colons can be
34842 used as optional separators.
34843
34844
34845
34846
34847 .section "Mailbox maintenance (exim_lock)" "SECTmailboxmaint"
34848 .cindex "mailbox" "maintenance"
34849 .cindex "&'exim_lock'&"
34850 .cindex "locking mailboxes"
34851 The &'exim_lock'& utility locks a mailbox file using the same algorithm as
34852 Exim. For a discussion of locking issues, see section &<<SECTopappend>>&.
34853 &'Exim_lock'& can be used to prevent any modification of a mailbox by Exim or
34854 a user agent while investigating a problem. The utility requires the name of
34855 the file as its first argument. If the locking is successful, the second
34856 argument is run as a command (using C's &[system()]& function); if there is no
34857 second argument, the value of the SHELL environment variable is used; if this
34858 is unset or empty, &_/bin/sh_& is run. When the command finishes, the mailbox
34859 is unlocked and the utility ends. The following options are available:
34860
34861 .vlist
34862 .vitem &%-fcntl%&
34863 Use &[fcntl()]& locking on the open mailbox.
34864
34865 .vitem &%-flock%&
34866 Use &[flock()]& locking on the open mailbox, provided the operating system
34867 supports it.
34868
34869 .vitem &%-interval%&
34870 This must be followed by a number, which is a number of seconds; it sets the
34871 interval to sleep between retries (default 3).
34872
34873 .vitem &%-lockfile%&
34874 Create a lock file before opening the mailbox.
34875
34876 .vitem &%-mbx%&
34877 Lock the mailbox using MBX rules.
34878
34879 .vitem &%-q%&
34880 Suppress verification output.
34881
34882 .vitem &%-retries%&
34883 This must be followed by a number; it sets the number of times to try to get
34884 the lock (default 10).
34885
34886 .vitem &%-restore_time%&
34887 This option causes &%exim_lock%& to restore the modified and read times to the
34888 locked file before exiting. This allows you to access a locked mailbox (for
34889 example, to take a backup copy) without disturbing the times that the user
34890 subsequently sees.
34891
34892 .vitem &%-timeout%&
34893 This must be followed by a number, which is a number of seconds; it sets a
34894 timeout to be used with a blocking &[fcntl()]& lock. If it is not set (the
34895 default), a non-blocking call is used.
34896
34897 .vitem &%-v%&
34898 Generate verbose output.
34899 .endlist
34900
34901 If none of &%-fcntl%&, &%-flock%&, &%-lockfile%& or &%-mbx%& are given, the
34902 default is to create a lock file and also to use &[fcntl()]& locking on the
34903 mailbox, which is the same as Exim's default. The use of &%-flock%& or
34904 &%-fcntl%& requires that the file be writeable; the use of &%-lockfile%&
34905 requires that the directory containing the file be writeable. Locking by lock
34906 file does not last for ever; Exim assumes that a lock file is expired if it is
34907 more than 30 minutes old.
34908
34909 The &%-mbx%& option can be used with either or both of &%-fcntl%& or
34910 &%-flock%&. It assumes &%-fcntl%& by default. MBX locking causes a shared lock
34911 to be taken out on the open mailbox, and an exclusive lock on the file
34912 &_/tmp/.n.m_& where &'n'& and &'m'& are the device number and inode
34913 number of the mailbox file. When the locking is released, if an exclusive lock
34914 can be obtained for the mailbox, the file in &_/tmp_& is deleted.
34915
34916 The default output contains verification of the locking that takes place. The
34917 &%-v%& option causes some additional information to be given. The &%-q%& option
34918 suppresses all output except error messages.
34919
34920 A command such as
34921 .code
34922 exim_lock /var/spool/mail/spqr
34923 .endd
34924 runs an interactive shell while the file is locked, whereas
34925 .display
34926 &`exim_lock -q /var/spool/mail/spqr <<End`&
34927 <&'some commands'&>
34928 &`End`&
34929 .endd
34930 runs a specific non-interactive sequence of commands while the file is locked,
34931 suppressing all verification output. A single command can be run by a command
34932 such as
34933 .code
34934 exim_lock -q /var/spool/mail/spqr \
34935   "cp /var/spool/mail/spqr /some/where"
34936 .endd
34937 Note that if a command is supplied, it must be entirely contained within the
34938 second argument &-- hence the quotes.
34939 .ecindex IIDutils
34940
34941
34942 . ////////////////////////////////////////////////////////////////////////////
34943 . ////////////////////////////////////////////////////////////////////////////
34944
34945 .chapter "The Exim monitor" "CHAPeximon"
34946 .scindex IIDeximon "Exim monitor" "description"
34947 .cindex "X-windows"
34948 .cindex "&'eximon'&"
34949 .cindex "Local/eximon.conf"
34950 .cindex "&_exim_monitor/EDITME_&"
34951 The Exim monitor is an application which displays in an X window information
34952 about the state of Exim's queue and what Exim is doing. An admin user can
34953 perform certain operations on messages from this GUI interface; however all
34954 such facilities are also available from the command line, and indeed, the
34955 monitor itself makes use of the command line to perform any actions requested.
34956
34957
34958
34959 .section "Running the monitor" "SECID264"
34960 The monitor is started by running the script called &'eximon'&. This is a shell
34961 script that sets up a number of environment variables, and then runs the
34962 binary called &_eximon.bin_&. The default appearance of the monitor window can
34963 be changed by editing the &_Local/eximon.conf_& file created by editing
34964 &_exim_monitor/EDITME_&. Comments in that file describe what the various
34965 parameters are for.
34966
34967 The parameters that get built into the &'eximon'& script can be overridden for
34968 a particular invocation by setting up environment variables of the same names,
34969 preceded by &`EXIMON_`&. For example, a shell command such as
34970 .code
34971 EXIMON_LOG_DEPTH=400 eximon
34972 .endd
34973 (in a Bourne-compatible shell) runs &'eximon'& with an overriding setting of
34974 the LOG_DEPTH parameter. If EXIMON_LOG_FILE_PATH is set in the environment, it
34975 overrides the Exim log file configuration. This makes it possible to have
34976 &'eximon'& tailing log data that is written to syslog, provided that MAIL.INFO
34977 syslog messages are routed to a file on the local host.
34978
34979 X resources can be used to change the appearance of the window in the normal
34980 way. For example, a resource setting of the form
34981 .code
34982 Eximon*background: gray94
34983 .endd
34984 changes the colour of the background to light grey rather than white. The
34985 stripcharts are drawn with both the data lines and the reference lines in
34986 black. This means that the reference lines are not visible when on top of the
34987 data. However, their colour can be changed by setting a resource called
34988 &"highlight"& (an odd name, but that's what the Athena stripchart widget uses).
34989 For example, if your X server is running Unix, you could set up lighter
34990 reference lines in the stripcharts by obeying
34991 .code
34992 xrdb -merge <<End
34993 Eximon*highlight: gray
34994 End
34995 .endd
34996 .cindex "admin user"
34997 In order to see the contents of messages on the queue, and to operate on them,
34998 &'eximon'& must either be run as root or by an admin user.
34999
35000 The command-line parameters of &'eximon'& are passed to &_eximon.bin_& and may
35001 contain X11 resource parameters interpreted by the X11 library.  In addition,
35002 if the first parameter starts with the string "gdb" then it is removed and the
35003 binary is invoked under gdb (the parameter is used as the gdb command-name, so
35004 versioned variants of gdb can be invoked).
35005
35006 The monitor's window is divided into three parts. The first contains one or
35007 more stripcharts and two action buttons, the second contains a &"tail"& of the
35008 main log file, and the third is a display of the queue of messages awaiting
35009 delivery, with two more action buttons. The following sections describe these
35010 different parts of the display.
35011
35012
35013
35014
35015 .section "The stripcharts" "SECID265"
35016 .cindex "stripchart"
35017 The first stripchart is always a count of messages on the queue. Its name can
35018 be configured by setting QUEUE_STRIPCHART_NAME in the
35019 &_Local/eximon.conf_& file. The remaining stripcharts are defined in the
35020 configuration script by regular expression matches on log file entries, making
35021 it possible to display, for example, counts of messages delivered to certain
35022 hosts or using certain transports. The supplied defaults display counts of
35023 received and delivered messages, and of local and SMTP deliveries. The default
35024 period between stripchart updates is one minute; this can be adjusted by a
35025 parameter in the &_Local/eximon.conf_& file.
35026
35027 The stripchart displays rescale themselves automatically as the value they are
35028 displaying changes. There are always 10 horizontal lines in each chart; the
35029 title string indicates the value of each division when it is greater than one.
35030 For example, &"x2"& means that each division represents a value of 2.
35031
35032 It is also possible to have a stripchart which shows the percentage fullness of
35033 a particular disk partition, which is useful when local deliveries are confined
35034 to a single partition.
35035
35036 .cindex "&%statvfs%& function"
35037 This relies on the availability of the &[statvfs()]& function or equivalent in
35038 the operating system. Most, but not all versions of Unix that support Exim have
35039 this. For this particular stripchart, the top of the chart always represents
35040 100%, and the scale is given as &"x10%"&. This chart is configured by setting
35041 SIZE_STRIPCHART and (optionally) SIZE_STRIPCHART_NAME in the
35042 &_Local/eximon.conf_& file.
35043
35044
35045
35046
35047 .section "Main action buttons" "SECID266"
35048 .cindex "size" "of monitor window"
35049 .cindex "Exim monitor" "window size"
35050 .cindex "window size"
35051 Below the stripcharts there is an action button for quitting the monitor. Next
35052 to this is another button marked &"Size"&. They are placed here so that
35053 shrinking the window to its default minimum size leaves just the queue count
35054 stripchart and these two buttons visible. Pressing the &"Size"& button causes
35055 the window to expand to its maximum size, unless it is already at the maximum,
35056 in which case it is reduced to its minimum.
35057
35058 When expanding to the maximum, if the window cannot be fully seen where it
35059 currently is, it is moved back to where it was the last time it was at full
35060 size. When it is expanding from its minimum size, the old position is
35061 remembered, and next time it is reduced to the minimum it is moved back there.
35062
35063 The idea is that you can keep a reduced window just showing one or two
35064 stripcharts at a convenient place on your screen, easily expand it to show
35065 the full window when required, and just as easily put it back to what it was.
35066 The idea is copied from what the &'twm'& window manager does for its
35067 &'f.fullzoom'& action. The minimum size of the window can be changed by setting
35068 the MIN_HEIGHT and MIN_WIDTH values in &_Local/eximon.conf_&.
35069
35070 Normally, the monitor starts up with the window at its full size, but it can be
35071 built so that it starts up with the window at its smallest size, by setting
35072 START_SMALL=yes in &_Local/eximon.conf_&.
35073
35074
35075
35076 .section "The log display" "SECID267"
35077 .cindex "log" "tail of; in monitor"
35078 The second section of the window is an area in which a display of the tail of
35079 the main log is maintained.
35080 To save space on the screen, the timestamp on each log line is shortened by
35081 removing the date and, if &%log_timezone%& is set, the timezone.
35082 The log tail is not available when the only destination for logging data is
35083 syslog, unless the syslog lines are routed to a local file whose name is passed
35084 to &'eximon'& via the EXIMON_LOG_FILE_PATH environment variable.
35085
35086 The log sub-window has a scroll bar at its lefthand side which can be used to
35087 move back to look at earlier text, and the up and down arrow keys also have a
35088 scrolling effect. The amount of log that is kept depends on the setting of
35089 LOG_BUFFER in &_Local/eximon.conf_&, which specifies the amount of memory
35090 to use. When this is full, the earlier 50% of data is discarded &-- this is
35091 much more efficient than throwing it away line by line. The sub-window also has
35092 a horizontal scroll bar for accessing the ends of long log lines. This is the
35093 only means of horizontal scrolling; the right and left arrow keys are not
35094 available. Text can be cut from this part of the window using the mouse in the
35095 normal way. The size of this subwindow is controlled by parameters in the
35096 configuration file &_Local/eximon.conf_&.
35097
35098 Searches of the text in the log window can be carried out by means of the ^R
35099 and ^S keystrokes, which default to a reverse and a forward search,
35100 respectively. The search covers only the text that is displayed in the window.
35101 It cannot go further back up the log.
35102
35103 The point from which the search starts is indicated by a caret marker. This is
35104 normally at the end of the text in the window, but can be positioned explicitly
35105 by pointing and clicking with the left mouse button, and is moved automatically
35106 by a successful search. If new text arrives in the window when it is scrolled
35107 back, the caret remains where it is, but if the window is not scrolled back,
35108 the caret is moved to the end of the new text.
35109
35110 Pressing ^R or ^S pops up a window into which the search text can be typed.
35111 There are buttons for selecting forward or reverse searching, for carrying out
35112 the search, and for cancelling. If the &"Search"& button is pressed, the search
35113 happens and the window remains so that further searches can be done. If the
35114 &"Return"& key is pressed, a single search is done and the window is closed. If
35115 ^C is typed the search is cancelled.
35116
35117 The searching facility is implemented using the facilities of the Athena text
35118 widget. By default this pops up a window containing both &"search"& and
35119 &"replace"& options. In order to suppress the unwanted &"replace"& portion for
35120 eximon, a modified version of the &%TextPop%& widget is distributed with Exim.
35121 However, the linkers in BSDI and HP-UX seem unable to handle an externally
35122 provided version of &%TextPop%& when the remaining parts of the text widget
35123 come from the standard libraries. The compile-time option EXIMON_TEXTPOP can be
35124 unset to cut out the modified &%TextPop%&, making it possible to build Eximon
35125 on these systems, at the expense of having unwanted items in the search popup
35126 window.
35127
35128
35129
35130 .section "The queue display" "SECID268"
35131 .cindex "queue" "display in monitor"
35132 The bottom section of the monitor window contains a list of all messages that
35133 are on the queue, which includes those currently being received or delivered,
35134 as well as those awaiting delivery. The size of this subwindow is controlled by
35135 parameters in the configuration file &_Local/eximon.conf_&, and the frequency
35136 at which it is updated is controlled by another parameter in the same file &--
35137 the default is 5 minutes, since queue scans can be quite expensive. However,
35138 there is an &"Update"& action button just above the display which can be used
35139 to force an update of the queue display at any time.
35140
35141 When a host is down for some time, a lot of pending mail can build up for it,
35142 and this can make it hard to deal with other messages on the queue. To help
35143 with this situation there is a button next to &"Update"& called &"Hide"&. If
35144 pressed, a dialogue box called &"Hide addresses ending with"& is put up. If you
35145 type anything in here and press &"Return"&, the text is added to a chain of
35146 such texts, and if every undelivered address in a message matches at least one
35147 of the texts, the message is not displayed.
35148
35149 If there is an address that does not match any of the texts, all the addresses
35150 are displayed as normal. The matching happens on the ends of addresses so, for
35151 example, &'cam.ac.uk'& specifies all addresses in Cambridge, while
35152 &'xxx@foo.com.example'& specifies just one specific address. When any hiding
35153 has been set up, a button called &"Unhide"& is displayed. If pressed, it
35154 cancels all hiding. Also, to ensure that hidden messages do not get forgotten,
35155 a hide request is automatically cancelled after one hour.
35156
35157 While the dialogue box is displayed, you can't press any buttons or do anything
35158 else to the monitor window. For this reason, if you want to cut text from the
35159 queue display to use in the dialogue box, you have to do the cutting before
35160 pressing the &"Hide"& button.
35161
35162 The queue display contains, for each unhidden queued message, the length of
35163 time it has been on the queue, the size of the message, the message id, the
35164 message sender, and the first undelivered recipient, all on one line. If it is
35165 a bounce message, the sender is shown as &"<>"&. If there is more than one
35166 recipient to which the message has not yet been delivered, subsequent ones are
35167 listed on additional lines, up to a maximum configured number, following which
35168 an ellipsis is displayed. Recipients that have already received the message are
35169 not shown.
35170
35171 .cindex "frozen messages" "display"
35172 If a message is frozen, an asterisk is displayed at the left-hand side.
35173
35174 The queue display has a vertical scroll bar, and can also be scrolled by means
35175 of the arrow keys. Text can be cut from it using the mouse in the normal way.
35176 The text searching facilities, as described above for the log window, are also
35177 available, but the caret is always moved to the end of the text when the queue
35178 display is updated.
35179
35180
35181
35182 .section "The queue menu" "SECID269"
35183 .cindex "queue" "menu in monitor"
35184 If the &%shift%& key is held down and the left button is clicked when the mouse
35185 pointer is over the text for any message, an action menu pops up, and the first
35186 line of the queue display for the message is highlighted. This does not affect
35187 any selected text.
35188
35189 If you want to use some other event for popping up the menu, you can set the
35190 MENU_EVENT parameter in &_Local/eximon.conf_& to change the default, or
35191 set EXIMON_MENU_EVENT in the environment before starting the monitor. The
35192 value set in this parameter is a standard X event description. For example, to
35193 run eximon using &%ctrl%& rather than &%shift%& you could use
35194 .code
35195 EXIMON_MENU_EVENT='Ctrl<Btn1Down>' eximon
35196 .endd
35197 The title of the menu is the message id, and it contains entries which act as
35198 follows:
35199
35200 .ilist
35201 &'message log'&: The contents of the message log for the message are displayed
35202 in a new text window.
35203 .next
35204 &'headers'&: Information from the spool file that contains the envelope
35205 information and headers is displayed in a new text window. See chapter
35206 &<<CHAPspool>>& for a description of the format of spool files.
35207 .next
35208 &'body'&: The contents of the spool file containing the body of the message are
35209 displayed in a new text window. There is a default limit of 20,000 bytes to the
35210 amount of data displayed. This can be changed by setting the BODY_MAX
35211 option at compile time, or the EXIMON_BODY_MAX option at run time.
35212 .next
35213 &'deliver message'&: A call to Exim is made using the &%-M%& option to request
35214 delivery of the message. This causes an automatic thaw if the message is
35215 frozen. The &%-v%& option is also set, and the output from Exim is displayed in
35216 a new text window. The delivery is run in a separate process, to avoid holding
35217 up the monitor while the delivery proceeds.
35218 .next
35219 &'freeze message'&: A call to Exim is made using the &%-Mf%& option to request
35220 that the message be frozen.
35221 .next
35222 .cindex "thawing messages"
35223 .cindex "unfreezing messages"
35224 .cindex "frozen messages" "thawing"
35225 &'thaw message'&: A call to Exim is made using the &%-Mt%& option to request
35226 that the message be thawed.
35227 .next
35228 .cindex "delivery" "forcing failure"
35229 &'give up on msg'&: A call to Exim is made using the &%-Mg%& option to request
35230 that Exim gives up trying to deliver the message. A bounce message is generated
35231 for any remaining undelivered addresses.
35232 .next
35233 &'remove message'&: A call to Exim is made using the &%-Mrm%& option to request
35234 that the message be deleted from the system without generating a bounce
35235 message.
35236 .next
35237 &'add recipient'&: A dialog box is displayed into which a recipient address can
35238 be typed. If the address is not qualified and the QUALIFY_DOMAIN parameter
35239 is set in &_Local/eximon.conf_&, the address is qualified with that domain.
35240 Otherwise it must be entered as a fully qualified address. Pressing RETURN
35241 causes a call to Exim to be made using the &%-Mar%& option to request that an
35242 additional recipient be added to the message, unless the entry box is empty, in
35243 which case no action is taken.
35244 .next
35245 &'mark delivered'&: A dialog box is displayed into which a recipient address
35246 can be typed. If the address is not qualified and the QUALIFY_DOMAIN parameter
35247 is set in &_Local/eximon.conf_&, the address is qualified with that domain.
35248 Otherwise it must be entered as a fully qualified address. Pressing RETURN
35249 causes a call to Exim to be made using the &%-Mmd%& option to mark the given
35250 recipient address as already delivered, unless the entry box is empty, in which
35251 case no action is taken.
35252 .next
35253 &'mark all delivered'&: A call to Exim is made using the &%-Mmad%& option to
35254 mark all recipient addresses as already delivered.
35255 .next
35256 &'edit sender'&: A dialog box is displayed initialized with the current
35257 sender's address. Pressing RETURN causes a call to Exim to be made using the
35258 &%-Mes%& option to replace the sender address, unless the entry box is empty,
35259 in which case no action is taken. If you want to set an empty sender (as in
35260 bounce messages), you must specify it as &"<>"&. Otherwise, if the address is
35261 not qualified and the QUALIFY_DOMAIN parameter is set in &_Local/eximon.conf_&,
35262 the address is qualified with that domain.
35263 .endlist
35264
35265 When a delivery is forced, a window showing the &%-v%& output is displayed. In
35266 other cases when a call to Exim is made, if there is any output from Exim (in
35267 particular, if the command fails) a window containing the command and the
35268 output is displayed. Otherwise, the results of the action are normally apparent
35269 from the log and queue displays. However, if you set ACTION_OUTPUT=yes in
35270 &_Local/eximon.conf_&, a window showing the Exim command is always opened, even
35271 if no output is generated.
35272
35273 The queue display is automatically updated for actions such as freezing and
35274 thawing, unless ACTION_QUEUE_UPDATE=no has been set in
35275 &_Local/eximon.conf_&. In this case the &"Update"& button has to be used to
35276 force an update of the display after one of these actions.
35277
35278 In any text window that is displayed as result of a menu action, the normal
35279 cut-and-paste facility is available, and searching can be carried out using ^R
35280 and ^S, as described above for the log tail window.
35281 .ecindex IIDeximon
35282
35283
35284
35285
35286
35287 . ////////////////////////////////////////////////////////////////////////////
35288 . ////////////////////////////////////////////////////////////////////////////
35289
35290 .chapter "Security considerations" "CHAPsecurity"
35291 .scindex IIDsecurcon "security" "discussion of"
35292 This chapter discusses a number of issues concerned with security, some of
35293 which are also covered in other parts of this manual.
35294
35295 For reasons that this author does not understand, some people have promoted
35296 Exim as a &"particularly secure"& mailer. Perhaps it is because of the
35297 existence of this chapter in the documentation. However, the intent of the
35298 chapter is simply to describe the way Exim works in relation to certain
35299 security concerns, not to make any specific claims about the effectiveness of
35300 its security as compared with other MTAs.
35301
35302 What follows is a description of the way Exim is supposed to be. Best efforts
35303 have been made to try to ensure that the code agrees with the theory, but an
35304 absence of bugs can never be guaranteed. Any that are reported will get fixed
35305 as soon as possible.
35306
35307
35308 .section "Building a more &""hardened""& Exim" "SECID286"
35309 .cindex "security" "build-time features"
35310 There are a number of build-time options that can be set in &_Local/Makefile_&
35311 to create Exim binaries that are &"harder"& to attack, in particular by a rogue
35312 Exim administrator who does not have the root password, or by someone who has
35313 penetrated the Exim (but not the root) account. These options are as follows:
35314
35315 .ilist
35316 ALT_CONFIG_PREFIX can be set to a string that is required to match the
35317 start of any file names used with the &%-C%& option. When it is set, these file
35318 names are also not allowed to contain the sequence &"/../"&. (However, if the
35319 value of the &%-C%& option is identical to the value of CONFIGURE_FILE in
35320 &_Local/Makefile_&, Exim ignores &%-C%& and proceeds as usual.) There is no
35321 default setting for &%ALT_CONFIG_PREFIX%&.
35322
35323 If the permitted configuration files are confined to a directory to
35324 which only root has access, this guards against someone who has broken
35325 into the Exim account from running a privileged Exim with an arbitrary
35326 configuration file, and using it to break into other accounts.
35327 .next
35328
35329 If a non-trusted configuration file (i.e. not the default configuration file
35330 or one which is trusted by virtue of being listed in the TRUSTED_CONFIG_LIST
35331 file) is specified with &%-C%&, or if macros are given with &%-D%& (but see
35332 the next item), then root privilege is retained only if the caller of Exim is
35333 root. This locks out the possibility of testing a configuration using &%-C%&
35334 right through message reception and delivery, even if the caller is root. The
35335 reception works, but by that time, Exim is running as the Exim user, so when
35336 it re-execs to regain privilege for the delivery, the use of &%-C%& causes
35337 privilege to be lost. However, root can test reception and delivery using two
35338 separate commands.
35339
35340 .next
35341 The WHITELIST_D_MACROS build option declares some macros to be safe to override
35342 with &%-D%& if the real uid is one of root, the Exim run-time user or the
35343 CONFIGURE_OWNER, if defined.  The potential impact of this option is limited by
35344 requiring the run-time value supplied to &%-D%& to match a regex that errs on
35345 the restrictive side.  Requiring build-time selection of safe macros is onerous
35346 but this option is intended solely as a transition mechanism to permit
35347 previously-working configurations to continue to work after release 4.73.
35348 .next
35349 If DISABLE_D_OPTION is defined, the use of the &%-D%& command line option
35350 is disabled.
35351 .next
35352 FIXED_NEVER_USERS can be set to a colon-separated list of users that are
35353 never to be used for any deliveries. This is like the &%never_users%& runtime
35354 option, but it cannot be overridden; the runtime option adds additional users
35355 to the list. The default setting is &"root"&; this prevents a non-root user who
35356 is permitted to modify the runtime file from using Exim as a way to get root.
35357 .endlist
35358
35359
35360
35361 .section "Root privilege" "SECID270"
35362 .cindex "setuid"
35363 .cindex "root privilege"
35364 The Exim binary is normally setuid to root, which means that it gains root
35365 privilege (runs as root) when it starts execution. In some special cases (for
35366 example, when the daemon is not in use and there are no local deliveries), it
35367 may be possible to run Exim setuid to some user other than root. This is
35368 discussed in the next section. However, in most installations, root privilege
35369 is required for two things:
35370
35371 .ilist
35372 To set up a socket connected to the standard SMTP port (25) when initialising
35373 the listening daemon. If Exim is run from &'inetd'&, this privileged action is
35374 not required.
35375 .next
35376 To be able to change uid and gid in order to read users' &_.forward_& files and
35377 perform local deliveries as the receiving user or as specified in the
35378 configuration.
35379 .endlist
35380
35381 It is not necessary to be root to do any of the other things Exim does, such as
35382 receiving messages and delivering them externally over SMTP, and it is
35383 obviously more secure if Exim does not run as root except when necessary.
35384 For this reason, a user and group for Exim to use must be defined in
35385 &_Local/Makefile_&. These are known as &"the Exim user"& and &"the Exim
35386 group"&. Their values can be changed by the run time configuration, though this
35387 is not recommended. Often a user called &'exim'& is used, but some sites use
35388 &'mail'& or another user name altogether.
35389
35390 Exim uses &[setuid()]& whenever it gives up root privilege. This is a permanent
35391 abdication; the process cannot regain root afterwards. Prior to release 4.00,
35392 &[seteuid()]& was used in some circumstances, but this is no longer the case.
35393
35394 After a new Exim process has interpreted its command line options, it changes
35395 uid and gid in the following cases:
35396
35397 .ilist
35398 .oindex "&%-C%&"
35399 .oindex "&%-D%&"
35400 If the &%-C%& option is used to specify an alternate configuration file, or if
35401 the &%-D%& option is used to define macro values for the configuration, and the
35402 calling process is not running as root, the uid and gid are changed to those of
35403 the calling process.
35404 However, if DISABLE_D_OPTION is defined in &_Local/Makefile_&, the &%-D%&
35405 option may not be used at all.
35406 If WHITELIST_D_MACROS is defined in &_Local/Makefile_&, then some macro values
35407 can be supplied if the calling process is running as root, the Exim run-time
35408 user or CONFIGURE_OWNER, if defined.
35409 .next
35410 .oindex "&%-be%&"
35411 .oindex "&%-bf%&"
35412 .oindex "&%-bF%&"
35413 If the expansion test option (&%-be%&) or one of the filter testing options
35414 (&%-bf%& or &%-bF%&) are used, the uid and gid are changed to those of the
35415 calling process.
35416 .next
35417 If the process is not a daemon process or a queue runner process or a delivery
35418 process or a process for testing address routing (started with &%-bt%&), the
35419 uid and gid are changed to the Exim user and group. This means that Exim always
35420 runs under its own uid and gid when receiving messages. This also applies when
35421 testing address verification
35422 .oindex "&%-bv%&"
35423 .oindex "&%-bh%&"
35424 (the &%-bv%& option) and testing incoming message policy controls (the &%-bh%&
35425 option).
35426 .next
35427 For a daemon, queue runner, delivery, or address testing process, the uid
35428 remains as root at this stage, but the gid is changed to the Exim group.
35429 .endlist
35430
35431 The processes that initially retain root privilege behave as follows:
35432
35433 .ilist
35434 A daemon process changes the gid to the Exim group and the uid to the Exim
35435 user after setting up one or more listening sockets. The &[initgroups()]&
35436 function is called, so that if the Exim user is in any additional groups, they
35437 will be used during message reception.
35438 .next
35439 A queue runner process retains root privilege throughout its execution. Its
35440 job is to fork a controlled sequence of delivery processes.
35441 .next
35442 A delivery process retains root privilege throughout most of its execution,
35443 but any actual deliveries (that is, the transports themselves) are run in
35444 subprocesses which always change to a non-root uid and gid. For local
35445 deliveries this is typically the uid and gid of the owner of the mailbox; for
35446 remote deliveries, the Exim uid and gid are used. Once all the delivery
35447 subprocesses have been run, a delivery process changes to the Exim uid and gid
35448 while doing post-delivery tidying up such as updating the retry database and
35449 generating bounce and warning messages.
35450
35451 While the recipient addresses in a message are being routed, the delivery
35452 process runs as root. However, if a user's filter file has to be processed,
35453 this is done in a subprocess that runs under the individual user's uid and
35454 gid. A system filter is run as root unless &%system_filter_user%& is set.
35455 .next
35456 A process that is testing addresses (the &%-bt%& option) runs as root so that
35457 the routing is done in the same environment as a message delivery.
35458 .endlist
35459
35460
35461
35462
35463 .section "Running Exim without privilege" "SECTrunexiwitpri"
35464 .cindex "privilege, running without"
35465 .cindex "unprivileged running"
35466 .cindex "root privilege" "running without"
35467 Some installations like to run Exim in an unprivileged state for more of its
35468 operation, for added security. Support for this mode of operation is provided
35469 by the global option &%deliver_drop_privilege%&. When this is set, the uid and
35470 gid are changed to the Exim user and group at the start of a delivery process
35471 (and also queue runner and address testing processes). This means that address
35472 routing is no longer run as root, and the deliveries themselves cannot change
35473 to any other uid.
35474
35475 .cindex SIGHUP
35476 .cindex "daemon" "restarting"
35477 Leaving the binary setuid to root, but setting &%deliver_drop_privilege%& means
35478 that the daemon can still be started in the usual way, and it can respond
35479 correctly to SIGHUP because the re-invocation regains root privilege.
35480
35481 An alternative approach is to make Exim setuid to the Exim user and also setgid
35482 to the Exim group. If you do this, the daemon must be started from a root
35483 process. (Calling Exim from a root process makes it behave in the way it does
35484 when it is setuid root.) However, the daemon cannot restart itself after a
35485 SIGHUP signal because it cannot regain privilege.
35486
35487 It is still useful to set &%deliver_drop_privilege%& in this case, because it
35488 stops Exim from trying to re-invoke itself to do a delivery after a message has
35489 been received. Such a re-invocation is a waste of resources because it has no
35490 effect.
35491
35492 If restarting the daemon is not an issue (for example, if &%mua_wrapper%& is
35493 set, or &'inetd'& is being used instead of a daemon), having the binary setuid
35494 to the Exim user seems a clean approach, but there is one complication:
35495
35496 In this style of operation, Exim is running with the real uid and gid set to
35497 those of the calling process, and the effective uid/gid set to Exim's values.
35498 Ideally, any association with the calling process' uid/gid should be dropped,
35499 that is, the real uid/gid should be reset to the effective values so as to
35500 discard any privileges that the caller may have. While some operating systems
35501 have a function that permits this action for a non-root effective uid, quite a
35502 number of them do not. Because of this lack of standardization, Exim does not
35503 address this problem at this time.
35504
35505 For this reason, the recommended approach for &"mostly unprivileged"& running
35506 is to keep the Exim binary setuid to root, and to set
35507 &%deliver_drop_privilege%&. This also has the advantage of allowing a daemon to
35508 be used in the most straightforward way.
35509
35510 If you configure Exim not to run delivery processes as root, there are a
35511 number of restrictions on what you can do:
35512
35513 .ilist
35514 You can deliver only as the Exim user/group. You should  explicitly use the
35515 &%user%& and &%group%& options to override routers or local transports that
35516 normally deliver as the recipient. This makes sure that configurations that
35517 work in this mode function the same way in normal mode. Any implicit or
35518 explicit specification of another user causes an error.
35519 .next
35520 Use of &_.forward_& files is severely restricted, such that it is usually
35521 not worthwhile to include them in the configuration.
35522 .next
35523 Users who wish to use &_.forward_& would have to make their home directory and
35524 the file itself accessible to the Exim user. Pipe and append-to-file entries,
35525 and their equivalents in Exim filters, cannot be used. While they could be
35526 enabled in the Exim user's name, that would be insecure and not very useful.
35527 .next
35528 Unless the local user mailboxes are all owned by the Exim user (possible in
35529 some POP3 or IMAP-only environments):
35530
35531 .olist
35532 They must be owned by the Exim group and be writeable by that group. This
35533 implies you must set &%mode%& in the appendfile configuration, as well as the
35534 mode of the mailbox files themselves.
35535 .next
35536 You must set &%no_check_owner%&, since most or all of the files will not be
35537 owned by the Exim user.
35538 .next
35539 You must set &%file_must_exist%&, because Exim cannot set the owner correctly
35540 on a newly created mailbox when unprivileged. This also implies that new
35541 mailboxes need to be created manually.
35542 .endlist olist
35543 .endlist ilist
35544
35545
35546 These restrictions severely restrict what can be done in local deliveries.
35547 However, there are no restrictions on remote deliveries. If you are running a
35548 gateway host that does no local deliveries, setting &%deliver_drop_privilege%&
35549 gives more security at essentially no cost.
35550
35551 If you are using the &%mua_wrapper%& facility (see chapter
35552 &<<CHAPnonqueueing>>&), &%deliver_drop_privilege%& is forced to be true.
35553
35554
35555
35556
35557 .section "Delivering to local files" "SECID271"
35558 Full details of the checks applied by &(appendfile)& before it writes to a file
35559 are given in chapter &<<CHAPappendfile>>&.
35560
35561
35562
35563 .section "IPv4 source routing" "SECID272"
35564 .cindex "source routing" "in IP packets"
35565 .cindex "IP source routing"
35566 Many operating systems suppress IP source-routed packets in the kernel, but
35567 some cannot be made to do this, so Exim does its own check. It logs incoming
35568 IPv4 source-routed TCP calls, and then drops them. Things are all different in
35569 IPv6. No special checking is currently done.
35570
35571
35572
35573 .section "The VRFY, EXPN, and ETRN commands in SMTP" "SECID273"
35574 Support for these SMTP commands is disabled by default. If required, they can
35575 be enabled by defining suitable ACLs.
35576
35577
35578
35579
35580 .section "Privileged users" "SECID274"
35581 .cindex "trusted users"
35582 .cindex "admin user"
35583 .cindex "privileged user"
35584 .cindex "user" "trusted"
35585 .cindex "user" "admin"
35586 Exim recognizes two sets of users with special privileges. Trusted users are
35587 able to submit new messages to Exim locally, but supply their own sender
35588 addresses and information about a sending host. For other users submitting
35589 local messages, Exim sets up the sender address from the uid, and doesn't
35590 permit a remote host to be specified.
35591
35592 .oindex "&%-f%&"
35593 However, an untrusted user is permitted to use the &%-f%& command line option
35594 in the special form &%-f <>%& to indicate that a delivery failure for the
35595 message should not cause an error report. This affects the message's envelope,
35596 but it does not affect the &'Sender:'& header. Untrusted users may also be
35597 permitted to use specific forms of address with the &%-f%& option by setting
35598 the &%untrusted_set_sender%& option.
35599
35600 Trusted users are used to run processes that receive mail messages from some
35601 other mail domain and pass them on to Exim for delivery either locally, or over
35602 the Internet. Exim trusts a caller that is running as root, as the Exim user,
35603 as any user listed in the &%trusted_users%& configuration option, or under any
35604 group listed in the &%trusted_groups%& option.
35605
35606 Admin users are permitted to do things to the messages on Exim's queue. They
35607 can freeze or thaw messages, cause them to be returned to their senders, remove
35608 them entirely, or modify them in various ways. In addition, admin users can run
35609 the Exim monitor and see all the information it is capable of providing, which
35610 includes the contents of files on the spool.
35611
35612 .oindex "&%-M%&"
35613 .oindex "&%-q%&"
35614 By default, the use of the &%-M%& and &%-q%& options to cause Exim to attempt
35615 delivery of messages on its queue is restricted to admin users. This
35616 restriction can be relaxed by setting the &%no_prod_requires_admin%& option.
35617 Similarly, the use of &%-bp%& (and its variants) to list the contents of the
35618 queue is also restricted to admin users. This restriction can be relaxed by
35619 setting &%no_queue_list_requires_admin%&.
35620
35621 Exim recognizes an admin user if the calling process is running as root or as
35622 the Exim user or if any of the groups associated with the calling process is
35623 the Exim group. It is not necessary actually to be running under the Exim
35624 group. However, if admin users who are not root or the Exim user are to access
35625 the contents of files on the spool via the Exim monitor (which runs
35626 unprivileged), Exim must be built to allow group read access to its spool
35627 files.
35628
35629
35630
35631 .section "Spool files" "SECID275"
35632 .cindex "spool directory" "files"
35633 Exim's spool directory and everything it contains is owned by the Exim user and
35634 set to the Exim group. The mode for spool files is defined in the
35635 &_Local/Makefile_& configuration file, and defaults to 0640. This means that
35636 any user who is a member of the Exim group can access these files.
35637
35638
35639
35640 .section "Use of argv[0]" "SECID276"
35641 Exim examines the last component of &%argv[0]%&, and if it matches one of a set
35642 of specific strings, Exim assumes certain options. For example, calling Exim
35643 with the last component of &%argv[0]%& set to &"rsmtp"& is exactly equivalent
35644 to calling it with the option &%-bS%&. There are no security implications in
35645 this.
35646
35647
35648
35649 .section "Use of %f formatting" "SECID277"
35650 The only use made of &"%f"& by Exim is in formatting load average values. These
35651 are actually stored in integer variables as 1000 times the load average.
35652 Consequently, their range is limited and so therefore is the length of the
35653 converted output.
35654
35655
35656
35657 .section "Embedded Exim path" "SECID278"
35658 Exim uses its own path name, which is embedded in the code, only when it needs
35659 to re-exec in order to regain root privilege. Therefore, it is not root when it
35660 does so. If some bug allowed the path to get overwritten, it would lead to an
35661 arbitrary program's being run as exim, not as root.
35662
35663
35664
35665 .section "Dynamic module directory" "SECTdynmoddir"
35666 Any dynamically loadable modules must be installed into the directory
35667 defined in &`LOOKUP_MODULE_DIR`& in &_Local/Makefile_& for Exim to permit
35668 loading it.
35669
35670
35671 .section "Use of sprintf()" "SECID279"
35672 .cindex "&[sprintf()]&"
35673 A large number of occurrences of &"sprintf"& in the code are actually calls to
35674 &'string_sprintf()'&, a function that returns the result in malloc'd store.
35675 The intermediate formatting is done into a large fixed buffer by a function
35676 that runs through the format string itself, and checks the length of each
35677 conversion before performing it, thus preventing buffer overruns.
35678
35679 The remaining uses of &[sprintf()]& happen in controlled circumstances where
35680 the output buffer is known to be sufficiently long to contain the converted
35681 string.
35682
35683
35684
35685 .section "Use of debug_printf() and log_write()" "SECID280"
35686 Arbitrary strings are passed to both these functions, but they do their
35687 formatting by calling the function &'string_vformat()'&, which runs through
35688 the format string itself, and checks the length of each conversion.
35689
35690
35691
35692 .section "Use of strcat() and strcpy()" "SECID281"
35693 These are used only in cases where the output buffer is known to be large
35694 enough to hold the result.
35695 .ecindex IIDsecurcon
35696
35697
35698
35699
35700 . ////////////////////////////////////////////////////////////////////////////
35701 . ////////////////////////////////////////////////////////////////////////////
35702
35703 .chapter "Format of spool files" "CHAPspool"
35704 .scindex IIDforspo1 "format" "spool files"
35705 .scindex IIDforspo2 "spool directory" "format of files"
35706 .scindex IIDforspo3 "spool files" "format of"
35707 .cindex "spool files" "editing"
35708 A message on Exim's queue consists of two files, whose names are the message id
35709 followed by -D and -H, respectively. The data portion of the message is kept in
35710 the -D file on its own. The message's envelope, status, and headers are all
35711 kept in the -H file, whose format is described in this chapter. Each of these
35712 two files contains the final component of its own name as its first line. This
35713 is insurance against disk crashes where the directory is lost but the files
35714 themselves are recoverable.
35715
35716 Some people are tempted into editing -D files in order to modify messages. You
35717 need to be extremely careful if you do this; it is not recommended and you are
35718 on your own if you do it. Here are some of the pitfalls:
35719
35720 .ilist
35721 You must ensure that Exim does not try to deliver the message while you are
35722 fiddling with it. The safest way is to take out a write lock on the -D file,
35723 which is what Exim itself does, using &[fcntl()]&. If you update the file in
35724 place, the lock will be retained. If you write a new file and rename it, the
35725 lock will be lost at the instant of rename.
35726 .next
35727 .vindex "&$body_linecount$&"
35728 If you change the number of lines in the file, the value of
35729 &$body_linecount$&, which is stored in the -H file, will be incorrect. At
35730 present, this value is not used by Exim, but there is no guarantee that this
35731 will always be the case.
35732 .next
35733 If the message is in MIME format, you must take care not to break it.
35734 .next
35735 If the message is cryptographically signed, any change will invalidate the
35736 signature.
35737 .endlist
35738 All in all, modifying -D files is fraught with danger.
35739
35740 Files whose names end with -J may also be seen in the &_input_& directory (or
35741 its subdirectories when &%split_spool_directory%& is set). These are journal
35742 files, used to record addresses to which the message has been delivered during
35743 the course of a delivery attempt. If there are still undelivered recipients at
35744 the end, the -H file is updated, and the -J file is deleted. If, however, there
35745 is some kind of crash (for example, a power outage) before this happens, the -J
35746 file remains in existence. When Exim next processes the message, it notices the
35747 -J file and uses it to update the -H file before starting the next delivery
35748 attempt.
35749
35750 .section "Format of the -H file" "SECID282"
35751 .cindex "uid (user id)" "in spool file"
35752 .cindex "gid (group id)" "in spool file"
35753 The second line of the -H file contains the login name for the uid of the
35754 process that called Exim to read the message, followed by the numerical uid and
35755 gid. For a locally generated message, this is normally the user who sent the
35756 message. For a message received over TCP/IP via the daemon, it is
35757 normally the Exim user.
35758
35759 The third line of the file contains the address of the message's sender as
35760 transmitted in the envelope, contained in angle brackets. The sender address is
35761 empty for bounce messages. For incoming SMTP mail, the sender address is given
35762 in the MAIL command. For locally generated mail, the sender address is
35763 created by Exim from the login name of the current user and the configured
35764 &%qualify_domain%&. However, this can be overridden by the &%-f%& option or a
35765 leading &"From&~"& line if the caller is trusted, or if the supplied address is
35766 &"<>"& or an address that matches &%untrusted_set_senders%&.
35767
35768 The fourth line contains two numbers. The first is the time that the message
35769 was received, in the conventional Unix form &-- the number of seconds since the
35770 start of the epoch. The second number is a count of the number of messages
35771 warning of delayed delivery that have been sent to the sender.
35772
35773 There follow a number of lines starting with a hyphen. These can appear in any
35774 order, and are omitted when not relevant:
35775
35776 .vlist
35777 .vitem "&%-acl%&&~<&'number'&>&~<&'length'&>"
35778 This item is obsolete, and is not generated from Exim release 4.61 onwards;
35779 &%-aclc%& and &%-aclm%& are used instead. However, &%-acl%& is still
35780 recognized, to provide backward compatibility. In the old format, a line of
35781 this form is present for every ACL variable that is not empty. The number
35782 identifies the variable; the &%acl_c%&&*x*& variables are numbered 0&--9 and
35783 the &%acl_m%&&*x*& variables are numbered 10&--19. The length is the length of
35784 the data string for the variable. The string itself starts at the beginning of
35785 the next line, and is followed by a newline character. It may contain internal
35786 newlines.
35787
35788 .vitem "&%-aclc%&&~<&'rest-of-name'&>&~<&'length'&>"
35789 A line of this form is present for every ACL connection variable that is
35790 defined. Note that there is a space between &%-aclc%& and the rest of the name.
35791 The length is the length of the data string for the variable. The string itself
35792 starts at the beginning of the next line, and is followed by a newline
35793 character. It may contain internal newlines.
35794
35795 .vitem "&%-aclm%&&~<&'rest-of-name'&>&~<&'length'&>"
35796 A line of this form is present for every ACL message variable that is defined.
35797 Note that there is a space between &%-aclm%& and the rest of the name. The
35798 length is the length of the data string for the variable. The string itself
35799 starts at the beginning of the next line, and is followed by a newline
35800 character. It may contain internal newlines.
35801
35802 .vitem "&%-active_hostname%&&~<&'hostname'&>"
35803 This is present if, when the message was received over SMTP, the value of
35804 &$smtp_active_hostname$& was different to the value of &$primary_hostname$&.
35805
35806 .vitem &%-allow_unqualified_recipient%&
35807 This is present if unqualified recipient addresses are permitted in header
35808 lines (to stop such addresses from being qualified if rewriting occurs at
35809 transport time). Local messages that were input using &%-bnq%& and remote
35810 messages from hosts that match &%recipient_unqualified_hosts%& set this flag.
35811
35812 .vitem &%-allow_unqualified_sender%&
35813 This is present if unqualified sender addresses are permitted in header lines
35814 (to stop such addresses from being qualified if rewriting occurs at transport
35815 time). Local messages that were input using &%-bnq%& and remote messages from
35816 hosts that match &%sender_unqualified_hosts%& set this flag.
35817
35818 .vitem "&%-auth_id%&&~<&'text'&>"
35819 The id information for a message received on an authenticated SMTP connection
35820 &-- the value of the &$authenticated_id$& variable.
35821
35822 .vitem "&%-auth_sender%&&~<&'address'&>"
35823 The address of an authenticated sender &-- the value of the
35824 &$authenticated_sender$& variable.
35825
35826 .vitem "&%-body_linecount%&&~<&'number'&>"
35827 This records the number of lines in the body of the message, and is always
35828 present.
35829
35830 .vitem "&%-body_zerocount%&&~<&'number'&>"
35831 This records the number of binary zero bytes in the body of the message, and is
35832 present if the number is greater than zero.
35833
35834 .vitem &%-deliver_firsttime%&
35835 This is written when a new message is first added to the spool. When the spool
35836 file is updated after a deferral, it is omitted.
35837
35838 .vitem "&%-frozen%&&~<&'time'&>"
35839 .cindex "frozen messages" "spool data"
35840 The message is frozen, and the freezing happened at <&'time'&>.
35841
35842 .vitem "&%-helo_name%&&~<&'text'&>"
35843 This records the host name as specified by a remote host in a HELO or EHLO
35844 command.
35845
35846 .vitem "&%-host_address%&&~<&'address'&>.<&'port'&>"
35847 This records the IP address of the host from which the message was received and
35848 the remote port number that was used. It is omitted for locally generated
35849 messages.
35850
35851 .vitem "&%-host_auth%&&~<&'text'&>"
35852 If the message was received on an authenticated SMTP connection, this records
35853 the name of the authenticator &-- the value of the
35854 &$sender_host_authenticated$& variable.
35855
35856 .vitem &%-host_lookup_failed%&
35857 This is present if an attempt to look up the sending host's name from its IP
35858 address failed. It corresponds to the &$host_lookup_failed$& variable.
35859
35860 .vitem "&%-host_name%&&~<&'text'&>"
35861 .cindex "reverse DNS lookup"
35862 .cindex "DNS" "reverse lookup"
35863 This records the name of the remote host from which the message was received,
35864 if the host name was looked up from the IP address when the message was being
35865 received. It is not present if no reverse lookup was done.
35866
35867 .vitem "&%-ident%&&~<&'text'&>"
35868 For locally submitted messages, this records the login of the originating user,
35869 unless it was a trusted user and the &%-oMt%& option was used to specify an
35870 ident value. For messages received over TCP/IP, this records the ident string
35871 supplied by the remote host, if any.
35872
35873 .vitem "&%-interface_address%&&~<&'address'&>.<&'port'&>"
35874 This records the IP address of the local interface and the port number through
35875 which a message was received from a remote host. It is omitted for locally
35876 generated messages.
35877
35878 .vitem &%-local%&
35879 The message is from a local sender.
35880
35881 .vitem &%-localerror%&
35882 The message is a locally-generated bounce message.
35883
35884 .vitem "&%-local_scan%&&~<&'string'&>"
35885 This records the data string that was returned by the &[local_scan()]& function
35886 when the message was received &-- the value of the &$local_scan_data$&
35887 variable. It is omitted if no data was returned.
35888
35889 .vitem &%-manual_thaw%&
35890 The message was frozen but has been thawed manually, that is, by an explicit
35891 Exim command rather than via the auto-thaw process.
35892
35893 .vitem &%-N%&
35894 A testing delivery process was started using the &%-N%& option to suppress any
35895 actual deliveries, but delivery was deferred. At any further delivery attempts,
35896 &%-N%& is assumed.
35897
35898 .vitem &%-received_protocol%&
35899 This records the value of the &$received_protocol$& variable, which contains
35900 the name of the protocol by which the message was received.
35901
35902 .vitem &%-sender_set_untrusted%&
35903 The envelope sender of this message was set by an untrusted local caller (used
35904 to ensure that the caller is displayed in queue listings).
35905
35906 .vitem "&%-spam_score_int%&&~<&'number'&>"
35907 If a message was scanned by SpamAssassin, this is present. It records the value
35908 of &$spam_score_int$&.
35909
35910 .vitem &%-tls_certificate_verified%&
35911 A TLS certificate was received from the client that sent this message, and the
35912 certificate was verified by the server.
35913
35914 .vitem "&%-tls_cipher%&&~<&'cipher name'&>"
35915 When the message was received over an encrypted connection, this records the
35916 name of the cipher suite that was used.
35917
35918 .vitem "&%-tls_peerdn%&&~<&'peer DN'&>"
35919 When the message was received over an encrypted connection, and a certificate
35920 was received from the client, this records the Distinguished Name from that
35921 certificate.
35922 .endlist
35923
35924 Following the options there is a list of those addresses to which the message
35925 is not to be delivered. This set of addresses is initialized from the command
35926 line when the &%-t%& option is used and &%extract_addresses_remove_arguments%&
35927 is set; otherwise it starts out empty. Whenever a successful delivery is made,
35928 the address is added to this set. The addresses are kept internally as a
35929 balanced binary tree, and it is a representation of that tree which is written
35930 to the spool file. If an address is expanded via an alias or forward file, the
35931 original address is added to the tree when deliveries to all its child
35932 addresses are complete.
35933
35934 If the tree is empty, there is a single line in the spool file containing just
35935 the text &"XX"&. Otherwise, each line consists of two letters, which are either
35936 Y or N, followed by an address. The address is the value for the node of the
35937 tree, and the letters indicate whether the node has a left branch and/or a
35938 right branch attached to it, respectively. If branches exist, they immediately
35939 follow. Here is an example of a three-node tree:
35940 .code
35941 YY darcy@austen.fict.example
35942 NN alice@wonderland.fict.example
35943 NN editor@thesaurus.ref.example
35944 .endd
35945 After the non-recipients tree, there is a list of the message's recipients.
35946 This is a simple list, preceded by a count. It includes all the original
35947 recipients of the message, including those to whom the message has already been
35948 delivered. In the simplest case, the list contains one address per line. For
35949 example:
35950 .code
35951 4
35952 editor@thesaurus.ref.example
35953 darcy@austen.fict.example
35954 rdo@foundation
35955 alice@wonderland.fict.example
35956 .endd
35957 However, when a child address has been added to the top-level addresses as a
35958 result of the use of the &%one_time%& option on a &(redirect)& router, each
35959 line is of the following form:
35960 .display
35961 <&'top-level address'&> <&'errors_to address'&> &&&
35962   <&'length'&>,<&'parent number'&>#<&'flag bits'&>
35963 .endd
35964 The 01 flag bit indicates the presence of the three other fields that follow
35965 the top-level address. Other bits may be used in future to support additional
35966 fields. The <&'parent number'&> is the offset in the recipients list of the
35967 original parent of the &"one time"& address. The first two fields are the
35968 envelope sender that is associated with this address and its length. If the
35969 length is zero, there is no special envelope sender (there are then two space
35970 characters in the line). A non-empty field can arise from a &(redirect)& router
35971 that has an &%errors_to%& setting.
35972
35973
35974 A blank line separates the envelope and status information from the headers
35975 which follow. A header may occupy several lines of the file, and to save effort
35976 when reading it in, each header is preceded by a number and an identifying
35977 character. The number is the number of characters in the header, including any
35978 embedded newlines and the terminating newline. The character is one of the
35979 following:
35980
35981 .table2 50pt
35982 .row <&'blank'&>         "header in which Exim has no special interest"
35983 .row &`B`&               "&'Bcc:'& header"
35984 .row &`C`&               "&'Cc:'& header"
35985 .row &`F`&               "&'From:'& header"
35986 .row &`I`&               "&'Message-id:'& header"
35987 .row &`P`&               "&'Received:'& header &-- P for &""postmark""&"
35988 .row &`R`&               "&'Reply-To:'& header"
35989 .row &`S`&               "&'Sender:'& header"
35990 .row &`T`&               "&'To:'& header"
35991 .row &`*`&               "replaced or deleted header"
35992 .endtable
35993
35994 Deleted or replaced (rewritten) headers remain in the spool file for debugging
35995 purposes. They are not transmitted when the message is delivered. Here is a
35996 typical set of headers:
35997 .code
35998 111P Received: by hobbit.fict.example with local (Exim 4.00)
35999 id 14y9EI-00026G-00; Fri, 11 May 2001 10:28:59 +0100
36000 049  Message-Id: <E14y9EI-00026G-00@hobbit.fict.example>
36001 038* X-rewrote-sender: bb@hobbit.fict.example
36002 042* From: Bilbo Baggins <bb@hobbit.fict.example>
36003 049F From: Bilbo Baggins <B.Baggins@hobbit.fict.example>
36004 099* To: alice@wonderland.fict.example, rdo@foundation,
36005 darcy@austen.fict.example, editor@thesaurus.ref.example
36006 104T To: alice@wonderland.fict.example, rdo@foundation.example,
36007 darcy@austen.fict.example, editor@thesaurus.ref.example
36008 038  Date: Fri, 11 May 2001 10:28:59 +0100
36009 .endd
36010 The asterisked headers indicate that the envelope sender, &'From:'& header, and
36011 &'To:'& header have been rewritten, the last one because routing expanded the
36012 unqualified domain &'foundation'&.
36013 .ecindex IIDforspo1
36014 .ecindex IIDforspo2
36015 .ecindex IIDforspo3
36016
36017 . ////////////////////////////////////////////////////////////////////////////
36018 . ////////////////////////////////////////////////////////////////////////////
36019
36020 .chapter "Support for DKIM (DomainKeys Identified Mail)" "CHAPdkim" &&&
36021          "DKIM Support"
36022 .cindex "DKIM"
36023
36024 DKIM is a mechanism by which messages sent by some entity can be provably
36025 linked to a domain which that entity controls.  It permits reputation to
36026 be tracked on a per-domain basis, rather than merely upon source IP address.
36027 DKIM is documented in RFC 4871.
36028
36029 Since version 4.70, DKIM support is compiled into Exim by default. It can be
36030 disabled by setting DISABLE_DKIM=yes in Local/Makefile.
36031
36032 Exim's DKIM implementation allows to
36033 .olist
36034 Sign outgoing messages: This function is implemented in the SMTP transport.
36035 It can co-exist with all other Exim features, including transport filters.
36036 .next
36037 Verify signatures in incoming messages: This is implemented by an additional
36038 ACL (acl_smtp_dkim), which can be called several times per message, with
36039 different signature contexts.
36040 .endlist
36041
36042 In typical Exim style, the verification implementation does not include any
36043 default "policy". Instead it enables you to build your own policy using
36044 Exim's standard controls.
36045
36046 Please note that verification of DKIM signatures in incoming mail is turned
36047 on by default for logging purposes. For each signature in incoming email,
36048 exim will log a line displaying the most important signature details, and the
36049 signature status. Here is an example (with line-breaks added for clarity):
36050 .code
36051 2009-09-09 10:22:28 1MlIRf-0003LU-U3 DKIM:
36052     d=facebookmail.com s=q1-2009b
36053     c=relaxed/relaxed a=rsa-sha1
36054     i=@facebookmail.com t=1252484542 [verification succeeded]
36055 .endd
36056 You might want to turn off DKIM verification processing entirely for internal
36057 or relay mail sources. To do that, set the &%dkim_disable_verify%& ACL
36058 control modifier. This should typically be done in the RCPT ACL, at points
36059 where you accept mail from relay sources (internal hosts or authenticated
36060 senders).
36061
36062
36063 .section "Signing outgoing messages" "SECID513"
36064 .cindex "DKIM" "signing"
36065
36066 Signing is implemented by setting private options on the SMTP transport.
36067 These options take (expandable) strings as arguments.
36068
36069 .option dkim_domain smtp string&!! unset
36070 MANDATORY:
36071 The domain you want to sign with. The result of this expanded
36072 option is put into the &%$dkim_domain%& expansion variable.
36073
36074 .option dkim_selector smtp string&!! unset
36075 MANDATORY:
36076 This sets the key selector string. You can use the &%$dkim_domain%& expansion
36077 variable to look up a matching selector. The result is put in the expansion
36078 variable &%$dkim_selector%& which should be used in the &%dkim_private_key%&
36079 option along with &%$dkim_domain%&.
36080
36081 .option dkim_private_key smtp string&!! unset
36082 MANDATORY:
36083 This sets the private key to use. You can use the &%$dkim_domain%& and
36084 &%$dkim_selector%& expansion variables to determine the private key to use.
36085 The result can either
36086 .ilist
36087 be a valid RSA private key in ASCII armor, including line breaks.
36088 .next
36089 start with a slash, in which case it is treated as a file that contains
36090 the private key.
36091 .next
36092 be "0", "false" or the empty string, in which case the message will not
36093 be signed. This case will not result in an error, even if &%dkim_strict%&
36094 is set.
36095 .endlist
36096
36097 .option dkim_canon smtp string&!! unset
36098 OPTIONAL:
36099 This option sets the canonicalization method used when signing a message.
36100 The DKIM RFC currently supports two methods: "simple" and "relaxed".
36101 The option defaults to "relaxed" when unset. Note: the current implementation
36102 only supports using the same canonicalization method for both headers and body.
36103
36104 .option dkim_strict smtp string&!! unset
36105 OPTIONAL:
36106 This  option  defines  how  Exim  behaves  when  signing a message that
36107 should be signed fails for some reason.  When the expansion evaluates to
36108 either "1" or "true", Exim will defer. Otherwise Exim will send the message
36109 unsigned. You can use the &%$dkim_domain%& and &%$dkim_selector%& expansion
36110 variables here.
36111
36112 .option dkim_sign_headers smtp string&!! unset
36113 OPTIONAL:
36114 When set, this option must expand to (or be specified as) a colon-separated
36115 list of header names. Headers with these names will be included in the message
36116 signature. When unspecified, the header names recommended in RFC4871 will be
36117 used.
36118
36119
36120 .section "Verifying DKIM signatures in incoming mail" "SECID514"
36121 .cindex "DKIM" "verification"
36122
36123 Verification of DKIM signatures in incoming email is implemented via the
36124 &%acl_smtp_dkim%& ACL. By default, this ACL is called once for each
36125 syntactically(!) correct signature in the incoming message.
36126
36127 To evaluate the signature in the ACL a large number of expansion variables
36128 containing the signature status and its details are set up during the
36129 runtime of the ACL.
36130
36131 Calling the ACL only for existing signatures is not sufficient to build
36132 more advanced policies. For that reason, the global option
36133 &%dkim_verify_signers%&, and a global expansion variable
36134 &%$dkim_signers%& exist.
36135
36136 The global option &%dkim_verify_signers%& can be set to a colon-separated
36137 list of DKIM domains or identities for which the ACL &%acl_smtp_dkim%& is
36138 called. It is expanded when the message has been received. At this point,
36139 the expansion variable &%$dkim_signers%& already contains a colon-separated
36140 list of signer domains and identities for the message. When
36141 &%dkim_verify_signers%& is not specified in the main configuration,
36142 it defaults as:
36143 .code
36144 dkim_verify_signers = $dkim_signers
36145 .endd
36146 This leads to the default behaviour of calling &%acl_smtp_dkim%& for each
36147 DKIM signature in the message. Current DKIM verifiers may want to explicitly
36148 call the ACL for known domains or identities. This would be achieved as follows:
36149 .code
36150 dkim_verify_signers = paypal.com:ebay.com:$dkim_signers
36151 .endd
36152 This would result in &%acl_smtp_dkim%& always being called for "paypal.com"
36153 and "ebay.com", plus all domains and identities that have signatures in the message.
36154 You can also be more creative in constructing your policy. For example:
36155 .code
36156 dkim_verify_signers = $sender_address_domain:$dkim_signers
36157 .endd
36158
36159 If a domain or identity is listed several times in the (expanded) value of
36160 &%dkim_verify_signers%&, the ACL is only called once for that domain or identity.
36161
36162
36163 Inside the &%acl_smtp_dkim%&, the following expansion variables are
36164 available (from most to least important):
36165
36166
36167 .vlist
36168 .vitem &%$dkim_cur_signer%&
36169 The signer that is being evaluated in this ACL run. This can be a domain or
36170 an identity. This is one of the list items from the expanded main option
36171 &%dkim_verify_signers%& (see above).
36172 .vitem &%$dkim_verify_status%&
36173 A string describing the general status of the signature. One of
36174 .ilist
36175 &%none%&: There is no signature in the message for the current domain or
36176 identity (as reflected by &%$dkim_cur_signer%&).
36177 .next
36178 &%invalid%&: The signature could not be verified due to a processing error.
36179 More detail is available in &%$dkim_verify_reason%&.
36180 .next
36181 &%fail%&: Verification of the signature failed.  More detail is
36182 available in &%$dkim_verify_reason%&.
36183 .next
36184 &%pass%&: The signature passed verification. It is valid.
36185 .endlist
36186 .vitem &%$dkim_verify_reason%&
36187 A string giving a litte bit more detail when &%$dkim_verify_status%& is either
36188 "fail" or "invalid". One of
36189 .ilist
36190 &%pubkey_unavailable%& (when &%$dkim_verify_status%&="invalid"): The public
36191 key for the domain could not be retrieved. This may be a temporary problem.
36192 .next
36193 &%pubkey_syntax%& (when &%$dkim_verify_status%&="invalid"): The public key
36194 record for the domain is syntactically invalid.
36195 .next
36196 &%bodyhash_mismatch%& (when &%$dkim_verify_status%&="fail"): The calculated
36197 body hash does not match the one specified in the signature header. This
36198 means that the message body was modified in transit.
36199 .next
36200 &%signature_incorrect%& (when &%$dkim_verify_status%&="fail"): The signature
36201 could not be verified. This may mean that headers were modified,
36202 re-written or otherwise changed in a way which is incompatible with
36203 DKIM verification. It may of course also mean that the signature is forged.
36204 .endlist
36205 .vitem &%$dkim_domain%&
36206 The signing domain. IMPORTANT: This variable is only populated if there is
36207 an actual signature in the message for the current domain or identity (as
36208 reflected by &%$dkim_cur_signer%&).
36209 .vitem &%$dkim_identity%&
36210 The signing identity, if present. IMPORTANT: This variable is only populated
36211 if there is an actual signature in the message for the current domain or
36212 identity (as reflected by &%$dkim_cur_signer%&).
36213 .vitem &%$dkim_selector%&
36214 The key record selector string.
36215 .vitem &%$dkim_algo%&
36216 The algorithm used. One of 'rsa-sha1' or 'rsa-sha256'.
36217 .vitem &%$dkim_canon_body%&
36218 The body canonicalization method. One of 'relaxed' or 'simple'.
36219 .vitem &%dkim_canon_headers%&
36220 The header canonicalization method. One of 'relaxed' or 'simple'.
36221 .vitem &%$dkim_copiedheaders%&
36222 A transcript of headers and their values which are included in the signature
36223 (copied from the 'z=' tag of the signature).
36224 .vitem &%$dkim_bodylength%&
36225 The number of signed body bytes. If zero ("0"), the body is unsigned. If no
36226 limit was set by the signer, "9999999999999" is returned. This makes sure
36227 that this variable always expands to an integer value.
36228 .vitem &%$dkim_created%&
36229 UNIX timestamp reflecting the date and time when the signature was created.
36230 When this was not specified by the signer, "0" is returned.
36231 .vitem &%$dkim_expires%&
36232 UNIX timestamp reflecting the date and time when the signer wants the
36233 signature to be treated as "expired". When this was not specified by the
36234 signer, "9999999999999" is returned. This makes it possible to do useful
36235 integer size comparisons against this value.
36236 .vitem &%$dkim_headernames%&
36237 A colon-separated list of names of headers included in the signature.
36238 .vitem &%$dkim_key_testing%&
36239 "1" if the key record has the "testing" flag set, "0" if not.
36240 .vitem &%$nosubdomains%&
36241 "1" if the key record forbids subdomaining, "0" otherwise.
36242 .vitem &%$dkim_key_srvtype%&
36243 Service type (tag s=) from the key record. Defaults to "*" if not specified
36244 in the key record.
36245 .vitem &%$dkim_key_granularity%&
36246 Key granularity (tag g=) from the key record. Defaults to "*" if not specified
36247 in the key record.
36248 .vitem &%$dkim_key_notes%&
36249 Notes from the key record (tag n=).
36250 .endlist
36251
36252 In addition, two ACL conditions are provided:
36253
36254 .vlist
36255 .vitem &%dkim_signers%&
36256 ACL condition that checks a colon-separated list of domains or identities
36257 for a match against the domain or identity that the ACL is currently verifying
36258 (reflected by &%$dkim_cur_signer%&). This is typically used to restrict an ACL
36259 verb to a group of domains or identities. For example:
36260
36261 .code
36262 # Warn when Mail purportedly from GMail has no signature at all
36263 warn log_message = GMail sender without DKIM signature
36264      sender_domains = gmail.com
36265      dkim_signers = gmail.com
36266      dkim_status = none
36267 .endd
36268
36269 .vitem &%dkim_status%&
36270 ACL condition that checks a colon-separated list of possible DKIM verification
36271 results against the actual result of verification. This is typically used
36272 to restrict an ACL verb to a list of verification outcomes, for example:
36273
36274 .code
36275 deny message = Mail from Paypal with invalid/missing signature
36276      sender_domains = paypal.com:paypal.de
36277      dkim_signers = paypal.com:paypal.de
36278      dkim_status = none:invalid:fail
36279 .endd
36280
36281 The possible status keywords are: 'none','invalid','fail' and 'pass'. Please
36282 see the documentation of the &%$dkim_verify_status%& expansion variable above
36283 for more information of what they mean.
36284 .endlist
36285
36286 . ////////////////////////////////////////////////////////////////////////////
36287 . ////////////////////////////////////////////////////////////////////////////
36288
36289 .chapter "Adding new drivers or lookup types" "CHID13" &&&
36290          "Adding drivers or lookups"
36291 .cindex "adding drivers"
36292 .cindex "new drivers, adding"
36293 .cindex "drivers" "adding new"
36294 The following actions have to be taken in order to add a new router, transport,
36295 authenticator, or lookup type to Exim:
36296
36297 .olist
36298 Choose a name for the driver or lookup type that does not conflict with any
36299 existing name; I will use &"newdriver"& in what follows.
36300 .next
36301 Add to &_src/EDITME_& the line:
36302 .display
36303 <&'type'&>&`_NEWDRIVER=yes`&
36304 .endd
36305 where <&'type'&> is ROUTER, TRANSPORT, AUTH, or LOOKUP. If the
36306 code is not to be included in the binary by default, comment this line out. You
36307 should also add any relevant comments about the driver or lookup type.
36308 .next
36309 Add to &_src/config.h.defaults_& the line:
36310 .code
36311 #define <type>_NEWDRIVER
36312 .endd
36313 .next
36314 Edit &_src/drtables.c_&, adding conditional code to pull in the private header
36315 and create a table entry as is done for all the other drivers and lookup types.
36316 .next
36317 Edit &_Makefile_& in the appropriate sub-directory (&_src/routers_&,
36318 &_src/transports_&, &_src/auths_&, or &_src/lookups_&); add a line for the new
36319 driver or lookup type and add it to the definition of OBJ.
36320 .next
36321 Create &_newdriver.h_& and &_newdriver.c_& in the appropriate sub-directory of
36322 &_src_&.
36323 .next
36324 Edit &_scripts/MakeLinks_& and add commands to link the &_.h_& and &_.c_& files
36325 as for other drivers and lookups.
36326 .endlist
36327
36328 Then all you need to do is write the code! A good way to start is to make a
36329 proforma by copying an existing module of the same type, globally changing all
36330 occurrences of the name, and cutting out most of the code. Note that any
36331 options you create must be listed in alphabetical order, because the tables are
36332 searched using a binary chop procedure.
36333
36334 There is a &_README_& file in each of the sub-directories of &_src_& describing
36335 the interface that is expected.
36336
36337
36338
36339
36340 . ////////////////////////////////////////////////////////////////////////////
36341 . ////////////////////////////////////////////////////////////////////////////
36342
36343 . /////////////////////////////////////////////////////////////////////////////
36344 . These lines are processing instructions for the Simple DocBook Processor that
36345 . Philip Hazel has developed as a less cumbersome way of making PostScript and
36346 . PDFs than using xmlto and fop. They will be ignored by all other XML
36347 . processors.
36348 . /////////////////////////////////////////////////////////////////////////////
36349
36350 .literal xml
36351 <?sdop
36352   format="newpage"
36353   foot_right_recto="&chaptertitle;"
36354   foot_right_verso="&chaptertitle;"
36355 ?>
36356 .literal off
36357
36358 .makeindex "Options index"   "option"
36359 .makeindex "Variables index" "variable"
36360 .makeindex "Concept index"   "concept"
36361
36362
36363 . /////////////////////////////////////////////////////////////////////////////
36364 . /////////////////////////////////////////////////////////////////////////////